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