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

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013, 2014 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 /**
  21  * @file
  22  *
  23  * Gossen Metrawatt Metrahit 1x/2x drivers
  24  *
  25  * @internal
  26  */
  27
  28 #ifndef LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
  29 #define LIBSIGROK_HARDWARE_GMC_MH_1X_2X_PROTOCOL_H
  30
  31 #include <stdint.h>
  32 #include <glib.h>
  33 #include <libsigrok/libsigrok.h>
  34 #include "libsigrok-internal.h"
  35
  36 #define LOG_PREFIX "gmc-mh-1x-2x"
  37
  38 #define GMC_BUFSIZE 266
  39 #define GMC_REPLY_SIZE 14
  40
  41 /** Message ID bits 4, 5 */
  42 #define MSGID_MASK  0x30 /**< Mask to get message ID bits */
  43 #define MSGID_INF   0x00 /**< Start of message with device info */
  44 #define MSGID_D10   0x10 /**< Start of data message, non-displayed intermediate */
  45 #define MSGID_DTA   0x20 /**< Start of data message, displayed, averaged */
  46 #define MSGID_DATA  0x30 /**< Data byte in message */
  47
  48 #define MSGC_MASK   0x0f /**< Mask to get message byte contents in send mode */
  49
  50 #define MSGSRC_MASK 0xc0 /**< Mask to get bits related to message source */
  51
  52 #define bc(x) (x & MSGC_MASK) /**< Get contents from a byte */
  53
  54 #define MASK_6BITS  0x3f /**< Mask lower six bits. */
  55
  56 /**
  57  * Internal multimeter model codes. In opposite to the multimeter models from
  58  * protocol (see decode_model()), these codes allow working with ranges.
  59  */
  60 enum model {
  61         METRAHIT_NONE           = 0,  /**< Value for uninitialized variable */
  62         METRAHIT_12S            = 12,
  63         METRAHIT_13S14A         = 13,
  64         METRAHIT_14S            = 14,
  65         METRAHIT_15S            = 15,
  66         METRAHIT_16S            = 16,
  67         METRAHIT_16I            = 17, /**< Metrahit 16I, L */
  68         METRAHIT_16T            = 18, /**< Metrahit 16T, U, KMM2002 */
  69         METRAHIT_16X = METRAHIT_16T,  /**< All Metrahit 16 */
  70         /* A Metrahit 17 exists, but seems not to have an IR interface. */
  71         METRAHIT_18S            = 19,
  72         METRAHIT_2X             = 20, /**< For model type comparisons */
  73         METRAHIT_22SM           = METRAHIT_2X + 1,      /**< Send mode */
  74         METRAHIT_22S            = METRAHIT_22SM + 1,    /**< Bidi mode */
  75         METRAHIT_22M            = METRAHIT_22S + 1,     /**< Bidi mode */
  76         METRAHIT_23S            = METRAHIT_22M + 1,
  77         METRAHIT_24S            = METRAHIT_23S + 1,
  78         METRAHIT_25S            = METRAHIT_24S + 1,
  79         METRAHIT_26SM           = METRAHIT_25S + 1,     /**< Send mode */
  80         METRAHIT_26S            = METRAHIT_26SM + 1,    /**< Bidi mode */
  81         METRAHIT_26M            = METRAHIT_26S + 1,     /**< Bidi mode */
  82         /* The Metrahit 27x and 28Cx have a totally different protocol */
  83         METRAHIT_28S            = METRAHIT_26M + 1,
  84         METRAHIT_29S            = METRAHIT_28S + 1,
  85 };
  86
  87 /** Private, per-device-instance driver context. */
  88 struct dev_context {
  89         /* Model-specific information */
  90         enum model model;       /**< Model code. */
  91
  92         /* Acquisition settings */
  93         struct sr_sw_limits limits;
  94
  95         /* Operational state */
  96         gboolean settings_ok;   /**< Settings msg received yet. */
  97         int msg_type;       /**< Message type (MSGID_INF, ...). */
  98         int msg_len;        /**< Message length (valid when msg, curr. type known).*/
  99         enum sr_mq mq;      /**< Measured quantity */
 100         enum sr_unit unit;  /**< Measured unit */
 101         enum sr_mqflag mqflags; /**< Measured quantity flags */
 102         float value;            /**< Measured value */
 103         int8_t scale;       /**< Scale for value. */
 104         int8_t scale1000;   /**< Additional scale factor 1000x. */
 105         int addr;           /**< Device address (1..15). */
 106         int cmd_idx;        /**< Parameter "Idx" (Index) of current command, if required. */
 107         int cmd_seq;        /**< Command sequence. Used to query status every n messages. */
 108         gboolean autorng;   /**< Auto range enabled. */
 109         float ubatt;        /**< Battery voltage. */
 110         uint8_t fw_ver_maj; /**< Firmware version major. */
 111         uint8_t fw_ver_min; /**< Firmware version minor. */
 112         int64_t req_sent_at;    /**< Request sent. */
 113         gboolean response_pending; /**< Request sent, response is pending. */
 114
 115         /* Temporary state across callbacks */
 116         uint8_t buf[GMC_BUFSIZE];       /**< Buffer for read callback */
 117         int buflen;                     /**< Data len in buf */
 118 };
 119
 120 /* Forward declarations */
 121 SR_PRIV int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 122                 const struct sr_channel_group *cg);
 123 SR_PRIV int gmc_decode_model_bd(uint8_t mcode);
 124 SR_PRIV int gmc_decode_model_sm(uint8_t mcode);
 125 SR_PRIV int gmc_mh_1x_2x_receive_data(int fd, int revents, void *cb_data);
 126 SR_PRIV int gmc_mh_2x_receive_data(int fd, int revents, void *cb_data);
 127 SR_PRIV const char *gmc_model_str(enum model mcode);
 128 SR_PRIV int process_msg14(struct sr_dev_inst *sdi);
 129 SR_PRIV int req_meas14(const struct sr_dev_inst *sdi);
 130 SR_PRIV int req_stat14(const struct sr_dev_inst *sdi, gboolean power_on);
 131
 132 #endif