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