hardware/kecheng-kc-330b/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_KECHENG_KC_330B_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_KECHENG_KC_330B_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 "kecheng-kc-330b: "
  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 EP_IN 0x80 | 1
  38 #define EP_OUT 2
  39
  40 /* 500ms */
  41 #define DEFAULT_SAMPLE_INTERVAL 0
  42 #define DEFAULT_ALARM_LOW 40
  43 #define DEFAULT_ALARM_HIGH 120
  44 #define DEFAULT_WEIGHT_TIME SR_MQFLAG_SPL_TIME_WEIGHT_F
  45 #define DEFAULT_WEIGHT_FREQ SR_MQFLAG_SPL_FREQ_WEIGHT_A
  46 /* Live */
  47 #define DEFAULT_DATA_SOURCE DATA_SOURCE_LIVE
  48
  49 enum {
  50         LIVE_SPL_IDLE,
  51         LIVE_SPL_WAIT,
  52         LOG_DATA_IDLE,
  53         LOG_DATA_WAIT,
  54 };
  55
  56 enum {
  57         CMD_CONFIGURE = 0x01,
  58         CMD_IDENTIFY = 0x02,
  59         CMD_SET_DATE_TIME = 0x03,
  60         CMD_GET_STATUS = 0x04,
  61         CMD_GET_LOG_INFO = 0x05,
  62         CMD_GET_LOG_DATA = 0x07,
  63         CMD_GET_LIVE_SPL = 0x08,
  64 };
  65
  66 enum {
  67         DATA_SOURCE_LIVE,
  68         DATA_SOURCE_MEMORY,
  69 };
  70
  71 enum {
  72         DEVICE_ACTIVE,
  73         DEVICE_INACTIVE,
  74 };
  75
  76 /** Private, per-device-instance driver context. */
  77 struct dev_context {
  78         /* Acquisition settings */
  79         uint64_t limit_samples;
  80         int sample_interval;
  81         int alarm_low;
  82         int alarm_high;
  83         uint64_t mqflags;
  84         int data_source;
  85
  86         /* Operational state */
  87         int state;
  88         gboolean config_dirty;
  89         uint64_t num_samples;
  90         uint64_t stored_samples;
  91         void *cb_data;
  92         struct libusb_transfer *xfer;
  93         unsigned char buf[128];
  94
  95         /* Temporary state across callbacks */
  96         gint64 last_live_request;
  97
  98 };
  99
 100 SR_PRIV int kecheng_kc_330b_handle_events(int fd, int revents, void *cb_data);
 101 SR_PRIV void kecheng_kc_330b_receive_transfer(struct libusb_transfer *transfer);
 102 SR_PRIV int kecheng_kc_330b_configure(const struct sr_dev_inst *sdi);
 103 SR_PRIV int kecheng_kc_330b_set_date_time(struct sr_dev_inst *sdi);
 104 SR_PRIV int kecheng_kc_330b_recording_get(const struct sr_dev_inst *sdi,
 105                 gboolean *tmp);
 106 SR_PRIV int kecheng_kc_330b_status_get(const struct sr_dev_inst *sdi,
 107                 int *status);
 108 SR_PRIV int kecheng_kc_330b_log_info_get(const struct sr_dev_inst *sdi,
 109                 unsigned char *buf);
 110
 111 #endif