sr: drivers using sr_usb_dev_inst_new() must free it properly as well
[sigrok:sigrok.git] / libsigrok / hardware / genericdmm / api.c
1 /*
2  * This file is part of the sigrok project.
3  *
4  * Copyright (C) 2012 Uwe Hermann <uwe@hermann-uwe.de>
5  * Copyright (C) 2012 Bert Vermeulen <bert@biot.com>
6  *
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 2 of the License, or
10  * (at your option) any later version.
11  *
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.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
20  */
21
22 #include <stdlib.h>
23 #include <string.h>
24 #include <fcntl.h>
25 #include "libsigrok.h"
26 #include "libsigrok-internal.h"
27 #include "genericdmm.h"
28
29
30 extern SR_PRIV struct dmmchip dmmchip_fs9922;
31
32 static struct sr_hwopt victor_70c_vidpid[] = {
33         { SR_HWOPT_CONN, "1244.d237" },
34         { 0, NULL }
35 };
36 static struct dev_profile dev_profiles[] = {
37         { "victor-70c", "Victor", "70C", &dmmchip_fs9922,
38                 DMM_TRANSPORT_USBHID, victor_70c_vidpid
39         },
40         { "mastech-va18b", "Mastech", "VA18B", NULL, DMM_TRANSPORT_SERIAL, NULL},
41         { NULL, NULL, NULL, NULL, 0, NULL }
42 };
43
44 static const int hwopts[] = {
45         SR_HWOPT_MODEL,
46         SR_HWOPT_CONN,
47         SR_HWOPT_SERIALCOMM,
48         0,
49 };
50
51 static const int hwcaps[] = {
52         SR_HWCAP_MULTIMETER,
53         SR_HWCAP_LIMIT_SAMPLES,
54         SR_HWCAP_LIMIT_MSEC,
55         SR_HWCAP_CONTINUOUS,
56         0,
57 };
58
59 static const char *probe_names[] = {
60         "Probe",
61         NULL,
62 };
63
64 SR_PRIV struct sr_dev_driver genericdmm_driver_info;
65 static struct sr_dev_driver *gdi = &genericdmm_driver_info;
66 /* TODO need a way to keep this local to the static library */
67 SR_PRIV libusb_context *genericdmm_usb_context = NULL;
68
69
70 static GSList *connect_usb(const char *conn)
71 {
72         struct sr_dev_inst *sdi;
73         struct drv_context *drvc;
74         struct dev_context *devc;
75         libusb_device **devlist;
76         struct libusb_device_descriptor des;
77         GSList *devices;
78         GRegex *reg;
79         GMatchInfo *match;
80         int vid, pid, bus, addr, devcnt, err, i;
81         char *mstr;
82
83         drvc = gdi->priv;
84
85         vid = pid = bus = addr = 0;
86         reg = g_regex_new(DMM_CONN_USB_VIDPID, 0, 0, NULL);
87         if (g_regex_match(reg, conn, 0, &match)) {
88                 /* Extract VID. */
89                 if ((mstr = g_match_info_fetch(match, 1)))
90                         vid = strtoul(mstr, NULL, 16);
91                 g_free(mstr);
92
93                 /* Extract PID. */
94                 if ((mstr = g_match_info_fetch(match, 2)))
95                         pid = strtoul(mstr, NULL, 16);
96                 g_free(mstr);
97         } else {
98                 g_match_info_unref(match);
99                 g_regex_unref(reg);
100                 reg = g_regex_new(DMM_CONN_USB_BUSADDR, 0, 0, NULL);
101                 if (g_regex_match(reg, conn, 0, &match)) {
102                         /* Extract bus. */
103                         if ((mstr = g_match_info_fetch(match, 0)))
104                                 bus = strtoul(mstr, NULL, 16);
105                         g_free(mstr);
106
107                         /* Extract address. */
108                         if ((mstr = g_match_info_fetch(match, 0)))
109                                 addr = strtoul(mstr, NULL, 16);
110                         g_free(mstr);
111                 }
112         }
113         g_match_info_unref(match);
114         g_regex_unref(reg);
115
116         if (vid + pid + bus + addr == 0)
117                 return NULL;
118
119         if (bus > 64) {
120                 sr_err("invalid bus");
121                 return NULL;
122         }
123
124         if (addr > 127) {
125                 sr_err("invalid address");
126                 return NULL;
127         }
128
129         /* Looks like a valid USB device specification, but is it connected? */
130         devices = NULL;
131         libusb_get_device_list(genericdmm_usb_context, &devlist);
132         for (i = 0; devlist[i]; i++) {
133                 if ((err = libusb_get_device_descriptor(devlist[i], &des))) {
134                         sr_err("genericdmm: failed to get device descriptor: %d", err);
135                         continue;
136                 }
137
138                 if (vid + pid && (des.idVendor != vid || des.idProduct != pid))
139                         /* VID/PID specified, but no match. */
140                         continue;
141
142                 if (bus + addr && (
143                                 libusb_get_bus_number(devlist[i]) != bus
144                                 || libusb_get_device_address(devlist[i]) != addr))
145                         /* Bus/address specified, but no match. */
146                         continue;
147
148                 /* Found one. */
149                 if (!(devc = g_try_malloc0(sizeof(struct dev_context)))) {
150                         sr_err("genericdmm: devc malloc failed.");
151                         return 0;
152                 }
153
154                 devcnt = g_slist_length(drvc->instances);
155                 if (!(sdi = sr_dev_inst_new(devcnt, SR_ST_ACTIVE,
156                                 NULL, NULL, NULL))) {
157                         sr_err("genericdmm: sr_dev_inst_new returned NULL.");
158                         return NULL;
159                 }
160                 sdi->priv = devc;
161                 devc->usb = sr_usb_dev_inst_new(
162                                 libusb_get_bus_number(devlist[i]),
163                                 libusb_get_device_address(devlist[i]), NULL);
164                 devices = g_slist_append(devices, sdi);
165         }
166         libusb_free_device_list(devlist, 1);
167
168         return devices;
169 }
170
171 static GSList *connect_serial(const char *conn, const char *serialcomm)
172 {
173         GSList *devices;
174
175         devices = NULL;
176
177         /* TODO */
178         sr_dbg("not yet implemented");
179
180         return devices;
181 }
182
183 GSList *genericdmm_connect(const char *conn, const char *serialcomm)
184 {
185         GSList *devices;
186
187         if (serialcomm)
188                 /* Must be a serial port. */
189                 return connect_serial(conn, serialcomm);
190
191         if ((devices = connect_usb(conn)))
192                 return devices;
193
194         return NULL;
195 }
196
197 static GSList *default_scan(GSList *options)
198 {
199         GSList *l, *devices;
200         struct sr_hwopt *opt;
201         const char *conn, *serialcomm;
202
203         devices = NULL;
204         conn = serialcomm = NULL;
205         for (l = options; l; l = l->next) {
206                 opt = l->data;
207                 switch (opt->hwopt) {
208                 case SR_HWOPT_CONN:
209                         conn = opt->value;
210                         break;
211                 case SR_HWOPT_SERIALCOMM:
212                         serialcomm = opt->value;
213                         break;
214                 }
215         }
216         if (conn)
217                 devices = genericdmm_connect(conn, serialcomm);
218
219         return devices;
220 }
221
222 static int hw_init(void)
223 {
224         struct drv_context *drvc;
225
226         if (!(drvc = g_try_malloc0(sizeof(struct drv_context)))) {
227                 sr_err("genericdmm: driver context malloc failed.");
228                 return SR_ERR;
229         }
230
231         if (libusb_init(&genericdmm_usb_context) != 0) {
232                 sr_err("genericdmm: Failed to initialize USB.");
233                 return SR_ERR;
234         }
235
236         gdi->priv = drvc;
237
238         return SR_OK;
239 }
240
241 static GSList *hw_scan(GSList *options)
242 {
243         GSList *l, *ldef, *defopts, *newopts, *devices;
244         struct sr_hwopt *opt, *defopt;
245         struct dev_profile *pr, *profile;
246         struct sr_dev_inst *sdi;
247         struct drv_context *drvc;
248         const char *model;
249
250         drvc = gdi->priv;
251
252         /* Separate model from the options list. */
253         model = NULL;
254         newopts = NULL;
255         for (l = options; l; l = l->next) {
256                 opt = l->data;
257                 if (opt->hwopt == SR_HWOPT_MODEL)
258                         model = opt->value;
259                 else
260                         /* New list with references to the original data. */
261                         newopts = g_slist_append(newopts, opt);
262         }
263         if (!model) {
264                 /* This driver only works when a model is specified. */
265                 return NULL;
266         }
267
268         /* Find a profile with this model name. */
269         profile = NULL;
270         for (pr = dev_profiles; pr->modelid; pr++) {
271                 if (!strcmp(pr->modelid, model)) {
272                         profile = pr;
273                         break;
274                 }
275         }
276         if (!profile) {
277                 sr_err("Unknown model %s.", model);
278                 return NULL;
279         }
280
281         /* Initialize the DMM chip driver. */
282         if (profile->chip->init)
283                 profile->chip->init();
284
285         /* Convert the profile's default options list to a GSList. */
286         defopts = NULL;
287         for (opt = profile->defaults_opts; opt->hwopt; opt++) {
288                 /* New list with references to const data in the profile. */
289                 defopts = g_slist_append(defopts, opt);
290         }
291
292         /* Options given as argument to this function override the
293          * profile's default options.
294          */
295         for (ldef = defopts; ldef; ldef = ldef->next) {
296                 defopt = ldef->data;
297                 for (l = newopts; l; l = l->next) {
298                         opt = l->data;
299                         if (opt->hwopt == defopt->hwopt) {
300                                 /* Override the default, and drop it from the
301                                  * options list.
302                                  */
303                                 ldef->data = l->data;
304                                 newopts = g_slist_remove(newopts, opt);
305                                 break;
306                         }
307                 }
308         }
309         /* Whatever is left in newopts wasn't in the default options. */
310         defopts = g_slist_concat(defopts, newopts);
311         g_slist_free(newopts);
312
313         if (profile->chip->scan)
314                 /* The DMM chip driver wants to do its own scanning. */
315                 devices = profile->chip->scan(defopts);
316         else
317                 devices = default_scan(defopts);
318         g_slist_free(defopts);
319
320         if (devices) {
321                 /* TODO: need to fix up sdi->index fields */
322                 for (l = devices; l; l = l->next) {
323                         /* The default connection-based scanner doesn't really
324                          * know about profiles, so it never filled in the vendor
325                          * or model. Do that now.
326                          */
327                         sdi = l->data;
328                         sdi->driver = gdi;
329                         if (!sdi->vendor)
330                                 sdi->vendor = g_strdup(profile->vendor);
331                         if (!sdi->model)
332                                 sdi->model = g_strdup(profile->model);
333                         /* Add a copy of these new devices to the driver instances. */
334                         drvc->instances = g_slist_append(drvc->instances, l->data);
335                 }
336         }
337
338         return devices;
339 }
340
341 static int hw_dev_open(struct sr_dev_inst *sdi)
342 {
343         struct dev_context *devc;
344
345         if (!(devc = sdi->priv)) {
346                 sr_err("genericdmm: sdi->priv was NULL.");
347                 return SR_ERR_BUG;
348         }
349
350         sr_dbg("genericdmm: Opening serial port '%s'.", devc->serial->port);
351
352         switch (devc->profile->transport) {
353         case DMM_TRANSPORT_USBHID:
354                 /* TODO */
355                 break;
356         case DMM_TRANSPORT_SERIAL:
357                 /* TODO: O_NONBLOCK? */
358                 devc->serial->fd = serial_open(devc->serial->port, O_RDWR | O_NONBLOCK);
359                 if (devc->serial->fd == -1) {
360                         sr_err("genericdmm: Couldn't open serial port '%s'.",
361                                devc->serial->port);
362                         return SR_ERR;
363                 }
364                 //      serial_set_params(devc->serial->fd, 2400, 8, 0, 1, 2);
365                 break;
366         default:
367                 sr_err("No transport set.");
368         }
369
370         return SR_OK;
371 }
372
373 static int hw_dev_close(struct sr_dev_inst *sdi)
374 {
375         struct dev_context *devc;
376
377         if (!(devc = sdi->priv)) {
378                 sr_err("genericdmm: %s: sdi->priv was NULL.", __func__);
379                 return SR_ERR_BUG;
380         }
381
382         switch (devc->profile->transport) {
383         case DMM_TRANSPORT_USBHID:
384                 /* TODO */
385                 break;
386         case DMM_TRANSPORT_SERIAL:
387                 if (devc->serial && devc->serial->fd != -1) {
388                         serial_close(devc->serial->fd);
389                         devc->serial->fd = -1;
390                         sdi->status = SR_ST_INACTIVE;
391                 }
392                 break;
393         }
394
395         return SR_OK;
396 }
397
398 static int hw_cleanup(void)
399 {
400         GSList *l;
401         struct sr_dev_inst *sdi;
402         struct dev_context *devc;
403         struct drv_context *drvc;
404
405         if (!(drvc = gdi->priv))
406                 return SR_OK;
407
408         /* Properly close and free all devices. */
409         for (l = drvc->instances; l; l = l->next) {
410                 if (!(sdi = l->data)) {
411                         /* Log error, but continue cleaning up the rest. */
412                         sr_err("genericdmm: sdi was NULL, continuing.");
413                         continue;
414                 }
415                 if (!(devc = sdi->priv)) {
416                         /* Log error, but continue cleaning up the rest. */
417                         sr_err("genericdmm: sdi->priv was NULL, continuing.");
418                         continue;
419                 }
420
421                 if (devc->profile) {
422                         switch (devc->profile->transport) {
423                         case DMM_TRANSPORT_USBHID:
424                                 /* TODO */
425                                 sr_usb_dev_inst_free(devc->usb);
426                                 break;
427                         case DMM_TRANSPORT_SERIAL:
428                                 if (devc->serial && devc->serial->fd != -1)
429                                         serial_close(devc->serial->fd);
430                                 sr_serial_dev_inst_free(devc->serial);
431                                 break;
432                         }
433                 }
434
435                 sr_dev_inst_free(sdi);
436         }
437
438         g_slist_free(drvc->instances);
439         drvc->instances = NULL;
440
441         if (genericdmm_usb_context)
442                 libusb_exit(genericdmm_usb_context);
443
444         return SR_OK;
445 }
446
447 static int hw_info_get(int info_id, const void **data,
448                 const struct sr_dev_inst *sdi)
449 {
450         struct dev_context *devc;
451
452         (void)sdi;
453         (void)devc;
454
455         switch (info_id) {
456         case SR_DI_HWOPTS:
457                 *data = hwopts;
458                 break;
459         case SR_DI_HWCAPS:
460                 *data = hwcaps;
461                 break;
462         case SR_DI_NUM_PROBES:
463                 *data = GINT_TO_POINTER(1);
464                 break;
465         case SR_DI_PROBE_NAMES:
466                 *data = probe_names;
467                 break;
468         case SR_DI_CUR_SAMPLERATE:
469                 /* TODO get rid of this */
470                 *data = NULL;
471                 break;
472         default:
473                 /* Unknown device info ID. */
474                 return SR_ERR_ARG;
475         }
476
477         return SR_OK;
478 }
479
480 static int hw_dev_config_set(const struct sr_dev_inst *sdi, int hwcap,
481                 const void *value)
482 {
483         struct dev_context *devc;
484
485         if (!(devc = sdi->priv)) {
486                 sr_err("genericdmm: sdi->priv was NULL.");
487                 return SR_ERR_BUG;
488         }
489
490         switch (hwcap) {
491         case SR_HWCAP_LIMIT_MSEC:
492                 if (*(const uint64_t *)value == 0) {
493                         sr_err("genericdmm: LIMIT_MSEC can't be 0.");
494                         return SR_ERR;
495                 }
496                 devc->limit_msec = *(const uint64_t *)value;
497                 sr_dbg("genericdmm: Setting LIMIT_MSEC to %" PRIu64 ".",
498                        devc->limit_msec);
499                 break;
500         case SR_HWCAP_LIMIT_SAMPLES:
501                 devc->limit_samples = *(const uint64_t *)value;
502                 sr_dbg("genericdmm: Setting LIMIT_SAMPLES to %" PRIu64 ".",
503                        devc->limit_samples);
504                 break;
505         default:
506                 sr_err("genericdmm: Unknown capability: %d.", hwcap);
507                 return SR_ERR;
508                 break;
509         }
510
511         return SR_OK;
512 }
513
514 static int receive_data(int fd, int revents, void *cb_data)
515 {
516         struct sr_dev_inst *sdi;
517         struct dev_context *devc;
518
519         if (!(sdi = cb_data))
520                 return FALSE;
521
522         if (!(devc = sdi->priv))
523                 return FALSE;
524
525         if (revents != G_IO_IN) {
526                 sr_err("genericdmm: No data?");
527                 return FALSE;
528         }
529
530         switch (devc->profile->transport) {
531         case DMM_TRANSPORT_USBHID:
532                 /* TODO */
533                 break;
534         case DMM_TRANSPORT_SERIAL:
535                 /* TODO */
536                 break;
537         }
538
539         return TRUE;
540 }
541
542 static int hw_dev_acquisition_start(const struct sr_dev_inst *sdi,
543                 void *cb_data)
544 {
545         struct sr_datafeed_packet packet;
546         struct sr_datafeed_header header;
547         struct sr_datafeed_meta_analog meta;
548         struct dev_context *devc;
549
550         if (!(devc = sdi->priv)) {
551                 sr_err("genericdmm: sdi->priv was NULL.");
552                 return SR_ERR_BUG;
553         }
554
555         sr_dbg("genericdmm: Starting acquisition.");
556
557         devc->cb_data = cb_data;
558
559         /* Send header packet to the session bus. */
560         sr_dbg("genericdmm: Sending SR_DF_HEADER.");
561         packet.type = SR_DF_HEADER;
562         packet.payload = (uint8_t *)&header;
563         header.feed_version = 1;
564         gettimeofday(&header.starttime, NULL);
565         sr_session_send(devc->cb_data, &packet);
566
567         /* Send metadata about the SR_DF_ANALOG packets to come. */
568         sr_dbg("genericdmm: Sending SR_DF_META_ANALOG.");
569         packet.type = SR_DF_META_ANALOG;
570         packet.payload = &meta;
571         meta.num_probes = 1;
572         sr_session_send(devc->cb_data, &packet);
573
574         /* Hook up a proxy handler to receive data from the device. */
575         switch (devc->profile->transport) {
576         case DMM_TRANSPORT_USBHID:
577                 /* TODO libusb FD setup */
578                 break;
579         case DMM_TRANSPORT_SERIAL:
580                 /* TODO serial FD setup */
581                 // sr_source_add(devc->serial->fd, G_IO_IN, -1, receive_data, sdi);
582                 break;
583         }
584
585         return SR_OK;
586 }
587
588 static int hw_dev_acquisition_stop(const struct sr_dev_inst *sdi,
589                 void *cb_data)
590 {
591         struct sr_datafeed_packet packet;
592
593         /* Avoid compiler warnings. */
594         (void)sdi;
595
596         sr_dbg("genericdmm: Stopping acquisition.");
597
598         /* Send end packet to the session bus. */
599         sr_dbg("genericdmm: Sending SR_DF_END.");
600         packet.type = SR_DF_END;
601         sr_session_send(cb_data, &packet);
602
603         return SR_OK;
604 }
605
606 SR_PRIV struct sr_dev_driver genericdmm_driver_info = {
607         .name = "genericdmm",
608         .longname = "Generic DMM",
609         .api_version = 1,
610         .init = hw_init,
611         .cleanup = hw_cleanup,
612         .scan = hw_scan,
613         .dev_open = hw_dev_open,
614         .dev_close = hw_dev_close,
615         .info_get = hw_info_get,
616         .dev_config_set = hw_dev_config_set,
617         .dev_acquisition_start = hw_dev_acquisition_start,
618         .dev_acquisition_stop = hw_dev_acquisition_stop,
619         .priv = NULL,
620 };