]>
Commit | Line | Data |
---|---|---|
a1bb33af | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
a1bb33af | 3 | * |
13d8e03c | 4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> |
a1bb33af UH |
5 | * |
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. | |
10 | * | |
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. | |
15 | * | |
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/>. | |
18 | */ | |
19 | ||
20 | #include <stdio.h> | |
21 | #include <glib.h> | |
545f9786 | 22 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ |
45c59c8b BV |
23 | #include "libsigrok.h" |
24 | #include "libsigrok-internal.h" | |
a1bb33af | 25 | |
2ad1deb8 | 26 | /** @cond PRIVATE */ |
3544f848 | 27 | #define LOG_PREFIX "device" |
2ad1deb8 | 28 | /** @endcond */ |
a885ce3e | 29 | |
393fb9cb UH |
30 | /** |
31 | * @file | |
32 | * | |
33 | * Device handling in libsigrok. | |
34 | */ | |
35 | ||
7b870c38 UH |
36 | /** |
37 | * @defgroup grp_devices Devices | |
38 | * | |
39 | * Device handling in libsigrok. | |
40 | * | |
41 | * @{ | |
42 | */ | |
43 | ||
04cb9157 | 44 | /** @private |
91aea754 UH |
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 | |
04cb9157 | 50 | * |
91aea754 | 51 | * @return NULL (failure) or new struct sr_channel*. |
04cb9157 | 52 | */ |
56d0d245 | 53 | SR_PRIV struct sr_channel *sr_channel_new(int index, int type, |
48a486cd BV |
54 | gboolean enabled, const char *name) |
55 | { | |
ba7dd8bb | 56 | struct sr_channel *ch; |
48a486cd | 57 | |
ba7dd8bb UH |
58 | if (!(ch = g_try_malloc0(sizeof(struct sr_channel)))) { |
59 | sr_err("Channel malloc failed."); | |
48a486cd BV |
60 | return NULL; |
61 | } | |
62 | ||
ba7dd8bb UH |
63 | ch->index = index; |
64 | ch->type = type; | |
65 | ch->enabled = enabled; | |
48a486cd | 66 | if (name) |
ba7dd8bb | 67 | ch->name = g_strdup(name); |
48a486cd | 68 | |
ba7dd8bb | 69 | return ch; |
48a486cd BV |
70 | } |
71 | ||
94799bc4 | 72 | /** |
ba7dd8bb | 73 | * Set the name of the specified channel in the specified device. |
94799bc4 | 74 | * |
ba7dd8bb | 75 | * If the channel already has a different name assigned to it, it will be |
94799bc4 UH |
76 | * removed, and the new name will be saved instead. |
77 | * | |
ba7dd8bb UH |
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 | |
37e8b4c4 | 82 | * of the string is made. |
0e3b1439 | 83 | * |
37e8b4c4 | 84 | * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. |
9fb5f2df | 85 | * |
47117241 | 86 | * @since 0.3.0 |
94799bc4 | 87 | */ |
f3ca73ed | 88 | SR_API int sr_dev_channel_name_set(const struct sr_dev_inst *sdi, |
ba7dd8bb | 89 | int channelnum, const char *name) |
a1bb33af | 90 | { |
37e8b4c4 | 91 | GSList *l; |
ba7dd8bb | 92 | struct sr_channel *ch; |
37e8b4c4 | 93 | int ret; |
a1bb33af | 94 | |
37e8b4c4 BV |
95 | if (!sdi) { |
96 | sr_err("%s: sdi was NULL", __func__); | |
0e3b1439 | 97 | return SR_ERR_ARG; |
94799bc4 UH |
98 | } |
99 | ||
37e8b4c4 | 100 | ret = SR_ERR_ARG; |
ba7dd8bb UH |
101 | for (l = sdi->channels; l; l = l->next) { |
102 | ch = l->data; | |
103 | if (ch->index == channelnum) { | |
104 | g_free(ch->name); | |
105 | ch->name = g_strdup(name); | |
37e8b4c4 BV |
106 | ret = SR_OK; |
107 | break; | |
108 | } | |
94799bc4 UH |
109 | } |
110 | ||
37e8b4c4 | 111 | return ret; |
a1bb33af UH |
112 | } |
113 | ||
be5bf44d | 114 | /** |
ba7dd8bb | 115 | * Enable or disable a channel on the specified device. |
be5bf44d | 116 | * |
ba7dd8bb UH |
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. | |
be5bf44d | 120 | * |
2a854d71 | 121 | * @return SR_OK on success or SR_ERR on failure. In case of invalid |
ba7dd8bb | 122 | * arguments, SR_ERR_ARG is returned and the channel enabled state |
2a854d71 | 123 | * remains unchanged. |
9fb5f2df | 124 | * |
47117241 | 125 | * @since 0.3.0 |
be5bf44d | 126 | */ |
f3ca73ed | 127 | SR_API int sr_dev_channel_enable(const struct sr_dev_inst *sdi, int channelnum, |
be5bf44d BV |
128 | gboolean state) |
129 | { | |
130 | GSList *l; | |
ba7dd8bb | 131 | struct sr_channel *ch; |
be5bf44d | 132 | int ret; |
2a854d71 | 133 | gboolean was_enabled; |
be5bf44d BV |
134 | |
135 | if (!sdi) | |
136 | return SR_ERR_ARG; | |
137 | ||
138 | ret = SR_ERR_ARG; | |
ba7dd8bb UH |
139 | for (l = sdi->channels; l; l = l->next) { |
140 | ch = l->data; | |
141 | if (ch->index == channelnum) { | |
142 | was_enabled = ch->enabled; | |
143 | ch->enabled = state; | |
be5bf44d | 144 | ret = SR_OK; |
2a854d71 | 145 | if (!state != !was_enabled && sdi->driver |
f3ca73ed UH |
146 | && sdi->driver->config_channel_set) { |
147 | ret = sdi->driver->config_channel_set( | |
3f239f08 | 148 | sdi, ch, SR_CHANNEL_SET_ENABLED); |
2a854d71 DE |
149 | /* Roll back change if it wasn't applicable. */ |
150 | if (ret == SR_ERR_ARG) | |
ba7dd8bb | 151 | ch->enabled = was_enabled; |
2a854d71 | 152 | } |
be5bf44d BV |
153 | break; |
154 | } | |
155 | } | |
156 | ||
157 | return ret; | |
158 | } | |
159 | ||
94799bc4 | 160 | /** |
9c5332d2 UH |
161 | * Determine whether the specified device instance has the specified |
162 | * capability. | |
94799bc4 | 163 | * |
9c5332d2 | 164 | * @param sdi Pointer to the device instance to be checked. Must not be NULL. |
8ec95d22 UH |
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). | |
04cb9157 | 168 | * @param[in] key The option that should be checked for is supported by the |
4d15e5c9 | 169 | * specified device. |
94799bc4 | 170 | * |
04cb9157 MH |
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. | |
9fb5f2df | 174 | * |
53f05fa8 | 175 | * @since 0.2.0 |
94799bc4 | 176 | */ |
4d15e5c9 | 177 | SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) |
7d658874 | 178 | { |
003595ac | 179 | GVariant *gvar; |
4d15e5c9 | 180 | const int *devopts; |
003595ac BV |
181 | gsize num_opts, i; |
182 | int ret; | |
7d658874 | 183 | |
003595ac | 184 | if (!sdi || !sdi->driver || !sdi->driver->config_list) |
8ec95d22 | 185 | return FALSE; |
94799bc4 | 186 | |
8f996b89 | 187 | if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, |
92b68bb5 | 188 | &gvar, sdi, NULL) != SR_OK) |
8ec95d22 | 189 | return FALSE; |
94799bc4 | 190 | |
003595ac BV |
191 | ret = FALSE; |
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] == key) { | |
195 | ret = TRUE; | |
196 | break; | |
197 | } | |
94799bc4 | 198 | } |
003595ac | 199 | g_variant_unref(gvar); |
218557b8 | 200 | |
003595ac | 201 | return ret; |
a1bb33af | 202 | } |
fd9836bf | 203 | |
04cb9157 MH |
204 | /** @private |
205 | * Allocate and init new device instance struct. | |
2eb84c98 UH |
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 | |
04cb9157 | 211 | * |
2eb84c98 UH |
212 | * @retval NULL Error |
213 | * @retval struct sr_dev_inst *. Dynamically allocated, free using | |
04cb9157 MH |
214 | * sr_dev_inst_free(). |
215 | */ | |
1b9e567b | 216 | SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int status, |
48a486cd BV |
217 | const char *vendor, const char *model, const char *version) |
218 | { | |
219 | struct sr_dev_inst *sdi; | |
220 | ||
221 | if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { | |
c4227fc6 | 222 | sr_err("Device instance malloc failed."); |
48a486cd BV |
223 | return NULL; |
224 | } | |
225 | ||
e8d3d6c8 | 226 | sdi->driver = NULL; |
48a486cd BV |
227 | sdi->status = status; |
228 | sdi->inst_type = -1; | |
229 | sdi->vendor = vendor ? g_strdup(vendor) : NULL; | |
230 | sdi->model = model ? g_strdup(model) : NULL; | |
231 | sdi->version = version ? g_strdup(version) : NULL; | |
2fe6210a SA |
232 | sdi->serial_num = NULL; |
233 | sdi->connection_id = NULL; | |
ba7dd8bb | 234 | sdi->channels = NULL; |
660e398f | 235 | sdi->channel_groups = NULL; |
0812c40e | 236 | sdi->session = NULL; |
9e2e9864 | 237 | sdi->conn = NULL; |
48a486cd BV |
238 | sdi->priv = NULL; |
239 | ||
240 | return sdi; | |
241 | } | |
242 | ||
04cb9157 MH |
243 | /** @private |
244 | * Free device instance struct created by sr_dev_inst(). | |
2eb84c98 | 245 | * @param sdi struct* to free. |
04cb9157 | 246 | */ |
48a486cd BV |
247 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) |
248 | { | |
ba7dd8bb | 249 | struct sr_channel *ch; |
d3cff734 BV |
250 | GSList *l; |
251 | ||
ba7dd8bb UH |
252 | for (l = sdi->channels; l; l = l->next) { |
253 | ch = l->data; | |
254 | g_free(ch->name); | |
379d2609 | 255 | g_free(ch->priv); |
ba7dd8bb | 256 | g_free(ch); |
d3cff734 | 257 | } |
ba7dd8bb | 258 | g_slist_free(sdi->channels); |
d3cff734 | 259 | |
660e398f UH |
260 | if (sdi->channel_groups) |
261 | g_slist_free(sdi->channel_groups); | |
90c7f4e9 | 262 | |
48a486cd BV |
263 | g_free(sdi->vendor); |
264 | g_free(sdi->model); | |
265 | g_free(sdi->version); | |
2fe6210a SA |
266 | g_free(sdi->serial_num); |
267 | g_free(sdi->connection_id); | |
48a486cd BV |
268 | g_free(sdi); |
269 | } | |
270 | ||
271 | #ifdef HAVE_LIBUSB_1_0 | |
272 | ||
04cb9157 MH |
273 | /** @private |
274 | * Allocate and init struct for USB device instance. | |
2eb84c98 UH |
275 | * @param[in] bus @copydoc sr_usb_dev_inst::bus |
276 | * @param[in] address @copydoc sr_usb_dev_inst::address | |
277 | * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl | |
04cb9157 | 278 | * |
2eb84c98 UH |
279 | * @retval NULL Error |
280 | * @retval other struct sr_usb_dev_inst * for USB device instance. | |
04cb9157 | 281 | */ |
48a486cd BV |
282 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, |
283 | uint8_t address, struct libusb_device_handle *hdl) | |
284 | { | |
285 | struct sr_usb_dev_inst *udi; | |
286 | ||
287 | if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { | |
c4227fc6 | 288 | sr_err("USB device instance malloc failed."); |
48a486cd BV |
289 | return NULL; |
290 | } | |
291 | ||
292 | udi->bus = bus; | |
293 | udi->address = address; | |
294 | udi->devhdl = hdl; | |
295 | ||
296 | return udi; | |
297 | } | |
298 | ||
04cb9157 MH |
299 | /** @private |
300 | * Free struct * allocated by sr_usb_dev_inst(). | |
2eb84c98 | 301 | * @param usb struct* to free. Must not be NULL. |
04cb9157 | 302 | */ |
48a486cd BV |
303 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) |
304 | { | |
a006798b | 305 | g_free(usb); |
48a486cd BV |
306 | } |
307 | ||
308 | #endif | |
309 | ||
c4f2dfd0 UH |
310 | #ifdef HAVE_LIBSERIALPORT |
311 | ||
9fb5f2df UH |
312 | /** |
313 | * @private | |
299bdb24 BV |
314 | * |
315 | * Both parameters are copied to newly allocated strings, and freed | |
316 | * automatically by sr_serial_dev_inst_free(). | |
9fb5f2df | 317 | * |
04cb9157 | 318 | * @param[in] port OS-specific serial port specification. Examples: |
9fb5f2df | 319 | * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1". |
04cb9157 MH |
320 | * @param[in] serialcomm A serial communication parameters string, in the form |
321 | * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example | |
322 | * "9600/8n1" or "600/7o2". This is an optional parameter; | |
323 | * it may be filled in later. | |
9fb5f2df UH |
324 | * |
325 | * @return A pointer to a newly initialized struct sr_serial_dev_inst, | |
326 | * or NULL on error. | |
299bdb24 | 327 | */ |
48a486cd | 328 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, |
299bdb24 | 329 | const char *serialcomm) |
48a486cd BV |
330 | { |
331 | struct sr_serial_dev_inst *serial; | |
332 | ||
299bdb24 | 333 | if (!port) { |
c4227fc6 | 334 | sr_err("Serial port required."); |
299bdb24 BV |
335 | return NULL; |
336 | } | |
337 | ||
338 | if (!(serial = g_try_malloc0(sizeof(struct sr_serial_dev_inst)))) { | |
c4227fc6 | 339 | sr_err("Serial device instance malloc failed."); |
48a486cd BV |
340 | return NULL; |
341 | } | |
342 | ||
343 | serial->port = g_strdup(port); | |
299bdb24 BV |
344 | if (serialcomm) |
345 | serial->serialcomm = g_strdup(serialcomm); | |
48a486cd BV |
346 | |
347 | return serial; | |
348 | } | |
349 | ||
04cb9157 MH |
350 | /** @private |
351 | * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst(). | |
2eb84c98 | 352 | * @param serial struct sr_serial_dev_inst * to free. Must not be NULL. |
04cb9157 | 353 | */ |
48a486cd BV |
354 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) |
355 | { | |
356 | g_free(serial->port); | |
299bdb24 | 357 | g_free(serial->serialcomm); |
acac8fc3 | 358 | g_free(serial); |
48a486cd | 359 | } |
c4f2dfd0 UH |
360 | #endif |
361 | ||
df823ac4 | 362 | /** @private */ |
ae67644f ML |
363 | SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device) |
364 | { | |
365 | struct sr_usbtmc_dev_inst *usbtmc; | |
366 | ||
367 | if (!device) { | |
368 | sr_err("Device name required."); | |
369 | return NULL; | |
370 | } | |
371 | ||
372 | if (!(usbtmc = g_try_malloc0(sizeof(struct sr_usbtmc_dev_inst)))) { | |
373 | sr_err("USBTMC device instance malloc failed."); | |
374 | return NULL; | |
375 | } | |
376 | ||
377 | usbtmc->device = g_strdup(device); | |
378 | usbtmc->fd = -1; | |
379 | ||
380 | return usbtmc; | |
381 | } | |
382 | ||
df823ac4 | 383 | /** @private */ |
ae67644f ML |
384 | SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc) |
385 | { | |
386 | g_free(usbtmc->device); | |
387 | g_free(usbtmc); | |
388 | } | |
389 | ||
576ff5b0 UH |
390 | /** |
391 | * Get the list of devices/instances of the specified driver. | |
392 | * | |
393 | * @param driver The driver to use. Must not be NULL. | |
394 | * | |
395 | * @return The list of devices/instances of this driver, or NULL upon errors | |
396 | * or if the list is empty. | |
397 | * | |
53f05fa8 | 398 | * @since 0.2.0 |
576ff5b0 | 399 | */ |
f99e32af | 400 | SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver) |
811deee4 | 401 | { |
811deee4 BV |
402 | if (driver && driver->dev_list) |
403 | return driver->dev_list(); | |
404 | else | |
405 | return NULL; | |
406 | } | |
407 | ||
576ff5b0 | 408 | /** |
8102cee4 | 409 | * Clear the list of device instances a driver knows about. |
576ff5b0 | 410 | * |
8102cee4 BV |
411 | * @param driver The driver to use. This must be a pointer to one of |
412 | * the entries returned by sr_driver_list(). Must not be NULL. | |
576ff5b0 | 413 | * |
8102cee4 BV |
414 | * @retval SR_OK Success |
415 | * @retval SR_ERR_ARG Invalid driver | |
576ff5b0 UH |
416 | * |
417 | * @since 0.2.0 | |
418 | */ | |
f99e32af | 419 | SR_API int sr_dev_clear(const struct sr_dev_driver *driver) |
811deee4 | 420 | { |
8102cee4 BV |
421 | int ret; |
422 | ||
423 | if (!driver) { | |
424 | sr_err("Invalid driver."); | |
425 | return SR_ERR_ARG; | |
426 | } | |
427 | ||
428 | if (driver->dev_clear) | |
429 | ret = driver->dev_clear(); | |
811deee4 | 430 | else |
8102cee4 BV |
431 | ret = std_dev_clear(driver, NULL); |
432 | ||
433 | return ret; | |
811deee4 BV |
434 | } |
435 | ||
576ff5b0 UH |
436 | /** |
437 | * Open the specified device. | |
438 | * | |
439 | * @param sdi Device instance to use. Must not be NULL. | |
440 | * | |
441 | * @return SR_OK upon success, a negative error code upon errors. | |
442 | * | |
443 | * @since 0.2.0 | |
444 | */ | |
efdecf4c BV |
445 | SR_API int sr_dev_open(struct sr_dev_inst *sdi) |
446 | { | |
447 | int ret; | |
448 | ||
449 | if (!sdi || !sdi->driver || !sdi->driver->dev_open) | |
450 | return SR_ERR; | |
451 | ||
452 | ret = sdi->driver->dev_open(sdi); | |
453 | ||
454 | return ret; | |
455 | } | |
456 | ||
576ff5b0 UH |
457 | /** |
458 | * Close the specified device. | |
459 | * | |
460 | * @param sdi Device instance to use. Must not be NULL. | |
461 | * | |
462 | * @return SR_OK upon success, a negative error code upon errors. | |
463 | * | |
464 | * @since 0.2.0 | |
465 | */ | |
efdecf4c BV |
466 | SR_API int sr_dev_close(struct sr_dev_inst *sdi) |
467 | { | |
468 | int ret; | |
469 | ||
470 | if (!sdi || !sdi->driver || !sdi->driver->dev_close) | |
471 | return SR_ERR; | |
472 | ||
473 | ret = sdi->driver->dev_close(sdi); | |
474 | ||
475 | return ret; | |
476 | } | |
477 | ||
7b870c38 | 478 | /** @} */ |