board/musenki/flash.c

   1 /*
   2  * (C) Copyright 2001
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 #include <common.h>
  25 #include <mpc824x.h>
  26
  27 #if defined(CFG_ENV_IS_IN_FLASH)
  28 # ifndef  CFG_ENV_ADDR
  29 #  define CFG_ENV_ADDR  (CFG_FLASH_BASE + CFG_ENV_OFFSET)
  30 # endif
  31 # ifndef  CFG_ENV_SIZE
  32 #  define CFG_ENV_SIZE  CFG_ENV_SECT_SIZE
  33 # endif
  34 # ifndef  CFG_ENV_SECT_SIZE
  35 #  define CFG_ENV_SECT_SIZE  CFG_ENV_SIZE
  36 # endif
  37 #endif
  38
  39 /*---------------------------------------------------------------------*/
  40 #undef DEBUG_FLASH
  41
  42 #ifdef DEBUG_FLASH
  43 #define DEBUGF(fmt,args...) printf(fmt ,##args)
  44 #else
  45 #define DEBUGF(fmt,args...)
  46 #endif
  47 /*---------------------------------------------------------------------*/
  48
  49 flash_info_t    flash_info[CFG_MAX_FLASH_BANKS]; /* info for FLASH chips        */
  50
  51 /*-----------------------------------------------------------------------
  52  * Functions
  53  */
  54 static ulong flash_get_size (vu_char *addr, flash_info_t *info);
  55 static int write_data (flash_info_t *info, uchar *dest, uchar data);
  56 static void flash_get_offsets (ulong base, flash_info_t *info);
  57
  58
  59
  60 /*
  61  * don't ask.  its stupid, but more than one soul has had to live with this mistake
  62  * "swaptab[i]" is the value of "i" with the bits reversed.
  63  */
  64
  65 #define  MUSENKI_BROKEN_FLASH 1
  66
  67 #ifdef MUSENKI_BROKEN_FLASH
  68 unsigned char swaptab[256] = {
  69   0x00, 0x80, 0x40, 0xc0, 0x20, 0xa0, 0x60, 0xe0,
  70   0x10, 0x90, 0x50, 0xd0, 0x30, 0xb0, 0x70, 0xf0,
  71   0x08, 0x88, 0x48, 0xc8, 0x28, 0xa8, 0x68, 0xe8,
  72   0x18, 0x98, 0x58, 0xd8, 0x38, 0xb8, 0x78, 0xf8,
  73   0x04, 0x84, 0x44, 0xc4, 0x24, 0xa4, 0x64, 0xe4,
  74   0x14, 0x94, 0x54, 0xd4, 0x34, 0xb4, 0x74, 0xf4,
  75   0x0c, 0x8c, 0x4c, 0xcc, 0x2c, 0xac, 0x6c, 0xec,
  76   0x1c, 0x9c, 0x5c, 0xdc, 0x3c, 0xbc, 0x7c, 0xfc,
  77   0x02, 0x82, 0x42, 0xc2, 0x22, 0xa2, 0x62, 0xe2,
  78   0x12, 0x92, 0x52, 0xd2, 0x32, 0xb2, 0x72, 0xf2,
  79   0x0a, 0x8a, 0x4a, 0xca, 0x2a, 0xaa, 0x6a, 0xea,
  80   0x1a, 0x9a, 0x5a, 0xda, 0x3a, 0xba, 0x7a, 0xfa,
  81   0x06, 0x86, 0x46, 0xc6, 0x26, 0xa6, 0x66, 0xe6,
  82   0x16, 0x96, 0x56, 0xd6, 0x36, 0xb6, 0x76, 0xf6,
  83   0x0e, 0x8e, 0x4e, 0xce, 0x2e, 0xae, 0x6e, 0xee,
  84   0x1e, 0x9e, 0x5e, 0xde, 0x3e, 0xbe, 0x7e, 0xfe,
  85   0x01, 0x81, 0x41, 0xc1, 0x21, 0xa1, 0x61, 0xe1,
  86   0x11, 0x91, 0x51, 0xd1, 0x31, 0xb1, 0x71, 0xf1,
  87   0x09, 0x89, 0x49, 0xc9, 0x29, 0xa9, 0x69, 0xe9,
  88   0x19, 0x99, 0x59, 0xd9, 0x39, 0xb9, 0x79, 0xf9,
  89   0x05, 0x85, 0x45, 0xc5, 0x25, 0xa5, 0x65, 0xe5,
  90   0x15, 0x95, 0x55, 0xd5, 0x35, 0xb5, 0x75, 0xf5,
  91   0x0d, 0x8d, 0x4d, 0xcd, 0x2d, 0xad, 0x6d, 0xed,
  92   0x1d, 0x9d, 0x5d, 0xdd, 0x3d, 0xbd, 0x7d, 0xfd,
  93   0x03, 0x83, 0x43, 0xc3, 0x23, 0xa3, 0x63, 0xe3,
  94   0x13, 0x93, 0x53, 0xd3, 0x33, 0xb3, 0x73, 0xf3,
  95   0x0b, 0x8b, 0x4b, 0xcb, 0x2b, 0xab, 0x6b, 0xeb,
  96   0x1b, 0x9b, 0x5b, 0xdb, 0x3b, 0xbb, 0x7b, 0xfb,
  97   0x07, 0x87, 0x47, 0xc7, 0x27, 0xa7, 0x67, 0xe7,
  98   0x17, 0x97, 0x57, 0xd7, 0x37, 0xb7, 0x77, 0xf7,
  99   0x0f, 0x8f, 0x4f, 0xcf, 0x2f, 0xaf, 0x6f, 0xef,
 100   0x1f, 0x9f, 0x5f, 0xdf, 0x3f, 0xbf, 0x7f, 0xff,
 101 };
 102
 103 #define BS(b)     (swaptab[b])
 104
 105 #else
 106
 107 #define BS(b)     (b)
 108
 109 #endif
 110
 111 #define BYTEME(x) ((x) & 0xFF)
 112
 113 /*-----------------------------------------------------------------------
 114  */
 115
 116 unsigned long flash_init (void)
 117 {
 118         unsigned long size_b0, size_b1;
 119         int i;
 120
 121         /* Init: no FLASHes known */
 122         for (i=0; i<CFG_MAX_FLASH_BANKS; ++i) {
 123                 flash_info[i].flash_id = FLASH_UNKNOWN;
 124         }
 125
 126         /* Static FLASH Bank configuration here - FIXME XXX */
 127
 128         DEBUGF("\n## Get flash bank 1 size @ 0x%08x\n",CFG_FLASH_BASE0_PRELIM);
 129
 130         size_b0 = flash_get_size((vu_char *)CFG_FLASH_BASE0_PRELIM, &flash_info[0]);
 131
 132         if (flash_info[0].flash_id == FLASH_UNKNOWN) {
 133                 printf ("## Unknown FLASH on Bank 0: "
 134                         "ID 0x%lx, Size = 0x%08lx = %ld MB\n",
 135                         flash_info[0].flash_id,
 136                         size_b0, size_b0<<20);
 137         }
 138
 139         DEBUGF("## Get flash bank 2 size @ 0x%08x\n",CFG_FLASH_BASE1_PRELIM);
 140         size_b1 = flash_get_size((vu_char *)CFG_FLASH_BASE1_PRELIM, &flash_info[1]);
 141
 142         DEBUGF("## Prelim. Flash bank sizes: %08lx + 0x%08lx\n",size_b0,size_b1);
 143
 144         flash_get_offsets (CFG_FLASH_BASE, &flash_info[0]);
 145
 146         flash_info[0].size = size_b0;
 147
 148 #if CFG_MONITOR_BASE >= CFG_FLASH_BASE
 149         DEBUGF("protect monitor %x @ %x\n", CFG_MONITOR_BASE, monitor_flash_len);
 150         /* monitor protection ON by default */
 151         flash_protect(FLAG_PROTECT_SET,
 152                       CFG_MONITOR_BASE,
 153                       CFG_MONITOR_BASE+monitor_flash_len-1,
 154                       &flash_info[0]);
 155 #endif
 156
 157 #ifdef  CFG_ENV_IS_IN_FLASH
 158         /* ENV protection ON by default */
 159         DEBUGF("protect environtment %x @ %x\n", CFG_ENV_ADDR, CFG_ENV_SECT_SIZE);
 160         flash_protect(FLAG_PROTECT_SET,
 161                       CFG_ENV_ADDR,
 162                       CFG_ENV_ADDR+CFG_ENV_SECT_SIZE-1,
 163                       &flash_info[0]);
 164 #endif
 165
 166         if (size_b1) {
 167                 flash_info[1].size = size_b1;
 168                 flash_get_offsets (CFG_FLASH_BASE + size_b0, &flash_info[1]);
 169
 170 #if CFG_MONITOR_BASE >= CFG_FLASH_BASE
 171                 /* monitor protection ON by default */
 172                 flash_protect(FLAG_PROTECT_SET,
 173                               CFG_MONITOR_BASE,
 174                               CFG_MONITOR_BASE+monitor_flash_len-1,
 175                               &flash_info[1]);
 176 #endif
 177
 178 #ifdef  CFG_ENV_IS_IN_FLASH
 179                 /* ENV protection ON by default */
 180                 flash_protect(FLAG_PROTECT_SET,
 181                               CFG_ENV_ADDR,
 182                               CFG_ENV_ADDR+CFG_ENV_SECT_SIZE-1,
 183                               &flash_info[1]);
 184 #endif
 185         } else {
 186                 flash_info[1].flash_id = FLASH_UNKNOWN;
 187                 flash_info[1].sector_count = -1;
 188                 flash_info[1].size = 0;
 189         }
 190
 191         DEBUGF("## Final Flash bank sizes: %08lx + 0x%08lx\n",size_b0,size_b1);
 192
 193         return (size_b0 + size_b1);
 194 }
 195
 196 /*-----------------------------------------------------------------------
 197  */
 198 static void flash_get_offsets (ulong base, flash_info_t *info)
 199 {
 200         int i;
 201
 202         if (info->flash_id == FLASH_UNKNOWN) {
 203                 return;
 204         }
 205
 206         switch (info->flash_id & FLASH_VENDMASK) {
 207         case FLASH_MAN_INTEL:
 208             for (i = 0; i < info->sector_count; i++) {
 209                 info->start[i] = base;
 210                 base += 0x00020000;             /* 128k per bank */
 211             }
 212             return;
 213
 214         default:
 215             printf ("Don't know sector ofsets for flash type 0x%lx\n", info->flash_id);
 216             return;
 217         }
 218 }
 219
 220 /*-----------------------------------------------------------------------
 221  */
 222 void flash_print_info  (flash_info_t *info)
 223 {
 224         int i;
 225
 226         if (info->flash_id == FLASH_UNKNOWN) {
 227                 printf ("missing or unknown FLASH type\n");
 228                 return;
 229         }
 230
 231         switch (info->flash_id & FLASH_VENDMASK) {
 232         case FLASH_MAN_AMD:     printf ("AMD ");                break;
 233         case FLASH_MAN_FUJ:     printf ("Fujitsu ");            break;
 234         case FLASH_MAN_SST:     printf ("SST ");                break;
 235         case FLASH_MAN_STM:     printf ("STM ");                break;
 236         case FLASH_MAN_INTEL:   printf ("Intel ");              break;
 237         case FLASH_MAN_MT:      printf ("MT ");                 break;
 238         default:                printf ("Unknown Vendor ");     break;
 239         }
 240
 241         switch (info->flash_id & FLASH_TYPEMASK) {
 242         case FLASH_28F320J3A:   printf ("28F320J3A (32Mbit = 128K x 32)\n");
 243                                 break;
 244         case FLASH_28F640J3A:   printf ("28F640J3A (64Mbit = 128K x 64)\n");
 245                                 break;
 246         case FLASH_28F128J3A:   printf ("28F128J3A (128Mbit = 128K x 128)\n");
 247                                 break;
 248         default:                printf ("Unknown Chip Type\n");
 249                                 break;
 250         }
 251
 252         if (info->size >= (1 << 20)) {
 253                 i = 20;
 254         } else {
 255                 i = 10;
 256         }
 257         printf ("  Size: %ld %cB in %d Sectors\n",
 258                 info->size >> i,
 259                 (i == 20) ? 'M' : 'k',
 260                 info->sector_count);
 261
 262         printf ("  Sector Start Addresses:");
 263         for (i=0; i<info->sector_count; ++i) {
 264                 if ((i % 5) == 0)
 265                         printf ("\n   ");
 266                 printf (" %08lX%s",
 267                         info->start[i],
 268                         info->protect[i] ? " (RO)" : "     "
 269                 );
 270         }
 271         printf ("\n");
 272         return;
 273 }
 274
 275 /*-----------------------------------------------------------------------
 276  */
 277
 278
 279 /*-----------------------------------------------------------------------
 280  */
 281
 282 /*
 283  * The following code cannot be run from FLASH!
 284  */
 285 static ulong flash_get_size (vu_char *addr, flash_info_t *info)
 286 {
 287         vu_char manuf, device;
 288
 289         addr[0] = BS(0x90);
 290         manuf = BS(addr[0]);
 291         DEBUGF("Manuf. ID @ 0x%08lx: 0x%08x\n", (vu_char *)addr, manuf);
 292
 293         switch (manuf) {
 294         case BYTEME(AMD_MANUFACT):
 295                 info->flash_id = FLASH_MAN_AMD;
 296                 break;
 297         case BYTEME(FUJ_MANUFACT):
 298                 info->flash_id = FLASH_MAN_FUJ;
 299                 break;
 300         case BYTEME(SST_MANUFACT):
 301                 info->flash_id = FLASH_MAN_SST;
 302                 break;
 303         case BYTEME(STM_MANUFACT):
 304                 info->flash_id = FLASH_MAN_STM;
 305                 break;
 306         case BYTEME(INTEL_MANUFACT):
 307                 info->flash_id = FLASH_MAN_INTEL;
 308                 break;
 309         default:
 310                 info->flash_id = FLASH_UNKNOWN;
 311                 info->sector_count = 0;
 312                 info->size = 0;
 313                 addr[0] = BS(0xFF);             /* restore read mode, (yes, BS is a NOP) */
 314                 return 0;                       /* no or unknown flash  */
 315         }
 316
 317         device = BS(addr[2]);                   /* device ID            */
 318
 319         DEBUGF("Device ID @ 0x%08x: 0x%08x\n", (&addr[1]), device);
 320
 321         switch (device) {
 322         case BYTEME(INTEL_ID_28F320J3A):
 323                 info->flash_id += FLASH_28F320J3A;
 324                 info->sector_count = 32;
 325                 info->size = 0x00400000;
 326                 break;                          /* =>  4 MB             */
 327
 328         case BYTEME(INTEL_ID_28F640J3A):
 329                 info->flash_id += FLASH_28F640J3A;
 330                 info->sector_count = 64;
 331                 info->size = 0x00800000;
 332                 break;                          /* => 8 MB              */
 333
 334         case BYTEME(INTEL_ID_28F128J3A):
 335                 info->flash_id += FLASH_28F128J3A;
 336                 info->sector_count = 128;
 337                 info->size = 0x01000000;
 338                 break;                          /* => 16 MB             */
 339
 340         default:
 341                 info->flash_id = FLASH_UNKNOWN;
 342                 addr[0] = BS(0xFF);             /* restore read mode (yes, a NOP) */
 343                 return 0;                       /* => no or unknown flash */
 344
 345         }
 346
 347         if (info->sector_count > CFG_MAX_FLASH_SECT) {
 348                 printf ("** ERROR: sector count %d > max (%d) **\n",
 349                         info->sector_count, CFG_MAX_FLASH_SECT);
 350                 info->sector_count = CFG_MAX_FLASH_SECT;
 351         }
 352
 353         addr[0] = BS(0xFF);             /* restore read mode */
 354
 355         return (info->size);
 356 }
 357
 358
 359 /*-----------------------------------------------------------------------
 360  */
 361
 362 int     flash_erase (flash_info_t *info, int s_first, int s_last)
 363 {
 364         int flag, prot, sect;
 365         ulong start, now, last;
 366
 367         if ((s_first < 0) || (s_first > s_last)) {
 368                 if (info->flash_id == FLASH_UNKNOWN) {
 369                         printf ("- missing\n");
 370                 } else {
 371                         printf ("- no sectors to erase\n");
 372                 }
 373                 return 1;
 374         }
 375
 376         if ((info->flash_id & FLASH_VENDMASK) != FLASH_MAN_INTEL) {
 377                 printf ("Can erase only Intel flash types - aborted\n");
 378                 return 1;
 379         }
 380
 381         prot = 0;
 382         for (sect=s_first; sect<=s_last; ++sect) {
 383                 if (info->protect[sect]) {
 384                         prot++;
 385                 }
 386         }
 387
 388         if (prot) {
 389                 printf ("- Warning: %d protected sectors will not be erased!\n", prot);
 390         } else {
 391                 printf ("\n");
 392         }
 393
 394         start = get_timer (0);
 395         last  = start;
 396         /* Start erase on unprotected sectors */
 397         for (sect = s_first; sect<=s_last; sect++) {
 398                 if (info->protect[sect] == 0) { /* not protected */
 399                         vu_char *addr = (vu_char *)(info->start[sect]);
 400                         unsigned long status;
 401
 402                         /* Disable interrupts which might cause a timeout here */
 403                         flag = disable_interrupts();
 404
 405                         *addr = BS(0x50);       /* clear status register */
 406                         *addr = BS(0x20);       /* erase setup */
 407                         *addr = BS(0xD0);       /* erase confirm */
 408
 409                         /* re-enable interrupts if necessary */
 410                         if (flag) {
 411                                 enable_interrupts();
 412                         }
 413
 414                         /* wait at least 80us - let's wait 1 ms */
 415                         udelay (1000);
 416
 417                         while (((status = BS(*addr)) & BYTEME(0x00800080)) != BYTEME(0x00800080)) {
 418                                 if ((now=get_timer(start)) > CFG_FLASH_ERASE_TOUT) {
 419                                         printf ("Timeout\n");
 420                                         *addr = BS(0xB0); /* suspend erase        */
 421                                         *addr = BS(0xFF); /* reset to read mode */
 422                                         return 1;
 423                                 }
 424
 425                                 /* show that we're waiting */
 426                                 if ((now - last) > 1000) {      /* every second */
 427                                         putc ('.');
 428                                         last = now;
 429                                 }
 430                         }
 431
 432                         *addr = BS(0xFF);       /* reset to read mode */
 433                 }
 434         }
 435         printf (" done\n");
 436         return 0;
 437 }
 438
 439 /*-----------------------------------------------------------------------
 440  * Copy memory to flash, returns:
 441  * 0 - OK
 442  * 1 - write timeout
 443  * 2 - Flash not erased
 444  * 4 - Flash not identified
 445  */
 446
 447 #define FLASH_WIDTH     1       /* flash bus width in bytes */
 448
 449 int write_buff (flash_info_t *info, uchar *src, ulong addr, ulong cnt)
 450 {
 451         uchar *wp = (uchar *)addr;
 452         int rc;
 453
 454         if (info->flash_id == FLASH_UNKNOWN) {
 455                 return 4;
 456         }
 457
 458         while (cnt > 0) {
 459                 if ((rc = write_data(info, wp, *src)) != 0) {
 460                         return rc;
 461                 }
 462                 wp++;
 463                 src++;
 464                 cnt--;
 465         }
 466
 467         return cnt;
 468 }
 469
 470 /*-----------------------------------------------------------------------
 471  * Write a word to Flash, returns:
 472  * 0 - OK
 473  * 1 - write timeout
 474  * 2 - Flash not erased
 475  */
 476 static int write_data (flash_info_t *info, uchar *dest, uchar data)
 477 {
 478         vu_char *addr = (vu_char *)dest;
 479         ulong status;
 480         ulong start;
 481         int flag;
 482
 483         /* Check if Flash is (sufficiently) erased */
 484         if ((BS(*addr) & data) != data) {
 485                 return 2;
 486         }
 487         /* Disable interrupts which might cause a timeout here */
 488         flag = disable_interrupts();
 489
 490         *addr = BS(0x40);               /* write setup */
 491         *addr = data;
 492
 493         /* re-enable interrupts if necessary */
 494         if (flag) {
 495                 enable_interrupts();
 496         }
 497
 498         start = get_timer (0);
 499
 500         while (((status = BS(*addr)) & BYTEME(0x00800080)) != BYTEME(0x00800080)) {
 501                 if (get_timer(start) > CFG_FLASH_WRITE_TOUT) {
 502                         *addr = BS(0xFF);       /* restore read mode */
 503                         return 1;
 504                 }
 505         }
 506
 507         *addr = BS(0xFF);       /* restore read mode */
 508
 509         return 0;
 510 }
 511
 512 /*-----------------------------------------------------------------------
 513  */