]>
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 <stdlib.h> | |
21 | #include <stdio.h> | |
22 | #include <sys/types.h> | |
23 | #include <dirent.h> | |
24 | #include <string.h> | |
25 | #include <glib.h> | |
26 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ | |
27 | #include "libsigrok.h" | |
28 | #include "libsigrok-internal.h" | |
29 | ||
30 | /** @cond PRIVATE */ | |
31 | #define LOG_PREFIX "hwdriver" | |
32 | /** @endcond */ | |
33 | ||
34 | extern SR_PRIV struct sr_dev_driver *drivers_list[]; | |
35 | ||
36 | /** | |
37 | * @file | |
38 | * | |
39 | * Hardware driver handling in libsigrok. | |
40 | */ | |
41 | ||
42 | /** | |
43 | * @defgroup grp_driver Hardware drivers | |
44 | * | |
45 | * Hardware driver handling in libsigrok. | |
46 | * | |
47 | * @{ | |
48 | */ | |
49 | ||
50 | static struct sr_config_info sr_config_info_data[] = { | |
51 | {SR_CONF_CONN, SR_T_STRING, "conn", | |
52 | "Connection", NULL}, | |
53 | {SR_CONF_SERIALCOMM, SR_T_STRING, "serialcomm", | |
54 | "Serial communication", NULL}, | |
55 | {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate", | |
56 | "Sample rate", NULL}, | |
57 | {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", | |
58 | "Pre-trigger capture ratio", NULL}, | |
59 | {SR_CONF_PATTERN_MODE, SR_T_STRING, "pattern", | |
60 | "Pattern", NULL}, | |
61 | {SR_CONF_TRIGGER_MATCH, SR_T_INT32, "triggermatch", | |
62 | "Trigger matches", NULL}, | |
63 | {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock", | |
64 | "External clock mode", NULL}, | |
65 | {SR_CONF_SWAP, SR_T_BOOL, "swap", | |
66 | "Swap channel order", NULL}, | |
67 | {SR_CONF_RLE, SR_T_BOOL, "rle", | |
68 | "Run Length Encoding", NULL}, | |
69 | {SR_CONF_TRIGGER_SLOPE, SR_T_STRING, "triggerslope", | |
70 | "Trigger slope", NULL}, | |
71 | {SR_CONF_TRIGGER_SOURCE, SR_T_STRING, "triggersource", | |
72 | "Trigger source", NULL}, | |
73 | {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", | |
74 | "Horizontal trigger position", NULL}, | |
75 | {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", | |
76 | "Buffer size", NULL}, | |
77 | {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", | |
78 | "Time base", NULL}, | |
79 | {SR_CONF_FILTER, SR_T_STRING, "filter", | |
80 | "Filter targets", NULL}, | |
81 | {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", | |
82 | "Volts/div", NULL}, | |
83 | {SR_CONF_COUPLING, SR_T_STRING, "coupling", | |
84 | "Coupling", NULL}, | |
85 | {SR_CONF_DATALOG, SR_T_BOOL, "datalog", | |
86 | "Datalog", NULL}, | |
87 | {SR_CONF_SPL_WEIGHT_FREQ, SR_T_STRING, "spl_weight_freq", | |
88 | "Sound pressure level frequency weighting", NULL}, | |
89 | {SR_CONF_SPL_WEIGHT_TIME, SR_T_STRING, "spl_weight_time", | |
90 | "Sound pressure level time weighting", NULL}, | |
91 | {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max", | |
92 | "Hold max", NULL}, | |
93 | {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min", | |
94 | "Hold min", NULL}, | |
95 | {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range", | |
96 | "Sound pressure level measurement range", NULL}, | |
97 | {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold", | |
98 | "Voltage threshold", NULL }, | |
99 | {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off", | |
100 | "Power off", NULL}, | |
101 | {SR_CONF_DATA_SOURCE, SR_T_STRING, "data_source", | |
102 | "Data source", NULL}, | |
103 | {SR_CONF_NUM_LOGIC_CHANNELS, SR_T_INT32, "logic_channels", | |
104 | "Number of logic channels", NULL}, | |
105 | {SR_CONF_NUM_ANALOG_CHANNELS, SR_T_INT32, "analog_channels", | |
106 | "Number of analog channels", NULL}, | |
107 | {SR_CONF_OUTPUT_VOLTAGE, SR_T_FLOAT, "output_voltage", | |
108 | "Current output voltage", NULL}, | |
109 | {SR_CONF_OUTPUT_VOLTAGE_MAX, SR_T_FLOAT, "output_voltage_max", | |
110 | "Maximum output voltage", NULL}, | |
111 | {SR_CONF_OUTPUT_CURRENT, SR_T_FLOAT, "output_current", | |
112 | "Current output current", NULL}, | |
113 | {SR_CONF_OUTPUT_CURRENT_MAX, SR_T_FLOAT, "output_current_max", | |
114 | "Maximum output current", NULL}, | |
115 | {SR_CONF_OUTPUT_ENABLED, SR_T_BOOL, "output_enabled", | |
116 | "Output enabled", NULL}, | |
117 | {SR_CONF_OUTPUT_CHANNEL_CONFIG, SR_T_STRING, "output_channel_config", | |
118 | "Output channel modes", NULL}, | |
119 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ENABLED, SR_T_BOOL, "ovp_enabled", | |
120 | "Over-voltage protection enabled", NULL}, | |
121 | {SR_CONF_OVER_VOLTAGE_PROTECTION_ACTIVE, SR_T_BOOL, "ovp_active", | |
122 | "Over-voltage protection active", NULL}, | |
123 | {SR_CONF_OVER_VOLTAGE_PROTECTION_THRESHOLD, SR_T_FLOAT, "ovp_threshold", | |
124 | "Over-voltage protection threshold", NULL}, | |
125 | {SR_CONF_OVER_CURRENT_PROTECTION_ENABLED, SR_T_BOOL, "ocp_enabled", | |
126 | "Over-current protection enabled", NULL}, | |
127 | {SR_CONF_OVER_CURRENT_PROTECTION_ACTIVE, SR_T_BOOL, "ocp_active", | |
128 | "Over-current protection active", NULL}, | |
129 | {SR_CONF_OVER_CURRENT_PROTECTION_THRESHOLD, SR_T_FLOAT, "ocp_threshold", | |
130 | "Over-current protection threshold", NULL}, | |
131 | {SR_CONF_LIMIT_SAMPLES, SR_T_UINT64, "limit_samples", | |
132 | "Sample limit", NULL}, | |
133 | {SR_CONF_CLOCK_EDGE, SR_T_STRING, "clock_edge", | |
134 | "Clock edge", NULL}, | |
135 | {SR_CONF_AMPLITUDE, SR_T_FLOAT, "amplitude", | |
136 | "Amplitude", NULL}, | |
137 | {SR_CONF_OVER_TEMPERATURE_PROTECTION, SR_T_BOOL, "otp", | |
138 | "Over-temperature protection", NULL}, | |
139 | {SR_CONF_OUTPUT_REGULATION, SR_T_STRING, "output_regulation", | |
140 | "Output channel regulation", NULL}, | |
141 | {0, 0, NULL, NULL, NULL}, | |
142 | }; | |
143 | ||
144 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype) | |
145 | { | |
146 | switch (datatype) { | |
147 | case SR_T_INT32: | |
148 | return G_VARIANT_TYPE_INT32; | |
149 | case SR_T_UINT64: | |
150 | return G_VARIANT_TYPE_UINT64; | |
151 | case SR_T_STRING: | |
152 | return G_VARIANT_TYPE_STRING; | |
153 | case SR_T_BOOL: | |
154 | return G_VARIANT_TYPE_BOOLEAN; | |
155 | case SR_T_FLOAT: | |
156 | return G_VARIANT_TYPE_DOUBLE; | |
157 | case SR_T_RATIONAL_PERIOD: | |
158 | case SR_T_RATIONAL_VOLT: | |
159 | case SR_T_UINT64_RANGE: | |
160 | case SR_T_DOUBLE_RANGE: | |
161 | return G_VARIANT_TYPE_TUPLE; | |
162 | case SR_T_KEYVALUE: | |
163 | return G_VARIANT_TYPE_DICTIONARY; | |
164 | default: | |
165 | return NULL; | |
166 | } | |
167 | } | |
168 | ||
169 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *value) | |
170 | { | |
171 | const struct sr_config_info *info; | |
172 | const GVariantType *type, *expected; | |
173 | info = sr_config_info_get(key); | |
174 | if (!info) | |
175 | return SR_OK; | |
176 | expected = sr_variant_type_get(info->datatype); | |
177 | type = g_variant_get_type(value); | |
178 | if (!g_variant_type_equal(type, expected)) { | |
179 | gchar *expected_string = g_variant_type_dup_string(expected); | |
180 | gchar *type_string = g_variant_type_dup_string(type); | |
181 | sr_err("Wrong variant type for key '%s': expected '%s', got '%s'", | |
182 | info->name, expected_string, type_string); | |
183 | g_free(expected_string); | |
184 | g_free(type_string); | |
185 | return SR_ERR_ARG; | |
186 | } | |
187 | return SR_OK; | |
188 | } | |
189 | ||
190 | /** | |
191 | * Return the list of supported hardware drivers. | |
192 | * | |
193 | * @return Pointer to the NULL-terminated list of hardware driver pointers. | |
194 | * | |
195 | * @since 0.1.0 | |
196 | */ | |
197 | SR_API struct sr_dev_driver **sr_driver_list(void) | |
198 | { | |
199 | ||
200 | return drivers_list; | |
201 | } | |
202 | ||
203 | /** | |
204 | * Initialize a hardware driver. | |
205 | * | |
206 | * This usually involves memory allocations and variable initializations | |
207 | * within the driver, but _not_ scanning for attached devices. | |
208 | * The API call sr_driver_scan() is used for that. | |
209 | * | |
210 | * @param ctx A libsigrok context object allocated by a previous call to | |
211 | * sr_init(). Must not be NULL. | |
212 | * @param driver The driver to initialize. This must be a pointer to one of | |
213 | * the entries returned by sr_driver_list(). Must not be NULL. | |
214 | * | |
215 | * @retval SR_OK Success | |
216 | * @retval SR_ERR_ARG Invalid parameter(s). | |
217 | * @retval SR_ERR_BUG Internal errors. | |
218 | * @retval other Another negative error code upon other errors. | |
219 | * | |
220 | * @since 0.2.0 | |
221 | */ | |
222 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) | |
223 | { | |
224 | int ret; | |
225 | ||
226 | if (!ctx) { | |
227 | sr_err("Invalid libsigrok context, can't initialize."); | |
228 | return SR_ERR_ARG; | |
229 | } | |
230 | ||
231 | if (!driver) { | |
232 | sr_err("Invalid driver, can't initialize."); | |
233 | return SR_ERR_ARG; | |
234 | } | |
235 | ||
236 | sr_spew("Initializing driver '%s'.", driver->name); | |
237 | if ((ret = driver->init(ctx)) < 0) | |
238 | sr_err("Failed to initialize the driver: %d.", ret); | |
239 | ||
240 | return ret; | |
241 | } | |
242 | ||
243 | /** | |
244 | * Tell a hardware driver to scan for devices. | |
245 | * | |
246 | * In addition to the detection, the devices that are found are also | |
247 | * initialized automatically. On some devices, this involves a firmware upload, | |
248 | * or other such measures. | |
249 | * | |
250 | * The order in which the system is scanned for devices is not specified. The | |
251 | * caller should not assume or rely on any specific order. | |
252 | * | |
253 | * Before calling sr_driver_scan(), the user must have previously initialized | |
254 | * the driver by calling sr_driver_init(). | |
255 | * | |
256 | * @param driver The driver that should scan. This must be a pointer to one of | |
257 | * the entries returned by sr_driver_list(). Must not be NULL. | |
258 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
259 | * scanner. Can be NULL/empty. | |
260 | * | |
261 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
262 | * found (or errors were encountered). This list must be freed by the | |
263 | * caller using g_slist_free(), but without freeing the data pointed | |
264 | * to in the list. | |
265 | * | |
266 | * @since 0.2.0 | |
267 | */ | |
268 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
269 | { | |
270 | GSList *l; | |
271 | struct sr_config *src; | |
272 | ||
273 | if (!driver) { | |
274 | sr_err("Invalid driver, can't scan for devices."); | |
275 | return NULL; | |
276 | } | |
277 | ||
278 | if (!driver->priv) { | |
279 | sr_err("Driver not initialized, can't scan for devices."); | |
280 | return NULL; | |
281 | } | |
282 | ||
283 | for (l = options; l; l = l->next) { | |
284 | src = l->data; | |
285 | if (sr_variant_type_check(src->key, src->data) != SR_OK) | |
286 | return NULL; | |
287 | } | |
288 | ||
289 | l = driver->scan(options); | |
290 | ||
291 | sr_spew("Scan of '%s' found %d devices.", driver->name, | |
292 | g_slist_length(l)); | |
293 | ||
294 | return l; | |
295 | } | |
296 | ||
297 | /** Call driver cleanup function for all drivers. | |
298 | * @private */ | |
299 | SR_PRIV void sr_hw_cleanup_all(void) | |
300 | { | |
301 | int i; | |
302 | struct sr_dev_driver **drivers; | |
303 | ||
304 | drivers = sr_driver_list(); | |
305 | for (i = 0; drivers[i]; i++) { | |
306 | if (drivers[i]->cleanup) | |
307 | drivers[i]->cleanup(); | |
308 | } | |
309 | } | |
310 | ||
311 | /** Allocate struct sr_config. | |
312 | * A floating reference can be passed in for data. | |
313 | * @private | |
314 | */ | |
315 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data) | |
316 | { | |
317 | struct sr_config *src; | |
318 | ||
319 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
320 | return NULL; | |
321 | src->key = key; | |
322 | src->data = g_variant_ref_sink(data); | |
323 | ||
324 | return src; | |
325 | } | |
326 | ||
327 | /** Free struct sr_config. | |
328 | * @private | |
329 | */ | |
330 | SR_PRIV void sr_config_free(struct sr_config *src) | |
331 | { | |
332 | ||
333 | if (!src || !src->data) { | |
334 | sr_err("%s: invalid data!", __func__); | |
335 | return; | |
336 | } | |
337 | ||
338 | g_variant_unref(src->data); | |
339 | g_free(src); | |
340 | ||
341 | } | |
342 | ||
343 | /** | |
344 | * Query value of a configuration key at the given driver or device instance. | |
345 | * | |
346 | * @param[in] driver The sr_dev_driver struct to query. | |
347 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
348 | * contain a pointer to the struct sr_dev_inst to be checked. | |
349 | * Otherwise it must be NULL. | |
350 | * @param[in] cg The channel group on the device for which to list the | |
351 | * values, or NULL. | |
352 | * @param[in] key The configuration key (SR_CONF_*). | |
353 | * @param[in,out] data Pointer to a GVariant where the value will be stored. | |
354 | * Must not be NULL. The caller is given ownership of the GVariant | |
355 | * and must thus decrease the refcount after use. However if | |
356 | * this function returns an error code, the field should be | |
357 | * considered unused, and should not be unreferenced. | |
358 | * | |
359 | * @retval SR_OK Success. | |
360 | * @retval SR_ERR Error. | |
361 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
362 | * interpreted as an error by the caller; merely as an indication | |
363 | * that it's not applicable. | |
364 | * | |
365 | * @since 0.3.0 | |
366 | */ | |
367 | SR_API int sr_config_get(const struct sr_dev_driver *driver, | |
368 | const struct sr_dev_inst *sdi, | |
369 | const struct sr_channel_group *cg, | |
370 | uint32_t key, GVariant **data) | |
371 | { | |
372 | int ret; | |
373 | ||
374 | if (!driver || !data) | |
375 | return SR_ERR; | |
376 | ||
377 | if (!driver->config_get) | |
378 | return SR_ERR_ARG; | |
379 | ||
380 | if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { | |
381 | /* Got a floating reference from the driver. Sink it here, | |
382 | * caller will need to unref when done with it. */ | |
383 | g_variant_ref_sink(*data); | |
384 | } | |
385 | ||
386 | return ret; | |
387 | } | |
388 | ||
389 | /** | |
390 | * Set value of a configuration key in a device instance. | |
391 | * | |
392 | * @param[in] sdi The device instance. | |
393 | * @param[in] cg The channel group on the device for which to list the | |
394 | * values, or NULL. | |
395 | * @param[in] key The configuration key (SR_CONF_*). | |
396 | * @param data The new value for the key, as a GVariant with GVariantType | |
397 | * appropriate to that key. A floating reference can be passed | |
398 | * in; its refcount will be sunk and unreferenced after use. | |
399 | * | |
400 | * @retval SR_OK Success. | |
401 | * @retval SR_ERR Error. | |
402 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
403 | * interpreted as an error by the caller; merely as an indication | |
404 | * that it's not applicable. | |
405 | * | |
406 | * @since 0.3.0 | |
407 | */ | |
408 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, | |
409 | const struct sr_channel_group *cg, | |
410 | uint32_t key, GVariant *data) | |
411 | { | |
412 | int ret; | |
413 | ||
414 | g_variant_ref_sink(data); | |
415 | ||
416 | if (!sdi || !sdi->driver || !data) | |
417 | ret = SR_ERR; | |
418 | else if (!sdi->driver->config_set) | |
419 | ret = SR_ERR_ARG; | |
420 | else if ((ret = sr_variant_type_check(key, data)) == SR_OK) | |
421 | ret = sdi->driver->config_set(key, data, sdi, cg); | |
422 | ||
423 | g_variant_unref(data); | |
424 | ||
425 | return ret; | |
426 | } | |
427 | ||
428 | /** | |
429 | * Apply configuration settings to the device hardware. | |
430 | * | |
431 | * @param sdi The device instance. | |
432 | * | |
433 | * @return SR_OK upon success or SR_ERR in case of error. | |
434 | * | |
435 | * @since 0.3.0 | |
436 | */ | |
437 | SR_API int sr_config_commit(const struct sr_dev_inst *sdi) | |
438 | { | |
439 | int ret; | |
440 | ||
441 | if (!sdi || !sdi->driver) | |
442 | ret = SR_ERR; | |
443 | else if (!sdi->driver->config_commit) | |
444 | ret = SR_OK; | |
445 | else | |
446 | ret = sdi->driver->config_commit(sdi); | |
447 | ||
448 | return ret; | |
449 | } | |
450 | ||
451 | /** | |
452 | * List all possible values for a configuration key. | |
453 | * | |
454 | * @param[in] driver The sr_dev_driver struct to query. | |
455 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
456 | * contain a pointer to the struct sr_dev_inst to be checked. | |
457 | * @param[in] cg The channel group on the device for which to list the | |
458 | * values, or NULL. | |
459 | * @param[in] key The configuration key (SR_CONF_*). | |
460 | * @param[in,out] data A pointer to a GVariant where the list will be stored. | |
461 | * The caller is given ownership of the GVariant and must thus | |
462 | * unref the GVariant after use. However if this function | |
463 | * returns an error code, the field should be considered | |
464 | * unused, and should not be unreferenced. | |
465 | * | |
466 | * @retval SR_OK Success. | |
467 | * @retval SR_ERR Error. | |
468 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
469 | * interpreted as an error by the caller; merely as an indication | |
470 | * that it's not applicable. | |
471 | * | |
472 | * @since 0.3.0 | |
473 | */ | |
474 | SR_API int sr_config_list(const struct sr_dev_driver *driver, | |
475 | const struct sr_dev_inst *sdi, | |
476 | const struct sr_channel_group *cg, | |
477 | uint32_t key, GVariant **data) | |
478 | { | |
479 | int ret; | |
480 | ||
481 | if (!driver || !data) | |
482 | ret = SR_ERR; | |
483 | else if (!driver->config_list) | |
484 | ret = SR_ERR_ARG; | |
485 | else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) | |
486 | g_variant_ref_sink(*data); | |
487 | ||
488 | return ret; | |
489 | } | |
490 | ||
491 | /** | |
492 | * Get information about a configuration key, by key. | |
493 | * | |
494 | * @param[in] key The configuration key. | |
495 | * | |
496 | * @return A pointer to a struct sr_config_info, or NULL if the key | |
497 | * was not found. | |
498 | * | |
499 | * @since 0.2.0 | |
500 | */ | |
501 | SR_API const struct sr_config_info *sr_config_info_get(uint32_t key) | |
502 | { | |
503 | int i; | |
504 | ||
505 | for (i = 0; sr_config_info_data[i].key; i++) { | |
506 | if (sr_config_info_data[i].key == key) | |
507 | return &sr_config_info_data[i]; | |
508 | } | |
509 | ||
510 | return NULL; | |
511 | } | |
512 | ||
513 | /** | |
514 | * Get information about a configuration key, by name. | |
515 | * | |
516 | * @param[in] optname The configuration key. | |
517 | * | |
518 | * @return A pointer to a struct sr_config_info, or NULL if the key | |
519 | * was not found. | |
520 | * | |
521 | * @since 0.2.0 | |
522 | */ | |
523 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) | |
524 | { | |
525 | int i; | |
526 | ||
527 | for (i = 0; sr_config_info_data[i].key; i++) { | |
528 | if (!strcmp(sr_config_info_data[i].id, optname)) | |
529 | return &sr_config_info_data[i]; | |
530 | } | |
531 | ||
532 | return NULL; | |
533 | } | |
534 | ||
535 | /** @} */ |