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