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