2 * This file is part of the libsigrok project.
4 * Copyright (C) 2012 Martin Ling <martin-git@earth.li>
5 * Copyright (C) 2013 Bert Vermeulen <bert@biot.com>
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.
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.
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/>.
21 #ifndef LIBSIGROK_HARDWARE_RIGOL_DS_PROTOCOL_H
22 #define LIBSIGROK_HARDWARE_RIGOL_DS_PROTOCOL_H
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
29 #define LOG_PREFIX "rigol-ds"
31 /* Size of acquisition buffers */
32 #define ACQ_BUFFER_SIZE (32 * 1024)
34 /* Maximum number of samples to retrieve at once. */
35 #define ACQ_BLOCK_SIZE (30 * 1000)
37 #define MAX_ANALOG_CHANNELS 4
38 #define MAX_DIGITAL_CHANNELS 16
40 enum protocol_version {
41 PROTOCOL_V1, /* VS5000 */
42 PROTOCOL_V2, /* DS1000 */
43 PROTOCOL_V3, /* DS2000, DSO1000 */
44 PROTOCOL_V4, /* DS1000Z */
48 /* Used by DS1000 versions up to 2.02, and VS5000 series */
50 /* Used by DS1000 versions from 2.04 onwards and all later series */
57 DATA_SOURCE_SEGMENTED,
60 struct rigol_ds_vendor {
62 const char *full_name;
65 struct rigol_ds_series {
66 const struct rigol_ds_vendor *vendor;
68 enum protocol_version protocol;
69 enum data_format format;
70 uint64_t max_timebase[2];
72 int num_horizontal_divs;
77 struct rigol_ds_model {
78 const struct rigol_ds_series *series;
80 uint64_t min_timebase[2];
81 unsigned int analog_channels;
86 WAIT_NONE, /* Don't wait */
87 WAIT_TRIGGER, /* Wait for trigger (only live capture) */
88 WAIT_BLOCK, /* Wait for block data (only when reading sample mem) */
89 WAIT_STOP, /* Wait for scope stopping (only single shots) */
92 /** Private, per-device-instance driver context. */
95 const struct rigol_ds_model *model;
96 enum data_format format;
98 /* Device properties */
99 const uint64_t (*timebases)[2];
100 uint64_t num_timebases;
101 const uint64_t (*vdivs)[2];
105 struct sr_channel_group **analog_groups;
106 struct sr_channel_group *digital_group;
108 /* Acquisition settings */
109 GSList *enabled_channels;
110 uint64_t limit_frames;
111 enum data_source data_source;
112 uint64_t analog_frame_size;
113 uint64_t digital_frame_size;
115 /* Device settings */
116 gboolean analog_channels[MAX_ANALOG_CHANNELS];
117 gboolean digital_channels[MAX_DIGITAL_CHANNELS];
120 float attenuation[MAX_ANALOG_CHANNELS];
121 float vdiv[MAX_ANALOG_CHANNELS];
122 int vert_reference[MAX_ANALOG_CHANNELS];
123 float vert_offset[MAX_ANALOG_CHANNELS];
124 char *trigger_source;
125 float horiz_triggerpos;
128 char *coupling[MAX_ANALOG_CHANNELS];
130 /* Operational state */
132 /* Number of frames received in total. */
134 /* GSList entry for the current channel. */
135 GSList *channel_entry;
136 /* Number of bytes received for current channel. */
137 uint64_t num_channel_bytes;
138 /* Number of bytes of block header read */
139 uint64_t num_header_bytes;
140 /* Number of bytes in current data block, if 0 block header expected */
141 uint64_t num_block_bytes;
142 /* Number of data block bytes already read */
143 uint64_t num_block_read;
144 /* What to wait for in *_receive */
145 enum wait_events wait_event;
146 /* Trigger/block copying/stop waiting status */
148 /* Acq buffers used for reading from the scope and sending data to app */
149 unsigned char *buffer;
153 SR_PRIV int rigol_ds_config_set(const struct sr_dev_inst *sdi, const char *format, ...);
154 SR_PRIV int rigol_ds_capture_start(const struct sr_dev_inst *sdi);
155 SR_PRIV int rigol_ds_channel_start(const struct sr_dev_inst *sdi);
156 SR_PRIV int rigol_ds_receive(int fd, int revents, void *cb_data);
157 SR_PRIV int rigol_ds_get_dev_cfg(const struct sr_dev_inst *sdi);
158 SR_PRIV int rigol_ds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi);