flash.c 14 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35
/*
**=====================================================================
**
** Copyright (C) 2000, 2001, 2002, 2003
** The LEOX team <team@leox.org>, http://www.leox.org
**
** LEOX.org is about the development of free hardware and software resources
**   for system on chip.
**
** Description: U-Boot port on the LEOX's ELPT860 CPU board
** ~~~~~~~~~~~
**
**=====================================================================
**
** This program is free software; you can redistribute it and/or
** modify it under the terms of the GNU General Public License as
** published by the Free Software Foundation; either version 2 of
** the License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place, Suite 330, Boston,
** MA 02111-1307 USA
**
**=====================================================================
*/

/*
** Note 1: In this file, you have to provide the following variable:
** ------
36
**              flash_info_t    flash_info[CONFIG_SYS_MAX_FLASH_BANKS]
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63
** 'flash_info_t' structure is defined into 'include/flash.h'
** and defined as extern into 'common/cmd_flash.c'
**
** Note 2: In this file, you have to provide the following functions:
** ------
**              unsigned long   flash_init(void)
** called from 'board_init_r()' into 'common/board.c'
**
**              void            flash_print_info(flash_info_t *info)
** called from 'do_flinfo()' into 'common/cmd_flash.c'
**
**              int             flash_erase(flash_info_t *info,
**                                          int           s_first,
**                                          int           s_last)
** called from 'do_flerase()' & 'flash_sect_erase()' into 'common/cmd_flash.c'
**
**              int             write_buff (flash_info_t *info,
**                                          uchar        *src,
**                                          ulong         addr,
**                                          ulong         cnt)
** called from 'flash_write()' into 'common/cmd_flash.c'
*/

#include <common.h>
#include <mpc8xx.h>


64
#ifndef	CONFIG_ENV_ADDR
65
#  define CONFIG_ENV_ADDR	(CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
66 67
#endif

68
flash_info_t	flash_info[CONFIG_SYS_MAX_FLASH_BANKS]; /* info for FLASH chips */
69 70 71 72 73 74 75 76 77 78 79 80 81

/*-----------------------------------------------------------------------
 * Internal Functions
 */
static void   flash_get_offsets (ulong base, flash_info_t *info);
static ulong  flash_get_size (volatile unsigned char *addr, flash_info_t *info);

static int write_word (flash_info_t *info, ulong dest, ulong data);
static int write_byte (flash_info_t *info, ulong dest, uchar data);

/*-----------------------------------------------------------------------
 */

wdenk's avatar
wdenk committed
82
unsigned long
83 84
flash_init (void)
{
85
  volatile immap_t     *immap  = (immap_t *)CONFIG_SYS_IMMR;
86 87 88
  volatile memctl8xx_t *memctl = &immap->im_memctl;
  unsigned long         size_b0;
  int i;
wdenk's avatar
wdenk committed
89

90
  /* Init: no FLASHes known */
91
  for (i=0; i<CONFIG_SYS_MAX_FLASH_BANKS; ++i)
92 93 94
    {
      flash_info[i].flash_id = FLASH_UNKNOWN;
    }
wdenk's avatar
wdenk committed
95

96
  /* Static FLASH Bank configuration here - FIXME XXX */
wdenk's avatar
wdenk committed
97 98

  size_b0 = flash_get_size ((volatile unsigned char *)FLASH_BASE0_PRELIM,
99
			    &flash_info[0]);
wdenk's avatar
wdenk committed
100 101

  if ( flash_info[0].flash_id == FLASH_UNKNOWN )
102 103 104 105
    {
      printf ("## Unknown FLASH on Bank 0 - Size = 0x%08lx = %ld MB\n",
	      size_b0, size_b0<<20);
    }
wdenk's avatar
wdenk committed
106

107
  /* Remap FLASH according to real size */
108 109
  memctl->memc_or0 = CONFIG_SYS_OR_TIMING_FLASH | (-size_b0 & OR_AM_MSK);
  memctl->memc_br0 = (CONFIG_SYS_FLASH_BASE & BR_BA_MSK) | BR_MS_GPCM | BR_PS_8 | BR_V;
wdenk's avatar
wdenk committed
110

111
  /* Re-do sizing to get full correct info */
112
  size_b0 = flash_get_size ((volatile unsigned char *)CONFIG_SYS_FLASH_BASE,
113
			    &flash_info[0]);
wdenk's avatar
wdenk committed
114

115
  flash_get_offsets (CONFIG_SYS_FLASH_BASE, &flash_info[0]);
wdenk's avatar
wdenk committed
116

117
#if CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE
118 119
  /* monitor protection ON by default */
  flash_protect (FLAG_PROTECT_SET,
120 121
		 CONFIG_SYS_MONITOR_BASE,
		 CONFIG_SYS_MONITOR_BASE + monitor_flash_len-1,
122 123
		 &flash_info[0]);
#endif
wdenk's avatar
wdenk committed
124

125
#ifdef	CONFIG_ENV_IS_IN_FLASH
126 127
  /* ENV protection ON by default */
  flash_protect(FLAG_PROTECT_SET,
128 129
		CONFIG_ENV_ADDR,
		CONFIG_ENV_ADDR + CONFIG_ENV_SIZE-1,
130 131 132 133
		&flash_info[0]);
#endif

  flash_info[0].size = size_b0;
wdenk's avatar
wdenk committed
134

135 136 137 138 139
  return (size_b0);
}

