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 * Add a trigger to the specified device (and the specified channel).
163 * If the specified channel of this device already has a trigger, it will
164 * be silently replaced.
166 * @param[in,out] sdi Pointer to the device instance; must not be NULL.
167 * @param[in] channelnum Number of channel, starting at 0.
168 * @param[in] trigger Trigger string, in the format used by sigrok-cli
170 * @return SR_OK on success or SR_ERR on failure. In case of invalid
171 * arguments, SR_ERR_ARG is returned and the trigger settings
176 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int channelnum,
180 struct sr_channel *ch;
188 for (l = sdi->channels; l; l = l->next) {
190 if (ch->index == channelnum) {
191 old_trigger = ch->trigger;
193 if (g_strcmp0(trigger, old_trigger) == 0)
195 /* Set new trigger if it has changed. */
196 ch->trigger = g_strdup(trigger);
198 if (sdi->driver && sdi->driver->config_channel_set) {
199 ret = sdi->driver->config_channel_set(
200 sdi, ch, SR_CHANNEL_SET_TRIGGER);
201 /* Roll back change if it wasn't applicable. */
202 if (ret == SR_ERR_ARG) {
204 ch->trigger = old_trigger;
217 * Determine whether the specified device instance has the specified
220 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
221 * If the device's 'driver' field is NULL (virtual device), this
222 * function will always return FALSE (virtual devices don't have
223 * a hardware capabilities list).
224 * @param[in] key The option that should be checked for is supported by the
227 * @retval TRUE Device has the specified option
228 * @retval FALSE Device does not have the specified option, invalid input
229 * parameters or other error conditions.
233 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
240 if (!sdi || !sdi->driver || !sdi->driver->config_list)
243 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS,
244 &gvar, sdi, NULL) != SR_OK)
248 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
249 for (i = 0; i < num_opts; i++) {
250 if (devopts[i] == key) {
255 g_variant_unref(gvar);
261 * Allocate and init new device instance struct.
262 * @param[in] index @copydoc sr_dev_inst::index
263 * @param[in] status @copydoc sr_dev_inst::status
264 * @param[in] vendor @copydoc sr_dev_inst::vendor
265 * @param[in] model @copydoc sr_dev_inst::model
266 * @param[in] version @copydoc sr_dev_inst::version
269 * @retval struct sr_dev_inst *. Dynamically allocated, free using
270 * sr_dev_inst_free().
272 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
273 const char *vendor, const char *model, const char *version)
275 struct sr_dev_inst *sdi;
277 if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
278 sr_err("Device instance malloc failed.");
284 sdi->status = status;
286 sdi->vendor = vendor ? g_strdup(vendor) : NULL;
287 sdi->model = model ? g_strdup(model) : NULL;
288 sdi->version = version ? g_strdup(version) : NULL;
289 sdi->channels = NULL;
290 sdi->channel_groups = NULL;
298 * Free device instance struct created by sr_dev_inst().
299 * @param sdi struct* to free.
301 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
303 struct sr_channel *ch;
306 for (l = sdi->channels; l; l = l->next) {
312 g_slist_free(sdi->channels);
314 if (sdi->channel_groups)
315 g_slist_free(sdi->channel_groups);
319 g_free(sdi->version);
323 #ifdef HAVE_LIBUSB_1_0
326 * Allocate and init struct for USB device instance.
327 * @param[in] bus @copydoc sr_usb_dev_inst::bus
328 * @param[in] address @copydoc sr_usb_dev_inst::address
329 * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl
332 * @retval other struct sr_usb_dev_inst * for USB device instance.
334 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
335 uint8_t address, struct libusb_device_handle *hdl)
337 struct sr_usb_dev_inst *udi;
339 if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
340 sr_err("USB device instance malloc failed.");
345 udi->address = address;
352 * Free struct * allocated by sr_usb_dev_inst().
353 * @param usb struct* to free. Must not be NULL.
355 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
362 #ifdef HAVE_LIBSERIALPORT
367 * Both parameters are copied to newly allocated strings, and freed
368 * automatically by sr_serial_dev_inst_free().
370 * @param[in] port OS-specific serial port specification. Examples:
371 * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
372 * @param[in] serialcomm A serial communication parameters string, in the form
373 * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example
374 * "9600/8n1" or "600/7o2". This is an optional parameter;
375 * it may be filled in later.
377 * @return A pointer to a newly initialized struct sr_serial_dev_inst,
380 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
381 const char *serialcomm)
383 struct sr_serial_dev_inst *serial;
386 sr_err("Serial port required.");
390 if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
391 sr_err("Serial device instance malloc failed.");
395 serial->port = g_strdup(port);
397 serial->serialcomm = g_strdup(serialcomm);
403 * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst().
404 * @param serial struct sr_serial_dev_inst * to free. Must not be NULL.
406 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
408 g_free(serial->port);
409 g_free(serial->serialcomm);
415 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device)
417 struct sr_usbtmc_dev_inst *usbtmc;
420 sr_err("Device name required.");
424 if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) {
425 sr_err("USBTMC device instance malloc failed.");
429 usbtmc->device = g_strdup(device);
436 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc)
438 g_free(usbtmc->device);
443 * Get the list of devices/instances of the specified driver.
445 * @param driver The driver to use. Must not be NULL.
447 * @return The list of devices/instances of this driver, or NULL upon errors
448 * or if the list is empty.
452 SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver)
454 if (driver && driver->dev_list)
455 return driver->dev_list();
461 * Clear the list of device instances a driver knows about.
463 * @param driver The driver to use. This must be a pointer to one of
464 * the entries returned by sr_driver_list(). Must not be NULL.
466 * @retval SR_OK Success
467 * @retval SR_ERR_ARG Invalid driver
471 SR_API int sr_dev_clear(const struct sr_dev_driver *driver)
476 sr_err("Invalid driver.");
480 if (driver->dev_clear)
481 ret = driver->dev_clear();
483 ret = std_dev_clear(driver, NULL);
489 * Open the specified device.
491 * @param sdi Device instance to use. Must not be NULL.
493 * @return SR_OK upon success, a negative error code upon errors.
497 SR_API int sr_dev_open(struct sr_dev_inst *sdi)
501 if (!sdi || !sdi->driver || !sdi->driver->dev_open)
504 ret = sdi->driver->dev_open(sdi);
510 * Close the specified device.
512 * @param sdi Device instance to use. Must not be NULL.
514 * @return SR_OK upon success, a negative error code upon errors.
518 SR_API int sr_dev_close(struct sr_dev_inst *sdi)
522 if (!sdi || !sdi->driver || !sdi->driver->dev_close)
525 ret = sdi->driver->dev_close(sdi);