Add new AUTO special value, resolve #20

Jan Breuer

2015-03-18 323ec66d62f19673e66762fe25585746d3b2a5e0

 libscpi/inc/scpi/types.h

@@ -1,5 +1,7 @@
/*-
 * Copyright (c) 2012-2013 Jan Breuer,
 * Copyright (c) 2013 Jan Breuer
 *                    Richard.hmm
 * Copyright (c) 2012 Jan Breuer
 *
 * All Rights Reserved
 * 
@@ -35,92 +37,111 @@
 */

#ifndef SCPI_TYPES_H
#define   SCPI_TYPES_H
#define SCPI_TYPES_H

#include <stddef.h>
#include <stdint.h>
#include <stdbool.h>

#ifdef   __cplusplus
#ifdef  __cplusplus
extern "C" {
#endif

#define FALSE false
#define TRUE true
#ifndef FALSE
    #define FALSE 0
#endif
#ifndef TRUE
    #define TRUE (!FALSE)
#endif

    /* basic data types */
    typedef bool bool_t;
    //typedef enum { FALSE = 0, TRUE } bool_t;

    /* scpi interface */
    typedef struct _scpi_t scpi_t;
    typedef struct _scpi_interface_t scpi_interface_t;
    typedef struct _scpi_buffer_t scpi_buffer_t;
    typedef size_t(*scpi_write_t)(scpi_t * context, const char * data, size_t len);
    typedef int (*scpi_error_callback_t)(scpi_t * context, int_fast16_t error);

    /* scpi commands */
    typedef enum _scpi_result_t scpi_result_t;
    typedef struct _scpi_param_list_t scpi_param_list_t;
    typedef struct _scpi_command_t scpi_command_t;
    typedef scpi_result_t(*scpi_command_callback_t)(scpi_t *);

    /* scpi error queue */
    typedef void * scpi_error_queue_t;

    /* scpi units */
    typedef enum _scpi_unit_t scpi_unit_t;
    typedef struct _scpi_unit_def_t scpi_unit_def_t;
    typedef enum _scpi_special_number_t scpi_special_number_t;
    typedef struct _scpi_special_number_def_t scpi_special_number_def_t;
    typedef struct _scpi_number_t scpi_number_t;
    typedef bool scpi_bool_t;
    /* typedef enum { FALSE = 0, TRUE } scpi_bool_t; */

    /* IEEE 488.2 registers */
    enum _scpi_reg_name_t {
        SCPI_REG_STB = 0, /* Status Byte */
        SCPI_REG_SRE,     /* Service Request Enable Register */
        SCPI_REG_ESR,     /* Standard Event Status Register (ESR, SESR) */
        SCPI_REG_ESE,     /* Event Status Enable Register */
        SCPI_REG_OPER,    /* OPERation Status Register */
        SCPI_REG_OPERE,   /* OPERation Status Enable Register */
        SCPI_REG_QUES,    /* QUEStionable status register */
        SCPI_REG_QUESE,   /* QUEStionable status Enable Register */

        /* last definition - number of registers */
        SCPI_REG_COUNT
    };
    typedef enum _scpi_reg_name_t scpi_reg_name_t;

    enum _scpi_ctrl_name_t {
        SCPI_CTRL_SRQ = 1, /* service request */
        SCPI_CTRL_GTL,     /* Go to local */
        SCPI_CTRL_SDC,     /* Selected device clear */
        SCPI_CTRL_PPC,     /* Parallel poll configure */
        SCPI_CTRL_GET,     /* Group execute trigger */
        SCPI_CTRL_TCT,     /* Take control */
        SCPI_CTRL_LLO,     /* Device clear */
        SCPI_CTRL_DCL,     /* Local lockout */
        SCPI_CTRL_PPU,     /* Parallel poll unconfigure */
        SCPI_CTRL_SPE,     /* Serial poll enable */
        SCPI_CTRL_SPD,     /* Serial poll disable */
        SCPI_CTRL_MLA,     /* My local address */
        SCPI_CTRL_UNL,     /* Unlisten */
        SCPI_CTRL_MTA,     /* My talk address */
        SCPI_CTRL_UNT,     /* Untalk */
        SCPI_CTRL_MSA      /* My secondary address */
    };
    typedef enum _scpi_ctrl_name_t scpi_ctrl_name_t;

    typedef uint16_t scpi_reg_val_t;
    
    struct _scpi_param_list_t {
        const scpi_command_t * cmd;
        const char * parameters;
        size_t length;

    /* scpi commands */
    enum _scpi_result_t {
        SCPI_RES_OK = 1,
        SCPI_RES_ERR = -1
    };
    typedef enum _scpi_result_t scpi_result_t;


#define SCPI_CMD_LIST_END       {.pattern = NULL, .callback = NULL, }

    struct _scpi_command_t {
        const char * pattern;
        scpi_command_callback_t callback;
    };
    typedef struct _scpi_command_t scpi_command_t;

    struct _scpi_buffer_t {
        size_t length;
        size_t position;
        char * data;
    };

    struct _scpi_interface_t {
        scpi_error_callback_t error;
        scpi_write_t write;
        scpi_command_callback_t reset;
        scpi_command_callback_t test;
        scpi_command_callback_t srq;
    typedef struct _scpi_buffer_t scpi_buffer_t;
    
    struct _scpi_const_buffer_t {
        size_t length;
        size_t position;
        const char * data;
    };
    typedef struct _scpi_const_buffer_t scpi_const_buffer_t;    

    struct _scpi_t {
        const scpi_command_t * cmdlist;
        scpi_buffer_t buffer;
        scpi_param_list_t paramlist;
        scpi_interface_t * interface;
        int_fast16_t output_count;
        int_fast16_t input_count;
        bool_t cmd_error;
        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;
    struct _scpi_param_list_t {
        const scpi_command_t * cmd;
        const char * parameters;
        size_t length;
        scpi_const_buffer_t cmd_raw;
    };
    #define SCPI_CMD_LIST_END       {NULL, NULL, }
    typedef struct _scpi_param_list_t scpi_param_list_t;

    /* scpi interface */
    typedef struct _scpi_t scpi_t;
    typedef struct _scpi_interface_t scpi_interface_t;

    typedef size_t(*scpi_write_t)(scpi_t * context, const char * data, size_t len);
    typedef scpi_result_t(*scpi_write_control_t)(scpi_t * context, scpi_ctrl_name_t ctrl, scpi_reg_val_t val);
    typedef int (*scpi_error_callback_t)(scpi_t * context, int_fast16_t error);

    typedef scpi_result_t(*scpi_command_callback_t)(scpi_t *);

    /* scpi error queue */
    typedef void * scpi_error_queue_t;

    /* scpi units */
    enum _scpi_unit_t {
        SCPI_UNIT_NONE,
        SCPI_UNIT_VOLT,
@@ -129,16 +150,17 @@
        SCPI_UNIT_HERTZ,
        SCPI_UNIT_CELSIUS,
        SCPI_UNIT_SECONDS,
        SCPI_UNIT_DISTANCE
    };


#define SCPI_UNITS_LIST_END       {.name = NULL, .unit = SCPI_UNIT_NONE, .mult = 0}
    typedef enum _scpi_unit_t scpi_unit_t;

    struct _scpi_unit_def_t {
        const char * name;
        scpi_unit_t unit;
        double mult;
    };
    #define SCPI_UNITS_LIST_END       {NULL, SCPI_UNIT_NONE, 0}
    typedef struct _scpi_unit_def_t scpi_unit_def_t;

    enum _scpi_special_number_t {
        SCPI_NUM_NUMBER,
@@ -150,45 +172,57 @@
        SCPI_NUM_NAN,
        SCPI_NUM_INF,
        SCPI_NUM_NINF,
        SCPI_NUM_AUTO
    };

#define SCPI_SPECIAL_NUMBERS_LIST_END   {.name = NULL, .type = SCPI_NUM_NUMBER}    
    typedef enum _scpi_special_number_t scpi_special_number_t;

    struct _scpi_special_number_def_t {
        const char * name;
        scpi_special_number_t type;
    };
    #define SCPI_SPECIAL_NUMBERS_LIST_END   {NULL, SCPI_NUM_NUMBER}    
    typedef struct _scpi_special_number_def_t scpi_special_number_def_t;

    struct _scpi_number_t {
        double value;
        scpi_unit_t unit;
        scpi_special_number_t type;
    };
    typedef struct _scpi_number_t scpi_number_t;

    enum _scpi_result_t {
        SCPI_RES_OK = 1,
        SCPI_RES_ERR = -1,
    struct _scpi_command_t {
        const char * pattern;
        scpi_command_callback_t callback;
    };


    enum _scpi_reg_name_t {
        SCPI_REG_STB = 0, // Status Byte
        SCPI_REG_SRE, // Service Request Enable Register
        SCPI_REG_ESR, // Standard Event Status Register (ESR, SESR)
        SCPI_REG_ESE, // Event Status Enable Register
        SCPI_REG_OPER, // OPERation Status Register
        SCPI_REG_OPERE, // OPERation Status Enable Register
        SCPI_REG_QUES, // QUEStionable status register
        SCPI_REG_QUESE, // QUEStionable status Enable Register

        /* last definition - number of registers */
        SCPI_REG_COUNT,
    struct _scpi_interface_t {
        scpi_error_callback_t error;
        scpi_write_t write;
        scpi_write_control_t control;
        scpi_command_callback_t flush;
        scpi_command_callback_t reset;
        scpi_command_callback_t test;
    };

    struct _scpi_t {
        const scpi_command_t * cmdlist;
        scpi_buffer_t buffer;
        scpi_param_list_t paramlist;
        scpi_interface_t * interface;
        int_fast16_t output_count;
        int_fast16_t input_count;
        scpi_bool_t cmd_error;
        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;
        const char * idn[4];
    };

#ifdef   __cplusplus
#ifdef  __cplusplus
}
#endif

#endif   /* SCPI_TYPES_H */
#endif  /* SCPI_TYPES_H */