3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
11 #if defined(CONFIG_ENV_IS_IN_FLASH)
12 # ifndef CONFIG_ENV_ADDR
13 # define CONFIG_ENV_ADDR (CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
15 # ifndef CONFIG_ENV_SIZE
16 # define CONFIG_ENV_SIZE CONFIG_ENV_SECT_SIZE
18 # ifndef CONFIG_ENV_SECT_SIZE
19 # define CONFIG_ENV_SECT_SIZE CONFIG_ENV_SIZE
23 /*---------------------------------------------------------------------*/
27 #define DEBUGF(fmt,args...) printf(fmt ,##args)
29 #define DEBUGF(fmt,args...)
31 /*---------------------------------------------------------------------*/
33 flash_info_t flash_info[CONFIG_SYS_MAX_FLASH_BANKS]; /* info for FLASH chips */
35 /*-----------------------------------------------------------------------
38 static ulong flash_get_size (vu_char *addr, flash_info_t *info);
39 static int write_data (flash_info_t *info, uchar *dest, uchar data);
40 static void flash_get_offsets (ulong base, flash_info_t *info);
44 * don't ask. its stupid, but more than one soul has had to live with this mistake
45 * "swaptab[i]" is the value of "i" with the bits reversed.
48 #define MUSENKI_BROKEN_FLASH 1
50 #ifdef MUSENKI_BROKEN_FLASH
51 unsigned char swaptab[256] = {
52 0x00, 0x80, 0x40, 0xc0, 0x20, 0xa0, 0x60, 0xe0,
53 0x10, 0x90, 0x50, 0xd0, 0x30, 0xb0, 0x70, 0xf0,
54 0x08, 0x88, 0x48, 0xc8, 0x28, 0xa8, 0x68, 0xe8,
55 0x18, 0x98, 0x58, 0xd8, 0x38, 0xb8, 0x78, 0xf8,
56 0x04, 0x84, 0x44, 0xc4, 0x24, 0xa4, 0x64, 0xe4,
57 0x14, 0x94, 0x54, 0xd4, 0x34, 0xb4, 0x74, 0xf4,
58 0x0c, 0x8c, 0x4c, 0xcc, 0x2c, 0xac, 0x6c, 0xec,
59 0x1c, 0x9c, 0x5c, 0xdc, 0x3c, 0xbc, 0x7c, 0xfc,
60 0x02, 0x82, 0x42, 0xc2, 0x22, 0xa2, 0x62, 0xe2,
61 0x12, 0x92, 0x52, 0xd2, 0x32, 0xb2, 0x72, 0xf2,
62 0x0a, 0x8a, 0x4a, 0xca, 0x2a, 0xaa, 0x6a, 0xea,
63 0x1a, 0x9a, 0x5a, 0xda, 0x3a, 0xba, 0x7a, 0xfa,
64 0x06, 0x86, 0x46, 0xc6, 0x26, 0xa6, 0x66, 0xe6,
65 0x16, 0x96, 0x56, 0xd6, 0x36, 0xb6, 0x76, 0xf6,
66 0x0e, 0x8e, 0x4e, 0xce, 0x2e, 0xae, 0x6e, 0xee,
67 0x1e, 0x9e, 0x5e, 0xde, 0x3e, 0xbe, 0x7e, 0xfe,
68 0x01, 0x81, 0x41, 0xc1, 0x21, 0xa1, 0x61, 0xe1,
69 0x11, 0x91, 0x51, 0xd1, 0x31, 0xb1, 0x71, 0xf1,
70 0x09, 0x89, 0x49, 0xc9, 0x29, 0xa9, 0x69, 0xe9,
71 0x19, 0x99, 0x59, 0xd9, 0x39, 0xb9, 0x79, 0xf9,
72 0x05, 0x85, 0x45, 0xc5, 0x25, 0xa5, 0x65, 0xe5,
73 0x15, 0x95, 0x55, 0xd5, 0x35, 0xb5, 0x75, 0xf5,
74 0x0d, 0x8d, 0x4d, 0xcd, 0x2d, 0xad, 0x6d, 0xed,
75 0x1d, 0x9d, 0x5d, 0xdd, 0x3d, 0xbd, 0x7d, 0xfd,
76 0x03, 0x83, 0x43, 0xc3, 0x23, 0xa3, 0x63, 0xe3,
77 0x13, 0x93, 0x53, 0xd3, 0x33, 0xb3, 0x73, 0xf3,
78 0x0b, 0x8b, 0x4b, 0xcb, 0x2b, 0xab, 0x6b, 0xeb,
79 0x1b, 0x9b, 0x5b, 0xdb, 0x3b, 0xbb, 0x7b, 0xfb,
80 0x07, 0x87, 0x47, 0xc7, 0x27, 0xa7, 0x67, 0xe7,
81 0x17, 0x97, 0x57, 0xd7, 0x37, 0xb7, 0x77, 0xf7,
82 0x0f, 0x8f, 0x4f, 0xcf, 0x2f, 0xaf, 0x6f, 0xef,
83 0x1f, 0x9f, 0x5f, 0xdf, 0x3f, 0xbf, 0x7f, 0xff,
86 #define BS(b) (swaptab[b])
94 #define BYTEME(x) ((x) & 0xFF)
96 /*-----------------------------------------------------------------------
99 unsigned long flash_init (void)
101 unsigned long size_b0, size_b1;
104 /* Init: no FLASHes known */
105 for (i=0; i<CONFIG_SYS_MAX_FLASH_BANKS; ++i) {
106 flash_info[i].flash_id = FLASH_UNKNOWN;
109 /* Static FLASH Bank configuration here - FIXME XXX */
111 DEBUGF("\n## Get flash bank 1 size @ 0x%08x\n",CONFIG_SYS_FLASH_BASE0_PRELIM);
113 size_b0 = flash_get_size((vu_char *)CONFIG_SYS_FLASH_BASE0_PRELIM, &flash_info[0]);
115 if (flash_info[0].flash_id == FLASH_UNKNOWN) {
116 printf ("## Unknown FLASH on Bank 0: "
117 "ID 0x%lx, Size = 0x%08lx = %ld MB\n",
118 flash_info[0].flash_id,
119 size_b0, size_b0<<20);
122 DEBUGF("## Get flash bank 2 size @ 0x%08x\n",CONFIG_SYS_FLASH_BASE1_PRELIM);
123 size_b1 = flash_get_size((vu_char *)CONFIG_SYS_FLASH_BASE1_PRELIM, &flash_info[1]);
125 DEBUGF("## Prelim. Flash bank sizes: %08lx + 0x%08lx\n",size_b0,size_b1);
127 flash_get_offsets (CONFIG_SYS_FLASH_BASE, &flash_info[0]);
129 flash_info[0].size = size_b0;
131 #if CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE
132 DEBUGF("protect monitor %x @ %x\n", CONFIG_SYS_MONITOR_BASE, monitor_flash_len);
133 /* monitor protection ON by default */
134 flash_protect(FLAG_PROTECT_SET,
135 CONFIG_SYS_MONITOR_BASE,
136 CONFIG_SYS_MONITOR_BASE+monitor_flash_len-1,
140 #ifdef CONFIG_ENV_IS_IN_FLASH
141 /* ENV protection ON by default */
142 DEBUGF("protect environtment %x @ %x\n", CONFIG_ENV_ADDR, CONFIG_ENV_SECT_SIZE);
143 flash_protect(FLAG_PROTECT_SET,
145 CONFIG_ENV_ADDR+CONFIG_ENV_SECT_SIZE-1,
150 flash_info[1].size = size_b1;
151 flash_get_offsets (CONFIG_SYS_FLASH_BASE + size_b0, &flash_info[1]);
153 #if CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE
154 /* monitor protection ON by default */
155 flash_protect(FLAG_PROTECT_SET,
156 CONFIG_SYS_MONITOR_BASE,
157 CONFIG_SYS_MONITOR_BASE+monitor_flash_len-1,
161 #ifdef CONFIG_ENV_IS_IN_FLASH
162 /* ENV protection ON by default */
163 flash_protect(FLAG_PROTECT_SET,
165 CONFIG_ENV_ADDR+CONFIG_ENV_SECT_SIZE-1,
169 flash_info[1].flash_id = FLASH_UNKNOWN;
170 flash_info[1].sector_count = -1;
171 flash_info[1].size = 0;
174 DEBUGF("## Final Flash bank sizes: %08lx + 0x%08lx\n",size_b0,size_b1);
176 return (size_b0 + size_b1);
179 /*-----------------------------------------------------------------------
181 static void flash_get_offsets (ulong base, flash_info_t *info)
185 if (info->flash_id == FLASH_UNKNOWN) {
189 switch (info->flash_id & FLASH_VENDMASK) {
190 case FLASH_MAN_INTEL:
191 for (i = 0; i < info->sector_count; i++) {
192 info->start[i] = base;
193 base += 0x00020000; /* 128k per bank */
198 printf ("Don't know sector ofsets for flash type 0x%lx\n", info->flash_id);
203 /*-----------------------------------------------------------------------
205 void flash_print_info (flash_info_t *info)
209 if (info->flash_id == FLASH_UNKNOWN) {
210 printf ("missing or unknown FLASH type\n");
214 switch (info->flash_id & FLASH_VENDMASK) {
215 case FLASH_MAN_AMD: printf ("AMD "); break;
216 case FLASH_MAN_FUJ: printf ("Fujitsu "); break;
217 case FLASH_MAN_SST: printf ("SST "); break;
218 case FLASH_MAN_STM: printf ("STM "); break;
219 case FLASH_MAN_INTEL: printf ("Intel "); break;
220 case FLASH_MAN_MT: printf ("MT "); break;
221 default: printf ("Unknown Vendor "); break;
224 switch (info->flash_id & FLASH_TYPEMASK) {
225 case FLASH_28F320J3A: printf ("28F320J3A (32Mbit = 128K x 32)\n");
227 case FLASH_28F640J3A: printf ("28F640J3A (64Mbit = 128K x 64)\n");
229 case FLASH_28F128J3A: printf ("28F128J3A (128Mbit = 128K x 128)\n");
231 default: printf ("Unknown Chip Type\n");
235 if (info->size >= (1 << 20)) {
240 printf (" Size: %ld %cB in %d Sectors\n",
242 (i == 20) ? 'M' : 'k',
245 printf (" Sector Start Addresses:");
246 for (i=0; i<info->sector_count; ++i) {
251 info->protect[i] ? " (RO)" : " "
258 /*-----------------------------------------------------------------------
262 /*-----------------------------------------------------------------------
266 * The following code cannot be run from FLASH!
268 static ulong flash_get_size (vu_char *addr, flash_info_t *info)
270 vu_char manuf, device;
274 DEBUGF("Manuf. ID @ 0x%08lx: 0x%08x\n", (vu_char *)addr, manuf);
277 case BYTEME(AMD_MANUFACT):
278 info->flash_id = FLASH_MAN_AMD;
280 case BYTEME(FUJ_MANUFACT):
281 info->flash_id = FLASH_MAN_FUJ;
283 case BYTEME(SST_MANUFACT):
284 info->flash_id = FLASH_MAN_SST;
286 case BYTEME(STM_MANUFACT):
287 info->flash_id = FLASH_MAN_STM;
289 case BYTEME(INTEL_MANUFACT):
290 info->flash_id = FLASH_MAN_INTEL;
293 info->flash_id = FLASH_UNKNOWN;
294 info->sector_count = 0;
296 addr[0] = BS(0xFF); /* restore read mode, (yes, BS is a NOP) */
297 return 0; /* no or unknown flash */
300 device = BS(addr[2]); /* device ID */
302 DEBUGF("Device ID @ 0x%08x: 0x%08x\n", (&addr[1]), device);
305 case BYTEME(INTEL_ID_28F320J3A):
306 info->flash_id += FLASH_28F320J3A;
307 info->sector_count = 32;
308 info->size = 0x00400000;
311 case BYTEME(INTEL_ID_28F640J3A):
312 info->flash_id += FLASH_28F640J3A;
313 info->sector_count = 64;
314 info->size = 0x00800000;
317 case BYTEME(INTEL_ID_28F128J3A):
318 info->flash_id += FLASH_28F128J3A;
319 info->sector_count = 128;
320 info->size = 0x01000000;
321 break; /* => 16 MB */
324 info->flash_id = FLASH_UNKNOWN;
325 addr[0] = BS(0xFF); /* restore read mode (yes, a NOP) */
326 return 0; /* => no or unknown flash */
330 if (info->sector_count > CONFIG_SYS_MAX_FLASH_SECT) {
331 printf ("** ERROR: sector count %d > max (%d) **\n",
332 info->sector_count, CONFIG_SYS_MAX_FLASH_SECT);
333 info->sector_count = CONFIG_SYS_MAX_FLASH_SECT;
336 addr[0] = BS(0xFF); /* restore read mode */
342 /*-----------------------------------------------------------------------
345 int flash_erase (flash_info_t *info, int s_first, int s_last)
347 int flag, prot, sect;
348 ulong start, now, last;
350 if ((s_first < 0) || (s_first > s_last)) {
351 if (info->flash_id == FLASH_UNKNOWN) {
352 printf ("- missing\n");
354 printf ("- no sectors to erase\n");
359 if ((info->flash_id & FLASH_VENDMASK) != FLASH_MAN_INTEL) {
360 printf ("Can erase only Intel flash types - aborted\n");
365 for (sect=s_first; sect<=s_last; ++sect) {
366 if (info->protect[sect]) {
372 printf ("- Warning: %d protected sectors will not be erased!\n", prot);
377 start = get_timer (0);
379 /* Start erase on unprotected sectors */
380 for (sect = s_first; sect<=s_last; sect++) {
381 if (info->protect[sect] == 0) { /* not protected */
382 vu_char *addr = (vu_char *)(info->start[sect]);
383 unsigned long status;
385 /* Disable interrupts which might cause a timeout here */
386 flag = disable_interrupts();
388 *addr = BS(0x50); /* clear status register */
389 *addr = BS(0x20); /* erase setup */
390 *addr = BS(0xD0); /* erase confirm */
392 /* re-enable interrupts if necessary */
397 /* wait at least 80us - let's wait 1 ms */
400 while (((status = BS(*addr)) & BYTEME(0x00800080)) != BYTEME(0x00800080)) {
401 if ((now=get_timer(start)) > CONFIG_SYS_FLASH_ERASE_TOUT) {
402 printf ("Timeout\n");
403 *addr = BS(0xB0); /* suspend erase */
404 *addr = BS(0xFF); /* reset to read mode */
408 /* show that we're waiting */
409 if ((now - last) > 1000) { /* every second */
415 *addr = BS(0xFF); /* reset to read mode */
422 /*-----------------------------------------------------------------------
423 * Copy memory to flash, returns:
426 * 2 - Flash not erased
427 * 4 - Flash not identified
430 #define FLASH_WIDTH 1 /* flash bus width in bytes */
432 int write_buff (flash_info_t *info, uchar *src, ulong addr, ulong cnt)
434 uchar *wp = (uchar *)addr;
437 if (info->flash_id == FLASH_UNKNOWN) {
442 if ((rc = write_data(info, wp, *src)) != 0) {
453 /*-----------------------------------------------------------------------
454 * Write a word to Flash, returns:
457 * 2 - Flash not erased
459 static int write_data (flash_info_t *info, uchar *dest, uchar data)
461 vu_char *addr = (vu_char *)dest;
466 /* Check if Flash is (sufficiently) erased */
467 if ((BS(*addr) & data) != data) {
470 /* Disable interrupts which might cause a timeout here */
471 flag = disable_interrupts();
473 *addr = BS(0x40); /* write setup */
476 /* re-enable interrupts if necessary */
481 start = get_timer (0);
483 while (((status = BS(*addr)) & BYTEME(0x00800080)) != BYTEME(0x00800080)) {
484 if (get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT) {
485 *addr = BS(0xFF); /* restore read mode */
490 *addr = BS(0xFF); /* restore read mode */
495 /*-----------------------------------------------------------------------