Difference between revisions of "Unit STMPE"

From Ultibo.org
Jump to: navigation, search
Line 1,815: Line 1,815:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''STMPE control'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PSTMPEControl = ^TSTMPEControl;</code>
 +
 
 +
<code>TSTMPEControl = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''General Properties''
 +
|-
 +
| <code>Chip:LongWord;</code>
 +
| The chip type (eg STMPE_CHIP_STMPE610)
 +
|-
 +
| <code>IRQ:TGPIOInfo;</code>
 +
| The GPIO information for the IRQ line (Optional)
 +
|-
 +
|colspan="2"|''I2C Properties''
 +
|-
 +
| <code>I2C:PI2CDevice;</code>
 +
| The I2C device this device is connected to (Optional)
 +
|-
 +
| <code>Address:Word;</code>
 +
| The I2C address of the device
 +
|-
 +
|colspan="2"|''SPI Properties''
 +
|-
 +
| <code>SPI:PSPIDevice;</code>
 +
| The SPI device this device is connected to (Optional)
 +
|-
 +
| <code>ChipSelect:Word;</code>
 +
| The SPI chip select of the device
 +
|-
 +
|colspan="2"|''Register Properties''
 +
|-
 +
| <code>RegMax:LongWord;</code>
 +
| The maximum register address for read or write
 +
|-
 +
| <code>RegDir:LongWord;</code>
 +
| The register address direction (Ascending / Descending)
 +
|-
 +
| <code>RegSize:LongWord;</code>
 +
| The standard size of a register read or write
 +
|-
 +
|}
 +
</div></div> 
 +
 +
'''STMPE offsets'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PSTMPEOffsets = ^TSTMPEOffsets;</code>
 +
 
 +
<code>TSTMPEOffsets = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Control Register offsets''
 +
|-
 +
| <code>SysCtrl:Byte;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>IntCtrl:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>IntEnable:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>IntStatus:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''GPIO Registers offsets''
 +
|-
 +
| <code>GPIOIntEnable:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOIntStatus:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOPinGet:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOPinSet:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOPinClr:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIODirSet:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOFuncSet:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOPullUp:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOPullDown:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOEdgeDetect:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIORisingEdge:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GPIOFallingEdge:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Touchscreen Register offsets (610 and 811 Only)''
 +
|-
 +
| <code>ADCCtrl1:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ADCCtrl2:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>TSCCtrl:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>TSCCfg:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FIFOThreshold:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>FIFOStatus:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>TSCDataXYZ:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>TSCFractionZ:Byte;</code>
 +
| &nbsp;
 +
|-
 +
| <code>TSCIDrive:Byte;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
 +
'''STMPE GPIO'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PSTMPEGPIO = ^TSTMPEGPIO;</code>
 +
 
 +
<code>TSTMPEGPIO = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''GPIO Properties''
 +
|-
 +
| <code>GPIO:TGPIODevice;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''STMPE Properties''
 +
|-
 +
| <code>Control:TSTMPEControl;</code>
 +
| The control information (Chip, I2C, SPI etc) for this device
 +
|-
 +
| <code>Offsets:TSTMPEOffsets;</code>
 +
| The register offsets for this device
 +
|-
 +
|}
 +
</div></div>
 +
 +
