]>
Commit | Line | Data |
---|---|---|
063e7aef | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
063e7aef UH |
3 | * |
4 | * Copyright (C) 2013 Uwe Hermann <uwe@hermann-uwe.de> | |
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 2 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 | |
2ea1fdf1 | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
063e7aef UH |
18 | */ |
19 | ||
d9251a2c UH |
20 | /** |
21 | * @file | |
22 | * | |
23 | * Standard API helper functions. | |
24 | * | |
25 | * @internal | |
26 | */ | |
04cb9157 | 27 | |
d18bf7bd UH |
28 | /* Needed for gettimeofday(), at least on FreeBSD. */ |
29 | #define _XOPEN_SOURCE 700 | |
30 | ||
6ec6c43b | 31 | #include <config.h> |
697fb6dd UH |
32 | #include <string.h> |
33 | #include <math.h> | |
d18bf7bd | 34 | #include <sys/time.h> |
063e7aef | 35 | #include <glib.h> |
c1aae900 | 36 | #include <libsigrok/libsigrok.h> |
063e7aef | 37 | #include "libsigrok-internal.h" |
5a1afc09 | 38 | #include "scpi.h" |
063e7aef | 39 | |
3544f848 ML |
40 | #define LOG_PREFIX "std" |
41 | ||
063e7aef | 42 | /** |
12852b03 | 43 | * Standard driver init() callback API helper. |
063e7aef | 44 | * |
6078d2c9 | 45 | * This function can be used to simplify most driver's init() API callback. |
063e7aef | 46 | * |
12852b03 UH |
47 | * Create a new 'struct drv_context' (drvc), assign sr_ctx to it, and |
48 | * then assign 'drvc' to the 'struct sr_dev_driver' (di) that is passed. | |
063e7aef | 49 | * |
12852b03 UH |
50 | * @param[in] di The driver instance to use. Must not be NULL. |
51 | * @param[in] sr_ctx The libsigrok context to assign. May be NULL. | |
063e7aef | 52 | * |
12852b03 UH |
53 | * @retval SR_OK Success. |
54 | * @retval SR_ERR_ARG Invalid argument. | |
063e7aef | 55 | */ |
c45c32ce | 56 | SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx) |
063e7aef UH |
57 | { |
58 | struct drv_context *drvc; | |
59 | ||
12852b03 UH |
60 | if (!di) { |
61 | sr_err("%s: Invalid argument.", __func__); | |
62 | return SR_ERR_ARG; | |
63 | } | |
64 | ||
91219afc | 65 | drvc = g_malloc0(sizeof(struct drv_context)); |
063e7aef | 66 | drvc->sr_ctx = sr_ctx; |
c2523f22 | 67 | drvc->instances = NULL; |
41812aca | 68 | di->context = drvc; |
063e7aef UH |
69 | |
70 | return SR_OK; | |
71 | } | |
4afdfd46 | 72 | |
700d6b64 | 73 | /** |
12852b03 | 74 | * Standard driver cleanup() callback API helper. |
700d6b64 | 75 | * |
12852b03 | 76 | * This function can be used to simplify most driver's cleanup() API callback. |
700d6b64 | 77 | * |
12852b03 | 78 | * Free all device instances by calling sr_dev_clear() and then release any |
700d6b64 LPC |
79 | * resources allocated by std_init(). |
80 | * | |
12852b03 | 81 | * @param[in] di The driver instance to use. Must not be NULL. |
700d6b64 | 82 | * |
12852b03 UH |
83 | * @retval SR_OK Success. |
84 | * @retval SR_ERR_ARG Invalid argument. | |
85 | * @retval other Other error. | |
86 | */ | |
700d6b64 LPC |
87 | SR_PRIV int std_cleanup(const struct sr_dev_driver *di) |
88 | { | |
89 | int ret; | |
90 | ||
12852b03 UH |
91 | if (!di) { |
92 | sr_err("%s: Invalid argument.", __func__); | |
93 | return SR_ERR_ARG; | |
94 | } | |
95 | ||
700d6b64 LPC |
96 | ret = sr_dev_clear(di); |
97 | g_free(di->context); | |
98 | ||
99 | return ret; | |
100 | } | |
101 | ||
4d67b9d9 UH |
102 | /** |
103 | * Dummmy driver dev_open() callback API helper. | |
104 | * | |
105 | * @param[in] sdi The device instance to use. May be NULL (unused). | |
106 | * | |
107 | * @retval SR_OK Success. | |
108 | */ | |
109 | SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi) | |
110 | { | |
111 | (void)sdi; | |
112 | ||
113 | return SR_OK; | |
114 | } | |
115 | ||
116 | /** | |
117 | * Dummmy driver dev_close() callback API helper. | |
118 | * | |
119 | * @param[in] sdi The device instance to use. May be NULL (unused). | |
120 | * | |
121 | * @retval SR_OK Success. | |
122 | */ | |
123 | SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi) | |
124 | { | |
125 | (void)sdi; | |
126 | ||
127 | return SR_OK; | |
128 | } | |
129 | ||
130 | /** | |
131 | * Dummmy driver dev_acquisition_start() callback API helper. | |
132 | * | |
133 | * @param[in] sdi The device instance to use. May be NULL (unused). | |
134 | * | |
135 | * @retval SR_OK Success. | |
136 | */ | |
137 | SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi) | |
138 | { | |
139 | (void)sdi; | |
140 | ||
141 | return SR_OK; | |
142 | } | |
143 | ||
144 | /** | |
145 | * Dummmy driver dev_acquisition_stop() callback API helper. | |
146 | * | |
147 | * @param[in] sdi The device instance to use. May be NULL (unused). | |
148 | * | |
149 | * @retval SR_OK Success. | |
150 | */ | |
151 | SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi) | |
152 | { | |
153 | (void)sdi; | |
154 | ||
155 | return SR_OK; | |
156 | } | |
157 | ||
4afdfd46 UH |
158 | /** |
159 | * Standard API helper for sending an SR_DF_HEADER packet. | |
160 | * | |
12852b03 | 161 | * This function can be used to simplify most drivers' |
6078d2c9 | 162 | * dev_acquisition_start() API callback. |
4afdfd46 | 163 | * |
12852b03 | 164 | * @param[in] sdi The device instance to use. Must not be NULL. |
4afdfd46 | 165 | * |
12852b03 UH |
166 | * @retval SR_OK Success. |
167 | * @retval SR_ERR_ARG Invalid argument. | |
168 | * @retval other Other error. | |
4afdfd46 | 169 | */ |
bee2b016 | 170 | SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi) |
4afdfd46 | 171 | { |
12852b03 | 172 | const char *prefix; |
4afdfd46 UH |
173 | int ret; |
174 | struct sr_datafeed_packet packet; | |
175 | struct sr_datafeed_header header; | |
176 | ||
12852b03 UH |
177 | if (!sdi) { |
178 | sr_err("%s: Invalid argument.", __func__); | |
179 | return SR_ERR_ARG; | |
180 | } | |
181 | ||
182 | prefix = (sdi->driver) ? sdi->driver->name : "unknown"; | |
183 | ||
4afdfd46 | 184 | /* Send header packet to the session bus. */ |
ac2926b3 | 185 | sr_dbg("%s: Sending SR_DF_HEADER packet.", prefix); |
4afdfd46 UH |
186 | packet.type = SR_DF_HEADER; |
187 | packet.payload = (uint8_t *)&header; | |
188 | header.feed_version = 1; | |
189 | gettimeofday(&header.starttime, NULL); | |
190 | ||
191 | if ((ret = sr_session_send(sdi, &packet)) < 0) { | |
12852b03 | 192 | sr_err("%s: Failed to send SR_DF_HEADER packet: %d.", prefix, ret); |
4afdfd46 UH |
193 | return ret; |
194 | } | |
195 | ||
196 | return SR_OK; | |
197 | } | |
cd2f0fe2 | 198 | |
3be42bc2 UH |
199 | /** |
200 | * Standard API helper for sending an SR_DF_END packet. | |
201 | * | |
12852b03 UH |
202 | * This function can be used to simplify most drivers' |
203 | * dev_acquisition_stop() API callback. | |
204 | * | |
205 | * @param[in] sdi The device instance to use. Must not be NULL. | |
3be42bc2 | 206 | * |
12852b03 UH |
207 | * @retval SR_OK Success. |
208 | * @retval SR_ERR_ARG Invalid argument. | |
209 | * @retval other Other error. | |
3be42bc2 | 210 | */ |
bee2b016 | 211 | SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi) |
3be42bc2 | 212 | { |
12852b03 | 213 | const char *prefix; |
3be42bc2 UH |
214 | int ret; |
215 | struct sr_datafeed_packet packet; | |
216 | ||
12852b03 UH |
217 | if (!sdi) { |
218 | sr_err("%s: Invalid argument.", __func__); | |
3be42bc2 | 219 | return SR_ERR_ARG; |
12852b03 UH |
220 | } |
221 | ||
222 | prefix = (sdi->driver) ? sdi->driver->name : "unknown"; | |
3be42bc2 UH |
223 | |
224 | sr_dbg("%s: Sending SR_DF_END packet.", prefix); | |
225 | ||
226 | packet.type = SR_DF_END; | |
227 | packet.payload = NULL; | |
228 | ||
229 | if ((ret = sr_session_send(sdi, &packet)) < 0) { | |
230 | sr_err("%s: Failed to send SR_DF_END packet: %d.", prefix, ret); | |
231 | return ret; | |
232 | } | |
233 | ||
234 | return SR_OK; | |
235 | } | |
236 | ||
b7602846 SA |
237 | /** |
238 | * Standard API helper for sending an SR_DF_FRAME_BEGIN packet. | |
239 | * | |
240 | * This function can be used to simplify most drivers' | |
241 | * frame handling. | |
242 | * | |
243 | * @param[in] sdi The device instance to use. Must not be NULL. | |
244 | * | |
245 | * @retval SR_OK Success. | |
246 | * @retval SR_ERR_ARG Invalid argument. | |
247 | * @retval other Other error. | |
248 | */ | |
249 | SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi) | |
250 | { | |
251 | const char *prefix; | |
252 | int ret; | |
253 | struct sr_datafeed_packet packet; | |
254 | ||
255 | if (!sdi) { | |
256 | sr_err("%s: Invalid argument.", __func__); | |
257 | return SR_ERR_ARG; | |
258 | } | |
259 | ||
260 | prefix = (sdi->driver) ? sdi->driver->name : "unknown"; | |
261 | ||
262 | sr_dbg("%s: Sending SR_DF_FRAME_BEGIN packet.", prefix); | |
263 | ||
264 | packet.type = SR_DF_FRAME_BEGIN; | |
265 | packet.payload = NULL; | |
266 | ||
267 | if ((ret = sr_session_send(sdi, &packet)) < 0) { | |
268 | sr_err("%s: Failed to send SR_DF_FRAME_BEGIN packet: %d.", prefix, ret); | |
269 | return ret; | |
270 | } | |
271 | ||
272 | return SR_OK; | |
273 | } | |
274 | ||
275 | /** | |
276 | * Standard API helper for sending an SR_DF_FRAME_END packet. | |
277 | * | |
278 | * This function can be used to simplify most drivers' | |
279 | * frame handling. | |
280 | * | |
281 | * @param[in] sdi The device instance to use. Must not be NULL. | |
282 | * | |
283 | * @retval SR_OK Success. | |
284 | * @retval SR_ERR_ARG Invalid argument. | |
285 | * @retval other Other error. | |
286 | */ | |
287 | SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi) | |
288 | { | |
289 | const char *prefix; | |
290 | int ret; | |
291 | struct sr_datafeed_packet packet; | |
292 | ||
293 | if (!sdi) { | |
294 | sr_err("%s: Invalid argument.", __func__); | |
295 | return SR_ERR_ARG; | |
296 | } | |
297 | ||
298 | prefix = (sdi->driver) ? sdi->driver->name : "unknown"; | |
299 | ||
300 | sr_dbg("%s: Sending SR_DF_FRAME_END packet.", prefix); | |
301 | ||
302 | packet.type = SR_DF_FRAME_END; | |
303 | packet.payload = NULL; | |
304 | ||
305 | if ((ret = sr_session_send(sdi, &packet)) < 0) { | |
306 | sr_err("%s: Failed to send SR_DF_FRAME_END packet: %d.", prefix, ret); | |
307 | return ret; | |
308 | } | |
309 | ||
310 | return SR_OK; | |
311 | } | |
312 | ||
c4f2dfd0 UH |
313 | #ifdef HAVE_LIBSERIALPORT |
314 | ||
813aab69 | 315 | /** |
12852b03 | 316 | * Standard serial driver dev_open() callback API helper. |
23dc6661 BV |
317 | * |
318 | * This function can be used to implement the dev_open() driver API | |
319 | * callback in drivers that use a serial port. The port is opened | |
6c592ece | 320 | * with the SERIAL_RDWR flag. |
23dc6661 | 321 | * |
12852b03 UH |
322 | * @param[in] sdi The device instance to use. Must not be NULL. |
323 | * | |
23dc6661 | 324 | * @retval SR_OK Success. |
12852b03 UH |
325 | * @retval SR_ERR_ARG Invalid argument. |
326 | * @retval other Serial port open failed. | |
23dc6661 BV |
327 | */ |
328 | SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi) | |
329 | { | |
330 | struct sr_serial_dev_inst *serial; | |
331 | ||
12852b03 UH |
332 | if (!sdi) { |
333 | sr_err("%s: Invalid argument.", __func__); | |
7e463623 | 334 | return SR_ERR_ARG; |
12852b03 | 335 | } |
23dc6661 | 336 | |
7e463623 | 337 | serial = sdi->conn; |
23dc6661 | 338 | |
7e463623 | 339 | return serial_open(serial, SERIAL_RDWR); |
23dc6661 BV |
340 | } |
341 | ||
813aab69 | 342 | /** |
12852b03 | 343 | * Standard serial driver dev_close() callback API helper. |
1e7134dc BV |
344 | * |
345 | * This function can be used to implement the dev_close() driver API | |
346 | * callback in drivers that use a serial port. | |
347 | * | |
12852b03 UH |
348 | * @param[in] sdi The device instance to use. Must not be NULL. |
349 | * | |
1e7134dc | 350 | * @retval SR_OK Success. |
12852b03 UH |
351 | * @retval SR_ERR_ARG Invalid argument. |
352 | * @retval other Serial port close failed. | |
1e7134dc BV |
353 | */ |
354 | SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi) | |
355 | { | |
356 | struct sr_serial_dev_inst *serial; | |
357 | ||
12852b03 UH |
358 | if (!sdi) { |
359 | sr_err("%s: Invalid argument.", __func__); | |
093e1cba | 360 | return SR_ERR_ARG; |
12852b03 | 361 | } |
1e7134dc | 362 | |
f1ba6b4b | 363 | serial = sdi->conn; |
093e1cba | 364 | |
f1ba6b4b | 365 | return serial_close(serial); |
1e7134dc BV |
366 | } |
367 | ||
813aab69 | 368 | /** |
12852b03 | 369 | * Standard serial driver dev_acquisition_stop() callback API helper. |
cd2f0fe2 | 370 | * |
12852b03 | 371 | * This function can be used to simplify most (serial port based) drivers' |
6078d2c9 | 372 | * dev_acquisition_stop() API callback. |
cd2f0fe2 | 373 | * |
12852b03 UH |
374 | * @param[in] sdi The device instance for which acquisition should stop. |
375 | * Must not be NULL. | |
cd2f0fe2 | 376 | * |
1477a9a6 | 377 | * @retval SR_OK Success. |
12852b03 UH |
378 | * @retval SR_ERR_ARG Invalid argument. |
379 | * @retval other Other error. | |
cd2f0fe2 | 380 | */ |
1b38775b | 381 | SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi) |
cd2f0fe2 | 382 | { |
12852b03 UH |
383 | struct sr_serial_dev_inst *serial; |
384 | const char *prefix; | |
cd2f0fe2 | 385 | int ret; |
cd2f0fe2 | 386 | |
12852b03 UH |
387 | if (!sdi) { |
388 | sr_err("%s: Invalid argument.", __func__); | |
389 | return SR_ERR_ARG; | |
390 | } | |
391 | ||
392 | serial = sdi->conn; | |
393 | prefix = sdi->driver->name; | |
394 | ||
102f1239 | 395 | if ((ret = serial_source_remove(sdi->session, serial)) < 0) { |
ac2926b3 | 396 | sr_err("%s: Failed to remove source: %d.", prefix, ret); |
cd2f0fe2 UH |
397 | return ret; |
398 | } | |
399 | ||
093e1cba | 400 | if ((ret = sr_dev_close(sdi)) < 0) { |
ac2926b3 | 401 | sr_err("%s: Failed to close device: %d.", prefix, ret); |
cd2f0fe2 UH |
402 | return ret; |
403 | } | |
404 | ||
12852b03 | 405 | return std_session_send_df_end(sdi); |
cd2f0fe2 | 406 | } |
49f00e13 | 407 | |
c4f2dfd0 UH |
408 | #endif |
409 | ||
813aab69 | 410 | /** |
12852b03 | 411 | * Standard driver dev_clear() callback API helper. |
49f00e13 | 412 | * |
813aab69 MH |
413 | * Clear driver, this means, close all instances. |
414 | * | |
49f00e13 BV |
415 | * This function can be used to implement the dev_clear() driver API |
416 | * callback. dev_close() is called before every sr_dev_inst is cleared. | |
417 | * | |
8bf18daa | 418 | * The only limitation is driver-specific device contexts (sdi->priv / devc). |
49f00e13 BV |
419 | * These are freed, but any dynamic allocation within structs stored |
420 | * there cannot be freed. | |
421 | * | |
12852b03 UH |
422 | * @param[in] driver The driver which will have its instances released. |
423 | * Must not be NULL. | |
424 | * @param[in] clear_private If not NULL, this points to a function called | |
8bf18daa | 425 | * with sdi->priv (devc) as argument. The function can then clear |
12852b03 | 426 | * any device instance-specific resources kept there. |
8bf18daa UH |
427 | * It must NOT clear the struct pointed to by sdi->priv (devc), |
428 | * since this function will always free it after clear_private() | |
429 | * has run. | |
49f00e13 | 430 | * |
12852b03 UH |
431 | * @retval SR_OK Success. |
432 | * @retval SR_ERR_ARG Invalid argument. | |
433 | * @retval SR_ERR_BUG Implementation bug. | |
434 | * @retval other Other error. | |
49f00e13 | 435 | */ |
6e43c3d5 | 436 | SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver, |
144f6660 | 437 | std_dev_clear_callback clear_private) |
49f00e13 | 438 | { |
49f00e13 | 439 | struct drv_context *drvc; |
12a33563 | 440 | struct sr_dev_inst *sdi; |
7aebe22d | 441 | GSList *l; |
49f00e13 BV |
442 | int ret; |
443 | ||
12852b03 UH |
444 | if (!driver) { |
445 | sr_err("%s: Invalid argument.", __func__); | |
446 | return SR_ERR_ARG; | |
447 | } | |
448 | ||
449 | drvc = driver->context; /* Caller checked for context != NULL. */ | |
3a277f3b | 450 | |
49f00e13 BV |
451 | ret = SR_OK; |
452 | for (l = drvc->instances; l; l = l->next) { | |
49f00e13 | 453 | if (!(sdi = l->data)) { |
12852b03 | 454 | sr_err("%s: Invalid device instance.", __func__); |
49f00e13 BV |
455 | ret = SR_ERR_BUG; |
456 | continue; | |
457 | } | |
49f00e13 BV |
458 | if (driver->dev_close) |
459 | driver->dev_close(sdi); | |
460 | ||
461 | if (sdi->conn) { | |
45357ce6 | 462 | #ifdef HAVE_LIBSERIALPORT |
c4f2dfd0 | 463 | if (sdi->inst_type == SR_INST_SERIAL) |
12a33563 | 464 | sr_serial_dev_inst_free(sdi->conn); |
c4f2dfd0 | 465 | #endif |
45357ce6 | 466 | #ifdef HAVE_LIBUSB_1_0 |
c4f2dfd0 | 467 | if (sdi->inst_type == SR_INST_USB) |
49f00e13 | 468 | sr_usb_dev_inst_free(sdi->conn); |
a0c7e23a | 469 | #endif |
23f43dff ML |
470 | if (sdi->inst_type == SR_INST_SCPI) |
471 | sr_scpi_free(sdi->conn); | |
daa39012 AJ |
472 | if (sdi->inst_type == SR_INST_MODBUS) |
473 | sr_modbus_free(sdi->conn); | |
49f00e13 | 474 | } |
8bf18daa UH |
475 | |
476 | /* Clear driver-specific stuff, if any. */ | |
ae5859ff BV |
477 | if (clear_private) |
478 | clear_private(sdi->priv); | |
8bf18daa UH |
479 | |
480 | /* Clear sdi->priv (devc). */ | |
481 | g_free(sdi->priv); | |
886413b6 | 482 | |
49f00e13 BV |
483 | sr_dev_inst_free(sdi); |
484 | } | |
485 | ||
486 | g_slist_free(drvc->instances); | |
487 | drvc->instances = NULL; | |
488 | ||
489 | return ret; | |
490 | } | |
c01bf34c | 491 | |
f778bf02 UH |
492 | SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver) |
493 | { | |
494 | return std_dev_clear_with_callback(driver, NULL); | |
495 | } | |
496 | ||
c01bf34c | 497 | /** |
12852b03 | 498 | * Standard driver dev_list() callback API helper. |
c01bf34c | 499 | * |
12852b03 | 500 | * This function can be used as the dev_list() callback by most drivers. |
c01bf34c | 501 | * |
12852b03 | 502 | * Return the devices contained in the driver context instances list. |
c01bf34c | 503 | * |
12852b03 UH |
504 | * @param[in] di The driver instance to use. Must not be NULL. |
505 | * | |
506 | * @retval NULL Error, or the list is empty. | |
507 | * @retval other The list of device instances of this driver. | |
c01bf34c LPC |
508 | */ |
509 | SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di) | |
510 | { | |
12852b03 UH |
511 | struct drv_context *drvc; |
512 | ||
513 | if (!di) { | |
514 | sr_err("%s: Invalid argument.", __func__); | |
515 | return NULL; | |
516 | } | |
517 | ||
518 | drvc = di->context; | |
c01bf34c LPC |
519 | |
520 | return drvc->instances; | |
521 | } | |
15a5bfe4 LPC |
522 | |
523 | /** | |
12852b03 | 524 | * Standard driver scan() callback API helper. |
15a5bfe4 LPC |
525 | * |
526 | * This function can be used to perform common tasks required by a driver's | |
527 | * scan() callback. It will initialize the driver for each device on the list | |
528 | * and add the devices on the list to the driver's device instance list. | |
529 | * Usually it should be used as the last step in the scan() callback, right | |
530 | * before returning. | |
531 | * | |
532 | * Note: This function can only be used if std_init() has been called | |
533 | * previously by the driver. | |
534 | * | |
535 | * Example: | |
536 | * @code{c} | |
537 | * static GSList *scan(struct sr_dev_driver *di, GSList *options) | |
538 | * { | |
539 | * struct GSList *device; | |
540 | * struct sr_dev_inst *sdi; | |
541 | * | |
542 | * sdi = g_new0(sr_dev_inst, 1); | |
543 | * sdi->vendor = ...; | |
544 | * ... | |
545 | * devices = g_slist_append(devices, sdi); | |
546 | * ... | |
547 | * return std_scan_complete(di, devices); | |
548 | * } | |
549 | * @endcode | |
550 | * | |
12852b03 UH |
551 | * @param[in] di The driver instance to use. Must not be NULL. |
552 | * @param[in] devices List of newly discovered devices (struct sr_dev_inst). | |
553 | * May be NULL. | |
15a5bfe4 LPC |
554 | * |
555 | * @return The @p devices list. | |
556 | */ | |
557 | SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices) | |
558 | { | |
39fcfdc9 | 559 | struct drv_context *drvc; |
15a5bfe4 LPC |
560 | GSList *l; |
561 | ||
39fcfdc9 UH |
562 | if (!di) { |
563 | sr_err("Invalid driver instance (di), cannot complete scan."); | |
564 | return NULL; | |
565 | } | |
566 | ||
567 | drvc = di->context; | |
568 | ||
15a5bfe4 LPC |
569 | for (l = devices; l; l = l->next) { |
570 | struct sr_dev_inst *sdi = l->data; | |
39fcfdc9 | 571 | if (!sdi) { |
12852b03 | 572 | sr_err("Invalid device instance, cannot complete scan."); |
39fcfdc9 UH |
573 | return NULL; |
574 | } | |
15a5bfe4 LPC |
575 | sdi->driver = di; |
576 | } | |
577 | ||
578 | drvc->instances = g_slist_concat(drvc->instances, g_slist_copy(devices)); | |
579 | ||
580 | return devices; | |
581 | } | |
e66d1892 UH |
582 | |
583 | SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data, | |
584 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, | |
585 | const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[], | |
586 | size_t drvsize, const uint32_t devopts[], size_t devsize) | |
587 | { | |
588 | switch (key) { | |
589 | case SR_CONF_SCAN_OPTIONS: | |
590 | /* Always return scanopts, regardless of sdi or cg. */ | |
591 | if (!scanopts) | |
592 | return SR_ERR_ARG; | |
593 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
594 | scanopts, scansize, sizeof(uint32_t)); | |
595 | break; | |
596 | case SR_CONF_DEVICE_OPTIONS: | |
597 | if (!sdi) { | |
598 | /* sdi == NULL: return drvopts. */ | |
599 | if (!drvopts) | |
600 | return SR_ERR_ARG; | |
601 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
602 | drvopts, drvsize, sizeof(uint32_t)); | |
603 | } else if (sdi && !cg) { | |
604 | /* sdi != NULL, cg == NULL: return devopts. */ | |
605 | if (!devopts) | |
606 | return SR_ERR_ARG; | |
607 | *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
608 | devopts, devsize, sizeof(uint32_t)); | |
609 | } else { | |
610 | /* | |
611 | * Note: sdi != NULL, cg != NULL is not handled by | |
612 | * this function since it's very driver-specific. | |
613 | */ | |
614 | sr_err("%s: %s: sdi/cg != NULL: not handling.", | |
615 | sdi->driver->name, __func__); | |
616 | return SR_ERR_ARG; | |
617 | } | |
618 | break; | |
619 | default: | |
620 | return SR_ERR_NA; | |
621 | } | |
622 | ||
623 | return SR_OK; | |
624 | } | |
db944f16 | 625 | |
58ffcf97 | 626 | SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n) |
db944f16 UH |
627 | { |
628 | unsigned int i; | |
629 | GVariant *rational[2]; | |
630 | GVariantBuilder gvb; | |
631 | ||
632 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
633 | ||
634 | for (i = 0; i < n; i++) { | |
58ffcf97 UH |
635 | rational[0] = g_variant_new_uint64(a[i][0]); |
636 | rational[1] = g_variant_new_uint64(a[i][1]); | |
db944f16 UH |
637 | |
638 | /* FIXME: Valgrind reports a memory leak here. */ | |
639 | g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2)); | |
640 | } | |
641 | ||
642 | return g_variant_builder_end(&gvb); | |
643 | } | |
644 | ||
645 | SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n) | |
646 | { | |
647 | unsigned int i; | |
648 | GVariant *rational[2]; | |
649 | GVariantBuilder gvb; | |
650 | ||
651 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
652 | ||
653 | for (i = 0; i < n; i++) { | |
654 | rational[0] = g_variant_new_uint64(r[i].p); | |
655 | rational[1] = g_variant_new_uint64(r[i].q); | |
656 | ||
657 | /* FIXME: Valgrind reports a memory leak here. */ | |
658 | g_variant_builder_add_value(&gvb, g_variant_new_tuple(rational, 2)); | |
659 | } | |
660 | ||
661 | return g_variant_builder_end(&gvb); | |
662 | } | |
463160cb UH |
663 | |
664 | static GVariant *samplerate_helper(const uint64_t samplerates[], unsigned int n, const char *str) | |
665 | { | |
666 | GVariant *gvar; | |
667 | GVariantBuilder gvb; | |
668 | ||
669 | g_variant_builder_init(&gvb, G_VARIANT_TYPE("a{sv}")); | |
670 | gvar = g_variant_new_fixed_array(G_VARIANT_TYPE("t"), samplerates, | |
671 | n, sizeof(uint64_t)); | |
672 | g_variant_builder_add(&gvb, "{sv}", str, gvar); | |
673 | ||
674 | return g_variant_builder_end(&gvb); | |
675 | } | |
676 | ||
677 | SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n) | |
678 | { | |
679 | return samplerate_helper(samplerates, n, "samplerates"); | |
680 | } | |
681 | ||
682 | SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n) | |
683 | { | |
684 | return samplerate_helper(samplerates, n, "samplerate-steps"); | |
685 | } | |
54d471f4 UH |
686 | |
687 | SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step) | |
688 | { | |
689 | GVariantBuilder gvb; | |
690 | ||
691 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
692 | ||
693 | g_variant_builder_add_value(&gvb, g_variant_new_double(min)); | |
694 | g_variant_builder_add_value(&gvb, g_variant_new_double(max)); | |
695 | g_variant_builder_add_value(&gvb, g_variant_new_double(step)); | |
696 | ||
697 | return g_variant_builder_end(&gvb); | |
698 | } | |
699 | ||
700 | SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]) | |
701 | { | |
702 | unsigned int i; | |
703 | GVariantBuilder gvb; | |
704 | ||
705 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
706 | ||
707 | for (i = 0; i < 3; i++) | |
708 | g_variant_builder_add_value(&gvb, g_variant_new_double(a[i])); | |
709 | ||
710 | return g_variant_builder_end(&gvb); | |
711 | } | |
7bc3cfe6 UH |
712 | |
713 | SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double min, const double max, const double step) | |
714 | { | |
715 | double d; | |
716 | GVariant *gvar, *range[2]; | |
717 | GVariantBuilder gvb; | |
718 | ||
719 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
720 | ||
721 | for (d = min; d <= max; d += step) { | |
722 | range[0] = g_variant_new_double(d); | |
723 | range[1] = g_variant_new_double(d); | |
724 | ||
725 | gvar = g_variant_new_tuple(range, 2); | |
726 | g_variant_builder_add_value(&gvb, gvar); | |
727 | } | |
728 | ||
729 | return g_variant_builder_end(&gvb); | |
730 | } | |
105df674 | 731 | |
a162eeb2 UH |
732 | SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high) |
733 | { | |
734 | GVariant *range[2]; | |
735 | ||
736 | range[0] = g_variant_new_uint64(low); | |
737 | range[1] = g_variant_new_uint64(high); | |
738 | ||
739 | return g_variant_new_tuple(range, 2); | |
740 | } | |
741 | ||
43995cda UH |
742 | SR_PRIV GVariant *std_gvar_tuple_double(double low, double high) |
743 | { | |
744 | GVariant *range[2]; | |
745 | ||
746 | range[0] = g_variant_new_double(low); | |
747 | range[1] = g_variant_new_double(high); | |
748 | ||
749 | return g_variant_new_tuple(range, 2); | |
750 | } | |
751 | ||
769561cb | 752 | SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n) |
105df674 UH |
753 | { |
754 | return g_variant_new_fixed_array(G_VARIANT_TYPE_INT32, | |
755 | a, n, sizeof(int32_t)); | |
756 | } | |
757 | ||
769561cb | 758 | SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n) |
105df674 UH |
759 | { |
760 | return g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32, | |
761 | a, n, sizeof(uint32_t)); | |
762 | } | |
763 | ||
769561cb | 764 | SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n) |
105df674 UH |
765 | { |
766 | return g_variant_new_fixed_array(G_VARIANT_TYPE_UINT64, | |
767 | a, n, sizeof(uint64_t)); | |
768 | } | |
9fb9afb5 | 769 | |
70635036 FS |
770 | SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n) |
771 | { | |
772 | GVariant *gvar; | |
773 | GVariantBuilder *builder; | |
774 | unsigned int i; | |
775 | ||
776 | builder = g_variant_builder_new(G_VARIANT_TYPE ("as")); | |
777 | ||
778 | for (i = 0; i < n; i++) | |
779 | g_variant_builder_add(builder, "s", a[i]); | |
780 | ||
781 | gvar = g_variant_new("as", builder); | |
782 | g_variant_builder_unref(builder); | |
783 | ||
784 | return gvar; | |
785 | } | |
786 | ||
94e64a0b | 787 | SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n) |
9fb9afb5 UH |
788 | { |
789 | unsigned int i; | |
790 | GVariant *gvar, *range[2]; | |
791 | GVariantBuilder gvb; | |
792 | ||
793 | g_variant_builder_init(&gvb, G_VARIANT_TYPE_ARRAY); | |
794 | ||
795 | for (i = 0; i < n; i++) { | |
94e64a0b UH |
796 | range[0] = g_variant_new_double(a[i][0]); |
797 | range[1] = g_variant_new_double(a[i][1]); | |
9fb9afb5 UH |
798 | gvar = g_variant_new_tuple(range, 2); |
799 | g_variant_builder_add_value(&gvb, gvar); | |
800 | } | |
801 | ||
802 | return g_variant_builder_end(&gvb); | |
803 | } | |
697fb6dd UH |
804 | |
805 | /* Return the index of 'data' in the array 'arr' (or -1). */ | |
806 | static int find_in_array(GVariant *data, const GVariantType *type, | |
807 | const void *arr, unsigned int n) | |
808 | { | |
809 | const char * const *sarr; | |
810 | const char *s; | |
811 | const uint64_t *u64arr; | |
812 | const uint8_t *u8arr; | |
813 | uint64_t u64; | |
814 | uint8_t u8; | |
815 | unsigned int i; | |
816 | ||
817 | if (!g_variant_is_of_type(data, type)) | |
818 | return -1; | |
819 | ||
820 | switch (g_variant_classify(data)) { | |
821 | case G_VARIANT_CLASS_STRING: | |
822 | s = g_variant_get_string(data, NULL); | |
823 | sarr = arr; | |
824 | ||
825 | for (i = 0; i < n; i++) | |
826 | if (!strcmp(s, sarr[i])) | |
827 | return i; | |
828 | break; | |
829 | case G_VARIANT_CLASS_UINT64: | |
830 | u64 = g_variant_get_uint64(data); | |
831 | u64arr = arr; | |
832 | ||
833 | for (i = 0; i < n; i++) | |
834 | if (u64 == u64arr[i]) | |
835 | return i; | |
836 | break; | |
837 | case G_VARIANT_CLASS_BYTE: | |
838 | u8 = g_variant_get_byte(data); | |
839 | u8arr = arr; | |
840 | ||
841 | for (i = 0; i < n; i++) | |
842 | if (u8 == u8arr[i]) | |
843 | return i; | |
844 | default: | |
845 | break; | |
846 | } | |
847 | ||
848 | return -1; | |
849 | } | |
850 | ||
851 | SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n) | |
852 | { | |
853 | return find_in_array(data, G_VARIANT_TYPE_STRING, a, n); | |
854 | } | |
855 | ||
856 | SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n) | |
857 | { | |
858 | return find_in_array(data, G_VARIANT_TYPE_UINT64, a, n); | |
859 | } | |
860 | ||
861 | SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n) | |
862 | { | |
863 | return find_in_array(data, G_VARIANT_TYPE_BYTE, a, n); | |
864 | } | |
865 | ||
866 | SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n) | |
867 | { | |
868 | int idx; | |
869 | GVariant *data; | |
870 | ||
871 | data = g_variant_new_string(s); | |
872 | idx = find_in_array(data, G_VARIANT_TYPE_STRING, a, n); | |
873 | g_variant_unref(data); | |
874 | ||
875 | return idx; | |
876 | } | |
877 | ||
878 | SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n) | |
879 | { | |
880 | int idx; | |
881 | GVariant *data; | |
882 | ||
883 | data = g_variant_new_byte(b); | |
884 | idx = find_in_array(data, G_VARIANT_TYPE_BYTE, a, n); | |
885 | g_variant_unref(data); | |
886 | ||
887 | return idx; | |
888 | } | |
889 | ||
890 | SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n) | |
891 | { | |
892 | unsigned int i; | |
893 | uint64_t low, high; | |
894 | ||
895 | g_variant_get(data, "(tt)", &low, &high); | |
896 | ||
897 | for (i = 0; i < n; i++) | |
898 | if (a[i][0] == low && a[i][1] == high) | |
899 | return i; | |
900 | ||
901 | return -1; | |
902 | } | |
903 | ||
904 | SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n) | |
905 | { | |
906 | unsigned int i; | |
907 | double low, high; | |
908 | ||
909 | g_variant_get(data, "(dd)", &low, &high); | |
910 | ||
911 | for (i = 0; i < n; i++) | |
912 | if ((fabs(a[i][0] - low) < 0.1) && ((fabs(a[i][1] - high) < 0.1))) | |
913 | return i; | |
914 | ||
915 | return -1; | |
916 | } | |
917 | ||
918 | SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n) | |
919 | { | |
920 | unsigned int i; | |
921 | ||
922 | for (i = 0; i < n; i++) | |
923 | if (d == a[i][0]) | |
924 | return i; | |
925 | ||
926 | return -1; | |
927 | } | |
fcd6a8bd UH |
928 | |
929 | SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n) | |
930 | { | |
931 | unsigned int i; | |
932 | ||
933 | for (i = 0; i < n; i++) | |
934 | if (cg == a[i]) | |
935 | return i; | |
936 | ||
937 | return -1; | |
938 | } |