blob: 423a6db5cdb99a70ba93c40d541bdb790477628f [file] [log] [blame]
hailfingerdfb32a02010-01-19 11:15:48 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2010 Carl-Daniel Hailfinger
David Hendricksfe05e742015-08-15 17:29:39 -07005 * Copyright (C) 2015 Simon Glass
6 * Copyright (C) 2015 Stefan Tauner
hailfingerdfb32a02010-01-19 11:15:48 +00007 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 2 of the License.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
David Hendricksfe05e742015-08-15 17:29:39 -070022//#include "platform.h"
23
24#include <stdlib.h>
hailfinger7a009082010-11-09 23:30:43 +000025#include <stdio.h>
hailfingerdfb32a02010-01-19 11:15:48 +000026#include <string.h>
David Hendricksfe05e742015-08-15 17:29:39 -070027#include <limits.h>
28#include <errno.h>
29
30#if IS_WINDOWS
31#include <lusb0_usb.h>
32#else
hailfingerdfb32a02010-01-19 11:15:48 +000033#include <usb.h>
David Hendricksfe05e742015-08-15 17:29:39 -070034#endif
35
hailfingerdfb32a02010-01-19 11:15:48 +000036#include "flash.h"
snelson8913d082010-02-26 05:48:29 +000037#include "chipdrivers.h"
hailfinger428f6852010-07-27 22:41:39 +000038#include "programmer.h"
hailfingerdfb32a02010-01-19 11:15:48 +000039#include "spi.h"
40
stepan4c06de72011-01-28 09:00:15 +000041#define FIRMWARE_VERSION(x,y,z) ((x << 16) | (y << 8) | z)
hailfingerdfb32a02010-01-19 11:15:48 +000042#define DEFAULT_TIMEOUT 3000
David Hendricksfe05e742015-08-15 17:29:39 -070043#define REQTYPE_OTHER_OUT (USB_ENDPOINT_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER) /* 0x43 */
44#define REQTYPE_OTHER_IN (USB_ENDPOINT_IN | USB_TYPE_VENDOR | USB_RECIP_OTHER) /* 0xC3 */
45#define REQTYPE_EP_OUT (USB_ENDPOINT_OUT | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT) /* 0x42 */
46#define REQTYPE_EP_IN (USB_ENDPOINT_IN | USB_TYPE_VENDOR | USB_RECIP_ENDPOINT) /* 0xC2 */
hailfinger1ff33dc2010-07-03 11:02:10 +000047static usb_dev_handle *dediprog_handle;
hailfingerfb6287d2010-11-16 21:25:29 +000048static int dediprog_endpoint;
hailfingerdfb32a02010-01-19 11:15:48 +000049
David Hendricksfe05e742015-08-15 17:29:39 -070050enum dediprog_leds {
51 LED_INVALID = -1,
52 LED_NONE = 0,
Simon Glasse53cc1d2015-01-08 05:48:51 -070053 LED_PASS = 1 << 0,
54 LED_BUSY = 1 << 1,
55 LED_ERROR = 1 << 2,
56 LED_ALL = 7,
57};
58
Simon Glassa1f80682015-01-08 05:55:29 -070059/* IO bits for CMD_SET_IO_LED message */
David Hendricksfe05e742015-08-15 17:29:39 -070060enum dediprog_ios {
Simon Glassa1f80682015-01-08 05:55:29 -070061 IO1 = 1 << 0,
62 IO2 = 1 << 1,
63 IO3 = 1 << 2,
64 IO4 = 1 << 3,
65};
66
David Hendricksfe05e742015-08-15 17:29:39 -070067enum dediprog_cmds {
68 CMD_TRANSCEIVE = 0x01,
69 CMD_POLL_STATUS_REG = 0x02,
70 CMD_SET_VPP = 0x03,
71 CMD_SET_TARGET = 0x04,
72 CMD_READ_EEPROM = 0x05,
73 CMD_WRITE_EEPROM = 0x06,
74 CMD_SET_IO_LED = 0x07,
75 CMD_READ_PROG_INFO = 0x08,
76 CMD_SET_VCC = 0x09,
77 CMD_SET_STANDALONE = 0x0A,
78 CMD_GET_BUTTON = 0x11,
79 CMD_GET_UID = 0x12,
80 CMD_SET_CS = 0x14,
81 CMD_IO_MODE = 0x15,
82 CMD_FW_UPDATE = 0x1A,
83 CMD_FPGA_UPDATE = 0x1B,
84 CMD_READ_FPGA_VERSION = 0x1C,
85 CMD_SET_HOLD = 0x1D,
86 CMD_READ = 0x20,
87 CMD_WRITE = 0x30,
88 CMD_WRITE_AT45DB = 0x31,
89 CMD_NAND_WRITE = 0x32,
90 CMD_NAND_READ = 0x33,
91 CMD_SET_SPI_CLK = 0x61,
92 CMD_CHECK_SOCKET = 0x62,
93 CMD_DOWNLOAD_PRJ = 0x63,
94 CMD_READ_PRJ_NAME = 0x64,
95 // New protocol/firmware only
96 CMD_CHECK_SDCARD = 0x65,
97 CMD_READ_PRJ = 0x66,
Simon Glassa1f80682015-01-08 05:55:29 -070098};
99
David Hendricksfe05e742015-08-15 17:29:39 -0700100enum dediprog_target {
101 FLASH_TYPE_APPLICATION_FLASH_1 = 0,
102 FLASH_TYPE_FLASH_CARD,
103 FLASH_TYPE_APPLICATION_FLASH_2,
104 FLASH_TYPE_SOCKET,
Simon Glassa1f80682015-01-08 05:55:29 -0700105};
106
David Hendricksfe05e742015-08-15 17:29:39 -0700107enum dediprog_readmode {
108 READ_MODE_STD = 1,
109 READ_MODE_FAST = 2,
110 READ_MODE_ATMEL45 = 3,
111 READ_MODE_4B_ADDR_FAST = 4,
112 READ_MODE_4B_ADDR_FAST_0x0C = 5, /* New protocol only */
Simon Glassd01002b2015-01-08 05:44:16 -0700113};
114
David Hendricksfe05e742015-08-15 17:29:39 -0700115enum dediprog_writemode {
116 WRITE_MODE_PAGE_PGM = 1,
117 WRITE_MODE_PAGE_WRITE = 2,
118 WRITE_MODE_1B_AAI = 3,
119 WRITE_MODE_2B_AAI = 4,
120 WRITE_MODE_128B_PAGE = 5,
121 WRITE_MODE_PAGE_AT26DF041 = 6,
122 WRITE_MODE_SILICON_BLUE_FPGA = 7,
123 WRITE_MODE_64B_PAGE_NUMONYX_PCM = 8, /* unit of length 512 bytes */
124 WRITE_MODE_4B_ADDR_256B_PAGE_PGM = 9,
125 WRITE_MODE_32B_PAGE_PGM_MXIC_512K = 10, /* unit of length 512 bytes */
126 WRITE_MODE_4B_ADDR_256B_PAGE_PGM_0x12 = 11,
127 WRITE_MODE_4B_ADDR_256B_PAGE_PGM_FLAGS = 12,
Simon Glassd01002b2015-01-08 05:44:16 -0700128};
129
David Hendricksfe05e742015-08-15 17:29:39 -0700130
131static int dediprog_firmwareversion = FIRMWARE_VERSION(0, 0, 0);
132
133#if 0
hailfinger1ff33dc2010-07-03 11:02:10 +0000134/* Might be useful for other pieces of code as well. */
135static void print_hex(void *buf, size_t len)
hailfingerdfb32a02010-01-19 11:15:48 +0000136{
137 size_t i;
138
139 for (i = 0; i < len; i++)
140 msg_pdbg(" %02x", ((uint8_t *)buf)[i]);
141}
David Hendricksfe05e742015-08-15 17:29:39 -0700142#endif
hailfingerdfb32a02010-01-19 11:15:48 +0000143
hailfinger1ff33dc2010-07-03 11:02:10 +0000144/* Might be useful for other USB devices as well. static for now. */
David Hendricksfe05e742015-08-15 17:29:39 -0700145/* device parameter allows user to specify one device of multiple installed */
146static struct usb_device *get_device_by_vid_pid(uint16_t vid, uint16_t pid, unsigned int device)
hailfingerdfb32a02010-01-19 11:15:48 +0000147{
148 struct usb_bus *bus;
149 struct usb_device *dev;
150
151 for (bus = usb_get_busses(); bus; bus = bus->next)
152 for (dev = bus->devices; dev; dev = dev->next)
153 if ((dev->descriptor.idVendor == vid) &&
David Hendricksfe05e742015-08-15 17:29:39 -0700154 (dev->descriptor.idProduct == pid)) {
155 if (device == 0)
156 return dev;
157 device--;
158 }
hailfingerdfb32a02010-01-19 11:15:48 +0000159
160 return NULL;
161}
162
David Hendricksfe05e742015-08-15 17:29:39 -0700163/* This function sets the GPIOs connected to the LEDs as well as IO1-IO4. */
stepan4c06de72011-01-28 09:00:15 +0000164static int dediprog_set_leds(int leds)
165{
David Hendricksfe05e742015-08-15 17:29:39 -0700166 if (leds < LED_NONE || leds > LED_ALL)
Simon Glasse53cc1d2015-01-08 05:48:51 -0700167 leds = LED_ALL;
stepan4c06de72011-01-28 09:00:15 +0000168
169 /* Older Dediprogs with 2.x.x and 3.x.x firmware only had
170 * two LEDs, and they were reversed. So map them around if
171 * we have an old device. On those devices the LEDs map as
172 * follows:
173 * bit 2 == 0: green light is on.
174 * bit 0 == 0: red light is on.
175 */
David Hendricksfe05e742015-08-15 17:29:39 -0700176 int target_leds;
177 if (dediprog_firmwareversion < FIRMWARE_VERSION(5,0,0)) {
178 target_leds = ((leds & LED_ERROR) >> 2) |
179 ((leds & LED_PASS) << 2);
stepan4c06de72011-01-28 09:00:15 +0000180 } else {
David Hendricksfe05e742015-08-15 17:29:39 -0700181 target_leds = leds;
Simon Glass543101a2015-01-08 06:28:13 -0700182 }
David Hendricksfe05e742015-08-15 17:29:39 -0700183
184 target_leds ^= 7;
185 int ret = usb_control_msg(dediprog_handle, REQTYPE_EP_OUT, CMD_SET_IO_LED, 0x09, target_leds,
186 NULL, 0x0, DEFAULT_TIMEOUT);
stepan4c06de72011-01-28 09:00:15 +0000187 if (ret != 0x0) {
David Hendricksfe05e742015-08-15 17:29:39 -0700188 msg_perr("Command Set LED 0x%x failed (%s)!\n", leds, usb_strerror());
stepan4c06de72011-01-28 09:00:15 +0000189 return 1;
190 }
191
stepan4c06de72011-01-28 09:00:15 +0000192 return 0;
193}
194
hailfingerf76cc322010-11-09 22:00:31 +0000195static int dediprog_set_spi_voltage(int millivolt)
hailfingerdfb32a02010-01-19 11:15:48 +0000196{
197 int ret;
hailfingerf76cc322010-11-09 22:00:31 +0000198 uint16_t voltage_selector;
hailfingerdfb32a02010-01-19 11:15:48 +0000199
hailfingerf76cc322010-11-09 22:00:31 +0000200 switch (millivolt) {
201 case 0:
hailfingerdfb32a02010-01-19 11:15:48 +0000202 /* Admittedly this one is an assumption. */
hailfingerf76cc322010-11-09 22:00:31 +0000203 voltage_selector = 0x0;
hailfingerdfb32a02010-01-19 11:15:48 +0000204 break;
hailfingerf76cc322010-11-09 22:00:31 +0000205 case 1800:
206 voltage_selector = 0x12;
hailfingerdfb32a02010-01-19 11:15:48 +0000207 break;
hailfingerf76cc322010-11-09 22:00:31 +0000208 case 2500:
209 voltage_selector = 0x11;
hailfingerdfb32a02010-01-19 11:15:48 +0000210 break;
hailfingerf76cc322010-11-09 22:00:31 +0000211 case 3500:
212 voltage_selector = 0x10;
hailfingerdfb32a02010-01-19 11:15:48 +0000213 break;
214 default:
hailfingerf76cc322010-11-09 22:00:31 +0000215 msg_perr("Unknown voltage %i mV! Aborting.\n", millivolt);
hailfingerdfb32a02010-01-19 11:15:48 +0000216 return 1;
217 }
hailfingerf76cc322010-11-09 22:00:31 +0000218 msg_pdbg("Setting SPI voltage to %u.%03u V\n", millivolt / 1000,
219 millivolt % 1000);
hailfingerdfb32a02010-01-19 11:15:48 +0000220
David Hendricksfe05e742015-08-15 17:29:39 -0700221 if (voltage_selector == 0) {
222 /* Wait some time as the original driver does. */
223 programmer_delay(200 * 1000);
224 }
225 ret = usb_control_msg(dediprog_handle, REQTYPE_EP_OUT, CMD_SET_VCC, voltage_selector, 0,
226 NULL, 0x0, DEFAULT_TIMEOUT);
hailfingerdfb32a02010-01-19 11:15:48 +0000227 if (ret != 0x0) {
uwe8d342eb2011-07-28 08:13:25 +0000228 msg_perr("Command Set SPI Voltage 0x%x failed!\n",
229 voltage_selector);
hailfingerdfb32a02010-01-19 11:15:48 +0000230 return 1;
231 }
David Hendricksfe05e742015-08-15 17:29:39 -0700232 if (voltage_selector != 0) {
233 /* Wait some time as the original driver does. */
234 programmer_delay(200 * 1000);
235 }
hailfingerdfb32a02010-01-19 11:15:48 +0000236 return 0;
237}
238
David Hendricksfe05e742015-08-15 17:29:39 -0700239struct dediprog_spispeeds {
240 const char *const name;
241 const int speed;
242};
243
244static const struct dediprog_spispeeds spispeeds[] = {
245 { "24M", 0x0 },
246 { "12M", 0x2 },
247 { "8M", 0x1 },
248 { "3M", 0x3 },
249 { "2.18M", 0x4 },
250 { "1.5M", 0x5 },
251 { "750k", 0x6 },
252 { "375k", 0x7 },
253 { NULL, 0x0 },
254};
255
256static int dediprog_set_spi_speed(unsigned int spispeed_idx)
hailfingerdfb32a02010-01-19 11:15:48 +0000257{
David Hendricksfe05e742015-08-15 17:29:39 -0700258 if (dediprog_firmwareversion < FIRMWARE_VERSION(5, 0, 0)) {
259 msg_pinfo("Skipping to set SPI speed because firmware is too old.\n");
260 return 0;
261 }
hailfingerdfb32a02010-01-19 11:15:48 +0000262
David Hendricksfe05e742015-08-15 17:29:39 -0700263 const struct dediprog_spispeeds *spispeed = &spispeeds[spispeed_idx];
264 msg_pdbg("SPI speed is %sHz\n", spispeed->name);
hailfingerdfb32a02010-01-19 11:15:48 +0000265
David Hendricksfe05e742015-08-15 17:29:39 -0700266 int ret = usb_control_msg(dediprog_handle, REQTYPE_EP_OUT, CMD_SET_SPI_CLK, spispeed->speed, 0xff,
267 NULL, 0x0, DEFAULT_TIMEOUT);
hailfingerdfb32a02010-01-19 11:15:48 +0000268 if (ret != 0x0) {
David Hendricksfe05e742015-08-15 17:29:39 -0700269 msg_perr("Command Set SPI Speed 0x%x failed!\n", spispeed->speed);
hailfingerdfb32a02010-01-19 11:15:48 +0000270 return 1;
271 }
272 return 0;
273}
274
hailfingerfb6287d2010-11-16 21:25:29 +0000275/* Bulk read interface, will read multiple 512 byte chunks aligned to 512 bytes.
276 * @start start address
277 * @len length
278 * @return 0 on success, 1 on failure
279 */
280static int dediprog_spi_bulk_read(struct flashchip *flash, uint8_t *buf,
stefanctc5eb8a92011-11-23 09:13:48 +0000281 unsigned int start, unsigned int len)
hailfingerfb6287d2010-11-16 21:25:29 +0000282{
283 int ret;
stefanctc5eb8a92011-11-23 09:13:48 +0000284 unsigned int i;
hailfingerfb6287d2010-11-16 21:25:29 +0000285 /* chunksize must be 512, other sizes will NOT work at all. */
stefanctc5eb8a92011-11-23 09:13:48 +0000286 const unsigned int chunksize = 0x200;
287 const unsigned int count = len / chunksize;
David Hendricksfe05e742015-08-15 17:29:39 -0700288 const char count_and_chunk[] = {count & 0xff,
289 (count >> 8) & 0xff,
290 chunksize & 0xff,
291 (chunksize >> 8) & 0xff};
hailfingerfb6287d2010-11-16 21:25:29 +0000292
293 if ((start % chunksize) || (len % chunksize)) {
294 msg_perr("%s: Unaligned start=%i, len=%i! Please report a bug "
295 "at flashrom@flashrom.org\n", __func__, start, len);
296 return 1;
297 }
298
299 /* No idea if the hardware can handle empty reads, so chicken out. */
300 if (!len)
301 return 0;
302 /* Command Read SPI Bulk. No idea which read command is used on the
303 * SPI side.
304 */
David Hendricksfe05e742015-08-15 17:29:39 -0700305 ret = usb_control_msg(dediprog_handle, REQTYPE_EP_OUT, CMD_READ, start % 0x10000,
306 start / 0x10000, (char *)count_and_chunk,
307 sizeof(count_and_chunk), DEFAULT_TIMEOUT);
308 if (ret != sizeof(count_and_chunk)) {
hailfingerfb6287d2010-11-16 21:25:29 +0000309 msg_perr("Command Read SPI Bulk failed, %i %s!\n", ret,
310 usb_strerror());
311 return 1;
312 }
313
314 for (i = 0; i < count; i++) {
315 ret = usb_bulk_read(dediprog_handle, 0x80 | dediprog_endpoint,
316 (char *)buf + i * chunksize, chunksize,
317 DEFAULT_TIMEOUT);
318 if (ret != chunksize) {
319 msg_perr("SPI bulk read %i failed, expected %i, got %i "
320 "%s!\n", i, chunksize, ret, usb_strerror());
321 return 1;
322 }
323 }
324
325 return 0;
326}
327
stefanctc5eb8a92011-11-23 09:13:48 +0000328static int dediprog_spi_read(struct flashchip *flash, uint8_t *buf,
329 unsigned int start, unsigned int len)
hailfingerdfb32a02010-01-19 11:15:48 +0000330{
hailfingerfb6287d2010-11-16 21:25:29 +0000331 int ret;
332 /* chunksize must be 512, other sizes will NOT work at all. */
stefanctc5eb8a92011-11-23 09:13:48 +0000333 const unsigned int chunksize = 0x200;
334 unsigned int residue = start % chunksize ? chunksize - start % chunksize : 0;
335 unsigned int bulklen;
hailfingerfb6287d2010-11-16 21:25:29 +0000336
Simon Glasse53cc1d2015-01-08 05:48:51 -0700337 dediprog_set_leds(LED_BUSY);
stepan4c06de72011-01-28 09:00:15 +0000338
hailfingerfb6287d2010-11-16 21:25:29 +0000339 if (residue) {
340 msg_pdbg("Slow read for partial block from 0x%x, length 0x%x\n",
341 start, residue);
342 ret = spi_read_chunked(flash, buf, start, residue, 16);
Simon Glasse53cc1d2015-01-08 05:48:51 -0700343 if (ret)
344 goto err;
hailfingerfb6287d2010-11-16 21:25:29 +0000345 }
346
347 /* Round down. */
348 bulklen = (len - residue) / chunksize * chunksize;
349 ret = dediprog_spi_bulk_read(flash, buf + residue, start + residue,
350 bulklen);
Simon Glasse53cc1d2015-01-08 05:48:51 -0700351 if (ret)
352 goto err;
hailfingerfb6287d2010-11-16 21:25:29 +0000353
354 len -= residue + bulklen;
355 if (len) {
356 msg_pdbg("Slow read for partial block from 0x%x, length 0x%x\n",
357 start, len);
358 ret = spi_read_chunked(flash, buf + residue + bulklen,
359 start + residue + bulklen, len, 16);
Simon Glasse53cc1d2015-01-08 05:48:51 -0700360 if (ret)
361 goto err;
hailfingerfb6287d2010-11-16 21:25:29 +0000362 }
363
Simon Glasse53cc1d2015-01-08 05:48:51 -0700364 dediprog_set_leds(LED_PASS);
hailfingerfb6287d2010-11-16 21:25:29 +0000365 return 0;
Simon Glasse53cc1d2015-01-08 05:48:51 -0700366err:
367 dediprog_set_leds(LED_ERROR);
368 return ret;
hailfingerdfb32a02010-01-19 11:15:48 +0000369}
370
David Hendricksfe05e742015-08-15 17:29:39 -0700371/* Bulk write interface, will write multiple chunksize byte chunks aligned to chunksize bytes.
372 * @chunksize length of data chunks, only 256 supported by now
373 * @start start address
374 * @len length
375 * @dedi_spi_cmd dediprog specific write command for spi bus
376 * @return 0 on success, 1 on failure
377 */
378static int dediprog_spi_bulk_write(struct flashchip *flash, const uint8_t *buf, unsigned int chunksize,
379 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
hailfinger556e9c32010-11-23 21:28:16 +0000380{
stepan4c06de72011-01-28 09:00:15 +0000381 int ret;
David Hendricksfe05e742015-08-15 17:29:39 -0700382 unsigned int i;
383 /* USB transfer size must be 512, other sizes will NOT work at all.
384 * chunksize is the real data size per USB bulk transfer. The remaining
385 * space in a USB bulk transfer must be filled with 0xff padding.
386 */
387 const unsigned int count = len / chunksize;
388 const char count_and_cmd[] = {count & 0xff, (count >> 8) & 0xff, 0x00, dedi_spi_cmd};
389 char usbbuf[512];
390
391 /*
392 * We should change this check to
393 * chunksize > 512
394 * once we know how to handle different chunk sizes.
395 */
396 if (chunksize != 256) {
397 msg_perr("%s: Chunk sizes other than 256 bytes are unsupported, chunksize=%u!\n"
398 "Please report a bug at flashrom@flashrom.org\n", __func__, chunksize);
399 return 1;
400 }
401
402 if ((start % chunksize) || (len % chunksize)) {
403 msg_perr("%s: Unaligned start=%i, len=%i! Please report a bug "
404 "at flashrom@flashrom.org\n", __func__, start, len);
405 return 1;
406 }
407
408 /* No idea if the hardware can handle empty writes, so chicken out. */
409 if (!len)
410 return 0;
411 /* Command Write SPI Bulk. No idea which write command is used on the
412 * SPI side.
413 */
414 ret = usb_control_msg(dediprog_handle, REQTYPE_EP_OUT, CMD_WRITE, start % 0x10000, start / 0x10000,
415 (char *)count_and_cmd, sizeof(count_and_cmd), DEFAULT_TIMEOUT);
416 if (ret != sizeof(count_and_cmd)) {
417 msg_perr("Command Write SPI Bulk failed, %i %s!\n", ret,
418 usb_strerror());
419 return 1;
420 }
421
422 for (i = 0; i < count; i++) {
423 memset(usbbuf, 0xff, sizeof(usbbuf));
424 memcpy(usbbuf, buf + i * chunksize, chunksize);
425 ret = usb_bulk_write(dediprog_handle, dediprog_endpoint,
426 usbbuf, 512,
427 DEFAULT_TIMEOUT);
428 if (ret != 512) {
429 msg_perr("SPI bulk write failed, expected %i, got %i "
430 "%s!\n", 512, ret, usb_strerror());
431 return 1;
432 }
433 }
434
435 return 0;
436}
437
438static int dediprog_spi_write(struct flashchip *flash, const uint8_t *buf,
439 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
440{
441 int ret;
442// const unsigned int chunksize = flash->chip->page_size;
443 const unsigned int chunksize = flash->page_size;
444 unsigned int residue = start % chunksize ? chunksize - start % chunksize : 0;
445 unsigned int bulklen;
stepan4c06de72011-01-28 09:00:15 +0000446
Simon Glasse53cc1d2015-01-08 05:48:51 -0700447 dediprog_set_leds(LED_BUSY);
stepan4c06de72011-01-28 09:00:15 +0000448
David Hendricksfe05e742015-08-15 17:29:39 -0700449 if (chunksize != 256) {
450 msg_pdbg("Page sizes other than 256 bytes are unsupported as "
451 "we don't know how dediprog\nhandles them.\n");
452 /* Write everything like it was residue. */
453 residue = len;
454 }
stepan4c06de72011-01-28 09:00:15 +0000455
David Hendricksfe05e742015-08-15 17:29:39 -0700456 if (residue) {
457 msg_pdbg("Slow write for partial block from 0x%x, length 0x%x\n",
458 start, residue);
459 /* No idea about the real limit. Maybe 12, maybe more. */
460 ret = spi_write_chunked(flash, (uint8_t *)buf, start, residue, 12);
461 if (ret) {
462 dediprog_set_leds(LED_ERROR);
463 return ret;
464 }
465 }
466
467 /* Round down. */
468 bulklen = (len - residue) / chunksize * chunksize;
469 ret = dediprog_spi_bulk_write(flash, buf + residue, chunksize, start + residue, bulklen, dedi_spi_cmd);
470 if (ret) {
Simon Glasse53cc1d2015-01-08 05:48:51 -0700471 dediprog_set_leds(LED_ERROR);
David Hendricksfe05e742015-08-15 17:29:39 -0700472 return ret;
473 }
stepan4c06de72011-01-28 09:00:15 +0000474
David Hendricksfe05e742015-08-15 17:29:39 -0700475 len -= residue + bulklen;
476 if (len) {
477 msg_pdbg("Slow write for partial block from 0x%x, length 0x%x\n",
478 start, len);
479 ret = spi_write_chunked(flash, (uint8_t *)(buf + residue + bulklen),
480 start + residue + bulklen, len, 12);
481 if (ret) {
482 dediprog_set_leds(LED_ERROR);
483 return ret;
484 }
485 }
486
487 dediprog_set_leds(LED_PASS);
488 return 0;
hailfinger556e9c32010-11-23 21:28:16 +0000489}
490
David Hendricksfe05e742015-08-15 17:29:39 -0700491//static int dediprog_spi_write_256(struct flashchip *flash, const uint8_t *buf, unsigned int start, unsigned int len)
492static int dediprog_spi_write_256(struct flashchip *flash, uint8_t *buf, unsigned int start, unsigned int len)
493{
494 return dediprog_spi_write(flash, buf, start, len, WRITE_MODE_PAGE_PGM);
495}
496
497#if 0
498static int dediprog_spi_write_aai(struct flashchip *flash, const uint8_t *buf, unsigned int start, unsigned int len)
499{
500 return dediprog_spi_write(flash, buf, start, len, WRITE_MODE_2B_AAI);
501}
502#endif
503
504//static int dediprog_spi_send_command(struct flashchip *flash,
505static int dediprog_spi_send_command(unsigned int writecnt,
506 unsigned int readcnt,
507 const unsigned char *writearr,
508 unsigned char *readarr)
hailfingerdfb32a02010-01-19 11:15:48 +0000509{
510 int ret;
511
hailfingeraf389cc2010-01-22 02:53:30 +0000512 msg_pspew("%s, writecnt=%i, readcnt=%i\n", __func__, writecnt, readcnt);
David Hendricksfe05e742015-08-15 17:29:39 -0700513 if (writecnt > UINT16_MAX) {
514 msg_perr("Invalid writecnt=%i, aborting.\n", writecnt);
515 return 1;
Simon Glass543101a2015-01-08 06:28:13 -0700516 }
David Hendricksfe05e742015-08-15 17:29:39 -0700517 if (readcnt > UINT16_MAX) {
518 msg_perr("Invalid readcnt=%i, aborting.\n", readcnt);
519 return 1;
520 }
521
522 ret = usb_control_msg(dediprog_handle, REQTYPE_EP_OUT, CMD_TRANSCEIVE, 0, readcnt ? 0x1 : 0x0,
523 (char *)writearr, writecnt, DEFAULT_TIMEOUT);
hailfingerdfb32a02010-01-19 11:15:48 +0000524 if (ret != writecnt) {
hailfingeraf389cc2010-01-22 02:53:30 +0000525 msg_perr("Send SPI failed, expected %i, got %i %s!\n",
526 writecnt, ret, usb_strerror());
hailfingerdfb32a02010-01-19 11:15:48 +0000527 return 1;
528 }
David Hendricksfe05e742015-08-15 17:29:39 -0700529 if (readcnt == 0)
hailfingerdfb32a02010-01-19 11:15:48 +0000530 return 0;
David Hendricksfe05e742015-08-15 17:29:39 -0700531
532 ret = usb_control_msg(dediprog_handle, REQTYPE_EP_IN, CMD_TRANSCEIVE, 0, 0,
533 (char *)readarr, readcnt, DEFAULT_TIMEOUT);
hailfingerdfb32a02010-01-19 11:15:48 +0000534 if (ret != readcnt) {
hailfingeraf389cc2010-01-22 02:53:30 +0000535 msg_perr("Receive SPI failed, expected %i, got %i %s!\n",
536 readcnt, ret, usb_strerror());
hailfingerdfb32a02010-01-19 11:15:48 +0000537 return 1;
538 }
539 return 0;
540}
541
hailfinger1ff33dc2010-07-03 11:02:10 +0000542static int dediprog_check_devicestring(void)
hailfingerdfb32a02010-01-19 11:15:48 +0000543{
544 int ret;
hailfinger7a009082010-11-09 23:30:43 +0000545 int fw[3];
hailfingerdfb32a02010-01-19 11:15:48 +0000546 char buf[0x11];
547
David Hendricksfe05e742015-08-15 17:29:39 -0700548#if 0
549 /* Command Prepare Receive Device String. */
550 ret = usb_control_msg(dediprog_handle, REQTYPE_OTHER_IN, 0x7, 0x0, 0xef03,
551 buf, 0x1, DEFAULT_TIMEOUT);
552 /* The char casting is needed to stop gcc complaining about an always true comparison. */
553 if ((ret != 0x1) || (buf[0] != (char)0xff)) {
554 msg_perr("Unexpected response to Command Prepare Receive Device"
555 " String!\n");
556 return 1;
557 }
558#endif
hailfingerdfb32a02010-01-19 11:15:48 +0000559 /* Command Receive Device String. */
David Hendricksfe05e742015-08-15 17:29:39 -0700560 ret = usb_control_msg(dediprog_handle, REQTYPE_EP_IN, CMD_READ_PROG_INFO, 0, 0,
561 buf, 0x10, DEFAULT_TIMEOUT);
hailfingerdfb32a02010-01-19 11:15:48 +0000562 if (ret != 0x10) {
563 msg_perr("Incomplete/failed Command Receive Device String!\n");
564 return 1;
565 }
566 buf[0x10] = '\0';
567 msg_pdbg("Found a %s\n", buf);
David Hendricksfe05e742015-08-15 17:29:39 -0700568 if (memcmp(buf, "SF100", 0x5) != 0) {
hailfingerdfb32a02010-01-19 11:15:48 +0000569 msg_perr("Device not a SF100!\n");
570 return 1;
571 }
hailfinger7a009082010-11-09 23:30:43 +0000572 if (sscanf(buf, "SF100 V:%d.%d.%d ", &fw[0], &fw[1], &fw[2]) != 3) {
David Hendricksfe05e742015-08-15 17:29:39 -0700573 msg_perr("Unexpected firmware version string!\n");
hailfinger7a009082010-11-09 23:30:43 +0000574 return 1;
575 }
hailfingerdfb32a02010-01-19 11:15:48 +0000576 /* Only these versions were tested. */
David Hendricksfe05e742015-08-15 17:29:39 -0700577 if (fw[0] < 2 || fw[0] > 5) {
hailfinger7a009082010-11-09 23:30:43 +0000578 msg_perr("Unexpected firmware version %d.%d.%d!\n", fw[0],
579 fw[1], fw[2]);
hailfingerdfb32a02010-01-19 11:15:48 +0000580 return 1;
581 }
stepan4c06de72011-01-28 09:00:15 +0000582 dediprog_firmwareversion = FIRMWARE_VERSION(fw[0], fw[1], fw[2]);
hailfingerdfb32a02010-01-19 11:15:48 +0000583 return 0;
584}
585
Simon Glassa1f80682015-01-08 05:55:29 -0700586static int dediprog_device_init(void)
hailfingerdfb32a02010-01-19 11:15:48 +0000587{
588 int ret;
589 char buf[0x1];
590
591 memset(buf, 0, sizeof(buf));
David Hendricksfe05e742015-08-15 17:29:39 -0700592 ret = usb_control_msg(dediprog_handle, REQTYPE_OTHER_IN, 0x0B, 0x0, 0x0,
593 buf, 0x1, DEFAULT_TIMEOUT);
hailfinger7a009082010-11-09 23:30:43 +0000594 if (ret < 0) {
595 msg_perr("Command A failed (%s)!\n", usb_strerror());
596 return 1;
597 }
hailfingerdfb32a02010-01-19 11:15:48 +0000598 if ((ret != 0x1) || (buf[0] != 0x6f)) {
Simon Glassa1f80682015-01-08 05:55:29 -0700599 msg_perr("Unexpected response to init!\n");
hailfingerdfb32a02010-01-19 11:15:48 +0000600 return 1;
601 }
602 return 0;
603}
604
David Hendricksfe05e742015-08-15 17:29:39 -0700605#if 0
606/* Something.
607 * Present in eng_detect_blink.log with firmware 3.1.8
608 * Always preceded by Command Receive Device String
609 */
610static int dediprog_command_b(void)
hailfingerdfb32a02010-01-19 11:15:48 +0000611{
612 int ret;
David Hendricksfe05e742015-08-15 17:29:39 -0700613 char buf[0x3];
hailfingerdfb32a02010-01-19 11:15:48 +0000614
David Hendricksfe05e742015-08-15 17:29:39 -0700615 ret = usb_control_msg(dediprog_handle, REQTYPE_OTHER_IN, 0x7, 0x0, 0xef00,
616 buf, 0x3, DEFAULT_TIMEOUT);
617 if (ret < 0) {
618 msg_perr("Command B failed (%s)!\n", usb_strerror());
619 return 1;
620 }
621 if ((ret != 0x3) || (buf[0] != 0xff) || (buf[1] != 0xff) ||
622 (buf[2] != 0xff)) {
623 msg_perr("Unexpected response to Command B!\n");
624 return 1;
625 }
626
627 return 0;
628}
629#endif
630
631static int set_target_flash(enum dediprog_target target)
632{
633 int ret = usb_control_msg(dediprog_handle, REQTYPE_EP_OUT, CMD_SET_TARGET, target, 0,
634 NULL, 0, DEFAULT_TIMEOUT);
635 if (ret != 0) {
Simon Glassa1f80682015-01-08 05:55:29 -0700636 msg_perr("set_target_flash failed (%s)!\n", usb_strerror());
hailfingerdfb32a02010-01-19 11:15:48 +0000637 return 1;
638 }
639 return 0;
640}
641
David Hendricksfe05e742015-08-15 17:29:39 -0700642#if 0
643/* Returns true if the button is currently pressed. */
644static bool dediprog_get_button(void)
Simon Glassd01002b2015-01-08 05:44:16 -0700645{
David Hendricksfe05e742015-08-15 17:29:39 -0700646 char buf[1];
647 int ret = usb_control_msg(dediprog_handle, REQTYPE_EP_IN, CMD_GET_BUTTON, 0, 0,
648 buf, 0x1, DEFAULT_TIMEOUT);
649 if (ret != 0) {
650 msg_perr("Could not get button state (%s)!\n", usb_strerror());
651 return 1;
Simon Glassd01002b2015-01-08 05:44:16 -0700652 }
David Hendricksfe05e742015-08-15 17:29:39 -0700653 return buf[0] != 1;
Simon Glassd01002b2015-01-08 05:44:16 -0700654}
David Hendricksfe05e742015-08-15 17:29:39 -0700655#endif
Simon Glassd01002b2015-01-08 05:44:16 -0700656
hailfingerf76cc322010-11-09 22:00:31 +0000657static int parse_voltage(char *voltage)
658{
659 char *tmp = NULL;
hailfingerb91c08c2011-08-15 19:54:20 +0000660 int i;
661 int millivolt = 0, fraction = 0;
hailfingerf76cc322010-11-09 22:00:31 +0000662
663 if (!voltage || !strlen(voltage)) {
664 msg_perr("Empty voltage= specified.\n");
665 return -1;
666 }
667 millivolt = (int)strtol(voltage, &tmp, 0);
668 voltage = tmp;
669 /* Handle "," and "." as decimal point. Everything after it is assumed
670 * to be in decimal notation.
671 */
672 if ((*voltage == '.') || (*voltage == ',')) {
673 voltage++;
674 for (i = 0; i < 3; i++) {
675 fraction *= 10;
676 /* Don't advance if the current character is invalid,
677 * but continue multiplying.
678 */
679 if ((*voltage < '0') || (*voltage > '9'))
680 continue;
681 fraction += *voltage - '0';
682 voltage++;
683 }
684 /* Throw away remaining digits. */
685 voltage += strspn(voltage, "0123456789");
686 }
687 /* The remaining string must be empty or "mV" or "V". */
688 tolower_string(voltage);
689
690 /* No unit or "V". */
691 if ((*voltage == '\0') || !strncmp(voltage, "v", 1)) {
692 millivolt *= 1000;
693 millivolt += fraction;
694 } else if (!strncmp(voltage, "mv", 2) ||
695 !strncmp(voltage, "milliv", 6)) {
696 /* No adjustment. fraction is discarded. */
697 } else {
698 /* Garbage at the end of the string. */
699 msg_perr("Garbage voltage= specified.\n");
700 return -1;
701 }
702 return millivolt;
703}
704
David Hendricksfe05e742015-08-15 17:29:39 -0700705#if 0
706static const struct spi_master spi_master_dediprog = {
707 .type = SPI_CONTROLLER_DEDIPROG,
708 .max_data_read = MAX_DATA_UNSPECIFIED,
709 .max_data_write = MAX_DATA_UNSPECIFIED,
710 .command = dediprog_spi_send_command,
711 .multicommand = default_spi_send_multicommand,
712 .read = dediprog_spi_read,
713 .write_256 = dediprog_spi_write_256,
714 .write_aai = dediprog_spi_write_aai,
715};
716#endif
mkarcherd264e9e2011-05-11 17:07:07 +0000717static const struct spi_programmer spi_programmer_dediprog = {
uwe8d342eb2011-07-28 08:13:25 +0000718 .type = SPI_CONTROLLER_DEDIPROG,
719 .max_data_read = MAX_DATA_UNSPECIFIED,
720 .max_data_write = MAX_DATA_UNSPECIFIED,
721 .command = dediprog_spi_send_command,
722 .multicommand = default_spi_send_multicommand,
723 .read = dediprog_spi_read,
724 .write_256 = dediprog_spi_write_256,
mkarcherd264e9e2011-05-11 17:07:07 +0000725};
726
dhendrix0ffc2eb2011-06-14 01:35:36 +0000727static int dediprog_shutdown(void *data)
728{
729 msg_pspew("%s\n", __func__);
730
David Hendricksfe05e742015-08-15 17:29:39 -0700731 dediprog_firmwareversion = FIRMWARE_VERSION(0, 0, 0);
732
dhendrix0ffc2eb2011-06-14 01:35:36 +0000733 /* URB 28. Command Set SPI Voltage to 0. */
734 if (dediprog_set_spi_voltage(0x0))
735 return 1;
736
737 if (usb_release_interface(dediprog_handle, 0)) {
738 msg_perr("Could not release USB interface!\n");
739 return 1;
740 }
741 if (usb_close(dediprog_handle)) {
742 msg_perr("Could not close USB device!\n");
743 return 1;
744 }
745 return 0;
746}
747
hailfingerdfb32a02010-01-19 11:15:48 +0000748/* URB numbers refer to the first log ever captured. */
749int dediprog_init(void)
750{
751 struct usb_device *dev;
David Hendricksfe05e742015-08-15 17:29:39 -0700752 char *voltage, *device, *spispeed, *target_str;
753 int spispeed_idx = 1;
hailfingerb91c08c2011-08-15 19:54:20 +0000754 int millivolt = 3500;
David Hendricksfe05e742015-08-15 17:29:39 -0700755 long usedevice = 0;
756 long target = 1;
757 int i, ret;
hailfingerdfb32a02010-01-19 11:15:48 +0000758
759 msg_pspew("%s\n", __func__);
760
David Hendricksfe05e742015-08-15 17:29:39 -0700761 spispeed = extract_programmer_param("spispeed");
762 if (spispeed) {
763 for (i = 0; spispeeds[i].name; ++i) {
764 if (!strcasecmp(spispeeds[i].name, spispeed)) {
765 spispeed_idx = i;
766 break;
767 }
768 }
769 if (!spispeeds[i].name) {
770 msg_perr("Error: Invalid spispeed value: '%s'.\n", spispeed);
771 free(spispeed);
772 return 1;
773 }
774 free(spispeed);
775 }
776
hailfingerf76cc322010-11-09 22:00:31 +0000777 voltage = extract_programmer_param("voltage");
778 if (voltage) {
779 millivolt = parse_voltage(voltage);
780 free(voltage);
uwe8d342eb2011-07-28 08:13:25 +0000781 if (millivolt < 0)
hailfingerf76cc322010-11-09 22:00:31 +0000782 return 1;
hailfingerf76cc322010-11-09 22:00:31 +0000783 msg_pinfo("Setting voltage to %i mV\n", millivolt);
784 }
David Hendricksfe05e742015-08-15 17:29:39 -0700785
786 device = extract_programmer_param("device");
787 if (device) {
788 char *dev_suffix;
789 errno = 0;
790 usedevice = strtol(device, &dev_suffix, 10);
791 if (errno != 0 || device == dev_suffix) {
792 msg_perr("Error: Could not convert 'device'.\n");
793 free(device);
Simon Glassd01002b2015-01-08 05:44:16 -0700794 return 1;
795 }
David Hendricksfe05e742015-08-15 17:29:39 -0700796 if (usedevice < 0 || usedevice > UINT_MAX) {
797 msg_perr("Error: Value for 'device' is out of range.\n");
798 free(device);
799 return 1;
800 }
801 if (strlen(dev_suffix) > 0) {
802 msg_perr("Error: Garbage following 'device' value.\n");
803 free(device);
804 return 1;
805 }
806 msg_pinfo("Using device %li.\n", usedevice);
Simon Glassd01002b2015-01-08 05:44:16 -0700807 }
David Hendricksfe05e742015-08-15 17:29:39 -0700808 free(device);
809
810 target_str = extract_programmer_param("target");
811 if (target_str) {
812 char *target_suffix;
813 errno = 0;
814 target = strtol(target_str, &target_suffix, 10);
815 if (errno != 0 || target_str == target_suffix) {
816 msg_perr("Error: Could not convert 'target'.\n");
817 free(target_str);
818 return 1;
819 }
820 if (target < 1 || target > 2) {
821 msg_perr("Error: Value for 'target' is out of range.\n");
822 free(target_str);
823 return 1;
824 }
825 if (strlen(target_suffix) > 0) {
826 msg_perr("Error: Garbage following 'target' value.\n");
827 free(target_str);
828 return 1;
829 }
830 msg_pinfo("Using target %li.\n", target);
831 }
832 free(target_str);
hailfingerf76cc322010-11-09 22:00:31 +0000833
hailfingerdfb32a02010-01-19 11:15:48 +0000834 /* Here comes the USB stuff. */
835 usb_init();
836 usb_find_busses();
837 usb_find_devices();
David Hendricksfe05e742015-08-15 17:29:39 -0700838 dev = get_device_by_vid_pid(0x0483, 0xdada, (unsigned int) usedevice);
hailfingerdfb32a02010-01-19 11:15:48 +0000839 if (!dev) {
840 msg_perr("Could not find a Dediprog SF100 on USB!\n");
841 return 1;
842 }
843 msg_pdbg("Found USB device (%04x:%04x).\n",
uwe8d342eb2011-07-28 08:13:25 +0000844 dev->descriptor.idVendor, dev->descriptor.idProduct);
hailfingerdfb32a02010-01-19 11:15:48 +0000845 dediprog_handle = usb_open(dev);
David Hendricksfe05e742015-08-15 17:29:39 -0700846 if (!dediprog_handle) {
847 msg_perr("Could not open USB device: %s\n", usb_strerror());
848 return 1;
849 }
hailfingerfb6287d2010-11-16 21:25:29 +0000850 ret = usb_set_configuration(dediprog_handle, 1);
851 if (ret < 0) {
852 msg_perr("Could not set USB device configuration: %i %s\n",
853 ret, usb_strerror());
854 if (usb_close(dediprog_handle))
855 msg_perr("Could not close USB device!\n");
856 return 1;
857 }
858 ret = usb_claim_interface(dediprog_handle, 0);
859 if (ret < 0) {
860 msg_perr("Could not claim USB device interface %i: %i %s\n",
861 0, ret, usb_strerror());
862 if (usb_close(dediprog_handle))
863 msg_perr("Could not close USB device!\n");
864 return 1;
865 }
866 dediprog_endpoint = 2;
David Hendricksfe05e742015-08-15 17:29:39 -0700867
dhendrix0ffc2eb2011-06-14 01:35:36 +0000868 if (register_shutdown(dediprog_shutdown, NULL))
869 return 1;
870
David Hendricksfe05e742015-08-15 17:29:39 -0700871 /* Perform basic setup. */
Simon Glassa1f80682015-01-08 05:55:29 -0700872 if (dediprog_device_init())
hailfingerdfb32a02010-01-19 11:15:48 +0000873 return 1;
Simon Glassa1f80682015-01-08 05:55:29 -0700874 if (dediprog_check_devicestring())
hailfingerdfb32a02010-01-19 11:15:48 +0000875 return 1;
David Hendricksfe05e742015-08-15 17:29:39 -0700876
877 /* Set all possible LEDs as soon as possible to indicate activity.
878 * Because knowing the firmware version is required to set the LEDs correctly we need to this after
879 * dediprog_setup() has queried the device and set dediprog_firmwareversion. */
880 dediprog_set_leds(LED_ALL);
881
882 /* Select target/socket, frequency and VCC. */
883 if (set_target_flash(FLASH_TYPE_APPLICATION_FLASH_1) ||
884 dediprog_set_spi_speed(spispeed_idx) ||
885 dediprog_set_spi_voltage(millivolt)) {
Simon Glasse53cc1d2015-01-08 05:48:51 -0700886 dediprog_set_leds(LED_ERROR);
hailfingerdfb32a02010-01-19 11:15:48 +0000887 return 1;
stepan4c06de72011-01-28 09:00:15 +0000888 }
hailfingerdfb32a02010-01-19 11:15:48 +0000889
David Hendricksfe05e742015-08-15 17:29:39 -0700890// register_spi_master(&spi_master_dediprog);
mkarcherd264e9e2011-05-11 17:07:07 +0000891 register_spi_programmer(&spi_programmer_dediprog);
hailfingerdfb32a02010-01-19 11:15:48 +0000892
David Hendricksfe05e742015-08-15 17:29:39 -0700893 dediprog_set_leds(LED_NONE);
stepan4c06de72011-01-28 09:00:15 +0000894
hailfingerdfb32a02010-01-19 11:15:48 +0000895 return 0;
896}
David Hendricksfe05e742015-08-15 17:29:39 -0700897