]> sigrok.org Git - libsigrok.git/blob - hwdriver.c
Add SR_CONF key for data source
[libsigrok.git] / hwdriver.c
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_RLE, SR_T_BOOL, "rle",
67                 "Run Length Encoding", NULL},
68         {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
69                 "Trigger slope", NULL},
70         {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
71                 "Trigger source", NULL},
72         {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
73                 "Horizontal trigger position", NULL},
74         {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
75                 "Buffer size", NULL},
76         {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
77                 "Time base", NULL},
78         {SR_CONF_FILTER, SR_T_CHAR, "filter",
79                 "Filter targets", NULL},
80         {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
81                 "Volts/div", NULL},
82         {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
83                 "Coupling", NULL},
84         {SR_CONF_DATALOG, SR_T_BOOL, "datalog",
85                 "Datalog", NULL},
86         {SR_CONF_SPL_WEIGHT_FREQ, SR_T_CHAR, "spl_weight_freq",
87                 "Sound pressure level frequency weighting", NULL},
88         {SR_CONF_SPL_WEIGHT_TIME, SR_T_CHAR, "spl_weight_time",
89                 "Sound pressure level time weighting", NULL},
90         {SR_CONF_HOLD_MAX, SR_T_BOOL, "hold_max",
91                 "Hold max", NULL},
92         {SR_CONF_HOLD_MIN, SR_T_BOOL, "hold_min",
93                 "Hold min", NULL},
94         {SR_CONF_SPL_MEASUREMENT_RANGE, SR_T_UINT64_RANGE, "spl_meas_range",
95                 "Sound pressure level measurement range", NULL},
96         {SR_CONF_POWER_OFF, SR_T_BOOL, "power_off",
97                 "Power off", NULL},
98         {SR_CONF_DATA_SOURCE, SR_T_CHAR, "data_source",
99                 "Data source", NULL},
100         {0, 0, NULL, NULL, NULL},
101 };
102
103 /** @cond PRIVATE */
104 #ifdef HAVE_HW_BRYMEN_DMM
105 extern SR_PRIV struct sr_dev_driver brymen_bm857_driver_info;
106 #endif
107 #ifdef HAVE_HW_CEM_DT_885X
108 extern SR_PRIV struct sr_dev_driver cem_dt_885x_driver_info;
109 #endif
110 #ifdef HAVE_HW_COLEAD_SLM
111 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
112 #endif
113 #ifdef HAVE_HW_DEMO
114 extern SR_PRIV struct sr_dev_driver demo_driver_info;
115 #endif
116 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
117 extern SR_PRIV struct sr_dev_driver ikalogic_scanalogic2_driver_info;
118 #endif
119 #ifdef HAVE_HW_LASCAR_EL_USB
120 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
121 #endif
122 #ifdef HAVE_HW_MIC_985XX
123 extern SR_PRIV struct sr_dev_driver mic_98581_driver_info;
124 extern SR_PRIV struct sr_dev_driver mic_98583_driver_info;
125 #endif
126 #ifdef HAVE_HW_NEXUS_OSCIPRIME
127 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
128 #endif
129 #ifdef HAVE_HW_OLS
130 extern SR_PRIV struct sr_dev_driver ols_driver_info;
131 #endif
132 #ifdef HAVE_HW_RIGOL_DS1XX2
133 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
134 #endif
135 #ifdef HAVE_HW_TONDAJ_SL_814
136 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
137 #endif
138 #ifdef HAVE_HW_VICTOR_DMM
139 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
140 #endif
141 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
142 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
143 #endif
144 #ifdef HAVE_HW_ASIX_SIGMA
145 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
146 #endif
147 #ifdef HAVE_HW_CHRONOVU_LA8
148 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
149 #endif
150 #ifdef HAVE_HW_LINK_MSO19
151 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
152 #endif
153 #ifdef HAVE_HW_ALSA
154 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
155 #endif
156 #ifdef HAVE_HW_FX2LAFW
157 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
158 #endif
159 #ifdef HAVE_HW_HANTEK_DSO
160 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
161 #endif
162 #ifdef HAVE_HW_AGILENT_DMM
163 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
164 #endif
165 #ifdef HAVE_HW_FLUKE_DMM
166 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
167 #endif
168 #ifdef HAVE_HW_SERIAL_DMM
169 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
170 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
171 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
172 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
173 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
174 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
175 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
176 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
177 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
178 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
179 extern SR_PRIV struct sr_dev_driver radioshack_22_805_driver_info;
180 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
181 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_ser_driver_info;
182 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_ser_driver_info;
183 extern SR_PRIV struct sr_dev_driver voltcraft_m3650d_driver_info;
184 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
185 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
186 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_ser_driver_info;
187 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
188 #endif
189 #ifdef HAVE_HW_UNI_T_DMM
190 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8060_driver_info;
191 extern SR_PRIV struct sr_dev_driver tecpel_dmm_8061_driver_info;
192 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
193 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_driver_info;
194 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
195 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_driver_info;
196 #endif
197 /** @endcond */
198
199 static struct sr_dev_driver *drivers_list[] = {
200 #ifdef HAVE_HW_BRYMEN_DMM
201         &brymen_bm857_driver_info,
202 #endif
203 #ifdef HAVE_HW_CEM_DT_885X
204         &cem_dt_885x_driver_info,
205 #endif
206 #ifdef HAVE_HW_COLEAD_SLM
207         &colead_slm_driver_info,
208 #endif
209 #ifdef HAVE_HW_DEMO
210         &demo_driver_info,
211 #endif
212 #ifdef HAVE_HW_IKALOGIC_SCANALOGIC2
213         &ikalogic_scanalogic2_driver_info,
214 #endif
215 #ifdef HAVE_HW_LASCAR_EL_USB
216         &lascar_el_usb_driver_info,
217 #endif
218 #ifdef HAVE_HW_MIC_985XX
219         &mic_98581_driver_info,
220         &mic_98583_driver_info,
221 #endif
222 #ifdef HAVE_HW_NEXUS_OSCIPRIME
223         &nexus_osciprime_driver_info,
224 #endif
225 #ifdef HAVE_HW_OLS
226         &ols_driver_info,
227 #endif
228 #ifdef HAVE_HW_RIGOL_DS1XX2
229         &rigol_ds1xx2_driver_info,
230 #endif
231 #ifdef HAVE_HW_TONDAJ_SL_814
232         &tondaj_sl_814_driver_info,
233 #endif
234 #ifdef HAVE_HW_VICTOR_DMM
235         &victor_dmm_driver_info,
236 #endif
237 #ifdef HAVE_HW_ZEROPLUS_LOGIC_CUBE
238         &zeroplus_logic_cube_driver_info,
239 #endif
240 #ifdef HAVE_HW_ASIX_SIGMA
241         &asix_sigma_driver_info,
242 #endif
243 #ifdef HAVE_HW_CHRONOVU_LA8
244         &chronovu_la8_driver_info,
245 #endif
246 #ifdef HAVE_HW_LINK_MSO19
247         &link_mso19_driver_info,
248 #endif
249 #ifdef HAVE_HW_ALSA
250         &alsa_driver_info,
251 #endif
252 #ifdef HAVE_HW_FX2LAFW
253         &fx2lafw_driver_info,
254 #endif
255 #ifdef HAVE_HW_HANTEK_DSO
256         &hantek_dso_driver_info,
257 #endif
258 #ifdef HAVE_HW_AGILENT_DMM
259         &agdmm_driver_info,
260 #endif
261 #ifdef HAVE_HW_FLUKE_DMM
262         &flukedmm_driver_info,
263 #endif
264 #ifdef HAVE_HW_SERIAL_DMM
265         &digitek_dt4000zc_driver_info,
266         &tekpower_tp4000zc_driver_info,
267         &metex_me31_driver_info,
268         &peaktech_3410_driver_info,
269         &mastech_mas345_driver_info,
270         &va_va18b_driver_info,
271         &metex_m3640d_driver_info,
272         &peaktech_4370_driver_info,
273         &pce_pce_dm32_driver_info,
274         &radioshack_22_168_driver_info,
275         &radioshack_22_805_driver_info,
276         &radioshack_22_812_driver_info,
277         &tecpel_dmm_8060_ser_driver_info,
278         &tecpel_dmm_8061_ser_driver_info,
279         &voltcraft_m3650d_driver_info,
280         &voltcraft_vc820_ser_driver_info,
281         &voltcraft_vc840_ser_driver_info,
282         &uni_t_ut61d_ser_driver_info,
283         &uni_t_ut61e_ser_driver_info,
284 #endif
285 #ifdef HAVE_HW_UNI_T_DMM
286         &tecpel_dmm_8060_driver_info,
287         &tecpel_dmm_8061_driver_info,
288         &uni_t_ut61d_driver_info,
289         &uni_t_ut61e_driver_info,
290         &voltcraft_vc820_driver_info,
291         &voltcraft_vc840_driver_info,
292 #endif
293         NULL,
294 };
295
296 /**
297  * Return the list of supported hardware drivers.
298  *
299  * @return Pointer to the NULL-terminated list of hardware driver pointers.
300  */
301 SR_API struct sr_dev_driver **sr_driver_list(void)
302 {
303
304         return drivers_list;
305 }
306
307 /**
308  * Initialize a hardware driver.
309  *
310  * This usually involves memory allocations and variable initializations
311  * within the driver, but _not_ scanning for attached devices.
312  * The API call sr_driver_scan() is used for that.
313  *
314  * @param ctx A libsigrok context object allocated by a previous call to
315  *            sr_init(). Must not be NULL.
316  * @param driver The driver to initialize. This must be a pointer to one of
317  *               the entries returned by sr_driver_list(). Must not be NULL.
318  *
319  * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
320  *         SR_ERR_BUG upon internal errors, or another negative error code
321  *         upon other errors.
322  */
323 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
324 {
325         int ret;
326
327         if (!ctx) {
328                 sr_err("Invalid libsigrok context, can't initialize.");
329                 return SR_ERR_ARG;
330         }
331
332         if (!driver) {
333                 sr_err("Invalid driver, can't initialize.");
334                 return SR_ERR_ARG;
335         }
336
337         sr_spew("Initializing driver '%s'.", driver->name);
338         if ((ret = driver->init(ctx)) < 0)
339                 sr_err("Failed to initialize the driver: %d.", ret);
340
341         return ret;
342 }
343
344 /**
345  * Tell a hardware driver to scan for devices.
346  *
347  * In addition to the detection, the devices that are found are also
348  * initialized automatically. On some devices, this involves a firmware upload,
349  * or other such measures.
350  *
351  * The order in which the system is scanned for devices is not specified. The
352  * caller should not assume or rely on any specific order.
353  *
354  * Before calling sr_driver_scan(), the user must have previously initialized
355  * the driver by calling sr_driver_init().
356  *
357  * @param driver The driver that should scan. This must be a pointer to one of
358  *               the entries returned by sr_driver_list(). Must not be NULL.
359  * @param options A list of 'struct sr_hwopt' options to pass to the driver's
360  *                scanner. Can be NULL/empty.
361  *
362  * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
363  *         found (or errors were encountered). This list must be freed by the
364  *         caller using g_slist_free(), but without freeing the data pointed
365  *         to in the list.
366  */
367 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
368 {
369         GSList *l;
370
371         if (!driver) {
372                 sr_err("Invalid driver, can't scan for devices.");
373                 return NULL;
374         }
375
376         if (!driver->priv) {
377                 sr_err("Driver not initialized, can't scan for devices.");
378                 return NULL;
379         }
380
381         l = driver->scan(options);
382
383         sr_spew("Scan of '%s' found %d devices.", driver->name,
384                 g_slist_length(l));
385
386         return l;
387 }
388
389 /** @private */
390 SR_PRIV void sr_hw_cleanup_all(void)
391 {
392         int i;
393         struct sr_dev_driver **drivers;
394
395         drivers = sr_driver_list();
396         for (i = 0; drivers[i]; i++) {
397                 if (drivers[i]->cleanup)
398                         drivers[i]->cleanup();
399         }
400 }
401
402 /** A floating reference can be passed in for data. */
403 SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data)
404 {
405         struct sr_config *src;
406
407         if (!(src = g_try_malloc(sizeof(struct sr_config))))
408                 return NULL;
409         src->key = key;
410         src->data = g_variant_ref_sink(data);
411
412         return src;
413 }
414
415 SR_PRIV void sr_config_free(struct sr_config *src)
416 {
417
418         if (!src || !src->data) {
419                 sr_err("%s: invalid data!", __func__);
420                 return;
421         }
422
423         g_variant_unref(src->data);
424         g_free(src);
425
426 }
427
428 /**
429  * Returns information about the given driver or device instance.
430  *
431  * @param driver The sr_dev_driver struct to query.
432  * @param key The configuration key (SR_CONF_*).
433  * @param data Pointer to a GVariant where the value will be stored. Must
434  *             not be NULL. The caller is given ownership of the GVariant
435  *             and must thus decrease the refcount after use. However if
436  *             this function returns an error code, the field should be
437  *             considered unused, and should not be unreferenced.
438  * @param sdi (optional) If the key is specific to a device, this must
439  *            contain a pointer to the struct sr_dev_inst to be checked.
440  *            Otherwise it must be NULL.
441  *
442  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
443  *         may be returned by the driver indicating it doesn't know that key,
444  *         but this is not to be flagged as an error by the caller; merely
445  *         as an indication that it's not applicable.
446  */
447 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
448                 GVariant **data, const struct sr_dev_inst *sdi)
449 {
450         int ret;
451
452         if (!driver || !data)
453                 return SR_ERR;
454
455         if (!driver->config_get)
456                 return SR_ERR_ARG;
457
458         if ((ret = driver->config_get(key, data, sdi)) == SR_OK) {
459                 /* Got a floating reference from the driver. Sink it here,
460                  * caller will need to unref when done with it. */
461                 g_variant_ref_sink(*data);
462         }
463
464         return ret;
465 }
466
467 /**
468  * Set a configuration key in a device instance.
469  *
470  * @param sdi The device instance.
471  * @param key The configuration key (SR_CONF_*).
472  * @param data The new value for the key, as a GVariant with GVariantType
473  *        appropriate to that key. A floating reference can be passed
474  *        in; its refcount will be sunk and unreferenced after use.
475  *
476  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
477  *         may be returned by the driver indicating it doesn't know that key,
478  *         but this is not to be flagged as an error by the caller; merely
479  *         as an indication that it's not applicable.
480  */
481 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data)
482 {
483         int ret;
484
485         g_variant_ref_sink(data);
486
487         if (!sdi || !sdi->driver || !data)
488                 ret = SR_ERR;
489         else if (!sdi->driver->config_set)
490                 ret = SR_ERR_ARG;
491         else
492                 ret = sdi->driver->config_set(key, data, sdi);
493
494         g_variant_unref(data);
495
496         return ret;
497 }
498
499 /**
500  * List all possible values for a configuration key.
501  *
502  * @param driver The sr_dev_driver struct to query.
503  * @param key The configuration key (SR_CONF_*).
504  * @param data A pointer to a GVariant where the list will be stored. The
505  *             caller is given ownership of the GVariant and must thus
506  *             unref the GVariant after use. However if this function
507  *             returns an error code, the field should be considered
508  *             unused, and should not be unreferenced.
509  * @param sdi (optional) If the key is specific to a device, this must
510  *            contain a pointer to the struct sr_dev_inst to be checked.
511  *
512  * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
513  *         may be returned by the driver indicating it doesn't know that key,
514  *         but this is not to be flagged as an error by the caller; merely
515  *         as an indication that it's not applicable.
516  */
517 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
518                 GVariant **data, const struct sr_dev_inst *sdi)
519 {
520         int ret;
521
522         if (!driver || !data)
523                 ret = SR_ERR;
524         else if (!driver->config_list)
525                 ret = SR_ERR_ARG;
526         else if ((ret = driver->config_list(key, data, sdi)) == SR_OK)
527                 g_variant_ref_sink(*data);
528
529         return ret;
530 }
531
532 /**
533  * Get information about a configuration key.
534  *
535  * @param key The configuration key.
536  *
537  * @return A pointer to a struct sr_config_info, or NULL if the key
538  *         was not found.
539  */
540 SR_API const struct sr_config_info *sr_config_info_get(int key)
541 {
542         int i;
543
544         for (i = 0; sr_config_info_data[i].key; i++) {
545                 if (sr_config_info_data[i].key == key)
546                         return &sr_config_info_data[i];
547         }
548
549         return NULL;
550 }
551
552 /**
553  * Get information about an configuration key, by name.
554  *
555  * @param optname The configuration key.
556  *
557  * @return A pointer to a struct sr_config_info, or NULL if the key
558  *         was not found.
559  */
560 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
561 {
562         int i;
563
564         for (i = 0; sr_config_info_data[i].key; i++) {
565                 if (!strcmp(sr_config_info_data[i].id, optname))
566                         return &sr_config_info_data[i];
567         }
568
569         return NULL;
570 }
571
572 /* Unnecessary level of indirection follows. */
573
574 /** @private */
575 SR_PRIV int sr_source_remove(int fd)
576 {
577         return sr_session_source_remove(fd);
578 }
579
580 /** @private */
581 SR_PRIV int sr_source_add(int fd, int events, int timeout,
582                           sr_receive_data_callback_t cb, void *cb_data)
583 {
584         return sr_session_source_add(fd, events, timeout, cb, cb_data);
585 }
586
587 /** @} */