2 * This file is part of the libsigrok project.
4 * Copyright (C) 2018 mhooijboer <marchelh@gmail.com>
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.
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.
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/>.
20 #ifndef LIBSIGROK_HARDWARE_SIGLENT_SDS_PROTOCOL_H
21 #define LIBSIGROK_HARDWARE_SIGLENT_SDS_PROTOCOL_H
26 #include <libsigrok/libsigrok.h>
27 #include "libsigrok-internal.h"
29 #define LOG_PREFIX "siglent-sds"
31 /* Size of acquisition buffers */
32 //#define ACQ_BUFFER_SIZE (6000000)
33 #define ACQ_BUFFER_SIZE (18000000)
35 /* Maximum number of samples to retrieve at once. */
36 #define ACQ_BLOCK_SIZE (30 * 1000)
38 #define MAX_ANALOG_CHANNELS 4
39 #define MAX_DIGITAL_CHANNELS 16
41 #define DEVICE_STATE_STOPPED 0 /* Scope is in stopped state */
42 #define DEVICE_STATE_DATA_ACQ 1 /* A new signal has been acquired */
43 #define DEVICE_STATE_TRIG_RDY 8192 /* Trigger is ready */
45 enum protocol_version {
59 struct siglent_sds_vendor {
61 const char *full_name;
65 struct siglent_sds_series {
66 const struct siglent_sds_vendor *vendor;
68 enum protocol_version protocol;
69 uint64_t max_timebase[2];
71 int num_horizontal_divs;
72 int num_vertical_divs;
76 struct siglent_sds_model {
77 const struct siglent_sds_series *series;
79 uint64_t min_timebase[2];
80 unsigned int analog_channels;
82 unsigned int digital_channels;
86 WAIT_NONE, /* Don't wait */
87 WAIT_TRIGGER, /* Wait for trigger */
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 siglent_sds_model *model;
97 /* Device properties */
98 const uint64_t (*timebases)[2];
99 uint64_t num_timebases;
100 const uint64_t (*vdivs)[2];
104 struct sr_channel_group **analog_groups;
105 struct sr_channel_group *digital_group;
107 /* Acquisition settings */
108 GSList *enabled_channels;
109 uint64_t limit_frames;
110 enum data_source data_source;
111 uint64_t analog_frame_size;
112 uint64_t digital_frame_size;
113 uint64_t num_samples;
114 long blockHeaderSize;
117 /* Device settings */
118 gboolean analog_channels[MAX_ANALOG_CHANNELS];
119 gboolean digital_channels[MAX_DIGITAL_CHANNELS];
122 float attenuation[MAX_ANALOG_CHANNELS];
123 float vdiv[MAX_ANALOG_CHANNELS];
124 int vert_reference[MAX_ANALOG_CHANNELS];
125 float vert_offset[MAX_ANALOG_CHANNELS];
126 char *trigger_source;
127 float horiz_triggerpos;
130 char *coupling[MAX_ANALOG_CHANNELS];
132 /* Operational state */
134 /* Number of frames received in total. */
136 /* GSList entry for the current channel. */
137 GSList *channel_entry;
138 /* Number of bytes received for current channel. */
139 uint64_t num_channel_bytes;
140 /* Number of bytes of block header read */
141 uint64_t num_header_bytes;
142 /* Number of bytes in current data block, if 0 block header expected */
143 uint64_t num_block_bytes;
144 /* Number of data block bytes already read */
145 uint64_t num_block_read;
146 /* What to wait for in *_receive */
147 enum wait_events wait_event;
148 /* Trigger/block copying/stop waiting status */
150 /* Acq buffers used for reading from the scope and sending data to app */
151 unsigned char *buffer;
155 SR_PRIV int siglent_sds_config_set(const struct sr_dev_inst *sdi,
156 const char *format, ...);
157 SR_PRIV int siglent_sds_capture_start(const struct sr_dev_inst *sdi);
158 SR_PRIV int siglent_sds_channel_start(const struct sr_dev_inst *sdi);
159 SR_PRIV int siglent_sds_receive(int fd, int revents, void *cb_data);
160 SR_PRIV int siglent_sds_get_dev_cfg(const struct sr_dev_inst *sdi);
161 SR_PRIV int siglent_sds_get_dev_cfg_vertical(const struct sr_dev_inst *sdi);
162 SR_PRIV int siglent_sds_get_dev_cfg_horizontal(const struct sr_dev_inst *sdi);