blob: 020c3bf507174ac3e73c72e6afee6d008889a1a3 [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
48const struct dev_entry devs_usbblasterspi[] = {
49 {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
James Lairdc60de0e2013-03-27 13:00:23 +000054static struct ftdi_context ftdic;
55
56// command bytes
57#define BIT_BYTE (1<<7) // byte mode (rather than bitbang)
58#define BIT_READ (1<<6) // read request
59#define BIT_LED (1<<5)
60#define BIT_CS (1<<3)
61#define BIT_TMS (1<<1)
62#define BIT_CLK (1<<0)
63
64#define BUF_SIZE 64
65
66/* The programmer shifts bits in the wrong order for SPI, so we use this method to reverse the bits when needed.
67 * http://graphics.stanford.edu/~seander/bithacks.html#ReverseByteWith32Bits */
Jacob Garberbeeb8bc2019-06-21 15:24:17 -060068static uint8_t reverse(uint8_t b)
James Lairdc60de0e2013-03-27 13:00:23 +000069{
70 return ((b * 0x0802LU & 0x22110LU) | (b * 0x8020LU & 0x88440LU)) * 0x10101LU >> 16;
71}
72
James Lairdc60de0e2013-03-27 13:00:23 +000073static int send_write(unsigned int writecnt, const unsigned char *writearr)
74{
James Lairdc60de0e2013-03-27 13:00:23 +000075 uint8_t buf[BUF_SIZE];
76
77 memset(buf, 0, sizeof(buf));
78 while (writecnt) {
Nico Huber519be662018-12-23 20:03:35 +010079 unsigned int i;
James Lairdc60de0e2013-03-27 13:00:23 +000080 unsigned int n_write = min(writecnt, BUF_SIZE - 1);
81 msg_pspew("writing %d-byte packet\n", n_write);
82
83 buf[0] = BIT_BYTE | (uint8_t)n_write;
84 for (i = 0; i < n_write; i++) {
85 buf[i+1] = reverse(writearr[i]);
86 }
87 if (ftdi_write_data(&ftdic, buf, n_write + 1) < 0) {
88 msg_perr("USB-Blaster write failed\n");
89 return -1;
90 }
91
92 writearr += n_write;
93 writecnt -= n_write;
94 }
95 return 0;
96}
97
98static int send_read(unsigned int readcnt, unsigned char *readarr)
99{
100 int i;
101 unsigned int n_read;
102 uint8_t buf[BUF_SIZE];
103 memset(buf, 0, sizeof(buf));
104
105 n_read = readcnt;
106 while (n_read) {
107 unsigned int payload_size = min(n_read, BUF_SIZE - 1);
108 msg_pspew("reading %d-byte packet\n", payload_size);
109
110 buf[0] = BIT_BYTE | BIT_READ | (uint8_t)payload_size;
111 if (ftdi_write_data(&ftdic, buf, payload_size + 1) < 0) {
112 msg_perr("USB-Blaster write failed\n");
113 return -1;
114 }
115 n_read -= payload_size;
David Hendricks17d46372020-06-23 14:16:26 -0700116 }
James Lairdc60de0e2013-03-27 13:00:23 +0000117
118 n_read = readcnt;
119 while (n_read) {
120 int ret = ftdi_read_data(&ftdic, readarr, n_read);
121 if (ret < 0) {
122 msg_perr("USB-Blaster read failed\n");
123 return -1;
124 }
125 for (i = 0; i < ret; i++) {
126 readarr[i] = reverse(readarr[i]);
127 }
128 n_read -= ret;
129 readarr += ret;
130 }
131 return 0;
132}
133
134/* Returns 0 upon success, a negative number upon errors. */
Edward O'Callaghane4ddc362020-04-12 17:27:53 +1000135static int usbblaster_spi_send_command(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
James Lairdc60de0e2013-03-27 13:00:23 +0000136 const unsigned char *writearr, unsigned char *readarr)
137{
138 uint8_t cmd;
139 int ret = 0;
140
141 cmd = BIT_LED; // asserts /CS
142 if (ftdi_write_data(&ftdic, &cmd, 1) < 0) {
143 msg_perr("USB-Blaster enable chip select failed\n");
144 ret = -1;
145 }
146
147 if (!ret && writecnt)
148 ret = send_write(writecnt, writearr);
149
150 if (!ret && readcnt)
151 ret = send_read(readcnt, readarr);
152
153 cmd = BIT_CS;
154 if (ftdi_write_data(&ftdic, &cmd, 1) < 0) {
155 msg_perr("USB-Blaster disable chip select failed\n");
156 ret = -1;
157 }
158
159 return ret;
160}
161
162
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000163static const struct spi_master spi_master_usbblaster = {
James Lairdc60de0e2013-03-27 13:00:23 +0000164 .max_data_read = 256,
165 .max_data_write = 256,
166 .command = usbblaster_spi_send_command,
167 .multicommand = default_spi_send_multicommand,
168 .read = default_spi_read,
169 .write_256 = default_spi_write_256,
170 .write_aai = default_spi_write_aai,
171};
172
Anastasia Klimchuke7045832021-03-23 16:34:07 +1100173/* Returns 0 upon success, a negative number upon errors. */
174int usbblaster_spi_init(void)
175{
176 uint8_t buf[BUF_SIZE + 1];
177
178 if (ftdi_init(&ftdic) < 0)
179 return -1;
180
181 if (ftdi_usb_open(&ftdic, ALTERA_VID, ALTERA_USBBLASTER_PID) < 0) {
182 msg_perr("Failed to open USB-Blaster: %s\n", ftdic.error_str);
183 return -1;
184 }
185
186 if (ftdi_usb_reset(&ftdic) < 0) {
187 msg_perr("USB-Blaster reset failed\n");
188 return -1;
189 }
190
191 if (ftdi_set_latency_timer(&ftdic, 2) < 0) {
192 msg_perr("USB-Blaster set latency timer failed\n");
193 return -1;
194 }
195
196 if (ftdi_write_data_set_chunksize(&ftdic, 4096) < 0 ||
197 ftdi_read_data_set_chunksize(&ftdic, BUF_SIZE) < 0) {
198 msg_perr("USB-Blaster set chunk size failed\n");
199 return -1;
200 }
201
202 memset(buf, 0, sizeof(buf));
203 buf[sizeof(buf)-1] = BIT_LED | BIT_CS;
204 if (ftdi_write_data(&ftdic, buf, sizeof(buf)) < 0) {
205 msg_perr("USB-Blaster reset write failed\n");
206 return -1;
207 }
208 if (ftdi_read_data(&ftdic, buf, sizeof(buf)) < 0) {
209 msg_perr("USB-Blaster reset read failed\n");
210 return -1;
211 }
212
213 register_spi_master(&spi_master_usbblaster);
214 return 0;
215}
216
James Lairdc60de0e2013-03-27 13:00:23 +0000217#endif