blob: 7e7e2b188858853f82ea486dfb1a3485d0604ac6 [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.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
19 */
20
Carl-Daniel Hailfinger71127722010-05-31 15:27:27 +000021#if CONFIG_FT2232_SPI == 1
Carl-Daniel Hailfinger3426ef62009-08-19 13:27:58 +000022
Paul Fox05dfbe62009-06-16 21:08:06 +000023#include <stdio.h>
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000024#include <strings.h>
Paul Fox05dfbe62009-06-16 21:08:06 +000025#include <string.h>
26#include <stdlib.h>
Carl-Daniel Hailfingerfeea2722009-07-01 00:02:23 +000027#include <ctype.h>
Paul Fox05dfbe62009-06-16 21:08:06 +000028#include "flash.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000029#include "programmer.h"
Paul Fox05dfbe62009-06-16 21:08:06 +000030#include "spi.h"
Paul Fox05dfbe62009-06-16 21:08:06 +000031#include <ftdi.h>
32
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000033/* This is not defined in libftdi.h <0.20 (c7e4c09e68cfa6f5e112334aa1b3bb23401c8dc7 to be exact).
34 * Some tests indicate that his is the only change that it is needed to support the FT232H in flashrom. */
35#if !defined(HAVE_FT232H)
36#define TYPE_232H 6
37#endif
38
Uwe Hermann836b26a2011-10-14 20:33:14 +000039/* Please keep sorted by vendor ID, then device ID. */
40
Uwe Hermann70145292010-07-29 19:57:55 +000041#define FTDI_VID 0x0403
42#define FTDI_FT2232H_PID 0x6010
43#define FTDI_FT4232H_PID 0x6011
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000044#define FTDI_FT232H_PID 0x6014
Uwe Hermann836b26a2011-10-14 20:33:14 +000045#define TIAO_TUMPA_PID 0x8a98
Stefan Taunerb66ed842014-04-27 05:07:35 +000046#define TIAO_TUMPA_LITE_PID 0x8a99
Uwe Hermann70145292010-07-29 19:57:55 +000047#define AMONTEC_JTAGKEY_PID 0xCFF8
Jörg Fischer6529b9f2010-07-29 15:54:53 +000048
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000049#define GOEPEL_VID 0x096C
50#define GOEPEL_PICOTAP_PID 0x1449
51
Alex Badeacaf2d422010-11-10 03:26:57 +000052#define FIC_VID 0x1457
53#define OPENMOKO_DBGBOARD_PID 0x5118
54
Pete Batardc0207062011-06-11 12:21:37 +000055#define OLIMEX_VID 0x15BA
56#define OLIMEX_ARM_OCD_PID 0x0003
57#define OLIMEX_ARM_TINY_PID 0x0004
58#define OLIMEX_ARM_OCD_H_PID 0x002B
59#define OLIMEX_ARM_TINY_H_PID 0x002A
60
Stefan Tauner4b24a2d2012-12-27 18:40:36 +000061const struct dev_entry devs_ft2232spi[] = {
Uwe Hermann70145292010-07-29 19:57:55 +000062 {FTDI_VID, FTDI_FT2232H_PID, OK, "FTDI", "FT2232H"},
63 {FTDI_VID, FTDI_FT4232H_PID, OK, "FTDI", "FT4232H"},
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000064 {FTDI_VID, FTDI_FT232H_PID, OK, "FTDI", "FT232H"},
Uwe Hermann836b26a2011-10-14 20:33:14 +000065 {FTDI_VID, TIAO_TUMPA_PID, OK, "TIAO", "USB Multi-Protocol Adapter"},
Stefan Taunerb66ed842014-04-27 05:07:35 +000066 {FTDI_VID, TIAO_TUMPA_LITE_PID, OK, "TIAO", "USB Multi-Protocol Adapter Lite"},
Uwe Hermann70145292010-07-29 19:57:55 +000067 {FTDI_VID, AMONTEC_JTAGKEY_PID, OK, "Amontec", "JTAGkey"},
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000068 {GOEPEL_VID, GOEPEL_PICOTAP_PID, OK, "GOEPEL", "PicoTAP"},
Stefan Tauner3e515e22012-09-26 00:48:16 +000069 {FIC_VID, OPENMOKO_DBGBOARD_PID, OK, "FIC", "OpenMoko Neo1973 Debug board (V2+)"},
Pete Batardc0207062011-06-11 12:21:37 +000070 {OLIMEX_VID, OLIMEX_ARM_OCD_PID, NT, "Olimex", "ARM-USB-OCD"},
71 {OLIMEX_VID, OLIMEX_ARM_TINY_PID, OK, "Olimex", "ARM-USB-TINY"},
Stefan Tauner6697f712014-08-06 15:09:15 +000072 {OLIMEX_VID, OLIMEX_ARM_OCD_H_PID, OK, "Olimex", "ARM-USB-OCD-H"},
Stefan Taunerc2eec2c2014-05-03 21:33:01 +000073 {OLIMEX_VID, OLIMEX_ARM_TINY_H_PID, OK, "Olimex", "ARM-USB-TINY-H"},
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000074
75 {0},
Jörg Fischer6529b9f2010-07-29 15:54:53 +000076};
77
Samir Ibradžićb482c6d2012-05-15 22:58:19 +000078#define DEFAULT_DIVISOR 2
Paul Fox05dfbe62009-06-16 21:08:06 +000079
Uwe Hermannc67d0372009-10-01 18:40:02 +000080#define BITMODE_BITBANG_NORMAL 1
81#define BITMODE_BITBANG_SPI 2
Paul Fox05dfbe62009-06-16 21:08:06 +000082
Jörg Fischer6529b9f2010-07-29 15:54:53 +000083/* Set data bits low-byte command:
84 * value: 0x08 CS=high, DI=low, DO=low, SK=low
85 * dir: 0x0b CS=output, DI=input, DO=output, SK=output
86 *
87 * JTAGkey(2) needs to enable its output via Bit4 / GPIOL0
88 * value: 0x18 OE=high, CS=high, DI=low, DO=low, SK=low
89 * dir: 0x1b OE=output, CS=output, DI=input, DO=output, SK=output
Jörg Fischer6529b9f2010-07-29 15:54:53 +000090 */
Uwe Hermann70145292010-07-29 19:57:55 +000091static uint8_t cs_bits = 0x08;
92static uint8_t pindir = 0x0b;
Paul Fox05dfbe62009-06-16 21:08:06 +000093static struct ftdi_context ftdic_context;
94
Jörg Fischer6529b9f2010-07-29 15:54:53 +000095static const char *get_ft2232_devicename(int ft2232_vid, int ft2232_type)
96{
97 int i;
Uwe Hermann70145292010-07-29 19:57:55 +000098 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +000099 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000100 return devs_ft2232spi[i].device_name;
101 }
102 return "unknown device";
103}
104
105static const char *get_ft2232_vendorname(int ft2232_vid, int ft2232_type)
106{
107 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000108 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000109 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Uwe Hermann70145292010-07-29 19:57:55 +0000110 return devs_ft2232spi[i].vendor_name;
111 }
112 return "unknown vendor";
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000113}
114
Uwe Hermann70145292010-07-29 19:57:55 +0000115static int send_buf(struct ftdi_context *ftdic, const unsigned char *buf,
116 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000117{
118 int r;
119 r = ftdi_write_data(ftdic, (unsigned char *) buf, size);
120 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000121 msg_perr("ftdi_write_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Paul Fox05dfbe62009-06-16 21:08:06 +0000122 return 1;
123 }
124 return 0;
125}
126
Uwe Hermann70145292010-07-29 19:57:55 +0000127static int get_buf(struct ftdi_context *ftdic, const unsigned char *buf,
128 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000129{
130 int r;
Alex Badeab9556e02010-11-10 03:10:41 +0000131
132 while (size > 0) {
133 r = ftdi_read_data(ftdic, (unsigned char *) buf, size);
134 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000135 msg_perr("ftdi_read_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Alex Badeab9556e02010-11-10 03:10:41 +0000136 return 1;
137 }
138 buf += r;
139 size -= r;
Paul Fox05dfbe62009-06-16 21:08:06 +0000140 }
141 return 0;
142}
143
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000144static int ft2232_spi_send_command(struct flashctx *flash,
145 unsigned int writecnt, unsigned int readcnt,
146 const unsigned char *writearr,
147 unsigned char *readarr);
Michael Karcherb9dbe482011-05-11 17:07:07 +0000148
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000149static const struct spi_master spi_master_ft2232 = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000150 .type = SPI_CONTROLLER_FT2232,
151 .max_data_read = 64 * 1024,
152 .max_data_write = 256,
153 .command = ft2232_spi_send_command,
154 .multicommand = default_spi_send_multicommand,
155 .read = default_spi_read,
156 .write_256 = default_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000157 .write_aai = default_spi_write_aai,
Michael Karcherb9dbe482011-05-11 17:07:07 +0000158};
159
Uwe Hermann274a20d2011-07-21 09:18:18 +0000160/* Returns 0 upon success, a negative number upon errors. */
Paul Fox05dfbe62009-06-16 21:08:06 +0000161int ft2232_spi_init(void)
162{
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000163 int ret = 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000164 struct ftdi_context *ftdic = &ftdic_context;
165 unsigned char buf[512];
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000166 int ft2232_vid = FTDI_VID;
167 int ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000168 int channel_count = 4; /* Stores the number of channels of the device. */
169 enum ftdi_interface ft2232_interface = INTERFACE_A;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000170 /*
171 * The 'H' chips can run with an internal clock of either 12 MHz or 60 MHz,
172 * but the non-H chips can only run at 12 MHz. We enable the divide-by-5
173 * prescaler on the former to run on the same speed.
174 */
175 uint8_t clock_5x = 1;
176 /* In addition to the prescaler mentioned above there is also another
177 * configurable one on all versions of the chips. Its divisor div can be
178 * set by a 16 bit value x according to the following formula:
179 * div = (1 + x) * 2 <-> x = div / 2 - 1
180 * Hence the expressible divisors are all even numbers between 2 and
181 * 2^17 (=131072) resulting in SCK frequencies of 6 MHz down to about
182 * 92 Hz for 12 MHz inputs.
183 */
184 uint32_t divisor = DEFAULT_DIVISOR;
185 int f;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000186 char *arg;
Alex Badea0b94d052010-11-10 03:18:41 +0000187 double mpsse_clk;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000188
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000189 arg = extract_programmer_param("type");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000190 if (arg) {
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000191 if (!strcasecmp(arg, "2232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000192 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000193 channel_count = 2;
194 } else if (!strcasecmp(arg, "4232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000195 ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000196 channel_count = 4;
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000197 } else if (!strcasecmp(arg, "232H")) {
198 ft2232_type = FTDI_FT232H_PID;
199 channel_count = 1;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000200 } else if (!strcasecmp(arg, "jtagkey")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000201 ft2232_type = AMONTEC_JTAGKEY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000202 channel_count = 2;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000203 cs_bits = 0x18;
Uwe Hermann70145292010-07-29 19:57:55 +0000204 pindir = 0x1b;
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000205 } else if (!strcasecmp(arg, "picotap")) {
206 ft2232_vid = GOEPEL_VID;
207 ft2232_type = GOEPEL_PICOTAP_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000208 channel_count = 2;
Uwe Hermann836b26a2011-10-14 20:33:14 +0000209 } else if (!strcasecmp(arg, "tumpa")) {
210 /* Interface A is SPI1, B is SPI2. */
211 ft2232_type = TIAO_TUMPA_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000212 channel_count = 2;
Stefan Taunerb66ed842014-04-27 05:07:35 +0000213 } else if (!strcasecmp(arg, "tumpalite")) {
214 /* Only one channel is used on lite edition */
215 ft2232_type = TIAO_TUMPA_LITE_PID;
216 channel_count = 1;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000217 } else if (!strcasecmp(arg, "busblaster")) {
218 /* In its default configuration it is a jtagkey clone */
219 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000220 channel_count = 2;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000221 cs_bits = 0x18;
222 pindir = 0x1b;
Alex Badeacaf2d422010-11-10 03:26:57 +0000223 } else if (!strcasecmp(arg, "openmoko")) {
224 ft2232_vid = FIC_VID;
225 ft2232_type = OPENMOKO_DBGBOARD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000226 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000227 } else if (!strcasecmp(arg, "arm-usb-ocd")) {
228 ft2232_vid = OLIMEX_VID;
229 ft2232_type = OLIMEX_ARM_OCD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000230 channel_count = 2;
Paul Fertser3cf335e2011-12-20 02:08:14 +0000231 cs_bits = 0x08;
232 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000233 } else if (!strcasecmp(arg, "arm-usb-tiny")) {
234 ft2232_vid = OLIMEX_VID;
235 ft2232_type = OLIMEX_ARM_TINY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000236 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000237 } else if (!strcasecmp(arg, "arm-usb-ocd-h")) {
238 ft2232_vid = OLIMEX_VID;
239 ft2232_type = OLIMEX_ARM_OCD_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000240 channel_count = 2;
Paul Fertser3cf335e2011-12-20 02:08:14 +0000241 cs_bits = 0x08;
242 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000243 } else if (!strcasecmp(arg, "arm-usb-tiny-h")) {
244 ft2232_vid = OLIMEX_VID;
245 ft2232_type = OLIMEX_ARM_TINY_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000246 channel_count = 2;
Alex Badeacaf2d422010-11-10 03:26:57 +0000247 } else {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000248 msg_perr("Error: Invalid device type specified.\n");
249 free(arg);
Uwe Hermann274a20d2011-07-21 09:18:18 +0000250 return -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000251 }
252 }
253 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000254
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000255 arg = extract_programmer_param("port");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000256 if (arg) {
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000257 switch (toupper((unsigned char)*arg)) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000258 case 'A':
259 ft2232_interface = INTERFACE_A;
260 break;
261 case 'B':
262 ft2232_interface = INTERFACE_B;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000263 if (channel_count < 2)
264 channel_count = -1;
265 break;
266 case 'C':
267 ft2232_interface = INTERFACE_C;
268 if (channel_count < 3)
269 channel_count = -1;
270 break;
271 case 'D':
272 ft2232_interface = INTERFACE_D;
273 if (channel_count < 4)
274 channel_count = -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000275 break;
276 default:
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000277 channel_count = -1;
278 break;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000279 }
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000280 if (channel_count < 0 || strlen(arg) != 1) {
281 msg_perr("Error: Invalid channel/port/interface specified: \"%s\".\n", arg);
282 free(arg);
283 return -2;
284 }
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000285 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000286 free(arg);
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000287
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000288 arg = extract_programmer_param("divisor");
289 if (arg && strlen(arg)) {
290 unsigned int temp = 0;
291 char *endptr;
292 temp = strtoul(arg, &endptr, 10);
293 if (*endptr || temp < 2 || temp > 131072 || temp & 0x1) {
294 msg_perr("Error: Invalid SPI frequency divisor specified: \"%s\".\n"
295 "Valid are even values between 2 and 131072.\n", arg);
296 free(arg);
297 return -2;
298 } else {
299 divisor = (uint32_t)temp;
300 }
301 }
302 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000303
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000304 msg_pdbg("Using device type %s %s ",
Uwe Hermann70145292010-07-29 19:57:55 +0000305 get_ft2232_vendorname(ft2232_vid, ft2232_type),
306 get_ft2232_devicename(ft2232_vid, ft2232_type));
Stefan Tauner3e515e22012-09-26 00:48:16 +0000307 msg_pdbg("channel %s.\n",
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000308 (ft2232_interface == INTERFACE_A) ? "A" :
309 (ft2232_interface == INTERFACE_B) ? "B" :
310 (ft2232_interface == INTERFACE_C) ? "C" : "D");
Paul Fox05dfbe62009-06-16 21:08:06 +0000311
312 if (ftdi_init(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000313 msg_perr("ftdi_init failed.\n");
Uwe Hermann274a20d2011-07-21 09:18:18 +0000314 return -3;
Paul Fox05dfbe62009-06-16 21:08:06 +0000315 }
316
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000317 if (ftdi_set_interface(ftdic, ft2232_interface) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000318 msg_perr("Unable to select channel (%s).\n", ftdi_get_error_string(ftdic));
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000319 }
320
Shik Chen14fbc4b2012-09-17 00:40:54 +0000321 arg = extract_programmer_param("serial");
322 f = ftdi_usb_open_desc(ftdic, ft2232_vid, ft2232_type, NULL, arg);
323 free(arg);
Paul Fox05dfbe62009-06-16 21:08:06 +0000324
325 if (f < 0 && f != -5) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000326 msg_perr("Unable to open FTDI device: %d (%s).\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000327 return -4;
Paul Fox05dfbe62009-06-16 21:08:06 +0000328 }
329
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000330 if (ftdic->type != TYPE_2232H && ftdic->type != TYPE_4232H && ftdic->type != TYPE_232H) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000331 msg_pdbg("FTDI chip type %d is not high-speed.\n", ftdic->type);
Alex Badea0b94d052010-11-10 03:18:41 +0000332 clock_5x = 0;
333 }
334
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000335 if (ftdi_usb_reset(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000336 msg_perr("Unable to reset FTDI device (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000337 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000338
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000339 if (ftdi_set_latency_timer(ftdic, 2) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000340 msg_perr("Unable to set latency timer (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000341 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000342
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000343 if (ftdi_write_data_set_chunksize(ftdic, 256)) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000344 msg_perr("Unable to set chunk size (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000345 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000346
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000347 if (ftdi_set_bitmode(ftdic, 0x00, BITMODE_BITBANG_SPI) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000348 msg_perr("Unable to set bitmode to SPI (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000349 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000350
Alex Badea0b94d052010-11-10 03:18:41 +0000351 if (clock_5x) {
352 msg_pdbg("Disable divide-by-5 front stage\n");
353 buf[0] = 0x8a; /* Disable divide-by-5. */
Uwe Hermann274a20d2011-07-21 09:18:18 +0000354 if (send_buf(ftdic, buf, 1)) {
355 ret = -5;
356 goto ftdi_err;
357 }
Alex Badea0b94d052010-11-10 03:18:41 +0000358 mpsse_clk = 60.0;
359 } else {
360 mpsse_clk = 12.0;
361 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000362
Sean Nelson34b5db72010-01-10 01:08:37 +0000363 msg_pdbg("Set clock divisor\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000364 buf[0] = 0x86; /* command "set divisor" */
Ilya A. Volynets-Evenbakh3464d052012-06-14 13:08:33 +0000365 buf[1] = (divisor / 2 - 1) & 0xff;
366 buf[2] = ((divisor / 2 - 1) >> 8) & 0xff;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000367 if (send_buf(ftdic, buf, 3)) {
368 ret = -6;
369 goto ftdi_err;
370 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000371
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000372 msg_pdbg("MPSSE clock: %f MHz, divisor: %u, SPI clock: %f MHz\n",
373 mpsse_clk, divisor, (double)(mpsse_clk / divisor));
Paul Fox05dfbe62009-06-16 21:08:06 +0000374
Uwe Hermannc67d0372009-10-01 18:40:02 +0000375 /* Disconnect TDI/DO to TDO/DI for loopback. */
Sean Nelson34b5db72010-01-10 01:08:37 +0000376 msg_pdbg("No loopback of TDI/DO TDO/DI\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000377 buf[0] = 0x85;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000378 if (send_buf(ftdic, buf, 1)) {
379 ret = -7;
380 goto ftdi_err;
381 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000382
Sean Nelson34b5db72010-01-10 01:08:37 +0000383 msg_pdbg("Set data bits\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000384 buf[0] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000385 buf[1] = cs_bits;
386 buf[2] = pindir;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000387 if (send_buf(ftdic, buf, 3)) {
388 ret = -8;
389 goto ftdi_err;
390 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000391
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000392 register_spi_master(&spi_master_ft2232);
Paul Fox05dfbe62009-06-16 21:08:06 +0000393
394 return 0;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000395
396ftdi_err:
397 if ((f = ftdi_usb_close(ftdic)) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000398 msg_perr("Unable to close FTDI device: %d (%s)\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000399 }
Uwe Hermann274a20d2011-07-21 09:18:18 +0000400 return ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000401}
402
Uwe Hermann274a20d2011-07-21 09:18:18 +0000403/* Returns 0 upon success, a negative number upon errors. */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000404static int ft2232_spi_send_command(struct flashctx *flash,
405 unsigned int writecnt, unsigned int readcnt,
406 const unsigned char *writearr,
407 unsigned char *readarr)
Paul Fox05dfbe62009-06-16 21:08:06 +0000408{
409 struct ftdi_context *ftdic = &ftdic_context;
410 static unsigned char *buf = NULL;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000411 /* failed is special. We use bitwise ops, but it is essentially bool. */
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000412 int i = 0, ret = 0, failed = 0;
413 int bufsize;
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000414 static int oldbufsize = 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000415
Carl-Daniel Hailfinger142e30f2009-07-14 10:26:56 +0000416 if (writecnt > 65536 || readcnt > 65536)
417 return SPI_INVALID_LENGTH;
418
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000419 /* buf is not used for the response from the chip. */
420 bufsize = max(writecnt + 9, 260 + 9);
421 /* Never shrink. realloc() calls are expensive. */
422 if (bufsize > oldbufsize) {
423 buf = realloc(buf, bufsize);
424 if (!buf) {
Sean Nelson34b5db72010-01-10 01:08:37 +0000425 msg_perr("Out of memory!\n");
Uwe Hermann274a20d2011-07-21 09:18:18 +0000426 /* TODO: What to do with buf? */
427 return SPI_GENERIC_ERROR;
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000428 }
429 oldbufsize = bufsize;
Paul Fox05dfbe62009-06-16 21:08:06 +0000430 }
431
Uwe Hermannc67d0372009-10-01 18:40:02 +0000432 /*
433 * Minimize USB transfers by packing as many commands as possible
434 * together. If we're not expecting to read, we can assert CS#, write,
435 * and deassert CS# all in one shot. If reading, we do three separate
Stefan Reinauerab044b22009-09-16 08:26:59 +0000436 * operations.
437 */
Sean Nelson34b5db72010-01-10 01:08:37 +0000438 msg_pspew("Assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000439 buf[i++] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000440 buf[i++] = 0 & ~cs_bits; /* assertive */
441 buf[i++] = pindir;
Paul Fox05dfbe62009-06-16 21:08:06 +0000442
443 if (writecnt) {
444 buf[i++] = 0x11;
445 buf[i++] = (writecnt - 1) & 0xff;
446 buf[i++] = ((writecnt - 1) >> 8) & 0xff;
Uwe Hermannc67d0372009-10-01 18:40:02 +0000447 memcpy(buf + i, writearr, writecnt);
Paul Fox05dfbe62009-06-16 21:08:06 +0000448 i += writecnt;
449 }
450
Uwe Hermannc67d0372009-10-01 18:40:02 +0000451 /*
452 * Optionally terminate this batch of commands with a
Paul Fox05dfbe62009-06-16 21:08:06 +0000453 * read command, then do the fetch of the results.
454 */
455 if (readcnt) {
456 buf[i++] = 0x20;
457 buf[i++] = (readcnt - 1) & 0xff;
458 buf[i++] = ((readcnt - 1) >> 8) & 0xff;
459 ret = send_buf(ftdic, buf, i);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000460 failed = ret;
461 /* We can't abort here, we still have to deassert CS#. */
462 if (ret)
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000463 msg_perr("send_buf failed before read: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000464 i = 0;
Stefan Reinauerab044b22009-09-16 08:26:59 +0000465 if (ret == 0) {
Uwe Hermannc67d0372009-10-01 18:40:02 +0000466 /*
467 * FIXME: This is unreliable. There's no guarantee that
468 * we read the response directly after sending the read
469 * command. We may be scheduled out etc.
Stefan Reinauerab044b22009-09-16 08:26:59 +0000470 */
471 ret = get_buf(ftdic, readarr, readcnt);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000472 failed |= ret;
473 /* We can't abort here either. */
474 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000475 msg_perr("get_buf failed: %i\n", ret);
Stefan Reinauerab044b22009-09-16 08:26:59 +0000476 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000477 }
478
Sean Nelson34b5db72010-01-10 01:08:37 +0000479 msg_pspew("De-assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000480 buf[i++] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000481 buf[i++] = cs_bits;
482 buf[i++] = pindir;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000483 ret = send_buf(ftdic, buf, i);
484 failed |= ret;
485 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000486 msg_perr("send_buf failed at end: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000487
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000488 return failed ? -1 : 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000489}
490
Paul Fox05dfbe62009-06-16 21:08:06 +0000491#endif