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/>.
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
27 #define LOG_PREFIX "device"
33 * Device handling in libsigrok.
37 * @defgroup grp_devices Devices
39 * Device handling in libsigrok.
45 * Allocate and initialize new struct sr_channel and add to sdi.
46 * @param[in] sdi The device instance the channel is connected to.
47 * @param[in] index @copydoc sr_channel::index
48 * @param[in] type @copydoc sr_channel::type
49 * @param[in] enabled @copydoc sr_channel::enabled
50 * @param[in] name @copydoc sr_channel::name
52 * @return A new struct sr_channel*.
54 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
55 int index, int type, gboolean enabled, const char *name)
57 struct sr_channel *ch;
59 ch = g_malloc0(sizeof(struct sr_channel));
63 ch->enabled = enabled;
65 ch->name = g_strdup(name);
67 sdi->channels = g_slist_append(sdi->channels, ch);
73 * Set the name of the specified channel.
75 * If the channel already has a different name assigned to it, it will be
76 * removed, and the new name will be saved instead.
78 * @param[in] channel The channel whose name to set.
79 * @param[in] name The new name that the specified channel should get. A
80 * copy of the string is made.
82 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
86 SR_API int sr_dev_channel_name_set(struct sr_channel *channel,
90 sr_err("%s: channel was NULL", __func__);
94 g_free(channel->name);
95 channel->name = g_strdup(name);
100 * Enable or disable a channel.
102 * @param[in] channel The channel to enable or disable.
103 * @param[in] state TRUE to enable the channel, FALSE to disable.
105 * @return SR_OK on success or SR_ERR on failure. In case of invalid
106 * arguments, SR_ERR_ARG is returned and the channel enabled state
111 SR_API int sr_dev_channel_enable(struct sr_channel *channel,
115 gboolean was_enabled;
116 struct sr_dev_inst *sdi;
122 was_enabled = channel->enabled;
123 channel->enabled = state;
124 if (!state != !was_enabled && sdi->driver
125 && sdi->driver->config_channel_set) {
126 ret = sdi->driver->config_channel_set(
127 sdi, channel, SR_CHANNEL_SET_ENABLED);
128 /* Roll back change if it wasn't applicable. */
136 /* Returns the next enabled channel, wrapping around if necessary. */
137 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
138 struct sr_channel *cur_channel)
140 struct sr_channel *next_channel;
143 next_channel = cur_channel;
145 l = g_slist_find(sdi->channels, next_channel);
147 next_channel = l->next->data;
149 next_channel = sdi->channels->data;
150 } while (!next_channel->enabled);
156 * Determine whether the specified device instance has the specified
159 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
160 * If the device's 'driver' field is NULL (virtual device), this
161 * function will always return FALSE (virtual devices don't have
162 * a hardware capabilities list).
163 * @param[in] key The option that should be checked for is supported by the
166 * @retval TRUE Device has the specified option
167 * @retval FALSE Device does not have the specified option, invalid input
168 * parameters or other error conditions.
172 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
179 if (!sdi || !sdi->driver || !sdi->driver->config_list)
182 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
183 &gvar, sdi, NULL) != SR_OK)
187 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
188 for (i = 0; i < num_opts; i++) {
189 if ((devopts[i] & SR_CONF_MASK) == key) {
194 g_variant_unref(gvar);
200 * Enumerate the configuration options of the specified item.
202 * @param driver Pointer to the driver to be checked. Must not be NULL.
203 * @param sdi Pointer to the device instance to be checked. May be NULL to
204 * check driver options.
205 * @param cg Pointer to a channel group, if a specific channel group is to
206 * be checked. Must be NULL to check device-wide options.
207 * @return A GArray * of enum sr_configkey values, or NULL on invalid
208 * arguments. The array must be freed by the caller using
213 SR_API GArray *sr_dev_options(
214 const struct sr_dev_driver *driver, const struct sr_dev_inst *sdi,
215 const struct sr_channel_group *cg)
218 const uint32_t *opts;
223 if (!driver || !driver->config_list)
226 if (sdi && sdi->driver != driver)
229 if (driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, sdi, cg) != SR_OK)
232 opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t));
234 result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts);
236 for (i = 0; i < num_opts; i++) {
237 opt = opts[i] & SR_CONF_MASK;
238 g_array_insert_val(result, i, opt);
241 g_variant_unref(gvar);
247 * Enumerate the configuration capabilities supported by a device instance
248 * for a given configuration key.
250 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
251 * If the device's 'driver' field is NULL (virtual device), this
252 * function will always return FALSE (virtual devices don't have
253 * a hardware capabilities list).
254 * @param cg Pointer to a channel group, if a specific channel group is to
255 * be checked. Must be NULL to check device-wide options.
256 * @param[in] key The option that should be checked for is supported by the
259 * @retval A bitmask of enum sr_configcap values, which will be zero for
260 * invalid inputs or if the key is unsupported.
264 SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi,
265 const struct sr_channel_group *cg, const int key)
272 if (!sdi || !sdi->driver || !sdi->driver->config_list)
275 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
276 &gvar, sdi, cg) != SR_OK)
280 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
281 for (i = 0; i < num_opts; i++) {
282 if ((devopts[i] & SR_CONF_MASK) == key) {
283 ret = devopts[i] & ~SR_CONF_MASK;
287 g_variant_unref(gvar);
293 * Allocate and init a new user-generated device instance.
295 * @param vendor Device vendor
296 * @param model Device model
297 * @param version Device version
299 * @retval struct sr_dev_inst *. Dynamically allocated, free using
300 * sr_dev_inst_free().
302 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
303 const char *model, const char *version)
305 struct sr_dev_inst *sdi;
307 sdi = g_malloc0(sizeof(struct sr_dev_inst));
309 sdi->vendor = g_strdup(vendor);
310 sdi->model = g_strdup(model);
311 sdi->version = g_strdup(version);
312 sdi->inst_type = SR_INST_USER;
318 * Add a new channel to the specified device instance.
320 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
322 if (!sdi || sdi->inst_type != SR_INST_USER || index < 0)
325 sr_channel_new(sdi, index, type, TRUE, name);
331 * Free device instance struct created by sr_dev_inst().
332 * @param sdi device instance to free.
334 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
336 struct sr_channel *ch;
337 struct sr_channel_group *cg;
340 for (l = sdi->channels; l; l = l->next) {
346 g_slist_free(sdi->channels);
348 for (l = sdi->channel_groups; l; l = l->next) {
351 g_slist_free(cg->channels);
355 g_slist_free(sdi->channel_groups);
358 sr_session_dev_remove(sdi->session, sdi);
362 g_free(sdi->version);
363 g_free(sdi->serial_num);
364 g_free(sdi->connection_id);
368 #ifdef HAVE_LIBUSB_1_0
371 * Allocate and init struct for USB device instance.
372 * @param[in] bus @copydoc sr_usb_dev_inst::bus
373 * @param[in] address @copydoc sr_usb_dev_inst::address
374 * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
376 * @retval other struct sr_usb_dev_inst * for USB device instance.
378 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
379 uint8_t address, struct libusb_device_handle *hdl)
381 struct sr_usb_dev_inst *udi;
383 udi = g_malloc0(sizeof(struct sr_usb_dev_inst));
385 udi->address = address;
392 * Free struct * allocated by sr_usb_dev_inst().
393 * @param usb struct* to free. Must not be NULL.
395 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
402 #ifdef HAVE_LIBSERIALPORT
407 * Both parameters are copied to newly allocated strings, and freed
408 * automatically by sr_serial_dev_inst_free().
410 * @param[in] port OS-specific serial port specification. Examples:
411 * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
413 * @param[in] serialcomm A serial communication parameters string, in the form
414 * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
415 * "9600/8n1" or "600/7o2". This is an optional parameter;
416 * it may be filled in later. Can be NULL.
418 * @return A pointer to a newly initialized struct sr_serial_dev_inst,
421 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
422 const char *serialcomm)
424 struct sr_serial_dev_inst *serial;
426 serial = g_malloc0(sizeof(struct sr_serial_dev_inst));
427 serial->port = g_strdup(port);
429 serial->serialcomm = g_strdup(serialcomm);
435 * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
436 * @param serial struct sr_serial_dev_inst * to free. Must not be NULL.
438 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
440 g_free(serial->port);
441 g_free(serial->serialcomm);
447 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
449 struct sr_usbtmc_dev_inst *usbtmc;
451 usbtmc = g_malloc0(sizeof(struct sr_usbtmc_dev_inst));
452 usbtmc->device = g_strdup(device);
459 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
461 g_free(usbtmc->device);
466 * Get the list of devices/instances of the specified driver.
468 * @param driver The driver to use. Must not be NULL.
470 * @return The list of devices/instances of this driver, or NULL upon errors
471 * or if the list is empty.
475 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
477 if (driver && driver->dev_list)
478 return driver->dev_list(driver);
484 * Clear the list of device instances a driver knows about.
486 * @param driver The driver to use. This must be a pointer to one of
487 * the entries returned by sr_driver_list(). Must not be NULL.
489 * @retval SR_OK Success
490 * @retval SR_ERR_ARG Invalid driver
494 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
499 sr_err("Invalid driver.");
503 if (driver->dev_clear)
504 ret = driver->dev_clear(driver);
506 ret = std_dev_clear(driver, NULL);
512 * Open the specified device.
514 * @param sdi Device instance to use. Must not be NULL.
516 * @return SR_OK upon success, a negative error code upon errors.
520 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
524 if (!sdi || !sdi->driver || !sdi->driver->dev_open)
527 ret = sdi->driver->dev_open(sdi);
533 * Close the specified device.
535 * @param sdi Device instance to use. Must not be NULL.
537 * @return SR_OK upon success, a negative error code upon errors.
541 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
545 if (!sdi || !sdi->driver || !sdi->driver->dev_close)
548 ret = sdi->driver->dev_close(sdi);
554 * Queries a device instances' driver.
556 * @param sdi Device instance to use. Must not be NULL.
558 * @return The driver instance or NULL on error.
560 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi)
562 if (!sdi || !sdi->driver)
569 * Queries a device instances' vendor.
571 * @param sdi Device instance to use. Must not be NULL.
573 * @return The vendor string or NULL.
575 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi)
584 * Queries a device instances' model.
586 * @param sdi Device instance to use. Must not be NULL.
588 * @return The model string or NULL.
590 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi)
599 * Queries a device instances' version.
601 * @param sdi Device instance to use. Must not be NULL.
603 * @return The version string or NULL.
605 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi)
614 * Queries a device instances' serial number.
616 * @param sdi Device instance to use. Must not be NULL.
618 * @return The serial number string or NULL.
620 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
625 return sdi->serial_num;
629 * Queries a device instances' connection identifier.
631 * @param sdi Device instance to use. Must not be NULL.
633 * @return A copy of the connection id string or NULL. The caller is responsible
634 * for g_free()ing the string when it is no longer needed.
636 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
638 #ifdef HAVE_LIBUSB_1_0
639 struct drv_context *drvc;
641 char connection_id[64];
642 struct sr_usb_dev_inst *usb;
643 struct libusb_device **devlist;
649 #ifdef HAVE_LIBSERIALPORT
650 struct sr_serial_dev_inst *serial;
652 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) {
653 /* connection_id isn't populated, let's do that here. */
656 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(serial->port);
660 #ifdef HAVE_LIBUSB_1_0
661 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
662 /* connection_id isn't populated, let's do that here. */
664 drvc = sdi->driver->context;
667 if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {
668 sr_err("Failed to retrieve device list: %s.",
669 libusb_error_name(cnt));
673 for (i = 0; i < cnt; i++) {
674 /* Find the USB device by the logical address we know. */
675 b = libusb_get_bus_number(devlist[i]);
676 a = libusb_get_device_address(devlist[i]);
677 if (b != usb->bus || a != usb->address)
680 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
681 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(connection_id);
685 libusb_free_device_list(devlist, 1);
689 return sdi->connection_id;
693 * Queries a device instances' channel list.
695 * @param sdi Device instance to use. Must not be NULL.
697 * @return The GSList of channels or NULL.
699 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi)
704 return sdi->channels;
708 * Queries a device instances' channel groups list.
710 * @param sdi Device instance to use. Must not be NULL.
712 * @return The GSList of channel groups or NULL.
714 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi)
719 return sdi->channel_groups;