2 * This file is part of the sigrok 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"
26 /* Message logging helpers with driver-specific prefix string. */
27 #define DRIVER_LOG_DOMAIN "device: "
28 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
29 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
30 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
31 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
32 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
33 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
38 * Device handling in libsigrok.
42 * @defgroup grp_devices Devices
44 * Device handling in libsigrok.
50 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
51 gboolean enabled, const char *name)
53 struct sr_probe *probe;
55 if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
56 sr_err("Probe malloc failed.");
62 probe->enabled = enabled;
64 probe->name = g_strdup(name);
70 * Set the name of the specified probe in the specified device.
72 * If the probe already has a different name assigned to it, it will be
73 * removed, and the new name will be saved instead.
75 * @param sdi The device instance the probe is connected to.
76 * @param probenum The number of the probe whose name to set.
77 * Note that the probe numbers start at 0.
78 * @param name The new name that the specified probe should get. A copy
79 * of the string is made.
81 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
83 SR_API int sr_dev_probe_name_set(const struct sr_dev_inst *sdi,
84 int probenum, const char *name)
87 struct sr_probe *probe;
91 sr_err("%s: sdi was NULL", __func__);
96 for (l = sdi->probes; l; l = l->next) {
98 if (probe->index == probenum) {
100 probe->name = g_strdup(name);
110 * Enable or disable a probe on the specified device.
112 * @param sdi The device instance the probe is connected to.
113 * @param probenum The probe number, starting from 0.
114 * @param state TRUE to enable the probe, FALSE to disable.
116 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
118 SR_API int sr_dev_probe_enable(const struct sr_dev_inst *sdi, int probenum,
122 struct sr_probe *probe;
129 for (l = sdi->probes; l; l = l->next) {
131 if (probe->index == probenum) {
132 probe->enabled = state;
142 * Add a trigger to the specified device (and the specified probe).
144 * If the specified probe of this device already has a trigger, it will
145 * be silently replaced.
147 * @param sdi Must not be NULL.
148 * @param probenum The probe number, starting from 0.
149 * @param trigger Trigger string, in the format used by sigrok-cli
151 * @return SR_OK on success, or SR_ERR_ARG on invalid arguments.
153 SR_API int sr_dev_trigger_set(const struct sr_dev_inst *sdi, int probenum,
157 struct sr_probe *probe;
164 for (l = sdi->probes; l; l = l->next) {
166 if (probe->index == probenum) {
167 /* If the probe already has a trigger, kill it first. */
168 g_free(probe->trigger);
169 probe->trigger = g_strdup(trigger);
179 * Determine whether the specified device instance has the specified
182 * @param sdi Pointer to the device instance to be checked. Must not be NULL.
183 * If the device's 'driver' field is NULL (virtual device), this
184 * function will always return FALSE (virtual devices don't have
185 * a hardware capabilities list).
186 * @param key The option that should be checked for support on the
189 * @return TRUE if the device has the specified option, FALSE otherwise.
190 * FALSE is also returned on invalid input parameters or other
193 SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key)
200 if (!sdi || !sdi->driver || !sdi->driver->config_list)
203 if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, NULL) != SR_OK)
207 devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t));
208 for (i = 0; i < num_opts; i++) {
209 if (devopts[i] == key) {
214 g_variant_unref(gvar);
220 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
221 const char *vendor, const char *model, const char *version)
223 struct sr_dev_inst *sdi;
225 if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
226 sr_err("Device instance malloc failed.");
232 sdi->status = status;
234 sdi->vendor = vendor ? g_strdup(vendor) : NULL;
235 sdi->model = model ? g_strdup(model) : NULL;
236 sdi->version = version ? g_strdup(version) : NULL;
244 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
246 struct sr_probe *probe;
249 for (l = sdi->probes; l; l = l->next) {
258 g_free(sdi->version);
263 #ifdef HAVE_LIBUSB_1_0
266 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
267 uint8_t address, struct libusb_device_handle *hdl)
269 struct sr_usb_dev_inst *udi;
271 if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
272 sr_err("USB device instance malloc failed.");
277 udi->address = address;
284 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
288 /* Nothing to do for this device instance type. */
294 * @param pathname OS-specific serial port specification. Examples:
295 * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1".
296 * @param serialcomm A serial communication parameters string, in the form
297 * of <speed>/<data bits><parity><stopbits>, for example "9600/8n1" or
298 * "600/7o2". This is an optional parameter; it may be filled in later.
299 * @return A pointer to a newly initialized struct sr_serial_dev_inst,
302 * Both parameters are copied to newly allocated strings, and freed
303 * automatically by sr_serial_dev_inst_free().
305 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
306 const char *serialcomm)
308 struct sr_serial_dev_inst *serial;
311 sr_err("Serial port required.");
315 if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) {
316 sr_err("Serial device instance malloc failed.");
320 serial->port = g_strdup(port);
322 serial->serialcomm = g_strdup(serialcomm);
329 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
331 g_free(serial->port);
332 g_free(serial->serialcomm);
336 SR_API GSList *sr_dev_inst_list(const struct sr_dev_driver *driver)
338 if (driver && driver->dev_list)
339 return driver->dev_list();
344 SR_API int sr_dev_inst_clear(const struct sr_dev_driver *driver)
346 if (driver && driver->dev_clear)
347 return driver->dev_clear();