Difference between revisions of "Unit GPIO"

From Ultibo.org
Jump to: navigation, search
 
(15 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
−
'''Ultibo GPIO interface unit'''
+
'''Ultibo GPIO Interface unit'''
  
 
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.
 
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.
Line 39: Line 39:
 
| <code>GPIO_TYPE_NONE = 0;</code>
 
| <code>GPIO_TYPE_NONE = 0;</code>
 
| style="width: 50%;"|&nbsp;
 
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>GPIO_TYPE_MAX = 0;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''GPIO device type name''
 +
|-
 +
|colspan="2"|<code>GPIO_TYPE_NAMES:array[GPIO_TYPE_NONE..GPIO_TYPE_MAX] of String = ('GPIO_TYPE_NONE');</code>
 
|-
 
|-
 
|}
 
|}
Line 52: Line 59:
 
|-
 
|-
 
| <code>GPIO_STATE_ENABLED = 1;</code>
 
| <code>GPIO_STATE_ENABLED = 1;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>GPIO_STATE_MAX = 1;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 120: Line 132:
 
| <code>GPIO_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| <code>GPIO_LOG_LEVEL_INFO = LOG_LEVEL_INFO;</code>
 
| GPIO informational messages, such as a device being attached or detached
 
| GPIO informational messages, such as a device being attached or detached
 +
|-
 +
| <code>GPIO_LOG_LEVEL_WARN = LOG_LEVEL_WARN;</code>
 +
| GPIO warning messages
 
|-
 
|-
 
| <code>GPIO_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
 
| <code>GPIO_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR;</code>
Line 368: Line 383:
 
|}
 
|}
  
−
'''GPIO device properties'''
+
'''GPIO device get properties'''
 
   
 
   
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 
|-
 
