blob: 378566e8ea8009cbb5e248236ff9eaf973e59dc3 [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
Felix Singer7b83f3c2022-08-19 03:16:19 +020017#include <stdbool.h>
Paul Fox05dfbe62009-06-16 21:08:06 +000018#include <stdio.h>
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000019#include <strings.h>
Paul Fox05dfbe62009-06-16 21:08:06 +000020#include <string.h>
21#include <stdlib.h>
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +000022#include <ctype.h>
Paul Fox05dfbe62009-06-16 21:08:06 +000023#include "flash.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000024#include "programmer.h"
Paul Fox05dfbe62009-06-16 21:08:06 +000025#include "spi.h"
Paul Fox05dfbe62009-06-16 21:08:06 +000026#include <ftdi.h>
27
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000028/* This is not defined in libftdi.h <0.20 (c7e4c09e68cfa6f5e112334aa1b3bb23401c8dc7 to be exact).
Angel Pons44cfbb02021-04-17 17:07:34 +020029 * 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 +000030#if !defined(HAVE_FT232H)
31#define TYPE_232H 6
32#endif
33
Uwe Hermann836b26a2011-10-14 20:33:14 +000034/* Please keep sorted by vendor ID, then device ID. */
35
Uwe Hermann70145292010-07-29 19:57:55 +000036#define FTDI_VID 0x0403
37#define FTDI_FT2232H_PID 0x6010
38#define FTDI_FT4232H_PID 0x6011
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000039#define FTDI_FT232H_PID 0x6014
Charles Parent8efb0b32022-02-28 14:55:58 +010040#define FTDI_FT4233H_PID 0x6041
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
Jacek Naglak24e1bbb2022-05-18 02:25:13 +020043#define KT_LINK_PID 0xbbe2
Uwe Hermann70145292010-07-29 19:57:55 +000044#define AMONTEC_JTAGKEY_PID 0xCFF8
Jörg Fischer6529b9f2010-07-29 15:54:53 +000045
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000046#define GOEPEL_VID 0x096C
47#define GOEPEL_PICOTAP_PID 0x1449
48
Alex Badeacaf2d422010-11-10 03:26:57 +000049#define FIC_VID 0x1457
50#define OPENMOKO_DBGBOARD_PID 0x5118
51
Pete Batardc0207062011-06-11 12:21:37 +000052#define OLIMEX_VID 0x15BA
53#define OLIMEX_ARM_OCD_PID 0x0003
54#define OLIMEX_ARM_TINY_PID 0x0004
55#define OLIMEX_ARM_OCD_H_PID 0x002B
56#define OLIMEX_ARM_TINY_H_PID 0x002A
57
Todd Broch6800c952016-02-14 15:46:00 +000058#define GOOGLE_VID 0x18D1
59#define GOOGLE_SERVO_PID 0x5001
60#define GOOGLE_SERVO_V2_PID0 0x5002
61#define GOOGLE_SERVO_V2_PID1 0x5003
62
Thomas Heijligencc853d82021-05-04 15:32:17 +020063static const struct dev_entry devs_ft2232spi[] = {
Uwe Hermann70145292010-07-29 19:57:55 +000064 {FTDI_VID, FTDI_FT2232H_PID, OK, "FTDI", "FT2232H"},
65 {FTDI_VID, FTDI_FT4232H_PID, OK, "FTDI", "FT4232H"},
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000066 {FTDI_VID, FTDI_FT232H_PID, OK, "FTDI", "FT232H"},
Charles Parent8efb0b32022-02-28 14:55:58 +010067 {FTDI_VID, FTDI_FT4233H_PID, OK, "FTDI", "FT4233H"},
Uwe Hermann836b26a2011-10-14 20:33:14 +000068 {FTDI_VID, TIAO_TUMPA_PID, OK, "TIAO", "USB Multi-Protocol Adapter"},
Stefan Taunerb66ed842014-04-27 05:07:35 +000069 {FTDI_VID, TIAO_TUMPA_LITE_PID, OK, "TIAO", "USB Multi-Protocol Adapter Lite"},
Jacek Naglak24e1bbb2022-05-18 02:25:13 +020070 {FTDI_VID, KT_LINK_PID, OK, "Kristech", "KT-LINK"},
Uwe Hermann70145292010-07-29 19:57:55 +000071 {FTDI_VID, AMONTEC_JTAGKEY_PID, OK, "Amontec", "JTAGkey"},
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000072 {GOEPEL_VID, GOEPEL_PICOTAP_PID, OK, "GOEPEL", "PicoTAP"},
Todd Broch6800c952016-02-14 15:46:00 +000073 {GOOGLE_VID, GOOGLE_SERVO_PID, OK, "Google", "Servo"},
74 {GOOGLE_VID, GOOGLE_SERVO_V2_PID0, OK, "Google", "Servo V2 Legacy"},
75 {GOOGLE_VID, GOOGLE_SERVO_V2_PID1, OK, "Google", "Servo V2"},
Stefan Tauner3e515e22012-09-26 00:48:16 +000076 {FIC_VID, OPENMOKO_DBGBOARD_PID, OK, "FIC", "OpenMoko Neo1973 Debug board (V2+)"},
Stefan Tauner74dc73f2015-03-01 22:04:38 +000077 {OLIMEX_VID, OLIMEX_ARM_OCD_PID, OK, "Olimex", "ARM-USB-OCD"},
Pete Batardc0207062011-06-11 12:21:37 +000078 {OLIMEX_VID, OLIMEX_ARM_TINY_PID, OK, "Olimex", "ARM-USB-TINY"},
Stefan Tauner6697f712014-08-06 15:09:15 +000079 {OLIMEX_VID, OLIMEX_ARM_OCD_H_PID, OK, "Olimex", "ARM-USB-OCD-H"},
Stefan Taunerc2eec2c2014-05-03 21:33:01 +000080 {OLIMEX_VID, OLIMEX_ARM_TINY_H_PID, OK, "Olimex", "ARM-USB-TINY-H"},
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000081
82 {0},
Jörg Fischer6529b9f2010-07-29 15:54:53 +000083};
84
Simon Buhrowdb9be312021-04-09 14:48:39 +020085#define FTDI_HW_BUFFER_SIZE 4096 /* in bytes */
86
Samir Ibradžićb482c6d2012-05-15 22:58:19 +000087#define DEFAULT_DIVISOR 2
Paul Fox05dfbe62009-06-16 21:08:06 +000088
Uwe Hermannc67d0372009-10-01 18:40:02 +000089#define BITMODE_BITBANG_NORMAL 1
90#define BITMODE_BITBANG_SPI 2
Paul Fox05dfbe62009-06-16 21:08:06 +000091
Nico Hubercf880682021-06-20 15:59:57 +020092/*
93 * The variables `cs_bits` and `pindir` store the values for the
94 * "set data bits low byte" MPSSE command that sets the initial
95 * state and the direction of the I/O pins. `cs_bits` pins default
96 * to high and will be toggled during SPI transactions. All other
Michael Niewöhnerc2b303b2021-09-21 18:03:29 +020097 * output pins will be kept low all the time. For some programmers,
98 * some reserved GPIOL* pins are used as outputs. Free GPIOL* pins
Michael Niewöhnerece63c82021-09-21 20:15:32 +020099 * are configured as inputs, while it's possible to use them either
100 * as generic gpios or as additional CS# signal(s) through the
101 * parameter(s) `gpiolX`. On exit, all pins will be reconfigured
102 * as inputs.
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000103 *
Nico Hubercf880682021-06-20 15:59:57 +0200104 * The pin offsets are as follows:
105 * TCK/SK is bit 0.
106 * TDI/DO is bit 1.
107 * TDO/DI is bit 2.
108 * TMS/CS is bit 3.
109 * GPIOL0 is bit 4.
110 * GPIOL1 is bit 5.
111 * GPIOL2 is bit 6.
112 * GPIOL3 is bit 7.
113 *
114 * The default values (set below in ft2232_spi_init) are used for
115 * most devices:
116 * value: 0x08 CS=high, DI=low, DO=low, SK=low
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000117 * dir: 0x0b CS=output, DI=input, DO=output, SK=output
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000118 */
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000119struct ft2232_data {
120 uint8_t cs_bits;
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200121 uint8_t aux_bits;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000122 uint8_t pindir;
123 struct ftdi_context ftdi_context;
124};
Paul Fox05dfbe62009-06-16 21:08:06 +0000125
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000126static const char *get_ft2232_devicename(int ft2232_vid, int ft2232_type)
127{
128 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000129 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000130 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000131 return devs_ft2232spi[i].device_name;
132 }
133 return "unknown device";
134}
135
136static const char *get_ft2232_vendorname(int ft2232_vid, int ft2232_type)
137{
138 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000139 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000140 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Uwe Hermann70145292010-07-29 19:57:55 +0000141 return devs_ft2232spi[i].vendor_name;
142 }
143 return "unknown vendor";
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000144}
145
Uwe Hermann70145292010-07-29 19:57:55 +0000146static int send_buf(struct ftdi_context *ftdic, const unsigned char *buf,
147 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000148{
149 int r;
150 r = ftdi_write_data(ftdic, (unsigned char *) buf, size);
151 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000152 msg_perr("ftdi_write_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Paul Fox05dfbe62009-06-16 21:08:06 +0000153 return 1;
154 }
155 return 0;
156}
157
Uwe Hermann70145292010-07-29 19:57:55 +0000158static int get_buf(struct ftdi_context *ftdic, const unsigned char *buf,
159 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000160{
161 int r;
Alex Badeab9556e02010-11-10 03:10:41 +0000162
163 while (size > 0) {
164 r = ftdi_read_data(ftdic, (unsigned char *) buf, size);
165 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000166 msg_perr("ftdi_read_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Alex Badeab9556e02010-11-10 03:10:41 +0000167 return 1;
168 }
169 buf += r;
170 size -= r;
Paul Fox05dfbe62009-06-16 21:08:06 +0000171 }
172 return 0;
173}
174
Alan Green460c1c02021-01-08 09:36:45 +1100175static int ft2232_shutdown(void *data)
176{
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000177 struct ft2232_data *spi_data = (struct ft2232_data *)data;
178 struct ftdi_context *ftdic = &spi_data->ftdi_context;
Alan Green460c1c02021-01-08 09:36:45 +1100179 unsigned char buf[3];
Nico Huber4c40a792021-06-20 16:38:57 +0200180 int ret = 0;
Alan Green460c1c02021-01-08 09:36:45 +1100181
182 msg_pdbg("Releasing I/Os\n");
183 buf[0] = SET_BITS_LOW;
184 buf[1] = 0; /* Output byte ignored */
185 buf[2] = 0; /* Pin direction: all inputs */
186 if (send_buf(ftdic, buf, 3)) {
Nico Huberfda5f1f2021-06-20 16:46:31 +0200187 msg_perr("Unable to set pins back to inputs.\n");
Nico Huber4c40a792021-06-20 16:38:57 +0200188 ret = 1;
Alan Green460c1c02021-01-08 09:36:45 +1100189 }
190
Nico Huber4c40a792021-06-20 16:38:57 +0200191 const int close_ret = ftdi_usb_close(ftdic);
192 if (close_ret < 0) {
193 msg_perr("Unable to close FTDI device: %d (%s)\n", close_ret,
Alan Green460c1c02021-01-08 09:36:45 +1100194 ftdi_get_error_string(ftdic));
Nico Huber4c40a792021-06-20 16:38:57 +0200195 ret = 1;
Alan Green460c1c02021-01-08 09:36:45 +1100196 }
197
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000198 free(spi_data);
Nico Huber4c40a792021-06-20 16:38:57 +0200199 return ret;
Alan Green460c1c02021-01-08 09:36:45 +1100200}
201
Simon Buhrowdb9be312021-04-09 14:48:39 +0200202static bool ft2232_spi_command_fits(const struct spi_command *cmd, size_t buffer_size)
203{
204 const size_t cmd_len = 3; /* same length for any ft2232 command */
205 return
206 /* commands for CS# assertion and de-assertion: */
207 cmd_len + cmd_len
208 /* commands for either a write, a read or both: */
209 + (cmd->writecnt && cmd->readcnt ? cmd_len + cmd_len : cmd_len)
210 /* payload (only writecnt; readcnt concerns another buffer): */
211 + cmd->writecnt
212 <= buffer_size;
213}
214
215/* Returns 0 upon success, a negative number upon errors. */
216static int ft2232_spi_send_multicommand(const struct flashctx *flash, struct spi_command *cmds)
217{
218 struct ft2232_data *spi_data = flash->mst->spi.data;
219 struct ftdi_context *ftdic = &spi_data->ftdi_context;
220 static unsigned char buf[FTDI_HW_BUFFER_SIZE];
221 size_t i = 0;
222 int ret = 0;
223
224 /*
225 * Minimize FTDI-calls by packing as many commands as possible together.
226 */
227 for (; cmds->writecnt || cmds->readcnt; cmds++) {
228
229 if (cmds->writecnt > 65536 || cmds->readcnt > 65536)
230 return SPI_INVALID_LENGTH;
231
232 if (!ft2232_spi_command_fits(cmds, FTDI_HW_BUFFER_SIZE - i)) {
233 msg_perr("Command does not fit\n");
234 return SPI_GENERIC_ERROR;
235 }
236
237 msg_pspew("Assert CS#\n");
238 buf[i++] = SET_BITS_LOW;
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200239 /* assert CS# pins, keep aux_bits, all other output pins stay low */
240 buf[i++] = spi_data->aux_bits;
Simon Buhrowdb9be312021-04-09 14:48:39 +0200241 buf[i++] = spi_data->pindir;
242
243 /* WREN, OP(PROGRAM, ERASE), ADDR, DATA */
244 if (cmds->writecnt) {
245 buf[i++] = MPSSE_DO_WRITE | MPSSE_WRITE_NEG;
246 buf[i++] = (cmds->writecnt - 1) & 0xff;
247 buf[i++] = ((cmds->writecnt - 1) >> 8) & 0xff;
248 memcpy(buf + i, cmds->writearr, cmds->writecnt);
249 i += cmds->writecnt;
250 }
251
252 /* An optional read command */
253 if (cmds->readcnt) {
254 buf[i++] = MPSSE_DO_READ;
255 buf[i++] = (cmds->readcnt - 1) & 0xff;
256 buf[i++] = ((cmds->readcnt - 1) >> 8) & 0xff;
257 }
258
259 /* Add final de-assert CS# */
260 msg_pspew("De-assert CS#\n");
261 buf[i++] = SET_BITS_LOW;
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200262 buf[i++] = spi_data->cs_bits | spi_data->aux_bits;
Simon Buhrowdb9be312021-04-09 14:48:39 +0200263 buf[i++] = spi_data->pindir;
264
265 /* continue if there is no read-cmd and further cmds exist */
266 if (!cmds->readcnt &&
267 ((cmds + 1)->writecnt || (cmds + 1)->readcnt) &&
268 ft2232_spi_command_fits((cmds + 1), FTDI_HW_BUFFER_SIZE - i)) {
269 continue;
270 }
271
272 ret = send_buf(ftdic, buf, i);
273 i = 0;
274 if (ret) {
275 msg_perr("send_buf failed: %i\n", ret);
276 break;
277 }
278
279 if (cmds->readcnt) {
280 ret = get_buf(ftdic, cmds->readarr, cmds->readcnt);
281 if (ret) {
282 msg_perr("get_buf failed: %i\n", ret);
283 break;
284 }
285 }
286 }
287 return ret ? -1 : 0;
288}
289
Nico Huber03f3a6d2021-05-11 17:53:34 +0200290static const struct spi_master spi_master_ft2232 = {
Nico Huber1cf407b2017-11-10 20:18:23 +0100291 .features = SPI_MASTER_4BA,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000292 .max_data_read = 64 * 1024,
293 .max_data_write = 256,
Nico Huber13b33bc2021-06-20 13:20:33 +0200294 .command = default_spi_send_command,
Simon Buhrowdb9be312021-04-09 14:48:39 +0200295 .multicommand = ft2232_spi_send_multicommand,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000296 .read = default_spi_read,
297 .write_256 = default_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000298 .write_aai = default_spi_write_aai,
Anastasia Klimchukc63d9182021-07-06 16:18:44 +1000299 .shutdown = ft2232_shutdown,
Michael Karcherb9dbe482011-05-11 17:07:07 +0000300};
301
Uwe Hermann274a20d2011-07-21 09:18:18 +0000302/* Returns 0 upon success, a negative number upon errors. */
Thomas Heijligencc853d82021-05-04 15:32:17 +0200303static int ft2232_spi_init(void)
Paul Fox05dfbe62009-06-16 21:08:06 +0000304{
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000305 int ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000306 unsigned char buf[512];
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000307 int ft2232_vid = FTDI_VID;
308 int ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000309 int channel_count = 4; /* Stores the number of channels of the device. */
310 enum ftdi_interface ft2232_interface = INTERFACE_A;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000311 /*
312 * The 'H' chips can run with an internal clock of either 12 MHz or 60 MHz,
Nikolai Artemiev518674c2020-06-24 18:53:03 +1000313 * but the non-H chips can only run at 12 MHz. We disable the divide-by-5
314 * prescaler on 'H' chips so they run at 60MHz.
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000315 */
Felix Singer7b83f3c2022-08-19 03:16:19 +0200316 bool clock_5x = true;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000317 /* In addition to the prescaler mentioned above there is also another
318 * configurable one on all versions of the chips. Its divisor div can be
319 * set by a 16 bit value x according to the following formula:
320 * div = (1 + x) * 2 <-> x = div / 2 - 1
321 * Hence the expressible divisors are all even numbers between 2 and
322 * 2^17 (=131072) resulting in SCK frequencies of 6 MHz down to about
Nikolai Artemiev518674c2020-06-24 18:53:03 +1000323 * 92 Hz for 12 MHz inputs and 30 MHz down to about 458 Hz for 60 MHz
324 * inputs.
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000325 */
326 uint32_t divisor = DEFAULT_DIVISOR;
327 int f;
Harry Johnson9fc8e252021-07-08 14:28:39 -0700328 char *arg, *arg2;
Alex Badea0b94d052010-11-10 03:18:41 +0000329 double mpsse_clk;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000330 uint8_t cs_bits = 0x08;
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200331 uint8_t aux_bits = 0x00;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000332 uint8_t pindir = 0x0b;
Jacek Naglak24e1bbb2022-05-18 02:25:13 +0200333 uint8_t aux_bits_high = 0x00;
334 uint8_t pindir_high = 0x00;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000335
336 struct ft2232_data *const spi_data = calloc(1, sizeof(*spi_data));
337 if (!spi_data) {
338 msg_perr("Unable to allocate space for SPI master data\n");
339 return SPI_GENERIC_ERROR;
340 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000341
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000342 arg = extract_programmer_param("type");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000343 if (arg) {
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000344 if (!strcasecmp(arg, "2232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000345 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000346 channel_count = 2;
347 } else if (!strcasecmp(arg, "4232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000348 ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000349 channel_count = 4;
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000350 } else if (!strcasecmp(arg, "232H")) {
351 ft2232_type = FTDI_FT232H_PID;
352 channel_count = 1;
Charles Parent8efb0b32022-02-28 14:55:58 +0100353 } else if (!strcasecmp(arg, "4233H")) {
354 ft2232_type = FTDI_FT4233H_PID;
355 channel_count = 4;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000356 } else if (!strcasecmp(arg, "jtagkey")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000357 ft2232_type = AMONTEC_JTAGKEY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000358 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000359 /* JTAGkey(2) needs to enable its output via Bit4 / GPIOL0
360 * value: 0x18 OE=high, CS=high, DI=low, DO=low, SK=low
361 * dir: 0x1b OE=output, CS=output, DI=input, DO=output, SK=output */
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000362 cs_bits = 0x18;
Uwe Hermann70145292010-07-29 19:57:55 +0000363 pindir = 0x1b;
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000364 } else if (!strcasecmp(arg, "picotap")) {
365 ft2232_vid = GOEPEL_VID;
366 ft2232_type = GOEPEL_PICOTAP_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000367 channel_count = 2;
Uwe Hermann836b26a2011-10-14 20:33:14 +0000368 } else if (!strcasecmp(arg, "tumpa")) {
369 /* Interface A is SPI1, B is SPI2. */
370 ft2232_type = TIAO_TUMPA_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000371 channel_count = 2;
Stefan Taunerb66ed842014-04-27 05:07:35 +0000372 } else if (!strcasecmp(arg, "tumpalite")) {
373 /* Only one channel is used on lite edition */
374 ft2232_type = TIAO_TUMPA_LITE_PID;
375 channel_count = 1;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000376 } else if (!strcasecmp(arg, "busblaster")) {
377 /* In its default configuration it is a jtagkey clone */
378 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000379 channel_count = 2;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000380 cs_bits = 0x18;
381 pindir = 0x1b;
Alex Badeacaf2d422010-11-10 03:26:57 +0000382 } else if (!strcasecmp(arg, "openmoko")) {
383 ft2232_vid = FIC_VID;
384 ft2232_type = OPENMOKO_DBGBOARD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000385 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000386 } else if (!strcasecmp(arg, "arm-usb-ocd")) {
387 ft2232_vid = OLIMEX_VID;
388 ft2232_type = OLIMEX_ARM_OCD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000389 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000390 /* arm-usb-ocd(-h) has an output buffer that needs to be enabled by pulling ADBUS4 low.
391 * value: 0x08 #OE=low, CS=high, DI=low, DO=low, SK=low
392 * dir: 0x1b #OE=output, CS=output, DI=input, DO=output, SK=output */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000393 cs_bits = 0x08;
394 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000395 } else if (!strcasecmp(arg, "arm-usb-tiny")) {
396 ft2232_vid = OLIMEX_VID;
397 ft2232_type = OLIMEX_ARM_TINY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000398 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000399 } else if (!strcasecmp(arg, "arm-usb-ocd-h")) {
400 ft2232_vid = OLIMEX_VID;
401 ft2232_type = OLIMEX_ARM_OCD_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000402 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000403 /* See arm-usb-ocd */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000404 cs_bits = 0x08;
405 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000406 } else if (!strcasecmp(arg, "arm-usb-tiny-h")) {
407 ft2232_vid = OLIMEX_VID;
408 ft2232_type = OLIMEX_ARM_TINY_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000409 channel_count = 2;
Todd Broch6800c952016-02-14 15:46:00 +0000410 } else if (!strcasecmp(arg, "google-servo")) {
411 ft2232_vid = GOOGLE_VID;
412 ft2232_type = GOOGLE_SERVO_PID;
413 } else if (!strcasecmp(arg, "google-servo-v2")) {
414 ft2232_vid = GOOGLE_VID;
415 ft2232_type = GOOGLE_SERVO_V2_PID1;
416 /* Default divisor is too fast, and chip ID fails */
417 divisor = 6;
418 } else if (!strcasecmp(arg, "google-servo-v2-legacy")) {
419 ft2232_vid = GOOGLE_VID;
420 ft2232_type = GOOGLE_SERVO_V2_PID0;
Russ Dill7bd31a42019-10-30 00:40:43 -0700421 } else if (!strcasecmp(arg, "flyswatter")) {
422 ft2232_type = FTDI_FT2232H_PID;
423 channel_count = 2;
424 /* Flyswatter and Flyswatter-2 require GPIO bits 0x80
425 * and 0x40 to be driven low to enable output buffers */
426 pindir = 0xcb;
Jacek Naglak24e1bbb2022-05-18 02:25:13 +0200427 } else if (!strcasecmp(arg, "kt-link")) {
428 ft2232_type = KT_LINK_PID;
429 /* port B is used as uart */
430 channel_count = 1;
431 /* Set GPIOL1 output high - route TMS and TDO through multiplexers */
432 aux_bits = 0x20;
433 pindir = 0x2b;
434 /* Set GPIOH4 output low - enable TMS output buffer */
435 /* Set GPIOH5 output low - enable TDI output buffer */
436 /* Set GPIOH6 output low - enable TCK output buffer */
437 pindir_high = 0x70;
Alex Badeacaf2d422010-11-10 03:26:57 +0000438 } else {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000439 msg_perr("Error: Invalid device type specified.\n");
440 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000441 ret = -1;
442 goto init_err;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000443 }
444 }
445 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000446
Michael Niewöhnerb50d9eb2021-09-21 19:43:04 +0200447 /* Remember reserved pins before pindir gets modified. */
448 const uint8_t rsv_bits = pindir & 0xf0;
449
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000450 arg = extract_programmer_param("port");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000451 if (arg) {
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000452 switch (toupper((unsigned char)*arg)) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000453 case 'A':
454 ft2232_interface = INTERFACE_A;
455 break;
456 case 'B':
457 ft2232_interface = INTERFACE_B;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000458 if (channel_count < 2)
459 channel_count = -1;
460 break;
461 case 'C':
462 ft2232_interface = INTERFACE_C;
463 if (channel_count < 3)
464 channel_count = -1;
465 break;
466 case 'D':
467 ft2232_interface = INTERFACE_D;
468 if (channel_count < 4)
469 channel_count = -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000470 break;
471 default:
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000472 channel_count = -1;
473 break;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000474 }
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000475 if (channel_count < 0 || strlen(arg) != 1) {
476 msg_perr("Error: Invalid channel/port/interface specified: \"%s\".\n", arg);
477 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000478 ret = -2;
479 goto init_err;
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000480 }
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000481 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000482 free(arg);
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000483
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000484 arg = extract_programmer_param("divisor");
485 if (arg && strlen(arg)) {
486 unsigned int temp = 0;
487 char *endptr;
488 temp = strtoul(arg, &endptr, 10);
489 if (*endptr || temp < 2 || temp > 131072 || temp & 0x1) {
490 msg_perr("Error: Invalid SPI frequency divisor specified: \"%s\".\n"
491 "Valid are even values between 2 and 131072.\n", arg);
492 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000493 ret = -2;
494 goto init_err;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000495 }
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200496 divisor = (uint32_t)temp;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000497 }
498 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000499
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200500 bool csgpiol_set = false;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300501 arg = extract_programmer_param("csgpiol");
502 if (arg) {
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200503 csgpiol_set = true;
504 msg_pwarn("Deprecation warning: `csgpiol` is deprecated and will be removed "
505 "in the future.\nUse `gpiolX=C` instead.\n");
506
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300507 char *endptr;
508 unsigned int temp = strtoul(arg, &endptr, 10);
509 if (*endptr || endptr == arg || temp > 3) {
510 msg_perr("Error: Invalid GPIOL specified: \"%s\".\n"
511 "Valid values are between 0 and 3.\n", arg);
512 free(arg);
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000513 ret = -2;
514 goto init_err;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300515 }
Michael Niewöhnerb50d9eb2021-09-21 19:43:04 +0200516
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200517 unsigned int pin = temp + 4;
Michael Niewöhnerb50d9eb2021-09-21 19:43:04 +0200518 if (rsv_bits & 1 << pin) {
519 msg_perr("Error: Invalid GPIOL specified: \"%s\".\n"
520 "The pin is reserved on this programmer.\n",
521 arg);
522 free(arg);
523 return -2;
524 }
525
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200526 cs_bits |= 1 << pin;
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200527 pindir |= 1 << pin;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300528 }
529 free(arg);
530
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200531 /* gpiolX */
532 int pin;
533 for (pin = 0; pin < 4; pin++) {
534 char gpiol_param[7];
535 snprintf(gpiol_param, sizeof(gpiol_param), "gpiol%d", pin);
536 arg = extract_programmer_param(gpiol_param);
537
538 if (!arg)
539 continue;
540
541 if (csgpiol_set) {
542 msg_perr("Error: `csgpiol` and `gpiolX` are mutually exclusive.\n"
543 "Since `csgpiol` is deprecated and will be removed in the "
544 "future, use of `gpiolX=C` is recommended.\n");
545 free(arg);
546 return -2;
547 }
548
549 uint8_t bit = 1 << (pin + 4);
550 if (rsv_bits & bit) {
551 msg_perr("Error: Invalid GPIOL specified: \"gpiol%d=%s\".\n"
552 "Pin GPIOL%i is reserved on this programmer.\n",
553 pin, arg, pin);
554 free(arg);
555 return -2;
556 }
557
558 if (strlen(arg) != 1)
559 goto format_error;
560
561 switch (toupper((unsigned char)arg[0])) {
562 case 'H':
563 aux_bits |= bit;
564 pindir |= bit;
565 break;
566 case 'L':
567 pindir |= bit;
568 break;
569 case 'C':
570 cs_bits |= bit;
571 pindir |= bit;
572 break;
573 default:
574 goto format_error;
575 }
576
577 free(arg);
578 continue;
579
580format_error:
581 msg_perr("Error: Invalid GPIOL specified: \"gpiol%d=%s\".\n"
582 "Valid values are H, L and C.\n"
583 " H - Set GPIOL output high\n"
584 " L - Set GPIOL output low\n"
585 " C - Use GPIOL as additional CS# output\n",
586 pin, arg);
587
588 free(arg);
589 return -2;
590 }
591
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000592 msg_pdbg("Using device type %s %s ",
Uwe Hermann70145292010-07-29 19:57:55 +0000593 get_ft2232_vendorname(ft2232_vid, ft2232_type),
594 get_ft2232_devicename(ft2232_vid, ft2232_type));
Stefan Tauner3e515e22012-09-26 00:48:16 +0000595 msg_pdbg("channel %s.\n",
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000596 (ft2232_interface == INTERFACE_A) ? "A" :
597 (ft2232_interface == INTERFACE_B) ? "B" :
598 (ft2232_interface == INTERFACE_C) ? "C" : "D");
Paul Fox05dfbe62009-06-16 21:08:06 +0000599
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000600 struct ftdi_context *const ftdic = &spi_data->ftdi_context;
Paul Fox05dfbe62009-06-16 21:08:06 +0000601 if (ftdi_init(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000602 msg_perr("ftdi_init failed.\n");
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000603 ret = -3;
604 goto init_err;
Paul Fox05dfbe62009-06-16 21:08:06 +0000605 }
606
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000607 if (ftdi_set_interface(ftdic, ft2232_interface) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000608 msg_perr("Unable to select channel (%s).\n", ftdi_get_error_string(ftdic));
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000609 }
610
Shik Chen14fbc4b2012-09-17 00:40:54 +0000611 arg = extract_programmer_param("serial");
Harry Johnson9fc8e252021-07-08 14:28:39 -0700612 arg2 = extract_programmer_param("description");
613
614 f = ftdi_usb_open_desc(ftdic, ft2232_vid, ft2232_type, arg2, arg);
615
Shik Chen14fbc4b2012-09-17 00:40:54 +0000616 free(arg);
Harry Johnson9fc8e252021-07-08 14:28:39 -0700617 free(arg2);
Paul Fox05dfbe62009-06-16 21:08:06 +0000618
619 if (f < 0 && f != -5) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000620 msg_perr("Unable to open FTDI device: %d (%s).\n", f, ftdi_get_error_string(ftdic));
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000621 ret = -4;
622 goto init_err;
Paul Fox05dfbe62009-06-16 21:08:06 +0000623 }
624
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000625 if (ftdic->type != TYPE_2232H && ftdic->type != TYPE_4232H && ftdic->type != TYPE_232H) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000626 msg_pdbg("FTDI chip type %d is not high-speed.\n", ftdic->type);
Felix Singer7b83f3c2022-08-19 03:16:19 +0200627 clock_5x = false;
Alex Badea0b94d052010-11-10 03:18:41 +0000628 }
629
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000630 if (ftdi_usb_reset(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000631 msg_perr("Unable to reset FTDI device (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000632 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000633
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000634 if (ftdi_set_latency_timer(ftdic, 2) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000635 msg_perr("Unable to set latency timer (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000636 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000637
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000638 if (ftdi_set_bitmode(ftdic, 0x00, BITMODE_BITBANG_SPI) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000639 msg_perr("Unable to set bitmode to SPI (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000640 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000641
Alex Badea0b94d052010-11-10 03:18:41 +0000642 if (clock_5x) {
643 msg_pdbg("Disable divide-by-5 front stage\n");
Nikolai Artemiev518674c2020-06-24 18:53:03 +1000644 buf[0] = DIS_DIV_5;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000645 if (send_buf(ftdic, buf, 1)) {
646 ret = -5;
647 goto ftdi_err;
648 }
Alex Badea0b94d052010-11-10 03:18:41 +0000649 mpsse_clk = 60.0;
650 } else {
651 mpsse_clk = 12.0;
652 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000653
Sean Nelson34b5db72010-01-10 01:08:37 +0000654 msg_pdbg("Set clock divisor\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000655 buf[0] = TCK_DIVISOR;
Ilya A. Volynets-Evenbakh3464d052012-06-14 13:08:33 +0000656 buf[1] = (divisor / 2 - 1) & 0xff;
657 buf[2] = ((divisor / 2 - 1) >> 8) & 0xff;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000658 if (send_buf(ftdic, buf, 3)) {
659 ret = -6;
660 goto ftdi_err;
661 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000662
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000663 msg_pdbg("MPSSE clock: %f MHz, divisor: %u, SPI clock: %f MHz\n",
664 mpsse_clk, divisor, (double)(mpsse_clk / divisor));
Paul Fox05dfbe62009-06-16 21:08:06 +0000665
Uwe Hermannc67d0372009-10-01 18:40:02 +0000666 /* Disconnect TDI/DO to TDO/DI for loopback. */
Sean Nelson34b5db72010-01-10 01:08:37 +0000667 msg_pdbg("No loopback of TDI/DO TDO/DI\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000668 buf[0] = LOOPBACK_END;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000669 if (send_buf(ftdic, buf, 1)) {
670 ret = -7;
671 goto ftdi_err;
672 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000673
Sean Nelson34b5db72010-01-10 01:08:37 +0000674 msg_pdbg("Set data bits\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000675 buf[0] = SET_BITS_LOW;
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200676 buf[1] = cs_bits | aux_bits;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000677 buf[2] = pindir;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000678 if (send_buf(ftdic, buf, 3)) {
679 ret = -8;
680 goto ftdi_err;
681 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000682
Jacek Naglak24e1bbb2022-05-18 02:25:13 +0200683 if (pindir_high) {
684 msg_pdbg("Set data bits HighByte\n");
685 buf[0] = SET_BITS_HIGH;
686 buf[1] = aux_bits_high;
687 buf[2] = pindir_high;
688 if (send_buf(ftdic, buf, 3)) {
689 ret = -8;
690 goto ftdi_err;
691 }
692 }
693
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000694 spi_data->cs_bits = cs_bits;
Michael Niewöhnerece63c82021-09-21 20:15:32 +0200695 spi_data->aux_bits = aux_bits;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000696 spi_data->pindir = pindir;
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000697
Anastasia Klimchukc63d9182021-07-06 16:18:44 +1000698 return register_spi_master(&spi_master_ft2232, spi_data);
Uwe Hermann274a20d2011-07-21 09:18:18 +0000699
700ftdi_err:
701 if ((f = ftdi_usb_close(ftdic)) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000702 msg_perr("Unable to close FTDI device: %d (%s)\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000703 }
Anastasia Klimchuke8106ba2021-04-12 10:05:57 +1000704init_err:
705 free(spi_data);
Uwe Hermann274a20d2011-07-21 09:18:18 +0000706 return ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000707}
708
Thomas Heijligencc853d82021-05-04 15:32:17 +0200709const struct programmer_entry programmer_ft2232_spi = {
710 .name = "ft2232_spi",
711 .type = USB,
712 .devs.dev = devs_ft2232spi,
713 .init = ft2232_spi_init,
Thomas Heijligencc853d82021-05-04 15:32:17 +0200714};