/*-----------------------------------------------------------------------
 */
wdenk's avatar
wdenk committed
140 141
static void
flash_get_offsets (ulong          base,
142 143 144 145 146 147 148
		   flash_info_t  *info)
{
  int i;

#define SECTOR_64KB    0x00010000

  /* set up sector start adress table */
wdenk's avatar
wdenk committed
149
  for (i = 0; i < info->sector_count; i++)
150 151 152 153 154 155 156
    {
      info->start[i] = base + (i * SECTOR_64KB);
    }
}

/*-----------------------------------------------------------------------
 */
wdenk's avatar
wdenk committed
157
void
158 159 160
flash_print_info (flash_info_t *info)
{
  int i;
wdenk's avatar
wdenk committed
161 162

  if ( info->flash_id == FLASH_UNKNOWN )
163 164 165 166 167
    {
      printf ("missing or unknown FLASH type\n");
      return;
    }

wdenk's avatar
wdenk committed
168
  switch ( info->flash_id & FLASH_VENDMASK )
169 170 171 172 173 174
    {
    case FLASH_MAN_AMD:	printf ("AMD ");		break;
    case FLASH_MAN_FUJ:	printf ("FUJITSU ");		break;
    case FLASH_MAN_STM: printf ("STM (Thomson) ");      break;
    default:		printf ("Unknown Vendor ");	break;
    }
wdenk's avatar
wdenk committed
175 176

  switch ( info->flash_id & FLASH_TYPEMASK )
177 178 179 180 181 182
    {
    case FLASH_AM040:   printf ("AM29F040   (4 Mbits)\n");
      break;
    default:	        printf ("Unknown Chip Type\n");
      break;
    }
wdenk's avatar
wdenk committed
183 184

  printf ("  Size: %ld KB in %d Sectors\n",
185
	  info->size >> 10, info->sector_count);
wdenk's avatar
wdenk committed
186

187
  printf ("  Sector Start Addresses:");
wdenk's avatar
wdenk committed
188
  for (i=0; i<info->sector_count; ++i)
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
    {
      if ((i % 5) == 0)
	printf ("\n   ");
      printf (" %08lX%s",
	      info->start[i],
	      info->protect[i] ? " (RO)" : "     "
	      );
    }
  printf ("\n");

  return;
}

/*-----------------------------------------------------------------------
 */


/*-----------------------------------------------------------------------
 */

/*
 * The following code cannot be run from FLASH!
 */

wdenk's avatar
wdenk committed
213 214 215
static ulong
flash_get_size (volatile unsigned char *addr,
		flash_info_t           *info)
