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