]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the libsigrok project. | |
3 | * | |
4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> | |
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 <config.h> | |
21 | #include <glib.h> | |
22 | #include <stdio.h> | |
23 | #include <string.h> | |
24 | #include <libsigrok/libsigrok.h> | |
25 | #include "libsigrok-internal.h" | |
26 | #include "scpi.h" | |
27 | ||
28 | /** @cond PRIVATE */ | |
29 | #define LOG_PREFIX "device" | |
30 | /** @endcond */ | |
31 | ||
32 | /** | |
33 | * @file | |
34 | * | |
35 | * Device handling in libsigrok. | |
36 | */ | |
37 | ||
38 | /** | |
39 | * @defgroup grp_devices Devices | |
40 | * | |
41 | * Device handling in libsigrok. | |
42 | * | |
43 | * @{ | |
44 | */ | |
45 | ||
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 | |
59 | */ | |
60 | SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi, | |
61 | int index, int type, gboolean enabled, const char *name) | |
62 | { | |
63 | struct sr_channel *ch; | |
64 | ||
65 | ch = g_malloc0(sizeof(*ch)); | |
66 | ch->sdi = sdi; | |
67 | ch->index = index; | |
68 | ch->type = type; | |
69 | ch->enabled = enabled; | |
70 | if (name) | |
71 | ch->name = g_strdup(name); | |
72 | ||
73 | sdi->channels = g_slist_append(sdi->channels, ch); | |
74 | ||
75 | return ch; | |
76 | } | |
77 | ||
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 sr_channel_free(), suitable for glib iterators. | |
96 | * | |
97 | * @private | |
98 | */ | |
99 | SR_PRIV void sr_channel_free_cb(void *p) | |
100 | { | |
101 | sr_channel_free(p); | |
102 | } | |
103 | ||
104 | /** | |
105 | * Set the name of the specified channel. | |
106 | * | |
107 | * If the channel already has a different name assigned to it, it will be | |
108 | * removed, and the new name will be saved instead. | |
109 | * | |
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. | |
113 | * | |
114 | * @return SR_OK on success, or SR_ERR_ARG on invalid arguments. | |
115 | * | |
116 | * @since 0.3.0 | |
117 | */ | |
118 | SR_API int sr_dev_channel_name_set(struct sr_channel *channel, | |
119 | const char *name) | |
120 | { | |
121 | if (!channel) | |
122 | return SR_ERR_ARG; | |
123 | ||
124 | g_free(channel->name); | |
125 | channel->name = g_strdup(name); | |
126 | ||
127 | return SR_OK; | |
128 | } | |
129 | ||
130 | /** | |
131 | * Enable or disable a channel. | |
132 | * | |
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. | |
135 | * | |
136 | * @return SR_OK on success or SR_ERR on failure. In case of invalid | |
137 | * arguments, SR_ERR_ARG is returned and the channel enabled state | |
138 | * remains unchanged. | |
139 | * | |
140 | * @since 0.3.0 | |
141 | */ | |
142 | SR_API int sr_dev_channel_enable(struct sr_channel *channel, gboolean state) | |
143 | { | |
144 | int ret; | |
145 | gboolean was_enabled; | |
146 | struct sr_dev_inst *sdi; | |
147 | ||
148 | if (!channel) | |
149 | return SR_ERR_ARG; | |
150 | ||
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; | |
161 | } | |
162 | ||
163 | return SR_OK; | |
164 | } | |
165 | ||
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 | */ | |
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 | ||
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 | * | |
208 | * @private | |
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 | * | |
234 | * @private | |
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 | ||
258 | /** | |
259 | * Determine whether the specified device instance has the specified | |
260 | * capability. | |
261 | * | |
262 | * @param sdi Pointer to the device instance to be checked. Must not be NULL. | |
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). | |
266 | * @param[in] key The option that should be checked for is supported by the | |
267 | * specified device. | |
268 | * | |
269 | * @retval TRUE Device has the specified option. | |
270 | * @retval FALSE Device does not have the specified option, invalid input | |
271 | * parameters or other error conditions. | |
272 | * | |
273 | * @since 0.2.0 | |
274 | */ | |
275 | SR_API gboolean sr_dev_has_option(const struct sr_dev_inst *sdi, int key) | |
276 | { | |
277 | GVariant *gvar; | |
278 | const int *devopts; | |
279 | gsize num_opts, i; | |
280 | int ret; | |
281 | ||
282 | if (!sdi || !sdi->driver || !sdi->driver->config_list) | |
283 | return FALSE; | |
284 | ||
285 | if (sdi->driver->config_list(SR_CONF_DEVICE_OPTIONS, | |
286 | &gvar, sdi, NULL) != SR_OK) | |
287 | return FALSE; | |
288 | ||
289 | ret = FALSE; | |
290 | devopts = g_variant_get_fixed_array(gvar, &num_opts, sizeof(int32_t)); | |
291 | for (i = 0; i < num_opts; i++) { | |
292 | if ((devopts[i] & SR_CONF_MASK) == key) { | |
293 | ret = TRUE; | |
294 | break; | |
295 | } | |
296 | } | |
297 | g_variant_unref(gvar); | |
298 | ||
299 | return ret; | |
300 | } | |
301 | ||
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. | |
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 | * | |
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 | */ | |
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) | |
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 | ||
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). | |
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. | |
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 | */ | |
367 | SR_API int sr_dev_config_capabilities_list(const struct sr_dev_inst *sdi, | |
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 | ||
395 | /** | |
396 | * Allocate and init a new user-generated device instance. | |
397 | * | |
398 | * @param vendor Device vendor. | |
399 | * @param model Device model. | |
400 | * @param version Device version. | |
401 | * | |
402 | * @retval struct sr_dev_inst *. Dynamically allocated, free using | |
403 | * sr_dev_inst_free(). | |
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 | ||
410 | sdi = g_malloc0(sizeof(*sdi)); | |
411 | ||
412 | sdi->vendor = g_strdup(vendor); | |
413 | sdi->model = g_strdup(model); | |
414 | sdi->version = g_strdup(version); | |
415 | sdi->inst_type = SR_INST_USER; | |
416 | ||
417 | return sdi; | |
418 | } | |
419 | ||
420 | /** | |
421 | * Add a new channel to the specified device instance. | |
422 | * | |
423 | * @param[in] sdi Device instance to use. Must not be NULL. | |
424 | * @param[in] index @copydoc sr_channel::index | |
425 | * @param[in] type @copydoc sr_channel::type | |
426 | * @param[in] name @copydoc sr_channel::name | |
427 | * | |
428 | * @return SR_OK Success. | |
429 | * @return SR_OK Invalid argument. | |
430 | */ | |
431 | SR_API int sr_dev_inst_channel_add(struct sr_dev_inst *sdi, int index, int type, const char *name) | |
432 | { | |
433 | if (!sdi || sdi->inst_type != SR_INST_USER || index < 0) | |
434 | return SR_ERR_ARG; | |
435 | ||
436 | sr_channel_new(sdi, index, type, TRUE, name); | |
437 | ||
438 | return SR_OK; | |
439 | } | |
440 | ||
441 | /** | |
442 | * Free device instance struct created by sr_dev_inst(). | |
443 | * | |
444 | * @param sdi Device instance to free. If NULL, the function will do nothing. | |
445 | * | |
446 | * @private | |
447 | */ | |
448 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) | |
449 | { | |
450 | struct sr_channel *ch; | |
451 | struct sr_channel_group *cg; | |
452 | GSList *l; | |
453 | ||
454 | if (!sdi) | |
455 | return; | |
456 | ||
457 | for (l = sdi->channels; l; l = l->next) { | |
458 | ch = l->data; | |
459 | sr_channel_free(ch); | |
460 | } | |
461 | g_slist_free(sdi->channels); | |
462 | ||
463 | for (l = sdi->channel_groups; l; l = l->next) { | |
464 | cg = l->data; | |
465 | g_free(cg->name); | |
466 | g_slist_free(cg->channels); | |
467 | g_free(cg->priv); | |
468 | g_free(cg); | |
469 | } | |
470 | g_slist_free(sdi->channel_groups); | |
471 | ||
472 | if (sdi->session) | |
473 | sr_session_dev_remove(sdi->session, sdi); | |
474 | ||
475 | g_free(sdi->vendor); | |
476 | g_free(sdi->model); | |
477 | g_free(sdi->version); | |
478 | g_free(sdi->serial_num); | |
479 | g_free(sdi->connection_id); | |
480 | g_free(sdi); | |
481 | } | |
482 | ||
483 | #ifdef HAVE_LIBUSB_1_0 | |
484 | ||
485 | /** | |
486 | * Allocate and init a struct for a USB device instance. | |
487 | * | |
488 | * @param[in] bus @copydoc sr_usb_dev_inst::bus | |
489 | * @param[in] address @copydoc sr_usb_dev_inst::address | |
490 | * @param[in] hdl @copydoc sr_usb_dev_inst::devhdl | |
491 | * | |
492 | * @return The struct sr_usb_dev_inst * for USB device instance. | |
493 | * | |
494 | * @private | |
495 | */ | |
496 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, | |
497 | uint8_t address, struct libusb_device_handle *hdl) | |
498 | { | |
499 | struct sr_usb_dev_inst *udi; | |
500 | ||
501 | udi = g_malloc0(sizeof(*udi)); | |
502 | udi->bus = bus; | |
503 | udi->address = address; | |
504 | udi->devhdl = hdl; | |
505 | ||
506 | return udi; | |
507 | } | |
508 | ||
509 | /** | |
510 | * Free struct sr_usb_dev_inst * allocated by sr_usb_dev_inst(). | |
511 | * | |
512 | * @param usb The struct sr_usb_dev_inst * to free. If NULL, this | |
513 | * function does nothing. | |
514 | * | |
515 | * @private | |
516 | */ | |
517 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) | |
518 | { | |
519 | g_free(usb); | |
520 | } | |
521 | ||
522 | #endif | |
523 | ||
524 | #ifdef HAVE_SERIAL_COMM | |
525 | ||
526 | /** | |
527 | * Allocate and init a struct for a serial device instance. | |
528 | * | |
529 | * Both parameters are copied to newly allocated strings, and freed | |
530 | * automatically by sr_serial_dev_inst_free(). | |
531 | * | |
532 | * @param[in] port OS-specific serial port specification. Examples: | |
533 | * "/dev/ttyUSB0", "/dev/ttyACM1", "/dev/tty.Modem-0", "COM1". | |
534 | * Must not be NULL. | |
535 | * @param[in] serialcomm A serial communication parameters string, in the form | |
536 | * of \<speed\>/\<data bits\>\<parity\>\<stopbits\>, for example | |
537 | * "9600/8n1" or "600/7o2". This is an optional parameter; | |
538 | * it may be filled in later. Can be NULL. | |
539 | * | |
540 | * @return A pointer to a newly initialized struct sr_serial_dev_inst, | |
541 | * or NULL on error. | |
542 | * | |
543 | * @private | |
544 | */ | |
545 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, | |
546 | const char *serialcomm) | |
547 | { | |
548 | struct sr_serial_dev_inst *serial; | |
549 | ||
550 | serial = g_malloc0(sizeof(*serial)); | |
551 | serial->port = g_strdup(port); | |
552 | if (serialcomm) | |
553 | serial->serialcomm = g_strdup(serialcomm); | |
554 | ||
555 | return serial; | |
556 | } | |
557 | ||
558 | /** | |
559 | * Free struct sr_serial_dev_inst * allocated by sr_serial_dev_inst(). | |
560 | * | |
561 | * @param serial The struct sr_serial_dev_inst * to free. If NULL, this | |
562 | * function will do nothing. | |
563 | * | |
564 | * @private | |
565 | */ | |
566 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) | |
567 | { | |
568 | if (!serial) | |
569 | return; | |
570 | ||
571 | g_free(serial->port); | |
572 | g_free(serial->serialcomm); | |
573 | g_free(serial); | |
574 | } | |
575 | #endif | |
576 | ||
577 | /** @private */ | |
578 | SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device) | |
579 | { | |
580 | struct sr_usbtmc_dev_inst *usbtmc; | |
581 | ||
582 | usbtmc = g_malloc0(sizeof(*usbtmc)); | |
583 | usbtmc->device = g_strdup(device); | |
584 | usbtmc->fd = -1; | |
585 | ||
586 | return usbtmc; | |
587 | } | |
588 | ||
589 | /** @private */ | |
590 | SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc) | |
591 | { | |
592 | if (!usbtmc) | |
593 | return; | |
594 | ||
595 | g_free(usbtmc->device); | |
596 | g_free(usbtmc); | |
597 | } | |
598 | ||
599 | /** | |
600 | * Get the list of devices/instances of the specified driver. | |
601 | * | |
602 | * @param driver The driver to use. Must not be NULL. | |
603 | * | |
604 | * @return The list of devices/instances of this driver, or NULL upon errors | |
605 | * or if the list is empty. | |
606 | * | |
607 | * @since 0.2.0 | |
608 | */ | |
609 | SR_API GSList *sr_dev_list(const struct sr_dev_driver *driver) | |
610 | { | |
611 | if (driver && driver->dev_list) | |
612 | return driver->dev_list(driver); | |
613 | else | |
614 | return NULL; | |
615 | } | |
616 | ||
617 | /** | |
618 | * Clear the list of device instances a driver knows about. | |
619 | * | |
620 | * @param driver The driver to use. This must be a pointer to one of | |
621 | * the entries returned by sr_driver_list(). Must not be NULL. | |
622 | * | |
623 | * @retval SR_OK Success. | |
624 | * @retval SR_ERR_ARG Invalid driver. | |
625 | * | |
626 | * @since 0.2.0 | |
627 | */ | |
628 | SR_API int sr_dev_clear(const struct sr_dev_driver *driver) | |
629 | { | |
630 | if (!driver) { | |
631 | sr_err("Invalid driver."); | |
632 | return SR_ERR_ARG; | |
633 | } | |
634 | ||
635 | if (!driver->context) { | |
636 | /* | |
637 | * Driver was never initialized, nothing to do. | |
638 | * | |
639 | * No log message since this usually gets called for all | |
640 | * drivers, whether they were initialized or not. | |
641 | */ | |
642 | return SR_OK; | |
643 | } | |
644 | ||
645 | /* No log message here, too verbose and not very useful. */ | |
646 | ||
647 | return driver->dev_clear(driver); | |
648 | } | |
649 | ||
650 | /** | |
651 | * Open the specified device instance. | |
652 | * | |
653 | * If the device instance is already open (sdi->status == SR_ST_ACTIVE), | |
654 | * SR_ERR will be returned and no re-opening of the device will be attempted. | |
655 | * | |
656 | * If opening was successful, sdi->status is set to SR_ST_ACTIVE, otherwise | |
657 | * it will be left unchanged. | |
658 | * | |
659 | * @param sdi Device instance to use. Must not be NULL. | |
660 | * | |
661 | * @retval SR_OK Success. | |
662 | * @retval SR_ERR_ARG Invalid arguments. | |
663 | * @retval SR_ERR Device instance was already active, or other error. | |
664 | * | |
665 | * @since 0.2.0 | |
666 | */ | |
667 | SR_API int sr_dev_open(struct sr_dev_inst *sdi) | |
668 | { | |
669 | int ret; | |
670 | ||
671 | if (!sdi || !sdi->driver || !sdi->driver->dev_open) | |
672 | return SR_ERR_ARG; | |
673 | ||
674 | if (sdi->status == SR_ST_ACTIVE) { | |
675 | sr_err("%s: Device instance already active, can't re-open.", | |
676 | sdi->driver->name); | |
677 | return SR_ERR; | |
678 | } | |
679 | ||
680 | sr_dbg("%s: Opening device instance.", sdi->driver->name); | |
681 | ||
682 | ret = sdi->driver->dev_open(sdi); | |
683 | ||
684 | if (ret == SR_OK) | |
685 | sdi->status = SR_ST_ACTIVE; | |
686 | ||
687 | return ret; | |
688 | } | |
689 | ||
690 | /** | |
691 | * Close the specified device instance. | |
692 | * | |
693 | * If the device instance is not open (sdi->status != SR_ST_ACTIVE), | |
694 | * SR_ERR_DEV_CLOSED will be returned and no closing will be attempted. | |
695 | * | |
696 | * Note: sdi->status will be set to SR_ST_INACTIVE, regardless of whether | |
697 | * there are any errors during closing of the device instance (any errors | |
698 | * will be reported via error code and log message, though). | |
699 | * | |
700 | * @param sdi Device instance to use. Must not be NULL. | |
701 | * | |
702 | * @retval SR_OK Success. | |
703 | * @retval SR_ERR_ARG Invalid arguments. | |
704 | * @retval SR_ERR_DEV_CLOSED Device instance was not active. | |
705 | * @retval SR_ERR Other error. | |
706 | * | |
707 | * @since 0.2.0 | |
708 | */ | |
709 | SR_API int sr_dev_close(struct sr_dev_inst *sdi) | |
710 | { | |
711 | if (!sdi || !sdi->driver || !sdi->driver->dev_close) | |
712 | return SR_ERR_ARG; | |
713 | ||
714 | if (sdi->status != SR_ST_ACTIVE) { | |
715 | sr_err("%s: Device instance not active, can't close.", | |
716 | sdi->driver->name); | |
717 | return SR_ERR_DEV_CLOSED; | |
718 | } | |
719 | ||
720 | sdi->status = SR_ST_INACTIVE; | |
721 | ||
722 | sr_dbg("%s: Closing device instance.", sdi->driver->name); | |
723 | ||
724 | return sdi->driver->dev_close(sdi); | |
725 | } | |
726 | ||
727 | /** | |
728 | * Queries a device instances' driver. | |
729 | * | |
730 | * @param sdi Device instance to use. Must not be NULL. | |
731 | * | |
732 | * @return The driver instance or NULL on error. | |
733 | */ | |
734 | SR_API struct sr_dev_driver *sr_dev_inst_driver_get(const struct sr_dev_inst *sdi) | |
735 | { | |
736 | if (!sdi || !sdi->driver) | |
737 | return NULL; | |
738 | ||
739 | return sdi->driver; | |
740 | } | |
741 | ||
742 | /** | |
743 | * Queries a device instances' vendor. | |
744 | * | |
745 | * @param sdi Device instance to use. Must not be NULL. | |
746 | * | |
747 | * @return The vendor string or NULL. | |
748 | */ | |
749 | SR_API const char *sr_dev_inst_vendor_get(const struct sr_dev_inst *sdi) | |
750 | { | |
751 | if (!sdi) | |
752 | return NULL; | |
753 | ||
754 | return sdi->vendor; | |
755 | } | |
756 | ||
757 | /** | |
758 | * Queries a device instances' model. | |
759 | * | |
760 | * @param sdi Device instance to use. Must not be NULL. | |
761 | * | |
762 | * @return The model string or NULL. | |
763 | */ | |
764 | SR_API const char *sr_dev_inst_model_get(const struct sr_dev_inst *sdi) | |
765 | { | |
766 | if (!sdi) | |
767 | return NULL; | |
768 | ||
769 | return sdi->model; | |
770 | } | |
771 | ||
772 | /** | |
773 | * Queries a device instances' version. | |
774 | * | |
775 | * @param sdi Device instance to use. Must not be NULL. | |
776 | * | |
777 | * @return The version string or NULL. | |
778 | */ | |
779 | SR_API const char *sr_dev_inst_version_get(const struct sr_dev_inst *sdi) | |
780 | { | |
781 | if (!sdi) | |
782 | return NULL; | |
783 | ||
784 | return sdi->version; | |
785 | } | |
786 | ||
787 | /** | |
788 | * Queries a device instances' serial number. | |
789 | * | |
790 | * @param sdi Device instance to use. Must not be NULL. | |
791 | * | |
792 | * @return The serial number string or NULL. | |
793 | */ | |
794 | SR_API const char *sr_dev_inst_sernum_get(const struct sr_dev_inst *sdi) | |
795 | { | |
796 | if (!sdi) | |
797 | return NULL; | |
798 | ||
799 | return sdi->serial_num; | |
800 | } | |
801 | ||
802 | /** | |
803 | * Queries a device instances' connection identifier. | |
804 | * | |
805 | * @param sdi Device instance to use. Must not be NULL. | |
806 | * | |
807 | * @return A copy of the connection ID string or NULL. The caller is responsible | |
808 | * for g_free()ing the string when it is no longer needed. | |
809 | */ | |
810 | SR_API const char *sr_dev_inst_connid_get(const struct sr_dev_inst *sdi) | |
811 | { | |
812 | #ifdef HAVE_LIBUSB_1_0 | |
813 | struct drv_context *drvc; | |
814 | int cnt, i, a, b; | |
815 | char conn_id_usb[64]; | |
816 | struct sr_usb_dev_inst *usb; | |
817 | struct libusb_device **devlist; | |
818 | #endif | |
819 | ||
820 | #ifdef HAVE_SERIAL_COMM | |
821 | struct sr_serial_dev_inst *serial; | |
822 | #endif | |
823 | ||
824 | struct sr_scpi_dev_inst *scpi; | |
825 | char *conn_id_scpi; | |
826 | ||
827 | if (!sdi) | |
828 | return NULL; | |
829 | ||
830 | #ifdef HAVE_SERIAL_COMM | |
831 | if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SERIAL)) { | |
832 | /* connection_id isn't populated, let's do that for serial devices. */ | |
833 | ||
834 | serial = sdi->conn; | |
835 | ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(serial->port); | |
836 | } | |
837 | #endif | |
838 | ||
839 | #ifdef HAVE_LIBUSB_1_0 | |
840 | if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_USB)) { | |
841 | /* connection_id isn't populated, let's do that for USB devices. */ | |
842 | ||
843 | drvc = sdi->driver->context; | |
844 | usb = sdi->conn; | |
845 | ||
846 | if ((cnt = libusb_get_device_list(drvc->sr_ctx->libusb_ctx, &devlist)) < 0) { | |
847 | sr_err("Failed to retrieve device list: %s.", | |
848 | libusb_error_name(cnt)); | |
849 | return NULL; | |
850 | } | |
851 | ||
852 | for (i = 0; i < cnt; i++) { | |
853 | /* Find the USB device by the logical address we know. */ | |
854 | b = libusb_get_bus_number(devlist[i]); | |
855 | a = libusb_get_device_address(devlist[i]); | |
856 | if (b != usb->bus || a != usb->address) | |
857 | continue; | |
858 | ||
859 | if (usb_get_port_path(devlist[i], conn_id_usb, sizeof(conn_id_usb)) < 0) | |
860 | continue; | |
861 | ||
862 | ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_usb); | |
863 | break; | |
864 | } | |
865 | ||
866 | libusb_free_device_list(devlist, 1); | |
867 | } | |
868 | #endif | |
869 | ||
870 | if ((!sdi->connection_id) && (sdi->inst_type == SR_INST_SCPI)) { | |
871 | /* connection_id isn't populated, let's do that for SCPI devices. */ | |
872 | ||
873 | scpi = sdi->conn; | |
874 | sr_scpi_connection_id(scpi, &conn_id_scpi); | |
875 | ((struct sr_dev_inst *)sdi)->connection_id = g_strdup(conn_id_scpi); | |
876 | g_free(conn_id_scpi); | |
877 | } | |
878 | ||
879 | return sdi->connection_id; | |
880 | } | |
881 | ||
882 | /** | |
883 | * Queries a device instances' channel list. | |
884 | * | |
885 | * @param sdi Device instance to use. Must not be NULL. | |
886 | * | |
887 | * @return The GSList of channels or NULL. | |
888 | */ | |
889 | SR_API GSList *sr_dev_inst_channels_get(const struct sr_dev_inst *sdi) | |
890 | { | |
891 | if (!sdi) | |
892 | return NULL; | |
893 | ||
894 | return sdi->channels; | |
895 | } | |
896 | ||
897 | /** | |
898 | * Queries a device instances' channel groups list. | |
899 | * | |
900 | * @param sdi Device instance to use. Must not be NULL. | |
901 | * | |
902 | * @return The GSList of channel groups or NULL. | |
903 | */ | |
904 | SR_API GSList *sr_dev_inst_channel_groups_get(const struct sr_dev_inst *sdi) | |
905 | { | |
906 | if (!sdi) | |
907 | return NULL; | |
908 | ||
909 | return sdi->channel_groups; | |
910 | } | |
911 | ||
912 | /** @} */ |