CLI Commands in RAM#

Support for CLI commands stored in and executed from RAM.

Modules#

cli_storage_ram_t

Typedefs#

Definition of the CLI storage RAM handle.

Functions#

void
sl_cli_storage_ram_clear(sl_cli_command_arg_t *arguments)

Clear the command lines stored in ram.

void
sl_cli_storage_ram_list(sl_cli_command_arg_t *arguments)

Print the contet of the command lines stored in ram.

void
sl_cli_storage_ram_define(sl_cli_command_arg_t *arguments)

Start defining new command lines that will be stored in ram.

void
sl_cli_storage_ram_execute(sl_cli_command_arg_t *arguments)

Execute command lines stored in ram.

size_t
sl_cli_storage_ram_count(sl_cli_handle_t cli_handle)

Get the number of command lines stored in ram.

void
sl_cli_storage_ram_init(cli_storage_ram_handle_t handle)

Initialize the cli_storage_ram instance.

Typedef Documentation#

cli_storage_ram_handle_t#

typedef cli_storage_ram_t* cli_storage_ram_handle_t

Definition of the CLI storage RAM handle.


Definition at line 72 of file platform/service/cli_storage/inc/sl_cli_storage_ram.h

Function Documentation#

sl_cli_storage_ram_clear#

void sl_cli_storage_ram_clear (sl_cli_command_arg_t * arguments)

Clear the command lines stored in ram.

Parameters
[in]arguments

A pointer to the command arguments.

This function can be used directly as a cli command handler.


Definition at line 82 of file platform/service/cli_storage/inc/sl_cli_storage_ram.h

sl_cli_storage_ram_list#

void sl_cli_storage_ram_list (sl_cli_command_arg_t * arguments)

Print the contet of the command lines stored in ram.

Parameters
[in]arguments

A pointer to the command arguments.

This function can be used directly as a cli command handler.


Definition at line 92 of file platform/service/cli_storage/inc/sl_cli_storage_ram.h

sl_cli_storage_ram_define#

void sl_cli_storage_ram_define (sl_cli_command_arg_t * arguments)

Start defining new command lines that will be stored in ram.

Parameters
[in]arguments

A pointer to the command arguments.

This function can be used directly as a cli command handler.


Definition at line 102 of file platform/service/cli_storage/inc/sl_cli_storage_ram.h

sl_cli_storage_ram_execute#

void sl_cli_storage_ram_execute (sl_cli_command_arg_t * arguments)

Execute command lines stored in ram.

Parameters
[in]arguments

A pointer to the command arguments.

This function can be used directly as a cli command handler.

Note

  • The function has a different implementation in a bare-metal vs. kernel configurations. In a bare-metal configuration, this function will signal that stored commands shall be run by the sl_cli_storage_ram_tick function. One stored command is executed for each call to the sl_cli_storage_ram_tick function. In a kernel configuration, all stored commands will be executed before this function returns.


Definition at line 121 of file platform/service/cli_storage/inc/sl_cli_storage_ram.h

sl_cli_storage_ram_count#

size_t sl_cli_storage_ram_count (sl_cli_handle_t cli_handle)

Get the number of command lines stored in ram.

Parameters
[in]cli_handle

Handle to the CLI where the cli_storage_ram component is connected.

Returns

  • The number of command lines stored in ram.


Definition at line 133 of file platform/service/cli_storage/inc/sl_cli_storage_ram.h

sl_cli_storage_ram_init#

void sl_cli_storage_ram_init (cli_storage_ram_handle_t handle)

Initialize the cli_storage_ram instance.

Parameters
[in]handle

A handle to the cli_storage_ram instance.


Definition at line 142 of file platform/service/cli_storage/inc/sl_cli_storage_ram.h