2 * This file is part of the sigrok project.
4 * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
5 * Copyright (C) 2012 Alexandru Gagniuc <mr.nuke.me@gmail.com>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/types.h>
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
29 #include "radioshack-dmm.h"
31 static const int hwopts[] = {
37 static const int hwcaps[] = {
39 SR_HWCAP_LIMIT_SAMPLES,
44 static const char *probe_names[] = {
49 SR_PRIV struct sr_dev_driver radioshackdmm_driver_info;
50 static struct sr_dev_driver *di = &radioshackdmm_driver_info;
52 static const struct radioshackdmm_profile supported_radioshackdmm[] = {
53 { RADIOSHACK_22_812, "22-812", 100 },
56 /* Properly close and free all devices. */
57 static int clear_instances(void)
59 struct sr_dev_inst *sdi;
60 struct drv_context *drvc;
61 struct dev_context *devc;
64 if (!(drvc = di->priv))
68 for (l = drvc->instances; l; l = l->next) {
71 if (!(devc = sdi->priv))
73 sr_serial_dev_inst_free(devc->serial);
74 sr_dev_inst_free(sdi);
76 g_slist_free(drvc->instances);
77 drvc->instances = NULL;
82 static int hw_init(void)
84 struct drv_context *drvc;
86 if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
87 sr_err("Driver context malloc failed.");
96 static GSList *rs_22_812_scan(const char *conn, const char *serialcomm)
98 struct sr_dev_inst *sdi;
99 struct drv_context *drvc;
100 struct dev_context *devc;
101 struct sr_probe *probe;
107 if ((fd = serial_open(conn, O_RDONLY|O_NONBLOCK)) == -1) {
108 sr_err("Unable to open %s: %s.", conn, strerror(errno));
111 if (serial_set_paramstr(fd, serialcomm) != SR_OK) {
112 sr_err("Unable to set serial parameters.");
116 sr_info("Probing port %s readonly.", conn);
122 /* There's no way to get an ID from the multimeter. It just sends data
123 * periodically, so the best we can do is check if the packets match the
124 * expected format. */
125 while (!devices && retry < 3)
128 size_t good_packets = 0;
132 /* Let's get a bit of data and see if we can find a packet */
134 serial_readline(fd, &b, &len, 250);
135 if( (len == 0) || (len < RS_22_812_PACKET_SIZE) ) {
136 /* Not enough data received, is the DMM connected ? */
140 /* Let's treat our buffer like a stream, and find any
142 for( i = 0; i < len - RS_22_812_PACKET_SIZE + 1;
143 /* don't increment i here */ )
145 const rs_22_812_packet *packet = (void *)(&buf[i]);
146 if( !rs_22_812_is_packet_valid(packet) ){
151 i += RS_22_812_PACKET_SIZE;
154 /* If we dropped more than two packets worth of data, something
156 size_t dropped = len - (good_packets * RS_22_812_PACKET_SIZE);
157 if(dropped > 2 * RS_22_812_PACKET_SIZE)
160 /* Let's see if we have anything good */
161 if (good_packets == 0)
164 sr_info("Found RS 22-812 on port %s.", conn);
166 if (!(sdi = sr_dev_inst_new(0, SR_ST_INACTIVE, "RadioShack",
169 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
170 sr_err("Device context malloc failed.");
174 /* devc->profile = RADIOSHACK_22_812; */
175 devc->serial = sr_serial_dev_inst_new(conn, -1);
176 devc->serialcomm = g_strdup(serialcomm);
180 if (!(probe = sr_probe_new(0, SR_PROBE_ANALOG, TRUE, "P1")))
182 sdi->probes = g_slist_append(sdi->probes, probe);
183 drvc->instances = g_slist_append(drvc->instances, sdi);
184 devices = g_slist_append(devices, sdi);
192 static GSList *hw_scan(GSList *options)
194 struct sr_hwopt *opt;
196 const char *conn, *serialcomm;
198 conn = serialcomm = NULL;
199 for (l = options; l; l = l->next) {
201 switch (opt->hwopt) {
205 case SR_HWOPT_SERIALCOMM:
206 serialcomm = opt->value;
214 /* Use the provided comm specs. */
215 devices = rs_22_812_scan(conn, serialcomm);
217 /* Then try the default 4800 8n1 */
218 devices = rs_22_812_scan(conn, "4800/8n1");
224 static GSList *hw_dev_list(void)
226 struct drv_context *drvc;
230 return drvc->instances;
233 static int hw_dev_open(struct sr_dev_inst *sdi)
235 struct dev_context *devc;
237 if (!(devc = sdi->priv)) {
238 sr_err("sdi->priv was NULL.");
242 devc->serial->fd = serial_open(devc->serial->port, O_RDONLY);
243 if (devc->serial->fd == -1) {
244 sr_err("Couldn't open serial port '%s'.",
248 if (serial_set_paramstr(devc->serial->fd, devc->serialcomm) != SR_OK) {
249 sr_err("Unable to set serial parameters.");
252 sdi->status = SR_ST_ACTIVE;
257 static int hw_dev_close(struct sr_dev_inst *sdi)
259 struct dev_context *devc;
261 if (!(devc = sdi->priv)) {
262 sr_err("sdi->priv was NULL.");
266 if (devc->serial && devc->serial->fd != -1) {
267 serial_close(devc->serial->fd);
268 devc->serial->fd = -1;
269 sdi->status = SR_ST_INACTIVE;
275 static int hw_cleanup(void)
282 static int hw_info_get(int info_id, const void **data,
283 const struct sr_dev_inst *sdi)
285 (void)sdi; /* Does nothing. prevents "unused parameter" warning */
294 case SR_DI_NUM_PROBES:
295 *data = GINT_TO_POINTER(1);
297 case SR_DI_PROBE_NAMES:
307 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
310 struct dev_context *devc;
312 if (sdi->status != SR_ST_ACTIVE)
315 if (!(devc = sdi->priv)) {
316 sr_err("sdi->priv was NULL.");
321 case SR_HWCAP_LIMIT_SAMPLES:
322 devc->limit_samples = *(const uint64_t *)value;
323 sr_dbg("Setting sample limit to %" PRIu64 ".",
324 devc->limit_samples);
327 sr_err("Unknown capability: %d.", hwcap);
335 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
338 struct sr_datafeed_packet packet;
339 struct sr_datafeed_header header;
340 struct sr_datafeed_meta_analog meta;
341 struct dev_context *devc;
343 if (!(devc = sdi->priv)) {
344 sr_err("sdi->priv was NULL.");
348 sr_dbg("Starting acquisition.");
350 devc->cb_data = cb_data;
352 /* Reset the number of samples to take. If we've already collected our
353 * quota, but we start a new session, and don't reset this, we'll just
354 * quit without aquiring any new samples */
355 devc->num_samples = 0;
357 /* Send header packet to the session bus. */
358 sr_dbg("Sending SR_DF_HEADER.");
359 packet.type = SR_DF_HEADER;
360 packet.payload = (uint8_t *)&header;
361 header.feed_version = 1;
362 gettimeofday(&header.starttime, NULL);
363 sr_session_send(devc->cb_data, &packet);
365 /* Send metadata about the SR_DF_ANALOG packets to come. */
366 sr_dbg("Sending SR_DF_META_ANALOG.");
367 packet.type = SR_DF_META_ANALOG;
368 packet.payload = &meta;
370 sr_session_send(devc->cb_data, &packet);
372 /* Poll every 100ms, or whenever some data comes in. */
373 sr_source_add(devc->serial->fd, G_IO_IN, 50,
374 radioshack_receive_data, (void *)sdi );
379 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
382 struct sr_datafeed_packet packet;
383 struct dev_context *devc;
385 if (sdi->status != SR_ST_ACTIVE)
388 if (!(devc = sdi->priv)) {
389 sr_err("sdi->priv was NULL.");
393 sr_dbg("Stopping acquisition.");
395 sr_source_remove(devc->serial->fd);
396 hw_dev_close((struct sr_dev_inst *)sdi);
398 /* Send end packet to the session bus. */
399 sr_dbg("Sending SR_DF_END.");
400 packet.type = SR_DF_END;
401 sr_session_send(cb_data, &packet);
406 SR_PRIV struct sr_dev_driver radioshackdmm_driver_info = {
407 .name = "radioshack-dmm",
408 .longname = "Radioshack 22-812/22-039 DMMs",
411 .cleanup = hw_cleanup,
413 .dev_list = hw_dev_list,
414 .dev_clear = clear_instances,
415 .dev_open = hw_dev_open,
416 .dev_close = hw_dev_close,
417 .info_get = hw_info_get,
418 .dev_config_set = hw_dev_config_set,
419 .dev_acquisition_start = hw_dev_acquisition_start,
420 .dev_acquisition_stop = hw_dev_acquisition_stop,