216 217 218 219 220 221 222 223 224
{
  short i;
  uchar value;
  ulong base = (ulong)addr;

  /* Write auto select command: read Manufacturer ID */
  addr[0x0555] = 0xAA;
  addr[0x02AA] = 0x55;
  addr[0x0555] = 0x90;
wdenk's avatar
wdenk committed
225

226 227
  value = addr[0];

wdenk's avatar
wdenk committed
228
  switch ( value )
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
    {
      /*    case AMD_MANUFACT: */
    case 0x01:
      info->flash_id = FLASH_MAN_AMD;
      break;
      /*    case FUJ_MANUFACT: */
    case 0x04:
      info->flash_id = FLASH_MAN_FUJ;
      break;
      /*    case STM_MANUFACT: */
    case 0x20:
      info->flash_id = FLASH_MAN_STM;
      break;

    default:
      info->flash_id = FLASH_UNKNOWN;
      info->sector_count = 0;
      info->size = 0;
      return (0);			/* no or unknown flash	*/
    }
wdenk's avatar
wdenk committed
249

250
  value = addr[1];			/* device ID		*/
wdenk's avatar
wdenk committed
251 252

  switch ( value )
253 254 255 256 257 258 259 260 261 262 263 264 265 266
    {
    case STM_ID_F040B:
    case AMD_ID_F040B:
      info->flash_id += FLASH_AM040;    /* 4 Mbits = 512k * 8  */
      info->sector_count = 8;
      info->size = 0x00080000;
      break;

    default:
      info->flash_id = FLASH_UNKNOWN;
      return (0);			/* => no or unknown flash */
    }

  /* set up sector start adress table */
wdenk's avatar
wdenk committed
267
  for (i = 0; i < info->sector_count; i++)
268 269 270
    {
      info->start[i] = base + (i * 0x00010000);
    }
wdenk's avatar
wdenk committed
271

272
  /* check for protected sectors */
wdenk's avatar
wdenk committed
273
  for (i = 0; i < info->sector_count; i++)
274 275 276 277 278 279 280 281 282 283
    {
      /* read sector protection at sector address, (A7 .. A0) = 0x02 */
      /* D0 = 1 if protected */
      addr = (volatile unsigned char *)(info->start[i]);
      info->protect[i] = addr[2] & 1;
    }

  /*
   * Prevent writes to uninitialized FLASH.
   */
wdenk's avatar
wdenk committed
284
  if ( info->flash_id != FLASH_UNKNOWN )
285 286
    {
      addr = (volatile unsigned char *)info->start[0];
wdenk's avatar
wdenk committed
287

288 289
      *addr = 0xF0;	/* reset bank */
    }
wdenk's avatar
wdenk committed
290

291 292 293 294 295 296 297 298
  return (info->size);
}


/*-----------------------------------------------------------------------
 */

int
wdenk's avatar
wdenk committed
299 300
flash_erase (flash_info_t  *info,
	     int            s_first,
301 302 303 304 305
	     int            s_last)
{
  volatile unsigned char *addr = (volatile unsigned char *)(info->start[0]);
  int flag, prot, sect, l_sect;
  ulong start, now, last;
wdenk's avatar
wdenk committed
306 307

  if ( (s_first < 0) || (s_first > s_last) )
308
    {
wdenk's avatar
wdenk committed
309
      if ( info->flash_id == FLASH_UNKNOWN )
310 311
	{
	  printf ("- missing\n");
wdenk's avatar
wdenk committed
312 313
	}
      else
314 315 316 317 318 319 320
	{
	  printf ("- no sectors to erase\n");
	}
      return ( 1 );
    }

  if ( (info->flash_id == FLASH_UNKNOWN) ||
wdenk's avatar
wdenk committed
321
       (info->flash_id > FLASH_AMD_COMP) )
322 323 324 325 326
    {
      printf ("Can't erase unknown flash type %08lx - aborted\n",
	      info->flash_id);
      return ( 1 );
    }
wdenk's avatar
wdenk committed
327

328
  prot = 0;
wdenk's avatar
wdenk committed
329
  for (sect=s_first; sect<=s_last; ++sect)
330
    {
wdenk's avatar
wdenk committed
331
      if ( info->protect[sect] )
332 333 334 335
	{
	  prot++;
	}
    }
wdenk's avatar
wdenk committed
336 337

  if ( prot )
338 339
    {
      printf ("- Warning: %d protected sectors will not be erased!\n", prot);
wdenk's avatar
wdenk committed
340 341
    }
  else
342 343 344
    {
      printf ("\n");
    }
wdenk's avatar
wdenk committed
345

346
  l_sect = -1;
wdenk's avatar
wdenk committed
347

348 349
  /* Disable interrupts which might cause a timeout here */
  flag = disable_interrupts();
wdenk's avatar
wdenk committed
350

351 352 353 354 355
  addr[0x0555] = 0xAA;
  addr[0x02AA] = 0x55;
  addr[0x0555] = 0x80;
  addr[0x0555] = 0xAA;
  addr[0x02AA] = 0x55;
wdenk's avatar
wdenk committed
356

357
  /* Start erase on unprotected sectors */
wdenk's avatar
wdenk committed
358
  for (sect = s_first; sect<=s_last; sect++)
359 360 361 362 363 364 365 366
    {
      if (info->protect[sect] == 0)    /* not protected */
	{
	  addr = (volatile unsigned char *)(info->start[sect]);
	  addr[0] = 0x30;
	  l_sect = sect;
	}
    }
wdenk's avatar
wdenk committed
367

368 369 370
  /* re-enable interrupts if necessary */
  if ( flag )
    enable_interrupts();
wdenk's avatar
wdenk committed
371

372 373
  /* wait at least 80us - let's wait 1 ms */
  udelay (1000);
wdenk's avatar
wdenk committed
374

375 376 377 378 379
  /*
   * We wait for the last triggered sector
   */
  if ( l_sect < 0 )
    goto DONE;
wdenk's avatar
wdenk committed
380

381 382 383
  start = get_timer (0);
  last  = start;
  addr = (volatile unsigned char *)(info->start[l_sect]);
wdenk's avatar
wdenk committed
384
  while ( (addr[0] & 0x80) != 0x80 )
385
    {
386
      if ( (now = get_timer(start)) > CONFIG_SYS_FLASH_ERASE_TOUT )
387 388 389 390 391 392 393 394 395 396 397
	{
	  printf ("Timeout\n");
	  return ( 1 );
	}
      /* show that we're waiting */
      if ( (now - last) > 1000 )     /* every second */
	{
	  putc ('.');
	  last = now;
	}
    }
wdenk's avatar
wdenk committed
398

399 400 401 402
DONE:
  /* reset to read mode */
  addr = (volatile unsigned char *)info->start[0];
  addr[0] = 0xF0;	/* reset bank */
wdenk's avatar
wdenk committed
403

404
  printf (" done\n");
wdenk's avatar
wdenk committed
405

406 407 408 409 410 411 412 413 414 415
  return ( 0 );
}