'''STMPE touch'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PSTMPETouch = ^TSTMPETouch;</code>
 +
 
 +
<code>TSTMPETouch = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Touch Properties''
 +
|-
 +
| <code>Touch:TTouchDevice;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''STMPE Properties''
 +
|-
 +
| <code>Control:TSTMPEControl;</code>
 +
| The control information (Chip, I2C, SPI etc) for this device
 +
|-
 +
| <code>Offsets:TSTMPEOffsets;</code>
 +
| The register offsets for this device
 +
|-
 +
| <code>Timer:TTimerHandle;</code>
 +
| Handle for touch release timer
 +
|-
 +
|}
 +
</div></div> 
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 04:01, 25 January 2017

Return to Unit Reference


Description

ST Microelectronics STMPE Driver unit

The ST Microelectronics STMPE devices are a range of multi function chips that include GPIO, ADC, 4 wire touchscreen controller and PWM outputs in varying combinations. Many of the functions overlap so a pin can be used for example as a GPIO or a PWM but not both at once. The Touchscreen controller also consumes many of the GPIO pins in the models that support it. This driver supports the GPIO and Touchscreen functions of the following chips:

STMPE610 - 6 GPIO / 4-wire Touch / I2C / SPI

STMPE801 - 8 GPIO / I2C

STMPE811 - 8 GPIO / 4-wire Touch / I2C / SPI

STMPE1601 - 16 GPIO / 4 PWM / I2C

STMPE1801 - 18 GPIO / I2C

STMPE2401 - 24 GPIO / 3 PWM / I2C

STMPE2403 - 24 GPIO / 3 PWM / I2C

Note: A number of variations also support Keypad, Temperature and other features which are not currently handled by this driver.

Constants


[Expand]
STMPE specific constants STMPE*_*


[Expand]
STMPE chip constants STMPE_CHIP_*


[Expand]
STMPE direction constants STMPE_DIR_*


[Expand]
STMPE I2C constants STMPE_I2C_*


[Expand]
STMPE SPI constants STMPE_SPI_*


[Expand]
STMPE register constants STMPE*_REG_*


[Expand]
STMPE ID constants STMPE*_CHIP_ID


[Expand]
STMPE system control constants STMPE*_SYS_CTRL*_*


[Expand]
STMPE touchscreen control constants STMPE*_TSC_CTRL_*


[Expand]
STMPE touchscreen config constants STMPE*_TSC_CFG_*


[Expand]
STMPE ADC control 1 constants STMPE*_ADC_CTRL1_*


[Expand]
STMPE ADC control 2 constants STMPE*_ADC_CTRL2_*


[Expand]
STMPE FIFO control and status constants STMPE*_FIFO_STA_*


[Expand]
STMPE interrupt control constants STMPE*_INT_CTRL_*


[Expand]
STMPE interrupt enable constants STMPE*_INT_EN_*


[Expand]
STMPE interrupt status constants STMPE*_INT_STA_*


[Expand]
STMPE offset constants STMPE*Offsets*


Type definitions


STMPE control

[Expand]

PSTMPEControl = ^TSTMPEControl;

TSTMPEControl = record

STMPE offsets

[Expand]

PSTMPEOffsets = ^TSTMPEOffsets;

TSTMPEOffsets = record

STMPE GPIO

[Expand]

PSTMPEGPIO = ^TSTMPEGPIO;

TSTMPEGPIO = record

STMPE touch

[Expand]

PSTMPETouch = ^TSTMPETouch;

TSTMPETouch = record


Public variables


STMPE specific variables

STMPE_SAMPLE_TIME:Byte = 4;
STMPE_MOD_12B:Byte = 1;
STMPE_REF_SEL:Byte = 0;
STMPE_ADC_FREQ:Byte = 2;
STMPE_AVE_CTRL:Byte = 3;
STMPE_TOUCH_DET_DELAY:Byte = 4;
STMPE_SETTLING:Byte = 2;
STMPE_FRACTION_Z:Byte = 7;
STMPE_I_DRIVE:Byte = 0;


Function declarations


Initialization functions

[Expand] 
procedure STMPEInit;
Description: Initialize the STMPE unit and parameters


STMPE functions

[Expand] 
function STMPE610GPIOCreate(I2C:PI2CDevice; SPI:PSPIDevice; Address,ChipSelect:Word; IRQ:PGPIOInfo):PGPIODevice;
Description: Create, register and start a new STMPE610 GPIO device connected to the specified I2C or SPI device


[Expand] 
function STMPE801GPIOCreate(I2C:PI2CDevice; Address:Word; IRQ:PGPIOInfo):PGPIODevice;
Description: Create, register and start a new STMPE801 GPIO device connected to the specified I2C device


[Expand] 
function STMPE811GPIOCreate(I2C:PI2CDevice; SPI:PSPIDevice; Address,ChipSelect:Word; IRQ:PGPIOInfo):PGPIODevice;
Description: Create, register and start a new STMPE811 GPIO device connected to the specified I2C or SPI device


[Expand] 
function STMPE1601GPIOCreate(I2C:PI2CDevice; Address:Word; IRQ:PGPIOInfo):PGPIODevice;
Description: Create, register and start a new STMPE1601 GPIO device connected to the specified I2C device


[Expand] 
function STMPE1801GPIOCreate(I2C:PI2CDevice; Address:Word; IRQ:PGPIOInfo):PGPIODevice;
Description: Create, register and start a new STMPE1801 GPIO device connected to the specified I2C device


[Expand] 
function STMPE2401GPIOCreate(I2C:PI2CDevice; Address:Word; IRQ:PGPIOInfo):PGPIODevice;
Description: Create, register and start a new STMPE2401 GPIO device connected to the specified I2C device


[Expand] 
function STMPEGPIODestroy(GPIO:PGPIODevice):LongWord;
Description: Stop, deregister and destroy an STMPE GPIO device created by this driver


[Expand] 
function STMPE610TouchCreate(I2C:PI2CDevice; SPI:PSPIDevice; Address,ChipSelect:Word; Width,Height:LongWord; IRQ:PGPIOInfo):PTouchDevice;
Description: Create, register and start a new STMPE610 Touch device connected to the specified I2C or SPI device


[Expand] 
function STMPE811TouchCreate(I2C:PI2CDevice; SPI:PSPIDevice; Address,ChipSelect:Word; Width,Height:LongWord; IRQ:PGPIOInfo):PTouchDevice;
Description: Create, register and start a new STMPE811 Touch device connected to the specified I2C or SPI device


[Expand] 
function STMPETouchDestroy(Touch:PTouchDevice):LongWord;
Description: Stop, deregister and destroy an STMPE Touch device created by this driver


STMPE GPIO functions

[Expand] 
function STMPEGPIOStart(GPIO:PGPIODevice):LongWord;
Description: Implementation of GPIODeviceStart API for STMPE


[Expand] 
function STMPEGPIOStop(GPIO:PGPIODevice):LongWord;
Description: Implementation of GPIODeviceStop API for STMPE


[Expand] 
function STMPEGPIORead(GPIO:PGPIODevice; Reg:LongWord):LongWord;
Description: Implementation of GPIODeviceRead API for STMPE


[Expand] 
procedure STMPEGPIOWrite(GPIO:PGPIODevice; Reg,Value:LongWord);
Description: Implementation of GPIODeviceWrite API for STMPE


[Expand] 
function STMPEGPIOInputGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
Description: Implementation of GPIODeviceInputGet API for STMPE


[Expand] 
function STMPEGPIOOutputSet(GPIO:PGPIODevice; Pin,Level:LongWord):LongWord;
Description: Implementation of GPIODeviceOutputSet API for STMPE


[Expand] 
function STMPEGPIOPullGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
Description: Implementation of GPIODevicePullGet API for STMPE


[Expand] 
function STMPEGPIOPullSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;
Description: Implementation of GPIODevicePullSelect API for STMPE


[Expand] 
function STMPEGPIOFunctionGet(GPIO:PGPIODevice; Pin:LongWord):LongWord;
Description: Implementation of GPIODeviceFunctionGet API for STMPE


[Expand] 
function STMPEGPIOFunctionSelect(GPIO:PGPIODevice; Pin,Mode:LongWord):LongWord;
Description: Implementation of GPIODeviceFunctionSelect API for STMPE


STMPE touch functions

[Expand] 
function STMPETouchStart(Touch:PTouchDevice):LongWord;
Description: Implementation of TouchDeviceStart API for STMPE


[Expand] 
function STMPETouchStop(Touch:PTouchDevice):LongWord;
Description: Implementation of TouchDeviceStop API for STMPE


[Expand] 
procedure STMPETouchTimer(Touch:PSTMPETouch);
Description: Touch device timer event handler for STMPE


[Expand] 
procedure STMPETouchCallback(Touch:PSTMPETouch; Pin,Trigger:LongWord);
Description: Touch device event callback (Interrupt) handler for STMPE


STMPE helper functions

[Expand] 
function STMPEReadByte(Control:PSTMPEControl; Reg:Byte; Value:PByte):LongWord;
Description: To be documented


[Expand] 
function STMPEWriteByte(Control:PSTMPEControl; Reg,Value:Byte):LongWord;
Description: To be documented


[Expand] 
function STMPEReadWord(Control:PSTMPEControl; Reg:Byte; Value:PWord):LongWord;
Description: To be documented


[Expand] 
function STMPEWriteWord(Control:PSTMPEControl; Reg:Byte; Value:Word):LongWord;
Description: To be documented


[Expand] 
function STMPEReadBytes(Control:PSTMPEControl; Reg,Len:Byte; Values:PByte):LongWord;
Description: To be documented


[Expand] 
function STMPEWriteBytes(Control:PSTMPEControl; Reg,Len:Byte; Values:PByte):LongWord;
Description: To be documented


[Expand] 
function STMPESetBits(Control:PSTMPEControl; Reg,Mask,Value:Byte):LongWord;
Description: To be documented


[Expand] 
function STMPEResetFIFO(Control:PSTMPEControl; Reg:Byte):LongWord;
Description: To be documented


Return to Unit Reference

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