blob: 901acdd93a179f9c8b9ea5648c44d656b163ed81 [file] [log] [blame]
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +00001/*
2 * This file is part of the flashrom project.
3 *
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +00004 * Copyright (C) 2009, 2010, 2011, 2012 Carl-Daniel Hailfinger
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +00005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000014 */
15
16#include <stdio.h>
Carl-Daniel Hailfinger1c6d2ff2012-08-27 00:44:42 +000017#include <strings.h>
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000018#include <string.h>
19#include <stdlib.h>
20#include <ctype.h>
Carl-Daniel Hailfingerd2f007f2010-09-16 22:34:25 +000021#include <unistd.h>
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000022#include "flash.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000023#include "programmer.h"
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000024#include "spi.h"
25
26/* Change this to #define if you want to test without a serial implementation */
27#undef FAKE_COMMUNICATION
28
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -060029struct buspirate_speeds {
Carl-Daniel Hailfingerc4224842011-06-09 20:06:34 +000030 const char *name;
31 const int speed;
32};
33
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -060034#define BP_DEFAULTBAUD 115200
35
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000036#ifndef FAKE_COMMUNICATION
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +000037static int buspirate_serialport_setup(char *dev)
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000038{
39 /* 115200bps, 8 databits, no parity, 1 stopbit */
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -060040 sp_fd = sp_openserport(dev, BP_DEFAULTBAUD);
Elyes HAOUAS124ef382018-03-27 12:15:09 +020041 if (sp_fd == SER_INV_FD)
Niklas Söderlund2a95e872012-07-30 19:42:33 +000042 return 1;
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000043 return 0;
44}
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000045#else
46#define buspirate_serialport_setup(...) 0
Carl-Daniel Hailfingerefa151e2010-01-06 16:09:10 +000047#define serialport_shutdown(...) 0
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000048#define serialport_write(...) 0
49#define serialport_read(...) 0
Patrick Georgi3b6237d2010-01-06 19:09:40 +000050#define sp_flush_incoming(...) 0
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000051#endif
52
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +000053static unsigned char *bp_commbuf = NULL;
54static int bp_commbufsize = 0;
55
56static int buspirate_commbuf_grow(int bufsize)
57{
58 unsigned char *tmpbuf;
59
60 /* Never shrink. realloc() calls are expensive. */
61 if (bufsize <= bp_commbufsize)
62 return 0;
63
64 tmpbuf = realloc(bp_commbuf, bufsize);
65 if (!tmpbuf) {
66 /* Keep the existing buffer because memory is already tight. */
67 msg_perr("Out of memory!\n");
68 return ERROR_OOM;
69 }
70
71 bp_commbuf = tmpbuf;
72 bp_commbufsize = bufsize;
73 return 0;
74}
75
Uwe Hermann91f4afa2011-07-28 08:13:25 +000076static int buspirate_sendrecv(unsigned char *buf, unsigned int writecnt,
77 unsigned int readcnt)
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000078{
Nico Huber519be662018-12-23 20:03:35 +010079 unsigned int i;
80 int ret = 0;
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000081
Sean Nelson84f7bce2010-01-09 23:56:41 +000082 msg_pspew("%s: write %i, read %i ", __func__, writecnt, readcnt);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000083 if (!writecnt && !readcnt) {
Sean Nelson84f7bce2010-01-09 23:56:41 +000084 msg_perr("Zero length command!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000085 return 1;
86 }
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +000087 if (writecnt)
88 msg_pspew("Sending");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000089 for (i = 0; i < writecnt; i++)
Sean Nelson84f7bce2010-01-09 23:56:41 +000090 msg_pspew(" 0x%02x", buf[i]);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +000091#ifdef FAKE_COMMUNICATION
92 /* Placate the caller for now. */
93 if (readcnt) {
94 buf[0] = 0x01;
95 memset(buf + 1, 0xff, readcnt - 1);
96 }
97 ret = 0;
98#else
99 if (writecnt)
100 ret = serialport_write(buf, writecnt);
101 if (ret)
102 return ret;
103 if (readcnt)
104 ret = serialport_read(buf, readcnt);
105 if (ret)
106 return ret;
107#endif
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000108 if (readcnt)
109 msg_pspew(", receiving");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000110 for (i = 0; i < readcnt; i++)
Sean Nelson84f7bce2010-01-09 23:56:41 +0000111 msg_pspew(" 0x%02x", buf[i]);
112 msg_pspew("\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000113 return 0;
114}
115
Jacob Garber4a84ec22019-07-25 19:12:31 -0600116static int buspirate_wait_for_string(unsigned char *buf, const char *key)
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000117{
118 unsigned int keylen = strlen(key);
119 int ret;
120
121 ret = buspirate_sendrecv(buf, 0, keylen);
122 while (!ret) {
123 if (!memcmp(buf, key, keylen))
124 return 0;
125 memmove(buf, buf + 1, keylen - 1);
126 ret = buspirate_sendrecv(buf + keylen - 1, 0, 1);
127 }
128 return ret;
129}
130
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000131static int buspirate_spi_send_command_v1(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000132 const unsigned char *writearr, unsigned char *readarr);
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000133static int buspirate_spi_send_command_v2(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000134 const unsigned char *writearr, unsigned char *readarr);
Michael Karcherb9dbe482011-05-11 17:07:07 +0000135
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000136static struct spi_master spi_master_buspirate = {
Nico Huber1cf407b2017-11-10 20:18:23 +0100137 .features = SPI_MASTER_4BA,
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000138 .max_data_read = MAX_DATA_UNSPECIFIED,
139 .max_data_write = MAX_DATA_UNSPECIFIED,
140 .command = NULL,
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000141 .multicommand = default_spi_send_multicommand,
142 .read = default_spi_read,
143 .write_256 = default_spi_write_256,
Nico Huber7bca1262012-06-15 22:28:12 +0000144 .write_aai = default_spi_write_aai,
Michael Karcherb9dbe482011-05-11 17:07:07 +0000145};
146
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600147static const struct buspirate_speeds spispeeds[] = {
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000148 {"30k", 0x0},
149 {"125k", 0x1},
150 {"250k", 0x2},
151 {"1M", 0x3},
152 {"2M", 0x4},
153 {"2.6M", 0x5},
154 {"4M", 0x6},
155 {"8M", 0x7},
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600156 {NULL, 0x0}
157};
158
159static const struct buspirate_speeds serialspeeds[] = {
160 {"115200", 115200},
161 {"230400", 230400},
162 {"250000", 250000},
163 {"2000000", 2000000},
164 {"2M", 2000000},
165 {NULL, 0}
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000166};
167
David Hendricks8bb20212011-06-14 01:35:36 +0000168static int buspirate_spi_shutdown(void *data)
169{
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000170 int ret = 0, ret2 = 0;
171 /* No need to allocate a buffer here, we know that bp_commbuf is at least DEFAULT_BUFSIZE big. */
David Hendricks8bb20212011-06-14 01:35:36 +0000172
173 /* Exit raw SPI mode (enter raw bitbang mode) */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000174 bp_commbuf[0] = 0x00;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000175 if ((ret = buspirate_sendrecv(bp_commbuf, 1, 0)))
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000176 goto out_shutdown;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000177 if ((ret = buspirate_wait_for_string(bp_commbuf, "BBIO")))
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000178 goto out_shutdown;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000179 if ((ret = buspirate_sendrecv(bp_commbuf, 0, 1)))
180 goto out_shutdown;
181 msg_pdbg("Raw bitbang mode version %c\n", bp_commbuf[0]);
182 if (bp_commbuf[0] != '1') {
183 msg_perr("Can't handle raw bitbang mode version %c!\n", bp_commbuf[0]);
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000184 ret = 1;
185 goto out_shutdown;
David Hendricks8bb20212011-06-14 01:35:36 +0000186 }
187 /* Reset Bus Pirate (return to user terminal) */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000188 bp_commbuf[0] = 0x0f;
189 ret = buspirate_sendrecv(bp_commbuf, 1, 0);
David Hendricks8bb20212011-06-14 01:35:36 +0000190
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000191out_shutdown:
David Hendricks8bb20212011-06-14 01:35:36 +0000192 /* Shut down serial port communication */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000193 ret2 = serialport_shutdown(NULL);
194 /* Keep the oldest error, it is probably the best indicator. */
195 if (ret2 && !ret)
196 ret = ret2;
197 bp_commbufsize = 0;
198 free(bp_commbuf);
199 bp_commbuf = NULL;
David Hendricks8bb20212011-06-14 01:35:36 +0000200 if (ret)
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000201 msg_pdbg("Bus Pirate shutdown failed.\n");
202 else
203 msg_pdbg("Bus Pirate shutdown completed.\n");
David Hendricks8bb20212011-06-14 01:35:36 +0000204
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000205 return ret;
David Hendricks8bb20212011-06-14 01:35:36 +0000206}
207
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000208#define BP_FWVERSION(a,b) ((a) << 8 | (b))
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600209#define BP_HWVERSION(a,b) BP_FWVERSION(a,b)
210
211/**
212 * The Bus Pirate's PIC microcontroller supports custom baud rates by manually specifying a
213 * clock divisor that can be calculated with the formula (16000000 / (4 * baud)) - 1.
214 */
215#define BP_DIVISOR(baud) ((4000000/(baud)) - 1)
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000216
Thomas Heijligencc853d82021-05-04 15:32:17 +0200217static int buspirate_spi_init(void)
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000218{
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000219 char *tmp;
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000220 char *dev;
221 int i;
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600222 int cnt;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000223 unsigned int fw_version_major = 0;
224 unsigned int fw_version_minor = 0;
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600225 unsigned int hw_version_major = 0;
226 unsigned int hw_version_minor = 0;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000227 int spispeed = 0x7;
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600228 int serialspeed_index = -1;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +0000229 int ret = 0;
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000230 int pullup = 0;
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000231
Carl-Daniel Hailfinger2b6dcb32010-07-08 10:13:37 +0000232 dev = extract_programmer_param("dev");
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000233 if (dev && !strlen(dev)) {
234 free(dev);
235 dev = NULL;
236 }
237 if (!dev) {
238 msg_perr("No serial device given. Use flashrom -p buspirate_spi:dev=/dev/ttyUSB0\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000239 return 1;
240 }
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000241
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000242 tmp = extract_programmer_param("spispeed");
243 if (tmp) {
244 for (i = 0; spispeeds[i].name; i++) {
245 if (!strncasecmp(spispeeds[i].name, tmp, strlen(spispeeds[i].name))) {
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000246 spispeed = spispeeds[i].speed;
247 break;
248 }
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000249 }
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000250 if (!spispeeds[i].name)
Sean Nelson84f7bce2010-01-09 23:56:41 +0000251 msg_perr("Invalid SPI speed, using default.\n");
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000252 }
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000253 free(tmp);
254
Elyes HAOUASe2c90c42018-08-18 09:04:41 +0200255 /* Extract serialspeed parameter */
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600256 tmp = extract_programmer_param("serialspeed");
257 if (tmp) {
258 for (i = 0; serialspeeds[i].name; i++) {
259 if (!strncasecmp(serialspeeds[i].name, tmp, strlen(serialspeeds[i].name))) {
260 serialspeed_index = i;
261 break;
262 }
263 }
264 if (!serialspeeds[i].name)
265 msg_perr("Invalid serial speed %s, using default.\n", tmp);
266 }
267 free(tmp);
268
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000269 tmp = extract_programmer_param("pullups");
270 if (tmp) {
271 if (strcasecmp("on", tmp) == 0)
272 pullup = 1;
273 else if (strcasecmp("off", tmp) == 0)
274 ; // ignore
275 else
276 msg_perr("Invalid pullups state, not using them.\n");
277 }
278 free(tmp);
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000279
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000280 /* Default buffer size is 19: 16 bytes data, 3 bytes control. */
281#define DEFAULT_BUFSIZE (16 + 3)
282 bp_commbuf = malloc(DEFAULT_BUFSIZE);
283 if (!bp_commbuf) {
284 bp_commbufsize = 0;
285 msg_perr("Out of memory!\n");
Stefan Reinauer18385912014-04-26 16:12:45 +0000286 free(dev);
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000287 return ERROR_OOM;
288 }
289 bp_commbufsize = DEFAULT_BUFSIZE;
290
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000291 ret = buspirate_serialport_setup(dev);
Carl-Daniel Hailfinger744132a2010-07-06 09:55:48 +0000292 free(dev);
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000293 if (ret) {
294 bp_commbufsize = 0;
295 free(bp_commbuf);
296 bp_commbuf = NULL;
297 return ret;
298 }
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000299
Stefan Reinauer18385912014-04-26 16:12:45 +0000300 if (register_shutdown(buspirate_spi_shutdown, NULL) != 0) {
301 bp_commbufsize = 0;
302 free(bp_commbuf);
303 bp_commbuf = NULL;
David Hendricks8bb20212011-06-14 01:35:36 +0000304 return 1;
Stefan Reinauer18385912014-04-26 16:12:45 +0000305 }
David Hendricks8bb20212011-06-14 01:35:36 +0000306
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000307 /* This is the brute force version, but it should work.
308 * It is likely to fail if a previous flashrom run was aborted during a write with the new SPI commands
309 * in firmware v5.5 because that firmware may wait for up to 4096 bytes of input before responding to
310 * 0x00 again. The obvious workaround (sending 4096 bytes of \0) may cause significant startup delays.
311 */
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000312 for (i = 0; i < 20; i++) {
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000313 /* Enter raw bitbang mode */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000314 bp_commbuf[0] = 0x00;
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000315 /* Send the command, don't read the response. */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000316 ret = buspirate_sendrecv(bp_commbuf, 1, 0);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000317 if (ret)
318 return ret;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000319 /* The old way to handle responses from a Bus Pirate already in BBIO mode was to flush any
320 * response which came in over serial. Unfortunately that does not work reliably on Linux
321 * with FTDI USB-serial.
322 */
323 //sp_flush_incoming();
324 /* The Bus Pirate can't handle UART input buffer overflow in BBIO mode, and sending a sequence
325 * of 0x00 too fast apparently triggers such an UART input buffer overflow.
326 */
Maksim Kuleshov73dc0db2013-04-05 08:06:10 +0000327 internal_sleep(10000);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000328 }
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000329 /* We know that 20 commands of \0 should elicit at least one BBIO1 response. */
330 if ((ret = buspirate_wait_for_string(bp_commbuf, "BBIO")))
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000331 return ret;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000332
333 /* Reset the Bus Pirate. */
334 bp_commbuf[0] = 0x0f;
335 /* Send the command, don't read the response. */
336 if ((ret = buspirate_sendrecv(bp_commbuf, 1, 0)))
337 return ret;
338 if ((ret = buspirate_wait_for_string(bp_commbuf, "irate ")))
339 return ret;
340 /* Read the hardware version string. Last byte of the buffer is reserved for \0. */
341 for (i = 0; i < DEFAULT_BUFSIZE - 1; i++) {
342 if ((ret = buspirate_sendrecv(bp_commbuf + i, 0, 1)))
343 return ret;
344 if (strchr("\r\n\t ", bp_commbuf[i]))
345 break;
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000346 }
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000347 bp_commbuf[i] = '\0';
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600348 msg_pdbg("Detected Bus Pirate hardware ");
349 if (bp_commbuf[0] != 'v')
350 msg_pdbg("(unknown version number format)");
351 else if (!strchr("0123456789", bp_commbuf[1]))
352 msg_pdbg("(unknown version number format)");
353 else {
354 hw_version_major = strtoul((char *)bp_commbuf + 1, &tmp, 10);
355 while ((*tmp != '\0') && !strchr("0123456789", *tmp))
356 tmp++;
357 hw_version_minor = strtoul(tmp, NULL, 10);
358 msg_pdbg("%u.%u", hw_version_major, hw_version_minor);
359 }
360 msg_pdbg2(" (\"%s\")", bp_commbuf);
361 msg_pdbg("\n");
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000362
363 if ((ret = buspirate_wait_for_string(bp_commbuf, "irmware ")))
364 return ret;
365 /* Read the firmware version string. Last byte of the buffer is reserved for \0. */
366 for (i = 0; i < DEFAULT_BUFSIZE - 1; i++) {
367 if ((ret = buspirate_sendrecv(bp_commbuf + i, 0, 1)))
368 return ret;
369 if (strchr("\r\n\t ", bp_commbuf[i]))
370 break;
371 }
372 bp_commbuf[i] = '\0';
373 msg_pdbg("Detected Bus Pirate firmware ");
374 if (bp_commbuf[0] != 'v')
375 msg_pdbg("(unknown version number format)");
376 else if (!strchr("0123456789", bp_commbuf[1]))
377 msg_pdbg("(unknown version number format)");
378 else {
379 fw_version_major = strtoul((char *)bp_commbuf + 1, &tmp, 10);
380 while ((*tmp != '\0') && !strchr("0123456789", *tmp))
381 tmp++;
382 fw_version_minor = strtoul(tmp, NULL, 10);
383 msg_pdbg("%u.%u", fw_version_major, fw_version_minor);
384 }
385 msg_pdbg2(" (\"%s\")", bp_commbuf);
386 msg_pdbg("\n");
387
388 if ((ret = buspirate_wait_for_string(bp_commbuf, "HiZ>")))
389 return ret;
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600390
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000391 /* Tell the user about missing SPI binary mode in firmware 2.3 and older. */
392 if (BP_FWVERSION(fw_version_major, fw_version_minor) < BP_FWVERSION(2, 4)) {
393 msg_pinfo("Bus Pirate firmware 2.3 and older does not support binary SPI access.\n");
394 msg_pinfo("Please upgrade to the latest firmware (at least 2.4).\n");
395 return SPI_PROGRAMMER_ERROR;
396 }
397
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000398 /* Use fast SPI mode in firmware 5.5 and newer. */
399 if (BP_FWVERSION(fw_version_major, fw_version_minor) >= BP_FWVERSION(5, 5)) {
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600400 msg_pdbg("Using SPI command set v2.\n");
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000401 /* Sensible default buffer size. */
402 if (buspirate_commbuf_grow(260 + 5))
403 return ERROR_OOM;
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000404 spi_master_buspirate.max_data_read = 2048;
405 spi_master_buspirate.max_data_write = 256;
406 spi_master_buspirate.command = buspirate_spi_send_command_v2;
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000407 } else {
408 msg_pinfo("Bus Pirate firmware 5.4 and older does not support fast SPI access.\n");
409 msg_pinfo("Reading/writing a flash chip may take hours.\n");
410 msg_pinfo("It is recommended to upgrade to firmware 5.5 or newer.\n");
411 /* Sensible default buffer size. */
412 if (buspirate_commbuf_grow(16 + 3))
413 return ERROR_OOM;
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000414 spi_master_buspirate.max_data_read = 12;
415 spi_master_buspirate.max_data_write = 12;
416 spi_master_buspirate.command = buspirate_spi_send_command_v1;
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000417 }
418
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000419 /* Workaround for broken speed settings in firmware 6.1 and older. */
420 if (BP_FWVERSION(fw_version_major, fw_version_minor) < BP_FWVERSION(6, 2))
421 if (spispeed > 0x4) {
422 msg_perr("Bus Pirate firmware 6.1 and older does not support SPI speeds above 2 MHz. "
423 "Limiting speed to 2 MHz.\n");
424 msg_pinfo("It is recommended to upgrade to firmware 6.2 or newer.\n");
425 spispeed = 0x4;
426 }
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600427
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000428 /* This works because speeds numbering starts at 0 and is contiguous. */
429 msg_pdbg("SPI speed is %sHz\n", spispeeds[spispeed].name);
430
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600431 /* Set 2M baud serial speed by default on hardware 3.0 and newer if a custom speed was not set */
432 if (serialspeed_index == -1 && BP_HWVERSION(hw_version_major, hw_version_minor) >= BP_HWVERSION(3, 0)) {
433 serialspeed_index = ARRAY_SIZE(serialspeeds) - 2;
434 msg_pdbg("Bus Pirate v3 or newer detected. Set serial speed to 2M baud.\n");
435 }
436
437 /* Set custom serial speed if specified */
438 if (serialspeed_index != -1) {
439 if (BP_FWVERSION(fw_version_major, fw_version_minor) < BP_FWVERSION(5, 5)) {
440 /* This feature requires firmware 5.5 or newer */
441 msg_perr("Bus Pirate firmware 5.4 and older does not support custom serial speeds."
442 "Using default speed of 115200 baud.\n");
443 } else if (serialspeeds[serialspeed_index].speed != BP_DEFAULTBAUD) {
444 /* Set the serial speed to match the user's choice if it doesn't already */
445
446 if (BP_HWVERSION(hw_version_major, hw_version_minor) < BP_HWVERSION(3, 0))
447 msg_pwarn("Increased serial speeds may not work on older (<3.0) Bus Pirates."
448 " Continue at your own risk.\n");
449
450 /* Enter baud rate configuration mode */
451 cnt = snprintf((char *)bp_commbuf, DEFAULT_BUFSIZE, "b\n");
452 if ((ret = buspirate_sendrecv(bp_commbuf, cnt, 0)))
453 return ret;
454 if ((ret = buspirate_wait_for_string(bp_commbuf, ">")))
455 return ret;
456
457 /* Enter manual clock divisor entry mode */
458 cnt = snprintf((char *)bp_commbuf, DEFAULT_BUFSIZE, "10\n");
459 if ((ret = buspirate_sendrecv(bp_commbuf, cnt, 0)))
460 return ret;
461 if ((ret = buspirate_wait_for_string(bp_commbuf, ">")))
462 return ret;
463
464 /* Set the clock divisor to the value calculated from the user's input */
465 cnt = snprintf((char *)bp_commbuf, DEFAULT_BUFSIZE, "%d\n",
466 BP_DIVISOR(serialspeeds[serialspeed_index].speed));
467
468 if ((ret = buspirate_sendrecv(bp_commbuf, cnt, 0)))
469 return ret;
470 sleep(1);
471
472 /* Reconfigure the host's serial baud rate to the new value */
473 if ((ret = serialport_config(sp_fd, serialspeeds[serialspeed_index].speed))) {
474 msg_perr("Unable to configure system baud rate to specified value.");
475 return ret;
476 }
477
478 /* Return to the main prompt */
479 bp_commbuf[0] = ' ';
480 if ((ret = buspirate_sendrecv(bp_commbuf, 1, 0)))
481 return ret;
482 if ((ret = buspirate_wait_for_string(bp_commbuf, "HiZ>")))
483 return ret;
484
485 msg_pdbg("Serial speed is %d baud\n", serialspeeds[serialspeed_index].speed);
486 }
487
488 }
489
490
491
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000492 /* Enter raw bitbang mode */
493 for (i = 0; i < 20; i++) {
494 bp_commbuf[0] = 0x00;
495 if ((ret = buspirate_sendrecv(bp_commbuf, 1, 0)))
496 return ret;
497 }
498 if ((ret = buspirate_wait_for_string(bp_commbuf, "BBIO")))
499 return ret;
500 if ((ret = buspirate_sendrecv(bp_commbuf, 0, 1)))
501 return ret;
502 msg_pdbg("Raw bitbang mode version %c\n", bp_commbuf[0]);
503 if (bp_commbuf[0] != '1') {
504 msg_perr("Can't handle raw bitbang mode version %c!\n", bp_commbuf[0]);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000505 return 1;
506 }
507 /* Enter raw SPI mode */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000508 bp_commbuf[0] = 0x01;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000509 ret = buspirate_sendrecv(bp_commbuf, 1, 0);
Richard Hughesd82be7b2018-12-19 15:38:51 +0000510 if (ret)
511 return 1;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000512 if ((ret = buspirate_wait_for_string(bp_commbuf, "SPI")))
Carl-Daniel Hailfingerd2f007f2010-09-16 22:34:25 +0000513 return ret;
Carl-Daniel Hailfingera16a8922012-08-17 17:30:43 +0000514 if ((ret = buspirate_sendrecv(bp_commbuf, 0, 1)))
515 return ret;
516 msg_pdbg("Raw SPI mode version %c\n", bp_commbuf[0]);
517 if (bp_commbuf[0] != '1') {
518 msg_perr("Can't handle raw SPI mode version %c!\n", bp_commbuf[0]);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000519 return 1;
520 }
521
522 /* Initial setup (SPI peripherals config): Enable power, CS high, AUX */
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000523 bp_commbuf[0] = 0x40 | 0x0b;
524 if (pullup == 1) {
525 bp_commbuf[0] |= (1 << 2);
526 msg_pdbg("Enabling pull-up resistors.\n");
527 }
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000528 ret = buspirate_sendrecv(bp_commbuf, 1, 1);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000529 if (ret)
530 return 1;
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000531 if (bp_commbuf[0] != 0x01) {
Brian Salcedo30dfdba2013-01-03 20:44:30 +0000532 msg_perr("Protocol error while setting power/CS/AUX(/Pull-up resistors)!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000533 return 1;
534 }
535
Carl-Daniel Hailfingerd5b28fa2009-11-24 18:27:10 +0000536 /* Set SPI speed */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000537 bp_commbuf[0] = 0x60 | spispeed;
538 ret = buspirate_sendrecv(bp_commbuf, 1, 1);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000539 if (ret)
540 return 1;
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000541 if (bp_commbuf[0] != 0x01) {
Sean Nelson84f7bce2010-01-09 23:56:41 +0000542 msg_perr("Protocol error while setting SPI speed!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000543 return 1;
544 }
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600545
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000546 /* Set SPI config: output type, idle, clock edge, sample */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000547 bp_commbuf[0] = 0x80 | 0xa;
Maxime Vincent2099c642017-11-24 13:04:08 +0100548 if (pullup == 1) {
549 bp_commbuf[0] &= ~(1 << 3);
550 msg_pdbg("Pull-ups enabled, so using HiZ pin output! (Open-Drain mode)\n");
551 }
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000552 ret = buspirate_sendrecv(bp_commbuf, 1, 1);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000553 if (ret)
554 return 1;
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000555 if (bp_commbuf[0] != 0x01) {
Sean Nelson84f7bce2010-01-09 23:56:41 +0000556 msg_perr("Protocol error while setting SPI config!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000557 return 1;
558 }
559
560 /* De-assert CS# */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000561 bp_commbuf[0] = 0x03;
562 ret = buspirate_sendrecv(bp_commbuf, 1, 1);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000563 if (ret)
564 return 1;
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000565 if (bp_commbuf[0] != 0x01) {
Sean Nelson84f7bce2010-01-09 23:56:41 +0000566 msg_perr("Protocol error while raising CS#!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000567 return 1;
568 }
569
Carl-Daniel Hailfingera5bcbce2014-07-19 22:03:29 +0000570 register_spi_master(&spi_master_buspirate);
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000571
572 return 0;
573}
574
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000575static int buspirate_spi_send_command_v1(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000576 const unsigned char *writearr, unsigned char *readarr)
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000577{
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000578 unsigned int i = 0;
579 int ret = 0;
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000580
581 if (writecnt > 16 || readcnt > 16 || (readcnt + writecnt) > 16)
582 return SPI_INVALID_LENGTH;
583
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000584 /* 3 bytes extra for CS#, len, CS#. */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000585 if (buspirate_commbuf_grow(writecnt + readcnt + 3))
586 return ERROR_OOM;
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000587
588 /* Assert CS# */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000589 bp_commbuf[i++] = 0x02;
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000590
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000591 bp_commbuf[i++] = 0x10 | (writecnt + readcnt - 1);
592 memcpy(bp_commbuf + i, writearr, writecnt);
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000593 i += writecnt;
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000594 memset(bp_commbuf + i, 0, readcnt);
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000595
596 i += readcnt;
597 /* De-assert CS# */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000598 bp_commbuf[i++] = 0x03;
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000599
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000600 ret = buspirate_sendrecv(bp_commbuf, i, i);
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000601
602 if (ret) {
603 msg_perr("Bus Pirate communication error!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000604 return SPI_GENERIC_ERROR;
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000605 }
606
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000607 if (bp_commbuf[0] != 0x01) {
Sean Nelson84f7bce2010-01-09 23:56:41 +0000608 msg_perr("Protocol error while lowering CS#!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000609 return SPI_GENERIC_ERROR;
610 }
611
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000612 if (bp_commbuf[1] != 0x01) {
Sean Nelson84f7bce2010-01-09 23:56:41 +0000613 msg_perr("Protocol error while reading/writing SPI!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000614 return SPI_GENERIC_ERROR;
615 }
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000616
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000617 if (bp_commbuf[i - 1] != 0x01) {
Sean Nelson84f7bce2010-01-09 23:56:41 +0000618 msg_perr("Protocol error while raising CS#!\n");
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000619 return SPI_GENERIC_ERROR;
620 }
621
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000622 /* Skip CS#, length, writearr. */
Carl-Daniel Hailfinger316fdfb2012-06-08 15:27:47 +0000623 memcpy(readarr, bp_commbuf + 2 + writecnt, readcnt);
Carl-Daniel Hailfinger04e18be2010-07-29 16:24:09 +0000624
Carl-Daniel Hailfinger5cca01f2009-11-24 00:20:03 +0000625 return ret;
626}
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000627
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000628static int buspirate_spi_send_command_v2(const struct flashctx *flash, unsigned int writecnt, unsigned int readcnt,
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000629 const unsigned char *writearr, unsigned char *readarr)
630{
631 int i = 0, ret = 0;
632
633 if (writecnt > 4096 || readcnt > 4096 || (readcnt + writecnt) > 4096)
634 return SPI_INVALID_LENGTH;
635
636 /* 5 bytes extra for command, writelen, readlen.
637 * 1 byte extra for Ack/Nack.
638 */
639 if (buspirate_commbuf_grow(max(writecnt + 5, readcnt + 1)))
640 return ERROR_OOM;
641
642 /* Combined SPI write/read. */
643 bp_commbuf[i++] = 0x04;
644 bp_commbuf[i++] = (writecnt >> 8) & 0xff;
645 bp_commbuf[i++] = writecnt & 0xff;
646 bp_commbuf[i++] = (readcnt >> 8) & 0xff;
647 bp_commbuf[i++] = readcnt & 0xff;
648 memcpy(bp_commbuf + i, writearr, writecnt);
Shawn Anastasio2b5adfb2017-12-31 00:17:15 -0600649
Carl-Daniel Hailfinger64263c72012-11-01 23:38:51 +0000650 ret = buspirate_sendrecv(bp_commbuf, i + writecnt, 1 + readcnt);
651
652 if (ret) {
653 msg_perr("Bus Pirate communication error!\n");
654 return SPI_GENERIC_ERROR;
655 }
656
657 if (bp_commbuf[0] != 0x01) {
658 msg_perr("Protocol error while sending SPI write/read!\n");
659 return SPI_GENERIC_ERROR;
660 }
661
662 /* Skip Ack. */
663 memcpy(readarr, bp_commbuf + 1, readcnt);
664
665 return ret;
Nico Huberdeeac7e2017-04-22 00:09:42 +0200666}
Thomas Heijligencc853d82021-05-04 15:32:17 +0200667
668const struct programmer_entry programmer_buspirate_spi = {
669 .name = "buspirate_spi",
670 .type = OTHER,
671 /* FIXME */
672 .devs.note = "Dangerous Prototypes Bus Pirate\n",
673 .init = buspirate_spi_init,
674 .map_flash_region = fallback_map,
675 .unmap_flash_region = fallback_unmap,
676 .delay = internal_delay,
677};