/*-----------------------------------------------------------------------
 * Copy memory to flash, returns:
 * 0 - OK
 * 1 - write timeout
 * 2 - Flash not erased
 */

wdenk's avatar
wdenk committed
416 417 418 419
int
write_buff (flash_info_t  *info,
	    uchar         *src,
	    ulong          addr,
420 421 422 423 424 425 426 427 428 429 430
	    ulong          cnt)
{
  ulong cp, wp, data;
  uchar bdata;
  int i, l, rc;

  if ( (info->flash_id & FLASH_TYPEMASK) == FLASH_AM040 )
    {
      /* Width of the data bus: 8 bits */

      wp = addr;
wdenk's avatar
wdenk committed
431

432 433 434
      while ( cnt )
	{
	  bdata = *src++;
wdenk's avatar
wdenk committed
435

436 437 438 439
	  if ( (rc = write_byte(info, wp, bdata)) != 0 )
	    {
	      return (rc);
	    }
wdenk's avatar
wdenk committed
440

441 442 443 444 445 446 447 448 449 450 451
	  ++wp;
	  --cnt;
	}

      return ( 0 );
    }
  else
    {
      /* Width of the data bus: 32 bits */

      wp = (addr & ~3);	/* get lower word aligned address */
wdenk's avatar
wdenk committed
452

453 454 455
      /*
       * handle unaligned start bytes
       */
wdenk's avatar
wdenk committed
456
      if ( (l = addr - wp) != 0 )
457 458
	{
	  data = 0;
wdenk's avatar
wdenk committed
459
	  for (i=0, cp=wp; i<l; ++i, ++cp)
460 461 462
	    {
	      data = (data << 8) | (*(uchar *)cp);
	    }
wdenk's avatar
wdenk committed
463
	  for (; i<4 && cnt>0; ++i)
464 465 466 467 468
	    {
	      data = (data << 8) | *src++;
	      --cnt;
	      ++cp;
	    }
wdenk's avatar
wdenk committed
469
	  for (; cnt==0 && i<4; ++i, ++cp)
470 471 472
	    {
	      data = (data << 8) | (*(uchar *)cp);
	    }
wdenk's avatar
wdenk committed
473 474

	  if ( (rc = write_word(info, wp, data)) != 0 )
475 476 477 478 479
	    {
	      return (rc);
	    }
	  wp += 4;
	}
wdenk's avatar
wdenk committed
480

481 482 483
      /*
       * handle word aligned part
       */
wdenk's avatar
wdenk committed
484
      while ( cnt >= 4 )
485 486
	{
	  data = 0;
wdenk's avatar
wdenk committed
487
	  for (i=0; i<4; ++i)
488 489 490
	    {
	      data = (data << 8) | *src++;
	    }
wdenk's avatar
wdenk committed
491
	  if ( (rc = write_word(info, wp, data)) != 0 )
492 493 494 495 496 497
	    {
	      return (rc);
	    }
	  wp  += 4;
	  cnt -= 4;
	}
wdenk's avatar
wdenk committed
498 499

      if ( cnt == 0 )
500 501 502
	{
	  return (0);
	}
wdenk's avatar
wdenk committed
503

504 505 506 507
      /*
       * handle unaligned tail bytes
       */
      data = 0;
wdenk's avatar
wdenk committed
508
      for (i=0, cp=wp; i<4 && cnt>0; ++i, ++cp)
509 510 511 512
	{
	  data = (data << 8) | *src++;
	  --cnt;
	}
wdenk's avatar
wdenk committed
513
      for (; i<4; ++i, ++cp)
514 515 516
	{
	  data = (data << 8) | (*(uchar *)cp);
	}
wdenk's avatar
wdenk committed
517

518 519 520 521 522 523 524 525 526 527
      return (write_word(info, wp, data));
    }
}

