blob: 8b442dbb3219b9a9d03ef478c007f49366c5b7e2 [file] [log] [blame]
James Lairdc60de0e2013-03-27 13:00:23 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2012 James Laird <jhl@mafipulation.org>
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; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
James Lairdc60de0e2013-03-27 13:00:23 +000014 */
15
16/*
17 * Device should be connected as per "active serial" mode:
18 *
19 * +---------+------+-----------+
20 * | SPI | Pin | Altera |
21 * +---------+------+-----------+
22 * | SCLK | 1 | DCLK |
23 * | GND | 2,10 | GND |
24 * | VCC | 4 | VCC(TRGT) |
25 * | MISO | 7 | DATAOUT |
26 * | /CS | 8 | nCS |
27 * | MOSI | 9 | ASDI |
28 * +---------+------+-----------+
29 *
30 * See also the USB-Blaster Download Cable User Guide: http://www.altera.com/literature/ug/ug_usb_blstr.pdf
31 */
32
33#if CONFIG_USBBLASTER_SPI == 1
34
35#include <stdio.h>
36#include <string.h>
37#include <stdlib.h>
38#include <ctype.h>
39#include <ftdi.h>
40#include "flash.h"
41#include "programmer.h"
42#include "spi.h"
43
44/* Please keep sorted by vendor ID, then device ID. */
45#define ALTERA_VID 0x09fb
46#define ALTERA_USBBLASTER_PID 0x6001
47
Thomas Heijligencc853d82021-05-04 15:32:17 +020048static const struct dev_entry devs_usbblasterspi[] = {
James Lairdc60de0e2013-03-27 13:00:23 +000049 {ALTERA_VID, ALTERA_USBBLASTER_PID, OK, "Altera", "USB-Blaster"},
50
Evgeny Zinoviev83c56b82019-11-05 17:47:43 +030051 {0}
James Lairdc60de0e2013-03-27 13:00:23 +000052};
53
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +000054static const struct spi_master spi_master_usbblaster;
James Lairdc60de0e2013-03-27 13:00:23 +000055
56static struct ftdi_context ftdic;
57
58// command bytes
59#define BIT_BYTE (1<<7) // byte mode (rather than bitbang)
60#define BIT_READ (1<<6) // read request
61#define BIT_LED (1<<5)
62#define BIT_CS (1<<3)
63#define BIT_TMS (1<<1)
64#define BIT_CLK (1<<0)
65
66#define BUF_SIZE 64
67
68/* The programmer shifts bits in the wrong order for SPI, so we use this method to reverse the bits when needed.
69 * http://graphics.stanford.edu/~seander/bithacks.html#ReverseByteWith32Bits */
Jacob Garberbeeb8bc2019-06-21 15:24:17 -060070static uint8_t reverse(uint8_t b)
James Lairdc60de0e2013-03-27 13:00:23 +000071{
72 return ((b * 0x0802LU & 0x22110LU) | (b * 0x8020LU & 0x88440LU)) * 0x10101LU >> 16;
73}
74
75
76/* Returns 0 upon success, a negative number upon errors. */
Thomas Heijligencc853d82021-05-04 15:32:17 +020077static int usbblaster_spi_init(void)
James Lairdc60de0e2013-03-27 13:00:23 +000078{
Angel Pons7e134562021-06-07 13:29:13 +020079 uint8_t buf[BUF_SIZE + 1] = { 0 };
James Lairdc60de0e2013-03-27 13:00:23 +000080
81 if (ftdi_init(&ftdic) < 0)
82 return -1;
83
84 if (ftdi_usb_open(&ftdic, ALTERA_VID, ALTERA_USBBLASTER_PID) < 0) {
85 msg_perr("Failed to open USB-Blaster: %s\n", ftdic.error_str);
86 return -1;
87 }
88
89 if (ftdi_usb_reset(&ftdic) < 0) {
90 msg_perr("USB-Blaster reset failed\n");
91 return -1;
92 }
93
94 if (ftdi_set_latency_timer(&ftdic, 2) < 0) {
95 msg_perr("USB-Blaster set latency timer failed\n");
96 return -1;
97 }
98
99 if (ftdi_write_data_set_chunksize(&ftdic, 4096) < 0 ||
100 ftdi_read_data_set_chunksize(&ftdic, BUF_SIZE) < 0) {
101 msg_perr("USB-Blaster set chunk size failed\n");
102 return -1;
103 }
104
James Lairdc60de0e2013-03-27 13:00:23 +0000105 buf[sizeof(buf)-1] = BIT_LED | BIT_CS;
106 if (ftdi_write_data(&ftdic, buf, sizeof(buf)) < 0) {
107 msg_perr("USB-Blaster reset write failed\n");
108 return -1;
109 }
110 if (ftdi_read_data(&ftdic, buf, sizeof(buf)) < 0) {
111 msg_perr("USB-Blaster reset read failed\n");
112 return -1;
113 }
114
Nico Huber5e08e3e2021-05-11 17:38:14 +0200115 register_spi_master(&spi_master_usbblaster, NULL);
James Lairdc60de0e2013-03-27 13:00:23 +0000116 return 0;
117}
118
119static int send_write(unsigned int writecnt, const unsigned char *writearr)
120{
Angel Pons7e134562021-06-07 13:29:13 +0200121 uint8_t buf[BUF_SIZE] = { 0 };
James Lairdc60de0e2013-03-27 13:00:23 +0000122
James Lairdc60de0e2013-03-27 13:00:23 +0000123 while (writecnt) {
Nico Huber519be662018-12-23 20:03:35 +0100124 unsigned int i;
James Lairdc60de0e2013-03-27 13:00:23 +0000125 unsigned int n_write = min(writecnt, BUF_SIZE - 1);
126 msg_pspew("writing %d-byte packet\n", n_write);
127
128 buf[0] = BIT_BYTE | (uint8_t)n_write;
129 for (i = 0; i < n_write; i++) {
130 buf[i+1] = reverse(writearr[i]);
131 }
132 if (ftdi_write_data(&ftdic, buf, n_write + 1) < 0) {
133 msg_perr("USB-Blaster write failed\n");
134 return -1;
135 }
136
137 writearr += n_write;
138 writecnt -= n_write;
139 }
140 return 0;
141}
142
143static int send_read(unsigned int readcnt, unsigned char *readarr)
144{
145 int i;
146 unsigned int n_read;
Angel Pons7e134562021-06-07 13:29:13 +0200147 uint8_t buf[BUF_SIZE] = { 0 };
James Lairdc60de0e2013-03-27 13:00:23 +0000148
149 n_read = readcnt;
150 while (n_read) {
151 unsigned int payload_size = min(n_read, BUF_SIZE - 1);
152 msg_pspew("reading %d-byte packet\n", payload_size);
153
154 buf[0] = BIT_BYTE | BIT_READ | (uint8_t)payload_size;
155 if (ftdi_write_data(&ftdic, buf, payload_size + 1) < 0) {
156 msg_perr("USB-Blaster write failed\n");
157 return -1;
158 }
159 n_read -= payload_size;
David Hendrickscdb290e2020-06-23 14:16:26 -0700160 }
James Lairdc60de0e2013-03-27 13:00:23 +0000161
162 n_read = readcnt;
163 while (n_read) {
164 int ret = ftdi_read_data(&ftdic, readarr, n_read);
165 if (ret < 0) {
166 msg_perr("USB-Blaster read failed\n");
167 return -1;
168 }
169 for (i = 0; i < ret; i++) {
170 readarr[i] = reverse(readarr[i]);
171 }
172 n_read -= ret;
173 readarr += ret;
174 }
175 return 0;
176}
177
178/* Returns 0 upon success, a negative number upon errors. */
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000179static int usbblaster_spi_send_command(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
James Lairdc60de0e2013-03-27 13:00:23 +0000180 const unsigned char *writearr, unsigned char *readarr)
181{
182 uint8_t cmd;
183 int ret = 0;
184
185 cmd = BIT_LED; // asserts /CS
186 if (ftdi_write_data(&ftdic, &cmd, 1) < 0) {
187 msg_perr("USB-Blaster enable chip select failed\n");
188 ret = -1;
189 }
190
191 if (!ret && writecnt)
192 ret = send_write(writecnt, writearr);
193
194 if (!ret && readcnt)
195 ret = send_read(readcnt, readarr);
196
197 cmd = BIT_CS;
198 if (ftdi_write_data(&ftdic, &cmd, 1) < 0) {
199 msg_perr("USB-Blaster disable chip select failed\n");
200 ret = -1;
201 }
202
203 return ret;
204}
205
206
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000207static const struct spi_master spi_master_usbblaster = {
James Lairdc60de0e2013-03-27 13:00:23 +0000208 .max_data_read = 256,
209 .max_data_write = 256,
210 .command = usbblaster_spi_send_command,
211 .multicommand = default_spi_send_multicommand,
212 .read = default_spi_read,
213 .write_256 = default_spi_write_256,
214 .write_aai = default_spi_write_aai,
215};
216
Thomas Heijligencc853d82021-05-04 15:32:17 +0200217const struct programmer_entry programmer_usbblaster_spi = {
218 .name = "usbblaster_spi",
219 .type = USB,
220 .devs.dev = devs_usbblasterspi,
221 .init = usbblaster_spi_init,
222 .map_flash_region = fallback_map,
223 .unmap_flash_region = fallback_unmap,
224 .delay = internal_delay,
225};
226
James Lairdc60de0e2013-03-27 13:00:23 +0000227#endif