Difference between revisions of "Unit GPIO"
| Line 284: | Line 284: | ||
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
<pre style="border: 0; padding-bottom:0px;">function GPIODeviceFind(GPIOId:LongWord):PGPIODevice;</pre> | <pre style="border: 0; padding-bottom:0px;">function GPIODeviceFind(GPIOId:LongWord):PGPIODevice;</pre> | ||
| + | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
| + | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
| + | {| class="wikitable" style="font-size: 14px; background: white;" | ||
| + | |- | ||
| + | ! '''Note''' | ||
| + | | To be documented | ||
| + | |- | ||
| + | |} | ||
| + | </div></div> | ||
| + | <br /> | ||
| + | <div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial; padding-top: 0px; padding-bottom: 15px;"> | ||
| + | <pre style="border: 0; padding-bottom:0px;">function GPIODeviceFindByName(const Name:String):PGPIODevice; inline;</pre> | ||
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | <div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div> | ||
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | <div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;"> | ||
Revision as of 06:41, 28 July 2016
Return to Unit Reference
Description
GPIO devices represent the external or internal pins available on most system on chip (SoC) devices to provide control and interfacing capabilities for both hardware and software.
This unit maintains pin numbering exactly as per the SoC documentation but abstracts other features such as alternate function selects to avoid exposing chip specific values via the API.
Not all GPIO devices support the same feature set so the GPIODeviceProperties function returns a structure which describes the number of pins as well as minimum and maximum pin numbers along with a set of flags that indicate what functionality is supported by the device.
Multiple GPIO devices can be accomodated, each one is registered with this unit when the driver for the device is loaded and initialized. This unit includes functions for enumerating the devices that are available and each function takes a GPIODevice parameter to allow specifying the exact device to control.
Simplified versions of many of the functions in this unit are provided in the Platform unit to allow control of the default GPIO device and in cases where there is only one device registered these functions will provide most of the capability required.
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
procedure GPIOInit;
| Note | To be documented |
|---|
GPIO functions
function GPIODeviceStart(GPIO:PGPIODevice):LongWord;
| Note | To be documented |
|---|
function GPIODeviceStop(GPIO:PGPIODevice):LongWord;
| Note | To be documented |
|---|
function GPIODeviceRead(GPIO:PGPIODevice; Reg:LongWord):LongWord;
| Note | To be documented |
|---|
procedure GPIODeviceWrite(GPIO:PGPIODevice; Reg,Value:LongWord);
| Note | To be documented |
|---|
function GPIODeviceInputGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODeviceInputWait(GPIO:PGPIODevice; Pin,Trigger,Timeout:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODeviceInputEvent(GPIO:PGPIODevice; Pin,Trigger,Flags,Timeout:LongWord; Callback:TGPIOCallback; Data:Pointer):LongWord;
| Note | To be documented |
|---|
function GPIODeviceInputCancel(GPIO:PGPIODevice; Pin:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODeviceOutputSet(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODevicePullGet(GPIO:PGPIODevice;Pin:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODevicePullSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODeviceFunctionGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODeviceFunctionSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;
| Note | To be documented |
|---|
function GPIODeviceProperties(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord;
| Note | To be documented |
|---|
function GPIODeviceCreate:PGPIODevice;
| Return | Pointer to new GPIO entry or nil if GPIO could not be created |
|---|
function GPIODeviceCreateEx(Size:LongWord):PGPIODevice;
| Size | Size in bytes to allocate for new GPIO (Including the GPIO entry) |
|---|---|
| Return | Pointer to new GPIO entry or nil if GPIO could not be created |
function GPIODeviceDestroy(GPIO:PGPIODevice):LongWord;
| Note | To be documented |
|---|
function GPIODeviceRegister(GPIO:PGPIODevice):LongWord;
| Note | To be documented |
|---|
function GPIODeviceDeregister(GPIO:PGPIODevice):LongWord;
| Note | To be documented |
|---|
function GPIODeviceFind(GPIOId:LongWord):PGPIODevice;
| Note | To be documented |
|---|
function GPIODeviceFindByName(const Name:String):PGPIODevice; inline;
| Note | To be documented |
|---|
Return to Unit Reference
