Difference between revisions of "Unit SPI"

From Ultibo.org
Jump to: navigation, search
 
(7 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
----
 
----
  
−
'''Ultibo SPI interface unit'''
+
'''Ultibo SPI Interface unit'''
  
 
SPI (Serial Peripheral Interface) is a synchronous serial bus for communication with peripheral components.
 
SPI (Serial Peripheral Interface) is a synchronous serial bus for communication with peripheral components.
Line 26: Line 26:
 
| <code>SPI_NAME_PREFIX = 'SPI';</code>
 
| <code>SPI_NAME_PREFIX = 'SPI';</code>
 
| Name prefix for SPI Devices
 
| Name prefix for SPI Devices
 +
|-
 +
| <code>SPISLAVE_NAME_PREFIX = 'SPISlave';</code>
 +
| Name prefix for SPI Slave Devices
 
|-
 
|-
 
|}
 
|}
Line 37: Line 40:
 
| <code>SPI_TYPE_NONE = 0;</code>
 
| <code>SPI_TYPE_NONE = 0;</code>
 
| style="width: 50%;"|&nbsp;
 
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>SPI_TYPE_MASTER = 1;</code>
 +
| &nbsp;
 +
|-
 +
| <code>SPI_TYPE_SLAVE = 2;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>SPI_TYPE_MAX = 2;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
|colspan="2"|SPI Type Names
 +
|-
 +
|colspan="2"|<code>SPI_TYPE_NAMES:array[SPI_TYPE_NONE..SPI_TYPE_MAX] of String = ('SPI_TYPE_NONE', 'SPI_TYPE_MASTER', 'SPI_TYPE_SLAVE');</code>
 
|-
 
|-
 
|}
 
|}
Line 50: Line 70:
 
|-
 
|-
 
| <code>SPI_STATE_ENABLED = 1;</code>
 
| <code>SPI_STATE_ENABLED = 1;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>SPI_STATE_MAX = 1;</code>
 
| &nbsp;
 
| &nbsp;
 
|-
 
|-
Line 106: Line 131:
 
| <code>SPI_TRANSFER_PIO = $00000002;</code>
 
| <code>SPI_TRANSFER_PIO = $00000002;</code>
 
| Use PIO (Polling) for transfer (Write/Read)
 
| Use PIO (Polling) for transfer (Write/Read)
 +
|-
 +
|colspan="2"|&nbsp;
 +
|-
 +
| <code>SPI_TRANSFER_DELAY = $00000004;</code>
 +
| Add a delay after each byte written (Write/Read) Note: Only available with PIO transfer unless provided directly by hardware
 
|-
 
|-
 
|}
 
|}
Line 176: Line 206:
 
| <code>SelectPolarity:LongWord;</code>
 
| <code>SelectPolarity:LongWord;</code>
 
| Default chip select polarity (eg SPI_CS_POLARITY_LOW)
 
| Default chip select polarity (eg SPI_CS_POLARITY_LOW)
 +
|-
 +
| <code>ByteDelay:LongWord;</code>
 +
| Delay between bytes written (Microseconds)
 
|-
 
|-
 
|}
 
|}
Line 209: Line 242:
 
| <code>SelectPolarity:LongWord;</code>
 
| <code>SelectPolarity:LongWord;</code>
 
| The chip select polarity for this chip select (eg SPI_CS_POLARITY_LOW)
 
| The chip select polarity for this chip select (eg SPI_CS_POLARITY_LOW)
 +
|-
 +
| <code>ByteDelay:LongWord;</code>
 +
| Delay between bytes written for this chip select (Microseconds)
 
|-
 
|-
 
|}
 
|}
Line 362: Line 398:
 
|-
 
|-
 
| <code>TSPIDeviceSetSelectPolarity = function(SPI:PSPIDevice; ChipSelect:Word; SelectPolarity:LongWord):LongWord;</code>
 
