comm_interface.h File Reference

The comm_interface.h file describes the interface definition for the communication interface. Each commaunication instance needs to implement comm interface. More...

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>

Include dependency graph for comm_interface.h:

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

Go to the source code of this file.

Data Structures
struct	_comm_handle_
struct	_comm_control_
struct	_comm_interface_

Macros
#define	COMM_INTERFACE_OK   0
	Operation succeeded. More...

Typedefs
typedef struct _comm_handle_	comm_handle_t
typedef struct _comm_control_	comm_control_t
typedef enum _comm_type_	comm_type_t
typedef enum _comm_instance_type_	comm_instance_type_t
typedef void(*	COMM_Event_t) (uint32_t event)
typedef int32_t()	COMM_GetCapabilities_t(comm_handle_t *pHandle)
	The interface function to get the capability of the communication interface. More...
typedef int32_t()	COMM_Init_t(comm_handle_t *pHandle, void *pCommInstance, COMM_Event_t event, void *pInitializeData)
	The interface function to initialize the communication interface. More...
typedef int32_t()	COMM_Config_t(comm_handle_t *pHandle, void *pConfigData)
	The interface function to configure the communication interface. More...
typedef int32_t()	COMM_Send_t(comm_handle_t *pHandle, void *pData, uint32_t size)
	The interface function to send data through the communication interface. More...
typedef int32_t()	COMM_Receive_t(comm_handle_t *pHandle, void *pData, uint32_t size)
	The interface function to receive data through the communication interface. More...
typedef int32_t()	COMM_GetStatus_t(comm_handle_t *pHandle)
	The interface function to get the status of the comm. More...
typedef struct _comm_interface_	comm_interface_t

Enumerations
enum	_comm_type_ {   COMM_UART, COMM_BLUETOOTH, COMM_I2C, COMM_SOCKET,   COMM_NFC }
enum	_comm_instance_type_ { COMM_BLOCKING, COMM_NONBLOCKING }

Detailed Description

The comm_interface.h file describes the interface definition for the communication interface. Each commaunication instance needs to implement comm interface.

Definition in file comm_interface.h.

Macro Definition Documentation

COMM_INTERFACE_OK

#define COMM_INTERFACE_OK   0

Operation succeeded.

Definition at line 20 of file comm_interface.h.

Referenced by COMM_UART_GetCapabilities(), and COMM_UART_Init().

Typedef Documentation

COMM_Config_t

typedef int32_t() COMM_Config_t(comm_handle_t *pHandle, void *pConfigData)

The interface function to configure the communication interface.

Definition at line 68 of file comm_interface.h.

comm_control_t

typedef struct _comm_control_ comm_control_t

COMM_Event_t

typedef void(* COMM_Event_t) (uint32_t event)

Definition at line 62 of file comm_interface.h.

COMM_GetCapabilities_t

typedef int32_t() COMM_GetCapabilities_t(comm_handle_t *pHandle)

The interface function to get the capability of the communication interface.

Definition at line 64 of file comm_interface.h.

COMM_GetStatus_t

typedef int32_t() COMM_GetStatus_t(comm_handle_t *pHandle)

The interface function to get the status of the comm.

Definition at line 74 of file comm_interface.h.

comm_handle_t

typedef struct _comm_handle_ comm_handle_t

COMM_Init_t

typedef int32_t() COMM_Init_t(comm_handle_t *pHandle, void *pCommInstance, COMM_Event_t event, void *pInitializeData)

The interface function to initialize the communication interface.

Definition at line 66 of file comm_interface.h.

comm_instance_type_t

typedef enum _comm_instance_type_ comm_instance_type_t

comm_interface_t

typedef struct _comm_interface_ comm_interface_t

COMM_Receive_t

typedef int32_t() COMM_Receive_t(comm_handle_t *pHandle, void *pData, uint32_t size)

The interface function to receive data through the communication interface.

Definition at line 72 of file comm_interface.h.

COMM_Send_t

typedef int32_t() COMM_Send_t(comm_handle_t *pHandle, void *pData, uint32_t size)

The interface function to send data through the communication interface.

Definition at line 70 of file comm_interface.h.

comm_type_t

typedef enum _comm_type_ comm_type_t

Enumeration Type Documentation

_comm_instance_type_

enum _comm_instance_type_

Enumerator
COMM_BLOCKING
COMM_NONBLOCKING

Definition at line 55 of file comm_interface.h.

_comm_type_

enum _comm_type_

Enumerator
COMM_UART
COMM_BLUETOOTH
COMM_I2C
COMM_SOCKET
COMM_NFC

Definition at line 44 of file comm_interface.h.