nRF5 SDK v14.0.0
Macros | Functions
Infineon I2C Protocol Stack: Physical Layer

Module for the physical layer of the Infineon I2C Protocol Stack library. More...

Macros

#define IFX_I2C_PL_EVENT_SUCCESS   0x01
 Success event propagated to upper layer.
 
#define IFX_I2C_PL_EVENT_ERROR   0x02
 Error event propagated to upper layer.
 

Functions

uint16_t ifx_i2c_pl_init (ifx_i2c_event_handler_t p_handler)
 Function for initializing the module. More...
 
uint16_t ifx_i2c_pl_send_frame (uint8_t *frame, uint16_t frame_len)
 Function for sending a frame. More...
 
uint16_t ifx_i2c_pl_receive_frame (void)
 Function for receiving a frame. More...
 

Detailed Description

Module for the physical layer of the Infineon I2C Protocol Stack library.

Function Documentation

uint16_t ifx_i2c_pl_init ( ifx_i2c_event_handler_t  p_handler)

Function for initializing the module.

Function initializes and enables the module and registers an event handler to receive events from this module.

Attention
This function must be called before using the module.
Parameters
[in]p_handlerFunction pointer to the event handler of the upper layer.
Return values
IFX_I2C_STACK_SUCCESSIf initialization was successful.
IFX_I2C_STACK_ERRORIf the module is already initialized.
uint16_t ifx_i2c_pl_receive_frame ( void  )

Function for receiving a frame.

Asynchronous function to receive a frame. The function returns immediately. One of the following events is propagated to the event handler registered with ifx_i2c_pl_init

Return values
IFX_I2C_STACK_SUCCESSIf function was successful.
IFX_I2C_STACK_ERRORIf the module is busy.
uint16_t ifx_i2c_pl_send_frame ( uint8_t *  frame,
uint16_t  frame_len 
)

Function for sending a frame.

Asynchronous function to send a frame. The function returns immediately. One of the following events is propagated to the event handler registered with ifx_i2c_pl_init

Parameters
[in]frameBuffer containing the frame.
[in]frame_lenFrame length.
Return values
IFX_I2C_STACK_SUCCESSIf function was successful.
IFX_I2C_STACK_ERRORIf the module is busy.

Documentation feedback | Developer Zone | Subscribe | Updated