src/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/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 (32 * 1024)
  33
  34 /* Maximum number of samples to retrieve at once. */
  35 #define ACQ_BLOCK_SIZE (30 * 1000)
  36
  37 #define MAX_ANALOG_CHANNELS 4
  38 #define MAX_DIGITAL_CHANNELS 16
  39
  40 enum protocol_version {
  41         PROTOCOL_V1, /* VS5000 */
  42         PROTOCOL_V2, /* DS1000 */
  43         PROTOCOL_V3, /* DS2000, DSO1000 */
  44         PROTOCOL_V4, /* DS1000Z */
  45 };
  46
  47 enum data_format {
  48         /* Used by DS1000 versions up to 2.02, and VS5000 series */
  49         FORMAT_RAW,
  50         /* Used by DS1000 versions from 2.04 onwards and all later series */
  51         FORMAT_IEEE488_2,
  52 };
  53
  54 enum data_source {
  55         DATA_SOURCE_LIVE,
  56         DATA_SOURCE_MEMORY,
  57         DATA_SOURCE_SEGMENTED,
  58 };
  59
  60 struct rigol_ds_vendor {
  61         const char *name;
  62         const char *full_name;
  63 };
  64
  65 struct rigol_ds_series {
  66         const struct rigol_ds_vendor *vendor;
  67         const char *name;
  68         enum protocol_version protocol;
  69         enum data_format format;
  70         uint64_t max_timebase[2];
  71         uint64_t min_vdiv[2];
  72         int num_horizontal_divs;
  73         int live_samples;
  74         int buffer_samples;
  75 };
  76
  77 enum cmds {
  78         CMD_GET_HORIZ_TRIGGERPOS,
  79         CMD_SET_HORIZ_TRIGGERPOS,
  80 };
  81
  82 struct rigol_ds_command {
  83         int cmd;
  84         const char *str;
  85 };
  86
  87 struct rigol_ds_model {
  88         const struct rigol_ds_series *series;
  89         const char *name;
  90         uint64_t min_timebase[2];
  91         unsigned int analog_channels;
  92         bool has_digital;
  93         const char **trigger_sources;
  94         unsigned int num_trigger_sources;
  95         const struct rigol_ds_command *cmds;
  96 };
  97
  98 enum wait_events {
  99         WAIT_NONE,    /* Don't wait */
 100         WAIT_TRIGGER, /* Wait for trigger (only live capture) */
 101         WAIT_BLOCK,   /* Wait for block data (only when reading sample mem) */
 102         WAIT_STOP,    /* Wait for scope stopping (only single shots) */
 103 };
 104
 105 struct dev_context {
 106         const struct rigol_ds_model *model;
 107         enum data_format format;
 108
 109         /* Device properties */
 110         const uint64_t (*timebases)[2];
 111         uint64_t num_timebases;
 112         const uint64_t (*vdivs)[2];
 113         uint64_t num_vdivs;
 114
 115         /* Channel groups */
 116         struct sr_channel_group **analog_groups;
 117         struct sr_channel_group *digital_group;
 118
 119         /* Acquisition settings */
 120         GSList *enabled_channels;
 121         uint64_t limit_frames;
 122         enum data_source data_source;
 123         uint64_t analog_frame_size;
 124         uint64_t digital_frame_size;
 125
 126         /* Device settings */
 127         gboolean analog_channels[MAX_ANALOG_CHANNELS];
 128         gboolean digital_channels[MAX_DIGITAL_CHANNELS];
 129         gboolean la_enabled;
 130         float timebase;
 131         float attenuation[MAX_ANALOG_CHANNELS];
 132         float vdiv[MAX_ANALOG_CHANNELS];
 133         int vert_reference[MAX_ANALOG_CHANNELS];
 134         float vert_origin[MAX_ANALOG_CHANNELS];
 135         float vert_offset[MAX_ANALOG_CHANNELS];
 136         float vert_inc[MAX_ANALOG_CHANNELS];
 137         char *trigger_source;
 138         float horiz_triggerpos;
 139         char *trigger_slope;
 140         float trigger_level;
 141         char *coupling[MAX_ANALOG_CHANNELS];
 142
 143         /* Number of frames received in total. */
 144         uint64_t num_frames;
 145         /* GSList entry for the current channel. */
 146         GSList *channel_entry;
 147         /* Number of bytes received for current channel. */
 148         uint64_t num_channel_bytes;
 149         /* Number of bytes of block header read */
 150         uint64_t num_header_bytes;
 151         /* Number of bytes in current data block, if 0 block header expected */
 152         uint64_t num_block_bytes;
 153         /* Number of data block bytes already read */
 154         uint64_t num_block_read;
 155         /* What to wait for in *_receive */
 156         enum wait_events wait_event;
 157         /* Trigger/block copying/stop waiting status */
 158         int wait_status;
 159         /* Acq buffers used for reading from the scope and sending data to app */
 160         unsigned char *buffer;
 161         float *data;
 162 };
 163
 164 SR_PRIV int rigol_ds_config_set(const struct sr_dev_inst *sdi, const char *format, ...);
 165 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi);
 166 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi);
 167 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data);
 168 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi);
 169 SR_PRIV int rigol_ds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi);
 170
 171 #endif