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