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