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/>.
22 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
23 #include "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
46 * @param[in] index @copydoc sr_channel::index
47 * @param[in] type @copydoc sr_channel::type
48 * @param[in] enabled @copydoc sr_channel::enabled
49 * @param[in] name @copydoc sr_channel::name
51 * @return NULL (failure) or new struct sr_channel*.
53 SR_PRIV struct sr_channel *sr_channel_new(int index, int type,
54 gboolean enabled, const char *name)
56 struct sr_channel *ch;
58 if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) {
59 sr_err("Channel malloc failed.");
65 ch->enabled = enabled;
67 ch->name = g_strdup(name);
73 * Set the name of the specified channel in the specified device.
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 sdi The device instance the channel is connected to.
79 * @param[in] channelnum The number of the channel whose name to set.
80 * Note that the channel numbers start at 0.
81 * @param[in] name The new name that the specified channel should get. A copy
82 * of the string is made.
84 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
88 SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi,
89 int channelnum, const char *name)
92 struct sr_channel *ch;
96 sr_err("%s: sdi was NULL", __func__);
101 for (l = sdi->channels; l; l = l->next) {
103 if (ch->index == channelnum) {
105 ch->name = g_strdup(name);
115 * Enable or disable a channel on the specified device.
117 * @param sdi The device instance the channel is connected to.
118 * @param channelnum The channel number, starting from 0.
119 * @param state TRUE to enable the channel, FALSE to disable.
121 * @return SR_OK on success or SR_ERR on failure. In case of invalid
122 * arguments, SR_ERR_ARG is returned and the channel enabled state
127 SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum,
131 struct sr_channel *ch;
133 gboolean was_enabled;
139 for (l = sdi->channels; l; l = l->next) {
141 if (ch->index == channelnum) {
142 was_enabled = ch->enabled;
145 if (!state != !was_enabled && sdi->driver
146 && sdi->driver->config_channel_set) {
147 ret = sdi->driver->config_channel_set(
148 sdi, ch, SR_CHANNEL_SET_ENABLED);
149 /* Roll back change if it wasn't applicable. */
150 if (ret == SR_ERR_ARG)
151 ch->enabled = was_enabled;
161 * Determine whether the specified device instance has the specified
164 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
165 * If the device's 'driver' field is NULL (virtual device), this
166 * function will always return FALSE (virtual devices don't have
167 * a hardware capabilities list).
168 * @param[in] key The option that should be checked for is supported by the
171 * @retval TRUE Device has the specified option
172 * @retval FALSE Device does not have the specified option, invalid input
173 * parameters or other error conditions.
177 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
184 if (!sdi || !sdi->driver || !sdi->driver->config_list)
187 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
188 &gvar, sdi, NULL) != SR_OK)
192 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
193 for (i = 0; i < num_opts; i++) {
194 if ((devopts[i] & SR_CONF_MASK) == key) {
199 g_variant_unref(gvar);
205 * Allocate and init a new device instance struct.
206 * @param[in] index @copydoc sr_dev_inst::index
207 * @param[in] status @copydoc sr_dev_inst::status
208 * @param[in] vendor @copydoc sr_dev_inst::vendor
209 * @param[in] model @copydoc sr_dev_inst::model
210 * @param[in] version @copydoc sr_dev_inst::version
213 * @retval struct sr_dev_inst *. Dynamically allocated, free using
214 * sr_dev_inst_free().
216 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status,
217 const char *vendor, const char *model, const char *version)
219 struct sr_dev_inst *sdi;
221 if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
222 sr_err("Device instance malloc failed.");
227 sdi->status = status;
229 sdi->vendor = vendor ? g_strdup(vendor) : NULL;
230 sdi->model = model ? g_strdup(model) : NULL;
231 sdi->version = version ? g_strdup(version) : NULL;
232 sdi->serial_num = NULL;
233 sdi->connection_id = NULL;
234 sdi->channels = NULL;
235 sdi->channel_groups = NULL;
244 * Allocate and init a new user-generated device instance.
246 SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor,
247 const char *model, const char *version)
249 struct sr_dev_inst *sdi;
251 sdi = sr_dev_inst_new(0, vendor, model, version);
255 sdi->inst_type = SR_INST_USER;
261 * Add a new channel to the specified device instance.
263 SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name)
265 struct sr_channel *ch;
267 if (!sdi || sdi->inst_type != SR_INST_USER || index < 0)
270 ch = sr_channel_new(index, type, TRUE, name);
274 sdi->channels = g_slist_append(sdi->channels, ch);
280 * Free device instance struct created by sr_dev_inst().
281 * @param sdi device instance to free.
283 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
285 struct sr_channel *ch;
286 struct sr_channel_group *cg;
289 for (l = sdi->channels; l; l = l->next) {
295 g_slist_free(sdi->channels);
297 for (l = sdi->channel_groups; l; l = l->next) {
300 g_slist_free(cg->channels);
304 g_slist_free(sdi->channel_groups);
308 g_free(sdi->version);
309 g_free(sdi->serial_num);
310 g_free(sdi->connection_id);
314 #ifdef HAVE_LIBUSB_1_0
317 * Allocate and init struct for USB device instance.
318 * @param[in] bus @copydoc sr_usb_dev_inst::bus
319 * @param[in] address @copydoc sr_usb_dev_inst::address
320 * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
323 * @retval other struct sr_usb_dev_inst * for USB device instance.
325 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
326 uint8_t address, struct libusb_device_handle *hdl)
328 struct sr_usb_dev_inst *udi;
330 if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
331 sr_err("USB device instance malloc failed.");
336 udi->address = address;
343 * Free struct * allocated by sr_usb_dev_inst().
344 * @param usb struct* to free. Must not be NULL.
346 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
353 #ifdef HAVE_LIBSERIALPORT
358 * Both parameters are copied to newly allocated strings, and freed
359 * automatically by sr_serial_dev_inst_free().
361 * @param[in] port OS-specific serial port specification. Examples:
362 * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
363 * @param[in] serialcomm A serial communication parameters string, in the form
364 * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
365 * "9600/8n1" or "600/7o2". This is an optional parameter;
366 * it may be filled in later.
368 * @return A pointer to a newly initialized struct sr_serial_dev_inst,
371 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
372 const char *serialcomm)
374 struct sr_serial_dev_inst *serial;
377 sr_err("Serial port required.");
381 if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
382 sr_err("Serial device instance malloc failed.");
386 serial->port = g_strdup(port);
388 serial->serialcomm = g_strdup(serialcomm);
394 * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
395 * @param serial struct sr_serial_dev_inst * to free. Must not be NULL.
397 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
399 g_free(serial->port);
400 g_free(serial->serialcomm);
406 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
408 struct sr_usbtmc_dev_inst *usbtmc;
411 sr_err("Device name required.");
415 if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
416 sr_err("USBTMC device instance malloc failed.");
420 usbtmc->device = g_strdup(device);
427 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
429 g_free(usbtmc->device);
434 * Get the list of devices/instances of the specified driver.
436 * @param driver The driver to use. Must not be NULL.
438 * @return The list of devices/instances of this driver, or NULL upon errors
439 * or if the list is empty.
443 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
445 if (driver && driver->dev_list)
446 return driver->dev_list();
452 * Clear the list of device instances a driver knows about.
454 * @param driver The driver to use. This must be a pointer to one of
455 * the entries returned by sr_driver_list(). Must not be NULL.
457 * @retval SR_OK Success
458 * @retval SR_ERR_ARG Invalid driver
462 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
467 sr_err("Invalid driver.");
471 if (driver->dev_clear)
472 ret = driver->dev_clear();
474 ret = std_dev_clear(driver, NULL);
480 * Open the specified device.
482 * @param sdi Device instance to use. Must not be NULL.
484 * @return SR_OK upon success, a negative error code upon errors.
488 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
492 if (!sdi || !sdi->driver || !sdi->driver->dev_open)
495 ret = sdi->driver->dev_open(sdi);
501 * Close the specified device.
503 * @param sdi Device instance to use. Must not be NULL.
505 * @return SR_OK upon success, a negative error code upon errors.
509 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
513 if (!sdi || !sdi->driver || !sdi->driver->dev_close)
516 ret = sdi->driver->dev_close(sdi);
522 * Queries a device instances' driver.
524 * @param sdi Device instance to use. Must not be NULL.
526 * @return The driver instance or NULL on error.
528 SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi)
530 if (!sdi || !sdi->driver)
537 * Queries a device instances' vendor.
539 * @param sdi Device instance to use. Must not be NULL.
541 * @return The vendor string or NULL.
543 SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi)
552 * Queries a device instances' model.
554 * @param sdi Device instance to use. Must not be NULL.
556 * @return The model string or NULL.
558 SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi)
567 * Queries a device instances' version.
569 * @param sdi Device instance to use. Must not be NULL.
571 * @return The version string or NULL.
573 SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi)
582 * Queries a device instances' serial number.
584 * @param sdi Device instance to use. Must not be NULL.
586 * @return The serial number string or NULL.
588 SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi)
593 return sdi->serial_num;
597 * Queries a device instances' connection identifier.
599 * @param sdi Device instance to use. Must not be NULL.
601 * @return A copy of the connection id string or NULL. The caller is responsible
602 * for g_free()ing the string when it is no longer needed.
604 SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi)
606 struct drv_context *drvc;
608 char connection_id[64];
610 #ifdef HAVE_LIBUSB_1_0
611 struct sr_usb_dev_inst *usb;
612 struct libusb_device **devlist;
613 struct libusb_device_descriptor des;
619 #ifdef HAVE_LIBSERIALPORT
620 struct sr_serial_dev_inst *serial;
622 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) {
623 /* connection_id isn't populated, let's do that here. */
626 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(serial->port);
631 #ifdef HAVE_LIBUSB_1_0
632 if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) {
633 /* connection_id isn't populated, let's do that here. */
635 drvc = sdi->driver->priv;
638 if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) {
639 sr_err("Failed to retrieve device list: %s.",
640 libusb_error_name(cnt));
644 for (i = 0; i < cnt; i++) {
645 if ((r = libusb_get_device_descriptor(devlist[i], &des)) < 0) {
646 sr_err("Failed to get device descriptor: %s.",
647 libusb_error_name(r));
651 /* Find the USB device by the logical address we know. */
652 b = libusb_get_bus_number(devlist[i]);
653 a = libusb_get_device_address(devlist[i]);
654 if (b != usb->bus || a != usb->address)
657 usb_get_port_path(devlist[i], connection_id, sizeof(connection_id));
658 ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(connection_id);
662 libusb_free_device_list(devlist, 1);
666 return sdi->connection_id;
670 * Queries a device instances' channel list.
672 * @param sdi Device instance to use. Must not be NULL.
674 * @return The GSList of channels or NULL.
676 SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi)
681 return sdi->channels;
685 * Queries a device instances' channel groups list.
687 * @param sdi Device instance to use. Must not be NULL.
689 * @return The GSList of channel groups or NULL.
691 SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi)
696 return sdi->channel_groups;