blob: c09405e7ea8d1883f1efe76b129396bc56840dea [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
Uwe Hermann70145292010-07-29 19:57:55 +000046#define AMONTEC_JTAGKEY_PID 0xCFF8
Jörg Fischer6529b9f2010-07-29 15:54:53 +000047
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000048#define GOEPEL_VID 0x096C
49#define GOEPEL_PICOTAP_PID 0x1449
50
Alex Badeacaf2d422010-11-10 03:26:57 +000051#define FIC_VID 0x1457
52#define OPENMOKO_DBGBOARD_PID 0x5118
53
Pete Batardc0207062011-06-11 12:21:37 +000054#define OLIMEX_VID 0x15BA
55#define OLIMEX_ARM_OCD_PID 0x0003
56#define OLIMEX_ARM_TINY_PID 0x0004
57#define OLIMEX_ARM_OCD_H_PID 0x002B
58#define OLIMEX_ARM_TINY_H_PID 0x002A
59
Jörg Fischer6529b9f2010-07-29 15:54:53 +000060const struct usbdev_status devs_ft2232spi[] = {
Uwe Hermann70145292010-07-29 19:57:55 +000061 {FTDI_VID, FTDI_FT2232H_PID, OK, "FTDI", "FT2232H"},
62 {FTDI_VID, FTDI_FT4232H_PID, OK, "FTDI", "FT4232H"},
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +000063 {FTDI_VID, FTDI_FT232H_PID, OK, "FTDI", "FT232H"},
Uwe Hermann836b26a2011-10-14 20:33:14 +000064 {FTDI_VID, TIAO_TUMPA_PID, OK, "TIAO", "USB Multi-Protocol Adapter"},
Uwe Hermann70145292010-07-29 19:57:55 +000065 {FTDI_VID, AMONTEC_JTAGKEY_PID, OK, "Amontec", "JTAGkey"},
Samir Ibradžić7189a5f2011-10-20 23:14:10 +000066 {GOEPEL_VID, GOEPEL_PICOTAP_PID, OK, "GOEPEL", "PicoTAP"},
Stefan Tauner3e515e22012-09-26 00:48:16 +000067 {FIC_VID, OPENMOKO_DBGBOARD_PID, OK, "FIC", "OpenMoko Neo1973 Debug board (V2+)"},
Pete Batardc0207062011-06-11 12:21:37 +000068 {OLIMEX_VID, OLIMEX_ARM_OCD_PID, NT, "Olimex", "ARM-USB-OCD"},
69 {OLIMEX_VID, OLIMEX_ARM_TINY_PID, OK, "Olimex", "ARM-USB-TINY"},
70 {OLIMEX_VID, OLIMEX_ARM_OCD_H_PID, NT, "Olimex", "ARM-USB-OCD-H"},
71 {OLIMEX_VID, OLIMEX_ARM_TINY_H_PID, NT, "Olimex", "ARM-USB-TINY-H"},
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000072
73 {0},
Jörg Fischer6529b9f2010-07-29 15:54:53 +000074};
75
Samir Ibradžićb482c6d2012-05-15 22:58:19 +000076#define DEFAULT_DIVISOR 2
Paul Fox05dfbe62009-06-16 21:08:06 +000077
Uwe Hermannc67d0372009-10-01 18:40:02 +000078#define BITMODE_BITBANG_NORMAL 1
79#define BITMODE_BITBANG_SPI 2
Paul Fox05dfbe62009-06-16 21:08:06 +000080
Jörg Fischer6529b9f2010-07-29 15:54:53 +000081/* Set data bits low-byte command:
82 * value: 0x08 CS=high, DI=low, DO=low, SK=low
83 * dir: 0x0b CS=output, DI=input, DO=output, SK=output
84 *
85 * JTAGkey(2) needs to enable its output via Bit4 / GPIOL0
86 * value: 0x18 OE=high, CS=high, DI=low, DO=low, SK=low
87 * dir: 0x1b OE=output, CS=output, DI=input, DO=output, SK=output
Jörg Fischer6529b9f2010-07-29 15:54:53 +000088 */
Uwe Hermann70145292010-07-29 19:57:55 +000089static uint8_t cs_bits = 0x08;
90static uint8_t pindir = 0x0b;
Paul Fox05dfbe62009-06-16 21:08:06 +000091static struct ftdi_context ftdic_context;
92
Jörg Fischer6529b9f2010-07-29 15:54:53 +000093static const char *get_ft2232_devicename(int ft2232_vid, int ft2232_type)
94{
95 int i;
Uwe Hermann70145292010-07-29 19:57:55 +000096 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +000097 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Jörg Fischer6529b9f2010-07-29 15:54:53 +000098 return devs_ft2232spi[i].device_name;
99 }
100 return "unknown device";
101}
102
103static const char *get_ft2232_vendorname(int ft2232_vid, int ft2232_type)
104{
105 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000106 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000107 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Uwe Hermann70145292010-07-29 19:57:55 +0000108 return devs_ft2232spi[i].vendor_name;
109 }
110 return "unknown vendor";
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000111}
112
Uwe Hermann70145292010-07-29 19:57:55 +0000113static int send_buf(struct ftdi_context *ftdic, const unsigned char *buf,
114 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000115{
116 int r;
117 r = ftdi_write_data(ftdic, (unsigned char *) buf, size);
118 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000119 msg_perr("ftdi_write_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Paul Fox05dfbe62009-06-16 21:08:06 +0000120 return 1;
121 }
122 return 0;
123}
124
Uwe Hermann70145292010-07-29 19:57:55 +0000125static int get_buf(struct ftdi_context *ftdic, const unsigned char *buf,
126 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000127{
128 int r;
Alex Badeab9556e02010-11-10 03:10:41 +0000129
130 while (size > 0) {
131 r = ftdi_read_data(ftdic, (unsigned char *) buf, size);
132 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000133 msg_perr("ftdi_read_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Alex Badeab9556e02010-11-10 03:10:41 +0000134 return 1;
135 }
136 buf += r;
137 size -= r;
Paul Fox05dfbe62009-06-16 21:08:06 +0000138 }
139 return 0;
140}
141
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000142static int ft2232_spi_send_command(struct flashctx *flash,
143 unsigned int writecnt, unsigned int readcnt,
144 const unsigned char *writearr,
145 unsigned char *readarr);
Michael Karcherb9dbe482011-05-11 17:07:07 +0000146
147static const struct spi_programmer spi_programmer_ft2232 = {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000148 .type = SPI_CONTROLLER_FT2232,
149 .max_data_read = 64 * 1024,
150 .max_data_write = 256,
151 .command = ft2232_spi_send_command,
152 .multicommand = default_spi_send_multicommand,
153 .read = default_spi_read,
154 .write_256 = default_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000155 .write_aai = default_spi_write_aai,
Michael Karcherb9dbe482011-05-11 17:07:07 +0000156};
157
Uwe Hermann274a20d2011-07-21 09:18:18 +0000158/* Returns 0 upon success, a negative number upon errors. */
Paul Fox05dfbe62009-06-16 21:08:06 +0000159int ft2232_spi_init(void)
160{
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000161 int ret = 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000162 struct ftdi_context *ftdic = &ftdic_context;
163 unsigned char buf[512];
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000164 int ft2232_vid = FTDI_VID;
165 int ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000166 int channel_count = 4; /* Stores the number of channels of the device. */
167 enum ftdi_interface ft2232_interface = INTERFACE_A;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000168 /*
169 * The 'H' chips can run with an internal clock of either 12 MHz or 60 MHz,
170 * but the non-H chips can only run at 12 MHz. We enable the divide-by-5
171 * prescaler on the former to run on the same speed.
172 */
173 uint8_t clock_5x = 1;
174 /* In addition to the prescaler mentioned above there is also another
175 * configurable one on all versions of the chips. Its divisor div can be
176 * set by a 16 bit value x according to the following formula:
177 * div = (1 + x) * 2 <-> x = div / 2 - 1
178 * Hence the expressible divisors are all even numbers between 2 and
179 * 2^17 (=131072) resulting in SCK frequencies of 6 MHz down to about
180 * 92 Hz for 12 MHz inputs.
181 */
182 uint32_t divisor = DEFAULT_DIVISOR;
183 int f;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000184 char *arg;
Alex Badea0b94d052010-11-10 03:18:41 +0000185 double mpsse_clk;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000186
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000187 arg = extract_programmer_param("type");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000188 if (arg) {
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000189 if (!strcasecmp(arg, "2232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000190 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000191 channel_count = 2;
192 } else if (!strcasecmp(arg, "4232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000193 ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000194 channel_count = 4;
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000195 } else if (!strcasecmp(arg, "232H")) {
196 ft2232_type = FTDI_FT232H_PID;
197 channel_count = 1;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000198 } else if (!strcasecmp(arg, "jtagkey")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000199 ft2232_type = AMONTEC_JTAGKEY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000200 channel_count = 2;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000201 cs_bits = 0x18;
Uwe Hermann70145292010-07-29 19:57:55 +0000202 pindir = 0x1b;
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000203 } else if (!strcasecmp(arg, "picotap")) {
204 ft2232_vid = GOEPEL_VID;
205 ft2232_type = GOEPEL_PICOTAP_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000206 channel_count = 2;
Uwe Hermann836b26a2011-10-14 20:33:14 +0000207 } else if (!strcasecmp(arg, "tumpa")) {
208 /* Interface A is SPI1, B is SPI2. */
209 ft2232_type = TIAO_TUMPA_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000210 channel_count = 2;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000211 } else if (!strcasecmp(arg, "busblaster")) {
212 /* In its default configuration it is a jtagkey clone */
213 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000214 channel_count = 2;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000215 cs_bits = 0x18;
216 pindir = 0x1b;
Alex Badeacaf2d422010-11-10 03:26:57 +0000217 } else if (!strcasecmp(arg, "openmoko")) {
218 ft2232_vid = FIC_VID;
219 ft2232_type = OPENMOKO_DBGBOARD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000220 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000221 } else if (!strcasecmp(arg, "arm-usb-ocd")) {
222 ft2232_vid = OLIMEX_VID;
223 ft2232_type = OLIMEX_ARM_OCD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000224 channel_count = 2;
Paul Fertser3cf335e2011-12-20 02:08:14 +0000225 cs_bits = 0x08;
226 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000227 } else if (!strcasecmp(arg, "arm-usb-tiny")) {
228 ft2232_vid = OLIMEX_VID;
229 ft2232_type = OLIMEX_ARM_TINY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000230 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000231 } else if (!strcasecmp(arg, "arm-usb-ocd-h")) {
232 ft2232_vid = OLIMEX_VID;
233 ft2232_type = OLIMEX_ARM_OCD_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000234 channel_count = 2;
Paul Fertser3cf335e2011-12-20 02:08:14 +0000235 cs_bits = 0x08;
236 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000237 } else if (!strcasecmp(arg, "arm-usb-tiny-h")) {
238 ft2232_vid = OLIMEX_VID;
239 ft2232_type = OLIMEX_ARM_TINY_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000240 channel_count = 2;
Alex Badeacaf2d422010-11-10 03:26:57 +0000241 } else {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000242 msg_perr("Error: Invalid device type specified.\n");
243 free(arg);
Uwe Hermann274a20d2011-07-21 09:18:18 +0000244 return -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000245 }
246 }
247 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000248
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000249 arg = extract_programmer_param("port");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000250 if (arg) {
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000251 switch (toupper((unsigned char)*arg)) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000252 case 'A':
253 ft2232_interface = INTERFACE_A;
254 break;
255 case 'B':
256 ft2232_interface = INTERFACE_B;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000257 if (channel_count < 2)
258 channel_count = -1;
259 break;
260 case 'C':
261 ft2232_interface = INTERFACE_C;
262 if (channel_count < 3)
263 channel_count = -1;
264 break;
265 case 'D':
266 ft2232_interface = INTERFACE_D;
267 if (channel_count < 4)
268 channel_count = -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000269 break;
270 default:
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000271 channel_count = -1;
272 break;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000273 }
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000274 if (channel_count < 0 || strlen(arg) != 1) {
275 msg_perr("Error: Invalid channel/port/interface specified: \"%s\".\n", arg);
276 free(arg);
277 return -2;
278 }
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000279 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000280 free(arg);
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000281
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000282 arg = extract_programmer_param("divisor");
283 if (arg && strlen(arg)) {
284 unsigned int temp = 0;
285 char *endptr;
286 temp = strtoul(arg, &endptr, 10);
287 if (*endptr || temp < 2 || temp > 131072 || temp & 0x1) {
288 msg_perr("Error: Invalid SPI frequency divisor specified: \"%s\".\n"
289 "Valid are even values between 2 and 131072.\n", arg);
290 free(arg);
291 return -2;
292 } else {
293 divisor = (uint32_t)temp;
294 }
295 }
296 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000297
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000298 msg_pdbg("Using device type %s %s ",
Uwe Hermann70145292010-07-29 19:57:55 +0000299 get_ft2232_vendorname(ft2232_vid, ft2232_type),
300 get_ft2232_devicename(ft2232_vid, ft2232_type));
Stefan Tauner3e515e22012-09-26 00:48:16 +0000301 msg_pdbg("channel %s.\n",
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000302 (ft2232_interface == INTERFACE_A) ? "A" :
303 (ft2232_interface == INTERFACE_B) ? "B" :
304 (ft2232_interface == INTERFACE_C) ? "C" : "D");
Paul Fox05dfbe62009-06-16 21:08:06 +0000305
306 if (ftdi_init(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000307 msg_perr("ftdi_init failed.\n");
Uwe Hermann274a20d2011-07-21 09:18:18 +0000308 return -3;
Paul Fox05dfbe62009-06-16 21:08:06 +0000309 }
310
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000311 if (ftdi_set_interface(ftdic, ft2232_interface) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000312 msg_perr("Unable to select channel (%s).\n", ftdi_get_error_string(ftdic));
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000313 }
314
Shik Chen14fbc4b2012-09-17 00:40:54 +0000315 arg = extract_programmer_param("serial");
316 f = ftdi_usb_open_desc(ftdic, ft2232_vid, ft2232_type, NULL, arg);
317 free(arg);
Paul Fox05dfbe62009-06-16 21:08:06 +0000318
319 if (f < 0 && f != -5) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000320 msg_perr("Unable to open FTDI device: %d (%s).\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000321 return -4;
Paul Fox05dfbe62009-06-16 21:08:06 +0000322 }
323
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000324 if (ftdic->type != TYPE_2232H && ftdic->type != TYPE_4232H && ftdic->type != TYPE_232H) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000325 msg_pdbg("FTDI chip type %d is not high-speed.\n", ftdic->type);
Alex Badea0b94d052010-11-10 03:18:41 +0000326 clock_5x = 0;
327 }
328
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000329 if (ftdi_usb_reset(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000330 msg_perr("Unable to reset FTDI device (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000331 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000332
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000333 if (ftdi_set_latency_timer(ftdic, 2) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000334 msg_perr("Unable to set latency timer (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000335 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000336
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000337 if (ftdi_write_data_set_chunksize(ftdic, 256)) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000338 msg_perr("Unable to set chunk size (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000339 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000340
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000341 if (ftdi_set_bitmode(ftdic, 0x00, BITMODE_BITBANG_SPI) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000342 msg_perr("Unable to set bitmode to SPI (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000343 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000344
Alex Badea0b94d052010-11-10 03:18:41 +0000345 if (clock_5x) {
346 msg_pdbg("Disable divide-by-5 front stage\n");
347 buf[0] = 0x8a; /* Disable divide-by-5. */
Uwe Hermann274a20d2011-07-21 09:18:18 +0000348 if (send_buf(ftdic, buf, 1)) {
349 ret = -5;
350 goto ftdi_err;
351 }
Alex Badea0b94d052010-11-10 03:18:41 +0000352 mpsse_clk = 60.0;
353 } else {
354 mpsse_clk = 12.0;
355 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000356
Sean Nelson34b5db72010-01-10 01:08:37 +0000357 msg_pdbg("Set clock divisor\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000358 buf[0] = 0x86; /* command "set divisor" */
Ilya A. Volynets-Evenbakh3464d052012-06-14 13:08:33 +0000359 buf[1] = (divisor / 2 - 1) & 0xff;
360 buf[2] = ((divisor / 2 - 1) >> 8) & 0xff;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000361 if (send_buf(ftdic, buf, 3)) {
362 ret = -6;
363 goto ftdi_err;
364 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000365
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000366 msg_pdbg("MPSSE clock: %f MHz, divisor: %u, SPI clock: %f MHz\n",
367 mpsse_clk, divisor, (double)(mpsse_clk / divisor));
Paul Fox05dfbe62009-06-16 21:08:06 +0000368
Uwe Hermannc67d0372009-10-01 18:40:02 +0000369 /* Disconnect TDI/DO to TDO/DI for loopback. */
Sean Nelson34b5db72010-01-10 01:08:37 +0000370 msg_pdbg("No loopback of TDI/DO TDO/DI\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000371 buf[0] = 0x85;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000372 if (send_buf(ftdic, buf, 1)) {
373 ret = -7;
374 goto ftdi_err;
375 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000376
Sean Nelson34b5db72010-01-10 01:08:37 +0000377 msg_pdbg("Set data bits\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000378 buf[0] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000379 buf[1] = cs_bits;
380 buf[2] = pindir;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000381 if (send_buf(ftdic, buf, 3)) {
382 ret = -8;
383 goto ftdi_err;
384 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000385
Michael Karcherb9dbe482011-05-11 17:07:07 +0000386 register_spi_programmer(&spi_programmer_ft2232);
Paul Fox05dfbe62009-06-16 21:08:06 +0000387
388 return 0;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000389
390ftdi_err:
391 if ((f = ftdi_usb_close(ftdic)) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000392 msg_perr("Unable to close FTDI device: %d (%s)\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000393 }
Uwe Hermann274a20d2011-07-21 09:18:18 +0000394 return ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000395}
396
Uwe Hermann274a20d2011-07-21 09:18:18 +0000397/* Returns 0 upon success, a negative number upon errors. */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000398static int ft2232_spi_send_command(struct flashctx *flash,
399 unsigned int writecnt, unsigned int readcnt,
400 const unsigned char *writearr,
401 unsigned char *readarr)
Paul Fox05dfbe62009-06-16 21:08:06 +0000402{
403 struct ftdi_context *ftdic = &ftdic_context;
404 static unsigned char *buf = NULL;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000405 /* failed is special. We use bitwise ops, but it is essentially bool. */
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000406 int i = 0, ret = 0, failed = 0;
407 int bufsize;
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000408 static int oldbufsize = 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000409
Carl-Daniel Hailfinger142e30f2009-07-14 10:26:56 +0000410 if (writecnt > 65536 || readcnt > 65536)
411 return SPI_INVALID_LENGTH;
412
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000413 /* buf is not used for the response from the chip. */
414 bufsize = max(writecnt + 9, 260 + 9);
415 /* Never shrink. realloc() calls are expensive. */
416 if (bufsize > oldbufsize) {
417 buf = realloc(buf, bufsize);
418 if (!buf) {
Sean Nelson34b5db72010-01-10 01:08:37 +0000419 msg_perr("Out of memory!\n");
Uwe Hermann274a20d2011-07-21 09:18:18 +0000420 /* TODO: What to do with buf? */
421 return SPI_GENERIC_ERROR;
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000422 }
423 oldbufsize = bufsize;
Paul Fox05dfbe62009-06-16 21:08:06 +0000424 }
425
Uwe Hermannc67d0372009-10-01 18:40:02 +0000426 /*
427 * Minimize USB transfers by packing as many commands as possible
428 * together. If we're not expecting to read, we can assert CS#, write,
429 * and deassert CS# all in one shot. If reading, we do three separate
Stefan Reinauerab044b22009-09-16 08:26:59 +0000430 * operations.
431 */
Sean Nelson34b5db72010-01-10 01:08:37 +0000432 msg_pspew("Assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000433 buf[i++] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000434 buf[i++] = 0 & ~cs_bits; /* assertive */
435 buf[i++] = pindir;
Paul Fox05dfbe62009-06-16 21:08:06 +0000436
437 if (writecnt) {
438 buf[i++] = 0x11;
439 buf[i++] = (writecnt - 1) & 0xff;
440 buf[i++] = ((writecnt - 1) >> 8) & 0xff;
Uwe Hermannc67d0372009-10-01 18:40:02 +0000441 memcpy(buf + i, writearr, writecnt);
Paul Fox05dfbe62009-06-16 21:08:06 +0000442 i += writecnt;
443 }
444
Uwe Hermannc67d0372009-10-01 18:40:02 +0000445 /*
446 * Optionally terminate this batch of commands with a
Paul Fox05dfbe62009-06-16 21:08:06 +0000447 * read command, then do the fetch of the results.
448 */
449 if (readcnt) {
450 buf[i++] = 0x20;
451 buf[i++] = (readcnt - 1) & 0xff;
452 buf[i++] = ((readcnt - 1) >> 8) & 0xff;
453 ret = send_buf(ftdic, buf, i);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000454 failed = ret;
455 /* We can't abort here, we still have to deassert CS#. */
456 if (ret)
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000457 msg_perr("send_buf failed before read: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000458 i = 0;
Stefan Reinauerab044b22009-09-16 08:26:59 +0000459 if (ret == 0) {
Uwe Hermannc67d0372009-10-01 18:40:02 +0000460 /*
461 * FIXME: This is unreliable. There's no guarantee that
462 * we read the response directly after sending the read
463 * command. We may be scheduled out etc.
Stefan Reinauerab044b22009-09-16 08:26:59 +0000464 */
465 ret = get_buf(ftdic, readarr, readcnt);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000466 failed |= ret;
467 /* We can't abort here either. */
468 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000469 msg_perr("get_buf failed: %i\n", ret);
Stefan Reinauerab044b22009-09-16 08:26:59 +0000470 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000471 }
472
Sean Nelson34b5db72010-01-10 01:08:37 +0000473 msg_pspew("De-assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000474 buf[i++] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000475 buf[i++] = cs_bits;
476 buf[i++] = pindir;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000477 ret = send_buf(ftdic, buf, i);
478 failed |= ret;
479 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000480 msg_perr("send_buf failed at end: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000481
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000482 return failed ? -1 : 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000483}
484
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000485void print_supported_usbdevs(const struct usbdev_status *devs)
486{
Uwe Hermann70145292010-07-29 19:57:55 +0000487 int i;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000488
Carl-Daniel Hailfingera73fb492010-10-06 23:48:34 +0000489 msg_pinfo("USB devices:\n");
Uwe Hermann70145292010-07-29 19:57:55 +0000490 for (i = 0; devs[i].vendor_name != NULL; i++) {
491 msg_pinfo("%s %s [%04x:%04x]%s\n", devs[i].vendor_name,
492 devs[i].device_name, devs[i].vendor_id,
493 devs[i].device_id,
494 (devs[i].status == NT) ? " (untested)" : "");
495 }
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000496}
497
Paul Fox05dfbe62009-06-16 21:08:06 +0000498#endif