| | |
| | | * Copyright (c) 2012 Jan Breuer |
| | | * |
| | | * All Rights Reserved |
| | | * |
| | | * |
| | | * Redistribution and use in source and binary forms, with or without |
| | | * modification, are permitted provided that the following conditions are |
| | | * met: |
| | |
| | | * 2. Redistributions in binary form must reproduce the above copyright |
| | | * notice, this list of conditions and the following disclaimer in the |
| | | * documentation and/or other materials provided with the distribution. |
| | | * |
| | | * |
| | | * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR |
| | | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED |
| | | * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| | |
| | | /** |
| | | * @file scpi_types.h |
| | | * @date Thu Nov 15 10:58:45 UTC 2012 |
| | | * |
| | | * |
| | | * @brief SCPI data types |
| | | * |
| | | * |
| | | * |
| | | * |
| | | */ |
| | | |
| | | #ifndef SCPI_TYPES_H |
| | |
| | | |
| | | #include <stddef.h> |
| | | #include <stdint.h> |
| | | #include "scpi/config.h" |
| | | |
| | | #if HAVE_STDBOOL |
| | | #include <stdbool.h> |
| | | #endif |
| | | |
| | | #ifdef __cplusplus |
| | | extern "C" { |
| | | #endif |
| | | |
| | | #if !HAVE_STDBOOL |
| | | typedef unsigned char bool; |
| | | #endif |
| | | |
| | | #ifndef FALSE |
| | | #define FALSE 0 |
| | | #define FALSE 0 |
| | | #endif |
| | | #ifndef TRUE |
| | | #define TRUE (!FALSE) |
| | | #define TRUE (!FALSE) |
| | | #endif |
| | | |
| | | /* basic data types */ |
| | |
| | | |
| | | typedef struct _scpi_command_t scpi_command_t; |
| | | |
| | | #define SCPI_CMD_LIST_END {NULL, NULL, } |
| | | #define SCPI_CMD_LIST_END {NULL, NULL, 0} |
| | | |
| | | /* scpi interface */ |
| | | typedef struct _scpi_t scpi_t; |
| | |
| | | char * data; |
| | | }; |
| | | typedef struct _scpi_buffer_t scpi_buffer_t; |
| | | |
| | | |
| | | struct _scpi_const_buffer_t { |
| | | size_t length; |
| | | size_t position; |
| | |
| | | |
| | | /* scpi lexer */ |
| | | enum _scpi_token_type_t { |
| | | TokComma, |
| | | TokSemicolon, |
| | | TokQuiestion, |
| | | TokNewLine, |
| | | TokHexnum, |
| | | TokOctnum, |
| | | TokBinnum, |
| | | TokProgramMnemonic, |
| | | TokDecimalNumericProgramData, |
| | | TokDecimalNumericProgramDataWithSuffix, |
| | | TokSuffixProgramData, |
| | | TokArbitraryBlockProgramData, |
| | | TokSingleQuoteProgramData, |
| | | TokDoubleQuoteProgramData, |
| | | TokProgramExpression, |
| | | TokCompoundProgramHeader, |
| | | TokIncompleteCompoundProgramHeader, |
| | | TokCommonProgramHeader, |
| | | TokIncompleteCommonProgramHeader, |
| | | TokCompoundQueryProgramHeader, |
| | | TokCommonQueryProgramHeader, |
| | | TokWhiteSpace, |
| | | TokAllProgramData, |
| | | TokInvalid, |
| | | TokUnknown, |
| | | SCPI_TOKEN_COMMA, |
| | | SCPI_TOKEN_SEMICOLON, |
| | | SCPI_TOKEN_COLON, |
| | | SCPI_TOKEN_SPECIFIC_CHARACTER, |
| | | SCPI_TOKEN_QUESTION, |
| | | SCPI_TOKEN_NL, |
| | | SCPI_TOKEN_HEXNUM, |
| | | SCPI_TOKEN_OCTNUM, |
| | | SCPI_TOKEN_BINNUM, |
| | | SCPI_TOKEN_PROGRAM_MNEMONIC, |
| | | SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA, |
| | | SCPI_TOKEN_DECIMAL_NUMERIC_PROGRAM_DATA_WITH_SUFFIX, |
| | | SCPI_TOKEN_SUFFIX_PROGRAM_DATA, |
| | | SCPI_TOKEN_ARBITRARY_BLOCK_PROGRAM_DATA, |
| | | SCPI_TOKEN_SINGLE_QUOTE_PROGRAM_DATA, |
| | | SCPI_TOKEN_DOUBLE_QUOTE_PROGRAM_DATA, |
| | | SCPI_TOKEN_PROGRAM_EXPRESSION, |
| | | SCPI_TOKEN_COMPOUND_PROGRAM_HEADER, |
| | | SCPI_TOKEN_INCOMPLETE_COMPOUND_PROGRAM_HEADER, |
| | | SCPI_TOKEN_COMMON_PROGRAM_HEADER, |
| | | SCPI_TOKEN_INCOMPLETE_COMMON_PROGRAM_HEADER, |
| | | SCPI_TOKEN_COMPOUND_QUERY_PROGRAM_HEADER, |
| | | SCPI_TOKEN_COMMON_QUERY_PROGRAM_HEADER, |
| | | SCPI_TOKEN_WS, |
| | | SCPI_TOKEN_ALL_PROGRAM_DATA, |
| | | SCPI_TOKEN_INVALID, |
| | | SCPI_TOKEN_UNKNOWN, |
| | | }; |
| | | typedef enum _scpi_token_type_t scpi_token_type_t; |
| | | |
| | | struct _scpi_token_t { |
| | | scpi_token_type_t type; |
| | | const char * ptr; |
| | | char * ptr; |
| | | int len; |
| | | }; |
| | | typedef struct _scpi_token_t scpi_token_t; |
| | | |
| | | struct _lex_state_t { |
| | | const char * buffer; |
| | | const char * pos; |
| | | char * buffer; |
| | | char * pos; |
| | | int len; |
| | | }; |
| | | typedef struct _lex_state_t lex_state_t; |
| | | |
| | | /* scpi parser */ |
| | | /* scpi parser */ |
| | | enum _message_termination_t { |
| | | PmutNone, |
| | | PmutNewLine, |
| | | PmutSemicolon, |
| | | SCPI_MESSAGE_TERMINATION_NONE, |
| | | SCPI_MESSAGE_TERMINATION_NL, |
| | | SCPI_MESSAGE_TERMINATION_SEMICOLON, |
| | | }; |
| | | typedef enum _message_termination_t message_termination_t; |
| | | |
| | | |
| | | struct _scpi_parser_state_t { |
| | | scpi_token_t programHeader; |
| | | scpi_token_t programData; |
| | |
| | | SCPI_NUM_DOWN, |
| | | SCPI_NUM_NAN, |
| | | SCPI_NUM_INF, |
| | | SCPI_NUM_NINF |
| | | SCPI_NUM_NINF, |
| | | SCPI_NUM_AUTO |
| | | }; |
| | | typedef enum _scpi_special_number_t scpi_special_number_t; |
| | | |
| | | struct _scpi_special_number_def_t { |
| | | struct _scpi_choice_def_t { |
| | | const char * name; |
| | | scpi_special_number_t type; |
| | | int32_t tag; |
| | | }; |
| | | #define SCPI_SPECIAL_NUMBERS_LIST_END {NULL, SCPI_NUM_NUMBER} |
| | | typedef struct _scpi_special_number_def_t scpi_special_number_def_t; |
| | | #define SCPI_CHOICE_LIST_END {NULL, -1} |
| | | typedef struct _scpi_choice_def_t scpi_choice_def_t; |
| | | |
| | | struct _scpi_param_list_t { |
| | | const scpi_command_t * cmd; |
| | | lex_state_t lex_state; |
| | | scpi_const_buffer_t cmd_raw; |
| | | }; |
| | | typedef struct _scpi_param_list_t scpi_param_list_t; |
| | | |
| | | typedef struct _scpi_param_list_t scpi_param_list_t; |
| | | |
| | | struct _scpi_number_parameter_t { |
| | | double value; |
| | | scpi_bool_t special; |
| | | |
| | | union { |
| | | double value; |
| | | int32_t tag; |
| | | }; |
| | | scpi_unit_t unit; |
| | | int8_t base; |
| | | scpi_special_number_t type; |
| | | }; |
| | | typedef struct _scpi_number_parameter_t scpi_number_t; |
| | | |
| | | struct _scpi_data_parameter_t { |
| | | const char * ptr; |
| | | int32_t len; |
| | | int32_t len; |
| | | }; |
| | | typedef struct _scpi_data_parameter_t scpi_data_parameter_t; |
| | | |
| | | struct _scpi_parameter_t { |
| | | scpi_token_type_t type; |
| | | scpi_data_parameter_t data; |
| | | scpi_number_t number; |
| | | }; |
| | | typedef struct _scpi_parameter_t scpi_parameter_t; |
| | | |
| | | |
| | | typedef scpi_token_t scpi_parameter_t; |
| | | |
| | | struct _scpi_command_t { |
| | | const char * pattern; |
| | | scpi_command_callback_t callback; |
| | | #if USE_COMMAND_TAGS |
| | | int32_t tag; |
| | | #endif /* USE_COMMAND_TAGS */ |
| | | }; |
| | | |
| | | struct _scpi_interface_t { |
| | |
| | | scpi_write_control_t control; |
| | | scpi_command_callback_t flush; |
| | | scpi_command_callback_t reset; |
| | | scpi_command_callback_t test; |
| | | }; |
| | | |
| | | struct _scpi_t { |
| | |
| | | scpi_error_queue_t error_queue; |
| | | scpi_reg_val_t * registers; |
| | | const scpi_unit_def_t * units; |
| | | const scpi_special_number_def_t * special_numbers; |
| | | void * user_context; |
| | | scpi_parser_state_t parser_state; |
| | | const char * idn[4]; |
| | | size_t arbitrary_reminding; |
| | | }; |
| | | |
| | | enum _scpi_array_format_t { |
| | | SCPI_FORMAT_ASCII = 0, |
| | | SCPI_FORMAT_NORMAL = 1, |
| | | SCPI_FORMAT_SWAPPED = 2, |
| | | SCPI_FORMAT_BIGENDIAN = SCPI_FORMAT_NORMAL, |
| | | SCPI_FORMAT_LITTLEENDIAN = SCPI_FORMAT_SWAPPED, |
| | | }; |
| | | typedef enum _scpi_array_format_t scpi_array_format_t; |
| | | |
| | | #ifdef __cplusplus |
| | | } |
| | | #endif |