blob: 52161f1831973cdd2727b8eb738339c0cb2e05a1 [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;
164 enum dediprog_devtype devicetype;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000165};
Simon Glass557eb4f2015-07-05 16:53:22 +0000166
Nico Huberd99a2bd2016-02-18 21:42:49 +0000167#if defined(LIBUSB_MAJOR) && defined(LIBUSB_MINOR) && defined(LIBUSB_MICRO) && \
168 LIBUSB_MAJOR <= 1 && LIBUSB_MINOR == 0 && LIBUSB_MICRO < 9
169/* Quick and dirty replacement for missing libusb_error_name in libusb < 1.0.9 */
170const char * LIBUSB_CALL libusb_error_name(int error_code)
171{
172 if (error_code >= INT16_MIN && error_code <= INT16_MAX) {
173 /* 18 chars for text, rest for number (16 b should be enough), sign, nullbyte. */
174 static char my_libusb_error[18 + 5 + 2];
175 sprintf(my_libusb_error, "libusb error code %i", error_code);
176 return my_libusb_error;
177 } else {
178 return "UNKNOWN";
179 }
180}
181#endif
182
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000183static enum protocol protocol(const struct dediprog_data *dp_data)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000184{
David Hendricksf73f8a72018-02-21 07:34:34 -0800185 /* Firmware version < 5.0.0 is handled explicitly in some cases. */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000186 switch (dp_data->devicetype) {
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000187 case DEV_SF100:
Jay Thompsoncabe3202018-08-17 14:30:04 -0500188 case DEV_SF200:
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000189 if (dp_data->firmwareversion < FIRMWARE_VERSION(5, 5, 0))
David Hendricksf73f8a72018-02-21 07:34:34 -0800190 return PROTOCOL_V1;
191 else
192 return PROTOCOL_V2;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000193 case DEV_SF600:
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000194 if (dp_data->firmwareversion < FIRMWARE_VERSION(6, 9, 0))
David Hendricksf73f8a72018-02-21 07:34:34 -0800195 return PROTOCOL_V1;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000196 else if (dp_data->firmwareversion <= FIRMWARE_VERSION(7, 2, 21))
David Hendricksf73f8a72018-02-21 07:34:34 -0800197 return PROTOCOL_V2;
198 else
199 return PROTOCOL_V3;
Nico Huber00578222024-03-02 14:00:53 +0100200 case DEV_SF700:
201 case DEV_SF600PG2:
202 return PROTOCOL_V3;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000203 default:
David Hendricksf73f8a72018-02-21 07:34:34 -0800204 return PROTOCOL_UNKNOWN;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000205 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000206}
Simon Glassae616512016-01-23 23:27:58 +0000207
Nico Huberd99a2bd2016-02-18 21:42:49 +0000208struct dediprog_transfer_status {
209 int error; /* OK if 0, ERROR else */
210 unsigned int queued_idx;
211 unsigned int finished_idx;
212};
213
214static void LIBUSB_CALL dediprog_bulk_read_cb(struct libusb_transfer *const transfer)
215{
216 struct dediprog_transfer_status *const status = (struct dediprog_transfer_status *)transfer->user_data;
217 if (transfer->status != LIBUSB_TRANSFER_COMPLETED) {
218 status->error = 1;
219 msg_perr("SPI bulk read failed!\n");
220 }
221 ++status->finished_idx;
222}
223
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000224static int dediprog_bulk_read_poll(struct libusb_context *usb_ctx,
225 const struct dediprog_transfer_status *const status,
226 const int finish)
Nico Huberd99a2bd2016-02-18 21:42:49 +0000227{
228 if (status->finished_idx >= status->queued_idx)
229 return 0;
230
231 do {
232 struct timeval timeout = { 10, 0 };
233 const int ret = libusb_handle_events_timeout(usb_ctx, &timeout);
234 if (ret < 0) {
235 msg_perr("Polling read events failed: %i %s!\n", ret, libusb_error_name(ret));
236 return 1;
237 }
238 } while (finish && (status->finished_idx < status->queued_idx));
239 return 0;
240}
241
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000242static int dediprog_read(libusb_device_handle *dediprog_handle,
243 enum dediprog_cmds cmd, unsigned int value, unsigned int idx,
244 uint8_t *bytes, size_t size)
Simon Glassae616512016-01-23 23:27:58 +0000245{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000246 return libusb_control_transfer(dediprog_handle, REQTYPE_EP_IN, cmd, value, idx,
247 (unsigned char *)bytes, size, DEFAULT_TIMEOUT);
Simon Glassae616512016-01-23 23:27:58 +0000248}
249
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000250static int dediprog_write(libusb_device_handle *dediprog_handle,
251 enum dediprog_cmds cmd, unsigned int value, unsigned int idx,
252 const uint8_t *bytes, size_t size)
Simon Glassae616512016-01-23 23:27:58 +0000253{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000254 return libusb_control_transfer(dediprog_handle, REQTYPE_EP_OUT, cmd, value, idx,
255 (unsigned char *)bytes, size, DEFAULT_TIMEOUT);
Simon Glassae616512016-01-23 23:27:58 +0000256}
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000257
Nico Huberd99a2bd2016-02-18 21:42:49 +0000258
Simon Glass25e9f402015-06-28 13:31:19 +0000259/* This function sets the GPIOs connected to the LEDs as well as IO1-IO4. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000260static int dediprog_set_leds(int leds, const struct dediprog_data *dp_data)
Stefan Reinauer915b8402011-01-28 09:00:15 +0000261{
Simon Glass25e9f402015-06-28 13:31:19 +0000262 if (leds < LED_NONE || leds > LED_ALL)
263 leds = LED_ALL;
Stefan Reinauer915b8402011-01-28 09:00:15 +0000264
Simon Glassae616512016-01-23 23:27:58 +0000265 /* Older Dediprogs with 2.x.x and 3.x.x firmware only had two LEDs, assigned to different bits. So map
266 * them around if we have an old device. On those devices the LEDs map as follows:
Stefan Reinauer915b8402011-01-28 09:00:15 +0000267 * bit 2 == 0: green light is on.
Simon Glassae616512016-01-23 23:27:58 +0000268 * bit 0 == 0: red light is on.
269 *
270 * Additionally, the command structure has changed with the "new" protocol.
271 *
272 * FIXME: take IO pins into account
Stefan Reinauer915b8402011-01-28 09:00:15 +0000273 */
Simon Glassae616512016-01-23 23:27:58 +0000274 int target_leds, ret;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000275 if (protocol(dp_data) >= PROTOCOL_V2) {
Simon Glassae616512016-01-23 23:27:58 +0000276 target_leds = (leds ^ 7) << 8;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000277 ret = dediprog_write(dp_data->handle, CMD_SET_IO_LED, target_leds, 0, NULL, 0);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000278 } else {
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000279 if (dp_data->firmwareversion < FIRMWARE_VERSION(5, 0, 0)) {
Simon Glassae616512016-01-23 23:27:58 +0000280 target_leds = ((leds & LED_ERROR) >> 2) | ((leds & LED_PASS) << 2);
281 } else {
282 target_leds = leds;
283 }
284 target_leds ^= 7;
285
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000286 ret = dediprog_write(dp_data->handle, CMD_SET_IO_LED, 0x9, target_leds, NULL, 0);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000287 }
288
Stefan Reinauer915b8402011-01-28 09:00:15 +0000289 if (ret != 0x0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000290 msg_perr("Command Set LED 0x%x failed (%s)!\n", leds, libusb_error_name(ret));
Stefan Reinauer915b8402011-01-28 09:00:15 +0000291 return 1;
292 }
293
Stefan Reinauer915b8402011-01-28 09:00:15 +0000294 return 0;
295}
296
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000297static int dediprog_set_spi_voltage(libusb_device_handle *dediprog_handle, int millivolt)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000298{
299 int ret;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000300 uint16_t voltage_selector;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000301
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000302 switch (millivolt) {
303 case 0:
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000304 /* Admittedly this one is an assumption. */
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000305 voltage_selector = 0x0;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000306 break;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000307 case 1800:
308 voltage_selector = 0x12;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000309 break;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000310 case 2500:
311 voltage_selector = 0x11;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000312 break;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000313 case 3500:
314 voltage_selector = 0x10;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000315 break;
316 default:
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000317 msg_perr("Unknown voltage %i mV! Aborting.\n", millivolt);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000318 return 1;
319 }
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000320 msg_pdbg("Setting SPI voltage to %u.%03u V\n", millivolt / 1000,
321 millivolt % 1000);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000322
Nico Huber4099a8a2012-06-16 00:02:27 +0000323 if (voltage_selector == 0) {
324 /* Wait some time as the original driver does. */
325 programmer_delay(200 * 1000);
326 }
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000327 ret = dediprog_write(dediprog_handle, CMD_SET_VCC, voltage_selector, 0, NULL, 0);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000328 if (ret != 0x0) {
Uwe Hermann91f4afa2011-07-28 08:13:25 +0000329 msg_perr("Command Set SPI Voltage 0x%x failed!\n",
330 voltage_selector);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000331 return 1;
332 }
Nico Huber4099a8a2012-06-16 00:02:27 +0000333 if (voltage_selector != 0) {
334 /* Wait some time as the original driver does. */
335 programmer_delay(200 * 1000);
336 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000337 return 0;
338}
339
Nico Huber77fa67d2013-02-20 18:03:36 +0000340struct dediprog_spispeeds {
341 const char *const name;
342 const int speed;
343};
344
345static const struct dediprog_spispeeds spispeeds[] = {
346 { "24M", 0x0 },
347 { "12M", 0x2 },
348 { "8M", 0x1 },
349 { "3M", 0x3 },
350 { "2.18M", 0x4 },
351 { "1.5M", 0x5 },
352 { "750k", 0x6 },
353 { "375k", 0x7 },
354 { NULL, 0x0 },
355};
356
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000357static int dediprog_set_spi_speed(unsigned int spispeed_idx, const struct dediprog_data *dp_data)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000358{
Nico Huber00578222024-03-02 14:00:53 +0100359 if (dp_data->devicetype < DEV_SF600PG2 && dp_data->firmwareversion < FIRMWARE_VERSION(5, 0, 0)) {
Patrick Georgiefe2d432013-05-23 21:47:46 +0000360 msg_pwarn("Skipping to set SPI speed because firmware is too old.\n");
361 return 0;
362 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000363
Simon Glass557eb4f2015-07-05 16:53:22 +0000364 const struct dediprog_spispeeds *spispeed = &spispeeds[spispeed_idx];
365 msg_pdbg("SPI speed is %sHz\n", spispeed->name);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000366
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000367 int ret = dediprog_write(dp_data->handle, CMD_SET_SPI_CLK, spispeed->speed, 0, NULL, 0);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000368 if (ret != 0x0) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000369 msg_perr("Command Set SPI Speed 0x%x failed!\n", spispeed->speed);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000370 return 1;
371 }
372 return 0;
373}
374
Nico Huber7eb38aa2019-03-21 15:42:54 +0100375static int prepare_rw_cmd(
Nico Huber93db6e12018-09-30 01:18:43 +0200376 struct flashctx *const flash, uint8_t *data_packet, unsigned int count,
Nico Huber477e1692019-06-18 23:56:01 +0200377 uint8_t dedi_spi_cmd, unsigned int *value, unsigned int *idx, unsigned int start, int is_read)
378{
Nico Huber9a11cbf2023-01-13 01:19:07 +0100379 const struct dediprog_data *dp_data = flash->mst.spi->data;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000380
Nico Hubera96aaa32024-03-05 12:56:13 +0100381 if (count > MAX_BLOCK_COUNT) {
Nico Huberac90af62022-12-18 00:22:47 +0000382 msg_perr("%s: Unsupported transfer length of %u blocks!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200383 "Please report a bug at flashprog@flashprog.org\n",
Nico Huber477e1692019-06-18 23:56:01 +0200384 __func__, count);
385 return 1;
386 }
387
Simon Glassae616512016-01-23 23:27:58 +0000388 /* First 5 bytes are common in both generations. */
389 data_packet[0] = count & 0xff;
390 data_packet[1] = (count >> 8) & 0xff;
391 data_packet[2] = 0; /* RFU */
392 data_packet[3] = dedi_spi_cmd; /* Read/Write Mode (currently READ_MODE_STD, WRITE_MODE_PAGE_PGM or WRITE_MODE_2B_AAI) */
393 data_packet[4] = 0; /* "Opcode". Specs imply necessity only for READ_MODE_4B_ADDR_FAST and WRITE_MODE_4B_ADDR_256B_PAGE_PGM */
394
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000395 if (protocol(dp_data) >= PROTOCOL_V2) {
Nico Huber93db6e12018-09-30 01:18:43 +0200396 if (is_read && flash->chip->feature_bits & FEATURE_4BA_FAST_READ) {
397 data_packet[3] = READ_MODE_4B_ADDR_FAST_0x0C;
398 data_packet[4] = JEDEC_READ_4BA_FAST;
399 } else if (dedi_spi_cmd == WRITE_MODE_PAGE_PGM
400 && (flash->chip->feature_bits & FEATURE_4BA_WRITE)) {
Nico Huberfb176d22024-03-25 15:55:13 +0100401 if (protocol(dp_data) >= PROTOCOL_V3)
402 data_packet[3] = WRITE_MODE_4B_ADDR_256B_PAGE_PGM;
403 else
404 data_packet[3] = WRITE_MODE_4B_ADDR_256B_PAGE_PGM_0x12;
Nico Huber93db6e12018-09-30 01:18:43 +0200405 data_packet[4] = JEDEC_BYTE_PROGRAM_4BA;
406 }
407
Simon Glassae616512016-01-23 23:27:58 +0000408 *value = *idx = 0;
409 data_packet[5] = 0; /* RFU */
410 data_packet[6] = (start >> 0) & 0xff;
411 data_packet[7] = (start >> 8) & 0xff;
412 data_packet[8] = (start >> 16) & 0xff;
413 data_packet[9] = (start >> 24) & 0xff;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000414 if (protocol(dp_data) >= PROTOCOL_V3) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800415 if (is_read) {
416 data_packet[10] = 0x00; /* address length (3 or 4) */
417 data_packet[11] = 0x00; /* dummy cycle / 2 */
418 } else {
419 /* 16 LSBs and 16 HSBs of page size */
420 /* FIXME: This assumes page size of 256. */
421 data_packet[10] = 0x00;
422 data_packet[11] = 0x01;
423 data_packet[12] = 0x00;
424 data_packet[13] = 0x00;
425 }
426 }
Simon Glassae616512016-01-23 23:27:58 +0000427 } else {
Nico Huber9bb8a322022-05-24 15:07:34 +0200428 if (flash->chip->feature_bits & FEATURE_4BA_EAR_ANY) {
Nico Huber7eb38aa2019-03-21 15:42:54 +0100429 if (spi_set_extended_address(flash, start >> 24))
430 return 1;
431 } else if (start >> 24) {
432 msg_cerr("Can't handle 4-byte address with dediprog.\n");
433 return 1;
434 }
435 /*
436 * We don't know how the dediprog firmware handles 4-byte
437 * addresses. So let's not tell it what we are doing and
438 * only send the lower 3 bytes.
439 */
440 *value = start & 0xffff;
441 *idx = (start >> 16) & 0xff;
Simon Glassae616512016-01-23 23:27:58 +0000442 }
Nico Huber7eb38aa2019-03-21 15:42:54 +0100443
444 return 0;
Simon Glassae616512016-01-23 23:27:58 +0000445}
446
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000447/* Bulk read interface, will read multiple 512 byte chunks aligned to 512 bytes.
448 * @start start address
449 * @len length
450 * @return 0 on success, 1 on failure
451 */
Simon Glassae616512016-01-23 23:27:58 +0000452static 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 +0000453{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000454 int err = 1;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100455 const struct dediprog_data *dp_data = flash->mst.spi->data;
Nico Huberd99a2bd2016-02-18 21:42:49 +0000456
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000457 /* chunksize must be 512, other sizes will NOT work at all. */
Simon Glassae616512016-01-23 23:27:58 +0000458 const unsigned int chunksize = 512;
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000459 const unsigned int count = len / chunksize;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000460
Nico Huberd99a2bd2016-02-18 21:42:49 +0000461 struct dediprog_transfer_status status = { 0, 0, 0 };
462 struct libusb_transfer *transfers[DEDIPROG_ASYNC_TRANSFERS] = { NULL, };
463 struct libusb_transfer *transfer;
464
Nico Huberbbaa1712018-12-05 13:26:20 +0100465 if (len == 0)
466 return 0;
467
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000468 if ((start % chunksize) || (len % chunksize)) {
Nico Huberac90af62022-12-18 00:22:47 +0000469 msg_perr("%s: Unaligned start=%i, len=%i!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200470 "Please report a bug at flashprog@flashprog.org\n",
Simon Glassae616512016-01-23 23:27:58 +0000471 __func__, start, len);
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000472 return 1;
473 }
474
David Hendricksf73f8a72018-02-21 07:34:34 -0800475 int command_packet_size;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000476 switch (protocol(dp_data)) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800477 case PROTOCOL_V1:
478 command_packet_size = 5;
479 break;
480 case PROTOCOL_V2:
481 command_packet_size = 10;
482 break;
483 case PROTOCOL_V3:
484 command_packet_size = 12;
485 break;
486 default:
487 return 1;
488 }
489
490 uint8_t data_packet[command_packet_size];
Simon Glassae616512016-01-23 23:27:58 +0000491 unsigned int value, idx;
Nico Huber7eb38aa2019-03-21 15:42:54 +0100492 if (prepare_rw_cmd(flash, data_packet, count, READ_MODE_STD, &value, &idx, start, 1))
493 return 1;
Simon Glassae616512016-01-23 23:27:58 +0000494
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000495 int ret = dediprog_write(dp_data->handle, CMD_READ, value, idx, data_packet, sizeof(data_packet));
Nico Huber519be662018-12-23 20:03:35 +0100496 if (ret != (int)sizeof(data_packet)) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000497 msg_perr("Command Read SPI Bulk failed, %i %s!\n", ret, libusb_error_name(ret));
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000498 return 1;
499 }
500
Nico Huberd99a2bd2016-02-18 21:42:49 +0000501 /*
502 * Ring buffer of bulk transfers.
503 * Poll until at least one transfer is ready,
504 * schedule next transfers until buffer is full.
505 */
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000506
Nico Huberd99a2bd2016-02-18 21:42:49 +0000507 /* Allocate bulk transfers. */
508 unsigned int i;
Nico Huber519be662018-12-23 20:03:35 +0100509 for (i = 0; i < MIN(DEDIPROG_ASYNC_TRANSFERS, count); ++i) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000510 transfers[i] = libusb_alloc_transfer(0);
511 if (!transfers[i]) {
512 msg_perr("Allocating libusb transfer %i failed: %s!\n", i, libusb_error_name(ret));
513 goto err_free;
Elyes HAOUAS124ef382018-03-27 12:15:09 +0200514 }
515 }
Nico Huberd99a2bd2016-02-18 21:42:49 +0000516
517 /* Now transfer requested chunks using libusb's asynchronous interface. */
518 while (!status.error && (status.queued_idx < count)) {
Nico Huberf84df9a2016-05-04 13:24:07 +0200519 while ((status.queued_idx < count) &&
520 (status.queued_idx - status.finished_idx) < DEDIPROG_ASYNC_TRANSFERS)
521 {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000522 transfer = transfers[status.queued_idx % DEDIPROG_ASYNC_TRANSFERS];
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000523 libusb_fill_bulk_transfer(transfer, dp_data->handle, 0x80 | dp_data->in_endpoint,
Nico Huberd99a2bd2016-02-18 21:42:49 +0000524 (unsigned char *)buf + status.queued_idx * chunksize, chunksize,
525 dediprog_bulk_read_cb, &status, DEFAULT_TIMEOUT);
526 transfer->flags |= LIBUSB_TRANSFER_SHORT_NOT_OK;
527 ret = libusb_submit_transfer(transfer);
528 if (ret < 0) {
529 msg_perr("Submitting SPI bulk read %i failed: %s!\n",
530 status.queued_idx, libusb_error_name(ret));
531 goto err_free;
532 }
533 ++status.queued_idx;
534 }
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000535 if (dediprog_bulk_read_poll(dp_data->usb_ctx, &status, 0))
Nico Huberd99a2bd2016-02-18 21:42:49 +0000536 goto err_free;
537 }
538 /* Wait for transfers to finish. */
Rick Altherr4f9cd8b2021-12-13 17:10:00 -0800539 if (dediprog_bulk_read_poll(dp_data->usb_ctx, &status, 1))
Nico Huberd99a2bd2016-02-18 21:42:49 +0000540 goto err_free;
541 /* Check if everything has been transmitted. */
542 if ((status.finished_idx < count) || status.error)
543 goto err_free;
544
545 err = 0;
546
547err_free:
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000548 dediprog_bulk_read_poll(dp_data->usb_ctx, &status, 1);
Nico Huberd99a2bd2016-02-18 21:42:49 +0000549 for (i = 0; i < DEDIPROG_ASYNC_TRANSFERS; ++i)
550 if (transfers[i]) libusb_free_transfer(transfers[i]);
551 return err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000552}
553
Simon Glassae616512016-01-23 23:27:58 +0000554static int dediprog_spi_read(struct flashctx *flash, uint8_t *buf, unsigned int start, unsigned int len)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000555{
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000556 int ret;
557 /* chunksize must be 512, other sizes will NOT work at all. */
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000558 const unsigned int chunksize = 0x200;
Nico Huberbbaa1712018-12-05 13:26:20 +0100559 unsigned int residue = start % chunksize ? min(len, chunksize - start % chunksize) : 0;
Stefan Taunerc69c9c82011-11-23 09:13:48 +0000560 unsigned int bulklen;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100561 const struct dediprog_data *dp_data = flash->mst.spi->data;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000562
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000563 dediprog_set_leds(LED_BUSY, dp_data);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000564
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000565 if (residue) {
566 msg_pdbg("Slow read for partial block from 0x%x, length 0x%x\n",
567 start, residue);
Edward O'Callaghan317c67b2020-10-09 12:56:53 +1100568 ret = default_spi_read(flash, buf, start, residue);
Simon Glass25e9f402015-06-28 13:31:19 +0000569 if (ret)
570 goto err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000571 }
572
573 /* Round down. */
574 bulklen = (len - residue) / chunksize * chunksize;
Simon Glassae616512016-01-23 23:27:58 +0000575 ret = dediprog_spi_bulk_read(flash, buf + residue, start + residue, bulklen);
Simon Glass25e9f402015-06-28 13:31:19 +0000576 if (ret)
577 goto err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000578
579 len -= residue + bulklen;
Simon Glassae616512016-01-23 23:27:58 +0000580 if (len != 0) {
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000581 msg_pdbg("Slow read for partial block from 0x%x, length 0x%x\n",
582 start, len);
Edward O'Callaghan317c67b2020-10-09 12:56:53 +1100583 ret = default_spi_read(flash, buf + residue + bulklen,
584 start + residue + bulklen, len);
Simon Glass25e9f402015-06-28 13:31:19 +0000585 if (ret)
586 goto err;
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000587 }
588
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000589 dediprog_set_leds(LED_PASS, dp_data);
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +0000590 return 0;
Simon Glass25e9f402015-06-28 13:31:19 +0000591err:
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000592 dediprog_set_leds(LED_ERROR, dp_data);
Simon Glass25e9f402015-06-28 13:31:19 +0000593 return ret;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000594}
595
Nico Hubera4b14f72012-06-19 12:06:53 +0000596/* Bulk write interface, will write multiple chunksize byte chunks aligned to chunksize bytes.
597 * @chunksize length of data chunks, only 256 supported by now
598 * @start start address
599 * @len length
600 * @dedi_spi_cmd dediprog specific write command for spi bus
601 * @return 0 on success, 1 on failure
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000602 */
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000603static int dediprog_spi_bulk_write(struct flashctx *flash, const uint8_t *buf, unsigned int chunksize,
Nico Hubera4b14f72012-06-19 12:06:53 +0000604 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000605{
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000606 /* USB transfer size must be 512, other sizes will NOT work at all.
607 * chunksize is the real data size per USB bulk transfer. The remaining
608 * space in a USB bulk transfer must be filled with 0xff padding.
609 */
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000610 const unsigned int count = len / chunksize;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100611 const struct dediprog_data *dp_data = flash->mst.spi->data;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000612
Nico Hubera4b14f72012-06-19 12:06:53 +0000613 /*
614 * We should change this check to
615 * chunksize > 512
616 * once we know how to handle different chunk sizes.
617 */
618 if (chunksize != 256) {
619 msg_perr("%s: Chunk sizes other than 256 bytes are unsupported, chunksize=%u!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200620 "Please report a bug at flashprog@flashprog.org\n",
Nico Huberac90af62022-12-18 00:22:47 +0000621 __func__, chunksize);
Nico Hubera4b14f72012-06-19 12:06:53 +0000622 return 1;
623 }
624
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000625 if ((start % chunksize) || (len % chunksize)) {
Nico Huberac90af62022-12-18 00:22:47 +0000626 msg_perr("%s: Unaligned start=%i, len=%i!\n"
Nico Huberc3b02dc2023-08-12 01:13:45 +0200627 "Please report a bug at flashprog@flashprog.org\n",
Nico Huberac90af62022-12-18 00:22:47 +0000628 __func__, start, len);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000629 return 1;
630 }
631
632 /* No idea if the hardware can handle empty writes, so chicken out. */
Simon Glassae616512016-01-23 23:27:58 +0000633 if (len == 0)
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000634 return 0;
Simon Glassae616512016-01-23 23:27:58 +0000635
David Hendricksf73f8a72018-02-21 07:34:34 -0800636 int command_packet_size;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000637 switch (protocol(dp_data)) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800638 case PROTOCOL_V1:
639 command_packet_size = 5;
640 break;
641 case PROTOCOL_V2:
642 command_packet_size = 10;
643 break;
644 case PROTOCOL_V3:
645 command_packet_size = 14;
646 break;
647 default:
648 return 1;
649 }
650
651 uint8_t data_packet[command_packet_size];
Simon Glassae616512016-01-23 23:27:58 +0000652 unsigned int value, idx;
Nico Huber7eb38aa2019-03-21 15:42:54 +0100653 if (prepare_rw_cmd(flash, data_packet, count, dedi_spi_cmd, &value, &idx, start, 0))
654 return 1;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000655 int ret = dediprog_write(dp_data->handle, CMD_WRITE, value, idx, data_packet, sizeof(data_packet));
Nico Huber519be662018-12-23 20:03:35 +0100656 if (ret != (int)sizeof(data_packet)) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000657 msg_perr("Command Write SPI Bulk failed, %s!\n", libusb_error_name(ret));
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000658 return 1;
659 }
660
Simon Glassae616512016-01-23 23:27:58 +0000661 unsigned int i;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000662 for (i = 0; i < count; i++) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000663 unsigned char usbbuf[512];
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000664 memcpy(usbbuf, buf + i * chunksize, chunksize);
Simon Glassae616512016-01-23 23:27:58 +0000665 memset(usbbuf + chunksize, 0xff, sizeof(usbbuf) - chunksize); // fill up with 0xFF
Nico Huberd99a2bd2016-02-18 21:42:49 +0000666 int transferred;
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000667 ret = libusb_bulk_transfer(dp_data->handle, dp_data->out_endpoint, usbbuf, 512, &transferred,
Nico Huberd99a2bd2016-02-18 21:42:49 +0000668 DEFAULT_TIMEOUT);
669 if ((ret < 0) || (transferred != 512)) {
670 msg_perr("SPI bulk write failed, expected %i, got %s!\n", 512, libusb_error_name(ret));
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000671 return 1;
672 }
673 }
674
675 return 0;
676}
677
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000678static int dediprog_spi_write(struct flashctx *flash, const uint8_t *buf,
Nico Hubera4b14f72012-06-19 12:06:53 +0000679 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
Carl-Daniel Hailfinger306b8182010-11-23 21:28:16 +0000680{
Stefan Reinauer915b8402011-01-28 09:00:15 +0000681 int ret;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000682 const unsigned int chunksize = flash->chip->page_size;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000683 unsigned int residue = start % chunksize ? chunksize - start % chunksize : 0;
684 unsigned int bulklen;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100685 const struct dediprog_data *dp_data = flash->mst.spi->data;
Stefan Reinauer915b8402011-01-28 09:00:15 +0000686
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000687 dediprog_set_leds(LED_BUSY, dp_data);
Stefan Reinauer915b8402011-01-28 09:00:15 +0000688
Nico Hubera4b14f72012-06-19 12:06:53 +0000689 if (chunksize != 256) {
690 msg_pdbg("Page sizes other than 256 bytes are unsupported as "
691 "we don't know how dediprog\nhandles them.\n");
692 /* Write everything like it was residue. */
693 residue = len;
694 }
695
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000696 if (residue) {
697 msg_pdbg("Slow write for partial block from 0x%x, length 0x%x\n",
698 start, residue);
Nico Huber93db6e12018-09-30 01:18:43 +0200699 /* No idea about the real limit. Maybe 16 including command and address, maybe more. */
700 ret = spi_write_chunked(flash, buf, start, residue, 11);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000701 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000702 dediprog_set_leds(LED_ERROR, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000703 return ret;
704 }
705 }
Stefan Reinauer915b8402011-01-28 09:00:15 +0000706
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000707 /* Round down. */
708 bulklen = (len - residue) / chunksize * chunksize;
Nico Hubera4b14f72012-06-19 12:06:53 +0000709 ret = dediprog_spi_bulk_write(flash, buf + residue, chunksize, start + residue, bulklen, dedi_spi_cmd);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000710 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000711 dediprog_set_leds(LED_ERROR, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000712 return ret;
713 }
Stefan Reinauer915b8402011-01-28 09:00:15 +0000714
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000715 len -= residue + bulklen;
716 if (len) {
717 msg_pdbg("Slow write for partial block from 0x%x, length 0x%x\n",
718 start, len);
719 ret = spi_write_chunked(flash, buf + residue + bulklen,
Nico Huber93db6e12018-09-30 01:18:43 +0200720 start + residue + bulklen, len, 11);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000721 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000722 dediprog_set_leds(LED_ERROR, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000723 return ret;
724 }
725 }
726
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000727 dediprog_set_leds(LED_PASS, dp_data);
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000728 return 0;
Carl-Daniel Hailfinger306b8182010-11-23 21:28:16 +0000729}
730
Nico Hubera96aaa32024-03-05 12:56:13 +0100731static int dediprog_spi_write_chunked(struct flashctx *flash, const uint8_t *buf,
732 unsigned int start, unsigned int len, uint8_t dedi_spi_cmd)
733{
734 /* We can write only up to 65535 pages at once: */
735 while (len) {
736 const size_t len_here = MIN(len, flash->chip->page_size * MAX_BLOCK_COUNT);
737 const int ret = dediprog_spi_write(flash, buf, start, len_here, dedi_spi_cmd);
738 if (ret)
739 return ret;
740
741 start += len_here;
742 buf += len_here;
743 len -= len_here;
744 }
745 return 0;
746}
747
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000748static 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 +0000749{
Nico Hubera96aaa32024-03-05 12:56:13 +0100750 return dediprog_spi_write_chunked(flash, buf, start, len, WRITE_MODE_PAGE_PGM);
Nico Hubera4b14f72012-06-19 12:06:53 +0000751}
752
Stefan Taunerffb0cf62014-05-25 07:47:47 +0000753static 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 +0000754{
Nico Hubera96aaa32024-03-05 12:56:13 +0100755 return dediprog_spi_write_chunked(flash, buf, start, len, WRITE_MODE_2B_AAI);
Nico Hubera4b14f72012-06-19 12:06:53 +0000756}
757
Edward O'Callaghan5eca4272020-04-12 17:27:53 +1000758static int dediprog_spi_send_command(const struct flashctx *flash,
Carl-Daniel Hailfinger8a3c60c2011-12-18 15:01:24 +0000759 unsigned int writecnt,
760 unsigned int readcnt,
761 const unsigned char *writearr,
762 unsigned char *readarr)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000763{
764 int ret;
Nico Huber9a11cbf2023-01-13 01:19:07 +0100765 const struct dediprog_data *dp_data = flash->mst.spi->data;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000766
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000767 msg_pspew("%s, writecnt=%i, readcnt=%i\n", __func__, writecnt, readcnt);
Nico Huber9a11cbf2023-01-13 01:19:07 +0100768 if (writecnt > flash->mst.spi->max_data_write) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000769 msg_perr("Invalid writecnt=%i, aborting.\n", writecnt);
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000770 return 1;
771 }
Nico Huber9a11cbf2023-01-13 01:19:07 +0100772 if (readcnt > flash->mst.spi->max_data_read) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000773 msg_perr("Invalid readcnt=%i, aborting.\n", readcnt);
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000774 return 1;
775 }
Elyes HAOUAS0cacb112019-02-04 12:16:38 +0100776
Simon Glassae616512016-01-23 23:27:58 +0000777 unsigned int idx, value;
778 /* New protocol has options and timeout combined as value while the old one used the value field for
779 * timeout and the index field for options. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000780 if (protocol(dp_data) >= PROTOCOL_V2) {
Simon Glassae616512016-01-23 23:27:58 +0000781 idx = 0;
782 value = readcnt ? 0x1 : 0x0; // Indicate if we require a read
783 } else {
784 idx = readcnt ? 0x1 : 0x0; // Indicate if we require a read
785 value = 0;
786 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000787 ret = dediprog_write(dp_data->handle, CMD_TRANSCEIVE, value, idx, writearr, writecnt);
Nico Huber519be662018-12-23 20:03:35 +0100788 if (ret != (int)writecnt) {
Carl-Daniel Hailfingereac65792010-01-22 02:53:30 +0000789 msg_perr("Send SPI failed, expected %i, got %i %s!\n",
Nico Huberd99a2bd2016-02-18 21:42:49 +0000790 writecnt, ret, libusb_error_name(ret));
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000791 return 1;
792 }
Simon Glassae616512016-01-23 23:27:58 +0000793 if (readcnt == 0) // If we don't require a response, we are done here
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000794 return 0;
Simon Glass557eb4f2015-07-05 16:53:22 +0000795
Stefan Tauner74367bf2016-02-20 20:53:46 +0000796 /* The specifications do state the possibility to set a timeout for transceive transactions.
797 * Apparently the "timeout" is a delay, and you can use long delays to accelerate writing - in case you
798 * can predict the time needed by the previous command or so (untested). In any case, using this
799 * "feature" to set sane-looking timouts for the read below will completely trash performance with
800 * SF600 and/or firmwares >= 6.0 while they seem to be benign on SF100 with firmwares <= 5.5.2. *shrug*
801 *
802 * The specification also uses only 0 in its examples, so the lesson to learn here:
803 * "Never trust the description of an interface in the documentation but use the example code and pray."
Simon Glassae616512016-01-23 23:27:58 +0000804 const uint8_t read_timeout = 10 + readcnt/512;
David Hendricksf73f8a72018-02-21 07:34:34 -0800805 if (protocol() >= PROTOCOL_V2) {
Simon Glassae616512016-01-23 23:27:58 +0000806 idx = 0;
807 value = min(read_timeout, 0xFF) | (0 << 8) ; // Timeout in lower byte, option in upper byte
808 } else {
809 idx = (0 & 0xFF); // Lower byte is option (0x01 = require SR, 0x02 keep CS low)
810 value = min(read_timeout, 0xFF); // Possibly two bytes but we play safe here
811 }
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000812 ret = dediprog_read(dp_data->dediprog_handle, CMD_TRANSCEIVE, value, idx, readarr, readcnt);
Stefan Tauner74367bf2016-02-20 20:53:46 +0000813 */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000814 ret = dediprog_read(dp_data->handle, CMD_TRANSCEIVE, 0, 0, readarr, readcnt);
Nico Huber519be662018-12-23 20:03:35 +0100815 if (ret != (int)readcnt) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000816 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 +0000817 return 1;
818 }
819 return 0;
820}
821
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000822static int dediprog_check_devicestring(struct dediprog_data *dp_data)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000823{
Nico Huber5262e292024-03-02 13:21:25 +0100824 const int devstr_len = 32, old_devstr_len = 16;
Nico Hubere76e21f2024-02-29 23:33:35 +0100825 char buf[devstr_len + 1];
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000826 int ret;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000827
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000828 /* Command Receive Device String. */
Nico Hubere76e21f2024-02-29 23:33:35 +0100829 ret = dediprog_read(dp_data->handle, CMD_READ_PROG_INFO, 0, 0, (uint8_t *)buf, devstr_len);
Nico Huber5262e292024-03-02 13:21:25 +0100830 if (ret < old_devstr_len || ret > devstr_len) {
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000831 msg_perr("Incomplete/failed Command Receive Device String!\n");
832 return 1;
833 }
Nico Huber5262e292024-03-02 13:21:25 +0100834 buf[ret] = '\0';
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000835 msg_pdbg("Found a %s\n", buf);
Nico Hubere76e21f2024-02-29 23:33:35 +0100836 if (memcmp(buf, "SF100", 5) == 0)
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000837 dp_data->devicetype = DEV_SF100;
Nico Hubere76e21f2024-02-29 23:33:35 +0100838 else if (memcmp(buf, "SF200", 5) == 0)
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000839 dp_data->devicetype = DEV_SF200;
Nico Huber00578222024-03-02 14:00:53 +0100840 else if (memcmp(buf, "SF600PG2", 8) == 0) /* match first, before shorter, generic SF600 */
841 dp_data->devicetype = DEV_SF600PG2;
Nico Hubere76e21f2024-02-29 23:33:35 +0100842 else if (memcmp(buf, "SF600", 5) == 0)
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000843 dp_data->devicetype = DEV_SF600;
Nico Huber00578222024-03-02 14:00:53 +0100844 else if (memcmp(buf, "SF700", 5) == 0)
845 dp_data->devicetype = DEV_SF700;
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000846 else {
Nico Huber00578222024-03-02 14:00:53 +0100847 msg_perr("Device not a SF100, SF200, SF600(Plus(-G2)), or SF700!\n");
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000848 return 1;
849 }
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000850
Nico Huberbdef5c22024-03-02 13:51:39 +0100851 unsigned int sfnum;
852 unsigned int fw[3];
Nico Huber0ab5c3d2024-03-02 13:53:16 +0100853 if (sscanf(buf, "SF%u", &sfnum) != 1 ||
Nico Huber00578222024-03-02 14:00:53 +0100854 sfnum != dp_data->devicetype / 100 * 100 ||
Nico Huber0ab5c3d2024-03-02 13:53:16 +0100855 sscanf(buf, "SF%*s V:%u.%u.%u ", &fw[0], &fw[1], &fw[2]) != 3) {
Simon Glassae616512016-01-23 23:27:58 +0000856 msg_perr("Unexpected firmware version string '%s'\n", buf);
Mathias Krausedb7afc52010-11-09 23:30:43 +0000857 return 1;
858 }
Nico Huber00578222024-03-02 14:00:53 +0100859
860 /* Only allow major versions that were tested. */
861 if ((dp_data->devicetype == DEV_SF600PG2 && fw[0] > 1) ||
862 (dp_data->devicetype == DEV_SF700 && fw[0] != 4) ||
863 (dp_data->devicetype <= DEV_SF600 && (fw[0] < 2 || fw[0] > 7))) {
Simon Glassae616512016-01-23 23:27:58 +0000864 msg_perr("Unexpected firmware version %d.%d.%d!\n", fw[0], fw[1], fw[2]);
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000865 return 1;
866 }
David Hendricksf73f8a72018-02-21 07:34:34 -0800867
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000868 dp_data->firmwareversion = FIRMWARE_VERSION(fw[0], fw[1], fw[2]);
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000869 if (protocol(dp_data) == PROTOCOL_UNKNOWN) {
David Hendricksf73f8a72018-02-21 07:34:34 -0800870 msg_perr("Internal error: Unable to determine protocol version.\n");
871 return 1;
872 }
Simon Glassae616512016-01-23 23:27:58 +0000873
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000874 return 0;
875}
876
David Hendricksc05900f2016-02-18 21:42:41 +0000877/*
Ryan O'Leary301ae222019-06-24 19:14:33 -0700878 * Read the id from the dediprog. This should return the numeric part of the
879 * serial number found on a sticker on the back of the dediprog. Note this
880 * number is stored in writable eeprom, so it could get out of sync. Also note,
881 * this function only supports SF100 at this time, but SF600 support is not too
882 * much different.
883 * @return the id on success, -1 on failure
884 */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000885static int dediprog_read_id(libusb_device_handle *dediprog_handle)
Ryan O'Leary301ae222019-06-24 19:14:33 -0700886{
887 int ret;
888 uint8_t buf[3];
889
890 ret = libusb_control_transfer(dediprog_handle, REQTYPE_OTHER_IN,
891 0x7, /* request */
892 0, /* value */
893 0xEF00, /* index */
894 buf, sizeof(buf),
895 DEFAULT_TIMEOUT);
896 if (ret != sizeof(buf)) {
897 msg_perr("Failed to read dediprog id, error %d!\n", ret);
898 return -1;
899 }
900
901 return buf[0] << 16 | buf[1] << 8 | buf[2];
902}
903
904/*
David Hendricksc05900f2016-02-18 21:42:41 +0000905 * This command presumably sets the voltage for the SF100 itself (not the
906 * SPI flash). Only use this command with firmware older than V6.0.0. Newer
907 * (including all SF600s) do not support it.
908 */
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000909
David Hendricksc05900f2016-02-18 21:42:41 +0000910/* This command presumably sets the voltage for the SF100 itself (not the SPI flash).
911 * Only use dediprog_set_voltage on SF100 programmers with firmware older
912 * than V6.0.0. Newer programmers (including all SF600s) do not support it. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000913static int dediprog_set_voltage(libusb_device_handle *dediprog_handle)
David Hendricksc05900f2016-02-18 21:42:41 +0000914{
Nico Huberd99a2bd2016-02-18 21:42:49 +0000915 unsigned char buf[1] = {0};
916 int ret = libusb_control_transfer(dediprog_handle, REQTYPE_OTHER_IN, CMD_SET_VOLTAGE, 0x0, 0x0,
Simon Glass557eb4f2015-07-05 16:53:22 +0000917 buf, 0x1, DEFAULT_TIMEOUT);
Mathias Krausedb7afc52010-11-09 23:30:43 +0000918 if (ret < 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000919 msg_perr("Command Set Voltage failed (%s)!\n", libusb_error_name(ret));
Mathias Krausedb7afc52010-11-09 23:30:43 +0000920 return 1;
921 }
David Hendricksc05900f2016-02-18 21:42:41 +0000922 if ((ret != 1) || (buf[0] != 0x6f)) {
Simon Glass557eb4f2015-07-05 16:53:22 +0000923 msg_perr("Unexpected response to init!\n");
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000924 return 1;
925 }
David Hendricksc05900f2016-02-18 21:42:41 +0000926
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000927 return 0;
928}
929
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000930static int dediprog_standalone_mode(const struct dediprog_data *dp_data)
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000931{
932 int ret;
933
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000934 if (dp_data->devicetype != DEV_SF600)
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000935 return 0;
936
937 msg_pdbg2("Disabling standalone mode.\n");
Anastasia Klimchuk7d973882021-07-14 09:33:50 +1000938 ret = dediprog_write(dp_data->handle, CMD_SET_STANDALONE, LEAVE_STANDALONE_MODE, 0, NULL, 0);
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000939 if (ret) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000940 msg_perr("Failed to disable standalone mode: %s\n", libusb_error_name(ret));
David Woodhouse7f3b89f2016-02-18 21:42:15 +0000941 return 1;
942 }
943
944 return 0;
945}
946
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000947#if 0
948/* Something.
949 * Present in eng_detect_blink.log with firmware 3.1.8
950 * Always preceded by Command Receive Device String
951 */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000952static int dediprog_command_b(libusb_device_handle *dediprog_handle)
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000953{
954 int ret;
955 char buf[0x3];
956
Simon Glass557eb4f2015-07-05 16:53:22 +0000957 ret = usb_control_msg(dediprog_handle, REQTYPE_OTHER_IN, 0x7, 0x0, 0xef00,
958 buf, 0x3, DEFAULT_TIMEOUT);
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000959 if (ret < 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000960 msg_perr("Command B failed (%s)!\n", libusb_error_name(ret));
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000961 return 1;
962 }
963 if ((ret != 0x3) || (buf[0] != 0xff) || (buf[1] != 0xff) ||
964 (buf[2] != 0xff)) {
965 msg_perr("Unexpected response to Command B!\n");
966 return 1;
967 }
968
969 return 0;
970}
971#endif
972
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000973static int set_target_flash(libusb_device_handle *dediprog_handle, enum dediprog_target target)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000974{
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000975 int ret = dediprog_write(dediprog_handle, CMD_SET_TARGET, target, 0, NULL, 0);
Simon Glass557eb4f2015-07-05 16:53:22 +0000976 if (ret != 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000977 msg_perr("set_target_flash failed (%s)!\n", libusb_error_name(ret));
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000978 return 1;
979 }
980 return 0;
981}
982
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000983#if 0
Simon Glass557eb4f2015-07-05 16:53:22 +0000984/* Returns true if the button is currently pressed. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +1000985static bool dediprog_get_button(libusb_device_handle *dediprog_handle)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000986{
Simon Glass557eb4f2015-07-05 16:53:22 +0000987 char buf[1];
988 int ret = usb_control_msg(dediprog_handle, REQTYPE_EP_IN, CMD_GET_BUTTON, 0, 0,
989 buf, 0x1, DEFAULT_TIMEOUT);
990 if (ret != 0) {
Nico Huberd99a2bd2016-02-18 21:42:49 +0000991 msg_perr("Could not get button state (%s)!\n", libusb_error_name(ret));
Carl-Daniel Hailfingerff30d8a2011-01-20 21:05:15 +0000992 return 1;
993 }
Simon Glass557eb4f2015-07-05 16:53:22 +0000994 return buf[0] != 1;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +0000995}
Carl-Daniel Hailfingerad3cc552010-07-03 11:02:10 +0000996#endif
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +0000997
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +0000998static int parse_voltage(char *voltage)
999{
1000 char *tmp = NULL;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001001 int i;
1002 int millivolt = 0, fraction = 0;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001003
1004 if (!voltage || !strlen(voltage)) {
1005 msg_perr("Empty voltage= specified.\n");
1006 return -1;
1007 }
1008 millivolt = (int)strtol(voltage, &tmp, 0);
1009 voltage = tmp;
1010 /* Handle "," and "." as decimal point. Everything after it is assumed
1011 * to be in decimal notation.
1012 */
1013 if ((*voltage == '.') || (*voltage == ',')) {
1014 voltage++;
1015 for (i = 0; i < 3; i++) {
1016 fraction *= 10;
1017 /* Don't advance if the current character is invalid,
1018 * but continue multiplying.
1019 */
1020 if ((*voltage < '0') || (*voltage > '9'))
1021 continue;
1022 fraction += *voltage - '0';
1023 voltage++;
1024 }
1025 /* Throw away remaining digits. */
1026 voltage += strspn(voltage, "0123456789");
1027 }
1028 /* The remaining string must be empty or "mV" or "V". */
1029 tolower_string(voltage);
1030
1031 /* No unit or "V". */
1032 if ((*voltage == '\0') || !strncmp(voltage, "v", 1)) {
1033 millivolt *= 1000;
1034 millivolt += fraction;
1035 } else if (!strncmp(voltage, "mv", 2) ||
1036 !strncmp(voltage, "milliv", 6)) {
1037 /* No adjustment. fraction is discarded. */
1038 } else {
1039 /* Garbage at the end of the string. */
1040 msg_perr("Garbage voltage= specified.\n");
1041 return -1;
1042 }
1043 return millivolt;
1044}
1045
Anastasia Klimchukc63d9182021-07-06 16:18:44 +10001046static int dediprog_shutdown(void *data);
1047
Nico Huber93db6e12018-09-30 01:18:43 +02001048static struct spi_master spi_master_dediprog = {
Nico Huberdc5af542018-12-22 16:54:59 +01001049 .features = SPI_MASTER_NO_4BA_MODES,
Simon Glassae616512016-01-23 23:27:58 +00001050 .max_data_read = 16, /* 18 seems to work fine as well, but 19 times out sometimes with FW 5.15. */
1051 .max_data_write = 16,
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001052 .command = dediprog_spi_send_command,
1053 .multicommand = default_spi_send_multicommand,
1054 .read = dediprog_spi_read,
1055 .write_256 = dediprog_spi_write_256,
Nico Hubera4b14f72012-06-19 12:06:53 +00001056 .write_aai = dediprog_spi_write_aai,
Anastasia Klimchukc63d9182021-07-06 16:18:44 +10001057 .shutdown = dediprog_shutdown,
Aarya Chaumal0cea7532022-07-04 18:21:50 +05301058 .probe_opcode = default_spi_probe_opcode,
Michael Karcherb9dbe482011-05-11 17:07:07 +00001059};
1060
Ryan O'Leary301ae222019-06-24 19:14:33 -07001061/*
1062 * Open a dediprog_handle with the USB device at the given index.
1063 * @index index of the USB device
1064 * @return 0 for success, -1 for error, -2 for busy device
1065 */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001066static int dediprog_open(int index, struct dediprog_data *dp_data)
Ryan O'Leary301ae222019-06-24 19:14:33 -07001067{
1068 const uint16_t vid = devs_dediprog[0].vendor_id;
1069 const uint16_t pid = devs_dediprog[0].device_id;
1070 int ret;
1071
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001072 dp_data->handle = usb_dev_get_by_vid_pid_number(dp_data->usb_ctx, vid, pid, (unsigned int) index);
1073 if (!dp_data->handle) {
Ryan O'Leary301ae222019-06-24 19:14:33 -07001074 msg_perr("Could not find a Dediprog programmer on USB.\n");
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001075 libusb_exit(dp_data->usb_ctx);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001076 return -1;
1077 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001078 ret = libusb_set_configuration(dp_data->handle, 1);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001079 if (ret != 0) {
1080 msg_perr("Could not set USB device configuration: %i %s\n",
1081 ret, libusb_error_name(ret));
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001082 libusb_close(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001083 return -2;
1084 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001085 ret = libusb_claim_interface(dp_data->handle, 0);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001086 if (ret < 0) {
1087 msg_perr("Could not claim USB device interface %i: %i %s\n",
1088 0, ret, libusb_error_name(ret));
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001089 libusb_close(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001090 return -2;
1091 }
1092 return 0;
1093}
1094
David Hendricks8bb20212011-06-14 01:35:36 +00001095static int dediprog_shutdown(void *data)
1096{
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001097 int ret = 0;
1098 struct dediprog_data *dp_data = data;
Carl-Daniel Hailfinger64204b52011-12-20 01:54:19 +00001099
David Hendricks8bb20212011-06-14 01:35:36 +00001100 /* URB 28. Command Set SPI Voltage to 0. */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001101 if (dediprog_set_spi_voltage(dp_data->handle, 0x0)) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001102 ret = 1;
1103 goto out;
David Hendricks8bb20212011-06-14 01:35:36 +00001104 }
Nico Huberd99a2bd2016-02-18 21:42:49 +00001105
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001106 if (libusb_release_interface(dp_data->handle, 0)) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001107 msg_perr("Could not release USB interface!\n");
1108 ret = 1;
1109 goto out;
1110 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001111 libusb_close(dp_data->handle);
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001112 libusb_exit(dp_data->usb_ctx);
1113out:
1114 free(data);
1115 return ret;
David Hendricks8bb20212011-06-14 01:35:36 +00001116}
1117
Nico Hubere3a26882023-01-11 21:45:51 +01001118static int dediprog_init(struct flashprog_programmer *const prog)
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001119{
Ryan O'Leary301ae222019-06-24 19:14:33 -07001120 char *voltage, *id_str, *device, *spispeed, *target_str;
Patrick Georgiefe2d432013-05-23 21:47:46 +00001121 int spispeed_idx = 1;
Carl-Daniel Hailfinger082c8b52011-08-15 19:54:20 +00001122 int millivolt = 3500;
Ryan O'Leary301ae222019-06-24 19:14:33 -07001123 int id = -1; /* -1 defaults to enumeration order */
1124 int found_id;
Nathan Laredo21541a62012-12-24 22:07:36 +00001125 long usedevice = 0;
Nico Huber5e5e8212016-05-04 12:27:58 +02001126 long target = FLASH_TYPE_APPLICATION_FLASH_1;
Nico Huber77fa67d2013-02-20 18:03:36 +00001127 int i, ret;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001128
Nico Huber77fa67d2013-02-20 18:03:36 +00001129 spispeed = extract_programmer_param("spispeed");
1130 if (spispeed) {
1131 for (i = 0; spispeeds[i].name; ++i) {
1132 if (!strcasecmp(spispeeds[i].name, spispeed)) {
1133 spispeed_idx = i;
1134 break;
1135 }
1136 }
1137 if (!spispeeds[i].name) {
Patrick Georgiefe2d432013-05-23 21:47:46 +00001138 msg_perr("Error: Invalid spispeed value: '%s'.\n", spispeed);
Nico Huber77fa67d2013-02-20 18:03:36 +00001139 free(spispeed);
1140 return 1;
1141 }
1142 free(spispeed);
1143 }
Simon Glass557eb4f2015-07-05 16:53:22 +00001144
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001145 voltage = extract_programmer_param("voltage");
1146 if (voltage) {
1147 millivolt = parse_voltage(voltage);
1148 free(voltage);
Uwe Hermann91f4afa2011-07-28 08:13:25 +00001149 if (millivolt < 0)
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001150 return 1;
Carl-Daniel Hailfingerc2441382010-11-09 22:00:31 +00001151 msg_pinfo("Setting voltage to %i mV\n", millivolt);
1152 }
1153
Ryan O'Leary301ae222019-06-24 19:14:33 -07001154 id_str = extract_programmer_param("id");
1155 if (id_str) {
1156 char prefix0, prefix1;
1157 if (sscanf(id_str, "%c%c%d", &prefix0, &prefix1, &id) != 3) {
1158 msg_perr("Error: Could not parse dediprog 'id'.\n");
1159 msg_perr("Expected a string like SF012345 or DP012345.\n");
1160 free(id_str);
1161 return 1;
1162 }
1163 if (id < 0 || id >= 0x1000000) {
1164 msg_perr("Error: id %s is out of range!\n", id_str);
1165 free(id_str);
1166 return 1;
1167 }
1168 if (!(prefix0 == 'S' && prefix1 == 'F') && !(prefix0 == 'D' && prefix1 == 'P')) {
1169 msg_perr("Error: %s is an invalid id!\n", id_str);
1170 free(id_str);
1171 return 1;
1172 }
1173 msg_pinfo("Will search for dediprog id %s.\n", id_str);
1174 }
1175 free(id_str);
1176
Nathan Laredo21541a62012-12-24 22:07:36 +00001177 device = extract_programmer_param("device");
1178 if (device) {
1179 char *dev_suffix;
Ryan O'Leary301ae222019-06-24 19:14:33 -07001180 if (id != -1) {
1181 msg_perr("Error: Cannot use 'id' and 'device'.\n");
1182 }
Nathan Laredo21541a62012-12-24 22:07:36 +00001183 errno = 0;
1184 usedevice = strtol(device, &dev_suffix, 10);
1185 if (errno != 0 || device == dev_suffix) {
1186 msg_perr("Error: Could not convert 'device'.\n");
1187 free(device);
1188 return 1;
1189 }
Nico Huber961f4a12019-10-04 17:34:22 +02001190 if (usedevice < 0 || usedevice > INT_MAX) {
Nathan Laredo21541a62012-12-24 22:07:36 +00001191 msg_perr("Error: Value for 'device' is out of range.\n");
1192 free(device);
1193 return 1;
1194 }
1195 if (strlen(dev_suffix) > 0) {
1196 msg_perr("Error: Garbage following 'device' value.\n");
1197 free(device);
1198 return 1;
1199 }
1200 msg_pinfo("Using device %li.\n", usedevice);
1201 }
1202 free(device);
1203
Stefan Taunere659d2d2013-05-03 21:58:28 +00001204 target_str = extract_programmer_param("target");
1205 if (target_str) {
1206 char *target_suffix;
1207 errno = 0;
1208 target = strtol(target_str, &target_suffix, 10);
1209 if (errno != 0 || target_str == target_suffix) {
1210 msg_perr("Error: Could not convert 'target'.\n");
1211 free(target_str);
1212 return 1;
1213 }
1214 if (target < 1 || target > 2) {
1215 msg_perr("Error: Value for 'target' is out of range.\n");
1216 free(target_str);
1217 return 1;
1218 }
1219 if (strlen(target_suffix) > 0) {
1220 msg_perr("Error: Garbage following 'target' value.\n");
1221 free(target_str);
1222 return 1;
1223 }
Nico Huber5e5e8212016-05-04 12:27:58 +02001224 switch (target) {
1225 case 1:
1226 msg_pinfo("Using target %s.\n", "FLASH_TYPE_APPLICATION_FLASH_1");
1227 target = FLASH_TYPE_APPLICATION_FLASH_1;
1228 break;
1229 case 2:
1230 msg_pinfo("Using target %s.\n", "FLASH_TYPE_APPLICATION_FLASH_2");
1231 target = FLASH_TYPE_APPLICATION_FLASH_2;
1232 break;
1233 default:
1234 break;
1235 }
Stefan Taunere659d2d2013-05-03 21:58:28 +00001236 }
1237 free(target_str);
1238
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001239 struct dediprog_data *dp_data = calloc(1, sizeof(*dp_data));
1240 if (!dp_data) {
1241 msg_perr("Unable to allocate space for SPI master data\n");
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001242 return 1;
1243 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001244 dp_data->firmwareversion = FIRMWARE_VERSION(0, 0, 0);
1245 dp_data->devicetype = DEV_UNKNOWN;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001246
1247 /* Here comes the USB stuff. */
Thomas Heijligen88e87c52022-08-05 17:56:20 +02001248 ret = libusb_init(&dp_data->usb_ctx);
1249 if (ret) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001250 msg_perr("Could not initialize libusb!\n");
1251 goto init_err_exit;
1252 }
Stefan Taunerfdec7472016-02-22 08:59:27 +00001253
Ryan O'Leary301ae222019-06-24 19:14:33 -07001254 if (id != -1) {
1255 for (i = 0; ; i++) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001256 ret = dediprog_open(i, dp_data);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001257 if (ret == -1) {
1258 /* no dev */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001259 goto init_err_exit;
Ryan O'Leary301ae222019-06-24 19:14:33 -07001260 } else if (ret == -2) {
1261 /* busy dev */
1262 continue;
1263 }
1264
1265 /* Notice we can only call dediprog_read_id() after
1266 * libusb_set_configuration() and
1267 * libusb_claim_interface(). When searching by id and
1268 * either configuration or claim fails (usually the
Nico Huberc3b02dc2023-08-12 01:13:45 +02001269 * device is in use by another instance of flashprog),
Ryan O'Leary301ae222019-06-24 19:14:33 -07001270 * the device is skipped and the next device is tried.
1271 */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001272 found_id = dediprog_read_id(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001273 if (found_id < 0) {
1274 msg_perr("Could not read id.\n");
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001275 libusb_release_interface(dp_data->handle, 0);
1276 libusb_close(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001277 continue;
1278 }
1279 msg_pinfo("Found dediprog id SF%06d.\n", found_id);
1280 if (found_id != id) {
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001281 libusb_release_interface(dp_data->handle, 0);
1282 libusb_close(dp_data->handle);
Ryan O'Leary301ae222019-06-24 19:14:33 -07001283 continue;
1284 }
1285 break;
1286 }
1287 } else {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001288 if (dediprog_open(usedevice, dp_data)) {
1289 goto init_err_exit;
Ryan O'Leary301ae222019-06-24 19:14:33 -07001290 }
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001291 found_id = dediprog_read_id(dp_data->handle);
David Woodhoused2a7e872013-07-30 09:34:44 +00001292 }
Ryan O'Leary301ae222019-06-24 19:14:33 -07001293
1294 if (found_id >= 0) {
1295 msg_pinfo("Using dediprog id SF%06d.\n", found_id);
Carl-Daniel Hailfinger482e9742010-11-16 21:25:29 +00001296 }
Nico Huber77fa67d2013-02-20 18:03:36 +00001297
David Hendricksc05900f2016-02-18 21:42:41 +00001298 /* Try reading the devicestring. If that fails and the device is old (FW < 6.0.0, which we can not know)
1299 * then we need to try the "set voltage" command and then attempt to read the devicestring again. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001300 if (dediprog_check_devicestring(dp_data)) {
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001301 if (dediprog_set_voltage(dp_data->handle))
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001302 goto init_err_cleanup_exit;
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001303 if (dediprog_check_devicestring(dp_data))
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001304 goto init_err_cleanup_exit;
David Hendricksc05900f2016-02-18 21:42:41 +00001305 }
Nico Huber77fa67d2013-02-20 18:03:36 +00001306
Jay Thompsoncabe3202018-08-17 14:30:04 -05001307 /* SF100/SF200 uses one in/out endpoint, SF600 uses separate in/out endpoints */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001308 dp_data->in_endpoint = 2;
1309 switch (dp_data->devicetype) {
Jay Thompsoncabe3202018-08-17 14:30:04 -05001310 case DEV_SF100:
1311 case DEV_SF200:
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001312 dp_data->out_endpoint = 2;
Jay Thompsoncabe3202018-08-17 14:30:04 -05001313 break;
1314 default:
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001315 dp_data->out_endpoint = 1;
Jay Thompsoncabe3202018-08-17 14:30:04 -05001316 break;
1317 }
David Woodhouse7f3b89f2016-02-18 21:42:15 +00001318
Simon Glass25e9f402015-06-28 13:31:19 +00001319 /* Set all possible LEDs as soon as possible to indicate activity.
1320 * Because knowing the firmware version is required to set the LEDs correctly we need to this after
David Hendricksf73f8a72018-02-21 07:34:34 -08001321 * dediprog_check_devicestring() has queried the device. */
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001322 dediprog_set_leds(LED_ALL, dp_data);
Simon Glass25e9f402015-06-28 13:31:19 +00001323
Simon Glass557eb4f2015-07-05 16:53:22 +00001324 /* Select target/socket, frequency and VCC. */
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001325 if (set_target_flash(dp_data->handle, target) ||
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001326 dediprog_set_spi_speed(spispeed_idx, dp_data) ||
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001327 dediprog_set_spi_voltage(dp_data->handle, millivolt)) {
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001328 dediprog_set_leds(LED_ERROR, dp_data);
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001329 goto init_err_cleanup_exit;
Stefan Reinauer915b8402011-01-28 09:00:15 +00001330 }
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001331
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001332 if (dediprog_standalone_mode(dp_data))
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001333 goto init_err_cleanup_exit;
David Woodhouse7f3b89f2016-02-18 21:42:15 +00001334
Anastasia Klimchuk7d973882021-07-14 09:33:50 +10001335 if ((dp_data->devicetype == DEV_SF100) ||
1336 (dp_data->devicetype == DEV_SF600 && protocol(dp_data) == PROTOCOL_V3))
Nico Huber7eb38aa2019-03-21 15:42:54 +01001337 spi_master_dediprog.features &= ~SPI_MASTER_NO_4BA_MODES;
1338
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001339 if (protocol(dp_data) >= PROTOCOL_V2)
Nico Huber93db6e12018-09-30 01:18:43 +02001340 spi_master_dediprog.features |= SPI_MASTER_4BA;
1341
Angel Pons116d56d2021-03-22 11:28:00 +01001342 if (dediprog_set_leds(LED_NONE, dp_data))
1343 goto init_err_cleanup_exit;
Stefan Reinauer915b8402011-01-28 09:00:15 +00001344
Nico Huber89569d62023-01-12 23:31:40 +01001345 return register_spi_master(&spi_master_dediprog, 0, dp_data);
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001346
1347init_err_cleanup_exit:
Anastasia Klimchukb31f7ac2021-07-12 14:18:37 +10001348 dediprog_shutdown(dp_data);
1349 return 1;
1350
1351init_err_exit:
1352 free(dp_data);
Anastasia Klimchuk66e04562021-06-28 17:03:52 +10001353 return 1;
Carl-Daniel Hailfingerd38fac82010-01-19 11:15:48 +00001354}
Thomas Heijligencc853d82021-05-04 15:32:17 +02001355
1356const struct programmer_entry programmer_dediprog = {
1357 .name = "dediprog",
1358 .type = USB,
1359 .devs.dev = devs_dediprog,
1360 .init = dediprog_init,
Thomas Heijligencc853d82021-05-04 15:32:17 +02001361};