blob: 5c9a4c0bf2813282ed9d9cf4553556472e05f4c0 [file] [log] [blame]
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2010 Carl-Daniel Hailfinger
Simon Glass557eb4f2015-07-05 16:53:22 +00005 * Copyright (C) 2015 Simon Glass
6 * Copyright (C) 2015 Stefan Tauner
Carl-Daniel Hailfingerd38fac82010-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.
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +000016 */
17
Nico Huber4d440a72017-08-15 11:26:48 +020018#include <sys/types.h>
Stefan Tauner5c316f92015-02-08 21:57:52 +000019#include <stdlib.h>
Mathias Krausedb7afc52010-11-09 23:30:43 +000020#include <stdio.h>
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +000021#include <string.h>
Stefan Taunere34e3e82013-01-01 00:06:51 +000022#include <limits.h>
Nathan Laredo21541a62012-12-24 22:07:36 +000023#include <errno.h>
Nico Huberd99a2bd2016-02-18 21:42:49 +000024#include <libusb.h>
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +000025#include "flash.h"
Sean Nelson14ba6682010-02-26 05:48:29 +000026#include "chipdrivers.h"
Carl-Daniel Hailfinger5b997c32010-07-27 22:41:39 +000027#include "programmer.h"
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +000028#include "spi.h"
29
Nico Huberd99a2bd2016-02-18 21:42:49 +000030/* LIBUSB_CALL ensures the right calling conventions on libusb callbacks.
31 * However, the macro is not defined everywhere. m(
32 */
33#ifndef LIBUSB_CALL
34#define LIBUSB_CALL
35#endif
36
Stefan Reinauer915b8402011-01-28 09:00:15 +000037#define FIRMWARE_VERSION(x,y,z) ((x << 16) | (y << 8) | z)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +000038#define DEFAULT_TIMEOUT 3000
Nico Hubera96aaa32024-03-05 12:56:13 +010039#define MAX_BLOCK_COUNT 65535
Nico Huberd99a2bd2016-02-18 21:42:49 +000040#define DEDIPROG_ASYNC_TRANSFERS 8 /* at most 8 asynchronous transfers */
David Hendricksc3685182020-06-23 17:36:09 -070041#define REQTYPE_OTHER_OUT (LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_OTHER) /* 0x43 */
Nico Huberd99a2bd2016-02-18 21:42:49 +000042#define REQTYPE_OTHER_IN (LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_OTHER) /* 0xC3 */
43#define REQTYPE_EP_OUT (LIBUSB_ENDPOINT_OUT | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_ENDPOINT) /* 0x42 */
44#define REQTYPE_EP_IN (LIBUSB_ENDPOINT_IN | LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_RECIPIENT_ENDPOINT) /* 0xC2 */
David Woodhouse7f3b89f2016-02-18 21:42:15 +000045
46enum dediprog_devtype {
47 DEV_UNKNOWN = 0,
48 DEV_SF100 = 100,
Jay Thompsoncabe3202018-08-17 14:30:04 -050049 DEV_SF200 = 200,
David Woodhouse7f3b89f2016-02-18 21:42:15 +000050 DEV_SF600 = 600,
Nico Huber00578222024-03-02 14:00:53 +010051 DEV_SF600PG2 = 600+2,
52 DEV_SF700 = 700,
David Woodhouse7f3b89f2016-02-18 21:42:15 +000053};
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +000054
Simon Glass25e9f402015-06-28 13:31:19 +000055enum dediprog_leds {
56 LED_INVALID = -1,
57 LED_NONE = 0,
58 LED_PASS = 1 << 0,
59 LED_BUSY = 1 << 1,
60 LED_ERROR = 1 << 2,
61 LED_ALL = 7,
62};
63
Simon Glass557eb4f2015-07-05 16:53:22 +000064/* IO bits for CMD_SET_IO_LED message */
65enum dediprog_ios {
66 IO1 = 1 << 0,
67 IO2 = 1 << 1,
68 IO3 = 1 << 2,
69 IO4 = 1 << 3,
70};
71
72enum dediprog_cmds {
73 CMD_TRANSCEIVE = 0x01,
74 CMD_POLL_STATUS_REG = 0x02,
75 CMD_SET_VPP = 0x03,
76 CMD_SET_TARGET = 0x04,
77 CMD_READ_EEPROM = 0x05,
78 CMD_WRITE_EEPROM = 0x06,
79 CMD_SET_IO_LED = 0x07,
80 CMD_READ_PROG_INFO = 0x08,
81 CMD_SET_VCC = 0x09,
82 CMD_SET_STANDALONE = 0x0A,
David Hendricksc05900f2016-02-18 21:42:41 +000083 CMD_SET_VOLTAGE = 0x0B, /* Only in firmware older than 6.0.0 */
Simon Glass557eb4f2015-07-05 16:53:22 +000084 CMD_GET_BUTTON = 0x11,
85 CMD_GET_UID = 0x12,
86 CMD_SET_CS = 0x14,
87 CMD_IO_MODE = 0x15,
88 CMD_FW_UPDATE = 0x1A,
89 CMD_FPGA_UPDATE = 0x1B,
90 CMD_READ_FPGA_VERSION = 0x1C,
91 CMD_SET_HOLD = 0x1D,
92 CMD_READ = 0x20,
93 CMD_WRITE = 0x30,
94 CMD_WRITE_AT45DB = 0x31,
95 CMD_NAND_WRITE = 0x32,
96 CMD_NAND_READ = 0x33,
97 CMD_SET_SPI_CLK = 0x61,
98 CMD_CHECK_SOCKET = 0x62,
99 CMD_DOWNLOAD_PRJ = 0x63,
100 CMD_READ_PRJ_NAME = 0x64,
101 // New protocol/firmware only
102 CMD_CHECK_SDCARD = 0x65,
103 CMD_READ_PRJ = 0x66,
104};
105
106enum dediprog_target {
107 FLASH_TYPE_APPLICATION_FLASH_1 = 0,
108 FLASH_TYPE_FLASH_CARD,
109 FLASH_TYPE_APPLICATION_FLASH_2,
110 FLASH_TYPE_SOCKET,
111};
112
113enum dediprog_readmode {
114 READ_MODE_STD = 1,
115 READ_MODE_FAST = 2,
116 READ_MODE_ATMEL45 = 3,
117 READ_MODE_4B_ADDR_FAST = 4,
118 READ_MODE_4B_ADDR_FAST_0x0C = 5, /* New protocol only */
119};
120
121enum dediprog_writemode {
Elyes HAOUASac01baa2018-05-28 16:52:21 +0200122 WRITE_MODE_PAGE_PGM = 1,
Simon Glass557eb4f2015-07-05 16:53:22 +0000123 WRITE_MODE_PAGE_WRITE = 2,
124 WRITE_MODE_1B_AAI = 3,
125 WRITE_MODE_2B_AAI = 4,
126 WRITE_MODE_128B_PAGE = 5,
127 WRITE_MODE_PAGE_AT26DF041 = 6,
128 WRITE_MODE_SILICON_BLUE_FPGA = 7,
Simon Glassae616512016-01-23 23:27:58 +0000129 WRITE_MODE_64B_PAGE_NUMONYX_PCM = 8, /* unit of 512 bytes */
Simon Glass557eb4f2015-07-05 16:53:22 +0000130 WRITE_MODE_4B_ADDR_256B_PAGE_PGM = 9,
Simon Glassae616512016-01-23 23:27:58 +0000131 WRITE_MODE_32B_PAGE_PGM_MXIC_512K = 10, /* unit of 512 bytes */
Simon Glass557eb4f2015-07-05 16:53:22 +0000132 WRITE_MODE_4B_ADDR_256B_PAGE_PGM_0x12 = 11,
133 WRITE_MODE_4B_ADDR_256B_PAGE_PGM_FLAGS = 12,
134};
135
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000136enum dediprog_standalone_mode {
137 ENTER_STANDALONE_MODE = 0,
138 LEAVE_STANDALONE_MODE = 1,
139};
140
David Hendricksf73f8a72018-02-21 07:34:34 -0800141/*
Nico Huberc3b02dc2023-08-12 01:13:45 +0200142 * These are not official designations; they are for use in flashprog only.
David Hendricksf73f8a72018-02-21 07:34:34 -0800143 * Order must be preserved so that comparison operators work.
144 */
145enum protocol {
146 PROTOCOL_UNKNOWN,
147 PROTOCOL_V1,
148 PROTOCOL_V2,
149 PROTOCOL_V3,
150};
151
Thomas Heijligencc853d82021-05-04 15:32:17 +0200152static const struct dev_entry devs_dediprog[] = {
Jay Thompsoncabe3202018-08-17 14:30:04 -0500153 {0x0483, 0xDADA, OK, "Dediprog", "SF100/SF200/SF600"},
Stefan Taunerfdec7472016-02-22 08:59:27 +0000154
155 {0},
156};
Simon Glass557eb4f2015-07-05 16:53:22 +0000157
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000158struct dediprog_data {
159 struct libusb_context *usb_ctx;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000160 libusb_device_handle *handle;
161 int in_endpoint;
162 int out_endpoint;
163 int firmwareversion;
Nico Huber274e6552024-03-24 12:34:57 +0100164 char devicestring[32+1];
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000165 enum dediprog_devtype devicetype;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000166};
Simon Glass557eb4f2015-07-05 16:53:22 +0000167
Nico Huberd99a2bd2016-02-18 21:42:49 +0000168#if defined(LIBUSB_MAJOR) && defined(LIBUSB_MINOR) && defined(LIBUSB_MICRO) && \
169 LIBUSB_MAJOR <= 1 && LIBUSB_MINOR == 0 && LIBUSB_MICRO < 9
170/* Quick and dirty replacement for missing libusb_error_name in libusb < 1.0.9 */
171const char * LIBUSB_CALL libusb_error_name(int error_code)
172{
173 if (error_code >= INT16_MIN && error_code <= INT16_MAX) {
174 /* 18 chars for text, rest for number (16 b should be enough), sign, nullbyte. */
175 static char my_libusb_error[18 + 5 + 2];
176 sprintf(my_libusb_error, "libusb error code %i", error_code);
177 return my_libusb_error;
178 } else {
179 return "UNKNOWN";
180 }
181}
182#endif
183
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000184static enum protocol protocol(const struct dediprog_data *dp_data)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000185{
David Hendricksf73f8a72018-02-21 07:34:34 -0800186 /* Firmware version < 5.0.0 is handled explicitly in some cases. */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000187 switch (dp_data->devicetype) {
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000188 case DEV_SF100:
Jay Thompsoncabe3202018-08-17 14:30:04 -0500189 case DEV_SF200:
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000190 if (dp_data->firmwareversion < FIRMWARE_VERSION(5, 5, 0))
David Hendricksf73f8a72018-02-21 07:34:34 -0800191 return PROTOCOL_V1;
192 else
193 return PROTOCOL_V2;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000194 case DEV_SF600:
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000195 if (dp_data->firmwareversion < FIRMWARE_VERSION(6, 9, 0))
David Hendricksf73f8a72018-02-21 07:34:34 -0800196 return PROTOCOL_V1;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000197 else if (dp_data->firmwareversion <= FIRMWARE_VERSION(7, 2, 21))
David Hendricksf73f8a72018-02-21 07:34:34 -0800198 return PROTOCOL_V2;
199 else
200 return PROTOCOL_V3;
Nico Huber00578222024-03-02 14:00:53 +0100201 case DEV_SF700:
202 case DEV_SF600PG2:
203 return PROTOCOL_V3;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000204 default:
David Hendricksf73f8a72018-02-21 07:34:34 -0800205 return PROTOCOL_UNKNOWN;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000206 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000207}
Simon Glassae616512016-01-23 23:27:58 +0000208
Nico Huberd99a2bd2016-02-18 21:42:49 +0000209struct dediprog_transfer_status {
Richard Hughes842d6782021-01-15 09:48:12 +0000210 struct flashctx *flash;
Nico Huberd99a2bd2016-02-18 21:42:49 +0000211 int error; /* OK if 0, ERROR else */
212 unsigned int queued_idx;
213 unsigned int finished_idx;
214};
215
216static void LIBUSB_CALL dediprog_bulk_read_cb(struct libusb_transfer *const transfer)
217{
218 struct dediprog_transfer_status *const status = (struct dediprog_transfer_status *)transfer->user_data;
219 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
220 status->error = 1;
221 msg_perr("SPI bulk read failed!\n");
222 }
Richard Hughes842d6782021-01-15 09:48:12 +0000223 flashprog_progress_add(status->flash, transfer->actual_length);
Nico Huberd99a2bd2016-02-18 21:42:49 +0000224 ++status->finished_idx;
225}
226
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000227static int dediprog_bulk_read_poll(struct libusb_context *usb_ctx,
228 const struct dediprog_transfer_status *const status,
229 const int finish)
Nico Huberd99a2bd2016-02-18 21:42:49 +0000230{
231 if (status->finished_idx >= status->queued_idx)
232 return 0;
233
234 do {
235 struct timeval timeout = { 10, 0 };
236 const int ret = libusb_handle_events_timeout(usb_ctx, &timeout);
237 if (ret < 0) {
238 msg_perr("Polling read events failed: %i %s!\n", ret, libusb_error_name(ret));
239 return 1;
240 }
241 } while (finish && (status->finished_idx < status->queued_idx));
242 return 0;
243}
244
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000245static int dediprog_read(libusb_device_handle *dediprog_handle,
246 enum dediprog_cmds cmd, unsigned int value, unsigned int idx,
247 uint8_t *bytes, size_t size)
Simon Glassae616512016-01-23 23:27:58 +0000248{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000249 return libusb_control_transfer(dediprog_handle, REQTYPE_EP_IN, cmd, value, idx,
250 (unsigned char *)bytes, size, DEFAULT_TIMEOUT);
Simon Glassae616512016-01-23 23:27:58 +0000251}
252
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000253static int dediprog_write(libusb_device_handle *dediprog_handle,
254 enum dediprog_cmds cmd, unsigned int value, unsigned int idx,
255 const uint8_t *bytes, size_t size)
Simon Glassae616512016-01-23 23:27:58 +0000256{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000257 return libusb_control_transfer(dediprog_handle, REQTYPE_EP_OUT, cmd, value, idx,
258 (unsigned char *)bytes, size, DEFAULT_TIMEOUT);
Simon Glassae616512016-01-23 23:27:58 +0000259}
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000260
Nico Huberd99a2bd2016-02-18 21:42:49 +0000261
Simon Glass25e9f402015-06-28 13:31:19 +0000262/* This function sets the GPIOs connected to the LEDs as well as IO1-IO4. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000263static int dediprog_set_leds(int leds, const struct dediprog_data *dp_data)
Stefan Reinauer915b8402011-01-28 09:00:15 +0000264{
Simon Glass25e9f402015-06-28 13:31:19 +0000265 if (leds < LED_NONE || leds > LED_ALL)
266 leds = LED_ALL;
Stefan Reinauer915b8402011-01-28 09:00:15 +0000267
Simon Glassae616512016-01-23 23:27:58 +0000268 /* Older Dediprogs with 2.x.x and 3.x.x firmware only had two LEDs, assigned to different bits. So map
269 * them around if we have an old device. On those devices the LEDs map as follows:
Stefan Reinauer915b8402011-01-28 09:00:15 +0000270 * bit 2 == 0: green light is on.
Simon Glassae616512016-01-23 23:27:58 +0000271 * bit 0 == 0: red light is on.
272 *
273 * Additionally, the command structure has changed with the "new" protocol.
274 *
275 * FIXME: take IO pins into account
Stefan Reinauer915b8402011-01-28 09:00:15 +0000276 */
Simon Glassae616512016-01-23 23:27:58 +0000277 int target_leds, ret;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000278 if (protocol(dp_data) >= PROTOCOL_V2) {
Simon Glassae616512016-01-23 23:27:58 +0000279 target_leds = (leds ^ 7) << 8;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000280 ret = dediprog_write(dp_data->handle, CMD_SET_IO_LED, target_leds, 0, NULL, 0);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000281 } else {
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000282 if (dp_data->firmwareversion < FIRMWARE_VERSION(5, 0, 0)) {
Simon Glassae616512016-01-23 23:27:58 +0000283 target_leds = ((leds & LED_ERROR) >> 2) | ((leds & LED_PASS) << 2);
284 } else {
285 target_leds = leds;
286 }
287 target_leds ^= 7;
288
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000289 ret = dediprog_write(dp_data->handle, CMD_SET_IO_LED, 0x9, target_leds, NULL, 0);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000290 }
291
Stefan Reinauer915b8402011-01-28 09:00:15 +0000292 if (ret != 0x0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000293 msg_perr("Command Set LED 0x%x failed (%s)!\n", leds, libusb_error_name(ret));
Stefan Reinauer915b8402011-01-28 09:00:15 +0000294 return 1;
295 }
296
Stefan Reinauer915b8402011-01-28 09:00:15 +0000297 return 0;
298}
299
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000300static int dediprog_set_spi_voltage(libusb_device_handle *dediprog_handle, int millivolt)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000301{
302 int ret;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000303 uint16_t voltage_selector;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000304
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000305 switch (millivolt) {
306 case 0:
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000307 /* Admittedly this one is an assumption. */
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000308 voltage_selector = 0x0;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000309 break;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000310 case 1800:
311 voltage_selector = 0x12;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000312 break;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000313 case 2500:
314 voltage_selector = 0x11;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000315 break;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000316 case 3500:
317 voltage_selector = 0x10;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000318 break;
319 default:
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000320 msg_perr("Unknown voltage %i mV! Aborting.\n", millivolt);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000321 return 1;
322 }
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000323 msg_pdbg("Setting SPI voltage to %u.%03u V\n", millivolt / 1000,
324 millivolt % 1000);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000325
Nico Huber4099a8a2012-06-16 00:02:27 +0000326 if (voltage_selector == 0) {
327 /* Wait some time as the original driver does. */
328 programmer_delay(200 * 1000);
329 }
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000330 ret = dediprog_write(dediprog_handle, CMD_SET_VCC, voltage_selector, 0, NULL, 0);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000331 if (ret != 0x0) {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000332 msg_perr("Command Set SPI Voltage 0x%x failed!\n",
333 voltage_selector);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000334 return 1;
335 }
Nico Huber4099a8a2012-06-16 00:02:27 +0000336 if (voltage_selector != 0) {
337 /* Wait some time as the original driver does. */
338 programmer_delay(200 * 1000);
339 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000340 return 0;
341}
342
Nico Huber77fa67d2013-02-20 18:03:36 +0000343struct dediprog_spispeeds {
344 const char *const name;
345 const int speed;
346};
347
348static const struct dediprog_spispeeds spispeeds[] = {
349 { "24M", 0x0 },
350 { "12M", 0x2 },
351 { "8M", 0x1 },
352 { "3M", 0x3 },
353 { "2.18M", 0x4 },
354 { "1.5M", 0x5 },
355 { "750k", 0x6 },
356 { "375k", 0x7 },
357 { NULL, 0x0 },
358};
359
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000360static int dediprog_set_spi_speed(unsigned int spispeed_idx, const struct dediprog_data *dp_data)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000361{
Nico Huber00578222024-03-02 14:00:53 +0100362 if (dp_data->devicetype < DEV_SF600PG2 && dp_data->firmwareversion < FIRMWARE_VERSION(5, 0, 0)) {
Patrick Georgiefe2d432013-05-23 21:47:46 +0000363 msg_pwarn("Skipping to set SPI speed because firmware is too old.\n");
364 return 0;
365 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000366
Simon Glass557eb4f2015-07-05 16:53:22 +0000367 const struct dediprog_spispeeds *spispeed = &spispeeds[spispeed_idx];
368 msg_pdbg("SPI speed is %sHz\n", spispeed->name);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000369
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000370 int ret = dediprog_write(dp_data->handle, CMD_SET_SPI_CLK, spispeed->speed, 0, NULL, 0);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000371 if (ret != 0x0) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000372 msg_perr("Command Set SPI Speed 0x%x failed!\n", spispeed->speed);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000373 return 1;
374 }
375 return 0;
376}
377
Nico Huber7eb38aa2019-03-21 15:42:54 +0100378static int prepare_rw_cmd(
Nico Huber93db6e12018-09-30 01:18:43 +0200379 struct flashctx *const flash, uint8_t *data_packet, unsigned int count,
Nico Huber477e1692019-06-18 23:56:01 +0200380 uint8_t dedi_spi_cmd, unsigned int *value, unsigned int *idx, unsigned int start, int is_read)
381{
Nico Huber9a11cbf2023-01-13 01:19:07 +0100382 const struct dediprog_data *dp_data = flash->mst.spi->data;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000383
Nico Hubera96aaa32024-03-05 12:56:13 +0100384 if (count > MAX_BLOCK_COUNT) {
Nico Huberac90af62022-12-18 00:22:47 +0000385 msg_perr("%s: Unsupported transfer length of %u blocks!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200386 "Please report a bug at flashprog@flashprog.org\n",
Nico Huber477e1692019-06-18 23:56:01 +0200387 __func__, count);
388 return 1;
389 }
390
Simon Glassae616512016-01-23 23:27:58 +0000391 /* First 5 bytes are common in both generations. */
392 data_packet[0] = count & 0xff;
393 data_packet[1] = (count >> 8) & 0xff;
394 data_packet[2] = 0; /* RFU */
395 data_packet[3] = dedi_spi_cmd; /* Read/Write Mode (currently READ_MODE_STD, WRITE_MODE_PAGE_PGM or WRITE_MODE_2B_AAI) */
396 data_packet[4] = 0; /* "Opcode". Specs imply necessity only for READ_MODE_4B_ADDR_FAST and WRITE_MODE_4B_ADDR_256B_PAGE_PGM */
397
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000398 if (protocol(dp_data) >= PROTOCOL_V2) {
Nico Huber93db6e12018-09-30 01:18:43 +0200399 if (is_read && flash->chip->feature_bits & FEATURE_4BA_FAST_READ) {
400 data_packet[3] = READ_MODE_4B_ADDR_FAST_0x0C;
401 data_packet[4] = JEDEC_READ_4BA_FAST;
402 } else if (dedi_spi_cmd == WRITE_MODE_PAGE_PGM
403 && (flash->chip->feature_bits & FEATURE_4BA_WRITE)) {
Nico Huberfb176d22024-03-25 15:55:13 +0100404 if (protocol(dp_data) >= PROTOCOL_V3)
405 data_packet[3] = WRITE_MODE_4B_ADDR_256B_PAGE_PGM;
406 else
407 data_packet[3] = WRITE_MODE_4B_ADDR_256B_PAGE_PGM_0x12;
Nico Huber93db6e12018-09-30 01:18:43 +0200408 data_packet[4] = JEDEC_BYTE_PROGRAM_4BA;
409 }
410
Simon Glassae616512016-01-23 23:27:58 +0000411 *value = *idx = 0;
412 data_packet[5] = 0; /* RFU */
413 data_packet[6] = (start >> 0) & 0xff;
414 data_packet[7] = (start >> 8) & 0xff;
415 data_packet[8] = (start >> 16) & 0xff;
416 data_packet[9] = (start >> 24) & 0xff;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000417 if (protocol(dp_data) >= PROTOCOL_V3) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800418 if (is_read) {
419 data_packet[10] = 0x00; /* address length (3 or 4) */
420 data_packet[11] = 0x00; /* dummy cycle / 2 */
421 } else {
422 /* 16 LSBs and 16 HSBs of page size */
423 /* FIXME: This assumes page size of 256. */
424 data_packet[10] = 0x00;
425 data_packet[11] = 0x01;
426 data_packet[12] = 0x00;
427 data_packet[13] = 0x00;
428 }
429 }
Simon Glassae616512016-01-23 23:27:58 +0000430 } else {
Nico Huber9bb8a322022-05-24 15:07:34 +0200431 if (flash->chip->feature_bits & FEATURE_4BA_EAR_ANY) {
Nico Huber7eb38aa2019-03-21 15:42:54 +0100432 if (spi_set_extended_address(flash, start >> 24))
433 return 1;
434 } else if (start >> 24) {
435 msg_cerr("Can't handle 4-byte address with dediprog.\n");
436 return 1;
437 }
438 /*
439 * We don't know how the dediprog firmware handles 4-byte
440 * addresses. So let's not tell it what we are doing and
441 * only send the lower 3 bytes.
442 */
443 *value = start & 0xffff;
444 *idx = (start >> 16) & 0xff;
Simon Glassae616512016-01-23 23:27:58 +0000445 }
Nico Huber7eb38aa2019-03-21 15:42:54 +0100446
447 return 0;
Simon Glassae616512016-01-23 23:27:58 +0000448}
449
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000450/* Bulk read interface, will read multiple 512 byte chunks aligned to 512 bytes.
451 * @start start address
452 * @len length
453 * @return 0 on success, 1 on failure
454 */
Simon Glassae616512016-01-23 23:27:58 +0000455static int dediprog_spi_bulk_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len)
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000456{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000457 int err = 1;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100458 const struct dediprog_data *dp_data = flash->mst.spi->data;
Nico Huberd99a2bd2016-02-18 21:42:49 +0000459
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000460 /* chunksize must be 512, other sizes will NOT work at all. */
Simon Glassae616512016-01-23 23:27:58 +0000461 const unsigned int chunksize = 512;
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000462 const unsigned int count = len / chunksize;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000463
Richard Hughes842d6782021-01-15 09:48:12 +0000464 struct dediprog_transfer_status status = { flash, 0, 0, 0 };
Nico Huberd99a2bd2016-02-18 21:42:49 +0000465 struct libusb_transfer *transfers[DEDIPROG_ASYNC_TRANSFERS] = { NULL, };
466 struct libusb_transfer *transfer;
467
Nico Huberbbaa1712018-12-05 13:26:20 +0100468 if (len == 0)
469 return 0;
470
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000471 if ((start % chunksize) || (len % chunksize)) {
Nico Huberac90af62022-12-18 00:22:47 +0000472 msg_perr("%s: Unaligned start=%i, len=%i!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200473 "Please report a bug at flashprog@flashprog.org\n",
Simon Glassae616512016-01-23 23:27:58 +0000474 __func__, start, len);
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000475 return 1;
476 }
477
David Hendricksf73f8a72018-02-21 07:34:34 -0800478 int command_packet_size;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000479 switch (protocol(dp_data)) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800480 case PROTOCOL_V1:
481 command_packet_size = 5;
482 break;
483 case PROTOCOL_V2:
484 command_packet_size = 10;
485 break;
486 case PROTOCOL_V3:
487 command_packet_size = 12;
488 break;
489 default:
490 return 1;
491 }
492
493 uint8_t data_packet[command_packet_size];
Simon Glassae616512016-01-23 23:27:58 +0000494 unsigned int value, idx;
Nico Huber7eb38aa2019-03-21 15:42:54 +0100495 if (prepare_rw_cmd(flash, data_packet, count, READ_MODE_STD, &value, &idx, start, 1))
496 return 1;
Simon Glassae616512016-01-23 23:27:58 +0000497
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000498 int ret = dediprog_write(dp_data->handle, CMD_READ, value, idx, data_packet, sizeof(data_packet));
Nico Huber519be662018-12-23 20:03:35 +0100499 if (ret != (int)sizeof(data_packet)) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000500 msg_perr("Command Read SPI Bulk failed, %i %s!\n", ret, libusb_error_name(ret));
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000501 return 1;
502 }
503
Nico Huberd99a2bd2016-02-18 21:42:49 +0000504 /*
505 * Ring buffer of bulk transfers.
506 * Poll until at least one transfer is ready,
507 * schedule next transfers until buffer is full.
508 */
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000509
Nico Huberd99a2bd2016-02-18 21:42:49 +0000510 /* Allocate bulk transfers. */
511 unsigned int i;
Nico Huber519be662018-12-23 20:03:35 +0100512 for (i = 0; i < MIN(DEDIPROG_ASYNC_TRANSFERS, count); ++i) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000513 transfers[i] = libusb_alloc_transfer(0);
514 if (!transfers[i]) {
515 msg_perr("Allocating libusb transfer %i failed: %s!\n", i, libusb_error_name(ret));
516 goto err_free;
Elyes HAOUAS124ef382018-03-27 12:15:09 +0200517 }
518 }
Nico Huberd99a2bd2016-02-18 21:42:49 +0000519
520 /* Now transfer requested chunks using libusb's asynchronous interface. */
521 while (!status.error && (status.queued_idx < count)) {
Nico Huberf84df9a2016-05-04 13:24:07 +0200522 while ((status.queued_idx < count) &&
523 (status.queued_idx - status.finished_idx) < DEDIPROG_ASYNC_TRANSFERS)
524 {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000525 transfer = transfers[status.queued_idx % DEDIPROG_ASYNC_TRANSFERS];
Nico Huber821a0852024-03-24 13:34:51 +0100526 libusb_fill_bulk_transfer(transfer, dp_data->handle, dp_data->in_endpoint,
Nico Huberd99a2bd2016-02-18 21:42:49 +0000527 (unsigned char *)buf + status.queued_idx * chunksize, chunksize,
528 dediprog_bulk_read_cb, &status, DEFAULT_TIMEOUT);
529 transfer->flags |= LIBUSB_TRANSFER_SHORT_NOT_OK;
530 ret = libusb_submit_transfer(transfer);
531 if (ret < 0) {
532 msg_perr("Submitting SPI bulk read %i failed: %s!\n",
533 status.queued_idx, libusb_error_name(ret));
534 goto err_free;
535 }
536 ++status.queued_idx;
537 }
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000538 if (dediprog_bulk_read_poll(dp_data->usb_ctx, &status, 0))
Nico Huberd99a2bd2016-02-18 21:42:49 +0000539 goto err_free;
540 }
541 /* Wait for transfers to finish. */
Rick Altherr4f9cd8b2021-12-13 17:10:00 -0800542 if (dediprog_bulk_read_poll(dp_data->usb_ctx, &status, 1))
Nico Huberd99a2bd2016-02-18 21:42:49 +0000543 goto err_free;
544 /* Check if everything has been transmitted. */
545 if ((status.finished_idx < count) || status.error)
546 goto err_free;
547
548 err = 0;
549
550err_free:
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000551 dediprog_bulk_read_poll(dp_data->usb_ctx, &status, 1);
Nico Huberd99a2bd2016-02-18 21:42:49 +0000552 for (i = 0; i < DEDIPROG_ASYNC_TRANSFERS; ++i)
553 if (transfers[i]) libusb_free_transfer(transfers[i]);
554 return err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000555}
556
Simon Glassae616512016-01-23 23:27:58 +0000557static int dediprog_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000558{
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000559 int ret;
560 /* chunksize must be 512, other sizes will NOT work at all. */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000561 const unsigned int chunksize = 0x200;
Nico Huberbbaa1712018-12-05 13:26:20 +0100562 unsigned int residue = start % chunksize ? min(len, chunksize - start % chunksize) : 0;
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000563 unsigned int bulklen;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100564 const struct dediprog_data *dp_data = flash->mst.spi->data;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000565
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000566 dediprog_set_leds(LED_BUSY, dp_data);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000567
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000568 if (residue) {
569 msg_pdbg("Slow read for partial block from 0x%x, length 0x%x\n",
570 start, residue);
Edward O'Callaghan317c67b2020-10-09 12:56:53 +1100571 ret = default_spi_read(flash, buf, start, residue);
Simon Glass25e9f402015-06-28 13:31:19 +0000572 if (ret)
573 goto err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000574 }
575
576 /* Round down. */
577 bulklen = (len - residue) / chunksize * chunksize;
Simon Glassae616512016-01-23 23:27:58 +0000578 ret = dediprog_spi_bulk_read(flash, buf + residue, start + residue, bulklen);
Simon Glass25e9f402015-06-28 13:31:19 +0000579 if (ret)
580 goto err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000581
582 len -= residue + bulklen;
Simon Glassae616512016-01-23 23:27:58 +0000583 if (len != 0) {
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000584 msg_pdbg("Slow read for partial block from 0x%x, length 0x%x\n",
585 start, len);
Edward O'Callaghan317c67b2020-10-09 12:56:53 +1100586 ret = default_spi_read(flash, buf + residue + bulklen,
587 start + residue + bulklen, len);
Simon Glass25e9f402015-06-28 13:31:19 +0000588 if (ret)
589 goto err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000590 }
591
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000592 dediprog_set_leds(LED_PASS, dp_data);
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000593 return 0;
Simon Glass25e9f402015-06-28 13:31:19 +0000594err:
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000595 dediprog_set_leds(LED_ERROR, dp_data);
Simon Glass25e9f402015-06-28 13:31:19 +0000596 return ret;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000597}
598
Nico Hubera4b14f72012-06-19 12:06:53 +0000599/* Bulk write interface, will write multiple chunksize byte chunks aligned to chunksize bytes.
600 * @chunksize length of data chunks, only 256 supported by now
601 * @start start address
602 * @len length
603 * @dedi_spi_cmd dediprog specific write command for spi bus
604 * @return 0 on success, 1 on failure
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000605 */
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000606static int dediprog_spi_bulk_write(struct flashctx *flash, const uint8_t *buf, unsigned int chunksize,
Nico Hubera4b14f72012-06-19 12:06:53 +0000607 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000608{
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000609 /* USB transfer size must be 512, other sizes will NOT work at all.
610 * chunksize is the real data size per USB bulk transfer. The remaining
611 * space in a USB bulk transfer must be filled with 0xff padding.
612 */
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000613 const unsigned int count = len / chunksize;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100614 const struct dediprog_data *dp_data = flash->mst.spi->data;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000615
Nico Hubera4b14f72012-06-19 12:06:53 +0000616 /*
617 * We should change this check to
618 * chunksize > 512
619 * once we know how to handle different chunk sizes.
620 */
621 if (chunksize != 256) {
622 msg_perr("%s: Chunk sizes other than 256 bytes are unsupported, chunksize=%u!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200623 "Please report a bug at flashprog@flashprog.org\n",
Nico Huberac90af62022-12-18 00:22:47 +0000624 __func__, chunksize);
Nico Hubera4b14f72012-06-19 12:06:53 +0000625 return 1;
626 }
627
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000628 if ((start % chunksize) || (len % chunksize)) {
Nico Huberac90af62022-12-18 00:22:47 +0000629 msg_perr("%s: Unaligned start=%i, len=%i!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200630 "Please report a bug at flashprog@flashprog.org\n",
Nico Huberac90af62022-12-18 00:22:47 +0000631 __func__, start, len);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000632 return 1;
633 }
634
635 /* No idea if the hardware can handle empty writes, so chicken out. */
Simon Glassae616512016-01-23 23:27:58 +0000636 if (len == 0)
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000637 return 0;
Simon Glassae616512016-01-23 23:27:58 +0000638
David Hendricksf73f8a72018-02-21 07:34:34 -0800639 int command_packet_size;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000640 switch (protocol(dp_data)) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800641 case PROTOCOL_V1:
642 command_packet_size = 5;
643 break;
644 case PROTOCOL_V2:
645 command_packet_size = 10;
646 break;
647 case PROTOCOL_V3:
648 command_packet_size = 14;
649 break;
650 default:
651 return 1;
652 }
653
654 uint8_t data_packet[command_packet_size];
Simon Glassae616512016-01-23 23:27:58 +0000655 unsigned int value, idx;
Nico Huber7eb38aa2019-03-21 15:42:54 +0100656 if (prepare_rw_cmd(flash, data_packet, count, dedi_spi_cmd, &value, &idx, start, 0))
657 return 1;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000658 int ret = dediprog_write(dp_data->handle, CMD_WRITE, value, idx, data_packet, sizeof(data_packet));
Nico Huber519be662018-12-23 20:03:35 +0100659 if (ret != (int)sizeof(data_packet)) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000660 msg_perr("Command Write SPI Bulk failed, %s!\n", libusb_error_name(ret));
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000661 return 1;
662 }
663
Simon Glassae616512016-01-23 23:27:58 +0000664 unsigned int i;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000665 for (i = 0; i < count; i++) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000666 unsigned char usbbuf[512];
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000667 memcpy(usbbuf, buf + i * chunksize, chunksize);
Simon Glassae616512016-01-23 23:27:58 +0000668 memset(usbbuf + chunksize, 0xff, sizeof(usbbuf) - chunksize); // fill up with 0xFF
Nico Huberd99a2bd2016-02-18 21:42:49 +0000669 int transferred;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000670 ret = libusb_bulk_transfer(dp_data->handle, dp_data->out_endpoint, usbbuf, 512, &transferred,
Nico Huberd99a2bd2016-02-18 21:42:49 +0000671 DEFAULT_TIMEOUT);
672 if ((ret < 0) || (transferred != 512)) {
673 msg_perr("SPI bulk write failed, expected %i, got %s!\n", 512, libusb_error_name(ret));
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000674 return 1;
675 }
Richard Hughes842d6782021-01-15 09:48:12 +0000676 flashprog_progress_add(flash, chunksize);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000677 }
678
679 return 0;
680}
681
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000682static int dediprog_spi_write(struct flashctx *flash, const uint8_t *buf,
Nico Hubera4b14f72012-06-19 12:06:53 +0000683 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
Carl-Daniel Hailfinger306b8182010-11-23 21:28:16 +0000684{
Stefan Reinauer915b8402011-01-28 09:00:15 +0000685 int ret;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000686 const unsigned int chunksize = flash->chip->page_size;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000687 unsigned int residue = start % chunksize ? chunksize - start % chunksize : 0;
688 unsigned int bulklen;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100689 const struct dediprog_data *dp_data = flash->mst.spi->data;
Stefan Reinauer915b8402011-01-28 09:00:15 +0000690
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000691 dediprog_set_leds(LED_BUSY, dp_data);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000692
Nico Hubera4b14f72012-06-19 12:06:53 +0000693 if (chunksize != 256) {
694 msg_pdbg("Page sizes other than 256 bytes are unsupported as "
695 "we don't know how dediprog\nhandles them.\n");
696 /* Write everything like it was residue. */
697 residue = len;
698 }
699
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000700 if (residue) {
701 msg_pdbg("Slow write for partial block from 0x%x, length 0x%x\n",
702 start, residue);
Nico Huber93db6e12018-09-30 01:18:43 +0200703 /* No idea about the real limit. Maybe 16 including command and address, maybe more. */
Nico Hubere36e3dc2023-04-28 21:23:08 +0000704 ret = default_spi_write_256(flash, buf, start, residue);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000705 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000706 dediprog_set_leds(LED_ERROR, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000707 return ret;
708 }
709 }
Stefan Reinauer915b8402011-01-28 09:00:15 +0000710
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000711 /* Round down. */
712 bulklen = (len - residue) / chunksize * chunksize;
Nico Hubera4b14f72012-06-19 12:06:53 +0000713 ret = dediprog_spi_bulk_write(flash, buf + residue, chunksize, start + residue, bulklen, dedi_spi_cmd);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000714 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000715 dediprog_set_leds(LED_ERROR, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000716 return ret;
717 }
Stefan Reinauer915b8402011-01-28 09:00:15 +0000718
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000719 len -= residue + bulklen;
720 if (len) {
721 msg_pdbg("Slow write for partial block from 0x%x, length 0x%x\n",
722 start, len);
Nico Hubere36e3dc2023-04-28 21:23:08 +0000723 ret = default_spi_write_256(flash, buf + residue + bulklen, start + residue + bulklen, len);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000724 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000725 dediprog_set_leds(LED_ERROR, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000726 return ret;
727 }
728 }
729
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000730 dediprog_set_leds(LED_PASS, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000731 return 0;
Carl-Daniel Hailfinger306b8182010-11-23 21:28:16 +0000732}
733
Nico Hubera96aaa32024-03-05 12:56:13 +0100734static int dediprog_spi_write_chunked(struct flashctx *flash, const uint8_t *buf,
735 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
736{
737 /* We can write only up to 65535 pages at once: */
738 while (len) {
739 const size_t len_here = MIN(len, flash->chip->page_size * MAX_BLOCK_COUNT);
740 const int ret = dediprog_spi_write(flash, buf, start, len_here, dedi_spi_cmd);
741 if (ret)
742 return ret;
743
744 start += len_here;
745 buf += len_here;
746 len -= len_here;
747 }
748 return 0;
749}
750
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000751static int dediprog_spi_write_256(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Nico Hubera4b14f72012-06-19 12:06:53 +0000752{
Nico Hubera96aaa32024-03-05 12:56:13 +0100753 return dediprog_spi_write_chunked(flash, buf, start, len, WRITE_MODE_PAGE_PGM);
Nico Hubera4b14f72012-06-19 12:06:53 +0000754}
755
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000756static int dediprog_spi_write_aai(struct flashctx *flash, const uint8_t *buf, unsigned int start, unsigned int len)
Nico Hubera4b14f72012-06-19 12:06:53 +0000757{
Nico Hubera96aaa32024-03-05 12:56:13 +0100758 return dediprog_spi_write_chunked(flash, buf, start, len, WRITE_MODE_2B_AAI);
Nico Hubera4b14f72012-06-19 12:06:53 +0000759}
760
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000761static int dediprog_spi_send_command(const struct flashctx *flash,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000762 unsigned int writecnt,
763 unsigned int readcnt,
764 const unsigned char *writearr,
765 unsigned char *readarr)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000766{
767 int ret;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100768 const struct dediprog_data *dp_data = flash->mst.spi->data;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000769
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000770 msg_pspew("%s, writecnt=%i, readcnt=%i\n", __func__, writecnt, readcnt);
Nico Hubere36e3dc2023-04-28 21:23:08 +0000771 if (writecnt > flash->mst.spi->max_data_write + 5) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000772 msg_perr("Invalid writecnt=%i, aborting.\n", writecnt);
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000773 return 1;
774 }
Nico Huber9a11cbf2023-01-13 01:19:07 +0100775 if (readcnt > flash->mst.spi->max_data_read) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000776 msg_perr("Invalid readcnt=%i, aborting.\n", readcnt);
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000777 return 1;
778 }
Elyes HAOUAS0cacb112019-02-04 12:16:38 +0100779
Simon Glassae616512016-01-23 23:27:58 +0000780 unsigned int idx, value;
781 /* New protocol has options and timeout combined as value while the old one used the value field for
782 * timeout and the index field for options. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000783 if (protocol(dp_data) >= PROTOCOL_V2) {
Simon Glassae616512016-01-23 23:27:58 +0000784 idx = 0;
785 value = readcnt ? 0x1 : 0x0; // Indicate if we require a read
786 } else {
787 idx = readcnt ? 0x1 : 0x0; // Indicate if we require a read
788 value = 0;
789 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000790 ret = dediprog_write(dp_data->handle, CMD_TRANSCEIVE, value, idx, writearr, writecnt);
Nico Huber519be662018-12-23 20:03:35 +0100791 if (ret != (int)writecnt) {
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000792 msg_perr("Send SPI failed, expected %i, got %i %s!\n",
Nico Huberd99a2bd2016-02-18 21:42:49 +0000793 writecnt, ret, libusb_error_name(ret));
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000794 return 1;
795 }
Simon Glassae616512016-01-23 23:27:58 +0000796 if (readcnt == 0) // If we don't require a response, we are done here
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000797 return 0;
Simon Glass557eb4f2015-07-05 16:53:22 +0000798
Stefan Tauner74367bf2016-02-20 20:53:46 +0000799 /* The specifications do state the possibility to set a timeout for transceive transactions.
800 * Apparently the "timeout" is a delay, and you can use long delays to accelerate writing - in case you
801 * can predict the time needed by the previous command or so (untested). In any case, using this
802 * "feature" to set sane-looking timouts for the read below will completely trash performance with
803 * SF600 and/or firmwares >= 6.0 while they seem to be benign on SF100 with firmwares <= 5.5.2. *shrug*
804 *
805 * The specification also uses only 0 in its examples, so the lesson to learn here:
806 * "Never trust the description of an interface in the documentation but use the example code and pray."
Simon Glassae616512016-01-23 23:27:58 +0000807 const uint8_t read_timeout = 10 + readcnt/512;
David Hendricksf73f8a72018-02-21 07:34:34 -0800808 if (protocol() >= PROTOCOL_V2) {
Simon Glassae616512016-01-23 23:27:58 +0000809 idx = 0;
810 value = min(read_timeout, 0xFF) | (0 << 8) ; // Timeout in lower byte, option in upper byte
811 } else {
812 idx = (0 & 0xFF); // Lower byte is option (0x01 = require SR, 0x02 keep CS low)
813 value = min(read_timeout, 0xFF); // Possibly two bytes but we play safe here
814 }
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000815 ret = dediprog_read(dp_data->dediprog_handle, CMD_TRANSCEIVE, value, idx, readarr, readcnt);
Stefan Tauner74367bf2016-02-20 20:53:46 +0000816 */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000817 ret = dediprog_read(dp_data->handle, CMD_TRANSCEIVE, 0, 0, readarr, readcnt);
Nico Huber519be662018-12-23 20:03:35 +0100818 if (ret != (int)readcnt) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000819 msg_perr("Receive SPI failed, expected %i, got %i %s!\n", readcnt, ret, libusb_error_name(ret));
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000820 return 1;
821 }
822 return 0;
823}
824
Nico Huber274e6552024-03-24 12:34:57 +0100825static int dediprog_read_devicestring(struct dediprog_data *dp_data)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000826{
Nico Huber274e6552024-03-24 12:34:57 +0100827 const int devstr_len = sizeof(dp_data->devicestring) - 1, old_devstr_len = 16;
828 char *const buf = dp_data->devicestring;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000829 int ret;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000830
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000831 /* Command Receive Device String. */
Nico Hubere76e21f2024-02-29 23:33:35 +0100832 ret = dediprog_read(dp_data->handle, CMD_READ_PROG_INFO, 0, 0, (uint8_t *)buf, devstr_len);
Nico Huber5262e292024-03-02 13:21:25 +0100833 if (ret < old_devstr_len || ret > devstr_len) {
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000834 msg_perr("Incomplete/failed Command Receive Device String!\n");
835 return 1;
836 }
Nico Huber5262e292024-03-02 13:21:25 +0100837 buf[ret] = '\0';
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000838 msg_pdbg("Found a %s\n", buf);
Nico Hubere76e21f2024-02-29 23:33:35 +0100839 if (memcmp(buf, "SF100", 5) == 0)
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000840 dp_data->devicetype = DEV_SF100;
Nico Hubere76e21f2024-02-29 23:33:35 +0100841 else if (memcmp(buf, "SF200", 5) == 0)
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000842 dp_data->devicetype = DEV_SF200;
Nico Huber00578222024-03-02 14:00:53 +0100843 else if (memcmp(buf, "SF600PG2", 8) == 0) /* match first, before shorter, generic SF600 */
844 dp_data->devicetype = DEV_SF600PG2;
Nico Hubere76e21f2024-02-29 23:33:35 +0100845 else if (memcmp(buf, "SF600", 5) == 0)
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000846 dp_data->devicetype = DEV_SF600;
Nico Huber00578222024-03-02 14:00:53 +0100847 else if (memcmp(buf, "SF700", 5) == 0)
848 dp_data->devicetype = DEV_SF700;
Nico Huber274e6552024-03-24 12:34:57 +0100849 else
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000850 return 1;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000851
Nico Huber274e6552024-03-24 12:34:57 +0100852 return 0;
853}
854
855static int dediprog_check_devicestring(struct dediprog_data *dp_data)
856{
857 char *const buf = dp_data->devicestring;
Nico Huberbdef5c22024-03-02 13:51:39 +0100858 unsigned int sfnum;
859 unsigned int fw[3];
Nico Huber274e6552024-03-24 12:34:57 +0100860
Nico Huber0ab5c3d2024-03-02 13:53:16 +0100861 if (sscanf(buf, "SF%u", &sfnum) != 1 ||
Nico Huber00578222024-03-02 14:00:53 +0100862 sfnum != dp_data->devicetype / 100 * 100 ||
Nico Huber0ab5c3d2024-03-02 13:53:16 +0100863 sscanf(buf, "SF%*s V:%u.%u.%u ", &fw[0], &fw[1], &fw[2]) != 3) {
Simon Glassae616512016-01-23 23:27:58 +0000864 msg_perr("Unexpected firmware version string '%s'\n", buf);
Mathias Krausedb7afc52010-11-09 23:30:43 +0000865 return 1;
866 }
Nico Huber00578222024-03-02 14:00:53 +0100867
868 /* Only allow major versions that were tested. */
869 if ((dp_data->devicetype == DEV_SF600PG2 && fw[0] > 1) ||
870 (dp_data->devicetype == DEV_SF700 && fw[0] != 4) ||
871 (dp_data->devicetype <= DEV_SF600 && (fw[0] < 2 || fw[0] > 7))) {
Simon Glassae616512016-01-23 23:27:58 +0000872 msg_perr("Unexpected firmware version %d.%d.%d!\n", fw[0], fw[1], fw[2]);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000873 return 1;
874 }
David Hendricksf73f8a72018-02-21 07:34:34 -0800875
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000876 dp_data->firmwareversion = FIRMWARE_VERSION(fw[0], fw[1], fw[2]);
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000877 if (protocol(dp_data) == PROTOCOL_UNKNOWN) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800878 msg_perr("Internal error: Unable to determine protocol version.\n");
879 return 1;
880 }
Simon Glassae616512016-01-23 23:27:58 +0000881
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000882 return 0;
883}
884
David Hendricksc05900f2016-02-18 21:42:41 +0000885/*
Ryan O'Leary301ae222019-06-24 19:14:33 -0700886 * Read the id from the dediprog. This should return the numeric part of the
887 * serial number found on a sticker on the back of the dediprog. Note this
Nico Huber821a0852024-03-24 13:34:51 +0100888 * number is stored in writable eeprom, so it could get out of sync.
Ryan O'Leary301ae222019-06-24 19:14:33 -0700889 * @return the id on success, -1 on failure
890 */
Nico Huber821a0852024-03-24 13:34:51 +0100891static int dediprog_read_id(struct dediprog_data *const dp)
Ryan O'Leary301ae222019-06-24 19:14:33 -0700892{
Nico Huber821a0852024-03-24 13:34:51 +0100893 const int min_len = 3;
Ryan O'Leary301ae222019-06-24 19:14:33 -0700894 int ret;
Ryan O'Leary301ae222019-06-24 19:14:33 -0700895
Nico Huber821a0852024-03-24 13:34:51 +0100896 if (dp->devicetype >= DEV_SF600PG2) {
897 const uint8_t out[6] = { 0x00, 0x00, 0x00, 0x02, 0x00, 0x00 };
898 const uint8_t cmd = 0x71;
899 uint8_t buf[512];
900 int transferred;
901 int try;
902
903 /* Always query the id twice as the endpoint
904 can lock up in mysterious ways otherwise. */
905 for (try = 0; try < 2; ++try) {
906 ret = dediprog_write(dp->handle, cmd, 0, 0, out, sizeof(out));
907 if (ret != (int)sizeof(out))
908 goto failed_ret;
909
910 ret = libusb_bulk_transfer(dp->handle, dp->in_endpoint,
911 buf, sizeof(buf), &transferred, DEFAULT_TIMEOUT);
912 }
913
914 if (ret == 0 && transferred >= min_len)
915 return buf[2] << 16 | buf[1] << 8 | buf[0];
916 } else {
917 uint8_t buf[16];
918
919 if (dp->devicetype >= DEV_SF600) {
920 ret = dediprog_read(dp->handle, CMD_READ_EEPROM, 0, 0, buf, sizeof(buf));
921 } else {
922 ret = libusb_control_transfer(dp->handle, REQTYPE_OTHER_IN,
923 0x7, /* request */
924 0, /* value */
925 0xEF00, /* index */
926 buf, min_len, DEFAULT_TIMEOUT);
927 }
928
929 if (ret >= min_len)
930 return buf[0] << 16 | buf[1] << 8 | buf[2];
Ryan O'Leary301ae222019-06-24 19:14:33 -0700931 }
932
Nico Huber821a0852024-03-24 13:34:51 +0100933failed_ret:
934 msg_perr("Failed to read dediprog id: ");
935 if (ret < 0)
936 msg_perr("%s (%d)\n", libusb_strerror(ret), ret);
937 else
938 msg_perr("short read!\n");
939 return -1;
Ryan O'Leary301ae222019-06-24 19:14:33 -0700940}
941
942/*
David Hendricksc05900f2016-02-18 21:42:41 +0000943 * This command presumably sets the voltage for the SF100 itself (not the
944 * SPI flash). Only use this command with firmware older than V6.0.0. Newer
945 * (including all SF600s) do not support it.
946 */
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000947
David Hendricksc05900f2016-02-18 21:42:41 +0000948/* This command presumably sets the voltage for the SF100 itself (not the SPI flash).
949 * Only use dediprog_set_voltage on SF100 programmers with firmware older
950 * than V6.0.0. Newer programmers (including all SF600s) do not support it. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000951static int dediprog_set_voltage(libusb_device_handle *dediprog_handle)
David Hendricksc05900f2016-02-18 21:42:41 +0000952{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000953 unsigned char buf[1] = {0};
954 int ret = libusb_control_transfer(dediprog_handle, REQTYPE_OTHER_IN, CMD_SET_VOLTAGE, 0x0, 0x0,
Simon Glass557eb4f2015-07-05 16:53:22 +0000955 buf, 0x1, DEFAULT_TIMEOUT);
Mathias Krausedb7afc52010-11-09 23:30:43 +0000956 if (ret < 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000957 msg_perr("Command Set Voltage failed (%s)!\n", libusb_error_name(ret));
Mathias Krausedb7afc52010-11-09 23:30:43 +0000958 return 1;
959 }
David Hendricksc05900f2016-02-18 21:42:41 +0000960 if ((ret != 1) || (buf[0] != 0x6f)) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000961 msg_perr("Unexpected response to init!\n");
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000962 return 1;
963 }
David Hendricksc05900f2016-02-18 21:42:41 +0000964
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000965 return 0;
966}
967
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000968static int dediprog_standalone_mode(const struct dediprog_data *dp_data)
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000969{
970 int ret;
971
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000972 if (dp_data->devicetype != DEV_SF600)
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000973 return 0;
974
975 msg_pdbg2("Disabling standalone mode.\n");
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000976 ret = dediprog_write(dp_data->handle, CMD_SET_STANDALONE, LEAVE_STANDALONE_MODE, 0, NULL, 0);
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000977 if (ret) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000978 msg_perr("Failed to disable standalone mode: %s\n", libusb_error_name(ret));
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000979 return 1;
980 }
981
982 return 0;
983}
984
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000985#if 0
986/* Something.
987 * Present in eng_detect_blink.log with firmware 3.1.8
988 * Always preceded by Command Receive Device String
989 */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000990static int dediprog_command_b(libusb_device_handle *dediprog_handle)
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000991{
992 int ret;
993 char buf[0x3];
994
Simon Glass557eb4f2015-07-05 16:53:22 +0000995 ret = usb_control_msg(dediprog_handle, REQTYPE_OTHER_IN, 0x7, 0x0, 0xef00,
996 buf, 0x3, DEFAULT_TIMEOUT);
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000997 if (ret < 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000998 msg_perr("Command B failed (%s)!\n", libusb_error_name(ret));
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000999 return 1;
1000 }
1001 if ((ret != 0x3) || (buf[0] != 0xff) || (buf[1] != 0xff) ||
1002 (buf[2] != 0xff)) {
1003 msg_perr("Unexpected response to Command B!\n");
1004 return 1;
1005 }
1006
1007 return 0;
1008}
1009#endif
1010
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001011static int set_target_flash(libusb_device_handle *dediprog_handle, enum dediprog_target target)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001012{
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001013 int ret = dediprog_write(dediprog_handle, CMD_SET_TARGET, target, 0, NULL, 0);
Simon Glass557eb4f2015-07-05 16:53:22 +00001014 if (ret != 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +00001015 msg_perr("set_target_flash failed (%s)!\n", libusb_error_name(ret));
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001016 return 1;
1017 }
1018 return 0;
1019}
1020
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +00001021#if 0
Simon Glass557eb4f2015-07-05 16:53:22 +00001022/* Returns true if the button is currently pressed. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001023static bool dediprog_get_button(libusb_device_handle *dediprog_handle)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001024{
Simon Glass557eb4f2015-07-05 16:53:22 +00001025 char buf[1];
1026 int ret = usb_control_msg(dediprog_handle, REQTYPE_EP_IN, CMD_GET_BUTTON, 0, 0,
1027 buf, 0x1, DEFAULT_TIMEOUT);
1028 if (ret != 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +00001029 msg_perr("Could not get button state (%s)!\n", libusb_error_name(ret));
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +00001030 return 1;
1031 }
Simon Glass557eb4f2015-07-05 16:53:22 +00001032 return buf[0] != 1;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +00001033}
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +00001034#endif
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001035
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001036static int parse_voltage(char *voltage)
1037{
1038 char *tmp = NULL;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001039 int i;
1040 int millivolt = 0, fraction = 0;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001041
1042 if (!voltage || !strlen(voltage)) {
1043 msg_perr("Empty voltage= specified.\n");
1044 return -1;
1045 }
1046 millivolt = (int)strtol(voltage, &tmp, 0);
1047 voltage = tmp;
1048 /* Handle "," and "." as decimal point. Everything after it is assumed
1049 * to be in decimal notation.
1050 */
1051 if ((*voltage == '.') || (*voltage == ',')) {
1052 voltage++;
1053 for (i = 0; i < 3; i++) {
1054 fraction *= 10;
1055 /* Don't advance if the current character is invalid,
1056 * but continue multiplying.
1057 */
1058 if ((*voltage < '0') || (*voltage > '9'))
1059 continue;
1060 fraction += *voltage - '0';
1061 voltage++;
1062 }
1063 /* Throw away remaining digits. */
1064 voltage += strspn(voltage, "0123456789");
1065 }
1066 /* The remaining string must be empty or "mV" or "V". */
1067 tolower_string(voltage);
1068
1069 /* No unit or "V". */
1070 if ((*voltage == '\0') || !strncmp(voltage, "v", 1)) {
1071 millivolt *= 1000;
1072 millivolt += fraction;
1073 } else if (!strncmp(voltage, "mv", 2) ||
1074 !strncmp(voltage, "milliv", 6)) {
1075 /* No adjustment. fraction is discarded. */
1076 } else {
1077 /* Garbage at the end of the string. */
1078 msg_perr("Garbage voltage= specified.\n");
1079 return -1;
1080 }
1081 return millivolt;
1082}
1083
Anastasia Klimchukc63d9182021-07-06 16:18:44 +10001084static int dediprog_shutdown(void *data);
1085
Nico Huber93db6e12018-09-30 01:18:43 +02001086static struct spi_master spi_master_dediprog = {
Nico Huberdc5af542018-12-22 16:54:59 +01001087 .features = SPI_MASTER_NO_4BA_MODES,
Simon Glassae616512016-01-23 23:27:58 +00001088 .max_data_read = 16, /* 18 seems to work fine as well, but 19 times out sometimes with FW 5.15. */
Nico Hubere36e3dc2023-04-28 21:23:08 +00001089 .max_data_write = 16 - 5, /* Account for 5 bytes cmd/addr. */
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001090 .command = dediprog_spi_send_command,
1091 .multicommand = default_spi_send_multicommand,
1092 .read = dediprog_spi_read,
1093 .write_256 = dediprog_spi_write_256,
Nico Hubera4b14f72012-06-19 12:06:53 +00001094 .write_aai = dediprog_spi_write_aai,
Anastasia Klimchukc63d9182021-07-06 16:18:44 +10001095 .shutdown = dediprog_shutdown,
Aarya Chaumal0cea7532022-07-04 18:21:50 +05301096 .probe_opcode = default_spi_probe_opcode,
Michael Karcherb9dbe482011-05-11 17:07:07 +00001097};
1098
Ryan O'Leary301ae222019-06-24 19:14:33 -07001099/*
1100 * Open a dediprog_handle with the USB device at the given index.
1101 * @index index of the USB device
Nico Huber274e6552024-03-24 12:34:57 +01001102 * @return 0 for success, -1 for error, -2 for busy device, -3 for unknown device
Ryan O'Leary301ae222019-06-24 19:14:33 -07001103 */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001104static int dediprog_open(int index, struct dediprog_data *dp_data)
Ryan O'Leary301ae222019-06-24 19:14:33 -07001105{
1106 const uint16_t vid = devs_dediprog[0].vendor_id;
1107 const uint16_t pid = devs_dediprog[0].device_id;
1108 int ret;
1109
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001110 dp_data->handle = usb_dev_get_by_vid_pid_number(dp_data->usb_ctx, vid, pid, (unsigned int) index);
1111 if (!dp_data->handle) {
Ryan O'Leary301ae222019-06-24 19:14:33 -07001112 msg_perr("Could not find a Dediprog programmer on USB.\n");
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001113 libusb_exit(dp_data->usb_ctx);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001114 return -1;
1115 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001116 ret = libusb_set_configuration(dp_data->handle, 1);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001117 if (ret != 0) {
1118 msg_perr("Could not set USB device configuration: %i %s\n",
1119 ret, libusb_error_name(ret));
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001120 libusb_close(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001121 return -2;
1122 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001123 ret = libusb_claim_interface(dp_data->handle, 0);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001124 if (ret < 0) {
1125 msg_perr("Could not claim USB device interface %i: %i %s\n",
1126 0, ret, libusb_error_name(ret));
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001127 libusb_close(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001128 return -2;
1129 }
Nico Huber274e6552024-03-24 12:34:57 +01001130
1131 /* Try reading the devicestring. If that fails and the device is old
1132 (FW < 6.0.0, which we cannot know), then we need to try the "set
1133 voltage" command and then attempt to read the devicestring again. */
1134 if (dediprog_read_devicestring(dp_data)) {
1135 if (dediprog_set_voltage(dp_data->handle))
1136 goto unknown_dev;
1137 if (dediprog_read_devicestring(dp_data))
1138 goto unknown_dev;
1139 }
Nico Huber821a0852024-03-24 13:34:51 +01001140
1141 dp_data->in_endpoint = LIBUSB_ENDPOINT_IN | 2;
1142 if (dp_data->devicetype <= DEV_SF200)
1143 dp_data->out_endpoint = 2;
1144 else
1145 dp_data->out_endpoint = 1;
1146
Ryan O'Leary301ae222019-06-24 19:14:33 -07001147 return 0;
Nico Huber274e6552024-03-24 12:34:57 +01001148
1149unknown_dev:
1150 msg_pwarn("Ignoring unknown Dediprog device. Not a SF100, SF200, SF600(Plus(G2)), or SF700!\n");
1151 libusb_release_interface(dp_data->handle, 0);
1152 libusb_close(dp_data->handle);
1153 return -3;
Ryan O'Leary301ae222019-06-24 19:14:33 -07001154}
1155
David Hendricks8bb20212011-06-14 01:35:36 +00001156static int dediprog_shutdown(void *data)
1157{
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001158 int ret = 0;
1159 struct dediprog_data *dp_data = data;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +00001160
David Hendricks8bb20212011-06-14 01:35:36 +00001161 /* URB 28. Command Set SPI Voltage to 0. */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001162 if (dediprog_set_spi_voltage(dp_data->handle, 0x0)) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001163 ret = 1;
1164 goto out;
David Hendricks8bb20212011-06-14 01:35:36 +00001165 }
Nico Huberd99a2bd2016-02-18 21:42:49 +00001166
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001167 if (libusb_release_interface(dp_data->handle, 0)) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001168 msg_perr("Could not release USB interface!\n");
1169 ret = 1;
1170 goto out;
1171 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001172 libusb_close(dp_data->handle);
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001173 libusb_exit(dp_data->usb_ctx);
1174out:
1175 free(data);
1176 return ret;
David Hendricks8bb20212011-06-14 01:35:36 +00001177}
1178
Nico Hubere3a26882023-01-11 21:45:51 +01001179static int dediprog_init(struct flashprog_programmer *const prog)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001180{
Ryan O'Leary301ae222019-06-24 19:14:33 -07001181 char *voltage, *id_str, *device, *spispeed, *target_str;
Patrick Georgiefe2d432013-05-23 21:47:46 +00001182 int spispeed_idx = 1;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001183 int millivolt = 3500;
Nico Hubere8463c82024-03-24 16:50:50 +01001184 long id = -1; /* -1 defaults to enumeration order */
Ryan O'Leary301ae222019-06-24 19:14:33 -07001185 int found_id;
Nathan Laredo21541a62012-12-24 22:07:36 +00001186 long usedevice = 0;
Nico Huber5e5e8212016-05-04 12:27:58 +02001187 long target = FLASH_TYPE_APPLICATION_FLASH_1;
Nico Huber77fa67d2013-02-20 18:03:36 +00001188 int i, ret;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001189
Nico Huber77fa67d2013-02-20 18:03:36 +00001190 spispeed = extract_programmer_param("spispeed");
1191 if (spispeed) {
1192 for (i = 0; spispeeds[i].name; ++i) {
1193 if (!strcasecmp(spispeeds[i].name, spispeed)) {
1194 spispeed_idx = i;
1195 break;
1196 }
1197 }
1198 if (!spispeeds[i].name) {
Patrick Georgiefe2d432013-05-23 21:47:46 +00001199 msg_perr("Error: Invalid spispeed value: '%s'.\n", spispeed);
Nico Huber77fa67d2013-02-20 18:03:36 +00001200 free(spispeed);
1201 return 1;
1202 }
1203 free(spispeed);
1204 }
Simon Glass557eb4f2015-07-05 16:53:22 +00001205
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001206 voltage = extract_programmer_param("voltage");
1207 if (voltage) {
1208 millivolt = parse_voltage(voltage);
1209 free(voltage);
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001210 if (millivolt < 0)
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001211 return 1;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001212 msg_pinfo("Setting voltage to %i mV\n", millivolt);
1213 }
1214
Ryan O'Leary301ae222019-06-24 19:14:33 -07001215 id_str = extract_programmer_param("id");
1216 if (id_str) {
Nico Hubere8463c82024-03-24 16:50:50 +01001217 const char prefixes[][4] = { "SF", "DP", "S6B", };
1218 for (i = 0; i < (int)ARRAY_SIZE(prefixes); ++i) {
1219 if (!strncmp(id_str, prefixes[i], strlen(prefixes[i])))
1220 break;
1221 }
1222 if (i >= (int)ARRAY_SIZE(prefixes)) {
1223 msg_perr("Error: Could not parse dediprog `id'.\n");
1224 msg_perr("Expected a string prefixed with any of ");
1225 for (i = 0; i < (int)ARRAY_SIZE(prefixes); ++i)
1226 msg_perr("%s`%s'", i > 0 ? ", " : "", prefixes[i]);
1227 msg_perr(".\n");
1228 free(id_str);
1229 return 1;
1230 }
1231 char *endptr;
1232 id = strtol(id_str + strlen(prefixes[i]), &endptr, 10);
1233 if (strlen(id_str) <= strlen(prefixes[i]) || *endptr) {
1234 msg_perr("Error: Could not parse dediprog `id'.\n");
1235 msg_perr("Expected a number after string prefix.\n");
Ryan O'Leary301ae222019-06-24 19:14:33 -07001236 free(id_str);
1237 return 1;
1238 }
1239 if (id < 0 || id >= 0x1000000) {
Nico Hubere8463c82024-03-24 16:50:50 +01001240 msg_perr("Error: id `%s' is out of range!\n", id_str);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001241 free(id_str);
1242 return 1;
1243 }
1244 msg_pinfo("Will search for dediprog id %s.\n", id_str);
1245 }
1246 free(id_str);
1247
Nathan Laredo21541a62012-12-24 22:07:36 +00001248 device = extract_programmer_param("device");
1249 if (device) {
1250 char *dev_suffix;
Ryan O'Leary301ae222019-06-24 19:14:33 -07001251 if (id != -1) {
1252 msg_perr("Error: Cannot use 'id' and 'device'.\n");
1253 }
Nathan Laredo21541a62012-12-24 22:07:36 +00001254 errno = 0;
1255 usedevice = strtol(device, &dev_suffix, 10);
1256 if (errno != 0 || device == dev_suffix) {
1257 msg_perr("Error: Could not convert 'device'.\n");
1258 free(device);
1259 return 1;
1260 }
Nico Huber961f4a12019-10-04 17:34:22 +02001261 if (usedevice < 0 || usedevice > INT_MAX) {
Nathan Laredo21541a62012-12-24 22:07:36 +00001262 msg_perr("Error: Value for 'device' is out of range.\n");
1263 free(device);
1264 return 1;
1265 }
1266 if (strlen(dev_suffix) > 0) {
1267 msg_perr("Error: Garbage following 'device' value.\n");
1268 free(device);
1269 return 1;
1270 }
1271 msg_pinfo("Using device %li.\n", usedevice);
1272 }
1273 free(device);
1274
Stefan Taunere659d2d2013-05-03 21:58:28 +00001275 target_str = extract_programmer_param("target");
1276 if (target_str) {
1277 char *target_suffix;
1278 errno = 0;
1279 target = strtol(target_str, &target_suffix, 10);
1280 if (errno != 0 || target_str == target_suffix) {
1281 msg_perr("Error: Could not convert 'target'.\n");
1282 free(target_str);
1283 return 1;
1284 }
1285 if (target < 1 || target > 2) {
1286 msg_perr("Error: Value for 'target' is out of range.\n");
1287 free(target_str);
1288 return 1;
1289 }
1290 if (strlen(target_suffix) > 0) {
1291 msg_perr("Error: Garbage following 'target' value.\n");
1292 free(target_str);
1293 return 1;
1294 }
Nico Huber5e5e8212016-05-04 12:27:58 +02001295 switch (target) {
1296 case 1:
1297 msg_pinfo("Using target %s.\n", "FLASH_TYPE_APPLICATION_FLASH_1");
1298 target = FLASH_TYPE_APPLICATION_FLASH_1;
1299 break;
1300 case 2:
1301 msg_pinfo("Using target %s.\n", "FLASH_TYPE_APPLICATION_FLASH_2");
1302 target = FLASH_TYPE_APPLICATION_FLASH_2;
1303 break;
1304 default:
1305 break;
1306 }
Stefan Taunere659d2d2013-05-03 21:58:28 +00001307 }
1308 free(target_str);
1309
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001310 struct dediprog_data *dp_data = calloc(1, sizeof(*dp_data));
1311 if (!dp_data) {
1312 msg_perr("Unable to allocate space for SPI master data\n");
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001313 return 1;
1314 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001315 dp_data->firmwareversion = FIRMWARE_VERSION(0, 0, 0);
1316 dp_data->devicetype = DEV_UNKNOWN;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001317
1318 /* Here comes the USB stuff. */
Thomas Heijligen88e87c52022-08-05 17:56:20 +02001319 ret = libusb_init(&dp_data->usb_ctx);
1320 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001321 msg_perr("Could not initialize libusb!\n");
1322 goto init_err_exit;
1323 }
Stefan Taunerfdec7472016-02-22 08:59:27 +00001324
Ryan O'Leary301ae222019-06-24 19:14:33 -07001325 if (id != -1) {
1326 for (i = 0; ; i++) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001327 ret = dediprog_open(i, dp_data);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001328 if (ret == -1) {
1329 /* no dev */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001330 goto init_err_exit;
Nico Huber274e6552024-03-24 12:34:57 +01001331 } else if (ret < 0) {
1332 /* busy or unknown dev */
Ryan O'Leary301ae222019-06-24 19:14:33 -07001333 continue;
1334 }
1335
1336 /* Notice we can only call dediprog_read_id() after
1337 * libusb_set_configuration() and
1338 * libusb_claim_interface(). When searching by id and
1339 * either configuration or claim fails (usually the
Nico Huberc3b02dc2023-08-12 01:13:45 +02001340 * device is in use by another instance of flashprog),
Ryan O'Leary301ae222019-06-24 19:14:33 -07001341 * the device is skipped and the next device is tried.
1342 */
Nico Huber821a0852024-03-24 13:34:51 +01001343 found_id = dediprog_read_id(dp_data);
Nico Huber38af1a12024-03-24 15:04:20 +01001344 if (found_id >= 0)
1345 msg_pinfo("Found dediprog id SF%06d.\n", found_id);
1346 if (found_id == id)
1347 break;
1348
1349 libusb_release_interface(dp_data->handle, 0);
1350 libusb_close(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001351 }
1352 } else {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001353 if (dediprog_open(usedevice, dp_data)) {
1354 goto init_err_exit;
Ryan O'Leary301ae222019-06-24 19:14:33 -07001355 }
Nico Huber821a0852024-03-24 13:34:51 +01001356 found_id = dediprog_read_id(dp_data);
David Woodhoused2a7e872013-07-30 09:34:44 +00001357 }
Ryan O'Leary301ae222019-06-24 19:14:33 -07001358
1359 if (found_id >= 0) {
1360 msg_pinfo("Using dediprog id SF%06d.\n", found_id);
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +00001361 }
Nico Huber77fa67d2013-02-20 18:03:36 +00001362
Nico Huber274e6552024-03-24 12:34:57 +01001363 if (dediprog_check_devicestring(dp_data))
1364 goto init_err_cleanup_exit;
Nico Huber77fa67d2013-02-20 18:03:36 +00001365
Simon Glass25e9f402015-06-28 13:31:19 +00001366 /* Set all possible LEDs as soon as possible to indicate activity.
1367 * Because knowing the firmware version is required to set the LEDs correctly we need to this after
David Hendricksf73f8a72018-02-21 07:34:34 -08001368 * dediprog_check_devicestring() has queried the device. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001369 dediprog_set_leds(LED_ALL, dp_data);
Simon Glass25e9f402015-06-28 13:31:19 +00001370
Simon Glass557eb4f2015-07-05 16:53:22 +00001371 /* Select target/socket, frequency and VCC. */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001372 if (set_target_flash(dp_data->handle, target) ||
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001373 dediprog_set_spi_speed(spispeed_idx, dp_data) ||
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001374 dediprog_set_spi_voltage(dp_data->handle, millivolt)) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001375 dediprog_set_leds(LED_ERROR, dp_data);
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001376 goto init_err_cleanup_exit;
Stefan Reinauer915b8402011-01-28 09:00:15 +00001377 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001378
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001379 if (dediprog_standalone_mode(dp_data))
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001380 goto init_err_cleanup_exit;
David Woodhouse7f3b89f2016-02-18 21:42:15 +00001381
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001382 if ((dp_data->devicetype == DEV_SF100) ||
1383 (dp_data->devicetype == DEV_SF600 && protocol(dp_data) == PROTOCOL_V3))
Nico Huber7eb38aa2019-03-21 15:42:54 +01001384 spi_master_dediprog.features &= ~SPI_MASTER_NO_4BA_MODES;
1385
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001386 if (protocol(dp_data) >= PROTOCOL_V2)
Nico Huber93db6e12018-09-30 01:18:43 +02001387 spi_master_dediprog.features |= SPI_MASTER_4BA;
1388
Angel Pons116d56d2021-03-22 11:28:00 +01001389 if (dediprog_set_leds(LED_NONE, dp_data))
1390 goto init_err_cleanup_exit;
Stefan Reinauer915b8402011-01-28 09:00:15 +00001391
Nico Huber89569d62023-01-12 23:31:40 +01001392 return register_spi_master(&spi_master_dediprog, 0, dp_data);
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001393
1394init_err_cleanup_exit:
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001395 dediprog_shutdown(dp_data);
1396 return 1;
1397
1398init_err_exit:
1399 free(dp_data);
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001400 return 1;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001401}
Thomas Heijligencc853d82021-05-04 15:32:17 +02001402
1403const struct programmer_entry programmer_dediprog = {
1404 .name = "dediprog",
1405 .type = USB,
1406 .devs.dev = devs_dediprog,
1407 .init = dediprog_init,
Thomas Heijligencc853d82021-05-04 15:32:17 +02001408};