hardware/cem-dt-885x/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   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_CEM_DT_885X_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_CEM_DT_885X_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 "cem-dt-885x: "
  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 /* When retrieving samples from device memory, group this many
  38  * together into a sigrok packet. */
  39 #define SAMPLES_PER_PACKET 50
  40
  41 /* Various temporary storage, at least 8 bytes. */
  42 #define BUF_SIZE SAMPLES_PER_PACKET * 2
  43
  44 /* When in hold mode, force the last measurement out at this interval.
  45  * We're using 50ms, which duplicates the non-hold 20Hz update rate. */
  46 #define HOLD_REPEAT_INTERVAL 50 * 1000
  47
  48 enum {
  49         TOKEN_WEIGHT_TIME_FAST = 0x02,
  50         TOKEN_WEIGHT_TIME_SLOW = 0x03,
  51         TOKEN_HOLD_MAX = 0x04,
  52         TOKEN_HOLD_MIN = 0x05,
  53         TOKEN_TIME = 0x06,
  54         TOKEN_MEAS_RANGE_OVER = 0x07,
  55         TOKEN_MEAS_RANGE_UNDER = 0x08,
  56         TOKEN_STORE_FULL = 0x09,
  57         TOKEN_RECORDING_ON = 0x0a,
  58         TOKEN_MEAS_WAS_READOUT = 0x0b,
  59         TOKEN_MEAS_WAS_BARGRAPH = 0x0c,
  60         TOKEN_MEASUREMENT = 0xd,
  61         TOKEN_HOLD_NONE = 0x0e,
  62         TOKEN_BATTERY_LOW = 0x0f,
  63         TOKEN_MEAS_RANGE_OK = 0x11,
  64         TOKEN_STORE_OK = 0x19,
  65         TOKEN_RECORDING_OFF = 0x1a,
  66         TOKEN_WEIGHT_FREQ_A = 0x1b,
  67         TOKEN_WEIGHT_FREQ_C = 0x1c,
  68         TOKEN_BATTERY_OK = 0x1f,
  69         TOKEN_MEAS_RANGE_30_80 = 0x30,
  70         TOKEN_MEAS_RANGE_30_130 = 0x40,
  71         TOKEN_MEAS_RANGE_50_100 = 0x4b,
  72         TOKEN_MEAS_RANGE_80_130 = 0x4c,
  73 };
  74
  75 enum {
  76         CMD_TOGGLE_RECORDING = 0x55,
  77         CMD_TOGGLE_WEIGHT_FREQ = 0x99,
  78         CMD_TOGGLE_WEIGHT_TIME = 0x77,
  79         CMD_TOGGLE_HOLD_MAX_MIN = 0x11,
  80         CMD_TOGGLE_MEAS_RANGE = 0x88,
  81         CMD_TOGGLE_POWER_OFF = 0x33,
  82         CMD_TRANSFER_MEMORY = 0xac,
  83 };
  84
  85 enum {
  86         RECORD_DBA = 0xaa,
  87         RECORD_DBC = 0xcc,
  88         RECORD_DATA = 0xac,
  89         RECORD_END = 0xdd,
  90 };
  91
  92 enum {
  93         DATA_SOURCE_LIVE,
  94         DATA_SOURCE_MEMORY,
  95 };
  96
  97 /** Private, per-device-instance driver context. */
  98 struct dev_context {
  99         /* Device state */
 100         uint64_t cur_mqflags;
 101         int recording;
 102         int cur_meas_range;
 103         int cur_data_source;
 104
 105         /* Acquisition settings */
 106         uint64_t limit_samples;
 107
 108         /* Operational state */
 109         int state;
 110         uint64_t num_samples;
 111         gboolean enable_data_source_memory;
 112
 113         /* Temporary state across callbacks */
 114         void *cb_data;
 115         unsigned char cmd;
 116         unsigned char token;
 117         int buf_len;
 118         unsigned char buf[BUF_SIZE];
 119         float last_spl;
 120         gint64 hold_last_sent;
 121 };
 122
 123 /* Parser state machine. */
 124 enum {
 125         ST_INIT,
 126         ST_GET_TOKEN,
 127         ST_GET_DATA,
 128         ST_GET_LOG_HEADER,
 129         ST_GET_LOG_RECORD_META,
 130         ST_GET_LOG_RECORD_DATA,
 131 };
 132
 133 SR_PRIV int cem_dt_885x_receive_data(int fd, int revents, void *cb_data);
 134 SR_PRIV int cem_dt_885x_recording_set(const struct sr_dev_inst *sdi, gboolean start);
 135 SR_PRIV gboolean cem_dt_885x_recording_get(const struct sr_dev_inst *sdi,
 136                 int *state);
 137 SR_PRIV int cem_dt_885x_weight_freq_get(const struct sr_dev_inst *sdi);
 138 SR_PRIV int cem_dt_885x_weight_freq_set(const struct sr_dev_inst *sdi, int freqw);
 139 SR_PRIV int cem_dt_885x_weight_time_get(const struct sr_dev_inst *sdi);
 140 SR_PRIV int cem_dt_885x_weight_time_set(const struct sr_dev_inst *sdi, int timew);
 141 SR_PRIV int cem_dt_885x_holdmode_get(const struct sr_dev_inst *sdi,
 142                 gboolean *holdmode);
 143 SR_PRIV int cem_dt_885x_holdmode_set(const struct sr_dev_inst *sdi, int holdmode);
 144 SR_PRIV int cem_dt_885x_meas_range_get(const struct sr_dev_inst *sdi,
 145                 uint64_t *low, uint64_t *high);
 146 SR_PRIV int cem_dt_885x_meas_range_set(const struct sr_dev_inst *sdi,
 147                 uint64_t low, uint64_t high);
 148 SR_PRIV int cem_dt_885x_power_off(const struct sr_dev_inst *sdi);
 149
 150 #endif