FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kGpioBank.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_GPIO_BANK_H
9 #define K_FIRESYNC_GPIO_BANK_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
13 kBeginHeader()
14 
15 
21 //typedef kObject kGpioBank; --forward-declared in kFsDef.x.h
22 
23 
30 kFsFx(kSize) kGpioBank_Index(kGpioBank bank);
31 
39 kFsFx(kGpioBankType) kGpioBank_Type(kGpioBank bank);
40 
48 kFsFx(kSize) kGpioBank_PinCount(kGpioBank bank);
49 
60 kFsFx(kStatus) kGpioBank_SetPinType(kGpioBank bank, kSize pinIndex, kGpioPin pinType);
61 
71 kFsFx(kGpioPin) kGpioBank_PinType(kGpioBank bank, kSize pinIndex);
72 
82 kFsFx(kStatus) kGpioBank_EnableEvents(kGpioBank bank, kSize pinIndex, kBool enabled);
83 
92 kFsFx(kBool) kGpioBank_EventsEnabled(kGpioBank bank, kSize pinIndex);
93 
103 kFsFx(kStatus) kGpioBank_SetState(kGpioBank bank, kSize pinIndex, kBool enabled);
104 
119 kFsFx(kStatus) kGpioBank_SetState64u(kGpioBank bank, k64u mask, k64u state);
120 
130 kFsFx(kStatus) kGpioBank_GetState(kGpioBank bank, kSize pinIndex, kBool* enabled);
131 
142 kFsFx(kStatus) kGpioBank_GetState64u(kGpioBank bank, k64u* state);
143 
144 kEndHeader()
145 
146 #include <kFireSync/Client/kGpioBank.x.h>
147 
148 #endif
kGpioBank::kGpioBank_PinType
kGpioPin kGpioBank_PinType(kGpioBank bank, kSize pinIndex)
Gets the GPIO pin type specified by an index.
kGpioBank::kGpioBank_EventsEnabled
kBool kGpioBank_EventsEnabled(kGpioBank bank, kSize pinIndex)
Reports whether input events is enabled for this GPIO pin.
kGpioBank::kGpioBank_GetState64u
kStatus kGpioBank_GetState64u(kGpioBank bank, k64u *state)
Gets the output state for all GPIO pins in this bank.
kGpioBank::kGpioBank_PinCount
kSize kGpioBank_PinCount(kGpioBank bank)
Gets the actual number of GPIO pins in this bank.
kGpioPin
Represents GPIO pin types.
kGpioBank::kGpioBank_SetState
kStatus kGpioBank_SetState(kGpioBank bank, kSize pinIndex, kBool enabled)
Sets the output state for one GPIO pin in this bank, specified by an index.
kGpioBank::kGpioBank_GetState
kStatus kGpioBank_GetState(kGpioBank bank, kSize pinIndex, kBool *enabled)
Gets the output state for one GPIO pin in this bank, specified by an index.
kGpioBank::kGpioBank_SetState64u
kStatus kGpioBank_SetState64u(kGpioBank bank, k64u mask, k64u state)
Sets the output state for one or more GPIO pins in this bank.
kNodeDef.h
Essential declarations related to FireSync nodes.
kGpioBank
Represents a local node's GPIO bank.
kGpioBank::kGpioBank_EnableEvents
kStatus kGpioBank_EnableEvents(kGpioBank bank, kSize pinIndex, kBool enabled)
Enables or disables input events for this GPIO pin.
kGpioBank::kGpioBank_Index
kSize kGpioBank_Index(kGpioBank bank)
Gets the index of the GPIO bank module.
kGpioBank::kGpioBank_Type
kGpioBankType kGpioBank_Type(kGpioBank bank)
Gets the type of the GPIO bank module.
kGpioBankType
Represents GPIO bank types.
kGpioBank::kGpioBank_SetPinType
kStatus kGpioBank_SetPinType(kGpioBank bank, kSize pinIndex, kGpioPin pinType)
Sets the GPIO pin type, specified by an index.