flash.c 13.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
/*
**=====================================================================
**
** 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
** ~~~~~~~~~~~
**
**=====================================================================
**
15
 * SPDX-License-Identifier:	GPL-2.0+
16 17 18 19 20 21 22
**
**=====================================================================
*/

/*
** Note 1: In this file, you have to provide the following variable:
** ------
23
**              flash_info_t    flash_info[CONFIG_SYS_MAX_FLASH_BANKS]
24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
** '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>


51
#ifndef	CONFIG_ENV_ADDR
52
#  define CONFIG_ENV_ADDR	(CONFIG_SYS_FLASH_BASE + CONFIG_ENV_OFFSET)
53 54
#endif

55
flash_info_t	flash_info[CONFIG_SYS_MAX_FLASH_BANKS]; /* info for FLASH chips */
56 57 58 59 60 61 62 63 64 65 66 67 68

/*-----------------------------------------------------------------------
 * 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
69
unsigned long
70 71
flash_init (void)
{
72
  volatile immap_t     *immap  = (immap_t *)CONFIG_SYS_IMMR;
73 74 75
  volatile memctl8xx_t *memctl = &immap->im_memctl;
  unsigned long         size_b0;
  int i;
wdenk's avatar
wdenk committed
76

77
  /* Init: no FLASHes known */
78
  for (i=0; i<CONFIG_SYS_MAX_FLASH_BANKS; ++i)
79 80 81
    {
      flash_info[i].flash_id = FLASH_UNKNOWN;
    }
wdenk's avatar
wdenk committed
82

83
  /* Static FLASH Bank configuration here - FIXME XXX */
wdenk's avatar
wdenk committed
84 85

  size_b0 = flash_get_size ((volatile unsigned char *)FLASH_BASE0_PRELIM,
86
			    &flash_info[0]);
wdenk's avatar
wdenk committed
87 88

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

94
  /* Remap FLASH according to real size */
95 96
  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
97

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

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

104
#if CONFIG_SYS_MONITOR_BASE >= CONFIG_SYS_FLASH_BASE
105 106
  /* monitor protection ON by default */
  flash_protect (FLAG_PROTECT_SET,
107 108
		 CONFIG_SYS_MONITOR_BASE,
		 CONFIG_SYS_MONITOR_BASE + monitor_flash_len-1,
109 110
		 &flash_info[0]);
#endif
wdenk's avatar
wdenk committed
111

112
#ifdef	CONFIG_ENV_IS_IN_FLASH
113 114
  /* ENV protection ON by default */
  flash_protect(FLAG_PROTECT_SET,
115 116
		CONFIG_ENV_ADDR,
		CONFIG_ENV_ADDR + CONFIG_ENV_SIZE-1,
117 118 119 120
		&flash_info[0]);
#endif

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

122 123 124 125 126
  return (size_b0);
}

/*-----------------------------------------------------------------------
 */
wdenk's avatar
wdenk committed
127 128
static void
flash_get_offsets (ulong          base,
129 130 131 132 133 134 135
		   flash_info_t  *info)
{
  int i;

#define SECTOR_64KB    0x00010000

  /* set up sector start adress table */
wdenk's avatar
wdenk committed
136
  for (i = 0; i < info->sector_count; i++)
137 138 139 140 141 142 143
    {
      info->start[i] = base + (i * SECTOR_64KB);
    }
}

/*-----------------------------------------------------------------------
 */
