u-boot/doc
Peter Tyser 0f89860494 83xx: Replace CONFIG_MPC83XX with CONFIG_MPC83xx
Use the standard lowercase "xx" capitalization that other Freescale
architectures use for CPU defines to prevent confusion and errors

Signed-off-by: Peter Tyser <ptyser@xes-inc.com>
Signed-off-by: Kim Phillips <kim.phillips@freescale.com>
2009-06-12 20:47:17 +02:00
..
uImage.FIT rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
feature-removal-schedule.txt i2c: Remove deprecated individual i2c commands 2009-06-12 20:39:46 +02:00
I2C_Edge_Conditions rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README-i386 Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README-integrator Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.440-DDR-performance PPC440 DDR setup: Set SDRAM0_CFG0[PMU]=0 for best performance 2006-07-28 18:34:58 +02:00
README.adnpesc1 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.adnpesc1_base32 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.alaska8220 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.AMCC-eval-boards-cleanup Major cleanup for AMCC PPC4xx eval boards. 2005-08-01 16:49:12 +02:00
README.amigaone * Patch by Thomas Frieden, 13 Nov 2002: 2002-11-19 11:04:11 +00:00
README.ARM-memory-map Patch by Anders Larsen, 09 Jan 2004: 2004-02-08 19:38:38 +00:00
README.ARM-SoC Patch by Steven Scholz, 16 Aug 2004: 2004-10-09 22:21:29 +00:00
README.at91 at91sam9: add watchdog support 2009-04-04 20:42:19 +02:00
README.atum8548 mpc85xx: Add support for ATUM8548 (updated) 2008-01-09 16:25:03 -06:00
README.autoboot Fix printf() format problems with configurable prompts 2008-07-31 17:08:27 +02:00
README.AVR32 avr32: Update README 2008-09-01 13:41:58 +02:00
README.AVR32-port-muxing avr32: refactor the portmux/gpio code 2008-09-01 14:20:41 +02:00
README.bamboo ppc4xx: Update AMCC Bamboo README doc/README.bamboo 2007-08-06 21:10:17 +02:00
README.bedbug Update README.* to reference new CONFIG_CMD_* names now. 2007-07-09 19:10:03 -05:00
README.blackfin add some more Blackfin docs 2008-02-04 19:26:54 -05:00
README.cmi rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.COBRA5272 Patch by Florian Schlote, 08 Sep 2004: 2005-01-09 18:21:42 +00:00
README.commands Patch by Kenneth Johansson, 30 Jun 2003: 2003-07-01 21:06:45 +00:00
README.commands.itest * Patch by Laurent Mohin, 10 Feb 2004: 2004-02-23 20:48:38 +00:00
README.console Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.db64360 * Patch by Ronen Shitrit, 10 Dec 2003: 2004-01-03 00:43:19 +00:00
README.db64460 * Patch by Ronen Shitrit, 10 Dec 2003: 2004-01-03 00:43:19 +00:00
README.dk1c20 Patches by Stephan Linz, 30 Jan 2004: 2004-02-09 23:12:24 +00:00
README.dk1c20_std32 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.dk1s10 Change all '$(...)' variable references into '${...}' 2005-11-20 21:40:11 +01:00
README.dk1s10_mldk20 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.dk1s10_std32 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.dk1s40_std32 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.dk20k200_std32 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.ebony i2c: Update references to individual i2c commands 2009-06-12 20:39:46 +02:00
README.enetaddr doc/README.enetaddr: document proper MAC usage 2009-03-20 22:39:09 +01:00
README.evb64260 Initial revision 2002-11-02 23:30:20 +00:00
README.EVB-64260-750CX * Code cleanup: 2003-06-27 21:31:46 +00:00
README.fads * Code cleanup: 2003-06-27 21:31:46 +00:00
README.fsl-ddr Check DDR interleaving mode 2008-10-18 21:54:05 +02:00
README.generic_usb_ohci rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.IceCube * Temporarily disabled John Kerl's extended MII command code because 2004-04-18 23:32:11 +00:00
README.idma2intr * Patch by Arun Dharankar, 4 Apr 2003: 2003-04-05 00:53:31 +00:00
README.imx31 move README.imx31 to doc/ and merge with README.mx31 2008-10-08 18:59:04 +02:00
README.INCA-IP * Patches by Xianghua Xiao, 15 Oct 2003: 2003-10-15 23:53:47 +00:00
README.iomux IOMUX: Add console multiplexing support. 2008-12-07 01:23:35 +01:00
README.IPHASE4539 * Code cleanup: 2003-06-27 21:31:46 +00:00
README.JFFS2 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.JFFS2_NAND rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.kmeter1 powerpc: 83xx: add support for the kmeter1 board 2009-01-24 00:36:19 +01:00
README.korat Coding style cleanup; update CHANGELOG 2009-02-12 00:08:39 +01:00
README.LED LED Add documentation describing the status_led and colour led API. 2009-06-12 20:39:49 +02:00
README.Lite5200B_low_power [PATCH] icecube/lite5200b: document wakeup from low-power support 2007-04-18 12:11:05 +02:00
README.lynxkdi rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.m68k rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.m5253evbe rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.m5373evb i2c: Update references to individual i2c commands 2009-06-12 20:39:46 +02:00
README.m5475evb i2c: Update references to individual i2c commands 2009-06-12 20:39:46 +02:00
README.m52277evb i2c: Update references to individual i2c commands 2009-06-12 20:39:46 +02:00
README.m53017evb ColdFire: Add MCF5301x CPU and M53017EVB support 2008-11-03 09:45:58 -07:00
README.m54455evb i2c: Update references to individual i2c commands 2009-06-12 20:39:46 +02:00
README.marubun-pcmcia rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.MBX rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.mflash mflash: Initial mflash support 2009-04-03 23:47:06 +02:00
README.mips doc/README.mips: Add MIPS notes 2008-04-25 00:03:53 +02:00
README.ml300 Cleanup (PPC4xx is AMCC now) 2005-09-23 11:05:55 +02:00
README.Modem * Code cleanup: 2003-06-27 21:31:46 +00:00
README.modnet50 fix comments with new drivers organization 2008-01-09 21:48:49 +01:00
README.mpc5xx * Code cleanup: 2003-06-27 21:31:46 +00:00
README.mpc74xx Initial revision 2002-11-02 23:30:20 +00:00
README.mpc83xx.ddrecc mpc83xx: Correct the README for DDR ECC 2007-08-10 01:13:11 -05:00
README.mpc83xxads Add support for ep8248 board 2005-08-06 01:42:58 +02:00
README.mpc85xxads * Switched default PCI speed for 8540 ADS back to 33MHz 2006-08-09 13:51:05 -05:00
README.mpc85xxcds * Patch by Jon Loeliger, 2005-05-05 2005-07-25 14:05:07 -05:00
README.mpc832xemds 83xx: Replace CONFIG_MPC83XX with CONFIG_MPC83xx 2009-06-12 20:47:17 +02:00
README.mpc837xemds 83xx: Replace CONFIG_MPC83XX with CONFIG_MPC83xx 2009-06-12 20:47:17 +02:00
README.mpc837xerdb 83xx: Replace CONFIG_MPC83XX with CONFIG_MPC83xx 2009-06-12 20:47:17 +02:00
README.mpc7448hpc2 Some code cleanup. 2007-03-04 01:36:05 +01:00
README.mpc8313erdb mpc8313erdb: Document NAND boot. 2008-10-29 14:35:56 -05:00
README.mpc8315erdb rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.mpc8323erdb mpc83xx: add support for the MPC8323E RDB 2007-08-10 01:12:25 -05:00
README.mpc8349itx 83xx: Replace CONFIG_MPC83XX with CONFIG_MPC83xx 2009-06-12 20:47:17 +02:00
README.mpc8360emds 83xx: Replace CONFIG_MPC83XX with CONFIG_MPC83xx 2009-06-12 20:47:17 +02:00
README.mpc8544ds Coding style cleanup, update CHANGELOG 2007-08-14 09:54:46 +02:00
README.mpc8569mds 85xx: Add README for MPC8569MDS 2009-06-12 09:13:27 -05:00
README.mpc8572ds Coding style cleanup; update CHANGELOG 2009-02-12 00:08:39 +01:00
README.mpc8610hpcd 8610HPCD: Document the flashbank selection switches. 2008-02-20 15:26:51 -06:00
README.mpc8641hpcn mpc8641: Fix error in README 2008-12-01 10:28:52 -06:00
README.MPC866 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.mvbc_p Prepare v1.3.4-rc1: Code cleanup, update CHANGELOG, sort Makefile 2008-07-15 22:22:44 +02:00
README.mvblm7 Coding Style Cleanup 2008-06-28 23:34:37 +02:00
README.nand Noisily disable the legacy NAND subsystem. 2009-04-03 15:27:26 -05:00
README.nand-boot-ppc440 Fix some typos 2008-05-09 20:53:52 +02:00
README.ne2000 * Patches by Richard Woodruff, 01 Oct 2004: 2005-01-09 23:16:25 +00:00
README.NetConsole tools/Makefile: Compile ncb when CONFIG_NETCONSOLE 2009-04-04 01:12:25 +02:00
README.nios rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.nios_CONFIG_SYS_NIOS_CPU nios: Move README.nios_CONFIG_SYS_NIOS_CPU to doc/ dir 2009-01-24 01:29:23 +01:00
README.nios_DK Patches by Stephan Linz, 11 Dec 2003: 2004-01-03 19:43:48 +00:00
README.nmdk8815 Initial support for Nomadik 8815 development board 2009-01-24 18:10:37 +01:00
README.ns9750dev * Patch by Markus Pietrek, 24 Feb 2004: 2004-02-26 23:46:20 +00:00
README.ocotea Cleanup (PPC4xx is AMCC now) 2005-09-23 11:05:55 +02:00
README.ocotea-PIBS-to-U-Boot Cleanup (PPC4xx is AMCC now) 2005-09-23 11:05:55 +02:00
README.OFT Code cleanup, especially MIPS for GCC 4.x 2005-12-04 00:40:34 +01:00
README.omap3 Fix a typo in the instructions on using omap3's gpio interface. 2009-06-12 20:45:47 +02:00
README.omap730p2 * Patch by Rishi Bhattacharya, 08 May 2004: 2004-06-08 00:22:43 +00:00
README.OXC * Code cleanup: 2003-06-27 21:31:46 +00:00
README.PIP405 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.PlanetCore Document switching between U-Boot and PlanetCore on RPXlite 2005-08-06 02:11:33 +02:00
README.POST * Add support for SK98xx driver 2003-09-05 23:19:14 +00:00
README.ppc440 i2c: Update references to individual i2c commands 2009-06-12 20:39:46 +02:00
README.Purple * Code cleanup: 2003-06-27 21:31:46 +00:00
README.PXA_CF rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.qemu_mips MIPS: qemu_mips: update doc to generate and to use qemu flash, ide file 2008-12-17 22:29:05 +09:00
README.RPXClassic * Code cleanup: 2003-06-27 21:31:46 +00:00
README.RPXlite Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.Sandpoint8240 Change all '$(...)' variable references into '${...}' 2005-11-20 21:40:11 +01:00
README.sata doc: english polishing for README.sata 2008-04-13 14:56:51 -07:00
README.sbc8349 mpc83xx: U-Boot support for Wind River SBC8349 2007-03-02 11:05:53 -06:00
README.sbc8548 mpc85xx: Add support for SBC8548 (updated) 2008-01-09 16:25:03 -06:00
README.sbc8641d Add support for SBC8641D. Config files. 2007-08-10 14:50:05 -05:00
README.SBC8560 Cleanup 2004-10-11 23:10:30 +00:00
README.sched * Patch by Arun Dharankar, 4 Apr 2003: 2003-04-05 00:53:31 +00:00
README.serial_multi rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.sh sh: Add support Renesas Solutions R7780MP 2008-03-28 14:16:12 +09:00
README.sh7785lcr sh: Add support 32-Bit Extended Address Mode to sh7785lcr 2009-03-12 23:58:30 +09:00
README.sha1 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.silent rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.simpc8313 mpc83xx: New board support for SIMPC8313 2009-01-23 11:31:18 -06:00
README.SNTP Update README.* to reference new CONFIG_CMD_* names now. 2007-07-09 19:10:03 -05:00
README.standalone Merge branch 'master' of git://www.denx.de/git/u-boot-blackfin 2008-02-15 00:06:18 +01:00
README.stxxtc Add support for Silicon Turnkey eXpress XTc (mpc87x/88x) board. 2005-08-15 15:55:00 +02:00
README.TQM8260 rename CFG_ macros to CONFIG_SYS 2008-10-18 21:54:03 +02:00
README.update Fix to the auto-update feature documentation (CONFIG_UPDATE_TFTP_MSEC_MAX) 2008-10-31 09:50:25 +01:00
README.usb disk/ doc/ lib_*/ and tools/: Remove lingering references to CFG_CMD_* symbols. 2007-07-10 11:19:50 -05:00
README.video Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.VLAN Patches by Pantelis Antoniou, 30 Mar 2004: 2004-04-15 21:48:45 +00:00
README.xpedite1k i2c: Update references to individual i2c commands 2009-06-12 20:39:46 +02:00
README.zeus ppc4xx: Add initial Zeus (PPC405EP) board support 2007-08-14 14:44:41 +02:00
TODO-i386 * Patch by Marc Singer, 29 May 2003: 2003-05-31 18:35:21 +00:00

