2 * This file is part of the libsigrok project.
4 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
24 #include <libsigrok/libsigrok.h>
25 #include "libsigrok-internal.h"
29 #define LOG_PREFIX "device"
35 * Device handling in libsigrok.
39 * @defgroup grp_devices Devices
41 * Device handling in libsigrok.
47 * Allocate and initialize a new struct sr_channel and add it to sdi.
49 * @param[in] sdi The device instance the channel is connected to.
51 * @param[in] index @copydoc sr_channel::index
52 * @param[in] type @copydoc sr_channel::type
53 * @param[in] enabled @copydoc sr_channel::enabled
54 * @param[in] name @copydoc sr_channel::name
56 * @return A new struct sr_channel*.
60 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
61 int index, int type, gboolean enabled, const char *name)
63 struct sr_channel *ch;
65 ch = g_malloc0(sizeof(*ch));
69 ch->enabled = enabled;
71 ch->name = g_strdup(name);
73 sdi->channels = g_slist_append(sdi->channels, ch);
79 * Release a previously allocated struct sr_channel.
81 * @param[in] ch Pointer to struct sr_channel.
85 SR_PRIV void sr_channel_free(struct sr_channel *ch)
95 * Wrapper around @ref sr_channel_free(), suitable for glib iterators.
99 SR_PRIV void sr_channel_free_cb(void *p)
105 * Set the name of the specified channel.
107 * If the channel already has a different name assigned to it, it will be
108 * removed, and the new name will be saved instead.
110 * @param[in] channel The channel whose name to set. Must not be NULL.
111 * @param[in] name The new name that the specified channel should get.
112 * A copy of the string is made.
114 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
118 SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
124 g_free(channel->name);
125 channel->name = g_strdup(name);
131 * Enable or disable a channel.
133 * @param[in] channel The channel to enable or disable. Must not be NULL.
134 * @param[in] state TRUE to enable the channel, FALSE to disable.
136 * @return SR_OK on success or SR_ERR on failure. In case of invalid
137 * arguments, SR_ERR_ARG is returned and the channel enabled state
142 SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state)
145 gboolean was_enabled;
146 struct sr_dev_inst *sdi;
152 was_enabled = channel->enabled;
153 channel->enabled = state;
154 if (!state != !was_enabled && sdi->driver
155 && sdi->driver->config_channel_set) {
156 ret = sdi->driver->config_channel_set(
157 sdi, channel, SR_CHANNEL_SET_ENABLED);
158 /* Roll back change if it wasn't applicable. */
167 * Returns the next enabled channel, wrapping around if necessary.
169 * @param[in] sdi The device instance the channel is connected to.
171 * @param[in] cur_channel The current channel.
173 * @return A pointer to the next enabled channel of this device.
177 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
178 struct sr_channel *cur_channel)
180 struct sr_channel *next_channel;
183 next_channel = cur_channel;
185 l = g_slist_find(sdi->channels, next_channel);
187 next_channel = l->next->data;
189 next_channel = sdi->channels->data;
190 } while (!next_channel->enabled);
196 * Compare two channels, return whether they differ.
198 * The channels' names and types are checked. The enabled state is not
199 * considered a condition for difference. The test is motivated by the
200 * desire to detect changes in the configuration of acquisition setups
201 * between re-reads of an input file.
203 * @param[in] ch1 First channel.
204 * @param[in] ch2 Second channel.
206 * @return #TRUE upon differences or unexpected input, #FALSE otherwise.
210 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2)
215 if (ch1->type != ch2->type)
217 if (strcmp(ch1->name, ch2->name))
224 * Compare two channel lists, return whether they differ.
226 * Listing the same set of channels but in a different order is considered
227 * a difference in the lists.
229 * @param[in] l1 First channel list.
230 * @param[in] l2 Second channel list.
232 * @return #TRUE upon differences or unexpected input, #FALSE otherwise.
236 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2)
238 struct sr_channel *ch1, *ch2;
247 if (sr_channels_differ(ch1, ch2))
249 if (ch1->index != ch2->index)
259 * Determine whether the specified device instance has the specified
262 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
263 * If the device's 'driver' field is NULL (virtual device), this
264 * function will always return FALSE (virtual devices don't have
265 * a hardware capabilities list).
266 * @param[in] key The option that should be checked for is supported by the
269 * @retval TRUE Device has the specified option.
270 * @retval FALSE Device does not have the specified option, invalid input
271 * parameters or other error conditions.
275 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
282 if (!sdi || !sdi->driver || !sdi->driver->config_list)
285 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
286 &gvar, sdi, NULL) != SR_OK)
290 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
291 for (i = 0; i < num_opts; i++) {
292 if ((devopts[i] & SR_CONF_MASK) == key) {
297 g_variant_unref(gvar);
303 * Enumerate the configuration options of the specified item.
305 * @param driver Pointer to the driver to be checked. Must not be NULL.
306 * @param sdi Pointer to the device instance to be checked. May be NULL to
307 * check driver options.
308 * @param cg Pointer to a channel group, if a specific channel group is to
309 * be checked. Must be NULL to check device-wide options.
311 * @return A GArray * of enum sr_configkey values, or NULL on invalid
312 * arguments. The array must be freed by the caller using
317 SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
318 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
321 const uint32_t *opts;
326 if (!driver || !driver->config_list)
329 if (sdi && sdi->driver != driver)
332 if (driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, sdi, cg) != SR_OK)
335 opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
337 result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
339 for (i = 0; i < num_opts; i++) {
340 opt = opts[i] & SR_CONF_MASK;
341 g_array_insert_val(result, i, opt);
344 g_variant_unref(gvar);
350 * Enumerate the configuration capabilities supported by a device instance
351 * for a given configuration key.
353 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
354 * If the device's 'driver' field is NULL (virtual device), this
355 * function will always return FALSE (virtual devices don't have
356 * a hardware capabilities list).
357 * @param cg Pointer to a channel group, if a specific channel group is to
358 * be checked. Must be NULL to check device-wide options.
359 * @param[in] key The option that should be checked for is supported by the
362 * @retval A bitmask of enum sr_configcap values, which will be zero for
363 * invalid inputs or if the key is unsupported.
367 SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
368 const struct sr_channel_group *cg, const int key)
375 if (!sdi || !sdi->driver || !sdi->driver->config_list)
378 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
379 &gvar, sdi, cg) != SR_OK)
383 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
384 for (i = 0; i < num_opts; i++) {
385 if ((devopts[i] & SR_CONF_MASK) == key) {
386 ret = devopts[i] & ~SR_CONF_MASK;
390 g_variant_unref(gvar);
396 * Allocate and init a new user-generated device instance.
398 * @param vendor Device vendor.
399 * @param model Device model.
400 * @param version Device version.
402 * @retval struct sr_dev_inst *. Dynamically allocated, free using
403 * sr_dev_inst_free().
405 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
406 const char *model, const char *version)
408 struct sr_dev_inst *sdi;
410 sdi = g_malloc0(sizeof(*sdi));
412 sdi->vendor = g_strdup(vendor);
413 sdi->model = g_strdup(model);
414 sdi->version = g_strdup(version);
415 sdi->inst_type = SR_INST_USER;
421 * Add a new channel to the specified device instance.
423 * @param[in] index @copydoc sr_channel::index
424 * @param[in] type @copydoc sr_channel::type
425 * @param[in] name @copydoc sr_channel::name
427 * @return SR_OK Success.
428 * @return SR_OK Invalid argument.
430 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
432 if (!sdi || sdi->inst_type != SR_INST_USER || index < 0)
435 sr_channel_new(sdi, index, type, TRUE, name);
441 * Free device instance struct created by sr_dev_inst().
443 * @param sdi Device instance to free. If NULL, the function will do nothing.
447 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
449 struct sr_channel *ch;
450 struct sr_channel_group *cg;
456 for (l = sdi->channels; l; l = l->next) {
460 g_slist_free(sdi->channels);
462 for (l = sdi->channel_groups; l; l = l->next) {
465 g_slist_free(cg->channels);
469 g_slist_free(sdi->channel_groups);
472 sr_session_dev_remove(sdi->session, sdi);
476 g_free(sdi->version);
477 g_free(sdi->serial_num);
478 g_free(sdi->connection_id);
482 #ifdef HAVE_LIBUSB_1_0
485 * Allocate and init a struct for a USB device instance.
487 * @param[in] bus @copydoc sr_usb_dev_inst::bus
488 * @param[in] address @copydoc sr_usb_dev_inst::address
489 * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
491 * @return The struct sr_usb_dev_inst * for USB device instance.
495 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
496 uint8_t address, struct libusb_device_handle *hdl)
498 struct sr_usb_dev_inst *udi;
500 udi = g_malloc0(sizeof(*udi));
502 udi->address = address;
509 * Free struct sr_usb_dev_inst * allocated by sr_usb_dev_inst().
511 * @param usb The struct sr_usb_dev_inst * to free. If NULL, this
512 * function does nothing.
516 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
523 #ifdef HAVE_SERIAL_COMM
526 * Allocate and init a struct for a serial device instance.
528 * Both parameters are copied to newly allocated strings, and freed
529 * automatically by sr_serial_dev_inst_free().
531 * @param[in] port OS-specific serial port specification. Examples:
532 * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
534 * @param[in] serialcomm A serial communication parameters string, in the form
535 * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
536 * "9600/8n1" or "600/7o2". This is an optional parameter;
537 * it may be filled in later. Can be NULL.
539 * @return A pointer to a newly initialized struct sr_serial_dev_inst,
544 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
545 const char *serialcomm)
547 struct sr_serial_dev_inst *serial;
549 serial = g_malloc0(sizeof(*serial));
550 serial->port = g_strdup(port);
552 serial->serialcomm = g_strdup(serialcomm);
558 * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
560 * @param serial The struct sr_serial_dev_inst * to free. If NULL, this
561 * function will do nothing.
565 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
570 g_free(serial->port);
571 g_free(serial->serialcomm);
577 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
579 struct sr_usbtmc_dev_inst *usbtmc;
581 usbtmc = g_malloc0(sizeof(*usbtmc));
582 usbtmc->device = g_strdup(device);
589 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
594 g_free(usbtmc->device);
599 * Get the list of devices/instances of the specified driver.
601 * @param driver The driver to use. Must not be NULL.
603 * @return The list of devices/instances of this driver, or NULL upon errors
604 * or if the list is empty.
608 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
610 if (driver && driver->dev_list)
611 return driver->dev_list(driver);
617 * Clear the list of device instances a driver knows about.
619 * @param driver The driver to use. This must be a pointer to one of
620 * the entries returned by sr_driver_list(). Must not be NULL.
622 * @retval SR_OK Success.
623 * @retval SR_ERR_ARG Invalid driver.
627 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
630 sr_err("Invalid driver.");
634 if (!driver->context) {
636 * Driver was never initialized, nothing to do.
638 * No log message since this usually gets called for all
639 * drivers, whether they were initialized or not.
644 /* No log message here, too verbose and not very useful. */
646 return driver->dev_clear(driver);
650 * Open the specified device instance.
652 * If the device instance is already open (sdi->status == SR_ST_ACTIVE),
653 * SR_ERR will be returned and no re-opening of the device will be attempted.
655 * If opening was successful, sdi->status is set to SR_ST_ACTIVE, otherwise
656 * it will be left unchanged.
658 * @param sdi Device instance to use. Must not be NULL.
660 * @retval SR_OK Success.
661 * @retval SR_ERR_ARG Invalid arguments.
662 * @retval SR_ERR Device instance was already active, or other error.
666 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
670 if (!sdi || !sdi->driver || !sdi->driver->dev_open)
673 if (sdi->status == SR_ST_ACTIVE) {
674 sr_err("%s: Device instance already active, can't re-open.",
679 sr_dbg("%s: Opening device instance.", sdi->driver->name);
681 ret = sdi->driver->dev_open(sdi);
684 sdi->status = SR_ST_ACTIVE;
690 * Close the specified device instance.
692 * If the device instance is not open (sdi->status != SR_ST_ACTIVE),
693 * SR_ERR_DEV_CLOSED will be returned and no closing will be attempted.
695 * Note: sdi->status will be set to SR_ST_INACTIVE, regardless of whether
696 * there are any errors during closing of the device instance (any errors
697 * will be reported via error code and log message, though).
699 * @param sdi Device instance to use. Must not be NULL.
701 * @retval SR_OK Success.
702 * @retval SR_ERR_ARG Invalid arguments.
703 * @retval SR_ERR_DEV_CLOSED Device instance was not active.
704 * @retval SR_ERR Other error.
708 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
710 if (!sdi || !sdi->driver || !sdi->driver->dev_close)
713 if (sdi->status != SR_ST_ACTIVE) {
714 sr_err("%s: Device instance not active, can't close.",
716 return SR_ERR_DEV_CLOSED;
719 sdi->status = SR_ST_INACTIVE;
721 sr_dbg("%s: Closing device instance.", sdi->driver->name);
723 return sdi->driver->dev_close(sdi);
727 * Queries a device instances' driver.
729 * @param sdi Device instance to use. Must not be NULL.
731 * @return The driver instance or NULL on error.
733 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi)
735 if (!sdi || !sdi->driver)
742 * Queries a device instances' vendor.
744 * @param sdi Device instance to use. Must not be NULL.
746 * @return The vendor string or NULL.
748 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi)
757 * Queries a device instances' model.
759 * @param sdi Device instance to use. Must not be NULL.
761 * @return The model string or NULL.
763 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi)
772 * Queries a device instances' version.
774 * @param sdi Device instance to use. Must not be NULL.
776 * @return The version string or NULL.
778 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi)
787 * Queries a device instances' serial number.
789 * @param sdi Device instance to use. Must not be NULL.
791 * @return The serial number string or NULL.
793 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
798 return sdi->serial_num;
802 * Queries a device instances' connection identifier.
804 * @param sdi Device instance to use. Must not be NULL.
806 * @return A copy of the connection ID string or NULL. The caller is responsible
807 * for g_free()ing the string when it is no longer needed.
809 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
811 #ifdef HAVE_LIBUSB_1_0
812 struct drv_context *drvc;
814 char conn_id_usb[64];
815 struct sr_usb_dev_inst *usb;
816 struct libusb_device **devlist;
819 #ifdef HAVE_SERIAL_COMM
820 struct sr_serial_dev_inst *serial;
823 struct sr_scpi_dev_inst *scpi;
829 #ifdef HAVE_SERIAL_COMM
830 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) {
831 /* connection_id isn't populated, let's do that for serial devices. */
834 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(serial->port);
838 #ifdef HAVE_LIBUSB_1_0
839 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
840 /* connection_id isn't populated, let's do that for USB devices. */
842 drvc = sdi->driver->context;
845 if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {
846 sr_err("Failed to retrieve device list: %s.",
847 libusb_error_name(cnt));
851 for (i = 0; i < cnt; i++) {
852 /* Find the USB device by the logical address we know. */
853 b = libusb_get_bus_number(devlist[i]);
854 a = libusb_get_device_address(devlist[i]);
855 if (b != usb->bus || a != usb->address)
858 if (usb_get_port_path(devlist[i], conn_id_usb, sizeof(conn_id_usb)) < 0)
861 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_usb);
865 libusb_free_device_list(devlist, 1);
869 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SCPI)) {
870 /* connection_id isn't populated, let's do that for SCPI devices. */
873 sr_scpi_connection_id(scpi, &conn_id_scpi);
874 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_scpi);
875 g_free(conn_id_scpi);
878 return sdi->connection_id;
882 * Queries a device instances' channel list.
884 * @param sdi Device instance to use. Must not be NULL.
886 * @return The GSList of channels or NULL.
888 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi)
893 return sdi->channels;
897 * Queries a device instances' channel groups list.
899 * @param sdi Device instance to use. Must not be NULL.
901 * @return The GSList of channel groups or NULL.
903 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi)
908 return sdi->channel_groups;