]>
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 | ||
6ec6c43b | 20 | #include <config.h> |
a1bb33af | 21 | #include <glib.h> |
712f981d GS |
22 | #include <stdio.h> |
23 | #include <string.h> | |
c1aae900 | 24 | #include <libsigrok/libsigrok.h> |
45c59c8b | 25 | #include "libsigrok-internal.h" |
8107a9a6 | 26 | #include "scpi.h" |
a1bb33af | 27 | |
2ad1deb8 | 28 | /** @cond PRIVATE */ |
3544f848 | 29 | #define LOG_PREFIX "device" |
2ad1deb8 | 30 | /** @endcond */ |
a885ce3e | 31 | |
393fb9cb UH |
32 | /** |
33 | * @file | |
34 | * | |
35 | * Device handling in libsigrok. | |
36 | */ | |
37 | ||
7b870c38 UH |
38 | /** |
39 | * @defgroup grp_devices Devices | |
40 | * | |
41 | * Device handling in libsigrok. | |
42 | * | |
43 | * @{ | |
44 | */ | |
45 | ||
2ecc745c UH |
46 | /** |
47 | * Allocate and initialize a new struct sr_channel and add it to sdi. | |
48 | * | |
49 | * @param[in] sdi The device instance the channel is connected to. | |
50 | * Must not be NULL. | |
51 | * @param[in] index @copydoc sr_channel::index | |
52 | * @param[in] type @copydoc sr_channel::type | |
53 | * @param[in] enabled @copydoc sr_channel::enabled | |
54 | * @param[in] name @copydoc sr_channel::name | |
55 | * | |
56 | * @return A new struct sr_channel*. | |
57 | * | |
58 | * @private | |
04cb9157 | 59 | */ |
5e23fcab ML |
60 | SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi, |
61 | int index, int type, gboolean enabled, const char *name) | |
48a486cd | 62 | { |
ba7dd8bb | 63 | struct sr_channel *ch; |
48a486cd | 64 | |
e47a9562 | 65 | ch = g_malloc0(sizeof(*ch)); |
837b0866 | 66 | ch->sdi = sdi; |
ba7dd8bb UH |
67 | ch->index = index; |
68 | ch->type = type; | |
69 | ch->enabled = enabled; | |
48a486cd | 70 | if (name) |
ba7dd8bb | 71 | ch->name = g_strdup(name); |
48a486cd | 72 | |
5e23fcab ML |
73 | sdi->channels = g_slist_append(sdi->channels, ch); |
74 | ||
ba7dd8bb | 75 | return ch; |
48a486cd BV |
76 | } |
77 | ||
fe71c7e4 GS |
78 | /** |
79 | * Release a previously allocated struct sr_channel. | |
80 | * | |
81 | * @param[in] ch Pointer to struct sr_channel. | |
82 | * | |
83 | * @private | |
84 | */ | |
85 | SR_PRIV void sr_channel_free(struct sr_channel *ch) | |
86 | { | |
87 | if (!ch) | |
88 | return; | |
89 | g_free(ch->name); | |
90 | g_free(ch->priv); | |
91 | g_free(ch); | |
92 | } | |
93 | ||
94 | /** | |
95 | * Wrapper around @ref sr_channel_free(), suitable for glib iterators. | |
82b9f3d1 UH |
96 | * |
97 | * @private | |
fe71c7e4 GS |
98 | */ |
99 | SR_PRIV void sr_channel_free_cb(void *p) | |
100 | { | |
101 | sr_channel_free(p); | |
102 | } | |
103 | ||
94799bc4 | 104 | /** |
6f1346fb | 105 | * Set the name of the specified channel. |
94799bc4 | 106 | * |
ba7dd8bb | 107 | * If the channel already has a different name assigned to it, it will be |
94799bc4 UH |
108 | * removed, and the new name will be saved instead. |
109 | * | |
2ecc745c UH |
110 | * @param[in] channel The channel whose name to set. Must not be NULL. |
111 | * @param[in] name The new name that the specified channel should get. | |
112 | * A copy of the string is made. | |
0e3b1439 | 113 | * |
37e8b4c4 | 114 | * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. |
9fb5f2df | 115 | * |
47117241 | 116 | * @since 0.3.0 |
94799bc4 | 117 | */ |
6f1346fb ML |
118 | SR_API int sr_dev_channel_name_set(struct sr_channel *channel, |
119 | const char *name) | |
a1bb33af | 120 | { |
2ecc745c | 121 | if (!channel) |
0e3b1439 | 122 | return SR_ERR_ARG; |
94799bc4 | 123 | |
6f1346fb ML |
124 | g_free(channel->name); |
125 | channel->name = g_strdup(name); | |
2ecc745c | 126 | |
6f1346fb | 127 | return SR_OK; |
a1bb33af UH |
128 | } |
129 | ||
be5bf44d | 130 | /** |
6f1346fb | 131 | * Enable or disable a channel. |
be5bf44d | 132 | * |
2ecc745c UH |
133 | * @param[in] channel The channel to enable or disable. Must not be NULL. |
134 | * @param[in] state TRUE to enable the channel, FALSE to disable. | |
be5bf44d | 135 | * |
2ecc745c | 136 | * @return SR_OK on success or SR_ERR on failure. In case of invalid |
ba7dd8bb | 137 | * arguments, SR_ERR_ARG is returned and the channel enabled state |
2a854d71 | 138 | * remains unchanged. |
9fb5f2df | 139 | * |
47117241 | 140 | * @since 0.3.0 |
be5bf44d | 141 | */ |
2ecc745c | 142 | SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state) |
be5bf44d | 143 | { |
be5bf44d | 144 | int ret; |
2a854d71 | 145 | gboolean was_enabled; |
6f1346fb | 146 | struct sr_dev_inst *sdi; |
be5bf44d | 147 | |
6f1346fb | 148 | if (!channel) |
be5bf44d BV |
149 | return SR_ERR_ARG; |
150 | ||
6f1346fb ML |
151 | sdi = channel->sdi; |
152 | was_enabled = channel->enabled; | |
153 | channel->enabled = state; | |
154 | if (!state != !was_enabled && sdi->driver | |
155 | && sdi->driver->config_channel_set) { | |
156 | ret = sdi->driver->config_channel_set( | |
157 | sdi, channel, SR_CHANNEL_SET_ENABLED); | |
158 | /* Roll back change if it wasn't applicable. */ | |
159 | if (ret != SR_OK) | |
160 | return ret; | |
be5bf44d BV |
161 | } |
162 | ||
6f1346fb | 163 | return SR_OK; |
be5bf44d BV |
164 | } |
165 | ||
17a82e83 FS |
166 | /** |
167 | * Returns the next enabled channel, wrapping around if necessary. | |
168 | * | |
169 | * @param[in] sdi The device instance the channel is connected to. | |
170 | * Must not be NULL. | |
171 | * @param[in] cur_channel The current channel. | |
172 | * | |
173 | * @return A pointer to the next enabled channel of this device. | |
174 | * | |
175 | * @private | |
176 | */ | |
9c24d16a BV |
177 | SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi, |
178 | struct sr_channel *cur_channel) | |
179 | { | |
180 | struct sr_channel *next_channel; | |
181 | GSList *l; | |
182 | ||
183 | next_channel = cur_channel; | |
184 | do { | |
185 | l = g_slist_find(sdi->channels, next_channel); | |
186 | if (l && l->next) | |
187 | next_channel = l->next->data; | |
188 | else | |
189 | next_channel = sdi->channels->data; | |
190 | } while (!next_channel->enabled); | |
191 | ||
192 | return next_channel; | |
193 | } | |
194 | ||
712f981d GS |
195 | /** |
196 | * Compare two channels, return whether they differ. | |
197 | * | |
198 | * The channels' names and types are checked. The enabled state is not | |
199 | * considered a condition for difference. The test is motivated by the | |
200 | * desire to detect changes in the configuration of acquisition setups | |
201 | * between re-reads of an input file. | |
202 | * | |
203 | * @param[in] ch1 First channel. | |
204 | * @param[in] ch2 Second channel. | |
205 | * | |
206 | * @return #TRUE upon differences or unexpected input, #FALSE otherwise. | |
207 | * | |
82b9f3d1 | 208 | * @private |
712f981d GS |
209 | */ |
210 | SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2) | |
211 | { | |
212 | if (!ch1 || !ch2) | |
213 | return TRUE; | |
214 | ||
215 | if (ch1->type != ch2->type) | |
216 | return TRUE; | |
217 | if (strcmp(ch1->name, ch2->name)) | |
218 | return TRUE; | |
219 | ||
220 | return FALSE; | |
221 | } | |
222 | ||
223 | /** | |
224 | * Compare two channel lists, return whether they differ. | |
225 | * | |
226 | * Listing the same set of channels but in a different order is considered | |
227 | * a difference in the lists. | |
228 | * | |
229 | * @param[in] l1 First channel list. | |
230 | * @param[in] l2 Second channel list. | |
231 | * | |
232 | * @return #TRUE upon differences or unexpected input, #FALSE otherwise. | |
233 | * | |
82b9f3d1 | 234 | * @private |
712f981d GS |
235 | */ |
236 | SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2) | |
237 | { | |
238 | struct sr_channel *ch1, *ch2; | |
239 | ||
240 | while (l1 && l2) { | |
241 | ch1 = l1->data; | |
242 | ch2 = l2->data; | |
243 | l1 = l1->next; | |
244 | l2 = l2->next; | |
245 | if (!ch1 || !ch2) | |
246 | return TRUE; | |
247 | if (sr_channels_differ(ch1, ch2)) | |
248 | return TRUE; | |
249 | if (ch1->index != ch2->index) | |
250 | return TRUE; | |
251 | } | |
252 | if (l1 || l2) | |
253 | return TRUE; | |
254 | ||
255 | return FALSE; | |
256 | } | |
257 | ||
94799bc4 | 258 | /** |
9c5332d2 UH |
259 | * Determine whether the specified device instance has the specified |
260 | * capability. | |
94799bc4 | 261 | * |
9c5332d2 | 262 | * @param sdi Pointer to the device instance to be checked. Must not be NULL. |
8ec95d22 UH |
263 | * If the device's 'driver' field is NULL (virtual device), this |
264 | * function will always return FALSE (virtual devices don't have | |
265 | * a hardware capabilities list). | |
04cb9157 | 266 | * @param[in] key The option that should be checked for is supported by the |
4d15e5c9 | 267 | * specified device. |
94799bc4 | 268 | * |
2ecc745c | 269 | * @retval TRUE Device has the specified option. |
04cb9157 MH |
270 | * @retval FALSE Device does not have the specified option, invalid input |
271 | * parameters or other error conditions. | |
9fb5f2df | 272 | * |
53f05fa8 | 273 | * @since 0.2.0 |
94799bc4 | 274 | */ |
4d15e5c9 | 275 | SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) |
7d658874 | 276 | { |
003595ac | 277 | GVariant *gvar; |
4d15e5c9 | 278 | const int *devopts; |
003595ac BV |
279 | gsize num_opts, i; |
280 | int ret; | |
7d658874 | 281 | |
003595ac | 282 | if (!sdi || !sdi->driver || !sdi->driver->config_list) |
8ec95d22 | 283 | return FALSE; |
94799bc4 | 284 | |
8f996b89 | 285 | if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, |
92b68bb5 | 286 | &gvar, sdi, NULL) != SR_OK) |
8ec95d22 | 287 | return FALSE; |
94799bc4 | 288 | |
003595ac BV |
289 | ret = FALSE; |
290 | devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t)); | |
291 | for (i = 0; i < num_opts; i++) { | |
d099d880 | 292 | if ((devopts[i] & SR_CONF_MASK) == key) { |
003595ac BV |
293 | ret = TRUE; |
294 | break; | |
295 | } | |
94799bc4 | 296 | } |
003595ac | 297 | g_variant_unref(gvar); |
218557b8 | 298 | |
003595ac | 299 | return ret; |
a1bb33af | 300 | } |
fd9836bf | 301 | |
e7136c62 ML |
302 | /** |
303 | * Enumerate the configuration options of the specified item. | |
304 | * | |
305 | * @param driver Pointer to the driver to be checked. Must not be NULL. | |
306 | * @param sdi Pointer to the device instance to be checked. May be NULL to | |
307 | * check driver options. | |
2ecc745c UH |
308 | * @param cg Pointer to a channel group, if a specific channel group is to |
309 | * be checked. Must be NULL to check device-wide options. | |
310 | * | |
e7136c62 ML |
311 | * @return A GArray * of enum sr_configkey values, or NULL on invalid |
312 | * arguments. The array must be freed by the caller using | |
313 | * g_array_free(). | |
314 | * | |
315 | * @since 0.4.0 | |
316 | */ | |
2ecc745c UH |
317 | SR_API GArray *sr_dev_options(const struct sr_dev_driver *driver, |
318 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg) | |
e7136c62 ML |
319 | { |
320 | GVariant *gvar; | |
321 | const uint32_t *opts; | |
322 | uint32_t opt; | |
323 | gsize num_opts, i; | |
324 | GArray *result; | |
325 | ||
326 | if (!driver || !driver->config_list) | |
327 | return NULL; | |
328 | ||
329 | if (sdi && sdi->driver != driver) | |
330 | return NULL; | |
331 | ||
332 | if (driver->config_list(SR_CONF_DEVICE_OPTIONS, &gvar, sdi, cg) != SR_OK) | |
333 | return NULL; | |
334 | ||
335 | opts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(uint32_t)); | |
336 | ||
337 | result = g_array_sized_new(FALSE, FALSE, sizeof(uint32_t), num_opts); | |
338 | ||
339 | for (i = 0; i < num_opts; i++) { | |
340 | opt = opts[i] & SR_CONF_MASK; | |
341 | g_array_insert_val(result, i, opt); | |
342 | } | |
343 | ||
344 | g_variant_unref(gvar); | |
345 | ||
346 | return result; | |
347 | } | |
348 | ||
71e9c54d ML |
349 | /** |
350 | * Enumerate the configuration capabilities supported by a device instance | |
351 | * for a given configuration key. | |
352 | * | |
353 | * @param sdi Pointer to the device instance to be checked. Must not be NULL. | |
354 | * If the device's 'driver' field is NULL (virtual device), this | |
355 | * function will always return FALSE (virtual devices don't have | |
356 | * a hardware capabilities list). | |
2ecc745c UH |
357 | * @param cg Pointer to a channel group, if a specific channel group is to |
358 | * be checked. Must be NULL to check device-wide options. | |
71e9c54d ML |
359 | * @param[in] key The option that should be checked for is supported by the |
360 | * specified device. | |
361 | * | |
362 | * @retval A bitmask of enum sr_configcap values, which will be zero for | |
363 | * invalid inputs or if the key is unsupported. | |
364 | * | |
365 | * @since 0.4.0 | |
366 | */ | |
0c697a4b | 367 | SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi, |
71e9c54d ML |
368 | const struct sr_channel_group *cg, const int key) |
369 | { | |
370 | GVariant *gvar; | |
371 | const int *devopts; | |
372 | gsize num_opts, i; | |
373 | int ret; | |
374 | ||
375 | if (!sdi || !sdi->driver || !sdi->driver->config_list) | |
376 | return 0; | |
377 | ||
378 | if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, | |
379 | &gvar, sdi, cg) != SR_OK) | |
380 | return 0; | |
381 | ||
382 | ret = 0; | |
383 | devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t)); | |
384 | for (i = 0; i < num_opts; i++) { | |
385 | if ((devopts[i] & SR_CONF_MASK) == key) { | |
386 | ret = devopts[i] & ~SR_CONF_MASK; | |
387 | break; | |
388 | } | |
389 | } | |
390 | g_variant_unref(gvar); | |
391 | ||
392 | return ret; | |
393 | } | |
394 | ||
e705ce3b UH |
395 | /** |
396 | * Allocate and init a new user-generated device instance. | |
aac29cc1 | 397 | * |
2ecc745c UH |
398 | * @param vendor Device vendor. |
399 | * @param model Device model. | |
400 | * @param version Device version. | |
aac29cc1 UH |
401 | * |
402 | * @retval struct sr_dev_inst *. Dynamically allocated, free using | |
403 | * sr_dev_inst_free(). | |
e705ce3b UH |
404 | */ |
405 | SR_API struct sr_dev_inst *sr_dev_inst_user_new(const char *vendor, | |
406 | const char *model, const char *version) | |
407 | { | |
408 | struct sr_dev_inst *sdi; | |
409 | ||
e47a9562 | 410 | sdi = g_malloc0(sizeof(*sdi)); |
aac29cc1 | 411 | |
0af636be UH |
412 | sdi->vendor = g_strdup(vendor); |
413 | sdi->model = g_strdup(model); | |
414 | sdi->version = g_strdup(version); | |
e705ce3b UH |
415 | sdi->inst_type = SR_INST_USER; |
416 | ||
417 | return sdi; | |
418 | } | |
419 | ||
420 | /** | |
421 | * Add a new channel to the specified device instance. | |
2ecc745c UH |
422 | * |
423 | * @param[in] index @copydoc sr_channel::index | |
424 | * @param[in] type @copydoc sr_channel::type | |
425 | * @param[in] name @copydoc sr_channel::name | |
426 | * | |
427 | * @return SR_OK Success. | |
428 | * @return SR_OK Invalid argument. | |
e705ce3b UH |
429 | */ |
430 | SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name) | |
431 | { | |
e705ce3b UH |
432 | if (!sdi || sdi->inst_type != SR_INST_USER || index < 0) |
433 | return SR_ERR_ARG; | |
434 | ||
5e23fcab | 435 | sr_channel_new(sdi, index, type, TRUE, name); |
e705ce3b UH |
436 | |
437 | return SR_OK; | |
438 | } | |
439 | ||
2ecc745c UH |
440 | /** |
441 | * Free device instance struct created by sr_dev_inst(). | |
442 | * | |
4bf93988 | 443 | * @param sdi Device instance to free. If NULL, the function will do nothing. |
2ecc745c UH |
444 | * |
445 | * @private | |
04cb9157 | 446 | */ |
48a486cd BV |
447 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) |
448 | { | |
ba7dd8bb | 449 | struct sr_channel *ch; |
b1b1944e | 450 | struct sr_channel_group *cg; |
d3cff734 BV |
451 | GSList *l; |
452 | ||
4bf93988 UH |
453 | if (!sdi) |
454 | return; | |
455 | ||
ba7dd8bb UH |
456 | for (l = sdi->channels; l; l = l->next) { |
457 | ch = l->data; | |
fe71c7e4 | 458 | sr_channel_free(ch); |
d3cff734 | 459 | } |
ba7dd8bb | 460 | g_slist_free(sdi->channels); |
d3cff734 | 461 | |
b1b1944e BV |
462 | for (l = sdi->channel_groups; l; l = l->next) { |
463 | cg = l->data; | |
7aebe22d BV |
464 | g_free(cg->name); |
465 | g_slist_free(cg->channels); | |
b1b1944e | 466 | g_free(cg->priv); |
7aebe22d | 467 | g_free(cg); |
b1b1944e BV |
468 | } |
469 | g_slist_free(sdi->channel_groups); | |
90c7f4e9 | 470 | |
fe7b8efc SB |
471 | if (sdi->session) |
472 | sr_session_dev_remove(sdi->session, sdi); | |
473 | ||
48a486cd BV |
474 | g_free(sdi->vendor); |
475 | g_free(sdi->model); | |
476 | g_free(sdi->version); | |
2fe6210a SA |
477 | g_free(sdi->serial_num); |
478 | g_free(sdi->connection_id); | |
48a486cd BV |
479 | g_free(sdi); |
480 | } | |
481 | ||
482 | #ifdef HAVE_LIBUSB_1_0 | |
483 | ||
2ecc745c UH |
484 | /** |
485 | * Allocate and init a struct for a USB device instance. | |
486 | * | |
487 | * @param[in] bus @copydoc sr_usb_dev_inst::bus | |
488 | * @param[in] address @copydoc sr_usb_dev_inst::address | |
489 | * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl | |
04cb9157 | 490 | * |
2ecc745c UH |
491 | * @return The struct sr_usb_dev_inst * for USB device instance. |
492 | * | |
493 | * @private | |
04cb9157 | 494 | */ |
48a486cd BV |
495 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, |
496 | uint8_t address, struct libusb_device_handle *hdl) | |
497 | { | |
498 | struct sr_usb_dev_inst *udi; | |
499 | ||
e47a9562 | 500 | udi = g_malloc0(sizeof(*udi)); |
48a486cd BV |
501 | udi->bus = bus; |
502 | udi->address = address; | |
503 | udi->devhdl = hdl; | |
504 | ||
505 | return udi; | |
506 | } | |
507 | ||
2ecc745c UH |
508 | /** |
509 | * Free struct sr_usb_dev_inst * allocated by sr_usb_dev_inst(). | |
510 | * | |
5801ce78 UH |
511 | * @param usb The struct sr_usb_dev_inst * to free. If NULL, this |
512 | * function does nothing. | |
2ecc745c UH |
513 | * |
514 | * @private | |
04cb9157 | 515 | */ |
48a486cd BV |
516 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) |
517 | { | |
a006798b | 518 | g_free(usb); |
48a486cd BV |
519 | } |
520 | ||
521 | #endif | |
522 | ||
1df81f4b | 523 | #ifdef HAVE_SERIAL_COMM |
c4f2dfd0 | 524 | |
9fb5f2df | 525 | /** |
2ecc745c | 526 | * Allocate and init a struct for a serial device instance. |
299bdb24 BV |
527 | * |
528 | * Both parameters are copied to newly allocated strings, and freed | |
529 | * automatically by sr_serial_dev_inst_free(). | |
9fb5f2df | 530 | * |
04cb9157 | 531 | * @param[in] port OS-specific serial port specification. Examples: |
9fb5f2df | 532 | * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1". |
91219afc | 533 | * Must not be NULL. |
04cb9157 MH |
534 | * @param[in] serialcomm A serial communication parameters string, in the form |
535 | * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example | |
536 | * "9600/8n1" or "600/7o2". This is an optional parameter; | |
91219afc | 537 | * it may be filled in later. Can be NULL. |
9fb5f2df UH |
538 | * |
539 | * @return A pointer to a newly initialized struct sr_serial_dev_inst, | |
540 | * or NULL on error. | |
2ecc745c UH |
541 | * |
542 | * @private | |
299bdb24 | 543 | */ |
48a486cd | 544 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, |
299bdb24 | 545 | const char *serialcomm) |
48a486cd BV |
546 | { |
547 | struct sr_serial_dev_inst *serial; | |
548 | ||
e47a9562 | 549 | serial = g_malloc0(sizeof(*serial)); |
48a486cd | 550 | serial->port = g_strdup(port); |
299bdb24 BV |
551 | if (serialcomm) |
552 | serial->serialcomm = g_strdup(serialcomm); | |
48a486cd BV |
553 | |
554 | return serial; | |
555 | } | |
556 | ||
2ecc745c UH |
557 | /** |
558 | * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst(). | |
559 | * | |
04891a99 UH |
560 | * @param serial The struct sr_serial_dev_inst * to free. If NULL, this |
561 | * function will do nothing. | |
2ecc745c UH |
562 | * |
563 | * @private | |
04cb9157 | 564 | */ |
48a486cd BV |
565 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) |
566 | { | |
04891a99 UH |
567 | if (!serial) |
568 | return; | |
569 | ||
48a486cd | 570 | g_free(serial->port); |
299bdb24 | 571 | g_free(serial->serialcomm); |
acac8fc3 | 572 | g_free(serial); |
48a486cd | 573 | } |
c4f2dfd0 UH |
574 | #endif |
575 | ||
df823ac4 | 576 | /** @private */ |
ae67644f ML |
577 | SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device) |
578 | { | |
579 | struct sr_usbtmc_dev_inst *usbtmc; | |
580 | ||
e47a9562 | 581 | usbtmc = g_malloc0(sizeof(*usbtmc)); |
ae67644f ML |
582 | usbtmc->device = g_strdup(device); |
583 | usbtmc->fd = -1; | |
584 | ||
585 | return usbtmc; | |
586 | } | |
587 | ||
df823ac4 | 588 | /** @private */ |
ae67644f ML |
589 | SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc) |
590 | { | |
ce375f2a UH |
591 | if (!usbtmc) |
592 | return; | |
593 | ||
ae67644f ML |
594 | g_free(usbtmc->device); |
595 | g_free(usbtmc); | |
596 | } | |
597 | ||
576ff5b0 UH |
598 | /** |
599 | * Get the list of devices/instances of the specified driver. | |
600 | * | |
601 | * @param driver The driver to use. Must not be NULL. | |
602 | * | |
603 | * @return The list of devices/instances of this driver, or NULL upon errors | |
604 | * or if the list is empty. | |
605 | * | |
53f05fa8 | 606 | * @since 0.2.0 |
576ff5b0 | 607 | */ |
f99e32af | 608 | SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver) |
811deee4 | 609 | { |
811deee4 | 610 | if (driver && driver->dev_list) |
4f840ce9 | 611 | return driver->dev_list(driver); |
811deee4 BV |
612 | else |
613 | return NULL; | |
614 | } | |
615 | ||
576ff5b0 | 616 | /** |
8102cee4 | 617 | * Clear the list of device instances a driver knows about. |
576ff5b0 | 618 | * |
8102cee4 BV |
619 | * @param driver The driver to use. This must be a pointer to one of |
620 | * the entries returned by sr_driver_list(). Must not be NULL. | |
576ff5b0 | 621 | * |
2ecc745c UH |
622 | * @retval SR_OK Success. |
623 | * @retval SR_ERR_ARG Invalid driver. | |
576ff5b0 UH |
624 | * |
625 | * @since 0.2.0 | |
626 | */ | |
f99e32af | 627 | SR_API int sr_dev_clear(const struct sr_dev_driver *driver) |
811deee4 | 628 | { |
8102cee4 BV |
629 | if (!driver) { |
630 | sr_err("Invalid driver."); | |
631 | return SR_ERR_ARG; | |
632 | } | |
633 | ||
12852b03 UH |
634 | if (!driver->context) { |
635 | /* | |
636 | * Driver was never initialized, nothing to do. | |
637 | * | |
638 | * No log message since this usually gets called for all | |
639 | * drivers, whether they were initialized or not. | |
640 | */ | |
641 | return SR_OK; | |
642 | } | |
643 | ||
91057d2f UH |
644 | /* No log message here, too verbose and not very useful. */ |
645 | ||
f778bf02 | 646 | return driver->dev_clear(driver); |
811deee4 BV |
647 | } |
648 | ||
576ff5b0 | 649 | /** |
7e463623 UH |
650 | * Open the specified device instance. |
651 | * | |
652 | * If the device instance is already open (sdi->status == SR_ST_ACTIVE), | |
653 | * SR_ERR will be returned and no re-opening of the device will be attempted. | |
654 | * | |
655 | * If opening was successful, sdi->status is set to SR_ST_ACTIVE, otherwise | |
656 | * it will be left unchanged. | |
576ff5b0 UH |
657 | * |
658 | * @param sdi Device instance to use. Must not be NULL. | |
659 | * | |
7e463623 UH |
660 | * @retval SR_OK Success. |
661 | * @retval SR_ERR_ARG Invalid arguments. | |
662 | * @retval SR_ERR Device instance was already active, or other error. | |
576ff5b0 UH |
663 | * |
664 | * @since 0.2.0 | |
665 | */ | |
efdecf4c BV |
666 | SR_API int sr_dev_open(struct sr_dev_inst *sdi) |
667 | { | |
668 | int ret; | |
669 | ||
670 | if (!sdi || !sdi->driver || !sdi->driver->dev_open) | |
7e463623 | 671 | return SR_ERR_ARG; |
efdecf4c | 672 | |
6402c379 UH |
673 | if (sdi->status == SR_ST_ACTIVE) { |
674 | sr_err("%s: Device instance already active, can't re-open.", | |
675 | sdi->driver->name); | |
676 | return SR_ERR; | |
677 | } | |
678 | ||
7e463623 | 679 | sr_dbg("%s: Opening device instance.", sdi->driver->name); |
6402c379 | 680 | |
efdecf4c BV |
681 | ret = sdi->driver->dev_open(sdi); |
682 | ||
7e463623 UH |
683 | if (ret == SR_OK) |
684 | sdi->status = SR_ST_ACTIVE; | |
685 | ||
efdecf4c BV |
686 | return ret; |
687 | } | |
688 | ||
576ff5b0 | 689 | /** |
f1ba6b4b UH |
690 | * Close the specified device instance. |
691 | * | |
692 | * If the device instance is not open (sdi->status != SR_ST_ACTIVE), | |
693 | * SR_ERR_DEV_CLOSED will be returned and no closing will be attempted. | |
694 | * | |
695 | * Note: sdi->status will be set to SR_ST_INACTIVE, regardless of whether | |
696 | * there are any errors during closing of the device instance (any errors | |
697 | * will be reported via error code and log message, though). | |
576ff5b0 UH |
698 | * |
699 | * @param sdi Device instance to use. Must not be NULL. | |
700 | * | |
f1ba6b4b UH |
701 | * @retval SR_OK Success. |
702 | * @retval SR_ERR_ARG Invalid arguments. | |
703 | * @retval SR_ERR_DEV_CLOSED Device instance was not active. | |
704 | * @retval SR_ERR Other error. | |
576ff5b0 UH |
705 | * |
706 | * @since 0.2.0 | |
707 | */ | |
efdecf4c BV |
708 | SR_API int sr_dev_close(struct sr_dev_inst *sdi) |
709 | { | |
efdecf4c | 710 | if (!sdi || !sdi->driver || !sdi->driver->dev_close) |
f1ba6b4b | 711 | return SR_ERR_ARG; |
efdecf4c | 712 | |
093e1cba UH |
713 | if (sdi->status != SR_ST_ACTIVE) { |
714 | sr_err("%s: Device instance not active, can't close.", | |
715 | sdi->driver->name); | |
716 | return SR_ERR_DEV_CLOSED; | |
717 | } | |
718 | ||
f1ba6b4b UH |
719 | sdi->status = SR_ST_INACTIVE; |
720 | ||
721 | sr_dbg("%s: Closing device instance.", sdi->driver->name); | |
093e1cba | 722 | |
56c8dd82 | 723 | return sdi->driver->dev_close(sdi); |
efdecf4c BV |
724 | } |
725 | ||
0157fdce SA |
726 | /** |
727 | * Queries a device instances' driver. | |
728 | * | |
729 | * @param sdi Device instance to use. Must not be NULL. | |
730 | * | |
731 | * @return The driver instance or NULL on error. | |
732 | */ | |
2f5f9705 | 733 | SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi) |
0157fdce SA |
734 | { |
735 | if (!sdi || !sdi->driver) | |
736 | return NULL; | |
737 | ||
738 | return sdi->driver; | |
739 | } | |
740 | ||
741 | /** | |
742 | * Queries a device instances' vendor. | |
743 | * | |
744 | * @param sdi Device instance to use. Must not be NULL. | |
745 | * | |
746 | * @return The vendor string or NULL. | |
747 | */ | |
2f5f9705 | 748 | SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi) |
0157fdce SA |
749 | { |
750 | if (!sdi) | |
751 | return NULL; | |
752 | ||
753 | return sdi->vendor; | |
754 | } | |
755 | ||
756 | /** | |
757 | * Queries a device instances' model. | |
758 | * | |
759 | * @param sdi Device instance to use. Must not be NULL. | |
760 | * | |
761 | * @return The model string or NULL. | |
762 | */ | |
2f5f9705 | 763 | SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi) |
0157fdce SA |
764 | { |
765 | if (!sdi) | |
766 | return NULL; | |
767 | ||
768 | return sdi->model; | |
769 | } | |
770 | ||
771 | /** | |
772 | * Queries a device instances' version. | |
773 | * | |
774 | * @param sdi Device instance to use. Must not be NULL. | |
775 | * | |
776 | * @return The version string or NULL. | |
777 | */ | |
2f5f9705 | 778 | SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi) |
0157fdce SA |
779 | { |
780 | if (!sdi) | |
781 | return NULL; | |
782 | ||
783 | return sdi->version; | |
784 | } | |
785 | ||
786 | /** | |
787 | * Queries a device instances' serial number. | |
788 | * | |
789 | * @param sdi Device instance to use. Must not be NULL. | |
790 | * | |
791 | * @return The serial number string or NULL. | |
792 | */ | |
2f5f9705 | 793 | SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi) |
0157fdce SA |
794 | { |
795 | if (!sdi) | |
796 | return NULL; | |
797 | ||
798 | return sdi->serial_num; | |
799 | } | |
800 | ||
801 | /** | |
802 | * Queries a device instances' connection identifier. | |
803 | * | |
804 | * @param sdi Device instance to use. Must not be NULL. | |
805 | * | |
2ecc745c | 806 | * @return A copy of the connection ID string or NULL. The caller is responsible |
0157fdce SA |
807 | * for g_free()ing the string when it is no longer needed. |
808 | */ | |
2f5f9705 | 809 | SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi) |
0157fdce | 810 | { |
468665df | 811 | #ifdef HAVE_LIBUSB_1_0 |
0157fdce | 812 | struct drv_context *drvc; |
8de8551b | 813 | int cnt, i, a, b; |
8107a9a6 | 814 | char conn_id_usb[64]; |
0157fdce SA |
815 | struct sr_usb_dev_inst *usb; |
816 | struct libusb_device **devlist; | |
9c6a2913 | 817 | #endif |
0157fdce | 818 | |
1df81f4b | 819 | #ifdef HAVE_SERIAL_COMM |
8107a9a6 FS |
820 | struct sr_serial_dev_inst *serial; |
821 | #endif | |
822 | ||
823 | struct sr_scpi_dev_inst *scpi; | |
824 | char *conn_id_scpi; | |
825 | ||
0157fdce SA |
826 | if (!sdi) |
827 | return NULL; | |
828 | ||
1df81f4b | 829 | #ifdef HAVE_SERIAL_COMM |
e8cbb223 | 830 | if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) { |
8107a9a6 | 831 | /* connection_id isn't populated, let's do that for serial devices. */ |
e8cbb223 SA |
832 | |
833 | serial = sdi->conn; | |
2f5f9705 | 834 | ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(serial->port); |
e8cbb223 | 835 | } |
9c6a2913 | 836 | #endif |
e8cbb223 | 837 | |
9c6a2913 | 838 | #ifdef HAVE_LIBUSB_1_0 |
0157fdce | 839 | if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) { |
8107a9a6 | 840 | /* connection_id isn't populated, let's do that for USB devices. */ |
0157fdce | 841 | |
41812aca | 842 | drvc = sdi->driver->context; |
0157fdce SA |
843 | usb = sdi->conn; |
844 | ||
845 | if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) { | |
846 | sr_err("Failed to retrieve device list: %s.", | |
847 | libusb_error_name(cnt)); | |
848 | return NULL; | |
849 | } | |
850 | ||
851 | for (i = 0; i < cnt; i++) { | |
0157fdce SA |
852 | /* Find the USB device by the logical address we know. */ |
853 | b = libusb_get_bus_number(devlist[i]); | |
854 | a = libusb_get_device_address(devlist[i]); | |
855 | if (b != usb->bus || a != usb->address) | |
856 | continue; | |
857 | ||
8107a9a6 | 858 | if (usb_get_port_path(devlist[i], conn_id_usb, sizeof(conn_id_usb)) < 0) |
6c1a76d1 RT |
859 | continue; |
860 | ||
8107a9a6 | 861 | ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_usb); |
0157fdce SA |
862 | break; |
863 | } | |
864 | ||
865 | libusb_free_device_list(devlist, 1); | |
866 | } | |
9c6a2913 | 867 | #endif |
0157fdce | 868 | |
8107a9a6 FS |
869 | if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SCPI)) { |
870 | /* connection_id isn't populated, let's do that for SCPI devices. */ | |
871 | ||
872 | scpi = sdi->conn; | |
873 | sr_scpi_connection_id(scpi, &conn_id_scpi); | |
874 | ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_scpi); | |
875 | g_free(conn_id_scpi); | |
876 | } | |
877 | ||
0157fdce SA |
878 | return sdi->connection_id; |
879 | } | |
880 | ||
e437da2b UH |
881 | /** |
882 | * Queries a device instances' channel list. | |
883 | * | |
884 | * @param sdi Device instance to use. Must not be NULL. | |
885 | * | |
886 | * @return The GSList of channels or NULL. | |
887 | */ | |
2f5f9705 | 888 | SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi) |
e437da2b UH |
889 | { |
890 | if (!sdi) | |
891 | return NULL; | |
892 | ||
893 | return sdi->channels; | |
894 | } | |
895 | ||
896 | /** | |
897 | * Queries a device instances' channel groups list. | |
898 | * | |
899 | * @param sdi Device instance to use. Must not be NULL. | |
900 | * | |
901 | * @return The GSList of channel groups or NULL. | |
902 | */ | |
2f5f9705 | 903 | SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi) |
e437da2b UH |
904 | { |
905 | if (!sdi) | |
906 | return NULL; | |
907 | ||
908 | return sdi->channel_groups; | |
909 | } | |
910 | ||
7b870c38 | 911 | /** @} */ |