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/>.
22 #include <glib/gstdio.h>
23 #include <libsigrok/libsigrok.h>
24 #include "libsigrok-internal.h"
28 #define BITSTREAM_MAX_SIZE (256 * 1024) /* bitstream size limit for safety */
29 #define BITSTREAM_HEADER_SIZE 4 /* transfer header size in bytes */
31 /* Load a bitstream file into memory. Returns a newly allocated array
32 * consisting of a 32-bit length field followed by the bitstream data.
34 static unsigned char *load_bitstream_file(const char *filename, int *length_p)
38 unsigned char *stream;
41 /* Retrieve and validate the file size. */
42 if (g_stat(filename, &statbuf) < 0) {
43 sr_err("Failed to access bitstream file: %s.",
47 if (!S_ISREG(statbuf.st_mode)) {
48 sr_err("Bitstream is not a regular file.");
51 if (statbuf.st_size <= 0 || statbuf.st_size > BITSTREAM_MAX_SIZE) {
52 sr_err("Refusing to load bitstream of unreasonable size "
53 "(%" PRIu64 " bytes).", (uint64_t)statbuf.st_size);
57 /* The message length includes the 4-byte header. */
58 length = BITSTREAM_HEADER_SIZE + statbuf.st_size;
59 stream = g_try_malloc(length);
61 sr_err("Failed to allocate bitstream buffer.");
65 file = g_fopen(filename, "rb");
67 sr_err("Failed to open bitstream file: %s.", g_strerror(errno));
72 /* Write the message length header. */
73 *(uint32_t *)stream = GUINT32_TO_BE(length);
75 count = fread(stream + BITSTREAM_HEADER_SIZE,
76 length - BITSTREAM_HEADER_SIZE, 1, file);
78 sr_err("Failed to read bitstream file: %s.", g_strerror(errno));
89 /* Load a Raw Binary File (.rbf) from the firmware directory and transfer
92 SR_PRIV int lwla_send_bitstream(const struct sr_usb_dev_inst *usb,
96 unsigned char *stream;
101 if (!usb || !basename)
104 filename = g_build_filename(FIRMWARE_DIR, basename, NULL);
105 sr_info("Downloading FPGA bitstream at '%s'.", filename);
107 stream = load_bitstream_file(filename, &length);
113 /* Transfer the entire bitstream in one URB. */
114 ret = libusb_bulk_transfer(usb->devhdl, EP_BITSTREAM,
115 stream, length, &xfer_len, USB_TIMEOUT_MS);
119 sr_err("Failed to transfer bitstream: %s.",
120 libusb_error_name(ret));
123 if (xfer_len != length) {
124 sr_err("Failed to transfer bitstream: incorrect length "
125 "%d != %d.", xfer_len, length);
128 sr_info("FPGA bitstream download of %d bytes done.", xfer_len);
130 /* This delay appears to be necessary for reliable operation. */
136 SR_PRIV int lwla_send_command(const struct sr_usb_dev_inst *usb,
137 const uint16_t *command, int cmd_len)
142 if (!usb || !command || cmd_len <= 0)
146 ret = libusb_bulk_transfer(usb->devhdl, EP_COMMAND,
147 (unsigned char *)command, cmd_len * 2,
148 &xfer_len, USB_TIMEOUT_MS);
150 sr_dbg("Failed to send command %d: %s.",
151 LWLA_TO_UINT16(command[0]), libusb_error_name(ret));
154 if (xfer_len != cmd_len * 2) {
155 sr_dbg("Failed to send command %d: incorrect length %d != %d.",
156 LWLA_TO_UINT16(command[0]), xfer_len, cmd_len * 2);
162 SR_PRIV int lwla_receive_reply(const struct sr_usb_dev_inst *usb,
163 uint32_t *reply, int reply_len, int expect_len)
168 if (!usb || !reply || reply_len <= 0)
172 ret = libusb_bulk_transfer(usb->devhdl, EP_REPLY,
173 (unsigned char *)reply, reply_len * 4,
174 &xfer_len, USB_TIMEOUT_MS);
176 sr_dbg("Failed to receive reply: %s.", libusb_error_name(ret));
179 if (xfer_len != expect_len * 4) {
180 sr_dbg("Failed to receive reply: incorrect length %d != %d.",
181 xfer_len, expect_len * 4);
187 SR_PRIV int lwla_read_reg(const struct sr_usb_dev_inst *usb,
188 uint16_t reg, uint32_t *value)
192 uint32_t reply[128]; /* full EP buffer to avoid overflows */
194 command[0] = LWLA_WORD(CMD_READ_REG);
195 command[1] = LWLA_WORD(reg);
197 ret = lwla_send_command(usb, command, ARRAY_SIZE(command));
202 ret = lwla_receive_reply(usb, reply, ARRAY_SIZE(reply), 1);
205 *value = LWLA_TO_UINT32(reply[0]);
210 SR_PRIV int lwla_write_reg(const struct sr_usb_dev_inst *usb,
211 uint16_t reg, uint32_t value)
215 command[0] = LWLA_WORD(CMD_WRITE_REG);
216 command[1] = LWLA_WORD(reg);
217 command[2] = LWLA_WORD_0(value);
218 command[3] = LWLA_WORD_1(value);
220 return lwla_send_command(usb, command, ARRAY_SIZE(command));
223 SR_PRIV int lwla_write_regs(const struct sr_usb_dev_inst *usb,
224 const struct regval_pair *regvals, int count)
231 for (i = 0; i < count; ++i) {
232 ret = lwla_write_reg(usb, regvals[i].reg, regvals[i].val);