1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
|
/*
* This file is part of the flashrom project.
*
* Copyright 2014, Google Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* Alternatively, this software may be distributed under the terms of the
* GNU General Public License ("GPL") version 2 as published by the Free
* Software Foundation.
*/
/*
* This SPI flash programming interface is designed to talk to a Chromium OS
* device over a Raiden USB connection. The USB connection is routed to a
* microcontroller running an image compiled from:
*
* https://chromium.googlesource.com/chromiumos/platform/ec
*
* The protocol for the USB-SPI bridge is documented in the following file in
* that respository:
*
* chip/stm32/usb_spi.c
*
* Version 1:
* SPI transactions of up to 62B in each direction with every command having
* a response. The initial packet from host contains a 2B header indicating
* write and read counts with an optional payload length equal to the write
* count. The device will respond with a message that reports the 2B status
* code and an optional payload response length equal to read count.
*
* Message Format:
*
* Command Packet:
* +------------------+-----------------+------------------------+
* | write count : 1B | read count : 1B | write payload : <= 62B |
* +------------------+-----------------+------------------------+
*
* write count: 1 byte, zero based count of bytes to write
*
* read count: 1 byte, zero based count of bytes to read
*
* write payload: Up to 62 bytes of data to write to SPI, the total
* length of all TX packets must match write count.
* Due to data alignment constraints, this must be an
* even number of bytes unless this is the final packet.
*
* Response Packet:
* +-------------+-----------------------+
* | status : 2B | read payload : <= 62B |
* +-------------+-----------------------+
*
* status: 2 byte status
* 0x0000: Success
* 0x0001: SPI timeout
* 0x0002: Busy, try again
* This can happen if someone else has acquired the shared memory
* buffer that the SPI driver uses as /dev/null
* 0x0003: Write count invalid (V1 > 62B)
* 0x0004: Read count invalid (V1 > 62B)
* 0x0005: The SPI bridge is disabled.
* 0x8000: Unknown error mask
* The bottom 15 bits will contain the bottom 15 bits from the EC
* error code.
*
* read payload: Up to 62 bytes of data read from SPI, the total
* length of all RX packets must match read count
* unless an error status was returned. Due to data
* alignment constraints, this must be a even number
* of bytes unless this is the final packet.
*
* USB Error Codes:
*
* send_command return codes have the following format:
*
* 0x00000: Status code success.
* 0x00001-0x0FFFF: Error code returned by the USB SPI device.
* 0x10001-0x1FFFF: The host has determined an error has occurred.
* 0x20001-0x20063 Lower bits store the positive value representation
* of the libusb_error enum. See the libusb documentation:
* http://libusb.sourceforge.net/api-1.0/group__misc.html
*/
#include "programmer.h"
#include "spi.h"
#include "usb_device.h"
#include <libusb.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#define GOOGLE_VID (0x18D1)
#define GOOGLE_RAIDEN_SPI_SUBCLASS (0x51)
#define GOOGLE_RAIDEN_SPI_PROTOCOL (0x01)
enum raiden_debug_spi_request {
RAIDEN_DEBUG_SPI_REQ_ENABLE = 0x0000,
RAIDEN_DEBUG_SPI_REQ_DISABLE = 0x0001,
RAIDEN_DEBUG_SPI_REQ_ENABLE_AP = 0x0002,
RAIDEN_DEBUG_SPI_REQ_ENABLE_EC = 0x0003,
};
#define PACKET_HEADER_SIZE (2)
#define MAX_PACKET_SIZE (64)
#define PAYLOAD_SIZE (MAX_PACKET_SIZE - PACKET_HEADER_SIZE)
/*
* This timeout is so large because the Raiden SPI timeout is 800ms.
*/
#define TRANSFER_TIMEOUT_MS (200 + 800)
struct usb_device *device = NULL;
uint8_t in_endpoint = 0;
uint8_t out_endpoint = 0;
typedef struct {
int8_t write_count;
/* -1 Indicates readback all on halfduplex compliant devices. */
int8_t read_count;
uint8_t data[PAYLOAD_SIZE];
} __attribute__((packed)) usb_spi_command_t;
typedef struct {
uint16_t status_code;
uint8_t data[PAYLOAD_SIZE];
} __attribute__((packed)) usb_spi_response_t;
static int write_command(const struct flashctx *flash,
unsigned int write_count,
unsigned int read_count,
const unsigned char *write_buffer,
unsigned char *read_buffer)
{
int transferred;
int ret;
usb_spi_command_t command_packet;
if (write_count > PAYLOAD_SIZE) {
msg_perr("Raiden: Invalid write_count of %d\n", write_count);
return SPI_INVALID_LENGTH;
}
if (read_count > PAYLOAD_SIZE) {
msg_perr("Raiden: Invalid read_count of %d\n", read_count);
return SPI_INVALID_LENGTH;
}
command_packet.write_count = write_count;
command_packet.read_count = read_count;
memcpy(command_packet.data, write_buffer, write_count);
ret = LIBUSB(libusb_bulk_transfer(device->handle,
out_endpoint,
(void*)&command_packet,
write_count + PACKET_HEADER_SIZE,
&transferred,
TRANSFER_TIMEOUT_MS));
if (ret != 0) {
msg_perr("Raiden: OUT transfer failed\n"
" write_count = %d\n"
" read_count = %d\n",
write_count, read_count);
return ret;
}
if ((unsigned) transferred != write_count + PACKET_HEADER_SIZE) {
msg_perr("Raiden: Write failure (wrote %d, expected %d)\n",
transferred, write_count + PACKET_HEADER_SIZE);
return 0x10001;
}
return 0;
}
static int read_response(const struct flashctx *flash,
unsigned int write_count,
unsigned int read_count,
const unsigned char *write_buffer,
unsigned char *read_buffer)
{
int transferred;
int ret;
usb_spi_response_t response_packet;
ret = LIBUSB(libusb_bulk_transfer(device->handle,
in_endpoint,
(void*)&response_packet,
read_count + PACKET_HEADER_SIZE,
&transferred,
TRANSFER_TIMEOUT_MS));
if (ret != 0) {
msg_perr("Raiden: IN transfer failed\n"
" write_count = %d\n"
" read_count = %d\n",
write_count, read_count);
return ret;
}
if ((unsigned) transferred != read_count + PACKET_HEADER_SIZE) {
msg_perr("Raiden: Read failure (read %d, expected %d)\n",
transferred, read_count + PACKET_HEADER_SIZE);
return 0x10002;
}
memcpy(read_buffer, response_packet.data, read_count);
return response_packet.status_code;
}
static int send_command(struct flashctx *flash,
unsigned int write_count,
unsigned int read_count,
const unsigned char *write_buffer,
unsigned char *read_buffer)
{
int status = -1;
status = write_command(flash, write_count, read_count,
write_buffer, read_buffer);
if (status) {
return status;
}
status = read_response(flash, write_count, read_count,
write_buffer, read_buffer);
return status;
}
/*
* Unfortunately there doesn't seem to be a way to specify the maximum number
* of bytes that your SPI device can read/write, these values are the maximum
* data chunk size that flashrom will package up with an additional five bytes
* of command for the flash device, resulting in a 62 byte packet, that we then
* add two bytes to in either direction, making our way up to the 64 byte
* maximum USB packet size for the device.
*
* The largest command that flashrom generates is the byte program command, so
* we use that command header maximum size here.
*/
#define MAX_DATA_SIZE (PAYLOAD_SIZE - JEDEC_BYTE_PROGRAM_OUTSIZE)
static const struct spi_master spi_master_raiden_debug = {
.features = SPI_MASTER_4BA,
.max_data_read = MAX_DATA_SIZE,
.max_data_write = MAX_DATA_SIZE,
.command = send_command,
.multicommand = default_spi_send_multicommand,
.read = default_spi_read,
.write_256 = default_spi_write_256,
.write_aai = default_spi_write_aai,
};
static int match_endpoint(struct libusb_endpoint_descriptor const *descriptor,
enum libusb_endpoint_direction direction)
{
return (((descriptor->bEndpointAddress & LIBUSB_ENDPOINT_DIR_MASK) ==
direction) &&
((descriptor->bmAttributes & LIBUSB_TRANSFER_TYPE_MASK) ==
LIBUSB_TRANSFER_TYPE_BULK));
}
static int find_endpoints(struct usb_device *dev, uint8_t *in_ep, uint8_t *out_ep)
{
int i;
int in_count = 0;
int out_count = 0;
for (i = 0; i < dev->interface_descriptor->bNumEndpoints; i++) {
struct libusb_endpoint_descriptor const *endpoint =
&dev->interface_descriptor->endpoint[i];
if (match_endpoint(endpoint, LIBUSB_ENDPOINT_IN)) {
in_count++;
*in_ep = endpoint->bEndpointAddress;
} else if (match_endpoint(endpoint, LIBUSB_ENDPOINT_OUT)) {
out_count++;
*out_ep = endpoint->bEndpointAddress;
}
}
if (in_count != 1 || out_count != 1) {
msg_perr("Raiden: Failed to find one IN and one OUT endpoint\n"
" found %d IN and %d OUT endpoints\n",
in_count,
out_count);
return 1;
}
msg_pdbg("Raiden: Found IN endpoint = 0x%02x\n", *in_ep);
msg_pdbg("Raiden: Found OUT endpoint = 0x%02x\n", *out_ep);
return 0;
}
static int shutdown(void * data)
{
int ret = LIBUSB(libusb_control_transfer(
device->handle,
LIBUSB_ENDPOINT_OUT |
LIBUSB_REQUEST_TYPE_VENDOR |
LIBUSB_RECIPIENT_INTERFACE,
RAIDEN_DEBUG_SPI_REQ_DISABLE,
0,
device->interface_descriptor->bInterfaceNumber,
NULL,
0,
TRANSFER_TIMEOUT_MS));
if (ret != 0) {
msg_perr("Raiden: Failed to disable SPI bridge\n");
return ret;
}
usb_device_free(device);
device = NULL;
libusb_exit(NULL);
return 0;
}
static int get_target(void)
{
int request_enable = RAIDEN_DEBUG_SPI_REQ_ENABLE;
char *target_str = extract_programmer_param("target");
if (target_str) {
if (!strcasecmp(target_str, "ap"))
request_enable = RAIDEN_DEBUG_SPI_REQ_ENABLE_AP;
else if (!strcasecmp(target_str, "ec"))
request_enable = RAIDEN_DEBUG_SPI_REQ_ENABLE_EC;
else {
msg_perr("Invalid target: %s\n", target_str);
request_enable = -1;
}
}
free(target_str);
return request_enable;
}
static void free_dev_list(struct usb_device **dev_lst)
{
struct usb_device *dev = *dev_lst;
/* free devices we don't care about */
dev = dev->next;
while (dev)
dev = usb_device_free(dev);
}
int raiden_debug_spi_init(void)
{
struct usb_match match;
char *serial = extract_programmer_param("serial");
struct usb_device *current;
int found = 0;
int ret;
int request_enable = get_target();
if (request_enable < 0)
return 1;
usb_match_init(&match);
usb_match_value_default(&match.vid, GOOGLE_VID);
usb_match_value_default(&match.class, LIBUSB_CLASS_VENDOR_SPEC);
usb_match_value_default(&match.subclass, GOOGLE_RAIDEN_SPI_SUBCLASS);
usb_match_value_default(&match.protocol, GOOGLE_RAIDEN_SPI_PROTOCOL);
ret = LIBUSB(libusb_init(NULL));
if (ret != 0) {
msg_perr("Raiden: libusb_init failed\n");
return ret;
}
ret = usb_device_find(&match, ¤t);
if (ret != 0) {
msg_perr("Raiden: Failed to find devices\n");
return ret;
}
while (current) {
device = current;
if (find_endpoints(device, &in_endpoint, &out_endpoint)) {
msg_pdbg("Raiden: Failed to find valid endpoints on device");
usb_device_show(" ", current);
goto loop_end;
}
if (usb_device_claim(device)) {
msg_pdbg("Raiden: Failed to claim USB device");
usb_device_show(" ", current);
goto loop_end;
}
if (!serial) {
found = 1;
goto loop_end;
} else {
unsigned char dev_serial[32];
struct libusb_device_descriptor descriptor;
int rc;
memset(dev_serial, 0, sizeof(dev_serial));
if (libusb_get_device_descriptor(device->device, &descriptor)) {
msg_pdbg("USB: Failed to get device descriptor.\n");
goto loop_end;
}
rc = libusb_get_string_descriptor_ascii(device->handle,
descriptor.iSerialNumber,
dev_serial,
sizeof(dev_serial));
if (rc < 0) {
LIBUSB(rc);
} else {
if (strcmp(serial, (char *)dev_serial)) {
msg_pdbg("Raiden: Serial number %s did not match device", serial);
usb_device_show(" ", current);
} else {
msg_pinfo("Raiden: Serial number %s matched device", serial);
usb_device_show(" ", current);
found = 1;
}
}
}
loop_end:
if (found)
break;
else
current = usb_device_free(current);
}
if (!device || !found) {
msg_perr("Raiden: No usable device found.\n");
return 1;
}
free_dev_list(¤t);
ret = LIBUSB(libusb_control_transfer(
device->handle,
LIBUSB_ENDPOINT_OUT |
LIBUSB_REQUEST_TYPE_VENDOR |
LIBUSB_RECIPIENT_INTERFACE,
request_enable,
0,
device->interface_descriptor->bInterfaceNumber,
NULL,
0,
TRANSFER_TIMEOUT_MS));
if (ret != 0) {
msg_perr("Raiden: Failed to enable SPI bridge\n");
return ret;
}
register_spi_master(&spi_master_raiden_debug);
register_shutdown(shutdown, NULL);
return 0;
}
|