|-
−
| <code>TGPIODeviceProperties = function(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord;</code>
+
| <code>TGPIODeviceGetProperties = function(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord;</code>
 
| style="width: 40%;"|
 
| style="width: 40%;"|
 
|-
 
|-
Line 440: Line 455:
 
| A Device specific DeviceFunctionSelect method implementing the standard GPIO device interface (Or nil if the operation is not supported)
 
| A Device specific DeviceFunctionSelect method implementing the standard GPIO device interface (Or nil if the operation is not supported)
 
|-
 
|-
−
| <code>DeviceProperties:TGPIODeviceProperties;</code>
+
| <code>DeviceGetProperties:TGPIODeviceGetProperties;</code>
−
| A Device specific DeviceProperties method implementing the standard GPIO device interface (Or nil if the default method is suitable)
+
| A Device specific DeviceGetProperties method implementing the standard GPIO device interface (Or nil if the default method is suitable)
 
|-
 
|-
 
|colspan="2"|''Driver Properties''
 
|colspan="2"|''Driver Properties''
Line 534: Line 549:
 
=== Function declarations ===
 
=== Function declarations ===
 
----
 
----
−
 
  
  
Line 545: Line 559:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 560: Line 574:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to start
 
| The GPIO device to start
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 575: Line 589:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to stop
 
| The GPIO device to stop
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 590: Line 604:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to read from
 
| The GPIO device to read from
 
|-
 
|-
−
! '''Reg'''
+
! Reg
 
| The memory register to read from
 
| The memory register to read from
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The value of the memory register
 
| The value of the memory register
 
|-
 
|-
Line 608: Line 622:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to write to
 
| The GPIO device to write to
 
|-
 
|-
−
! '''Reg'''
+
! Reg
 
| The memory register to write to
 
| The memory register to write to
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The value to write to the register
 
| The value to write to the register
 
|-
 
|-
Line 626: Line 640:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to get from
 
| The GPIO device to get from
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to get the state for (eg GPIO_PIN_1)
 
| The pin to get the state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current state (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure
 
| The current state (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure
 
|-
 
|-
Line 644: Line 658:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to wait for
 
| The GPIO device to wait for
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to wait for the state to change (eg GPIO_PIN_1)
 
| The pin to wait for the state to change (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Trigger'''
+
! Trigger
 
| The trigger event to wait for (eg GPIO_TRIGGER_HIGH)
 
| The trigger event to wait for (eg GPIO_TRIGGER_HIGH)
 
|-
 
|-
−
! '''Timeout'''
+
! Timeout
 
| Number of milliseconds to wait for the change (INFINITE to wait forever)
 
| Number of milliseconds to wait for the change (INFINITE to wait forever)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The state after the change (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure or timeout
 
| The state after the change (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure or timeout
 
|-
 
|-
Line 668: Line 682:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to schedule the callback for
 
| The GPIO device to schedule the callback for
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to schedule the state change for (eg GPIO_PIN_1)
 
| The pin to schedule the state change for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Trigger'''
+
! Trigger
 
| The trigger event which will cause the function to be called (eg GPIO_TRIGGER_HIGH)
 
| The trigger event which will cause the function to be called (eg GPIO_TRIGGER_HIGH)
 
|-
 
|-
−
! '''Timeout'''
+
! Flags
 +
| The flags to control the event (eg GPIO_EVENT_FLAG_REPEAT)
 +
|-
 +
! Timeout
 
| The number of milliseconds before the scheduled trigger expires (INFINITE to never expire)
 
| The number of milliseconds before the scheduled trigger expires (INFINITE to never expire)
 
|-
 
|-
−
! '''Callback'''
+
! Callback
 
| The function to be called when the trigger occurs
 
| The function to be called when the trigger occurs
 
|-
 
|-
−
! '''Data'''
+
! Data
 
| A pointer to be pass to the function when the trigger occurs (Optional)
 
| A pointer to be pass to the function when the trigger occurs (Optional)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if the trigger was scheduled successfully or another error code on failure
 
| ERROR_SUCCESS if the trigger was scheduled successfully or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| The pin and trigger that caused the event will be passed to the callback function
 
| The pin and trigger that caused the event will be passed to the callback function
 
|-
 
|-
Line 701: Line 718:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to cancel the callback for
 
| The GPIO device to cancel the callback for
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to cancel the state change for (eg GPIO_PIN_1)
 
| The pin to cancel the state change for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if the callback was cancelled successfully or another error code on failure
 
| ERROR_SUCCESS if the callback was cancelled successfully or another error code on failure
 
|-
 
|-
Line 719: Line 736:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to set for
 
| The GPIO device to set for
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to set the state for (eg GPIO_PIN_1)
 
| The pin to set the state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Level'''
+
! Level
 
| The state to set the pin to (eg GPIO_LEVEL_HIGH)
 
| The state to set the pin to (eg GPIO_LEVEL_HIGH)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 +
|-
 +
|}
 +
</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 GPIODeviceLevelGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current level (state) of a pin on the specified GPIO device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! GPIO
 +
| The GPIO device to get from
 +
|-
 +
! Pin
 +
| The pin to get the level for (eg GPIO_PIN_1)
 +
|-
 +
! Return
 +
| The current level (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure
 +
|-
 +
! Note
 +
| This function is a synonym for GPIODeviceInputGet as in many cases the level can be read from a pin regardless of input or output mode. This may help to make code clearer or easier to understand in some cases.
 +
|-
 +
|}
 +
</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 GPIODeviceLevelSet(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Set the level (state) of a pin on the specified GPIO device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! GPIO
 +
| The GPIO device to set for
 +
|-
 +
! Pin
 +
| The pin to set the level for (eg GPIO_PIN_1)
 +
|-
 +
! Level
 +
| The level to set the pin to (eg GPIO_LEVEL_HIGH)
 +
|-
 +
! Return
 +
| ERROR_SUCCESS if completed successfully or another error code on failure
 +
|-
 +
! Note
 +
| This function is a synonym for GPIODeviceOutputSet as in many cases the level can be set for a pin regardless of input or output mode. This may help to make code clearer or easier to understand in some cases.
 
|-
 
|-
 
|}
 
|}
Line 740: Line 802:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to get from
 
| The GPIO device to get from
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to get the pull state for (eg GPIO_PIN_1)
 
| The pin to get the pull state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current pull state of the pin (eg GPIO_PULL_UP) or GPIO_PULL_UNKNOWN on failure
 
| The current pull state of the pin (eg GPIO_PULL_UP) or GPIO_PULL_UNKNOWN on failure
 
|-
 
|-
Line 758: Line 820:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to set for
 
| The GPIO device to set for
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to change the pull state for (eg GPIO_PIN_1)
 
| The pin to change the pull state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Mode'''
+
! Mode
 
| The pull state to set for the pin (eg GPIO_PULL_UP)
 
| The pull state to set for the pin (eg GPIO_PULL_UP)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
|-
 
|-
Line 779: Line 841:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to get from
 
| The GPIO device to get from
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to get the function for (eg GPIO_PIN_1)
 
| The pin to get the function for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure
 
| The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure
 
|-
 
|-
Line 797: Line 859:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to set for
 
| The GPIO device to set for
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to change the function for (eg GPIO_PIN_1)
 
| The pin to change the function for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Mode'''
+
! Mode
 
| The function to set for the pin (eg GPIO_FUNCTION_OUT)
 
| The function to set for the pin (eg GPIO_FUNCTION_OUT)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
|-
 
|-
Line 813: Line 875:
 
<br />
 
<br />
 
<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 GPIODeviceProperties(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function GPIODeviceProperties(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord; inline;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified GPIO device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified GPIO device</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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to get properties from
 
| The GPIO device to get properties from
 
|-
 
|-
−
! '''Properties'''
+
! Properties
 
| Pointer to a TGPIOProperties structure to fill in
 
| Pointer to a TGPIOProperties structure to fill in
 
|-
 
|-
−
! '''Return'''
+
! Return
 +
| ERROR_SUCCESS if completed or another error code on failure
 +
|-
 +
! Note
 +
| Replaced by GPIODeviceGetProperties for consistency
 +
|-
 +
|}
 +
</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 GPIODeviceGetProperties(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the properties for the specified GPIO device</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! GPIO
 +
| The GPIO device to get properties from
 +
|-
 +
! Properties
 +
| Pointer to a TGPIOProperties structure to fill in
 +
|-
 +
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 836: Line 919:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to new GPIO entry or nil if GPIO could not be created
 
| Pointer to new GPIO entry or nil if GPIO could not be created
 
|-
 
|-
Line 848: Line 931:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Size'''
+
! Size
 
| Size in bytes to allocate for new GPIO (Including the GPIO entry)
 
| Size in bytes to allocate for new GPIO (Including the GPIO entry)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to new GPIO entry or nil if GPIO could not be created
 
| Pointer to new GPIO entry or nil if GPIO could not be created
 
|-
 
|-
Line 863: Line 946:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to destroy
 
| The GPIO device to destroy
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 878: Line 961:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to register
 
| The GPIO device to register
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 893: Line 976:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to deregister
 
| The GPIO device to deregister
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 908: Line 991:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIOId'''
+
! GPIOId
 
| The ID number of the GPIO device to find
 
| The ID number of the GPIO device to find
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to GPIO device entry or nil if not found
 
| Pointer to GPIO device entry or nil if not found
 
|-
 
|-
Line 923: Line 1,006:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Name'''
+
! Name
 
| The name of the GPIO to find (eg GPIO0)
 
| The name of the GPIO to find (eg GPIO0)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to GPIO device entry or nil if not found
 
| Pointer to GPIO device entry or nil if not found
 
|-
 
|-
Line 938: Line 1,021:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Description'''
+
! Description
 
| The description of the GPIO to find (eg BCM2836 GPIO)
 
| The description of the GPIO to find (eg BCM2836 GPIO)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| Pointer to GPIO device entry or nil if not found
 
| Pointer to GPIO device entry or nil if not found
 
|-
 
|-
Line 953: Line 1,036:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Callback'''
+
! Callback
 
| The callback function to call for each GPIO in the table
 
| The callback function to call for each GPIO in the table
 
|-
 
|-
−
! '''Data'''
+
! Data
 
| A private data pointer to pass to callback for each GPIO in the table
 
| A private data pointer to pass to callback for each GPIO in the table
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| ERROR_SUCCESS if completed or another error code on failure
 
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
Line 971: Line 1,054:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''GPIO'''
+
! GPIO
 
| The GPIO device to notify changes for (Optional, pass nil for all GPIO devices)
 
| The GPIO device to notify changes for (Optional, pass nil for all GPIO devices)
 
|-
 
|-
−
! '''Callback'''
+
! Callback
 
| The function to call when a notification event occurs
 
| The function to call when a notification event occurs
 
|-
 
|-
−
! '''Data'''
+
! Data
 
| A private data pointer to pass to callback when a notification event occurs
 
| A private data pointer to pass to callback when a notification event occurs
 
|-
 
|-
−
! '''Notification'''
+
! Notification
 
| The events to register for notification of (eg DEVICE_NOTIFICATION_REGISTER)
 
| The events to register for notification of (eg DEVICE_NOTIFICATION_REGISTER)
 
|-
 
|-
−
! '''Flags'''
+
! Flags
 
| The flags to control the notification (eg NOTIFIER_FLAG_WORKER)
 
| The flags to control the notification (eg NOTIFIER_FLAG_WORKER)
 
|-
 
|-
Line 998: Line 1,081:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,010: Line 1,093:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to get the state for (eg GPIO_PIN_1)
 
| The pin to get the state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current state (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure
 
| The current state (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure
 
|-
 
|-
Line 1,025: Line 1,108:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to wait for the state to change (eg GPIO_PIN_1)
 
| The pin to wait for the state to change (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Trigger'''
+
! Trigger
 
| The trigger event to wait for (eg GPIO_TRIGGER_HIGH)
 
| The trigger event to wait for (eg GPIO_TRIGGER_HIGH)
 
|-
 
|-
−
! '''Timeout'''
+
! Timeout
 
| Number of milliseconds to wait for the change (INFINITE to wait forever)
 
| Number of milliseconds to wait for the change (INFINITE to wait forever)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The state after the change (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure or timeout
 
| The state after the change (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure or timeout
 
|-
 
|-
Line 1,046: Line 1,129:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to schedule the state change for (eg GPIO_PIN_1)
 
| The pin to schedule the state change for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Trigger'''
+
! Trigger
 
| The trigger event which will cause the function to be called (eg GPIO_TRIGGER_HIGH)
 
| The trigger event which will cause the function to be called (eg GPIO_TRIGGER_HIGH)
 
|-
 
|-
−
! '''Timeout'''
+
! Timeout
 
| The number of milliseconds before the scheduled trigger expires (INFINITE to never expire)
 
| The number of milliseconds before the scheduled trigger expires (INFINITE to never expire)
 
|-
 
|-
−
! '''Callback'''
+
! Callback
 
| The function to be called when the trigger occurs
 
| The function to be called when the trigger occurs
 
|-
 
|-
−
! '''Data'''
+
! Data
 
| A pointer to be pass to the function when the trigger occurs (Optional)
 
| A pointer to be pass to the function when the trigger occurs (Optional)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if the trigger was scheduled successfully or another error code on failure
 
| ERROR_SUCCESS if the trigger was scheduled successfully or another error code on failure
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| The pin and trigger that caused the event will be passed to the callback function
 
| The pin and trigger that caused the event will be passed to the callback function
 
|-
 
|-
Line 1,076: Line 1,159:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to set the state for (eg GPIO_PIN_1)
 
| The pin to set the state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Level'''
+
! Level
 
| The state to set the pin to (eg GPIO_LEVEL_HIGH)
 
| The state to set the pin to (eg GPIO_LEVEL_HIGH)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
|-
 
|-
Line 1,094: Line 1,177:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to get the pull state for (eg GPIO_PIN_1)
 
| The pin to get the pull state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current pull state of the pin (eg GPIO_PULL_UP) or GPIO_PULL_UNKNOWN on failure
 
| The current pull state of the pin (eg GPIO_PULL_UP) or GPIO_PULL_UNKNOWN on failure
 
|-
 
|-
Line 1,109: Line 1,192:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to change the pull state for (eg GPIO_PIN_1)
 
| The pin to change the pull state for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Mode'''
+
! Mode
 
| The pull state to set for the pin (eg GPIO_PULL_UP)
 
| The pull state to set for the pin (eg GPIO_PULL_UP)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
|-
 
|-
Line 1,127: Line 1,210:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to get the function for (eg GPIO_PIN_1)
 
| The pin to get the function for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure
 
| The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure
 
|-
 
|-
Line 1,142: Line 1,225:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Pin'''
+
! Pin
 
| The pin to change the function for (eg GPIO_PIN_1)
 
| The pin to change the function for (eg GPIO_PIN_1)
 
|-
 
|-
−
! '''Mode'''
+
! Mode
 
| The function to set for the pin (eg GPIO_FUNCTION_OUT)
 
| The function to set for the pin (eg GPIO_FUNCTION_OUT)
 
|-
 
|-
−
! '''Return'''
+
! Return
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
| ERROR_SUCCESS if completed successfully or another error code on failure
 
|-
 
|-
Line 1,158: Line 1,241:
  
 
<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 GPIOGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function GPIOGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current GPIO count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current GPIO count</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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,170: Line 1,253:
 
<br />
 
<br />
 
<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 GPIODeviceGetDefault:PGPIODevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function GPIODeviceGetDefault:PGPIODevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default GPIO device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default GPIO device</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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,187: Line 1,270:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,199: Line 1,282:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 +
| None 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 GPIOTypeToString(GPIOType:LongWord):String;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a GPIO type value to a string</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 +
| None 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 GPIOStateToString(GPIOState:LongWord):String;</pre>
 +
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Convert a GPIO state value to a string</div>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,211: Line 1,318:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Event must be registered by calling GPIODeviceRegisterEvent. Caller must hold the GPIO device lock.
+
| Event must be registered by calling GPIODeviceRegisterEvent
 +
Caller must hold the GPIO device lock
 
|-
 
|-
 
|}
 
|}
Line 1,223: Line 1,331:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Event must be deregistered first by calling GPIODeviceDeregisterEvent. Caller must hold the GPIO device lock.
+
| Event must be deregistered first by calling GPIODeviceDeregisterEvent
 +
Caller must hold the GPIO device lock
 
|-
 
|-
 
|}
 
|}
Line 1,235: Line 1,344:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Event must be created by calling GPIODeviceCreateEvent. Caller must hold the GPIO device lock.
+
| Event must be created by calling GPIODeviceCreateEvent
 +
Caller must hold the GPIO device lock
 
|-
 
|-
 
|}
 
|}
Line 1,247: Line 1,357:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
−
| Event must be destroyed by calling GPIODeviceDestroyEvent. Caller must hold the GPIO device lock.
+
| Event must be destroyed by calling GPIODeviceDestroyEvent
 +
Caller must hold the GPIO device lock
 
|-
 
|-
 
|}
 
