Difference between revisions of "Unit I2C"

From Ultibo.org
Jump to: navigation, search
Line 103: Line 103:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''I2C properties'''
 +
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PI2CProperties = ^TI2CProperties;</code>
 +
 
 +
<code>TI2CProperties = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Flags:LongWord;</code>
 +
| Device flags (eg I2C_FLAG_SLAVE)
 +
|-
 +
| <code>MaxSize:LongWord;</code>
 +
| Maximum supported data transfer size
 +
|-
 +
| <code>MinClock:LongWord;</code>
 +
| Minimum supported clock rate
 +
|-
 +
| <code>MaxClock:LongWord;</code>
 +
| Maximum supported clock rate
 +
|-
 +
| <code>ClockRate:LongWord;</code>
 +
| Current clock rate
 +
|-
 +
| <code>SlaveAddress:Word;</code>
 +
| Current slave address
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''I2C enumeration callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CEnumerate = function(I2C:PI2CDevice; Data:Pointer):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C notification callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device start'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceStart = function(I2C:PI2CDevice;Rate:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device stop'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceStop = function(I2C:PI2CDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device read'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceRead = function(I2C:PI2CDevice; Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device write'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceWrite = function(I2C:PI2CDevice; Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device write read'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceWriteRead = function(I2C:PI2CDevice; Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 +
'''I2C device write write'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceWriteWrite = function(I2C:PI2CDevice; Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device get rate'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceGetRate = function(I2C:PI2CDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device set rate'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceSetRate = function(I2C:PI2CDevice; Rate:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device get address'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceGetAddress = function(I2C:PI2CDevice):Word;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device set address'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceSetAddress = function(I2C:PI2CDevice; Address:Word):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device properties'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TI2CDeviceProperties = function(I2C:PI2CDevice; Properties:PI2CProperties):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''I2C device types'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PI2CDevice = ^TI2CDevice;</code>
 +
 
 +
<code>TI2CDevice = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Device Properties''
 +
|-
 +
| <code>Device:TDevice;</code>
 +
| The Device entry for this I2C
 +
|-
 +
|colspan="2"|''I2C Properties''
 +
|-
 +
| <code>I2CId:LongWord;</code>
 +
| Unique Id of this I2C in the I2C table
 +
|-
 +
| <code>I2CState:LongWord;</code>
 +
| I2C state (eg I2C_STATE_ENABLED)
 +
|-
 +
| <code>DeviceStart:TI2CDeviceStart;</code>
 +
| A Device specific DeviceStart method implementing the standard I2C device interface (Mandatory)
 +
|-
 +
| <code>DeviceStop:TI2CDeviceStop;</code>
 +
| A Device specific DeviceStop method implementing the standard I2C device interface (Mandatory)
 +
|-
 +
| <code>DeviceRead:TI2CDeviceRead;</code>
 +
| A Device specific DeviceRead method implementing the standard I2C device interface (Mandatory)
 +
|-
 +
| <code>DeviceWrite:TI2CDeviceWrite;</code>
 +
| A Device specific DeviceWrite method implementing the standard I2C device interface (Mandatory)
 +
|-
 +
| <code>DeviceWriteRead:TI2CDeviceWriteRead;</code>
 +
| A Device specific DeviceWriteRead method implementing the standard I2C device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceWriteWrite:TI2CDeviceWriteWrite;</code>
 +
| A Device specific DeviceWriteWrite method implementing the standard I2C device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceGetRate:TI2CDeviceGetRate;</code>
 +
| A Device specific DeviceGetRate method implementing the standard I2C device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceSetRate:TI2CDeviceSetRate;</code>
 +
| A Device specific DeviceSetRate method implementing the standard I2C device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceGetAddress:TI2CDeviceGetAddress;</code>
 +
| A Device specific DeviceGetAddress method implementing the standard I2C device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceSetAddress:TI2CDeviceSetAddress;</code>
 +
| A Device specific DeviceSetAddress method implementing the standard I2C device interface (Or nil if the default method is suitable)
 +
|-
 +
| <code>DeviceProperties:TI2CDeviceProperties;</code>
 +
| A Device specific DeviceProperties method implementing the standard I2C device interface (Or nil if the default method is suitable)
 +
|-
 +
|colspan="2"|''Statistics Properties''
 +
|-
 +
| <code>ReadCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>WriteCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ReadErrors:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>WriteErrors:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Driver Properties''
 +
|-
 +
| <code>Lock:TMutexHandle;</code>
 +
| Device lock
 +
|-
 +
| <code>Wait:TSemaphoreHandle;</code>
 +
| Read/Write wait event
 +
|-
 +
| <code>ClockRate:LongWord;</code>
 +
| Clock rate (Hz)
 +
|-
 +
| <code>SlaveAddress:Word;</code>
 +
| Slave address
 +
|-
 +
| <code>Properties:TI2CProperties;</code>
 +
| Device properties
 +
|-
 +
|colspan="2"|''Internal Properties''
 +
|-
 +
| <code>Prev:PI2CDevice;</code>
 +
| Previous entry in I2C table
 +
|-
 +
| <code>Next:PI2CDevice;</code>
 +
| Next entry in I2C table
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 05:42, 19 January 2017

Return to Unit Reference


Description

Ultibo I2C interface unit

I2C (Inter-Integrated Circuit) is a serial bus for communication between peripheral components.

Originally invented by Phillips the I2C protocol is used by thousands of common chips that perform a wide range of tasks such as real time clocks, temperature and other sensors, small LCD displays and many more.

Each device is assigned a 7bit address which is used by the host (or master) to signal the device that a message written to the bus is intended for that device or that the host wants to read data from that device.

Speeds range from 10Kbps to 3.4Mbps although the typical speed is either 100Kbps or 400Kbps.

This unit implements the standardized interface for I2C devices and allows reading or writing to a specific address, setting a clock rate for the communication and determining device properties.

For the purpose of this interface a device is the I2C 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 I2C device should know (or allow configuration of) the address to read and write to and the specific message format required for that device. The Intel System Management Bus (SMBus) is a variation of the I2C bus and in certain cases the two are compatible with each other.

Constants


[Expand]
I2C specific constants I2C_*


[Expand]
I2C device type constants I2C_TYPE_*


[Expand]
I2C device state constants I2C_STATE_*


[Expand]
I2C device flag constants I2C_FLAG_*


[Expand]
I2C logging constants I2C_LOG_*


Type definitions


I2C properties

[Expand]

PI2CProperties = ^TI2CProperties;

TI2CProperties = record

I2C enumeration callback

TI2CEnumerate = function(I2C:PI2CDevice; Data:Pointer):LongWord;

I2C notification callback

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

I2C device start

TI2CDeviceStart = function(I2C:PI2CDevice;Rate:LongWord):LongWord;

I2C device stop

TI2CDeviceStop = function(I2C:PI2CDevice):LongWord;

I2C device read

TI2CDeviceRead = function(I2C:PI2CDevice; Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;

I2C device write

TI2CDeviceWrite = function(I2C:PI2CDevice; Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;

I2C device write read

TI2CDeviceWriteRead = function(I2C:PI2CDevice; Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;

I2C device write write

TI2CDeviceWriteWrite = function(I2C:PI2CDevice; Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;

I2C device get rate

TI2CDeviceGetRate = function(I2C:PI2CDevice):LongWord;

I2C device set rate

TI2CDeviceSetRate = function(I2C:PI2CDevice; Rate:LongWord):LongWord;

I2C device get address

TI2CDeviceGetAddress = function(I2C:PI2CDevice):Word;

I2C device set address

TI2CDeviceSetAddress = function(I2C:PI2CDevice; Address:Word):LongWord;

I2C device properties

TI2CDeviceProperties = function(I2C:PI2CDevice; Properties:PI2CProperties):LongWord;

I2C device types

[Expand]

PI2CDevice = ^TI2CDevice;

TI2CDevice = record


Public variables


I2C logging

I2C_DEFAULT_LOG_LEVEL:LongWord = I2C_LOG_LEVEL_DEBUG; Minimum level for I2C messages. Only messages with level greater than or equal to this will be printed.
I2C_LOG_ENABLED:Boolean;


Function declarations


Initialization functions

[Expand] 
procedure I2CInit;
Description: Initialize the I2C unit and I2C device table


I2C functions

[Expand] 
function I2CDeviceStart(I2C:PI2CDevice; Rate:LongWord):LongWord;
Description: Start the specified I2C device ready for reading and writing


[Expand] 
function I2CDeviceStop(I2C:PI2CDevice):LongWord;
Description: Stop the specified I2C device and terminate reading and writing


[Expand] 
function I2CDeviceRead(I2C:PI2CDevice; Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Read data from the specified I2C device


[Expand] 
function I2CDeviceWrite(I2C:PI2CDevice; Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to the specified I2C device


[Expand] 
function I2CDeviceWriteRead(I2C:PI2CDevice; Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to and Read data from the specified I2C device in one operation. Useful for devices that require a register address specified before a read (eg EEPROM devices)


[Expand] 
function I2CDeviceWriteWrite(I2C:PI2CDevice; Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write 2 data blocks to the specified I2C device in one operation. Useful for devices that require a register address specified before a write (eg EEPROM devices)


[Expand] 
function I2CDeviceGetRate(I2C:PI2CDevice):LongWord;
Description: Get the clock rate of the specified I2C device


[Expand] 
function I2CDeviceSetRate(I2C:PI2CDevice; Rate:LongWord):LongWord;
Description: Set the clock rate for the specified I2C device


[Expand] 
function I2CDeviceGetAddress(I2C:PI2CDevice):Word;
Description: Get the slave address for the specified I2C device


[Expand] 
function I2CDeviceSetAddress(I2C:PI2CDevice; Address:Word):LongWord;
Description: Set the slave address for the specified I2C device


[Expand] 
function I2CDeviceProperties(I2C:PI2CDevice; Properties:PI2CProperties):LongWord;
Description: Get the properties for the specified I2C device


[Expand] 
function I2CDeviceCreate:PI2CDevice;
Description: Create a new I2C entry


[Expand] 
function I2CDeviceCreateEx(Size:LongWord):PI2CDevice;
Description: Create a new I2C entry


[Expand] 
function I2CDeviceDestroy(I2C:PI2CDevice):LongWord;
Description: Destroy an existing I2C entry


[Expand] 
function I2CDeviceRegister(I2C:PI2CDevice):LongWord;
Description: Register a new I2C in the I2C table


[Expand] 
function I2CDeviceDeregister(I2C:PI2CDevice):LongWord;
Description: Deregister a I2C from the I2C table


[Expand] 
function I2CDeviceFind(I2CId:LongWord):PI2CDevice;
Description: To be documented


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


[Expand] 
function I2CDeviceFindByDescription(const Description:String):PI2CDevice; inline;
Description: To be documented


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


[Expand] 
function I2CDeviceNotification(I2C:PI2CDevice; Callback:TI2CNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


RTL I2C functions

[Expand] 
function SysI2CAvailable:Boolean;
Description: Check if an I2C device is available


[Expand] 
function SysI2CStart(Rate:LongWord):LongWord;
Description: Start the default I2C device ready for reading and writing


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


[Expand] 
function SysI2CRead(Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Read data from the default I2C device


[Expand] 
function SysI2CWrite(Address:Word; Buffer:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to the default I2C device


[Expand] 
function SysI2CWriteRead(Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write data to and Read data from the default I2C device in one operation. Useful for devices that require a register address specified before a read (eg EEPROM devices)


[Expand] 
function SysI2CWriteWrite(Address:Word; Initial:Pointer; Len:LongWord; Data:Pointer; Size:LongWord; var Count:LongWord):LongWord;
Description: Write 2 data blocks to the default I2C device in one operation. Useful for devices that require a register address specified before a write (eg EEPROM devices)


[Expand] 
function SysI2CGetRate:LongWord;
Description: Get the clock rate of the default I2C device


[Expand] 
function SysI2CSetRate(Rate:LongWord):LongWord;
Description: Set the clock rate for the default I2C device


[Expand] 
function SysI2CGetAddress:Word;
Description: Get the slave address for the default I2C device


[Expand] 
function SysI2CSetAddress(Address:Word):LongWord;
Description: Set the slave address for the default I2C device


I2C helper functions

[Expand] 
function I2CGetCount:LongWord; inline;
Description: Get the current I2C count


[Expand] 
function I2CDeviceGetDefault:PI2CDevice; inline;
Description: Get the current default I2C device


[Expand] 
function I2CDeviceSetDefault(I2C:PI2CDevice):LongWord;
Description: Set the current default I2C device


[Expand] 
function I2CDeviceCheck(I2C:PI2CDevice):PI2CDevice;
Description: Check if the supplied I2C is in the I2C table


[Expand] 
procedure I2CLog(Level:LongWord; I2C:PI2CDevice; const AText:String);
Description: To be documented


[Expand] 
procedure I2CLogInfo(I2C:PI2CDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure I2CLogError(I2C:PI2CDevice; const AText:String); inline;
Description: To be documented


[Expand] 
procedure I2CLogDebug(I2C:PI2CDevice; const AText:String); inline;
Description: To be documented


Return to Unit Reference

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