board/xm250/flash.c

   1 /*
   2  * (C) Copyright 2001
   3  * Kyle Harris, Nexus Technologies, Inc. kharris@nexus-tech.net
   4  *
   5  * (C) Copyright 2001-2004
   6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   7  *
   8  * See file CREDITS for list of people who contributed to this
   9  * project.
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; either version 2 of
  14  * the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  24  * MA 02111-1307 USA
  25  */
  26
  27 #include <common.h>
  28 #include <linux/byteorder/swab.h>
  29
  30
  31 flash_info_t flash_info[CONFIG_SYS_MAX_FLASH_BANKS];    /* info for FLASH chips    */
  32
  33 /* Board support for 1 or 2 flash devices */
  34 #define FLASH_PORT_WIDTH32
  35 #undef FLASH_PORT_WIDTH16
  36
  37 #ifdef FLASH_PORT_WIDTH16
  38 #define FLASH_PORT_WIDTH                ushort
  39 #define FLASH_PORT_WIDTHV               vu_short
  40 #define SWAP(x)               __swab16(x)
  41 #else
  42 #define FLASH_PORT_WIDTH                ulong
  43 #define FLASH_PORT_WIDTHV               vu_long
  44 #define SWAP(x)               __swab32(x)
  45 #endif
  46
  47 /* Intel-compatible flash ID */
  48 #define INTEL_COMPAT  0x00890089
  49 #define INTEL_ALT     0x00B000B0
  50
  51 /* Intel-compatible flash commands */
  52 #define INTEL_PROGRAM 0x00100010
  53 #define INTEL_ERASE   0x00200020
  54 #define INTEL_CLEAR   0x00500050
  55 #define INTEL_LOCKBIT 0x00600060
  56 #define INTEL_PROTECT 0x00010001
  57 #define INTEL_STATUS  0x00700070
  58 #define INTEL_READID  0x00900090
  59 #define INTEL_CONFIRM 0x00D000D0
  60 #define INTEL_RESET   0xFFFFFFFF
  61
  62 /* Intel-compatible flash status bits */
  63 #define INTEL_FINISHED 0x00800080
  64 #define INTEL_OK       0x00800080
  65
  66 #define FPW        FLASH_PORT_WIDTH
  67 #define FPWV   FLASH_PORT_WIDTHV
  68
  69 #define mb() __asm__ __volatile__ ("" : : : "memory")
  70
  71 /*-----------------------------------------------------------------------
  72  * Functions
  73  */
  74 static ulong flash_get_size (FPW *addr, flash_info_t *info);
  75 static int write_data (flash_info_t *info, ulong dest, FPW data);
  76 static void flash_get_offsets (ulong base, flash_info_t *info);
  77 void inline spin_wheel (void);
  78
  79 /*-----------------------------------------------------------------------
  80  */
  81
  82 unsigned long flash_init (void)
  83 {
  84         int i;
  85         ulong size = 0;
  86
  87         for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
  88                 switch (i) {
  89                 case 0:
  90                         flash_get_size ((FPW *) PHYS_FLASH_1, &flash_info[i]);
  91                         flash_get_offsets (PHYS_FLASH_1, &flash_info[i]);
  92                         break;
  93                 case 1:
  94                         flash_get_size ((FPW *) PHYS_FLASH_2, &flash_info[i]);
  95                         flash_get_offsets (PHYS_FLASH_2, &flash_info[i]);
  96                         break;
  97                 default:
  98                         panic ("configured to many flash banks!\n");
  99                         break;
 100                 }
 101                 size += flash_info[i].size;
 102         }
 103
 104         /* Protect monitor and environment sectors
 105          */
 106         flash_protect ( FLAG_PROTECT_SET,
 107                         CONFIG_SYS_FLASH_BASE,
 108                         CONFIG_SYS_FLASH_BASE + monitor_flash_len - 1,
 109                         &flash_info[0] );
 110
 111         flash_protect ( FLAG_PROTECT_SET,
 112                         CONFIG_ENV_ADDR,
 113                         CONFIG_ENV_ADDR + CONFIG_ENV_SIZE - 1, &flash_info[0] );
 114
 115         return size;
 116 }
 117
 118 /*-----------------------------------------------------------------------
 119  */
 120 static void flash_get_offsets (ulong base, flash_info_t *info)
 121 {
 122         int i;
 123
 124         if (info->flash_id == FLASH_UNKNOWN) {
 125                 return;
 126         }
 127
 128         if ((info->flash_id & FLASH_VENDMASK) == FLASH_MAN_INTEL) {
 129                 for (i = 0; i < info->sector_count; i++) {
 130                         info->start[i] = base + (i * PHYS_FLASH_SECT_SIZE);
 131                         info->protect[i] = 0;
 132                 }
 133         }
 134 }
 135
 136 /*-----------------------------------------------------------------------
 137  */
 138 void flash_print_info (flash_info_t *info)
 139 {
 140         int i;
 141
 142         if (info->flash_id == FLASH_UNKNOWN) {
 143                 printf ("missing or unknown FLASH type\n");
 144                 return;
 145         }
 146
 147         switch (info->flash_id & FLASH_VENDMASK) {
 148         case FLASH_MAN_INTEL:
 149                 printf ("INTEL ");
 150                 break;
 151         default:
 152                 printf ("Unknown Vendor ");
 153                 break;
 154         }
 155
 156         switch (info->flash_id & FLASH_TYPEMASK) {
 157         case FLASH_28F128J3A:
 158                 printf ("28F128J3A\n");
 159                 break;
 160
 161         case FLASH_28F640J3A:
 162                 printf ("28F640J3A\n");
 163                 break;
 164         default:
 165                 printf ("Unknown Chip Type\n");
 166                 break;
 167         }
 168
 169         printf ("  Size: %ld MB in %d Sectors\n",
 170                         info->size >> 20, info->sector_count);
 171
 172         printf ("  Sector Start Addresses:");
 173         for (i = 0; i < info->sector_count; ++i) {
 174                 if ((i % 5) == 0)
 175                         printf ("\n   ");
 176                 printf (" %08lX%s",
 177                         info->start[i],
 178                         info->protect[i] ? " (RO)" : "     ");
 179         }
 180         printf ("\n");
 181         return;
 182 }
 183
 184 /*
 185  * The following code cannot be run from FLASH!
 186  */
 187 static ulong flash_get_size (FPW *addr, flash_info_t *info)
 188 {
 189         volatile FPW value;
 190
 191         /* Write auto select command: read Manufacturer ID */
 192         addr[0x5555] = (FPW) 0x00AA00AA;
 193         addr[0x2AAA] = (FPW) 0x00550055;
 194         addr[0x5555] = (FPW) 0x00900090;
 195
 196         mb ();
 197         value = addr[0];
 198
 199         switch (value) {
 200
 201         case (FPW) INTEL_MANUFACT:
 202                 info->flash_id = FLASH_MAN_INTEL;
 203                 break;
 204
 205         default:
 206                 info->flash_id = FLASH_UNKNOWN;
 207                 info->sector_count = 0;
 208                 info->size = 0;
 209                 addr[0] = (FPW) 0x00FF00FF;     /* restore read mode */
 210                 return (0);                     /* no or unknown flash  */
 211         }
 212
 213         mb ();
 214         value = addr[1];                        /* device ID        */
 215
 216         switch (value) {
 217
 218         case (FPW) INTEL_ID_28F128J3A:
 219                 info->flash_id += FLASH_28F128J3A;
 220                 info->sector_count = 128;
 221                 info->size = 0x02000000;
 222                 break;                          /* => 32 MB     */
 223
 224         case (FPW) INTEL_ID_28F640J3A:
 225                 info->flash_id += FLASH_28F640J3A;
 226                 info->sector_count = 64;
 227                 info->size = 0x01000000;
 228                 break;                          /* => 16 MB     */
 229
 230         default:
 231                 info->flash_id = FLASH_UNKNOWN;
 232                 break;
 233         }
 234
 235         if (info->sector_count > CONFIG_SYS_MAX_FLASH_SECT) {
 236                 printf ("** ERROR: sector count %d > max (%d) **\n",
 237                         info->sector_count, CONFIG_SYS_MAX_FLASH_SECT);
 238                 info->sector_count = CONFIG_SYS_MAX_FLASH_SECT;
 239         }
 240
 241         addr[0] = (FPW) 0x00FF00FF;             /* restore read mode */
 242
 243         return (info->size);
 244 }
 245
 246
 247 /*-----------------------------------------------------------------------
 248  */
 249
 250 int flash_erase (flash_info_t *info, int s_first, int s_last)
 251 {
 252         int flag, prot, sect;
 253         ulong type, start;
 254         int rcode = 0;
 255
 256         if ((s_first < 0) || (s_first > s_last)) {
 257                 if (info->flash_id == FLASH_UNKNOWN) {
 258                         printf ("- missing\n");
 259                 } else {
 260                         printf ("- no sectors to erase\n");
 261                 }
 262                 return 1;
 263         }
 264
 265         type = (info->flash_id & FLASH_VENDMASK);
 266         if ((type != FLASH_MAN_INTEL)) {
 267                 printf ("Can't erase unknown flash type %08lx - aborted\n",
 268                         info->flash_id);
 269                 return 1;
 270         }
 271
 272         prot = 0;
 273         for (sect = s_first; sect <= s_last; ++sect) {
 274                 if (info->protect[sect]) {
 275                         prot++;
 276                 }
 277         }
 278
 279         if (prot) {
 280                 printf ("- Warning: %d protected sectors will not be erased!\n",
 281                         prot);
 282         } else {
 283                 printf ("\n");
 284         }
 285
 286         /* Disable interrupts which might cause a timeout here */
 287         flag = disable_interrupts ();
 288
 289         /* Start erase on unprotected sectors */
 290         for (sect = s_first; sect <= s_last; sect++) {
 291                 if (info->protect[sect] == 0) { /* not protected */
 292                         FPWV *addr = (FPWV *) (info->start[sect]);
 293                         FPW status;
 294
 295                         printf ("Erasing sector %2d ... ", sect);
 296
 297                         /* arm simple, non interrupt dependent timer */
 298                         start = get_timer(0);
 299
 300                         *addr = (FPW) 0x00500050;       /* clear status register */
 301                         *addr = (FPW) 0x00200020;       /* erase setup */
 302                         *addr = (FPW) 0x00D000D0;       /* erase confirm */
 303
 304                         while (((status = *addr) & (FPW) 0x00800080) != (FPW) 0x00800080) {
 305                                 if (get_timer(start) > CONFIG_SYS_FLASH_ERASE_TOUT) {
 306                                         printf ("Timeout\n");
 307                                         *addr = (FPW) 0x00B000B0;       /* suspend erase     */
 308                                         *addr = (FPW) 0x00FF00FF;       /* reset to read mode */
 309                                         rcode = 1;
 310                                         break;
 311                                 }
 312                         }
 313
 314                         *addr = 0x00500050;     /* clear status register cmd.   */
 315                         *addr = 0x00FF00FF;     /* resest to read mode          */
 316
 317                         printf (" done\n");
 318                 }
 319         }
 320         return rcode;
 321 }
 322
 323 /*-----------------------------------------------------------------------
 324  * Copy memory to flash, returns:
 325  * 0 - OK
 326  * 1 - write timeout
 327  * 2 - Flash not erased
 328  * 4 - Flash not identified
 329  */
 330
 331 int write_buff (flash_info_t *info, uchar *src, ulong addr, ulong cnt)
 332 {
 333         ulong cp, wp;
 334         FPW data;
 335         int count, i, l, rc, port_width;
 336
 337         if (info->flash_id == FLASH_UNKNOWN) {
 338                 return 4;
 339         }
 340 /* get lower word aligned address */
 341 #ifdef FLASH_PORT_WIDTH16
 342         wp = (addr & ~1);
 343         port_width = 2;
 344 #else
 345         wp = (addr & ~3);
 346         port_width = 4;
 347 #endif
 348
 349         /*
 350          * handle unaligned start bytes
 351          */
 352         if ((l = addr - wp) != 0) {
 353                 data = 0;
 354                 for (i = 0, cp = wp; i < l; ++i, ++cp) {
 355                         data = (data << 8) | (*(uchar *) cp);
 356                 }
 357                 for (; i < port_width && cnt > 0; ++i) {
 358                         data = (data << 8) | *src++;
 359                         --cnt;
 360                         ++cp;
 361                 }
 362                 for (; cnt == 0 && i < port_width; ++i, ++cp) {
 363                         data = (data << 8) | (*(uchar *) cp);
 364                 }
 365
 366                 if ((rc = write_data (info, wp, SWAP (data))) != 0) {
 367                         return (rc);
 368                 }
 369                 wp += port_width;
 370         }
 371
 372         /*
 373          * handle word aligned part
 374          */
 375         count = 0;
 376         while (cnt >= port_width) {
 377                 data = 0;
 378                 for (i = 0; i < port_width; ++i) {
 379                         data = (data << 8) | *src++;
 380                 }
 381                 if ((rc = write_data (info, wp, SWAP (data))) != 0) {
 382                         return (rc);
 383                 }
 384                 wp += port_width;
 385                 cnt -= port_width;
 386                 if (count++ > 0x800) {
 387                         spin_wheel ();
 388                         count = 0;
 389                 }
 390         }
 391
 392         if (cnt == 0) {
 393                 return (0);
 394         }
 395
 396         /*
 397          * handle unaligned tail bytes
 398          */
 399         data = 0;
 400         for (i = 0, cp = wp; i < port_width && cnt > 0; ++i, ++cp) {
 401                 data = (data << 8) | *src++;
 402                 --cnt;
 403         }
 404         for (; i < port_width; ++i, ++cp) {
 405                 data = (data << 8) | (*(uchar *) cp);
 406         }
 407
 408         return (write_data (info, wp, SWAP (data)));
 409 }
 410
 411 /*-----------------------------------------------------------------------
 412  * Write a word or halfword to Flash, returns:
 413  * 0 - OK
 414  * 1 - write timeout
 415  * 2 - Flash not erased
 416  */
 417 static int write_data (flash_info_t *info, ulong dest, FPW data)
 418 {
 419         FPWV *addr = (FPWV *) dest;
 420         ulong status;
 421         int flag;
 422         ulong start;
 423
 424         /* Check if Flash is (sufficiently) erased */
 425         if ((*addr & data) != data) {
 426                 printf ("not erased at %08lx (%lx)\n", (ulong) addr, *addr);
 427                 return (2);
 428         }
 429         /* Disable interrupts which might cause a timeout here */
 430         flag = disable_interrupts ();
 431
 432         *addr = (FPW) 0x00400040;       /* write setup */
 433         *addr = data;
 434
 435         /* arm simple, non interrupt dependent timer */
 436         start = get_timer(0);
 437
 438         /* wait while polling the status register */
 439         while (((status = *addr) & (FPW) 0x00800080) != (FPW) 0x00800080) {
 440                 if (get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT) {
 441                         *addr = (FPW) 0x00FF00FF;       /* restore read mode */
 442                         return (1);
 443                 }
 444         }
 445
 446         *addr = (FPW) 0x00FF00FF;       /* restore read mode */
 447
 448         return (0);
 449 }
 450
 451 void inline spin_wheel (void)
 452 {
 453         static int p = 0;
 454         static char w[] = "\\/-";
 455
 456         printf ("\010%c", w[p]);
 457         (++p == 3) ? (p = 0) : 0;
 458 }
 459
 460 /*-----------------------------------------------------------------------
 461  * Set/Clear sector's lock bit, returns:
 462  * 0 - OK
 463  * 1 - Error (timeout, voltage problems, etc.)
 464  */
 465 int flash_real_protect(flash_info_t *info, long sector, int prot)
 466 {
 467         int i;
 468         int rc = 0;
 469         vu_long *addr = (vu_long *)(info->start[sector]);
 470         int flag = disable_interrupts();
 471         ulong start;
 472
 473         *addr = INTEL_CLEAR;    /* Clear status register */
 474         if (prot) {                     /* Set sector lock bit */
 475                 *addr = INTEL_LOCKBIT;  /* Sector lock bit */
 476                 *addr = INTEL_PROTECT;  /* set */
 477         }
 478         else {                          /* Clear sector lock bit */
 479                 *addr = INTEL_LOCKBIT;  /* All sectors lock bits */
 480                 *addr = INTEL_CONFIRM;  /* clear */
 481         }
 482
 483         start = get_timer(0);
 484
 485         while ((*addr & INTEL_FINISHED) != INTEL_FINISHED) {
 486                 if (get_timer(start) > CONFIG_SYS_FLASH_UNLOCK_TOUT) {
 487                         printf("Flash lock bit operation timed out\n");
 488                         rc = 1;
 489                         break;
 490                 }
 491         }
 492
 493         if (*addr != INTEL_OK) {
 494                 printf("Flash lock bit operation failed at %08X, CSR=%08X\n",
 495                        (uint)addr, (uint)*addr);
 496                 rc = 1;
 497         }
 498
 499         if (!rc)
 500                 info->protect[sector] = prot;
 501
 502         /*
 503          * Clear lock bit command clears all sectors lock bits, so
 504          * we have to restore lock bits of protected sectors.
 505          */
 506         if (!prot)
 507         {
 508                 for (i = 0; i < info->sector_count; i++)
 509                 {
 510                         if (info->protect[i])
 511                         {
 512                                 start = get_timer(0);
 513                                 addr = (vu_long *)(info->start[i]);
 514                                 *addr = INTEL_LOCKBIT;  /* Sector lock bit */
 515                                 *addr = INTEL_PROTECT;  /* set */
 516                                 while ((*addr & INTEL_FINISHED) != INTEL_FINISHED)
 517                                 {
 518                                         if (get_timer(start) > CONFIG_SYS_FLASH_UNLOCK_TOUT)
 519                                         {
 520                                                 printf("Flash lock bit operation timed out\n");
 521                                                 rc = 1;
 522                                                 break;
 523                                         }
 524                                 }
 525                         }
 526                 }
 527         }
 528
 529         if (flag)
 530                 enable_interrupts();
 531
 532         *addr = INTEL_RESET;            /* Reset to read array mode */
 533
 534         return rc;
 535 }