|}
Line 1,259: Line 1,370:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 +
| None 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;">procedure GPIOLogInfo(GPIO:PGPIODevice; const AText:String); inline;</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
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,266: Line 1,389:
 
<br />
 
<br />
 
<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;">procedure GPIOLogInfo(GPIO:PGPIODevice; const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure GPIOLogWarn(GPIO:PGPIODevice; const AText:String); 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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,278: Line 1,401:
 
<br />
 
<br />
 
<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;">procedure GPIOLogError(GPIO:PGPIODevice; const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure GPIOLogError(GPIO:PGPIODevice; const AText:String); 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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,290: Line 1,413:
 
<br />
 
<br />
 
<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;">procedure GPIOLogDebug(GPIO:PGPIODevice; const AText:String);</pre>
+
<pre style="border: 0; padding-bottom:0px;">procedure GPIOLogDebug(GPIO:PGPIODevice; const AText:String); 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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,307: Line 1,430:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,319: Line 1,442:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,331: Line 1,454:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,343: Line 1,466:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-
Line 1,355: Line 1,478:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! '''Note'''
+
! Note
 
| None documented
 
| None documented
 
|-
 
|-

Latest revision as of 04:40, 12 September 2023

Return to Unit Reference


Description

Ultibo GPIO Interface unit

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 GPIODeviceGetProperties 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 accommodated, 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


