Difference between revisions of "Unit SPI"

From Ultibo.org
Jump to: navigation, search
Line 201: Line 201:
 
<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 SPIDeviceRead(SPI:PSPIDevice; ChipSelect:Word; Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceRead(SPI:PSPIDevice; ChipSelect:Word; Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read data ?rom the specified SPI device</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read data from the specified 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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to read ?rom
+
| The SPI device to read from
 
|-
 
|-
 
! '''ChipSelect'''
 
! '''ChipSelect'''
−
| The chip select for the slave to read ?rom (eg SPI_CS_0)
+
| The chip select for the slave to read from (eg SPI_CS_0)
 
|-
 
|-
 
! '''Dest'''
 
! '''Dest'''
Line 267: Line 267:
 
<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 SPIDeviceWriteRead(SPI:PSPIDevice; ChipSelect:Word; Source,Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SPIDeviceWriteRead(SPI:PSPIDevice; ChipSelect:Word; Source,Dest:Pointer; Size,Flags:LongWord; var Count:LongWord):LongWord;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write data to and Read data ?rom the specified SPI device in one operation</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write data to and Read data from the specified SPI device in one operation</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;"
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to write to and read ?rom
+
| The SPI device to write to and read from
 
|-
 
|-
 
! '''ChipSelect'''
 
! '''ChipSelect'''
−
| The chip select for the slave to write to and read ?rom (eg SPI_CS_0)
+
| The chip select for the slave to write to and read from (eg SPI_CS_0)
 
|-
 
|-
 
! '''Source'''
 
! '''Source'''
Line 308: Line 308:
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to get device mode ?rom
+
| The SPI device to get device mode from
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 341: Line 341:
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to get clock rate ?rom
+
| The SPI device to get clock rate from
 
|-
 
|-
 
! '''ChipSelect'''
 
! '''ChipSelect'''
−
| The chip select number to get clock rate ?rom (SPI_CS_NONE for default)
+
| The chip select number to get clock rate from (SPI_CS_NONE for default)
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 380: Line 380:
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to get clock phase ?rom
+
| The SPI device to get clock phase from
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 413: Line 413:
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to get clock polarity ?rom
+
| The SPI device to get clock polarity from
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 446: Line 446:
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to get chip select polarity ?rom
+
| The SPI device to get chip select polarity from
 
|-
 
|-
 
! '''ChipSelect'''
 
! '''ChipSelect'''
−
| The chip select number to get polarity ?rom (SPI_CS_NONE for default)
+
| The chip select number to get polarity from (SPI_CS_NONE for default)
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 485: Line 485:
 
|-
 
|-
 
! '''SPI'''
 
! '''SPI'''
−
| The SPI device to get properties ?rom
+
| The SPI device to get properties from
 
|-
 
|-
 
! '''Properties'''
 
! '''Properties'''
Line 549: Line 549:
 
<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 ?rom the SPI table</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Deregister a 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;"
Line 672: Line 672:
 
<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 SysSPIRead(ChipSelect:Word; Dest:Pointer; Size:LongWord; var Count:LongWord):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SysSPIRead(ChipSelect:Word; Dest:Pointer; Size:LongWord; var Count:LongWord):LongWord;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read data ?rom the default SPI device</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Read data from the 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;">
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
{| class="wikitable" style="font-size: 14px; background: white;"
 
|-
 
|-
 
! '''ChipSet'''
 
! '''ChipSet'''
−
| The chip select for the slave to read ?rom (eg SPI_CS_0)
+
| The chip select for the slave to read from (eg SPI_CS_0)
 
|-
 
|-
 
! '''Dest'''
 
! '''Dest'''
Line 726: Line 726:
 
<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 SysSPIWriteRead(ChipSelect:Word; Source,Dest:Pointer; Size:LongWord; var Count:LongWord):LongWord;</pre>
 
<pre style="border: 0; padding-bottom:0px;">function SysSPIWriteRead(ChipSelect:Word; Source,Dest:Pointer; Size:LongWord; var Count:LongWord):LongWord;</pre>
−
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write data to and Read data ?rom the default SPI device in one operation</div>
+
<div style="font-size: 14px; padding-left: 12px;">'''Description:''' Write data to and Read data from the default SPI device in one operation</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;"
 
|-
 
|-
 
! '''ChipSet'''
 
! '''ChipSet'''
−
| The chip select for the slave to write to and read ?rom (eg SPI_CS_0)
+
| The chip select for the slave to write to and read from (eg SPI_CS_0)
 
|-
 
|-
 
! '''Source'''
 
! '''Source'''
Line 788: Line 788:
 
|-
 
|-
 
! '''ChipSelect'''
 
! '''ChipSelect'''
−
| The chip select number to get clock rate ?rom (SPI_CS_NONE for default)
+
| The chip select number to get clock rate from (SPI_CS_NONE for default)
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''
Line 875: Line 875:
 
|-
 
|-
 
! '''ChipSet'''
 
! '''ChipSet'''
−
| The chip select number to get polarity ?rom (SPI_CS_NONE for default)
+
| The chip select number to get polarity from (SPI_CS_NONE for default)
 
|-
 
|-
 
! '''Return'''
 
! '''Return'''

Revision as of 04:26, 30 November 2016

Return to Unit Reference


Description

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 psuedo standards exist with all of the available devices. SPI is a master-slave protocol where the master asserts the chip selectline (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 constants SPI_TYPE_*


[Expand]
SPI device state constants SPI_STATE_*


[Expand]
SPI device flag constants SPI_FLAG_*


[Expand]
SPI transfer flag constants SPI_TRANSFER_*


[Expand]
SPI logging constants SPI_LOG_*


Type definitions

To be documented

Public variables

To be documented

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 SPIDeviceProperties(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 a SPI from the SPI table


[Expand] 
function SPIDeviceFind(SPIId:LongWord):PSPIDevice;
Description: To be documented


[Expand] 
function SPIDeviceFindByName(const Name:String):PSPIDevice; inline;
Description: To be documented


[Expand] 
function SPIDeviceFindByDescription(const Description:String):PSPIDevice; inline;
Description: To be documented


[Expand] 
function SPIDeviceEnumerate(Callback:TSPIEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function SPIDeviceNotification(SPI:PSPIDevice; Callback:TSPINotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


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


</div></div>

[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; inline;
Description: Get the current SPI count


[Expand] 
function SPIDeviceGetDefault:PSPIDevice; inline;
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] 
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 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=1809"