FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kHxSerialOut.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_HX_SERIAL_OUT_H
9 #define K_FIRESYNC_HX_SERIAL_OUT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 #include <kFireSync/Hardware/kHxSerialOut.x.h>
13 
21 //typedef kObject kHxSerialOut; --forward-declared in kFsDef.x.h
22 
23 kInlineFx(kHxNode) kHxSerialOut_Node(kHxSerialOut serial)
24 {
25  kObj(kHxSerialOut, serial);
26 
27  return obj->node;
28 }
29 
30 kInlineFx(kSize) kHxSerialOut_Index(kHxSerialOut serial)
31 {
32  kObj(kHxSerialOut, serial);
33 
34  return obj->index;
35 }
36 
37 kInlineFx(kStatus) kHxSerialOut_Enable(kHxSerialOut serial, kBool enabled)
38 {
39  kObj(kHxSerialOut, serial);
40 
41  obj->enabled = enabled;
42 
43  return kOK;
44 }
45 
46 kInlineFx(kBool) kHxSerialOut_IsEnabled(kHxSerialOut serial)
47 {
48  kObj(kHxSerialOut, serial);
49 
50  return obj->enabled;
51 }
52 
53 kInlineFx(kStatus) kHxSerialOut_SetControl(kHxSerialOut serial, kSerialOutControl type)
54 {
55  kObj(kHxSerialOut, serial);
56 
57  obj->controlType = type;
58 
59  return kOK;
60 }
61 
62 kInlineFx(kSerialOutControl) kHxSerialOut_Control(kHxSerialOut serial)
63 {
64  kObj(kHxSerialOut, serial);
65 
66  return obj->controlType;
67 }
68 
69 kInlineFx(kStatus) kHxSerialOut_SetControlId(kHxSerialOut serial, kSize id)
70 {
71  kObj(kHxSerialOut, serial);
72 
73  obj->controlId = id;
74 
75  return kOK;
76 }
77 
78 kInlineFx(kSize) kHxSerialOut_ControlId(kHxSerialOut serial)
79 {
80  kObj(kHxSerialOut, serial);
81 
82  return obj->controlId;
83 }
84 
85 kInlineFx(kStatus) kHxSerialOut_SetMode(kHxSerialOut serial, kSerialOutMode mode)
86 {
87  kObj(kHxSerialOut, serial);
88 
89  obj->mode = mode;
90 
91  return kOK;
92 }
93 
94 kInlineFx(kSerialOutMode) kHxSerialOut_Mode(kHxSerialOut serial)
95 {
96  kObj(kHxSerialOut, serial);
97 
98  return obj->mode;
99 }
100 
101 kInlineFx(kStatus) kHxSerialOut_SetBitRate(kHxSerialOut serial, k32u bitRate)
102 {
103  kObj(kHxSerialOut, serial);
104 
105  obj->bitRate = bitRate;
106 
107  return kOK;
108 }
109 
110 kInlineFx(k32u) kHxSerialOut_BitRate(kHxSerialOut serial)
111 {
112  kObj(kHxSerialOut, serial);
113 
114  return obj->bitRate;
115 }
116 
117 kInlineFx(kStatus) kHxSerialOut_Write(kHxSerialOut serial, const void* buffer, kSize size)
118 {
119  return xkHxSerialOut_VTable(serial)->VWrite(serial, buffer, size);
120 }
121 
122 kInlineFx(kStatus) kHxSerialOut_Stats(kHxSerialOut serial, kSerialOutStats* stats)
123 {
124  return xkHxSerialOut_VTable(serial)->VStats(serial, stats);
125 }
126 
127 kInlineFx(kStatus) kHxSerialOut_Clear(kHxSerialOut serial)
128 {
129  return xkHxSerialOut_VTable(serial)->VClear(serial);
130 }
131 
132 #endif
Represents serial output control modes.
Represents serial output data modes.
#define kInlineFx(TYPE)
Essential declarations related to FireSync nodes.
Abstract base class for hardware node classes.
Represents serial output run-time statistics.
Definition: kNodeDef.h:1423
#define kObj(TypeName_T, T_object)
#define kOK