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