2 * This file is part of the sigrok project.
4 * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
22 #include <sys/types.h>
26 #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */
27 #include "libsigrok.h"
28 #include "libsigrok-internal.h"
30 /* Message logging helpers with driver-specific prefix string. */
31 #define DRIVER_LOG_DOMAIN "hwdriver: "
32 #define sr_log(l, s, args...) sr_log(l, DRIVER_LOG_DOMAIN s, ## args)
33 #define sr_spew(s, args...) sr_spew(DRIVER_LOG_DOMAIN s, ## args)
34 #define sr_dbg(s, args...) sr_dbg(DRIVER_LOG_DOMAIN s, ## args)
35 #define sr_info(s, args...) sr_info(DRIVER_LOG_DOMAIN s, ## args)
36 #define sr_warn(s, args...) sr_warn(DRIVER_LOG_DOMAIN s, ## args)
37 #define sr_err(s, args...) sr_err(DRIVER_LOG_DOMAIN s, ## args)
42 * Hardware driver handling in libsigrok.
46 * @defgroup grp_driver Hardware drivers
48 * Hardware driver handling in libsigrok.
53 static struct sr_config_info sr_config_info_data[] = {
54 {SR_CONF_CONN, SR_T_CHAR, "conn",
56 {SR_CONF_SERIALCOMM, SR_T_CHAR, "serialcomm",
57 "Serial communication", NULL},
58 {SR_CONF_SAMPLERATE, SR_T_UINT64, "samplerate",
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_RLE, SR_T_BOOL, "rle",
65 "Run Length Encoding", NULL},
66 {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope",
67 "Trigger slope", NULL},
68 {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource",
69 "Trigger source", NULL},
70 {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos",
71 "Horizontal trigger position", NULL},
72 {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize",
74 {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase",
76 {SR_CONF_FILTER, SR_T_CHAR, "filter",
77 "Filter targets", NULL},
78 {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv",
80 {SR_CONF_COUPLING, SR_T_CHAR, "coupling",
82 {0, 0, NULL, NULL, NULL},
86 #ifdef HAVE_HW_COLEAD_SLM
87 extern SR_PRIV struct sr_dev_driver colead_slm_driver_info;
90 extern SR_PRIV struct sr_dev_driver demo_driver_info;
92 #ifdef HAVE_HW_LASCAR_EL_USB
93 extern SR_PRIV struct sr_dev_driver lascar_el_usb_driver_info;
95 #ifdef HAVE_HW_NEXUS_OSCIPRIME
96 extern SR_PRIV struct sr_dev_driver nexus_osciprime_driver_info;
99 extern SR_PRIV struct sr_dev_driver ols_driver_info;
101 #ifdef HAVE_HW_RIGOL_DS1XX2
102 extern SR_PRIV struct sr_dev_driver rigol_ds1xx2_driver_info;
104 #ifdef HAVE_HW_TONDAJ_SL_814
105 extern SR_PRIV struct sr_dev_driver tondaj_sl_814_driver_info;
107 #ifdef HAVE_HW_VICTOR_DMM
108 extern SR_PRIV struct sr_dev_driver victor_dmm_driver_info;
110 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
111 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
113 #ifdef HAVE_LA_ASIX_SIGMA
114 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
116 #ifdef HAVE_LA_CHRONOVU_LA8
117 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
119 #ifdef HAVE_LA_LINK_MSO19
120 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
123 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
125 #ifdef HAVE_LA_FX2LAFW
126 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
128 #ifdef HAVE_HW_HANTEK_DSO
129 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
131 #ifdef HAVE_HW_AGILENT_DMM
132 extern SR_PRIV struct sr_dev_driver agdmm_driver_info;
134 #ifdef HAVE_HW_FLUKE_DMM
135 extern SR_PRIV struct sr_dev_driver flukedmm_driver_info;
137 #ifdef HAVE_HW_SERIAL_DMM
138 extern SR_PRIV struct sr_dev_driver digitek_dt4000zc_driver_info;
139 extern SR_PRIV struct sr_dev_driver tekpower_tp4000zc_driver_info;
140 extern SR_PRIV struct sr_dev_driver metex_me31_driver_info;
141 extern SR_PRIV struct sr_dev_driver peaktech_3410_driver_info;
142 extern SR_PRIV struct sr_dev_driver mastech_mas345_driver_info;
143 extern SR_PRIV struct sr_dev_driver va_va18b_driver_info;
144 extern SR_PRIV struct sr_dev_driver metex_m3640d_driver_info;
145 extern SR_PRIV struct sr_dev_driver peaktech_4370_driver_info;
146 extern SR_PRIV struct sr_dev_driver pce_pce_dm32_driver_info;
147 extern SR_PRIV struct sr_dev_driver radioshack_22_168_driver_info;
148 extern SR_PRIV struct sr_dev_driver radioshack_22_812_driver_info;
149 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_ser_driver_info;
150 extern SR_PRIV struct sr_dev_driver voltcraft_vc840_ser_driver_info;
151 extern SR_PRIV struct sr_dev_driver uni_t_ut61e_ser_driver_info;
153 #ifdef HAVE_HW_UNI_T_DMM
154 extern SR_PRIV struct sr_dev_driver uni_t_ut61d_driver_info;
155 extern SR_PRIV struct sr_dev_driver voltcraft_vc820_driver_info;
159 static struct sr_dev_driver *drivers_list[] = {
160 #ifdef HAVE_HW_COLEAD_SLM
161 &colead_slm_driver_info,
166 #ifdef HAVE_HW_LASCAR_EL_USB
167 &lascar_el_usb_driver_info,
169 #ifdef HAVE_HW_NEXUS_OSCIPRIME
170 &nexus_osciprime_driver_info,
175 #ifdef HAVE_HW_RIGOL_DS1XX2
176 &rigol_ds1xx2_driver_info,
178 #ifdef HAVE_HW_TONDAJ_SL_814
179 &tondaj_sl_814_driver_info,
181 #ifdef HAVE_HW_VICTOR_DMM
182 &victor_dmm_driver_info,
184 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
185 &zeroplus_logic_cube_driver_info,
187 #ifdef HAVE_LA_ASIX_SIGMA
188 &asix_sigma_driver_info,
190 #ifdef HAVE_LA_CHRONOVU_LA8
191 &chronovu_la8_driver_info,
193 #ifdef HAVE_LA_LINK_MSO19
194 &link_mso19_driver_info,
199 #ifdef HAVE_LA_FX2LAFW
200 &fx2lafw_driver_info,
202 #ifdef HAVE_HW_HANTEK_DSO
203 &hantek_dso_driver_info,
205 #ifdef HAVE_HW_AGILENT_DMM
208 #ifdef HAVE_HW_FLUKE_DMM
209 &flukedmm_driver_info,
211 #ifdef HAVE_HW_SERIAL_DMM
212 &digitek_dt4000zc_driver_info,
213 &tekpower_tp4000zc_driver_info,
214 &metex_me31_driver_info,
215 &peaktech_3410_driver_info,
216 &mastech_mas345_driver_info,
217 &va_va18b_driver_info,
218 &metex_m3640d_driver_info,
219 &peaktech_4370_driver_info,
220 &pce_pce_dm32_driver_info,
221 &radioshack_22_168_driver_info,
222 &radioshack_22_812_driver_info,
223 &voltcraft_vc820_ser_driver_info,
224 &voltcraft_vc840_ser_driver_info,
225 &uni_t_ut61e_ser_driver_info,
227 #ifdef HAVE_HW_UNI_T_DMM
228 &uni_t_ut61d_driver_info,
229 &voltcraft_vc820_driver_info,
235 * Return the list of supported hardware drivers.
237 * @return Pointer to the NULL-terminated list of hardware driver pointers.
239 SR_API struct sr_dev_driver **sr_driver_list(void)
246 * Initialize a hardware driver.
248 * This usually involves memory allocations and variable initializations
249 * within the driver, but _not_ scanning for attached devices.
250 * The API call sr_driver_scan() is used for that.
252 * @param ctx A libsigrok context object allocated by a previous call to
253 * sr_init(). Must not be NULL.
254 * @param driver The driver to initialize. This must be a pointer to one of
255 * the entries returned by sr_driver_list(). Must not be NULL.
257 * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters,
258 * SR_ERR_BUG upon internal errors, or another negative error code
261 SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver)
266 sr_err("Invalid libsigrok context, can't initialize.");
271 sr_err("Invalid driver, can't initialize.");
275 sr_spew("Initializing driver '%s'.", driver->name);
276 if ((ret = driver->init(ctx)) < 0)
277 sr_err("Failed to initialize the driver: %d.", ret);
283 * Tell a hardware driver to scan for devices.
285 * In addition to the detection, the devices that are found are also
286 * initialized automatically. On some devices, this involves a firmware upload,
287 * or other such measures.
289 * The order in which the system is scanned for devices is not specified. The
290 * caller should not assume or rely on any specific order.
292 * Before calling sr_driver_scan(), the user must have previously initialized
293 * the driver by calling sr_driver_init().
295 * @param driver The driver that should scan. This must be a pointer to one of
296 * the entries returned by sr_driver_list(). Must not be NULL.
297 * @param options A list of 'struct sr_hwopt' options to pass to the driver's
298 * scanner. Can be NULL/empty.
300 * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were
301 * found (or errors were encountered). This list must be freed by the
302 * caller using g_slist_free(), but without freeing the data pointed
305 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
310 sr_err("Invalid driver, can't scan for devices.");
315 sr_err("Driver not initialized, can't scan for devices.");
319 l = driver->scan(options);
321 sr_spew("Scan of '%s' found %d devices.", driver->name,
328 SR_PRIV void sr_hw_cleanup_all(void)
331 struct sr_dev_driver **drivers;
333 drivers = sr_driver_list();
334 for (i = 0; drivers[i]; i++) {
335 if (drivers[i]->cleanup)
336 drivers[i]->cleanup();
340 SR_PRIV struct sr_config *sr_config_make(int key, const void *value)
342 struct sr_config *src;
344 if (!(src = g_try_malloc(sizeof(struct sr_config))))
353 * Returns information about the given driver or device instance.
355 * @param driver The sr_dev_driver struct to query.
356 * @param key The configuration key (SR_CONF_*).
357 * @param data Pointer where the value will be stored. Must not be NULL.
358 * @param sdi If the key is specific to a device, this must contain a
359 * pointer to the struct sr_dev_inst to be checked.
361 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
362 * may be returned by the driver indicating it doesn't know that key,
363 * but this is not to be flagged as an error by the caller; merely
364 * as an indication that it's not applicable.
366 SR_API int sr_config_get(const struct sr_dev_driver *driver, int key,
367 const void **data, const struct sr_dev_inst *sdi)
371 if (!driver || !data)
374 if (!driver->config_get)
377 ret = driver->config_get(key, data, sdi);
383 * Set a configuration key in a device instance.
385 * @param sdi The device instance.
386 * @param key The configuration key (SR_CONF_*).
387 * @param value The new value for the key, as a pointer to whatever type
388 * is appropriate for that key.
390 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
391 * may be returned by the driver indicating it doesn't know that key,
392 * but this is not to be flagged as an error by the caller; merely
393 * as an indication that it's not applicable.
395 SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key,
400 if (!sdi || !sdi->driver || !value)
403 if (!sdi->driver->config_set)
406 ret = sdi->driver->config_set(key, value, sdi);
412 * List all possible values for a configuration key.
414 * @param driver The sr_dev_driver struct to query.
415 * @param key The configuration key (SR_CONF_*).
416 * @param data A pointer to a list of values, in whatever format is
417 * appropriate for that key.
418 * @param sdi If the key is specific to a device, this must contain a
419 * pointer to the struct sr_dev_inst to be checked.
421 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
422 * may be returned by the driver indicating it doesn't know that key,
423 * but this is not to be flagged as an error by the caller; merely
424 * as an indication that it's not applicable.
426 SR_API int sr_config_list(const struct sr_dev_driver *driver, int key,
427 const void **data, const struct sr_dev_inst *sdi)
431 if (!driver || !data)
434 if (!driver->config_list)
437 ret = driver->config_list(key, data, sdi);
443 * Get information about a configuration key.
445 * @param opt The configuration key.
447 * @return A pointer to a struct sr_config_info, or NULL if the key
450 SR_API const struct sr_config_info *sr_config_info_get(int key)
454 for (i = 0; sr_config_info_data[i].key; i++) {
455 if (sr_config_info_data[i].key == key)
456 return &sr_config_info_data[i];
463 * Get information about an configuration key, by name.
465 * @param optname The configuration key.
467 * @return A pointer to a struct sr_config_info, or NULL if the key
470 SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname)
474 for (i = 0; sr_config_info_data[i].key; i++) {
475 if (!strcmp(sr_config_info_data[i].id, optname))
476 return &sr_config_info_data[i];
482 /* Unnecessary level of indirection follows. */
485 SR_PRIV int sr_source_remove(int fd)
487 return sr_session_source_remove(fd);
491 SR_PRIV int sr_source_add(int fd, int events, int timeout,
492 sr_receive_data_callback_t cb, void *cb_data)
494 return sr_session_source_add(fd, events, timeout, cb, cb_data);