board/mpc8560ads/flash.c

   1 /*
   2  * (C) Copyright 2003 Motorola Inc.
   3  *  Xianghua Xiao,(X.Xiao@motorola.com)
   4  *
   5  * (C) Copyright 2000, 2001
   6  *  Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   7  *
   8  * (C) Copyright 2001, Stuart Hughes, Lineo Inc, stuarth@lineo.com
   9  * Add support the Sharp chips on the mpc8260ads.
  10  * I started with board/ip860/flash.c and made changes I found in
  11  * the MTD project by David Schleef.
  12  *
  13  * See file CREDITS for list of people who contributed to this
  14  * project.
  15  *
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License as
  18  * published by the Free Software Foundation; either version 2 of
  19  * the License, or (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public License
  27  * along with this program; if not, write to the Free Software
  28  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  * MA 02111-1307 USA
  30  */
  31
  32 #include <common.h>
  33
  34 #if !defined(CFG_NO_FLASH)
  35
  36 flash_info_t    flash_info[CFG_MAX_FLASH_BANKS]; /* info for FLASH chips        */
  37
  38 #if defined(CFG_ENV_IS_IN_FLASH)
  39 # ifndef  CFG_ENV_ADDR
  40 #  define CFG_ENV_ADDR  (CFG_FLASH_BASE + CFG_ENV_OFFSET)
  41 # endif
  42 # ifndef  CFG_ENV_SIZE
  43 #  define CFG_ENV_SIZE  CFG_ENV_SECT_SIZE
  44 # endif
  45 # ifndef  CFG_ENV_SECT_SIZE
  46 #  define CFG_ENV_SECT_SIZE  CFG_ENV_SIZE
  47 # endif
  48 #endif
  49
  50 #undef DEBUG
  51
  52 /*-----------------------------------------------------------------------
  53  * Functions
  54  */
  55 static ulong flash_get_size (vu_long *addr, flash_info_t *info);
  56 static int write_word (flash_info_t *info, ulong dest, ulong data);
  57 static int clear_block_lock_bit(vu_long * addr);
  58 /*-----------------------------------------------------------------------
  59  */
  60
  61 unsigned long flash_init (void)
  62 {
  63         unsigned long size;
  64         int i;
  65
  66         /* Init: enable write,
  67          * or we cannot even write flash commands
  68          */
  69         for (i=0; i<CFG_MAX_FLASH_BANKS; ++i) {
  70                 flash_info[i].flash_id = FLASH_UNKNOWN;
  71
  72                 /* set the default sector offset */
  73         }
  74
  75         /* Static FLASH Bank configuration here - FIXME XXX */
  76
  77         size = flash_get_size((vu_long *)CFG_FLASH_BASE, &flash_info[0]);
  78
  79         if (flash_info[0].flash_id == FLASH_UNKNOWN) {
  80                 printf ("## Unknown FLASH on Bank 0 - Size = 0x%08lx = %ld MB\n",
  81                         size, size<<20);
  82         }
  83
  84         /* Re-do sizing to get full correct info */
  85         size = flash_get_size((vu_long *)CFG_FLASH_BASE, &flash_info[0]);
  86
  87         flash_info[0].size = size;
  88
  89 #if CFG_MONITOR_BASE >= CFG_FLASH_BASE
  90         /* monitor protection ON by default */
  91         flash_protect(FLAG_PROTECT_SET,
  92                       CFG_MONITOR_BASE,
  93                       CFG_MONITOR_BASE+monitor_flash_len-1,
  94                       &flash_info[0]);
  95
  96 #ifdef  CFG_ENV_IS_IN_FLASH
  97         /* ENV protection ON by default */
  98         flash_protect(FLAG_PROTECT_SET,
  99                       CFG_ENV_ADDR,
 100                       CFG_ENV_ADDR+CFG_ENV_SECT_SIZE-1,
 101                       &flash_info[0]);
 102 #endif
 103 #endif
 104         return (size);
 105 }
 106
 107 /*-----------------------------------------------------------------------
 108  */
 109 void flash_print_info  (flash_info_t *info)
 110 {
 111         int i;
 112
 113         if (info->flash_id == FLASH_UNKNOWN) {
 114                 printf ("missing or unknown FLASH type\n");
 115                 return;
 116         }
 117
 118         switch (info->flash_id & FLASH_VENDMASK) {
 119         case FLASH_MAN_INTEL:   printf ("Intel ");              break;
 120         case FLASH_MAN_SHARP:   printf ("Sharp ");              break;
 121         default:                printf ("Unknown Vendor ");     break;
 122         }
 123
 124         switch (info->flash_id & FLASH_TYPEMASK) {
 125         case FLASH_28F016SV:    printf ("28F016SV (16 Mbit, 32 x 64k)\n");
 126                                 break;
 127         case FLASH_28F160S3:    printf ("28F160S3 (16 Mbit, 32 x 512K)\n");
 128                                 break;
 129         case FLASH_28F320S3:    printf ("28F320S3 (32 Mbit, 64 x 512K)\n");
 130                                 break;
 131         case FLASH_LH28F016SCT: printf ("28F016SC (16 Mbit, 32 x 64K)\n");
 132                                 break;
 133         case FLASH_28F640J3A:   printf ("28F640J3A (64 Mbit, 64 x 128K)\n");
 134                                 break;
 135         default:                printf ("Unknown Chip Type\n");
 136                                 break;
 137         }
 138
 139         printf ("  Size: %ld MB in %d Sectors\n",
 140                 info->size >> 20, info->sector_count);
 141
 142         printf ("  Sector Start Addresses:");
 143         for (i=0; i<info->sector_count; ++i) {
 144                 if ((i % 5) == 0)
 145                         printf ("\n   ");
 146                 printf (" %08lX%s",
 147                         info->start[i],
 148                         info->protect[i] ? " (RO)" : "     "
 149                 );
 150         }
 151         printf ("\n");
 152 }
 153
 154 /*
 155  * The following code cannot be run from FLASH!
 156  */
 157
 158 static ulong flash_get_size (vu_long *addr, flash_info_t *info)
 159 {
 160         short i;
 161         ulong value;
 162         ulong base = (ulong)addr;
 163         ulong sector_offset;
 164
 165 #ifdef DEBUG
 166         printf("Check flash at 0x%08x\n",(uint)addr);
 167 #endif
 168         /* Write "Intelligent Identifier" command: read Manufacturer ID */
 169         *addr = 0x90909090;
 170         udelay(20);
 171         asm("sync");
 172
 173         value = addr[0] & 0x00FF00FF;
 174
 175 #ifdef DEBUG
 176         printf("manufacturer=0x%x\n",(uint)value);
 177 #endif
 178         switch (value) {
 179         case MT_MANUFACT:       /* SHARP, MT or => Intel */
 180         case INTEL_ALT_MANU:
 181                 info->flash_id = FLASH_MAN_INTEL;
 182                 break;
 183         default:
 184                 printf("unknown manufacturer: %x\n", (unsigned int)value);
 185                 info->flash_id = FLASH_UNKNOWN;
 186                 info->sector_count = 0;
 187                 info->size = 0;
 188                 return (0);                     /* no or unknown flash  */
 189         }
 190
 191         value = addr[1] & 0x00FF00FF;             /* device ID            */
 192
 193 #ifdef DEBUG
 194         printf("deviceID=0x%x\n",(uint)value);
 195 #endif
 196         switch (value) {
 197         case (INTEL_ID_28F016S):
 198                 info->flash_id += FLASH_28F016SV;
 199                 info->sector_count = 32;
 200                 info->size = 0x00400000;
 201                 sector_offset = 0x20000;
 202                 break;                          /* => 2x2 MB            */
 203
 204         case (INTEL_ID_28F160S3):
 205                 info->flash_id += FLASH_28F160S3;
 206                 info->sector_count = 32;
 207                 info->size = 0x00400000;
 208                 sector_offset = 0x20000;
 209                 break;                          /* => 2x2 MB            */
 210
 211         case (INTEL_ID_28F320S3):
 212                 info->flash_id += FLASH_28F320S3;
 213                 info->sector_count = 64;
 214                 info->size = 0x00800000;
 215                 sector_offset = 0x20000;
 216                 break;                          /* => 2x4 MB            */
 217
 218         case (INTEL_ID_28F640J3A):
 219                 info->flash_id += FLASH_28F640J3A;
 220                 info->sector_count = 64;
 221                 info->size = 0x01000000;
 222                 sector_offset = 0x40000;
 223                 break;                          /* => 8 MB             */
 224
 225         case SHARP_ID_28F016SCL:
 226         case SHARP_ID_28F016SCZ:
 227                 info->flash_id      = FLASH_MAN_SHARP | FLASH_LH28F016SCT;
 228                 info->sector_count  = 32;
 229                 info->size          = 0x00800000;
 230                 sector_offset = 0x40000;
 231                 break;                          /* => 4x2 MB            */
 232
 233
 234         default:
 235                 info->flash_id = FLASH_UNKNOWN;
 236                 return (0);                     /* => no or unknown flash */
 237
 238         }
 239
 240         /* set up sector start address table */
 241         for (i = 0; i < info->sector_count; i++) {
 242                 info->start[i] = base;
 243                 base += sector_offset;
 244                 /* don't know how to check sector protection */
 245                 info->protect[i] = 0;
 246         }
 247
 248         /*
 249          * Prevent writes to uninitialized FLASH.
 250          */
 251         if (info->flash_id != FLASH_UNKNOWN) {
 252                 addr = (vu_long *)info->start[0];
 253                 *addr = 0xFFFFFF;       /* reset bank to read array mode */
 254                 asm("sync");
 255         }
 256
 257         return (info->size);
 258 }
 259
 260
 261 /*-----------------------------------------------------------------------
 262  */
 263
 264 int     flash_erase (flash_info_t *info, int s_first, int s_last)
 265 {
 266         int flag, prot, sect;
 267         ulong start, now, last;
 268
 269         if ((s_first < 0) || (s_first > s_last)) {
 270                 if (info->flash_id == FLASH_UNKNOWN) {
 271                         printf ("- missing\n");
 272                 } else {
 273                         printf ("- no sectors to erase\n");
 274                 }
 275                 return 1;
 276         }
 277
 278         if (    ((info->flash_id & FLASH_VENDMASK) != FLASH_MAN_INTEL)
 279              && ((info->flash_id & FLASH_VENDMASK) != FLASH_MAN_SHARP) ) {
 280                 printf ("Can't erase unknown flash type %08lx - aborted\n",
 281                         info->flash_id);
 282                 return 1;
 283         }
 284
 285         prot = 0;
 286         for (sect=s_first; sect<=s_last; ++sect) {
 287                 if (info->protect[sect]) {
 288                         prot++;
 289                 }
 290         }
 291
 292         if (prot) {
 293                 printf ("- Warning: %d protected sectors will not be erased!\n",
 294                         prot);
 295         } else {
 296                 printf ("\n");
 297         }
 298
 299 #ifdef DEBUG
 300         printf("\nFlash Erase:\n");
 301 #endif
 302         /* Make Sure Block Lock Bit is not set. */
 303         if(clear_block_lock_bit((vu_long *)(info->start[s_first]))){
 304                 return 1;
 305         }
 306
 307         /* Start erase on unprotected sectors */
 308 #if defined(DEBUG)
 309         printf("Begin to erase now,s_first=0x%x s_last=0x%x...\n",s_first,s_last);
 310 #endif
 311         for (sect = s_first; sect<=s_last; sect++) {
 312                 if (info->protect[sect] == 0) { /* not protected */
 313                         vu_long *addr = (vu_long *)(info->start[sect]);
 314                         asm("sync");
 315
 316                         last = start = get_timer (0);
 317
 318                         /* Disable interrupts which might cause a timeout here */
 319                         flag = disable_interrupts();
 320
 321                         /* Reset Array */
 322                         *addr = 0xffffffff;
 323                         asm("sync");
 324                         /* Clear Status Register */
 325                         *addr = 0x50505050;
 326                         asm("sync");
 327                         /* Single Block Erase Command */
 328                         *addr = 0x20202020;
 329                         asm("sync");
 330                         /* Confirm */
 331                         *addr = 0xD0D0D0D0;
 332                         asm("sync");
 333
 334                         if((info->flash_id & FLASH_TYPEMASK) != FLASH_LH28F016SCT) {
 335                             /* Resume Command, as per errata update */
 336                             *addr = 0xD0D0D0D0;
 337                             asm("sync");
 338                         }
 339
 340                         /* re-enable interrupts if necessary */
 341                         if (flag)
 342                                 enable_interrupts();
 343
 344                         /* wait at least 80us - let's wait 1 ms */
 345                         udelay (1000);
 346                         while ((*addr & 0x00800080) != 0x00800080) {
 347                                 if(*addr & 0x00200020){
 348                                         printf("Error in Block Erase - Lock Bit may be set!\n");
 349                                         printf("Status Register = 0x%X\n", (uint)*addr);
 350                                         *addr = 0xFFFFFFFF;     /* reset bank */
 351                                         asm("sync");
 352                                         return 1;
 353                                 }
 354                                 if ((now=get_timer(start)) > CFG_FLASH_ERASE_TOUT) {
 355                                         printf ("Timeout\n");
 356                                         *addr = 0xFFFFFFFF;     /* reset bank */
 357                                         asm("sync");
 358                                         return 1;
 359                                 }
 360                                 /* show that we're waiting */
 361                                 if ((now - last) > 1000) {      /* every second */
 362                                         putc ('.');
 363                                         last = now;
 364                                 }
 365                         }
 366
 367                         /* reset to read mode */
 368                         *addr = 0xFFFFFFFF;
 369                         asm("sync");
 370                 }
 371         }
 372
 373         printf ("flash erase done\n");
 374         return 0;
 375 }
 376
 377 /*-----------------------------------------------------------------------
 378  * Copy memory to flash, returns:
 379  * 0 - OK
 380  * 1 - write timeout
 381  * 2 - Flash not erased
 382  */
 383
 384 int write_buff (flash_info_t *info, uchar *src, ulong addr, ulong cnt)
 385 {
 386         ulong cp, wp, data;
 387         int i, l, rc;
 388
 389         wp = (addr & ~3);       /* get lower word aligned address */
 390
 391         /*
 392          * handle unaligned start bytes
 393          */
 394         if ((l = addr - wp) != 0) {
 395                 data = 0;
 396                 for (i=0, cp=wp; i<l; ++i, ++cp) {
 397                         data = (data << 8) | (*(uchar *)cp);
 398                 }
 399                 for (; i<4 && cnt>0; ++i) {
 400                         data = (data << 8) | *src++;
 401                         --cnt;
 402                         ++cp;
 403                 }
 404                 for (; cnt==0 && i<4; ++i, ++cp) {
 405                         data = (data << 8) | (*(uchar *)cp);
 406                 }
 407
 408                 if ((rc = write_word(info, wp, data)) != 0) {
 409                         return (rc);
 410                 }
 411                 wp += 4;
 412         }
 413
 414         /*
 415          * handle word aligned part
 416          */
 417         while (cnt >= 4) {
 418                 data = 0;
 419                 for (i=0; i<4; ++i) {
 420                         data = (data << 8) | *src++;
 421                 }
 422                 if ((rc = write_word(info, wp, data)) != 0) {
 423                         return (rc);
 424                 }
 425                 wp  += 4;
 426                 cnt -= 4;
 427         }
 428
 429         if (cnt == 0) {
 430                 return (0);
 431         }
 432
 433         /*
 434          * handle unaligned tail bytes
 435          */
 436         data = 0;
 437         for (i=0, cp=wp; i<4 && cnt>0; ++i, ++cp) {
 438                 data = (data << 8) | *src++;
 439                 --cnt;
 440         }
 441         for (; i<4; ++i, ++cp) {
 442                 data = (data << 8) | (*(uchar *)cp);
 443         }
 444
 445         return (write_word(info, wp, data));
 446 }
 447
 448 /*-----------------------------------------------------------------------
 449  * Write a word to Flash, returns:
 450  * 0 - OK
 451  * 1 - write timeout
 452  * 2 - Flash not erased
 453  */
 454 static int write_word (flash_info_t *info, ulong dest, ulong data)
 455 {
 456         vu_long *addr = (vu_long *)dest;
 457         ulong start, csr;
 458         int flag;
 459
 460         /* Check if Flash is (sufficiently) erased */
 461         if ((*addr & data) != data) {
 462                 return (2);
 463         }
 464         /* Disable interrupts which might cause a timeout here */
 465         flag = disable_interrupts();
 466
 467         /* Write Command */
 468         *addr = 0x10101010;
 469         asm("sync");
 470
 471         /* Write Data */
 472         *addr = data;
 473
 474         /* re-enable interrupts if necessary */
 475         if (flag)
 476                 enable_interrupts();
 477
 478         /* data polling for D7 */
 479         start = get_timer (0);
 480         flag  = 0;
 481
 482         while (((csr = *addr) & 0x00800080) != 0x00800080) {
 483                 if (get_timer(start) > CFG_FLASH_WRITE_TOUT) {
 484                         flag = 1;
 485                         break;
 486                 }
 487         }
 488         if (csr & 0x40404040) {
 489                 printf ("CSR indicates write error (%08lx) at %08lx\n", csr, (ulong)addr);
 490                 flag = 1;
 491         }
 492
 493         /* Clear Status Registers Command */
 494         *addr = 0x50505050;
 495         asm("sync");
 496         /* Reset to read array mode */
 497         *addr = 0xFFFFFFFF;
 498         asm("sync");
 499
 500         return (flag);
 501 }
 502
 503 /*-----------------------------------------------------------------------
 504  * Clear Block Lock Bit, returns:
 505  * 0 - OK
 506  * 1 - Timeout
 507  */
 508
 509 static int clear_block_lock_bit(vu_long  * addr)
 510 {
 511         ulong start, now;
 512
 513         /* Reset Array */
 514         *addr = 0xffffffff;
 515         asm("sync");
 516         /* Clear Status Register */
 517         *addr = 0x50505050;
 518         asm("sync");
 519
 520         *addr = 0x60606060;
 521         asm("sync");
 522         *addr = 0xd0d0d0d0;
 523         asm("sync");
 524
 525         start = get_timer (0);
 526         while((*addr & 0x00800080) != 0x00800080){
 527                 if ((now=get_timer(start)) > CFG_FLASH_ERASE_TOUT) {
 528                         printf ("Timeout on clearing Block Lock Bit\n");
 529                         *addr = 0xFFFFFFFF;     /* reset bank */
 530                         asm("sync");
 531                         return 1;
 532                 }
 533         }
 534         return 0;
 535 }
 536
 537 #endif /* !CFG_NO_FLASH */