ketCube_terminal_common.h

Go to the documentation of this file.

 
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef __KETCUBE_TERMINAL_COMMON_H
#define __KETCUBE_TERMINAL_COMMON_H
 
#include <stdlib.h>
#include <string.h>
#include "ketCube_common.h"
#include "ketCube_cfg.h"
#include "ketCube_module_id.h"
 
typedef enum ketCube_terminal_command_opcode_t {
    KETCUBE_TERMINAL_OPCODE_CMD = 0,
    KETCUBE_TERMINAL_OPCODE_BATCH = 1,
} ketCube_terminal_command_opcode_t;
 
typedef enum ketCube_terminal_command_errorCode_t {
    KETCUBE_TERMINAL_CMD_ERR_OK = 0,
    KETCUBE_TERMINAL_CMD_ERR_INVALID_PARAMS,
    KETCUBE_TERMINAL_CMD_ERR_MEMORY_IO_FAIL,
    
    // remote terminal-related return codes
    KETCUBE_TERMINAL_CMD_ERR_COMMAND_NOT_FOUND,
    KETCUBE_TERMINAL_CMD_ERR_MODULE_NOT_FOUND,
    KETCUBE_TERMINAL_CMD_ERR_FAILED_CONTEXT,
    KETCUBE_TERMINAL_CMD_ERR_UNSPECIFIED_ERROR,
    KETCUBE_TERMINAL_CMD_ERR_NOT_SUPPORTED,
    KETCUBE_TERMINAL_CMD_ERR_CORE_API_MISMATCH,
} ketCube_terminal_command_errorCode_t;
 
typedef struct ketCube_terminal_command_flags_t {
    /* Record groups */
    bool isGroup:1;           
    
    /* Command origin */
    bool isLocal:1;           
    bool isRemote:1;          
    
    /* Command type */
    bool isEnvCmd:1;          
    bool isSetCmd:1;          
    bool isShowCmd:1;         
    
    /* Storage region -- for SET/SHOW commands */
    bool isEEPROM:1;          
    bool isRAM:1;             
    
    /* Command specifier */
    bool isGeneric:1;         
} ketCube_terminal_command_flags_t;
 
static inline void ketCube_terminal_andCmdFlags(
    ketCube_terminal_command_flags_t * out,
    ketCube_terminal_command_flags_t * in1,
    ketCube_terminal_command_flags_t * in2)
{
    out->isGroup   = in1->isGroup   && in2->isGroup;
    
    out->isLocal   = in1->isLocal   && in2->isLocal;
    out->isRemote  = in1->isRemote  && in2->isRemote;
    
    out->isEnvCmd  = in1->isEnvCmd  && in2->isEnvCmd;
    out->isSetCmd  = in1->isSetCmd  && in2->isSetCmd;
    out->isShowCmd = in1->isShowCmd && in2->isShowCmd;
    
    out->isEEPROM  = in1->isEEPROM  && in2->isEEPROM;
    out->isRAM     = in1->isRAM     && in2->isRAM;
    
    out->isGeneric = in1->isGeneric && in2->isGeneric;
}
 
typedef enum ketCube_terminal_cmdCheckResult_t {
    KETCUBE_CMD_CHECK_OK,
    KETCUBE_CMD_CHECK_FAILED_DEFINITION,
    KETCUBE_CMD_CHECK_FAILED_CONTEXT_ONLY_LOCAL,
    KETCUBE_CMD_CHECK_FAILED_CONTEXT_ONLY_REMOTE,
} ketCube_terminal_cmdCheckResult_t;
 
typedef enum ketCube_terminal_paramSet_type_t {
    KETCUBE_TERMINAL_PARAMS_NONE = 0,
    KETCUBE_TERMINAL_PARAMS_BOOLEAN,
    KETCUBE_TERMINAL_PARAMS_STRING,
    KETCUBE_TERMINAL_PARAMS_BYTE,
    KETCUBE_TERMINAL_PARAMS_MODULEID,
    KETCUBE_TERMINAL_PARAMS_INT32,
    KETCUBE_TERMINAL_PARAMS_UINT32,
    KETCUBE_TERMINAL_PARAMS_INT32_PAIR,
    KETCUBE_TERMINAL_PARAMS_BYTE_ARRAY
} ketCube_terminal_paramSet_type_t;
 
/* Maximum length of string returned by command */
#define KETCUBE_TERMINAL_PARAM_STR_MAX_LENGTH               64
#define KETCUBE_TERMINAL_PARAM_BYTE_ARRAY_MAX_LENGTH        32
 
#pragma pack(push, 1)
 
typedef union ketCube_terminal_paramSet_t {
    /* KETCUBE_TERMINAL_PARAMS_BOOLEAN */
    bool as_bool;
    /* KETCUBE_TERMINAL_PARAMS_BYTE */
    uint8_t as_byte;
    /* KETCUBE_TERMINAL_PARAMS_MODULEID */
    struct {
        uint16_t module_id;
        ketCube_severity_t severity;
    } as_module_id;
    /* KETCUBE_TERMINAL_PARAMS_INT32 */
    int as_int32;
    /* KETCUBE_TERMINAL_PARAMS_UINT32 */
    int as_uint32;
    /* KETCUBE_TERMINAL_PARAMS_STRING */
    char as_string[KETCUBE_TERMINAL_PARAM_STR_MAX_LENGTH];
    /* KETCUBE_TERMINAL_PARAMS_INT32_PAIR */
    struct {
        int first;
        int second;
    } as_int32_pair;
    struct {
        byte data[KETCUBE_TERMINAL_PARAM_BYTE_ARRAY_MAX_LENGTH];
        uint16_t length;
    } as_byte_array;
} ketCube_terminal_paramSet_t;
 
