Component: I2C (CAL) (Misc)

Author	Matrix TSL
Version	2.0
Category	Misc

I2C component

CAL = Code Abstraction Layer - Allows one code base to run on a wide range of chips. A low level implementation giving direct access to the Two Wire I²C peripheral.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_I2C.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_I2C.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

GetConsoleHandle

	GetConsoleHandle
Obtains the CAL console handle
- HANDLE	Return

GetList

	GetList
returns Named property List as filter string
- STRING	Name
- STRING	Return

GetValue

	GetValue
Get the Named property value.
- STRING	Name
- STRING	Return

Master_Init

	Master_Init
Initialise the Master
- VOID	Return

Master_Restart

	Master_Restart
Output a Master Restart sequence
- VOID	Return

Master_RxByte

	Master_RxByte
Returns a received data byte. Set Last=0 if there is following more Master_RxByte macros Set Last=1 if this is the last Master_RxByte and it is followed with Master_Stop. If Last = 1 the I2C bus will be presented with a 'Nack' condition.
- BYTE	Last
Range: 0-1 - 0 = Not the last byte to receive, 1 = last byte to receive
- BYTE	Return

Master_Start

	Master_Start
Output a Master Start sequence
- VOID	Return

Master_Stop

	Master_Stop
Output a Master Stop
- VOID	Return

Master_TxByte

	Master_TxByte
Send a data byte and collects the acknowledge from the slave. Returns 0 for Ack received. Returns 1 for Ack not received - slave not responding.
- BYTE	Data
Data byte to write to the I2C bus
- BYTE	Return

Master_Uninit

	Master_Uninit
Uninitialise the Master
- VOID	Return

SetValue

	SetValue
Change Named property to new Value. If "CHANNEL" the ports will be also updated from the fcd
- STRING	Name
- STRING	Value
port value as string
- VOID	Return

Slave_Init

	Slave_Init
Initialise the Slave with the given Address, or range of Addresses. Only address bits that have a corresponding bit set in the Mask will be compared with the incoming bus address.
- BYTE	Address
7 Bit Address of this device (Bit 0 is ignored)
- BYTE	Mask
Bit mask used to compare addresses
- VOID	Return

Slave_RxByte

	Slave_RxByte
Returns the data received, and sends either Ack or Nak Set parameter Last as: 1=Last=Nak, 0=Ack=More
- BYTE	Last
Sends Ack if 0, else Nak
- BYTE	Return

Slave_Status

	Slave_Status
Returns the Slave Status. Bit 0 = 1 Indicates address/data byte available in the buffer to read Bit 5 = 1 Indicates that the last byte received or transmitted was data (else address)
- BYTE	Return

Slave_TxByte

	Slave_TxByte
Send a data byte, returns Ack/Nak from Master 0=Ack=More, 1=Nak=Last
- BYTE	Data
- BYTE	Return

Slave_Uninit

	Slave_Uninit
Uninitialise the Slave
- VOID	Return

Transaction_Initialise

	Transaction_Initialise
Initialise the I2C interface to communicate with a Slave device at Address Returns 0 on fail, 1 on success
- BYTE	Address
7-bit I2C Address without the shift for the R/W bit
- BYTE	Return

Transaction_Read

	Transaction_Read
Attempt to read Length number of bytes from the I2C slave to the given Buffer. Ensure that the Buffer is large enough. Returns number of bytes read, caller should check that this matches requested Length
- BYTE	Buffer
Buffer to store the incoming byte data
- UINT	Length
Number of bytes to read
- UINT	Return

Transaction_Uninit

	Transaction_Uninit
Uninitialise the I2C interface
- VOID	Return

Transaction_Write

	Transaction_Write
Attempt to write Length number of bytes to the I2C slave from the given Buffer. Ensure that the Buffer is large enough. Returns the number of bytes written, the caller should check that this matches requested Length
- BYTE	Buffer
Buffer of bytes to write to the I2C
- UINT	Length
Number of bytes to send out, MS bit 0x8000 signifies no Stop if set
- UINT	Return

Property reference

	Properties
	Component Enable
Allows the component to be easily disabled from generating code, allowing for multiple CAL components to be easily created. For example a sensor IC with both I2C and SPI communications interfaces.
	Connections
	Channel
Channel selection
	Mode
Defines if the component will be used for Master or Slave communications. Master mode supports a software bitbanged I2C channel. Slave mode requires a hardware I2C peripheral to catch the communications from the Master.
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	Options
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Slew Rate Control
Slew Rate Control Enabled or Disabled
	SMBus Inputs
When Enabled input logic thresholds are compliant with SMBus specification
	Simulation
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API
Specifies the API component on the panel to interact with to provide comms simulation.