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 #define LOG_PREFIX "rigol-ds"
  30
  31 /* Size of acquisition buffers */
  32 #define ACQ_BUFFER_SIZE 32768
  33
  34 #define MAX_ANALOG_CHANNELS 4
  35 #define MAX_DIGITAL_CHANNELS 16
  36
  37 enum protocol_version {
  38         PROTOCOL_V1, /* VS5000 */
  39         PROTOCOL_V2, /* DS1000 */
  40         PROTOCOL_V3, /* DS2000, DSO1000 */
  41 };
  42
  43 enum data_format {
  44         /* Used by DS1000 versions up to 2.02, and VS5000 series */
  45         FORMAT_RAW,
  46         /* Used by DS1000 versions from 2.04 onwards and all later series */
  47         FORMAT_IEEE488_2,
  48 };
  49
  50 enum data_source {
  51         DATA_SOURCE_LIVE,
  52         DATA_SOURCE_MEMORY,
  53         DATA_SOURCE_SEGMENTED,
  54 };
  55
  56 struct rigol_ds_vendor {
  57         const char *name;
  58         const char *full_name;
  59 };
  60
  61 struct rigol_ds_series {
  62         const struct rigol_ds_vendor *vendor;
  63         const char *name;
  64         enum protocol_version protocol;
  65         enum data_format format;
  66         uint64_t max_timebase[2];
  67         uint64_t min_vdiv[2];
  68         int num_horizontal_divs;
  69         int live_samples;
  70         int buffer_samples;
  71 };
  72
  73 struct rigol_ds_model {
  74         const struct rigol_ds_series *series;
  75         const char *name;
  76         uint64_t min_timebase[2];
  77         unsigned int analog_channels;
  78         bool has_digital;
  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         enum data_format format;
  93
  94         /* Device properties */
  95         const uint64_t (*timebases)[2];
  96         uint64_t num_timebases;
  97         const uint64_t (*vdivs)[2];
  98         uint64_t num_vdivs;
  99
 100         /* Channel groups */
 101         struct sr_channel_group analog_groups[MAX_ANALOG_CHANNELS];
 102         struct sr_channel_group digital_group;
 103
 104         /* Acquisition settings */
 105         GSList *enabled_analog_channels;
 106         GSList *enabled_digital_channels;
 107         uint64_t limit_frames;
 108         void *cb_data;
 109         enum data_source data_source;
 110         uint64_t analog_frame_size;
 111         uint64_t digital_frame_size;
 112
 113         /* Device settings */
 114         gboolean analog_channels[MAX_ANALOG_CHANNELS];
 115         gboolean digital_channels[MAX_DIGITAL_CHANNELS];
 116         gboolean la_enabled;
 117         float timebase;
 118         float vdiv[MAX_ANALOG_CHANNELS];
 119         int vert_reference[MAX_ANALOG_CHANNELS];
 120         float vert_offset[MAX_ANALOG_CHANNELS];
 121         char *trigger_source;
 122         float horiz_triggerpos;
 123         char *trigger_slope;
 124         char *coupling[MAX_ANALOG_CHANNELS];
 125
 126         /* Operational state */
 127
 128         /* Number of frames received in total. */
 129         uint64_t num_frames;
 130         /* GSList entry for the current channel. */
 131         GSList *channel_entry;
 132         /* Number of bytes received for current channel. */
 133         uint64_t num_channel_bytes;
 134         /* Number of bytes of block header read */
 135         uint64_t num_header_bytes;
 136         /* Number of bytes in current data block, if 0 block header expected */
 137         uint64_t num_block_bytes;
 138         /* Number of data block bytes already read */
 139         uint64_t num_block_read;
 140         /* What to wait for in *_receive */
 141         enum wait_events wait_event;
 142         /* Trigger/block copying/stop waiting status */
 143         int wait_status;
 144         /* Acq buffers used for reading from the scope and sending data to app */
 145         unsigned char *buffer;
 146         float *data;
 147 };
 148
 149 SR_PRIV int rigol_ds_config_set(const struct sr_dev_inst *sdi, const char *format, ...);
 150 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi);
 151 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi);
 152 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data);
 153 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi);
 154
 155 #endif