]> sigrok.org Git - libsigrok.git/blob - src/libsigrok-internal.h
output/csv: use intermediate time_t var, silence compiler warning
[libsigrok.git] / src / libsigrok-internal.h
1 /*
2  * This file is part of the libsigrok project.
3  *
4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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
20 #ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
21 #define LIBSIGROK_LIBSIGROK_INTERNAL_H
22
23 #include "config.h"
24
25 #include <glib.h>
26 #ifdef HAVE_LIBHIDAPI
27 #include <hidapi.h>
28 #endif
29 #ifdef HAVE_LIBSERIALPORT
30 #include <libserialport.h>
31 #endif
32 #ifdef HAVE_LIBUSB_1_0
33 #include <libusb.h>
34 #endif
35 #ifdef HAVE_LIBFTDI
36 #include <ftdi.h>
37 #endif
38 #include <stdarg.h>
39 #include <stdint.h>
40 #include <stdio.h>
41 #include <stdlib.h>
42
43 struct zip;
44 struct zip_stat;
45
46 /**
47  * @file
48  *
49  * libsigrok private header file, only to be used internally.
50  */
51
52 /*--- Macros ----------------------------------------------------------------*/
53
54 #ifndef ARRAY_SIZE
55 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
56 #endif
57
58 #ifndef ARRAY_AND_SIZE
59 #define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
60 #endif
61
62 #ifndef G_SOURCE_FUNC
63 #define G_SOURCE_FUNC(f) ((GSourceFunc) (void (*)(void)) (f)) /* Since 2.58. */
64 #endif
65
66 #define SR_RECEIVE_DATA_CALLBACK(f) \
67         ((sr_receive_data_callback) (void (*)(void)) (f))
68
69 /**
70  * Read a 8 bits unsigned integer out of memory.
71  * @param x a pointer to the input memory
72  * @return the corresponding unsigned integer
73  */
74 static inline uint8_t read_u8(const uint8_t *p)
75 {
76         return p[0];
77 }
78 #define R8(x)   read_u8((const uint8_t *)(x))
79
80 /**
81  * Read an 8 bits signed integer out of memory.
82  * @param x a pointer to the input memory
83  * @return the corresponding signed integer
84  */
85 static inline int8_t read_i8(const uint8_t *p)
86 {
87         return (int8_t)p[0];
88 }
89
90 /**
91  * Read a 16 bits big endian unsigned integer out of memory.
92  * @param x a pointer to the input memory
93  * @return the corresponding unsigned integer
94  */
95 static inline uint16_t read_u16be(const uint8_t *p)
96 {
97         uint16_t u;
98
99         u = 0;
100         u <<= 8; u |= p[0];
101         u <<= 8; u |= p[1];
102
103         return u;
104 }
105 #define RB16(x) read_u16be((const uint8_t *)(x))
106
107 /**
108  * Read a 16 bits little endian unsigned integer out of memory.
109  * @param x a pointer to the input memory
110  * @return the corresponding unsigned integer
111  */
112 static inline uint16_t read_u16le(const uint8_t *p)
113 {
114         uint16_t u;
115
116         u = 0;
117         u <<= 8; u |= p[1];
118         u <<= 8; u |= p[0];
119
120         return u;
121 }
122 #define RL16(x) read_u16le((const uint8_t *)(x))
123
124 /**
125  * Read a 16 bits big endian signed integer out of memory.
126  * @param x a pointer to the input memory
127  * @return the corresponding signed integer
128  */
129 static inline int16_t read_i16be(const uint8_t *p)
130 {
131         uint16_t u;
132         int16_t i;
133
134         u = read_u16be(p);
135         i = (int16_t)u;
136
137         return i;
138 }
139 #define RB16S(x) read_i16be((const uint8_t *)(x))
140
141 /**
142  * Read a 16 bits little endian signed integer out of memory.
143  * @param x a pointer to the input memory
144  * @return the corresponding signed integer
145  */
146 static inline int16_t read_i16le(const uint8_t *p)
147 {
148         uint16_t u;
149         int16_t i;
150
151         u = read_u16le(p);
152         i = (int16_t)u;
153
154         return i;
155 }
156 #define RL16S(x) read_i16le((const uint8_t *)(x))
157
158 /**
159  * Read a 24 bits little endian unsigned integer out of memory.
160  * @param x a pointer to the input memory
161  * @return the corresponding unsigned integer
162  */
163 static inline uint32_t read_u24le(const uint8_t *p)
164 {
165         uint32_t u;
166
167         u = 0;
168         u <<= 8; u |= p[2];
169         u <<= 8; u |= p[1];
170         u <<= 8; u |= p[0];
171
172         return u;
173 }
174
175 /**
176  * Read a 24 bits big endian unsigned integer out of memory.
177  * @param x a pointer to the input memory
178  * @return the corresponding unsigned integer
179  */
180 static inline uint32_t read_u24be(const uint8_t *p)
181 {
182         uint32_t u;
183
184         u = 0;
185         u <<= 8; u |= p[0];
186         u <<= 8; u |= p[1];
187         u <<= 8; u |= p[2];
188
189         return u;
190 }
191
192 /**
193  * Read a 32 bits big endian unsigned integer out of memory.
194  * @param x a pointer to the input memory
195  * @return the corresponding unsigned integer
196  */
197 static inline uint32_t read_u32be(const uint8_t *p)
198 {
199         uint32_t u;
200
201         u = 0;
202         u <<= 8; u |= p[0];
203         u <<= 8; u |= p[1];
204         u <<= 8; u |= p[2];
205         u <<= 8; u |= p[3];
206
207         return u;
208 }
209 #define RB32(x) read_u32be((const uint8_t *)(x))
210
211 /**
212  * Read a 32 bits little endian unsigned integer out of memory.
213  * @param x a pointer to the input memory
214  * @return the corresponding unsigned integer
215  */
216 static inline uint32_t read_u32le(const uint8_t *p)
217 {
218         uint32_t u;
219
220         u = 0;
221         u <<= 8; u |= p[3];
222         u <<= 8; u |= p[2];
223         u <<= 8; u |= p[1];
224         u <<= 8; u |= p[0];
225
226         return u;
227 }
228 #define RL32(x) read_u32le((const uint8_t *)(x))
229
230 /**
231  * Read a 32 bits big endian signed integer out of memory.
232  * @param x a pointer to the input memory
233  * @return the corresponding signed integer
234  */
235 static inline int32_t read_i32be(const uint8_t *p)
236 {
237         uint32_t u;
238         int32_t i;
239
240         u = read_u32be(p);
241         i = (int32_t)u;
242
243         return i;
244 }
245 #define RB32S(x) read_i32be((const uint8_t *)(x))
246
247 /**
248  * Read a 32 bits little endian signed integer out of memory.
249  * @param x a pointer to the input memory
250  * @return the corresponding signed integer
251  */
252 static inline int32_t read_i32le(const uint8_t *p)
253 {
254         uint32_t u;
255         int32_t i;
256
257         u = read_u32le(p);
258         i = (int32_t)u;
259
260         return i;
261 }
262 #define RL32S(x) read_i32le((const uint8_t *)(x))
263
264 /**
265  * Read a 64 bits big endian unsigned integer out of memory.
266  * @param x a pointer to the input memory
267  * @return the corresponding unsigned integer
268  */
269 static inline uint64_t read_u64be(const uint8_t *p)
270 {
271         uint64_t u;
272
273         u = 0;
274         u <<= 8; u |= p[0];
275         u <<= 8; u |= p[1];
276         u <<= 8; u |= p[2];
277         u <<= 8; u |= p[3];
278         u <<= 8; u |= p[4];
279         u <<= 8; u |= p[5];
280         u <<= 8; u |= p[6];
281         u <<= 8; u |= p[7];
282
283         return u;
284 }
285 #define RB64(x) read_u64be((const uint8_t *)(x))
286
287 /**
288  * Read a 64 bits little endian unsigned integer out of memory.
289  * @param x a pointer to the input memory
290  * @return the corresponding unsigned integer
291  */
292 static inline uint64_t read_u64le(const uint8_t *p)
293 {
294         uint64_t u;
295
296         u = 0;
297         u <<= 8; u |= p[7];
298         u <<= 8; u |= p[6];
299         u <<= 8; u |= p[5];
300         u <<= 8; u |= p[4];
301         u <<= 8; u |= p[3];
302         u <<= 8; u |= p[2];
303         u <<= 8; u |= p[1];
304         u <<= 8; u |= p[0];
305
306         return u;
307 }
308 #define RL64(x) read_u64le((const uint8_t *)(x))
309
310 /**
311  * Read a 64 bits big endian signed integer out of memory.
312  * @param x a pointer to the input memory
313  * @return the corresponding unsigned integer
314  */
315 static inline int64_t read_i64be(const uint8_t *p)
316 {
317         uint64_t u;
318         int64_t i;
319
320         u = read_u64be(p);
321         i = (int64_t)u;
322
323         return i;
324 }
325 #define RB64S(x) read_i64be((const uint8_t *)(x))
326
327 /**
328  * Read a 64 bits little endian signed integer out of memory.
329  * @param x a pointer to the input memory
330  * @return the corresponding unsigned integer
331  */
332 static inline int64_t read_i64le(const uint8_t *p)
333 {
334         uint64_t u;
335         int64_t i;
336
337         u = read_u64le(p);
338         i = (int64_t)u;
339
340         return i;
341 }
342 #define RL64S(x) read_i64le((const uint8_t *)(x))
343
344 /**
345  * Read a 32 bits big endian float out of memory (single precision).
346  * @param x a pointer to the input memory
347  * @return the corresponding float
348  */
349 static inline float read_fltbe(const uint8_t *p)
350 {
351         /*
352          * Implementor's note: Strictly speaking the "union" trick
353          * is not portable. But this phrase was found to work on the
354          * project's supported platforms, and serve well until a more
355          * appropriate phrase is found.
356          */
357         union { uint32_t u32; float flt; } u;
358         float f;
359
360         u.u32 = read_u32be(p);
361         f = u.flt;
362
363         return f;
364 }
365 #define RBFL(x) read_fltbe((const uint8_t *)(x))
366
367 /**
368  * Read a 32 bits little endian float out of memory (single precision).
369  * @param x a pointer to the input memory
370  * @return the corresponding float
371  */
372 static inline float read_fltle(const uint8_t *p)
373 {
374         /*
375          * Implementor's note: Strictly speaking the "union" trick
376          * is not portable. But this phrase was found to work on the
377          * project's supported platforms, and serve well until a more
378          * appropriate phrase is found.
379          */
380         union { uint32_t u32; float flt; } u;
381         float f;
382
383         u.u32 = read_u32le(p);
384         f = u.flt;
385
386         return f;
387 }
388 #define RLFL(x) read_fltle((const uint8_t *)(x))
389
390 /**
391  * Read a 64 bits big endian float out of memory (double precision).
392  * @param x a pointer to the input memory
393  * @return the corresponding floating point value
394  */
395 static inline double read_dblbe(const uint8_t *p)
396 {
397         /*
398          * Implementor's note: Strictly speaking the "union" trick
399          * is not portable. But this phrase was found to work on the
400          * project's supported platforms, and serve well until a more
401          * appropriate phrase is found.
402          */
403         union { uint64_t u64; double flt; } u;
404         double f;
405
406         u.u64 = read_u64be(p);
407         f = u.flt;
408
409         return f;
410 }
411
412 /**
413  * Read a 64 bits little endian float out of memory (double precision).
414  * @param x a pointer to the input memory
415  * @return the corresponding floating point value
416  */
417 static inline double read_dblle(const uint8_t *p)
418 {
419         /*
420          * Implementor's note: Strictly speaking the "union" trick
421          * is not portable. But this phrase was found to work on the
422          * project's supported platforms, and serve well until a more
423          * appropriate phrase is found.
424          */
425         union { uint64_t u64; double flt; } u;
426         double f;
427
428         u.u64 = read_u64le(p);
429         f = u.flt;
430
431         return f;
432 }
433 #define RLDB(x) read_dblle((const uint8_t *)(x))
434
435 /**
436  * Write a 8 bits unsigned integer to memory.
437  * @param p a pointer to the output memory
438  * @param x the input unsigned integer
439  */
440 static inline void write_u8(uint8_t *p, uint8_t x)
441 {
442         p[0] = x;
443 }
444 #define W8(p, x) write_u8((uint8_t *)(p), (uint8_t)(x))
445
446 /**
447  * Write a 16 bits unsigned integer to memory stored as big endian.
448  * @param p a pointer to the output memory
449  * @param x the input unsigned integer
450  */
451 static inline void write_u16be(uint8_t *p, uint16_t x)
452 {
453         p[1] = x & 0xff; x >>= 8;
454         p[0] = x & 0xff; x >>= 8;
455 }
456 #define WB16(p, x) write_u16be((uint8_t *)(p), (uint16_t)(x))
457
458 /**
459  * Write a 16 bits unsigned integer to memory stored as little endian.
460  * @param p a pointer to the output memory
461  * @param x the input unsigned integer
462  */
463 static inline void write_u16le(uint8_t *p, uint16_t x)
464 {
465         p[0] = x & 0xff; x >>= 8;
466         p[1] = x & 0xff; x >>= 8;
467 }
468 #define WL16(p, x) write_u16le((uint8_t *)(p), (uint16_t)(x))
469
470 /**
471  * Write a 24 bits unsigned integer to memory stored as little endian.
472  * @param p a pointer to the output memory
473  * @param x the input unsigned integer
474  */
475 static inline void write_u24le(uint8_t *p, uint32_t x)
476 {
477         p[0] = x & 0xff; x >>= 8;
478         p[1] = x & 0xff; x >>= 8;
479         p[2] = x & 0xff; x >>= 8;
480 }
481 #define WL24(p, x) write_u24le((uint8_t *)(p), (uint32_t)(x))
482
483 /**
484  * Write a 32 bits unsigned integer to memory stored as big endian.
485  * @param p a pointer to the output memory
486  * @param x the input unsigned integer
487  */
488 static inline void write_u32be(uint8_t *p, uint32_t x)
489 {
490         p[3] = x & 0xff; x >>= 8;
491         p[2] = x & 0xff; x >>= 8;
492         p[1] = x & 0xff; x >>= 8;
493         p[0] = x & 0xff; x >>= 8;
494 }
495 #define WB32(p, x) write_u32be((uint8_t *)(p), (uint32_t)(x))
496
497 /**
498  * Write a 32 bits unsigned integer to memory stored as little endian.
499  * @param p a pointer to the output memory
500  * @param x the input unsigned integer
501  */
502 static inline void write_u32le(uint8_t *p, uint32_t x)
503 {
504         p[0] = x & 0xff; x >>= 8;
505         p[1] = x & 0xff; x >>= 8;
506         p[2] = x & 0xff; x >>= 8;
507         p[3] = x & 0xff; x >>= 8;
508 }
509 #define WL32(p, x) write_u32le((uint8_t *)(p), (uint32_t)(x))
510
511 /**
512  * Write a 40 bits unsigned integer to memory stored as little endian.
513  * @param p a pointer to the output memory
514  * @param x the input unsigned integer
515  */
516 static inline void write_u40le(uint8_t *p, uint64_t x)
517 {
518         p[0] = x & 0xff; x >>= 8;
519         p[1] = x & 0xff; x >>= 8;
520         p[2] = x & 0xff; x >>= 8;
521         p[3] = x & 0xff; x >>= 8;
522         p[4] = x & 0xff; x >>= 8;
523 }
524 #define WL40(p, x) write_u40le((uint8_t *)(p), (uint64_t)(x))
525
526 /**
527  * Write a 48 bits unsigned integer to memory stored as little endian.
528  * @param p a pointer to the output memory
529  * @param x the input unsigned integer
530  */
531 static inline void write_u48le(uint8_t *p, uint64_t x)
532 {
533         p[0] = x & 0xff; x >>= 8;
534         p[1] = x & 0xff; x >>= 8;
535         p[2] = x & 0xff; x >>= 8;
536         p[3] = x & 0xff; x >>= 8;
537         p[4] = x & 0xff; x >>= 8;
538         p[5] = x & 0xff; x >>= 8;
539 }
540 #define WL48(p, x) write_u48le((uint8_t *)(p), (uint64_t)(x))
541
542 /**
543  * Write a 64 bits unsigned integer to memory stored as big endian.
544  * @param p a pointer to the output memory
545  * @param x the input unsigned integer
546  */
547 static inline void write_u64be(uint8_t *p, uint64_t x)
548 {
549         p[7] = x & 0xff; x >>= 8;
550         p[6] = x & 0xff; x >>= 8;
551         p[5] = x & 0xff; x >>= 8;
552         p[4] = x & 0xff; x >>= 8;
553         p[3] = x & 0xff; x >>= 8;
554         p[2] = x & 0xff; x >>= 8;
555         p[1] = x & 0xff; x >>= 8;
556         p[0] = x & 0xff; x >>= 8;
557 }
558
559 /**
560  * Write a 64 bits unsigned integer to memory stored as little endian.
561  * @param p a pointer to the output memory
562  * @param x the input unsigned integer
563  */
564 static inline void write_u64le(uint8_t *p, uint64_t x)
565 {
566         p[0] = x & 0xff; x >>= 8;
567         p[1] = x & 0xff; x >>= 8;
568         p[2] = x & 0xff; x >>= 8;
569         p[3] = x & 0xff; x >>= 8;
570         p[4] = x & 0xff; x >>= 8;
571         p[5] = x & 0xff; x >>= 8;
572         p[6] = x & 0xff; x >>= 8;
573         p[7] = x & 0xff; x >>= 8;
574 }
575 #define WL64(p, x) write_u64le((uint8_t *)(p), (uint64_t)(x))
576
577 /**
578  * Write a 32 bits float to memory stored as big endian.
579  * @param p a pointer to the output memory
580  * @param x the input float
581  */
582 static inline void write_fltbe(uint8_t *p, float x)
583 {
584         union { uint32_t u; float f; } u;
585         u.f = x;
586         write_u32be(p, u.u);
587 }
588 #define WBFL(p, x) write_fltbe((uint8_t *)(p), (x))
589
590 /**
591  * Write a 32 bits float to memory stored as little endian.
592  * @param p a pointer to the output memory
593  * @param x the input float
594  */
595 static inline void write_fltle(uint8_t *p, float x)
596 {
597         union { uint32_t u; float f; } u;
598         u.f = x;
599         write_u32le(p, u.u);
600 }
601 #define WLFL(p, x) write_fltle((uint8_t *)(p), float (x))
602
603 /**
604  * Write a 64 bits float to memory stored as little endian.
605  * @param p a pointer to the output memory
606  * @param x the input floating point value
607  */
608 static inline void write_dblle(uint8_t *p, double x)
609 {
610         union { uint64_t u; double f; } u;
611         u.f = x;
612         write_u64le(p, u.u);
613 }
614 #define WLDB(p, x) write_dblle((uint8_t *)(p), float (x))
615
616 /* Endianess conversion helpers with read/write position increment. */
617
618 /**
619  * Read unsigned 8bit integer from raw memory, increment read position.
620  * @param[in, out] p Pointer into byte stream.
621  * @return Retrieved integer value, unsigned.
622  */
623 static inline uint8_t read_u8_inc(const uint8_t **p)
624 {
625         uint8_t v;
626
627         if (!p || !*p)
628                 return 0;
629         v = read_u8(*p);
630         *p += sizeof(v);
631
632         return v;
633 }
634
635 /**
636  * Read unsigned 8bit integer, check length, increment read position.
637  * @param[in, out] p Pointer into byte stream.
638  * @param[in, out] l Remaining input payload length.
639  * @return Retrieved integer value, unsigned.
640  */
641 static inline uint8_t read_u8_inc_len(const uint8_t **p, size_t *l)
642 {
643         uint8_t v;
644
645         if (!p || !*p)
646                 return 0;
647         if (l && *l < sizeof(v)) {
648                 *l = 0;
649                 return 0;
650         }
651         v = read_u8(*p);
652         *p += sizeof(v);
653         if (l)
654                 *l -= sizeof(v);
655
656         return v;
657 }
658
659 /**
660  * Read signed 8bit integer from raw memory, increment read position.
661  * @param[in, out] p Pointer into byte stream.
662  * @return Retrieved integer value, signed.
663  */
664 static inline int8_t read_i8_inc(const uint8_t **p)
665 {
666         int8_t v;
667
668         if (!p || !*p)
669                 return 0;
670         v = read_i8(*p);
671         *p += sizeof(v);
672
673         return v;
674 }
675
676 /**
677  * Read unsigned 16bit integer from raw memory (big endian format), increment read position.
678  * @param[in, out] p Pointer into byte stream.
679  * @return Retrieved integer value, unsigned.
680  */
681 static inline uint16_t read_u16be_inc(const uint8_t **p)
682 {
683         uint16_t v;
684
685         if (!p || !*p)
686                 return 0;
687         v = read_u16be(*p);
688         *p += sizeof(v);
689
690         return v;
691 }
692
693 /**
694  * Read unsigned 16bit integer from raw memory (little endian format), increment read position.
695  * @param[in, out] p Pointer into byte stream.
696  * @return Retrieved integer value, unsigned.
697  */
698 static inline uint16_t read_u16le_inc(const uint8_t **p)
699 {
700         uint16_t v;
701
702         if (!p || !*p)
703                 return 0;
704         v = read_u16le(*p);
705         *p += sizeof(v);
706
707         return v;
708 }
709
710 /**
711  * Read unsigned 16bit integer (LE format), check length, increment position.
712  * @param[in, out] p Pointer into byte stream.
713  * @param[in, out] l Remaining input payload length.
714  * @return Retrieved integer value, unsigned.
715  */
716 static inline uint16_t read_u16le_inc_len(const uint8_t **p, size_t *l)
717 {
718         uint16_t v;
719
720         if (!p || !*p)
721                 return 0;
722         if (l && *l < sizeof(v)) {
723                 *l = 0;
724                 return 0;
725         }
726         v = read_u16le(*p);
727         *p += sizeof(v);
728         if (l)
729                 *l -= sizeof(v);
730
731         return v;
732 }
733
734 /**
735  * Read signed 16bit integer from raw memory (big endian format), increment read position.
736  * @param[in, out] p Pointer into byte stream.
737  * @return Retrieved integer value, signed.
738  */
739 static inline int16_t read_i16be_inc(const uint8_t **p)
740 {
741         int16_t v;
742
743         if (!p || !*p)
744                 return 0;
745         v = read_i16be(*p);
746         *p += sizeof(v);
747
748         return v;
749 }
750
751 /**
752  * Read signed 16bit integer from raw memory (little endian format), increment read position.
753  * @param[in, out] p Pointer into byte stream.
754  * @return Retrieved integer value, signed.
755  */
756 static inline int16_t read_i16le_inc(const uint8_t **p)
757 {
758         int16_t v;
759
760         if (!p || !*p)
761                 return 0;
762         v = read_i16le(*p);
763         *p += sizeof(v);
764
765         return v;
766 }
767
768 /**
769  * Read unsigned 24bit integer from raw memory (little endian format), increment read position.
770  * @param[in, out] p Pointer into byte stream.
771  * @return Retrieved integer value, unsigned.
772  */
773 static inline uint32_t read_u24le_inc(const uint8_t **p)
774 {
775         uint32_t v;
776
777         if (!p || !*p)
778                 return 0;
779         v = read_u24le(*p);
780         *p += 3 * sizeof(uint8_t);
781
782         return v;
783 }
784
785 /**
786  * Read unsigned 32bit integer from raw memory (big endian format), increment read position.
787  * @param[in, out] p Pointer into byte stream.
788  * @return Retrieved integer value, unsigned.
789  */
790 static inline uint32_t read_u32be_inc(const uint8_t **p)
791 {
792         uint32_t v;
793
794         if (!p || !*p)
795                 return 0;
796         v = read_u32be(*p);
797         *p += sizeof(v);
798
799         return v;
800 }
801
802 /**
803  * Read unsigned 32bit integer from raw memory (little endian format), increment read position.
804  * @param[in, out] p Pointer into byte stream.
805  * @return Retrieved integer value, unsigned.
806  */
807 static inline uint32_t read_u32le_inc(const uint8_t **p)
808 {
809         uint32_t v;
810
811         if (!p || !*p)
812                 return 0;
813         v = read_u32le(*p);
814         *p += sizeof(v);
815
816         return v;
817 }
818
819 /**
820  * Read signed 32bit integer from raw memory (big endian format), increment read position.
821  * @param[in, out] p Pointer into byte stream.
822  * @return Retrieved integer value, signed.
823  */
824 static inline int32_t read_i32be_inc(const uint8_t **p)
825 {
826         int32_t v;
827
828         if (!p || !*p)
829                 return 0;
830         v = read_i32be(*p);
831         *p += sizeof(v);
832
833         return v;
834 }
835
836 /**
837  * Read signed 32bit integer from raw memory (little endian format), increment read position.
838  * @param[in, out] p Pointer into byte stream.
839  * @return Retrieved integer value, signed.
840  */
841 static inline int32_t read_i32le_inc(const uint8_t **p)
842 {
843         int32_t v;
844
845         if (!p || !*p)
846                 return 0;
847         v = read_i32le(*p);
848         *p += sizeof(v);
849
850         return v;
851 }
852
853 /**
854  * Read unsigned 64bit integer from raw memory (big endian format), increment read position.
855  * @param[in, out] p Pointer into byte stream.
856  * @return Retrieved integer value, unsigned.
857  */
858 static inline uint64_t read_u64be_inc(const uint8_t **p)
859 {
860         uint64_t v;
861
862         if (!p || !*p)
863                 return 0;
864         v = read_u64be(*p);
865         *p += sizeof(v);
866
867         return v;
868 }
869
870 /**
871  * Read unsigned 64bit integer from raw memory (little endian format), increment read position.
872  * @param[in, out] p Pointer into byte stream.
873  * @return Retrieved integer value, unsigned.
874  */
875 static inline uint64_t read_u64le_inc(const uint8_t **p)
876 {
877         uint64_t v;
878
879         if (!p || !*p)
880                 return 0;
881         v = read_u64le(*p);
882         *p += sizeof(v);
883
884         return v;
885 }
886
887 /**
888  * Read 32bit float from raw memory (big endian format), increment read position.
889  * @param[in, out] p Pointer into byte stream.
890  * @return Retrieved float value.
891  */
892 static inline float read_fltbe_inc(const uint8_t **p)
893 {
894         float v;
895
896         if (!p || !*p)
897                 return 0;
898         v = read_fltbe(*p);
899         *p += sizeof(v);
900
901         return v;
902 }
903
904 /**
905  * Read 32bit float from raw memory (little endian format), increment read position.
906  * @param[in, out] p Pointer into byte stream.
907  * @return Retrieved float value.
908  */
909 static inline float read_fltle_inc(const uint8_t **p)
910 {
911         float v;
912
913         if (!p || !*p)
914                 return 0;
915         v = read_fltle(*p);
916         *p += sizeof(v);
917
918         return v;
919 }
920
921 /**
922  * Read 64bit float from raw memory (big endian format), increment read position.
923  * @param[in, out] p Pointer into byte stream.
924  * @return Retrieved float value.
925  */
926 static inline double read_dblbe_inc(const uint8_t **p)
927 {
928         double v;
929
930         if (!p || !*p)
931                 return 0;
932         v = read_dblbe(*p);
933         *p += sizeof(v);
934
935         return v;
936 }
937
938 /**
939  * Read 64bit float from raw memory (little endian format), increment read position.
940  * @param[in, out] p Pointer into byte stream.
941  * @return Retrieved float value.
942  */
943 static inline double read_dblle_inc(const uint8_t **p)
944 {
945         double v;
946
947         if (!p || !*p)
948                 return 0;
949         v = read_dblle(*p);
950         *p += sizeof(v);
951
952         return v;
953 }
954
955 /**
956  * Write unsigned 8bit integer to raw memory, increment write position.
957  * @param[in, out] p Pointer into byte stream.
958  * @param[in] x Value to write.
959  */
960 static inline void write_u8_inc(uint8_t **p, uint8_t x)
961 {
962         if (!p || !*p)
963                 return;
964         write_u8(*p, x);
965         *p += sizeof(x);
966 }
967
968 /**
969  * Write unsigned 16bit big endian integer to raw memory, increment write position.
970  * @param[in, out] p Pointer into byte stream.
971  * @param[in] x Value to write.
972  */
973 static inline void write_u16be_inc(uint8_t **p, uint16_t x)
974 {
975         if (!p || !*p)
976                 return;
977         write_u16be(*p, x);
978         *p += sizeof(x);
979 }
980
981 /**
982  * Write unsigned 16bit little endian integer to raw memory, increment write position.
983  * @param[in, out] p Pointer into byte stream.
984  * @param[in] x Value to write.
985  */
986 static inline void write_u16le_inc(uint8_t **p, uint16_t x)
987 {
988         if (!p || !*p)
989                 return;
990         write_u16le(*p, x);
991         *p += sizeof(x);
992 }
993
994 /**
995  * Write unsigned 24bit liggle endian integer to raw memory, increment write position.
996  * @param[in, out] p Pointer into byte stream.
997  * @param[in] x Value to write.
998  */
999 static inline void write_u24le_inc(uint8_t **p, uint32_t x)
1000 {
1001         if (!p || !*p)
1002                 return;
1003         write_u24le(*p, x);
1004         *p += 3 * sizeof(uint8_t);
1005 }
1006
1007 /**
1008  * Write unsigned 32bit big endian integer to raw memory, increment write position.
1009  * @param[in, out] p Pointer into byte stream.
1010  * @param[in] x Value to write.
1011  */
1012 static inline void write_u32be_inc(uint8_t **p, uint32_t x)
1013 {
1014         if (!p || !*p)
1015                 return;
1016         write_u32be(*p, x);
1017         *p += sizeof(x);
1018 }
1019
1020 /**
1021  * Write unsigned 32bit little endian integer to raw memory, increment write position.
1022  * @param[in, out] p Pointer into byte stream.
1023  * @param[in] x Value to write.
1024  */
1025 static inline void write_u32le_inc(uint8_t **p, uint32_t x)
1026 {
1027         if (!p || !*p)
1028                 return;
1029         write_u32le(*p, x);
1030         *p += sizeof(x);
1031 }
1032
1033 /**
1034  * Write unsigned 40bit little endian integer to raw memory, increment write position.
1035  * @param[in, out] p Pointer into byte stream.
1036  * @param[in] x Value to write.
1037  */
1038 static inline void write_u40le_inc(uint8_t **p, uint64_t x)
1039 {
1040         if (!p || !*p)
1041                 return;
1042         write_u40le(*p, x);
1043         *p += 5 * sizeof(uint8_t);
1044 }
1045
1046 /**
1047  * Write unsigned 48bit little endian integer to raw memory, increment write position.
1048  * @param[in, out] p Pointer into byte stream.
1049  * @param[in] x Value to write.
1050  */
1051 static inline void write_u48le_inc(uint8_t **p, uint64_t x)
1052 {
1053         if (!p || !*p)
1054                 return;
1055         write_u48le(*p, x);
1056         *p += 48 / 8 * sizeof(uint8_t);
1057 }
1058
1059 /**
1060  * Write unsigned 64bit little endian integer to raw memory, increment write position.
1061  * @param[in, out] p Pointer into byte stream.
1062  * @param[in] x Value to write.
1063  */
1064 static inline void write_u64le_inc(uint8_t **p, uint64_t x)
1065 {
1066         if (!p || !*p)
1067                 return;
1068         write_u64le(*p, x);
1069         *p += sizeof(x);
1070 }
1071
1072 /**
1073  * Write single precision little endian float to raw memory, increment write position.
1074  * @param[in, out] p Pointer into byte stream.
1075  * @param[in] x Value to write.
1076  */
1077 static inline void write_fltle_inc(uint8_t **p, float x)
1078 {
1079         if (!p || !*p)
1080                 return;
1081         write_fltle(*p, x);
1082         *p += sizeof(x);
1083 }
1084
1085 /**
1086  * Write double precision little endian float to raw memory, increment write position.
1087  * @param[in, out] p Pointer into byte stream.
1088  * @param[in] x Value to write.
1089  */
1090 static inline void write_dblle_inc(uint8_t **p, double x)
1091 {
1092         if (!p || !*p)
1093                 return;
1094         write_dblle(*p, x);
1095         *p += sizeof(x);
1096 }
1097
1098 /* Portability fixes for FreeBSD. */
1099 #ifdef __FreeBSD__
1100 #define LIBUSB_CLASS_APPLICATION 0xfe
1101 #define libusb_has_capability(x) 0
1102 #define libusb_handle_events_timeout_completed(ctx, tv, c) \
1103         libusb_handle_events_timeout(ctx, tv)
1104 #endif
1105
1106 /*
1107  * Convenience for FTDI library version dependency.
1108  * - Version 1.5 introduced ftdi_tciflush(), ftdi_tcoflush(), and
1109  *   ftdi_tcioflush() all within the same commit, and deprecated
1110  *   ftdi_usb_purge_buffers() which suffered from inverse semantics.
1111  *   The API is drop-in compatible (arguments count and data types are
1112  *   identical). The libsigrok source code always flushes RX and TX at
1113  *   the same time, never individually.
1114  */
1115 #if defined HAVE_FTDI_TCIOFLUSH && HAVE_FTDI_TCIOFLUSH
1116 #  define PURGE_FTDI_BOTH ftdi_tcioflush
1117 #else
1118 #  define PURGE_FTDI_BOTH ftdi_usb_purge_buffers
1119 #endif
1120
1121 /* Static definitions of structs ending with an all-zero entry are a
1122  * problem when compiling with -Wmissing-field-initializers: GCC
1123  * suppresses the warning only with { 0 }, clang wants { } */
1124 #ifdef __clang__
1125 #define ALL_ZERO { }
1126 #else
1127 #define ALL_ZERO { 0 }
1128 #endif
1129
1130 #ifdef __APPLE__
1131 #define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
1132 #else
1133 #define SR_DRIVER_LIST_SECTION "__sr_driver_list"
1134 #endif
1135
1136 #if !defined SR_DRIVER_LIST_NOREORDER && defined __has_attribute
1137 #if __has_attribute(no_reorder)
1138 #define SR_DRIVER_LIST_NOREORDER __attribute__((no_reorder))
1139 #endif
1140 #endif
1141 #if !defined SR_DRIVER_LIST_NOREORDER
1142 #define SR_DRIVER_LIST_NOREORDER /* EMPTY */
1143 #endif
1144
1145 /**
1146  * Register a list of hardware drivers.
1147  *
1148  * This macro can be used to register multiple hardware drivers to the library.
1149  * This is useful when a driver supports multiple similar but slightly
1150  * different devices that require different sr_dev_driver struct definitions.
1151  *
1152  * For registering only a single driver see SR_REGISTER_DEV_DRIVER().
1153  *
1154  * Example:
1155  * @code{c}
1156  * #define MY_DRIVER(_name) \
1157  *     &(struct sr_dev_driver){ \
1158  *         .name = _name, \
1159  *         ...
1160  *     };
1161  *
1162  * SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
1163  *     MY_DRIVER("driver 1"),
1164  *     MY_DRIVER("driver 2"),
1165  *     ...
1166  * );
1167  * @endcode
1168  *
1169  * @param name Name to use for the driver list identifier.
1170  * @param ... Comma separated list of pointers to sr_dev_driver structs.
1171  */
1172 #define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
1173         static const struct sr_dev_driver *name[] \
1174                 SR_DRIVER_LIST_NOREORDER \
1175                 __attribute__((section (SR_DRIVER_LIST_SECTION), used, \
1176                         aligned(sizeof(struct sr_dev_driver *)))) \
1177                 = { \
1178                         __VA_ARGS__ \
1179                 };
1180
1181 /**
1182  * Register a hardware driver.
1183  *
1184  * This macro is used to register a hardware driver with the library. It has
1185  * to be used in order to make the driver accessible to applications using the
1186  * library.
1187  *
1188  * The macro invocation should be placed directly under the struct
1189  * sr_dev_driver definition.
1190  *
1191  * Example:
1192  * @code{c}
1193  * static struct sr_dev_driver driver_info = {
1194  *     .name = "driver",
1195  *     ....
1196  * };
1197  * SR_REGISTER_DEV_DRIVER(driver_info);
1198  * @endcode
1199  *
1200  * @param name Identifier name of sr_dev_driver struct to register.
1201  */
1202 #define SR_REGISTER_DEV_DRIVER(name) \
1203         SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
1204
1205 SR_API void sr_drivers_init(struct sr_context *context);
1206
1207 struct sr_context {
1208         struct sr_dev_driver **driver_list;
1209 #ifdef HAVE_LIBUSB_1_0
1210         libusb_context *libusb_ctx;
1211 #endif
1212         sr_resource_open_callback resource_open_cb;
1213         sr_resource_close_callback resource_close_cb;
1214         sr_resource_read_callback resource_read_cb;
1215         void *resource_cb_data;
1216 };
1217
1218 /** Input module metadata keys. */
1219 enum sr_input_meta_keys {
1220         /** The input filename, if there is one. */
1221         SR_INPUT_META_FILENAME = 0x01,
1222         /** The input file's size in bytes. */
1223         SR_INPUT_META_FILESIZE = 0x02,
1224         /** The first 128 bytes of the file, provided as a GString. */
1225         SR_INPUT_META_HEADER = 0x04,
1226
1227         /** The module cannot identify a file without this metadata. */
1228         SR_INPUT_META_REQUIRED = 0x80,
1229 };
1230
1231 /** Input (file) module struct. */
1232 struct sr_input {
1233         /**
1234          * A pointer to this input module's 'struct sr_input_module'.
1235          */
1236         const struct sr_input_module *module;
1237         GString *buf;
1238         struct sr_dev_inst *sdi;
1239         gboolean sdi_ready;
1240         void *priv;
1241 };
1242
1243 /** Input (file) module driver. */
1244 struct sr_input_module {
1245         /**
1246          * A unique ID for this input module, suitable for use in command-line
1247          * clients, [a-z0-9-]. Must not be NULL.
1248          */
1249         const char *id;
1250
1251         /**
1252          * A unique name for this input module, suitable for use in GUI
1253          * clients, can contain UTF-8. Must not be NULL.
1254          */
1255         const char *name;
1256
1257         /**
1258          * A short description of the input module. Must not be NULL.
1259          *
1260          * This can be displayed by frontends, e.g. when selecting the input
1261          * module for saving a file.
1262          */
1263         const char *desc;
1264
1265         /**
1266          * A NULL terminated array of strings containing a list of file name
1267          * extensions typical for the input file format, or NULL if there is
1268          * no typical extension for this file format.
1269          */
1270         const char *const *exts;
1271
1272         /**
1273          * Zero-terminated list of metadata items the module needs to be able
1274          * to identify an input stream. Can be all-zero, if the module cannot
1275          * identify streams at all, i.e. has to be forced into use.
1276          *
1277          * Each item is one of:
1278          *   SR_INPUT_META_FILENAME
1279          *   SR_INPUT_META_FILESIZE
1280          *   SR_INPUT_META_HEADER
1281          *
1282          * If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
1283          * identify a stream without the given metadata.
1284          */
1285         const uint8_t metadata[8];
1286
1287         /**
1288          * Returns a NULL-terminated list of options this module can take.
1289          * Can be NULL, if the module has no options.
1290          */
1291         const struct sr_option *(*options) (void);
1292
1293         /**
1294          * Check if this input module can load and parse the specified stream.
1295          *
1296          * @param[in] metadata Metadata the module can use to identify the stream.
1297          * @param[out] confidence "Strength" of the detection.
1298          *   Specialized handlers can take precedence over generic/basic support.
1299          *
1300          * @retval SR_OK This module knows the format.
1301          * @retval SR_ERR_NA There wasn't enough data for this module to
1302          *   positively identify the format.
1303          * @retval SR_ERR_DATA This module knows the format, but cannot handle
1304          *   it. This means the stream is either corrupt, or indicates a
1305          *   feature that the module does not support.
1306          * @retval SR_ERR This module does not know the format.
1307          *
1308          * Lower numeric values of 'confidence' mean that the input module
1309          * stronger believes in its capability to handle this specific format.
1310          * This way, multiple input modules can claim support for a format,
1311          * and the application can pick the best match, or try fallbacks
1312          * in case of errors. This approach also copes with formats that
1313          * are unreliable to detect in the absence of magic signatures.
1314          */
1315         int (*format_match) (GHashTable *metadata, unsigned int *confidence);
1316
1317         /**
1318          * Initialize the input module.
1319          *
1320          * @retval SR_OK Success
1321          * @retval other Negative error code.
1322          */
1323         int (*init) (struct sr_input *in, GHashTable *options);
1324
1325         /**
1326          * Send data to the specified input instance.
1327          *
1328          * When an input module instance is created with sr_input_new(), this
1329          * function is used to feed data to the instance.
1330          *
1331          * As enough data gets fed into this function to completely populate
1332          * the device instance associated with this input instance, this is
1333          * guaranteed to return the moment it's ready. This gives the caller
1334          * the chance to examine the device instance, attach session callbacks
1335          * and so on.
1336          *
1337          * @retval SR_OK Success
1338          * @retval other Negative error code.
1339          */
1340         int (*receive) (struct sr_input *in, GString *buf);
1341
1342         /**
1343          * Signal the input module no more data will come.
1344          *
1345          * This will cause the module to process any data it may have buffered.
1346          * The SR_DF_END packet will also typically be sent at this time.
1347          */
1348         int (*end) (struct sr_input *in);
1349
1350         /**
1351          * Reset the input module's input handling structures.
1352          *
1353          * Causes the input module to reset its internal state so that we can
1354          * re-send the input data from the beginning without having to
1355          * re-create the entire input module.
1356          *
1357          * @retval SR_OK Success.
1358          * @retval other Negative error code.
1359          */
1360         int (*reset) (struct sr_input *in);
1361
1362         /**
1363          * This function is called after the caller is finished using
1364          * the input module, and can be used to free any internal
1365          * resources the module may keep.
1366          *
1367          * This function is optional.
1368          *
1369          * @retval SR_OK Success
1370          * @retval other Negative error code.
1371          */
1372         void (*cleanup) (struct sr_input *in);
1373 };
1374
1375 /** Output module instance. */
1376 struct sr_output {
1377         /** A pointer to this output's module. */
1378         const struct sr_output_module *module;
1379
1380         /**
1381          * The device for which this output module is creating output. This
1382          * can be used by the module to find out channel names and numbers.
1383          */
1384         const struct sr_dev_inst *sdi;
1385
1386         /**
1387          * The name of the file that the data should be written to.
1388          */
1389         const char *filename;
1390
1391         /**
1392          * A generic pointer which can be used by the module to keep internal
1393          * state between calls into its callback functions.
1394          *
1395          * For example, the module might store a pointer to a chunk of output
1396          * there, and only flush it when it reaches a certain size.
1397          */
1398         void *priv;
1399 };
1400
1401 /** Output module driver. */
1402 struct sr_output_module {
1403         /**
1404          * A unique ID for this output module, suitable for use in command-line
1405          * clients, [a-z0-9-]. Must not be NULL.
1406          */
1407         const char *id;
1408
1409         /**
1410          * A unique name for this output module, suitable for use in GUI
1411          * clients, can contain UTF-8. Must not be NULL.
1412          */
1413         const char *name;
1414
1415         /**
1416          * A short description of the output module. Must not be NULL.
1417          *
1418          * This can be displayed by frontends, e.g. when selecting the output
1419          * module for saving a file.
1420          */
1421         const char *desc;
1422
1423         /**
1424          * A NULL terminated array of strings containing a list of file name
1425          * extensions typical for the input file format, or NULL if there is
1426          * no typical extension for this file format.
1427          */
1428         const char *const *exts;
1429
1430         /**
1431          * Bitfield containing flags that describe certain properties
1432          * this output module may or may not have.
1433          * @see sr_output_flags
1434          */
1435         const uint64_t flags;
1436
1437         /**
1438          * Returns a NULL-terminated list of options this module can take.
1439          * Can be NULL, if the module has no options.
1440          */
1441         const struct sr_option *(*options) (void);
1442
1443         /**
1444          * This function is called once, at the beginning of an output stream.
1445          *
1446          * The device struct will be available in the output struct passed in,
1447          * as well as the param field -- which may be NULL or an empty string,
1448          * if no parameter was passed.
1449          *
1450          * The module can use this to initialize itself, create a struct for
1451          * keeping state and storing it in the <code>internal</code> field.
1452          *
1453          * @param o Pointer to the respective 'struct sr_output'.
1454          *
1455          * @retval SR_OK Success
1456          * @retval other Negative error code.
1457          */
1458         int (*init) (struct sr_output *o, GHashTable *options);
1459
1460         /**
1461          * This function is passed a copy of every packet in the data feed.
1462          * Any output generated by the output module in response to the
1463          * packet should be returned in a newly allocated GString
1464          * <code>out</code>, which will be freed by the caller.
1465          *
1466          * Packets not of interest to the output module can just be ignored,
1467          * and the <code>out</code> parameter set to NULL.
1468          *
1469          * @param o Pointer to the respective 'struct sr_output'.
1470          * @param sdi The device instance that generated the packet.
1471          * @param packet The complete packet.
1472          * @param out A pointer where a GString * should be stored if
1473          * the module generates output, or NULL if not.
1474          *
1475          * @retval SR_OK Success
1476          * @retval other Negative error code.
1477          */
1478         int (*receive) (const struct sr_output *o,
1479                         const struct sr_datafeed_packet *packet, GString **out);
1480
1481         /**
1482          * This function is called after the caller is finished using
1483          * the output module, and can be used to free any internal
1484          * resources the module may keep.
1485          *
1486          * @retval SR_OK Success
1487          * @retval other Negative error code.
1488          */
1489         int (*cleanup) (struct sr_output *o);
1490 };
1491
1492 /** Transform module instance. */
1493 struct sr_transform {
1494         /** A pointer to this transform's module. */
1495         const struct sr_transform_module *module;
1496
1497         /**
1498          * The device for which this transform module is used. This
1499          * can be used by the module to find out channel names and numbers.
1500          */
1501         const struct sr_dev_inst *sdi;
1502
1503         /**
1504          * A generic pointer which can be used by the module to keep internal
1505          * state between calls into its callback functions.
1506          */
1507         void *priv;
1508 };
1509
1510 struct sr_transform_module {
1511         /**
1512          * A unique ID for this transform module, suitable for use in
1513          * command-line clients, [a-z0-9-]. Must not be NULL.
1514          */
1515         const char *id;
1516
1517         /**
1518          * A unique name for this transform module, suitable for use in GUI
1519          * clients, can contain UTF-8. Must not be NULL.
1520          */
1521         const char *name;
1522
1523         /**
1524          * A short description of the transform module. Must not be NULL.
1525          *
1526          * This can be displayed by frontends, e.g. when selecting
1527          * which transform module(s) to add.
1528          */
1529         const char *desc;
1530
1531         /**
1532          * Returns a NULL-terminated list of options this transform module
1533          * can take. Can be NULL, if the transform module has no options.
1534          */
1535         const struct sr_option *(*options) (void);
1536
1537         /**
1538          * This function is called once, at the beginning of a stream.
1539          *
1540          * @param t Pointer to the respective 'struct sr_transform'.
1541          * @param options Hash table of options for this transform module.
1542          *                Can be NULL if no options are to be used.
1543          *
1544          * @retval SR_OK Success
1545          * @retval other Negative error code.
1546          */
1547         int (*init) (struct sr_transform *t, GHashTable *options);
1548
1549         /**
1550          * This function is passed a pointer to every packet in the data feed.
1551          *
1552          * It can either return (in packet_out) a pointer to another packet
1553          * (possibly the exact same packet it got as input), or NULL.
1554          *
1555          * @param t Pointer to the respective 'struct sr_transform'.
1556          * @param packet_in Pointer to a datafeed packet.
1557          * @param packet_out Pointer to the resulting datafeed packet after
1558          *                   this function was run. If NULL, the transform
1559          *                   module intentionally didn't output a new packet.
1560          *
1561          * @retval SR_OK Success
1562          * @retval other Negative error code.
1563          */
1564         int (*receive) (const struct sr_transform *t,
1565                         struct sr_datafeed_packet *packet_in,
1566                         struct sr_datafeed_packet **packet_out);
1567
1568         /**
1569          * This function is called after the caller is finished using
1570          * the transform module, and can be used to free any internal
1571          * resources the module may keep.
1572          *
1573          * @retval SR_OK Success
1574          * @retval other Negative error code.
1575          */
1576         int (*cleanup) (struct sr_transform *t);
1577 };
1578
1579 #ifdef HAVE_LIBUSB_1_0
1580 /** USB device instance */
1581 struct sr_usb_dev_inst {
1582         /** USB bus */
1583         uint8_t bus;
1584         /** Device address on USB bus */
1585         uint8_t address;
1586         /** libusb device handle */
1587         struct libusb_device_handle *devhdl;
1588 };
1589 #endif
1590
1591 /** Raw TCP device instance. */
1592 struct sr_tcp_dev_inst {
1593         char *host_addr;        /**!< IP address or host name */
1594         char *tcp_port;         /**!< TCP port number/name */
1595         int sock_fd;            /**!< TCP socket's file descriptor */
1596 };
1597
1598 struct sr_serial_dev_inst;
1599 #ifdef HAVE_SERIAL_COMM
1600 struct ser_lib_functions;
1601 struct ser_hid_chip_functions;
1602 struct sr_bt_desc;
1603 typedef void (*serial_rx_chunk_callback)(struct sr_serial_dev_inst *serial,
1604         void *cb_data, const void *buf, size_t count);
1605 struct sr_serial_dev_inst {
1606         /** Port name, e.g. '/dev/tty42'. */
1607         char *port;
1608         /** Comm params for serial_set_paramstr(). */
1609         char *serialcomm;
1610         struct ser_lib_functions *lib_funcs;
1611         struct {
1612                 int bit_rate;
1613                 int data_bits;
1614                 int parity_bits;
1615                 int stop_bits;
1616         } comm_params;
1617         GString *rcv_buffer;
1618         serial_rx_chunk_callback rx_chunk_cb_func;
1619         void *rx_chunk_cb_data;
1620 #ifdef HAVE_LIBSERIALPORT
1621         /** libserialport port handle */
1622         struct sp_port *sp_data;
1623 #endif
1624 #ifdef HAVE_LIBHIDAPI
1625         enum ser_hid_chip_t {
1626                 SER_HID_CHIP_UNKNOWN,           /**!< place holder */
1627                 SER_HID_CHIP_BTC_BU86X,         /**!< Brymen BU86x */
1628                 SER_HID_CHIP_SIL_CP2110,        /**!< SiLabs CP2110 */
1629                 SER_HID_CHIP_VICTOR_DMM,        /**!< Victor 70/86 DMM cable */
1630                 SER_HID_CHIP_WCH_CH9325,        /**!< WCH CH9325 */
1631                 SER_HID_CHIP_LAST,              /**!< sentinel */
1632         } hid_chip;
1633         struct ser_hid_chip_functions *hid_chip_funcs;
1634         char *usb_path;
1635         char *usb_serno;
1636         const char *hid_path;
1637         hid_device *hid_dev;
1638         GSList *hid_source_args;
1639 #endif
1640 #ifdef HAVE_BLUETOOTH
1641         enum ser_bt_conn_t {
1642                 SER_BT_CONN_UNKNOWN,    /**!< place holder */
1643                 SER_BT_CONN_RFCOMM,     /**!< BT classic, RFCOMM channel */
1644                 SER_BT_CONN_BLE122,     /**!< BLE, BLE122 module, indications */
1645                 SER_BT_CONN_NRF51,      /**!< BLE, Nordic nRF51, notifications */
1646                 SER_BT_CONN_CC254x,     /**!< BLE, TI CC254x, notifications */
1647                 SER_BT_CONN_AC6328,     /**!< BLE, JL AC6328B, notifications */
1648                 SER_BT_CONN_DIALOG,     /**!< BLE, dialog DA14580, notifications */
1649                 SER_BT_CONN_NOTIFY,     /**!< BLE, generic notifications */
1650                 SER_BT_CONN_MAX,        /**!< sentinel */
1651         } bt_conn_type;
1652         char *bt_addr_local;
1653         char *bt_addr_remote;
1654         size_t bt_rfcomm_channel;
1655         uint16_t bt_notify_handle_read;
1656         uint16_t bt_notify_handle_write;
1657         uint16_t bt_notify_handle_cccd;
1658         uint16_t bt_notify_value_cccd;
1659         uint16_t bt_ble_mtu;
1660         struct sr_bt_desc *bt_desc;
1661         GSList *bt_source_args;
1662 #endif
1663         struct sr_tcp_dev_inst *tcp_dev;
1664 };
1665 #endif
1666
1667 struct sr_usbtmc_dev_inst {
1668         char *device;
1669         int fd;
1670 };
1671
1672 /* Private driver context. */
1673 struct drv_context {
1674         /** sigrok context */
1675         struct sr_context *sr_ctx;
1676         GSList *instances;
1677 };
1678
1679 /*--- log.c -----------------------------------------------------------------*/
1680
1681 /* Provide a macro for other source code locations to re-use. */
1682 #if defined(_WIN32) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1683 /*
1684  * On MinGW, we need to specify the gnu_printf format flavor or GCC
1685  * will assume non-standard Microsoft printf syntax.
1686  */
1687 #define ATTR_FMT_PRINTF(fmt_pos, arg_pos) \
1688                 __attribute__((__format__ (__gnu_printf__, fmt_pos, arg_pos)))
1689 #else
1690 #define ATTR_FMT_PRINTF(fmt_pos, arg_pos)       G_GNUC_PRINTF(fmt_pos, arg_pos)
1691 #endif
1692
1693 SR_PRIV int sr_log(int loglevel, const char *format, ...) ATTR_FMT_PRINTF(2, 3);
1694
1695 /* Message logging helpers with subsystem-specific prefix string. */
1696 #define sr_spew(...)    sr_log(SR_LOG_SPEW, LOG_PREFIX ": " __VA_ARGS__)
1697 #define sr_dbg(...)     sr_log(SR_LOG_DBG,  LOG_PREFIX ": " __VA_ARGS__)
1698 #define sr_info(...)    sr_log(SR_LOG_INFO, LOG_PREFIX ": " __VA_ARGS__)
1699 #define sr_warn(...)    sr_log(SR_LOG_WARN, LOG_PREFIX ": " __VA_ARGS__)
1700 #define sr_err(...)     sr_log(SR_LOG_ERR,  LOG_PREFIX ": " __VA_ARGS__)
1701
1702 /*--- device.c --------------------------------------------------------------*/
1703
1704 /** Scan options supported by a driver. */
1705 #define SR_CONF_SCAN_OPTIONS 0x7FFF0000
1706
1707 /** Device options for a particular device. */
1708 #define SR_CONF_DEVICE_OPTIONS 0x7FFF0001
1709
1710 /** Mask for separating config keys from capabilities. */
1711 #define SR_CONF_MASK 0x1fffffff
1712
1713 /** Values for the changes argument of sr_dev_driver.config_channel_set. */
1714 enum {
1715         /** The enabled state of the channel has been changed. */
1716         SR_CHANNEL_SET_ENABLED = 1 << 0,
1717 };
1718
1719 SR_PRIV struct sr_channel *sr_channel_new(struct sr_dev_inst *sdi,
1720                 int index, int type, gboolean enabled, const char *name);
1721 SR_PRIV void sr_channel_free(struct sr_channel *ch);
1722 SR_PRIV void sr_channel_free_cb(void *p);
1723 SR_PRIV struct sr_channel *sr_next_enabled_channel(const struct sr_dev_inst *sdi,
1724                 struct sr_channel *cur_channel);
1725 SR_PRIV gboolean sr_channels_differ(struct sr_channel *ch1, struct sr_channel *ch2);
1726 SR_PRIV gboolean sr_channel_lists_differ(GSList *l1, GSList *l2);
1727
1728 SR_PRIV struct sr_channel_group *sr_channel_group_new(struct sr_dev_inst *sdi,
1729         const char *name, void *priv);
1730 SR_PRIV void sr_channel_group_free(struct sr_channel_group *cg);
1731 SR_PRIV void sr_channel_group_free_cb(void *cg);
1732
1733 /** Device instance data */
1734 struct sr_dev_inst {
1735         /** Device driver. */
1736         struct sr_dev_driver *driver;
1737         /** Device instance status. SR_ST_NOT_FOUND, etc. */
1738         int status;
1739         /** Device instance type. SR_INST_USB, etc. */
1740         int inst_type;
1741         /** Device vendor. */
1742         char *vendor;
1743         /** Device model. */
1744         char *model;
1745         /** Device version. */
1746         char *version;
1747         /** Serial number. */
1748         char *serial_num;
1749         /** Connection string to uniquely identify devices. */
1750         char *connection_id;
1751         /** List of channels. */
1752         GSList *channels;
1753         /** List of sr_channel_group structs */
1754         GSList *channel_groups;
1755         /** Device instance connection data (used?) */
1756         void *conn;
1757         /** Device instance private data (used?) */
1758         void *priv;
1759         /** Session to which this device is currently assigned. */
1760         struct sr_session *session;
1761 };
1762
1763 /* Generic device instances */
1764 SR_PRIV void sr_dev_inst_free(struct sr_dev_inst *sdi);
1765
1766 #ifdef HAVE_LIBUSB_1_0
1767 /* USB-specific instances */
1768 SR_PRIV struct sr_usb_dev_inst *sr_usb_dev_inst_new(uint8_t bus,
1769                 uint8_t address, struct libusb_device_handle *hdl);
1770 SR_PRIV void sr_usb_dev_inst_free(struct sr_usb_dev_inst *usb);
1771 SR_PRIV void sr_usb_dev_inst_free_cb(gpointer p); /* Glib wrapper. */
1772 #endif
1773
1774 #ifdef HAVE_SERIAL_COMM
1775 #ifndef HAVE_LIBSERIALPORT
1776 /*
1777  * Some identifiers which initially got provided by libserialport are
1778  * used internally within the libsigrok serial layer's implementation,
1779  * while libserialport no longer is the exclusive provider of serial
1780  * communication support. Declare the identifiers here so they remain
1781  * available across all build configurations.
1782  */
1783 enum libsp_parity {
1784         SP_PARITY_NONE = 0,
1785         SP_PARITY_ODD = 1,
1786         SP_PARITY_EVEN = 2,
1787         SP_PARITY_MARK = 3,
1788         SP_PARITY_SPACE = 4,
1789 };
1790
1791 enum libsp_flowcontrol {
1792         SP_FLOWCONTROL_NONE = 0,
1793         SP_FLOWCONTROL_XONXOFF = 1,
1794         SP_FLOWCONTROL_RTSCTS = 2,
1795         SP_FLOWCONTROL_DTRDSR = 3,
1796 };
1797 #endif
1798
1799 /* Serial-specific instances */
1800 SR_PRIV struct sr_serial_dev_inst *sr_serial_dev_inst_new(const char *port,
1801                 const char *serialcomm);
1802 SR_PRIV void sr_serial_dev_inst_free(struct sr_serial_dev_inst *serial);
1803 #endif
1804
1805 /* USBTMC-specific instances */
1806 SR_PRIV struct sr_usbtmc_dev_inst *sr_usbtmc_dev_inst_new(const char *device);
1807 SR_PRIV void sr_usbtmc_dev_inst_free(struct sr_usbtmc_dev_inst *usbtmc);
1808
1809 /*--- hwdriver.c ------------------------------------------------------------*/
1810
1811 SR_PRIV const GVariantType *sr_variant_type_get(int datatype);
1812 SR_PRIV int sr_variant_type_check(uint32_t key, GVariant *data);
1813 SR_PRIV void sr_hw_cleanup_all(const struct sr_context *ctx);
1814 SR_PRIV struct sr_config *sr_config_new(uint32_t key, GVariant *data);
1815 SR_PRIV void sr_config_free(struct sr_config *src);
1816 SR_PRIV int sr_dev_acquisition_start(struct sr_dev_inst *sdi);
1817 SR_PRIV int sr_dev_acquisition_stop(struct sr_dev_inst *sdi);
1818
1819 /*--- session.c -------------------------------------------------------------*/
1820
1821 struct sr_session {
1822         /** Context this session exists in. */
1823         struct sr_context *ctx;
1824         /** List of struct sr_dev_inst pointers. */
1825         GSList *devs;
1826         /** List of struct sr_dev_inst pointers owned by this session. */
1827         GSList *owned_devs;
1828         /** List of struct datafeed_callback pointers. */
1829         GSList *datafeed_callbacks;
1830         GSList *transforms;
1831         struct sr_trigger *trigger;
1832
1833         /** Callback to invoke on session stop. */
1834         sr_session_stopped_callback stopped_callback;
1835         /** User data to be passed to the session stop callback. */
1836         void *stopped_cb_data;
1837
1838         /** Mutex protecting the main context pointer. */
1839         GMutex main_mutex;
1840         /** Context of the session main loop. */
1841         GMainContext *main_context;
1842
1843         /** Registered event sources for this session. */
1844         GHashTable *event_sources;
1845         /** Session main loop. */
1846         GMainLoop *main_loop;
1847         /** ID of idle source for dispatching the session stop notification. */
1848         unsigned int stop_check_id;
1849         /** Whether the session has been started. */
1850         gboolean running;
1851 };
1852
1853 SR_PRIV int sr_session_source_add_internal(struct sr_session *session,
1854                 void *key, GSource *source);
1855 SR_PRIV int sr_session_source_remove_internal(struct sr_session *session,
1856                 void *key);
1857 SR_PRIV int sr_session_source_destroyed(struct sr_session *session,
1858                 void *key, GSource *source);
1859 SR_PRIV int sr_session_fd_source_add(struct sr_session *session,
1860                 void *key, gintptr fd, int events, int timeout,
1861                 sr_receive_data_callback cb, void *cb_data);
1862
1863 SR_PRIV int sr_session_source_add(struct sr_session *session, int fd,
1864                 int events, int timeout, sr_receive_data_callback cb, void *cb_data);
1865 SR_PRIV int sr_session_source_add_pollfd(struct sr_session *session,
1866                 GPollFD *pollfd, int timeout, sr_receive_data_callback cb,
1867                 void *cb_data);
1868 SR_PRIV int sr_session_source_add_channel(struct sr_session *session,
1869                 GIOChannel *channel, int events, int timeout,
1870                 sr_receive_data_callback cb, void *cb_data);
1871 SR_PRIV int sr_session_source_remove(struct sr_session *session, int fd);
1872 SR_PRIV int sr_session_source_remove_pollfd(struct sr_session *session,
1873                 GPollFD *pollfd);
1874 SR_PRIV int sr_session_source_remove_channel(struct sr_session *session,
1875                 GIOChannel *channel);
1876
1877 SR_PRIV int sr_session_send_meta(const struct sr_dev_inst *sdi,
1878                 uint32_t key, GVariant *var);
1879 SR_PRIV int sr_session_send(const struct sr_dev_inst *sdi,
1880                 const struct sr_datafeed_packet *packet);
1881 SR_PRIV int sr_sessionfile_check(const char *filename);
1882 SR_PRIV struct sr_dev_inst *sr_session_prepare_sdi(const char *filename,
1883                 struct sr_session **session);
1884
1885 /*--- session_file.c --------------------------------------------------------*/
1886
1887 #if !HAVE_ZIP_DISCARD
1888 /* Replace zip_discard() if not available. */
1889 #define zip_discard(zip) sr_zip_discard(zip)
1890 SR_PRIV void sr_zip_discard(struct zip *archive);
1891 #endif
1892
1893 SR_PRIV GKeyFile *sr_sessionfile_read_metadata(struct zip *archive,
1894                         const struct zip_stat *entry);
1895
1896 /*--- analog.c --------------------------------------------------------------*/
1897
1898 SR_PRIV int sr_analog_init(struct sr_datafeed_analog *analog,
1899                            struct sr_analog_encoding *encoding,
1900                            struct sr_analog_meaning *meaning,
1901                            struct sr_analog_spec *spec,
1902                            int digits);
1903
1904 /*--- std.c -----------------------------------------------------------------*/
1905
1906 typedef int (*dev_close_callback)(struct sr_dev_inst *sdi);
1907 typedef void (*std_dev_clear_callback)(void *priv);
1908
1909 SR_PRIV int std_init(struct sr_dev_driver *di, struct sr_context *sr_ctx);
1910 SR_PRIV int std_cleanup(const struct sr_dev_driver *di);
1911 SR_PRIV int std_dummy_dev_open(struct sr_dev_inst *sdi);
1912 SR_PRIV int std_dummy_dev_close(struct sr_dev_inst *sdi);
1913 SR_PRIV int std_dummy_dev_acquisition_start(const struct sr_dev_inst *sdi);
1914 SR_PRIV int std_dummy_dev_acquisition_stop(struct sr_dev_inst *sdi);
1915 #ifdef HAVE_SERIAL_COMM
1916 SR_PRIV int std_serial_dev_open(struct sr_dev_inst *sdi);
1917 SR_PRIV int std_serial_dev_acquisition_stop(struct sr_dev_inst *sdi);
1918 #endif
1919 SR_PRIV int std_session_send_df_header(const struct sr_dev_inst *sdi);
1920 SR_PRIV int std_session_send_df_end(const struct sr_dev_inst *sdi);
1921 SR_PRIV int std_session_send_df_trigger(const struct sr_dev_inst *sdi);
1922 SR_PRIV int std_session_send_df_frame_begin(const struct sr_dev_inst *sdi);
1923 SR_PRIV int std_session_send_df_frame_end(const struct sr_dev_inst *sdi);
1924 SR_PRIV int std_dev_clear_with_callback(const struct sr_dev_driver *driver,
1925                 std_dev_clear_callback clear_private);
1926 SR_PRIV int std_dev_clear(const struct sr_dev_driver *driver);
1927 SR_PRIV GSList *std_dev_list(const struct sr_dev_driver *di);
1928 SR_PRIV int std_serial_dev_close(struct sr_dev_inst *sdi);
1929 SR_PRIV GSList *std_scan_complete(struct sr_dev_driver *di, GSList *devices);
1930
1931 SR_PRIV int std_opts_config_list(uint32_t key, GVariant **data,
1932         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg,
1933         const uint32_t scanopts[], size_t scansize, const uint32_t drvopts[],
1934         size_t drvsize, const uint32_t devopts[], size_t devsize);
1935
1936 extern SR_PRIV const uint32_t NO_OPTS[1];
1937
1938 #define STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts) \
1939         std_opts_config_list(key, data, sdi, cg, ARRAY_AND_SIZE(scanopts), \
1940                 ARRAY_AND_SIZE(drvopts), ARRAY_AND_SIZE(devopts))
1941
1942 SR_PRIV GVariant *std_gvar_tuple_array(const uint64_t a[][2], unsigned int n);
1943 SR_PRIV GVariant *std_gvar_tuple_rational(const struct sr_rational *r, unsigned int n);
1944 SR_PRIV GVariant *std_gvar_samplerates(const uint64_t samplerates[], unsigned int n);
1945 SR_PRIV GVariant *std_gvar_samplerates_steps(const uint64_t samplerates[], unsigned int n);
1946 SR_PRIV GVariant *std_gvar_min_max_step(double min, double max, double step);
1947 SR_PRIV GVariant *std_gvar_min_max_step_array(const double a[3]);
1948 SR_PRIV GVariant *std_gvar_min_max_step_thresholds(const double dmin, const double dmax, const double dstep);
1949
1950 SR_PRIV GVariant *std_gvar_tuple_u64(uint64_t low, uint64_t high);
1951 SR_PRIV GVariant *std_gvar_tuple_double(double low, double high);
1952
1953 SR_PRIV GVariant *std_gvar_array_i32(const int32_t a[], unsigned int n);
1954 SR_PRIV GVariant *std_gvar_array_u32(const uint32_t a[], unsigned int n);
1955 SR_PRIV GVariant *std_gvar_array_u64(const uint64_t a[], unsigned int n);
1956 SR_PRIV GVariant *std_gvar_array_str(const char *a[], unsigned int n);
1957
1958 SR_PRIV GVariant *std_gvar_thresholds(const double a[][2], unsigned int n);
1959
1960 SR_PRIV int std_str_idx(GVariant *data, const char *a[], unsigned int n);
1961 SR_PRIV int std_u64_idx(GVariant *data, const uint64_t a[], unsigned int n);
1962 SR_PRIV int std_u8_idx(GVariant *data, const uint8_t a[], unsigned int n);
1963
1964 SR_PRIV int std_str_idx_s(const char *s, const char *a[], unsigned int n);
1965 SR_PRIV int std_u8_idx_s(uint8_t b, const uint8_t a[], unsigned int n);
1966
1967 SR_PRIV int std_u64_tuple_idx(GVariant *data, const uint64_t a[][2], unsigned int n);
1968 SR_PRIV int std_double_tuple_idx(GVariant *data, const double a[][2], unsigned int n);
1969 SR_PRIV int std_double_tuple_idx_d0(const double d, const double a[][2], unsigned int n);
1970
1971 SR_PRIV int std_cg_idx(const struct sr_channel_group *cg, struct sr_channel_group *a[], unsigned int n);
1972
1973 SR_PRIV int std_dummy_set_params(struct sr_serial_dev_inst *serial,
1974         int baudrate, int bits, int parity, int stopbits,
1975         int flowcontrol, int rts, int dtr);
1976 SR_PRIV int std_dummy_set_handshake(struct sr_serial_dev_inst *serial,
1977         int rts, int dtr);
1978
1979 /*--- resource.c ------------------------------------------------------------*/
1980
1981 SR_PRIV int64_t sr_file_get_size(FILE *file);
1982
1983 SR_PRIV int sr_resource_open(struct sr_context *ctx,
1984                 struct sr_resource *res, int type, const char *name)
1985                 G_GNUC_WARN_UNUSED_RESULT;
1986 SR_PRIV int sr_resource_close(struct sr_context *ctx,
1987                 struct sr_resource *res);
1988 SR_PRIV gssize sr_resource_read(struct sr_context *ctx,
1989                 const struct sr_resource *res, void *buf, size_t count)
1990                 G_GNUC_WARN_UNUSED_RESULT;
1991 SR_PRIV void *sr_resource_load(struct sr_context *ctx, int type,
1992                 const char *name, size_t *size, size_t max_size)
1993                 G_GNUC_MALLOC G_GNUC_WARN_UNUSED_RESULT;
1994
1995 /*--- strutil.c -------------------------------------------------------------*/
1996
1997 SR_PRIV int sr_atol(const char *str, long *ret);
1998 SR_PRIV int sr_atol_base(const char *str, long *ret, char **end, int base);
1999 SR_PRIV int sr_atoul_base(const char *str, unsigned long *ret, char **end, int base);
2000 SR_PRIV int sr_atoi(const char *str, int *ret);
2001 SR_PRIV int sr_atod(const char *str, double *ret);
2002 SR_PRIV int sr_atof(const char *str, float *ret);
2003 SR_PRIV int sr_atod_ascii(const char *str, double *ret);
2004 SR_PRIV int sr_atod_ascii_digits(const char *str, double *ret, int *digits);
2005 SR_PRIV int sr_atof_ascii(const char *str, float *ret);
2006
2007 SR_PRIV GString *sr_hexdump_new(const uint8_t *data, const size_t len);
2008 SR_PRIV void sr_hexdump_free(GString *s);
2009
2010 /*--- soft-trigger.c --------------------------------------------------------*/
2011
2012 struct soft_trigger_logic {
2013         const struct sr_dev_inst *sdi;
2014         const struct sr_trigger *trigger;
2015         int count;
2016         int unitsize;
2017         int cur_stage;
2018         uint8_t *prev_sample;
2019         uint8_t *pre_trigger_buffer;
2020         uint8_t *pre_trigger_head;
2021         int pre_trigger_size;
2022         int pre_trigger_fill;
2023 };
2024
2025 SR_PRIV int logic_channel_unitsize(GSList *channels);
2026 SR_PRIV struct soft_trigger_logic *soft_trigger_logic_new(
2027                 const struct sr_dev_inst *sdi, struct sr_trigger *trigger,
2028                 int pre_trigger_samples);
2029 SR_PRIV void soft_trigger_logic_free(struct soft_trigger_logic *st);
2030 SR_PRIV int soft_trigger_logic_check(struct soft_trigger_logic *st, uint8_t *buf,
2031                 int len, int *pre_trigger_samples);
2032
2033 /*--- serial.c --------------------------------------------------------------*/
2034
2035 #ifdef HAVE_SERIAL_COMM
2036 enum {
2037         SERIAL_RDWR = 1,
2038         SERIAL_RDONLY = 2,
2039 };
2040
2041 typedef gboolean (*packet_valid_callback)(const uint8_t *buf);
2042 typedef int (*packet_valid_len_callback)(void *st,
2043         const uint8_t *p, size_t l, size_t *pl);
2044
2045 typedef GSList *(*sr_ser_list_append_t)(GSList *devs, const char *name,
2046                 const char *desc);
2047 typedef GSList *(*sr_ser_find_append_t)(GSList *devs, const char *name);
2048
2049 SR_PRIV int serial_open(struct sr_serial_dev_inst *serial, int flags);
2050 SR_PRIV int serial_close(struct sr_serial_dev_inst *serial);
2051 SR_PRIV int serial_flush(struct sr_serial_dev_inst *serial);
2052 SR_PRIV int serial_drain(struct sr_serial_dev_inst *serial);
2053 SR_PRIV size_t serial_has_receive_data(struct sr_serial_dev_inst *serial);
2054 SR_PRIV int serial_write_blocking(struct sr_serial_dev_inst *serial,
2055                 const void *buf, size_t count, unsigned int timeout_ms);
2056 SR_PRIV int serial_write_nonblocking(struct sr_serial_dev_inst *serial,
2057                 const void *buf, size_t count);
2058 SR_PRIV int serial_read_blocking(struct sr_serial_dev_inst *serial, void *buf,
2059                 size_t count, unsigned int timeout_ms);
2060 SR_PRIV int serial_read_nonblocking(struct sr_serial_dev_inst *serial, void *buf,
2061                 size_t count);
2062 SR_PRIV int serial_set_read_chunk_cb(struct sr_serial_dev_inst *serial,
2063                 serial_rx_chunk_callback cb, void *cb_data);
2064 SR_PRIV int serial_set_params(struct sr_serial_dev_inst *serial, int baudrate,
2065                 int bits, int parity, int stopbits, int flowcontrol, int rts, int dtr);
2066 SR_PRIV int serial_set_handshake(struct sr_serial_dev_inst *serial,
2067                 int rts, int dtr);
2068 SR_PRIV int serial_set_paramstr(struct sr_serial_dev_inst *serial,
2069                 const char *paramstr);
2070 SR_PRIV int serial_readline(struct sr_serial_dev_inst *serial, char **buf,
2071                 int *buflen, gint64 timeout_ms);
2072 SR_PRIV int serial_stream_detect(struct sr_serial_dev_inst *serial,
2073                 uint8_t *buf, size_t *buflen,
2074                 size_t packet_size, packet_valid_callback is_valid,
2075                 packet_valid_len_callback is_valid_len, size_t *return_size,
2076                 uint64_t timeout_ms);
2077 SR_PRIV int serial_source_add(struct sr_session *session,
2078                 struct sr_serial_dev_inst *serial, int events, int timeout,
2079                 sr_receive_data_callback cb, void *cb_data);
2080 SR_PRIV int serial_source_remove(struct sr_session *session,
2081                 struct sr_serial_dev_inst *serial);
2082 SR_PRIV GSList *sr_serial_find_usb(uint16_t vendor_id, uint16_t product_id);
2083 SR_PRIV int serial_timeout(struct sr_serial_dev_inst *port, int num_bytes);
2084
2085 SR_PRIV void sr_ser_discard_queued_data(struct sr_serial_dev_inst *serial);
2086 SR_PRIV size_t sr_ser_has_queued_data(struct sr_serial_dev_inst *serial);
2087 SR_PRIV void sr_ser_queue_rx_data(struct sr_serial_dev_inst *serial,
2088                 const uint8_t *data, size_t len);
2089 SR_PRIV size_t sr_ser_unqueue_rx_data(struct sr_serial_dev_inst *serial,
2090                 uint8_t *data, size_t len);
2091
2092 struct ser_lib_functions {
2093         int (*open)(struct sr_serial_dev_inst *serial, int flags);
2094         int (*close)(struct sr_serial_dev_inst *serial);
2095         int (*flush)(struct sr_serial_dev_inst *serial);
2096         int (*drain)(struct sr_serial_dev_inst *serial);
2097         int (*write)(struct sr_serial_dev_inst *serial,
2098                         const void *buf, size_t count,
2099                         int nonblocking, unsigned int timeout_ms);
2100         int (*read)(struct sr_serial_dev_inst *serial,
2101                         void *buf, size_t count,
2102                         int nonblocking, unsigned int timeout_ms);
2103         int (*set_params)(struct sr_serial_dev_inst *serial,
2104                         int baudrate, int bits, int parity, int stopbits,
2105                         int flowcontrol, int rts, int dtr);
2106         int (*set_handshake)(struct sr_serial_dev_inst *serial,
2107                         int rts, int dtr);
2108         int (*setup_source_add)(struct sr_session *session,
2109                         struct sr_serial_dev_inst *serial,
2110                         int events, int timeout,
2111                         sr_receive_data_callback cb, void *cb_data);
2112         int (*setup_source_remove)(struct sr_session *session,
2113                         struct sr_serial_dev_inst *serial);
2114         GSList *(*list)(GSList *list, sr_ser_list_append_t append);
2115         GSList *(*find_usb)(GSList *list, sr_ser_find_append_t append,
2116                         uint16_t vendor_id, uint16_t product_id);
2117         int (*get_frame_format)(struct sr_serial_dev_inst *serial,
2118                         int *baud, int *bits);
2119         size_t (*get_rx_avail)(struct sr_serial_dev_inst *serial);
2120 };
2121 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_libsp;
2122 SR_PRIV int ser_name_is_hid(struct sr_serial_dev_inst *serial);
2123 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_hid;
2124 SR_PRIV int ser_name_is_bt(struct sr_serial_dev_inst *serial);
2125 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_bt;
2126 SR_PRIV int ser_name_is_tcpraw(struct sr_serial_dev_inst *serial);
2127 extern SR_PRIV struct ser_lib_functions *ser_lib_funcs_tcpraw;
2128
2129 #ifdef HAVE_LIBHIDAPI
2130 struct vid_pid_item {
2131         uint16_t vid, pid;
2132 };
2133
2134 struct ser_hid_chip_functions {
2135         const char *chipname;
2136         const char *chipdesc;
2137         const struct vid_pid_item *vid_pid_items;
2138         const int max_bytes_per_request;
2139         int (*set_params)(struct sr_serial_dev_inst *serial,
2140                         int baudrate, int bits, int parity, int stopbits,
2141                         int flowcontrol, int rts, int dtr);
2142         int (*read_bytes)(struct sr_serial_dev_inst *serial,
2143                         uint8_t *data, int space, unsigned int timeout);
2144         int (*write_bytes)(struct sr_serial_dev_inst *serial,
2145                         const uint8_t *data, int space);
2146         int (*flush)(struct sr_serial_dev_inst *serial);
2147         int (*drain)(struct sr_serial_dev_inst *serial);
2148 };
2149 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_bu86x;
2150 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_ch9325;
2151 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_cp2110;
2152 extern SR_PRIV struct ser_hid_chip_functions *ser_hid_chip_funcs_victor;
2153 SR_PRIV const char *ser_hid_chip_find_name_vid_pid(uint16_t vid, uint16_t pid);
2154 #endif
2155 #endif
2156
2157 SR_PRIV int sr_serial_extract_options(GSList *options,
2158         const char **serial_device, const char **serial_options);
2159
2160 /*--- bt/ API ---------------------------------------------------------------*/
2161
2162 #ifdef HAVE_BLUETOOTH
2163 SR_PRIV const char *sr_bt_adapter_get_address(size_t idx);
2164
2165 struct sr_bt_desc;
2166 typedef void (*sr_bt_scan_cb)(void *cb_data, const char *addr, const char *name);
2167 typedef int (*sr_bt_data_cb)(void *cb_data, uint8_t *data, size_t dlen);
2168
2169 SR_PRIV struct sr_bt_desc *sr_bt_desc_new(void);
2170 SR_PRIV void sr_bt_desc_free(struct sr_bt_desc *desc);
2171
2172 SR_PRIV int sr_bt_config_cb_scan(struct sr_bt_desc *desc,
2173         sr_bt_scan_cb cb, void *cb_data);
2174 SR_PRIV int sr_bt_config_cb_data(struct sr_bt_desc *desc,
2175         sr_bt_data_cb cb, void *cb_data);
2176 SR_PRIV int sr_bt_config_addr_local(struct sr_bt_desc *desc, const char *addr);
2177 SR_PRIV int sr_bt_config_addr_remote(struct sr_bt_desc *desc, const char *addr);
2178 SR_PRIV int sr_bt_config_rfcomm(struct sr_bt_desc *desc, size_t channel);
2179 SR_PRIV int sr_bt_config_notify(struct sr_bt_desc *desc,
2180         uint16_t read_handle, uint16_t write_handle,
2181         uint16_t cccd_handle, uint16_t cccd_value,
2182         uint16_t ble_mtu);
2183
2184 SR_PRIV int sr_bt_scan_le(struct sr_bt_desc *desc, int duration);
2185 SR_PRIV int sr_bt_scan_bt(struct sr_bt_desc *desc, int duration);
2186
2187 SR_PRIV int sr_bt_connect_ble(struct sr_bt_desc *desc);
2188 SR_PRIV int sr_bt_connect_rfcomm(struct sr_bt_desc *desc);
2189 SR_PRIV void sr_bt_disconnect(struct sr_bt_desc *desc);
2190
2191 SR_PRIV ssize_t sr_bt_read(struct sr_bt_desc *desc,
2192         void *data, size_t len);
2193 SR_PRIV ssize_t sr_bt_write(struct sr_bt_desc *desc,
2194         const void *data, size_t len);
2195
2196 SR_PRIV int sr_bt_start_notify(struct sr_bt_desc *desc);
2197 SR_PRIV int sr_bt_check_notify(struct sr_bt_desc *desc);
2198 #endif
2199
2200 /*--- ezusb.c ---------------------------------------------------------------*/
2201
2202 #ifdef HAVE_LIBUSB_1_0
2203 SR_PRIV int ezusb_reset(struct libusb_device_handle *hdl, int set_clear);
2204 SR_PRIV int ezusb_install_firmware(struct sr_context *ctx, libusb_device_handle *hdl,
2205                                    const char *name);
2206 SR_PRIV int ezusb_upload_firmware(struct sr_context *ctx, libusb_device *dev,
2207                                   int configuration, const char *name);
2208 #endif
2209
2210 /*--- usb.c -----------------------------------------------------------------*/
2211
2212 SR_PRIV int sr_usb_split_conn(const char *conn,
2213         uint16_t *vid, uint16_t *pid, uint8_t *bus, uint8_t *addr);
2214 #ifdef HAVE_LIBUSB_1_0
2215 SR_PRIV GSList *sr_usb_find(libusb_context *usb_ctx, const char *conn);
2216 SR_PRIV int sr_usb_open(libusb_context *usb_ctx, struct sr_usb_dev_inst *usb);
2217 SR_PRIV void sr_usb_close(struct sr_usb_dev_inst *usb);
2218 SR_PRIV int usb_source_add(struct sr_session *session, struct sr_context *ctx,
2219                 int timeout, sr_receive_data_callback cb, void *cb_data);
2220 SR_PRIV int usb_source_remove(struct sr_session *session, struct sr_context *ctx);
2221 SR_PRIV int usb_get_port_path(libusb_device *dev, char *path, int path_len);
2222 SR_PRIV gboolean usb_match_manuf_prod(libusb_device *dev,
2223                 const char *manufacturer, const char *product);
2224 #endif
2225
2226 /*--- tcp.c -----------------------------------------------------------------*/
2227
2228 SR_PRIV gboolean sr_fd_is_readable(int fd);
2229
2230 SR_PRIV struct sr_tcp_dev_inst *sr_tcp_dev_inst_new(
2231         const char *host_addr, const char *tcp_port);
2232 SR_PRIV void sr_tcp_dev_inst_free(struct sr_tcp_dev_inst *tcp);
2233 SR_PRIV int sr_tcp_get_port_path(struct sr_tcp_dev_inst *tcp,
2234         const char *prefix, char separator, char *path, size_t path_len);
2235 SR_PRIV int sr_tcp_connect(struct sr_tcp_dev_inst *tcp);
2236 SR_PRIV int sr_tcp_disconnect(struct sr_tcp_dev_inst *tcp);
2237 SR_PRIV int sr_tcp_write_bytes(struct sr_tcp_dev_inst *tcp,
2238         const uint8_t *data, size_t dlen);
2239 SR_PRIV int sr_tcp_read_bytes(struct sr_tcp_dev_inst *tcp,
2240         uint8_t *data, size_t dlen, gboolean nonblocking);
2241 SR_PRIV int sr_tcp_source_add(struct sr_session *session,
2242         struct sr_tcp_dev_inst *tcp, int events, int timeout,
2243         sr_receive_data_callback cb, void *cb_data);
2244 SR_PRIV int sr_tcp_source_remove(struct sr_session *session,
2245         struct sr_tcp_dev_inst *tcp);
2246
2247 /*--- binary_helpers.c ------------------------------------------------------*/
2248
2249 /** Binary value type */
2250 enum binary_value_type {
2251         BVT_INVALID,
2252
2253         BVT_UINT8,
2254
2255         BVT_BE_UINT16,
2256         BVT_BE_UINT24,
2257         BVT_BE_UINT32,
2258
2259         BVT_LE_UINT16,
2260         BVT_LE_UINT24,
2261         BVT_LE_UINT32,
2262 };
2263
2264 /** Binary value specification */
2265 struct binary_value_spec {
2266         size_t offset;                  /**!< Offset into binary image */
2267         enum binary_value_type type;    /**!< Data type to decode */
2268 };
2269
2270 /**
2271  * Read extract a value from a binary data image, ensuring no out-of-bounds
2272  * read happens.
2273  *
2274  * @param[out] out Pointer to output buffer (conversion result)
2275  * @param[in] spec Binary value specification
2276  * @param[in] data Pointer to binary input data
2277  * @param[in] length Size of binary input data
2278  *
2279  * @return SR_OK on success, SR_ERR_* error code on failure.
2280  */
2281 SR_PRIV int bv_get_value_len(float *out, const struct binary_value_spec *spec,
2282         const uint8_t *data, size_t length);
2283
2284 /**
2285  * Read extract a value from a binary data image, without bound check.
2286  *
2287  * @param[out] out Pointer to output buffer (conversion result)
2288  * @param[in] spec Binary value specification
2289  * @param[in] data Pointer to binary input data
2290  *
2291  * @return SR_OK on success, SR_ERR_* error code on failure.
2292  */
2293 SR_PRIV int bv_get_value(float *out, const struct binary_value_spec *spec,
2294         const uint8_t *data);
2295
2296 /*--- crc.c -----------------------------------------------------------------*/
2297
2298 #define SR_CRC16_DEFAULT_INIT 0xffffU
2299
2300 /**
2301  * Calculate a CRC16 checksum using the 0x8005 polynomial.
2302  *
2303  * This CRC16 flavor is also known as CRC16-ANSI or CRC16-MODBUS.
2304  *
2305  * @param crc Initial value (typically 0xffff)
2306  * @param buffer Input buffer
2307  * @param len Buffer length
2308  * @return Checksum
2309  */
2310 SR_PRIV uint16_t sr_crc16(uint16_t crc, const uint8_t *buffer, int len);
2311
2312 /*--- modbus/modbus.c -------------------------------------------------------*/
2313
2314 struct sr_modbus_dev_inst {
2315         const char *name;
2316         const char *prefix;
2317         int priv_size;
2318         GSList *(*scan)(int modbusaddr);
2319         int (*dev_inst_new)(void *priv, const char *resource,
2320                 char **params, const char *serialcomm, int modbusaddr);
2321         int (*open)(void *priv);
2322         int (*source_add)(struct sr_session *session, void *priv, int events,
2323                 int timeout, sr_receive_data_callback cb, void *cb_data);
2324         int (*source_remove)(struct sr_session *session, void *priv);
2325         int (*send)(void *priv, const uint8_t *buffer, int buffer_size);
2326         int (*read_begin)(void *priv, uint8_t *function_code);
2327         int (*read_data)(void *priv, uint8_t *buf, int maxlen);
2328         int (*read_end)(void *priv);
2329         int (*close)(void *priv);
2330         void (*free)(void *priv);
2331         unsigned int read_timeout_ms;
2332         void *priv;
2333 };
2334
2335 SR_PRIV GSList *sr_modbus_scan(struct drv_context *drvc, GSList *options,
2336                 struct sr_dev_inst *(*probe_device)(struct sr_modbus_dev_inst *modbus));
2337 SR_PRIV struct sr_modbus_dev_inst *modbus_dev_inst_new(const char *resource,
2338                 const char *serialcomm, int modbusaddr);
2339 SR_PRIV int sr_modbus_open(struct sr_modbus_dev_inst *modbus);
2340 SR_PRIV int sr_modbus_source_add(struct sr_session *session,
2341                 struct sr_modbus_dev_inst *modbus, int events, int timeout,
2342                 sr_receive_data_callback cb, void *cb_data);
2343 SR_PRIV int sr_modbus_source_remove(struct sr_session *session,
2344                 struct sr_modbus_dev_inst *modbus);
2345 SR_PRIV int sr_modbus_request(struct sr_modbus_dev_inst *modbus,
2346                               uint8_t *request, int request_size);
2347 SR_PRIV int sr_modbus_reply(struct sr_modbus_dev_inst *modbus,
2348                             uint8_t *reply, int reply_size);
2349 SR_PRIV int sr_modbus_request_reply(struct sr_modbus_dev_inst *modbus,
2350                                     uint8_t *request, int request_size,
2351                                     uint8_t *reply, int reply_size);
2352 SR_PRIV int sr_modbus_read_coils(struct sr_modbus_dev_inst *modbus,
2353                                  int address, int nb_coils, uint8_t *coils);
2354 SR_PRIV int sr_modbus_read_holding_registers(struct sr_modbus_dev_inst *modbus,
2355                                              int address, int nb_registers,
2356                                              uint16_t *registers);
2357 SR_PRIV int sr_modbus_write_coil(struct sr_modbus_dev_inst *modbus,
2358                                  int address, int value);
2359 SR_PRIV int sr_modbus_write_multiple_registers(struct sr_modbus_dev_inst*modbus,
2360                                                int address, int nb_registers,
2361                                                uint16_t *registers);
2362 SR_PRIV int sr_modbus_close(struct sr_modbus_dev_inst *modbus);
2363 SR_PRIV void sr_modbus_free(struct sr_modbus_dev_inst *modbus);
2364
2365 /*--- dmm/es519xx.c ---------------------------------------------------------*/
2366
2367 /**
2368  * All 11-byte es519xx chips repeat each block twice for each conversion cycle
2369  * so always read 2 blocks at a time.
2370  */
2371 #define ES519XX_11B_PACKET_SIZE (11 * 2)
2372 #define ES519XX_14B_PACKET_SIZE 14
2373
2374 struct es519xx_info {
2375         gboolean is_judge, is_voltage, is_auto, is_micro, is_current;
2376         gboolean is_milli, is_resistance, is_continuity, is_diode;
2377         gboolean is_frequency, is_rpm, is_capacitance, is_duty_cycle;
2378         gboolean is_temperature, is_celsius, is_fahrenheit;
2379         gboolean is_adp0, is_adp1, is_adp2, is_adp3;
2380         gboolean is_sign, is_batt, is_ol, is_pmax, is_pmin, is_apo;
2381         gboolean is_dc, is_ac, is_vahz, is_min, is_max, is_rel, is_hold;
2382         gboolean is_digit4, is_ul, is_vasel, is_vbar, is_lpf1, is_lpf0, is_rmr;
2383         uint32_t baudrate;
2384         int packet_size;
2385         gboolean alt_functions, fivedigits, clampmeter, selectable_lpf;
2386         int digits;
2387 };
2388
2389 SR_PRIV gboolean sr_es519xx_2400_11b_packet_valid(const uint8_t *buf);
2390 SR_PRIV int sr_es519xx_2400_11b_parse(const uint8_t *buf, float *floatval,
2391                 struct sr_datafeed_analog *analog, void *info);
2392 SR_PRIV gboolean sr_es519xx_2400_11b_altfn_packet_valid(const uint8_t *buf);
2393 SR_PRIV int sr_es519xx_2400_11b_altfn_parse(const uint8_t *buf,
2394                 float *floatval, struct sr_datafeed_analog *analog, void *info);
2395 SR_PRIV gboolean sr_es519xx_19200_11b_5digits_packet_valid(const uint8_t *buf);
2396 SR_PRIV int sr_es519xx_19200_11b_5digits_parse(const uint8_t *buf,
2397                 float *floatval, struct sr_datafeed_analog *analog, void *info);
2398 SR_PRIV gboolean sr_es519xx_19200_11b_clamp_packet_valid(const uint8_t *buf);
2399 SR_PRIV int sr_es519xx_19200_11b_clamp_parse(const uint8_t *buf,
2400                 float *floatval, struct sr_datafeed_analog *analog, void *info);
2401 SR_PRIV gboolean sr_es519xx_19200_11b_packet_valid(const uint8_t *buf);
2402 SR_PRIV int sr_es519xx_19200_11b_parse(const uint8_t *buf, float *floatval,
2403                 struct sr_datafeed_analog *analog, void *info);
2404 SR_PRIV gboolean sr_es519xx_19200_14b_packet_valid(const uint8_t *buf);
2405 SR_PRIV int sr_es519xx_19200_14b_parse(const uint8_t *buf, float *floatval,
2406                 struct sr_datafeed_analog *analog, void *info);
2407 SR_PRIV gboolean sr_es519xx_19200_14b_sel_lpf_packet_valid(const uint8_t *buf);
2408 SR_PRIV int sr_es519xx_19200_14b_sel_lpf_parse(const uint8_t *buf,
2409                 float *floatval, struct sr_datafeed_analog *analog, void *info);
2410
2411 /*--- dmm/fs9922.c ----------------------------------------------------------*/
2412
2413 #define FS9922_PACKET_SIZE 14
2414
2415 struct fs9922_info {
2416         gboolean is_auto, is_dc, is_ac, is_rel, is_hold, is_bpn, is_z1, is_z2;
2417         gboolean is_max, is_min, is_apo, is_bat, is_nano, is_z3, is_micro;
2418         gboolean is_milli, is_kilo, is_mega, is_beep, is_diode, is_percent;
2419         gboolean is_z4, is_volt, is_ampere, is_ohm, is_hfe, is_hertz, is_farad;
2420         gboolean is_celsius, is_fahrenheit;
2421         int bargraph_sign, bargraph_value;
2422 };
2423
2424 SR_PRIV gboolean sr_fs9922_packet_valid(const uint8_t *buf);
2425 SR_PRIV int sr_fs9922_parse(const uint8_t *buf, float *floatval,
2426                             struct sr_datafeed_analog *analog, void *info);
2427 SR_PRIV void sr_fs9922_z1_diode(struct sr_datafeed_analog *analog, void *info);
2428
2429 /*--- dmm/fs9721.c ----------------------------------------------------------*/
2430
2431 #define FS9721_PACKET_SIZE 14
2432
2433 struct fs9721_info {
2434         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2435         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2436         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2437         gboolean is_c2c1_11, is_c2c1_10, is_c2c1_01, is_c2c1_00, is_sign;
2438 };
2439
2440 SR_PRIV gboolean sr_fs9721_packet_valid(const uint8_t *buf);
2441 SR_PRIV int sr_fs9721_parse(const uint8_t *buf, float *floatval,
2442                             struct sr_datafeed_analog *analog, void *info);
2443 SR_PRIV void sr_fs9721_00_temp_c(struct sr_datafeed_analog *analog, void *info);
2444 SR_PRIV void sr_fs9721_01_temp_c(struct sr_datafeed_analog *analog, void *info);
2445 SR_PRIV void sr_fs9721_10_temp_c(struct sr_datafeed_analog *analog, void *info);
2446 SR_PRIV void sr_fs9721_01_10_temp_f_c(struct sr_datafeed_analog *analog, void *info);
2447 SR_PRIV void sr_fs9721_max_c_min(struct sr_datafeed_analog *analog, void *info);
2448
2449 /*--- dmm/mm38xr.c ---------------------------------------------------------*/
2450
2451 #define METERMAN_38XR_PACKET_SIZE 15
2452
2453 struct meterman_38xr_info { int dummy; };
2454
2455 SR_PRIV gboolean meterman_38xr_packet_valid(const uint8_t *buf);
2456 SR_PRIV int meterman_38xr_parse(const uint8_t *buf, float *floatval,
2457         struct sr_datafeed_analog *analog, void *info);
2458
2459 /*--- dmm/ms2115b.c ---------------------------------------------------------*/
2460
2461 #define MS2115B_PACKET_SIZE 9
2462
2463 enum ms2115b_display {
2464         MS2115B_DISPLAY_MAIN,
2465         MS2115B_DISPLAY_SUB,
2466         MS2115B_DISPLAY_COUNT,
2467 };
2468
2469 struct ms2115b_info {
2470         /* Selected channel. */
2471         size_t ch_idx;
2472         gboolean is_ac, is_dc, is_auto;
2473         gboolean is_diode, is_beep, is_farad;
2474         gboolean is_ohm, is_ampere, is_volt, is_hz;
2475         gboolean is_duty_cycle, is_percent;
2476 };
2477
2478 extern SR_PRIV const char *ms2115b_channel_formats[];
2479 SR_PRIV gboolean sr_ms2115b_packet_valid(const uint8_t *buf);
2480 SR_PRIV int sr_ms2115b_parse(const uint8_t *buf, float *floatval,
2481         struct sr_datafeed_analog *analog, void *info);
2482
2483 /*--- dmm/ms8250d.c ---------------------------------------------------------*/
2484
2485 #define MS8250D_PACKET_SIZE 18
2486
2487 struct ms8250d_info {
2488         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2489         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2490         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2491         gboolean is_ncv, is_min, is_max, is_sign, is_autotimer;
2492 };
2493
2494 SR_PRIV gboolean sr_ms8250d_packet_valid(const uint8_t *buf);
2495 SR_PRIV int sr_ms8250d_parse(const uint8_t *buf, float *floatval,
2496                              struct sr_datafeed_analog *analog, void *info);
2497
2498 /*--- dmm/dtm0660.c ---------------------------------------------------------*/
2499
2500 #define DTM0660_PACKET_SIZE 15
2501
2502 struct dtm0660_info {
2503         gboolean is_ac, is_dc, is_auto, is_rs232, is_micro, is_nano, is_kilo;
2504         gboolean is_diode, is_milli, is_percent, is_mega, is_beep, is_farad;
2505         gboolean is_ohm, is_rel, is_hold, is_ampere, is_volt, is_hz, is_bat;
2506         gboolean is_degf, is_degc, is_c2c1_01, is_c2c1_00, is_apo, is_min;
2507         gboolean is_minmax, is_max, is_sign;
2508 };
2509
2510 SR_PRIV gboolean sr_dtm0660_packet_valid(const uint8_t *buf);
2511 SR_PRIV int sr_dtm0660_parse(const uint8_t *buf, float *floatval,
2512                         struct sr_datafeed_analog *analog, void *info);
2513
2514 /*--- dmm/m2110.c -----------------------------------------------------------*/
2515
2516 #define BBCGM_M2110_PACKET_SIZE 9
2517
2518 /* Dummy info struct. The parser does not use it. */
2519 struct m2110_info { int dummy; };
2520
2521 SR_PRIV gboolean sr_m2110_packet_valid(const uint8_t *buf);
2522 SR_PRIV int sr_m2110_parse(const uint8_t *buf, float *floatval,
2523                              struct sr_datafeed_analog *analog, void *info);
2524
2525 /*--- dmm/metex14.c ---------------------------------------------------------*/
2526
2527 #define METEX14_PACKET_SIZE 14
2528
2529 struct metex14_info {
2530         size_t ch_idx;
2531         gboolean is_ac, is_dc, is_resistance, is_capacity, is_temperature;
2532         gboolean is_diode, is_frequency, is_ampere, is_volt, is_farad;
2533         gboolean is_hertz, is_ohm, is_celsius, is_fahrenheit, is_watt;
2534         gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2535         gboolean is_gain, is_decibel, is_power, is_decibel_mw, is_power_factor;
2536         gboolean is_hfe, is_unitless, is_logic, is_min, is_max, is_avg;
2537 };
2538
2539 #ifdef HAVE_SERIAL_COMM
2540 SR_PRIV int sr_metex14_packet_request(struct sr_serial_dev_inst *serial);
2541 #endif
2542 SR_PRIV gboolean sr_metex14_packet_valid(const uint8_t *buf);
2543 SR_PRIV int sr_metex14_parse(const uint8_t *buf, float *floatval,
2544                              struct sr_datafeed_analog *analog, void *info);
2545 SR_PRIV gboolean sr_metex14_4packets_valid(const uint8_t *buf);
2546 SR_PRIV int sr_metex14_4packets_parse(const uint8_t *buf, float *floatval,
2547                              struct sr_datafeed_analog *analog, void *info);
2548
2549 /*--- dmm/rs9lcd.c ----------------------------------------------------------*/
2550
2551 #define RS9LCD_PACKET_SIZE 9
2552
2553 /* Dummy info struct. The parser does not use it. */
2554 struct rs9lcd_info { int dummy; };
2555
2556 SR_PRIV gboolean sr_rs9lcd_packet_valid(const uint8_t *buf);
2557 SR_PRIV int sr_rs9lcd_parse(const uint8_t *buf, float *floatval,
2558                             struct sr_datafeed_analog *analog, void *info);
2559
2560 /*--- dmm/bm25x.c -----------------------------------------------------------*/
2561
2562 #define BRYMEN_BM25X_PACKET_SIZE 15
2563
2564 /* Dummy info struct. The parser does not use it. */
2565 struct bm25x_info { int dummy; };
2566
2567 SR_PRIV gboolean sr_brymen_bm25x_packet_valid(const uint8_t *buf);
2568 SR_PRIV int sr_brymen_bm25x_parse(const uint8_t *buf, float *floatval,
2569                              struct sr_datafeed_analog *analog, void *info);
2570
2571 /*--- dmm/bm52x.c -----------------------------------------------------------*/
2572
2573 #define BRYMEN_BM52X_PACKET_SIZE 24
2574 #define BRYMEN_BM52X_DISPLAY_COUNT 2
2575
2576 struct brymen_bm52x_info { size_t ch_idx; };
2577
2578 #ifdef HAVE_SERIAL_COMM
2579 SR_PRIV int sr_brymen_bm52x_packet_request(struct sr_serial_dev_inst *serial);
2580 SR_PRIV int sr_brymen_bm82x_packet_request(struct sr_serial_dev_inst *serial);
2581 #endif
2582 SR_PRIV gboolean sr_brymen_bm52x_packet_valid(const uint8_t *buf);
2583 SR_PRIV gboolean sr_brymen_bm82x_packet_valid(const uint8_t *buf);
2584 /* BM520s and BM820s protocols are similar, the parse routine is shared. */
2585 SR_PRIV int sr_brymen_bm52x_parse(const uint8_t *buf, float *floatval,
2586                 struct sr_datafeed_analog *analog, void *info);
2587
2588 struct brymen_bm52x_state;
2589
2590 SR_PRIV void *brymen_bm52x_state_init(void);
2591 SR_PRIV void brymen_bm52x_state_free(void *state);
2592 SR_PRIV int brymen_bm52x_config_get(void *state, uint32_t key, GVariant **data,
2593         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2594 SR_PRIV int brymen_bm52x_config_set(void *state, uint32_t key, GVariant *data,
2595         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2596 SR_PRIV int brymen_bm52x_config_list(void *state, uint32_t key, GVariant **data,
2597         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2598 SR_PRIV int brymen_bm52x_acquire_start(void *state,
2599         const struct sr_dev_inst *sdi,
2600         sr_receive_data_callback *cb, void **cb_data);
2601
2602 /*--- dmm/bm85x.c -----------------------------------------------------------*/
2603
2604 #define BRYMEN_BM85x_PACKET_SIZE_MIN 4
2605
2606 struct brymen_bm85x_info { int dummy; };
2607
2608 #ifdef HAVE_SERIAL_COMM
2609 SR_PRIV int brymen_bm85x_after_open(struct sr_serial_dev_inst *serial);
2610 SR_PRIV int brymen_bm85x_packet_request(struct sr_serial_dev_inst *serial);
2611 #endif
2612 SR_PRIV gboolean brymen_bm85x_packet_valid(void *state,
2613         const uint8_t *buf, size_t len, size_t *pkt_len);
2614 SR_PRIV int brymen_bm85x_parse(void *state, const uint8_t *buf, size_t len,
2615         double *floatval, struct sr_datafeed_analog *analog, void *info);
2616
2617 /*--- dmm/bm86x.c -----------------------------------------------------------*/
2618
2619 #define BRYMEN_BM86X_PACKET_SIZE 24
2620 #define BRYMEN_BM86X_DISPLAY_COUNT 2
2621
2622 struct brymen_bm86x_info { size_t ch_idx; };
2623
2624 #ifdef HAVE_SERIAL_COMM
2625 SR_PRIV int sr_brymen_bm86x_packet_request(struct sr_serial_dev_inst *serial);
2626 #endif
2627 SR_PRIV gboolean sr_brymen_bm86x_packet_valid(const uint8_t *buf);
2628 SR_PRIV int sr_brymen_bm86x_parse(const uint8_t *buf, float *floatval,
2629                 struct sr_datafeed_analog *analog, void *info);
2630
2631 /*--- dmm/ut71x.c -----------------------------------------------------------*/
2632
2633 #define UT71X_PACKET_SIZE 11
2634
2635 struct ut71x_info {
2636         gboolean is_voltage, is_resistance, is_capacitance, is_temperature;
2637         gboolean is_celsius, is_fahrenheit, is_current, is_continuity;
2638         gboolean is_diode, is_frequency, is_duty_cycle, is_dc, is_ac;
2639         gboolean is_auto, is_manual, is_sign, is_power, is_loop_current;
2640 };
2641
2642 SR_PRIV gboolean sr_ut71x_packet_valid(const uint8_t *buf);
2643 SR_PRIV int sr_ut71x_parse(const uint8_t *buf, float *floatval,
2644                 struct sr_datafeed_analog *analog, void *info);
2645
2646 /*--- dmm/vc870.c -----------------------------------------------------------*/
2647
2648 #define VC870_PACKET_SIZE 23
2649
2650 struct vc870_info {
2651         gboolean is_voltage, is_dc, is_ac, is_temperature, is_resistance;
2652         gboolean is_continuity, is_capacitance, is_diode, is_loop_current;
2653         gboolean is_current, is_micro, is_milli, is_power;
2654         gboolean is_power_factor_freq, is_power_apparent_power, is_v_a_rms_value;
2655         gboolean is_sign2, is_sign1, is_batt, is_ol1, is_max, is_min;
2656         gboolean is_maxmin, is_rel, is_ol2, is_open, is_manu, is_hold;
2657         gboolean is_light, is_usb, is_warning, is_auto_power, is_misplug_warn;
2658         gboolean is_lo, is_hi, is_open2;
2659
2660         gboolean is_frequency, is_dual_display, is_auto;
2661 };
2662
2663 SR_PRIV gboolean sr_vc870_packet_valid(const uint8_t *buf);
2664 SR_PRIV int sr_vc870_parse(const uint8_t *buf, float *floatval,
2665                 struct sr_datafeed_analog *analog, void *info);
2666
2667 /*--- dmm/vc96.c ------------------------------------------------------------*/
2668
2669 #define VC96_PACKET_SIZE 13
2670
2671 struct vc96_info {
2672         size_t ch_idx;
2673         gboolean is_ac, is_dc, is_resistance, is_diode, is_ampere, is_volt;
2674         gboolean is_ohm, is_micro, is_milli, is_kilo, is_mega, is_hfe;
2675         gboolean is_unitless;
2676 };
2677
2678 SR_PRIV gboolean sr_vc96_packet_valid(const uint8_t *buf);
2679 SR_PRIV int sr_vc96_parse(const uint8_t *buf, float *floatval,
2680                 struct sr_datafeed_analog *analog, void *info);
2681
2682 /*--- lcr/es51919.c ---------------------------------------------------------*/
2683
2684 /* Acquisition details which apply to all supported serial-lcr devices. */
2685 struct lcr_parse_info {
2686         size_t ch_idx;
2687         uint64_t output_freq;
2688         const char *circuit_model;
2689 };
2690
2691 #define ES51919_PACKET_SIZE     17
2692 #define ES51919_CHANNEL_COUNT   2
2693 #define ES51919_COMM_PARAM      "9600/8n1/rts=1/dtr=1"
2694
2695 SR_PRIV int es51919_config_get(uint32_t key, GVariant **data,
2696         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2697 SR_PRIV int es51919_config_set(uint32_t key, GVariant *data,
2698         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2699 SR_PRIV int es51919_config_list(uint32_t key, GVariant **data,
2700         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2701 SR_PRIV gboolean es51919_packet_valid(const uint8_t *pkt);
2702 SR_PRIV int es51919_packet_parse(const uint8_t *pkt, float *floatval,
2703         struct sr_datafeed_analog *analog, void *info);
2704
2705 /*--- lcr/vc4080.c ----------------------------------------------------------*/
2706
2707 /* Note: Also uses 'struct lcr_parse_info' from es51919 above. */
2708
2709 #define VC4080_PACKET_SIZE      39
2710 #define VC4080_COMM_PARAM       "1200/8n1"
2711 #define VC4080_WITH_DQ_CHANS    0 /* Enable separate D/Q channels? */
2712
2713 enum vc4080_display {
2714         VC4080_DISPLAY_PRIMARY,
2715         VC4080_DISPLAY_SECONDARY,
2716 #if VC4080_WITH_DQ_CHANS
2717         VC4080_DISPLAY_D_VALUE,
2718         VC4080_DISPLAY_Q_VALUE,
2719 #endif
2720         VC4080_CHANNEL_COUNT,
2721 };
2722
2723 extern SR_PRIV const char *vc4080_channel_formats[VC4080_CHANNEL_COUNT];
2724
2725 SR_PRIV int vc4080_config_list(uint32_t key, GVariant **data,
2726         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg);
2727 SR_PRIV int vc4080_packet_request(struct sr_serial_dev_inst *serial);
2728 SR_PRIV gboolean vc4080_packet_valid(const uint8_t *pkt);
2729 SR_PRIV int vc4080_packet_parse(const uint8_t *pkt, float *floatval,
2730         struct sr_datafeed_analog *analog, void *info);
2731
2732 /*--- dmm/ut372.c -----------------------------------------------------------*/
2733
2734 #define UT372_PACKET_SIZE 27
2735
2736 struct ut372_info {
2737         int dummy;
2738 };
2739
2740 SR_PRIV gboolean sr_ut372_packet_valid(const uint8_t *buf);
2741 SR_PRIV int sr_ut372_parse(const uint8_t *buf, float *floatval,
2742                 struct sr_datafeed_analog *analog, void *info);
2743
2744 /*--- dmm/asycii.c ----------------------------------------------------------*/
2745
2746 #define ASYCII_PACKET_SIZE 16
2747
2748 struct asycii_info {
2749         gboolean is_ac, is_dc, is_ac_and_dc;
2750         gboolean is_resistance, is_capacitance, is_diode, is_gain;
2751         gboolean is_frequency, is_duty_cycle, is_duty_pos, is_duty_neg;
2752         gboolean is_pulse_width, is_period_pos, is_period_neg;
2753         gboolean is_pulse_count, is_count_pos, is_count_neg;
2754         gboolean is_ampere, is_volt, is_volt_ampere, is_farad, is_ohm;
2755         gboolean is_hertz, is_percent, is_seconds, is_decibel;
2756         gboolean is_pico, is_nano, is_micro, is_milli, is_kilo, is_mega;
2757         gboolean is_unitless;
2758         gboolean is_peak_min, is_peak_max;
2759         gboolean is_invalid;
2760 };
2761
2762 #ifdef HAVE_SERIAL_COMM
2763 SR_PRIV int sr_asycii_packet_request(struct sr_serial_dev_inst *serial);
2764 #endif
2765 SR_PRIV gboolean sr_asycii_packet_valid(const uint8_t *buf);
2766 SR_PRIV int sr_asycii_parse(const uint8_t *buf, float *floatval,
2767                             struct sr_datafeed_analog *analog, void *info);
2768
2769 /*--- dmm/eev121gw.c --------------------------------------------------------*/
2770
2771 #define EEV121GW_PACKET_SIZE 19
2772
2773 enum eev121gw_display {
2774         EEV121GW_DISPLAY_MAIN,
2775         EEV121GW_DISPLAY_SUB,
2776         EEV121GW_DISPLAY_BAR,
2777         EEV121GW_DISPLAY_COUNT,
2778 };
2779
2780 struct eev121gw_info {
2781         /* Selected channel. */
2782         size_t ch_idx;
2783         /*
2784          * Measured value, number and sign/overflow flags, scale factor
2785          * and significant digits.
2786          */
2787         uint32_t uint_value;
2788         gboolean is_ofl, is_neg;
2789         int factor, digits;
2790         /* Currently active mode (meter's function). */
2791         gboolean is_ac, is_dc, is_voltage, is_current, is_power, is_gain;
2792         gboolean is_resistance, is_capacitance, is_diode, is_temperature;
2793         gboolean is_continuity, is_frequency, is_period, is_duty_cycle;
2794         /* Quantities associated with mode/function. */
2795         gboolean is_ampere, is_volt, is_volt_ampere, is_dbm;
2796         gboolean is_ohm, is_farad, is_celsius, is_fahrenheit;
2797         gboolean is_hertz, is_seconds, is_percent, is_loop_current;
2798         gboolean is_unitless, is_logic;
2799         /* Other indicators. */
2800         gboolean is_min, is_max, is_avg, is_1ms_peak, is_rel, is_hold;
2801         gboolean is_low_pass, is_mem, is_bt, is_auto_range, is_test;
2802         gboolean is_auto_poweroff, is_low_batt;
2803 };
2804
2805 extern SR_PRIV const char *eev121gw_channel_formats[];
2806 SR_PRIV gboolean sr_eev121gw_packet_valid(const uint8_t *buf);
2807 SR_PRIV int sr_eev121gw_3displays_parse(const uint8_t *buf, float *floatval,
2808                 struct sr_datafeed_analog *analog, void *info);
2809
2810 /*--- scale/kern.c ----------------------------------------------------------*/
2811
2812 struct kern_info {
2813         gboolean is_gram, is_carat, is_ounce, is_pound, is_troy_ounce;
2814         gboolean is_pennyweight, is_grain, is_tael, is_momme, is_tola;
2815         gboolean is_percentage, is_piece, is_unstable, is_stable, is_error;
2816         int buflen;
2817 };
2818
2819 SR_PRIV gboolean sr_kern_packet_valid(const uint8_t *buf);
2820 SR_PRIV int sr_kern_parse(const uint8_t *buf, float *floatval,
2821                 struct sr_datafeed_analog *analog, void *info);
2822
2823 /*--- sw_limits.c -----------------------------------------------------------*/
2824
2825 struct sr_sw_limits {
2826         uint64_t limit_samples;
2827         uint64_t limit_frames;
2828         uint64_t limit_msec;
2829         uint64_t samples_read;
2830         uint64_t frames_read;
2831         uint64_t start_time;
2832 };
2833
2834 SR_PRIV int sr_sw_limits_config_get(const struct sr_sw_limits *limits, uint32_t key,
2835         GVariant **data);
2836 SR_PRIV int sr_sw_limits_config_set(struct sr_sw_limits *limits, uint32_t key,
2837         GVariant *data);
2838 SR_PRIV void sr_sw_limits_acquisition_start(struct sr_sw_limits *limits);
2839 SR_PRIV gboolean sr_sw_limits_check(struct sr_sw_limits *limits);
2840 SR_PRIV int sr_sw_limits_get_remain(const struct sr_sw_limits *limits,
2841         uint64_t *samples, uint64_t *frames, uint64_t *msecs,
2842         gboolean *exceeded);
2843 SR_PRIV void sr_sw_limits_update_samples_read(struct sr_sw_limits *limits,
2844         uint64_t samples_read);
2845 SR_PRIV void sr_sw_limits_update_frames_read(struct sr_sw_limits *limits,
2846         uint64_t frames_read);
2847 SR_PRIV void sr_sw_limits_init(struct sr_sw_limits *limits);
2848
2849 /*--- feed_queue.h ----------------------------------------------------------*/
2850
2851 struct feed_queue_logic;
2852 struct feed_queue_analog;
2853
2854 SR_API struct feed_queue_logic *feed_queue_logic_alloc(
2855         const struct sr_dev_inst *sdi,
2856         size_t sample_count, size_t unit_size);
2857 SR_API int feed_queue_logic_submit_one(struct feed_queue_logic *q,
2858         const uint8_t *data, size_t repeat_count);
2859 SR_API int feed_queue_logic_submit_many(struct feed_queue_logic *q,
2860         const uint8_t *data, size_t samples_count);
2861 SR_API int feed_queue_logic_flush(struct feed_queue_logic *q);
2862 SR_API int feed_queue_logic_send_trigger(struct feed_queue_logic *q);
2863 SR_API void feed_queue_logic_free(struct feed_queue_logic *q);
2864
2865 SR_API struct feed_queue_analog *feed_queue_analog_alloc(
2866         const struct sr_dev_inst *sdi,
2867         size_t sample_count, int digits, struct sr_channel *ch);
2868 SR_API int feed_queue_analog_mq_unit(struct feed_queue_analog *q,
2869         enum sr_mq mq, enum sr_mqflag mq_flag, enum sr_unit unit);
2870 SR_API int feed_queue_analog_scale_offset(struct feed_queue_analog *q,
2871         const struct sr_rational *scale, const struct sr_rational *offset);
2872 SR_API int feed_queue_analog_submit_one(struct feed_queue_analog *q,
2873         float data, size_t repeat_count);
2874 SR_API int feed_queue_analog_flush(struct feed_queue_analog *q);
2875 SR_API void feed_queue_analog_free(struct feed_queue_analog *q);
2876
2877 #endif