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