]> sigrok.org Git - libsigrok.git/blob - src/device.c
sr_dev_inst_free(): Allow NULL as argument.
[libsigrok.git] / src / device.c
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
5  *
6  * This program is free software: you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation, either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <stdio.h>
22 #include <glib.h>
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
25
26 /** @cond PRIVATE */
27 #define LOG_PREFIX "device"
28 /** @endcond */
29
30 /**
31  * @file
32  *
33  * Device handling in libsigrok.
34  */
35
36 /**
37  * @defgroup grp_devices Devices
38  *
39  * Device handling in libsigrok.
40  *
41  * @{
42  */
43
44 /**
45  * Allocate and initialize a new struct sr_channel and add it to sdi.
46  *
47  * @param[in] sdi The device instance the channel is connected to.
48  *                Must not be NULL.
49  * @param[in] index @copydoc sr_channel::index
50  * @param[in] type @copydoc sr_channel::type
51  * @param[in] enabled @copydoc sr_channel::enabled
52  * @param[in] name @copydoc sr_channel::name
53  *
54  * @return A new struct sr_channel*.
55  *
56  * @private
57  */
58 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
59                 int index, int type, gboolean enabled, const char *name)
60 {
61         struct sr_channel *ch;
62
63         ch = g_malloc0(sizeof(struct sr_channel));
64         ch->sdi = sdi;
65         ch->index = index;
66         ch->type = type;
67         ch->enabled = enabled;
68         if (name)
69                 ch->name = g_strdup(name);
70
71         sdi->channels = g_slist_append(sdi->channels, ch);
72
73         return ch;
74 }
75
76 /**
77  * Set the name of the specified channel.
78  *
79  * If the channel already has a different name assigned to it, it will be
80  * removed, and the new name will be saved instead.
81  *
82  * @param[in] channel The channel whose name to set. Must not be NULL.
83  * @param[in] name The new name that the specified channel should get.
84  *                 A copy of the string is made.
85  *
86  * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
87  *
88  * @since 0.3.0
89  */
90 SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
91                 const char *name)
92 {
93         if (!channel)
94                 return SR_ERR_ARG;
95
96         g_free(channel->name);
97         channel->name = g_strdup(name);
98
99         return SR_OK;
100 }
101
102 /**
103  * Enable or disable a channel.
104  *
105  * @param[in] channel The channel to enable or disable. Must not be NULL.
106  * @param[in] state TRUE to enable the channel, FALSE to disable.
107  *
108  * @return SR_OK on success or SR_ERR on failure. In case of invalid
109  *         arguments, SR_ERR_ARG is returned and the channel enabled state
110  *         remains unchanged.
111  *
112  * @since 0.3.0
113  */
114 SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state)
115 {
116         int ret;
117         gboolean was_enabled;
118         struct sr_dev_inst *sdi;
119
120         if (!channel)
121                 return SR_ERR_ARG;
122
123         sdi = channel->sdi;
124         was_enabled = channel->enabled;
125         channel->enabled = state;
126         if (!state != !was_enabled && sdi->driver
127                         && sdi->driver->config_channel_set) {
128                 ret = sdi->driver->config_channel_set(
129                         sdi, channel, SR_CHANNEL_SET_ENABLED);
130                 /* Roll back change if it wasn't applicable. */
131                 if (ret != SR_OK)
132                         return ret;
133         }
134
135         return SR_OK;
136 }
137
138 /* Returns the next enabled channel, wrapping around if necessary. */
139 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
140                 struct sr_channel *cur_channel)
141 {
142         struct sr_channel *next_channel;
143         GSList *l;
144
145         next_channel = cur_channel;
146         do {
147                 l = g_slist_find(sdi->channels, next_channel);
148                 if (l && l->next)
149                         next_channel = l->next->data;
150                 else
151                         next_channel = sdi->channels->data;
152         } while (!next_channel->enabled);
153
154         return next_channel;
155 }
156
157 /**
158  * Determine whether the specified device instance has the specified
159  * capability.
160  *
161  * @param sdi Pointer to the device instance to be checked. Must not be NULL.
162  *            If the device's 'driver' field is NULL (virtual device), this
163  *            function will always return FALSE (virtual devices don't have
164  *            a hardware capabilities list).
165  * @param[in] key The option that should be checked for is supported by the
166  *            specified device.
167  *
168  * @retval TRUE Device has the specified option.
169  * @retval FALSE Device does not have the specified option, invalid input
170  *         parameters or other error conditions.
171  *
172  * @since 0.2.0
173  */
174 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
175 {
176         GVariant *gvar;
177         const int *devopts;
178         gsize num_opts, i;
179         int ret;
180
181         if (!sdi || !sdi->driver || !sdi->driver->config_list)
182                 return FALSE;
183
184         if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
185                                 &gvar, sdi, NULL) != SR_OK)
186                 return FALSE;
187
188         ret = FALSE;
189         devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
190         for (i = 0; i < num_opts; i++) {
191                 if ((devopts[i] & SR_CONF_MASK) == key) {
192                         ret = TRUE;
193                         break;
194                 }
195         }
196         g_variant_unref(gvar);
197
198         return ret;
199 }
200
201 /**
202  * Enumerate the configuration options of the specified item.
203  *
204  * @param driver Pointer to the driver to be checked. Must not be NULL.
205  * @param sdi Pointer to the device instance to be checked. May be NULL to
206  *            check driver options.
207  * @param cg Pointer to a channel group, if a specific channel group is to
208  *           be checked. Must be NULL to check device-wide options.
209  *
210  * @return A GArray * of enum sr_configkey values, or NULL on invalid
211  *         arguments. The array must be freed by the caller using
212  *         g_array_free().
213  *
214  * @since 0.4.0
215  */
216 SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
217         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
218 {
219         GVariant *gvar;
220         const uint32_t *opts;
221         uint32_t opt;
222         gsize num_opts, i;
223         GArray *result;
224
225         if (!driver || !driver->config_list)
226                 return NULL;
227
228         if (sdi && sdi->driver != driver)
229                 return NULL;
230
231         if (driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, sdi, cg) != SR_OK)
232                 return NULL;
233
234         opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
235
236         result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
237
238         for (i = 0; i < num_opts; i++) {
239                 opt = opts[i] & SR_CONF_MASK;
240                 g_array_insert_val(result, i, opt);
241         }
242
243         g_variant_unref(gvar);
244
245         return result;
246 }
247
248 /**
249  * Enumerate the configuration capabilities supported by a device instance
250  * for a given configuration key.
251  *
252  * @param sdi Pointer to the device instance to be checked. Must not be NULL.
253  *            If the device's 'driver' field is NULL (virtual device), this
254  *            function will always return FALSE (virtual devices don't have
255  *            a hardware capabilities list).
256  * @param cg Pointer to a channel group, if a specific channel group is to
257  *           be checked. Must be NULL to check device-wide options.
258  * @param[in] key The option that should be checked for is supported by the
259  *            specified device.
260  *
261  * @retval A bitmask of enum sr_configcap values, which will be zero for
262  *         invalid inputs or if the key is unsupported.
263  *
264  * @since 0.4.0
265  */
266 SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
267                 const struct sr_channel_group *cg, const int key)
268 {
269         GVariant *gvar;
270         const int *devopts;
271         gsize num_opts, i;
272         int ret;
273
274         if (!sdi || !sdi->driver || !sdi->driver->config_list)
275                 return 0;
276
277         if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
278                                 &gvar, sdi, cg) != SR_OK)
279                 return 0;
280
281         ret = 0;
282         devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
283         for (i = 0; i < num_opts; i++) {
284                 if ((devopts[i] & SR_CONF_MASK) == key) {
285                         ret = devopts[i] & ~SR_CONF_MASK;
286                         break;
287                 }
288         }
289         g_variant_unref(gvar);
290
291         return ret;
292 }
293
294 /**
295  * Allocate and init a new user-generated device instance.
296  *
297  * @param vendor Device vendor.
298  * @param model Device model.
299  * @param version Device version.
300  *
301  * @retval struct sr_dev_inst *. Dynamically allocated, free using
302  *         sr_dev_inst_free().
303  */
304 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
305                 const char *model, const char *version)
306 {
307         struct sr_dev_inst *sdi;
308
309         sdi = g_malloc0(sizeof(struct sr_dev_inst));
310
311         sdi->vendor = g_strdup(vendor);
312         sdi->model = g_strdup(model);
313         sdi->version = g_strdup(version);
314         sdi->inst_type = SR_INST_USER;
315
316         return sdi;
317 }
318
319 /**
320  * Add a new channel to the specified device instance.
321  *
322  * @param[in] index @copydoc sr_channel::index
323  * @param[in] type @copydoc sr_channel::type
324  * @param[in] name @copydoc sr_channel::name
325  *
326  * @return SR_OK Success.
327  * @return SR_OK Invalid argument.
328  */
329 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
330 {
331         if (!sdi || sdi->inst_type != SR_INST_USER || index < 0)
332                 return SR_ERR_ARG;
333
334         sr_channel_new(sdi, index, type, TRUE, name);
335
336         return SR_OK;
337 }
338
339 /**
340  * Free device instance struct created by sr_dev_inst().
341  *
342  * @param sdi Device instance to free. If NULL, the function will do nothing.
343  *
344  * @private
345  */
346 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
347 {
348         struct sr_channel *ch;
349         struct sr_channel_group *cg;
350         GSList *l;
351
352         if (!sdi)
353                 return;
354
355         for (l = sdi->channels; l; l = l->next) {
356                 ch = l->data;
357                 g_free(ch->name);
358                 g_free(ch->priv);
359                 g_free(ch);
360         }
361         g_slist_free(sdi->channels);
362
363         for (l = sdi->channel_groups; l; l = l->next) {
364                 cg = l->data;
365                 g_free(cg->name);
366                 g_slist_free(cg->channels);
367                 g_free(cg->priv);
368                 g_free(cg);
369         }
370         g_slist_free(sdi->channel_groups);
371
372         if (sdi->session)
373                 sr_session_dev_remove(sdi->session, sdi);
374
375         g_free(sdi->vendor);
376         g_free(sdi->model);
377         g_free(sdi->version);
378         g_free(sdi->serial_num);
379         g_free(sdi->connection_id);
380         g_free(sdi);
381 }
382
383 #ifdef HAVE_LIBUSB_1_0
384
385 /**
386  * Allocate and init a struct for a USB device instance.
387  *
388  * @param[in] bus @copydoc sr_usb_dev_inst::bus
389  * @param[in] address @copydoc sr_usb_dev_inst::address
390  * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
391  *
392  * @return The struct sr_usb_dev_inst * for USB device instance.
393  *
394  * @private
395  */
396 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
397                         uint8_t address, struct libusb_device_handle *hdl)
398 {
399         struct sr_usb_dev_inst *udi;
400
401         udi = g_malloc0(sizeof(struct sr_usb_dev_inst));
402         udi->bus = bus;
403         udi->address = address;
404         udi->devhdl = hdl;
405
406         return udi;
407 }
408
409 /**
410  * Free struct sr_usb_dev_inst * allocated by sr_usb_dev_inst().
411  *
412  * @param usb The struct sr_usb_dev_inst * to free. Must not be NULL.
413  *
414  * @private
415  */
416 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
417 {
418         g_free(usb);
419 }
420
421 #endif
422
423 #ifdef HAVE_LIBSERIALPORT
424
425 /**
426  * Allocate and init a struct for a serial device instance.
427  *
428  * Both parameters are copied to newly allocated strings, and freed
429  * automatically by sr_serial_dev_inst_free().
430  *
431  * @param[in] port OS-specific serial port specification. Examples:
432  *                 "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
433  *                 Must not be NULL.
434  * @param[in] serialcomm A serial communication parameters string, in the form
435  *              of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
436  *              "9600/8n1" or "600/7o2". This is an optional parameter;
437  *              it may be filled in later. Can be NULL.
438  *
439  * @return A pointer to a newly initialized struct sr_serial_dev_inst,
440  *         or NULL on error.
441  *
442  * @private
443  */
444 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
445                 const char *serialcomm)
446 {
447         struct sr_serial_dev_inst *serial;
448
449         serial = g_malloc0(sizeof(struct sr_serial_dev_inst));
450         serial->port = g_strdup(port);
451         if (serialcomm)
452                 serial->serialcomm = g_strdup(serialcomm);
453
454         return serial;
455 }
456
457 /**
458  * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
459  *
460  * @param serial The struct sr_serial_dev_inst * to free. Must not be NULL.
461  *
462  * @private
463  */
464 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
465 {
466         g_free(serial->port);
467         g_free(serial->serialcomm);
468         g_free(serial);
469 }
470 #endif
471
472 /** @private */
473 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
474 {
475         struct sr_usbtmc_dev_inst *usbtmc;
476
477         usbtmc = g_malloc0(sizeof(struct sr_usbtmc_dev_inst));
478         usbtmc->device = g_strdup(device);
479         usbtmc->fd = -1;
480
481         return usbtmc;
482 }
483
484 /** @private */
485 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
486 {
487         g_free(usbtmc->device);
488         g_free(usbtmc);
489 }
490
491 /**
492  * Get the list of devices/instances of the specified driver.
493  *
494  * @param driver The driver to use. Must not be NULL.
495  *
496  * @return The list of devices/instances of this driver, or NULL upon errors
497  *         or if the list is empty.
498  *
499  * @since 0.2.0
500  */
501 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
502 {
503         if (driver && driver->dev_list)
504                 return driver->dev_list(driver);
505         else
506                 return NULL;
507 }
508
509 /**
510  * Clear the list of device instances a driver knows about.
511  *
512  * @param driver The driver to use. This must be a pointer to one of
513  *               the entries returned by sr_driver_list(). Must not be NULL.
514  *
515  * @retval SR_OK Success.
516  * @retval SR_ERR_ARG Invalid driver.
517  *
518  * @since 0.2.0
519  */
520 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
521 {
522         int ret;
523
524         if (!driver) {
525                 sr_err("Invalid driver.");
526                 return SR_ERR_ARG;
527         }
528
529         if (driver->dev_clear)
530                 ret = driver->dev_clear(driver);
531         else
532                 ret = std_dev_clear(driver, NULL);
533
534         return ret;
535 }
536
537 /**
538  * Open the specified device.
539  *
540  * @param sdi Device instance to use. Must not be NULL.
541  *
542  * @return SR_OK upon success, a negative error code upon errors.
543  *
544  * @since 0.2.0
545  */
546 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
547 {
548         int ret;
549
550         if (!sdi || !sdi->driver || !sdi->driver->dev_open)
551                 return SR_ERR;
552
553         ret = sdi->driver->dev_open(sdi);
554
555         return ret;
556 }
557
558 /**
559  * Close the specified device.
560  *
561  * @param sdi Device instance to use. Must not be NULL.
562  *
563  * @return SR_OK upon success, a negative error code upon errors.
564  *
565  * @since 0.2.0
566  */
567 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
568 {
569         int ret;
570
571         if (!sdi || !sdi->driver || !sdi->driver->dev_close)
572                 return SR_ERR;
573
574         ret = sdi->driver->dev_close(sdi);
575
576         return ret;
577 }
578
579 /**
580  * Queries a device instances' driver.
581  *
582  * @param sdi Device instance to use. Must not be NULL.
583  *
584  * @return The driver instance or NULL on error.
585  */
586 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi)
587 {
588         if (!sdi || !sdi->driver)
589                 return NULL;
590
591         return sdi->driver;
592 }
593
594 /**
595  * Queries a device instances' vendor.
596  *
597  * @param sdi Device instance to use. Must not be NULL.
598  *
599  * @return The vendor string or NULL.
600  */
601 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi)
602 {
603         if (!sdi)
604                 return NULL;
605
606         return sdi->vendor;
607 }
608
609 /**
610  * Queries a device instances' model.
611  *
612  * @param sdi Device instance to use. Must not be NULL.
613  *
614  * @return The model string or NULL.
615  */
616 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi)
617 {
618         if (!sdi)
619                 return NULL;
620
621         return sdi->model;
622 }
623
624 /**
625  * Queries a device instances' version.
626  *
627  * @param sdi Device instance to use. Must not be NULL.
628  *
629  * @return The version string or NULL.
630  */
631 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi)
632 {
633         if (!sdi)
634                 return NULL;
635
636         return sdi->version;
637 }
638
639 /**
640  * Queries a device instances' serial number.
641  *
642  * @param sdi Device instance to use. Must not be NULL.
643  *
644  * @return The serial number string or NULL.
645  */
646 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
647 {
648         if (!sdi)
649                 return NULL;
650
651         return sdi->serial_num;
652 }
653
654 /**
655  * Queries a device instances' connection identifier.
656  *
657  * @param sdi Device instance to use. Must not be NULL.
658  *
659  * @return A copy of the connection ID string or NULL. The caller is responsible
660  *         for g_free()ing the string when it is no longer needed.
661  */
662 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
663 {
664 #ifdef HAVE_LIBUSB_1_0
665         struct drv_context *drvc;
666         int cnt, i, a, b;
667         char connection_id[64];
668         struct sr_usb_dev_inst *usb;
669         struct libusb_device **devlist;
670 #endif
671
672         if (!sdi)
673                 return NULL;
674
675 #ifdef HAVE_LIBSERIALPORT
676         struct sr_serial_dev_inst *serial;
677
678         if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) {
679                 /* connection_id isn't populated, let's do that here. */
680
681                 serial = sdi->conn;
682                 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(serial->port);
683         }
684 #endif
685
686 #ifdef HAVE_LIBUSB_1_0
687         if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
688                 /* connection_id isn't populated, let's do that here. */
689
690                 drvc = sdi->driver->context;
691                 usb = sdi->conn;
692
693                 if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {
694                         sr_err("Failed to retrieve device list: %s.",
695                                libusb_error_name(cnt));
696                         return NULL;
697                 }
698
699                 for (i = 0; i < cnt; i++) {
700                         /* Find the USB device by the logical address we know. */
701                         b = libusb_get_bus_number(devlist[i]);
702                         a = libusb_get_device_address(devlist[i]);
703                         if (b != usb->bus || a != usb->address)
704                                 continue;
705
706                         usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
707                         ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(connection_id);
708                         break;
709                 }
710
711                 libusb_free_device_list(devlist, 1);
712         }
713 #endif
714
715         return sdi->connection_id;
716 }
717
718 /**
719  * Queries a device instances' channel list.
720  *
721  * @param sdi Device instance to use. Must not be NULL.
722  *
723  * @return The GSList of channels or NULL.
724  */
725 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi)
726 {
727         if (!sdi)
728                 return NULL;
729
730         return sdi->channels;
731 }
732
733 /**
734  * Queries a device instances' channel groups list.
735  *
736  * @param sdi Device instance to use. Must not be NULL.
737  *
738  * @return The GSList of channel groups or NULL.
739  */
740 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi)
741 {
742         if (!sdi)
743                 return NULL;
744
745         return sdi->channel_groups;
746 }
747
748 /** @} */