blob: 530588fb083c2eaa66c60bacab4c7da582c5d6e2 [file] [log] [blame]
Stefan Taunerac1b4c82012-02-17 14:51:04 +00001/*
2 * This file is part of the flashrom project.
3 *
4 * Copyright (C) 2011-2012 Stefan Tauner
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; version 2 of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
Stefan Taunerac1b4c82012-02-17 14:51:04 +000014 */
15
16#include <stdint.h>
17#include <stdlib.h>
Carl-Daniel Hailfinger2d251242012-02-24 23:49:30 +000018#include <string.h>
Stefan Taunerac1b4c82012-02-17 14:51:04 +000019#include "flash.h"
20#include "spi.h"
21#include "chipdrivers.h"
22
23static int spi_sfdp_read_sfdp_chunk(struct flashctx *flash, uint32_t address, uint8_t *buf, int len)
24{
25 int i, ret;
Carl-Daniel Hailfinger2d251242012-02-24 23:49:30 +000026 uint8_t *newbuf;
Stefan Taunerac1b4c82012-02-17 14:51:04 +000027 const unsigned char cmd[JEDEC_SFDP_OUTSIZE] = {
28 JEDEC_SFDP,
29 (address >> 16) & 0xff,
30 (address >> 8) & 0xff,
31 (address >> 0) & 0xff,
32 /* FIXME: the following dummy byte explodes on some programmers.
Carl-Daniel Hailfinger2d251242012-02-24 23:49:30 +000033 * One workaround is to read the dummy byte
Stefan Taunerac1b4c82012-02-17 14:51:04 +000034 * instead and discard its value.
35 */
36 0
37 };
38 msg_cspew("%s: addr=0x%x, len=%d, data:\n", __func__, address, len);
Carl-Daniel Hailfinger2d251242012-02-24 23:49:30 +000039 newbuf = malloc(len + 1);
40 if (!newbuf)
41 return SPI_PROGRAMMER_ERROR;
42 ret = spi_send_command(flash, sizeof(cmd) - 1, len + 1, cmd, newbuf);
43 memmove(buf, newbuf + 1, len);
44 free(newbuf);
45 if (ret)
46 return ret;
Stefan Taunerac1b4c82012-02-17 14:51:04 +000047 for (i = 0; i < len; i++)
48 msg_cspew(" 0x%02x", buf[i]);
49 msg_cspew("\n");
Carl-Daniel Hailfinger2d251242012-02-24 23:49:30 +000050 return 0;
Stefan Taunerac1b4c82012-02-17 14:51:04 +000051}
52
53static int spi_sfdp_read_sfdp(struct flashctx *flash, uint32_t address, uint8_t *buf, int len)
54{
Carl-Daniel Hailfinger2d251242012-02-24 23:49:30 +000055 /* FIXME: There are different upper bounds for the number of bytes to
56 * read on the various programmers (even depending on the rest of the
57 * structure of the transaction). 2 is a safe bet. */
58 int maxstep = 2;
Stefan Taunerac1b4c82012-02-17 14:51:04 +000059 int ret = 0;
60 while (len > 0) {
61 int step = min(len, maxstep);
62 ret = spi_sfdp_read_sfdp_chunk(flash, address, buf, step);
63 if (ret)
64 return ret;
65 address += step;
66 buf += step;
67 len -= step;
68 }
69 return ret;
70}
71
72struct sfdp_tbl_hdr {
73 uint8_t id;
74 uint8_t v_minor;
75 uint8_t v_major;
76 uint8_t len;
77 uint32_t ptp; /* 24b pointer */
78};
79
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +000080static int sfdp_add_uniform_eraser(struct flashchip *chip, uint8_t opcode, uint32_t block_size)
Stefan Taunerac1b4c82012-02-17 14:51:04 +000081{
82 int i;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +000083 uint32_t total_size = chip->total_size * 1024;
Stefan Taunerac1b4c82012-02-17 14:51:04 +000084 erasefunc_t *erasefn = spi_get_erasefn_from_opcode(opcode);
85
Stefan Tauner75adf322012-02-22 00:14:14 +000086 if (erasefn == NULL || total_size == 0 || block_size == 0 ||
87 total_size % block_size != 0) {
88 msg_cdbg("%s: invalid input, please report to "
89 "flashrom@flashrom.org\n", __func__);
Stefan Taunerac1b4c82012-02-17 14:51:04 +000090 return 1;
91 }
92
93 for (i = 0; i < NUM_ERASEFUNCTIONS; i++) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +000094 struct block_eraser *eraser = &chip->block_erasers[i];
Stefan Taunerac1b4c82012-02-17 14:51:04 +000095 /* Check for duplicates (including (some) non-uniform ones). */
96 if (eraser->eraseblocks[0].size == block_size &&
97 eraser->block_erase == erasefn) {
98 msg_cdbg2(" Tried to add a duplicate block eraser: "
Stefan Tauner75adf322012-02-22 00:14:14 +000099 "%d x %d B with opcode 0x%02x.\n",
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000100 total_size/block_size, block_size, opcode);
101 return 1;
102 }
Stefan Tauner75adf322012-02-22 00:14:14 +0000103 if (eraser->eraseblocks[0].size != 0 ||
104 eraser->block_erase != NULL) {
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000105 msg_cspew(" Block Eraser %d is already occupied.\n",
106 i);
107 continue;
108 }
109
110 eraser->block_erase = erasefn;
111 eraser->eraseblocks[0].size = block_size;
112 eraser->eraseblocks[0].count = total_size/block_size;
113 msg_cdbg2(" Block eraser %d: %d x %d B with opcode "
114 "0x%02x\n", i, total_size/block_size, block_size,
115 opcode);
116 return 0;
117 }
118 msg_cinfo("%s: Not enough space to store another eraser (i=%d)."
119 " Please report this at flashrom@flashrom.org\n",
120 __func__, i);
121 return 1;
122}
123
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000124static int sfdp_fill_flash(struct flashchip *chip, uint8_t *buf, uint16_t len)
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000125{
Stefan Tauner75adf322012-02-22 00:14:14 +0000126 uint8_t opcode_4k_erase = 0xFF;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000127 uint32_t tmp32;
128 uint8_t tmp8;
129 uint32_t total_size; /* in bytes */
130 uint32_t block_size;
Stefan Tauner75adf322012-02-22 00:14:14 +0000131 int j;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000132
133 msg_cdbg("Parsing JEDEC flash parameter table... ");
134 if (len != 9 * 4 && len != 4 * 4) {
135 msg_cdbg("%s: len out of spec\n", __func__);
136 return 1;
137 }
138 msg_cdbg2("\n");
Elyes HAOUAS0cacb112019-02-04 12:16:38 +0100139
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000140 /* 1. double word */
Stefan Tauner75adf322012-02-22 00:14:14 +0000141 tmp32 = ((unsigned int)buf[(4 * 0) + 0]);
142 tmp32 |= ((unsigned int)buf[(4 * 0) + 1]) << 8;
143 tmp32 |= ((unsigned int)buf[(4 * 0) + 2]) << 16;
144 tmp32 |= ((unsigned int)buf[(4 * 0) + 3]) << 24;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000145
146 tmp8 = (tmp32 >> 17) & 0x3;
147 switch (tmp8) {
148 case 0x0:
149 msg_cdbg2(" 3-Byte only addressing.\n");
150 break;
151 case 0x1:
152 msg_cdbg2(" 3-Byte (and optionally 4-Byte) addressing.\n");
153 break;
154 case 0x2:
155 msg_cdbg(" 4-Byte only addressing (not supported by "
156 "flashrom).\n");
157 return 1;
158 default:
159 msg_cdbg(" Required addressing mode (0x%x) not supported.\n",
160 tmp8);
161 return 1;
162 }
163
164 msg_cdbg2(" Status register is ");
165 if (tmp32 & (1 << 3)) {
166 msg_cdbg2("volatile and writes to the status register have to "
167 "be enabled with ");
168 if (tmp32 & (1 << 4)) {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000169 chip->feature_bits = FEATURE_WRSR_WREN;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000170 msg_cdbg2("WREN (0x06).\n");
171 } else {
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000172 chip->feature_bits = FEATURE_WRSR_EWSR;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000173 msg_cdbg2("EWSR (0x50).\n");
174 }
Steven Zakulec3603a282012-05-02 20:07:57 +0000175 } else {
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000176 msg_cdbg2("non-volatile and the standard does not allow "
177 "vendors to tell us whether EWSR/WREN is needed for "
178 "status register writes - assuming EWSR.\n");
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000179 chip->feature_bits = FEATURE_WRSR_EWSR;
Steven Zakulec3603a282012-05-02 20:07:57 +0000180 }
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000181
182 msg_cdbg2(" Write chunk size is ");
183 if (tmp32 & (1 << 2)) {
184 msg_cdbg2("at least 64 B.\n");
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000185 chip->page_size = 64;
186 chip->write = spi_chip_write_256;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000187 } else {
188 msg_cdbg2("1 B only.\n");
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000189 chip->page_size = 256;
190 chip->write = spi_chip_write_1;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000191 }
192
193 if ((tmp32 & 0x3) == 0x1) {
Stefan Tauner75adf322012-02-22 00:14:14 +0000194 opcode_4k_erase = (tmp32 >> 8) & 0xFF;
195 msg_cspew(" 4kB erase opcode is 0x%02x.\n", opcode_4k_erase);
196 /* add the eraser later, because we don't know total_size yet */
197 } else
198 msg_cspew(" 4kB erase opcode is not defined.\n");
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000199
200 /* 2. double word */
Stefan Tauner75adf322012-02-22 00:14:14 +0000201 tmp32 = ((unsigned int)buf[(4 * 1) + 0]);
202 tmp32 |= ((unsigned int)buf[(4 * 1) + 1]) << 8;
203 tmp32 |= ((unsigned int)buf[(4 * 1) + 2]) << 16;
204 tmp32 |= ((unsigned int)buf[(4 * 1) + 3]) << 24;
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000205
206 if (tmp32 & (1 << 31)) {
207 msg_cdbg("Flash chip size >= 4 Gb/512 MB not supported.\n");
208 return 1;
209 }
210 total_size = ((tmp32 & 0x7FFFFFFF) + 1) / 8;
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000211 chip->total_size = total_size / 1024;
212 msg_cdbg2(" Flash chip size is %d kB.\n", chip->total_size);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000213 if (total_size > (1 << 24)) {
214 msg_cdbg("Flash chip size is bigger than what 3-Byte addressing "
215 "can access.\n");
216 return 1;
217 }
218
Stefan Tauner75adf322012-02-22 00:14:14 +0000219 if (opcode_4k_erase != 0xFF)
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000220 sfdp_add_uniform_eraser(chip, opcode_4k_erase, 4 * 1024);
Stefan Tauner75adf322012-02-22 00:14:14 +0000221
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000222 /* FIXME: double words 3-7 contain unused fast read information */
223
224 if (len == 4 * 4) {
Stefan Tauner75adf322012-02-22 00:14:14 +0000225 msg_cdbg(" It seems like this chip supports the preliminary "
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000226 "Intel version of SFDP, skipping processing of double "
227 "words 3-9.\n");
228 goto done;
229 }
230
Stefan Tauner75adf322012-02-22 00:14:14 +0000231 /* 8. double word */
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000232 for (j = 0; j < 4; j++) {
Stefan Tauner75adf322012-02-22 00:14:14 +0000233 /* 7 double words from the start + 2 bytes for every eraser */
234 tmp8 = buf[(4 * 7) + (j * 2)];
235 msg_cspew(" Erase Sector Type %d Size: 0x%02x\n", j + 1,
236 tmp8);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000237 if (tmp8 == 0) {
Stefan Tauner75adf322012-02-22 00:14:14 +0000238 msg_cspew(" Erase Sector Type %d is unused.\n", j);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000239 continue;
240 }
241 if (tmp8 >= 31) {
Stefan Tauner75adf322012-02-22 00:14:14 +0000242 msg_cdbg2(" Block size of erase Sector Type %d (2^%d) "
243 "is too big for flashrom.\n", j, tmp8);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000244 continue;
245 }
246 block_size = 1 << (tmp8); /* block_size = 2 ^ field */
247
Stefan Tauner75adf322012-02-22 00:14:14 +0000248 tmp8 = buf[(4 * 7) + (j * 2) + 1];
249 msg_cspew(" Erase Sector Type %d Opcode: 0x%02x\n", j + 1,
250 tmp8);
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000251 sfdp_add_uniform_eraser(chip, tmp8, block_size);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000252 }
253
254done:
255 msg_cdbg("done.\n");
256 return 0;
257}
258
259int probe_spi_sfdp(struct flashctx *flash)
260{
261 int ret = 0;
262 uint8_t buf[8];
263 uint32_t tmp32;
264 uint8_t nph;
265 /* need to limit the table loop by comparing i to uint8_t nph hence: */
266 uint16_t i;
267 struct sfdp_tbl_hdr *hdrs;
268 uint8_t *hbuf;
269 uint8_t *tbuf;
270
271 if (spi_sfdp_read_sfdp(flash, 0x00, buf, 4)) {
272 msg_cdbg("Receiving SFDP signature failed.\n");
273 return 0;
274 }
275 tmp32 = buf[0];
276 tmp32 |= ((unsigned int)buf[1]) << 8;
277 tmp32 |= ((unsigned int)buf[2]) << 16;
278 tmp32 |= ((unsigned int)buf[3]) << 24;
279
280 if (tmp32 != 0x50444653) {
281 msg_cdbg2("Signature = 0x%08x (should be 0x50444653)\n", tmp32);
282 msg_cdbg("No SFDP signature found.\n");
283 return 0;
284 }
285
286 if (spi_sfdp_read_sfdp(flash, 0x04, buf, 3)) {
287 msg_cdbg("Receiving SFDP revision and number of parameter "
288 "headers (NPH) failed. ");
289 return 0;
290 }
291 msg_cdbg2("SFDP revision = %d.%d\n", buf[1], buf[0]);
292 if (buf[1] != 0x01) {
293 msg_cdbg("The chip supports an unknown version of SFDP. "
294 "Aborting SFDP probe!\n");
295 return 0;
296 }
297 nph = buf[2];
298 msg_cdbg2("SFDP number of parameter headers is %d (NPH = %d).\n",
299 nph + 1, nph);
300
301 /* Fetch all parameter headers, even if we don't use them all (yet). */
302 hbuf = malloc((nph + 1) * 8);
Angel Pons3bd47522021-06-07 12:33:53 +0200303 hdrs = malloc((nph + 1) * sizeof(*hdrs));
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000304 if (hbuf == NULL || hdrs == NULL ) {
305 msg_gerr("Out of memory!\n");
306 goto cleanup_hdrs;
307 }
308 if (spi_sfdp_read_sfdp(flash, 0x08, hbuf, (nph + 1) * 8)) {
309 msg_cdbg("Receiving SFDP parameter table headers failed.\n");
310 goto cleanup_hdrs;
311 }
312
313 for (i = 0; i <= nph; i++) {
314 uint16_t len;
315 hdrs[i].id = hbuf[(8 * i) + 0];
316 hdrs[i].v_minor = hbuf[(8 * i) + 1];
317 hdrs[i].v_major = hbuf[(8 * i) + 2];
318 hdrs[i].len = hbuf[(8 * i) + 3];
319 hdrs[i].ptp = hbuf[(8 * i) + 4];
320 hdrs[i].ptp |= ((unsigned int)hbuf[(8 * i) + 5]) << 8;
321 hdrs[i].ptp |= ((unsigned int)hbuf[(8 * i) + 6]) << 16;
322 msg_cdbg2("\nSFDP parameter table header %d/%d:\n", i, nph);
323 msg_cdbg2(" ID 0x%02x, version %d.%d\n", hdrs[i].id,
324 hdrs[i].v_major, hdrs[i].v_minor);
325 len = hdrs[i].len * 4;
326 tmp32 = hdrs[i].ptp;
327 msg_cdbg2(" Length %d B, Parameter Table Pointer 0x%06x\n",
328 len, tmp32);
329
330 if (tmp32 + len >= (1 << 24)) {
331 msg_cdbg("SFDP Parameter Table %d supposedly overflows "
332 "addressable SFDP area. This most\nprobably "
333 "indicates a corrupt SFDP parameter table "
334 "header. Skipping it.\n", i);
335 continue;
336 }
337
338 tbuf = malloc(len);
339 if (tbuf == NULL) {
340 msg_gerr("Out of memory!\n");
341 goto cleanup_hdrs;
342 }
343 if (spi_sfdp_read_sfdp(flash, tmp32, tbuf, len)){
344 msg_cdbg("Fetching SFDP parameter table %d failed.\n",
345 i);
346 free(tbuf);
347 continue;
348 }
349 msg_cspew(" Parameter table contents:\n");
350 for (tmp32 = 0; tmp32 < len; tmp32++) {
351 if ((tmp32 % 8) == 0) {
352 msg_cspew(" 0x%04x: ", tmp32);
353 }
Stefan Tauner75adf322012-02-22 00:14:14 +0000354 msg_cspew(" %02x", tbuf[tmp32]);
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000355 if ((tmp32 % 8) == 7) {
356 msg_cspew("\n");
357 continue;
358 }
359 if ((tmp32 % 8) == 3) {
360 msg_cspew(" ");
361 continue;
362 }
363 }
Stefan Tauner75adf322012-02-22 00:14:14 +0000364 msg_cspew("\n");
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000365
366 if (i == 0) { /* Mandatory JEDEC SFDP parameter table */
367 if (hdrs[i].id != 0)
368 msg_cdbg("ID of the mandatory JEDEC SFDP "
369 "parameter table is not 0 as demanded "
370 "by JESD216 (warning only).\n");
371
372 if (hdrs[i].v_major != 0x01) {
373 msg_cdbg("The chip contains an unknown "
374 "version of the JEDEC flash "
375 "parameters table, skipping it.\n");
376 } else if (len != 9 * 4 && len != 4 * 4) {
377 msg_cdbg("Length of the mandatory JEDEC SFDP "
378 "parameter table is wrong (%d B), "
379 "skipping it.\n", len);
Carl-Daniel Hailfinger5a7cb842012-08-25 01:17:58 +0000380 } else if (sfdp_fill_flash(flash->chip, tbuf, len) == 0)
Stefan Taunerac1b4c82012-02-17 14:51:04 +0000381 ret = 1;
382 }
383 free(tbuf);
384 }
385
386cleanup_hdrs:
387 free(hdrs);
388 free(hbuf);
389 return ret;
390}