2 * This file is part of the libsigrok project.
4 * Copyright (C) 2014 Daniel Elstner <daniel.kitta@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_SYSCLK_LWLA_LWLA_H
21 #define LIBSIGROK_HARDWARE_SYSCLK_LWLA_LWLA_H
26 #include <libsigrok/libsigrok.h>
28 struct sr_usb_dev_inst;
30 /* Rotate argument n bits to the left.
31 * This construct is an idiom recognized by GCC as bit rotation.
33 #define LROTATE(a, n) (((a) << (n)) | ((a) >> (CHAR_BIT * sizeof(a) - (n))))
35 /* Convert 16-bit little endian LWLA protocol word to machine word order. */
36 #define LWLA_TO_UINT16(val) GUINT16_FROM_LE(val)
38 /* Convert 32-bit mixed endian LWLA protocol word to machine word order. */
39 #define LWLA_TO_UINT32(val) LROTATE(GUINT32_FROM_LE(val), 16)
41 /* Convert 16-bit argument to LWLA protocol word. */
42 #define LWLA_WORD(val) GUINT16_TO_LE(val)
44 /* Extract 16-bit units in mixed endian order from 32/64-bit value. */
45 #define LWLA_WORD_0(val) GUINT16_TO_LE(((val) >> 16) & 0xFFFF)
46 #define LWLA_WORD_1(val) GUINT16_TO_LE((val) & 0xFFFF)
47 #define LWLA_WORD_2(val) GUINT16_TO_LE(((val) >> 48) & 0xFFFF)
48 #define LWLA_WORD_3(val) GUINT16_TO_LE(((val) >> 32) & 0xFFFF)
50 /* Maximum number of 16-bit words sent at a time during acquisition.
51 * Used for allocating the libusb transfer buffer.
53 #define MAX_ACQ_SEND_LEN16 64 /* 43 for capture setup plus stuffing */
55 /* Maximum number of 32-bit words received at a time during acquisition.
56 * This is a multiple of the endpoint buffer size to avoid transfer overflow
59 #define MAX_ACQ_RECV_LEN32 (2 * 512 / 4)
61 /* Maximum length of a register read/write sequence.
63 #define MAX_REG_SEQ_LEN 16
65 /* Logic datafeed packet size in bytes.
66 * This is a multiple of both 4 and 5 to match any model's unit size
67 * and memory granularity.
69 #define PACKET_SIZE (5000 * 4 * 5)
71 /** USB device end points.
76 EP_REPLY = 6 | LIBUSB_ENDPOINT_IN
79 /** LWLA protocol command ID codes.
90 /** LWLA capture state flags.
91 * The bit positions are the same as in the LWLA1016 control register.
94 STATUS_CAPTURING = 1 << 2,
95 STATUS_TRIGGERED = 1 << 5,
96 STATUS_MEM_AVAIL = 1 << 6,
99 /** LWLA1034 run-length encoding states.
106 /** Register address/value pair.
113 /** LWLA sample acquisition and decompression state.
115 struct acquisition_state {
116 uint64_t samples_max; /* maximum number of samples to process */
117 uint64_t samples_done; /* number of samples sent to the session bus */
118 uint64_t duration_max; /* maximum capture duration in milliseconds */
119 uint64_t duration_now; /* running capture duration since trigger */
121 uint64_t sample; /* last sample read from capture memory */
122 uint64_t run_len; /* remaining run length of current sample */
124 struct libusb_transfer *xfer_in; /* USB in transfer record */
125 struct libusb_transfer *xfer_out; /* USB out transfer record */
127 size_t mem_addr_fill; /* capture memory fill level */
128 size_t mem_addr_done; /* position up to which data was received */
129 size_t mem_addr_next; /* start address for next async read */
130 size_t mem_addr_stop; /* end of memory range to be read */
131 size_t in_index; /* position in read transfer buffer */
132 size_t out_index; /* position in logic packet buffer */
133 enum rle_state rle; /* RLE decoding state */
135 gboolean rle_enabled; /* capturing in timing-state mode */
136 gboolean clock_boost; /* switch to faster clock during capture */
137 unsigned int status; /* last received device status */
139 unsigned int reg_seq_pos; /* index of next register/value pair */
140 unsigned int reg_seq_len; /* length of register/value sequence */
142 struct regval reg_sequence[MAX_REG_SEQ_LEN]; /* register buffer */
143 uint32_t xfer_buf_in[MAX_ACQ_RECV_LEN32]; /* USB in buffer */
144 uint16_t xfer_buf_out[MAX_ACQ_SEND_LEN16]; /* USB out buffer */
145 uint8_t out_packet[PACKET_SIZE]; /* logic payload */
148 static inline void lwla_queue_regval(struct acquisition_state *acq,
149 unsigned int reg, uint32_t value)
151 acq->reg_sequence[acq->reg_seq_len].reg = reg;
152 acq->reg_sequence[acq->reg_seq_len].val = value;
156 SR_PRIV int lwla_send_bitstream(struct sr_context *ctx,
157 const struct sr_usb_dev_inst *usb,
160 SR_PRIV int lwla_send_command(const struct sr_usb_dev_inst *usb,
161 const uint16_t *command, int cmd_len);
163 SR_PRIV int lwla_receive_reply(const struct sr_usb_dev_inst *usb,
164 uint32_t *reply, int reply_len, int expect_len);
166 SR_PRIV int lwla_read_reg(const struct sr_usb_dev_inst *usb,
167 uint16_t reg, uint32_t *value);
169 SR_PRIV int lwla_write_reg(const struct sr_usb_dev_inst *usb,
170 uint16_t reg, uint32_t value);
172 SR_PRIV int lwla_write_regs(const struct sr_usb_dev_inst *usb,
173 const struct regval *regvals, int count);