]>
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 | /** | |
145 | * Return the list of supported hardware drivers. | |
146 | * | |
147 | * @return Pointer to the NULL-terminated list of hardware driver pointers. | |
148 | * | |
149 | * @since 0.1.0 | |
150 | */ | |
151 | SR_API struct sr_dev_driver **sr_driver_list(void) | |
152 | { | |
153 | ||
154 | return drivers_list; | |
155 | } | |
156 | ||
157 | /** | |
158 | * Initialize a hardware driver. | |
159 | * | |
160 | * This usually involves memory allocations and variable initializations | |
161 | * within the driver, but _not_ scanning for attached devices. | |
162 | * The API call sr_driver_scan() is used for that. | |
163 | * | |
164 | * @param ctx A libsigrok context object allocated by a previous call to | |
165 | * sr_init(). Must not be NULL. | |
166 | * @param driver The driver to initialize. This must be a pointer to one of | |
167 | * the entries returned by sr_driver_list(). Must not be NULL. | |
168 | * | |
169 | * @retval SR_OK Success | |
170 | * @retval SR_ERR_ARG Invalid parameter(s). | |
171 | * @retval SR_ERR_BUG Internal errors. | |
172 | * @retval other Another negative error code upon other errors. | |
173 | * | |
174 | * @since 0.2.0 | |
175 | */ | |
176 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) | |
177 | { | |
178 | int ret; | |
179 | ||
180 | if (!ctx) { | |
181 | sr_err("Invalid libsigrok context, can't initialize."); | |
182 | return SR_ERR_ARG; | |
183 | } | |
184 | ||
185 | if (!driver) { | |
186 | sr_err("Invalid driver, can't initialize."); | |
187 | return SR_ERR_ARG; | |
188 | } | |
189 | ||
190 | sr_spew("Initializing driver '%s'.", driver->name); | |
191 | if ((ret = driver->init(ctx)) < 0) | |
192 | sr_err("Failed to initialize the driver: %d.", ret); | |
193 | ||
194 | return ret; | |
195 | } | |
196 | ||
197 | /** | |
198 | * Tell a hardware driver to scan for devices. | |
199 | * | |
200 | * In addition to the detection, the devices that are found are also | |
201 | * initialized automatically. On some devices, this involves a firmware upload, | |
202 | * or other such measures. | |
203 | * | |
204 | * The order in which the system is scanned for devices is not specified. The | |
205 | * caller should not assume or rely on any specific order. | |
206 | * | |
207 | * Before calling sr_driver_scan(), the user must have previously initialized | |
208 | * the driver by calling sr_driver_init(). | |
209 | * | |
210 | * @param driver The driver that should scan. This must be a pointer to one of | |
211 | * the entries returned by sr_driver_list(). Must not be NULL. | |
212 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
213 | * scanner. Can be NULL/empty. | |
214 | * | |
215 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
216 | * found (or errors were encountered). This list must be freed by the | |
217 | * caller using g_slist_free(), but without freeing the data pointed | |
218 | * to in the list. | |
219 | * | |
220 | * @since 0.2.0 | |
221 | */ | |
222 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
223 | { | |
224 | GSList *l; | |
225 | ||
226 | if (!driver) { | |
227 | sr_err("Invalid driver, can't scan for devices."); | |
228 | return NULL; | |
229 | } | |
230 | ||
231 | if (!driver->priv) { | |
232 | sr_err("Driver not initialized, can't scan for devices."); | |
233 | return NULL; | |
234 | } | |
235 | ||
236 | l = driver->scan(options); | |
237 | ||
238 | sr_spew("Scan of '%s' found %d devices.", driver->name, | |
239 | g_slist_length(l)); | |
240 | ||
241 | return l; | |
242 | } | |
243 | ||
244 | /** Call driver cleanup function for all drivers. | |
245 | * @private */ | |
246 | SR_PRIV void sr_hw_cleanup_all(void) | |
247 | { | |
248 | int i; | |
249 | struct sr_dev_driver **drivers; | |
250 | ||
251 | drivers = sr_driver_list(); | |
252 | for (i = 0; drivers[i]; i++) { | |
253 | if (drivers[i]->cleanup) | |
254 | drivers[i]->cleanup(); | |
255 | } | |
256 | } | |
257 | ||
258 | /** Allocate struct sr_config. | |
259 | * A floating reference can be passed in for data. | |
260 | * @private | |
261 | */ | |
262 | SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data) | |
263 | { | |
264 | struct sr_config *src; | |
265 | ||
266 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
267 | return NULL; | |
268 | src->key = key; | |
269 | src->data = g_variant_ref_sink(data); | |
270 | ||
271 | return src; | |
272 | } | |
273 | ||
274 | /** Free struct sr_config. | |
275 | * @private | |
276 | */ | |
277 | SR_PRIV void sr_config_free(struct sr_config *src) | |
278 | { | |
279 | ||
280 | if (!src || !src->data) { | |
281 | sr_err("%s: invalid data!", __func__); | |
282 | return; | |
283 | } | |
284 | ||
285 | g_variant_unref(src->data); | |
286 | g_free(src); | |
287 | ||
288 | } | |
289 | ||
290 | /** | |
291 | * Query value of a configuration key at the given driver or device instance. | |
292 | * | |
293 | * @param[in] driver The sr_dev_driver struct to query. | |
294 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
295 | * contain a pointer to the struct sr_dev_inst to be checked. | |
296 | * Otherwise it must be NULL. | |
297 | * @param[in] cg The channel group on the device for which to list the | |
298 | * values, or NULL. | |
299 | * @param[in] key The configuration key (SR_CONF_*). | |
300 | * @param[in,out] data Pointer to a GVariant where the value will be stored. | |
301 | * Must not be NULL. The caller is given ownership of the GVariant | |
302 | * and must thus decrease the refcount after use. However if | |
303 | * this function returns an error code, the field should be | |
304 | * considered unused, and should not be unreferenced. | |
305 | * | |
306 | * @retval SR_OK Success. | |
307 | * @retval SR_ERR Error. | |
308 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
309 | * interpreted as an error by the caller; merely as an indication | |
310 | * that it's not applicable. | |
311 | * | |
312 | * @since 0.3.0 | |
313 | */ | |
314 | SR_API int sr_config_get(const struct sr_dev_driver *driver, | |
315 | const struct sr_dev_inst *sdi, | |
316 | const struct sr_channel_group *cg, | |
317 | int key, GVariant **data) | |
318 | { | |
319 | int ret; | |
320 | ||
321 | if (!driver || !data) | |
322 | return SR_ERR; | |
323 | ||
324 | if (!driver->config_get) | |
325 | return SR_ERR_ARG; | |
326 | ||
327 | if ((ret = driver->config_get(key, data, sdi, cg)) == SR_OK) { | |
328 | /* Got a floating reference from the driver. Sink it here, | |
329 | * caller will need to unref when done with it. */ | |
330 | g_variant_ref_sink(*data); | |
331 | } | |
332 | ||
333 | return ret; | |
334 | } | |
335 | ||
336 | /** | |
337 | * Set value of a configuration key in a device instance. | |
338 | * | |
339 | * @param[in] sdi The device instance. | |
340 | * @param[in] cg The channel group on the device for which to list the | |
341 | * values, or NULL. | |
342 | * @param[in] key The configuration key (SR_CONF_*). | |
343 | * @param data The new value for the key, as a GVariant with GVariantType | |
344 | * appropriate to that key. A floating reference can be passed | |
345 | * in; its refcount will be sunk and unreferenced after use. | |
346 | * | |
347 | * @retval SR_OK Success. | |
348 | * @retval SR_ERR Error. | |
349 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
350 | * interpreted as an error by the caller; merely as an indication | |
351 | * that it's not applicable. | |
352 | * | |
353 | * @since 0.3.0 | |
354 | */ | |
355 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, | |
356 | const struct sr_channel_group *cg, | |
357 | int key, GVariant *data) | |
358 | { | |
359 | int ret; | |
360 | ||
361 | g_variant_ref_sink(data); | |
362 | ||
363 | if (!sdi || !sdi->driver || !data) | |
364 | ret = SR_ERR; | |
365 | else if (!sdi->driver->config_set) | |
366 | ret = SR_ERR_ARG; | |
367 | else | |
368 | ret = sdi->driver->config_set(key, data, sdi, cg); | |
369 | ||
370 | g_variant_unref(data); | |
371 | ||
372 | return ret; | |
373 | } | |
374 | ||
375 | /** | |
376 | * Apply configuration settings to the device hardware. | |
377 | * | |
378 | * @param sdi The device instance. | |
379 | * | |
380 | * @return SR_OK upon success or SR_ERR in case of error. | |
381 | * | |
382 | * @since 0.3.0 | |
383 | */ | |
384 | SR_API int sr_config_commit(const struct sr_dev_inst *sdi) | |
385 | { | |
386 | int ret; | |
387 | ||
388 | if (!sdi || !sdi->driver) | |
389 | ret = SR_ERR; | |
390 | else if (!sdi->driver->config_commit) | |
391 | ret = SR_OK; | |
392 | else | |
393 | ret = sdi->driver->config_commit(sdi); | |
394 | ||
395 | return ret; | |
396 | } | |
397 | ||
398 | /** | |
399 | * List all possible values for a configuration key. | |
400 | * | |
401 | * @param[in] driver The sr_dev_driver struct to query. | |
402 | * @param[in] sdi (optional) If the key is specific to a device, this must | |
403 | * contain a pointer to the struct sr_dev_inst to be checked. | |
404 | * @param[in] cg The channel group on the device for which to list the | |
405 | * values, or NULL. | |
406 | * @param[in] key The configuration key (SR_CONF_*). | |
407 | * @param[in,out] data A pointer to a GVariant where the list will be stored. | |
408 | * The caller is given ownership of the GVariant and must thus | |
409 | * unref the GVariant after use. However if this function | |
410 | * returns an error code, the field should be considered | |
411 | * unused, and should not be unreferenced. | |
412 | * | |
413 | * @retval SR_OK Success. | |
414 | * @retval SR_ERR Error. | |
415 | * @retval SR_ERR_ARG The driver doesn't know that key, but this is not to be | |
416 | * interpreted as an error by the caller; merely as an indication | |
417 | * that it's not applicable. | |
418 | * | |
419 | * @since 0.3.0 | |
420 | */ | |
421 | SR_API int sr_config_list(const struct sr_dev_driver *driver, | |
422 | const struct sr_dev_inst *sdi, | |
423 | const struct sr_channel_group *cg, | |
424 | int key, GVariant **data) | |
425 | { | |
426 | int ret; | |
427 | ||
428 | if (!driver || !data) | |
429 | ret = SR_ERR; | |
430 | else if (!driver->config_list) | |
431 | ret = SR_ERR_ARG; | |
432 | else if ((ret = driver->config_list(key, data, sdi, cg)) == SR_OK) | |
433 | g_variant_ref_sink(*data); | |
434 | ||
435 | return ret; | |
436 | } | |
437 | ||
438 | /** | |
439 | * Get information about a configuration key, by key. | |
440 | * | |
441 | * @param[in] key The configuration key. | |
442 | * | |
443 | * @return A pointer to a struct sr_config_info, or NULL if the key | |
444 | * was not found. | |
445 | * | |
446 | * @since 0.2.0 | |
447 | */ | |
448 | SR_API const struct sr_config_info *sr_config_info_get(int key) | |
449 | { | |
450 | int i; | |
451 | ||
452 | for (i = 0; sr_config_info_data[i].key; i++) { | |
453 | if (sr_config_info_data[i].key == key) | |
454 | return &sr_config_info_data[i]; | |
455 | } | |
456 | ||
457 | return NULL; | |
458 | } | |
459 | ||
460 | /** | |
461 | * Get information about a configuration key, by name. | |
462 | * | |
463 | * @param[in] optname The configuration key. | |
464 | * | |
465 | * @return A pointer to a struct sr_config_info, or NULL if the key | |
466 | * was not found. | |
467 | * | |
468 | * @since 0.2.0 | |
469 | */ | |
470 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) | |
471 | { | |
472 | int i; | |
473 | ||
474 | for (i = 0; sr_config_info_data[i].key; i++) { | |
475 | if (!strcmp(sr_config_info_data[i].id, optname)) | |
476 | return &sr_config_info_data[i]; | |
477 | } | |
478 | ||
479 | return NULL; | |
480 | } | |
481 | ||
482 | /** @} */ |