| <code>TSPIDeviceSetSelectPolarity = function(SPI:PSPIDevice; ChipSelect:Word; SelectPolarity:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 +
'''SPI device get byte delay'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSPIDeviceGetByteDelay = function(SPI:PSPIDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 +
'''SPI device set byte delay'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TSPIDeviceSetByteDelay = function(SPI:PSPIDevice; Delay:LongWord):LongWord;</code>
 
| style="width: 40%;"|
 
| style="width: 40%;"|
 
|-
 
|-
Line 444: Line 498:
 
| <code>DeviceSetSelectPolarity:TSPIDeviceSetSelectPolarity;</code>
 
| <code>DeviceSetSelectPolarity:TSPIDeviceSetSelectPolarity;</code>
 
| A Device specific DeviceSetSelectPolarity method implementing the standard SPI device interface (Or nil if the default method is suitable)
 
| A Device specific DeviceSetSelectPolarity method implementing the standard SPI device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceGetByteDelay:TSPIDeviceGetByteDelay;</code>
 +
| A Device specific DeviceGetByteDelay method implementing the standard SPI device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceSetByteDelay:TSPIDeviceSetByteDelay;</code>
 +
| A Device specific DeviceSetByteDelay method implementing the standard SPI device interface (Or nil if the default method is suitable)
 
|-
 
|-
 
| <code>DeviceGetProperties:TSPIDeviceGetProperties;</code>
 
| <code>DeviceGetProperties:TSPIDeviceGetProperties;</code>
Line 641: Line 701:
 
|-
 
|-
 
! Note
 
! Note
−
| Because SPI writes and then reads for each byte, received data will be discarded for each by written.
+
| Because SPI writes and then reads for each byte, received data will be discarded for each byte written.
 
|-
 
|-
 
|}
 
|}
Line 964: Line 1,024:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! Note
+
! SPI
−
| None documented
+
| The SPI device to destroy
 +
|-
 +
! Return
 +
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
 
|}
 
|}
Line 976: Line 1,039:
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
−
! Note
+
! SPI
−
| None documented
+
| The SPI device to register
 +
|-
 +
! Return
 +
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
 
|}
 
|}
Line 984: Line 1,050:
 
<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 SPIDeviceDeregister(SPI:PSPIDevice):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceDeregister(SPI:PSPIDevice):LongWord;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Deregister a SPI from the SPI table</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Deregister an SPI from the SPI table</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
+
! SPI
−
| None documented
+
| The SPI device to deregister
 +
|-
 +
! Return
 +
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
 
|}
 
|}
Line 996: Line 1,065:
 
<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 SPIDeviceFind(SPIId:LongWord):PSPIDevice;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceFind(SPIId:LongWord):PSPIDevice;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' ERROR_SUCCESS if completed or another error code on failure</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
+
! SPIId
−
| None documented
+
| The ID number of the SPI device to find
 +
|-
 +
! Return
 +
| Pointer to SPI device entry or nil if not found
 
|-
 
|-
 
|}
 
|}
Line 1,008: Line 1,080:
 
<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 SPIDeviceFindByName(const Name:String):PSPIDevice; inline;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceFindByName(const Name:String):PSPIDevice; inline;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find an SPI device by name in the device table</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
+
! Name
−
| None documented
+
| The name of the SPI device to find (eg SPI0)
 +
|-
 +
! Return
 +
| Pointer to SPI device entry or nil if not found
 
|-
 
|-
 
|}
 
|}
Line 1,020: Line 1,095:
 
<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 SPIDeviceFindByDescription(const Description:String):PSPIDevice; inline;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceFindByDescription(const Description:String):PSPIDevice; inline;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Find an SPI device by description in the device table</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
+
! Description
−
| None documented
+
| The description of the SPI to find (eg BCM2837 SPI0 Master)
 +
|-
 +
! Return
 +
| Pointer to SPI device entry or nil if not found
 
|-
 
|-
 
|}
 
|}
Line 1,032: Line 1,110:
 
<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 SPIDeviceEnumerate(Callback:TSPIEnumerate; Data:Pointer):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceEnumerate(Callback:TSPIEnumerate; Data:Pointer):LongWord;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Enumerate all SPI devices in the SPI table</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
+
! Callback
−
| None documented
+
| The callback function to call for each SPI device in the table
 +
|-
 +
! Data
 +
| A private data pointer to pass to callback for each SPI device in the table
 +
|-
 +
! Return
 +
| ERROR_SUCCESS if completed or another error code on failure
 
|-
 
|-
 
|}
 
|}
Line 1,044: Line 1,128:
 
<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 SPIDeviceNotification(SPI:PSPIDevice; Callback:TSPINotification; Data:Pointer; Notification,Flags:LongWord):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceNotification(SPI:PSPIDevice; Callback:TSPINotification; Data:Pointer; Notification,Flags:LongWord):LongWord;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' To be documented</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Register a notification for SPI device changes</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
+
! Device
−
| None documented
+
| The SPI device to notify changes for (Optional, pass nil for all SPI 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)
 
|-
 
|-
 
|}
 
|}
Line 1,154: Line 1,250:
 
|-
 
|-
 
! Note
 
