Jump to main content

##

# 1.2.3.4 Library Interface

Command System Service library provides the following interfaces:

Functions

Name | Description
--- | ---
SYS_CMD_Initialize | Initializes data for the instance of the Command Processor module
SYS_CMD_ADDGRP | Allows clients to add command process to the Command Processor System Service
SYS_CMD_DELETE | Removes CMDIO parameters from the Command Processor System Service console
SYS_CMD_READY_TO_READ | Allows upper layer application to confirm that the command module is ready to accept command input
SYS_CMD_READY_TO_WRITE | Allows upper layer application to confirm that the command module is ready to write output to the Console System Service
SYS_CMD_Tasks | Maintains the Command Processor System Service's internal state machine
SYS_CMD_MESSAGE | Outputs a message to the Command Processor System Service console
SYS_CMD_PRINT | Outputs a printout to the Command Processor System Service console
SYS_CMDIO_GET_HANDLE | Gets the CMDIO Handle base via index
SYS_CMDIO_ADD | Adds CMDIO parameters to the Command Processor System Service console

Data types and constants

Name | Type | Description
--- | --- | ---
COMMAND_HISTORY_DEPTH | Macro | Command Processor System Service Maximum Depth of Command History
SYS_CMD_MAX_LENGTH | Macro | Command Processor System Service Command Buffer Maximum Length definition
SYS_CMD_READ_BUFFER_SIZE | Macro | Command Processor System Service Read Buffer Size definition
SYS_CMD_CallbackFunction | Typedef | Command Callback Function Handle
SYS_CMD_HANDLE | Typedef | Identifies a particular Command I/O instance
SYS_CMD_MSG_FNC | Typedef | Identifies a message function API
SYS_CMD_PRINT_FNC | Typedef | Identifies a print function API
SYS_CMD_PUTC_FNC | Typedef | Identifies a single character print function API
SYS_CMD_DATA_RDY_FNC | Typedef | Identifies a data available function API
SYS_CMD_GETC_FNC | Typedef | Identifies a get single character function API
SYS_CMD_READC_FNC | Typedef | Identifies a read single character function API
SYS_CMD_API | Struct | Identifies the Command API structure
SYS_CMD_EVENT | Enum | Identifies the Command Event Types
SYS_CMD_CONSOLE_IO_PARAM | Enum | Defines whether the command module is single character or full command read
SYS_CMD_INIT | Struct | Identifies the system command initialize structure
SYS_CMD_DEVICE_NODE | Struct | Defines the data structure to store each command instance
SYS_CMD_FNC | Typedef | Identifies the command process function API
SYS_CMD_DESCRIPTOR | Struct | Defines the descriptor structure for a single command process