typedef struct ketCube_remoteTerminal_packet_header_t {
    uint8_t opcode : 2;             // 2 bit opcode
    uint8_t is_16b_moduleid : 1;    // flag - is moduleid 16 bit?
    uint8_t rfu : 1;                // flag - RFU
    uint8_t seq : 4;                // sequence number (4 bits)
    uint8_t coreApiVersion;         // core API version (always 8bit)
} ketCube_remoteTerminal_packet_header_t;
 
typedef struct ketCube_remoteTerminal_single_cmd_header_t {
    union {
        uint8_t moduleId_8bit;      // 8bit module ID
        uint16_t moduleId_16bit;    // 16bit module ID
    } module_id;  // length determined by common header is_16b_moduleid flag
} ketCube_remoteTerminal_single_cmd_header_t;
 
typedef struct ketCube_remoteTerminal_batch_cmd_header_t {
    uint8_t length;             // length of batch block (single cmd)
    ketCube_remoteTerminal_single_cmd_header_t cmdHeader;
                                // batch command always comprises a single cmd
} ketCube_remoteTerminal_batch_cmd_header_t;
 
#pragma pack(pop)
 
extern ketCube_terminal_paramSet_t commandIOParams;
extern ketCube_terminal_command_errorCode_t commandErrorCode;
 
static inline int ketCube_terminal_ParamSetTypeToCount(
    ketCube_terminal_paramSet_type_t type)
{
    switch (type)
    {
        case KETCUBE_TERMINAL_PARAMS_NONE:
        default:
            return 0;
        case KETCUBE_TERMINAL_PARAMS_BOOLEAN:
        case KETCUBE_TERMINAL_PARAMS_BYTE:
        case KETCUBE_TERMINAL_PARAMS_STRING:
        case KETCUBE_TERMINAL_PARAMS_INT32:
        case KETCUBE_TERMINAL_PARAMS_UINT32:
        case KETCUBE_TERMINAL_PARAMS_BYTE_ARRAY:
        case KETCUBE_TERMINAL_PARAMS_MODULEID:
            return 1;
        case KETCUBE_TERMINAL_PARAMS_INT32_PAIR:
            return 2;
    }
}
 
 
static inline int ketCube_terminal_GetIOParamsMinStaticLength(
    ketCube_terminal_paramSet_type_t type)
{
    switch (type)
    {
        case KETCUBE_TERMINAL_PARAMS_NONE:
        default:
            return 0;
        case KETCUBE_TERMINAL_PARAMS_BOOLEAN:
            return sizeof(bool);
        case KETCUBE_TERMINAL_PARAMS_BYTE:
            return sizeof(uint8_t);
        case KETCUBE_TERMINAL_PARAMS_MODULEID:
            return sizeof(uint16_t) + 1;
        case KETCUBE_TERMINAL_PARAMS_STRING:
            return 1; /* at least null terminator */
        case KETCUBE_TERMINAL_PARAMS_INT32:
            return sizeof(int32_t);
        case KETCUBE_TERMINAL_PARAMS_UINT32:
            return sizeof(uint32_t);
        case KETCUBE_TERMINAL_PARAMS_INT32_PAIR:
            return (2 * sizeof(int));
        case KETCUBE_TERMINAL_PARAMS_BYTE_ARRAY:
            return 0;
    }
}
 
static inline int ketCube_terminal_GetIOParamsLength(
    ketCube_terminal_paramSet_type_t type)
{
    int len = ketCube_terminal_GetIOParamsMinStaticLength(type);
    
    switch (type)
    {
        default:
            return len;
        case KETCUBE_TERMINAL_PARAMS_STRING:
            return (int)strlen(commandIOParams.as_string);
        case KETCUBE_TERMINAL_PARAMS_BYTE_ARRAY:
            return (int)commandIOParams.as_byte_array.length;
    }
}
 
typedef struct ketCube_terminal_cmd_t {
    char * cmd;                       
    char * descr;                     
    ketCube_terminal_command_flags_t flags;           
    ketCube_terminal_paramSet_type_t outputSetType;   
    ketCube_terminal_paramSet_type_t paramSetType;    
    union
    {
        void (*callback) (void);                      
        struct ketCube_terminal_cmd_t * subCmdList;   
        struct ketCube_cfg_varDescr_t * cfgVarPtr;    
    } settingsPtr;                    
    ketCube_moduleID_t moduleId;
} ketCube_terminal_cmd_t;
 
extern ketCube_terminal_cmd_t ketCube_terminal_commands[];
 
extern void ketCube_terminal_printCmdList(ketCube_terminal_cmd_t * parent,
                                   ketCube_terminal_cmd_t * cmdList,
                                   ketCube_terminal_command_flags_t * contextFlags);
 
extern ketCube_terminal_cmdCheckResult_t ketCube_terminal_checkCmdContext(
    ketCube_terminal_cmd_t* command, bool local);
extern bool ketCube_terminal_checkCmdSubtreeContext(
    ketCube_terminal_command_flags_t* flags);
 
extern void ketCube_terminal_execute(ketCube_terminal_cmd_t* cmd,
    ketCube_terminal_command_flags_t activeFlags);
 
#endif