hardware/sysclk-lwla/protocol.h

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2014 Daniel Elstner <daniel.kitta@gmail.com>
   5  *
   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.
  10  *
  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.
  15  *
  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/>.
  18  */
  19
  20 #ifndef LIBSIGROK_HARDWARE_SYSCLK_LWLA_PROTOCOL_H
  21 #define LIBSIGROK_HARDWARE_SYSCLK_LWLA_PROTOCOL_H
  22
  23 #define LOG_PREFIX "sysclk-lwla"
  24
  25 #include "lwla.h"
  26 #include "libsigrok.h"
  27 #include "libsigrok-internal.h"
  28 #include <stdint.h>
  29 #include <glib.h>
  30
  31 /* For now, only the LWLA1034 is supported.
  32  */
  33 #define VENDOR_NAME     "SysClk"
  34 #define MODEL_NAME      "LWLA1034"
  35
  36 #define USB_VID_PID     "2961.6689"
  37 #define USB_INTERFACE   0
  38 #define USB_TIMEOUT     3000 /* ms */
  39
  40 #define NUM_CHANNELS    34
  41
  42 /* Bit mask covering all 34 channels.
  43  */
  44 #define ALL_CHANNELS_MASK (((uint64_t)1 << NUM_CHANNELS) - 1)
  45
  46 /** Unit and packet size for the sigrok logic datafeed.
  47  */
  48 #define UNIT_SIZE       ((NUM_CHANNELS + 7) / 8)
  49 #define PACKET_LENGTH   10000   /* units */
  50
  51 /** Size of the acquisition buffer in device memory units.
  52  */
  53 #define MEMORY_DEPTH    (256 * 1024)    /* 256k x 36 bit */
  54
  55 /** Number of device memory units (36 bit) to read at a time.  Slices of 8
  56  * consecutive 36-bit words are mapped to 9 32-bit words each, so the chunk
  57  * length should be a multiple of 8 to ensure alignment to slice boundaries.
  58  *
  59  * Experimentation has shown that reading chunks larger than about 1024 bytes
  60  * is unreliable.  The threshold seems to relate to the buffer size on the FX2
  61  * USB chip:  The configured endpoint buffer size is 512, and with double or
  62  * triple buffering enabled a multiple of 512 bytes can be kept in fly.
  63  *
  64  * The vendor software limits reads to 120 words (15 slices, 540 bytes) at
  65  * a time.  So far, it appears safe to increase this to 224 words (28 slices,
  66  * 1008 bytes), thus making the most of two 512 byte buffers.
  67  */
  68 #define READ_CHUNK_LEN  (28 * 8)
  69
  70 /** Calculate the required buffer size in 32-bit units for reading a given
  71  * number of device memory words.  Rounded to a multiple of 8 device words.
  72  */
  73 #define LWLA1034_MEMBUF_LEN(count) (((count) + 7) / 8 * 9)
  74
  75 /** Maximum number of 16-bit words sent at a time during acquisition.
  76  * Used for allocating the libusb transfer buffer.
  77  */
  78 #define MAX_ACQ_SEND_WORDS      8 /* 5 for memory read request plus stuffing */
  79
  80 /** Maximum number of 32-bit words received at a time during acquisition.
  81  * Round to the next multiple of the endpoint buffer size to avoid nasty
  82  * transfer overflow conditions on hiccups.
  83  */
  84 #define MAX_ACQ_RECV_LEN        ((READ_CHUNK_LEN / 8 * 9 + 127) / 128 * 128)
  85
  86 /** Maximum length of a register write sequence.
  87  */
  88 #define MAX_REG_WRITE_SEQ_LEN   5
  89
  90 /** Default configured samplerate.
  91  */
  92 #define DEFAULT_SAMPLERATE      SR_MHZ(125)
  93
  94 /** Maximum configurable sample count limit.
  95  */
  96 #define MAX_LIMIT_SAMPLES       (UINT64_C(1) << 48)
  97
  98 /** Maximum configurable capture duration in milliseconds.
  99  */
 100 #define MAX_LIMIT_MSEC          (UINT64_C(1) << 32)
 101
 102 /** LWLA1034 FPGA clock configurations.
 103  */
 104 enum clock_config {
 105         CONF_CLOCK_NONE,
 106         CONF_CLOCK_INT,
 107         CONF_CLOCK_EXT_RISE,
 108         CONF_CLOCK_EXT_FALL,
 109 };
 110
 111 /** Available clock sources.
 112  */
 113 enum clock_source {
 114         CLOCK_INTERNAL,
 115         CLOCK_EXT_CLK,
 116 };
 117
 118 /** Available trigger sources.
 119  */
 120 enum trigger_source {
 121         TRIGGER_CHANNELS = 0,
 122         TRIGGER_EXT_TRG,
 123 };
 124
 125 /** Available edge choices for the external clock and trigger inputs.
 126  */
 127 enum signal_edge {
 128         EDGE_POSITIVE = 0,
 129         EDGE_NEGATIVE,
 130 };
 131
 132 /** LWLA device states.
 133  */
 134 enum device_state {
 135         STATE_IDLE = 0,
 136
 137         STATE_START_CAPTURE,
 138
 139         STATE_STATUS_WAIT,
 140         STATE_STATUS_REQUEST,
 141         STATE_STATUS_RESPONSE,
 142
 143         STATE_STOP_CAPTURE,
 144
 145         STATE_LENGTH_REQUEST,
 146         STATE_LENGTH_RESPONSE,
 147
 148         STATE_READ_PREPARE,
 149         STATE_READ_REQUEST,
 150         STATE_READ_RESPONSE,
 151         STATE_READ_END,
 152 };
 153
 154 /** LWLA run-length encoding states.
 155  */
 156 enum rle_state {
 157         RLE_STATE_DATA,
 158         RLE_STATE_LEN
 159 };
 160
 161 /** LWLA sample acquisition and decompression state.
 162  */
 163 struct acquisition_state {
 164         uint64_t sample;
 165         uint64_t run_len;
 166
 167         /** Maximum number of samples to process. */
 168         uint64_t samples_max;
 169         /** Number of samples sent to the session bus. */
 170         uint64_t samples_done;
 171
 172         /** Maximum duration of capture, in milliseconds. */
 173         uint64_t duration_max;
 174         /** Running capture duration since trigger event. */
 175         uint64_t duration_now;
 176
 177         /** Capture memory fill level. */
 178         size_t mem_addr_fill;
 179
 180         size_t mem_addr_done;
 181         size_t mem_addr_next;
 182         size_t mem_addr_stop;
 183
 184         size_t out_index;
 185
 186         struct libusb_transfer *xfer_in;
 187         struct libusb_transfer *xfer_out;
 188
 189         unsigned int capture_flags;
 190
 191         enum rle_state rle;
 192
 193         /** Whether to bypass the clock divider. */
 194         gboolean bypass_clockdiv;
 195
 196         /* Payload data buffers for incoming and outgoing transfers. */
 197         uint32_t xfer_buf_in[MAX_ACQ_RECV_LEN];
 198         uint16_t xfer_buf_out[MAX_ACQ_SEND_WORDS];
 199
 200         /* Payload buffer for sigrok logic packets. */
 201         uint8_t out_packet[PACKET_LENGTH * UNIT_SIZE];
 202 };
 203
 204 /** Private, per-device-instance driver context.
 205  */
 206 struct dev_context {
 207         /** The samplerate selected by the user. */
 208         uint64_t samplerate;
 209
 210         /** The maximimum sampling duration, in milliseconds. */
 211         uint64_t limit_msec;
 212
 213         /** The maximimum number of samples to acquire. */
 214         uint64_t limit_samples;
 215
 216         /** Channels to use. */
 217         uint64_t channel_mask;
 218
 219         uint64_t trigger_mask;
 220         uint64_t trigger_edge_mask;
 221         uint64_t trigger_values;
 222
 223         struct acquisition_state *acquisition;
 224
 225         struct regval_pair reg_write_seq[MAX_REG_WRITE_SEQ_LEN];
 226         int reg_write_pos;
 227         int reg_write_len;
 228
 229         enum device_state state;
 230
 231         /** The currently active clock configuration of the device. */
 232         enum clock_config cur_clock_config;
 233
 234         /** Clock source configuration setting. */
 235         enum clock_source cfg_clock_source;
 236         /** Clock edge configuration setting. */
 237         enum signal_edge cfg_clock_edge;
 238
 239         /** Trigger source configuration setting. */
 240         enum trigger_source cfg_trigger_source;
 241         /** Trigger slope configuration setting. */
 242         enum signal_edge cfg_trigger_slope;
 243
 244         /* Indicates that stopping the acquisition is currently in progress. */
 245         gboolean stopping_in_progress;
 246
 247         /* Indicates whether a transfer failed. */
 248         gboolean transfer_error;
 249 };
 250
 251 SR_PRIV struct acquisition_state *lwla_alloc_acquisition_state(void);
 252 SR_PRIV void lwla_free_acquisition_state(struct acquisition_state *acq);
 253
 254 SR_PRIV int lwla_init_device(const struct sr_dev_inst *sdi);
 255 SR_PRIV int lwla_convert_trigger(const struct sr_dev_inst *sdi);
 256 SR_PRIV int lwla_set_clock_config(const struct sr_dev_inst *sdi);
 257 SR_PRIV int lwla_setup_acquisition(const struct sr_dev_inst *sdi);
 258 SR_PRIV int lwla_start_acquisition(const struct sr_dev_inst *sdi);
 259 SR_PRIV int lwla_abort_acquisition(const struct sr_dev_inst *sdi);
 260
 261 SR_PRIV int lwla_receive_data(int fd, int revents, void *cb_data);
 262
 263 #endif /* !LIBSIGROK_HARDWARE_SYSCLK_LWLA_PROTOCOL_H */