hardware/gmc-mh-1x-2x/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Matthias Heidbrink <m-sigrok@heidbrink.biz>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
  22
  23 #include <stdint.h>
  24 #include <glib.h>
  25 #include "libsigrok.h"
  26 #include "libsigrok-internal.h"
  27
  28 /* Message logging helpers with subsystem-specific prefix string. */
  29 #define LOG_PREFIX "gmc-mh-1x-2x: "
  30 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  31 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  32 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  33 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  34 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  35 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  36
  37 #define GMC_BUFSIZE  266
  38
  39 /** Message ID bits 4, 5 */
  40 #define MSGID_MASK  0x30 /**< Mask to get message ID bits */
  41 #define MSGID_INF   0x00 /**< Start of message with device info */
  42 #define MSGID_D10   0x10 /**< Start of data message, non-displayed intermediate */
  43 #define MSGID_DTA   0x20 /**< Start of data message, displayed, averaged */
  44 #define MSGID_DATA  0x30 /**< Data byte in message */
  45
  46 #define MSGC_MASK   0x0f  /**< Mask to get message byte contents */
  47
  48 #define MSGSRC_MASK 0xc0 /**< Mask to get bits related to message source */
  49
  50 #define bc(x) (x & MSGC_MASK) /**< Get contents from a byte */
  51
  52 #define MASK_6BITS  0x3f /**< Mask lower six bits. */
  53
  54 /**
  55  * Internal multimeter model codes. In opposite to the multimeter models from
  56  * protocol (see decode_model()), these codes allow working with ranges.
  57  */
  58 enum model {
  59         METRAHIT_NONE           = 0,  /**< Value for uninitialized variable */
  60         METRAHIT_12S            = 12,
  61         METRAHIT_13S14A         = 13,
  62         METRAHIT_14S            = 14,
  63         METRAHIT_15S            = 15,
  64         METRAHIT_16S            = 16,
  65         METRAHIT_16I            = 17,
  66         METRAHIT_16X = METRAHIT_16I,  /**< All Metrahit 16 */
  67         /* A Metrahit 17 exists, but seems not to have an IR interface. */
  68         METRAHIT_18S            = 18,
  69         METRAHIT_2X             = 20, /**< For model type comparisons */
  70         METRAHIT_22SM           = 22,
  71         METRAHIT_23S            = 23,
  72         METRAHIT_24S            = 24,
  73         METRAHIT_25SM           = 25,
  74         METRAHIT_26S            = 26,
  75         METRAHIT_28S            = 28,
  76         METRAHIT_29S            = 29,
  77 };
  78
  79 /** Convert GMC model code in send mode to sigrok-internal one. */
  80 SR_PRIV int gmc_decode_model_sm(uint8_t mcode);
  81
  82 /**
  83  * Convert GMC model code in bidirectional mode to sigrok-internal one.
  84  *
  85  * @param[in] mcode Model code.
  86  *
  87  * @return Model code.
  88  */
  89 SR_PRIV int gmc_decode_model_bidi(uint8_t mcode);
  90
  91 /** Get model string from sigrok-internal model code. */
  92 SR_PRIV const char *gmc_model_str(enum model mcode);
  93
  94 /** Private, per-device-instance driver context. */
  95 struct dev_context {
  96         /* Model-specific information */
  97         enum model model;       /**< Model code. */
  98
  99         /* Acquisition settings */
 100         uint64_t limit_samples; /**< Target number of samples */
 101         uint64_t limit_msec;    /**< Target sampling time */
 102
 103         /* Opaque pointer passed in by frontend. */
 104         void *cb_data;
 105
 106         /* Operational state */
 107         gboolean settings_ok;   /**< Settings msg received yet. */
 108         int msg_type;   /**< Message type (MSGID_INF, ...). */
 109         int msg_len;    /**< Message lengh (valid when msg, curr. type known).*/
 110         int mq;         /**< Measured quantity */
 111         int unit;               /**< Measured unit */
 112         uint64_t mqflags;       /**< Measured quantity flags */
 113         float value;            /**< Measured value */
 114         float scale;            /**< Scale for value. */
 115         int8_t scale1000;   /**< Additional scale factor 1000^x. */
 116         gboolean vmains_29S;    /**< Measured ctmv is V mains (29S only). */
 117
 118         /* Temporary state across callbacks */
 119         uint64_t num_samples;   /**< Current #samples for limit_samples */
 120         GTimer *elapsed_msec;   /**< Used for sampling with limit_msec  */
 121         uint8_t buf[GMC_BUFSIZE];       /**< Buffer for read callback */
 122         int buflen;                     /**< Data len in buf */
 123 };
 124
 125 SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data);
 126
 127 #endif