blob: 6508206fa84bb74f0b4730a616d6dc0f15b87d2e [file] [log] [blame]
Paul Fox05dfbe62009-06-16 21:08:06 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2009 Paul Fox <pgf@laptop.org>
Carl-Daniel Hailfinger5824fbf2010-05-21 23:09:42 +00005 * Copyright (C) 2009, 2010 Carl-Daniel Hailfinger
Paul Fox05dfbe62009-06-16 21:08:06 +00006 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 2 of the License.
10 *
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.
Paul Fox05dfbe62009-06-16 21:08:06 +000015 */
16
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000017#if CONFIG_FT2232_SPI == 1
Carl-Daniel Hailfinger3426ef62009-08-19 13:27:58 +000018
Paul Fox05dfbe62009-06-16 21:08:06 +000019#include <stdio.h>
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000020#include <strings.h>
Paul Fox05dfbe62009-06-16 21:08:06 +000021#include <string.h>
22#include <stdlib.h>
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +000023#include <ctype.h>
Paul Fox05dfbe62009-06-16 21:08:06 +000024#include "flash.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000025#include "programmer.h"
Paul Fox05dfbe62009-06-16 21:08:06 +000026#include "spi.h"
Paul Fox05dfbe62009-06-16 21:08:06 +000027#include <ftdi.h>
28
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000029/* This is not defined in libftdi.h <0.20 (c7e4c09e68cfa6f5e112334aa1b3bb23401c8dc7 to be exact).
Angel Pons44cfbb02021-04-17 17:07:34 +020030 * Some tests indicate that this is the only change that it is needed to support the FT232H in flashrom. */
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000031#if !defined(HAVE_FT232H)
32#define TYPE_232H 6
33#endif
34
Uwe Hermann836b26a2011-10-14 20:33:14 +000035/* Please keep sorted by vendor ID, then device ID. */
36
Uwe Hermann70145292010-07-29 19:57:55 +000037#define FTDI_VID 0x0403
38#define FTDI_FT2232H_PID 0x6010
39#define FTDI_FT4232H_PID 0x6011
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000040#define FTDI_FT232H_PID 0x6014
Uwe Hermann836b26a2011-10-14 20:33:14 +000041#define TIAO_TUMPA_PID 0x8a98
Stefan Taunerb66ed842014-04-27 05:07:35 +000042#define TIAO_TUMPA_LITE_PID 0x8a99
Uwe Hermann70145292010-07-29 19:57:55 +000043#define AMONTEC_JTAGKEY_PID 0xCFF8
Jörg Fischer6529b9f2010-07-29 15:54:53 +000044
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000045#define GOEPEL_VID 0x096C
46#define GOEPEL_PICOTAP_PID 0x1449
47
Alex Badeacaf2d422010-11-10 03:26:57 +000048#define FIC_VID 0x1457
49#define OPENMOKO_DBGBOARD_PID 0x5118
50
Pete Batardc0207062011-06-11 12:21:37 +000051#define OLIMEX_VID 0x15BA
52#define OLIMEX_ARM_OCD_PID 0x0003
53#define OLIMEX_ARM_TINY_PID 0x0004
54#define OLIMEX_ARM_OCD_H_PID 0x002B
55#define OLIMEX_ARM_TINY_H_PID 0x002A
56
Todd Broch6800c952016-02-14 15:46:00 +000057#define GOOGLE_VID 0x18D1
58#define GOOGLE_SERVO_PID 0x5001
59#define GOOGLE_SERVO_V2_PID0 0x5002
60#define GOOGLE_SERVO_V2_PID1 0x5003
61
Thomas Heijligencc853d82021-05-04 15:32:17 +020062static const struct dev_entry devs_ft2232spi[] = {
Uwe Hermann70145292010-07-29 19:57:55 +000063 {FTDI_VID, FTDI_FT2232H_PID, OK, "FTDI", "FT2232H"},
64 {FTDI_VID, FTDI_FT4232H_PID, OK, "FTDI", "FT4232H"},
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000065 {FTDI_VID, FTDI_FT232H_PID, OK, "FTDI", "FT232H"},
Uwe Hermann836b26a2011-10-14 20:33:14 +000066 {FTDI_VID, TIAO_TUMPA_PID, OK, "TIAO", "USB Multi-Protocol Adapter"},
Stefan Taunerb66ed842014-04-27 05:07:35 +000067 {FTDI_VID, TIAO_TUMPA_LITE_PID, OK, "TIAO", "USB Multi-Protocol Adapter Lite"},
Uwe Hermann70145292010-07-29 19:57:55 +000068 {FTDI_VID, AMONTEC_JTAGKEY_PID, OK, "Amontec", "JTAGkey"},
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000069 {GOEPEL_VID, GOEPEL_PICOTAP_PID, OK, "GOEPEL", "PicoTAP"},
Todd Broch6800c952016-02-14 15:46:00 +000070 {GOOGLE_VID, GOOGLE_SERVO_PID, OK, "Google", "Servo"},
71 {GOOGLE_VID, GOOGLE_SERVO_V2_PID0, OK, "Google", "Servo V2 Legacy"},
72 {GOOGLE_VID, GOOGLE_SERVO_V2_PID1, OK, "Google", "Servo V2"},
Stefan Tauner3e515e22012-09-26 00:48:16 +000073 {FIC_VID, OPENMOKO_DBGBOARD_PID, OK, "FIC", "OpenMoko Neo1973 Debug board (V2+)"},
Stefan Tauner74dc73f2015-03-01 22:04:38 +000074 {OLIMEX_VID, OLIMEX_ARM_OCD_PID, OK, "Olimex", "ARM-USB-OCD"},
Pete Batardc0207062011-06-11 12:21:37 +000075 {OLIMEX_VID, OLIMEX_ARM_TINY_PID, OK, "Olimex", "ARM-USB-TINY"},
Stefan Tauner6697f712014-08-06 15:09:15 +000076 {OLIMEX_VID, OLIMEX_ARM_OCD_H_PID, OK, "Olimex", "ARM-USB-OCD-H"},
Stefan Taunerc2eec2c2014-05-03 21:33:01 +000077 {OLIMEX_VID, OLIMEX_ARM_TINY_H_PID, OK, "Olimex", "ARM-USB-TINY-H"},
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000078
79 {0},
Jörg Fischer6529b9f2010-07-29 15:54:53 +000080};
81
Simon Buhrowdb9be312021-04-09 14:48:39 +020082#define FTDI_HW_BUFFER_SIZE 4096 /* in bytes */
83
Samir Ibradžićb482c6d2012-05-15 22:58:19 +000084#define DEFAULT_DIVISOR 2
Paul Fox05dfbe62009-06-16 21:08:06 +000085
Uwe Hermannc67d0372009-10-01 18:40:02 +000086#define BITMODE_BITBANG_NORMAL 1
87#define BITMODE_BITBANG_SPI 2
Paul Fox05dfbe62009-06-16 21:08:06 +000088
Antony Pavlovb4dd40c2015-01-25 03:52:47 +000089/* The variables cs_bits and pindir store the values for the "set data bits low byte" MPSSE command that
90 * sets the initial state and the direction of the I/O pins. The pin offsets are as follows:
91 * SCK is bit 0.
92 * DO is bit 1.
93 * DI is bit 2.
94 * CS is bit 3.
95 *
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +100096 * The default values (set below in ft2232_spi_init) are used for most devices:
Jörg Fischer6529b9f2010-07-29 15:54:53 +000097 * value: 0x08 CS=high, DI=low, DO=low, SK=low
98 * dir: 0x0b CS=output, DI=input, DO=output, SK=output
Jörg Fischer6529b9f2010-07-29 15:54:53 +000099 */
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000100struct ft2232_data {
101 uint8_t cs_bits;
102 uint8_t pindir;
103 struct ftdi_context ftdi_context;
104};
Paul Fox05dfbe62009-06-16 21:08:06 +0000105
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000106static const char *get_ft2232_devicename(int ft2232_vid, int ft2232_type)
107{
108 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000109 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000110 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000111 return devs_ft2232spi[i].device_name;
112 }
113 return "unknown device";
114}
115
116static const char *get_ft2232_vendorname(int ft2232_vid, int ft2232_type)
117{
118 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000119 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000120 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Uwe Hermann70145292010-07-29 19:57:55 +0000121 return devs_ft2232spi[i].vendor_name;
122 }
123 return "unknown vendor";
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000124}
125
Uwe Hermann70145292010-07-29 19:57:55 +0000126static int send_buf(struct ftdi_context *ftdic, const unsigned char *buf,
127 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000128{
129 int r;
130 r = ftdi_write_data(ftdic, (unsigned char *) buf, size);
131 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000132 msg_perr("ftdi_write_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Paul Fox05dfbe62009-06-16 21:08:06 +0000133 return 1;
134 }
135 return 0;
136}
137
Uwe Hermann70145292010-07-29 19:57:55 +0000138static int get_buf(struct ftdi_context *ftdic, const unsigned char *buf,
139 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000140{
141 int r;
Alex Badeab9556e02010-11-10 03:10:41 +0000142
143 while (size > 0) {
144 r = ftdi_read_data(ftdic, (unsigned char *) buf, size);
145 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000146 msg_perr("ftdi_read_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Alex Badeab9556e02010-11-10 03:10:41 +0000147 return 1;
148 }
149 buf += r;
150 size -= r;
Paul Fox05dfbe62009-06-16 21:08:06 +0000151 }
152 return 0;
153}
154
Alan Green460c1c02021-01-08 09:36:45 +1100155static int ft2232_shutdown(void *data)
156{
157 int f;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000158 struct ft2232_data *spi_data = (struct ft2232_data *)data;
159 struct ftdi_context *ftdic = &spi_data->ftdi_context;
Alan Green460c1c02021-01-08 09:36:45 +1100160 unsigned char buf[3];
161
162 msg_pdbg("Releasing I/Os\n");
163 buf[0] = SET_BITS_LOW;
164 buf[1] = 0; /* Output byte ignored */
165 buf[2] = 0; /* Pin direction: all inputs */
166 if (send_buf(ftdic, buf, 3)) {
167 msg_perr("Unable to set pins back inputs: (%s)\n",
168 ftdi_get_error_string(ftdic));
169 }
170
171 if ((f = ftdi_usb_close(ftdic)) < 0) {
172 msg_perr("Unable to close FTDI device: %d (%s)\n", f,
173 ftdi_get_error_string(ftdic));
174 return f;
175 }
176
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000177 free(spi_data);
Alan Green460c1c02021-01-08 09:36:45 +1100178 return 0;
179}
180
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000181static int ft2232_spi_send_command(const struct flashctx *flash,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000182 unsigned int writecnt, unsigned int readcnt,
183 const unsigned char *writearr,
184 unsigned char *readarr);
Michael Karcherb9dbe482011-05-11 17:07:07 +0000185
Simon Buhrowdb9be312021-04-09 14:48:39 +0200186static bool ft2232_spi_command_fits(const struct spi_command *cmd, size_t buffer_size)
187{
188 const size_t cmd_len = 3; /* same length for any ft2232 command */
189 return
190 /* commands for CS# assertion and de-assertion: */
191 cmd_len + cmd_len
192 /* commands for either a write, a read or both: */
193 + (cmd->writecnt && cmd->readcnt ? cmd_len + cmd_len : cmd_len)
194 /* payload (only writecnt; readcnt concerns another buffer): */
195 + cmd->writecnt
196 <= buffer_size;
197}
198
199/* Returns 0 upon success, a negative number upon errors. */
200static int ft2232_spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds)
201{
202 struct ft2232_data *spi_data = flash->mst->spi.data;
203 struct ftdi_context *ftdic = &spi_data->ftdi_context;
204 static unsigned char buf[FTDI_HW_BUFFER_SIZE];
205 size_t i = 0;
206 int ret = 0;
207
208 /*
209 * Minimize FTDI-calls by packing as many commands as possible together.
210 */
211 for (; cmds->writecnt || cmds->readcnt; cmds++) {
212
213 if (cmds->writecnt > 65536 || cmds->readcnt > 65536)
214 return SPI_INVALID_LENGTH;
215
216 if (!ft2232_spi_command_fits(cmds, FTDI_HW_BUFFER_SIZE - i)) {
217 msg_perr("Command does not fit\n");
218 return SPI_GENERIC_ERROR;
219 }
220
221 msg_pspew("Assert CS#\n");
222 buf[i++] = SET_BITS_LOW;
223 buf[i++] = 0 & ~spi_data->cs_bits; /* assertive */
224 buf[i++] = spi_data->pindir;
225
226 /* WREN, OP(PROGRAM, ERASE), ADDR, DATA */
227 if (cmds->writecnt) {
228 buf[i++] = MPSSE_DO_WRITE | MPSSE_WRITE_NEG;
229 buf[i++] = (cmds->writecnt - 1) & 0xff;
230 buf[i++] = ((cmds->writecnt - 1) >> 8) & 0xff;
231 memcpy(buf + i, cmds->writearr, cmds->writecnt);
232 i += cmds->writecnt;
233 }
234
235 /* An optional read command */
236 if (cmds->readcnt) {
237 buf[i++] = MPSSE_DO_READ;
238 buf[i++] = (cmds->readcnt - 1) & 0xff;
239 buf[i++] = ((cmds->readcnt - 1) >> 8) & 0xff;
240 }
241
242 /* Add final de-assert CS# */
243 msg_pspew("De-assert CS#\n");
244 buf[i++] = SET_BITS_LOW;
245 buf[i++] = spi_data->cs_bits;
246 buf[i++] = spi_data->pindir;
247
248 /* continue if there is no read-cmd and further cmds exist */
249 if (!cmds->readcnt &&
250 ((cmds + 1)->writecnt || (cmds + 1)->readcnt) &&
251 ft2232_spi_command_fits((cmds + 1), FTDI_HW_BUFFER_SIZE - i)) {
252 continue;
253 }
254
255 ret = send_buf(ftdic, buf, i);
256 i = 0;
257 if (ret) {
258 msg_perr("send_buf failed: %i\n", ret);
259 break;
260 }
261
262 if (cmds->readcnt) {
263 ret = get_buf(ftdic, cmds->readarr, cmds->readcnt);
264 if (ret) {
265 msg_perr("get_buf failed: %i\n", ret);
266 break;
267 }
268 }
269 }
270 return ret ? -1 : 0;
271}
272
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000273static struct spi_master spi_master_ft2232 = {
Nico Huber1cf407b2017-11-10 20:18:23 +0100274 .features = SPI_MASTER_4BA,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000275 .max_data_read = 64 * 1024,
276 .max_data_write = 256,
277 .command = ft2232_spi_send_command,
Simon Buhrowdb9be312021-04-09 14:48:39 +0200278 .multicommand = ft2232_spi_send_multicommand,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000279 .read = default_spi_read,
280 .write_256 = default_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000281 .write_aai = default_spi_write_aai,
Michael Karcherb9dbe482011-05-11 17:07:07 +0000282};
283
Uwe Hermann274a20d2011-07-21 09:18:18 +0000284/* Returns 0 upon success, a negative number upon errors. */
Thomas Heijligencc853d82021-05-04 15:32:17 +0200285static int ft2232_spi_init(void)
Paul Fox05dfbe62009-06-16 21:08:06 +0000286{
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000287 int ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000288 unsigned char buf[512];
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000289 int ft2232_vid = FTDI_VID;
290 int ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000291 int channel_count = 4; /* Stores the number of channels of the device. */
292 enum ftdi_interface ft2232_interface = INTERFACE_A;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000293 /*
294 * The 'H' chips can run with an internal clock of either 12 MHz or 60 MHz,
295 * but the non-H chips can only run at 12 MHz. We enable the divide-by-5
296 * prescaler on the former to run on the same speed.
297 */
298 uint8_t clock_5x = 1;
299 /* In addition to the prescaler mentioned above there is also another
300 * configurable one on all versions of the chips. Its divisor div can be
301 * set by a 16 bit value x according to the following formula:
302 * div = (1 + x) * 2 <-> x = div / 2 - 1
303 * Hence the expressible divisors are all even numbers between 2 and
304 * 2^17 (=131072) resulting in SCK frequencies of 6 MHz down to about
305 * 92 Hz for 12 MHz inputs.
306 */
307 uint32_t divisor = DEFAULT_DIVISOR;
308 int f;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000309 char *arg;
Alex Badea0b94d052010-11-10 03:18:41 +0000310 double mpsse_clk;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000311 uint8_t cs_bits = 0x08;
312 uint8_t pindir = 0x0b;
313
314 struct ft2232_data *const spi_data = calloc(1, sizeof(*spi_data));
315 if (!spi_data) {
316 msg_perr("Unable to allocate space for SPI master data\n");
317 return SPI_GENERIC_ERROR;
318 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000319
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000320 arg = extract_programmer_param("type");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000321 if (arg) {
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000322 if (!strcasecmp(arg, "2232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000323 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000324 channel_count = 2;
325 } else if (!strcasecmp(arg, "4232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000326 ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000327 channel_count = 4;
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000328 } else if (!strcasecmp(arg, "232H")) {
329 ft2232_type = FTDI_FT232H_PID;
330 channel_count = 1;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000331 } else if (!strcasecmp(arg, "jtagkey")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000332 ft2232_type = AMONTEC_JTAGKEY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000333 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000334 /* JTAGkey(2) needs to enable its output via Bit4 / GPIOL0
335 * value: 0x18 OE=high, CS=high, DI=low, DO=low, SK=low
336 * dir: 0x1b OE=output, CS=output, DI=input, DO=output, SK=output */
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000337 cs_bits = 0x18;
Uwe Hermann70145292010-07-29 19:57:55 +0000338 pindir = 0x1b;
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000339 } else if (!strcasecmp(arg, "picotap")) {
340 ft2232_vid = GOEPEL_VID;
341 ft2232_type = GOEPEL_PICOTAP_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000342 channel_count = 2;
Uwe Hermann836b26a2011-10-14 20:33:14 +0000343 } else if (!strcasecmp(arg, "tumpa")) {
344 /* Interface A is SPI1, B is SPI2. */
345 ft2232_type = TIAO_TUMPA_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000346 channel_count = 2;
Stefan Taunerb66ed842014-04-27 05:07:35 +0000347 } else if (!strcasecmp(arg, "tumpalite")) {
348 /* Only one channel is used on lite edition */
349 ft2232_type = TIAO_TUMPA_LITE_PID;
350 channel_count = 1;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000351 } else if (!strcasecmp(arg, "busblaster")) {
352 /* In its default configuration it is a jtagkey clone */
353 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000354 channel_count = 2;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000355 cs_bits = 0x18;
356 pindir = 0x1b;
Alex Badeacaf2d422010-11-10 03:26:57 +0000357 } else if (!strcasecmp(arg, "openmoko")) {
358 ft2232_vid = FIC_VID;
359 ft2232_type = OPENMOKO_DBGBOARD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000360 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000361 } else if (!strcasecmp(arg, "arm-usb-ocd")) {
362 ft2232_vid = OLIMEX_VID;
363 ft2232_type = OLIMEX_ARM_OCD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000364 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000365 /* arm-usb-ocd(-h) has an output buffer that needs to be enabled by pulling ADBUS4 low.
366 * value: 0x08 #OE=low, CS=high, DI=low, DO=low, SK=low
367 * dir: 0x1b #OE=output, CS=output, DI=input, DO=output, SK=output */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000368 cs_bits = 0x08;
369 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000370 } else if (!strcasecmp(arg, "arm-usb-tiny")) {
371 ft2232_vid = OLIMEX_VID;
372 ft2232_type = OLIMEX_ARM_TINY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000373 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000374 } else if (!strcasecmp(arg, "arm-usb-ocd-h")) {
375 ft2232_vid = OLIMEX_VID;
376 ft2232_type = OLIMEX_ARM_OCD_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000377 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000378 /* See arm-usb-ocd */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000379 cs_bits = 0x08;
380 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000381 } else if (!strcasecmp(arg, "arm-usb-tiny-h")) {
382 ft2232_vid = OLIMEX_VID;
383 ft2232_type = OLIMEX_ARM_TINY_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000384 channel_count = 2;
Todd Broch6800c952016-02-14 15:46:00 +0000385 } else if (!strcasecmp(arg, "google-servo")) {
386 ft2232_vid = GOOGLE_VID;
387 ft2232_type = GOOGLE_SERVO_PID;
388 } else if (!strcasecmp(arg, "google-servo-v2")) {
389 ft2232_vid = GOOGLE_VID;
390 ft2232_type = GOOGLE_SERVO_V2_PID1;
391 /* Default divisor is too fast, and chip ID fails */
392 divisor = 6;
393 } else if (!strcasecmp(arg, "google-servo-v2-legacy")) {
394 ft2232_vid = GOOGLE_VID;
395 ft2232_type = GOOGLE_SERVO_V2_PID0;
Russ Dill7bd31a42019-10-30 00:40:43 -0700396 } else if (!strcasecmp(arg, "flyswatter")) {
397 ft2232_type = FTDI_FT2232H_PID;
398 channel_count = 2;
399 /* Flyswatter and Flyswatter-2 require GPIO bits 0x80
400 * and 0x40 to be driven low to enable output buffers */
401 pindir = 0xcb;
Alex Badeacaf2d422010-11-10 03:26:57 +0000402 } else {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000403 msg_perr("Error: Invalid device type specified.\n");
404 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000405 ret = -1;
406 goto init_err;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000407 }
408 }
409 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000410
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000411 arg = extract_programmer_param("port");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000412 if (arg) {
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000413 switch (toupper((unsigned char)*arg)) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000414 case 'A':
415 ft2232_interface = INTERFACE_A;
416 break;
417 case 'B':
418 ft2232_interface = INTERFACE_B;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000419 if (channel_count < 2)
420 channel_count = -1;
421 break;
422 case 'C':
423 ft2232_interface = INTERFACE_C;
424 if (channel_count < 3)
425 channel_count = -1;
426 break;
427 case 'D':
428 ft2232_interface = INTERFACE_D;
429 if (channel_count < 4)
430 channel_count = -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000431 break;
432 default:
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000433 channel_count = -1;
434 break;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000435 }
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000436 if (channel_count < 0 || strlen(arg) != 1) {
437 msg_perr("Error: Invalid channel/port/interface specified: \"%s\".\n", arg);
438 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000439 ret = -2;
440 goto init_err;
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000441 }
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000442 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000443 free(arg);
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000444
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000445 arg = extract_programmer_param("divisor");
446 if (arg && strlen(arg)) {
447 unsigned int temp = 0;
448 char *endptr;
449 temp = strtoul(arg, &endptr, 10);
450 if (*endptr || temp < 2 || temp > 131072 || temp & 0x1) {
451 msg_perr("Error: Invalid SPI frequency divisor specified: \"%s\".\n"
452 "Valid are even values between 2 and 131072.\n", arg);
453 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000454 ret = -2;
455 goto init_err;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000456 }
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200457 divisor = (uint32_t)temp;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000458 }
459 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000460
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300461 arg = extract_programmer_param("csgpiol");
462 if (arg) {
463 char *endptr;
464 unsigned int temp = strtoul(arg, &endptr, 10);
465 if (*endptr || endptr == arg || temp > 3) {
466 msg_perr("Error: Invalid GPIOL specified: \"%s\".\n"
467 "Valid values are between 0 and 3.\n", arg);
468 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000469 ret = -2;
470 goto init_err;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300471 }
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200472 unsigned int pin = temp + 4;
473 cs_bits |= 1 << pin;
474 pindir |= 1 << pin;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300475 }
476 free(arg);
477
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000478 msg_pdbg("Using device type %s %s ",
Uwe Hermann70145292010-07-29 19:57:55 +0000479 get_ft2232_vendorname(ft2232_vid, ft2232_type),
480 get_ft2232_devicename(ft2232_vid, ft2232_type));
Stefan Tauner3e515e22012-09-26 00:48:16 +0000481 msg_pdbg("channel %s.\n",
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000482 (ft2232_interface == INTERFACE_A) ? "A" :
483 (ft2232_interface == INTERFACE_B) ? "B" :
484 (ft2232_interface == INTERFACE_C) ? "C" : "D");
Paul Fox05dfbe62009-06-16 21:08:06 +0000485
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000486 struct ftdi_context *const ftdic = &spi_data->ftdi_context;
Paul Fox05dfbe62009-06-16 21:08:06 +0000487 if (ftdi_init(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000488 msg_perr("ftdi_init failed.\n");
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000489 ret = -3;
490 goto init_err;
Paul Fox05dfbe62009-06-16 21:08:06 +0000491 }
492
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000493 if (ftdi_set_interface(ftdic, ft2232_interface) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000494 msg_perr("Unable to select channel (%s).\n", ftdi_get_error_string(ftdic));
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000495 }
496
Shik Chen14fbc4b2012-09-17 00:40:54 +0000497 arg = extract_programmer_param("serial");
498 f = ftdi_usb_open_desc(ftdic, ft2232_vid, ft2232_type, NULL, arg);
499 free(arg);
Paul Fox05dfbe62009-06-16 21:08:06 +0000500
501 if (f < 0 && f != -5) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000502 msg_perr("Unable to open FTDI device: %d (%s).\n", f, ftdi_get_error_string(ftdic));
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000503 ret = -4;
504 goto init_err;
Paul Fox05dfbe62009-06-16 21:08:06 +0000505 }
506
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000507 if (ftdic->type != TYPE_2232H && ftdic->type != TYPE_4232H && ftdic->type != TYPE_232H) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000508 msg_pdbg("FTDI chip type %d is not high-speed.\n", ftdic->type);
Alex Badea0b94d052010-11-10 03:18:41 +0000509 clock_5x = 0;
510 }
511
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000512 if (ftdi_usb_reset(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000513 msg_perr("Unable to reset FTDI device (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000514 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000515
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000516 if (ftdi_set_latency_timer(ftdic, 2) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000517 msg_perr("Unable to set latency timer (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000518 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000519
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000520 if (ftdi_set_bitmode(ftdic, 0x00, BITMODE_BITBANG_SPI) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000521 msg_perr("Unable to set bitmode to SPI (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000522 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000523
Alex Badea0b94d052010-11-10 03:18:41 +0000524 if (clock_5x) {
525 msg_pdbg("Disable divide-by-5 front stage\n");
Stefan Tauner05151b62015-01-25 23:42:57 +0000526 buf[0] = 0x8a; /* Disable divide-by-5. DIS_DIV_5 in newer libftdi */
Uwe Hermann274a20d2011-07-21 09:18:18 +0000527 if (send_buf(ftdic, buf, 1)) {
528 ret = -5;
529 goto ftdi_err;
530 }
Alex Badea0b94d052010-11-10 03:18:41 +0000531 mpsse_clk = 60.0;
532 } else {
533 mpsse_clk = 12.0;
534 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000535
Sean Nelson34b5db72010-01-10 01:08:37 +0000536 msg_pdbg("Set clock divisor\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000537 buf[0] = TCK_DIVISOR;
Ilya A. Volynets-Evenbakh3464d052012-06-14 13:08:33 +0000538 buf[1] = (divisor / 2 - 1) & 0xff;
539 buf[2] = ((divisor / 2 - 1) >> 8) & 0xff;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000540 if (send_buf(ftdic, buf, 3)) {
541 ret = -6;
542 goto ftdi_err;
543 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000544
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000545 msg_pdbg("MPSSE clock: %f MHz, divisor: %u, SPI clock: %f MHz\n",
546 mpsse_clk, divisor, (double)(mpsse_clk / divisor));
Paul Fox05dfbe62009-06-16 21:08:06 +0000547
Uwe Hermannc67d0372009-10-01 18:40:02 +0000548 /* Disconnect TDI/DO to TDO/DI for loopback. */
Sean Nelson34b5db72010-01-10 01:08:37 +0000549 msg_pdbg("No loopback of TDI/DO TDO/DI\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000550 buf[0] = LOOPBACK_END;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000551 if (send_buf(ftdic, buf, 1)) {
552 ret = -7;
553 goto ftdi_err;
554 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000555
Sean Nelson34b5db72010-01-10 01:08:37 +0000556 msg_pdbg("Set data bits\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000557 buf[0] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000558 buf[1] = cs_bits;
559 buf[2] = pindir;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000560 if (send_buf(ftdic, buf, 3)) {
561 ret = -8;
562 goto ftdi_err;
563 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000564
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000565 spi_data->cs_bits = cs_bits;
566 spi_data->pindir = pindir;
567 spi_master_ft2232.data = spi_data;
568
569 if (register_shutdown(ft2232_shutdown, spi_data)) {
570 ret = -9;
571 goto ftdi_err;
572 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000573 register_spi_master(&spi_master_ft2232);
Paul Fox05dfbe62009-06-16 21:08:06 +0000574
575 return 0;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000576
577ftdi_err:
578 if ((f = ftdi_usb_close(ftdic)) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000579 msg_perr("Unable to close FTDI device: %d (%s)\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000580 }
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000581init_err:
582 free(spi_data);
Uwe Hermann274a20d2011-07-21 09:18:18 +0000583 return ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000584}
585
Uwe Hermann274a20d2011-07-21 09:18:18 +0000586/* Returns 0 upon success, a negative number upon errors. */
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000587static int ft2232_spi_send_command(const struct flashctx *flash,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000588 unsigned int writecnt, unsigned int readcnt,
589 const unsigned char *writearr,
590 unsigned char *readarr)
Paul Fox05dfbe62009-06-16 21:08:06 +0000591{
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000592 struct ft2232_data *spi_data = flash->mst->spi.data;
593 struct ftdi_context *ftdic = &spi_data->ftdi_context;
Paul Fox05dfbe62009-06-16 21:08:06 +0000594 static unsigned char *buf = NULL;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000595 /* failed is special. We use bitwise ops, but it is essentially bool. */
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000596 int i = 0, ret = 0, failed = 0;
Angel Pons6d42d2b2020-03-31 15:34:35 +0200597 size_t bufsize;
598 static size_t oldbufsize = 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000599
Carl-Daniel Hailfinger142e30f2009-07-14 10:26:56 +0000600 if (writecnt > 65536 || readcnt > 65536)
601 return SPI_INVALID_LENGTH;
602
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000603 /* buf is not used for the response from the chip. */
604 bufsize = max(writecnt + 9, 260 + 9);
605 /* Never shrink. realloc() calls are expensive. */
Angel Pons6d42d2b2020-03-31 15:34:35 +0200606 if (!buf || bufsize > oldbufsize) {
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000607 buf = realloc(buf, bufsize);
608 if (!buf) {
Sean Nelson34b5db72010-01-10 01:08:37 +0000609 msg_perr("Out of memory!\n");
Uwe Hermann274a20d2011-07-21 09:18:18 +0000610 /* TODO: What to do with buf? */
611 return SPI_GENERIC_ERROR;
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000612 }
613 oldbufsize = bufsize;
Paul Fox05dfbe62009-06-16 21:08:06 +0000614 }
615
Uwe Hermannc67d0372009-10-01 18:40:02 +0000616 /*
617 * Minimize USB transfers by packing as many commands as possible
618 * together. If we're not expecting to read, we can assert CS#, write,
619 * and deassert CS# all in one shot. If reading, we do three separate
Stefan Reinauerab044b22009-09-16 08:26:59 +0000620 * operations.
621 */
Sean Nelson34b5db72010-01-10 01:08:37 +0000622 msg_pspew("Assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000623 buf[i++] = SET_BITS_LOW;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000624 buf[i++] = 0 & ~spi_data->cs_bits; /* assertive */
625 buf[i++] = spi_data->pindir;
Paul Fox05dfbe62009-06-16 21:08:06 +0000626
627 if (writecnt) {
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000628 buf[i++] = MPSSE_DO_WRITE | MPSSE_WRITE_NEG;
Paul Fox05dfbe62009-06-16 21:08:06 +0000629 buf[i++] = (writecnt - 1) & 0xff;
630 buf[i++] = ((writecnt - 1) >> 8) & 0xff;
Uwe Hermannc67d0372009-10-01 18:40:02 +0000631 memcpy(buf + i, writearr, writecnt);
Paul Fox05dfbe62009-06-16 21:08:06 +0000632 i += writecnt;
633 }
634
Uwe Hermannc67d0372009-10-01 18:40:02 +0000635 /*
636 * Optionally terminate this batch of commands with a
Paul Fox05dfbe62009-06-16 21:08:06 +0000637 * read command, then do the fetch of the results.
638 */
639 if (readcnt) {
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000640 buf[i++] = MPSSE_DO_READ;
Paul Fox05dfbe62009-06-16 21:08:06 +0000641 buf[i++] = (readcnt - 1) & 0xff;
642 buf[i++] = ((readcnt - 1) >> 8) & 0xff;
643 ret = send_buf(ftdic, buf, i);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000644 failed = ret;
645 /* We can't abort here, we still have to deassert CS#. */
646 if (ret)
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000647 msg_perr("send_buf failed before read: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000648 i = 0;
Stefan Reinauerab044b22009-09-16 08:26:59 +0000649 if (ret == 0) {
Uwe Hermannc67d0372009-10-01 18:40:02 +0000650 /*
651 * FIXME: This is unreliable. There's no guarantee that
652 * we read the response directly after sending the read
653 * command. We may be scheduled out etc.
Stefan Reinauerab044b22009-09-16 08:26:59 +0000654 */
655 ret = get_buf(ftdic, readarr, readcnt);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000656 failed |= ret;
657 /* We can't abort here either. */
658 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000659 msg_perr("get_buf failed: %i\n", ret);
Stefan Reinauerab044b22009-09-16 08:26:59 +0000660 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000661 }
662
Sean Nelson34b5db72010-01-10 01:08:37 +0000663 msg_pspew("De-assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000664 buf[i++] = SET_BITS_LOW;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000665 buf[i++] = spi_data->cs_bits;
666 buf[i++] = spi_data->pindir;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000667 ret = send_buf(ftdic, buf, i);
668 failed |= ret;
669 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000670 msg_perr("send_buf failed at end: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000671
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000672 return failed ? -1 : 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000673}
674
Thomas Heijligencc853d82021-05-04 15:32:17 +0200675const struct programmer_entry programmer_ft2232_spi = {
676 .name = "ft2232_spi",
677 .type = USB,
678 .devs.dev = devs_ft2232spi,
679 .init = ft2232_spi_init,
680 .map_flash_region = fallback_map,
681 .unmap_flash_region = fallback_unmap,
682 .delay = internal_delay,
683};
Paul Fox05dfbe62009-06-16 21:08:06 +0000684#endif