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