! Note
−
| Because SPI writes and then reads for each byte, received data will be discarded for each by written.
+
| Because SPI writes and then reads for each byte, received data will be discarded for each byte written.
 
|-
 
|-
 
|}
 
|}
Line 1,340: Line 1,436:
  
 
<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 SPIGetCount:LongWord; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function SPIGetCount:LongWord;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current SPI count</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current SPI 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;">
Line 1,352: Line 1,448:
 
<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 SPIDeviceGetDefault:PSPIDevice; inline;</pre>
+
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceGetDefault:PSPIDevice;</pre>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default SPI device</div>
 
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Get the current default SPI 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;">

Latest revision as of 04:41, 10 October 2023

Return to Unit Reference


Description

Ultibo SPI Interface unit

SPI (Serial Peripheral Interface) is a synchronous serial bus for communication with peripheral components.

The SPI protocol is not defined by any actual standard but some pseudo standards exist with all of the available devices. SPI is a master-slave protocol where the master asserts the chip select line (CS) to select the slave device before sending data one byte at a time. For every byte written to the bus by the master the selected slave returns a byte as well so for every write there is an equivalent read. SPI can also operate in either 4 wire (standard) or 3 wire(bidirectional) modes.

Due to the lack of formal standards and the range of devices that exist various options are provided to allow setting clock phase and polarity as well chip select polarity.

For the purpose of this interface a device is the SPI controller attached to the local system and may be either a master or a slave. Since the protocol does not include any form of enumeration or identification the interface does not attempt to represent the devices connected to the bus, any driver written to communicate with a connected SPI device should know (or allow configuration of) the chip select for the for the device and the specific message format required for that device.

Constants


[Expand]
SPI specific constants SPI_*


[Expand]
SPI device type SPI_TYPE_*


[Expand]
SPI device state SPI_STATE_*


[Expand]
SPI device flag SPI_FLAG_*


[Expand]
SPI transfer flag SPI_TRANSFER_*


[Expand]
SPI logging SPI_LOG_*


Type definitions


SPI properties

[Expand]

PSPIProperties = ^TSPIProperties;

TSPIProperties = record

SPI chip select

[Expand]

PSPIChipSelect = ^TSPIChipSelect;

TSPIChipSelect = record

SPI enumeration callback

TSPIEnumerate = function(SPI:PSPIDevice; Data:Pointer):LongWord;

SPI notification callback

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

SPI device start

TSPIDeviceStart = function(SPI:PSPIDevice; Mode,ClockRate,ClockPhase,ClockPolarity:LongWord):LongWord;

SPI device stop

TSPIDeviceStop = function(SPI:PSPIDevice):LongWord;

SPI device read

