blob: cf4b8b49413c01dc5c024d85845c189e705b9ce7 [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
Nico Hubercf880682021-06-20 15:59:57 +020089/*
90 * The variables `cs_bits` and `pindir` store the values for the
91 * "set data bits low byte" MPSSE command that sets the initial
92 * state and the direction of the I/O pins. `cs_bits` pins default
93 * to high and will be toggled during SPI transactions. All other
94 * output pins will be kept low all the time. On exit, all pins
95 * will be reconfigured as inputs.
Antony Pavlovb4dd40c2015-01-25 03:52:47 +000096 *
Nico Hubercf880682021-06-20 15:59:57 +020097 * The pin offsets are as follows:
98 * TCK/SK is bit 0.
99 * TDI/DO is bit 1.
100 * TDO/DI is bit 2.
101 * TMS/CS is bit 3.
102 * GPIOL0 is bit 4.
103 * GPIOL1 is bit 5.
104 * GPIOL2 is bit 6.
105 * GPIOL3 is bit 7.
106 *
107 * The default values (set below in ft2232_spi_init) are used for
108 * most devices:
109 * value: 0x08 CS=high, DI=low, DO=low, SK=low
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000110 * dir: 0x0b CS=output, DI=input, DO=output, SK=output
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000111 */
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000112struct ft2232_data {
113 uint8_t cs_bits;
114 uint8_t pindir;
115 struct ftdi_context ftdi_context;
116};
Paul Fox05dfbe62009-06-16 21:08:06 +0000117
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000118static const char *get_ft2232_devicename(int ft2232_vid, int ft2232_type)
119{
120 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000121 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000122 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000123 return devs_ft2232spi[i].device_name;
124 }
125 return "unknown device";
126}
127
128static const char *get_ft2232_vendorname(int ft2232_vid, int ft2232_type)
129{
130 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000131 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000132 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Uwe Hermann70145292010-07-29 19:57:55 +0000133 return devs_ft2232spi[i].vendor_name;
134 }
135 return "unknown vendor";
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000136}
137
Uwe Hermann70145292010-07-29 19:57:55 +0000138static int send_buf(struct ftdi_context *ftdic, const unsigned char *buf,
139 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000140{
141 int r;
142 r = ftdi_write_data(ftdic, (unsigned char *) buf, size);
143 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000144 msg_perr("ftdi_write_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Paul Fox05dfbe62009-06-16 21:08:06 +0000145 return 1;
146 }
147 return 0;
148}
149
Uwe Hermann70145292010-07-29 19:57:55 +0000150static int get_buf(struct ftdi_context *ftdic, const unsigned char *buf,
151 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000152{
153 int r;
Alex Badeab9556e02010-11-10 03:10:41 +0000154
155 while (size > 0) {
156 r = ftdi_read_data(ftdic, (unsigned char *) buf, size);
157 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000158 msg_perr("ftdi_read_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Alex Badeab9556e02010-11-10 03:10:41 +0000159 return 1;
160 }
161 buf += r;
162 size -= r;
Paul Fox05dfbe62009-06-16 21:08:06 +0000163 }
164 return 0;
165}
166
Alan Green460c1c02021-01-08 09:36:45 +1100167static int ft2232_shutdown(void *data)
168{
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000169 struct ft2232_data *spi_data = (struct ft2232_data *)data;
170 struct ftdi_context *ftdic = &spi_data->ftdi_context;
Alan Green460c1c02021-01-08 09:36:45 +1100171 unsigned char buf[3];
Nico Huber4c40a792021-06-20 16:38:57 +0200172 int ret = 0;
Alan Green460c1c02021-01-08 09:36:45 +1100173
174 msg_pdbg("Releasing I/Os\n");
175 buf[0] = SET_BITS_LOW;
176 buf[1] = 0; /* Output byte ignored */
177 buf[2] = 0; /* Pin direction: all inputs */
178 if (send_buf(ftdic, buf, 3)) {
Nico Huberfda5f1f2021-06-20 16:46:31 +0200179 msg_perr("Unable to set pins back to inputs.\n");
Nico Huber4c40a792021-06-20 16:38:57 +0200180 ret = 1;
Alan Green460c1c02021-01-08 09:36:45 +1100181 }
182
Nico Huber4c40a792021-06-20 16:38:57 +0200183 const int close_ret = ftdi_usb_close(ftdic);
184 if (close_ret < 0) {
185 msg_perr("Unable to close FTDI device: %d (%s)\n", close_ret,
Alan Green460c1c02021-01-08 09:36:45 +1100186 ftdi_get_error_string(ftdic));
Nico Huber4c40a792021-06-20 16:38:57 +0200187 ret = 1;
Alan Green460c1c02021-01-08 09:36:45 +1100188 }
189
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000190 free(spi_data);
Nico Huber4c40a792021-06-20 16:38:57 +0200191 return ret;
Alan Green460c1c02021-01-08 09:36:45 +1100192}
193
Simon Buhrowdb9be312021-04-09 14:48:39 +0200194static bool ft2232_spi_command_fits(const struct spi_command *cmd, size_t buffer_size)
195{
196 const size_t cmd_len = 3; /* same length for any ft2232 command */
197 return
198 /* commands for CS# assertion and de-assertion: */
199 cmd_len + cmd_len
200 /* commands for either a write, a read or both: */
201 + (cmd->writecnt && cmd->readcnt ? cmd_len + cmd_len : cmd_len)
202 /* payload (only writecnt; readcnt concerns another buffer): */
203 + cmd->writecnt
204 <= buffer_size;
205}
206
207/* Returns 0 upon success, a negative number upon errors. */
208static int ft2232_spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds)
209{
210 struct ft2232_data *spi_data = flash->mst->spi.data;
211 struct ftdi_context *ftdic = &spi_data->ftdi_context;
212 static unsigned char buf[FTDI_HW_BUFFER_SIZE];
213 size_t i = 0;
214 int ret = 0;
215
216 /*
217 * Minimize FTDI-calls by packing as many commands as possible together.
218 */
219 for (; cmds->writecnt || cmds->readcnt; cmds++) {
220
221 if (cmds->writecnt > 65536 || cmds->readcnt > 65536)
222 return SPI_INVALID_LENGTH;
223
224 if (!ft2232_spi_command_fits(cmds, FTDI_HW_BUFFER_SIZE - i)) {
225 msg_perr("Command does not fit\n");
226 return SPI_GENERIC_ERROR;
227 }
228
229 msg_pspew("Assert CS#\n");
230 buf[i++] = SET_BITS_LOW;
Nico Hubercf880682021-06-20 15:59:57 +0200231 buf[i++] = 0; /* assert CS# pins, all other output pins stay low */
Simon Buhrowdb9be312021-04-09 14:48:39 +0200232 buf[i++] = spi_data->pindir;
233
234 /* WREN, OP(PROGRAM, ERASE), ADDR, DATA */
235 if (cmds->writecnt) {
236 buf[i++] = MPSSE_DO_WRITE | MPSSE_WRITE_NEG;
237 buf[i++] = (cmds->writecnt - 1) & 0xff;
238 buf[i++] = ((cmds->writecnt - 1) >> 8) & 0xff;
239 memcpy(buf + i, cmds->writearr, cmds->writecnt);
240 i += cmds->writecnt;
241 }
242
243 /* An optional read command */
244 if (cmds->readcnt) {
245 buf[i++] = MPSSE_DO_READ;
246 buf[i++] = (cmds->readcnt - 1) & 0xff;
247 buf[i++] = ((cmds->readcnt - 1) >> 8) & 0xff;
248 }
249
250 /* Add final de-assert CS# */
251 msg_pspew("De-assert CS#\n");
252 buf[i++] = SET_BITS_LOW;
253 buf[i++] = spi_data->cs_bits;
254 buf[i++] = spi_data->pindir;
255
256 /* continue if there is no read-cmd and further cmds exist */
257 if (!cmds->readcnt &&
258 ((cmds + 1)->writecnt || (cmds + 1)->readcnt) &&
259 ft2232_spi_command_fits((cmds + 1), FTDI_HW_BUFFER_SIZE - i)) {
260 continue;
261 }
262
263 ret = send_buf(ftdic, buf, i);
264 i = 0;
265 if (ret) {
266 msg_perr("send_buf failed: %i\n", ret);
267 break;
268 }
269
270 if (cmds->readcnt) {
271 ret = get_buf(ftdic, cmds->readarr, cmds->readcnt);
272 if (ret) {
273 msg_perr("get_buf failed: %i\n", ret);
274 break;
275 }
276 }
277 }
278 return ret ? -1 : 0;
279}
280
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000281static struct spi_master spi_master_ft2232 = {
Nico Huber1cf407b2017-11-10 20:18:23 +0100282 .features = SPI_MASTER_4BA,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000283 .max_data_read = 64 * 1024,
284 .max_data_write = 256,
Nico Huber13b33bc2021-06-20 13:20:33 +0200285 .command = default_spi_send_command,
Simon Buhrowdb9be312021-04-09 14:48:39 +0200286 .multicommand = ft2232_spi_send_multicommand,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000287 .read = default_spi_read,
288 .write_256 = default_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000289 .write_aai = default_spi_write_aai,
Michael Karcherb9dbe482011-05-11 17:07:07 +0000290};
291
Uwe Hermann274a20d2011-07-21 09:18:18 +0000292/* Returns 0 upon success, a negative number upon errors. */
Thomas Heijligencc853d82021-05-04 15:32:17 +0200293static int ft2232_spi_init(void)
Paul Fox05dfbe62009-06-16 21:08:06 +0000294{
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000295 int ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000296 unsigned char buf[512];
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000297 int ft2232_vid = FTDI_VID;
298 int ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000299 int channel_count = 4; /* Stores the number of channels of the device. */
300 enum ftdi_interface ft2232_interface = INTERFACE_A;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000301 /*
302 * The 'H' chips can run with an internal clock of either 12 MHz or 60 MHz,
303 * but the non-H chips can only run at 12 MHz. We enable the divide-by-5
304 * prescaler on the former to run on the same speed.
305 */
306 uint8_t clock_5x = 1;
307 /* In addition to the prescaler mentioned above there is also another
308 * configurable one on all versions of the chips. Its divisor div can be
309 * set by a 16 bit value x according to the following formula:
310 * div = (1 + x) * 2 <-> x = div / 2 - 1
311 * Hence the expressible divisors are all even numbers between 2 and
312 * 2^17 (=131072) resulting in SCK frequencies of 6 MHz down to about
313 * 92 Hz for 12 MHz inputs.
314 */
315 uint32_t divisor = DEFAULT_DIVISOR;
316 int f;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000317 char *arg;
Alex Badea0b94d052010-11-10 03:18:41 +0000318 double mpsse_clk;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000319 uint8_t cs_bits = 0x08;
320 uint8_t pindir = 0x0b;
321
322 struct ft2232_data *const spi_data = calloc(1, sizeof(*spi_data));
323 if (!spi_data) {
324 msg_perr("Unable to allocate space for SPI master data\n");
325 return SPI_GENERIC_ERROR;
326 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000327
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000328 arg = extract_programmer_param("type");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000329 if (arg) {
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000330 if (!strcasecmp(arg, "2232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000331 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000332 channel_count = 2;
333 } else if (!strcasecmp(arg, "4232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000334 ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000335 channel_count = 4;
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000336 } else if (!strcasecmp(arg, "232H")) {
337 ft2232_type = FTDI_FT232H_PID;
338 channel_count = 1;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000339 } else if (!strcasecmp(arg, "jtagkey")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000340 ft2232_type = AMONTEC_JTAGKEY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000341 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000342 /* JTAGkey(2) needs to enable its output via Bit4 / GPIOL0
343 * value: 0x18 OE=high, CS=high, DI=low, DO=low, SK=low
344 * dir: 0x1b OE=output, CS=output, DI=input, DO=output, SK=output */
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000345 cs_bits = 0x18;
Uwe Hermann70145292010-07-29 19:57:55 +0000346 pindir = 0x1b;
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000347 } else if (!strcasecmp(arg, "picotap")) {
348 ft2232_vid = GOEPEL_VID;
349 ft2232_type = GOEPEL_PICOTAP_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000350 channel_count = 2;
Uwe Hermann836b26a2011-10-14 20:33:14 +0000351 } else if (!strcasecmp(arg, "tumpa")) {
352 /* Interface A is SPI1, B is SPI2. */
353 ft2232_type = TIAO_TUMPA_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000354 channel_count = 2;
Stefan Taunerb66ed842014-04-27 05:07:35 +0000355 } else if (!strcasecmp(arg, "tumpalite")) {
356 /* Only one channel is used on lite edition */
357 ft2232_type = TIAO_TUMPA_LITE_PID;
358 channel_count = 1;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000359 } else if (!strcasecmp(arg, "busblaster")) {
360 /* In its default configuration it is a jtagkey clone */
361 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000362 channel_count = 2;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000363 cs_bits = 0x18;
364 pindir = 0x1b;
Alex Badeacaf2d422010-11-10 03:26:57 +0000365 } else if (!strcasecmp(arg, "openmoko")) {
366 ft2232_vid = FIC_VID;
367 ft2232_type = OPENMOKO_DBGBOARD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000368 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000369 } else if (!strcasecmp(arg, "arm-usb-ocd")) {
370 ft2232_vid = OLIMEX_VID;
371 ft2232_type = OLIMEX_ARM_OCD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000372 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000373 /* arm-usb-ocd(-h) has an output buffer that needs to be enabled by pulling ADBUS4 low.
374 * value: 0x08 #OE=low, CS=high, DI=low, DO=low, SK=low
375 * dir: 0x1b #OE=output, CS=output, DI=input, DO=output, SK=output */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000376 cs_bits = 0x08;
377 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000378 } else if (!strcasecmp(arg, "arm-usb-tiny")) {
379 ft2232_vid = OLIMEX_VID;
380 ft2232_type = OLIMEX_ARM_TINY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000381 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000382 } else if (!strcasecmp(arg, "arm-usb-ocd-h")) {
383 ft2232_vid = OLIMEX_VID;
384 ft2232_type = OLIMEX_ARM_OCD_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000385 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000386 /* See arm-usb-ocd */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000387 cs_bits = 0x08;
388 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000389 } else if (!strcasecmp(arg, "arm-usb-tiny-h")) {
390 ft2232_vid = OLIMEX_VID;
391 ft2232_type = OLIMEX_ARM_TINY_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000392 channel_count = 2;
Todd Broch6800c952016-02-14 15:46:00 +0000393 } else if (!strcasecmp(arg, "google-servo")) {
394 ft2232_vid = GOOGLE_VID;
395 ft2232_type = GOOGLE_SERVO_PID;
396 } else if (!strcasecmp(arg, "google-servo-v2")) {
397 ft2232_vid = GOOGLE_VID;
398 ft2232_type = GOOGLE_SERVO_V2_PID1;
399 /* Default divisor is too fast, and chip ID fails */
400 divisor = 6;
401 } else if (!strcasecmp(arg, "google-servo-v2-legacy")) {
402 ft2232_vid = GOOGLE_VID;
403 ft2232_type = GOOGLE_SERVO_V2_PID0;
Russ Dill7bd31a42019-10-30 00:40:43 -0700404 } else if (!strcasecmp(arg, "flyswatter")) {
405 ft2232_type = FTDI_FT2232H_PID;
406 channel_count = 2;
407 /* Flyswatter and Flyswatter-2 require GPIO bits 0x80
408 * and 0x40 to be driven low to enable output buffers */
409 pindir = 0xcb;
Alex Badeacaf2d422010-11-10 03:26:57 +0000410 } else {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000411 msg_perr("Error: Invalid device type specified.\n");
412 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000413 ret = -1;
414 goto init_err;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000415 }
416 }
417 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000418
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000419 arg = extract_programmer_param("port");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000420 if (arg) {
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000421 switch (toupper((unsigned char)*arg)) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000422 case 'A':
423 ft2232_interface = INTERFACE_A;
424 break;
425 case 'B':
426 ft2232_interface = INTERFACE_B;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000427 if (channel_count < 2)
428 channel_count = -1;
429 break;
430 case 'C':
431 ft2232_interface = INTERFACE_C;
432 if (channel_count < 3)
433 channel_count = -1;
434 break;
435 case 'D':
436 ft2232_interface = INTERFACE_D;
437 if (channel_count < 4)
438 channel_count = -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000439 break;
440 default:
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000441 channel_count = -1;
442 break;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000443 }
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000444 if (channel_count < 0 || strlen(arg) != 1) {
445 msg_perr("Error: Invalid channel/port/interface specified: \"%s\".\n", arg);
446 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000447 ret = -2;
448 goto init_err;
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000449 }
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000450 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000451 free(arg);
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000452
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000453 arg = extract_programmer_param("divisor");
454 if (arg && strlen(arg)) {
455 unsigned int temp = 0;
456 char *endptr;
457 temp = strtoul(arg, &endptr, 10);
458 if (*endptr || temp < 2 || temp > 131072 || temp & 0x1) {
459 msg_perr("Error: Invalid SPI frequency divisor specified: \"%s\".\n"
460 "Valid are even values between 2 and 131072.\n", arg);
461 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000462 ret = -2;
463 goto init_err;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000464 }
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200465 divisor = (uint32_t)temp;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000466 }
467 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000468
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300469 arg = extract_programmer_param("csgpiol");
470 if (arg) {
471 char *endptr;
472 unsigned int temp = strtoul(arg, &endptr, 10);
473 if (*endptr || endptr == arg || temp > 3) {
474 msg_perr("Error: Invalid GPIOL specified: \"%s\".\n"
475 "Valid values are between 0 and 3.\n", arg);
476 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000477 ret = -2;
478 goto init_err;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300479 }
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200480 unsigned int pin = temp + 4;
481 cs_bits |= 1 << pin;
482 pindir |= 1 << pin;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300483 }
484 free(arg);
485
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000486 msg_pdbg("Using device type %s %s ",
Uwe Hermann70145292010-07-29 19:57:55 +0000487 get_ft2232_vendorname(ft2232_vid, ft2232_type),
488 get_ft2232_devicename(ft2232_vid, ft2232_type));
Stefan Tauner3e515e22012-09-26 00:48:16 +0000489 msg_pdbg("channel %s.\n",
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000490 (ft2232_interface == INTERFACE_A) ? "A" :
491 (ft2232_interface == INTERFACE_B) ? "B" :
492 (ft2232_interface == INTERFACE_C) ? "C" : "D");
Paul Fox05dfbe62009-06-16 21:08:06 +0000493
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000494 struct ftdi_context *const ftdic = &spi_data->ftdi_context;
Paul Fox05dfbe62009-06-16 21:08:06 +0000495 if (ftdi_init(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000496 msg_perr("ftdi_init failed.\n");
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000497 ret = -3;
498 goto init_err;
Paul Fox05dfbe62009-06-16 21:08:06 +0000499 }
500
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000501 if (ftdi_set_interface(ftdic, ft2232_interface) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000502 msg_perr("Unable to select channel (%s).\n", ftdi_get_error_string(ftdic));
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000503 }
504
Shik Chen14fbc4b2012-09-17 00:40:54 +0000505 arg = extract_programmer_param("serial");
506 f = ftdi_usb_open_desc(ftdic, ft2232_vid, ft2232_type, NULL, arg);
507 free(arg);
Paul Fox05dfbe62009-06-16 21:08:06 +0000508
509 if (f < 0 && f != -5) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000510 msg_perr("Unable to open FTDI device: %d (%s).\n", f, ftdi_get_error_string(ftdic));
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000511 ret = -4;
512 goto init_err;
Paul Fox05dfbe62009-06-16 21:08:06 +0000513 }
514
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000515 if (ftdic->type != TYPE_2232H && ftdic->type != TYPE_4232H && ftdic->type != TYPE_232H) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000516 msg_pdbg("FTDI chip type %d is not high-speed.\n", ftdic->type);
Alex Badea0b94d052010-11-10 03:18:41 +0000517 clock_5x = 0;
518 }
519
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000520 if (ftdi_usb_reset(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000521 msg_perr("Unable to reset FTDI device (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000522 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000523
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000524 if (ftdi_set_latency_timer(ftdic, 2) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000525 msg_perr("Unable to set latency timer (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000526 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000527
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000528 if (ftdi_set_bitmode(ftdic, 0x00, BITMODE_BITBANG_SPI) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000529 msg_perr("Unable to set bitmode to SPI (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000530 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000531
Alex Badea0b94d052010-11-10 03:18:41 +0000532 if (clock_5x) {
533 msg_pdbg("Disable divide-by-5 front stage\n");
Stefan Tauner05151b62015-01-25 23:42:57 +0000534 buf[0] = 0x8a; /* Disable divide-by-5. DIS_DIV_5 in newer libftdi */
Uwe Hermann274a20d2011-07-21 09:18:18 +0000535 if (send_buf(ftdic, buf, 1)) {
536 ret = -5;
537 goto ftdi_err;
538 }
Alex Badea0b94d052010-11-10 03:18:41 +0000539 mpsse_clk = 60.0;
540 } else {
541 mpsse_clk = 12.0;
542 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000543
Sean Nelson34b5db72010-01-10 01:08:37 +0000544 msg_pdbg("Set clock divisor\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000545 buf[0] = TCK_DIVISOR;
Ilya A. Volynets-Evenbakh3464d052012-06-14 13:08:33 +0000546 buf[1] = (divisor / 2 - 1) & 0xff;
547 buf[2] = ((divisor / 2 - 1) >> 8) & 0xff;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000548 if (send_buf(ftdic, buf, 3)) {
549 ret = -6;
550 goto ftdi_err;
551 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000552
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000553 msg_pdbg("MPSSE clock: %f MHz, divisor: %u, SPI clock: %f MHz\n",
554 mpsse_clk, divisor, (double)(mpsse_clk / divisor));
Paul Fox05dfbe62009-06-16 21:08:06 +0000555
Uwe Hermannc67d0372009-10-01 18:40:02 +0000556 /* Disconnect TDI/DO to TDO/DI for loopback. */
Sean Nelson34b5db72010-01-10 01:08:37 +0000557 msg_pdbg("No loopback of TDI/DO TDO/DI\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000558 buf[0] = LOOPBACK_END;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000559 if (send_buf(ftdic, buf, 1)) {
560 ret = -7;
561 goto ftdi_err;
562 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000563
Sean Nelson34b5db72010-01-10 01:08:37 +0000564 msg_pdbg("Set data bits\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000565 buf[0] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000566 buf[1] = cs_bits;
567 buf[2] = pindir;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000568 if (send_buf(ftdic, buf, 3)) {
569 ret = -8;
570 goto ftdi_err;
571 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000572
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000573 spi_data->cs_bits = cs_bits;
574 spi_data->pindir = pindir;
575 spi_master_ft2232.data = spi_data;
576
577 if (register_shutdown(ft2232_shutdown, spi_data)) {
578 ret = -9;
579 goto ftdi_err;
580 }
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000581 register_spi_master(&spi_master_ft2232);
Paul Fox05dfbe62009-06-16 21:08:06 +0000582
583 return 0;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000584
585ftdi_err:
586 if ((f = ftdi_usb_close(ftdic)) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000587 msg_perr("Unable to close FTDI device: %d (%s)\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000588 }
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000589init_err:
590 free(spi_data);
Uwe Hermann274a20d2011-07-21 09:18:18 +0000591 return ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000592}
593
Thomas Heijligencc853d82021-05-04 15:32:17 +0200594const struct programmer_entry programmer_ft2232_spi = {
595 .name = "ft2232_spi",
596 .type = USB,
597 .devs.dev = devs_ft2232spi,
598 .init = ft2232_spi_init,
599 .map_flash_region = fallback_map,
600 .unmap_flash_region = fallback_unmap,
601 .delay = internal_delay,
602};
Paul Fox05dfbe62009-06-16 21:08:06 +0000603#endif