blob: d8733cc870ad694954a912a9fd04fa1f0831fbd5 [file] [log] [blame]
Urja Rannikkof3196df2009-07-21 13:02:59 +00001Serial Flasher Protocol Specification - version 1 (0x01 return value == 1)
2
3Command And Answer Sequence - all commands give an answer.
4PC: COMMAND(8bit) <parameters determined by opcode>
5DEV: ACK/NAK(8bit) <OPTIONAL RETURN BYTES (only if ACK)> / nothing
6Command 0x10 (SYNCNOP) has a special return of NAK+ACK for synchronization.
7
8ACK = 0x06
9NAK = 0x15
10
11All multibyte values are little-endian. Addresses and lengths are 24-bit.
12
13COMMAND Description Parameters Return Value
140x00 NOP none ACK
150x01 Query programmer iface version none ACK + 16bit version (nonzero)
160x02 Query supported commands bitmap none ACK + 32 bytes (256 bits) of supported cmds flags
170x03 Query programmer name none ACK + 16 bytes string (null padding) / NAK
180x04 Query serial buffer size none ACK + 16bit size / NAK
190x05 Query supported bustypes none ACK + 8-bit flags (as per flashrom) / NAK
200x06 Query connected address lines none ACK + 8bit line count / NAK
210x07 Query operation buffer size none ACK + 16bit size / NAK
Stefan Tauner31019d42011-10-22 21:45:27 +0000220x08 Query maximum write-n length none ACK + 24bit length (0==2^24) / NAK
Urja Rannikkof3196df2009-07-21 13:02:59 +0000230x09 Read byte 24-bit addr ACK + BYTE / NAK
240x0A Read n bytes 24-bit addr + 24-bit length ACK + length bytes / NAK
250x0B Initialize operation buffer none ACK / NAK
260x0C Write to opbuf: Write byte 24-bit addr + 8-bit byte ACK / NAK (NOTE: takes 5 bytes in opbuf)
270x0D Write to opbuf: Write n 24-bit length + 24-bit addr + ACK / NAK (NOTE: takes 7+n bytes in opbuf)
28 + length bytes of data
290x0E Write to opbuf: delay 32-bit usecs ACK / NAK (NOTE: takes 5 bytes in opbuf)
300x0F Execute operation buffer none ACK / NAK
310x10 Sync NOP none NAK + ACK (for synchronization)
320x11 Query maximum read-n length none ACK + 24-bit length (0==2^24) / NAK
330x12 Set used bustype 8-bit flags (as with 0x05) ACK / NAK
Urja Rannikkoc93f5f12011-09-15 23:38:14 +0000340x13 Perform SPI operation 24-bit slen + 24-bit rlen ACK + rlen bytes of data / NAK
35 + slen bytes of data
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000360x14 Set SPI clock frequency in Hz 32-bit requested frequency ACK + 32-bit set frequency / NAK
Urja Rannikkof3196df2009-07-21 13:02:59 +0000370x?? unimplemented command - invalid.
38
39
40Additional information of the above commands:
41 About unimplemented commands / startup sequence:
42 Only commands allowed to be used without checking anything are 0x00,0x10 and 0x01 (NOP,SYNCNOP,Q_IFACE).
43 If 0x01 doesn't return 1, dont do anything if you dont support a newer protocol.
44 Then, check support for any other opcode (except 0x02) by using 0x02 (Q_CMDMAP).
45 0x02 (Q_CMDMAP):
46 The map's bits are mapped as follows:
47 cmd 0 support: byte 0 bit 0
48 cmd 1 support: byte 0 bit 1
49 cmd 7 support: byte 0 bit 7
50 cmd 8 support: byte 1 bit 0, and so on.
51 0x04 (Q_SERBUF):
Uwe Hermann4e3d0b32010-03-25 23:18:41 +000052 If the programmer has a guaranteed working flow control,
Urja Rannikkof3196df2009-07-21 13:02:59 +000053 it should return a big bogus value - eg 0xFFFF.
54 0x05 (Q_BUSTYPE):
55 The bit's are defined as follows:
Urja Rannikkoc93f5f12011-09-15 23:38:14 +000056 bit 0: PARALLEL, bit 1: LPC, bit 2: FWH, bit 3: SPI.
Urja Rannikkof3196df2009-07-21 13:02:59 +000057 0x06 (Q_CHIPSIZE):
58 Only applicable to parallel programmers.
Uwe Hermann4e3d0b32010-03-25 23:18:41 +000059 An LPC/FWH/SPI-programmer can report this as not supported in the command bitmap.
Urja Rannikkof3196df2009-07-21 13:02:59 +000060 0x08 (Q_WRNMAXLEN):
61 If a programmer reports a bigger maximum write-n length than the serial buffer size,
62 it is assumed that the programmer can process the data fast enough to take in the
63 reported maximum write-n without problems.
64 0x0F (O_EXEC):
65 Execute operation buffer will also clear it, regardless of the return value.
66 0x11 (Q_RDNMAXLEN):
67 If this command is not supported, assume return of 0 (2^24).
68 0x12 (S_BUSTYPE):
69 Set's the used bustype if the programmer can support more than one flash protocol.
70 Sending a byte with more than 1 bit set will make the programmer decide among them
71 on it's own. Bit values as with Q_BUSTYPE.
Urja Rannikkoc93f5f12011-09-15 23:38:14 +000072 0x13 (O_SPIOP):
73 Send and receive bytes via SPI.
74 Maximum slen is Q_WRNMAXLEN in case Q_BUSTYPE returns SPI only or S_BUSTYPE was used
75 to set SPI exclusively before. Same for rlen and Q_RDNMAXLEN.
76 This operation is immediate, meaning it doesnt use the operation buffer.
Stefan Taunerb98f6eb2012-08-13 16:33:04 +000077 0x14 (S_SPI_FREQ):
78 Set the SPI clock frequency. The 32-bit value indicates the
79 requested frequency in Hertz. Value 0 is reserved and should
80 be NAKed by the programmer. The requested frequency should be
81 mapped by the programmer software to a supported frequency
82 lower than the one requested. If there is no lower frequency
83 available the lowest possible should be used. The value
84 chosen is sent back in the reply with an ACK.
Urja Rannikkof3196df2009-07-21 13:02:59 +000085 About mandatory commands:
86 The only truly mandatory commands for any device are 0x00, 0x01, 0x02 and 0x10,
87 but one can't really do anything with these commands.
88 Support for the following commands is necessary for flashrom to operate properly:
89 S_CMD_Q_SERBUF, S_CMD_Q_OPBUF, S_CMD_Q_WRNMAXLEN, S_CMD_R_BYTE,
90 S_CMD_R_NBYTES, S_CMD_O_INIT, S_CMD_O_WRITEB, S_CMD_O_WRITEN,
91 S_CMD_O_DELAY, S_CMD_O_EXEC.
92 In addition, support for these commands is recommended:
93 S_CMD_Q_PGMNAME, S_CMD_Q_BUSTYPE, S_CMD_Q_CHIPSIZE (if parallel).
94
95
96This define listing should help C coders - (it's here to be the single source for copying - will be a .h someday i think)
97#define S_ACK 0x06
98#define S_NAK 0x15
99#define S_CMD_NOP 0x00 /* No operation */
100#define S_CMD_Q_IFACE 0x01 /* Query interface version */
101#define S_CMD_Q_CMDMAP 0x02 /* Query supported commands bitmap */
102#define S_CMD_Q_PGMNAME 0x03 /* Query programmer name */
103#define S_CMD_Q_SERBUF 0x04 /* Query Serial Buffer Size */
104#define S_CMD_Q_BUSTYPE 0x05 /* Query supported bustypes */
105#define S_CMD_Q_CHIPSIZE 0x06 /* Query supported chipsize (2^n format) */
106#define S_CMD_Q_OPBUF 0x07 /* Query operation buffer size */
Cristian Măgherușan-Stanciu9932c7b2011-07-07 19:56:58 +0000107#define S_CMD_Q_WRNMAXLEN 0x08 /* Query Write to opbuf: Write-N maximum length */
Urja Rannikkof3196df2009-07-21 13:02:59 +0000108#define S_CMD_R_BYTE 0x09 /* Read a single byte */
109#define S_CMD_R_NBYTES 0x0A /* Read n bytes */
110#define S_CMD_O_INIT 0x0B /* Initialize operation buffer */
111#define S_CMD_O_WRITEB 0x0C /* Write opbuf: Write byte with address */
112#define S_CMD_O_WRITEN 0x0D /* Write to opbuf: Write-N */
113#define S_CMD_O_DELAY 0x0E /* Write opbuf: udelay */
114#define S_CMD_O_EXEC 0x0F /* Execute operation buffer */
115#define S_CMD_SYNCNOP 0x10 /* Special no-operation that returns NAK+ACK */
116#define S_CMD_Q_RDNMAXLEN 0x11 /* Query read-n maximum length */
117#define S_CMD_S_BUSTYPE 0x12 /* Set used bustype(s). */
Urja Rannikkoc93f5f12011-09-15 23:38:14 +0000118#define S_CMD_O_SPIOP 0x13 /* Perform SPI operation. */
Stefan Taunerb98f6eb2012-08-13 16:33:04 +0000119#define S_CMD_S_SPI_FREQ 0x14 /* Set SPI clock frequency */