]>
Commit | Line | Data |
---|---|---|
1483577e | 1 | /* |
50985c20 | 2 | * This file is part of the libsigrok project. |
1483577e | 3 | * |
13d8e03c | 4 | * Copyright (C) 2013 Bert Vermeulen <bert@biot.com> |
1483577e 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 | ||
04cb9157 MH |
20 | /** @file |
21 | * @internal | |
22 | */ | |
23 | ||
a5827886 UH |
24 | #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H |
25 | #define LIBSIGROK_LIBSIGROK_INTERNAL_H | |
1483577e | 26 | |
b08024a8 | 27 | #include <stdarg.h> |
cc8a7d25 | 28 | #include <glib.h> |
1a081ca6 | 29 | #include "config.h" /* Needed for HAVE_LIBUSB_1_0 and others. */ |
69890f73 UH |
30 | #ifdef HAVE_LIBUSB_1_0 |
31 | #include <libusb.h> | |
32 | #endif | |
c4f2dfd0 | 33 | #ifdef HAVE_LIBSERIALPORT |
dc991353 | 34 | #include <libserialport.h> |
c4f2dfd0 | 35 | #endif |
b08024a8 | 36 | |
393fb9cb UH |
37 | /** |
38 | * @file | |
39 | * | |
40 | * libsigrok private header file, only to be used internally. | |
41 | */ | |
42 | ||
4cea9eb2 UH |
43 | /*--- Macros ----------------------------------------------------------------*/ |
44 | ||
45 | #ifndef ARRAY_SIZE | |
46 | #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) | |
47 | #endif | |
48 | ||
49 | #ifndef ARRAY_AND_SIZE | |
50 | #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) | |
51 | #endif | |
52 | ||
a4f9c35b | 53 | /** |
5bf0dd6a | 54 | * Read a 8 bits unsigned integer out of memory. |
a4f9c35b | 55 | * @param x a pointer to the input memory |
5bf0dd6a | 56 | * @return the corresponding unsigned integer |
a4f9c35b AJ |
57 | */ |
58 | #define R8(x) ((unsigned)((const uint8_t*)(x))[0]) | |
59 | ||
e28ef28a | 60 | /** |
5bf0dd6a | 61 | * Read a 16 bits big endian unsigned integer out of memory. |
e28ef28a | 62 | * @param x a pointer to the input memory |
5bf0dd6a | 63 | * @return the corresponding unsigned integer |
e28ef28a | 64 | */ |
79a1176b AJ |
65 | #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \ |
66 | (unsigned)((const uint8_t*)(x))[1]) | |
e28ef28a AJ |
67 | |
68 | /** | |
5bf0dd6a | 69 | * Read a 16 bits little endian unsigned integer out of memory. |
e28ef28a | 70 | * @param x a pointer to the input memory |
5bf0dd6a | 71 | * @return the corresponding unsigned integer |
e28ef28a | 72 | */ |
79a1176b AJ |
73 | #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \ |
74 | (unsigned)((const uint8_t*)(x))[0]) | |
e28ef28a AJ |
75 | |
76 | /** | |
5bf0dd6a | 77 | * Read a 16 bits little endian signed integer out of memory. |
e28ef28a | 78 | * @param x a pointer to the input memory |
5bf0dd6a BV |
79 | * @return the corresponding signed integer |
80 | */ | |
81 | #define RL16S(x) ((int16_t) \ | |
af945a66 | 82 | (((unsigned)((const uint8_t*)(x))[1] << 8) | \ |
5bf0dd6a BV |
83 | (unsigned)((const uint8_t*)(x))[0])) |
84 | ||
85 | /** | |
86 | * Read a 32 bits big endian unsigned integer out of memory. | |
87 | * @param x a pointer to the input memory | |
88 | * @return the corresponding unsigned integer | |
e28ef28a | 89 | */ |
79a1176b AJ |
90 | #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \ |
91 | ((unsigned)((const uint8_t*)(x))[1] << 16) | \ | |
92 | ((unsigned)((const uint8_t*)(x))[2] << 8) | \ | |
93 | (unsigned)((const uint8_t*)(x))[3]) | |
e28ef28a AJ |
94 | |
95 | /** | |
5bf0dd6a | 96 | * Read a 32 bits little endian unsigned integer out of memory. |
e28ef28a | 97 | * @param x a pointer to the input memory |
5bf0dd6a | 98 | * @return the corresponding unsigned integer |
e28ef28a | 99 | */ |
79a1176b AJ |
100 | #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \ |
101 | ((unsigned)((const uint8_t*)(x))[2] << 16) | \ | |
102 | ((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
103 | (unsigned)((const uint8_t*)(x))[0]) | |
e28ef28a | 104 | |
ea2d6d99 | 105 | /** |
5bf0dd6a BV |
106 | * Read a 32 bits little endian signed integer out of memory. |
107 | * @param x a pointer to the input memory | |
108 | * @return the corresponding signed integer | |
109 | */ | |
110 | #define RL32S(x) ((int32_t) \ | |
111 | (((unsigned)((const uint8_t*)(x))[3] << 24) | \ | |
112 | ((unsigned)((const uint8_t*)(x))[2] << 16) | \ | |
113 | ((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
114 | (unsigned)((const uint8_t*)(x))[0])) | |
115 | ||
116 | /** | |
117 | * Write a 8 bits unsigned integer to memory. | |
ea2d6d99 | 118 | * @param p a pointer to the output memory |
5bf0dd6a | 119 | * @param x the input unsigned integer |
ea2d6d99 | 120 | */ |
0c5f2abc | 121 | #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0) |
ea2d6d99 AJ |
122 | |
123 | /** | |
5bf0dd6a | 124 | * Write a 16 bits unsigned integer to memory stored as big endian. |
ea2d6d99 | 125 | * @param p a pointer to the output memory |
5bf0dd6a | 126 | * @param x the input unsigned integer |
ea2d6d99 AJ |
127 | */ |
128 | #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \ | |
0c5f2abc | 129 | ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0) |
ea2d6d99 AJ |
130 | |
131 | /** | |
5bf0dd6a | 132 | * Write a 16 bits unsigned integer to memory stored as little endian. |
ea2d6d99 | 133 | * @param p a pointer to the output memory |
5bf0dd6a | 134 | * @param x the input unsigned integer |
ea2d6d99 AJ |
135 | */ |
136 | #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \ | |
0c5f2abc | 137 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0) |
ea2d6d99 AJ |
138 | |
139 | /** | |
5bf0dd6a | 140 | * Write a 32 bits unsigned integer to memory stored as big endian. |
ea2d6d99 | 141 | * @param p a pointer to the output memory |
5bf0dd6a | 142 | * @param x the input unsigned integer |
ea2d6d99 AJ |
143 | */ |
144 | #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \ | |
145 | ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \ | |
146 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \ | |
0c5f2abc | 147 | ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0) |
ea2d6d99 AJ |
148 | |
149 | /** | |
5bf0dd6a | 150 | * Write a 32 bits unsigned integer to memory stored as little endian. |
ea2d6d99 | 151 | * @param p a pointer to the output memory |
5bf0dd6a | 152 | * @param x the input unsigned integer |
ea2d6d99 AJ |
153 | */ |
154 | #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \ | |
155 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \ | |
156 | ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \ | |
0c5f2abc | 157 | ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0) |
ea2d6d99 | 158 | |
6bf4273e UH |
159 | /* Portability fixes for FreeBSD. */ |
160 | #ifdef __FreeBSD__ | |
161 | #define LIBUSB_CLASS_APPLICATION 0xfe | |
15eea61a | 162 | #define libusb_has_capability(x) 0 |
6bf4273e UH |
163 | #define libusb_handle_events_timeout_completed(ctx, tv, c) \ |
164 | libusb_handle_events_timeout(ctx, tv) | |
165 | #endif | |
166 | ||
1685c276 BV |
167 | /* Static definitions of structs ending with an all-zero entry are a |
168 | * problem when compiling with -Wmissing-field-initializers: GCC | |
169 | * suppresses the warning only with { 0 }, clang wants { } */ | |
170 | #ifdef __clang__ | |
171 | #define ALL_ZERO { } | |
172 | #else | |
173 | #define ALL_ZERO { 0 } | |
174 | #endif | |
175 | ||
b8072700 | 176 | struct sr_context { |
032da34b | 177 | struct sr_dev_driver **driver_list; |
785b9ff2 PS |
178 | #ifdef HAVE_LIBUSB_1_0 |
179 | libusb_context *libusb_ctx; | |
6640324f | 180 | gboolean usb_source_present; |
5321ac6b ML |
181 | #ifdef _WIN32 |
182 | GThread *usb_thread; | |
183 | gboolean usb_thread_running; | |
f6c30de4 ML |
184 | HANDLE usb_wait_request_event; |
185 | HANDLE usb_wait_complete_event; | |
5321ac6b | 186 | GPollFD usb_pollfd; |
144f6660 | 187 | sr_receive_data_callback usb_cb; |
5321ac6b ML |
188 | void *usb_cb_data; |
189 | #endif | |
785b9ff2 | 190 | #endif |
b8072700 PS |
191 | }; |
192 | ||
20e88821 BV |
193 | /** Input module metadata keys. */ |
194 | enum sr_input_meta_keys { | |
195 | /** The input filename, if there is one. */ | |
196 | SR_INPUT_META_FILENAME = 0x01, | |
197 | /** The input file's size in bytes. */ | |
198 | SR_INPUT_META_FILESIZE = 0x02, | |
199 | /** The first 128 bytes of the file, provided as a GString. */ | |
200 | SR_INPUT_META_HEADER = 0x04, | |
201 | /** The file's MIME type. */ | |
202 | SR_INPUT_META_MIMETYPE = 0x08, | |
203 | ||
204 | /** The module cannot identify a file without this metadata. */ | |
205 | SR_INPUT_META_REQUIRED = 0x80, | |
206 | }; | |
207 | ||
d514d35d BV |
208 | /** Input (file) module struct. */ |
209 | struct sr_input { | |
210 | /** | |
211 | * A pointer to this input module's 'struct sr_input_module'. | |
d514d35d | 212 | */ |
17bfaca6 BV |
213 | const struct sr_input_module *module; |
214 | GString *buf; | |
d514d35d | 215 | struct sr_dev_inst *sdi; |
d0181813 | 216 | gboolean sdi_ready; |
17bfaca6 | 217 | void *priv; |
d514d35d BV |
218 | }; |
219 | ||
220 | /** Input (file) module driver. */ | |
221 | struct sr_input_module { | |
17bfaca6 | 222 | /** |
d65fcbcd | 223 | * A unique ID for this input module, suitable for use in command-line |
17bfaca6 BV |
224 | * clients, [a-z0-9-]. Must not be NULL. |
225 | */ | |
226 | const char *id; | |
d514d35d BV |
227 | |
228 | /** | |
d65fcbcd | 229 | * A unique name for this input module, suitable for use in GUI |
17bfaca6 | 230 | * clients, can contain UTF-8. Must not be NULL. |
d514d35d | 231 | */ |
17bfaca6 | 232 | const char *name; |
d514d35d BV |
233 | |
234 | /** | |
d65fcbcd | 235 | * A short description of the input module. Must not be NULL. |
d514d35d | 236 | * |
d65fcbcd | 237 | * This can be displayed by frontends, e.g. when selecting the input |
17bfaca6 BV |
238 | * module for saving a file. |
239 | */ | |
240 | const char *desc; | |
241 | ||
c7bc82ff JH |
242 | /** |
243 | * A NULL terminated array of strings containing a list of file name | |
244 | * extensions typical for the input file format, or NULL if there is | |
245 | * no typical extension for this file format. | |
246 | */ | |
247 | const char *const *exts; | |
248 | ||
17bfaca6 BV |
249 | /** |
250 | * Zero-terminated list of metadata items the module needs to be able | |
251 | * to identify an input stream. Can be all-zero, if the module cannot | |
252 | * identify streams at all, i.e. has to be forced into use. | |
253 | * | |
254 | * Each item is one of: | |
255 | * SR_INPUT_META_FILENAME | |
256 | * SR_INPUT_META_FILESIZE | |
257 | * SR_INPUT_META_HEADER | |
258 | * SR_INPUT_META_MIMETYPE | |
259 | * | |
260 | * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot | |
261 | * identify a stream without the given metadata. | |
262 | */ | |
263 | const uint8_t metadata[8]; | |
264 | ||
265 | /** | |
266 | * Returns a NULL-terminated list of options this module can take. | |
267 | * Can be NULL, if the module has no options. | |
268 | */ | |
269 | struct sr_option *(*options) (void); | |
270 | ||
271 | /** | |
272 | * Check if this input module can load and parse the specified stream. | |
273 | * | |
274 | * @param[in] metadata Metadata the module can use to identify the stream. | |
d514d35d | 275 | * |
4f979115 | 276 | * @retval SR_OK This module knows the format. |
753793ef | 277 | * @retval SR_ERR_NA There wasn't enough data for this module to |
4f979115 BV |
278 | * positively identify the format. |
279 | * @retval SR_ERR_DATA This module knows the format, but cannot handle it. | |
280 | * This means the stream is either corrupt, or indicates a feature | |
281 | * that the module does not support. | |
282 | * @retval SR_ERR This module does not know the format. | |
d514d35d | 283 | */ |
17bfaca6 | 284 | int (*format_match) (GHashTable *metadata); |
d514d35d BV |
285 | |
286 | /** | |
287 | * Initialize the input module. | |
288 | * | |
d514d35d BV |
289 | * @retval SR_OK Success |
290 | * @retval other Negative error code. | |
291 | */ | |
17bfaca6 | 292 | int (*init) (struct sr_input *in, GHashTable *options); |
d514d35d BV |
293 | |
294 | /** | |
753793ef | 295 | * Send data to the specified input instance. |
d514d35d | 296 | * |
753793ef BV |
297 | * When an input module instance is created with sr_input_new(), this |
298 | * function is used to feed data to the instance. | |
d514d35d | 299 | * |
753793ef BV |
300 | * As enough data gets fed into this function to completely populate |
301 | * the device instance associated with this input instance, this is | |
302 | * guaranteed to return the moment it's ready. This gives the caller | |
303 | * the chance to examine the device instance, attach session callbacks | |
304 | * and so on. | |
17bfaca6 BV |
305 | * |
306 | * @retval SR_OK Success | |
307 | * @retval other Negative error code. | |
308 | */ | |
d0181813 | 309 | int (*receive) (struct sr_input *in, GString *buf); |
17bfaca6 | 310 | |
753793ef BV |
311 | /** |
312 | * Signal the input module no more data will come. | |
313 | * | |
314 | * This will cause the module to process any data it may have buffered. | |
315 | * The SR_DF_END packet will also typically be sent at this time. | |
316 | */ | |
7066fd46 BV |
317 | int (*end) (struct sr_input *in); |
318 | ||
17bfaca6 BV |
319 | /** |
320 | * This function is called after the caller is finished using | |
321 | * the input module, and can be used to free any internal | |
322 | * resources the module may keep. | |
d514d35d | 323 | * |
753793ef BV |
324 | * This function is optional. |
325 | * | |
d514d35d BV |
326 | * @retval SR_OK Success |
327 | * @retval other Negative error code. | |
328 | */ | |
d5cc282f | 329 | void (*cleanup) (struct sr_input *in); |
d514d35d BV |
330 | }; |
331 | ||
a755b0e1 BV |
332 | /** Output module instance. */ |
333 | struct sr_output { | |
334 | /** A pointer to this output's module. */ | |
335 | const struct sr_output_module *module; | |
336 | ||
337 | /** | |
338 | * The device for which this output module is creating output. This | |
339 | * can be used by the module to find out channel names and numbers. | |
340 | */ | |
341 | const struct sr_dev_inst *sdi; | |
342 | ||
343 | /** | |
344 | * A generic pointer which can be used by the module to keep internal | |
345 | * state between calls into its callback functions. | |
346 | * | |
347 | * For example, the module might store a pointer to a chunk of output | |
348 | * there, and only flush it when it reaches a certain size. | |
349 | */ | |
d686c5ec | 350 | void *priv; |
a755b0e1 BV |
351 | }; |
352 | ||
353 | /** Output module driver. */ | |
354 | struct sr_output_module { | |
355 | /** | |
356 | * A unique ID for this output module, suitable for use in command-line | |
357 | * clients, [a-z0-9-]. Must not be NULL. | |
358 | */ | |
359 | char *id; | |
360 | ||
361 | /** | |
362 | * A unique name for this output module, suitable for use in GUI | |
363 | * clients, can contain UTF-8. Must not be NULL. | |
364 | */ | |
365 | const char *name; | |
366 | ||
367 | /** | |
368 | * A short description of the output module. Must not be NULL. | |
369 | * | |
370 | * This can be displayed by frontends, e.g. when selecting the output | |
371 | * module for saving a file. | |
372 | */ | |
373 | char *desc; | |
374 | ||
8a174d23 JH |
375 | /** |
376 | * A NULL terminated array of strings containing a list of file name | |
377 | * extensions typical for the input file format, or NULL if there is | |
378 | * no typical extension for this file format. | |
379 | */ | |
380 | const char *const *exts; | |
381 | ||
a755b0e1 BV |
382 | /** |
383 | * Returns a NULL-terminated list of options this module can take. | |
384 | * Can be NULL, if the module has no options. | |
a755b0e1 | 385 | */ |
af7d656d | 386 | const struct sr_option *(*options) (void); |
a755b0e1 BV |
387 | |
388 | /** | |
389 | * This function is called once, at the beginning of an output stream. | |
390 | * | |
391 | * The device struct will be available in the output struct passed in, | |
392 | * as well as the param field -- which may be NULL or an empty string, | |
393 | * if no parameter was passed. | |
394 | * | |
395 | * The module can use this to initialize itself, create a struct for | |
396 | * keeping state and storing it in the <code>internal</code> field. | |
397 | * | |
398 | * @param o Pointer to the respective 'struct sr_output'. | |
399 | * | |
400 | * @retval SR_OK Success | |
401 | * @retval other Negative error code. | |
402 | */ | |
403 | int (*init) (struct sr_output *o, GHashTable *options); | |
404 | ||
405 | /** | |
f3f19d11 | 406 | * This function is passed a copy of every packet in the data feed. |
a755b0e1 BV |
407 | * Any output generated by the output module in response to the |
408 | * packet should be returned in a newly allocated GString | |
409 | * <code>out</code>, which will be freed by the caller. | |
410 | * | |
411 | * Packets not of interest to the output module can just be ignored, | |
412 | * and the <code>out</code> parameter set to NULL. | |
413 | * | |
414 | * @param o Pointer to the respective 'struct sr_output'. | |
415 | * @param sdi The device instance that generated the packet. | |
416 | * @param packet The complete packet. | |
417 | * @param out A pointer where a GString * should be stored if | |
418 | * the module generates output, or NULL if not. | |
419 | * | |
420 | * @retval SR_OK Success | |
421 | * @retval other Negative error code. | |
422 | */ | |
423 | int (*receive) (const struct sr_output *o, | |
424 | const struct sr_datafeed_packet *packet, GString **out); | |
425 | ||
426 | /** | |
427 | * This function is called after the caller is finished using | |
428 | * the output module, and can be used to free any internal | |
429 | * resources the module may keep. | |
430 | * | |
431 | * @retval SR_OK Success | |
432 | * @retval other Negative error code. | |
433 | */ | |
434 | int (*cleanup) (struct sr_output *o); | |
435 | }; | |
436 | ||
790320f6 UH |
437 | /** Transform module instance. */ |
438 | struct sr_transform { | |
439 | /** A pointer to this transform's module. */ | |
440 | const struct sr_transform_module *module; | |
441 | ||
442 | /** | |
443 | * The device for which this transform module is used. This | |
444 | * can be used by the module to find out channel names and numbers. | |
445 | */ | |
446 | const struct sr_dev_inst *sdi; | |
447 | ||
448 | /** | |
449 | * A generic pointer which can be used by the module to keep internal | |
450 | * state between calls into its callback functions. | |
451 | */ | |
452 | void *priv; | |
453 | }; | |
454 | ||
455 | struct sr_transform_module { | |
456 | /** | |
457 | * A unique ID for this transform module, suitable for use in | |
458 | * command-line clients, [a-z0-9-]. Must not be NULL. | |
459 | */ | |
460 | char *id; | |
461 | ||
462 | /** | |
463 | * A unique name for this transform module, suitable for use in GUI | |
464 | * clients, can contain UTF-8. Must not be NULL. | |
465 | */ | |
466 | const char *name; | |
467 | ||
468 | /** | |
469 | * A short description of the transform module. Must not be NULL. | |
470 | * | |
471 | * This can be displayed by frontends, e.g. when selecting | |
472 | * which transform module(s) to add. | |
473 | */ | |
474 | char *desc; | |
475 | ||
476 | /** | |
477 | * Returns a NULL-terminated list of options this transform module | |
478 | * can take. Can be NULL, if the transform module has no options. | |
479 | */ | |
480 | const struct sr_option *(*options) (void); | |
481 | ||
482 | /** | |
483 | * This function is called once, at the beginning of a stream. | |
484 | * | |
485 | * @param t Pointer to the respective 'struct sr_transform'. | |
486 | * @param options Hash table of options for this transform module. | |
487 | * Can be NULL if no options are to be used. | |
488 | * | |
489 | * @retval SR_OK Success | |
490 | * @retval other Negative error code. | |
491 | */ | |
492 | int (*init) (struct sr_transform *t, GHashTable *options); | |
493 | ||
494 | /** | |
495 | * This function is passed a pointer to every packet in the data feed. | |
496 | * | |
497 | * It can either return (in packet_out) a pointer to another packet | |
498 | * (possibly the exact same packet it got as input), or NULL. | |
499 | * | |
500 | * @param t Pointer to the respective 'struct sr_transform'. | |
501 | * @param packet_in Pointer to a datafeed packet. | |
502 | * @param packet_out Pointer to the resulting datafeed packet after | |
503 | * this function was run. If NULL, the transform | |
504 | * module intentionally didn't output a new packet. | |
505 | * | |
506 | * @retval SR_OK Success | |
507 | * @retval other Negative error code. | |
508 | */ | |
509 | int (*receive) (const struct sr_transform *t, | |
510 | struct sr_datafeed_packet *packet_in, | |
511 | struct sr_datafeed_packet **packet_out); | |
512 | ||
513 | /** | |
514 | * This function is called after the caller is finished using | |
515 | * the transform module, and can be used to free any internal | |
516 | * resources the module may keep. | |
517 | * | |
518 | * @retval SR_OK Success | |
519 | * @retval other Negative error code. | |
520 | */ | |
521 | int (*cleanup) (struct sr_transform *t); | |
522 | }; | |
523 | ||
69890f73 | 524 | #ifdef HAVE_LIBUSB_1_0 |
04cb9157 | 525 | /** USB device instance */ |
d68e2d1a | 526 | struct sr_usb_dev_inst { |
98582bf5 BV |
527 | /** USB bus */ |
528 | uint8_t bus; | |
529 | /** Device address on USB bus */ | |
530 | uint8_t address; | |
531 | /** libusb device handle */ | |
532 | struct libusb_device_handle *devhdl; | |
69890f73 UH |
533 | }; |
534 | #endif | |
535 | ||
c4f2dfd0 | 536 | #ifdef HAVE_LIBSERIALPORT |
a9bce5a5 ML |
537 | #define SERIAL_PARITY_NONE SP_PARITY_NONE |
538 | #define SERIAL_PARITY_EVEN SP_PARITY_EVEN | |
539 | #define SERIAL_PARITY_ODD SP_PARITY_ODD | |
d68e2d1a | 540 | struct sr_serial_dev_inst { |
98582bf5 BV |
541 | /** Port name, e.g. '/dev/tty42'. */ |
542 | char *port; | |
543 | /** Comm params for serial_set_paramstr(). */ | |
544 | char *serialcomm; | |
98582bf5 BV |
545 | /** libserialport port handle */ |
546 | struct sp_port *data; | |
ba1949f5 ML |
547 | /** libserialport event set */ |
548 | struct sp_event_set *event_set; | |
549 | /** GPollFDs for event polling */ | |
550 | GPollFD *pollfds; | |
69890f73 | 551 | }; |
c4f2dfd0 | 552 | #endif |
69890f73 | 553 | |
ae67644f ML |
554 | struct sr_usbtmc_dev_inst { |
555 | char *device; | |
556 | int fd; | |
557 | }; | |
558 | ||
026c822d UH |
559 | /* Private driver context. */ |
560 | struct drv_context { | |
98582bf5 BV |
561 | /** sigrok context */ |
562 | struct sr_context *sr_ctx; | |
026c822d UH |
563 | GSList *instances; |
564 | }; | |
565 | ||
48a486cd BV |
566 | /*--- log.c -----------------------------------------------------------------*/ |
567 | ||
568 | SR_PRIV int sr_log(int loglevel, const char *format, ...); | |
569 | SR_PRIV int sr_spew(const char *format, ...); | |
570 | SR_PRIV int sr_dbg(const char *format, ...); | |
571 | SR_PRIV int sr_info(const char *format, ...); | |
572 | SR_PRIV int sr_warn(const char *format, ...); | |
573 | SR_PRIV int sr_err(const char *format, ...); | |
574 | ||
3544f848 ML |
575 | /* Message logging helpers with subsystem-specific prefix string. */ |
576 | #ifndef NO_LOG_WRAPPERS | |
577 | #define sr_log(l, s, args...) sr_log(l, "%s: " s, LOG_PREFIX, ## args) | |
578 | #define sr_spew(s, args...) sr_spew("%s: " s, LOG_PREFIX, ## args) | |
579 | #define sr_dbg(s, args...) sr_dbg("%s: " s, LOG_PREFIX, ## args) | |
580 | #define sr_info(s, args...) sr_info("%s: " s, LOG_PREFIX, ## args) | |
581 | #define sr_warn(s, args...) sr_warn("%s: " s, LOG_PREFIX, ## args) | |
582 | #define sr_err(s, args...) sr_err("%s: " s, LOG_PREFIX, ## args) | |
583 | #endif | |
584 | ||
48a486cd BV |
585 | /*--- device.c --------------------------------------------------------------*/ |
586 | ||
f3ca73ed | 587 | /** Values for the changes argument of sr_dev_driver.config_channel_set. */ |
2a854d71 | 588 | enum { |
fca75cbb | 589 | /** The enabled state of the channel has been changed. */ |
3f239f08 | 590 | SR_CHANNEL_SET_ENABLED = 1 << 0, |
2a854d71 DE |
591 | }; |
592 | ||
5e23fcab ML |
593 | SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi, |
594 | int index, int type, gboolean enabled, const char *name); | |
48a486cd | 595 | |
96727ef0 UH |
596 | /** Device instance data */ |
597 | struct sr_dev_inst { | |
598 | /** Device driver. */ | |
599 | struct sr_dev_driver *driver; | |
600 | /** Device instance status. SR_ST_NOT_FOUND, etc. */ | |
601 | int status; | |
602 | /** Device instance type. SR_INST_USB, etc. */ | |
603 | int inst_type; | |
604 | /** Device vendor. */ | |
605 | char *vendor; | |
606 | /** Device model. */ | |
607 | char *model; | |
608 | /** Device version. */ | |
609 | char *version; | |
610 | /** Serial number. */ | |
611 | char *serial_num; | |
612 | /** Connection string to uniquely identify devices. */ | |
613 | char *connection_id; | |
614 | /** List of channels. */ | |
615 | GSList *channels; | |
616 | /** List of sr_channel_group structs */ | |
617 | GSList *channel_groups; | |
618 | /** Device instance connection data (used?) */ | |
619 | void *conn; | |
620 | /** Device instance private data (used?) */ | |
621 | void *priv; | |
622 | /** Session to which this device is currently assigned. */ | |
623 | struct sr_session *session; | |
624 | }; | |
625 | ||
48a486cd | 626 | /* Generic device instances */ |
48a486cd | 627 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi); |
48a486cd | 628 | |
545f9786 | 629 | #ifdef HAVE_LIBUSB_1_0 |
69890f73 | 630 | /* USB-specific instances */ |
d68e2d1a | 631 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, |
69890f73 | 632 | uint8_t address, struct libusb_device_handle *hdl); |
d68e2d1a | 633 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb); |
69890f73 UH |
634 | #endif |
635 | ||
c4f2dfd0 | 636 | #ifdef HAVE_LIBSERIALPORT |
69890f73 | 637 | /* Serial-specific instances */ |
299bdb24 BV |
638 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, |
639 | const char *serialcomm); | |
d68e2d1a | 640 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial); |
c4f2dfd0 | 641 | #endif |
69890f73 | 642 | |
ae67644f ML |
643 | /* USBTMC-specific instances */ |
644 | SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device); | |
645 | SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc); | |
b08024a8 | 646 | |
c09f0b57 | 647 | /*--- hwdriver.c ------------------------------------------------------------*/ |
996b0c72 | 648 | |
032da34b UH |
649 | extern SR_PRIV struct sr_dev_driver **drivers_lists[]; |
650 | ||
13fef1ed | 651 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype); |
584560f1 | 652 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data); |
032da34b | 653 | SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx); |
584560f1 | 654 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data); |
722db131 | 655 | SR_PRIV void sr_config_free(struct sr_config *src); |
48a486cd | 656 | SR_PRIV int sr_source_remove(int fd); |
0812c40e ML |
657 | SR_PRIV int sr_source_remove_pollfd(GPollFD *pollfd); |
658 | SR_PRIV int sr_source_remove_channel(GIOChannel *channel); | |
48a486cd | 659 | SR_PRIV int sr_source_add(int fd, int events, int timeout, |
144f6660 | 660 | sr_receive_data_callback cb, void *cb_data); |
0812c40e ML |
661 | SR_PRIV int sr_source_add_pollfd(GPollFD *pollfd, int timeout, |
662 | sr_receive_data_callback cb, void *cb_data); | |
663 | SR_PRIV int sr_source_add_channel(GIOChannel *channel, int events, int timeout, | |
664 | sr_receive_data_callback cb, void *cb_data); | |
996b0c72 | 665 | |
a1645fcd BV |
666 | /*--- session.c -------------------------------------------------------------*/ |
667 | ||
e2b23821 | 668 | struct sr_session { |
4ed5d21d ML |
669 | /** Context this session exists in. */ |
670 | struct sr_context *ctx; | |
c0e3ba4b | 671 | /** List of struct sr_dev_inst pointers. */ |
e2b23821 | 672 | GSList *devs; |
1de3cced ML |
673 | /** List of struct sr_dev_inst pointers owned by this session. */ |
674 | GSList *owned_devs; | |
e2b23821 UH |
675 | /** List of struct datafeed_callback pointers. */ |
676 | GSList *datafeed_callbacks; | |
c0a1e532 | 677 | GSList *transforms; |
7b5e6d29 | 678 | struct sr_trigger *trigger; |
e2b23821 UH |
679 | GTimeVal starttime; |
680 | gboolean running; | |
681 | ||
682 | unsigned int num_sources; | |
683 | ||
684 | /* | |
685 | * Both "sources" and "pollfds" are of the same size and contain pairs | |
686 | * of descriptor and callback function. We can not embed the GPollFD | |
687 | * into the source struct since we want to be able to pass the array | |
688 | * of all poll descriptors to g_poll(). | |
689 | */ | |
690 | struct source *sources; | |
691 | GPollFD *pollfds; | |
692 | int source_timeout; | |
693 | ||
694 | /* | |
695 | * These are our synchronization primitives for stopping the session in | |
696 | * an async fashion. We need to make sure the session is stopped from | |
697 | * within the session thread itself. | |
698 | */ | |
98582bf5 BV |
699 | /** Mutex protecting access to abort_session. */ |
700 | GMutex stop_mutex; | |
701 | /** Abort current session. See sr_session_stop(). */ | |
e2b23821 UH |
702 | gboolean abort_session; |
703 | }; | |
704 | ||
de4d3f99 | 705 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, |
ae5859ff | 706 | const struct sr_datafeed_packet *packet); |
0812c40e | 707 | SR_PRIV int sr_session_stop_sync(struct sr_session *session); |
f438e0c9 | 708 | SR_PRIV int sr_sessionfile_check(const char *filename); |
8143cfdc BV |
709 | SR_PRIV int sr_packet_copy(const struct sr_datafeed_packet *packet, |
710 | struct sr_datafeed_packet **copy); | |
711 | SR_PRIV void sr_packet_free(struct sr_datafeed_packet *packet); | |
a1645fcd | 712 | |
41caa319 AJ |
713 | /*--- analog.c --------------------------------------------------------------*/ |
714 | ||
715 | SR_PRIV int sr_analog_init(struct sr_datafeed_analog2 *analog, | |
716 | struct sr_analog_encoding *encoding, | |
717 | struct sr_analog_meaning *meaning, | |
718 | struct sr_analog_spec *spec, | |
719 | int digits); | |
720 | ||
063e7aef UH |
721 | /*--- std.c -----------------------------------------------------------------*/ |
722 | ||
144f6660 UH |
723 | typedef int (*dev_close_callback)(struct sr_dev_inst *sdi); |
724 | typedef void (*std_dev_clear_callback)(void *priv); | |
cd2f0fe2 | 725 | |
f6beaac5 | 726 | SR_PRIV int std_init(struct sr_context *sr_ctx, struct sr_dev_driver *di, |
ae5859ff | 727 | const char *prefix); |
c4f2dfd0 | 728 | #ifdef HAVE_LIBSERIALPORT |
23dc6661 | 729 | SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi); |
d43b0908 | 730 | SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi, |
144f6660 | 731 | void *cb_data, dev_close_callback dev_close_fn, |
ae5859ff | 732 | struct sr_serial_dev_inst *serial, const char *prefix); |
c4f2dfd0 | 733 | #endif |
4afdfd46 | 734 | SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi, |
ae5859ff BV |
735 | const char *prefix); |
736 | SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver, | |
144f6660 | 737 | std_dev_clear_callback clear_private); |
043e899a | 738 | SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi); |
4afdfd46 | 739 | |
8d558c7a UH |
740 | /*--- strutil.c -------------------------------------------------------------*/ |
741 | ||
742 | SR_PRIV int sr_atol(const char *str, long *ret); | |
743 | SR_PRIV int sr_atoi(const char *str, int *ret); | |
744 | SR_PRIV int sr_atod(const char *str, double *ret); | |
745 | SR_PRIV int sr_atof(const char *str, float *ret); | |
9806c2d5 | 746 | SR_PRIV int sr_atof_ascii(const char *str, float *ret); |
8d558c7a | 747 | |
ac136b57 BV |
748 | /*--- soft-trigger.c --------------------------------------------------------*/ |
749 | ||
750 | struct soft_trigger_logic { | |
751 | const struct sr_dev_inst *sdi; | |
752 | const struct sr_trigger *trigger; | |
753 | int count; | |
754 | int unitsize; | |
755 | int cur_stage; | |
756 | uint8_t *prev_sample; | |
fe5a7355 AJ |
757 | uint8_t *pre_trigger_buffer; |
758 | uint8_t *pre_trigger_head; | |
759 | int pre_trigger_size; | |
760 | int pre_trigger_fill; | |
ac136b57 BV |
761 | }; |
762 | ||
763 | SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new( | |
fe5a7355 AJ |
764 | const struct sr_dev_inst *sdi, struct sr_trigger *trigger, |
765 | int pre_trigger_samples); | |
ac136b57 BV |
766 | SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st); |
767 | SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf, | |
fe5a7355 | 768 | int len, int *pre_trigger_samples); |
ac136b57 | 769 | |
3ea46116 | 770 | /*--- hardware/serial.c -----------------------------------------------------*/ |
058b7035 | 771 | |
c4f2dfd0 | 772 | #ifdef HAVE_LIBSERIALPORT |
a54dd31e UH |
773 | enum { |
774 | SERIAL_RDWR = 1, | |
775 | SERIAL_RDONLY = 2, | |
a54dd31e UH |
776 | }; |
777 | ||
144f6660 | 778 | typedef gboolean (*packet_valid_callback)(const uint8_t *buf); |
766456be | 779 | |
299bdb24 BV |
780 | SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags); |
781 | SR_PRIV int serial_close(struct sr_serial_dev_inst *serial); | |
782 | SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial); | |
bce75f94 | 783 | SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial); |
9a474211 | 784 | SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, |
eead2782 | 785 | const void *buf, size_t count, unsigned int timeout_ms); |
9a474211 ML |
786 | SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial, |
787 | const void *buf, size_t count); | |
9a474211 | 788 | SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, |
eead2782 | 789 | size_t count, unsigned int timeout_ms); |
9a474211 ML |
790 | SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf, |
791 | size_t count); | |
299bdb24 | 792 | SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, |
71caaad4 | 793 | int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr); |
299bdb24 BV |
794 | SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, |
795 | const char *paramstr); | |
796 | SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, | |
797 | int *buflen, gint64 timeout_ms); | |
766456be UH |
798 | SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, |
799 | uint8_t *buf, size_t *buflen, | |
144f6660 UH |
800 | size_t packet_size, |
801 | packet_valid_callback is_valid, | |
766456be | 802 | uint64_t timeout_ms, int baudrate); |
1bd9e678 DJ |
803 | SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device, |
804 | const char **serial_options); | |
102f1239 BV |
805 | SR_PRIV int serial_source_add(struct sr_session *session, |
806 | struct sr_serial_dev_inst *serial, int events, int timeout, | |
807 | sr_receive_data_callback cb, void *cb_data); | |
808 | SR_PRIV int serial_source_remove(struct sr_session *session, | |
809 | struct sr_serial_dev_inst *serial); | |
b541f837 | 810 | SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id); |
c5cfc735 | 811 | SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes); |
c4f2dfd0 | 812 | #endif |
1483577e | 813 | |
3ea46116 | 814 | /*--- hardware/ezusb.c ------------------------------------------------------*/ |
058b7035 | 815 | |
22b02383 | 816 | #ifdef HAVE_LIBUSB_1_0 |
1a081ca6 UH |
817 | SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); |
818 | SR_PRIV int ezusb_install_firmware(libusb_device_handle *hdl, | |
819 | const char *filename); | |
820 | SR_PRIV int ezusb_upload_firmware(libusb_device *dev, int configuration, | |
821 | const char *filename); | |
22b02383 | 822 | #endif |
058b7035 | 823 | |
3ea46116 | 824 | /*--- hardware/usb.c --------------------------------------------------------*/ |
0c632d36 UH |
825 | |
826 | #ifdef HAVE_LIBUSB_1_0 | |
7ae6a758 | 827 | SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn); |
0c632d36 | 828 | SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb); |
102f1239 BV |
829 | SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx, |
830 | int timeout, sr_receive_data_callback cb, void *cb_data); | |
831 | SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx); | |
76bc5f63 | 832 | SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len); |
0c632d36 UH |
833 | #endif |
834 | ||
3ea46116 | 835 | /*--- hardware/scpi.c -------------------------------------------------------*/ |
7b9d7320 | 836 | |
7b9d7320 DJ |
837 | #define SCPI_CMD_IDN "*IDN?" |
838 | #define SCPI_CMD_OPC "*OPC?" | |
839 | ||
840 | enum { | |
841 | SCPI_CMD_SET_TRIGGER_SOURCE, | |
842 | SCPI_CMD_SET_TIMEBASE, | |
843 | SCPI_CMD_SET_VERTICAL_DIV, | |
844 | SCPI_CMD_SET_TRIGGER_SLOPE, | |
845 | SCPI_CMD_SET_COUPLING, | |
846 | SCPI_CMD_SET_HORIZ_TRIGGERPOS, | |
847 | SCPI_CMD_GET_ANALOG_CHAN_STATE, | |
848 | SCPI_CMD_GET_DIG_CHAN_STATE, | |
849 | SCPI_CMD_GET_TIMEBASE, | |
850 | SCPI_CMD_GET_VERTICAL_DIV, | |
851 | SCPI_CMD_GET_VERTICAL_OFFSET, | |
852 | SCPI_CMD_GET_TRIGGER_SOURCE, | |
853 | SCPI_CMD_GET_HORIZ_TRIGGERPOS, | |
854 | SCPI_CMD_GET_TRIGGER_SLOPE, | |
855 | SCPI_CMD_GET_COUPLING, | |
856 | SCPI_CMD_SET_ANALOG_CHAN_STATE, | |
857 | SCPI_CMD_SET_DIG_CHAN_STATE, | |
858 | SCPI_CMD_GET_DIG_POD_STATE, | |
859 | SCPI_CMD_SET_DIG_POD_STATE, | |
860 | SCPI_CMD_GET_ANALOG_DATA, | |
861 | SCPI_CMD_GET_DIG_DATA, | |
c09392d0 DJ |
862 | SCPI_CMD_GET_SAMPLE_RATE, |
863 | SCPI_CMD_GET_SAMPLE_RATE_LIVE, | |
7b9d7320 DJ |
864 | }; |
865 | ||
866 | struct sr_scpi_hw_info { | |
867 | char *manufacturer; | |
868 | char *model; | |
869 | char *serial_number; | |
870 | char *firmware_version; | |
871 | }; | |
872 | ||
23f43dff | 873 | struct sr_scpi_dev_inst { |
f754c146 AJ |
874 | const char *name; |
875 | const char *prefix; | |
876 | int priv_size; | |
b541f837 | 877 | GSList *(*scan)(struct drv_context *drvc); |
17bdda58 AJ |
878 | int (*dev_inst_new)(void *priv, struct drv_context *drvc, |
879 | const char *resource, char **params, const char *serialcomm); | |
23f43dff | 880 | int (*open)(void *priv); |
102f1239 | 881 | int (*source_add)(struct sr_session *session, void *priv, int events, |
144f6660 | 882 | int timeout, sr_receive_data_callback cb, void *cb_data); |
102f1239 | 883 | int (*source_remove)(struct sr_session *session, void *priv); |
23f43dff | 884 | int (*send)(void *priv, const char *command); |
05c644ea ML |
885 | int (*read_begin)(void *priv); |
886 | int (*read_data)(void *priv, char *buf, int maxlen); | |
887 | int (*read_complete)(void *priv); | |
23f43dff ML |
888 | int (*close)(void *priv); |
889 | void (*free)(void *priv); | |
9092e668 | 890 | unsigned int read_timeout_ms; |
23f43dff ML |
891 | void *priv; |
892 | }; | |
893 | ||
b541f837 AJ |
894 | SR_PRIV GSList *sr_scpi_scan(struct drv_context *drvc, GSList *options, |
895 | struct sr_dev_inst *(*probe_device)(struct sr_scpi_dev_inst *scpi)); | |
17bdda58 AJ |
896 | SR_PRIV struct sr_scpi_dev_inst *scpi_dev_inst_new(struct drv_context *drvc, |
897 | const char *resource, const char *serialcomm); | |
23f43dff | 898 | SR_PRIV int sr_scpi_open(struct sr_scpi_dev_inst *scpi); |
102f1239 BV |
899 | SR_PRIV int sr_scpi_source_add(struct sr_session *session, |
900 | struct sr_scpi_dev_inst *scpi, int events, int timeout, | |
901 | sr_receive_data_callback cb, void *cb_data); | |
902 | SR_PRIV int sr_scpi_source_remove(struct sr_session *session, | |
903 | struct sr_scpi_dev_inst *scpi); | |
23f43dff | 904 | SR_PRIV int sr_scpi_send(struct sr_scpi_dev_inst *scpi, |
504f40a5 | 905 | const char *format, ...); |
87c41083 ML |
906 | SR_PRIV int sr_scpi_send_variadic(struct sr_scpi_dev_inst *scpi, |
907 | const char *format, va_list args); | |
05c644ea ML |
908 | SR_PRIV int sr_scpi_read_begin(struct sr_scpi_dev_inst *scpi); |
909 | SR_PRIV int sr_scpi_read_data(struct sr_scpi_dev_inst *scpi, char *buf, int maxlen); | |
910 | SR_PRIV int sr_scpi_read_complete(struct sr_scpi_dev_inst *scpi); | |
23f43dff ML |
911 | SR_PRIV int sr_scpi_close(struct sr_scpi_dev_inst *scpi); |
912 | SR_PRIV void sr_scpi_free(struct sr_scpi_dev_inst *scpi); | |
913 | ||
914 | SR_PRIV int sr_scpi_get_string(struct sr_scpi_dev_inst *scpi, | |
915 | const char *command, char **scpi_response); | |
916 | SR_PRIV int sr_scpi_get_bool(struct sr_scpi_dev_inst *scpi, | |
917 | const char *command, gboolean *scpi_response); | |
918 | SR_PRIV int sr_scpi_get_int(struct sr_scpi_dev_inst *scpi, | |
919 | const char *command, int *scpi_response); | |
920 | SR_PRIV int sr_scpi_get_float(struct sr_scpi_dev_inst *scpi, | |
921 | const char *command, float *scpi_response); | |
922 | SR_PRIV int sr_scpi_get_double(struct sr_scpi_dev_inst *scpi, | |
923 | const char *command, double *scpi_response); | |
924 | SR_PRIV int sr_scpi_get_opc(struct sr_scpi_dev_inst *scpi); | |
925 | SR_PRIV int sr_scpi_get_floatv(struct sr_scpi_dev_inst *scpi, | |
926 | const char *command, GArray **scpi_response); | |
927 | SR_PRIV int sr_scpi_get_uint8v(struct sr_scpi_dev_inst *scpi, | |
928 | const char *command, GArray **scpi_response); | |
929 | SR_PRIV int sr_scpi_get_hw_id(struct sr_scpi_dev_inst *scpi, | |
930 | struct sr_scpi_hw_info **scpi_response); | |
7b9d7320 DJ |
931 | SR_PRIV void sr_scpi_hw_info_free(struct sr_scpi_hw_info *hw_info); |
932 | ||
3ea46116 | 933 | /*--- hardware/dmm/es519xx.c ------------------------------------------------*/ |
c01bdebc | 934 | |
bfb926c1 AJ |
935 | /** |
936 | * All 11-byte es519xx chips repeat each block twice for each conversion cycle | |
937 | * so always read 2 blocks at a time. | |
938 | */ | |
939 | #define ES519XX_11B_PACKET_SIZE (11 * 2) | |
72e1672f | 940 | #define ES519XX_14B_PACKET_SIZE 14 |
c01bdebc AJ |
941 | |
942 | struct es519xx_info { | |
943 | gboolean is_judge, is_voltage, is_auto, is_micro, is_current; | |
944 | gboolean is_milli, is_resistance, is_continuity, is_diode; | |
945 | gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle; | |
946 | gboolean is_temperature, is_celsius, is_fahrenheit; | |
947 | gboolean is_adp0, is_adp1, is_adp2, is_adp3; | |
948 | gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo; | |
949 | gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold; | |
950 | gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr; | |
951 | uint32_t baudrate; | |
952 | int packet_size; | |
953 | gboolean alt_functions, fivedigits, clampmeter, selectable_lpf; | |
954 | }; | |
955 | ||
72e1672f UH |
956 | SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf); |
957 | SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval, | |
958 | struct sr_datafeed_analog *analog, void *info); | |
2588e50c AJ |
959 | SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf); |
960 | SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf, | |
961 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
72e1672f | 962 | SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf); |
93d719cd | 963 | SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf, |
72e1672f UH |
964 | float *floatval, struct sr_datafeed_analog *analog, void *info); |
965 | SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf); | |
966 | SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf, | |
967 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
968 | SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf); | |
969 | SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval, | |
970 | struct sr_datafeed_analog *analog, void *info); | |
971 | SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf); | |
972 | SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval, | |
973 | struct sr_datafeed_analog *analog, void *info); | |
974 | SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf); | |
975 | SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf, | |
976 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
c01bdebc | 977 | |
3ea46116 | 978 | /*--- hardware/dmm/fs9922.c -------------------------------------------------*/ |
79081ec8 | 979 | |
913abe83 UH |
980 | #define FS9922_PACKET_SIZE 14 |
981 | ||
982 | struct fs9922_info { | |
983 | gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2; | |
984 | gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro; | |
985 | gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent; | |
986 | gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad; | |
987 | gboolean is_celsius, is_fahrenheit; | |
988 | int bargraph_sign, bargraph_value; | |
989 | }; | |
990 | ||
913abe83 UH |
991 | SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf); |
992 | SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval, | |
993 | struct sr_datafeed_analog *analog, void *info); | |
e52bb9be | 994 | SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info); |
79081ec8 | 995 | |
3ea46116 | 996 | /*--- hardware/dmm/fs9721.c -------------------------------------------------*/ |
6c701476 | 997 | |
8c1adf37 UH |
998 | #define FS9721_PACKET_SIZE 14 |
999 | ||
1000 | struct fs9721_info { | |
1001 | gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo; | |
1002 | gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad; | |
1003 | gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat; | |
1004 | gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign; | |
1005 | }; | |
1006 | ||
8c1adf37 UH |
1007 | SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf); |
1008 | SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval, | |
93357bc3 | 1009 | struct sr_datafeed_analog *analog, void *info); |
2451a20f UH |
1010 | SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info); |
1011 | SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info); | |
1012 | SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info); | |
1013 | SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info); | |
d327972b | 1014 | SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info); |
6c701476 | 1015 | |
3ea46116 | 1016 | /*--- hardware/dmm/m2110.c --------------------------------------------------*/ |
825da8b2 MH |
1017 | |
1018 | #define BBCGM_M2110_PACKET_SIZE 9 | |
1019 | ||
1020 | SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf); | |
1021 | SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval, | |
1022 | struct sr_datafeed_analog *analog, void *info); | |
1023 | ||
3ea46116 | 1024 | /*--- hardware/dmm/metex14.c ------------------------------------------------*/ |
ac913e5c UH |
1025 | |
1026 | #define METEX14_PACKET_SIZE 14 | |
1027 | ||
1028 | struct metex14_info { | |
1029 | gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature; | |
1030 | gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad; | |
c02dc3e2 UH |
1031 | gboolean is_hertz, is_ohm, is_celsius, is_pico, is_nano, is_micro; |
1032 | gboolean is_milli, is_kilo, is_mega, is_gain, is_decibel, is_hfe; | |
e83437ae | 1033 | gboolean is_unitless, is_logic; |
ac913e5c UH |
1034 | }; |
1035 | ||
c4f2dfd0 | 1036 | #ifdef HAVE_LIBSERIALPORT |
ce3777ad | 1037 | SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial); |
c4f2dfd0 | 1038 | #endif |
ac913e5c UH |
1039 | SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf); |
1040 | SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval, | |
1fbab466 | 1041 | struct sr_datafeed_analog *analog, void *info); |
ac913e5c | 1042 | |
3ea46116 | 1043 | /*--- hardware/dmm/rs9lcd.c -------------------------------------------------*/ |
05f134ab | 1044 | |
21829e67 | 1045 | #define RS9LCD_PACKET_SIZE 9 |
05f134ab | 1046 | |
e7ed87a4 | 1047 | /* Dummy info struct. The parser does not use it. */ |
bf6f8399 | 1048 | struct rs9lcd_info { int dummy; }; |
e7ed87a4 | 1049 | |
05f134ab AG |
1050 | SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf); |
1051 | SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval, | |
1052 | struct sr_datafeed_analog *analog, void *info); | |
1053 | ||
3ea46116 | 1054 | /*--- hardware/dmm/bm25x.c --------------------------------------------------*/ |
a24c3f4a JH |
1055 | |
1056 | #define BRYMEN_BM25X_PACKET_SIZE 15 | |
1057 | ||
1058 | /* Dummy info struct. The parser does not use it. */ | |
1059 | struct bm25x_info { int dummy; }; | |
1060 | ||
1061 | SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf); | |
1062 | SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval, | |
1063 | struct sr_datafeed_analog *analog, void *info); | |
1064 | ||
626027df UH |
1065 | /*--- hardware/dmm/ut71x.c --------------------------------------------------*/ |
1066 | ||
1067 | #define UT71X_PACKET_SIZE 11 | |
1068 | ||
1069 | struct ut71x_info { | |
1070 | gboolean is_voltage, is_resistance, is_capacitance, is_temperature; | |
1071 | gboolean is_celsius, is_fahrenheit, is_current, is_continuity; | |
1072 | gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac; | |
1073 | gboolean is_auto, is_manual, is_sign, is_power, is_loop_current; | |
1074 | }; | |
1075 | ||
1076 | SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf); | |
1077 | SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval, | |
1078 | struct sr_datafeed_analog *analog, void *info); | |
1079 | ||
c36f78f7 UH |
1080 | /*--- hardware/dmm/vc870.c --------------------------------------------------*/ |
1081 | ||
1082 | #define VC870_PACKET_SIZE 23 | |
1083 | ||
1084 | struct vc870_info { | |
1085 | gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance; | |
1086 | gboolean is_continuity, is_capacitance, is_diode, is_loop_current; | |
1087 | gboolean is_current, is_micro, is_milli, is_power; | |
1088 | gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_eff_value; | |
1089 | gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min; | |
1090 | gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold; | |
1091 | gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn; | |
1092 | gboolean is_lo, is_hi, is_open2; | |
1093 | ||
1094 | gboolean is_frequency, is_dual_display, is_auto, is_rms; | |
1095 | }; | |
1096 | ||
1097 | SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf); | |
1098 | SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval, | |
1099 | struct sr_datafeed_analog *analog, void *info); | |
1100 | ||
3ea46116 | 1101 | /*--- hardware/lcr/es51919.c ------------------------------------------------*/ |
6bcb3ee8 JH |
1102 | |
1103 | SR_PRIV void es51919_serial_clean(void *priv); | |
1104 | SR_PRIV struct sr_dev_inst *es51919_serial_scan(GSList *options, | |
1105 | const char *vendor, | |
1106 | const char *model); | |
1107 | SR_PRIV int es51919_serial_config_get(uint32_t key, GVariant **data, | |
1108 | const struct sr_dev_inst *sdi, | |
1109 | const struct sr_channel_group *cg); | |
1110 | SR_PRIV int es51919_serial_config_set(uint32_t key, GVariant *data, | |
1111 | const struct sr_dev_inst *sdi, | |
1112 | const struct sr_channel_group *cg); | |
1113 | SR_PRIV int es51919_serial_config_list(uint32_t key, GVariant **data, | |
1114 | const struct sr_dev_inst *sdi, | |
1115 | const struct sr_channel_group *cg); | |
1116 | SR_PRIV int es51919_serial_acquisition_start(const struct sr_dev_inst *sdi, | |
1117 | void *cb_data); | |
1118 | SR_PRIV int es51919_serial_acquisition_stop(struct sr_dev_inst *sdi, | |
1119 | void *cb_data); | |
1120 | ||
f3cde309 ML |
1121 | /*--- hardware/dmm/ut372.c --------------------------------------------------*/ |
1122 | ||
1123 | #define UT372_PACKET_SIZE 27 | |
1124 | ||
1125 | struct ut372_info { | |
1126 | int dummy; | |
1127 | }; | |
1128 | ||
1129 | SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf); | |
1130 | SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval, | |
1131 | struct sr_datafeed_analog *analog, void *info); | |
1132 | ||
1483577e | 1133 | #endif |