TSPIDeviceRead = function(SPI:PSPIDevice; ChipSelect:Word; Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

SPI device write

TSPIDeviceWrite = function(SPI:PSPIDevice; ChipSelect:Word; Source:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

SPI device write read

TSPIDeviceWriteRead = function(SPI:PSPIDevice; ChipSelect:Word; Source,Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;

SPI device get mode

TSPIDeviceGetMode = function(SPI:PSPIDevice):LongWord;

SPI device set mode

TSPIDeviceSetMode = function(SPI:PSPIDevice; Mode:LongWord):LongWord;

SPI device get clock rate

TSPIDeviceGetClockRate = function(SPI:PSPIDevice; ChipSelect:Word):LongWord;

SPI device set clock rate

TSPIDeviceSetClockRate = function(SPI:PSPIDevice; ChipSelect:Word; ClockRate:LongWord):LongWord;

SPI device get clock phase

TSPIDeviceGetClockPhase = function(SPI:PSPIDevice):LongWord;

SPI device set clock phase

TSPIDeviceSetClockPhase = function(SPI:PSPIDevice; ClockPhase:LongWord):LongWord;

SPI device get clock polarity

TSPIDeviceGetClockPolarity = function(SPI:PSPIDevice):LongWord;

SPI device set clock polarity

TSPIDeviceSetClockPolarity = function(SPI:PSPIDevice; ClockPolarity:LongWord):LongWord;

SPI device get select polarity

TSPIDeviceGetSelectPolarity = function(SPI:PSPIDevice; ChipSelect:Word):LongWord;

SPI device set select polarity

TSPIDeviceSetSelectPolarity = function(SPI:PSPIDevice; ChipSelect:Word; SelectPolarity:LongWord):LongWord;

SPI device get byte delay

TSPIDeviceGetByteDelay = function(SPI:PSPIDevice):LongWord;

SPI device set byte delay

TSPIDeviceSetByteDelay = function(SPI:PSPIDevice; Delay:LongWord):LongWord;

SPI device get properties

TSPIDeviceGetProperties = function(SPI:PSPIDevice; Properties:PSPIProperties):LongWord;

SPI device

[Expand]

PSPIDevice = ^TSPIDevice;

TSPIDevice = record


Public variables


SPI logging

SPI_DEFAULT_LOG_LEVEL:LongWord = SPI_LOG_LEVEL_DEBUG; Minimum level for SPI messages. Only messages with level greater than or equal to this will be printed.
SPI_LOG_ENABLED:Boolean;


Function declarations


Initialization functions

[Expand] 
procedure SPIInit;
Description: Initialize the SPI unit and SPI device table


SPI functions

[Expand] 
function SPIDeviceStart(SPI:PSPIDevice; Mode,ClockRate,ClockPhase,ClockPolarity:LongWord):LongWord;
Description: Start the specified SPI device ready for writing and reading


[Expand] 
function SPIDeviceStop(SPI:PSPIDevice):LongWord;
Description: Stop the specified SPI device and terminate writing and reading


[Expand] 
function SPIDeviceRead(SPI:PSPIDevice; ChipSelect:Word; Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: Read data from the specified SPI device


[Expand] 
function SPIDeviceWrite(SPI:PSPIDevice; ChipSelect:Word; Source:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: Write data to the specified SPI device


[Expand] 
function SPIDeviceWriteRead(SPI:PSPIDevice; ChipSelect:Word; Source,Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;
Description: Write data to and Read data from the specified SPI device in one operation


[Expand] 
function SPIDeviceGetMode(SPI:PSPIDevice):LongWord;
Description: Get the device mode of the specified SPI device


[Expand] 
function SPIDeviceSetMode(SPI:PSPIDevice; Mode:LongWord):LongWord;
Description: Set the device mode for the specified SPI device


[Expand] 
function SPIDeviceGetClockRate(SPI:PSPIDevice; ChipSelect:Word):LongWord;
Description: Get the clock rate of the specified SPI device


[Expand] 
function SPIDeviceSetClockRate(SPI:PSPIDevice; ChipSelect:Word; ClockRate:LongWord):LongWord;
Description: Set the clock rate for the specified SPI device


[Expand] 
function SPIDeviceGetClockPhase(SPI:PSPIDevice):LongWord;
Description: Get the clock phase of the specified SPI device


[Expand] 
function SPIDeviceSetClockPhase(SPI:PSPIDevice; ClockPhase:LongWord):LongWord;
Description: Set the clock phase for the specified SPI device


[Expand] 
function SPIDeviceGetClockPolarity(SPI:PSPIDevice):LongWord;
Description: Get the clock polarity of the specified SPI device


[Expand] 
function SPIDeviceSetClockPolarity(SPI:PSPIDevice; ClockPolarity:LongWord):LongWord;
Description: Set the clock polarity for the specified SPI device


[Expand] 
function SPIDeviceGetSelectPolarity(SPI:PSPIDevice; ChipSelect:Word):LongWord;
Description: Get the chip select polarity of the specified SPI device


[Expand] 
function SPIDeviceSetSelectPolarity(SPI:PSPIDevice; ChipSelect:Word; SelectPolarity:LongWord):LongWord;
Description: Set the chip select polarity for the specified SPI device


[Expand] 
function SPIDeviceGetByteDelay(SPI:PSPIDevice):LongWord;
Description: Get the delay between bytes written for the specified SPI device


[Expand] 
function SPIDeviceSetByteDelay(SPI:PSPIDevice; Delay:LongWord):LongWord;
Description: Set the delay between bytes written for the specified SPI device


[Expand] 
function SPIDeviceProperties(SPI:PSPIDevice; Properties:PSPIProperties):LongWord; inline;
Description: Get the properties for the specified SPI device


[Expand] 
function SPIDeviceGetProperties(SPI:PSPIDevice;Properties:PSPIProperties):LongWord;
Description: Get the properties for the specified SPI device


[Expand] 
function SPIDeviceCreate:PSPIDevice;
Description: Create a new SPI entry


[Expand] 
function SPIDeviceCreateEx(Size:LongWord):PSPIDevice;
Description: Create a new SPI entry


[Expand] 
function SPIDeviceDestroy(SPI:PSPIDevice):LongWord;
Description: Destroy an existing SPI entry


[Expand] 
function SPIDeviceRegister(SPI:PSPIDevice):LongWord;
Description: Register a new SPI in the SPI table


[Expand] 
function SPIDeviceDeregister(SPI:PSPIDevice):LongWord;
Description: Deregister an SPI from the SPI table


[Expand] 
function SPIDeviceFind(SPIId:LongWord):PSPIDevice;
Description: ERROR_SUCCESS if completed or another error code on failure


[Expand] 
function SPIDeviceFindByName(const Name:String):PSPIDevice; inline;
Description: Find an SPI device by name in the device table


[Expand] 
function SPIDeviceFindByDescription(const Description:String):PSPIDevice; inline;
Description: Find an SPI device by description in the device table


[Expand] 
function SPIDeviceEnumerate(Callback:TSPIEnumerate; Data:Pointer):LongWord;
Description: Enumerate all SPI devices in the SPI table


[Expand] 
function SPIDeviceNotification(SPI:PSPIDevice; Callback:TSPINotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: Register a notification for SPI device changes


RTL SPI functions

[Expand] 
function SysSPIAvailable:Boolean;
Description: Check if an SPI device is available


[Expand] 
function SysSPIStart(Mode,ClockRate,ClockPhase,ClockPolarity:LongWord):LongWord;
Description: Start the default SPI device ready for writing and reading


[Expand] 
function SysSPIStop:LongWord;
Description: Stop the default SPI device and terminate writing and reading


[Expand] 
function SysSPIRead(ChipSelect:Word; Dest:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Read data from the default SPI device


[Expand] 
function SysSPIWrite(ChipSelect:Word; Source:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to the default SPI device


[Expand] 
function SysSPIWriteRead(ChipSelect:Word; Source,Dest:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to and Read data from the default SPI device in one operation


[Expand] 
function SysSPIGetMode:LongWord;
Description: Get the device mode of the default SPI device


[Expand] 
function SysSPISetMode(Mode:LongWord):LongWord;
Description: Set the device mode for the default SPI device


[Expand] 
function SysSPIGetClockRate(ChipSelect:Word):LongWord;
Description: Get the clock rate of the default SPI device


[Expand] 
function SysSPISetClockRate(ChipSelect:Word; ClockRate:LongWord):LongWord;
Description: Set the clock rate for the default SPI device


[Expand] 
function SysSPIGetClockPhase:LongWord;
Description: Get the clock phase of the default SPI device


[Expand] 
function SysSPISetClockPhase(ClockPhase:LongWord):LongWord;
Description: Set the clock phase for the default SPI device


[Expand] 
function SysSPIGetClockPolarity:LongWord;
Description: Get the clock polarity of the default SPI device


[Expand] 
function SysSPISetClockPolarity(ClockPolarity:LongWord):LongWord;
Description: Set the clock polarity for the default SPI device


[Expand] 
function SysSPIGetSelectPolarity(ChipSelect:Word):LongWord;
Description: Get the chip select polarity of the default SPI device


[Expand] 
function SysSPISetSelectPolarity(ChipSelect:Word; SelectPolarity:LongWord):LongWord;
Description: Set the chip select polarity for the default SPI device


SPI helper functions

[Expand] 
function SPIGetCount:LongWord;
Description: Get the current SPI count


[Expand] 
function SPIDeviceGetDefault:PSPIDevice;
Description: Get the current default SPI device


[Expand] 
function SPIDeviceSetDefault(SPI:PSPIDevice):LongWord;
Description: Set the current default SPI device


[Expand] 
function SPIDeviceCheck(SPI:PSPIDevice):PSPIDevice;
Description: Check if the supplied SPI is in the SPI table


[Expand] 
function SPITypeToString(SPIType:LongWord):String;
Description: Convert an SPI type value to a string


[Expand] 
function SPIStateToString(SPIState:LongWord):String;
Description: Convert an SPI state value to a string


[Expand] 
procedure SPILog(Level:LongWord; SPI:PSPIDevice; const AText:String);
Description: To be documented


[Expand] 
procedure SPILogInfo(SPI:PSPIDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure SPILogWarn(SPI:PSPIDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure SPILogError(SPI:PSPIDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure SPILogDebug(SPI:PSPIDevice; const AText:String); inline;
Description: To be documented


[Expand] 
function SPIChipSelectToString(ChipSelect:Word):String;
Description: To be documented


[Expand] 
function SPIModeToString(Mode:LongWord):String;
Description: To be documented


[Expand] 
function SPIClockPhaseToString(Phase:LongWord):String;
Description: To be documented


[Expand] 
function SPIClockPolarityToString(Polarity:LongWord):String;
Description: To be documented


[Expand] 
function SPISelectPolarityToString(Polarity:LongWord):String;
Description: To be documented


Return to Unit Reference

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