2 * Driver for USB-JTAG, Altera USB-Blaster II and compatibles
4 * Copyright (C) 2013 Franck Jullien franck.jullien@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 2 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/>.
24 #include <jtag/interface.h>
25 #include <jtag/commands.h>
26 #include <libusb_helper.h>
27 #include <target/image.h>
29 #include "ublast_access.h"
31 #define USBBLASTER_CTRL_READ_REV 0x94
32 #define USBBLASTER_CTRL_LOAD_FIRM 0xA0
33 #define USBBLASTER_EPOUT 4
34 #define USBBLASTER_EPIN 8
36 #define EZUSB_CPUCS 0xe600
39 /** Maximum size of a single firmware section. Entire EZ-USB code space = 16kB */
40 #define SECTION_BUFFERSIZE 16384
42 static int ublast2_libusb_read(struct ublast_lowlevel *low, uint8_t *buf,
43 unsigned size, uint32_t *bytes_read)
47 ret = jtag_libusb_bulk_read(low->libusb_dev,
58 static int ublast2_libusb_write(struct ublast_lowlevel *low, uint8_t *buf,
59 int size, uint32_t *bytes_written)
63 ret = jtag_libusb_bulk_write(low->libusb_dev,
75 static int ublast2_write_firmware_section(struct libusb_device_handle *libusb_dev,
76 struct image *firmware_image, int section_index)
79 uint8_t data[SECTION_BUFFERSIZE];
80 uint8_t *data_ptr = data;
83 uint16_t size = (uint16_t)firmware_image->sections[section_index].size;
84 uint16_t addr = (uint16_t)firmware_image->sections[section_index].base_address;
86 LOG_DEBUG("section %02i at addr 0x%04x (size 0x%04x)", section_index, addr,
89 /* Copy section contents to local buffer */
90 int ret = image_read_section(firmware_image, section_index, 0, size, data,
93 if ((ret != ERROR_OK) || (size_read != size)) {
94 /* Propagating the return code would return '0' (misleadingly indicating
95 * successful execution of the function) if only the size check fails. */
99 uint16_t bytes_remaining = size;
101 /* Send section data in chunks of up to 64 bytes to ULINK */
102 while (bytes_remaining > 0) {
103 if (bytes_remaining > 64)
106 chunk_size = bytes_remaining;
108 jtag_libusb_control_transfer(libusb_dev,
109 LIBUSB_REQUEST_TYPE_VENDOR |
111 USBBLASTER_CTRL_LOAD_FIRM,
118 bytes_remaining -= chunk_size;
120 data_ptr += chunk_size;
126 static int load_usb_blaster_firmware(struct libusb_device_handle *libusb_dev,
127 struct ublast_lowlevel *low)
129 struct image ublast2_firmware_image;
131 if (!low->firmware_path) {
132 LOG_ERROR("No firmware path specified");
136 if (libusb_claim_interface(libusb_dev, 0)) {
137 LOG_ERROR("unable to claim interface");
138 return ERROR_JTAG_INIT_FAILED;
141 ublast2_firmware_image.base_address = 0;
142 ublast2_firmware_image.base_address_set = false;
144 int ret = image_open(&ublast2_firmware_image, low->firmware_path, "ihex");
145 if (ret != ERROR_OK) {
146 LOG_ERROR("Could not load firmware image");
150 /** A host loader program must write 0x01 to the CPUCS register
151 * to put the CPU into RESET, load all or part of the EZUSB
152 * RAM with firmware, then reload the CPUCS register
153 * with ‘0’ to take the CPU out of RESET. The CPUCS register
154 * (at 0xE600) is the only EZ-USB register that can be written
155 * using the Firmware Download command.
158 char value = CPU_RESET;
159 jtag_libusb_control_transfer(libusb_dev,
160 LIBUSB_REQUEST_TYPE_VENDOR |
162 USBBLASTER_CTRL_LOAD_FIRM,
169 /* Download all sections in the image to ULINK */
170 for (unsigned int i = 0; i < ublast2_firmware_image.num_sections; i++) {
171 ret = ublast2_write_firmware_section(libusb_dev,
172 &ublast2_firmware_image, i);
173 if (ret != ERROR_OK) {
174 LOG_ERROR("Error while downloading the firmware");
180 jtag_libusb_control_transfer(libusb_dev,
181 LIBUSB_REQUEST_TYPE_VENDOR |
183 USBBLASTER_CTRL_LOAD_FIRM,
190 image_close(&ublast2_firmware_image);
193 * Release claimed interface. Most probably it is already disconnected
194 * and re-enumerated as new devices after firmware upload, so we do
195 * not need to care about errors.
197 libusb_release_interface(libusb_dev, 0);
202 static int ublast2_libusb_init(struct ublast_lowlevel *low)
204 const uint16_t vids[] = { low->ublast_vid_uninit, 0 };
205 const uint16_t pids[] = { low->ublast_pid_uninit, 0 };
206 struct libusb_device_handle *temp;
207 bool renumeration = false;
210 if (jtag_libusb_open(vids, pids, NULL, &temp, NULL) == ERROR_OK) {
211 LOG_INFO("Altera USB-Blaster II (uninitialized) found");
212 LOG_INFO("Loading firmware...");
213 ret = load_usb_blaster_firmware(temp, low);
214 jtag_libusb_close(temp);
220 const uint16_t vids_renum[] = { low->ublast_vid, 0 };
221 const uint16_t pids_renum[] = { low->ublast_pid, 0 };
223 if (renumeration == false) {
224 if (jtag_libusb_open(vids_renum, pids_renum, NULL,
225 &low->libusb_dev, NULL) != ERROR_OK) {
226 LOG_ERROR("Altera USB-Blaster II not found");
231 while (jtag_libusb_open(vids_renum, pids_renum, NULL,
232 &low->libusb_dev, NULL) != ERROR_OK && retry--) {
234 LOG_INFO("Waiting for reenumerate...");
238 LOG_ERROR("Altera USB-Blaster II not found");
243 if (libusb_claim_interface(low->libusb_dev, 0)) {
244 LOG_ERROR("unable to claim interface");
245 jtag_libusb_close(low->libusb_dev);
246 return ERROR_JTAG_INIT_FAILED;
250 jtag_libusb_control_transfer(low->libusb_dev,
251 LIBUSB_REQUEST_TYPE_VENDOR |
253 USBBLASTER_CTRL_READ_REV,
260 LOG_INFO("Altera USB-Blaster II found (Firm. rev. = %s)", buffer);
265 static int ublast2_libusb_quit(struct ublast_lowlevel *low)
267 if (libusb_release_interface(low->libusb_dev, 0))
268 LOG_ERROR("usb release interface failed");
270 jtag_libusb_close(low->libusb_dev);
274 static struct ublast_lowlevel low = {
275 .open = ublast2_libusb_init,
276 .close = ublast2_libusb_quit,
277 .read = ublast2_libusb_read,
278 .write = ublast2_libusb_write,
279 .flags = COPY_TDO_BUFFER,
282 struct ublast_lowlevel *ublast2_register_libusb(void)