caffeine-sal 0.1.17
Header-only polymorphic middleware services layer for the Caffeine Framework
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions
cfn_sal_utl_cli.h File Reference

Abstract Command Line Interface (CLI) service interface. More...

#include "cfn_sal.h"

Go to the source code of this file.

Data Structures

struct  cfn_sal_utl_cli_cmd_t
 
struct  cfn_sal_utl_cli_config_t
 
struct  cfn_sal_utl_cli_api_s
 CLI Virtual Method Table (VMT). More...
 

Macros

#define CFN_SAL_UTL_TYPE_CLI   CFN_SAL_TYPE('C', 'L', 'I')
 

Typedefs

typedef struct cfn_sal_utl_cli_s cfn_sal_utl_cli_t
 
typedef struct cfn_sal_utl_cli_api_s cfn_sal_utl_cli_api_t
 
typedef void(* cfn_sal_utl_cli_callback_t) (cfn_sal_utl_cli_t *driver, uint32_t event, uint32_t error, void *user_arg)
 

Enumerations

enum  cfn_sal_utl_cli_event_t { CFN_SAL_UTL_CLI_EVENT_NONE = 0 , CFN_SAL_UTL_CLI_EVENT_CMD_START = CFN_HAL_BIT(0) , CFN_SAL_UTL_CLI_EVENT_CMD_DONE = CFN_HAL_BIT(1) }
 

Functions

 CFN_HAL_VMT_CHECK (struct cfn_sal_utl_cli_api_s)
 
 CFN_SAL_CREATE_DRIVER_TYPE (sal_utl_cli, cfn_sal_utl_cli_config_t, cfn_sal_utl_cli_api_t, cfn_sal_phy_t, cfn_sal_utl_cli_callback_t)
 