GPIO specific constants GPIO_*
GPIO_NAME_PREFIX = 'GPIO'; Name prefix for GPIO Devices


GPIO device type GPIO_TYPE_*
GPIO_TYPE_NONE = 0;  
GPIO_TYPE_MAX = 0;  
GPIO device type name
GPIO_TYPE_NAMES:array[GPIO_TYPE_NONE..GPIO_TYPE_MAX] of String = ('GPIO_TYPE_NONE');


GPIO device state GPIO_STATE_*
GPIO_STATE_DISABLED = 0;  
GPIO_STATE_ENABLED = 1;  
 
GPIO_STATE_MAX = 1;  


GPIO device flag GPIO_FLAG_*
GPIO_FLAG_NONE = $00000000;  
GPIO_FLAG_PULL_UP = $00000001; Device supports Pull Up on a pin
GPIO_FLAG_PULL_DOWN = $00000002; Device supports Pull Down on a pin
GPIO_FLAG_TRIGGER_LOW = $00000004; Device supports Trigger on Low level on a pin
GPIO_FLAG_TRIGGER_HIGH = $00000008; Device supports Trigger on High level on a pin
GPIO_FLAG_TRIGGER_RISING = $00000010; Device supports Trigger on Rising edge on a pin
GPIO_FLAG_TRIGGER_FALLING = $00000020; Device supports Trigger on Falling edge on a pin
GPIO_FLAG_TRIGGER_EDGE = $00000040; Device supports Trigger on any edge (Rising or Falling) on a pin
GPIO_FLAG_TRIGGER_ASYNC = $00000080; Device supports Trigger on Asynchronous Rising/Falling edge on a pin


GPIO event flag GPIO_EVENT_FLAG_*
GPIO_EVENT_FLAG_NONE = $00000000;  
GPIO_EVENT_FLAG_REPEAT = $00000001; Event will be repeated until cancelled
GPIO_EVENT_FLAG_INTERRUPT = $00000002; Event will be dispatched by interrupt handler (If applicable)

Caution: Events called by the interrupt handler must obey interrupt rules with regard to locks, memory allocation and latency


