at.h

浏览该文件的文档.

 
#ifndef AT_H
#define AT_H
 
#include <stdint.h>
#include <stdbool.h>
#include "at_config.h"
 
#ifdef __cplusplus
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#define AT_RESPONSE_OK "OK\r\n"
#define AT_RESPONSE_ERROR "ERROR\r\n"
#define AT_RESPONSE_BUSY "BUSY\r\n"
#define AT_RESPONSE_ABORTING "ABORTING\r\n"
 
/* AT FLAG indicates the AT command feature. */
#define AT_FLAG_NONE                    0x0
#define AT_FLAG_ABORTABLE               0x10
#define AT_FLAG_NOT_BLOCK_URC           0x200
 
typedef enum {
    AT_RET_OK = 0,
    AT_RET_SYNTAX_ERROR,
    AT_RET_MALLOC_ERROR,
    AT_RET_MEM_API_ERROR,
    AT_RET_CHANNEL_PARA_ERROR,
    AT_RET_CHANNEL_NOT_INIT,
    AT_RET_CHANNEL_DATA_NULL,
    AT_RET_CMD_PARA_ERROR,
    AT_RET_CMD_FORMAT_ERROR,
    AT_RET_CMD_NO_MATCH,
    AT_RET_CMD_TYPE_ERROR,
    AT_RET_CMD_IN_PROGRESS_BLOCK,
    AT_RET_CMD_ATTR_NOT_ALLOW,
    AT_RET_PROC_CMD_FUNC_MISSING,
    AT_RET_PROC_READ_FUNC_MISSING,
    AT_RET_PROC_TEST_FUNC_MISSING,
    AT_RET_PROC_SET_FUNC_MISSING,
    AT_RET_PROC_WAIT_INTERACTIVITY,
    AT_RET_PROC_ABORT_CURRENT_COMMAND,
    AT_RET_PARSE_PARA_ERROR,
    AT_RET_PARSE_PARA_MISSING_ERROR,
    AT_RET_PROGRESS_BLOCK,
    AT_RET_TIMER_ERROR,
    AT_RET_ABORT_DELAY
} at_ret_t;
 
typedef enum {
    AT_CMD_TYPE_CMD = 0x00,    
    AT_CMD_TYPE_SET,           
    AT_CMD_TYPE_READ,          
    AT_CMD_TYPE_TEST,          
#ifdef CONFIG_AT_SUPPORT_QUERY
    AT_CMD_TYPE_QUERY,         
#endif
    AT_CMD_TYPE_ERROR
} at_cmd_type_t;
 
typedef at_ret_t(*at_abort_func_t)(void *arg);
 
typedef at_ret_t(*at_interactivity_func_t)(const char *data, uint32_t len);
 
typedef at_ret_t(*at_cmd_func_t)(void);
 
typedef at_ret_t(*at_set_func_t)(const void *arg);
 
typedef at_ret_t(*at_read_func_t)(void);
 
typedef at_ret_t(*at_test_func_t)(void);
 
#ifdef CONFIG_AT_SUPPORT_QUERY
typedef at_ret_t(*at_query_func_t)(const void *arg);
#endif
 
typedef struct {
    int32_t min_val;
    int32_t max_val;
} at_token_int_range_t;
 
typedef struct {
    uint32_t num;
    const int32_t *values;
} at_token_int_list_t;
 
typedef struct {
    uint32_t max_length;
} at_token_string_t;
 
typedef struct {
    uint32_t num;
    const uint8_t * const *values;
} at_token_string_values_t;
 
typedef struct {
    uint32_t max_value;
} at_token_bit_string_range_t;
 
typedef struct {
    uint32_t num;
    const uint32_t *values;
} at_token_bit_string_list_t;
 
typedef struct {
    uint32_t length_field_offset;
    uint32_t max_length;
} at_token_hex_string_t;
 
typedef enum {
    AT_SYNTAX_TYPE_INT,
    AT_SYNTAX_TYPE_STRING,
    AT_SYNTAX_TYPE_BIT_STRING,
    AT_SYNTAX_TYPE_OCTET_STRING,
    AT_SYNTAX_TYPE_NUM
} at_syntax_type_t;
 
typedef enum {
    AT_SYNTAX_ATTR_NOT_SUPPORTED    = 0x0001,
    AT_SYNTAX_ATTR_OPTIONAL         = 0x0002,
    AT_SYNTAX_ATTR_AT_MIN_VALUE     = 0x0004,
    AT_SYNTAX_ATTR_AT_MAX_VALUE     = 0x0008,
    AT_SYNTAX_ATTR_LIST_VALUE       = 0x0010,
    AT_SYNTAX_ATTR_MAX_LENGTH       = 0x0020,
    AT_SYNTAX_ATTR_ADD_LENGTH       = 0x0040,
    AT_SYNTAX_ATTR_FIX_CASE         = 0x0080,
    AT_SYNTAX_ATTR_LENGTH_FIELD     = 0x0100
} at_syntax_attribute_t;
 
typedef struct {
    uint32_t type : 4;    
    uint32_t last : 1;    
    uint32_t attribute : 12;    
    uint32_t offset : 15;    
    union {
        at_token_int_range_t int_range;
        at_token_int_list_t  int_list;
        at_token_string_t string;
        at_token_string_values_t string_list;
        at_token_bit_string_range_t bit_string_range;
        at_token_bit_string_list_t bit_string_list;
        at_token_hex_string_t octet_string;
    } entry;
} at_para_parse_syntax_t;
 
typedef struct {
    const char *name;    
    const uint16_t cmd_id;    
    const uint16_t attribute;
    const at_para_parse_syntax_t *syntax;
    at_cmd_func_t cmd;
    at_set_func_t set;
    at_read_func_t read;
    at_test_func_t test;
#ifdef CONFIG_AT_SUPPORT_QUERY
    at_query_func_t query;
#endif
} at_cmd_entry_t;
 
errcode_t uapi_at_cmd_table_register(const at_cmd_entry_t *table, uint32_t len,
                                     uint32_t struct_max_size);
 
#ifdef CONFIG_AT_SUPPORT_ASYNCHRONOUS
errcode_t uapi_at_cmd_abort_register(at_abort_func_t func, void *arg);
 
errcode_t uapi_at_send_async_result(uint16_t err);
 
errcode_t uapi_at_interactivity_func_register(at_interactivity_func_t func);
#endif
 
void uapi_at_report(const char *str);
 
void uapi_at_report_to_single_channel(at_channel_id_t channel_id, const char *str);
 
#ifdef CONFIG_AT_SUPPORT_NOTIFY_REPORT
errcode_t uapi_at_urc_to_channel(at_channel_id_t channel_id, const char *msg, uint32_t msg_len);
#endif
 
#ifdef __cplusplus
#if __cplusplus
}
#endif /* __cplusplus */
#endif /* __cplusplus */
 
#endif