common_interface.h

1 /*
2  * ====================== WARNING ======================
3  *
4  * THE CONTENTS OF THIS FILE HAVE BEEN AUTO-GENERATED.
5  * DO NOT MODIFY IN ANY WAY.
6  *
7  * ====================== WARNING ======================
8  */
9 
10 /**
11  * Common definitions potentially used across multiple .api files
12  */
13 
14 #ifndef COMMON_H_INCLUDE_GUARD
15 #define COMMON_H_INCLUDE_GUARD
16 
17 
18 #include "legato.h"
19 
20 // Interface specific includes
21 #include "defn_interface.h"
22 
23 
24 
25 //--------------------------------------------------------------------------------------------------
26 /**
27  * Definition example
28  */
29 //--------------------------------------------------------------------------------------------------
30 #define COMMON_FOUR 4
31 
32 
33 //--------------------------------------------------------------------------------------------------
34 /**
35  * Example of using previously DEFINEd symbol within an imported file.
36  */
37 //--------------------------------------------------------------------------------------------------
38 #define COMMON_TEN 10
39 
40 
41 //--------------------------------------------------------------------------------------------------
42 /**
43  * Reference example
44  */
45 //--------------------------------------------------------------------------------------------------
46 typedef struct common_OpaqueReference* common_OpaqueReferenceRef_t;
47 
48 
49 //--------------------------------------------------------------------------------------------------
50 /**
51  * ENUM example
52  */
53 //--------------------------------------------------------------------------------------------------
54 typedef enum
55 {
56  COMMON_ZERO,
57  ///< first enum
58 
59  COMMON_ONE,
60  ///< second enum
61 
62  COMMON_TWO,
63  ///< third enum
64 
65  COMMON_THREE
66  ///< fourth enum
67 }
68 common_EnumExample_t;
69 
70 
71 //--------------------------------------------------------------------------------------------------
72 /**
73  * BITMASK example
74  */
75 //--------------------------------------------------------------------------------------------------
76 typedef enum
77 {
78  COMMON_BIT0 = 0x1,
79  ///< first
80 
81  COMMON_BIT1 = 0x2,
82  ///< second
83 
84  COMMON_BIT2 = 0x4
85  ///< third
86 }
87 common_BitMaskExample_t;
88 
89 
90 #endif // COMMON_H_INCLUDE_GUARD
91