![]() |
Cordio Stack and Cordio Profiles
r2p3-02rel0
|
Terminal handler. More...
Go to the source code of this file.
Data Structures | |
struct | terminalCommand_t |
Terminal command. More... | |
Macros | |
#define | TERMINAL_MAX_ARGC 8u |
Maximum number of arguments to any command. | |
#define | TERMINAL_MAX_COMMAND_LEN 100u |
Maximum length of command line. | |
#define | TERMINAL_PRINTF_MAX_LEN 128u |
Maximum length of any printed output. | |
#define | TERMINAL_STRING_PROMPT "> " |
Prompt string. | |
#define | TERMINAL_STRING_ERROR "ERROR: " |
Error prefix. | |
#define | TERMINAL_STRING_USAGE "USAGE: " |
Usage prefix. | |
#define | TERMINAL_STRING_NEW_LINE "\r\n" |
New line string. | |
Typedefs | |
typedef uint8_t(* | terminalHandler_t) (uint32_t argc, char **argv) |
Handler for a terminal command. More... | |
typedef void(* | terminalUartTx_t) (const uint8_t *pBuf, uint32_t len) |
Handler for transmit. More... | |
Enumerations | |
enum | { TERMINAL_ERROR_OK = 0, TERMINAL_ERROR_BAD_ARGUMENTS = 1, TERMINAL_ERROR_TOO_FEW_ARGUMENTS = 2, TERMINAL_ERROR_TOO_MANY_ARGUMENTS = 3, TERMINAL_ERROR_EXEC = 4 } |
Terminal command error codes. More... | |
Functions | |
void | TerminalInit (wsfHandlerId_t handlerId) |
Initialize terminal. More... | |
void | TerminalRegisterUartTxFunc (terminalUartTx_t uartTxFunc) |
Register the UART Tx Function for the platform. More... | |
void | TerminalRegisterCommand (terminalCommand_t *pCommand) |
Register command with terminal. More... | |
void | TerminalHandler (wsfEventMask_t event, wsfMsgHdr_t *pMsg) |
Handler for terminal messages. More... | |
void | TerminalRx (uint8_t dataByte) |
Called by application when a data byte is received. More... | |
void | TerminalTxStr (const char *pStr) |
Called by application to transmit string. More... | |
void | TerminalTxChar (char c) |
Called by application to transmit character. More... | |
void | TerminalTxPrint (const char *pStr,...) |
Called by application to print formatted data. More... | |
void | TerminalTx (const uint8_t *pData, uint16_t len) |
Application function to transmit data.. More... | |
Terminal handler.
Copyright (c) 2015-2018 Arm Ltd. All Rights Reserved. Arm Ltd. confidential and proprietary.
IMPORTANT. Your use of this file is governed by a Software License Agreement ("Agreement") that must be accepted in order to download or otherwise receive a copy of this file. You may not use or copy this file for any purpose other than as described in the Agreement. If you do not agree to all of the terms of the Agreement do not use this file and delete all copies in your possession or control; if you do not have a copy of the Agreement, you must contact Arm Ltd. prior to any use, copying or further distribution of this software.
Definition in file terminal.h.