-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathfaV3Lib.h
More file actions
1047 lines (885 loc) · 34.8 KB
/
faV3Lib.h
File metadata and controls
1047 lines (885 loc) · 34.8 KB
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
#pragma once
/**
* @copyright Copyright 2024, Jefferson Science Associates, LLC.
* Subject to the terms in the LICENSE file found in the
* top-level directory.
*
* @author Bryan Moffit
* moffit@jlab.org Jefferson Lab, MS-12B3
* Phone: (757) 269-5660 12000 Jefferson Ave.
* Newport News, VA 23606
*
* @author David Abbott
* abbottd@jlab.org Jefferson Lab, MS-12B3
* Phone: (757) 269-7190 12000 Jefferson Ave.
* Newport News, VA 23606
* @file faV3Lib.h
*
* @brief Header for JLAB 250MHz FLASH ADC V3 library
*
*/
#include <stdint.h>
#define FAV3_BOARD_ID 0xadc30000
#define FAV3_MAX_BOARDS 20
#define FAV3_MAX_ADC_CHANNELS 16
#define FAV3_MAX_DATA_PER_CHANNEL 251
#define FAV3_MAX_A32_MEM 0x800000 /* 8 Meg */
#define FAV3_MAX_A32MB_SIZE 0x800000 /* 8 MB */
#define FAV3_VME_INT_LEVEL 3
#define FAV3_VME_INT_VEC 0xFA
#define FAV3_CTRL_PRAD_FIRMWARE 0x20F
#define FAV3_PROC_PRAD_FIRMWARE 0xF04
#define FAV3_SUPPORTED_CTRL_FIRMWARE 0x20E,0x20F
#define FAV3_SUPPORTED_CTRL_FIRMWARE_NUMBER 2
#define FAV3_SUPPORTED_PROC_FIRMWARE 0xE06,0xF05
#define FAV3_SUPPORTED_PROC_FIRMWARE_NUMBER 2
#define CHECK_PROC_SUPPORTED(...) { \
int __found = -1; \
const int __proc_supported[] = {__VA_ARGS__}; \
for (int i = 0; i < sizeof(__proc_supported) / sizeof(int); ++i) { \
if (faV3FwRev[id][FAV3_FW_PROC] == __proc_supported[i]) { \
__found = 1; break; \
} \
} \
if(__found == -1) { \
printf("%s: ERROR: Not supported with proc firmware 0x%0x\n", \
__func__, faV3FwRev[id][FAV3_FW_PROC]); \
return ERROR; \
}}
/* Macros to help with register spacers */
#define MERGE_(a,b) a##b
#define LABEL_(a) MERGE_(uint32_t faV3blank, a)
#define BLANK LABEL_(__LINE__)
typedef struct
{
/* 0x0100 */ volatile uint16_t status0;
/* 0x0102 */ volatile uint16_t status1;
/* 0x0104 */ volatile uint16_t status2;
/* 0x0106 */ volatile uint16_t config1;
/* 0x0108 */ volatile uint16_t config2;
/* 0x010A */ volatile uint16_t config4;
/* 0x010C */ volatile uint16_t config5;
/* 0x010E */ volatile uint16_t ptw;
/* 0x0110 */ volatile uint16_t pl;
/* 0x0112 */ volatile uint16_t nsb;
/* 0x0114 */ volatile uint16_t nsa;
/* 0x0116 */ volatile uint16_t thres[FAV3_MAX_ADC_CHANNELS];
/* 0x0136 */ volatile uint16_t config6;
/* 0x0138 */ volatile uint16_t config7;
/* 0x013A */ volatile uint16_t test_wave;
/* 0x013C */ volatile uint16_t pedestal[FAV3_MAX_ADC_CHANNELS];
/* 0x015C */ volatile uint16_t config3;
/* 0x015E */ volatile uint16_t status3;
/* 0x0160 */ volatile uint16_t status4;
/* 0x0162 */ volatile uint16_t rogue_ptw_fall_back;
/* 0x0164 */ volatile uint16_t trig_gain[FAV3_MAX_ADC_CHANNELS];
/* 0x0184 */ volatile uint16_t trig_delay[FAV3_MAX_ADC_CHANNELS];
/* 0x01A4 */ volatile uint16_t live_trig_mask;
/* 0x01A6 */ volatile uint16_t live_trig_width;
/* 0x01A8 */ volatile uint16_t hitbit_config;
/* 0x01AA */ volatile uint16_t la_rden;
/* 0x01AC */ volatile uint16_t la_ctrl_reg;
/* 0x01AE */ volatile uint16_t cmp_mode[FAV3_MAX_ADC_CHANNELS];
/* 0x01CE */ volatile uint16_t cmp_thr[FAV3_MAX_ADC_CHANNELS];
/* 0x01EE */ volatile uint16_t scaler_latch;
/* 0x01F0 */ BLANK[(0x210 - 0x1F0) >> 2];
/* 0x0210 */ volatile uint16_t la_dat[FAV3_MAX_ADC_CHANNELS];
/* 0x0230 */ volatile uint16_t acc0[FAV3_MAX_ADC_CHANNELS];
/* 0x0250 */ volatile uint16_t acc1[FAV3_MAX_ADC_CHANNELS];
/* 0x0270 */ volatile uint16_t acc2[FAV3_MAX_ADC_CHANNELS];
/* 0x0290 */ volatile uint16_t la_rdyStatus;
/* 0x0294 */ BLANK[(0x2A0 - 0x294) >> 2];
} faV3_adc_t;
typedef struct
{
/* 0x0300 */ volatile uint32_t scaler[FAV3_MAX_ADC_CHANNELS];
/* 0x0340 */ volatile uint32_t time_count;
} faV3_scalers_t;
typedef struct
{
/* 0x0400 */ volatile uint32_t testbit;
/* 0x0404 */ volatile uint32_t count_250;
/* 0x0408 */ volatile uint32_t count_sync;
/* 0x040C */ volatile uint32_t count_trig1;
/* 0x0410 */ volatile uint32_t count_trig2;
} faV3_system_test_t;
typedef struct
{
/* 0x0500 */ volatile uint32_t state_level;
/* 0x0504 */ volatile uint32_t state_csr;
/* 0x0508 */ volatile uint32_t state_value;
/* 0x050C */ BLANK[1];
/* 0x0510 */ volatile uint32_t berr_driven_count;
/* 0x0514 */ volatile uint32_t retry_driven_count;
/* 0x0518 */ BLANK[1];
/* 0x051C */ volatile uint32_t vxs_output_status;
/* 0x0520 */ volatile uint32_t sparsify_control;
/* 0x0524 */ volatile uint32_t sparsify_status;
/* 0x0528 */ volatile uint32_t first_trigger_mismatch;
/* 0x052C */ volatile uint32_t trigger_mismatch_counter;
/* 0x0530 */ volatile uint32_t triggers_processed;
/* 0x0534 */ BLANK[(0x540 - 0x534) >> 2];
/* 0x0540 */ volatile uint32_t idelay_control_1;
/* 0x0544 */ volatile uint32_t idelay_control_2;
/* 0x0548 */ volatile uint32_t idelay_status_1;
/* 0x054C */ volatile uint32_t idelay_status_2;
} faV3_aux_t;
typedef struct
{
/* 0x0000 */ volatile uint32_t version;
/* 0x0004 */ volatile uint32_t csr;
/* 0x0008 */ volatile uint32_t ctrl1;
/* 0x000C */ volatile uint32_t ctrl2;
/* 0x0010 */ volatile uint32_t blocklevel;
/* 0x0014 */ volatile uint32_t intr;
/* 0x0018 */ volatile uint32_t adr32;
/* 0x001C */ volatile uint32_t adr_mb;
/* 0x0020 */ volatile uint32_t sec_adr;
/* 0x0024 */ BLANK[1];
/* 0x0028 */ volatile uint32_t trig_cfg;
/* 0x002C */ volatile uint32_t reset;
/* 0x0030 */ volatile uint32_t trig_scal;
/* 0x0034 */ volatile uint32_t ev_count;
/* 0x0038 */ volatile uint32_t blk_count;
/* 0x003C */ volatile uint32_t blk_fifo_count;
/* 0x0040 */ volatile uint32_t blk_wrd_count;
/* 0x0044 */ volatile uint32_t trig_live_count;
/* 0x0048 */ volatile uint32_t ram_word_count;
/* 0x004C */ volatile uint32_t flow_status;
/* 0x0050 */ volatile uint32_t dac_csr;
/* 0x0054 */ volatile uint32_t dac_data;
/* 0x0058 */ volatile uint32_t config_rom_control0;
/* 0x005C */ volatile uint32_t config_rom_control1;
/* 0x0060 */ volatile uint32_t config_rom_control2;
/* 0x0064 */ volatile uint32_t config_rom_status0;
/* 0x0068 */ volatile uint32_t config_rom_status1;
/* 0x006C */ BLANK[(0x70 - 0x6C) >> 2];
/* 0x0070 */ volatile uint32_t status1;
/* 0x0074 */ volatile uint32_t status2;
/* 0x0078 */ volatile uint32_t status3;
/* 0x007C */ BLANK[(0x84 - 0x7C) >> 2];
/* 0x0084 */ volatile uint32_t trigger_control;
/* 0x0088 */ volatile uint32_t trig21_del;
/* 0x008C */ volatile uint32_t mem_adr;
/* 0x0090 */ volatile uint32_t mem1_data;
/* 0x0094 */ volatile uint32_t mem2_data;
/* 0x0098 */ volatile uint32_t prom_reg1;
/* 0x009C */ volatile uint32_t prom_reg2;
/* 0x00A0 */ volatile uint32_t berr_scal;
/* 0x00A4 */ volatile uint32_t berr_in_scal;
/* 0x00A8 */ volatile uint32_t proc_words_scal;
/* 0x00AC */ volatile uint32_t lost_trig_scal;
/* 0x00B0 */ volatile uint32_t header_scal;
/* 0x00B4 */ volatile uint32_t trig2_scal;
/* 0x00B8 */ volatile uint32_t trailer_scal;
/* 0x00BC */ volatile uint32_t syncreset_scal;
/* 0x00C0 */ volatile uint32_t busy_level;
/* 0x00C4 */ volatile uint32_t gen_evt_header;
/* 0x00C8 */ volatile uint32_t gen_evt_data;
/* 0x00CC */ volatile uint32_t gen_evt_trail;
/* 0x00D0 */ volatile uint32_t status_mgt;
/* 0x00D4 */ volatile uint32_t ctrl_mgt;
/* 0x00D8 */ volatile uint32_t mem_adr_w;
/* 0x00DC */ volatile uint32_t mem_adr_r;
/* 0x00E0 */ volatile uint32_t scaler_ctrl;
/* 0x00E4 */ volatile uint32_t serial_reg[3];
/* 0x00F0 */ volatile uint32_t scaler_insert;
/* 0x00F4 */ volatile uint32_t sum_threshold;
/* 0x00F8 */ volatile uint32_t sum_data;
/* 0x00FC */ volatile uint32_t sys_mon;
/* 0x0100 */ volatile faV3_adc_t adc;
/* 0x02A0 */ BLANK[(0x300 - 0x2A0) >> 2];
/* 0x0300 */ volatile faV3_scalers_t scalers;
/* 0x0344 */ BLANK[(0x400 - 0x344) >> 2];
/* 0x0400 */ volatile faV3_system_test_t system_test;
/* 0x0414 */ BLANK[(0x500 - 0x414) >> 2];
/* 0x0500 */ volatile faV3_aux_t aux;
} faV3_t;
typedef struct faV3_data_struct
{
uint32_t new_type;
uint32_t type;
uint32_t slot_id_hd;
uint32_t slot_id_tr;
uint32_t slot_id_evh;
uint32_t n_evts;
uint32_t blk_num;
uint32_t modID;
uint32_t PL;
uint32_t NSB;
uint32_t NSA;
uint32_t n_words;
uint32_t evt_num_1;
uint32_t evt_num_2;
uint32_t evt_of_blk;
uint32_t time_now;
uint32_t time_low_10;
uint32_t time_1;
uint32_t time_2;
uint32_t time_3;
uint32_t time_4;
uint32_t chan;
uint32_t width;
uint32_t valid_1;
uint32_t adc_1;
uint32_t valid_2;
uint32_t adc_2;
uint32_t over;
uint32_t under;
uint32_t nsa_ext;
uint32_t samp_ov_thres;
uint32_t adc_sum;
uint32_t ped_sum;
uint32_t pulse_num;
uint32_t thres_bin;
uint32_t quality;
uint32_t quality2;
uint32_t integral;
uint32_t time;
uint32_t chan_a;
uint32_t source_a;
uint32_t chan_b;
uint32_t source_b;
uint32_t group;
uint32_t time_coarse;
uint32_t time_fine;
uint32_t vmin;
uint32_t vpeak;
uint32_t trig_type_int; /* next 4 for internal trigger data */
uint32_t trig_state_int; /* e.g. helicity */
uint32_t evt_num_int;
uint32_t err_status_int;
uint32_t scaler_data_words;
} faV3data_t;
typedef struct faV3_sdc_struct
{
volatile uint16_t csr;
volatile uint16_t ctrl;
volatile uint16_t busy_enable;
volatile uint16_t busy_status;
} faV3sdc_t;
/* FADC Special Board IDs */
/* Define CSR Bits */
#define FAV3_CSR_EVENT_AVAILABLE (1 << 0)
#define FAV3_CSR_BLOCK_LEVEL_FLAG (1 << 1)
#define FAV3_CSR_BLOCK_READY (1 << 2)
#define FAV3_CSR_BERR_STATUS (1 << 3)
#define FAV3_CSR_TOKEN_STATUS (1 << 4)
#define FAV3_CSR_COMPRESSION_ERROR (1 << 5)
#define FAV3_DAC_SERIALIZATION_ACTIVE (1 << 10)
#define FAV3_CSR_FIFO_EMPTY (1 << 11)
#define FAV3_CSR_FIFO_ALMOST_EMPTY (1 << 12)
#define FAV3_CSR_FIFO_HALF_FULL (1 << 13)
#define FAV3_CSR_FIFO_ALMOST_FULL (1 << 14)
#define FAV3_CSR_FIFO_FULL (1 << 15)
#define FAV3_CSR_SOFT_PULSE_TRIG2 (1 << 20)
#define FAV3_CSR_SOFT_CLEAR (1 << 21)
#define FAV3_CSR_DATA_STREAM_SCALERS (1 << 22)
#define FAV3_CSR_FORCE_EOB_INSERT (1 << 23)
#define FAV3_CSR_FORCE_EOB_SUCCESS (1 << 24)
#define FAV3_CSR_FORCE_EOB_FAILED (1 << 25)
#define FAV3_CSR_ERROR_MASK 0x0c000000
#define FAV3_CSR_ERROR_CLEAR (1 << 27)
#define FAV3_CSR_SYNC (1 << 28)
#define FAV3_CSR_TRIGGER (1 << 29)
#define FAV3_CSR_SOFT_RESET (1 << 30)
#define FAV3_CSR_HARD_RESET (1 << 31)
/* Define ctrl1 Bits */
#define FAV3_REF_CLK_INTERNAL 0x0
#define FAV3_REF_CLK_FP 0x1
#define FAV3_REF_CLK_P0 0x2
#define FAV3_REF_CLK_MASK 0x3
#define FAV3_ENABLE_INTERNAL_CLK 0x8
#define FAV3_TRIG_FP 0x00
#define FAV3_TRIG_FP_ISYNC 0x10
#define FAV3_TRIG_P0 0x20
#define FAV3_TRIG_P0_ISYNC 0x30
#define FAV3_TRIG_VME_PLAYBACK 0x50
#define FAV3_TRIG_VME 0x60
#define FAV3_TRIG_INTERNAL 0x70
#define FAV3_TRIG_MASK 0x70
#define FAV3_ENABLE_SOFT_TRIG 0x80
#define FAV3_SRESET_FP 0x000
#define FAV3_SRESET_FP_ISYNC 0x100
#define FAV3_SRESET_P0 0x200
#define FAV3_SRESET_P0_ISYNC 0x300
#define FAV3_SRESET_VME 0x600
#define FAV3_SRESET_NONE 0x700
#define FAV3_SRESET_MASK 0x700
#define FAV3_ENABLE_SOFT_SRESET 0x800
#define FAV3_ENABLE_LIVE_TRIG_OUT 0x1000
#define FAV3_ENABLE_TRIG_OUT_FP 0x2000
#define FAV3_ENABLE_TRIG_OUT_P0 0x4000
#define FAV3_TRIGOUT_MASK 0x7000
#define FAV3_ENABLE_BLKLVL_INT 0x40000
#define FAV3_ENABLE_BERR 0x100000
#define FAV3_ENABLE_MULTIBLOCK 0x200000
#define FAV3_FIRST_BOARD 0x400000
#define FAV3_LAST_BOARD 0x800000
#define FAV3_ENABLE_DEBUG 0x2000000
#define FAV3_MB_TOKEN_VIA_P0 0x10000000
#define FAV3_MB_TOKEN_VIA_P2 0x20000000
#define FAV3_CTRL1_DATAFORMAT_MASK 0x0C000000
#define FAV3_CTRL1_DATAFORMAT_STD 0
#define FAV3_CTRL1_DATAFORMAT_INTERM_SUPPRESS 1
#define FAV3_CTRL1_DATAFORMAT_FULL_SUPPRESS 2
/* Define ctrl2 Bits */
#define FAV3_CTRL_GO (1 << 0)
#define FAV3_CTRL_ENABLE_TRIG (1 << 1)
#define FAV3_CTRL_ENABLE_SRESET (1 << 2)
#define FAV3_CTRL_ENABLE_INT_TRIG (1 << 3)
#define FAV3_CTRL_ENABLE_MASK 0x7
#define FAV3_CTRL_ENABLED 0x7
#define FAV3_CTRL_STREAM_ENABLE (1 << 4)
#define FAV3_CTRL_COMPRESS_DISABLE 0x000
#define FAV3_CTRL_COMPRESS_VERIFY 0x240
#define FAV3_CTRL_COMPRESS_ENABLE 0x280
#define FAV3_CTRL_COMPRESS_MASK 0x2C0
#define FAV3_CTRL_VXS_RO_ENABLE (1 << 10)
/* Define Reset Bits */
#define FAV3_RESET_HARD_CNTL (1 << 0)
#define FAV3_RESET_HARD_PROC (1 << 1)
#define FAV3_RESET_SOFT_CNTL (1 << 4)
#define FAV3_RESET_SOFT_PROC (1 << 5)
#define FAV3_RESET_ADC_FIFO (1 << 8)
#define FAV3_RESET_HITSUM_FIFO (1 << 10)
#define FAV3_RESET_DAC (1 << 11)
#define FAV3_RESET_EXT_RAM_PT (1 << 12)
#define FAV3_RESET_TOKEN (1 << 16)
#define FAV3_RESET_ALL 0xFFFF
/* Define trig_scal bits */
#define FAV3_TRIG_SCAL_RESET (1 << 31)
/* Define trigger_control bits */
#define FAV3_TRIGCTL_TRIGSTOP_EN (1 << 31)
#define FAV3_TRIGCTL_MAX2_MASK 0x00FF0000
#define FAV3_TRIGCTL_BUSY_EN (1 << 15)
#define FAV3_TRIGCTL_MAX1_MASK 0x000000FF
/* Define trig21 delay bits */
#define FAV3_TRIG21_DELAY_MASK 0x00000FFF
/* Define MGT Control bits */
#define FAV3_RELEASE_MGT_RESET 0x0
#define FAV3_MGT_RESET 0x1
#define FAV3_INT_ACTIVE 0x1000000
#define FAV3_INT_IACKSTAT_WAIT 0x2000000
#define FAV3_INT_IACKSTAT_ONBT 0x4000000
/* Define RAM Bits */
#define FAV3_RAM_DATA_MASK 0x000fffff
#define FAV3_RAM_FULL 0x00100000
#define FAV3_RAM_EMPTY 0x00200000
#define FAV3_RAM_ADR_INCREMENT 0x00100000
/* Define dac_csr and dac_data bits */
#define FAV3_DAC_READY (1 << 16)
#define FAV3_DAC_SUCCESS (1 << 17)
#define FAV3_DAC_NOT_READY (1 << 18)
#define FAV3_DAC_TIMEOUT (1 << 19)
#define FAV3_DAC_CLEAR (1 << 29)
#define FAV3_DAC_INIT_DONE (1 << 30)
#define FAV3_DAC_INIT (1 << 31)
#define FAV3_DAC_DATA_MASK 0x00000FFF
#define FAV3_DAC_CHAN_MASK 0x0003C000
#define FAV3_DAC_MAX_VALUE 0xFFF
/* Define Bit Masks */
#define FAV3_VERSION_MASK 0x00000fff
#define FAV3_BOARD_MASK 0xffff0000
#define FAV3_CSR_MASK 0x0fffffff
#define FAV3_CONTROL_MASK 0xffffffff
#define FAV3_CONTROL2_MASK 0xc00432ff
#define FAV3_EVENT_COUNT_MASK 0xffffff
#define FAV3_BLOCK_COUNT_MASK 0xfffff
#define FAV3_BLOCK_LEVEL_MASK 0xffff
#define FAV3_INT_ENABLE_MASK 0xc0000
#define FAV3_INT_VEC_MASK 0xff
#define FAV3_INT_LEVEL_MASK 0x700
#define FAV3_SLOT_ID_MASK 0x1f0000
#define FAV3_DAC_VALUE_MASK 0x0fff
#define FAV3_THR_VALUE_MASK 0x0fff
#define FAV3_THR_ACCUMULATOR_SCALER_MODE_MASK 0x1000
#define FAV3_PLAYBACK_DIS_MASK 0x2000
#define FAV3_THR_INVERT_MASK 0x4000
#define FAV3_THR_IGNORE_MASK 0x8000
#define FAV3_REF_CLK_SEL_MASK 0x7
#define FAV3_TRIG_SEL_MASK 0x70
#define FAV3_SRESET_SEL_MASK 0x700
#define FAV3_BUSY_LEVEL_MASK 0xfffff
#define FAV3_FORCE_BUSY 0x80000000
#define FAV3_A32_ENABLE 0x1
#define FAV3_AMB_ENABLE 0x1
#define FAV3_A32_ADDR_MASK 0xff80 /* 8 MB chunks */
#define FAV3_AMB_MIN_MASK 0xff80
#define FAV3_AMB_MAX_MASK 0xff800000
#define FAV3_SADR_AUTO_INCREMENT 0x10000
#define FAV3_PPG_WRITE_VALUE 0x8000
#define FAV3_PPG_SAMPLE_MASK 0x1fff
#define FAV3_PPG_MAX_SAMPLES 512
#define FAV3_PPG_ENABLE 0x80
/* Define system_monitor Bits/Masks */
#define FAV3_SYSMON_CTRL_TEMP_MASK 0x3FF
#define FAV3_SYSMON_FPGA_CORE_V_MASK 0x001FF800
#define FAV3_SYSMON_FPGA_AUX_V_MASK 0xFFC00000
/* Define MGT Status Bits/Masks */
#define FAV3_MGT_GTX1_LANE1_UP 0x1
#define FAV3_MGT_GTX1_LANE2_UP 0x2
#define FAV3_MGT_GTX1_CHANNEL_UP 0x4
#define FAV3_MGT_GTX1_HARD_ERROR 0x8
#define FAV3_MGT_GTX1_SOFT_ERROR 0x10
#define FAV3_MGT_GTX2_LANE1_UP 0x20
#define FAV3_MGT_GTX2_LANE2_UP 0x40
#define FAV3_MGT_GTX2_CHANNEL_UP 0x80
#define FAV3_MGT_GTX2_HARD_ERROR 0x100
#define FAV3_MGT_GTX2_SOFT_ERROR 0x200
#define FAV3_MGT_SUM_DATA_VALID 0x400
#define FAV3_MGT_RESET_ASSERTED 0x800
/* Define default ADC Processing prarmeters
values are in clock cycles 4ns/cycle */
#define FAV3_ADC_NS_PER_CLK 4
#define FAV3_ADC_PROC_MASK 0x300
#define FAV3_ADC_PROC_ENABLE 0x8
#define FAV3_MAX_PROC_MODE 10
#define FAV3_PROC_MODE_RAW 1
#define FAV3_PROC_MODE_PULSE_PARAM 9
#define FAV3_PROC_MODE_DEBUG 10
#define FAV3_SUPPORTED_MODES 1,9,10
#define FAV3_SUPPORTED_NMODES 3
extern const char *faV3_mode_names[FAV3_MAX_PROC_MODE + 1];
#define FAV3_ADC_PTW_MASK 0x01FF
#define FAV3_ADC_PL_MASK 0x07FF
#define FAV3_ADC_NSB_MASK 0x000F
#define FAV3_ADC_NSA_MASK 0x01FF
#define FAV3_ADC_CONFIG1_NSAT_MASK 0x0C00
#define FAV3_ADC_CONFIG1_TNSAT_MASK 0x3000
#define FAV3_ADC_CONFIG1_CHAN_READ_ENABLE (1<<15)
#define FAV3_ADC_STATUS1_TRIG_RCV_DONE (1<<15)
#define FAV3_ADC_STATUS1_TRIGNUM_MASK 0x0FFF
#define FAV3_ADC_STATUS2_CHAN_DATA_MASK 0x3FFF
#define FAV3_ADC_CONFIG3_TPT_MASK 0x0FFF
#define FAV3_ADC_CONFIG6_MNPED_MASK 0x00003C00
#define FAV3_ADC_CONFIG6_PMAXPED_MASK 0x000003FF
#define FAV3_ADC_CONFIG7_NPED_MASK 0x00003C00
#define FAV3_ADC_CONFIG7_MAXPED_MASK 0x000003FF
#define FAV3_ROGUE_PTW_FALL_BACK_MASK 0x0000FFFF
#define FAV3_ENABLE_ADC_PARAMETERS_DATA 0x8000
#define FAV3_SUPPRESS_TRIGGER_TIME_DATA 0x10000
#define FAV3_SUPPRESS_TRIGGER_TIME_WORD2_DATA 0x20000
#define FAV3_SUPPRESS_TRIGGER_TIME_MASK 0x30000
#define FAV3_ADC_VERSION_MASK 0x7fff
#define FAV3_ADC_PLAYBACK_MODE 0x0080
#define FAV3_ADC_PEAK_MASK 0x0070
#define FAV3_ADC_CHAN_MASK 0xffff
#define FAV3_ADC_DEFAULT_MODE 10
#define FAV3_ADC_DEFAULT_PL 50
#define FAV3_ADC_DEFAULT_PTW 50
#define FAV3_ADC_DEFAULT_NSB 5
#define FAV3_ADC_DEFAULT_NSA 10
#define FAV3_ADC_DEFAULT_NP 4
#define FAV3_ADC_DEFAULT_THRESH 0
#define FAV3_ADC_DEFAULT_NPED 4
#define FAV3_ADC_DEFAULT_MAXPED 1
#define FAV3_ADC_DEFAULT_NSAT 1
#define FAV3_ADC_DEFAULT_MNPED 4
#define FAV3_ADC_DEFAULT_TNSA 10
#define FAV3_ADC_DEFAULT_TNSAT 1
#define FAV3_ADC_DEFAULT_TPT 0
#define FAV3_ADC_DEFAULT_TET 10
#define FAV3_ADC_DEFAULT_DAC 3000
#define FAV3_ADC_MAX_PL 4096
#define FAV3_ADC_MAX_PTW 1024
#define FAV3_ADC_MAX_NSB 16
#define FAV3_ADC_MAX_NSA 512
#define FAV3_ADC_MAX_NP 4
#define FAV3_ADC_MAX_THRESH 8191
#define FAV3_ADC_MAX_NPED 15
#define FAV3_ADC_MAX_MAXPED 1023
#define FAV3_ADC_MAX_NSAT 4
#define FAV3_ADC_MAX_MNPED 15
#define FAV3_ADC_MAX_TNSA 63
#define FAV3_ADC_MAX_TNSAT 4
#define FAV3_ADC_MAX_TPT 4095
#define FAV3_ADC_MIN_PL 0
#define FAV3_ADC_MIN_PTW 6
#define FAV3_ADC_MIN_NSB 0
#define FAV3_ADC_MIN_NSA 2
#define FAV3_ADC_MIN_NP 1
#define FAV3_ADC_MIN_THRESH 0
#define FAV3_ADC_MIN_NPED 4
#define FAV3_ADC_MIN_MAXPED 0
#define FAV3_ADC_MIN_NSAT 1
#define FAV3_ADC_MIN_MNPED 4
#define FAV3_ADC_MIN_TNSA 0
#define FAV3_ADC_MIN_TNSAT 1
#define FAV3_ADC_MIN_TPT 0
#define FAV3_ADC_NSB_READBACK_MASK 0x0000000F
#define FAV3_ADC_NSB_NEGATIVE (1<<3)
#define FAV3_ADC_NSA_READBACK_MASK 0x000001FF
#define FAV3_ADC_TNSA_MASK 0x00007E00
#define FAV3_ADC_TPT_MASK 0xFFF
#define FAV3_ADC_PEDESTAL_MASK 0xffff
#define FAV3_ADC_DELAY_MASK 0x1ff
/* Define parameters for HITSUM (Trigger) FPGA */
#define FAV3_ITRIG_VERSION_MASK 0x1fff
#define FAV3_ITRIG_CONFIG_MASK 0x001F
#define FAV3_ITRIG_ENABLE_MASK 0x0010
#define FAV3_ITRIG_P2OUT_MASK 0x0008
#define FAV3_ITRIG_MODE_MASK 0x0007
#define FAV3_ITRIG_TABLE_MODE 0
#define FAV3_ITRIG_COIN_MODE 1
#define FAV3_ITRIG_WINDOW_MODE 2
#define FAV3_ITRIG_UNDEF_MODE 3
#define FAV3_ITRIG_SUM_MODE 4
#define FAV3_ITRIG_DISABLED 0x0010
#define FAV3_ITRIG_HB_P2OUT 0x0008
#define FAV3_ITRIG_OUT_MASK 0x0000f000 /* Bits from ctrl1 register */
#define FAV3_ITRIG_OUT_FP 0x00003000
#define FAV3_ITRIG_MIN_WIDTH 0x01 /* 4 nsec */
#define FAV3_ITRIG_MAX_WIDTH 0x100 /* 1.024 microsec */
#define FAV3_ITRIG_MAX_DELAY 0xf00 /* 15.360 microsec */
#define FAV3_ITRIG_WINDOW_MAX_WIDTH 0x200 /* 2.048 microsec */
#define FAV3_ITRIG_MAX_HB_WIDTH 0xff /* 1020 ns */
#define FAV3_ITRIG_MAX_HB_DELAY 0xf /* 60 ns */
#define FAV3_ITRIG_HB_INFO_MASK 0xffff
#define FAV3_ITRIG_HB_WIDTH_MASK 0x00ff
#define FAV3_ITRIG_HB_DELAY_MASK 0x1f00
/* Define State registers bits and masks */
#define FAV3_STATE_LEVEL_CAPTURE_MASK 0x000000FF
#define FAV3_STATE_CSR_ARM_BUFFER (1<<31)
#define FAV3_STATE_CSR_BUFFER_FULL (1<<27)
#define FAV3_STATE_CSR_BUFFER_EMPTY (1<<26)
#define FAV3_STATE_CSR_BUFFER_WORDS_MASK 0x000000FF
#define FAV3_STATE_VALUE_MASK 0x0000FFFF
/* Define ADC Data Types and Masks */
#define FAV3_DATA_TYPE_DEFINE 0x80000000
#define FAV3_DATA_TYPE_MASK 0x78000000
#define FAV3_DATA_SLOT_MASK 0x07c00000
#define FAV3_DATA_BLOCK_HEADER 0x00000000
#define FAV3_DATA_BLOCK_TRAILER 0x08000000
#define FAV3_DATA_EVENT_HEADER 0x10000000
#define FAV3_DATA_TRIGGER_TIME 0x18000000
#define FAV3_DATA_WINDOW_RAW 0x20000000
#define FAV3_DATA_WINDOW_SUM 0x28000000
#define FAV3_DATA_PULSE_RAW 0x30000000
#define FAV3_DATA_PULSE_INTEGRAL 0x38000000
#define FAV3_DATA_PULSE_TIME 0x40000000
#define FAV3_DATA_STREAM 0x48000000
#define FAV3_DATA_INVALID 0x70000000
#define FAV3_DATA_FILLER 0x78000000
#define FAV3_DUMMY_DATA 0xf800fafa
#define FAV3_DATA_BLKNUM_MASK 0x0000003f
#define FAV3_DATA_WRDCNT_MASK 0x003fffff
#define FAV3_DATA_TRIGNUM_MASK 0x07ffffff
/* Define Scaler Control bits */
#define FAV3_SCALER_CTRL_ENABLE (1<<0)
#define FAV3_SCALER_CTRL_LATCH (1<<1)
#define FAV3_SCALER_CTRL_RESET (1<<2)
#define FAV3_SCALER_CTRL_MASK (0x7)
/* Define Scaler Insert Mask */
#define FAV3_SCALER_INSERT_MASK 0x0000FFFF
/* Define Sum Threshold bits and masks */
#define FAV3_SUM_THRESHOLD_DREADY (1<<31)
#define FAV3_SUM_THRESHOLD_MASK 0x0000FFFF
/* Define Sum Data bits and masks */
#define FAV3_SUM_DATA_ARM_HISTORY_BUFFER (1<<31)
#define FAV3_SUM_DATA_SAMPLE_MASK 0x0000FFFF
/* Define Serial Number bits and masks */
#define FAV3_SERIAL_NUMBER_BOARDID_MASK 0x0000FFFF
/* Define FADC Signal Distribution card bits */
#define FAV3_SDC_BOARD_ID 0x0200
#define FAV3_SDC_BOARD_MASK 0xfffe
#define FAV3_SDC_ADR_MASK 0xffc0
#define FAV3SDC_BUSY_MASK 0x00ff
#define FAV3SDC_CSR_BUSY 0x1
#define FAV3SDC_CSR_TRIG 0x20
#define FAV3SDC_CSR_SRESET 0x40
#define FAV3SDC_CSR_INIT 0x80
#define FAV3SDC_CSR_MASK 0x00e1
#define FAV3SDC_CTRL_CLK_EXT 0x1
#define FAV3SDC_CTRL_NOSYNC_TRIG 0x10
#define FAV3SDC_CTRL_ENABLE_SOFT_TRIG 0x20
#define FAV3SDC_CTRL_NOSYNC_SRESET 0x100
#define FAV3SDC_CTRL_ENABLE_SOFT_SRESET 0x200
#define FAV3SDC_CTRL_ASSERT_SOFT_BUSY 0x8000
#define FAV3SDC_CTRL_MASK 0x8331
#define FAV3_CTRL1_SYSTEM_TEST_MODE (1<<31)
#define FAV3_TESTBIT_TRIGOUT (1<<0)
#define FAV3_TESTBIT_BUSYOUT (1<<1)
#define FAV3_TESTBIT_SDLINKOUT (1<<2)
#define FAV3_TESTBIT_TOKENOUT (1<<3)
#define FAV3_TESTBIT_STATBITB (1<<8)
#define FAV3_TESTBIT_TOKENIN (1<<9)
#define FAV3_TESTBIT_CLOCK250_STATUS (1<<15)
#define FAV3_CLOCK250COUNT_RESET (0<<0)
#define FAV3_CLOCK250COUNT_START (1<<0)
#define FAV3_SYNCP0COUNT_RESET (0<<0)
#define FAV3_TRIG1P0COUNT_RESET (0<<0)
#define FAV3_TRIG2P0COUNT_RESET (0<<0)
/* 0x520 sparse control */
#define FAV3_SPARSE_CONTROL_BYPASS (1 << 0)
#define FAV3_SPARSE_CONTROL_MODE_MASK 0x0000000E
/* 0x524 sparse status */
#define FAV3_SPARSE_STATUS_MASK 0x00000003
#define FAV3_SPARSE_STATUS_WAIT_CHANNEL_MASK (1 << 0)
#define FAV3_SPARSE_STATUS_ACTIVE (1 << 1)
#define FAV3_SPARSE_STATUS_CLEAR (1 << 31)
/* faV3Init initialization flag bits */
#define FAV3_INIT_SOFT_SYNCRESET (0<<0)
#define FAV3_INIT_EXT_SYNCRESET (1<<0)
#define FAV3_INIT_SOFT_TRIG (0<<1)
#define FAV3_INIT_FP_TRIG (1<<1)
#define FAV3_INIT_VXS_TRIG (2<<1)
#define FAV3_INIT_INT_CLKSRC (0<<4)
#define FAV3_INIT_FP_CLKSRC (1<<4)
#define FAV3_INIT_VXS_CLKSRC (2<<4)
#define FAV3_INIT_P2_CLKSRC ((1<<4) | (2<<4))
#define FAV3_INIT_SKIP (1<<16)
#define FAV3_INIT_USE_ADDRLIST (1<<17)
#define FAV3_INIT_SKIP_FIRMWARE_CHECK (1<<18)
#define FAV3_INIT_MULTIBLOCK_ONLY (1<<19)
#define FAV3_INIT_VXS_READOUT_ONLY (1<<20)
#define FAV3_INIT_A32_SLOTNUMBER (1<<21)
/* Define Init Flag bits for Clock Source */
#define FAV3_SOURCE_INT FAV3_INIT_INT_CLKSRC
#define FAV3_SOURCE_SDC FAV3_INIT_FP_CLKSRC
#define FAV3_SOURCE_VXS FAV3_INIT_VXS_CLKSRC
#define FAV3_SOURCE_MASK 0x30
/* fadcBlockError values */
#define FAV3_BLOCKERROR_NO_ERROR 0
#define FAV3_BLOCKERROR_TERM_ON_WORDCOUNT 1
#define FAV3_BLOCKERROR_UNKNOWN_BUS_ERROR 2
#define FAV3_BLOCKERROR_ZERO_WORD_COUNT 3
#define FAV3_BLOCKERROR_DMADONE_ERROR 4
#define FAV3_BLOCKERROR_NTYPES 5
/* Number of regs to read in faDebugOutput */
#define FAV3_DEBUG_OUTPUT_NREGS 57
enum faV3_firmware_functions
{
FAV3_FW_CTRL = 0,
FAV3_FW_PROC = 1,
FAV3_FW_FUNCTION_MAX
};
enum faV3_ctrl_firmware_types
{
FAV3_FW_CTRL_COMMON = 0,
FAV3_FW_CTRL_MAX
};
enum faV3_proc_firmware_types
{
FAV3_FW_PROC_COMMON = 0,
FAV3_FW_PROC_HALLD_PRODUCTION = 1,
FAV3_FW_PROC_MAX
};
enum faV3_setupadc_modes
{
FAV3_SETUPADC_MODE_NORMAL = 0,
FAV3_SETUPADC_MODE_MAX
};
/* Function Prototypes */
int faV3Init(uint32_t addr, uint32_t addr_inc, int nadc, int iFlag);
void faV3SetA32BaseAddress(uint32_t addr);
int faV3Slot(uint32_t i);
int faV3Id(uint32_t slot);
int faV3GetN();
int faV3SetClockSource(int id, int clkSrc);
int faV3GSetClockSource(int clkSrc);
int faV3Status(int id, int sflag);
void faV3GStatus(int sflag);
uint32_t faV3GetFirmwareVersions(int id, int pflag);
int faV3SetProcMode(int id, int pmode, uint32_t PL, uint32_t PTW,
uint32_t NSB, uint32_t NSA, uint32_t NP);
void faV3GSetProcMode(int pmode, uint32_t PL, uint32_t PTW,
uint32_t NSB, uint32_t NSA, uint32_t NP);
int faV3GetProcMode(int id, int *pmode, uint32_t * PL, uint32_t * PTW,
uint32_t * NSB, uint32_t * NSA, uint32_t * NP);
int32_t faV3SetPulseParameterConfig(int32_t id, uint32_t NPED, uint32_t MAXPED, uint32_t NSAT);
int32_t faV3GetPulseParameterConfig(int32_t id, uint32_t *NPED, uint32_t *MAXPED, uint32_t *NSAT);
int faV3SetTriggerStopCondition(int id, int trigger_max);
int faV3GetTriggerStopCondition(int id, int *trigger_max);
int faV3SetTriggerBusyCondition(int id, int trigger_max);
int faV3GetTriggerBusyCondition(int id, int *trigger_max);
int faV3SetTriggerPathSamples(int id, uint32_t TNSA, uint32_t TNSAT);
void faV3GSetTriggerPathSamples(uint32_t TNSA, uint32_t TNSAT);
int faV3GetTriggerPathSamples(int id, uint32_t *TNSA, uint32_t *TNSAT);
int faV3SetTriggerPathThreshold(int id, uint32_t TPT);
void faV3GSetTriggerPathThreshold(uint32_t TPT);
int faV3GetTriggerPathThreshold(int id, uint32_t *TPT);
int32_t faV3SetupADC(int id, int32_t mode);
int faV3SetPPG(int id, uint16_t *sdata, int nsamples);
int faV3PPGEnable(int id);
int faV3PPGDisable(int id);
uint32_t faV3ItrigControl(int id, uint16_t itrig_width, uint16_t itrig_dt);
int faV3ReadBlock(int id, volatile uint32_t * data, int nwrds, int rflag);
int faV3GetBlockError(int pflag);
int faV3PrintBlock(int id);
uint32_t faV3ReadCSR(int id);
int faV3Clear(int id);
void faV3GClear();
int faV3ClearError(int id);
void faV3GClearError();
int faV3Reset(int id, int iFlag);
void faV3GReset(int iFlag);
int faV3SoftReset(int id, int cflag);
int faV3ResetToken(int id);
int faV3TokenStatus(int id);
int faV3GTokenStatus();
uint32_t faV3GetTokenStatus(int pflag);
int faV3SetChanDisableMask(int id, uint16_t channel);
uint32_t faV3GetChanDisableMask(int id);
int faV3SetCompression(int id, int opt);
int faV3GetCompression(int id);
int faV3SetVXSReadout(int id, int opt);
void faV3GSetVXSReadout(int opt);
int faV3GetVXSReadout(int id);
int faV3EnableSyncSrc(int id);
void faV3GEnableSyncSrc();
int faV3Enable(int id, int eflag);
void faV3GEnable(int eflag);
int faV3Disable(int id, int eflag);
void faV3GDisable(int eflag);
int faV3Trig(int id);
void faV3GTrig();
int faV3Trig2(int id);
void faV3GTrig2();
int faV3SetTrig21Delay(int id, int delay);
int faV3GetTrig21Delay(int id);
int faV3EnableInternalPlaybackTrigger(int id);
int faV3Sync(int id);
int faV3Dready(int id, int dflag);
int faV3Bready(int id);
uint32_t faV3GBready();
uint32_t faV3GBlockReady(uint32_t slotmask, int nloop);
uint32_t faV3ScanMask();
int faV3BusyLevel(int id, uint32_t val, int bflag);
int faV3Busy(int id);
int faV3EnableSoftTrig(int id);
int faV3DisableSoftTrig(int id);
int faV3EnableSoftSync(int id);
int faV3DisableSoftSync(int id);
int faV3EnableClk(int id);
int faV3DisableClk(int id);
int faV3EnableTriggerOut(int id, int output);
int faV3EnableBusError(int id);
void faV3GEnableBusError();
int faV3DisableBusError(int id);
int faV3EnableMultiBlock(int tflag);
int faV3DisableMultiBlock();
int faV3SetBlockLevel(int id, int level);
void faV3GSetBlockLevel(int level);
int faV3SetClkSource(int id, int source);
int faV3SetTrigSource(int id, int source);
int faV3SetSyncSource(int id, int source);
int faV3EnableFP(int id);
int faV3SetTrigOut(int id, int trigout);
uint32_t faV3GetTriggerCount(int id);
int faV3ResetTriggerCount(int id);
int faV3SetThreshold(int id, int chan, uint16_t tvalue);
int faV3GetThreshold(int id, int chan);
int faV3PrintThreshold(int id);
int32_t faV3DACInit(int id);
int32_t faV3DACClear(int id);
int32_t faV3DACStatus(int id);
int32_t faV3DACSet(int id, int chan, uint32_t dac_value);
int32_t faV3DACGet(int id, int chan, uint32_t *dac_value);
int32_t faV3DACPrint(int id);
int faV3SetPedestal(int id, int chan, uint32_t ped);
int faV3GetPedestal(int id, int chan);
int faV3PrintPedestal(int id);
int faV3SetChannelDelay(int id, int chan, uint16_t delay);
int faV3GetChannelDelay(int id, int chan);
int faV3SetInvertMask(int id, uint16_t chmask);
uint16_t faV3GetInvertMask(int id);
int faV3SetTriggerProcessingMode(int id, int chan, int mode);
int faV3GetTriggerProcessingMode(int id, int chan);
int faV3SetChannelGain(int id, int chan, float gain);
float faV3GetChannelGain(int id, int chan);
/* scaler routine prototypes */
int faV3ReadScalers(int id, volatile uint32_t * data, uint32_t chmask, int rflag);
int faV3PrintScalers(int id, int rflag);
int faV3ClearScalers(int id);
int faV3LatchScalers(int id);
int faV3EnableScalers(int id);
int faV3DisableScalers(int id);
uint32_t faV3GetA32(int id);
uint32_t faV3GetA32M();
uint32_t faV3GetMinA32MB(int id);
uint32_t faV3GetMaxA32MB(int id);
int faV3PrintFifoStatus(int id);
int faV3Live(int id, int sflag);
void faV3DataDecode(uint32_t data);
int faV3TestSetSystemTestMode(int id, int mode);
int faV3TestSetTrigOut(int id, int mode);
int faV3TestSetBusyOut(int id, int mode);
int faV3TestSetSdLink(int id, int mode);
int faV3TestSetTokenOut(int id, int mode);
int faV3TestGetStatBitB(int id);
int faV3TestGetTokenIn(int id);
int faV3TestGetClock250CounterStatus(int id);
uint32_t faV3TestGetClock250Counter(int id);
uint32_t faV3TestGetSyncCounter(int id);
uint32_t faV3TestGetTrig1Counter(int id);
uint32_t faV3TestGetTrig2Counter(int id);
int faV3TestResetClock250Counter(int id);
int faV3TestResetSyncCounter(int id);
int faV3TestResetTrig1Counter(int id);
int faV3TestResetTrig2Counter(int id);
uint32_t faV3TestGetTestBitReg(int id);
int faV3TestSystemClock(int id, int pflag);
int faV3GetSerialNumber(int id, char **rval);
int faV3SetScalerBlockInterval(int id, uint32_t nblock);
int faV3GetScalerBlockInterval(int id);
int faV3ForceEndOfBlock(int id, int scalers);
void faV3GForceEndOfBlock(int scalers);
int faV3SetSparsificationMode(int id, int mode);
void faV3GSetSparsificationMode(int mode);
int faV3GetSparsificationMode(int id);
int faV3GetSparsificationStatus(int id);
int faV3ClearSparsificationStatus(int id);
void faV3GClearSparsificationStatus();
int faV3PrintAuxScal(int id);
uint32_t faV3GetFirstTriggerMismatch(int id);
uint32_t faV3GetMismatchTriggerCount(int id);
uint32_t faV3GetTriggersProcessedCount(int id);
int32_t faV3LoadIdelay(int32_t id, int32_t pflag);
int32_t faV3IDelayPrint(int32_t id);
int faV3SampleConfig(int id, int nsamples, int maxvalue);
int faV3GSampleConfig(int nsamples, int maxvalue);
int faV3ReadAllChannelSamples(int id, uint16_t data[16]);
int faV3SetRoguePTWFallBack(int id, uint16_t enablemask);