This file defines the API prototype for data link layer of the Infineon I2C Protocol Stack library. More...

#include "ifx_i2c_config.h"

Include dependency graph for ifx_i2c_data_link_layer.h:

This graph shows which files directly or indirectly include this file:

#define	IFX_I2C_DL_EVENT_ERROR (0x01)
	Error event propagated to upper layer. More...

#define	IFX_I2C_DL_EVENT_TX_SUCCESS (0x02)
	Transmit success event propagated to upper layer (bit field 1) More...

#define	IFX_I2C_DL_EVENT_RX_SUCCESS (0x04)
	Receive success event propagated to upper layer (bit field 3) More...

optiga_lib_status_t	ifx_i2c_dl_init (ifx_i2c_context_t *p_ctx, ifx_i2c_event_handler_t handler)
	Function for initializing the module. More...

optiga_lib_status_t	ifx_i2c_dl_send_frame (ifx_i2c_context_t *p_ctx, uint16_t frame_len)
	Function for sending a frame. More...

optiga_lib_status_t	ifx_i2c_dl_receive_frame (ifx_i2c_context_t *p_ctx)
	Function for receiving a frame. More...

Detailed Description

This file defines the API prototype for data link layer of the Infineon I2C Protocol Stack library.

Copyright: MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE

\endcopyright

Author: Infineon Technologies AG

Macro Definition Documentation

◆ IFX_I2C_DL_EVENT_ERROR

#define IFX_I2C_DL_EVENT_ERROR (0x01)

Error event propagated to upper layer.

◆ IFX_I2C_DL_EVENT_RX_SUCCESS

#define IFX_I2C_DL_EVENT_RX_SUCCESS (0x04)

Receive success event propagated to upper layer (bit field 3)

◆ IFX_I2C_DL_EVENT_TX_SUCCESS

#define IFX_I2C_DL_EVENT_TX_SUCCESS (0x02)

Transmit success event propagated to upper layer (bit field 1)

Function Documentation

◆ ifx_i2c_dl_init()

optiga_lib_status_t ifx_i2c_dl_init	(	ifx_i2c_context_t *	p_ctx,
		ifx_i2c_event_handler_t	handler
	)

Function for initializing the module.

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

Precondition

This function must be called before using the module.

Note

None

Parameters

[in,out]	p_ctx	Pointer to ifx i2c context.
[in]	handler	Function pointer to the event handler of the upper layer.

Return values

IFX_I2C_STACK_SUCCESS	If initialization was successful.
IFX_I2C_STACK_ERROR	If the module is already initialized.

Here is the call graph for this function:

◆ ifx_i2c_dl_receive_frame()

optiga_lib_status_t ifx_i2c_dl_receive_frame ( ifx_i2c_context_t * p_ctx )

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_dl_init.

Precondition

None

Note

None

Parameters

[in,out] p_ctx Pointer to ifx i2c context.

Return values

IFX_I2C_STACK_SUCCESS	If function was successful.
IFX_I2C_STACK_ERROR	If the module is busy.

Here is the call graph for this function:

◆ ifx_i2c_dl_send_frame()

optiga_lib_status_t ifx_i2c_dl_send_frame	(	ifx_i2c_context_t *	p_ctx,
		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_dl_init.

Precondition

None

Note

None

Parameters

[in,out]	p_ctx	Pointer to ifx i2c context.
[in]	frame_len	Frame length.

Return values

IFX_I2C_STACK_SUCCESS	If function was successful.
IFX_I2C_STACK_ERROR	If the module is busy.

Here is the call graph for this function: