hardware/rigol-ds/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
   5  * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef LIBSIGROK_HARDWARE_RIGOL_DS_PROTOCOL_H
  22 #define LIBSIGROK_HARDWARE_RIGOL_DS_PROTOCOL_H
  23
  24 #include <stdint.h>
  25 #include <stdbool.h>
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28
  29 /* Message logging helpers with subsystem-specific prefix string. */
  30 #define LOG_PREFIX "rigol-ds: "
  31 #define sr_log(l, s, args...) sr_log(l, LOG_PREFIX s, ## args)
  32 #define sr_spew(s, args...) sr_spew(LOG_PREFIX s, ## args)
  33 #define sr_dbg(s, args...) sr_dbg(LOG_PREFIX s, ## args)
  34 #define sr_info(s, args...) sr_info(LOG_PREFIX s, ## args)
  35 #define sr_warn(s, args...) sr_warn(LOG_PREFIX s, ## args)
  36 #define sr_err(s, args...) sr_err(LOG_PREFIX s, ## args)
  37
  38 #define DS1000_ANALOG_LIVE_WAVEFORM_SIZE 600
  39 #define DS2000_ANALOG_LIVE_WAVEFORM_SIZE 1400
  40 #define VS5000_ANALOG_LIVE_WAVEFORM_SIZE 2048
  41 /* Needs to be made configurable later */
  42 #define DS2000_ANALOG_MEM_WAVEFORM_SIZE_1C 14000
  43 #define DS2000_ANALOG_MEM_WAVEFORM_SIZE_2C 7000
  44 #define DIGITAL_WAVEFORM_SIZE 1210
  45 /* Size of acquisition buffers */
  46 #define ACQ_BUFFER_SIZE 32768
  47
  48 enum rigol_ds_series {
  49         RIGOL_DS1000,
  50         RIGOL_DS1000Z,
  51         RIGOL_DS2000,
  52         RIGOL_DS4000,
  53         RIGOL_DS6000,
  54         RIGOL_VS5000,
  55 };
  56
  57 enum rigol_protocol_flavor {
  58         /* Used by DS1000 and VS5000 series */
  59         PROTOCOL_LEGACY,
  60         /* Used by DS2000, DS4000, DS6000, ... series */
  61         PROTOCOL_IEEE488_2,
  62 };
  63
  64 enum data_source {
  65         DATA_SOURCE_LIVE,
  66         DATA_SOURCE_MEMORY,
  67         DATA_SOURCE_SEGMENTED,
  68 };
  69
  70 struct rigol_ds_model {
  71         char *name;
  72         enum rigol_ds_series series;
  73         enum rigol_protocol_flavor protocol;
  74         uint64_t min_timebase[2];
  75         uint64_t max_timebase[2];
  76         uint64_t min_vdiv[2];
  77         bool has_digital;
  78         int num_horizontal_divs;
  79 };
  80
  81 enum wait_events {
  82         WAIT_NONE,    /* Don't wait */
  83         WAIT_TRIGGER, /* Wait for trigger (only live capture) */
  84         WAIT_BLOCK,   /* Wait for block data (only when reading sample mem) */
  85         WAIT_STOP,    /* Wait for scope stopping (only single shots) */
  86 };
  87
  88 /** Private, per-device-instance driver context. */
  89 struct dev_context {
  90         /* Device model */
  91         const struct rigol_ds_model *model;
  92
  93         /* Device properties */
  94         const uint64_t (*timebases)[2];
  95         uint64_t num_timebases;
  96         const uint64_t (*vdivs)[2];
  97         uint64_t num_vdivs;
  98
  99         /* Probe groups */
 100         struct sr_probe_group analog_groups[2];
 101         struct sr_probe_group digital_group;
 102
 103         /* Acquisition settings */
 104         GSList *enabled_analog_probes;
 105         GSList *enabled_digital_probes;
 106         uint64_t limit_frames;
 107         void *cb_data;
 108         enum data_source data_source;
 109         uint64_t analog_frame_size;
 110
 111         /* Device settings */
 112         gboolean analog_channels[2];
 113         gboolean digital_channels[16];
 114         float timebase;
 115         float vdiv[2];
 116         int vert_reference[2];
 117         float vert_offset[2];
 118         char *trigger_source;
 119         float horiz_triggerpos;
 120         char *trigger_slope;
 121         char *coupling[2];
 122
 123         /* Operational state */
 124         uint64_t num_frames;
 125         /* FIXME: misnomer, actually this is number of frame samples? */
 126         uint64_t num_frame_bytes;
 127         struct sr_probe *channel_frame;
 128         /* Number of bytes in current data block, if 0 block header expected */
 129         uint64_t num_block_bytes;
 130         /* Number of data block bytes already read */
 131         uint64_t num_block_read;
 132         /* What to wait for in *_receive */
 133         enum wait_events wait_event;
 134         /* Trigger/block copying/stop waiting status */
 135         int wait_status;
 136         /* Acq buffers used for reading from the scope and sending data to app */
 137         unsigned char *buffer;
 138         float *data;
 139 };
 140
 141 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi);
 142 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data);
 143 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi);
 144
 145 #endif