Console Framework Interface

RTOS-integrated Console Framework Interface. More...

Data Structures
struct	sf_console_callback_args_t
struct	sf_console_command_t
struct	sf_console_menu_t
struct	sf_console_cfg_t
struct	sf_console_api_t
struct	sf_console_instance_t

Macros
#define	SF_CONSOLE_API_VERSION_MAJOR   (2U)
#define	SF_CONSOLE_HELP_COMMAND   ((uint8_t *) "?")
#define	SF_CONSOLE_MENU_PREVIOUS_COMMAND   ((uint8_t *) "^")
#define	SF_CONSOLE_ROOT_MENU_COMMAND   ((uint8_t *) "~")
#define	SF_CONSOLE_CALLBACK_NEXT_FUNCTION   ((void(*)(sf_console_callback_args_t * p_args)) 0x70000000)

Typedefs
typedef void	sf_console_ctrl_t
typedef sf_console_callback_args_t	sf_console_cb_args_t

Detailed Description

RTOS-integrated Console Framework Interface.

Summary

This module is a ThreadX-aware Console Framework.

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

See also Console Interface description Console Framework

Macro Definition Documentation

SF_CONSOLE_API_VERSION_MAJOR

#define SF_CONSOLE_API_VERSION_MAJOR   (2U)

Version of the API defined in this file

SF_CONSOLE_CALLBACK_NEXT_FUNCTION

#define SF_CONSOLE_CALLBACK_NEXT_FUNCTION   ((void(*)(sf_console_callback_args_t * p_args)) 0x70000000)

Use this macro to access the next menu layer from this command.

SF_CONSOLE_HELP_COMMAND

#define SF_CONSOLE_HELP_COMMAND   ((uint8_t *) "?")

Command to print each command and help in menu

SF_CONSOLE_MENU_PREVIOUS_COMMAND

#define SF_CONSOLE_MENU_PREVIOUS_COMMAND   ((uint8_t *) "^")

Previous command

SF_CONSOLE_ROOT_MENU_COMMAND

#define SF_CONSOLE_ROOT_MENU_COMMAND   ((uint8_t *) "~")

Root menu command

Typedef Documentation

sf_console_cb_args_t

typedef sf_console_callback_args_t sf_console_cb_args_t

DEPRECATED definition, please use sf_console_callback_args_t instead.

sf_console_ctrl_t

typedef void sf_console_ctrl_t

Console framework control block. Allocate an instance specific control block to pass into the console framework API calls.

Implemented as

• sf_console_instance_ctrl_t