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 #define BUF_SIZE 32
  38 /* When in hold mode, force the last measurement out at this interval.
  39  * We're using 50ms, which duplicates the non-hold 20Hz update rate. */
  40 #define HOLD_REPEAT_INTERVAL 50 * 1000
  41
  42 enum {
  43         TOKEN_WEIGHT_TIME_FAST = 0x02,
  44         TOKEN_WEIGHT_TIME_SLOW = 0x03,
  45         TOKEN_HOLD_MAX = 0x04,
  46         TOKEN_HOLD_MIN = 0x05,
  47         TOKEN_TIME = 0x06,
  48         TOKEN_MEAS_RANGE_OVER = 0x07,
  49         TOKEN_MEAS_RANGE_UNDER = 0x08,
  50         TOKEN_STORE_FULL = 0x09,
  51         TOKEN_RECORDING_ON = 0x0a,
  52         TOKEN_MEAS_WAS_READOUT = 0x0b,
  53         TOKEN_MEAS_WAS_BARGRAPH = 0x0c,
  54         TOKEN_MEASUREMENT = 0xd,
  55         TOKEN_HOLD_NONE = 0x0e,
  56         TOKEN_BATTERY_LOW = 0x0f,
  57         TOKEN_MEAS_RANGE_OK = 0x11,
  58         TOKEN_STORE_OK = 0x19,
  59         TOKEN_RECORDING_OFF = 0x1a,
  60         TOKEN_WEIGHT_FREQ_A = 0x1b,
  61         TOKEN_WEIGHT_FREQ_C = 0x1c,
  62         TOKEN_BATTERY_OK = 0x1f,
  63         TOKEN_MEAS_RANGE_30_80 = 0x30,
  64         TOKEN_MEAS_RANGE_30_130 = 0x40,
  65         TOKEN_MEAS_RANGE_50_100 = 0x4b,
  66         TOKEN_MEAS_RANGE_80_130 = 0x4c,
  67 };
  68
  69 enum {
  70         CMD_TOGGLE_RECORDING = 0x55,
  71         CMD_TOGGLE_WEIGHT_FREQ = 0x99,
  72         CMD_TOGGLE_WEIGHT_TIME = 0x77,
  73         CMD_TOGGLE_HOLD_MAX_MIN = 0x11,
  74 };
  75
  76 /** Private, per-device-instance driver context. */
  77 struct dev_context {
  78         /* Device state */
  79         uint64_t cur_mqflags;
  80         int recording;
  81
  82         /* Acquisition settings */
  83         uint64_t limit_samples;
  84
  85         /* Operational state */
  86         int state;
  87         uint64_t num_samples;
  88
  89         /* Temporary state across callbacks */
  90         void *cb_data;
  91         unsigned char cmd;
  92         unsigned char token;
  93         int buf_len;
  94         unsigned char buf[BUF_SIZE];
  95         float last_spl;
  96         gint64 hold_last_sent;
  97 };
  98
  99 /* Parser state machine. */
 100 enum {
 101         ST_INIT,
 102         ST_GET_TOKEN,
 103         ST_GET_DATA,
 104         ST_GET_LOG,
 105 };
 106
 107 SR_PRIV int cem_dt_885x_receive_data(int fd, int revents, void *cb_data);
 108 SR_PRIV int cem_dt_885x_recording_set(const struct sr_dev_inst *sdi, gboolean start);
 109 SR_PRIV gboolean cem_dt_885x_recording_get(const struct sr_dev_inst *sdi);
 110 SR_PRIV int cem_dt_885x_weight_freq_get(const struct sr_dev_inst *sdi);
 111 SR_PRIV int cem_dt_885x_weight_freq_set(const struct sr_dev_inst *sdi, int freqw);
 112 SR_PRIV int cem_dt_885x_weight_time_get(const struct sr_dev_inst *sdi);
 113 SR_PRIV int cem_dt_885x_weight_time_set(const struct sr_dev_inst *sdi, int timew);
 114 SR_PRIV int cem_dt_885x_holdmode_get(const struct sr_dev_inst *sdi,
 115                 gboolean *holdmode);
 116 SR_PRIV int cem_dt_885x_holdmode_set(const struct sr_dev_inst *sdi, int holdmode);
 117
 118 #endif