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 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,
126 g_free(channel->name);
127 channel->name = g_strdup(name);
133 * Enable or disable a channel.
135 * @param[in] channel The channel to enable or disable. Must not be NULL.
136 * @param[in] state TRUE to enable the channel, FALSE to disable.
138 * @return SR_OK on success or SR_ERR on failure. In case of invalid
139 * arguments, SR_ERR_ARG is returned and the channel enabled state
144 SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state)
147 gboolean was_enabled;
148 struct sr_dev_inst *sdi;
154 was_enabled = channel->enabled;
155 channel->enabled = state;
156 if (!state != !was_enabled && sdi->driver
157 && sdi->driver->config_channel_set) {
158 ret = sdi->driver->config_channel_set(
159 sdi, channel, SR_CHANNEL_SET_ENABLED);
160 /* Roll back change if it wasn't applicable. */
169 * Returns the next enabled channel, wrapping around if necessary.
171 * @param[in] sdi The device instance the channel is connected to.
173 * @param[in] cur_channel The current channel.
175 * @return A pointer to the next enabled channel of this device.
179 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
180 struct sr_channel *cur_channel)
182 struct sr_channel *next_channel;
185 next_channel = cur_channel;
187 l = g_slist_find(sdi->channels, next_channel);
189 next_channel = l->next->data;
191 next_channel = sdi->channels->data;
192 } while (!next_channel->enabled);
198 * Compare two channels, return whether they differ.
200 * The channels' names and types are checked. The enabled state is not
201 * considered a condition for difference. The test is motivated by the
202 * desire to detect changes in the configuration of acquisition setups
203 * between re-reads of an input file.
205 * @param[in] ch1 First channel.
206 * @param[in] ch2 Second channel.
208 * @return TRUE upon differences or unexpected input, FALSE otherwise.
212 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2)
217 if (ch1->type != ch2->type)
219 if (strcmp(ch1->name, ch2->name))
226 * Compare two channel lists, return whether they differ.
228 * Listing the same set of channels but in a different order is considered
229 * a difference in the lists.
231 * @param[in] l1 First channel list.
232 * @param[in] l2 Second channel list.
234 * @return TRUE upon differences or unexpected input, FALSE otherwise.
238 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2)
240 struct sr_channel *ch1, *ch2;
249 if (sr_channels_differ(ch1, ch2))
251 if (ch1->index != ch2->index)
261 * Allocate and initialize a new channel group, and add it to sdi.
263 * @param[in] sdi The device instance the channel group is connected to.
264 * Optional, can be NULL.
265 * @param[in] name @copydoc sr_channel_group::name
266 * @param[in] priv @copydoc sr_channel_group::priv
268 * @return A pointer to a new struct sr_channel_group, NULL upon error.
272 SR_PRIV struct sr_channel_group *sr_channel_group_new(struct sr_dev_inst *sdi,
273 const char *name, void *priv)
275 struct sr_channel_group *cg;
277 cg = g_malloc0(sizeof(*cg));
279 cg->name = g_strdup(name);
283 sdi->channel_groups = g_slist_append(sdi->channel_groups, cg);
289 * Release a previously allocated struct sr_channel_group.
291 * @param[in] cg Pointer to struct sr_channel_group.
295 SR_PRIV void sr_channel_group_free(struct sr_channel_group *cg)
301 g_slist_free(cg->channels);
307 * Wrapper around sr_channel_group_free(), suitable for glib iterators.
311 SR_PRIV void sr_channel_group_free_cb(void *cg)
313 return sr_channel_group_free(cg);
317 * Determine whether the specified device instance has the specified
320 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
321 * If the device's 'driver' field is NULL (virtual device), this
322 * function will always return FALSE (virtual devices don't have
323 * a hardware capabilities list).
324 * @param[in] key The option that should be checked for is supported by the
327 * @retval TRUE Device has the specified option.
328 * @retval FALSE Device does not have the specified option, invalid input
329 * parameters or other error conditions.
333 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
340 if (!sdi || !sdi->driver || !sdi->driver->config_list)
343 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
344 &gvar, sdi, NULL) != SR_OK)
348 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
349 for (i = 0; i < num_opts; i++) {
350 if ((devopts[i] & SR_CONF_MASK) == key) {
355 g_variant_unref(gvar);
361 * Enumerate the configuration options of the specified item.
363 * @param driver Pointer to the driver to be checked. Must not be NULL.
364 * @param sdi Pointer to the device instance to be checked. May be NULL to
365 * check driver options.
366 * @param cg Pointer to a channel group, if a specific channel group is to
367 * be checked. Must be NULL to check device-wide options.
369 * @return A GArray * of enum sr_configkey values, or NULL on invalid
370 * arguments. The array must be freed by the caller using
375 SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver,
376 const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
379 const uint32_t *opts;
384 if (!driver || !driver->config_list)
387 if (sdi && sdi->driver != driver)
390 if (driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, sdi, cg) != SR_OK)
393 opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
395 result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
397 for (i = 0; i < num_opts; i++) {
398 opt = opts[i] & SR_CONF_MASK;
399 g_array_insert_val(result, i, opt);
402 g_variant_unref(gvar);
408 * Enumerate the configuration capabilities supported by a device instance
409 * for a given configuration key.
411 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
412 * If the device's 'driver' field is NULL (virtual device), this
413 * function will always return FALSE (virtual devices don't have
414 * a hardware capabilities list).
415 * @param cg Pointer to a channel group, if a specific channel group is to
416 * be checked. Must be NULL to check device-wide options.
417 * @param[in] key The option that should be checked for is supported by the
420 * @retval A bitmask of enum sr_configcap values, which will be zero for
421 * invalid inputs or if the key is unsupported.
425 SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
426 const struct sr_channel_group *cg, const int key)
433 if (!sdi || !sdi->driver || !sdi->driver->config_list)
436 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
437 &gvar, sdi, cg) != SR_OK)
441 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
442 for (i = 0; i < num_opts; i++) {
443 if ((devopts[i] & SR_CONF_MASK) == key) {
444 ret = devopts[i] & ~SR_CONF_MASK;
448 g_variant_unref(gvar);
454 * Allocate and init a new user-generated device instance.
456 * @param vendor Device vendor.
457 * @param model Device model.
458 * @param version Device version.
460 * @retval struct sr_dev_inst *. Dynamically allocated, free using
461 * sr_dev_inst_free().
463 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
464 const char *model, const char *version)
466 struct sr_dev_inst *sdi;
468 sdi = g_malloc0(sizeof(*sdi));
470 sdi->vendor = g_strdup(vendor);
471 sdi->model = g_strdup(model);
472 sdi->version = g_strdup(version);
473 sdi->inst_type = SR_INST_USER;
479 * Add a new channel to the specified device instance.
481 * @param[in] sdi Device instance to use. Must not be NULL.
482 * @param[in] index @copydoc sr_channel::index
483 * @param[in] type @copydoc sr_channel::type
484 * @param[in] name @copydoc sr_channel::name
486 * @return SR_OK Success.
487 * @return SR_OK Invalid argument.
489 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
491 if (!sdi || sdi->inst_type != SR_INST_USER || index < 0)
494 if (!sr_channel_new(sdi, index, type, TRUE, name))
501 * Free device instance struct created by sr_dev_inst().
503 * @param sdi Device instance to free. If NULL, the function will do nothing.
507 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
509 struct sr_channel *ch;
515 for (l = sdi->channels; l; l = l->next) {
519 g_slist_free(sdi->channels);
520 g_slist_free_full(sdi->channel_groups, sr_channel_group_free_cb);
523 sr_session_dev_remove(sdi->session, sdi);
527 g_free(sdi->version);
528 g_free(sdi->serial_num);
529 g_free(sdi->connection_id);
533 #ifdef HAVE_LIBUSB_1_0
536 * Allocate and init a struct for a USB device instance.
538 * @param[in] bus @copydoc sr_usb_dev_inst::bus
539 * @param[in] address @copydoc sr_usb_dev_inst::address
540 * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
542 * @return The struct sr_usb_dev_inst * for USB device instance.
546 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
547 uint8_t address, struct libusb_device_handle *hdl)
549 struct sr_usb_dev_inst *udi;
551 udi = g_malloc0(sizeof(*udi));
553 udi->address = address;
560 * Free struct sr_usb_dev_inst * allocated by sr_usb_dev_inst().
562 * @param usb The struct sr_usb_dev_inst * to free. If NULL, this
563 * function does nothing.
567 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
573 * Wrapper for g_slist_free_full() convenience.
577 SR_PRIV void sr_usb_dev_inst_free_cb(gpointer p)
579 sr_usb_dev_inst_free(p);
583 #ifdef HAVE_SERIAL_COMM
586 * Allocate and init a struct for a serial device instance.
588 * Both parameters are copied to newly allocated strings, and freed
589 * automatically by sr_serial_dev_inst_free().
591 * @param[in] port OS-specific serial port specification. Examples:
592 * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
594 * @param[in] serialcomm A serial communication parameters string, in the form
595 * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
596 * "9600/8n1" or "600/7o2". This is an optional parameter;
597 * it may be filled in later. Can be NULL.
599 * @return A pointer to a newly initialized struct sr_serial_dev_inst,
604 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
605 const char *serialcomm)
607 struct sr_serial_dev_inst *serial;
609 serial = g_malloc0(sizeof(*serial));
610 serial->port = g_strdup(port);
612 serial->serialcomm = g_strdup(serialcomm);
618 * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
620 * @param serial The struct sr_serial_dev_inst * to free. If NULL, this
621 * function will do nothing.
625 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
630 g_free(serial->port);
631 g_free(serial->serialcomm);
637 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
639 struct sr_usbtmc_dev_inst *usbtmc;
641 usbtmc = g_malloc0(sizeof(*usbtmc));
642 usbtmc->device = g_strdup(device);
649 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
654 g_free(usbtmc->device);
659 * Get the list of devices/instances of the specified driver.
661 * @param driver The driver to use. Must not be NULL.
663 * @return The list of devices/instances of this driver, or NULL upon errors
664 * or if the list is empty.
668 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
670 if (driver && driver->dev_list)
671 return driver->dev_list(driver);
677 * Clear the list of device instances a driver knows about.
679 * @param driver The driver to use. This must be a pointer to one of
680 * the entries returned by sr_driver_list(). Must not be NULL.
682 * @retval SR_OK Success.
683 * @retval SR_ERR_ARG Invalid driver.
687 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
690 sr_err("Invalid driver.");
694 if (!driver->context) {
696 * Driver was never initialized, nothing to do.
698 * No log message since this usually gets called for all
699 * drivers, whether they were initialized or not.
704 /* No log message here, too verbose and not very useful. */
706 return driver->dev_clear(driver);
710 * Open the specified device instance.
712 * If the device instance is already open (sdi->status == SR_ST_ACTIVE),
713 * SR_ERR will be returned and no re-opening of the device will be attempted.
715 * If opening was successful, sdi->status is set to SR_ST_ACTIVE, otherwise
716 * it will be left unchanged.
718 * @param sdi Device instance to use. Must not be NULL.
720 * @retval SR_OK Success.
721 * @retval SR_ERR_ARG Invalid arguments.
722 * @retval SR_ERR Device instance was already active, or other error.
726 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
730 if (!sdi || !sdi->driver || !sdi->driver->dev_open)
733 if (sdi->status == SR_ST_ACTIVE) {
734 sr_err("%s: Device instance already active, can't re-open.",
739 sr_dbg("%s: Opening device instance.", sdi->driver->name);
741 ret = sdi->driver->dev_open(sdi);
744 sdi->status = SR_ST_ACTIVE;
750 * Close the specified device instance.
752 * If the device instance is not open (sdi->status != SR_ST_ACTIVE),
753 * SR_ERR_DEV_CLOSED will be returned and no closing will be attempted.
755 * Note: sdi->status will be set to SR_ST_INACTIVE, regardless of whether
756 * there are any errors during closing of the device instance (any errors
757 * will be reported via error code and log message, though).
759 * @param sdi Device instance to use. Must not be NULL.
761 * @retval SR_OK Success.
762 * @retval SR_ERR_ARG Invalid arguments.
763 * @retval SR_ERR_DEV_CLOSED Device instance was not active.
764 * @retval SR_ERR Other error.
768 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
770 if (!sdi || !sdi->driver || !sdi->driver->dev_close)
773 if (sdi->status != SR_ST_ACTIVE) {
774 sr_err("%s: Device instance not active, can't close.",
776 return SR_ERR_DEV_CLOSED;
779 sdi->status = SR_ST_INACTIVE;
781 sr_dbg("%s: Closing device instance.", sdi->driver->name);
783 return sdi->driver->dev_close(sdi);
787 * Queries a device instances' driver.
789 * @param sdi Device instance to use. Must not be NULL.
791 * @return The driver instance or NULL on error.
793 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi)
795 if (!sdi || !sdi->driver)
802 * Queries a device instances' vendor.
804 * @param sdi Device instance to use. Must not be NULL.
806 * @return The vendor string or NULL.
808 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi)
817 * Queries a device instances' model.
819 * @param sdi Device instance to use. Must not be NULL.
821 * @return The model string or NULL.
823 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi)
832 * Queries a device instances' version.
834 * @param sdi Device instance to use. Must not be NULL.
836 * @return The version string or NULL.
838 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi)
847 * Queries a device instances' serial number.
849 * @param sdi Device instance to use. Must not be NULL.
851 * @return The serial number string or NULL.
853 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
858 return sdi->serial_num;
862 * Queries a device instances' connection identifier.
864 * @param sdi Device instance to use. Must not be NULL.
866 * @return A copy of the connection ID string or NULL. The caller is responsible
867 * for g_free()ing the string when it is no longer needed.
869 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
871 #ifdef HAVE_LIBUSB_1_0
872 struct drv_context *drvc;
874 char conn_id_usb[64];
875 struct sr_usb_dev_inst *usb;
876 struct libusb_device **devlist;
879 #ifdef HAVE_SERIAL_COMM
880 struct sr_serial_dev_inst *serial;
883 struct sr_scpi_dev_inst *scpi;
889 #ifdef HAVE_SERIAL_COMM
890 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) {
891 /* connection_id isn't populated, let's do that for serial devices. */
894 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(serial->port);
898 #ifdef HAVE_LIBUSB_1_0
899 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
900 /* connection_id isn't populated, let's do that for USB devices. */
902 drvc = sdi->driver->context;
905 if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {
906 sr_err("Failed to retrieve device list: %s.",
907 libusb_error_name(cnt));
911 for (i = 0; i < cnt; i++) {
912 /* Find the USB device by the logical address we know. */
913 b = libusb_get_bus_number(devlist[i]);
914 a = libusb_get_device_address(devlist[i]);
915 if (b != usb->bus || a != usb->address)
918 if (usb_get_port_path(devlist[i], conn_id_usb, sizeof(conn_id_usb)) < 0)
921 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_usb);
925 libusb_free_device_list(devlist, 1);
929 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SCPI)) {
930 /* connection_id isn't populated, let's do that for SCPI devices. */
933 sr_scpi_connection_id(scpi, &conn_id_scpi);
934 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_scpi);
935 g_free(conn_id_scpi);
938 return sdi->connection_id;
942 * Queries a device instances' channel list.
944 * @param sdi Device instance to use. Must not be NULL.
946 * @return The GSList of channels or NULL.
948 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi)
953 return sdi->channels;
957 * Queries a device instances' channel groups list.
959 * @param sdi Device instance to use. Must not be NULL.
961 * @return The GSList of channel groups or NULL.
963 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi)
968 return sdi->channel_groups;