Storage of the board specific values (ethaddr...)
-------------------------------------------------

The board specific environment variables that should be unique
for each individual board, can be stored in the I2C EEPROM. This
will be done from offset 0x80 with the length of 0x80 bytes. The
following command can be used to store the values here:

=> setdef de:20:6a:ed:e2:72 de:20:6a:ed:e2:73 AB0001

	  ethaddr           eth1addr          serial#

Now those 3 values are stored into the I2C EEPROM. A CRC is added
to make sure that the values get not corrupted.


SW-Reset Pushbutton handling:
-----------------------------

The SW-reset push button is connected to a GPIO input too. This
way U-Boot can "see" how long the SW-reset was pressed, and a
specific action can be taken. Two different actions are supported:

a) Release after more than 5 seconds and less then 10 seconds:
   -> Run POST

   Please note, that the POST test will take a while (approx. 1 min
   on the 128MByte board). This is mainly due to the system memory
   test.

b) Release after more than 10 seconds:
   -> Restore factory default settings

   The factory default values are restored. The default environment
   variables are restored (ipaddr, serverip...) and the board
   specific values (ethaddr, eth1addr and serial#) are restored
   to the environment from the I2C EEPROM. Also a bootline parameter
   is added to the Linux bootline to signal the Linux kernel upon
   the next startup, that the factory defaults should be restored.

The command to check this sw-reset status and act accordingly is

=> chkreset

This command is added to the default "bootcmd", so that it is called
automatically upon startup.

Also, the 2 LED's are used to indicate the current status of this
command (time passed since pushing the button). When the POST test
will be run, the green LED will be switched off, and when the
factory restore will be initiated, the reg LED will be switched off.


Loggin of POST results:
-----------------------

The results of the POST tests are logged in a logbuffer located at the end
of the onboard memory. It can be accessed with the U-Boot command "log":

=> log show
<4>POST memory PASSED
<4>POST cache PASSED
<4>POST cpu PASSED
<4>POST uart PASSED
<4>POST ethernet PASSED

The DENX Linux kernel tree has support for this log buffer included. Exactly
this buffer is used for logging of all kernel messages too. By enabling the
compile time option "CONFIG_LOGBUFFER" this support is enabled. This way you
can access the U-Boot log messages from Linux too.

2007-08-10, Stefan Roese <sr@denx.de>