forked from sigrokproject/libsigrok
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathlibsigrok-internal.h
2280 lines (1959 loc) · 72.2 KB
/
libsigrok-internal.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This file is part of the libsigrok project.
*
* Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBSIGROK_LIBSIGROK_INTERNAL_H
#define LIBSIGROK_LIBSIGROK_INTERNAL_H
#include "config.h"
#include <glib.h>
#ifdef HAVE_LIBHIDAPI
#include <hidapi.h>
#endif
#ifdef HAVE_LIBSERIALPORT
#include <libserialport.h>
#endif
#ifdef HAVE_LIBUSB_1_0
#include <libusb.h>
#endif
#include <stdarg.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
struct zip;
struct zip_stat;
/**
* @file
*
* libsigrok private header file, only to be used internally.
*/
/*--- Macros ----------------------------------------------------------------*/
#ifndef ARRAY_SIZE
#define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
#endif
#ifndef ARRAY_AND_SIZE
#define ARRAY_AND_SIZE(a) (a), ARRAY_SIZE(a)
#endif
#ifndef G_SOURCE_FUNC
#define G_SOURCE_FUNC(f) ((GSourceFunc) (void (*)(void)) (f)) /* Since 2.58. */
#endif
#define SR_RECEIVE_DATA_CALLBACK(f) \
((sr_receive_data_callback) (void (*)(void)) (f))
/**
* Read a 8 bits unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint8_t read_u8(const uint8_t *p)
{
return p[0];
}
#define R8(x) read_u8((const uint8_t *)(x))
/**
* Read a 16 bits big endian unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint16_t read_u16be(const uint8_t *p)
{
uint16_t u;
u = 0;
u <<= 8; u |= p[0];
u <<= 8; u |= p[1];
return u;
}
#define RB16(x) read_u16be((const uint8_t *)(x))
/**
* Read a 16 bits little endian unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint16_t read_u16le(const uint8_t *p)
{
uint16_t u;
u = 0;
u <<= 8; u |= p[1];
u <<= 8; u |= p[0];
return u;
}
#define RL16(x) read_u16le((const uint8_t *)(x))
/**
* Read a 16 bits big endian signed integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding signed integer
*/
static inline int16_t read_i16be(const uint8_t *p)
{
uint16_t u;
int16_t i;
u = read_u16be(p);
i = (int16_t)u;
return i;
}
#define RB16S(x) read_i16be((const uint8_t *)(x))
/**
* Read a 16 bits little endian signed integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding signed integer
*/
static inline int16_t read_i16le(const uint8_t *p)
{
uint16_t u;
int16_t i;
u = read_u16le(p);
i = (int16_t)u;
return i;
}
#define RL16S(x) read_i16le((const uint8_t *)(x))
/**
* Read a 24 bits little endian unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint32_t read_u24le(const uint8_t *p)
{
uint32_t u;
u = 0;
u <<= 8; u |= p[2];
u <<= 8; u |= p[1];
u <<= 8; u |= p[0];
return u;
}
/**
* Read a 32 bits big endian unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint32_t read_u32be(const uint8_t *p)
{
uint32_t u;
u = 0;
u <<= 8; u |= p[0];
u <<= 8; u |= p[1];
u <<= 8; u |= p[2];
u <<= 8; u |= p[3];
return u;
}
#define RB32(x) read_u32be((const uint8_t *)(x))
/**
* Read a 32 bits little endian unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint32_t read_u32le(const uint8_t *p)
{
uint32_t u;
u = 0;
u <<= 8; u |= p[3];
u <<= 8; u |= p[2];
u <<= 8; u |= p[1];
u <<= 8; u |= p[0];
return u;
}
#define RL32(x) read_u32le((const uint8_t *)(x))
/**
* Read a 32 bits big endian signed integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding signed integer
*/
static inline int32_t read_i32be(const uint8_t *p)
{
uint32_t u;
int32_t i;
u = read_u32be(p);
i = (int32_t)u;
return i;
}
#define RB32S(x) read_i32be((const uint8_t *)(x))
/**
* Read a 32 bits little endian signed integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding signed integer
*/
static inline int32_t read_i32le(const uint8_t *p)
{
uint32_t u;
int32_t i;
u = read_u32le(p);
i = (int32_t)u;
return i;
}
#define RL32S(x) read_i32le((const uint8_t *)(x))
/**
* Read a 64 bits big endian unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint64_t read_u64be(const uint8_t *p)
{
uint64_t u;
u = 0;
u <<= 8; u |= p[0];
u <<= 8; u |= p[1];
u <<= 8; u |= p[2];
u <<= 8; u |= p[3];
u <<= 8; u |= p[4];
u <<= 8; u |= p[5];
u <<= 8; u |= p[6];
u <<= 8; u |= p[7];
return u;
}
#define RB64(x) read_u64be((const uint8_t *)(x))
/**
* Read a 64 bits little endian unsigned integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline uint64_t read_u64le(const uint8_t *p)
{
uint64_t u;
u = 0;
u <<= 8; u |= p[7];
u <<= 8; u |= p[6];
u <<= 8; u |= p[5];
u <<= 8; u |= p[4];
u <<= 8; u |= p[3];
u <<= 8; u |= p[2];
u <<= 8; u |= p[1];
u <<= 8; u |= p[0];
return u;
}
#define RL64(x) read_u64le((const uint8_t *)(x))
/**
* Read a 64 bits big endian signed integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline int64_t read_i64be(const uint8_t *p)
{
uint64_t u;
int64_t i;
u = read_u64be(p);
i = (int64_t)u;
return i;
}
#define RB64S(x) read_i64be((const uint8_t *)(x))
/**
* Read a 64 bits little endian signed integer out of memory.
* @param x a pointer to the input memory
* @return the corresponding unsigned integer
*/
static inline int64_t read_i64le(const uint8_t *p)
{
uint64_t u;
int64_t i;
u = read_u64le(p);
i = (int64_t)u;
return i;
}
#define RL64S(x) read_i64le((const uint8_t *)(x))
/**
* Read a 32 bits big endian float out of memory.
* @param x a pointer to the input memory
* @return the corresponding float
*/
static inline float read_fltbe(const uint8_t *p)
{
/*
* Implementor's note: Strictly speaking the "union" trick
* is not portable. But this phrase was found to work on the
* project's supported platforms, and serve well until a more
* appropriate phrase is found.
*/
union { uint32_t u32; float flt; } u;
float f;
u.u32 = read_u32be(p);
f = u.flt;
return f;
}
#define RBFL(x) read_fltbe((const uint8_t *)(x))
/**
* Read a 32 bits little endian float out of memory.
* @param x a pointer to the input memory
* @return the corresponding float
*/
static inline float read_fltle(const uint8_t *p)
{
/*
* Implementor's note: Strictly speaking the "union" trick
* is not portable. But this phrase was found to work on the
* project's supported platforms, and serve well until a more
* appropriate phrase is found.
*/
union { uint32_t u32; float flt; } u;
float f;
u.u32 = read_u32le(p);
f = u.flt;
return f;
}
#define RLFL(x) read_fltle((const uint8_t *)(x))
/**
* Write a 8 bits unsigned integer to memory.
* @param p a pointer to the output memory
* @param x the input unsigned integer
*/
static inline void write_u8(uint8_t *p, uint8_t x)
{
p[0] = x;
}
#define W8(p, x) write_u8((uint8_t *)(p), (uint8_t)(x))
/**
* Write a 16 bits unsigned integer to memory stored as big endian.
* @param p a pointer to the output memory
* @param x the input unsigned integer
*/
static inline void write_u16be(uint8_t *p, uint16_t x)
{
p[1] = x & 0xff; x >>= 8;
p[0] = x & 0xff; x >>= 8;
}
#define WB16(p, x) write_u16be((uint8_t *)(p), (uint16_t)(x))
/**
* Write a 16 bits unsigned integer to memory stored as little endian.
* @param p a pointer to the output memory
* @param x the input unsigned integer
*/
static inline void write_u16le(uint8_t *p, uint16_t x)
{
p[0] = x & 0xff; x >>= 8;
p[1] = x & 0xff; x >>= 8;
}
#define WL16(p, x) write_u16le((uint8_t *)(p), (uint16_t)(x))
/**
* Write a 32 bits unsigned integer to memory stored as big endian.
* @param p a pointer to the output memory
* @param x the input unsigned integer
*/
static inline void write_u32be(uint8_t *p, uint32_t x)
{
p[3] = x & 0xff; x >>= 8;
p[2] = x & 0xff; x >>= 8;
p[1] = x & 0xff; x >>= 8;
p[0] = x & 0xff; x >>= 8;
}
#define WB32(p, x) write_u32be((uint8_t *)(p), (uint32_t)(x))
/**
* Write a 32 bits unsigned integer to memory stored as little endian.
* @param p a pointer to the output memory
* @param x the input unsigned integer
*/
static inline void write_u32le(uint8_t *p, uint32_t x)
{
p[0] = x & 0xff; x >>= 8;
p[1] = x & 0xff; x >>= 8;
p[2] = x & 0xff; x >>= 8;
p[3] = x & 0xff; x >>= 8;
}
#define WL32(p, x) write_u32le((uint8_t *)(p), (uint32_t)(x))
/**
* Write a 32 bits float to memory stored as big endian.
* @param p a pointer to the output memory
* @param x the input float
*/
static inline void write_fltbe(uint8_t *p, float x)
{
union { uint32_t u; float f; } u;
u.f = x;
write_u32be(p, u.u);
}
#define WBFL(p, x) write_fltbe((uint8_t *)(p), (x))
/**
* Write a 32 bits float to memory stored as little endian.
* @param p a pointer to the output memory
* @param x the input float
*/
static inline void write_fltle(uint8_t *p, float x)
{
union { uint32_t u; float f; } u;
u.f = x;
write_u32le(p, u.u);
}
#define WLFL(p, x) write_fltle((uint8_t *)(p), float (x))
/* Endianess conversion helpers with read/write position increment. */
/**
* Read unsigned 8bit integer from raw memory, increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint8_t read_u8_inc(const uint8_t **p)
{
uint8_t v;
if (!p || !*p)
return 0;
v = read_u8(*p);
*p += sizeof(v);
return v;
}
/**
* Read unsigned 16bit integer from raw memory (big endian format), increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint16_t read_u16be_inc(const uint8_t **p)
{
uint16_t v;
if (!p || !*p)
return 0;
v = read_u16be(*p);
*p += sizeof(v);
return v;
}
/**
* Read unsigned 16bit integer from raw memory (little endian format), increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint16_t read_u16le_inc(const uint8_t **p)
{
uint16_t v;
if (!p || !*p)
return 0;
v = read_u16le(*p);
*p += sizeof(v);
return v;
}
/**
* Read unsigned 32bit integer from raw memory (big endian format), increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint32_t read_u32be_inc(const uint8_t **p)
{
uint32_t v;
if (!p || !*p)
return 0;
v = read_u32be(*p);
*p += sizeof(v);
return v;
}
/**
* Read unsigned 24bit integer from raw memory (little endian format), increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint32_t read_u24le_inc(const uint8_t **p)
{
uint32_t v;
if (!p || !*p)
return 0;
v = read_u24le(*p);
*p += 3 * sizeof(uint8_t);
return v;
}
/**
* Read unsigned 32bit integer from raw memory (little endian format), increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint32_t read_u32le_inc(const uint8_t **p)
{
uint32_t v;
if (!p || !*p)
return 0;
v = read_u32le(*p);
*p += sizeof(v);
return v;
}
/**
* Read unsigned 64bit integer from raw memory (big endian format), increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint64_t read_u64be_inc(const uint8_t **p)
{
uint64_t v;
if (!p || !*p)
return 0;
v = read_u64be(*p);
*p += sizeof(v);
return v;
}
/**
* Read unsigned 64bit integer from raw memory (little endian format), increment read position.
* @param[in, out] p Pointer into byte stream.
* @return Retrieved integer value, unsigned.
*/
static inline uint64_t read_u64le_inc(const uint8_t **p)
{
uint64_t v;
if (!p || !*p)
return 0;
v = read_u64le(*p);
*p += sizeof(v);
return v;
}
/**
* Write unsigned 8bit integer to raw memory, increment write position.
* @param[in, out] p Pointer into byte stream.
* @param[in] x Value to write.
*/
static inline void write_u8_inc(uint8_t **p, uint8_t x)
{
if (!p || !*p)
return;
write_u8(*p, x);
*p += sizeof(x);
}
/**
* Write unsigned 16bit big endian integer to raw memory, increment write position.
* @param[in, out] p Pointer into byte stream.
* @param[in] x Value to write.
*/
static inline void write_u16be_inc(uint8_t **p, uint16_t x)
{
if (!p || !*p)
return;
write_u16be(*p, x);
*p += sizeof(x);
}
/**
* Write unsigned 16bit little endian integer to raw memory, increment write position.
* @param[in, out] p Pointer into byte stream.
* @param[in] x Value to write.
*/
static inline void write_u16le_inc(uint8_t **p, uint16_t x)
{
if (!p || !*p)
return;
write_u16le(*p, x);
*p += sizeof(x);
}
/**
* Write unsigned 32bit big endian integer to raw memory, increment write position.
* @param[in, out] p Pointer into byte stream.
* @param[in] x Value to write.
*/
static inline void write_u32be_inc(uint8_t **p, uint32_t x)
{
if (!p || !*p)
return;
write_u32be(*p, x);
*p += sizeof(x);
}
/**
* Write unsigned 32bit little endian integer to raw memory, increment write position.
* @param[in, out] p Pointer into byte stream.
* @param[in] x Value to write.
*/
static inline void write_u32le_inc(uint8_t **p, uint32_t x)
{
if (!p || !*p)
return;
write_u32le(*p, x);
*p += sizeof(x);
}
/* Portability fixes for FreeBSD. */
#ifdef __FreeBSD__
#define LIBUSB_CLASS_APPLICATION 0xfe
#define libusb_has_capability(x) 0
#define libusb_handle_events_timeout_completed(ctx, tv, c) \
libusb_handle_events_timeout(ctx, tv)
#endif
/* Static definitions of structs ending with an all-zero entry are a
* problem when compiling with -Wmissing-field-initializers: GCC
* suppresses the warning only with { 0 }, clang wants { } */
#ifdef __clang__
#define ALL_ZERO { }
#else
#define ALL_ZERO { 0 }
#endif
#ifdef __APPLE__
#define SR_DRIVER_LIST_SECTION "__DATA,__sr_driver_list"
#else
#define SR_DRIVER_LIST_SECTION "__sr_driver_list"
#endif
/**
* Register a list of hardware drivers.
*
* This macro can be used to register multiple hardware drivers to the library.
* This is useful when a driver supports multiple similar but slightly
* different devices that require different sr_dev_driver struct definitions.
*
* For registering only a single driver see SR_REGISTER_DEV_DRIVER().
*
* Example:
* @code{c}
* #define MY_DRIVER(_name) \
* &(struct sr_dev_driver){ \
* .name = _name, \
* ...
* };
*
* SR_REGISTER_DEV_DRIVER_LIST(my_driver_infos,
* MY_DRIVER("driver 1"),
* MY_DRIVER("driver 2"),
* ...
* );
* @endcode
*
* @param name Name to use for the driver list identifier.
* @param ... Comma separated list of pointers to sr_dev_driver structs.
*/
#define SR_REGISTER_DEV_DRIVER_LIST(name, ...) \
static const struct sr_dev_driver *name[] \
__attribute__((section (SR_DRIVER_LIST_SECTION), used, \
aligned(sizeof(struct sr_dev_driver *)))) \
= { \
__VA_ARGS__ \
};
/**
* Register a hardware driver.
*
* This macro is used to register a hardware driver with the library. It has
* to be used in order to make the driver accessible to applications using the
* library.
*
* The macro invocation should be placed directly under the struct
* sr_dev_driver definition.
*
* Example:
* @code{c}
* static struct sr_dev_driver driver_info = {
* .name = "driver",
* ....
* };
* SR_REGISTER_DEV_DRIVER(driver_info);
* @endcode
*
* @param name Identifier name of sr_dev_driver struct to register.
*/
#define SR_REGISTER_DEV_DRIVER(name) \
SR_REGISTER_DEV_DRIVER_LIST(name##_list, &name);
SR_API void sr_drivers_init(struct sr_context *context);
struct sr_context {
struct sr_dev_driver **driver_list;
#ifdef HAVE_LIBUSB_1_0
libusb_context *libusb_ctx;
#endif
sr_resource_open_callback resource_open_cb;
sr_resource_close_callback resource_close_cb;
sr_resource_read_callback resource_read_cb;
void *resource_cb_data;
};
/** Input module metadata keys. */
enum sr_input_meta_keys {
/** The input filename, if there is one. */
SR_INPUT_META_FILENAME = 0x01,
/** The input file's size in bytes. */
SR_INPUT_META_FILESIZE = 0x02,
/** The first 128 bytes of the file, provided as a GString. */
SR_INPUT_META_HEADER = 0x04,
/** The module cannot identify a file without this metadata. */
SR_INPUT_META_REQUIRED = 0x80,
};
/** Input (file) module struct. */
struct sr_input {
/**
* A pointer to this input module's 'struct sr_input_module'.
*/
const struct sr_input_module *module;
GString *buf;
struct sr_dev_inst *sdi;
gboolean sdi_ready;
void *priv;
};
/** Input (file) module driver. */
struct sr_input_module {
/**
* A unique ID for this input module, suitable for use in command-line
* clients, [a-z0-9-]. Must not be NULL.
*/
const char *id;
/**
* A unique name for this input module, suitable for use in GUI
* clients, can contain UTF-8. Must not be NULL.
*/
const char *name;
/**
* A short description of the input module. Must not be NULL.
*
* This can be displayed by frontends, e.g. when selecting the input
* module for saving a file.
*/
const char *desc;
/**
* A NULL terminated array of strings containing a list of file name
* extensions typical for the input file format, or NULL if there is
* no typical extension for this file format.
*/
const char *const *exts;
/**
* Zero-terminated list of metadata items the module needs to be able
* to identify an input stream. Can be all-zero, if the module cannot
* identify streams at all, i.e. has to be forced into use.
*
* Each item is one of:
* SR_INPUT_META_FILENAME
* SR_INPUT_META_FILESIZE
* SR_INPUT_META_HEADER
*
* If the high bit (SR_INPUT META_REQUIRED) is set, the module cannot
* identify a stream without the given metadata.
*/
const uint8_t metadata[8];
/**
* Returns a NULL-terminated list of options this module can take.
* Can be NULL, if the module has no options.
*/
const struct sr_option *(*options) (void);
/**
* Check if this input module can load and parse the specified stream.
*
* @param[in] metadata Metadata the module can use to identify the stream.
* @param[out] confidence "Strength" of the detection.
* Specialized handlers can take precedence over generic/basic support.
*
* @retval SR_OK This module knows the format.
* @retval SR_ERR_NA There wasn't enough data for this module to
* positively identify the format.
* @retval SR_ERR_DATA This module knows the format, but cannot handle
* it. This means the stream is either corrupt, or indicates a
* feature that the module does not support.
* @retval SR_ERR This module does not know the format.
*
* Lower numeric values of 'confidence' mean that the input module
* stronger believes in its capability to handle this specific format.
* This way, multiple input modules can claim support for a format,
* and the application can pick the best match, or try fallbacks
* in case of errors. This approach also copes with formats that
* are unreliable to detect in the absence of magic signatures.
*/
int (*format_match) (GHashTable *metadata, unsigned int *confidence);
/**
* Initialize the input module.
*
* @retval SR_OK Success
* @retval other Negative error code.
*/
int (*init) (struct sr_input *in, GHashTable *options);
/**
* Send data to the specified input instance.
*
* When an input module instance is created with sr_input_new(), this
* function is used to feed data to the instance.
*
* As enough data gets fed into this function to completely populate
* the device instance associated with this input instance, this is
* guaranteed to return the moment it's ready. This gives the caller
* the chance to examine the device instance, attach session callbacks
* and so on.
*
* @retval SR_OK Success
* @retval other Negative error code.
*/
int (*receive) (struct sr_input *in, GString *buf);
/**
* Signal the input module no more data will come.
*
* This will cause the module to process any data it may have buffered.
* The SR_DF_END packet will also typically be sent at this time.
*/
int (*end) (struct sr_input *in);
/**
* Reset the input module's input handling structures.
*
* Causes the input module to reset its internal state so that we can
* re-send the input data from the beginning without having to
* re-create the entire input module.
*
* @retval SR_OK Success.
* @retval other Negative error code.
*/
int (*reset) (struct sr_input *in);
/**
* This function is called after the caller is finished using
* the input module, and can be used to free any internal
* resources the module may keep.
*
* This function is optional.
*
* @retval SR_OK Success
* @retval other Negative error code.
*/
void (*cleanup) (struct sr_input *in);
};
/** Output module instance. */
struct sr_output {
/** A pointer to this output's module. */
const struct sr_output_module *module;
/**
* The device for which this output module is creating output. This
* can be used by the module to find out channel names and numbers.
*/
const struct sr_dev_inst *sdi;
/**
* The name of the file that the data should be written to.
*/
const char *filename;
/**
* A generic pointer which can be used by the module to keep internal
* state between calls into its callback functions.
*
* For example, the module might store a pointer to a chunk of output
* there, and only flush it when it reaches a certain size.
*/
void *priv;
};
/** Output module driver. */
struct sr_output_module {
/**
* A unique ID for this output module, suitable for use in command-line
* clients, [a-z0-9-]. Must not be NULL.
*/
const char *id;
/**
* A unique name for this output module, suitable for use in GUI
* clients, can contain UTF-8. Must not be NULL.
*/
const char *name;
/**
* A short description of the output module. Must not be NULL.
*
* This can be displayed by frontends, e.g. when selecting the output
* module for saving a file.
*/
const char *desc;
/**
* A NULL terminated array of strings containing a list of file name
* extensions typical for the input file format, or NULL if there is
* no typical extension for this file format.
*/
const char *const *exts;
/**
* Bitfield containing flags that describe certain properties
* this output module may or may not have.
* @see sr_output_flags
*/
const uint64_t flags;
/**
* Returns a NULL-terminated list of options this module can take.
* Can be NULL, if the module has no options.
*/
const struct sr_option *(*options) (void);
/**
* This function is called once, at the beginning of an output stream.
*
* The device struct will be available in the output struct passed in,
* as well as the param field -- which may be NULL or an empty string,
* if no parameter was passed.
*
* The module can use this to initialize itself, create a struct for
* keeping state and storing it in the <code>internal</code> field.
*
* @param o Pointer to the respective 'struct sr_output'.
*
* @retval SR_OK Success
* @retval other Negative error code.
*/
int (*init) (struct sr_output *o, GHashTable *options);
/**
* This function is passed a copy of every packet in the data feed.
* Any output generated by the output module in response to the
* packet should be returned in a newly allocated GString
* <code>out</code>, which will be freed by the caller.
*
* Packets not of interest to the output module can just be ignored,
* and the <code>out</code> parameter set to NULL.
*
* @param o Pointer to the respective 'struct sr_output'.
* @param sdi The device instance that generated the packet.
* @param packet The complete packet.