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