libsigrok  0.2.2
sigrok hardware access and backend library
 All Data Structures Files Functions Variables Typedefs Enumerator Macros Groups Pages
hwdriver.c
Go to the documentation of this file.
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 /* Message logging helpers with subsystem-specific prefix string. */
31 #define LOG_PREFIX "hwdriver: "
32 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
33 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
34 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
35 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
36 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
37 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
38 
39 /**
40  * @file
41  *
42  * Hardware driver handling in libsigrok.
43  */
44 
45 /**
46  * @defgroup grp_driver Hardware drivers
47  *
48  * Hardware driver handling in libsigrok.
49  *
50  * @{
51  */
52 
53 static struct sr_config_info sr_config_info_data[] = {
54  {SR_CONF_CONN, SR_T_CHAR, "conn",
55  "Connection", NULL},
56  {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
57  "Serial communication", NULL},
58  {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
59  "Sample rate", NULL},
60  {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio",
61  "Pre-trigger capture ratio", NULL},
62  {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern",
63  "Pattern generator mode", NULL},
64  {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype",
65  "Trigger types", NULL},
66  {SR_CONF_EXTERNAL_CLOCK, SR_T_BOOL, "external_clock",
67  "External clock mode", NULL},
68  {SR_CONF_SWAP, SR_T_BOOL, "swap",
69  "Swap channel order", NULL},
70  {SR_CONF_RLE, SR_T_BOOL, "rle",
71  "Run Length Encoding", NULL},
72  {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
73  "Trigger slope", NULL},
74  {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
75  "Trigger source", NULL},
76  {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
77  "Horizontal trigger position", NULL},
78  {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
79  "Buffer size", NULL},
81  "Time base", NULL},
82  {SR_CONF_FILTER, SR_T_CHAR, "filter",
83  "Filter targets", NULL},
85  "Volts/div", NULL},
86  {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
87  "Coupling", NULL},
88  {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
89  "Datalog", NULL},
90  {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
91  "Sound pressure level frequency weighting", NULL},
92  {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
93  "Sound pressure level time weighting", NULL},
94  {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
95  "Hold max", NULL},
96  {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
97  "Hold min", NULL},
99  "Sound pressure level measurement range", NULL},
100  {SR_CONF_VOLTAGE_THRESHOLD, SR_T_DOUBLE_RANGE, "voltage_threshold",
101  "Voltage threshold", NULL },
102  {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
103  "Power off", NULL},
104  {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
105  "Data source", NULL},
106  {0, 0, NULL, NULL, NULL},
107 };
108 
109 /** @cond PRIVATE */
110 #ifdef HAVE_HW_BRYMEN_DMM
111 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
112 #endif
113 #ifdef HAVE_HW_CEM_DT_885X
114 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
115 #endif
116 #ifdef HAVE_HW_CENTER_3XX
117 extern SR_PRIV struct sr_dev_driver center_309_driver_info;
118 extern SR_PRIV struct sr_dev_driver voltcraft_k204_driver_info;
119 #endif
120 #ifdef HAVE_HW_COLEAD_SLM
121 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
122 #endif
123 #ifdef HAVE_HW_DEMO
124 extern SR_PRIV struct sr_dev_driver demo_driver_info;
125 #endif
126 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
127 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
128 #endif
129 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
130 extern SR_PRIV struct sr_dev_driver ikalogic_scanaplus_driver_info;
131 #endif
132 #ifdef HAVE_HW_KECHENG_KC_330B
133 extern SR_PRIV struct sr_dev_driver kecheng_kc_330b_driver_info;
134 #endif
135 #ifdef HAVE_HW_LASCAR_EL_USB
136 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
137 #endif
138 #ifdef HAVE_HW_MIC_985XX
139 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
140 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
141 #endif
142 #ifdef HAVE_HW_NORMA_DMM
143 extern SR_PRIV struct sr_dev_driver norma_dmm_driver_info;
144 #endif
145 #ifdef HAVE_HW_OLS
146 extern SR_PRIV struct sr_dev_driver ols_driver_info;
147 #endif
148 #ifdef HAVE_HW_RIGOL_DS1XX2
149 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
150 #endif
151 #ifdef HAVE_HW_SALEAE_LOGIC16
152 extern SR_PRIV struct sr_dev_driver saleae_logic16_driver_info;
153 #endif
154 #ifdef HAVE_HW_TELEINFO
155 extern SR_PRIV struct sr_dev_driver teleinfo_driver_info;
156 #endif
157 #ifdef HAVE_HW_TONDAJ_SL_814
158 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
159 #endif
160 #ifdef HAVE_HW_UNI_T_UT32X
161 extern SR_PRIV struct sr_dev_driver uni_t_ut32x_driver_info;
162 #endif
163 #ifdef HAVE_HW_VICTOR_DMM
164 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
165 #endif
166 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
167 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
168 #endif
169 #ifdef HAVE_HW_ASIX_SIGMA
170 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
171 #endif
172 #ifdef HAVE_HW_CHRONOVU_LA8
173 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
174 #endif
175 #ifdef HAVE_HW_LINK_MSO19
176 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
177 #endif
178 #ifdef HAVE_HW_ALSA
179 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
180 #endif
181 #ifdef HAVE_HW_FX2LAFW
182 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
183 #endif
184 #ifdef HAVE_HW_HANTEK_DSO
185 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
186 #endif
187 #ifdef HAVE_HW_AGILENT_DMM
188 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
189 #endif
190 #ifdef HAVE_HW_FLUKE_DMM
191 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
192 #endif
193 #ifdef HAVE_HW_SERIAL_DMM
194 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
195 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
196 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
197 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
198 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
199 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
200 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
201 extern SR_PRIV struct sr_dev_driver metex_m4650cr_driver_info;
202 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
203 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
204 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
205 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
206 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
207 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
208 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
209 extern SR_PRIV struct sr_dev_driver voltcraft_m4650cr_driver_info;
210 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
211 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_ser_driver_info;
212 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
213 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_ser_driver_info;
214 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_ser_driver_info;
215 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
216 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
217 extern SR_PRIV struct sr_dev_driver iso_tech_idm103n_driver_info;
218 #endif
219 #ifdef HAVE_HW_UNI_T_DMM
220 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
221 extern SR_PRIV struct sr_dev_driver uni_t_ut60a_driver_info;
222 extern SR_PRIV struct sr_dev_driver uni_t_ut60e_driver_info;
223 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
224 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
225 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
226 extern SR_PRIV struct sr_dev_driver voltcraft_vc830_driver_info;
227 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
228 #endif
229 /** @endcond */
230 
231 static struct sr_dev_driver *drivers_list[] = {
232 #ifdef HAVE_HW_BRYMEN_DMM
233  &brymen_bm857_driver_info,
234 #endif
235 #ifdef HAVE_HW_CEM_DT_885X
236  &cem_dt_885x_driver_info,
237 #endif
238 #ifdef HAVE_HW_CENTER_3XX
239  &center_309_driver_info,
240  &voltcraft_k204_driver_info,
241 #endif
242 #ifdef HAVE_HW_COLEAD_SLM
243  &colead_slm_driver_info,
244 #endif
245 #ifdef HAVE_HW_DEMO
246  &demo_driver_info,
247 #endif
248 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
249  &ikalogic_scanalogic2_driver_info,
250 #endif
251 #ifdef HAVE_HW_IKALOGIC_SCANAPLUS
252  &ikalogic_scanaplus_driver_info,
253 #endif
254 #ifdef HAVE_HW_KECHENG_KC_330B
255  &kecheng_kc_330b_driver_info,
256 #endif
257 #ifdef HAVE_HW_LASCAR_EL_USB
258  &lascar_el_usb_driver_info,
259 #endif
260 #ifdef HAVE_HW_MIC_985XX
261  &mic_98581_driver_info,
262  &mic_98583_driver_info,
263 #endif
264 #ifdef HAVE_HW_NORMA_DMM
265  &norma_dmm_driver_info,
266 #endif
267 #ifdef HAVE_HW_OLS
268  &ols_driver_info,
269 #endif
270 #ifdef HAVE_HW_RIGOL_DS1XX2
271  &rigol_ds1xx2_driver_info,
272 #endif
273 #ifdef HAVE_HW_SALEAE_LOGIC16
274  &saleae_logic16_driver_info,
275 #endif
276 #ifdef HAVE_HW_TELEINFO
277  &teleinfo_driver_info,
278 #endif
279 #ifdef HAVE_HW_TONDAJ_SL_814
280  &tondaj_sl_814_driver_info,
281 #endif
282 #ifdef HAVE_HW_UNI_T_UT32X
283  &uni_t_ut32x_driver_info,
284 #endif
285 #ifdef HAVE_HW_VICTOR_DMM
286  &victor_dmm_driver_info,
287 #endif
288 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
289  &zeroplus_logic_cube_driver_info,
290 #endif
291 #ifdef HAVE_HW_ASIX_SIGMA
292  &asix_sigma_driver_info,
293 #endif
294 #ifdef HAVE_HW_CHRONOVU_LA8
295  &chronovu_la8_driver_info,
296 #endif
297 #ifdef HAVE_HW_LINK_MSO19
298  &link_mso19_driver_info,
299 #endif
300 #ifdef HAVE_HW_ALSA
301  &alsa_driver_info,
302 #endif
303 #ifdef HAVE_HW_FX2LAFW
304  &fx2lafw_driver_info,
305 #endif
306 #ifdef HAVE_HW_HANTEK_DSO
307  &hantek_dso_driver_info,
308 #endif
309 #ifdef HAVE_HW_AGILENT_DMM
310  &agdmm_driver_info,
311 #endif
312 #ifdef HAVE_HW_FLUKE_DMM
313  &flukedmm_driver_info,
314 #endif
315 #ifdef HAVE_HW_SERIAL_DMM
316  &digitek_dt4000zc_driver_info,
317  &tekpower_tp4000zc_driver_info,
318  &metex_me31_driver_info,
319  &peaktech_3410_driver_info,
320  &mastech_mas345_driver_info,
321  &va_va18b_driver_info,
322  &metex_m3640d_driver_info,
323  &metex_m4650cr_driver_info,
324  &peaktech_4370_driver_info,
325  &pce_pce_dm32_driver_info,
326  &radioshack_22_168_driver_info,
327  &radioshack_22_805_driver_info,
328  &radioshack_22_812_driver_info,
329  &tecpel_dmm_8061_ser_driver_info,
330  &voltcraft_m3650d_driver_info,
331  &voltcraft_m4650cr_driver_info,
332  &voltcraft_vc820_ser_driver_info,
333  &voltcraft_vc830_ser_driver_info,
334  &voltcraft_vc840_ser_driver_info,
335  &uni_t_ut60a_ser_driver_info,
336  &uni_t_ut60e_ser_driver_info,
337  &uni_t_ut61d_ser_driver_info,
338  &uni_t_ut61e_ser_driver_info,
339  &iso_tech_idm103n_driver_info,
340 #endif
341 #ifdef HAVE_HW_UNI_T_DMM
342  &tecpel_dmm_8061_driver_info,
343  &uni_t_ut60a_driver_info,
344  &uni_t_ut60e_driver_info,
345  &uni_t_ut61d_driver_info,
346  &uni_t_ut61e_driver_info,
347  &voltcraft_vc820_driver_info,
348  &voltcraft_vc830_driver_info,
349  &voltcraft_vc840_driver_info,
350 #endif
351  NULL,
352 };
353 
354 /**
355  * Return the list of supported hardware drivers.
356  *
357  * @return Pointer to the NULL-terminated list of hardware driver pointers.
358  */
360 {
361 
362  return drivers_list;
363 }
364 
365 /**
366  * Initialize a hardware driver.
367  *
368  * This usually involves memory allocations and variable initializations
369  * within the driver, but _not_ scanning for attached devices.
370  * The API call sr_driver_scan() is used for that.
371  *
372  * @param ctx A libsigrok context object allocated by a previous call to
373  * sr_init(). Must not be NULL.
374  * @param driver The driver to initialize. This must be a pointer to one of
375  * the entries returned by sr_driver_list(). Must not be NULL.
376  *
377  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
378  * SR_ERR_BUG upon internal errors, or another negative error code
379  * upon other errors.
380  */
381 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
382 {
383  int ret;
384 
385  if (!ctx) {
386  sr_err("Invalid libsigrok context, can't initialize.");
387  return SR_ERR_ARG;
388  }
389 
390  if (!driver) {
391  sr_err("Invalid driver, can't initialize.");
392  return SR_ERR_ARG;
393  }
394 
395  sr_spew("Initializing driver '%s'.", driver->name);
396  if ((ret = driver->init(ctx)) < 0)
397  sr_err("Failed to initialize the driver: %d.", ret);
398 
399  return ret;
400 }
401 
402 /**
403  * Tell a hardware driver to scan for devices.
404  *
405  * In addition to the detection, the devices that are found are also
406  * initialized automatically. On some devices, this involves a firmware upload,
407  * or other such measures.
408  *
409  * The order in which the system is scanned for devices is not specified. The
410  * caller should not assume or rely on any specific order.
411  *
412  * Before calling sr_driver_scan(), the user must have previously initialized
413  * the driver by calling sr_driver_init().
414  *
415  * @param driver The driver that should scan. This must be a pointer to one of
416  * the entries returned by sr_driver_list(). Must not be NULL.
417  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
418  * scanner. Can be NULL/empty.
419  *
420  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
421  * found (or errors were encountered). This list must be freed by the
422  * caller using g_slist_free(), but without freeing the data pointed
423  * to in the list.
424  */
425 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
426 {
427  GSList *l;
428 
429  if (!driver) {
430  sr_err("Invalid driver, can't scan for devices.");
431  return NULL;
432  }
433 
434  if (!driver->priv) {
435  sr_err("Driver not initialized, can't scan for devices.");
436  return NULL;
437  }
438 
439  l = driver->scan(options);
440 
441  sr_spew("Scan of '%s' found %d devices.", driver->name,
442  g_slist_length(l));
443 
444  return l;
445 }
446 
447 /** @private */
448 SR_PRIV void sr_hw_cleanup_all(void)
449 {
450  int i;
451  struct sr_dev_driver **drivers;
452 
453  drivers = sr_driver_list();
454  for (i = 0; drivers[i]; i++) {
455  if (drivers[i]->cleanup)
456  drivers[i]->cleanup();
457  }
458 }
459 
460 /** A floating reference can be passed in for data.
461  * @private */
462 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
463 {
464  struct sr_config *src;
465 
466  if (!(src = g_try_malloc(sizeof(struct sr_config))))
467  return NULL;
468  src->key = key;
469  src->data = g_variant_ref_sink(data);
470 
471  return src;
472 }
473 
474 /** @private */
475 SR_PRIV void sr_config_free(struct sr_config *src)
476 {
477 
478  if (!src || !src->data) {
479  sr_err("%s: invalid data!", __func__);
480  return;
481  }
482 
483  g_variant_unref(src->data);
484  g_free(src);
485 
486 }
487 
488 /**
489  * Returns information about the given driver or device instance.
490  *
491  * @param driver The sr_dev_driver struct to query.
492  * @param key The configuration key (SR_CONF_*).
493  * @param data Pointer to a GVariant where the value will be stored. Must
494  * not be NULL. The caller is given ownership of the GVariant
495  * and must thus decrease the refcount after use. However if
496  * this function returns an error code, the field should be
497  * considered unused, and should not be unreferenced.
498  * @param sdi (optional) If the key is specific to a device, this must
499  * contain a pointer to the struct sr_dev_inst to be checked.
500  * Otherwise it must be NULL.
501  *
502  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
503  * may be returned by the driver indicating it doesn't know that key,
504  * but this is not to be flagged as an error by the caller; merely
505  * as an indication that it's not applicable.
506  */
507 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
508  GVariant **data, const struct sr_dev_inst *sdi)
509 {
510  int ret;
511 
512  if (!driver || !data)
513  return SR_ERR;
514 
515  if (!driver->config_get)
516  return SR_ERR_ARG;
517 
518  if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
519  /* Got a floating reference from the driver. Sink it here,
520  * caller will need to unref when done with it. */
521  g_variant_ref_sink(*data);
522  }
523 
524  return ret;
525 }
526 
527 /**
528  * Set a configuration key in a device instance.
529  *
530  * @param sdi The device instance.
531  * @param key The configuration key (SR_CONF_*).
532  * @param data The new value for the key, as a GVariant with GVariantType
533  * appropriate to that key. A floating reference can be passed
534  * in; its refcount will be sunk and unreferenced after use.
535  *
536  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
537  * may be returned by the driver indicating it doesn't know that key,
538  * but this is not to be flagged as an error by the caller; merely
539  * as an indication that it's not applicable.
540  */
541 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
542 {
543  int ret;
544 
545  g_variant_ref_sink(data);
546 
547  if (!sdi || !sdi->driver || !data)
548  ret = SR_ERR;
549  else if (!sdi->driver->config_set)
550  ret = SR_ERR_ARG;
551  else
552  ret = sdi->driver->config_set(key, data, sdi);
553 
554  g_variant_unref(data);
555 
556  return ret;
557 }
558 
559 /**
560  * List all possible values for a configuration key.
561  *
562  * @param driver The sr_dev_driver struct to query.
563  * @param key The configuration key (SR_CONF_*).
564  * @param data A pointer to a GVariant where the list will be stored. The
565  * caller is given ownership of the GVariant and must thus
566  * unref the GVariant after use. However if this function
567  * returns an error code, the field should be considered
568  * unused, and should not be unreferenced.
569  * @param sdi (optional) If the key is specific to a device, this must
570  * contain a pointer to the struct sr_dev_inst to be checked.
571  *
572  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
573  * may be returned by the driver indicating it doesn't know that key,
574  * but this is not to be flagged as an error by the caller; merely
575  * as an indication that it's not applicable.
576  */
577 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
578  GVariant **data, const struct sr_dev_inst *sdi)
579 {
580  int ret;
581 
582  if (!driver || !data)
583  ret = SR_ERR;
584  else if (!driver->config_list)
585  ret = SR_ERR_ARG;
586  else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
587  g_variant_ref_sink(*data);
588 
589  return ret;
590 }
591 
592 /**
593  * Get information about a configuration key.
594  *
595  * @param key The configuration key.
596  *
597  * @return A pointer to a struct sr_config_info, or NULL if the key
598  * was not found.
599  */
601 {
602  int i;
603 
604  for (i = 0; sr_config_info_data[i].key; i++) {
605  if (sr_config_info_data[i].key == key)
606  return &sr_config_info_data[i];
607  }
608 
609  return NULL;
610 }
611 
612 /**
613  * Get information about an configuration key, by name.
614  *
615  * @param optname The configuration key.
616  *
617  * @return A pointer to a struct sr_config_info, or NULL if the key
618  * was not found.
619  */
620 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
621 {
622  int i;
623 
624  for (i = 0; sr_config_info_data[i].key; i++) {
625  if (!strcmp(sr_config_info_data[i].id, optname))
626  return &sr_config_info_data[i];
627  }
628 
629  return NULL;
630 }
631 
632 /* Unnecessary level of indirection follows. */
633 
634 /** @private */
635 SR_PRIV int sr_source_remove(int fd)
636 {
637  return sr_session_source_remove(fd);
638 }
639 
640 /** @private */
641 SR_PRIV int sr_source_add(int fd, int events, int timeout,
642  sr_receive_data_callback_t cb, void *cb_data)
643 {
644  return sr_session_source_add(fd, events, timeout, cb, cb_data);
645 }
646 
647 /** @} */
Trigger types.
Definition: libsigrok.h:666
int(* init)(struct sr_context *sr_ctx)
Definition: libsigrok.h:811
int(* config_list)(int info_id, GVariant **data, const struct sr_dev_inst *sdi)
Definition: libsigrok.h:820
The device supports Run Length Encoding.
Definition: libsigrok.h:639
Filter.
Definition: libsigrok.h:657
GSList *(* scan)(GSList *options)
Definition: libsigrok.h:813
Time base.
Definition: libsigrok.h:654
Serial communication specification, in the form:
Definition: libsigrok.h:625
Specification on how to connect to a device.
Definition: libsigrok.h:604
int(* config_get)(int id, GVariant **data, const struct sr_dev_inst *sdi)
Definition: libsigrok.h:816
int sr_session_source_remove(int fd)
Remove the source belonging to the specified file descriptor.
Definition: session.c:716
The device supports setting its samplerate, in Hz.
Definition: libsigrok.h:630
The public libsigrok header file to be used by frontends.
Data source for acquisition.
Definition: libsigrok.h:737
Coupling.
Definition: libsigrok.h:663
Buffer size.
Definition: libsigrok.h:651
int(* config_set)(int id, GVariant *data, const struct sr_dev_inst *sdi)
Definition: libsigrok.h:818
Volts/div.
Definition: libsigrok.h:660
Power off the device.
Definition: libsigrok.h:725
Generic/unspecified error.
Definition: libsigrok.h:68
struct sr_config_info * sr_config_info_get(int key)
Get information about a configuration key.
Definition: hwdriver.c:600
int(* cleanup)(void)
Definition: libsigrok.h:812
Sound pressure level time weighting.
Definition: libsigrok.h:681
struct sr_dev_driver * driver
Definition: libsigrok.h:772
#define sr_spew(s, args...)
Definition: hwdriver.c:33
The device supports setting trigger slope.
Definition: libsigrok.h:642
Logic low-high threshold range.
Definition: libsigrok.h:693
The device supports swapping channels.
Definition: libsigrok.h:702
No error.
Definition: libsigrok.h:67
#define sr_err(s, args...)
Definition: hwdriver.c:37
GSList * sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
Tell a hardware driver to scan for devices.
Definition: hwdriver.c:425
The device supports setting a pre/post-trigger capture ratio.
Definition: libsigrok.h:633
struct sr_config_info * sr_config_info_name_get(const char *optname)
Get information about an configuration key, by name.
Definition: hwdriver.c:620
GVariant * data
Definition: libsigrok.h:554
int(* sr_receive_data_callback_t)(int fd, int revents, void *cb_data)
Definition: libsigrok.h:133
#define SR_PRIV
Definition: libsigrok.h:128
int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
Set a configuration key in a device instance.
Definition: hwdriver.c:541
int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
Initialize a hardware driver.
Definition: hwdriver.c:381
The device has internal storage, into which data is logged.
Definition: libsigrok.h:768
Trigger source.
Definition: libsigrok.h:645
The device supports setting a pattern (pattern generator mode).
Definition: libsigrok.h:636
struct sr_dev_driver ** sr_driver_list(void)
Return the list of supported hardware drivers.
Definition: hwdriver.c:359
Sound pressure level measurement range.
Definition: libsigrok.h:684
Sound pressure level frequency weighting.
Definition: libsigrok.h:678
Min hold mode.
Definition: libsigrok.h:690
Max hold mode.
Definition: libsigrok.h:687
void * priv
Definition: libsigrok.h:832
int sr_session_source_add(int fd, int events, int timeout, sr_receive_data_callback_t cb, void *cb_data)
Add an event source for a file descriptor.
Definition: session.c:593
char * name
Definition: libsigrok.h:808
Horizontal trigger position.
Definition: libsigrok.h:648
Function argument error.
Definition: libsigrok.h:70
The device supports using a external clock.
Definition: libsigrok.h:696
int sr_config_get(const struct sr_dev_driver *driver, int key, GVariant **data, const struct sr_dev_inst *sdi)
Returns information about the given driver or device instance.
Definition: hwdriver.c:507
int sr_config_list(const struct sr_dev_driver *driver, int key, GVariant **data, const struct sr_dev_inst *sdi)
List all possible values for a configuration key.
Definition: hwdriver.c:577
#define SR_API
Definition: libsigrok.h:121