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