blob: 5bdc2a7b277e26eb5c2493431e21ed4b7bcaa2bd [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).
30 * Some tests indicate that his is the only change that it is needed to support the FT232H in flashrom. */
31#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
Stefan Tauner4b24a2d2012-12-27 18:40:36 +000062const 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
Samir Ibradžićb482c6d2012-05-15 22:58:19 +000082#define DEFAULT_DIVISOR 2
Paul Fox05dfbe62009-06-16 21:08:06 +000083
Uwe Hermannc67d0372009-10-01 18:40:02 +000084#define BITMODE_BITBANG_NORMAL 1
85#define BITMODE_BITBANG_SPI 2
Paul Fox05dfbe62009-06-16 21:08:06 +000086
Antony Pavlovb4dd40c2015-01-25 03:52:47 +000087/* The variables cs_bits and pindir store the values for the "set data bits low byte" MPSSE command that
88 * sets the initial state and the direction of the I/O pins. The pin offsets are as follows:
89 * SCK is bit 0.
90 * DO is bit 1.
91 * DI is bit 2.
92 * CS is bit 3.
93 *
94 * The default values (set below) are used for most devices:
Jörg Fischer6529b9f2010-07-29 15:54:53 +000095 * value: 0x08 CS=high, DI=low, DO=low, SK=low
96 * dir: 0x0b CS=output, DI=input, DO=output, SK=output
Jörg Fischer6529b9f2010-07-29 15:54:53 +000097 */
Uwe Hermann70145292010-07-29 19:57:55 +000098static uint8_t cs_bits = 0x08;
99static uint8_t pindir = 0x0b;
Paul Fox05dfbe62009-06-16 21:08:06 +0000100static struct ftdi_context ftdic_context;
101
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000102static const char *get_ft2232_devicename(int ft2232_vid, int ft2232_type)
103{
104 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000105 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000106 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000107 return devs_ft2232spi[i].device_name;
108 }
109 return "unknown device";
110}
111
112static const char *get_ft2232_vendorname(int ft2232_vid, int ft2232_type)
113{
114 int i;
Uwe Hermann70145292010-07-29 19:57:55 +0000115 for (i = 0; devs_ft2232spi[i].vendor_name != NULL; i++) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000116 if ((devs_ft2232spi[i].device_id == ft2232_type) && (devs_ft2232spi[i].vendor_id == ft2232_vid))
Uwe Hermann70145292010-07-29 19:57:55 +0000117 return devs_ft2232spi[i].vendor_name;
118 }
119 return "unknown vendor";
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000120}
121
Uwe Hermann70145292010-07-29 19:57:55 +0000122static int send_buf(struct ftdi_context *ftdic, const unsigned char *buf,
123 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000124{
125 int r;
126 r = ftdi_write_data(ftdic, (unsigned char *) buf, size);
127 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000128 msg_perr("ftdi_write_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Paul Fox05dfbe62009-06-16 21:08:06 +0000129 return 1;
130 }
131 return 0;
132}
133
Uwe Hermann70145292010-07-29 19:57:55 +0000134static int get_buf(struct ftdi_context *ftdic, const unsigned char *buf,
135 int size)
Paul Fox05dfbe62009-06-16 21:08:06 +0000136{
137 int r;
Alex Badeab9556e02010-11-10 03:10:41 +0000138
139 while (size > 0) {
140 r = ftdi_read_data(ftdic, (unsigned char *) buf, size);
141 if (r < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000142 msg_perr("ftdi_read_data: %d, %s\n", r, ftdi_get_error_string(ftdic));
Alex Badeab9556e02010-11-10 03:10:41 +0000143 return 1;
144 }
145 buf += r;
146 size -= r;
Paul Fox05dfbe62009-06-16 21:08:06 +0000147 }
148 return 0;
149}
150
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000151static int ft2232_spi_send_command(struct flashctx *flash,
152 unsigned int writecnt, unsigned int readcnt,
153 const unsigned char *writearr,
154 unsigned char *readarr);
Michael Karcherb9dbe482011-05-11 17:07:07 +0000155
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000156static const struct spi_master spi_master_ft2232 = {
Nico Huber1cf407b2017-11-10 20:18:23 +0100157 .features = SPI_MASTER_4BA,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000158 .max_data_read = 64 * 1024,
159 .max_data_write = 256,
160 .command = ft2232_spi_send_command,
161 .multicommand = default_spi_send_multicommand,
162 .read = default_spi_read,
163 .write_256 = default_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000164 .write_aai = default_spi_write_aai,
Michael Karcherb9dbe482011-05-11 17:07:07 +0000165};
166
Uwe Hermann274a20d2011-07-21 09:18:18 +0000167/* Returns 0 upon success, a negative number upon errors. */
Paul Fox05dfbe62009-06-16 21:08:06 +0000168int ft2232_spi_init(void)
169{
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000170 int ret = 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000171 struct ftdi_context *ftdic = &ftdic_context;
172 unsigned char buf[512];
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000173 int ft2232_vid = FTDI_VID;
174 int ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000175 int channel_count = 4; /* Stores the number of channels of the device. */
176 enum ftdi_interface ft2232_interface = INTERFACE_A;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000177 /*
178 * The 'H' chips can run with an internal clock of either 12 MHz or 60 MHz,
179 * but the non-H chips can only run at 12 MHz. We enable the divide-by-5
180 * prescaler on the former to run on the same speed.
181 */
182 uint8_t clock_5x = 1;
183 /* In addition to the prescaler mentioned above there is also another
184 * configurable one on all versions of the chips. Its divisor div can be
185 * set by a 16 bit value x according to the following formula:
186 * div = (1 + x) * 2 <-> x = div / 2 - 1
187 * Hence the expressible divisors are all even numbers between 2 and
188 * 2^17 (=131072) resulting in SCK frequencies of 6 MHz down to about
189 * 92 Hz for 12 MHz inputs.
190 */
191 uint32_t divisor = DEFAULT_DIVISOR;
192 int f;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000193 char *arg;
Alex Badea0b94d052010-11-10 03:18:41 +0000194 double mpsse_clk;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000195
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000196 arg = extract_programmer_param("type");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000197 if (arg) {
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000198 if (!strcasecmp(arg, "2232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000199 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000200 channel_count = 2;
201 } else if (!strcasecmp(arg, "4232H")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000202 ft2232_type = FTDI_FT4232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000203 channel_count = 4;
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000204 } else if (!strcasecmp(arg, "232H")) {
205 ft2232_type = FTDI_FT232H_PID;
206 channel_count = 1;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000207 } else if (!strcasecmp(arg, "jtagkey")) {
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000208 ft2232_type = AMONTEC_JTAGKEY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000209 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000210 /* JTAGkey(2) needs to enable its output via Bit4 / GPIOL0
211 * value: 0x18 OE=high, CS=high, DI=low, DO=low, SK=low
212 * dir: 0x1b OE=output, CS=output, DI=input, DO=output, SK=output */
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000213 cs_bits = 0x18;
Uwe Hermann70145292010-07-29 19:57:55 +0000214 pindir = 0x1b;
Samir Ibradžić7189a5f2011-10-20 23:14:10 +0000215 } else if (!strcasecmp(arg, "picotap")) {
216 ft2232_vid = GOEPEL_VID;
217 ft2232_type = GOEPEL_PICOTAP_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000218 channel_count = 2;
Uwe Hermann836b26a2011-10-14 20:33:14 +0000219 } else if (!strcasecmp(arg, "tumpa")) {
220 /* Interface A is SPI1, B is SPI2. */
221 ft2232_type = TIAO_TUMPA_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000222 channel_count = 2;
Stefan Taunerb66ed842014-04-27 05:07:35 +0000223 } else if (!strcasecmp(arg, "tumpalite")) {
224 /* Only one channel is used on lite edition */
225 ft2232_type = TIAO_TUMPA_LITE_PID;
226 channel_count = 1;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000227 } else if (!strcasecmp(arg, "busblaster")) {
228 /* In its default configuration it is a jtagkey clone */
229 ft2232_type = FTDI_FT2232H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000230 channel_count = 2;
Steve Markgraf0528b7f2011-08-12 01:19:32 +0000231 cs_bits = 0x18;
232 pindir = 0x1b;
Alex Badeacaf2d422010-11-10 03:26:57 +0000233 } else if (!strcasecmp(arg, "openmoko")) {
234 ft2232_vid = FIC_VID;
235 ft2232_type = OPENMOKO_DBGBOARD_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")) {
238 ft2232_vid = OLIMEX_VID;
239 ft2232_type = OLIMEX_ARM_OCD_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000240 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000241 /* arm-usb-ocd(-h) has an output buffer that needs to be enabled by pulling ADBUS4 low.
242 * value: 0x08 #OE=low, CS=high, DI=low, DO=low, SK=low
243 * dir: 0x1b #OE=output, CS=output, DI=input, DO=output, SK=output */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000244 cs_bits = 0x08;
245 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000246 } else if (!strcasecmp(arg, "arm-usb-tiny")) {
247 ft2232_vid = OLIMEX_VID;
248 ft2232_type = OLIMEX_ARM_TINY_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000249 channel_count = 2;
Pete Batardc0207062011-06-11 12:21:37 +0000250 } else if (!strcasecmp(arg, "arm-usb-ocd-h")) {
251 ft2232_vid = OLIMEX_VID;
252 ft2232_type = OLIMEX_ARM_OCD_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000253 channel_count = 2;
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000254 /* See arm-usb-ocd */
Paul Fertser3cf335e2011-12-20 02:08:14 +0000255 cs_bits = 0x08;
256 pindir = 0x1b;
Pete Batardc0207062011-06-11 12:21:37 +0000257 } else if (!strcasecmp(arg, "arm-usb-tiny-h")) {
258 ft2232_vid = OLIMEX_VID;
259 ft2232_type = OLIMEX_ARM_TINY_H_PID;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000260 channel_count = 2;
Todd Broch6800c952016-02-14 15:46:00 +0000261 } else if (!strcasecmp(arg, "google-servo")) {
262 ft2232_vid = GOOGLE_VID;
263 ft2232_type = GOOGLE_SERVO_PID;
264 } else if (!strcasecmp(arg, "google-servo-v2")) {
265 ft2232_vid = GOOGLE_VID;
266 ft2232_type = GOOGLE_SERVO_V2_PID1;
267 /* Default divisor is too fast, and chip ID fails */
268 divisor = 6;
269 } else if (!strcasecmp(arg, "google-servo-v2-legacy")) {
270 ft2232_vid = GOOGLE_VID;
271 ft2232_type = GOOGLE_SERVO_V2_PID0;
Russ Dill7bd31a42019-10-30 00:40:43 -0700272 } else if (!strcasecmp(arg, "flyswatter")) {
273 ft2232_type = FTDI_FT2232H_PID;
274 channel_count = 2;
275 /* Flyswatter and Flyswatter-2 require GPIO bits 0x80
276 * and 0x40 to be driven low to enable output buffers */
277 pindir = 0xcb;
Alex Badeacaf2d422010-11-10 03:26:57 +0000278 } else {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000279 msg_perr("Error: Invalid device type specified.\n");
280 free(arg);
Uwe Hermann274a20d2011-07-21 09:18:18 +0000281 return -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000282 }
283 }
284 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000285
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000286 arg = extract_programmer_param("port");
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000287 if (arg) {
Carl-Daniel Hailfinger9e3a6c42010-10-08 12:40:09 +0000288 switch (toupper((unsigned char)*arg)) {
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000289 case 'A':
290 ft2232_interface = INTERFACE_A;
291 break;
292 case 'B':
293 ft2232_interface = INTERFACE_B;
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000294 if (channel_count < 2)
295 channel_count = -1;
296 break;
297 case 'C':
298 ft2232_interface = INTERFACE_C;
299 if (channel_count < 3)
300 channel_count = -1;
301 break;
302 case 'D':
303 ft2232_interface = INTERFACE_D;
304 if (channel_count < 4)
305 channel_count = -1;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000306 break;
307 default:
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000308 channel_count = -1;
309 break;
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000310 }
Stefan Taunerd7d423b2012-10-20 09:13:16 +0000311 if (channel_count < 0 || strlen(arg) != 1) {
312 msg_perr("Error: Invalid channel/port/interface specified: \"%s\".\n", arg);
313 free(arg);
314 return -2;
315 }
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000316 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000317 free(arg);
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000318
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000319 arg = extract_programmer_param("divisor");
320 if (arg && strlen(arg)) {
321 unsigned int temp = 0;
322 char *endptr;
323 temp = strtoul(arg, &endptr, 10);
324 if (*endptr || temp < 2 || temp > 131072 || temp & 0x1) {
325 msg_perr("Error: Invalid SPI frequency divisor specified: \"%s\".\n"
326 "Valid are even values between 2 and 131072.\n", arg);
327 free(arg);
328 return -2;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000329 }
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200330 divisor = (uint32_t)temp;
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000331 }
332 free(arg);
Stefan Tauner3e515e22012-09-26 00:48:16 +0000333
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300334 arg = extract_programmer_param("csgpiol");
335 if (arg) {
336 char *endptr;
337 unsigned int temp = strtoul(arg, &endptr, 10);
338 if (*endptr || endptr == arg || temp > 3) {
339 msg_perr("Error: Invalid GPIOL specified: \"%s\".\n"
340 "Valid values are between 0 and 3.\n", arg);
341 free(arg);
342 return -2;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300343 }
Elyes HAOUAS712ba3a2019-06-09 17:11:49 +0200344 unsigned int pin = temp + 4;
345 cs_bits |= 1 << pin;
346 pindir |= 1 << pin;
Sergey Alirzaev4acc3f32018-08-01 16:39:17 +0300347 }
348 free(arg);
349
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000350 msg_pdbg("Using device type %s %s ",
Uwe Hermann70145292010-07-29 19:57:55 +0000351 get_ft2232_vendorname(ft2232_vid, ft2232_type),
352 get_ft2232_devicename(ft2232_vid, ft2232_type));
Stefan Tauner3e515e22012-09-26 00:48:16 +0000353 msg_pdbg("channel %s.\n",
Stefan Taunerfbc71ac2012-09-26 00:46:02 +0000354 (ft2232_interface == INTERFACE_A) ? "A" :
355 (ft2232_interface == INTERFACE_B) ? "B" :
356 (ft2232_interface == INTERFACE_C) ? "C" : "D");
Paul Fox05dfbe62009-06-16 21:08:06 +0000357
358 if (ftdi_init(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000359 msg_perr("ftdi_init failed.\n");
Uwe Hermann274a20d2011-07-21 09:18:18 +0000360 return -3;
Paul Fox05dfbe62009-06-16 21:08:06 +0000361 }
362
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000363 if (ftdi_set_interface(ftdic, ft2232_interface) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000364 msg_perr("Unable to select channel (%s).\n", ftdi_get_error_string(ftdic));
Ilya A. Volynets-Evenbakh7c36d522012-08-14 01:32:46 +0000365 }
366
Shik Chen14fbc4b2012-09-17 00:40:54 +0000367 arg = extract_programmer_param("serial");
368 f = ftdi_usb_open_desc(ftdic, ft2232_vid, ft2232_type, NULL, arg);
369 free(arg);
Paul Fox05dfbe62009-06-16 21:08:06 +0000370
371 if (f < 0 && f != -5) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000372 msg_perr("Unable to open FTDI device: %d (%s).\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000373 return -4;
Paul Fox05dfbe62009-06-16 21:08:06 +0000374 }
375
Ilya A. Volynets-Evenbakh2c714ab2012-09-26 00:47:09 +0000376 if (ftdic->type != TYPE_2232H && ftdic->type != TYPE_4232H && ftdic->type != TYPE_232H) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000377 msg_pdbg("FTDI chip type %d is not high-speed.\n", ftdic->type);
Alex Badea0b94d052010-11-10 03:18:41 +0000378 clock_5x = 0;
379 }
380
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000381 if (ftdi_usb_reset(ftdic) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000382 msg_perr("Unable to reset FTDI device (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000383 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000384
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000385 if (ftdi_set_latency_timer(ftdic, 2) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000386 msg_perr("Unable to set latency timer (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000387 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000388
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000389 if (ftdi_write_data_set_chunksize(ftdic, 256)) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000390 msg_perr("Unable to set chunk size (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000391 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000392
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000393 if (ftdi_set_bitmode(ftdic, 0x00, BITMODE_BITBANG_SPI) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000394 msg_perr("Unable to set bitmode to SPI (%s).\n", ftdi_get_error_string(ftdic));
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000395 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000396
Alex Badea0b94d052010-11-10 03:18:41 +0000397 if (clock_5x) {
398 msg_pdbg("Disable divide-by-5 front stage\n");
Stefan Tauner05151b62015-01-25 23:42:57 +0000399 buf[0] = 0x8a; /* Disable divide-by-5. DIS_DIV_5 in newer libftdi */
Uwe Hermann274a20d2011-07-21 09:18:18 +0000400 if (send_buf(ftdic, buf, 1)) {
401 ret = -5;
402 goto ftdi_err;
403 }
Alex Badea0b94d052010-11-10 03:18:41 +0000404 mpsse_clk = 60.0;
405 } else {
406 mpsse_clk = 12.0;
407 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000408
Sean Nelson34b5db72010-01-10 01:08:37 +0000409 msg_pdbg("Set clock divisor\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000410 buf[0] = TCK_DIVISOR;
Ilya A. Volynets-Evenbakh3464d052012-06-14 13:08:33 +0000411 buf[1] = (divisor / 2 - 1) & 0xff;
412 buf[2] = ((divisor / 2 - 1) >> 8) & 0xff;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000413 if (send_buf(ftdic, buf, 3)) {
414 ret = -6;
415 goto ftdi_err;
416 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000417
Samir Ibradžićb482c6d2012-05-15 22:58:19 +0000418 msg_pdbg("MPSSE clock: %f MHz, divisor: %u, SPI clock: %f MHz\n",
419 mpsse_clk, divisor, (double)(mpsse_clk / divisor));
Paul Fox05dfbe62009-06-16 21:08:06 +0000420
Uwe Hermannc67d0372009-10-01 18:40:02 +0000421 /* Disconnect TDI/DO to TDO/DI for loopback. */
Sean Nelson34b5db72010-01-10 01:08:37 +0000422 msg_pdbg("No loopback of TDI/DO TDO/DI\n");
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000423 buf[0] = LOOPBACK_END;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000424 if (send_buf(ftdic, buf, 1)) {
425 ret = -7;
426 goto ftdi_err;
427 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000428
Sean Nelson34b5db72010-01-10 01:08:37 +0000429 msg_pdbg("Set data bits\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000430 buf[0] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000431 buf[1] = cs_bits;
432 buf[2] = pindir;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000433 if (send_buf(ftdic, buf, 3)) {
434 ret = -8;
435 goto ftdi_err;
436 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000437
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000438 register_spi_master(&spi_master_ft2232);
Paul Fox05dfbe62009-06-16 21:08:06 +0000439
440 return 0;
Uwe Hermann274a20d2011-07-21 09:18:18 +0000441
442ftdi_err:
443 if ((f = ftdi_usb_close(ftdic)) < 0) {
Stefan Tauner3e515e22012-09-26 00:48:16 +0000444 msg_perr("Unable to close FTDI device: %d (%s)\n", f, ftdi_get_error_string(ftdic));
Uwe Hermann274a20d2011-07-21 09:18:18 +0000445 }
Uwe Hermann274a20d2011-07-21 09:18:18 +0000446 return ret;
Paul Fox05dfbe62009-06-16 21:08:06 +0000447}
448
Uwe Hermann274a20d2011-07-21 09:18:18 +0000449/* Returns 0 upon success, a negative number upon errors. */
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000450static int ft2232_spi_send_command(struct flashctx *flash,
451 unsigned int writecnt, unsigned int readcnt,
452 const unsigned char *writearr,
453 unsigned char *readarr)
Paul Fox05dfbe62009-06-16 21:08:06 +0000454{
455 struct ftdi_context *ftdic = &ftdic_context;
456 static unsigned char *buf = NULL;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000457 /* failed is special. We use bitwise ops, but it is essentially bool. */
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000458 int i = 0, ret = 0, failed = 0;
459 int bufsize;
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000460 static int oldbufsize = 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000461
Carl-Daniel Hailfinger142e30f2009-07-14 10:26:56 +0000462 if (writecnt > 65536 || readcnt > 65536)
463 return SPI_INVALID_LENGTH;
464
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000465 /* buf is not used for the response from the chip. */
466 bufsize = max(writecnt + 9, 260 + 9);
467 /* Never shrink. realloc() calls are expensive. */
468 if (bufsize > oldbufsize) {
469 buf = realloc(buf, bufsize);
470 if (!buf) {
Sean Nelson34b5db72010-01-10 01:08:37 +0000471 msg_perr("Out of memory!\n");
Uwe Hermann274a20d2011-07-21 09:18:18 +0000472 /* TODO: What to do with buf? */
473 return SPI_GENERIC_ERROR;
Carl-Daniel Hailfingerb7e01452009-11-25 16:58:17 +0000474 }
475 oldbufsize = bufsize;
Paul Fox05dfbe62009-06-16 21:08:06 +0000476 }
477
Uwe Hermannc67d0372009-10-01 18:40:02 +0000478 /*
479 * Minimize USB transfers by packing as many commands as possible
480 * together. If we're not expecting to read, we can assert CS#, write,
481 * and deassert CS# all in one shot. If reading, we do three separate
Stefan Reinauerab044b22009-09-16 08:26:59 +0000482 * operations.
483 */
Sean Nelson34b5db72010-01-10 01:08:37 +0000484 msg_pspew("Assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000485 buf[i++] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000486 buf[i++] = 0 & ~cs_bits; /* assertive */
487 buf[i++] = pindir;
Paul Fox05dfbe62009-06-16 21:08:06 +0000488
489 if (writecnt) {
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000490 buf[i++] = MPSSE_DO_WRITE | MPSSE_WRITE_NEG;
Paul Fox05dfbe62009-06-16 21:08:06 +0000491 buf[i++] = (writecnt - 1) & 0xff;
492 buf[i++] = ((writecnt - 1) >> 8) & 0xff;
Uwe Hermannc67d0372009-10-01 18:40:02 +0000493 memcpy(buf + i, writearr, writecnt);
Paul Fox05dfbe62009-06-16 21:08:06 +0000494 i += writecnt;
495 }
496
Uwe Hermannc67d0372009-10-01 18:40:02 +0000497 /*
498 * Optionally terminate this batch of commands with a
Paul Fox05dfbe62009-06-16 21:08:06 +0000499 * read command, then do the fetch of the results.
500 */
501 if (readcnt) {
Antony Pavlovb4dd40c2015-01-25 03:52:47 +0000502 buf[i++] = MPSSE_DO_READ;
Paul Fox05dfbe62009-06-16 21:08:06 +0000503 buf[i++] = (readcnt - 1) & 0xff;
504 buf[i++] = ((readcnt - 1) >> 8) & 0xff;
505 ret = send_buf(ftdic, buf, i);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000506 failed = ret;
507 /* We can't abort here, we still have to deassert CS#. */
508 if (ret)
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000509 msg_perr("send_buf failed before read: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000510 i = 0;
Stefan Reinauerab044b22009-09-16 08:26:59 +0000511 if (ret == 0) {
Uwe Hermannc67d0372009-10-01 18:40:02 +0000512 /*
513 * FIXME: This is unreliable. There's no guarantee that
514 * we read the response directly after sending the read
515 * command. We may be scheduled out etc.
Stefan Reinauerab044b22009-09-16 08:26:59 +0000516 */
517 ret = get_buf(ftdic, readarr, readcnt);
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000518 failed |= ret;
519 /* We can't abort here either. */
520 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000521 msg_perr("get_buf failed: %i\n", ret);
Stefan Reinauerab044b22009-09-16 08:26:59 +0000522 }
Paul Fox05dfbe62009-06-16 21:08:06 +0000523 }
524
Sean Nelson34b5db72010-01-10 01:08:37 +0000525 msg_pspew("De-assert CS#\n");
Paul Fox05dfbe62009-06-16 21:08:06 +0000526 buf[i++] = SET_BITS_LOW;
Jörg Fischer6529b9f2010-07-29 15:54:53 +0000527 buf[i++] = cs_bits;
528 buf[i++] = pindir;
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000529 ret = send_buf(ftdic, buf, i);
530 failed |= ret;
531 if (ret)
Sean Nelson34b5db72010-01-10 01:08:37 +0000532 msg_perr("send_buf failed at end: %i\n", ret);
Paul Fox05dfbe62009-06-16 21:08:06 +0000533
Carl-Daniel Hailfingera2441ce2009-11-22 01:33:40 +0000534 return failed ? -1 : 0;
Paul Fox05dfbe62009-06-16 21:08:06 +0000535}
536
Paul Fox05dfbe62009-06-16 21:08:06 +0000537#endif