X-Git-Url: https://sigrok.org/gitweb/?a=blobdiff_plain;f=hardware%2Fgmc-mh-1x-2x%2Fprotocol.h;h=9d742e3cb692e0a5bb36805cb994b5a534c1475e;hb=2cfd16a31672be2ef8227dcda407e8cc5a24607f;hp=799421d092f85e54d6746de301110ebb328d4ecb;hpb=7b4edcb654d6b36da4369bac3688ad77f6132766;p=libsigrok.git diff --git a/hardware/gmc-mh-1x-2x/protocol.h b/hardware/gmc-mh-1x-2x/protocol.h index 799421d0..9d742e3c 100644 --- a/hardware/gmc-mh-1x-2x/protocol.h +++ b/hardware/gmc-mh-1x-2x/protocol.h @@ -25,25 +25,94 @@ #include "libsigrok.h" #include "libsigrok-internal.h" -/* Message logging helpers with subsystem-specific prefix string. */ -#define LOG_PREFIX "gmc-mh-1x-2x: " -#define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args) -#define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args) -#define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args) -#define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args) -#define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args) -#define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args) +#define LOG_PREFIX "gmc-mh-1x-2x" + +#define GMC_BUFSIZE 266 + +/** Message ID bits 4, 5 */ +#define MSGID_MASK 0x30 /**< Mask to get message ID bits */ +#define MSGID_INF 0x00 /**< Start of message with device info */ +#define MSGID_D10 0x10 /**< Start of data message, non-displayed intermediate */ +#define MSGID_DTA 0x20 /**< Start of data message, displayed, averaged */ +#define MSGID_DATA 0x30 /**< Data byte in message */ + +#define MSGC_MASK 0x0f /**< Mask to get message byte contents */ + +#define MSGSRC_MASK 0xc0 /**< Mask to get bits related to message source */ + +#define bc(x) (x & MSGC_MASK) /**< Get contents from a byte */ + +#define MASK_6BITS 0x3f /**< Mask lower six bits. */ + +/** + * Internal multimeter model codes. In opposite to the multimeter models from + * protocol (see decode_model()), these codes allow working with ranges. + */ +enum model { + METRAHIT_NONE = 0, /**< Value for uninitialized variable */ + METRAHIT_12S = 12, + METRAHIT_13S14A = 13, + METRAHIT_14S = 14, + METRAHIT_15S = 15, + METRAHIT_16S = 16, + METRAHIT_16I = 17, + METRAHIT_16X = METRAHIT_16I, /**< All Metrahit 16 */ + /* A Metrahit 17 exists, but seems not to have an IR interface. */ + METRAHIT_18S = 18, + METRAHIT_2X = 20, /**< For model type comparisons */ + METRAHIT_22SM = 22, + METRAHIT_23S = 23, + METRAHIT_24S = 24, + METRAHIT_25SM = 25, + METRAHIT_26S = 26, + METRAHIT_28S = 28, + METRAHIT_29S = 29, +}; + +/** Convert GMC model code in send mode to sigrok-internal one. */ +SR_PRIV int gmc_decode_model_sm(uint8_t mcode); + +/** + * Convert GMC model code in bidirectional mode to sigrok-internal one. + * + * @param[in] mcode Model code. + * + * @return Model code. + */ +SR_PRIV int gmc_decode_model_bidi(uint8_t mcode); + +/** Get model string from sigrok-internal model code. */ +SR_PRIV const char *gmc_model_str(enum model mcode); /** Private, per-device-instance driver context. */ struct dev_context { /* Model-specific information */ + enum model model; /**< Model code. */ /* Acquisition settings */ + uint64_t limit_samples; /**< Target number of samples */ + uint64_t limit_msec; /**< Target sampling time */ + + /* Opaque pointer passed in by frontend. */ + void *cb_data; /* Operational state */ + gboolean settings_ok; /**< Settings msg received yet. */ + int msg_type; /**< Message type (MSGID_INF, ...). */ + int msg_len; /**< Message lengh (valid when msg, curr. type known).*/ + int mq; /**< Measured quantity */ + int unit; /**< Measured unit */ + uint64_t mqflags; /**< Measured quantity flags */ + float value; /**< Measured value */ + float scale; /**< Scale for value. */ + int8_t scale1000; /**< Additional scale factor 1000^x. */ + gboolean vmains_29S; /**< Measured ctmv is V mains (29S only). */ /* Temporary state across callbacks */ - + uint64_t num_samples; /**< Current #samples for limit_samples */ + GTimer *elapsed_msec; /**< Used for sampling with limit_msec */ + uint8_t buf[GMC_BUFSIZE]; /**< Buffer for read callback */ + int buflen; /**< Data len in buf */ }; SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data);