]>
Commit | Line | Data |
---|---|---|
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_CLOCK_TYPE, SR_T_BOOL, "clocktype", | |
61 | "Using External Clock", NULL}, | |
62 | {SR_CONF_CAPTURE_RATIO, SR_T_UINT64, "captureratio", | |
63 | "Pre-trigger capture ratio", NULL}, | |
64 | {SR_CONF_DEVICE_MODE, SR_T_CHAR, "device", | |
65 | "Device Mode", NULL}, | |
66 | {SR_CONF_PATTERN_MODE, SR_T_CHAR, "pattern", | |
67 | "Pattern mode", NULL}, | |
68 | {SR_CONF_TRIGGER_TYPE, SR_T_CHAR, "triggertype", | |
69 | "Trigger types", NULL}, | |
70 | {SR_CONF_RLE, SR_T_BOOL, "rle", | |
71 | "Run Length Encoding", NULL}, | |
72 | {SR_CONF_TRIGGER_SLOPE, SR_T_UINT64, "triggerslope", | |
73 | "Trigger slope", NULL}, | |
74 | {SR_CONF_TRIGGER_SOURCE, SR_T_CHAR, "triggersource", | |
75 | "Trigger source", NULL}, | |
76 | {SR_CONF_HORIZ_TRIGGERPOS, SR_T_FLOAT, "horiz_triggerpos", | |
77 | "Horizontal trigger position", NULL}, | |
78 | {SR_CONF_BUFFERSIZE, SR_T_UINT64, "buffersize", | |
79 | "Buffer size", NULL}, | |
80 | {SR_CONF_TIMEBASE, SR_T_RATIONAL_PERIOD, "timebase", | |
81 | "Time base", NULL}, | |
82 | {SR_CONF_FILTER, SR_T_CHAR, "filter", | |
83 | "Filter targets", NULL}, | |
84 | {SR_CONF_VDIV, SR_T_RATIONAL_VOLT, "vdiv", | |
85 | "Volts/div", NULL}, | |
86 | {SR_CONF_COUPLING, SR_T_CHAR, "coupling", | |
87 | "Coupling", NULL}, | |
88 | {SR_CONF_DATALOG, SR_T_BOOL, "datalog", | |
89 | "Datalog", NULL}, | |
90 | {0, 0, NULL, NULL, NULL}, | |
91 | }; | |
92 | ||
93 | /** @cond PRIVATE */ | |
94 | #ifdef HAVE_LA_DEMO | |
95 | extern SR_PRIV struct sr_dev_driver demo_driver_info; | |
96 | #endif | |
97 | #ifdef HAVE_LA_DSLOGIC | |
98 | extern SR_PRIV struct sr_dev_driver DSLogic_driver_info; | |
99 | #endif | |
100 | /** @endcond */ | |
101 | ||
102 | static struct sr_dev_driver *drivers_list[] = { | |
103 | #ifdef HAVE_LA_DEMO | |
104 | &demo_driver_info, | |
105 | #endif | |
106 | #ifdef HAVE_LA_DSLOGIC | |
107 | &DSLogic_driver_info, | |
108 | #endif | |
109 | NULL, | |
110 | }; | |
111 | ||
112 | /** | |
113 | * Return the list of supported hardware drivers. | |
114 | * | |
115 | * @return Pointer to the NULL-terminated list of hardware driver pointers. | |
116 | */ | |
117 | SR_API struct sr_dev_driver **sr_driver_list(void) | |
118 | { | |
119 | ||
120 | return drivers_list; | |
121 | } | |
122 | ||
123 | /** | |
124 | * Initialize a hardware driver. | |
125 | * | |
126 | * This usually involves memory allocations and variable initializations | |
127 | * within the driver, but _not_ scanning for attached devices. | |
128 | * The API call sr_driver_scan() is used for that. | |
129 | * | |
130 | * @param ctx A libsigrok context object allocated by a previous call to | |
131 | * sr_init(). Must not be NULL. | |
132 | * @param driver The driver to initialize. This must be a pointer to one of | |
133 | * the entries returned by sr_driver_list(). Must not be NULL. | |
134 | * | |
135 | * @return SR_OK upon success, SR_ERR_ARG upon invalid parameters, | |
136 | * SR_ERR_BUG upon internal errors, or another negative error code | |
137 | * upon other errors. | |
138 | */ | |
139 | SR_API int sr_driver_init(struct sr_context *ctx, struct sr_dev_driver *driver) | |
140 | { | |
141 | int ret; | |
142 | ||
143 | if (!ctx) { | |
144 | sr_err("Invalid libsigrok context, can't initialize."); | |
145 | return SR_ERR_ARG; | |
146 | } | |
147 | ||
148 | if (!driver) { | |
149 | sr_err("Invalid driver, can't initialize."); | |
150 | return SR_ERR_ARG; | |
151 | } | |
152 | ||
153 | sr_spew("Initializing driver '%s'.", driver->name); | |
154 | if ((ret = driver->init(ctx)) < 0) | |
155 | sr_err("Failed to initialize the driver: %d.", ret); | |
156 | ||
157 | return ret; | |
158 | } | |
159 | ||
160 | /** | |
161 | * Tell a hardware driver to scan for devices. | |
162 | * | |
163 | * In addition to the detection, the devices that are found are also | |
164 | * initialized automatically. On some devices, this involves a firmware upload, | |
165 | * or other such measures. | |
166 | * | |
167 | * The order in which the system is scanned for devices is not specified. The | |
168 | * caller should not assume or rely on any specific order. | |
169 | * | |
170 | * Before calling sr_driver_scan(), the user must have previously initialized | |
171 | * the driver by calling sr_driver_init(). | |
172 | * | |
173 | * @param driver The driver that should scan. This must be a pointer to one of | |
174 | * the entries returned by sr_driver_list(). Must not be NULL. | |
175 | * @param options A list of 'struct sr_hwopt' options to pass to the driver's | |
176 | * scanner. Can be NULL/empty. | |
177 | * | |
178 | * @return A GSList * of 'struct sr_dev_inst', or NULL if no devices were | |
179 | * found (or errors were encountered). This list must be freed by the | |
180 | * caller using g_slist_free(), but without freeing the data pointed | |
181 | * to in the list. | |
182 | */ | |
183 | SR_API GSList *sr_driver_scan(struct sr_dev_driver *driver, GSList *options) | |
184 | { | |
185 | GSList *l; | |
186 | ||
187 | if (!driver) { | |
188 | sr_err("Invalid driver, can't scan for devices."); | |
189 | return NULL; | |
190 | } | |
191 | ||
192 | if (!driver->priv) { | |
193 | sr_err("Driver not initialized, can't scan for devices."); | |
194 | return NULL; | |
195 | } | |
196 | ||
197 | l = driver->scan(options); | |
198 | ||
199 | sr_spew("Scan of '%s' found %d devices.", driver->name, | |
200 | g_slist_length(l)); | |
201 | ||
202 | return l; | |
203 | } | |
204 | ||
205 | /** @private */ | |
206 | SR_PRIV void sr_hw_cleanup_all(void) | |
207 | { | |
208 | int i; | |
209 | struct sr_dev_driver **drivers; | |
210 | ||
211 | drivers = sr_driver_list(); | |
212 | for (i = 0; drivers[i]; i++) { | |
213 | if (drivers[i]->cleanup) | |
214 | drivers[i]->cleanup(); | |
215 | } | |
216 | } | |
217 | ||
218 | /** A floating reference can be passed in for data. */ | |
219 | SR_PRIV struct sr_config *sr_config_new(int key, GVariant *data) | |
220 | { | |
221 | struct sr_config *src; | |
222 | ||
223 | if (!(src = g_try_malloc(sizeof(struct sr_config)))) | |
224 | return NULL; | |
225 | src->key = key; | |
226 | src->data = g_variant_ref_sink(data); | |
227 | ||
228 | return src; | |
229 | } | |
230 | ||
231 | SR_PRIV void sr_config_free(struct sr_config *src) | |
232 | { | |
233 | ||
234 | if (!src || !src->data) { | |
235 | sr_err("%s: invalid data!", __func__); | |
236 | return; | |
237 | } | |
238 | ||
239 | g_variant_unref(src->data); | |
240 | g_free(src); | |
241 | ||
242 | } | |
243 | ||
244 | /** | |
245 | * Returns information about the given driver or device instance. | |
246 | * | |
247 | * @param driver The sr_dev_driver struct to query. | |
248 | * @param key The configuration key (SR_CONF_*). | |
249 | * @param data Pointer to a GVariant where the value will be stored. Must | |
250 | * not be NULL. The caller is given ownership of the GVariant | |
251 | * and must thus decrease the refcount after use. However if | |
252 | * this function returns an error code, the field should be | |
253 | * considered unused, and should not be unreferenced. | |
254 | * @param sdi (optional) If the key is specific to a device, this must | |
255 | * contain a pointer to the struct sr_dev_inst to be checked. | |
256 | * Otherwise it must be NULL. | |
257 | * | |
258 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
259 | * may be returned by the driver indicating it doesn't know that key, | |
260 | * but this is not to be flagged as an error by the caller; merely | |
261 | * as an indication that it's not applicable. | |
262 | */ | |
263 | SR_API int sr_config_get(const struct sr_dev_driver *driver, int key, | |
264 | GVariant **data, const struct sr_dev_inst *sdi) | |
265 | { | |
266 | int ret; | |
267 | ||
268 | if (!driver || !data) | |
269 | return SR_ERR; | |
270 | ||
271 | if (!driver->config_get) | |
272 | return SR_ERR_ARG; | |
273 | ||
274 | if ((ret = driver->config_get(key, data, sdi)) == SR_OK) { | |
275 | /* Got a floating reference from the driver. Sink it here, | |
276 | * caller will need to unref when done with it. */ | |
277 | g_variant_ref_sink(*data); | |
278 | } | |
279 | ||
280 | return ret; | |
281 | } | |
282 | ||
283 | /** | |
284 | * Set a configuration key in a device instance. | |
285 | * | |
286 | * @param sdi The device instance. | |
287 | * @param key The configuration key (SR_CONF_*). | |
288 | * @param data The new value for the key, as a GVariant with GVariantType | |
289 | * appropriate to that key. A floating reference can be passed | |
290 | * in; its refcount will be sunk and unreferenced after use. | |
291 | * | |
292 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
293 | * may be returned by the driver indicating it doesn't know that key, | |
294 | * but this is not to be flagged as an error by the caller; merely | |
295 | * as an indication that it's not applicable. | |
296 | */ | |
297 | SR_API int sr_config_set(const struct sr_dev_inst *sdi, int key, GVariant *data) | |
298 | { | |
299 | int ret; | |
300 | ||
301 | g_variant_ref_sink(data); | |
302 | ||
303 | if (!sdi || !sdi->driver || !data) | |
304 | ret = SR_ERR; | |
305 | else if (!sdi->driver->config_set) | |
306 | ret = SR_ERR_ARG; | |
307 | else | |
308 | ret = sdi->driver->config_set(key, data, sdi); | |
309 | ||
310 | g_variant_unref(data); | |
311 | ||
312 | return ret; | |
313 | } | |
314 | ||
315 | /** | |
316 | * List all possible values for a configuration key. | |
317 | * | |
318 | * @param driver The sr_dev_driver struct to query. | |
319 | * @param key The configuration key (SR_CONF_*). | |
320 | * @param data A pointer to a GVariant where the list will be stored. The | |
321 | * caller is given ownership of the GVariant and must thus | |
322 | * unref the GVariant after use. However if this function | |
323 | * returns an error code, the field should be considered | |
324 | * unused, and should not be unreferenced. | |
325 | * @param sdi (optional) If the key is specific to a device, this must | |
326 | * contain a pointer to the struct sr_dev_inst to be checked. | |
327 | * | |
328 | * @return SR_OK upon success or SR_ERR in case of error. Note SR_ERR_ARG | |
329 | * may be returned by the driver indicating it doesn't know that key, | |
330 | * but this is not to be flagged as an error by the caller; merely | |
331 | * as an indication that it's not applicable. | |
332 | */ | |
333 | SR_API int sr_config_list(const struct sr_dev_driver *driver, int key, | |
334 | GVariant **data, const struct sr_dev_inst *sdi) | |
335 | { | |
336 | int ret; | |
337 | ||
338 | if (!driver || !data) | |
339 | ret = SR_ERR; | |
340 | else if (!driver->config_list) | |
341 | ret = SR_ERR_ARG; | |
342 | else if ((ret = driver->config_list(key, data, sdi)) == SR_OK) | |
343 | g_variant_ref_sink(*data); | |
344 | ||
345 | return ret; | |
346 | } | |
347 | ||
348 | /** | |
349 | * Get information about a configuration key. | |
350 | * | |
351 | * @param key The configuration key. | |
352 | * | |
353 | * @return A pointer to a struct sr_config_info, or NULL if the key | |
354 | * was not found. | |
355 | */ | |
356 | SR_API const struct sr_config_info *sr_config_info_get(int key) | |
357 | { | |
358 | int i; | |
359 | ||
360 | for (i = 0; sr_config_info_data[i].key; i++) { | |
361 | if (sr_config_info_data[i].key == key) | |
362 | return &sr_config_info_data[i]; | |
363 | } | |
364 | ||
365 | return NULL; | |
366 | } | |
367 | ||
368 | /** | |
369 | * Get information about an configuration key, by name. | |
370 | * | |
371 | * @param optname The configuration key. | |
372 | * | |
373 | * @return A pointer to a struct sr_config_info, or NULL if the key | |
374 | * was not found. | |
375 | */ | |
376 | SR_API const struct sr_config_info *sr_config_info_name_get(const char *optname) | |
377 | { | |
378 | int i; | |
379 | ||
380 | for (i = 0; sr_config_info_data[i].key; i++) { | |
381 | if (!strcmp(sr_config_info_data[i].id, optname)) | |
382 | return &sr_config_info_data[i]; | |
383 | } | |
384 | ||
385 | return NULL; | |
386 | } | |
387 | ||
388 | /* Unnecessary level of indirection follows. */ | |
389 | ||
390 | /** @private */ | |
391 | SR_PRIV int sr_source_remove(int fd) | |
392 | { | |
393 | return sr_session_source_remove(fd); | |
394 | } | |
395 | ||
396 | /** @private */ | |
397 | SR_PRIV int sr_source_add(int fd, int events, int timeout, | |
398 | sr_receive_data_callback_t cb, void *cb_data) | |
399 | { | |
400 | return sr_session_source_add(fd, events, timeout, cb, cb_data); | |
401 | } | |
402 | ||
403 | /** @} */ |