]>
Commit | Line | Data |
---|---|---|
a1bb33af UH |
1 | /* |
2 | * This file is part of the sigrok project. | |
3 | * | |
c73d2ea4 | 4 | * Copyright (C) 2010-2012 Bert Vermeulen <bert@biot.com> |
a1bb33af UH |
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> | |
45c59c8b BV |
26 | #include "libsigrok.h" |
27 | #include "libsigrok-internal.h" | |
a1bb33af | 28 | |
8bfdc8c4 BV |
29 | |
30 | /* Driver scanning options. */ | |
31 | SR_API struct sr_hwcap_option sr_drvopts[] = { | |
b159add3 BV |
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"}, | |
8bfdc8c4 BV |
35 | {0, 0, NULL, NULL}, |
36 | }; | |
37 | ||
38 | /* Device instance options. */ | |
39 | SR_API struct sr_hwcap_option sr_hwcap_options[] = { | |
5a2326a7 UH |
40 | {SR_HWCAP_SAMPLERATE, SR_T_UINT64, "Sample rate", "samplerate"}, |
41 | {SR_HWCAP_CAPTURE_RATIO, SR_T_UINT64, "Pre-trigger capture ratio", "captureratio"}, | |
eb0a3731 | 42 | {SR_HWCAP_PATTERN_MODE, SR_T_CHAR, "Pattern generator mode", "pattern"}, |
4d436e71 | 43 | {SR_HWCAP_RLE, SR_T_BOOL, "Run Length Encoding", "rle"}, |
0fe11789 BV |
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", | |
47 | "horiz_triggerpos"}, | |
48 | {SR_HWCAP_BUFFERSIZE, SR_T_UINT64, "Buffer size", "buffersize"}, | |
c1e48618 | 49 | {SR_HWCAP_TIMEBASE, SR_T_RATIONAL_PERIOD, "Time base", "timebase"}, |
3c4976c9 | 50 | {SR_HWCAP_FILTER, SR_T_CHAR, "Filter targets", "filter"}, |
bd8db307 | 51 | {SR_HWCAP_VDIV, SR_T_RATIONAL_VOLT, "Volts/div", "vdiv"}, |
e1c8b2ab | 52 | {SR_HWCAP_COUPLING, SR_T_CHAR, "Coupling", "coupling"}, |
49d0ce50 | 53 | {0, 0, NULL, NULL}, |
a1bb33af UH |
54 | }; |
55 | ||
a61b0e6a | 56 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 57 | extern SR_PRIV struct sr_dev_driver demo_driver_info; |
a61b0e6a | 58 | #endif |
960a75e4 | 59 | #ifdef HAVE_LA_OLS |
c09f0b57 | 60 | extern SR_PRIV struct sr_dev_driver ols_driver_info; |
960a75e4 UH |
61 | #endif |
62 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE | |
c09f0b57 | 63 | extern SR_PRIV struct sr_dev_driver zeroplus_logic_cube_driver_info; |
960a75e4 | 64 | #endif |
5b907f9b | 65 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 66 | extern SR_PRIV struct sr_dev_driver asix_sigma_driver_info; |
5b907f9b | 67 | #endif |
f4314d7e | 68 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 69 | extern SR_PRIV struct sr_dev_driver chronovu_la8_driver_info; |
f4314d7e | 70 | #endif |
bffed4fc | 71 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 72 | extern SR_PRIV struct sr_dev_driver link_mso19_driver_info; |
bffed4fc | 73 | #endif |
6ed4f044 | 74 | #ifdef HAVE_LA_ALSA |
c09f0b57 | 75 | extern SR_PRIV struct sr_dev_driver alsa_driver_info; |
6ed4f044 | 76 | #endif |
f302a082 | 77 | #ifdef HAVE_LA_FX2LAFW |
c09f0b57 | 78 | extern SR_PRIV struct sr_dev_driver fx2lafw_driver_info; |
f302a082 | 79 | #endif |
3b533202 | 80 | #ifdef HAVE_HW_HANTEK_DSO |
62bb8840 | 81 | extern SR_PRIV struct sr_dev_driver hantek_dso_driver_info; |
3b533202 | 82 | #endif |
ca3d84cc BV |
83 | #ifdef HAVE_HW_GENERICDMM |
84 | extern SR_PRIV struct sr_dev_driver genericdmm_driver_info; | |
85 | #endif | |
6ed4f044 | 86 | |
c09f0b57 | 87 | static struct sr_dev_driver *drivers_list[] = { |
a61b0e6a | 88 | #ifdef HAVE_LA_DEMO |
c09f0b57 | 89 | &demo_driver_info, |
a61b0e6a | 90 | #endif |
960a75e4 | 91 | #ifdef HAVE_LA_OLS |
c09f0b57 | 92 | &ols_driver_info, |
960a75e4 UH |
93 | #endif |
94 | #ifdef HAVE_LA_ZEROPLUS_LOGIC_CUBE | |
c09f0b57 | 95 | &zeroplus_logic_cube_driver_info, |
960a75e4 | 96 | #endif |
5b907f9b | 97 | #ifdef HAVE_LA_ASIX_SIGMA |
c09f0b57 | 98 | &asix_sigma_driver_info, |
5b907f9b | 99 | #endif |
f4314d7e | 100 | #ifdef HAVE_LA_CHRONOVU_LA8 |
c09f0b57 | 101 | &chronovu_la8_driver_info, |
f4314d7e | 102 | #endif |
bffed4fc | 103 | #ifdef HAVE_LA_LINK_MSO19 |
c09f0b57 | 104 | &link_mso19_driver_info, |
bffed4fc | 105 | #endif |
6ed4f044 | 106 | #ifdef HAVE_LA_ALSA |
c09f0b57 | 107 | &alsa_driver_info, |
f302a082 JH |
108 | #endif |
109 | #ifdef HAVE_LA_FX2LAFW | |
c09f0b57 | 110 | &fx2lafw_driver_info, |
3b533202 BV |
111 | #endif |
112 | #ifdef HAVE_HW_HANTEK_DSO | |
62bb8840 | 113 | &hantek_dso_driver_info, |
6ed4f044 | 114 | #endif |
ca3d84cc BV |
115 | #ifdef HAVE_HW_GENERICDMM |
116 | &genericdmm_driver_info, | |
eb1f1eb4 | 117 | #endif |
050e9219 UH |
118 | NULL, |
119 | }; | |
a1bb33af | 120 | |
a1645fcd | 121 | /** |
cfe064d8 | 122 | * Return the list of supported hardware drivers. |
a1645fcd | 123 | * |
c09f0b57 | 124 | * @return Pointer to the NULL-terminated list of hardware driver pointers. |
a1645fcd | 125 | */ |
cfe064d8 | 126 | SR_API struct sr_dev_driver **sr_driver_list(void) |
a1bb33af | 127 | { |
80bf0426 | 128 | |
c09f0b57 | 129 | return drivers_list; |
a1bb33af UH |
130 | } |
131 | ||
a1645fcd | 132 | /** |
c09f0b57 | 133 | * Initialize a hardware driver. |
a1645fcd | 134 | * |
c09f0b57 | 135 | * @param driver The driver to initialize. |
a1645fcd | 136 | * |
80bf0426 | 137 | * @return SR_OK if all went well, or an error code otherwise. |
a1645fcd | 138 | */ |
cfe064d8 | 139 | SR_API int sr_driver_init(struct sr_dev_driver *driver) |
8722c31e | 140 | { |
8722c31e | 141 | |
80bf0426 BV |
142 | if (driver->init) |
143 | return driver->init(); | |
144 | ||
145 | return SR_OK; | |
146 | } | |
147 | ||
148 | /** | |
149 | * Tell a hardware driver to scan for devices. | |
150 | * | |
a5f2e707 BV |
151 | * In addition to the detection, the devices that are found are also |
152 | * initialized automatically. On some devices, this involves a firmware upload, | |
153 | * or other such measures. | |
154 | * | |
155 | * The order in which the system is scanned for devices is not specified. The | |
156 | * caller should not assume or rely on any specific order. | |
157 | * | |
80bf0426 BV |
158 | * @param driver The driver. |
159 | * @param options A list of struct sr_hwopt options to pass to the driver's | |
160 | * scanner. | |
161 | * | |
162 | * @return A GSList * of struct sr_dev_inst, or NULL if no devices were found. | |
163 | * This list must be freed by the caller, but without freeing the data | |
164 | * pointed to in the list. | |
165 | */ | |
166 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
167 | { | |
168 | ||
169 | if (driver->scan) | |
170 | return driver->scan(options); | |
171 | ||
172 | return NULL; | |
8722c31e BV |
173 | } |
174 | ||
93a04e3b | 175 | SR_PRIV void sr_hw_cleanup_all(void) |
8722c31e | 176 | { |
050e9219 | 177 | int i; |
c09f0b57 | 178 | struct sr_dev_driver **drivers; |
8722c31e | 179 | |
cfe064d8 | 180 | drivers = sr_driver_list(); |
c09f0b57 UH |
181 | for (i = 0; drivers[i]; i++) { |
182 | if (drivers[i]->cleanup) | |
183 | drivers[i]->cleanup(); | |
8722c31e | 184 | } |
8722c31e BV |
185 | } |
186 | ||
df123801 BV |
187 | /** |
188 | * Returns information about the given driver or device instance. | |
189 | * | |
190 | * @param driver The sr_dev_driver struct to query. | |
191 | * @param id The type of information, in the form of an SR_HWCAP_* option. | |
192 | * @param data Pointer where the value. will be stored. Must not be NULL. | |
193 | * @param sdi Pointer to the struct sr_dev_inst to be checked. Must not be NULL. | |
194 | * | |
195 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
196 | * may be returned by the driver indicating it doesn't know that id, | |
197 | * but this is not to be flagged as an error by the caller; merely | |
198 | * as an indication that it's not applicable. | |
199 | */ | |
200 | SR_API int sr_info_get(struct sr_dev_driver *driver, int id, | |
201 | const void **data, const struct sr_dev_inst *sdi) | |
202 | { | |
203 | int ret; | |
204 | ||
205 | if (driver == NULL || data == NULL) | |
206 | return SR_ERR; | |
207 | ||
208 | ret = driver->info_get(id, data, sdi); | |
209 | ||
210 | return ret; | |
211 | } | |
212 | ||
d68e2d1a | 213 | SR_PRIV struct sr_dev_inst *sr_dev_inst_new(int index, int status, |
49d0ce50 | 214 | const char *vendor, const char *model, const char *version) |
a1bb33af | 215 | { |
d68e2d1a | 216 | struct sr_dev_inst *sdi; |
a1bb33af | 217 | |
d68e2d1a | 218 | if (!(sdi = g_try_malloc(sizeof(struct sr_dev_inst)))) { |
c09f0b57 | 219 | sr_err("hwdriver: %s: sdi malloc failed", __func__); |
a1bb33af | 220 | return NULL; |
133a37bf | 221 | } |
a1bb33af UH |
222 | |
223 | sdi->index = index; | |
224 | sdi->status = status; | |
1d9a8a5f | 225 | sdi->inst_type = -1; |
8722c31e BV |
226 | sdi->vendor = vendor ? g_strdup(vendor) : NULL; |
227 | sdi->model = model ? g_strdup(model) : NULL; | |
228 | sdi->version = version ? g_strdup(version) : NULL; | |
47211d65 | 229 | sdi->probes = NULL; |
01cf8814 | 230 | sdi->priv = NULL; |
a1bb33af UH |
231 | |
232 | return sdi; | |
233 | } | |
234 | ||
bb7ef793 | 235 | SR_PRIV struct sr_dev_inst *sr_dev_inst_get(GSList *dev_insts, int dev_index) |
a1bb33af | 236 | { |
d68e2d1a | 237 | struct sr_dev_inst *sdi; |
a1bb33af UH |
238 | GSList *l; |
239 | ||
d68e2d1a UH |
240 | for (l = dev_insts; l; l = l->next) { |
241 | sdi = (struct sr_dev_inst *)(l->data); | |
bb7ef793 | 242 | if (sdi->index == dev_index) |
a1bb33af UH |
243 | return sdi; |
244 | } | |
bb7ef793 | 245 | sr_warn("could not find device index %d instance", dev_index); |
a1bb33af UH |
246 | |
247 | return NULL; | |
248 | } | |
249 | ||
d68e2d1a | 250 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi) |
a1bb33af | 251 | { |
66410a86 | 252 | g_free(sdi->priv); |
8722c31e BV |
253 | g_free(sdi->vendor); |
254 | g_free(sdi->model); | |
255 | g_free(sdi->version); | |
256 | g_free(sdi); | |
a1bb33af UH |
257 | } |
258 | ||
47211d65 BV |
259 | SR_PRIV struct sr_probe *sr_probe_new(int index, int type, |
260 | gboolean enabled, const char *name) | |
261 | { | |
262 | struct sr_probe *probe; | |
263 | ||
264 | if (!(probe = g_try_malloc0(sizeof(struct sr_probe)))) { | |
265 | sr_err("hwdriver: probe malloc failed"); | |
266 | return NULL; | |
267 | } | |
268 | ||
269 | probe->index = index; | |
270 | probe->type = type; | |
271 | probe->enabled = enabled; | |
272 | if (name) | |
273 | probe->name = g_strdup(name); | |
274 | ||
275 | return probe; | |
276 | } | |
277 | ||
22b02383 UH |
278 | #ifdef HAVE_LIBUSB_1_0 |
279 | ||
d68e2d1a | 280 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, |
62c82025 | 281 | uint8_t address, struct libusb_device_handle *hdl) |
a1bb33af | 282 | { |
d68e2d1a | 283 | struct sr_usb_dev_inst *udi; |
a1bb33af | 284 | |
d68e2d1a | 285 | if (!(udi = g_try_malloc(sizeof(struct sr_usb_dev_inst)))) { |
c09f0b57 | 286 | sr_err("hwdriver: %s: udi malloc failed", __func__); |
a1bb33af | 287 | return NULL; |
133a37bf | 288 | } |
a1bb33af UH |
289 | |
290 | udi->bus = bus; | |
291 | udi->address = address; | |
ca3d84cc | 292 | udi->devhdl = hdl; |
a1bb33af UH |
293 | |
294 | return udi; | |
295 | } | |
296 | ||
d68e2d1a | 297 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb) |
a1bb33af | 298 | { |
17e1afcb | 299 | /* Avoid compiler warnings. */ |
cb93f8a9 | 300 | (void)usb; |
a1bb33af | 301 | |
62c82025 | 302 | /* Nothing to do for this device instance type. */ |
a1bb33af UH |
303 | } |
304 | ||
22b02383 UH |
305 | #endif |
306 | ||
d68e2d1a UH |
307 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, |
308 | int fd) | |
a1bb33af | 309 | { |
d68e2d1a | 310 | struct sr_serial_dev_inst *serial; |
a1bb33af | 311 | |
d68e2d1a | 312 | if (!(serial = g_try_malloc(sizeof(struct sr_serial_dev_inst)))) { |
c09f0b57 | 313 | sr_err("hwdriver: %s: serial malloc failed", __func__); |
a1bb33af | 314 | return NULL; |
133a37bf | 315 | } |
a1bb33af | 316 | |
133a37bf | 317 | serial->port = g_strdup(port); |
a1bb33af UH |
318 | serial->fd = fd; |
319 | ||
320 | return serial; | |
321 | } | |
322 | ||
d68e2d1a | 323 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial) |
a1bb33af | 324 | { |
133a37bf | 325 | g_free(serial->port); |
a1bb33af UH |
326 | } |
327 | ||
a1645fcd | 328 | /** |
c09f0b57 | 329 | * Find out if a hardware driver has a specific capability. |
a1645fcd | 330 | * |
c09f0b57 | 331 | * @param driver The hardware driver in which to search for the capability. |
a1645fcd BV |
332 | * @param hwcap The capability to find in the list. |
333 | * | |
c496ac97 UH |
334 | * @return TRUE if the specified capability exists in the specified driver, |
335 | * FALSE otherwise. Also, if 'driver' is NULL or the respective driver | |
336 | * returns an invalid capability list, FALSE is returned. | |
a1645fcd | 337 | */ |
cfe064d8 | 338 | SR_API gboolean sr_driver_hwcap_exists(struct sr_dev_driver *driver, int hwcap) |
a1bb33af | 339 | { |
915f7cc8 JH |
340 | const int *hwcaps; |
341 | int i; | |
a1bb33af | 342 | |
c496ac97 UH |
343 | if (!driver) { |
344 | sr_err("hwdriver: %s: driver was NULL", __func__); | |
345 | return FALSE; | |
346 | } | |
347 | ||
be34a1c7 | 348 | if (driver->info_get(SR_DI_HWCAPS, (const void **)&hwcaps, NULL) != SR_OK) |
c496ac97 | 349 | return FALSE; |
c496ac97 | 350 | |
ffedd0bf UH |
351 | for (i = 0; hwcaps[i]; i++) { |
352 | if (hwcaps[i] == hwcap) | |
a1bb33af | 353 | return TRUE; |
49d0ce50 | 354 | } |
a1bb33af UH |
355 | |
356 | return FALSE; | |
357 | } | |
358 | ||
8bfdc8c4 BV |
359 | /** |
360 | * Get a hardware driver option. | |
361 | * | |
362 | * @param hwopt The option to get. | |
363 | * | |
364 | * @return A pointer to a struct with information about the parameter, or NULL | |
365 | * if the option was not found. | |
366 | */ | |
367 | SR_API const struct sr_hwcap_option *sr_drvopt_get(int hwopt) | |
368 | { | |
369 | int i; | |
370 | ||
371 | for (i = 0; sr_drvopts[i].hwcap; i++) { | |
372 | if (sr_drvopts[i].hwcap == hwopt) | |
373 | return &sr_drvopts[i]; | |
374 | } | |
375 | ||
376 | return NULL; | |
377 | } | |
378 | ||
a1645fcd | 379 | /** |
c09f0b57 | 380 | * Get a hardware driver capability option. |
a1645fcd | 381 | * |
93a04e3b | 382 | * @param hwcap The capability to get. |
a1645fcd | 383 | * |
44dae539 UH |
384 | * @return A pointer to a struct with information about the parameter, or NULL |
385 | * if the capability was not found. | |
a1645fcd | 386 | */ |
915f7cc8 | 387 | SR_API const struct sr_hwcap_option *sr_hw_hwcap_get(int hwcap) |
a1bb33af | 388 | { |
a1bb33af UH |
389 | int i; |
390 | ||
ffedd0bf UH |
391 | for (i = 0; sr_hwcap_options[i].hwcap; i++) { |
392 | if (sr_hwcap_options[i].hwcap == hwcap) | |
a65de030 | 393 | return &sr_hwcap_options[i]; |
a1bb33af UH |
394 | } |
395 | ||
49d0ce50 | 396 | return NULL; |
a1bb33af UH |
397 | } |
398 | ||
69cfcfc8 | 399 | /* Unnecessary level of indirection follows. */ |
544a4582 | 400 | |
69cfcfc8 | 401 | SR_PRIV int sr_source_remove(int fd) |
a1bb33af | 402 | { |
69cfcfc8 | 403 | return sr_session_source_remove(fd); |
a1bb33af UH |
404 | } |
405 | ||
69cfcfc8 UH |
406 | SR_PRIV int sr_source_add(int fd, int events, int timeout, |
407 | sr_receive_data_callback_t cb, void *cb_data) | |
a1bb33af | 408 | { |
69cfcfc8 | 409 | return sr_session_source_add(fd, events, timeout, cb, cb_data); |
a1bb33af | 410 | } |