board/zylonite/flash.c

   1 /*
   2  * (C) Copyright 2001
   3  * Kyle Harris, Nexus Technologies, Inc. kharris@nexus-tech.net
   4  *
   5  * (C) Copyright 2001
   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 #define FPW        FLASH_PORT_WIDTH
  48 #define FPWV   FLASH_PORT_WIDTHV
  49
  50 #define mb() __asm__ __volatile__ ("" : : : "memory")
  51
  52 /*-----------------------------------------------------------------------
  53  * Functions
  54  */
  55 static ulong flash_get_size (FPW *addr, flash_info_t *info);
  56 static int write_data (flash_info_t *info, ulong dest, FPW data);
  57 static void flash_get_offsets (ulong base, flash_info_t *info);
  58 void inline spin_wheel (void);
  59
  60 /*-----------------------------------------------------------------------
  61  */
  62
  63 unsigned long flash_init (void)
  64 {
  65 #if 0
  66         int i;
  67         ulong size = 0;
  68
  69         for (i = 0; i < CONFIG_SYS_MAX_FLASH_BANKS; i++) {
  70                 switch (i) {
  71                 case 0:
  72                         flash_get_size ((FPW *) PHYS_FLASH_1, &flash_info[i]);
  73                         flash_get_offsets (PHYS_FLASH_1, &flash_info[i]);
  74                         break;
  75                 case 1:
  76                         flash_get_size ((FPW *) PHYS_FLASH_2, &flash_info[i]);
  77                         flash_get_offsets (PHYS_FLASH_2, &flash_info[i]);
  78                         break;
  79                 default:
  80                         panic ("configured too many flash banks!\n");
  81                         break;
  82                 }
  83                 size += flash_info[i].size;
  84         }
  85
  86         /* Protect monitor and environment sectors
  87          */
  88         flash_protect ( FLAG_PROTECT_SET,
  89                         CONFIG_SYS_FLASH_BASE,
  90                         CONFIG_SYS_FLASH_BASE + monitor_flash_len - 1,
  91                         &flash_info[0] );
  92
  93         flash_protect ( FLAG_PROTECT_SET,
  94                         CONFIG_ENV_ADDR,
  95                         CONFIG_ENV_ADDR + CONFIG_ENV_SIZE - 1, &flash_info[0] );
  96
  97         return size;
  98 #endif
  99         return 0;
 100 }
 101
 102 /*-----------------------------------------------------------------------
 103  */
 104 static void flash_get_offsets (ulong base, flash_info_t *info)
 105 {
 106         int i;
 107
 108         if (info->flash_id == FLASH_UNKNOWN) {
 109                 return;
 110         }
 111
 112         if ((info->flash_id & FLASH_VENDMASK) == FLASH_MAN_INTEL) {
 113                 for (i = 0; i < info->sector_count; i++) {
 114                         info->start[i] = base + (i * PHYS_FLASH_SECT_SIZE);
 115                         info->protect[i] = 0;
 116                 }
 117         }
 118 }
 119
 120 /*-----------------------------------------------------------------------
 121  */
 122 void flash_print_info (flash_info_t *info)
 123 {
 124         int i;
 125
 126         if (info->flash_id == FLASH_UNKNOWN) {
 127                 printf ("missing or unknown FLASH type\n");
 128                 return;
 129         }
 130
 131         switch (info->flash_id & FLASH_VENDMASK) {
 132         case FLASH_MAN_INTEL:
 133                 printf ("INTEL ");
 134                 break;
 135         default:
 136                 printf ("Unknown Vendor ");
 137                 break;
 138         }
 139
 140         switch (info->flash_id & FLASH_TYPEMASK) {
 141         case FLASH_28F128J3A:
 142                 printf ("28F128J3A\n");
 143                 break;
 144         default:
 145                 printf ("Unknown Chip Type\n");
 146                 break;
 147         }
 148
 149         printf ("  Size: %ld MB in %d Sectors\n",
 150                         info->size >> 20, info->sector_count);
 151
 152         printf ("  Sector Start Addresses:");
 153         for (i = 0; i < info->sector_count; ++i) {
 154                 if ((i % 5) == 0)
 155                         printf ("\n   ");
 156                 printf (" %08lX%s",
 157                         info->start[i],
 158                         info->protect[i] ? " (RO)" : "     ");
 159         }
 160         printf ("\n");
 161         return;
 162 }
 163
 164 /*
 165  * The following code cannot be run from FLASH!
 166  */
 167 static ulong flash_get_size (FPW *addr, flash_info_t *info)
 168 {
 169         volatile FPW value;
 170
 171         /* Write auto select command: read Manufacturer ID */
 172         addr[0x5555] = (FPW) 0x00AA00AA;
 173         addr[0x2AAA] = (FPW) 0x00550055;
 174         addr[0x5555] = (FPW) 0x00900090;
 175
 176         mb ();
 177         value = addr[0];
 178
 179         switch (value) {
 180
 181         case (FPW) INTEL_MANUFACT:
 182                 info->flash_id = FLASH_MAN_INTEL;
 183                 break;
 184
 185         default:
 186                 info->flash_id = FLASH_UNKNOWN;
 187                 info->sector_count = 0;
 188                 info->size = 0;
 189                 addr[0] = (FPW) 0x00FF00FF;     /* restore read mode */
 190                 return (0);                     /* no or unknown flash  */
 191         }
 192
 193         mb ();
 194         value = addr[1];                        /* device ID        */
 195
 196         switch (value) {
 197
 198         case (FPW) INTEL_ID_28F128J3A:
 199                 info->flash_id += FLASH_28F128J3A;
 200                 info->sector_count = 128;
 201                 info->size = 0x02000000;
 202                 break;                          /* => 16 MB     */
 203
 204         default:
 205                 info->flash_id = FLASH_UNKNOWN;
 206                 break;
 207         }
 208
 209         if (info->sector_count > CONFIG_SYS_MAX_FLASH_SECT) {
 210                 printf ("** ERROR: sector count %d > max (%d) **\n",
 211                         info->sector_count, CONFIG_SYS_MAX_FLASH_SECT);
 212                 info->sector_count = CONFIG_SYS_MAX_FLASH_SECT;
 213         }
 214
 215         addr[0] = (FPW) 0x00FF00FF;             /* restore read mode */
 216
 217         return (info->size);
 218 }
 219
 220
 221 /*-----------------------------------------------------------------------
 222  */
 223
 224 int flash_erase (flash_info_t *info, int s_first, int s_last)
 225 {
 226         int flag, prot, sect;
 227         ulong type, start;
 228         int rcode = 0;
 229
 230         if ((s_first < 0) || (s_first > s_last)) {
 231                 if (info->flash_id == FLASH_UNKNOWN) {
 232                         printf ("- missing\n");
 233                 } else {
 234                         printf ("- no sectors to erase\n");
 235                 }
 236                 return 1;
 237         }
 238
 239         type = (info->flash_id & FLASH_VENDMASK);
 240         if ((type != FLASH_MAN_INTEL)) {
 241                 printf ("Can't erase unknown flash type %08lx - aborted\n",
 242                         info->flash_id);
 243                 return 1;
 244         }
 245
 246         prot = 0;
 247         for (sect = s_first; sect <= s_last; ++sect) {
 248                 if (info->protect[sect]) {
 249                         prot++;
 250                 }
 251         }
 252
 253         if (prot) {
 254                 printf ("- Warning: %d protected sectors will not be erased!\n",
 255                         prot);
 256         } else {
 257                 printf ("\n");
 258         }
 259
 260         /* Disable interrupts which might cause a timeout here */
 261         flag = disable_interrupts ();
 262
 263         /* Start erase on unprotected sectors */
 264         for (sect = s_first; sect <= s_last; sect++) {
 265                 if (info->protect[sect] == 0) { /* not protected */
 266                         FPWV *addr = (FPWV *) (info->start[sect]);
 267                         FPW status;
 268
 269                         printf ("Erasing sector %2d ... ", sect);
 270
 271                         /* arm simple, non interrupt dependent timer */
 272                         start = get_timer(0);
 273
 274                         *addr = (FPW) 0x00500050;       /* clear status register */
 275                         *addr = (FPW) 0x00200020;       /* erase setup */
 276                         *addr = (FPW) 0x00D000D0;       /* erase confirm */
 277
 278                         while (((status = *addr) & (FPW) 0x00800080) != (FPW) 0x00800080) {
 279                                 if (get_timer(start) > CONFIG_SYS_FLASH_ERASE_TOUT) {
 280                                         printf ("Timeout\n");
 281                                         *addr = (FPW) 0x00B000B0;       /* suspend erase     */
 282                                         *addr = (FPW) 0x00FF00FF;       /* reset to read mode */
 283                                         rcode = 1;
 284                                         break;
 285                                 }
 286                         }
 287
 288                         *addr = 0x00500050;     /* clear status register cmd.   */
 289                         *addr = 0x00FF00FF;     /* resest to read mode          */
 290
 291                         printf (" done\n");
 292                 }
 293         }
 294         return rcode;
 295 }
 296
 297 /*-----------------------------------------------------------------------
 298  * Copy memory to flash, returns:
 299  * 0 - OK
 300  * 1 - write timeout
 301  * 2 - Flash not erased
 302  * 4 - Flash not identified
 303  */
 304
 305 int write_buff (flash_info_t *info, uchar *src, ulong addr, ulong cnt)
 306 {
 307         ulong cp, wp;
 308         FPW data;
 309         int count, i, l, rc, port_width;
 310
 311         if (info->flash_id == FLASH_UNKNOWN) {
 312                 return 4;
 313         }
 314 /* get lower word aligned address */
 315 #ifdef FLASH_PORT_WIDTH16
 316         wp = (addr & ~1);
 317         port_width = 2;
 318 #else
 319         wp = (addr & ~3);
 320         port_width = 4;
 321 #endif
 322
 323         /*
 324          * handle unaligned start bytes
 325          */
 326         if ((l = addr - wp) != 0) {
 327                 data = 0;
 328                 for (i = 0, cp = wp; i < l; ++i, ++cp) {
 329                         data = (data << 8) | (*(uchar *) cp);
 330                 }
 331                 for (; i < port_width && cnt > 0; ++i) {
 332                         data = (data << 8) | *src++;
 333                         --cnt;
 334                         ++cp;
 335                 }
 336                 for (; cnt == 0 && i < port_width; ++i, ++cp) {
 337                         data = (data << 8) | (*(uchar *) cp);
 338                 }
 339
 340                 if ((rc = write_data (info, wp, SWAP (data))) != 0) {
 341                         return (rc);
 342                 }
 343                 wp += port_width;
 344         }
 345
 346         /*
 347          * handle word aligned part
 348          */
 349         count = 0;
 350         while (cnt >= port_width) {
 351                 data = 0;
 352                 for (i = 0; i < port_width; ++i) {
 353                         data = (data << 8) | *src++;
 354                 }
 355                 if ((rc = write_data (info, wp, SWAP (data))) != 0) {
 356                         return (rc);
 357                 }
 358                 wp += port_width;
 359                 cnt -= port_width;
 360                 if (count++ > 0x800) {
 361                         spin_wheel ();
 362                         count = 0;
 363                 }
 364         }
 365
 366         if (cnt == 0) {
 367                 return (0);
 368         }
 369
 370         /*
 371          * handle unaligned tail bytes
 372          */
 373         data = 0;
 374         for (i = 0, cp = wp; i < port_width && cnt > 0; ++i, ++cp) {
 375                 data = (data << 8) | *src++;
 376                 --cnt;
 377         }
 378         for (; i < port_width; ++i, ++cp) {
 379                 data = (data << 8) | (*(uchar *) cp);
 380         }
 381
 382         return (write_data (info, wp, SWAP (data)));
 383 }
 384
 385 /*-----------------------------------------------------------------------
 386  * Write a word or halfword to Flash, returns:
 387  * 0 - OK
 388  * 1 - write timeout
 389  * 2 - Flash not erased
 390  */
 391 static int write_data (flash_info_t *info, ulong dest, FPW data)
 392 {
 393         FPWV *addr = (FPWV *) dest;
 394         ulong status;
 395         int flag;
 396         ulong start;
 397
 398         /* Check if Flash is (sufficiently) erased */
 399         if ((*addr & data) != data) {
 400                 printf ("not erased at %08lx (%lx)\n", (ulong) addr, *addr);
 401                 return (2);
 402         }
 403         /* Disable interrupts which might cause a timeout here */
 404         flag = disable_interrupts ();
 405
 406         *addr = (FPW) 0x00400040;       /* write setup */
 407         *addr = data;
 408
 409         /* arm simple, non interrupt dependent timer */
 410         start = get_timer(0);
 411
 412         /* wait while polling the status register */
 413         while (((status = *addr) & (FPW) 0x00800080) != (FPW) 0x00800080) {
 414                 if (get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT) {
 415                         *addr = (FPW) 0x00FF00FF;       /* restore read mode */
 416                         return (1);
 417                 }
 418         }
 419
 420         *addr = (FPW) 0x00FF00FF;       /* restore read mode */
 421
 422         return (0);
 423 }
 424
 425 void inline spin_wheel (void)
 426 {
 427         static int p = 0;
 428         static char w[] = "\\/-";
 429
 430         printf ("\010%c", w[p]);
 431         (++p == 3) ? (p = 0) : 0;
 432 }