-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathvxlapi.h
executable file
·2990 lines (2513 loc) · 152 KB
/
vxlapi.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
/*----------------------------------------------------------------------------
| File:
| vxlapi.h
| Project:
| Multi Bus driver for Win98/WinNT/Win2000/WinXP
|
| Description:
| Driver Interface Prototypes - customer version
|
|-----------------------------------------------------------------------------
| $Author: Jörg $ $Locker: $ $Revision: 49 $
| $Header: /VCANDRV/XLAPI/bin/vxlapi.h 49 27.08.08 7:02 Jörg $
|-----------------------------------------------------------------------------
| Copyright (c) 2008 by Vector Informatik GmbH. All rights reserved.
----------------------------------------------------------------------------*/
#ifndef _V_XLAPI_H_
#define _V_XLAPI_H_
#ifdef __cplusplus
extern "C" {
#endif
#define _XL_EXPORT_API __stdcall
#ifndef DYNAMIC_XLDRIVER_DLL
#ifndef BUILD_DLL_FOR_MSVC
#define _XL_EXPORT_DECL __declspec(dllimport) _XL_EXPORT_API
#define _XL_EXPORT_DEF __declspec(dllimport) _XL_EXPORT_API
#else
#define _XL_EXPORT_DECL __declspec(dllexport) _XL_EXPORT_API
#define _XL_EXPORT_DEF __declspec(dllexport) _XL_EXPORT_API
#endif
#endif
// Functions have the following parameters
#define DEFPARAMS XLportHandle portHandle, XLaccess accessMask, XLuserHandle userHandle
// Almost all xlFr... Functions have the following parameters
#define DEFFRPARAM XLportHandle portHandle, XLaccess accessMask
// Marcos for interface definition and implementation
#ifdef DYNAMIC_XLDRIVER_DLL
#ifdef DO_NOT_DEFINE_EXTERN_DECLARATION
// All DECL_STDXL_FUNC have return type XLstatus
#define DECL_STDXL_FUNC(apiname, apitype, args) \
typedef XLstatus (_XL_EXPORT_API *apitype) args
#else // DO_NOT_DEFINE_EXTERN_DECLARATION
#define DECL_STDXL_FUNC(apiname, apitype, args) \
typedef XLstatus (_XL_EXPORT_API *apitype) args; \
extern apitype apiname
#endif // DO_NOT_DEFINE_EXTERN_DECLARATION
#else // DYNAMIC_XLDRIVER_DLL
// All DECL_STDXL_FUNC have return type XLstatus
#define DECL_STDXL_FUNC(apiname, apitype, args) \
XLstatus _XL_EXPORT_DECL apiname args
#define IMPL_STDXL_FUNC(apiname, args) \
XLstatus _XL_EXPORT_DEF apiname args
#endif // DYNAMIC_XLDRIVER_DLL
// the pshpack1.h which is shiped with BCB 6 has
// some problem with one byte alignment. So we use the pragma
#if (__BORLANDC__ >= 0x0560)
#pragma pack(push,1)
#else
#include <pshpack1.h>
#endif
//------------------------------------------------------------------------------
// Transceiver types
//------------------------------------------------------------------------------
// CAN Cab
#define XL_TRANSCEIVER_TYPE_NONE 0x0000
#define XL_TRANSCEIVER_TYPE_CAN_251 0x0001
#define XL_TRANSCEIVER_TYPE_CAN_252 0x0002
#define XL_TRANSCEIVER_TYPE_CAN_DNOPTO 0x0003
#define XL_TRANSCEIVER_TYPE_CAN_SWC_PROTO 0x0005 //!< Prototype. Driver may latch-up.
#define XL_TRANSCEIVER_TYPE_CAN_SWC 0x0006
#define XL_TRANSCEIVER_TYPE_CAN_EVA 0x0007
#define XL_TRANSCEIVER_TYPE_CAN_FIBER 0x0008
#define XL_TRANSCEIVER_TYPE_CAN_1054_OPTO 0x000B //!< 1054 with optical isolation
#define XL_TRANSCEIVER_TYPE_CAN_SWC_OPTO 0x000C //!< SWC with optical isolation
#define XL_TRANSCEIVER_TYPE_CAN_B10011S 0x000D //!< B10011S truck-and-trailer
#define XL_TRANSCEIVER_TYPE_CAN_1050 0x000E //!< 1050
#define XL_TRANSCEIVER_TYPE_CAN_1050_OPTO 0x000F //!< 1050 with optical isolation
#define XL_TRANSCEIVER_TYPE_CAN_1041 0x0010 //!< 1041
#define XL_TRANSCEIVER_TYPE_CAN_1041_OPTO 0x0011 //!< 1041 with optical isolation
#define XL_TRANSCEIVER_TYPE_LIN_6258_OPTO 0x0017 //!< Vector LINcab 6258opto with transceiver Infineon TLE6258
#define XL_TRANSCEIVER_TYPE_LIN_6259_OPTO 0x0019 //!< Vector LINcab 6259opto with transceiver Infineon TLE6259
#define XL_TRANSCEIVER_TYPE_DAIO_8444_OPTO 0x001D //!< Vector IOcab 8444 (8 dig.Inp.; 4 dig.Outp.; 4 ana.Inp.; 4 ana.Outp.)
#define XL_TRANSCEIVER_TYPE_CAN_1041A_OPTO 0x0021 //!< 1041A with optical isolation
#define XL_TRANSCEIVER_TYPE_LIN_6259_MAG 0x0023 //!< LIN transceiver 6259, with transceiver Infineon TLE6259, magnetically isolated, stress functionality
#define XL_TRANSCEIVER_TYPE_LIN_7259_MAG 0x0025 //!< LIN transceiver 7259, with transceiver Infineon TLE7259, magnetically isolated, stress functionality
#define XL_TRANSCEIVER_TYPE_CAN_1054_MAG 0x0033 //!< TJA1054, magnetically isolated, with selectable termination resistor (via 4th IO line)
#define XL_TRANSCEIVER_TYPE_CAN_251_MAG 0x0035 //!< 82C250/251 or equivalent, magnetically isolated
#define XL_TRANSCEIVER_TYPE_CAN_1050_MAG 0x0037 //!< TJA1050, magnetically isolated
#define XL_TRANSCEIVER_TYPE_CAN_1040_MAG 0x0039 //!< TJA1040, magnetically isolated
#define XL_TRANSCEIVER_TYPE_CAN_1041A_MAG 0x003B //!< TJA1041A, magnetically isolated
#define XL_TRANSCEIVER_TYPE_TWIN_CAN_1041A_MAG 0x0080 //!< TWINcab with two TJA1041A, magnetically isolated
// CAN PiggyBack
#define XL_TRANSCEIVER_TYPE_PB_CAN_251 0x0101
#define XL_TRANSCEIVER_TYPE_PB_CAN_1054 0x0103
#define XL_TRANSCEIVER_TYPE_PB_CAN_251_OPTO 0x0105
#define XL_TRANSCEIVER_TYPE_PB_CAN_SWC 0x010B
// 0x010D not supported, 0x010F, 0x0111, 0x0113 reserved for future use!!
#define XL_TRANSCEIVER_TYPE_PB_CAN_1054_OPTO 0x0115
#define XL_TRANSCEIVER_TYPE_PB_CAN_SWC_OPTO 0x0117
#define XL_TRANSCEIVER_TYPE_PB_CAN_TT_OPTO 0x0119
#define XL_TRANSCEIVER_TYPE_PB_CAN_1050 0x011B
#define XL_TRANSCEIVER_TYPE_PB_CAN_1050_OPTO 0x011D
#define XL_TRANSCEIVER_TYPE_PB_CAN_1041 0x011F
#define XL_TRANSCEIVER_TYPE_PB_CAN_1041_OPTO 0x0121
#define XL_TRANSCEIVER_TYPE_PB_LIN_6258_OPTO 0x0129 //!< LIN piggy back with transceiver Infineon TLE6258
#define XL_TRANSCEIVER_TYPE_PB_LIN_6259_OPTO 0x012B //!< LIN piggy back with transceiver Infineon TLE6259
#define XL_TRANSCEIVER_TYPE_PB_LIN_6259_MAG 0x012D //!< LIN piggy back with transceiver Infineon TLE6259, magnetically isolated, stress functionality
#define XL_TRANSCEIVER_TYPE_PB_CAN_1041A_OPTO 0x012F //!< CAN transceiver 1041A
#define XL_TRANSCEIVER_TYPE_PB_LIN_7259_MAG 0x0131 //!< LIN piggy back with transceiver Infineon TLE7259, magnetically isolated, stress functionality
#define XL_TRANSCEIVER_TYPE_PB_CAN_251_MAG 0x0135 //!< 82C250/251 or compatible, magnetically isolated
#define XL_TRANSCEIVER_TYPE_PB_CAN_1050_MAG 0x0136 //!< TJA 1050, magnetically isolated
#define XL_TRANSCEIVER_TYPE_PB_CAN_1040_MAG 0x0137 //!< TJA 1040, magnetically isolated
#define XL_TRANSCEIVER_TYPE_PB_CAN_1041A_MAG 0x0138 //!< TJA 1041A, magnetically isolated
#define XL_TRANSCEIVER_TYPE_PB_DAIO_8444_OPTO 0x0139 //!< optically isolated IO piggy
#define XL_TRANSCEIVER_TYPE_PB_CAN_1054_MAG 0x013B //!< TJA1054, magnetically isolated, with selectable termination resistor (via 4th IO line)
// FlexRay PiggyBacks
#define XL_TRANSCEIVER_TYPE_PB_FR_1080 0x0201 //!< refer to \\vistrpnifs1\data\Hardware\Projects\cab-piggy-cartridge\!Technical_Info_CANcab_CANpiggy.xls
#define XL_TRANSCEIVER_TYPE_PB_FR_1080_MAG 0x0202 //!< TJA 1080 magnetically isolated piggy
//------------------------------------------------------------------------------
// Transceiver Operation Modes
//------------------------------------------------------------------------------
#define XL_TRANSCEIVER_LINEMODE_NA ((unsigned int)0x0000)
#define XL_TRANSCEIVER_LINEMODE_TWO_LINE ((unsigned int)0x0001)
#define XL_TRANSCEIVER_LINEMODE_CAN_H ((unsigned int)0x0002)
#define XL_TRANSCEIVER_LINEMODE_CAN_L ((unsigned int)0x0003)
#define XL_TRANSCEIVER_LINEMODE_SWC_SLEEP ((unsigned int)0x0004) //!< SWC Sleep Mode.
#define XL_TRANSCEIVER_LINEMODE_SWC_NORMAL ((unsigned int)0x0005) //!< SWC Normal Mode.
#define XL_TRANSCEIVER_LINEMODE_SWC_FAST ((unsigned int)0x0006) //!< SWC High-Speed Mode.
#define XL_TRANSCEIVER_LINEMODE_SWC_WAKEUP ((unsigned int)0x0007) //!< SWC Wakeup Mode.
#define XL_TRANSCEIVER_LINEMODE_SLEEP ((unsigned int)0x0008)
#define XL_TRANSCEIVER_LINEMODE_NORMAL ((unsigned int)0x0009)
#define XL_TRANSCEIVER_LINEMODE_STDBY ((unsigned int)0x000a) //!< Standby for those who support it
#define XL_TRANSCEIVER_LINEMODE_TT_CAN_H ((unsigned int)0x000b) //!< truck & trailer: operating mode single wire using CAN high
#define XL_TRANSCEIVER_LINEMODE_TT_CAN_L ((unsigned int)0x000c) //!< truck & trailer: operating mode single wire using CAN low
#define XL_TRANSCEIVER_LINEMODE_EVA_00 ((unsigned int)0x000d) //!< CANcab Eva
#define XL_TRANSCEIVER_LINEMODE_EVA_01 ((unsigned int)0x000e) //!< CANcab Eva
#define XL_TRANSCEIVER_LINEMODE_EVA_10 ((unsigned int)0x000f) //!< CANcab Eva
#define XL_TRANSCEIVER_LINEMODE_EVA_11 ((unsigned int)0x0010) //!< CANcab Eva
//------------------------------------------------------------------------------
// Transceiver Capabilities
//------------------------------------------------------------------------------
#define XL_TRANSCEIVER_CAPABILITY_NONE ((unsigned int) 0)
#define XL_TRANSCEIVER_CAPABILITY_HIGHSPEED ((unsigned int) 1)
//------------------------------------------------------------------------------
// Transceiver Status Flags
//------------------------------------------------------------------------------
// (not all used, but for compatibility reasons)
#define XL_TRANSCEIVER_STATUS_PRESENT ((unsigned int)0x0001)
#define XL_TRANSCEIVER_STATUS_POWER ((unsigned int)0x0002)
#define XL_TRANSCEIVER_STATUS_MEMBLANK ((unsigned int)0x0004)
#define XL_TRANSCEIVER_STATUS_MEMCORRUPT ((unsigned int)0x0008)
#define XL_TRANSCEIVER_STATUS_POWER_GOOD ((unsigned int)0x0010)
#define XL_TRANSCEIVER_STATUS_EXT_POWER_GOOD ((unsigned int)0x0020)
////////////////////////////////////////////////////////////////////////////////
// For the timestamps and the access mask the API use 64 bit values
typedef unsigned __int64 XLuint64;
////////////////////////////////////////////////////////////////////////////////
typedef char *XLstringType;
////////////////////////////////////////////////////////////////////////////////
// accessmask
typedef XLuint64 XLaccess;
////////////////////////////////////////////////////////////////////////////////
// handle for xlSetNotification
typedef HANDLE XLhandle;
////////////////////////////////////////////////////////////////////////////////
// LIN lib
//------------------------------------------------------------------------------
// defines for LIN
//------------------------------------------------------------------------------
// defines for xlLinSetChannelParams
#define XL_LIN_MASTER 01 //!< channel is a LIN master
#define XL_LIN_SLAVE 02 //!< channel is a LIN slave
#define XL_LIN_VERSION_1_3 0x01 //!< LIN version 1.3
#define XL_LIN_VERSION_2_0 0x02 //!< LIN version 2.0
// defines for xlLinSetSlave
#define XL_LIN_CALC_CHECKSUM 0x100 //!< flag for automatic 'classic' checksum calculation
#define XL_LIN_CALC_CHECKSUM_ENHANCED 0x200 //!< flag for automatic 'enhanced' checksum calculation
// defines for the SleepMode function call
#define XL_LIN_SET_SILENT 0x01 //!< set hardware into sleep mode
#define XL_LIN_SET_WAKEUPID 0x03 //!< set hardware into sleep mode and send a request at wake-up
// defines for xlLinSetChecksum. For LIN >= 2.0 there can be used two different Checksum models.
#define XL_LIN_CHECKSUM_CLASSIC 0x00 //!< Use classic CRC
#define XL_LIN_CHECKSUM_ENHANCED 0x01 //!< Use enhanced CRC
#define XL_LIN_CHECKSUM_UNDEFINED 0xff //!< Set the checksum calculation to undefined.
// defines for the wake-up events
#define XL_LIN_STAYALIVE 0x00 //!< flag if nothing changes
#define XL_LIN_SET_SLEEPMODE 0x01 //!< flag if the hardware is set into the sleep mode
#define XL_LIN_COMESFROM_SLEEPMODE 0x02 //!< flag if the hardware comes from the sleep mode
#define XL_LIN_WAKUP_INTERNAL 0x01 //!< flag to signal a internal WAKEUP (event)
#define XL_LIN_UNDEFINED_DLC 0xff //!< set the DLC to undefined (xlLINSetDLC)
// defines for xlLinSwitchSlave
#define XL_LIN_SLAVE_ON 0xff //!< switch on the LIN slave
#define XL_LIN_SLAVE_OFF 0x00 //!< switch off the LIN slave
//------------------------------------------------------------------------------
// structures for LIN
//------------------------------------------------------------------------------
typedef struct {
unsigned int LINMode; //!< XL_LIN_SLAVE | XL_LIN_MASTER
int baudrate; //!< the baudrate will be calculated within the API. Here: e.g. 9600, 19200
unsigned int LINVersion; //!< define for the LIN version (actual V1.3 of V2.0)
unsigned int reserved; //!< for future use
} XLlinStatPar;
////////////////////////////////////////////////////////////////////////////////
// Defines
//------------------------------------------------------------------------------
// message flags
#ifndef MAX_MSG_LEN
#define MAX_MSG_LEN 8
#endif
// interface version for our events
#define XL_INTERFACE_VERSION_V2 2
#define XL_INTERFACE_VERSION_V3 3
#define XL_INTERFACE_VERSION_V4 4
//current version
#define XL_INTERFACE_VERSION XL_INTERFACE_VERSION_V3
#define XL_CAN_EXT_MSG_ID 0x80000000
#define XL_CAN_MSG_FLAG_ERROR_FRAME 0x01
#define XL_CAN_MSG_FLAG_OVERRUN 0x02 //!< Overrun in Driver or CAN Controller
//!< special case: OVERRUN combined with TIMER
//!< means the 32 bit timer has overrun
#define XL_CAN_MSG_FLAG_NERR 0x04 //!< Line Error on Lowspeed
#define XL_CAN_MSG_FLAG_WAKEUP 0x08 //!< High Voltage Message on Single Wire CAN
#define XL_CAN_MSG_FLAG_REMOTE_FRAME 0x10
#define XL_CAN_MSG_FLAG_RESERVED_1 0x20
#define XL_CAN_MSG_FLAG_TX_COMPLETED 0x40 //!< Message Transmitted
#define XL_CAN_MSG_FLAG_TX_REQUEST 0x80 //!< Transmit Message stored into Controller
// LIN flags
#define XL_LIN_MSGFLAG_TX XL_CAN_MSG_FLAG_TX_COMPLETED //!< LIN TX flag
#define XL_LIN_MSGFLAG_CRCERROR 0x81 //!< Wrong LIN CRC
//------------------------------------------------------------------------------
// structure for XL_RECEIVE_MSG, XL_TRANSMIT_MSG
struct s_xl_can_msg { /* 32 Bytes */
unsigned long id;
unsigned short flags;
unsigned short dlc;
XLuint64 res1;
unsigned char data [MAX_MSG_LEN];
XLuint64 res2;
};
//------------------------------------------------------------------------------
// structure for XL_TRANSMIT_DAIO_DATA
// flags masks
#define XL_DAIO_DATA_GET 0x8000
#define XL_DAIO_DATA_VALUE_DIGITAL 0x0001
#define XL_DAIO_DATA_VALUE_ANALOG 0x0002
#define XL_DAIO_DATA_PWM 0x0010
// optional function flags
#define XL_DAIO_MODE_PULSE 0x0020 // generates pulse in values of PWM
struct s_xl_daio_data { /* 32 Bytes */
unsigned short flags; // 2
unsigned int timestamp_correction; // 4
unsigned char mask_digital; // 1
unsigned char value_digital; // 1
unsigned char mask_analog; // 1
unsigned char reserved0; // 1
unsigned short value_analog[4]; // 8
unsigned int pwm_frequency; // 4
unsigned short pwm_value; // 2
unsigned int reserved1; // 4
unsigned int reserved2; // 4
};
//------------------------------------------------------------------------------
// structure for XL_CHIP_STATE
#define XL_CHIPSTAT_BUSOFF 0x01
#define XL_CHIPSTAT_ERROR_PASSIVE 0x02
#define XL_CHIPSTAT_ERROR_WARNING 0x04
#define XL_CHIPSTAT_ERROR_ACTIVE 0x08
#define XL_CAN_STATE_FLAG_SJA_MODE 0x00000001
struct s_xl_chip_state {
unsigned char busStatus;
unsigned char txErrorCounter;
unsigned char rxErrorCounter;
unsigned char chipState; // raw Status Register Value
unsigned int flags;
};
//------------------------------------------------------------------------------
// structure for XL_SYNC_PULSE
#define XL_SYNC_PULSE_EXTERNAL 0x00
#define XL_SYNC_PULSE_OUR 0x01
#define XL_SYNC_PULSE_OUR_SHARED 0x02
struct s_xl_sync_pulse {
unsigned char pulseCode; //!< generated by us
XLuint64 time; //!< 1ns resolution
};
//------------------------------------------------------------------------------
// structure and defines for XL_TRANSCEIVER
#define XL_TRANSCEIVER_EVENT_NONE 0
#define XL_TRANSCEIVER_EVENT_INSERTED 1 //!< cable was inserted
#define XL_TRANSCEIVER_EVENT_REMOVED 2 //!< cable was removed
#define XL_TRANSCEIVER_EVENT_STATE_CHANGE 3 //!< transceiver state changed
struct s_xl_transceiver {
unsigned char event_reason; //!< reason for what was event sent
unsigned char is_present; //!< allways valid transceiver presence flag
};
//------------------------------------------------------------------------------
// defines for SET_OUTPUT_MODE
#define XL_OUTPUT_MODE_SILENT 0 //!< switch CAN trx into default silent mode
#define XL_OUTPUT_MODE_NORMAL 1 //!< switch CAN trx into normal mode
#define XL_OUTPUT_MODE_TX_OFF 2 //!< switch CAN trx into silent mode with tx pin off
#define XL_OUTPUT_MODE_SJA_1000_SILENT 3 //!< switch CAN trx into SJA1000 silent mode
//------------------------------------------------------------------------------
// Transceiver modes
#define XL_TRANSCEIVER_EVENT_ERROR 1
#define XL_TRANSCEIVER_EVENT_CHANGED 2
#define XL_TRANSCEIVER_RESNET_NA 0
#define XL_TRANSCEIVER_RESNET_MASTER 1
#define XL_TRANSCEIVER_RESNET_MASTER_STBY 2
#define XL_TRANSCEIVER_RESNET_SLAVE 3
//------------------------------------------------------------------------------
// definitions for the events and commands used by the driver
enum e_XLevent_type {
XL_NO_COMMAND = 0,
XL_RECEIVE_MSG = 1,
XL_CHIP_STATE = 4,
XL_TRANSCEIVER = 6,
XL_TIMER = 8,
XL_TRANSMIT_MSG =10,
XL_SYNC_PULSE =11,
XL_APPLICATION_NOTIFICATION =15,
//for LIN we have special events
XL_LIN_MSG =20,
XL_LIN_ERRMSG =21,
XL_LIN_SYNCERR =22,
XL_LIN_NOANS =23,
XL_LIN_WAKEUP =24,
XL_LIN_SLEEP =25,
XL_LIN_CRCINFO =26,
// for D/A IO bus
XL_RECEIVE_DAIO_DATA =32, //!< D/A IO data message
};
////////////////////////////////////////////////////////////////////////////////
// LIN lib
//------------------------------------------------------------------------------
// LIN event structures
struct s_xl_lin_msg {
unsigned char id;
unsigned char dlc;
unsigned short flags;
unsigned char data[8];
unsigned char crc;
};
struct s_xl_lin_sleep {
unsigned char flag;
};
struct s_xl_lin_no_ans {
unsigned char id;
};
struct s_xl_lin_wake_up {
unsigned char flag;
};
struct s_xl_lin_crc_info {
unsigned char id;
unsigned char flags;
};
//------------------------------------------------------------------------------
// LIN messages structure
union s_xl_lin_msg_api {
struct s_xl_lin_msg linMsg;
struct s_xl_lin_no_ans linNoAns;
struct s_xl_lin_wake_up linWakeUp;
struct s_xl_lin_sleep linSleep;
struct s_xl_lin_crc_info linCRCinfo;
};
//------------------------------------------------------------------------------
// BASIC bus message structure
union s_xl_tag_data {
struct s_xl_can_msg msg;
struct s_xl_chip_state chipState;
union s_xl_lin_msg_api linMsgApi;
struct s_xl_sync_pulse syncPulse;
struct s_xl_daio_data daioData;
struct s_xl_transceiver transceiver;
};
typedef unsigned char XLeventTag;
//------------------------------------------------------------------------------
// XL_EVENT structures
// event type definition
struct s_xl_event {
XLeventTag tag; // 1
unsigned char chanIndex; // 1
unsigned short transId; // 2
unsigned short portHandle; // 2 internal use only !!!!
unsigned short reserved; // 2
XLuint64 timeStamp; // 8
union s_xl_tag_data tagData; // 32 Bytes
};
// --------
// 48 Bytes
typedef struct s_xl_event XLevent;
// message name to aquire a unique message id from windows
#define DriverNotifyMessageName "VectorCanDriverChangeNotifyMessage"
// defines for the supported hardware
#define XL_HWTYPE_NONE 0
#define XL_HWTYPE_VIRTUAL 1
#define XL_HWTYPE_CANCARDX 2
#define XL_HWTYPE_CANCARDY 12
#define XL_HWTYPE_CANCARDXL 15
#define XL_HWTYPE_CANCASEXL 21
#define XL_HWTYPE_CANCASEXL_LOG_OBSOLETE 23
#define XL_HWTYPE_CANBOARDXL 25
#define XL_HWTYPE_CANBOARDXL_PXI 27
#define XL_HWTYPE_VN2600 29
#define XL_HWTYPE_VN2610 XL_HWTYPE_VN2600
#define XL_HWTYPE_VN3300 37
#define XL_HWTYPE_VN3600 39
#define XL_HWTYPE_VN7600 41
#define XL_HWTYPE_CANCARDXLE 43
#define XL_MAX_HWTYPE 43
//------------------------------------------------------------------------------
// build a channels mask from the channels index
#define XL_CHANNEL_MASK(x) (1I64<<(x))
#define XL_MAX_APPNAME 32
//------------------------------------------------------------------------------
// driver status
typedef short XLstatus;
#define XL_SUCCESS 0
#define XL_PENDING 1
#define XL_ERR_QUEUE_IS_EMPTY 10
#define XL_ERR_QUEUE_IS_FULL 11
#define XL_ERR_TX_NOT_POSSIBLE 12
#define XL_ERR_NO_LICENSE 14
#define XL_ERR_WRONG_PARAMETER 101
#define XL_ERR_TWICE_REGISTER 110
#define XL_ERR_INVALID_CHAN_INDEX 111
#define XL_ERR_INVALID_ACCESS 112
#define XL_ERR_PORT_IS_OFFLINE 113
#define XL_ERR_CHAN_IS_ONLINE 116
#define XL_ERR_NOT_IMPLEMENTED 117
#define XL_ERR_INVALID_PORT 118
#define XL_ERR_HW_NOT_READY 120
#define XL_ERR_CMD_TIMEOUT 121
#define XL_ERR_HW_NOT_PRESENT 129
#define XL_ERR_NOTIFY_ALREADY_ACTIVE 131
#define XL_ERR_NO_RESOURCES 152
#define XL_ERR_WRONG_CHIP_TYPE 153
#define XL_ERR_WRONG_COMMAND 154
#define XL_ERR_INVALID_HANDLE 155
#define XL_ERR_CANNOT_OPEN_DRIVER 201
#define XL_ERR_WRONG_BUS_TYPE 202
#define XL_ERROR 255
//defines for xlGetDriverConfig structures
#define XL_MAX_LENGTH 31
#define XL_CONFIG_MAX_CHANNELS 64
//activate - channel flags
#define XL_ACTIVATE_NONE 0
#define XL_ACTIVATE_RESET_CLOCK 8
//activate - bus types
#define XL_BUS_TYPE_NONE 0x00000000
#define XL_BUS_TYPE_CAN 0x00000001
#define XL_BUS_TYPE_LIN 0x00000002
#define XL_BUS_TYPE_FLEXRAY 0x00000004
#define XL_BUS_TYPE_MOST 0x00000010
#define XL_BUS_TYPE_DAIO 0x00000040 // IO cab
#define XL_BUS_TYPE_HWSYNC 0x00000080
#define XL_BUS_TYPE_J1708 0x00000100
// device capabilities
#define XL_CHCAP_LOG_CAPABLE 0x00002000
#define XL_BUS_COMPATIBLE_CAN XL_BUS_TYPE_CAN
#define XL_BUS_COMPATIBLE_LIN XL_BUS_TYPE_LIN
#define XL_BUS_COMPATIBLE_FLEXRAY XL_BUS_TYPE_FLEXRAY
#define XL_BUS_COMPATIBLE_MOST XL_BUS_TYPE_MOST
#define XL_BUS_COMPATIBLE_DAIO XL_BUS_TYPE_DAIO //io cab
#define XL_BUS_COMPATIBLE_HWSYNC XL_BUS_TYPE_HWSYNC //external sync line
#define XL_BUS_COMPATIBLE_J1708 XL_BUS_TYPE_J1708
// the following bus types can be used with the current cab / piggy
#define XL_BUS_ACTIVE_CAP_CAN XL_BUS_COMPATIBLE_CAN<<16
#define XL_BUS_ACTIVE_CAP_LIN XL_BUS_COMPATIBLE_LIN<<16
#define XL_BUS_ACTIVE_CAP_FLEXRAY XL_BUS_COMPATIBLE_FLEXRAY<<16
#define XL_BUS_ACTIVE_CAP_MOST XL_BUS_COMPATIBLE_MOST<<16
#define XL_BUS_ACTIVE_CAP_DAIO XL_BUS_COMPATIBLE_DAIO<<16
#define XL_BUS_ACTIVE_CAP_HWSYNC XL_BUS_COMPATIBLE_HWSYNC<<16
#define XL_BUS_ACTIVE_CAP_J1708 XL_BUS_COMPATIBLE_J1708<<16
//------------------------------------------------------------------------------
// acceptance filter
#define XL_CAN_STD 01 //!< flag for standard ID's
#define XL_CAN_EXT 02 //!< flag for extended ID's
//------------------------------------------------------------------------------
// bit timing
typedef struct {
unsigned long bitRate;
unsigned char sjw;
unsigned char tseg1;
unsigned char tseg2;
unsigned char sam; // 1 or 3
} XLchipParams;
typedef struct {
unsigned int busType;
union {
struct {
unsigned int bitRate;
unsigned char sjw;
unsigned char tseg1;
unsigned char tseg2;
unsigned char sam; // 1 or 3
unsigned char outputMode;
}can;
unsigned char raw[32];
}data;
} XLbusParams;
// porthandle
#define XL_INVALID_PORTHANDLE (-1)
typedef long XLportHandle, *pXLportHandle;
// structures for xlGetDriverConfig
typedef struct s_xl_channel_config {
char name [XL_MAX_LENGTH + 1];
unsigned char hwType; //!< HWTYPE_xxxx (see above)
unsigned char hwIndex; //!< Index of the hardware (same type) (0,1,...)
unsigned char hwChannel; //!< Index of the channel (same hardware) (0,1,...)
unsigned short transceiverType; //!< TRANSCEIVER_TYPE_xxxx (see above)
unsigned int transceiverState; //!< transceiver state
unsigned char channelIndex; //!< Global channel index (0,1,...)
XLuint64 channelMask; //!< Global channel mask (=1<<channelIndex)
unsigned int channelCapabilities;
unsigned int channelBusCapabilities; //!< what buses are supported and which are possible to be activated
// Channel
unsigned char isOnBus; //!< The channel is on bus
unsigned int connectedBusType; //!< currently selected bus
XLbusParams busParams;
unsigned int driverVersion;
unsigned int interfaceVersion; //!< version of interface with driver
unsigned int raw_data[10];
unsigned int serialNumber;
unsigned int articleNumber;
char transceiverName [XL_MAX_LENGTH + 1]; //!< name for CANcab or another transceiver
unsigned int specialCabFlags; //!< XL_SPECIAL_CAB_LIN_RECESSIVE_STRESS, XL_SPECIAL_CAB_LIN_DOMINANT_TIMEOUT flags
unsigned int dominantTimeout; //!< Dominant Timeout in us.
unsigned char dominantRecessiveDelay; //!< Delay in us.
unsigned char recessiveDominantDelay; //!< Delay in us.
unsigned char connectionInfo; //!< XL_CONNECTION_INFO_XXX
unsigned char reserved01;
unsigned short minimalSupplyVoltage; //!< Minimal Supply Voltage of the Cab/Piggy in 1/100 V
unsigned short maximalSupplyVoltage; //!< Maximal Supply Voltage of the Cab/Piggy in 1/100 V
unsigned int reserved[6];
} XL_CHANNEL_CONFIG;
typedef XL_CHANNEL_CONFIG XLchannelConfig;
typedef XL_CHANNEL_CONFIG *pXLchannelConfig;
typedef struct s_xl_driver_config {
unsigned int dllVersion;
unsigned int channelCount; // total number of channels
unsigned int reserved[10];
XLchannelConfig channel[XL_CONFIG_MAX_CHANNELS]; // [channelCount]
} XL_DRIVER_CONFIG;
typedef XL_DRIVER_CONFIG XLdriverConfig;
typedef XL_DRIVER_CONFIG *pXLdriverConfig;
///////////////////////////////////////////////////////
// DAIO params definition
// analog and digital port configuration
#define XL_DAIO_DIGITAL_ENABLED 0x00000001 // digital port is enabled
#define XL_DAIO_DIGITAL_INPUT 0x00000002 // digital port is input, otherwise it is an output
#define XL_DAIO_DIGITAL_TRIGGER 0x00000004 // digital port is trigger
#define XL_DAIO_ANALOG_ENABLED 0x00000001 // analog port is enabled
#define XL_DAIO_ANALOG_INPUT 0x00000002 // analog port is input, otherwise it is an output
#define XL_DAIO_ANALOG_TRIGGER 0x00000004 // analog port is trigger
#define XL_DAIO_ANALOG_RANGE_32V 0x00000008 // analog port is in range 0..32,768V, otherwise 0..8,192V
// XL_DAIO trigger mode
#define XL_DAIO_TRIGGER_MODE_NONE 0x00000000 // no trigger configured
#define XL_DAIO_TRIGGER_MODE_DIGITAL 0x00000001 // trigger on preconfigured digital lines
#define XL_DAIO_TRIGGER_MODE_ANALOG_ASCENDING 0x00000002 // trigger on input 3 ascending
#define XL_DAIO_TRIGGER_MODE_ANALOG_DESCENDING 0x00000004 // trigger on input 3 ascending
#define XL_DAIO_TRIGGER_MODE_ANALOG (XL_DAIO_TRIGGER_MODE_ANALOG_ASCENDING | \
XL_DAIO_TRIGGER_MODE_ANALOG_DESCENDING) // trigger on input 3
// XL_DAIO trigger level
#define XL_DAIO_TRIGGER_LEVEL_NONE 0 // no trigger level is defined
// periodic measurement setting
#define XL_DAIO_POLLING_NONE 0 // periodic measurement is disabled
// capture mode settings
#define XL_DAIO_CAPTURE_NONE 0x00000000 // no capture is defined
#define XL_DAIO_CAPTURE_PWM 0x00000001 // capture is on PWM signal
#define XL_DAIO_CAPTURE_DIGITAL_INPUT_4 0x00000002 // capture is on digital input 4
#define XL_DAIO_CAPTURE_FREQ_10000KHZ 0x00000100 // setting for capture counter: using 10 MHz
#define XL_DAIO_CAPTURE_FREQ_5000KHZ 0x00000200 // using 5 Mhz
#define XL_DAIO_CAPTURE_FREQ_2500KHZ 0x00000400 // using 2,5 Mhz
#define XL_DAIO_CAPTURE_FREQ_1250KHZ 0x00000800 // using 1,25 MHz
// structure for the acceptance filter
struct _XLacc_filt {
unsigned char isSet;
unsigned long code;
unsigned long mask; // relevant = 1
};
typedef struct _XLacc_filt XLaccFilt;
// structure for the acceptance filter of one CAN chip
struct _XLacceptance {
XLaccFilt std;
XLaccFilt xtd;
};
typedef struct _XLacceptance XLacceptance;
// defines for xlSetGlobalTimeSync
#define XL_SET_TIMESYNC_NO_CHANGE (unsigned long) 0
#define XL_SET_TIMESYNC_ON (unsigned long) 1
#define XL_SET_TIMESYNC_OFF (unsigned long) 2
#include <poppack.h>
////////////////////////////////////////////////////////////////////////////////
// MOST lib
//------------------------------------------------------------------------------
// special MOST defines
#define XLuserHandle unsigned short
// size of allocation table
#define MOST_ALLOC_TABLE_SIZE 64 // size of channel alloctaion table + 4Bytes (MPR, MDR; ?, ?)
// max. size of rx fifo for rx event in bytes
#define RX_FIFO_MOST_QUEUE_SIZE_MAX 131072
// defines for the event tags
#define XL_MOST_START 0x0101
#define XL_MOST_STOP 0x0102
#define XL_MOST_EVENTSOURCES 0x0103
#define XL_MOST_ALLBYPASS 0x0107
#define XL_MOST_TIMINGMODE 0x0108
#define XL_MOST_FREQUENCY 0x0109
#define XL_MOST_REGISTER_BYTES 0x010a
#define XL_MOST_REGISTER_BITS 0x010b
#define XL_MOST_SPECIAL_REGISTER 0x010c
#define XL_MOST_CTRL_RX_SPY 0x010d
#define XL_MOST_CTRL_RX_OS8104 0x010e
#define XL_MOST_CTRL_TX 0x010f
#define XL_MOST_ASYNC_MSG 0x0110
#define XL_MOST_ASYNC_TX 0x0111
#define XL_MOST_SYNC_ALLOCTABLE 0x0112
#define XL_MOST_SYNC_VOLUME_STATUS 0x0116
#define XL_MOST_RXLIGHT 0x0117
#define XL_MOST_TXLIGHT 0x0118
#define XL_MOST_LOCKSTATUS 0x0119
#define XL_MOST_ERROR 0x011a
#define XL_MOST_CTRL_RXBUFFER 0x011c
#define XL_MOST_CTRL_SYNC_AUDIO 0x011f
#define XL_MOST_SYNC_MUTE_STATUS 0x0120
#define XL_MOST_GENLIGHTERROR 0x0121
#define XL_MOST_GENLOCKERROR 0x0122
#define XL_MOST_TXLIGHT_POWER 0x0123
#define XL_MOST_CTRL_BUSLOAD 0x0126
#define XL_MOST_ASYNC_BUSLOAD 0x0127
#define XL_MOST_CTRL_SYNC_AUDIO_EX 0x012a
#define XL_MOST_TIMINGMODE_SPDIF 0x012b
#define XL_MOST_STREAM_STATE 0x012c
#define XL_MOST_STREAM_BUFFER 0x012d
// defines for xlMostSwitchEventSources
#define XL_MOST_SOURCE_ASYNC_SPY 0x8000
#define XL_MOST_SOURCE_ASYNC_RX 0x1000
#define XL_MOST_SOURCE_ASYNC_TX 0x0800
#define XL_MOST_SOURCE_CTRL_OS8104A 0x0400
#define XL_MOST_SOURCE_CTRL_SPY 0x0100
#define XL_MOST_SOURCE_SYNCLINE 0x0010
#define XL_MOST_SOURCE_ASYNC_RX_FIFO_OVER 0x0008
// data for XL_MOST_ERROR:
#define XL_MOST_OS8104_TX_LOCK_ERROR 0x00000001
#define XL_MOST_OS8104_SPDIF_LOCK_ERROR 0x00000002
#define XL_MOST_OS8104_ASYNC_BUFFER_FULL 0x00000003
#define XL_MOST_OS8104_ASYNC_CRC_ERROR 0x00000004
#define XL_MOST_ASYNC_TX_UNDERRUN 0x00000005
#define XL_MOST_CTRL_TX_UNDERRUN 0x00000006
#define XL_MOST_MCU_TS_CMD_QUEUE_UNDERRUN 0x00000007
#define XL_MOST_MCU_TS_CMD_QUEUE_OVERRUN 0x00000008
#define XL_MOST_CMD_TX_UNDERRUN 0x00000009
#define XL_MOST_SYNCPULSE_ERROR 0x0000000A
#define XL_MOST_OS8104_CODING_ERROR 0x0000000B
#define XL_MOST_ERROR_UNKNOWN_COMMAND 0x0000000C
#define XL_MOST_ASYNC_RX_OVERFLOW_ERROR 0x0000000D
#define XL_MOST_FPGA_TS_FIFO_OVERFLOW 0x0000000E
#define XL_MOST_SPY_OVERFLOW_ERROR 0x0000000F
#define XL_MOST_CTRL_TYPE_QUEUE_OVERFLOW 0x00000010
#define XL_MOST_ASYNC_TYPE_QUEUE_OVERFLOW 0x00000011
#define XL_MOST_CTRL_UNKNOWN_TYPE 0x00000012
#define XL_MOST_CTRL_QUEUE_UNDERRUN 0x00000013
#define XL_MOST_ASYNC_UNKNOWN_TYPE 0x00000014
#define XL_MOST_ASYNC_QUEUE_UNDERRUN 0x00000015
// data for demanded timstamps
#define XL_MOST_DEMANDED_START 0x00000001
#define XL_MOST_RX_DATA_SIZE 1028
#define XL_MOST_TS_DATA_SIZE 12
#define XL_MOST_RX_ELEMENT_HEADER_SIZE 32
#define XL_MOST_CTRL_RX_SPY_SIZE 36
#define XL_MOST_CTRL_RX_OS8104_SIZE 28
#define XL_MOST_SPECIAL_REGISTER_CHANGE_SIZE 20
#define XL_MOST_ERROR_EV_SIZE_4 4 // dwords
#define XL_MOST_ERROR_EV_SIZE 16 // bytes
// defines for the audio devices
#define XL_MOST_DEVICE_CASE_LINE_IN 0
#define XL_MOST_DEVICE_CASE_LINE_OUT 1
#define XL_MOST_DEVICE_SPDIF_IN 7
#define XL_MOST_DEVICE_SPDIF_OUT 8
#define XL_MOST_DEVICE_SPDIF_IN_OUT_SYNC 11
// defines for xlMostCtrlSyncAudioEx, mode
#define XL_MOST_SPDIF_LOCK_OFF 0
#define XL_MOST_SPDIF_LOCK_ON 1
// defines for the XL_MOST_SYNC_MUTES_STATUS event
#define XL_MOST_NO_MUTE 0
#define XL_MOST_MUTE 1
// defines for the event sources in XLmostEvent
#define XL_MOST_VN2600 0x01
#define XL_MOST_OS8104A 0x02
#define XL_MOST_OS8104B 0x04
#define XL_MOST_SPY 0x08
// defines for xlMostSetAllBypass and XL_MOST_ALLBYPASS
#define XL_MOST_MODE_DEACTIVATE 0
#define XL_MOST_MODE_ACTIVATE 1
#define XL_MOST_MODE_FORCE_DEACTIVATE 2
#define XL_MOST_RX_BUFFER_CLEAR_ONCE 2
// defines for xlMostSetTimingMode and the XL_MOST_TIMINGMODE(_SPDIF)_EV event.
#define XL_MOST_TIMING_SLAVE 0
#define XL_MOST_TIMING_MASTER 1
#define XL_MOST_TIMING_SLAVE_SPDIF_MASTER 2
#define XL_MOST_TIMING_SLAVE_SPDIF_SLAVE 3
#define XL_MOST_TIMING_MASTER_SPDIF_MASTER 4
#define XL_MOST_TIMING_MASTER_SPDIF_SLAVE 5
#define XL_MOST_TIMING_MASTER_FROM_SPDIF_SLAVE 6
// defines for xlMostSetFrequency and the XL_MOST_FREQUENCY_EV event.
#define XL_MOST_FREQUENCY_44100 0
#define XL_MOST_FREQUENCY_48000 1
#define XL_MOST_FREQUENCY_ERROR 2
// defines for xlMostSetTxLight
#define XL_MOST_LIGHT_OFF 0
#define XL_MOST_LIGHT_FORCE_ON 1 // unmodulated on
#define XL_MOST_LIGHT_MODULATED 2 // modulated light
//defines for xlMostSetTxLightPower and the XL_MOST_TXLIGHT_POWER_EV event.
#define XL_MOST_LIGHT_FULL 3
#define XL_MOST_LIGHT_3DB 4
// defines for the XL_MOST_LOCKSTATUS event
#define XL_MOST_UNLOCK 5
#define XL_MOST_LOCK 6
#define XL_MOST_STATE_UNKNOWN 9
// defines for the XL_MOST_CTRL_RX_OS8104 event (tx event)
#define XL_MOST_TX_WHILE_UNLOCKED 0x80000000
#define XL_MOST_TX_TIMEOUT 0x40000000
#define XL_MOST_DIRECTION_RX 0
#define XL_MOST_DIRECTION_TX 1
#define XL_MOST_NO_QUEUE_OVERFLOW 0x0000
#define XL_MOST_QUEUE_OVERFLOW 0x8000
#define XL_MOST_COMMAND_FAILED 0x4000
#define XL_MOST_INTERNAL_OVERFLOW 0x2000
#define XL_MOST_MEASUREMENT_NOT_ACTIVE 0x1000
#define XL_MOST_QUEUE_OVERFLOW_ASYNC 0x0800
#define XL_MOST_QUEUE_OVERFLOW_CTRL 0x0400
#define XL_MOST_NOT_SUPPORTED 0x0200
#define XL_MOST_NA_CHANGED 0x0001 // node address changed
#define XL_MOST_GA_CHANGED 0x0002 // group address changed
#define XL_MOST_APA_CHANGED 0x0004 // alternative packet address changed
#define XL_MOST_NPR_CHANGED 0x0008 // node position register changed
#define XL_MOST_MPR_CHANGED 0x0010 // max position register changed
#define XL_MOST_NDR_CHANGED 0x0020 // node delay register changed
#define XL_MOST_MDR_CHANGED 0x0040 // max delay register changed
#define XL_MOST_SBC_CHANGED 0x0080 //
#define XL_MOST_XTIM_CHANGED 0x0100 //
#define XL_MOST_XRTY_CHANGED 0x0200 //
// defines for the MOST register (xlMostWriteRegister)
#define XL_MOST_bGA 0x89 // Group Address
#define XL_MOST_bNAH 0x8A // Node Address High
#define XL_MOST_bNAL 0x8B // Node Address Low
#define XL_MOST_bSDC2 0x8C // Source Data Control 2
#define XL_MOST_bSDC3 0x8D // Source Data Control 3
#define XL_MOST_bCM2 0x8E // Clock Manager 2
#define XL_MOST_bNDR 0x8F // Node Delay
#define XL_MOST_bMPR 0x90 // Maximum Position
#define XL_MOST_bMDR 0x91 // Maximum Delay
#define XL_MOST_bCM4 0x93 // Clock Manager 4
#define XL_MOST_bSBC 0x96 // Synchronous Bandwidth Control
#define XL_MOST_bXSR2 0x97 // Transceiver Status 2
#define XL_MOST_bRTYP 0xA0 // Receive Message Type
#define XL_MOST_bRSAH 0xA1 // Source Address High
#define XL_MOST_bRSAL 0xA2 // Source Address Low
#define XL_MOST_bRCD0 0xA3 // Receive Control Data 0 --> bRCD16 = bRCD0+16
#define XL_MOST_bXTIM 0xBE // Transmit Retry Time
#define XL_MOST_bXRTY 0xBF // Transmit Retries
#define XL_MOST_bXPRI 0xC0 // Transmit Priority
#define XL_MOST_bXTYP 0xC1 // Transmit Message Type
#define XL_MOST_bXTAH 0xC2 // Target Address High
#define XL_MOST_bXTAL 0xC3 // Target Address Low
#define XL_MOST_bXCD0 0xC4 // Transmit Control Data 0 --> bXCD16 = bXCD0+16
#define XL_MOST_bXTS 0xD5 // Transmit Transfer Status
#define XL_MOST_bPCTC 0xE2 // Packet Control
#define XL_MOST_bPCTS 0xE3 // Packet Status
// defines
#define XL_MOST_SPY_RX_STATUS_NO_LIGHT 0x01
#define XL_MOST_SPY_RX_STATUS_NO_LOCK 0x02
#define XL_MOST_SPY_RX_STATUS_BIPHASE_ERROR 0x04
#define XL_MOST_SPY_RX_STATUS_MESSAGE_LENGTH_ERROR 0x08
#define XL_MOST_SPY_RX_STATUS_PARITY_ERROR 0x10
#define XL_MOST_SPY_RX_STATUS_FRAME_LENGTH_ERROR 0x20
#define XL_MOST_SPY_RX_STATUS_PREAMBLE_TYPE_ERROR 0x40
#define XL_MOST_SPY_RX_STATUS_CRC_ERROR 0x80
// defines for status of async frames
#define XL_MOST_ASYNC_NO_ERROR 0x00
#define XL_MOST_ASYNC_SBC_ERROR 0x0C
#define XL_MOST_ASYNC_NEXT_STARTS_TO_EARLY 0x0D
#define XL_MOST_ASYNC_TO_LONG 0x0E
#define XL_MOST_ASYNC_UNLOCK 0x0F // unlock occured within receiption of packet
// defines for XL_MOST_SYNC_PULSE_EV member trigger_source
#define SYNC_PULSE_EXTERNAL 0x00
#define SYNC_PULSE_OUR 0x01
// ctrlType value within the XL_CTRL_SPY event
#define XL_MOST_CTRL_TYPE_NORMAL 0x00
#define XL_MOST_CTRL_TYPE_REMOTE_READ 0x01
#define XL_MOST_CTRL_TYPE_REMOTE_WRITE 0x02
#define XL_MOST_CTRL_TYPE_RESOURCE_ALLOCATE 0x03
#define XL_MOST_CTRL_TYPE_RESOURCE_DEALLOCATE 0x04
#define XL_MOST_CTRL_TYPE_GET_SOURCE 0x05
// counterType for the xlMost****GenerateBusload function
#define XL_MOST_BUSLOAD_COUNTER_TYPE_NONE 0x00
#define XL_MOST_BUSLOAD_COUNTER_TYPE_1_BYTE 0x01
#define XL_MOST_BUSLOAD_COUNTER_TYPE_2_BYTE 0x02
#define XL_MOST_BUSLOAD_COUNTER_TYPE_3_BYTE 0x03
#define XL_MOST_BUSLOAD_COUNTER_TYPE_4_BYTE 0x04
// selection bits for xlMostGetDeviceStates / CMD_GET_DEVICE_STATE->selection_mask
#define XL_MOST_STATESEL_LIGHTLOCK 0x0001
#define XL_MOST_STATESEL_REGISTERBUNCH1 0x0002
#define XL_MOST_STATESEL_BYPASSTIMING 0x0004
#define XL_MOST_STATESEL_REGISTERBUNCH2 0x0008
#define XL_MOST_STATESEL_REGISTERBUNCH3 0x0010
#define XL_MOST_STATESEL_VOLUMEMUTE 0x0020
#define XL_MOST_STATESEL_EVENTSOURCE 0x0040
#define XL_MOST_STATESEL_RXBUFFERMODE 0x0080
#define XL_MOST_STATESEL_ALLOCTABLE 0x0100
#define XL_MOST_STATESEL_SUPERVISOR_LOCKSTATUS 0x0200
#define XL_MOST_STATESEL_SUPERVISOR_MESSAGE 0x0400
// defines for sync data streaming
#define XL_MOST_STREAM_RX_DATA 0 // RX streaming: MOST -> PC
#define XL_MOST_STREAM_TX_DATA 1 // TX streaming: PC -> MOST
#define XL_MOST_STREAM_ADD_FRAME_HEADER 1 // only for RX: additionally the orig. TS + status information are reported
// stream states
#define XL_MOST_STREAM_STATE_CLOSED 0x01
#define XL_MOST_STREAM_STATE_OPENED 0x02
#define XL_MOST_STREAM_STATE_STARTED 0x03
#define XL_MOST_STREAM_STATE_STOPPED 0x04
#define XL_MOST_STREAM_STATE_START_PENDING 0x05 // waiting for result from hw
#define XL_MOST_STREAM_STATE_STOP_PENDING 0x06 // waiting for result from hw
#define XL_MOST_STREAM_STATE_UNKNOWN 0xFF
// stream modes
#define XL_MOST_STREAM_ACTIVATE 0
#define XL_MOST_STREAM_DEACTIVATE 1
#define XL_MOST_STREAM_INVALID_HANDLE 0
// latency values
#define XL_MOST_STREAM_LATENCY_VERY_LOW 0
#define XL_MOST_STREAM_LATENCY_LOW 1
#define XL_MOST_STREAM_LATENCY_MEDIUM 2
#define XL_MOST_STREAM_LATENCY_HIGH 3
#define XL_MOST_STREAM_LATENCY_VERY_HIGH 4