CCAux  2.12.0.0
CCAux API reference
CCAuxTypes.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * CCAuxTypes.h
6 *
7 * Version 2.12.0.0, 2017-12-21
8 *
9 * (c) CrossControl 2010-2017
10 *
11 
12  * File description: Common types
13  *
14  ************************************************/
15 
16 #ifndef CCAUXTYPES_H_
17 #define CCAUXTYPES_H_
18 
19 // CCAux API uses default integer types based on stdint.h with addition of float, double and character types.
20 // stdint.h is not available on all platforms/systems (e.g. Visual Studio for Windows).
21 // Define CCAUX_USE_STDINT_H to use the stdint.h from your build system instead of these defaults.
22 // Define CCAUX_USER_TYPEDEFS to use your own header file entirely.
23 #ifdef CCAUX_USE_STDINT_H
24 #include <stdint.h>
25 typedef float float32_t;
26 typedef double float64_t;
27 typedef char char_t;
28 #else
29 // You can also include your own typedef file.
30 #ifdef CCAUX_USER_TYPEDEFS
31 // This file is not part of CCAux, you must provide it yourself.
32 #include <ccaux_ext_typedefs.h>
33 #else
34 
35 // CCAux default typdefs
36 typedef float float32_t;
37 typedef double float64_t;
38 typedef char char_t;
39 
40 #ifdef _MSC_VER
41 // Microsoft Visual Studio
42 #if (_MSC_VER < 1300)
43 // Visual Studio 6 and Embedded Visual C++ 4
44 typedef signed char int8_t;
45 typedef signed short int16_t;
46 typedef signed int int32_t;
47 typedef unsigned char uint8_t;
48 typedef unsigned short uint16_t;
49 typedef unsigned int uint32_t;
50 #else
51 // VS2003+
52 typedef signed __int8 int8_t;
53 typedef signed __int16 int16_t;
54 typedef signed __int32 int32_t;
55 typedef unsigned __int8 uint8_t;
56 typedef unsigned __int16 uint16_t;
57 typedef unsigned __int32 uint32_t;
58 #endif
59 typedef signed __int64 int64_t;
60 typedef unsigned __int64 uint64_t;
61 
62 #else // _MSC_VER
63 // Other compilers (e.g gcc)
64 typedef signed char int8_t;
65 typedef signed short int16_t;
66 typedef signed int int32_t;
67 typedef unsigned char uint8_t;
68 typedef unsigned short uint16_t;
69 typedef unsigned int uint32_t;
70 #ifdef X64
71 typedef long int int64_t;
72 #else
73 //typedef long long int int64_t;
74 #endif
75 #ifdef X64
76 typedef unsigned long int uint64_t;
77 #else
78 //typedef unsigned long long int uint64_t;
79 #endif
80 
81 #endif // _MSC_VER
82 #endif // CCAUX_USER_TYPEDEFS
83 #endif // CCAUX_USE_STDINT
84 
85 
86 #ifdef __cplusplus
87 namespace CrossControl
88 {
89 #endif
90 
91 #ifndef __cplusplus
92 #define bool int
93 #endif
94 
98 typedef enum
99 {
124 }VoltageEnum;
125 
127 typedef enum
128 {
132 
134 typedef enum
135 {
141 
145 typedef enum
146 {
147  Disabled = 0,
148  Enabled = 1
149 } CCStatus;
150 
154 typedef enum
155 {
174  ERR_EEPROM = 18,
191 } eErr;
192 
196 typedef enum
197 {
202 
206 typedef enum
207 {
208  Analog_Channel_1 = 0, /* Analog video channel 1 */
209  Analog_Channel_2 = 1, /* Analog video channel 2 */
210  Analog_Channel_3 = 2, /* Analog video channel 3 */
211  Analog_Channel_4 = 3 /* Analog video channel 4 */
212 } VideoChannel;
213 
214 /* Struct used for received video */
216 {
220 };
221 
222 /* Struct used for I2c-accesses to decoder */
224 {
227 };
228 
229 /* Version info struct */
231 {
236 };
237 
238 /* Video standard */
239 /* The video decoder auto detect the video standard */
240 typedef enum
241 {
244  STD_M_PAL = 2,
245  STD_PAL = 3,
246  STD_NTSC = 4,
248 } videoStandard;
249 
250 /* Available video rotation */
251 typedef enum
252 {
253  RotNone = 0,
257 } VideoRotation;
258 
259 typedef struct version_info VersionType;
260 
261 /* Buzzer setup struct */
262 typedef struct
263 {
266 } BuzzerSetup;
267 
268 /* Led timing setup struct */
269 typedef struct
270 {
275 } LedTimingType;
276 
277 /* For FPGA leds */
278 typedef struct
279 {
286 
287 /* Led color struct */
288 typedef struct
289 {
294 
298 typedef enum
299 {
303 } CanFrameType;
304 
319 typedef enum
320 {
332  All_Events = 15,
334 } TriggerConf;
335 
339 typedef enum
340 {
341  NoAction = 0,
344 } PowerAction;
345 
352 typedef enum
353 {
362 
366 typedef enum
367 {
368  OCD_OK = 0,
369  OCD_OC = 1,
371 } OCDStatus;
372 
376 typedef struct
377 {
385 } TimerType;
386 
390 typedef enum
391 {
392  TEMP_CPU = 0,
393  TEMP_BOX = 1,
394  TEMP_ENV = 2,
401 
406 {
415 };
416 
420 typedef struct
421 {
422  enum UpgradeAction currentAction;
425 } UpgradeStatus;
426 
430 typedef enum
431 {
432  RED = 0,
439 } CCAuxColor;
440 
444 typedef enum
445 {
450 } RS4XXPort;
451 
455 typedef enum
456 {
493 } CfgInModeEnum;
494 
498 #define CFGIN_VOLTAGE_3V3 CFGIN_VOLTAGE_2V5
499 #define CFGIN_VOLTAGE_5VPD CFGIN_VOLTAGE_5V
500 
504 typedef enum
505 {
515 
519 typedef enum
520 {
526 } BootModeEnum;
527 
531 typedef enum
532 {
536 
537 
538 typedef enum
539 {
547 } PowerOutput;
548 
552 typedef enum
553 {
561 } SystemMode;
562 
563 
564 #define MAX_BEEP_VOLUME 2000
565 
566 #ifdef __cplusplus
567 }
568 #endif
569 
570 #endif /*CCAUXTYPES_H_*/
571 
Definition: CCAuxTypes.h:113
Definition: CCAuxTypes.h:110
uint8_t nrOfPulses
Definition: CCAuxTypes.h:284
Definition: CCAuxTypes.h:188
Definition: CCAuxTypes.h:510
Definition: CCAuxTypes.h:269
uint32_t RunTime60_70
Definition: CCAuxTypes.h:382
uint8_t blue
Definition: CCAuxTypes.h:292
Definition: CCAuxTypes.h:467
Definition: CCAuxTypes.h:393
eErr
Definition: CCAuxTypes.h:154
Definition: CCAuxTypes.h:470
Definition: CCAuxTypes.h:544
Definition: CCAuxTypes.h:506
Definition: CCAuxTypes.h:466
Definition: CCAuxTypes.h:322
Definition: CCAuxTypes.h:485
Definition: CCAuxTypes.h:161
Definition: CCAuxTypes.h:157
SystemMode
Definition: CCAuxTypes.h:552
Definition: CCAuxTypes.h:137
Definition: CCAuxTypes.h:301
Definition: CCAuxTypes.h:136
Definition: CCAuxTypes.h:354
Definition: CCAuxTypes.h:215
Definition: CCAuxTypes.h:164
Definition: CCAuxTypes.h:475
Definition: CCAuxTypes.h:394
Definition: CCAuxTypes.h:198
Definition: CCAuxTypes.h:331
Definition: CCAuxTypes.h:560
double float64_t
Definition: CCAuxTypes.h:26
Definition: CCAuxTypes.h:156
Definition: CCAuxTypes.h:370
uint8_t onTime
Definition: CCAuxTypes.h:281
Definition: CCAuxTypes.h:461
Definition: CCAuxTypes.h:121
Definition: CCAuxTypes.h:446
Definition: CCAuxTypes.h:492
Definition: CCAuxTypes.h:173
Definition: CCAuxTypes.h:521
uint32_t TotHeatTime
Definition: CCAuxTypes.h:380
uint16_t frequency
Definition: CCAuxTypes.h:264
CCStatus
Definition: CCAuxTypes.h:145
Definition: CCAuxTypes.h:341
float float32_t
Definition: CCAuxTypes.h:25
Definition: CCAuxTypes.h:120
uint8_t offTime
Definition: CCAuxTypes.h:272
Definition: CCAuxTypes.h:109
Definition: CCAuxTypes.h:557
Definition: CCAuxTypes.h:230
Definition: CCAuxTypes.h:480
uint8_t percent
Definition: CCAuxTypes.h:423
PowerOutput
Definition: CCAuxTypes.h:538
ButtonPowerTransitionStatus
Definition: CCAuxTypes.h:352
Definition: CCAuxTypes.h:512
Definition: CCAuxTypes.h:449
uint8_t register_value
Definition: CCAuxTypes.h:226
Definition: CCAuxTypes.h:355
LightSensorSamplingMode
Definition: CCAuxTypes.h:134
Definition: CCAuxTypes.h:255
Definition: CCAuxTypes.h:177
Definition: CCAuxTypes.h:166
Definition: CCAuxTypes.h:325
Definition: CCAuxTypes.h:476
unsigned __int64 uint64_t
Definition: CCAuxTypes.h:60
Definition: CCAuxTypes.h:167
Definition: CCAuxTypes.h:326
Definition: CCAuxTypes.h:117
Definition: CCAuxTypes.h:437
JidaSensorType
Definition: CCAuxTypes.h:390
Definition: CCAuxTypes.h:436
Definition: CCAuxTypes.h:101
Definition: CCAuxTypes.h:412
Definition: CCAuxTypes.h:434
UpgradeAction
Definition: CCAuxTypes.h:405
Definition: CCAuxTypes.h:545
Definition: CCAuxTypes.h:369
uint32_t RunTime70_80
Definition: CCAuxTypes.h:383
Definition: CCAuxTypes.h:420
Definition: CCAuxTypes.h:172
Definition: CCAuxTypes.h:457
Definition: CCAuxTypes.h:533
Definition: CCAuxTypes.h:543
Definition: CCAuxTypes.h:395
Definition: CCAuxTypes.h:396
Definition: About.h:30
Definition: CCAuxTypes.h:554
Definition: CCAuxTypes.h:555
Definition: CCAuxTypes.h:106
Definition: CCAuxTypes.h:123
Definition: CCAuxTypes.h:104
uint32_t TotSuspTime
Definition: CCAuxTypes.h:379
Definition: CCAuxTypes.h:162
LightSensorOperationRange
Definition: CCAuxTypes.h:127
Definition: CCAuxTypes.h:508
Definition: CCAuxTypes.h:522
Definition: CCAuxTypes.h:168
unsigned short uint16_t
Definition: CCAuxTypes.h:48
Definition: CCAuxTypes.h:209
CCAuxColor
Definition: CCAuxTypes.h:430
Definition: CCAuxTypes.h:524
Definition: CCAuxTypes.h:358
Definition: CCAuxTypes.h:409
Definition: CCAuxTypes.h:478
Definition: CCAuxTypes.h:413
Definition: CCAuxTypes.h:178
unsigned int uint32_t
Definition: CCAuxTypes.h:49
DeInterlaceMode
Definition: CCAuxTypes.h:196
TriggerConf
Definition: CCAuxTypes.h:319
Definition: CCAuxTypes.h:111
Definition: CCAuxTypes.h:414
Definition: CCAuxTypes.h:108
uint8_t onTime
Definition: CCAuxTypes.h:271
PowerAction
Definition: CCAuxTypes.h:339
Definition: CCAuxTypes.h:330
Definition: CCAuxTypes.h:489
Definition: CCAuxTypes.h:180
Definition: CCAuxTypes.h:115
Definition: CCAuxTypes.h:321
Definition: CCAuxTypes.h:525
Definition: CCAuxTypes.h:199
RS4XXPort
Definition: CCAuxTypes.h:444
Definition: CCAuxTypes.h:300
Definition: CCAuxTypes.h:392
Definition: CCAuxTypes.h:360
unsigned char uint8_t
Definition: CCAuxTypes.h:47
Definition: CCAuxTypes.h:407
Definition: CCAuxTypes.h:129
Definition: CCAuxTypes.h:534
Definition: CCAuxTypes.h:112
signed int int32_t
Definition: CCAuxTypes.h:46
Definition: CCAuxTypes.h:107
Definition: CCAuxTypes.h:328
Definition: CCAuxTypes.h:200
Definition: CCAuxTypes.h:359
Definition: CCAuxTypes.h:469
Definition: CCAuxTypes.h:208
Definition: CCAuxTypes.h:482
Definition: CCAuxTypes.h:324
Definition: CCAuxTypes.h:487
Definition: CCAuxTypes.h:484
Definition: CCAuxTypes.h:262
signed __int64 int64_t
Definition: CCAuxTypes.h:59
Definition: CCAuxTypes.h:408
uint8_t decoder_register
Definition: CCAuxTypes.h:225
Definition: CCAuxTypes.h:471
Definition: CCAuxTypes.h:376
Definition: CCAuxTypes.h:245
VideoChannel
Definition: CCAuxTypes.h:206
Definition: CCAuxTypes.h:148
Definition: CCAuxTypes.h:432
Definition: CCAuxTypes.h:176
Definition: CCAuxTypes.h:435
uint8_t major
Definition: CCAuxTypes.h:232
Definition: CCAuxTypes.h:119
Definition: CCAuxTypes.h:256
Definition: CCAuxTypes.h:483
Definition: CCAuxTypes.h:368
Definition: CCAuxTypes.h:465
uint8_t build
Definition: CCAuxTypes.h:235
uint8_t offTime
Definition: CCAuxTypes.h:282
VoltageEnum
Definition: CCAuxTypes.h:98
Definition: CCAuxTypes.h:105
uint8_t green
Definition: CCAuxTypes.h:291
Definition: CCAuxTypes.h:473
Definition: CCAuxTypes.h:174
Definition: CCAuxTypes.h:541
Definition: CCAuxTypes.h:288
uint8_t nrOfPulses
Definition: CCAuxTypes.h:274
Definition: CCAuxTypes.h:147
Definition: CCAuxTypes.h:327
Definition: CCAuxTypes.h:175
Definition: CCAuxTypes.h:223
Definition: CCAuxTypes.h:244
Definition: CCAuxTypes.h:118
Definition: CCAuxTypes.h:474
Definition: CCAuxTypes.h:433
Definition: CCAuxTypes.h:398
signed short int16_t
Definition: CCAuxTypes.h:45
Definition: CCAuxTypes.h:460
Definition: CCAuxTypes.h:246
Definition: CCAuxTypes.h:477
Definition: CCAuxTypes.h:169
CanFrameType
Definition: CCAuxTypes.h:298
uint32_t Above80RunTime
Definition: CCAuxTypes.h:384
Definition: CCAuxTypes.h:247
Definition: CCAuxTypes.h:481
Definition: CCAuxTypes.h:159
uint32_t RunTime40_60
Definition: CCAuxTypes.h:381
Definition: CCAuxTypes.h:546
Definition: CCAuxTypes.h:189
Definition: CCAuxTypes.h:479
Definition: CCAuxTypes.h:100
Definition: CCAuxTypes.h:114
Definition: CCAuxTypes.h:458
Definition: CCAuxTypes.h:190
uint8_t red
Definition: CCAuxTypes.h:290
Definition: CCAuxTypes.h:410
Definition: CCAuxTypes.h:343
signed char int8_t
Definition: CCAuxTypes.h:44
Definition: CCAuxTypes.h:448
Definition: CCAuxTypes.h:211
Definition: CCAuxTypes.h:472
Definition: CCAuxTypes.h:399
uint16_t volume
Definition: CCAuxTypes.h:265
Definition: CCAuxTypes.h:523
Definition: CCAuxTypes.h:210
Definition: CCAuxTypes.h:138
Definition: CCAuxTypes.h:542
Definition: CCAuxTypes.h:278
Definition: CCAuxTypes.h:253
Definition: CCAuxTypes.h:438
Definition: CCAuxTypes.h:163
uint8_t idleTime
Definition: CCAuxTypes.h:273
Definition: CCAuxTypes.h:491
CfgInModeEnum
Definition: CCAuxTypes.h:455
OCDStatus
Definition: CCAuxTypes.h:366
Definition: CCAuxTypes.h:333
uint16_t received_width
Definition: CCAuxTypes.h:217
Definition: CCAuxTypes.h:486
uint8_t idleTime
Definition: CCAuxTypes.h:283
videoStandard
Definition: CCAuxTypes.h:240
uint8_t minor
Definition: CCAuxTypes.h:233
Definition: CCAuxTypes.h:558
Definition: CCAuxTypes.h:468
uint32_t TotRunTime
Definition: CCAuxTypes.h:378
Definition: CCAuxTypes.h:459
Definition: CCAuxTypes.h:357
BootModeEnum
Definition: CCAuxTypes.h:519
Definition: CCAuxTypes.h:411
Definition: CCAuxTypes.h:242
Definition: CCAuxTypes.h:302
Definition: CCAuxTypes.h:254
Definition: CCAuxTypes.h:171
Definition: CCAuxTypes.h:463
Definition: CCAuxTypes.h:342
Definition: CCAuxTypes.h:507
Definition: CCAuxTypes.h:329
Definition: CCAuxTypes.h:488
Definition: CCAuxTypes.h:462
uint16_t received_height
Definition: CCAuxTypes.h:218
Definition: CCAuxTypes.h:160
Definition: CCAuxTypes.h:356
Definition: CCAuxTypes.h:447
Definition: CCAuxTypes.h:102
Definition: CCAuxTypes.h:170
ButtonConfigEnum
Definition: CCAuxTypes.h:504
Definition: CCAuxTypes.h:540
VideoRotation
Definition: CCAuxTypes.h:251
uint8_t ledNbr
Definition: CCAuxTypes.h:280
eErr errorCode
Definition: CCAuxTypes.h:424
Definition: CCAuxTypes.h:332
Definition: CCAuxTypes.h:397
Definition: CCAuxTypes.h:490
char char_t
Definition: CCAuxTypes.h:27
Definition: CCAuxTypes.h:165
Definition: CCAuxTypes.h:130
uint8_t received_framerate
Definition: CCAuxTypes.h:219
uint8_t release
Definition: CCAuxTypes.h:234
Definition: CCAuxTypes.h:103
Definition: CCAuxTypes.h:116
Definition: CCAuxTypes.h:122
Definition: CCAuxTypes.h:464
Definition: CCAuxTypes.h:243
ConfigOnOffTriggerMode
Definition: CCAuxTypes.h:531
Definition: CCAuxTypes.h:158