GPIO logging GPIO_LOG_*
GPIO_LOG_LEVEL_DEBUG = LOG_LEVEL_DEBUG; GPIO debugging messages
GPIO_LOG_LEVEL_INFO = LOG_LEVEL_INFO; GPIO informational messages, such as a device being attached or detached
GPIO_LOG_LEVEL_WARN = LOG_LEVEL_WARN; GPIO warning messages
GPIO_LOG_LEVEL_ERROR = LOG_LEVEL_ERROR; GPIO error messages
GPIO_LOG_LEVEL_NONE = LOG_LEVEL_NONE; No GPIO messages


Type definitions


GPIO properties

PGPIOProperties = ^TGPIOProperties;

TGPIOProperties = record

Flags:LongWord; Device flags (eg GPIO_FLAG_TRIGGER_HIGH)
PinMin:LongWord;  
PinMax:LongWord;  
PinCount:LongWord;  
FunctionMin:LongWord;  
FunctionMax:LongWord;  
FunctionCount:LongWord;  

GPIO event

PGPIOEvent = ^TGPIOEvent;

TGPIOEvent = record

Pin:PGPIOPin; GPIO Pin this event belongs to
Callback:TGPIOCallback; Callback function to call when trigger occurs
Data:Pointer; Pointer to pass to the callback function when trigger occurs
Timeout:LongWord; Timeout in milliseconds for this callback (or INFINITE for no timeout)
Prev:PGPIOEvent; Previous event in the list
Next:PGPIOEvent; Next event in the list

GPIO pin

PGPIOPin = ^TGPIOPin;

TGPIOPin = record

Note: Forward declared for GPIOEvent
GPIO:PGPIODevice; GPIO device this pin belongs to
Pin:LongWord; Pin number of this pin on the device (May be used by drivers for internal numbering)
Flags:LongWord; Current flags for this pin (eg GPIO_EVENT_FLAG_REPEAT)
Trigger:LongWord; Current trigger value for this pin (or GPIO_TRIGGER_NONE if no triggers current)
Count:LongWord; Count of threads and events waiting for the trigger
Event:TEventHandle; Event for threads waiting for the trigger
Events:PGPIOEvent; List of events waiting for the trigger

GPIO enumeration callback

TGPIOEnumerate = function(GPIO:PGPIODevice; Data:Pointer):LongWord;

GPIO notification callback

TGPIONotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

GPIO device start

TGPIODeviceStart = function(GPIO:PGPIODevice):LongWord;

GPIO device stop

TGPIODeviceStop = function(GPIO:PGPIODevice):LongWord;

GPIO device read

TGPIODeviceRead = function(GPIO:PGPIODevice; Reg:LongWord):LongWord;

GPIO device write

TGPIODeviceWrite = procedure(GPIO:PGPIODevice; Reg,Value:LongWord);

GPIO device input get

TGPIODeviceInputGet = function(GPIO:PGPIODevice; Pin:LongWord):LongWord;

GPIO device input wait

TGPIODeviceInputWait = function(GPIO:PGPIODevice; Pin,Trigger,Timeout:LongWord):LongWord;

GPIO device input event

TGPIODeviceInputEvent = function(GPIO:PGPIODevice; Pin,Trigger,Flags,Timeout:LongWord; Callback:TGPIOCallback; Data:Pointer):LongWord;

GPIO device input cancel

TGPIODeviceInputCancel = function(GPIO:PGPIODevice; Pin:LongWord):LongWord;

GPIO device output set