wdenk's avatar
wdenk committed
144
void
145 146 147
flash_print_info (flash_info_t *info)
{
  int i;
wdenk's avatar
wdenk committed
148 149

  if ( info->flash_id == FLASH_UNKNOWN )
150 151 152 153 154
    {
      printf ("missing or unknown FLASH type\n");
      return;
    }

wdenk's avatar
wdenk committed
155
  switch ( info->flash_id & FLASH_VENDMASK )
156 157 158 159 160 161
    {
    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
162 163

  switch ( info->flash_id & FLASH_TYPEMASK )
164 165 166 167 168 169
    {
    case FLASH_AM040:   printf ("AM29F040   (4 Mbits)\n");
      break;
    default:	        printf ("Unknown Chip Type\n");
      break;
    }
wdenk's avatar
wdenk committed
170 171

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

174
  printf ("  Sector Start Addresses:");
wdenk's avatar
wdenk committed
175
  for (i=0; i<info->sector_count; ++i)
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199
    {
      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
200 201 202
static ulong
flash_get_size (volatile unsigned char *addr,
		flash_info_t           *info)
203 204 205 206 207 208 209 210 211
{
  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
212

213 214
  value = addr[0];

wdenk's avatar
wdenk committed
215
  switch ( value )
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
    {
      /*    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
236

237
  value = addr[1];			/* device ID		*/
wdenk's avatar
wdenk committed
238 239

  switch ( value )
240 241 242 243 244 245 246 247 248 249 250 251 252 253
    {
    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
254
  for (i = 0; i < info->sector_count; i++)
255 256 257
    {
      info->start[i] = base + (i * 0x00010000);
    }
wdenk's avatar
wdenk committed
258

259
  /* check for protected sectors */
wdenk's avatar
wdenk committed
260
  for (i = 0; i < info->sector_count; i++)
261 262 263 264 265 266 267 268 269 270
    {
      /* 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
271
  if ( info->flash_id != FLASH_UNKNOWN )
272 273
    {
      addr = (volatile unsigned char *)info->start[0];
wdenk's avatar
wdenk committed
274

275 276
      *addr = 0xF0;	/* reset bank */
    }
wdenk's avatar
wdenk committed
277

278 279 280 281 282 283 284 285
  return (info->size);
}


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

int
wdenk's avatar
wdenk committed
286 287
flash_erase (flash_info_t  *info,
	     int            s_first,
288 289 290 291 292
	     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
293 294

  if ( (s_first < 0) || (s_first > s_last) )
295
    {
wdenk's avatar
wdenk committed
296
      if ( info->flash_id == FLASH_UNKNOWN )
297 298
	{
	  printf ("- missing\n");
wdenk's avatar
wdenk committed
299 300
	}
      else
301 302 303 304 305 306 307
	{
	  printf ("- no sectors to erase\n");
	}
      return ( 1 );
    }

  if ( (info->flash_id == FLASH_UNKNOWN) ||
wdenk's avatar
wdenk committed
308
       (info->flash_id > FLASH_AMD_COMP) )
309 310 311 312 313
    {
      printf ("Can't erase unknown flash type %08lx - aborted\n",
	      info->flash_id);
      return ( 1 );
    }
wdenk's avatar
wdenk committed
314

315
  prot = 0;
wdenk's avatar
wdenk committed
316
  for (sect=s_first; sect<=s_last; ++sect)
317
    {
wdenk's avatar
wdenk committed
318
      if ( info->protect[sect] )
319 320 321 322
	{
	  prot++;
	}
    }
wdenk's avatar
wdenk committed
323 324

  if ( prot )
325 326
    {
      printf ("- Warning: %d protected sectors will not be erased!\n", prot);
wdenk's avatar
wdenk committed
327 328
    }
  else
329 330 331
    {
      printf ("\n");
    }
wdenk's avatar
wdenk committed
332

333
  l_sect = -1;
wdenk's avatar
wdenk committed
334

335 336
  /* Disable interrupts which might cause a timeout here */
  flag = disable_interrupts();
wdenk's avatar
wdenk committed
337

338 339 340 341 342
  addr[0x0555] = 0xAA;
  addr[0x02AA] = 0x55;
  addr[0x0555] = 0x80;
  addr[0x0555] = 0xAA;
  addr[0x02AA] = 0x55;
wdenk's avatar
wdenk committed
343

344
  /* Start erase on unprotected sectors */
wdenk's avatar
wdenk committed
345
  for (sect = s_first; sect<=s_last; sect++)
346 347 348 349 350 351 352 353
    {
      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
354

355 356 357
  /* re-enable interrupts if necessary */
  if ( flag )
    enable_interrupts();
wdenk's avatar
wdenk committed
358

359 360
  /* wait at least 80us - let's wait 1 ms */
  udelay (1000);
wdenk's avatar
wdenk committed
361

362 363 364 365 366
  /*
   * We wait for the last triggered sector
   */
  if ( l_sect < 0 )
    goto DONE;
wdenk's avatar
wdenk committed
367

368 369 370
  start = get_timer (0);
  last  = start;
  addr = (volatile unsigned char *)(info->start[l_sect]);
wdenk's avatar
wdenk committed
371
  while ( (addr[0] & 0x80) != 0x80 )
372
    {
373
      if ( (now = get_timer(start)) > CONFIG_SYS_FLASH_ERASE_TOUT )
374 375 376 377 378 379 380 381 382 383 384
	{
	  printf ("Timeout\n");
	  return ( 1 );
	}
      /* show that we're waiting */
      if ( (now - last) > 1000 )     /* every second */
	{
	  putc ('.');
	  last = now;
	}
    }
wdenk's avatar
wdenk committed
385

386 387 388 389
DONE:
  /* reset to read mode */
  addr = (volatile unsigned char *)info->start[0];
  addr[0] = 0xF0;	/* reset bank */
wdenk's avatar
wdenk committed
390

391
  printf (" done\n");
wdenk's avatar
wdenk committed
392

393 394 395 396 397 398 399 400 401 402
  return ( 0 );
}

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

wdenk's avatar
wdenk committed
403 404 405 406
int
write_buff (flash_info_t  *info,
	    uchar         *src,
	    ulong          addr,
407 408 409 410 411 412 413 414 415 416 417
	    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
418

419 420 421
      while ( cnt )
	{
	  bdata = *src++;
wdenk's avatar
wdenk committed
422

423 424 425 426
	  if ( (rc = write_byte(info, wp, bdata)) != 0 )
	    {
	      return (rc);
	    }
wdenk's avatar
wdenk committed
427

428 429 430 431 432 433 434 435 436 437 438
	  ++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
439

440 441 442
      /*
       * handle unaligned start bytes
       */
wdenk's avatar
wdenk committed
443
      if ( (l = addr - wp) != 0 )
444 445
	{
	  data = 0;
wdenk's avatar
wdenk committed
446
	  for (i=0, cp=wp; i<l; ++i, ++cp)
447 448 449
	    {
	      data = (data << 8) | (*(uchar *)cp);
	    }
wdenk's avatar
wdenk committed
450
	  for (; i<4 && cnt>0; ++i)
451 452 453 454 455
	    {
	      data = (data << 8) | *src++;
	      --cnt;
	      ++cp;
	    }
wdenk's avatar
wdenk committed
456
	  for (; cnt==0 && i<4; ++i, ++cp)
457 458 459
	    {
	      data = (data << 8) | (*(uchar *)cp);
	    }
wdenk's avatar
wdenk committed
460 461

	  if ( (rc = write_word(info, wp, data)) != 0 )
462 463 464 465 466
	    {
	      return (rc);
	    }
	  wp += 4;
	}
wdenk's avatar
wdenk committed
467

468 469 470
      /*
       * handle word aligned part
       */
wdenk's avatar
wdenk committed
471
      while ( cnt >= 4 )
472 473
	{
	  data = 0;
wdenk's avatar
wdenk committed
474
	  for (i=0; i<4; ++i)
475 476 477
	    {
	      data = (data << 8) | *src++;
	    }
wdenk's avatar
wdenk committed
478
	  if ( (rc = write_word(info, wp, data)) != 0 )
479 480 481 482 483 484
	    {
	      return (rc);
	    }
	  wp  += 4;
	  cnt -= 4;
	}
wdenk's avatar
wdenk committed
485 486

      if ( cnt == 0 )
487 488 489
	{
	  return (0);
	}
wdenk's avatar
wdenk committed
490

491 492 493 494
      /*
       * handle unaligned tail bytes
       */
      data = 0;
wdenk's avatar
wdenk committed
495
      for (i=0, cp=wp; i<4 && cnt>0; ++i, ++cp)
496 497 498 499
	{
	  data = (data << 8) | *src++;
	  --cnt;
	}
wdenk's avatar
wdenk committed
500
      for (; i<4; ++i, ++cp)
501 502 503
	{
	  data = (data << 8) | (*(uchar *)cp);
	}
wdenk's avatar
wdenk committed
504

505 506 507 508 509 510 511 512 513 514
      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
515 516 517
static int
write_word (flash_info_t  *info,
	    ulong          dest,
518 519 520 521 522
	    ulong          data)
{
  vu_long *addr = (vu_long*)(info->start[0]);
  ulong start;
  int flag;
wdenk's avatar
wdenk committed
523

524
  /* Check if Flash is (sufficiently) erased */
wdenk's avatar
wdenk committed
525
  if ( (*((vu_long *)dest) & data) != data )
526 527 528 529 530
    {
      return (2);
    }
  /* Disable interrupts which might cause a timeout here */
  flag = disable_interrupts();
wdenk's avatar
wdenk committed
531

532 533 534
  addr[0x0555] = 0x00AA00AA;
  addr[0x02AA] = 0x00550055;
  addr[0x0555] = 0x00A000A0;
wdenk's avatar
wdenk committed
535

536
  *((vu_long *)dest) = data;
wdenk's avatar
wdenk committed
537

538 539 540 541 542 543
  /* re-enable interrupts if necessary */
  if ( flag )
    enable_interrupts();

  /* data polling for D7 */
  start = get_timer (0);
wdenk's avatar
wdenk committed
544
  while ( (*((vu_long *)dest) & 0x00800080) != (data & 0x00800080) )
545
    {
546
      if ( get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT )
547 548 549 550 551 552 553 554 555 556 557 558 559 560
	{
	  return (1);
	}
    }

  return (0);
}

/*-----------------------------------------------------------------------
 * Write a byte to Flash, returns:
 * 0 - OK
 * 1 - write timeout
 * 2 - Flash not erased
 */
wdenk's avatar
wdenk committed
561 562 563
static int
write_byte (flash_info_t  *info,
	    ulong          dest,
564 565 566 567 568
	    uchar          data)
{
  volatile unsigned char *addr = (volatile unsigned char *)(info->start[0]);
  ulong  start;
  int    flag;
wdenk's avatar
wdenk committed
569

570
  /* Check if Flash is (sufficiently) erased */
wdenk's avatar
wdenk committed
571
  if ( (*((volatile unsigned char *)dest) & data) != data )
572 573 574 575 576
    {
      return (2);
    }
  /* Disable interrupts which might cause a timeout here */
  flag = disable_interrupts();
wdenk's avatar
wdenk committed
577

578 579 580
  addr[0x0555] = 0xAA;
  addr[0x02AA] = 0x55;
  addr[0x0555] = 0xA0;
wdenk's avatar
wdenk committed
581

582
  *((volatile unsigned char *)dest) = data;
wdenk's avatar
wdenk committed
583

584 585 586 587 588 589
  /* re-enable interrupts if necessary */
  if ( flag )
    enable_interrupts();

  /* data polling for D7 */
  start = get_timer (0);
wdenk's avatar
wdenk committed
590
  while ( (*((volatile unsigned char *)dest) & 0x80) != (data & 0x80) )
591
    {
592
      if ( get_timer(start) > CONFIG_SYS_FLASH_WRITE_TOUT )
593 594 595 596 597 598 599 600 601 602
	{
	  return (1);
	}
    }

  return (0);
}

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