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