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