]>
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 | #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H | |
21 | #define LIBSIGROK_LIBSIGROK_INTERNAL_H | |
22 | ||
23 | #include "config.h" | |
24 | ||
25 | #include <glib.h> | |
26 | #ifdef HAVE_LIBHIDAPI | |
27 | #include <hidapi.h> | |
28 | #endif | |
29 | #ifdef HAVE_LIBSERIALPORT | |
30 | #include <libserialport.h> | |
31 | #endif | |
32 | #ifdef HAVE_LIBUSB_1_0 | |
33 | #include <libusb.h> | |
34 | #endif | |
35 | #include <stdarg.h> | |
36 | #include <stdint.h> | |
37 | #include <stdio.h> | |
38 | #include <stdlib.h> | |
39 | ||
40 | struct zip; | |
41 | struct zip_stat; | |
42 | ||
43 | /** | |
44 | * @file | |
45 | * | |
46 | * libsigrok private header file, only to be used internally. | |
47 | */ | |
48 | ||
49 | /*--- Macros ----------------------------------------------------------------*/ | |
50 | ||
51 | #ifndef ARRAY_SIZE | |
52 | #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0])) | |
53 | #endif | |
54 | ||
55 | #ifndef ARRAY_AND_SIZE | |
56 | #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a) | |
57 | #endif | |
58 | ||
59 | /** | |
60 | * Read a 8 bits unsigned integer out of memory. | |
61 | * @param x a pointer to the input memory | |
62 | * @return the corresponding unsigned integer | |
63 | */ | |
64 | #define R8(x) ((unsigned)((const uint8_t*)(x))[0]) | |
65 | ||
66 | /** | |
67 | * Read a 16 bits big endian unsigned integer out of memory. | |
68 | * @param x a pointer to the input memory | |
69 | * @return the corresponding unsigned integer | |
70 | */ | |
71 | #define RB16(x) (((unsigned)((const uint8_t*)(x))[0] << 8) | \ | |
72 | (unsigned)((const uint8_t*)(x))[1]) | |
73 | ||
74 | /** | |
75 | * Read a 16 bits little endian unsigned integer out of memory. | |
76 | * @param x a pointer to the input memory | |
77 | * @return the corresponding unsigned integer | |
78 | */ | |
79 | #define RL16(x) (((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
80 | (unsigned)((const uint8_t*)(x))[0]) | |
81 | ||
82 | /** | |
83 | * Read a 16 bits big endian signed integer out of memory. | |
84 | * @param x a pointer to the input memory | |
85 | * @return the corresponding signed integer | |
86 | */ | |
87 | #define RB16S(x) ((int16_t) \ | |
88 | (((unsigned)((const uint8_t*)(x))[0] << 8) | \ | |
89 | (unsigned)((const uint8_t*)(x))[1])) | |
90 | ||
91 | /** | |
92 | * Read a 16 bits little endian signed integer out of memory. | |
93 | * @param x a pointer to the input memory | |
94 | * @return the corresponding signed integer | |
95 | */ | |
96 | #define RL16S(x) ((int16_t) \ | |
97 | (((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
98 | (unsigned)((const uint8_t*)(x))[0])) | |
99 | ||
100 | /** | |
101 | * Read a 32 bits big endian unsigned integer out of memory. | |
102 | * @param x a pointer to the input memory | |
103 | * @return the corresponding unsigned integer | |
104 | */ | |
105 | #define RB32(x) (((unsigned)((const uint8_t*)(x))[0] << 24) | \ | |
106 | ((unsigned)((const uint8_t*)(x))[1] << 16) | \ | |
107 | ((unsigned)((const uint8_t*)(x))[2] << 8) | \ | |
108 | (unsigned)((const uint8_t*)(x))[3]) | |
109 | ||
110 | /** | |
111 | * Read a 32 bits little endian unsigned integer out of memory. | |
112 | * @param x a pointer to the input memory | |
113 | * @return the corresponding unsigned integer | |
114 | */ | |
115 | #define RL32(x) (((unsigned)((const uint8_t*)(x))[3] << 24) | \ | |
116 | ((unsigned)((const uint8_t*)(x))[2] << 16) | \ | |
117 | ((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
118 | (unsigned)((const uint8_t*)(x))[0]) | |
119 | ||
120 | /** | |
121 | * Read a 32 bits big endian signed integer out of memory. | |
122 | * @param x a pointer to the input memory | |
123 | * @return the corresponding signed integer | |
124 | */ | |
125 | #define RB32S(x) ((int32_t) \ | |
126 | (((unsigned)((const uint8_t*)(x))[0] << 24) | \ | |
127 | ((unsigned)((const uint8_t*)(x))[1] << 16) | \ | |
128 | ((unsigned)((const uint8_t*)(x))[2] << 8) | \ | |
129 | (unsigned)((const uint8_t*)(x))[3])) | |
130 | ||
131 | /** | |
132 | * Read a 32 bits little endian signed integer out of memory. | |
133 | * @param x a pointer to the input memory | |
134 | * @return the corresponding signed integer | |
135 | */ | |
136 | #define RL32S(x) ((int32_t) \ | |
137 | (((unsigned)((const uint8_t*)(x))[3] << 24) | \ | |
138 | ((unsigned)((const uint8_t*)(x))[2] << 16) | \ | |
139 | ((unsigned)((const uint8_t*)(x))[1] << 8) | \ | |
140 | (unsigned)((const uint8_t*)(x))[0])) | |
141 | ||
142 | /** | |
143 | * Read a 64 bits big endian unsigned integer out of memory. | |
144 | * @param x a pointer to the input memory | |
145 | * @return the corresponding unsigned integer | |
146 | */ | |
147 | #define RB64(x) (((uint64_t)((const uint8_t*)(x))[0] << 56) | \ | |
148 | ((uint64_t)((const uint8_t*)(x))[1] << 48) | \ | |
149 | ((uint64_t)((const uint8_t*)(x))[2] << 40) | \ | |
150 | ((uint64_t)((const uint8_t*)(x))[3] << 32) | \ | |
151 | ((uint64_t)((const uint8_t*)(x))[4] << 24) | \ | |
152 | ((uint64_t)((const uint8_t*)(x))[5] << 16) | \ | |
153 | ((uint64_t)((const uint8_t*)(x))[6] << 8) | \ | |
154 | (uint64_t)((const uint8_t*)(x))[7]) | |
155 | ||
156 | /** | |
157 | * Read a 64 bits little endian unsigned integer out of memory. | |
158 | * @param x a pointer to the input memory | |
159 | * @return the corresponding unsigned integer | |
160 | */ | |
161 | #define RL64(x) (((uint64_t)((const uint8_t*)(x))[7] << 56) | \ | |
162 | ((uint64_t)((const uint8_t*)(x))[6] << 48) | \ | |
163 | ((uint64_t)((const uint8_t*)(x))[5] << 40) | \ | |
164 | ((uint64_t)((const uint8_t*)(x))[4] << 32) | \ | |
165 | ((uint64_t)((const uint8_t*)(x))[3] << 24) | \ | |
166 | ((uint64_t)((const uint8_t*)(x))[2] << 16) | \ | |
167 | ((uint64_t)((const uint8_t*)(x))[1] << 8) | \ | |
168 | (uint64_t)((const uint8_t*)(x))[0]) | |
169 | ||
170 | /** | |
171 | * Read a 64 bits little endian signed integer out of memory. | |
172 | * @param x a pointer to the input memory | |
173 | * @return the corresponding unsigned integer | |
174 | */ | |
175 | #define RL64S(x) ((int64_t) \ | |
176 | (((uint64_t)((const uint8_t*)(x))[7] << 56) | \ | |
177 | ((uint64_t)((const uint8_t*)(x))[6] << 48) | \ | |
178 | ((uint64_t)((const uint8_t*)(x))[5] << 40) | \ | |
179 | ((uint64_t)((const uint8_t*)(x))[4] << 32) | \ | |
180 | ((uint64_t)((const uint8_t*)(x))[3] << 24) | \ | |
181 | ((uint64_t)((const uint8_t*)(x))[2] << 16) | \ | |
182 | ((uint64_t)((const uint8_t*)(x))[1] << 8) | \ | |
183 | (uint64_t)((const uint8_t*)(x))[0])) | |
184 | ||
185 | /** | |
186 | * Read a 32 bits big endian float out of memory. | |
187 | * @param x a pointer to the input memory | |
188 | * @return the corresponding float | |
189 | */ | |
190 | #define RBFL(x) ((union { uint32_t u; float f; }) { .u = RB32(x) }.f) | |
191 | ||
192 | /** | |
193 | * Read a 32 bits little endian float out of memory. | |
194 | * @param x a pointer to the input memory | |
195 | * @return the corresponding float | |
196 | */ | |
197 | #define RLFL(x) ((union { uint32_t u; float f; }) { .u = RL32(x) }.f) | |
198 | ||
199 | /** | |
200 | * Write a 8 bits unsigned integer to memory. | |
201 | * @param p a pointer to the output memory | |
202 | * @param x the input unsigned integer | |
203 | */ | |
204 | #define W8(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); } while (0) | |
205 | ||
206 | /** | |
207 | * Write a 16 bits unsigned integer to memory stored as big endian. | |
208 | * @param p a pointer to the output memory | |
209 | * @param x the input unsigned integer | |
210 | */ | |
211 | #define WB16(p, x) do { ((uint8_t*)(p))[1] = (uint8_t) (x); \ | |
212 | ((uint8_t*)(p))[0] = (uint8_t)((x)>>8); } while (0) | |
213 | ||
214 | /** | |
215 | * Write a 16 bits unsigned integer to memory stored as little endian. | |
216 | * @param p a pointer to the output memory | |
217 | * @param x the input unsigned integer | |
218 | */ | |
219 | #define WL16(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \ | |
220 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); } while (0) | |
221 | ||
222 | /** | |
223 | * Write a 32 bits unsigned integer to memory stored as big endian. | |
224 | * @param p a pointer to the output memory | |
225 | * @param x the input unsigned integer | |
226 | */ | |
227 | #define WB32(p, x) do { ((uint8_t*)(p))[3] = (uint8_t) (x); \ | |
228 | ((uint8_t*)(p))[2] = (uint8_t)((x)>>8); \ | |
229 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>16); \ | |
230 | ((uint8_t*)(p))[0] = (uint8_t)((x)>>24); } while (0) | |
231 | ||
232 | /** | |
233 | * Write a 32 bits unsigned integer to memory stored as little endian. | |
234 | * @param p a pointer to the output memory | |
235 | * @param x the input unsigned integer | |
236 | */ | |
237 | #define WL32(p, x) do { ((uint8_t*)(p))[0] = (uint8_t) (x); \ | |
238 | ((uint8_t*)(p))[1] = (uint8_t)((x)>>8); \ | |
239 | ((uint8_t*)(p))[2] = (uint8_t)((x)>>16); \ | |
240 | ((uint8_t*)(p))[3] = (uint8_t)((x)>>24); } while (0) | |
241 | ||
242 | /** | |
243 | * Write a 32 bits float to memory stored as big endian. | |
244 | * @param p a pointer to the output memory | |
245 | * @param x the input float | |
246 | */ | |
247 | #define WBFL(p, x) WB32(p, (union { uint32_t u; float f; }) { .f = x }.u) | |
248 | ||
249 | /** | |
250 | * Write a 32 bits float to memory stored as little endian. | |
251 | * @param p a pointer to the output memory | |
252 | * @param x the input float | |
253 | */ | |
254 | #define WLFL(p, x) WL32(p, (union { uint32_t u; float f; }) { .f = x }.u) | |
255 | ||
256 | /* Portability fixes for FreeBSD. */ | |
257 | #ifdef __FreeBSD__ | |
258 | #define LIBUSB_CLASS_APPLICATION 0xfe | |
259 | #define libusb_has_capability(x) 0 | |
260 | #define libusb_handle_events_timeout_completed(ctx, tv, c) \ | |
261 | libusb_handle_events_timeout(ctx, tv) | |
262 | #endif | |
263 | ||
264 | /* Static definitions of structs ending with an all-zero entry are a | |
265 | * problem when compiling with -Wmissing-field-initializers: GCC | |
266 | * suppresses the warning only with { 0 }, clang wants { } */ | |
267 | #ifdef __clang__ | |
268 | #define ALL_ZERO { } | |
269 | #else | |
270 | #define ALL_ZERO { 0 } | |
271 | #endif | |
272 | ||
273 | #ifdef __APPLE__ | |
274 | #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list" | |
275 | #else | |
276 | #define SR_DRIVER_LIST_SECTION "__sr_driver_list" | |
277 | #endif | |
278 | ||
279 | /** | |
280 | * Register a list of hardware drivers. | |
281 | * | |
282 | * This macro can be used to register multiple hardware drivers to the library. | |
283 | * This is useful when a driver supports multiple similar but slightly | |
284 | * different devices that require different sr_dev_driver struct definitions. | |
285 | * | |
286 | * For registering only a single driver see SR_REGISTER_DEV_DRIVER(). | |
287 | * | |
288 | * Example: | |
289 | * @code{c} | |
290 | * #define MY_DRIVER(_name) \ | |
291 | * &(struct sr_dev_driver){ \ | |
292 | * .name = _name, \ | |
293 | * ... | |
294 | * }; | |
295 | * | |
296 | * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos, | |
297 | * MY_DRIVER("driver 1"), | |
298 | * MY_DRIVER("driver 2"), | |
299 | * ... | |
300 | * ); | |
301 | * @endcode | |
302 | * | |
303 | * @param name Name to use for the driver list identifier. | |
304 | * @param ... Comma separated list of pointers to sr_dev_driver structs. | |
305 | */ | |
306 | #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \ | |
307 | static const struct sr_dev_driver *name[] \ | |
308 | __attribute__((section (SR_DRIVER_LIST_SECTION), used, \ | |
309 | aligned(sizeof(struct sr_dev_driver *)))) \ | |
310 | = { \ | |
311 | __VA_ARGS__ \ | |
312 | }; | |
313 | ||
314 | /** | |
315 | * Register a hardware driver. | |
316 | * | |
317 | * This macro is used to register a hardware driver with the library. It has | |
318 | * to be used in order to make the driver accessible to applications using the | |
319 | * library. | |
320 | * | |
321 | * The macro invocation should be placed directly under the struct | |
322 | * sr_dev_driver definition. | |
323 | * | |
324 | * Example: | |
325 | * @code{c} | |
326 | * static struct sr_dev_driver driver_info = { | |
327 | * .name = "driver", | |
328 | * .... | |
329 | * }; | |
330 | * SR_REGISTER_DEV_DRIVER(driver_info); | |
331 | * @endcode | |
332 | * | |
333 | * @param name Identifier name of sr_dev_driver struct to register. | |
334 | */ | |
335 | #define SR_REGISTER_DEV_DRIVER(name) \ | |
336 | SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name); | |
337 | ||
338 | SR_API void sr_drivers_init(struct sr_context *context); | |
339 | ||
340 | struct sr_context { | |
341 | struct sr_dev_driver **driver_list; | |
342 | #ifdef HAVE_LIBUSB_1_0 | |
343 | libusb_context *libusb_ctx; | |
344 | #endif | |
345 | sr_resource_open_callback resource_open_cb; | |
346 | sr_resource_close_callback resource_close_cb; | |
347 | sr_resource_read_callback resource_read_cb; | |
348 | void *resource_cb_data; | |
349 | }; | |
350 | ||
351 | /** Input module metadata keys. */ | |
352 | enum sr_input_meta_keys { | |
353 | /** The input filename, if there is one. */ | |
354 | SR_INPUT_META_FILENAME = 0x01, | |
355 | /** The input file's size in bytes. */ | |
356 | SR_INPUT_META_FILESIZE = 0x02, | |
357 | /** The first 128 bytes of the file, provided as a GString. */ | |
358 | SR_INPUT_META_HEADER = 0x04, | |
359 | ||
360 | /** The module cannot identify a file without this metadata. */ | |
361 | SR_INPUT_META_REQUIRED = 0x80, | |
362 | }; | |
363 | ||
364 | /** Input (file) module struct. */ | |
365 | struct sr_input { | |
366 | /** | |
367 | * A pointer to this input module's 'struct sr_input_module'. | |
368 | */ | |
369 | const struct sr_input_module *module; | |
370 | GString *buf; | |
371 | struct sr_dev_inst *sdi; | |
372 | gboolean sdi_ready; | |
373 | void *priv; | |
374 | }; | |
375 | ||
376 | /** Input (file) module driver. */ | |
377 | struct sr_input_module { | |
378 | /** | |
379 | * A unique ID for this input module, suitable for use in command-line | |
380 | * clients, [a-z0-9-]. Must not be NULL. | |
381 | */ | |
382 | const char *id; | |
383 | ||
384 | /** | |
385 | * A unique name for this input module, suitable for use in GUI | |
386 | * clients, can contain UTF-8. Must not be NULL. | |
387 | */ | |
388 | const char *name; | |
389 | ||
390 | /** | |
391 | * A short description of the input module. Must not be NULL. | |
392 | * | |
393 | * This can be displayed by frontends, e.g. when selecting the input | |
394 | * module for saving a file. | |
395 | */ | |
396 | const char *desc; | |
397 | ||
398 | /** | |
399 | * A NULL terminated array of strings containing a list of file name | |
400 | * extensions typical for the input file format, or NULL if there is | |
401 | * no typical extension for this file format. | |
402 | */ | |
403 | const char *const *exts; | |
404 | ||
405 | /** | |
406 | * Zero-terminated list of metadata items the module needs to be able | |
407 | * to identify an input stream. Can be all-zero, if the module cannot | |
408 | * identify streams at all, i.e. has to be forced into use. | |
409 | * | |
410 | * Each item is one of: | |
411 | * SR_INPUT_META_FILENAME | |
412 | * SR_INPUT_META_FILESIZE | |
413 | * SR_INPUT_META_HEADER | |
414 | * | |
415 | * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot | |
416 | * identify a stream without the given metadata. | |
417 | */ | |
418 | const uint8_t metadata[8]; | |
419 | ||
420 | /** | |
421 | * Returns a NULL-terminated list of options this module can take. | |
422 | * Can be NULL, if the module has no options. | |
423 | */ | |
424 | const struct sr_option *(*options) (void); | |
425 | ||
426 | /** | |
427 | * Check if this input module can load and parse the specified stream. | |
428 | * | |
429 | * @param[in] metadata Metadata the module can use to identify the stream. | |
430 | * @param[out] confidence "Strength" of the detection. | |
431 | * Specialized handlers can take precedence over generic/basic support. | |
432 | * | |
433 | * @retval SR_OK This module knows the format. | |
434 | * @retval SR_ERR_NA There wasn't enough data for this module to | |
435 | * positively identify the format. | |
436 | * @retval SR_ERR_DATA This module knows the format, but cannot handle | |
437 | * it. This means the stream is either corrupt, or indicates a | |
438 | * feature that the module does not support. | |
439 | * @retval SR_ERR This module does not know the format. | |
440 | * | |
441 | * Lower numeric values of 'confidence' mean that the input module | |
442 | * stronger believes in its capability to handle this specific format. | |
443 | * This way, multiple input modules can claim support for a format, | |
444 | * and the application can pick the best match, or try fallbacks | |
445 | * in case of errors. This approach also copes with formats that | |
446 | * are unreliable to detect in the absence of magic signatures. | |
447 | */ | |
448 | int (*format_match) (GHashTable *metadata, unsigned int *confidence); | |
449 | ||
450 | /** | |
451 | * Initialize the input module. | |
452 | * | |
453 | * @retval SR_OK Success | |
454 | * @retval other Negative error code. | |
455 | */ | |
456 | int (*init) (struct sr_input *in, GHashTable *options); | |
457 | ||
458 | /** | |
459 | * Send data to the specified input instance. | |
460 | * | |
461 | * When an input module instance is created with sr_input_new(), this | |
462 | * function is used to feed data to the instance. | |
463 | * | |
464 | * As enough data gets fed into this function to completely populate | |
465 | * the device instance associated with this input instance, this is | |
466 | * guaranteed to return the moment it's ready. This gives the caller | |
467 | * the chance to examine the device instance, attach session callbacks | |
468 | * and so on. | |
469 | * | |
470 | * @retval SR_OK Success | |
471 | * @retval other Negative error code. | |
472 | */ | |
473 | int (*receive) (struct sr_input *in, GString *buf); | |
474 | ||
475 | /** | |
476 | * Signal the input module no more data will come. | |
477 | * | |
478 | * This will cause the module to process any data it may have buffered. | |
479 | * The SR_DF_END packet will also typically be sent at this time. | |
480 | */ | |
481 | int (*end) (struct sr_input *in); | |
482 | ||
483 | /** | |
484 | * Reset the input module's input handling structures. | |
485 | * | |
486 | * Causes the input module to reset its internal state so that we can | |
487 | * re-send the input data from the beginning without having to | |
488 | * re-create the entire input module. | |
489 | * | |
490 | * @retval SR_OK Success. | |
491 | * @retval other Negative error code. | |
492 | */ | |
493 | int (*reset) (struct sr_input *in); | |
494 | ||
495 | /** | |
496 | * This function is called after the caller is finished using | |
497 | * the input module, and can be used to free any internal | |
498 | * resources the module may keep. | |
499 | * | |
500 | * This function is optional. | |
501 | * | |
502 | * @retval SR_OK Success | |
503 | * @retval other Negative error code. | |
504 | */ | |
505 | void (*cleanup) (struct sr_input *in); | |
506 | }; | |
507 | ||
508 | /** Output module instance. */ | |
509 | struct sr_output { | |
510 | /** A pointer to this output's module. */ | |
511 | const struct sr_output_module *module; | |
512 | ||
513 | /** | |
514 | * The device for which this output module is creating output. This | |
515 | * can be used by the module to find out channel names and numbers. | |
516 | */ | |
517 | const struct sr_dev_inst *sdi; | |
518 | ||
519 | /** | |
520 | * The name of the file that the data should be written to. | |
521 | */ | |
522 | const char *filename; | |
523 | ||
524 | /** | |
525 | * A generic pointer which can be used by the module to keep internal | |
526 | * state between calls into its callback functions. | |
527 | * | |
528 | * For example, the module might store a pointer to a chunk of output | |
529 | * there, and only flush it when it reaches a certain size. | |
530 | */ | |
531 | void *priv; | |
532 | }; | |
533 | ||
534 | /** Output module driver. */ | |
535 | struct sr_output_module { | |
536 | /** | |
537 | * A unique ID for this output module, suitable for use in command-line | |
538 | * clients, [a-z0-9-]. Must not be NULL. | |
539 | */ | |
540 | const char *id; | |
541 | ||
542 | /** | |
543 | * A unique name for this output module, suitable for use in GUI | |
544 | * clients, can contain UTF-8. Must not be NULL. | |
545 | */ | |
546 | const char *name; | |
547 | ||
548 | /** | |
549 | * A short description of the output module. Must not be NULL. | |
550 | * | |
551 | * This can be displayed by frontends, e.g. when selecting the output | |
552 | * module for saving a file. | |
553 | */ | |
554 | const char *desc; | |
555 | ||
556 | /** | |
557 | * A NULL terminated array of strings containing a list of file name | |
558 | * extensions typical for the input file format, or NULL if there is | |
559 | * no typical extension for this file format. | |
560 | */ | |
561 | const char *const *exts; | |
562 | ||
563 | /** | |
564 | * Bitfield containing flags that describe certain properties | |
565 | * this output module may or may not have. | |
566 | * @see sr_output_flags | |
567 | */ | |
568 | const uint64_t flags; | |
569 | ||
570 | /** | |
571 | * Returns a NULL-terminated list of options this module can take. | |
572 | * Can be NULL, if the module has no options. | |
573 | */ | |
574 | const struct sr_option *(*options) (void); | |
575 | ||
576 | /** | |
577 | * This function is called once, at the beginning of an output stream. | |
578 | * | |
579 | * The device struct will be available in the output struct passed in, | |
580 | * as well as the param field -- which may be NULL or an empty string, | |
581 | * if no parameter was passed. | |
582 | * | |
583 | * The module can use this to initialize itself, create a struct for | |
584 | * keeping state and storing it in the <code>internal</code> field. | |
585 | * | |
586 | * @param o Pointer to the respective 'struct sr_output'. | |
587 | * | |
588 | * @retval SR_OK Success | |
589 | * @retval other Negative error code. | |
590 | */ | |
591 | int (*init) (struct sr_output *o, GHashTable *options); | |
592 | ||
593 | /** | |
594 | * This function is passed a copy of every packet in the data feed. | |
595 | * Any output generated by the output module in response to the | |
596 | * packet should be returned in a newly allocated GString | |
597 | * <code>out</code>, which will be freed by the caller. | |
598 | * | |
599 | * Packets not of interest to the output module can just be ignored, | |
600 | * and the <code>out</code> parameter set to NULL. | |
601 | * | |
602 | * @param o Pointer to the respective 'struct sr_output'. | |
603 | * @param sdi The device instance that generated the packet. | |
604 | * @param packet The complete packet. | |
605 | * @param out A pointer where a GString * should be stored if | |
606 | * the module generates output, or NULL if not. | |
607 | * | |
608 | * @retval SR_OK Success | |
609 | * @retval other Negative error code. | |
610 | */ | |
611 | int (*receive) (const struct sr_output *o, | |
612 | const struct sr_datafeed_packet *packet, GString **out); | |
613 | ||
614 | /** | |
615 | * This function is called after the caller is finished using | |
616 | * the output module, and can be used to free any internal | |
617 | * resources the module may keep. | |
618 | * | |
619 | * @retval SR_OK Success | |
620 | * @retval other Negative error code. | |
621 | */ | |
622 | int (*cleanup) (struct sr_output *o); | |
623 | }; | |
624 | ||
625 | /** Transform module instance. */ | |
626 | struct sr_transform { | |
627 | /** A pointer to this transform's module. */ | |
628 | const struct sr_transform_module *module; | |
629 | ||
630 | /** | |
631 | * The device for which this transform module is used. This | |
632 | * can be used by the module to find out channel names and numbers. | |
633 | */ | |
634 | const struct sr_dev_inst *sdi; | |
635 | ||
636 | /** | |
637 | * A generic pointer which can be used by the module to keep internal | |
638 | * state between calls into its callback functions. | |
639 | */ | |
640 | void *priv; | |
641 | }; | |
642 | ||
643 | struct sr_transform_module { | |
644 | /** | |
645 | * A unique ID for this transform module, suitable for use in | |
646 | * command-line clients, [a-z0-9-]. Must not be NULL. | |
647 | */ | |
648 | const char *id; | |
649 | ||
650 | /** | |
651 | * A unique name for this transform module, suitable for use in GUI | |
652 | * clients, can contain UTF-8. Must not be NULL. | |
653 | */ | |
654 | const char *name; | |
655 | ||
656 | /** | |
657 | * A short description of the transform module. Must not be NULL. | |
658 | * | |
659 | * This can be displayed by frontends, e.g. when selecting | |
660 | * which transform module(s) to add. | |
661 | */ | |
662 | const char *desc; | |
663 | ||
664 | /** | |
665 | * Returns a NULL-terminated list of options this transform module | |
666 | * can take. Can be NULL, if the transform module has no options. | |
667 | */ | |
668 | const struct sr_option *(*options) (void); | |
669 | ||
670 | /** | |
671 | * This function is called once, at the beginning of a stream. | |
672 | * | |
673 | * @param t Pointer to the respective 'struct sr_transform'. | |
674 | * @param options Hash table of options for this transform module. | |
675 | * Can be NULL if no options are to be used. | |
676 | * | |
677 | * @retval SR_OK Success | |
678 | * @retval other Negative error code. | |
679 | */ | |
680 | int (*init) (struct sr_transform *t, GHashTable *options); | |
681 | ||
682 | /** | |
683 | * This function is passed a pointer to every packet in the data feed. | |
684 | * | |
685 | * It can either return (in packet_out) a pointer to another packet | |
686 | * (possibly the exact same packet it got as input), or NULL. | |
687 | * | |
688 | * @param t Pointer to the respective 'struct sr_transform'. | |
689 | * @param packet_in Pointer to a datafeed packet. | |
690 | * @param packet_out Pointer to the resulting datafeed packet after | |
691 | * this function was run. If NULL, the transform | |
692 | * module intentionally didn't output a new packet. | |
693 | * | |
694 | * @retval SR_OK Success | |
695 | * @retval other Negative error code. | |
696 | */ | |
697 | int (*receive) (const struct sr_transform *t, | |
698 | struct sr_datafeed_packet *packet_in, | |
699 | struct sr_datafeed_packet **packet_out); | |
700 | ||
701 | /** | |
702 | * This function is called after the caller is finished using | |
703 | * the transform module, and can be used to free any internal | |
704 | * resources the module may keep. | |
705 | * | |
706 | * @retval SR_OK Success | |
707 | * @retval other Negative error code. | |
708 | */ | |
709 | int (*cleanup) (struct sr_transform *t); | |
710 | }; | |
711 | ||
712 | #ifdef HAVE_LIBUSB_1_0 | |
713 | /** USB device instance */ | |
714 | struct sr_usb_dev_inst { | |
715 | /** USB bus */ | |
716 | uint8_t bus; | |
717 | /** Device address on USB bus */ | |
718 | uint8_t address; | |
719 | /** libusb device handle */ | |
720 | struct libusb_device_handle *devhdl; | |
721 | }; | |
722 | #endif | |
723 | ||
724 | struct sr_serial_dev_inst; | |
725 | #ifdef HAVE_SERIAL_COMM | |
726 | struct ser_lib_functions; | |
727 | struct ser_hid_chip_functions; | |
728 | struct sr_bt_desc; | |
729 | typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial, | |
730 | void *cb_data, const void *buf, size_t count); | |
731 | struct sr_serial_dev_inst { | |
732 | /** Port name, e.g. '/dev/tty42'. */ | |
733 | char *port; | |
734 | /** Comm params for serial_set_paramstr(). */ | |
735 | char *serialcomm; | |
736 | struct ser_lib_functions *lib_funcs; | |
737 | struct { | |
738 | int bit_rate; | |
739 | int data_bits; | |
740 | int parity_bits; | |
741 | int stop_bits; | |
742 | } comm_params; | |
743 | GString *rcv_buffer; | |
744 | serial_rx_chunk_callback rx_chunk_cb_func; | |
745 | void *rx_chunk_cb_data; | |
746 | #ifdef HAVE_LIBSERIALPORT | |
747 | /** libserialport port handle */ | |
748 | struct sp_port *sp_data; | |
749 | #endif | |
750 | #ifdef HAVE_LIBHIDAPI | |
751 | enum ser_hid_chip_t { | |
752 | SER_HID_CHIP_UNKNOWN, /**!< place holder */ | |
753 | SER_HID_CHIP_BTC_BU86X, /**!< Brymen BU86x */ | |
754 | SER_HID_CHIP_SIL_CP2110, /**!< SiLabs CP2110 */ | |
755 | SER_HID_CHIP_VICTOR_DMM, /**!< Victor 70/86 DMM cable */ | |
756 | SER_HID_CHIP_WCH_CH9325, /**!< WCH CH9325 */ | |
757 | SER_HID_CHIP_LAST, /**!< sentinel */ | |
758 | } hid_chip; | |
759 | struct ser_hid_chip_functions *hid_chip_funcs; | |
760 | char *usb_path; | |
761 | char *usb_serno; | |
762 | const char *hid_path; | |
763 | hid_device *hid_dev; | |
764 | GSList *hid_source_args; | |
765 | #endif | |
766 | #ifdef HAVE_BLUETOOTH | |
767 | enum ser_bt_conn_t { | |
768 | SER_BT_CONN_UNKNOWN, /**!< place holder */ | |
769 | SER_BT_CONN_RFCOMM, /**!< BT classic, RFCOMM channel */ | |
770 | SER_BT_CONN_BLE122, /**!< BLE, BLE122 module, indications */ | |
771 | SER_BT_CONN_NRF51, /**!< BLE, Nordic nRF51, notifications */ | |
772 | SER_BT_CONN_CC254x, /**!< BLE, TI CC254x, notifications */ | |
773 | SER_BT_CONN_MAX, /**!< sentinel */ | |
774 | } bt_conn_type; | |
775 | char *bt_addr_local; | |
776 | char *bt_addr_remote; | |
777 | size_t bt_rfcomm_channel; | |
778 | uint16_t bt_notify_handle_read; | |
779 | uint16_t bt_notify_handle_write; | |
780 | uint16_t bt_notify_handle_cccd; | |
781 | uint16_t bt_notify_value_cccd; | |
782 | struct sr_bt_desc *bt_desc; | |
783 | GSList *bt_source_args; | |
784 | #endif | |
785 | }; | |
786 | #endif | |
787 | ||
788 | struct sr_usbtmc_dev_inst { | |
789 | char *device; | |
790 | int fd; | |
791 | }; | |
792 | ||
793 | /* Private driver context. */ | |
794 | struct drv_context { | |
795 | /** sigrok context */ | |
796 | struct sr_context *sr_ctx; | |
797 | GSList *instances; | |
798 | }; | |
799 | ||
800 | /*--- log.c -----------------------------------------------------------------*/ | |
801 | ||
802 | #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4)) | |
803 | /* | |
804 | * On MinGW, we need to specify the gnu_printf format flavor or GCC | |
805 | * will assume non-standard Microsoft printf syntax. | |
806 | */ | |
807 | SR_PRIV int sr_log(int loglevel, const char *format, ...) | |
808 | __attribute__((__format__ (__gnu_printf__, 2, 3))); | |
809 | #else | |
810 | SR_PRIV int sr_log(int loglevel, const char *format, ...) G_GNUC_PRINTF(2, 3); | |
811 | #endif | |
812 | ||
813 | /* Message logging helpers with subsystem-specific prefix string. */ | |
814 | #define sr_spew(...) sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__) | |
815 | #define sr_dbg(...) sr_log(SR_LOG_DBG, LOG_PREFIX ": " __VA_ARGS__) | |
816 | #define sr_info(...) sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__) | |
817 | #define sr_warn(...) sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__) | |
818 | #define sr_err(...) sr_log(SR_LOG_ERR, LOG_PREFIX ": " __VA_ARGS__) | |
819 | ||
820 | /*--- device.c --------------------------------------------------------------*/ | |
821 | ||
822 | /** Scan options supported by a driver. */ | |
823 | #define SR_CONF_SCAN_OPTIONS 0x7FFF0000 | |
824 | ||
825 | /** Device options for a particular device. */ | |
826 | #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001 | |
827 | ||
828 | /** Mask for separating config keys from capabilities. */ | |
829 | #define SR_CONF_MASK 0x1fffffff | |
830 | ||
831 | /** Values for the changes argument of sr_dev_driver.config_channel_set. */ | |
832 | enum { | |
833 | /** The enabled state of the channel has been changed. */ | |
834 | SR_CHANNEL_SET_ENABLED = 1 << 0, | |
835 | }; | |
836 | ||
837 | SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi, | |
838 | int index, int type, gboolean enabled, const char *name); | |
839 | SR_PRIV void sr_channel_free(struct sr_channel *ch); | |
840 | SR_PRIV void sr_channel_free_cb(void *p); | |
841 | SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi, | |
842 | struct sr_channel *cur_channel); | |
843 | SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2); | |
844 | SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2); | |
845 | ||
846 | /** Device instance data */ | |
847 | struct sr_dev_inst { | |
848 | /** Device driver. */ | |
849 | struct sr_dev_driver *driver; | |
850 | /** Device instance status. SR_ST_NOT_FOUND, etc. */ | |
851 | int status; | |
852 | /** Device instance type. SR_INST_USB, etc. */ | |
853 | int inst_type; | |
854 | /** Device vendor. */ | |
855 | char *vendor; | |
856 | /** Device model. */ | |
857 | char *model; | |
858 | /** Device version. */ | |
859 | char *version; | |
860 | /** Serial number. */ | |
861 | char *serial_num; | |
862 | /** Connection string to uniquely identify devices. */ | |
863 | char *connection_id; | |
864 | /** List of channels. */ | |
865 | GSList *channels; | |
866 | /** List of sr_channel_group structs */ | |
867 | GSList *channel_groups; | |
868 | /** Device instance connection data (used?) */ | |
869 | void *conn; | |
870 | /** Device instance private data (used?) */ | |
871 | void *priv; | |
872 | /** Session to which this device is currently assigned. */ | |
873 | struct sr_session *session; | |
874 | }; | |
875 | ||
876 | /* Generic device instances */ | |
877 | SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi); | |
878 | ||
879 | #ifdef HAVE_LIBUSB_1_0 | |
880 | /* USB-specific instances */ | |
881 | SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus, | |
882 | uint8_t address, struct libusb_device_handle *hdl); | |
883 | SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb); | |
884 | #endif | |
885 | ||
886 | #ifdef HAVE_SERIAL_COMM | |
887 | #ifndef HAVE_LIBSERIALPORT | |
888 | /* | |
889 | * Some identifiers which initially got provided by libserialport are | |
890 | * used internally within the libsigrok serial layer's implementation, | |
891 | * while libserialport no longer is the exclusive provider of serial | |
892 | * communication support. Declare the identifiers here so they remain | |
893 | * available across all build configurations. | |
894 | */ | |
895 | enum libsp_parity { | |
896 | SP_PARITY_NONE = 0, | |
897 | SP_PARITY_ODD = 1, | |
898 | SP_PARITY_EVEN = 2, | |
899 | SP_PARITY_MARK = 3, | |
900 | SP_PARITY_SPACE = 4, | |
901 | }; | |
902 | ||
903 | enum libsp_flowcontrol { | |
904 | SP_FLOWCONTROL_NONE = 0, | |
905 | SP_FLOWCONTROL_XONXOFF = 1, | |
906 | SP_FLOWCONTROL_RTSCTS = 2, | |
907 | SP_FLOWCONTROL_DTRDSR = 3, | |
908 | }; | |
909 | #endif | |
910 | ||
911 | /* Serial-specific instances */ | |
912 | SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port, | |
913 | const char *serialcomm); | |
914 | SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial); | |
915 | #endif | |
916 | ||
917 | /* USBTMC-specific instances */ | |
918 | SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device); | |
919 | SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc); | |
920 | ||
921 | /*--- hwdriver.c ------------------------------------------------------------*/ | |
922 | ||
923 | SR_PRIV const GVariantType *sr_variant_type_get(int datatype); | |
924 | SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data); | |
925 | SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx); | |
926 | SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data); | |
927 | SR_PRIV void sr_config_free(struct sr_config *src); | |
928 | SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi); | |
929 | SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi); | |
930 | ||
931 | /*--- session.c -------------------------------------------------------------*/ | |
932 | ||
933 | struct sr_session { | |
934 | /** Context this session exists in. */ | |
935 | struct sr_context *ctx; | |
936 | /** List of struct sr_dev_inst pointers. */ | |
937 | GSList *devs; | |
938 | /** List of struct sr_dev_inst pointers owned by this session. */ | |
939 | GSList *owned_devs; | |
940 | /** List of struct datafeed_callback pointers. */ | |
941 | GSList *datafeed_callbacks; | |
942 | GSList *transforms; | |
943 | struct sr_trigger *trigger; | |
944 | ||
945 | /** Callback to invoke on session stop. */ | |
946 | sr_session_stopped_callback stopped_callback; | |
947 | /** User data to be passed to the session stop callback. */ | |
948 | void *stopped_cb_data; | |
949 | ||
950 | /** Mutex protecting the main context pointer. */ | |
951 | GMutex main_mutex; | |
952 | /** Context of the session main loop. */ | |
953 | GMainContext *main_context; | |
954 | ||
955 | /** Registered event sources for this session. */ | |
956 | GHashTable *event_sources; | |
957 | /** Session main loop. */ | |
958 | GMainLoop *main_loop; | |
959 | /** ID of idle source for dispatching the session stop notification. */ | |
960 | unsigned int stop_check_id; | |
961 | /** Whether the session has been started. */ | |
962 | gboolean running; | |
963 | }; | |
964 | ||
965 | SR_PRIV int sr_session_source_add_internal(struct sr_session *session, | |
966 | void *key, GSource *source); | |
967 | SR_PRIV int sr_session_source_remove_internal(struct sr_session *session, | |
968 | void *key); | |
969 | SR_PRIV int sr_session_source_destroyed(struct sr_session *session, | |
970 | void *key, GSource *source); | |
971 | SR_PRIV int sr_session_fd_source_add(struct sr_session *session, | |
972 | void *key, gintptr fd, int events, int timeout, | |
973 | sr_receive_data_callback cb, void *cb_data); | |
974 | ||
975 | SR_PRIV int sr_session_source_add(struct sr_session *session, int fd, | |
976 | int events, int timeout, sr_receive_data_callback cb, void *cb_data); | |
977 | SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session, | |
978 | GPollFD *pollfd, int timeout, sr_receive_data_callback cb, | |
979 | void *cb_data); | |
980 | SR_PRIV int sr_session_source_add_channel(struct sr_session *session, | |
981 | GIOChannel *channel, int events, int timeout, | |
982 | sr_receive_data_callback cb, void *cb_data); | |
983 | SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd); | |
984 | SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session, | |
985 | GPollFD *pollfd); | |
986 | SR_PRIV int sr_session_source_remove_channel(struct sr_session *session, | |
987 | GIOChannel *channel); | |
988 | ||
989 | SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi, | |
990 | uint32_t key, GVariant *var); | |
991 | SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi, | |
992 | const struct sr_datafeed_packet *packet); | |
993 | SR_PRIV int sr_sessionfile_check(const char *filename); | |
994 | SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename, | |
995 | struct sr_session **session); | |
996 | ||
997 | /*--- session_file.c --------------------------------------------------------*/ | |
998 | ||
999 | #if !HAVE_ZIP_DISCARD | |
1000 | /* Replace zip_discard() if not available. */ | |
1001 | #define zip_discard(zip) sr_zip_discard(zip) | |
1002 | SR_PRIV void sr_zip_discard(struct zip *archive); | |
1003 | #endif | |
1004 | ||
1005 | SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive, | |
1006 | const struct zip_stat *entry); | |
1007 | ||
1008 | /*--- analog.c --------------------------------------------------------------*/ | |
1009 | ||
1010 | SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog, | |
1011 | struct sr_analog_encoding *encoding, | |
1012 | struct sr_analog_meaning *meaning, | |
1013 | struct sr_analog_spec *spec, | |
1014 | int digits); | |
1015 | ||
1016 | /*--- std.c -----------------------------------------------------------------*/ | |
1017 | ||
1018 | typedef int (*dev_close_callback)(struct sr_dev_inst *sdi); | |
1019 | typedef void (*std_dev_clear_callback)(void *priv); | |
1020 | ||
1021 | SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx); | |
1022 | SR_PRIV int std_cleanup(const struct sr_dev_driver *di); | |
1023 | SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi); | |
1024 | SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi); | |
1025 | SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi); | |
1026 | SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi); | |
1027 | #ifdef HAVE_SERIAL_COMM | |
1028 | SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi); | |
1029 | SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi); | |
1030 | #endif | |
1031 | SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi); | |
1032 | SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi); | |
1033 | SR_PRIV int std_session_send_frame_begin(const struct sr_dev_inst *sdi); | |
1034 | SR_PRIV int std_session_send_frame_end(const struct sr_dev_inst *sdi); | |
1035 | SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver, | |
1036 | std_dev_clear_callback clear_private); | |
1037 | SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver); | |
1038 | SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di); | |
1039 | SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi); | |
1040 | SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices); | |
1041 | ||
1042 | SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data, | |
1043 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg, | |
1044 | const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[], | |
1045 | size_t drvsize, const uint32_t devopts[], size_t devsize); | |
1046 | ||
1047 | extern SR_PRIV const uint32_t NO_OPTS[1]; | |
1048 | ||
1049 | #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \ | |
1050 | std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \ | |
1051 | ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts)) | |
1052 | ||
1053 | SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n); | |
1054 | SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n); | |
1055 | SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n); | |
1056 | SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n); | |
1057 | SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step); | |
1058 | SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]); | |
1059 | SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep); | |
1060 | ||
1061 | SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high); | |
1062 | SR_PRIV GVariant *std_gvar_tuple_double(double low, double high); | |
1063 | ||
1064 | SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n); | |
1065 | SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n); | |
1066 | SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n); | |
1067 | SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n); | |
1068 | ||
1069 | SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n); | |
1070 | ||
1071 | SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n); | |
1072 | SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n); | |
1073 | SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n); | |
1074 | ||
1075 | SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n); | |
1076 | SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n); | |
1077 | ||
1078 | SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n); | |
1079 | SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n); | |
1080 | SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n); | |
1081 | ||
1082 | SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n); | |
1083 | ||
1084 | SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial, | |
1085 | int baudrate, int bits, int parity, int stopbits, | |
1086 | int flowcontrol, int rts, int dtr); | |
1087 | ||
1088 | /*--- resource.c ------------------------------------------------------------*/ | |
1089 | ||
1090 | SR_PRIV int64_t sr_file_get_size(FILE *file); | |
1091 | ||
1092 | SR_PRIV int sr_resource_open(struct sr_context *ctx, | |
1093 | struct sr_resource *res, int type, const char *name) | |
1094 | G_GNUC_WARN_UNUSED_RESULT; | |
1095 | SR_PRIV int sr_resource_close(struct sr_context *ctx, | |
1096 | struct sr_resource *res); | |
1097 | SR_PRIV gssize sr_resource_read(struct sr_context *ctx, | |
1098 | const struct sr_resource *res, void *buf, size_t count) | |
1099 | G_GNUC_WARN_UNUSED_RESULT; | |
1100 | SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type, | |
1101 | const char *name, size_t *size, size_t max_size) | |
1102 | G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT; | |
1103 | ||
1104 | /*--- strutil.c -------------------------------------------------------------*/ | |
1105 | ||
1106 | SR_PRIV int sr_atol(const char *str, long *ret); | |
1107 | SR_PRIV int sr_atoi(const char *str, int *ret); | |
1108 | SR_PRIV int sr_atod(const char *str, double *ret); | |
1109 | SR_PRIV int sr_atof(const char *str, float *ret); | |
1110 | SR_PRIV int sr_atod_ascii(const char *str, double *ret); | |
1111 | SR_PRIV int sr_atof_ascii(const char *str, float *ret); | |
1112 | ||
1113 | SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len); | |
1114 | SR_PRIV void sr_hexdump_free(GString *s); | |
1115 | ||
1116 | /*--- soft-trigger.c --------------------------------------------------------*/ | |
1117 | ||
1118 | struct soft_trigger_logic { | |
1119 | const struct sr_dev_inst *sdi; | |
1120 | const struct sr_trigger *trigger; | |
1121 | int count; | |
1122 | int unitsize; | |
1123 | int cur_stage; | |
1124 | uint8_t *prev_sample; | |
1125 | uint8_t *pre_trigger_buffer; | |
1126 | uint8_t *pre_trigger_head; | |
1127 | int pre_trigger_size; | |
1128 | int pre_trigger_fill; | |
1129 | }; | |
1130 | ||
1131 | SR_PRIV int logic_channel_unitsize(GSList *channels); | |
1132 | SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new( | |
1133 | const struct sr_dev_inst *sdi, struct sr_trigger *trigger, | |
1134 | int pre_trigger_samples); | |
1135 | SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st); | |
1136 | SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf, | |
1137 | int len, int *pre_trigger_samples); | |
1138 | ||
1139 | /*--- serial.c --------------------------------------------------------------*/ | |
1140 | ||
1141 | #ifdef HAVE_SERIAL_COMM | |
1142 | enum { | |
1143 | SERIAL_RDWR = 1, | |
1144 | SERIAL_RDONLY = 2, | |
1145 | }; | |
1146 | ||
1147 | typedef gboolean (*packet_valid_callback)(const uint8_t *buf); | |
1148 | ||
1149 | typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name, | |
1150 | const char *desc); | |
1151 | typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name); | |
1152 | ||
1153 | SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags); | |
1154 | SR_PRIV int serial_close(struct sr_serial_dev_inst *serial); | |
1155 | SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial); | |
1156 | SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial); | |
1157 | SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial); | |
1158 | SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial, | |
1159 | const void *buf, size_t count, unsigned int timeout_ms); | |
1160 | SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial, | |
1161 | const void *buf, size_t count); | |
1162 | SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf, | |
1163 | size_t count, unsigned int timeout_ms); | |
1164 | SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf, | |
1165 | size_t count); | |
1166 | SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial, | |
1167 | serial_rx_chunk_callback cb, void *cb_data); | |
1168 | SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate, | |
1169 | int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr); | |
1170 | SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial, | |
1171 | const char *paramstr); | |
1172 | SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf, | |
1173 | int *buflen, gint64 timeout_ms); | |
1174 | SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial, | |
1175 | uint8_t *buf, size_t *buflen, | |
1176 | size_t packet_size, | |
1177 | packet_valid_callback is_valid, | |
1178 | uint64_t timeout_ms); | |
1179 | SR_PRIV int sr_serial_extract_options(GSList *options, const char **serial_device, | |
1180 | const char **serial_options); | |
1181 | SR_PRIV int serial_source_add(struct sr_session *session, | |
1182 | struct sr_serial_dev_inst *serial, int events, int timeout, | |
1183 | sr_receive_data_callback cb, void *cb_data); | |
1184 | SR_PRIV int serial_source_remove(struct sr_session *session, | |
1185 | struct sr_serial_dev_inst *serial); | |
1186 | SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id); | |
1187 | SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes); | |
1188 | ||
1189 | SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial); | |
1190 | SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial); | |
1191 | SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial, | |
1192 | const uint8_t *data, size_t len); | |
1193 | SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial, | |
1194 | uint8_t *data, size_t len); | |
1195 | ||
1196 | struct ser_lib_functions { | |
1197 | int (*open)(struct sr_serial_dev_inst *serial, int flags); | |
1198 | int (*close)(struct sr_serial_dev_inst *serial); | |
1199 | int (*flush)(struct sr_serial_dev_inst *serial); | |
1200 | int (*drain)(struct sr_serial_dev_inst *serial); | |
1201 | int (*write)(struct sr_serial_dev_inst *serial, | |
1202 | const void *buf, size_t count, | |
1203 | int nonblocking, unsigned int timeout_ms); | |
1204 | int (*read)(struct sr_serial_dev_inst *serial, | |
1205 | void *buf, size_t count, | |
1206 | int nonblocking, unsigned int timeout_ms); | |
1207 | int (*set_params)(struct sr_serial_dev_inst *serial, | |
1208 | int baudrate, int bits, int parity, int stopbits, | |
1209 | int flowcontrol, int rts, int dtr); | |
1210 | int (*setup_source_add)(struct sr_session *session, | |
1211 | struct sr_serial_dev_inst *serial, | |
1212 | int events, int timeout, | |
1213 | sr_receive_data_callback cb, void *cb_data); | |
1214 | int (*setup_source_remove)(struct sr_session *session, | |
1215 | struct sr_serial_dev_inst *serial); | |
1216 | GSList *(*list)(GSList *list, sr_ser_list_append_t append); | |
1217 | GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append, | |
1218 | uint16_t vendor_id, uint16_t product_id); | |
1219 | int (*get_frame_format)(struct sr_serial_dev_inst *serial, | |
1220 | int *baud, int *bits); | |
1221 | size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial); | |
1222 | }; | |
1223 | extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp; | |
1224 | SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial); | |
1225 | extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid; | |
1226 | SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial); | |
1227 | extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt; | |
1228 | ||
1229 | #ifdef HAVE_LIBHIDAPI | |
1230 | struct vid_pid_item { | |
1231 | uint16_t vid, pid; | |
1232 | }; | |
1233 | ||
1234 | struct ser_hid_chip_functions { | |
1235 | const char *chipname; | |
1236 | const char *chipdesc; | |
1237 | const struct vid_pid_item *vid_pid_items; | |
1238 | const int max_bytes_per_request; | |
1239 | int (*set_params)(struct sr_serial_dev_inst *serial, | |
1240 | int baudrate, int bits, int parity, int stopbits, | |
1241 | int flowcontrol, int rts, int dtr); | |
1242 | int (*read_bytes)(struct sr_serial_dev_inst *serial, | |
1243 | uint8_t *data, int space, unsigned int timeout); | |
1244 | int (*write_bytes)(struct sr_serial_dev_inst *serial, | |
1245 | const uint8_t *data, int space); | |
1246 | int (*flush)(struct sr_serial_dev_inst *serial); | |
1247 | int (*drain)(struct sr_serial_dev_inst *serial); | |
1248 | }; | |
1249 | extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x; | |
1250 | extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325; | |
1251 | extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110; | |
1252 | extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor; | |
1253 | SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid); | |
1254 | #endif | |
1255 | #endif | |
1256 | ||
1257 | /*--- bt/ API ---------------------------------------------------------------*/ | |
1258 | ||
1259 | #ifdef HAVE_BLUETOOTH | |
1260 | SR_PRIV const char *sr_bt_adapter_get_address(size_t idx); | |
1261 | ||
1262 | struct sr_bt_desc; | |
1263 | typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name); | |
1264 | typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen); | |
1265 | ||
1266 | SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void); | |
1267 | SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc); | |
1268 | ||
1269 | SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc, | |
1270 | sr_bt_scan_cb cb, void *cb_data); | |
1271 | SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc, | |
1272 | sr_bt_data_cb cb, void *cb_data); | |
1273 | SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr); | |
1274 | SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr); | |
1275 | SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel); | |
1276 | SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc, | |
1277 | uint16_t read_handle, uint16_t write_handle, | |
1278 | uint16_t cccd_handle, uint16_t cccd_value); | |
1279 | ||
1280 | SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration); | |
1281 | SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration); | |
1282 | ||
1283 | SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc); | |
1284 | SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc); | |
1285 | SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc); | |
1286 | ||
1287 | SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc, | |
1288 | void *data, size_t len); | |
1289 | SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc, | |
1290 | const void *data, size_t len); | |
1291 | ||
1292 | SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc); | |
1293 | SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc); | |
1294 | #endif | |
1295 | ||
1296 | /*--- ezusb.c ---------------------------------------------------------------*/ | |
1297 | ||
1298 | #ifdef HAVE_LIBUSB_1_0 | |
1299 | SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear); | |
1300 | SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl, | |
1301 | const char *name); | |
1302 | SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev, | |
1303 | int configuration, const char *name); | |
1304 | #endif | |
1305 | ||
1306 | /*--- usb.c -----------------------------------------------------------------*/ | |
1307 | ||
1308 | #ifdef HAVE_LIBUSB_1_0 | |
1309 | SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn); | |
1310 | SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb); | |
1311 | SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb); | |
1312 | SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx, | |
1313 | int timeout, sr_receive_data_callback cb, void *cb_data); | |
1314 | SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx); | |
1315 | SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len); | |
1316 | SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev, | |
1317 | const char *manufacturer, const char *product); | |
1318 | #endif | |
1319 | ||
1320 | ||
1321 | /*--- modbus/modbus.c -------------------------------------------------------*/ | |
1322 | ||
1323 | struct sr_modbus_dev_inst { | |
1324 | const char *name; | |
1325 | const char *prefix; | |
1326 | int priv_size; | |
1327 | GSList *(*scan)(int modbusaddr); | |
1328 | int (*dev_inst_new)(void *priv, const char *resource, | |
1329 | char **params, const char *serialcomm, int modbusaddr); | |
1330 | int (*open)(void *priv); | |
1331 | int (*source_add)(struct sr_session *session, void *priv, int events, | |
1332 | int timeout, sr_receive_data_callback cb, void *cb_data); | |
1333 | int (*source_remove)(struct sr_session *session, void *priv); | |
1334 | int (*send)(void *priv, const uint8_t *buffer, int buffer_size); | |
1335 | int (*read_begin)(void *priv, uint8_t *function_code); | |
1336 | int (*read_data)(void *priv, uint8_t *buf, int maxlen); | |
1337 | int (*read_end)(void *priv); | |
1338 | int (*close)(void *priv); | |
1339 | void (*free)(void *priv); | |
1340 | unsigned int read_timeout_ms; | |
1341 | void *priv; | |
1342 | }; | |
1343 | ||
1344 | SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options, | |
1345 | struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus)); | |
1346 | SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource, | |
1347 | const char *serialcomm, int modbusaddr); | |
1348 | SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus); | |
1349 | SR_PRIV int sr_modbus_source_add(struct sr_session *session, | |
1350 | struct sr_modbus_dev_inst *modbus, int events, int timeout, | |
1351 | sr_receive_data_callback cb, void *cb_data); | |
1352 | SR_PRIV int sr_modbus_source_remove(struct sr_session *session, | |
1353 | struct sr_modbus_dev_inst *modbus); | |
1354 | SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus, | |
1355 | uint8_t *request, int request_size); | |
1356 | SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus, | |
1357 | uint8_t *reply, int reply_size); | |
1358 | SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus, | |
1359 | uint8_t *request, int request_size, | |
1360 | uint8_t *reply, int reply_size); | |
1361 | SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus, | |
1362 | int address, int nb_coils, uint8_t *coils); | |
1363 | SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus, | |
1364 | int address, int nb_registers, | |
1365 | uint16_t *registers); | |
1366 | SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus, | |
1367 | int address, int value); | |
1368 | SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus, | |
1369 | int address, int nb_registers, | |
1370 | uint16_t *registers); | |
1371 | SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus); | |
1372 | SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus); | |
1373 | ||
1374 | /*--- dmm/es519xx.c ---------------------------------------------------------*/ | |
1375 | ||
1376 | /** | |
1377 | * All 11-byte es519xx chips repeat each block twice for each conversion cycle | |
1378 | * so always read 2 blocks at a time. | |
1379 | */ | |
1380 | #define ES519XX_11B_PACKET_SIZE (11 * 2) | |
1381 | #define ES519XX_14B_PACKET_SIZE 14 | |
1382 | ||
1383 | struct es519xx_info { | |
1384 | gboolean is_judge, is_voltage, is_auto, is_micro, is_current; | |
1385 | gboolean is_milli, is_resistance, is_continuity, is_diode; | |
1386 | gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle; | |
1387 | gboolean is_temperature, is_celsius, is_fahrenheit; | |
1388 | gboolean is_adp0, is_adp1, is_adp2, is_adp3; | |
1389 | gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo; | |
1390 | gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold; | |
1391 | gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr; | |
1392 | uint32_t baudrate; | |
1393 | int packet_size; | |
1394 | gboolean alt_functions, fivedigits, clampmeter, selectable_lpf; | |
1395 | int digits; | |
1396 | }; | |
1397 | ||
1398 | SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf); | |
1399 | SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval, | |
1400 | struct sr_datafeed_analog *analog, void *info); | |
1401 | SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf); | |
1402 | SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf, | |
1403 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
1404 | SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf); | |
1405 | SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf, | |
1406 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
1407 | SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf); | |
1408 | SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf, | |
1409 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
1410 | SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf); | |
1411 | SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval, | |
1412 | struct sr_datafeed_analog *analog, void *info); | |
1413 | SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf); | |
1414 | SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval, | |
1415 | struct sr_datafeed_analog *analog, void *info); | |
1416 | SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf); | |
1417 | SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf, | |
1418 | float *floatval, struct sr_datafeed_analog *analog, void *info); | |
1419 | ||
1420 | /*--- dmm/fs9922.c ----------------------------------------------------------*/ | |
1421 | ||
1422 | #define FS9922_PACKET_SIZE 14 | |
1423 | ||
1424 | struct fs9922_info { | |
1425 | gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2; | |
1426 | gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro; | |
1427 | gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent; | |
1428 | gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad; | |
1429 | gboolean is_celsius, is_fahrenheit; | |
1430 | int bargraph_sign, bargraph_value; | |
1431 | }; | |
1432 | ||
1433 | SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf); | |
1434 | SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval, | |
1435 | struct sr_datafeed_analog *analog, void *info); | |
1436 | SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info); | |
1437 | ||
1438 | /*--- dmm/fs9721.c ----------------------------------------------------------*/ | |
1439 | ||
1440 | #define FS9721_PACKET_SIZE 14 | |
1441 | ||
1442 | struct fs9721_info { | |
1443 | gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo; | |
1444 | gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad; | |
1445 | gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat; | |
1446 | gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign; | |
1447 | }; | |
1448 | ||
1449 | SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf); | |
1450 | SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval, | |
1451 | struct sr_datafeed_analog *analog, void *info); | |
1452 | SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info); | |
1453 | SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info); | |
1454 | SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info); | |
1455 | SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info); | |
1456 | SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info); | |
1457 | ||
1458 | /*--- dmm/ms2115b.c ---------------------------------------------------------*/ | |
1459 | ||
1460 | #define MS2115B_PACKET_SIZE 9 | |
1461 | ||
1462 | enum ms2115b_display { | |
1463 | MS2115B_DISPLAY_MAIN, | |
1464 | MS2115B_DISPLAY_SUB, | |
1465 | MS2115B_DISPLAY_COUNT, | |
1466 | }; | |
1467 | ||
1468 | struct ms2115b_info { | |
1469 | /* Selected channel. */ | |
1470 | size_t ch_idx; | |
1471 | gboolean is_ac, is_dc, is_auto; | |
1472 | gboolean is_diode, is_beep, is_farad; | |
1473 | gboolean is_ohm, is_ampere, is_volt, is_hz; | |
1474 | gboolean is_duty_cycle, is_percent; | |
1475 | }; | |
1476 | ||
1477 | extern SR_PRIV const char *ms2115b_channel_formats[]; | |
1478 | SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf); | |
1479 | SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval, | |
1480 | struct sr_datafeed_analog *analog, void *info); | |
1481 | ||
1482 | /*--- dmm/ms8250d.c ---------------------------------------------------------*/ | |
1483 | ||
1484 | #define MS8250D_PACKET_SIZE 18 | |
1485 | ||
1486 | struct ms8250d_info { | |
1487 | gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo; | |
1488 | gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad; | |
1489 | gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat; | |
1490 | gboolean is_ncv, is_min, is_max, is_sign, is_autotimer; | |
1491 | }; | |
1492 | ||
1493 | SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf); | |
1494 | SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval, | |
1495 | struct sr_datafeed_analog *analog, void *info); | |
1496 | ||
1497 | /*--- dmm/dtm0660.c ---------------------------------------------------------*/ | |
1498 | ||
1499 | #define DTM0660_PACKET_SIZE 15 | |
1500 | ||
1501 | struct dtm0660_info { | |
1502 | gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo; | |
1503 | gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad; | |
1504 | gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat; | |
1505 | gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min; | |
1506 | gboolean is_minmax, is_max, is_sign; | |
1507 | }; | |
1508 | ||
1509 | SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf); | |
1510 | SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval, | |
1511 | struct sr_datafeed_analog *analog, void *info); | |
1512 | ||
1513 | /*--- dmm/m2110.c -----------------------------------------------------------*/ | |
1514 | ||
1515 | #define BBCGM_M2110_PACKET_SIZE 9 | |
1516 | ||
1517 | /* Dummy info struct. The parser does not use it. */ | |
1518 | struct m2110_info { int dummy; }; | |
1519 | ||
1520 | SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf); | |
1521 | SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval, | |
1522 | struct sr_datafeed_analog *analog, void *info); | |
1523 | ||
1524 | /*--- dmm/metex14.c ---------------------------------------------------------*/ | |
1525 | ||
1526 | #define METEX14_PACKET_SIZE 14 | |
1527 | ||
1528 | struct metex14_info { | |
1529 | size_t ch_idx; | |
1530 | gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature; | |
1531 | gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad; | |
1532 | gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt; | |
1533 | gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega; | |
1534 | gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor; | |
1535 | gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg; | |
1536 | }; | |
1537 | ||
1538 | #ifdef HAVE_SERIAL_COMM | |
1539 | SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial); | |
1540 | #endif | |
1541 | SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf); | |
1542 | SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval, | |
1543 | struct sr_datafeed_analog *analog, void *info); | |
1544 | SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf); | |
1545 | SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval, | |
1546 | struct sr_datafeed_analog *analog, void *info); | |
1547 | ||
1548 | /*--- dmm/rs9lcd.c ----------------------------------------------------------*/ | |
1549 | ||
1550 | #define RS9LCD_PACKET_SIZE 9 | |
1551 | ||
1552 | /* Dummy info struct. The parser does not use it. */ | |
1553 | struct rs9lcd_info { int dummy; }; | |
1554 | ||
1555 | SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf); | |
1556 | SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval, | |
1557 | struct sr_datafeed_analog *analog, void *info); | |
1558 | ||
1559 | /*--- dmm/bm25x.c -----------------------------------------------------------*/ | |
1560 | ||
1561 | #define BRYMEN_BM25X_PACKET_SIZE 15 | |
1562 | ||
1563 | /* Dummy info struct. The parser does not use it. */ | |
1564 | struct bm25x_info { int dummy; }; | |
1565 | ||
1566 | SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf); | |
1567 | SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval, | |
1568 | struct sr_datafeed_analog *analog, void *info); | |
1569 | ||
1570 | /*--- dmm/bm86x.c -----------------------------------------------------------*/ | |
1571 | ||
1572 | #define BRYMEN_BM86X_PACKET_SIZE 24 | |
1573 | #define BRYMEN_BM86X_DISPLAY_COUNT 2 | |
1574 | ||
1575 | struct brymen_bm86x_info { size_t ch_idx; }; | |
1576 | ||
1577 | #ifdef HAVE_SERIAL_COMM | |
1578 | SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial); | |
1579 | #endif | |
1580 | SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf); | |
1581 | SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval, | |
1582 | struct sr_datafeed_analog *analog, void *info); | |
1583 | ||
1584 | /*--- dmm/ut71x.c -----------------------------------------------------------*/ | |
1585 | ||
1586 | #define UT71X_PACKET_SIZE 11 | |
1587 | ||
1588 | struct ut71x_info { | |
1589 | gboolean is_voltage, is_resistance, is_capacitance, is_temperature; | |
1590 | gboolean is_celsius, is_fahrenheit, is_current, is_continuity; | |
1591 | gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac; | |
1592 | gboolean is_auto, is_manual, is_sign, is_power, is_loop_current; | |
1593 | }; | |
1594 | ||
1595 | SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf); | |
1596 | SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval, | |
1597 | struct sr_datafeed_analog *analog, void *info); | |
1598 | ||
1599 | /*--- dmm/vc870.c -----------------------------------------------------------*/ | |
1600 | ||
1601 | #define VC870_PACKET_SIZE 23 | |
1602 | ||
1603 | struct vc870_info { | |
1604 | gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance; | |
1605 | gboolean is_continuity, is_capacitance, is_diode, is_loop_current; | |
1606 | gboolean is_current, is_micro, is_milli, is_power; | |
1607 | gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value; | |
1608 | gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min; | |
1609 | gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold; | |
1610 | gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn; | |
1611 | gboolean is_lo, is_hi, is_open2; | |
1612 | ||
1613 | gboolean is_frequency, is_dual_display, is_auto; | |
1614 | }; | |
1615 | ||
1616 | SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf); | |
1617 | SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval, | |
1618 | struct sr_datafeed_analog *analog, void *info); | |
1619 | ||
1620 | /*--- dmm/vc96.c ------------------------------------------------------------*/ | |
1621 | ||
1622 | #define VC96_PACKET_SIZE 13 | |
1623 | ||
1624 | struct vc96_info { | |
1625 | size_t ch_idx; | |
1626 | gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt; | |
1627 | gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe; | |
1628 | gboolean is_unitless; | |
1629 | }; | |
1630 | ||
1631 | SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf); | |
1632 | SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval, | |
1633 | struct sr_datafeed_analog *analog, void *info); | |
1634 | ||
1635 | /*--- lcr/es51919.c ---------------------------------------------------------*/ | |
1636 | ||
1637 | /* Acquisition details which apply to all supported serial-lcr devices. */ | |
1638 | struct lcr_parse_info { | |
1639 | size_t ch_idx; | |
1640 | uint64_t output_freq; | |
1641 | const char *circuit_model; | |
1642 | }; | |
1643 | ||
1644 | #define ES51919_PACKET_SIZE 17 | |
1645 | #define ES51919_CHANNEL_COUNT 2 | |
1646 | #define ES51919_COMM_PARAM "9600/8n1/rts=1/dtr=1" | |
1647 | ||
1648 | SR_PRIV int es51919_config_get(uint32_t key, GVariant **data, | |
1649 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg); | |
1650 | SR_PRIV int es51919_config_set(uint32_t key, GVariant *data, | |
1651 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg); | |
1652 | SR_PRIV int es51919_config_list(uint32_t key, GVariant **data, | |
1653 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg); | |
1654 | SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt); | |
1655 | SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval, | |
1656 | struct sr_datafeed_analog *analog, void *info); | |
1657 | ||
1658 | /*--- lcr/vc4080.c ----------------------------------------------------------*/ | |
1659 | ||
1660 | /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */ | |
1661 | ||
1662 | #define VC4080_PACKET_SIZE 39 | |
1663 | #define VC4080_COMM_PARAM "1200/8n1" | |
1664 | #define VC4080_WITH_DQ_CHANS 0 /* Enable separate D/Q channels? */ | |
1665 | ||
1666 | enum vc4080_display { | |
1667 | VC4080_DISPLAY_PRIMARY, | |
1668 | VC4080_DISPLAY_SECONDARY, | |
1669 | #if VC4080_WITH_DQ_CHANS | |
1670 | VC4080_DISPLAY_D_VALUE, | |
1671 | VC4080_DISPLAY_Q_VALUE, | |
1672 | #endif | |
1673 | VC4080_CHANNEL_COUNT, | |
1674 | }; | |
1675 | ||
1676 | extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT]; | |
1677 | ||
1678 | SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data, | |
1679 | const struct sr_dev_inst *sdi, const struct sr_channel_group *cg); | |
1680 | SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial); | |
1681 | SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt); | |
1682 | SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval, | |
1683 | struct sr_datafeed_analog *analog, void *info); | |
1684 | ||
1685 | /*--- dmm/ut372.c -----------------------------------------------------------*/ | |
1686 | ||
1687 | #define UT372_PACKET_SIZE 27 | |
1688 | ||
1689 | struct ut372_info { | |
1690 | int dummy; | |
1691 | }; | |
1692 | ||
1693 | SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf); | |
1694 | SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval, | |
1695 | struct sr_datafeed_analog *analog, void *info); | |
1696 | ||
1697 | /*--- dmm/asycii.c ----------------------------------------------------------*/ | |
1698 | ||
1699 | #define ASYCII_PACKET_SIZE 16 | |
1700 | ||
1701 | struct asycii_info { | |
1702 | gboolean is_ac, is_dc, is_ac_and_dc; | |
1703 | gboolean is_resistance, is_capacitance, is_diode, is_gain; | |
1704 | gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg; | |
1705 | gboolean is_pulse_width, is_period_pos, is_period_neg; | |
1706 | gboolean is_pulse_count, is_count_pos, is_count_neg; | |
1707 | gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm; | |
1708 | gboolean is_hertz, is_percent, is_seconds, is_decibel; | |
1709 | gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega; | |
1710 | gboolean is_unitless; | |
1711 | gboolean is_peak_min, is_peak_max; | |
1712 | gboolean is_invalid; | |
1713 | }; | |
1714 | ||
1715 | #ifdef HAVE_SERIAL_COMM | |
1716 | SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial); | |
1717 | #endif | |
1718 | SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf); | |
1719 | SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval, | |
1720 | struct sr_datafeed_analog *analog, void *info); | |
1721 | ||
1722 | /*--- dmm/eev121gw.c --------------------------------------------------------*/ | |
1723 | ||
1724 | #define EEV121GW_PACKET_SIZE 19 | |
1725 | ||
1726 | enum eev121gw_display { | |
1727 | EEV121GW_DISPLAY_MAIN, | |
1728 | EEV121GW_DISPLAY_SUB, | |
1729 | EEV121GW_DISPLAY_BAR, | |
1730 | EEV121GW_DISPLAY_COUNT, | |
1731 | }; | |
1732 | ||
1733 | struct eev121gw_info { | |
1734 | /* Selected channel. */ | |
1735 | size_t ch_idx; | |
1736 | /* | |
1737 | * Measured value, number and sign/overflow flags, scale factor | |
1738 | * and significant digits. | |
1739 | */ | |
1740 | uint32_t uint_value; | |
1741 | gboolean is_ofl, is_neg; | |
1742 | int factor, digits; | |
1743 | /* Currently active mode (meter's function). */ | |
1744 | gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain; | |
1745 | gboolean is_resistance, is_capacitance, is_diode, is_temperature; | |
1746 | gboolean is_continuity, is_frequency, is_period, is_duty_cycle; | |
1747 | /* Quantities associated with mode/function. */ | |
1748 | gboolean is_ampere, is_volt, is_volt_ampere, is_dbm; | |
1749 | gboolean is_ohm, is_farad, is_celsius, is_fahrenheit; | |
1750 | gboolean is_hertz, is_seconds, is_percent, is_loop_current; | |
1751 | gboolean is_unitless, is_logic; | |
1752 | /* Other indicators. */ | |
1753 | gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold; | |
1754 | gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test; | |
1755 | gboolean is_auto_poweroff, is_low_batt; | |
1756 | }; | |
1757 | ||
1758 | extern SR_PRIV const char *eev121gw_channel_formats[]; | |
1759 | SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf); | |
1760 | SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval, | |
1761 | struct sr_datafeed_analog *analog, void *info); | |
1762 | ||
1763 | /*--- scale/kern.c ----------------------------------------------------------*/ | |
1764 | ||
1765 | struct kern_info { | |
1766 | gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce; | |
1767 | gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola; | |
1768 | gboolean is_percentage, is_piece, is_unstable, is_stable, is_error; | |
1769 | int buflen; | |
1770 | }; | |
1771 | ||
1772 | SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf); | |
1773 | SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval, | |
1774 | struct sr_datafeed_analog *analog, void *info); | |
1775 | ||
1776 | /*--- sw_limits.c -----------------------------------------------------------*/ | |
1777 | ||
1778 | struct sr_sw_limits { | |
1779 | uint64_t limit_samples; | |
1780 | uint64_t limit_frames; | |
1781 | uint64_t limit_msec; | |
1782 | uint64_t samples_read; | |
1783 | uint64_t frames_read; | |
1784 | uint64_t start_time; | |
1785 | }; | |
1786 | ||
1787 | SR_PRIV int sr_sw_limits_config_get(struct sr_sw_limits *limits, uint32_t key, | |
1788 | GVariant **data); | |
1789 | SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key, | |
1790 | GVariant *data); | |
1791 | SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits); | |
1792 | SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits); | |
1793 | SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits, | |
1794 | uint64_t samples_read); | |
1795 | SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits, | |
1796 | uint64_t frames_read); | |
1797 | SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits); | |
1798 | ||
1799 | #endif |