TGPIODeviceOutputSet = function(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;

GPIO device pull get

TGPIODevicePullGet = function(GPIO:PGPIODevice; Pin:LongWord):LongWord;

GPIO device pull select

TGPIODevicePullSelect = function(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;

GPIO device function get

TGPIODeviceFunctionGet = function(GPIO:PGPIODevice; Pin:LongWord):LongWord;

GPIO device function select

TGPIODeviceFunctionSelect = function(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;

GPIO device get properties

TGPIODeviceGetProperties = function(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord;

GPIO device

PGPIODevice = ^TGPIODevice;

TGPIODevice = record

Note: Forward declared for GPIOPin
Device Properties
Device:TDevice; The Device entry for this GPIO
GPIO Properties
GPIOId:LongWord; Unique Id of this GPIO in the GPIO table
GPIOState:LongWord; GPIO state (eg GPIO_STATE_ENABLED)
DeviceStart:TGPIODeviceStart; A Device specific DeviceStart method implementing the standard GPIO device interface (Mandatory)
DeviceStop:TGPIODeviceStop; A Device specific DeviceStop method implementing the standard GPIO device interface (Mandatory)
DeviceRead:TGPIODeviceRead; A Device specific DeviceRead method implementing the standard GPIO device interface (Or nil if the default method is suitable)
DeviceWrite:TGPIODeviceWrite; A Device specific DeviceWrite method implementing the standard GPIO device interface (Or nil if the default method is suitable)
DeviceInputGet:TGPIODeviceInputGet; A Device specific DeviceInputGet method implementing the standard GPIO device interface (Mandatory)
DeviceInputWait:TGPIODeviceInputWait; A Device specific DeviceInputWait method implementing the standard GPIO device interface (Or nil if the operation is not supported)
DeviceInputEvent:TGPIODeviceInputEvent; A Device specific DeviceInputEvent method implementing the standard GPIO device interface (Or nil if the operation is not supported)
DeviceInputCancel:TGPIODeviceInputCancel; A Device specific DeviceInputCancel method implementing the standard GPIO device interface (Or nil if the operation is not supported)
DeviceOutputSet:TGPIODeviceOutputSet; A Device specific DeviceOutputSet method implementing the standard GPIO device interface (Mandatory)
DevicePullGet:TGPIODevicePullGet; A Device specific DevicePullGet method implementing the standard GPIO device interface (Or nil if the operation is not supported)
DevicePullSelect:TGPIODevicePullSelect; A Device specific DevicePullSelect method implementing the standard GPIO device interface (Or nil if the operation is not supported)
DeviceFunctionGet:TGPIODeviceFunctionGet; A Device specific DeviceFunctionGet method implementing the standard GPIO device interface (Or nil if the operation is not supported)
DeviceFunctionSelect:TGPIODeviceFunctionSelect; A Device specific DeviceFunctionSelect method implementing the standard GPIO device interface (Or nil if the operation is not supported)
DeviceGetProperties:TGPIODeviceGetProperties; A Device specific DeviceGetProperties method implementing the standard GPIO device interface (Or nil if the default method is suitable)
Driver Properties
Lock:TMutexHandle; Device lock
Address:Pointer; Device register base address
Pins:array of TGPIOPin; Device pins
Properties:TGPIOProperties; Device properties
Statistics Properties
GetCount:LongWord;  
SetCount:LongWord;  
WaitCount:LongWord;  
EventCount:LongWord;  
Internal Properties
Prev:PGPIODevice; Previous entry in GPIO table
Next:PGPIODevice; Next entry in GPIO table

GPIO pin information

PGPIOInfo = ^TGPIOInfo;

TGPIOInfo = record

Note: Used by other units to pass complete details of a GPIO pin
GPIO:PGPIODevice; Device for this GPIO pin
Pin:LongWord; Pin number (eg GPIO_PIN_59)
Func:LongWord; Function value (or GPIO_FUNCTION_UNKNOWN)
Pull:LongWord; Pull Up/Down value (or GPIO_PULL_UNKNOWN)
Trigger:LongWord; Trigger value (or GPIO_TRIGGER_UNKNOWN)


Public variables


GPIO logging

GPIO_DEFAULT_LOG_LEVEL:LongWord = GPIO_LOG_LEVEL_DEBUG; Minimum level for GPIO messages. Only messages with level greater than or equal to this will be printed.
GPIO_LOG_ENABLED:Boolean;


Function declarations


Initialization functions 

procedure GPIOInit;
Description: To be documented
Note None documented


GPIO functions 

function GPIODeviceStart(GPIO:PGPIODevice):LongWord;
Description: Start the specified GPIO device and enable access
GPIO The GPIO device to start
Return ERROR_SUCCESS if completed or another error code on failure 


function GPIODeviceStop(GPIO:PGPIODevice):LongWord;
Description: Stop the specified GPIO device and disable access
GPIO The GPIO device to stop
Return ERROR_SUCCESS if completed or another error code on failure 


function GPIODeviceRead(GPIO:PGPIODevice; Reg:LongWord):LongWord;
Description: Perform a direct read from a register of the specified GPIO device
GPIO The GPIO device to read from
Reg The memory register to read from
Return The value of the memory register 


procedure GPIODeviceWrite(GPIO:PGPIODevice; Reg,Value:LongWord);
Description: Perform a direct write to a register of the specified GPIO device
GPIO The GPIO device to write to
Reg The memory register to write to
Return The value to write to the register 


function GPIODeviceInputGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
Description: Get the current state of an input pin on the specified GPIO device
GPIO The GPIO device to get from
Pin The pin to get the state for (eg GPIO_PIN_1)
Return The current state (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure 


function GPIODeviceInputWait(GPIO:PGPIODevice; Pin,Trigger,Timeout:LongWord):LongWord;
Description: Wait for the state of a input pin to change on the specified GPIO device
GPIO The GPIO device to wait for
Pin The pin to wait for the state to change (eg GPIO_PIN_1)
Trigger The trigger event to wait for (eg GPIO_TRIGGER_HIGH)
Timeout Number of milliseconds to wait for the change (INFINITE to wait forever)
Return The state after the change (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure or timeout 


function GPIODeviceInputEvent(GPIO:PGPIODevice; Pin,Trigger,Flags,Timeout:LongWord; Callback:TGPIOCallback; Data:Pointer):LongWord;
Description: Schedule a function to be called when the state of a input pin changes on the specified GPIO device
GPIO The GPIO device to schedule the callback for
Pin The pin to schedule the state change for (eg GPIO_PIN_1)
Trigger The trigger event which will cause the function to be called (eg GPIO_TRIGGER_HIGH)
Flags The flags to control the event (eg GPIO_EVENT_FLAG_REPEAT)
Timeout The number of milliseconds before the scheduled trigger expires (INFINITE to never expire)
Callback The function to be called when the trigger occurs
Data A pointer to be pass to the function when the trigger occurs (Optional)
Return ERROR_SUCCESS if the trigger was scheduled successfully or another error code on failure
Note The pin and trigger that caused the event will be passed to the callback function 


function GPIODeviceInputCancel(GPIO:PGPIODevice; Pin:LongWord):LongWord;
Description: Cancel a previously scheduled event callback function for an input pin on the specified GPIO device
GPIO The GPIO device to cancel the callback for
Pin The pin to cancel the state change for (eg GPIO_PIN_1)
Return ERROR_SUCCESS if the callback was cancelled successfully or another error code on failure 


function GPIODeviceOutputSet(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;
Description: Set the state of a output pin on the specified GPIO device
GPIO The GPIO device to set for
Pin The pin to set the state for (eg GPIO_PIN_1)
Level The state to set the pin to (eg GPIO_LEVEL_HIGH)
Return ERROR_SUCCESS if completed successfully or another error code on failure 


function GPIODeviceLevelGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
Description: Get the current level (state) of a pin on the specified GPIO device
GPIO The GPIO device to get from
Pin The pin to get the level for (eg GPIO_PIN_1)
Return The current level (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure
Note This function is a synonym for GPIODeviceInputGet as in many cases the level can be read from a pin regardless of input or output mode. This may help to make code clearer or easier to understand in some cases. 


function GPIODeviceLevelSet(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;
Description: Set the level (state) of a pin on the specified GPIO device
GPIO The GPIO device to set for
Pin The pin to set the level for (eg GPIO_PIN_1)
Level The level to set the pin to (eg GPIO_LEVEL_HIGH)
Return ERROR_SUCCESS if completed successfully or another error code on failure
Note This function is a synonym for GPIODeviceOutputSet as in many cases the level can be set for a pin regardless of input or output mode. This may help to make code clearer or easier to understand in some cases. 


function GPIODevicePullGet(GPIO:PGPIODevice;Pin:LongWord):LongWord;
Description: Get the current pull state of a pin on the specified GPIO device
GPIO The GPIO device to get from
Pin The pin to get the pull state for (eg GPIO_PIN_1)
Return The current pull state of the pin (eg GPIO_PULL_UP) or GPIO_PULL_UNKNOWN on failure 


function GPIODevicePullSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;
Description: Change the pull state of a pin on the specified GPIO device
GPIO The GPIO device to set for
Pin The pin to change the pull state for (eg GPIO_PIN_1)
Mode The pull state to set for the pin (eg GPIO_PULL_UP)
Return ERROR_SUCCESS if completed successfully or another error code on failure 


function GPIODeviceFunctionGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
Description: Get the current function of a pin on the specified GPIO device
GPIO The GPIO device to get from
Pin The pin to get the function for (eg GPIO_PIN_1)
Return The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure 


function GPIODeviceFunctionSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;
Description: Change the function of a pin on the specified GPIO device
GPIO The GPIO device to set for
Pin The pin to change the function for (eg GPIO_PIN_1)
Mode The function to set for the pin (eg GPIO_FUNCTION_OUT)
Return ERROR_SUCCESS if completed successfully or another error code on failure 


function GPIODeviceProperties(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord; inline;
Description: Get the properties for the specified GPIO device
GPIO The GPIO device to get properties from
Properties Pointer to a TGPIOProperties structure to fill in
Return ERROR_SUCCESS if completed or another error code on failure
Note Replaced by GPIODeviceGetProperties for consistency 


function GPIODeviceGetProperties(GPIO:PGPIODevice; Properties:PGPIOProperties):LongWord;
Description: Get the properties for the specified GPIO device
GPIO The GPIO device to get properties from
Properties Pointer to a TGPIOProperties structure to fill in
Return ERROR_SUCCESS if completed or another error code on failure 


function GPIODeviceCreate:PGPIODevice;
Description: Create a new GPIO entry
Return Pointer to new GPIO entry or nil if GPIO could not be created 


function GPIODeviceCreateEx(Size:LongWord):PGPIODevice;
Description: Create a new GPIO entry
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;
Description: Destroy an existing GPIO entry
GPIO The GPIO device to destroy
Return ERROR_SUCCESS if completed or another error code on failure 


function GPIODeviceRegister(GPIO:PGPIODevice):LongWord;
Description: Register a new GPIO in the GPIO table
GPIO The GPIO device to register
Return ERROR_SUCCESS if completed or another error code on failure 


function GPIODeviceDeregister(GPIO:PGPIODevice):LongWord;
Description: Deregister a GPIO in the GPIO table
GPIO The GPIO device to deregister
Return ERROR_SUCCESS if completed or another error code on failure 


function GPIODeviceFind(GPIOId:LongWord):PGPIODevice;
Description: Find a GPIO device by ID in the GPIO table
GPIOId The ID number of the GPIO device to find
Return Pointer to GPIO device entry or nil if not found 


function GPIODeviceFindByName(const Name:String):PGPIODevice; inline;
Description: Find a GPIO device by name in the GPIO table
Name The name of the GPIO to find (eg GPIO0)
Return Pointer to GPIO device entry or nil if not found 


function GPIODeviceFindByDescription(const Description:String):PGPIODevice; inline;
Description: Find a GPIO device by description in the GPIO table
Description The description of the GPIO to find (eg BCM2836 GPIO)
Return Pointer to GPIO device entry or nil if not found 


function GPIODeviceEnumerate(Callback:TGPIOEnumerate; Data:Pointer):LongWord;
Description: Enumerate all GPIO devices in the GPIO table
Callback The callback function to call for each GPIO in the table
Data A private data pointer to pass to callback for each GPIO in the table
Note ERROR_SUCCESS if completed or another error code on failure 


function GPIODeviceNotification(GPIO:PGPIODevice; Callback:TGPIONotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for GPIO device changes
GPIO The GPIO device to notify changes for (Optional, pass nil for all GPIO devices)
Callback The function to call when a notification event occurs
Data A private data pointer to pass to callback when a notification event occurs
Notification The events to register for notification of (eg DEVICE_NOTIFICATION_REGISTER)
Flags The flags to control the notification (eg NOTIFIER_FLAG_WORKER)


RTL GPIO functions 

function SysGPIOAvailable:Boolean;
Description: Check if a GPIO device is available
Note None documented 


function SysGPIOInputGet(Pin:LongWord):LongWord;
Description: Get the current state of a GPIO input pin
Pin The pin to get the state for (eg GPIO_PIN_1)
Return The current state (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure 


function SysGPIOInputWait(Pin,Trigger,Timeout:LongWord):LongWord;
Description: Wait for the state of a GPIO input pin to change
Pin The pin to wait for the state to change (eg GPIO_PIN_1)
Trigger The trigger event to wait for (eg GPIO_TRIGGER_HIGH)
Timeout Number of milliseconds to wait for the change (INFINITE to wait forever)
Return The state after the change (eg GPIO_LEVEL_HIGH) or GPIO_LEVEL_UNKNOWN on failure or timeout 


function SysGPIOInputEvent(Pin,Trigger,Timeout:LongWord; Callback:TGPIOCallback; Data:Pointer):LongWord;
Description: Schedule a function to be called when the state of a GPIO input pin changes
Pin The pin to schedule the state change for (eg GPIO_PIN_1)
Trigger The trigger event which will cause the function to be called (eg GPIO_TRIGGER_HIGH)
Timeout The number of milliseconds before the scheduled trigger expires (INFINITE to never expire)
Callback The function to be called when the trigger occurs
Data A pointer to be pass to the function when the trigger occurs (Optional)
Return ERROR_SUCCESS if the trigger was scheduled successfully or another error code on failure
Note The pin and trigger that caused the event will be passed to the callback function 


function SysGPIOOutputSet(Pin,Level:LongWord):LongWord;
Description: Set the state of a GPIO output pin
Pin The pin to set the state for (eg GPIO_PIN_1)
Level The state to set the pin to (eg GPIO_LEVEL_HIGH)
Return ERROR_SUCCESS if completed successfully or another error code on failure 


function SysGPIOPullGet(Pin:LongWord):LongWord;
Description: Get the current pull state of a GPIO pin
Pin The pin to get the pull state for (eg GPIO_PIN_1)
Return The current pull state of the pin (eg GPIO_PULL_UP) or GPIO_PULL_UNKNOWN on failure 


function SysGPIOPullSelect(Pin,Mode:LongWord):LongWord;
Description: Change the pull state of a GPIO pin
Pin The pin to change the pull state for (eg GPIO_PIN_1)
Mode The pull state to set for the pin (eg GPIO_PULL_UP)
Return ERROR_SUCCESS if completed successfully or another error code on failure 


function SysGPIOFunctionGet(Pin:LongWord):LongWord;
Description: Get the current function of a GPIO pin
Pin The pin to get the function for (eg GPIO_PIN_1)
Return The current function of the pin (eg GPIO_FUNCTION_IN) or GPIO_FUNCTION_UNKNOWN on failure 


function SysGPIOFunctionSelect(Pin,Mode:LongWord):LongWord;
Description: Change the function of a GPIO pin
Pin The pin to change the function for (eg GPIO_PIN_1)
Mode The function to set for the pin (eg GPIO_FUNCTION_OUT)
Return ERROR_SUCCESS if completed successfully or another error code on failure


GPIO helper functions 

function GPIOGetCount:LongWord;
Description: Get the current GPIO count
Note None documented 


function GPIODeviceGetDefault:PGPIODevice;
Description: Get the current default GPIO device
Note None documented 


function GPIODeviceSetDefault(GPIO:PGPIODevice):LongWord;
Description: Set the current default GPIO device
Note None documented 


function GPIODeviceCheck(GPIO:PGPIODevice):PGPIODevice;
Description: Check if the supplied GPIO is in the GPIO table
Note None documented 


function GPIOTypeToString(GPIOType:LongWord):String;
Description: Convert a GPIO type value to a string
Note None documented 


function GPIOStateToString(GPIOState:LongWord):String;
Description: Convert a GPIO state value to a string
Note None documented 


function GPIODeviceCreateEvent(GPIO:PGPIODevice; Pin:PGPIOPin; Callback:TGPIOCallback; Data:Pointer; Timeout:LongWord):PGPIOEvent;
Description: Create a new event using the supplied parameters
Note Event must be registered by calling GPIODeviceRegisterEvent

Caller must hold the GPIO device lock 


function GPIODeviceDestroyEvent(GPIO:PGPIODevice; Event:PGPIOEvent):LongWord;
Description: Destroy an existing event
Note Event must be deregistered first by calling GPIODeviceDeregisterEvent

Caller must hold the GPIO device lock 


function GPIODeviceRegisterEvent(GPIO:PGPIODevice; Pin:PGPIOPin; Event:PGPIOEvent):LongWord;
Description: Register an event in the event list of the supplied Pin
Note Event must be created by calling GPIODeviceCreateEvent

Caller must hold the GPIO device lock 


function GPIODeviceDeregisterEvent(GPIO:PGPIODevice;Pin:PGPIOPin;Event:PGPIOEvent):LongWord;
Description: Deregister an event in the event list of the supplied Pin
Note Event must be destroyed by calling GPIODeviceDestroyEvent

Caller must hold the GPIO device lock 


procedure GPIOLog(Level:LongWord; GPIO:PGPIODevice; const AText:String);
Description: To be documented
Note None documented 


procedure GPIOLogInfo(GPIO:PGPIODevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure GPIOLogWarn(GPIO:PGPIODevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure GPIOLogError(GPIO:PGPIODevice; const AText:String); inline;
Description: To be documented
Note None documented 


procedure GPIOLogDebug(GPIO:PGPIODevice; const AText:String); inline;
Description: To be documented
Note None documented 


function GPIOPinToString(Pin:LongWord):String;
Description: To be documented
Note None documented 


function GPIOLevelToString(Level:LongWord):String;
Description: To be documented
Note None documented 


function GPIOTriggerToString(Trigger:LongWord):String;
Description: To be documented
Note None documented 


function GPIOPullToString(Value:LongWord):String;
Description: To be documented
Note None documented 


function GPIOFunctionToString(Value:LongWord):String;
Description: To be documented
Note None documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_GPIO&oldid=5802"