CFN_HAL_INLINE void cfn_sal_utl_cli_populate (cfn_sal_utl_cli_t *driver, uint32_t peripheral_id, void *dependency, const cfn_sal_utl_cli_api_t *api, const cfn_sal_phy_t *phy, const cfn_sal_utl_cli_config_t *config, cfn_sal_utl_cli_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_utl_cli_construct (cfn_sal_utl_cli_t *driver, const cfn_sal_utl_cli_config_t *config, const cfn_sal_phy_t *phy, void *dependency, cfn_sal_utl_cli_callback_t callback, void *user_arg)
 
cfn_hal_error_code_t cfn_sal_utl_cli_destruct (cfn_sal_utl_cli_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_init (cfn_sal_utl_cli_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_deinit (cfn_sal_utl_cli_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_config_set (cfn_sal_utl_cli_t *driver, const cfn_sal_utl_cli_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_config_get (cfn_sal_utl_cli_t *driver, cfn_sal_utl_cli_config_t *config)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_callback_register (cfn_sal_utl_cli_t *driver, cfn_sal_utl_cli_callback_t callback, void *user_arg)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_power_state_set (cfn_sal_utl_cli_t *driver, cfn_hal_power_state_t state)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_event_enable (cfn_sal_utl_cli_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_event_disable (cfn_sal_utl_cli_t *driver, uint32_t event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_event_get (cfn_sal_utl_cli_t *driver, uint32_t *event_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_error_enable (cfn_sal_utl_cli_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_error_disable (cfn_sal_utl_cli_t *driver, uint32_t error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_error_get (cfn_sal_utl_cli_t *driver, uint32_t *error_mask)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_feed_char (cfn_sal_utl_cli_t *driver, char c)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_print (cfn_sal_utl_cli_t *driver, const char *str)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_print_line (cfn_sal_utl_cli_t *driver, const char *str)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_register_command (cfn_sal_utl_cli_t *driver, const cfn_sal_utl_cli_cmd_t *cmd)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_unregister_command (cfn_sal_utl_cli_t *driver, const char *name)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_set_prompt (cfn_sal_utl_cli_t *driver, const char *prompt)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_clear_screen (cfn_sal_utl_cli_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_register_command_simple (cfn_sal_utl_cli_t *driver, const char *cmd, void *callback)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_print_help (cfn_sal_utl_cli_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_history_prev (cfn_sal_utl_cli_t *driver)
 
CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_history_next (cfn_sal_utl_cli_t *driver)
 

Detailed Description

Abstract Command Line Interface (CLI) service interface.

Macro Definition Documentation

◆ CFN_SAL_UTL_TYPE_CLI

#define CFN_SAL_UTL_TYPE_CLI   CFN_SAL_TYPE('C', 'L', 'I')

Typedef Documentation

◆ cfn_sal_utl_cli_api_t

typedef struct cfn_sal_utl_cli_api_s cfn_sal_utl_cli_api_t

◆ cfn_sal_utl_cli_callback_t

typedef void(* cfn_sal_utl_cli_callback_t) (cfn_sal_utl_cli_t *driver, uint32_t event, uint32_t error, void *user_arg)

◆ cfn_sal_utl_cli_t

typedef struct cfn_sal_utl_cli_s cfn_sal_utl_cli_t

Enumeration Type Documentation

◆ cfn_sal_utl_cli_event_t

enum cfn_sal_utl_cli_event_t
Enumerator
CFN_SAL_UTL_CLI_EVENT_NONE 
CFN_SAL_UTL_CLI_EVENT_CMD_START 
CFN_SAL_UTL_CLI_EVENT_CMD_DONE 

Function Documentation

◆ CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK ( struct cfn_sal_utl_cli_api_s  )

◆ CFN_SAL_CREATE_DRIVER_TYPE()

CFN_SAL_CREATE_DRIVER_TYPE ( sal_utl_cli  ,
cfn_sal_utl_cli_config_t  ,
cfn_sal_utl_cli_api_t  ,
cfn_sal_phy_t  ,
cfn_sal_utl_cli_callback_t   
)

◆ cfn_sal_utl_cli_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_callback_register ( cfn_sal_utl_cli_t *  driver,
cfn_sal_utl_cli_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_utl_cli_clear_screen()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_clear_screen ( cfn_sal_utl_cli_t *  driver)

◆ cfn_sal_utl_cli_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_config_get ( cfn_sal_utl_cli_t *  driver,
cfn_sal_utl_cli_config_t *  config 
)

◆ cfn_sal_utl_cli_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_config_set ( cfn_sal_utl_cli_t *  driver,
const cfn_sal_utl_cli_config_t *  config 
)

◆ cfn_sal_utl_cli_construct()

cfn_hal_error_code_t cfn_sal_utl_cli_construct ( cfn_sal_utl_cli_t *  driver,
const cfn_sal_utl_cli_config_t *  config,
const cfn_sal_phy_t *  phy,
void *  dependency,
cfn_sal_utl_cli_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_utl_cli_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_deinit ( cfn_sal_utl_cli_t *  driver)

◆ cfn_sal_utl_cli_destruct()

cfn_hal_error_code_t cfn_sal_utl_cli_destruct ( cfn_sal_utl_cli_t *  driver)

◆ cfn_sal_utl_cli_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_error_disable ( cfn_sal_utl_cli_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_utl_cli_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_error_enable ( cfn_sal_utl_cli_t *  driver,
uint32_t  error_mask 
)

◆ cfn_sal_utl_cli_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_error_get ( cfn_sal_utl_cli_t *  driver,
uint32_t *  error_mask 
)

◆ cfn_sal_utl_cli_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_event_disable ( cfn_sal_utl_cli_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_utl_cli_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_event_enable ( cfn_sal_utl_cli_t *  driver,
uint32_t  event_mask 
)

◆ cfn_sal_utl_cli_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_event_get ( cfn_sal_utl_cli_t *  driver,
uint32_t *  event_mask 
)

◆ cfn_sal_utl_cli_feed_char()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_feed_char ( cfn_sal_utl_cli_t *  driver,
char  c 
)

◆ cfn_sal_utl_cli_history_next()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_history_next ( cfn_sal_utl_cli_t *  driver)

◆ cfn_sal_utl_cli_history_prev()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_history_prev ( cfn_sal_utl_cli_t *  driver)

◆ cfn_sal_utl_cli_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_init ( cfn_sal_utl_cli_t *  driver)

◆ cfn_sal_utl_cli_populate()

CFN_HAL_INLINE void cfn_sal_utl_cli_populate ( cfn_sal_utl_cli_t *  driver,
uint32_t  peripheral_id,
void *  dependency,
const cfn_sal_utl_cli_api_t *  api,
const cfn_sal_phy_t *  phy,
const cfn_sal_utl_cli_config_t *  config,
cfn_sal_utl_cli_callback_t  callback,
void *  user_arg 
)

◆ cfn_sal_utl_cli_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_power_state_set ( cfn_sal_utl_cli_t *  driver,
cfn_hal_power_state_t  state 
)

◆ cfn_sal_utl_cli_print()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_print ( cfn_sal_utl_cli_t *  driver,
const char *  str 
)

◆ cfn_sal_utl_cli_print_help()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_print_help ( cfn_sal_utl_cli_t *  driver)

◆ cfn_sal_utl_cli_print_line()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_print_line ( cfn_sal_utl_cli_t *  driver,
const char *  str 
)

◆ cfn_sal_utl_cli_register_command()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_register_command ( cfn_sal_utl_cli_t *  driver,
const cfn_sal_utl_cli_cmd_t *  cmd 
)

◆ cfn_sal_utl_cli_register_command_simple()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_register_command_simple ( cfn_sal_utl_cli_t *  driver,
const char *  cmd,
void *  callback 
)

◆ cfn_sal_utl_cli_set_prompt()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_set_prompt ( cfn_sal_utl_cli_t *  driver,
const char *  prompt 
)

◆ cfn_sal_utl_cli_unregister_command()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_sal_utl_cli_unregister_command ( cfn_sal_utl_cli_t *  driver,
const char *  name 
)
Generated by doxygen 1.9.8