/*-----------------------------------------------------------------------
 * Write a word to Flash, returns:
 * 0 - OK
 * 1 - write timeout
 * 2 - Flash not erased
 */
wdenk's avatar
wdenk committed
528 529 530
static int
write_word (flash_info_t  *info,
	    ulong          dest,
531 532 533 534 535
	    ulong          data)
{
  vu_long *addr = (vu_long*)(info->start[0]);
  ulong start;
  int flag;
wdenk's avatar
wdenk committed
536

537
  /* Check if Flash is (sufficiently) erased */
wdenk's avatar
wdenk committed
538
  if ( (*((vu_long *)dest) & data) != data )
539 540 541 542 543
    {
      return (2);
    }
  /* Disable interrupts which might cause a timeout here */
  flag = disable_interrupts();
wdenk's avatar
wdenk committed
544

545 546 547
  addr[0x0555] = 0x00AA00AA;
  addr[0x02AA] = 0x00550055;
  addr[0x0555] = 0x00A000A0;
wdenk's avatar
wdenk committed
548

549
  *((vu_long *)dest) = data;
wdenk's avatar
wdenk committed
550

551 552 553 554 555 556
  /* re-enable interrupts if necessary */
  if ( flag )
    enable_interrupts();

  /* data polling for D7 */
  start = get_timer (0);
wdenk's avatar
wdenk committed
557
  while ( (*((vu_long *)dest) & 0x00800080) != (data & 0x00800080) )
558
    {
559
      if ( get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT )
560 561 562 563 564 565 566 567 568 569 570 571 572 573
	{
	  return (1);
	}
    }

  return (0);
}

/*-----------------------------------------------------------------------
 * Write a byte to Flash, returns:
 * 0 - OK
 * 1 - write timeout
 * 2 - Flash not erased
 */
wdenk's avatar
wdenk committed
574 575 576
static int
write_byte (flash_info_t  *info,
	    ulong          dest,
577 578 579 580 581
	    uchar          data)
{
  volatile unsigned char *addr = (volatile unsigned char *)(info->start[0]);
  ulong  start;
  int    flag;
wdenk's avatar
wdenk committed
582

583
  /* Check if Flash is (sufficiently) erased */
wdenk's avatar
wdenk committed
584
  if ( (*((volatile unsigned char *)dest) & data) != data )
585 586 587 588 589
    {
      return (2);
    }
  /* Disable interrupts which might cause a timeout here */
  flag = disable_interrupts();
wdenk's avatar
wdenk committed
590

591 592 593
  addr[0x0555] = 0xAA;
  addr[0x02AA] = 0x55;
  addr[0x0555] = 0xA0;
wdenk's avatar
wdenk committed
594

595
  *((volatile unsigned char *)dest) = data;
wdenk's avatar
wdenk committed
596

597 598 599 600 601 602
  /* re-enable interrupts if necessary */
  if ( flag )
    enable_interrupts();

  /* data polling for D7 */
  start = get_timer (0);
wdenk's avatar
wdenk committed
603
  while ( (*((volatile unsigned char *)dest) & 0x80) != (data & 0x80) )
604
    {
605
      if ( get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT )
606 607 608 609 610 611 612 613 614 615
	{
	  return (1);
	}
    }

  return (0);
}

/*-----------------------------------------------------------------------
 */