Communications Framework Interface

RTOS-integrated communications Framework Interface. More...

Data Structures
struct	sf_comms_callback_args_t
struct	sf_comms_cfg_t
struct	sf_comms_api_t
struct	sf_comms_instance_t

Macros
#define	SF_COMMS_API_VERSION_MAJOR   (2U)

Typedefs
typedef void	sf_comms_ctrl_t

Enumerations
enum	sf_comms_lock_t { SF_COMMS_LOCK_TX = 0, SF_COMMS_LOCK_RX, SF_COMMS_LOCK_ALL }
enum	sf_comms_event_t { SF_COMMS_DISCONNECT_EVENT }

Detailed Description

RTOS-integrated communications Framework Interface.

Implemented by:

• UART Framework Instance - UART implementation
• USB Communication Framework V2 - USBX CDC ACM device implementation
• Telnet Communication Framework on sf_comms_telnet - NetX telnet server with shared IP Instance implementation

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

See also Framework Communications Interface description: UART Communications Framework

Macro Definition Documentation

SF_COMMS_API_VERSION_MAJOR

#define SF_COMMS_API_VERSION_MAJOR   (2U)

Version of the API defined in this file

Typedef Documentation

sf_comms_ctrl_t

typedef void sf_comms_ctrl_t

Communications framework control block. Allocate an instance specific control block to pass into the communications framework API calls.

Implemented as

• sf_console_instance_ctrl_t

Enumeration Type Documentation

sf_comms_event_t

enum sf_comms_event_t

Options for the callback events.

Note

Only applies for SF_COMMS_TELNET.

Enumerator
SF_COMMS_DISCONNECT_EVENT	Disconnected the client.

sf_comms_lock_t

enum sf_comms_lock_t

Communications locks

Enumerator
SF_COMMS_LOCK_TX	Lock Transmit.
SF_COMMS_LOCK_RX	Lock Receive.
SF_COMMS_LOCK_ALL	Lock Transmit and Receive.