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 "libsigrok.h"
27 #include "libsigrok-internal.h"
30 /* Driver scanning options. */
31 SR_API struct sr_hwcap_option sr_drvopts[] = {
32 {SR_HWOPT_MODEL, SR_T_KEYVALUE, "Model", "model"},
33 {SR_HWOPT_CONN, SR_T_CHAR, "Connection", "conn"},
34 {SR_HWOPT_SERIALCOMM, SR_T_CHAR, "Serial communication", "serialcomm"},
38 /* Device instance options. */
39 SR_API struct sr_hwcap_option sr_hwcap_options[] = {
40 {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"},
41 {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"},
42 {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"},
43 {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"},
44 {SR_HWCAP_TRIGGER_SLOPE, SR_T_UINT64, "Trigger slope", "triggerslope"},
45 {SR_HWCAP_TRIGGER_SOURCE, SR_T_CHAR, "Trigger source", "triggersource"},
46 {SR_HWCAP_HORIZ_TRIGGERPOS, SR_T_FLOAT, "Horizontal trigger position",
48 {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"},
49 {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"},
50 {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"},
51 {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"},
52 {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"},
57 extern SR_PRIV struct sr_dev_driver demo_driver_info;
60 extern SR_PRIV struct sr_dev_driver ols_driver_info;
62 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
63 extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info;
65 #ifdef HAVE_LA_ASIX_SIGMA
66 extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info;
68 #ifdef HAVE_LA_CHRONOVU_LA8
69 extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info;
71 #ifdef HAVE_LA_LINK_MSO19
72 extern SR_PRIV struct sr_dev_driver link_mso19_driver_info;
75 extern SR_PRIV struct sr_dev_driver alsa_driver_info;
77 #ifdef HAVE_LA_FX2LAFW
78 extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info;
80 #ifdef HAVE_HW_HANTEK_DSO
81 extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info;
83 #ifdef HAVE_HW_GENERICDMM
84 extern SR_PRIV struct sr_dev_driver genericdmm_driver_info;
87 static struct sr_dev_driver *drivers_list[] = {
94 #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE
95 &zeroplus_logic_cube_driver_info,
97 #ifdef HAVE_LA_ASIX_SIGMA
98 &asix_sigma_driver_info,
100 #ifdef HAVE_LA_CHRONOVU_LA8
101 &chronovu_la8_driver_info,
103 #ifdef HAVE_LA_LINK_MSO19
104 &link_mso19_driver_info,
109 #ifdef HAVE_LA_FX2LAFW
110 &fx2lafw_driver_info,
112 #ifdef HAVE_HW_HANTEK_DSO
113 &hantek_dso_driver_info,
115 #ifdef HAVE_HW_GENERICDMM
116 &genericdmm_driver_info,
122 * Return the list of supported hardware drivers.
124 * @return Pointer to the NULL-terminated list of hardware driver pointers.
126 SR_API struct sr_dev_driver **sr_driver_list(void)
133 * Initialize a hardware driver.
135 * @param driver The driver to initialize.
137 * @return SR_OK if all went well, or an error code otherwise.
139 SR_API int sr_driver_init(struct sr_dev_driver *driver)
143 return driver->init();
149 * Tell a hardware driver to scan for devices.
151 * @param driver The driver.
152 * @param options A list of struct sr_hwopt options to pass to the driver's
155 * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found.
156 * This list must be freed by the caller, but without freeing the data
157 * pointed to in the list.
159 SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options)
163 return driver->scan(options);
168 SR_PRIV void sr_hw_cleanup_all(void)
171 struct sr_dev_driver **drivers;
173 drivers = sr_driver_list();
174 for (i = 0; drivers[i]; i++) {
175 if (drivers[i]->cleanup)
176 drivers[i]->cleanup();
181 * Returns information about the given driver or device instance.
183 * @param driver The sr_dev_driver struct to query.
184 * @param id The type of information, in the form of an SR_HWCAP_* option.
185 * @param data Pointer where the value. will be stored. Must not be NULL.
186 * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL.
188 * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG
189 * may be returned by the driver indicating it doesn't know that id,
190 * but this is not to be flagged as an error by the caller; merely
191 * as an indication that it's not applicable.
193 SR_API int sr_info_get(struct sr_dev_driver *driver, int id,
194 const void **data, const struct sr_dev_inst *sdi)
198 if (driver == NULL || data == NULL)
201 ret = driver->info_get(id, data, sdi);
206 SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status,
207 const char *vendor, const char *model, const char *version)
209 struct sr_dev_inst *sdi;
211 if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) {
212 sr_err("hwdriver: %s: sdi malloc failed", __func__);
217 sdi->status = status;
219 sdi->vendor = vendor ? g_strdup(vendor) : NULL;
220 sdi->model = model ? g_strdup(model) : NULL;
221 sdi->version = version ? g_strdup(version) : NULL;
228 SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index)
230 struct sr_dev_inst *sdi;
233 for (l = dev_insts; l; l = l->next) {
234 sdi = (struct sr_dev_inst *)(l->data);
235 if (sdi->index == dev_index)
238 sr_warn("could not find device index %d instance", dev_index);
243 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi)
248 g_free(sdi->version);
252 SR_PRIV struct sr_probe *sr_probe_new(int index, int type,
253 gboolean enabled, const char *name)
255 struct sr_probe *probe;
257 if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) {
258 sr_err("hwdriver: probe malloc failed");
262 probe->index = index;
264 probe->enabled = enabled;
266 probe->name = g_strdup(name);
271 #ifdef HAVE_LIBUSB_1_0
273 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
274 uint8_t address, struct libusb_device_handle *hdl)
276 struct sr_usb_dev_inst *udi;
278 if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) {
279 sr_err("hwdriver: %s: udi malloc failed", __func__);
284 udi->address = address;
290 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb)
292 /* Avoid compiler warnings. */
295 /* Nothing to do for this device instance type. */
300 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
303 struct sr_serial_dev_inst *serial;
305 if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) {
306 sr_err("hwdriver: %s: serial malloc failed", __func__);
310 serial->port = g_strdup(port);
316 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial)
318 g_free(serial->port);
322 * Find out if a hardware driver has a specific capability.
324 * @param driver The hardware driver in which to search for the capability.
325 * @param hwcap The capability to find in the list.
327 * @return TRUE if the specified capability exists in the specified driver,
328 * FALSE otherwise. Also, if 'driver' is NULL or the respective driver
329 * returns an invalid capability list, FALSE is returned.
331 SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap)
337 sr_err("hwdriver: %s: driver was NULL", __func__);
341 if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK)
344 for (i = 0; hwcaps[i]; i++) {
345 if (hwcaps[i] == hwcap)
353 * Get a hardware driver option.
355 * @param hwopt The option to get.
357 * @return A pointer to a struct with information about the parameter, or NULL
358 * if the option was not found.
360 SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt)
364 for (i = 0; sr_drvopts[i].hwcap; i++) {
365 if (sr_drvopts[i].hwcap == hwopt)
366 return &sr_drvopts[i];
373 * Get a hardware driver capability option.
375 * @param hwcap The capability to get.
377 * @return A pointer to a struct with information about the parameter, or NULL
378 * if the capability was not found.
380 SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap)
384 for (i = 0; sr_hwcap_options[i].hwcap; i++) {
385 if (sr_hwcap_options[i].hwcap == hwcap)
386 return &sr_hwcap_options[i];
392 /* Unnecessary level of indirection follows. */
394 SR_PRIV int sr_source_remove(int fd)
396 return sr_session_source_remove(fd);
399 SR_PRIV int sr_source_add(int fd, int events, int timeout,
400 sr_receive_data_callback_t cb, void *cb_data)
402 return sr_session_source_add(fd, events, timeout, cb, cb_data);