u-boot/doc
Wolfgang Denk c37207d7f5 Fix printf() format problems with configurable prompts
U-Boot allows for configurable prompt strings using the
CONFIG_AUTOBOOT_PROMPT resp. CONFIG_MENUPROMPT definitions. So far,
the assumption was that any such user defined problts would contain
exactly one "%d" format specifier. But some boards did not.

To allow for flexible boot prompts without adding too complex code we
now allow to specify the whole list of printf() arguments in the user
definition. This is powerful, but requires a responsible user who
really understands what he is doing, as he needs to know for exanple
which variables are available in the respective context.

Signed-off-by: Wolfgang Denk <wd@denx.de>
2008-07-31 17:08:27 +02:00
..
uImage.FIT Cleanup coding style, update CHANGELOG 2008-03-26 11:48:46 +01:00
I2C_Edge_Conditions Cleanup (PPC4xx is AMCC now) 2005-09-23 11:05:55 +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 Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.adnpesc1_base32 Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.alaska8220 Patch by TsiChung Liew, 23 Sep 2004: 2004-10-28 00:09:35 +00:00
README.AMCC-eval-boards-cleanup Major cleanup for AMCC PPC4xx eval boards. 2005-08-01 16:49:12 +02:00
README.amigaone
README.ARM-memory-map
README.ARM-SoC
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 Add AVR32 architecture support 2006-10-24 14:21:16 +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
README.COBRA5272 Patch by Florian Schlote, 08 Sep 2004: 2005-01-09 18:21:42 +00:00
README.commands
README.commands.itest
README.console Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.db64360
README.db64460
README.dk1c20
README.dk1c20_std32
README.dk1s10 Change all '$(...)' variable references into '${...}' 2005-11-20 21:40:11 +01:00
README.dk1s10_mldk20
README.dk1s10_std32
README.dk1s40_std32
README.dk20k200_std32
README.ebony Cleanup (PPC4xx is AMCC now) 2005-09-23 11:05:55 +02:00
README.evb64260
README.EVB-64260-750CX
README.fads
README.generic_usb_ohci USB: add new configuration variable CONFIG_PCI_OHCI_DEVNO 2008-05-27 12:53:34 +02:00
README.IceCube
README.idma2intr
README.INCA-IP
README.IPHASE4539
README.JFFS2 disk/ doc/ lib_*/ and tools/: Remove lingering references to CFG_CMD_* symbols. 2007-07-10 11:19:50 -05:00
README.JFFS2_NAND
README.korat ppc4xx: Updates to Korat-specific code 2008-03-27 10:52:03 +01:00
README.Lite5200B_low_power [PATCH] icecube/lite5200b: document wakeup from low-power support 2007-04-18 12:11:05 +02:00
README.lynxkdi
README.m68k Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.m5253evbe Coding style cleanup 2007-08-18 14:33:02 +02:00
README.m5373evb Coding Style Cleanup; update CHANGELOG 2008-01-23 14:31:17 +01:00
README.m5475evb Coding Style Cleanup; update CHANGELOG 2008-01-23 14:31:17 +01:00
README.m52277evb ColdFire: Add MCF5227x cpu and M52277EVB support-1 2008-01-17 14:59:41 -06:00
README.m54455evb Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.marubun-pcmcia Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.MBX
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
README.modnet50 fix comments with new drivers organization 2008-01-09 21:48:49 +01:00
README.mpc5xx
README.mpc74xx
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 Minor cleanup. 2007-03-08 22:52:51 +01:00
README.mpc837xemds Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.mpc837xerdb mpc83xx: clean up the readme for 83xx boards 2008-04-25 09:34:22 -05:00
README.mpc7448hpc2 Some code cleanup. 2007-03-04 01:36:05 +01:00
README.mpc8313erdb Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.mpc8315erdb mpc83xx: clean up the readme for 83xx boards 2008-04-25 09:34:22 -05:00
README.mpc8323erdb mpc83xx: add support for the MPC8323E RDB 2007-08-10 01:12:25 -05:00
README.mpc8349itx Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.mpc8360emds Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.mpc8544ds Coding style cleanup, update CHANGELOG 2007-08-14 09:54:46 +02:00
README.mpc8610hpcd 8610HPCD: Document the flashbank selection switches. 2008-02-20 15:26:51 -06:00
README.mpc8641hpcn Big white-space cleanup. 2008-05-21 00:14:08 +02:00
README.MPC866
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 fix various comments 2008-01-09 21:50:47 +01: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 Update usage of 'nc' in README.NetConsole 2007-04-04 18:12:28 -04:00
README.nios
README.nios_CFG_NIOS_CPU
README.nios_DK
README.ns9750dev
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.omap730p2
README.OXC
README.PIP405 disk/ doc/ lib_*/ and tools/: Remove lingering references to CFG_CMD_* symbols. 2007-07-10 11:19:50 -05:00
README.PlanetCore Document switching between U-Boot and PlanetCore on RPXlite 2005-08-06 02:11:33 +02:00
README.POST
README.ppc440 ppc4xx: Add pci_pre_init() for 405 boards 2007-06-25 15:57:39 +02:00
README.Purple
README.PXA_CF
README.qemu_mips qemu_mips: add README 2008-05-04 00:18:15 +02:00
README.RPXClassic
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
README.serial_multi Add support for CONFIG_SERIAL_MULTI on MPC5xxx 2006-06-16 17:04:45 +02:00
README.sh sh: Add support Renesas Solutions R7780MP 2008-03-28 14:16:12 +09:00
README.sha1 Update CHANGELOG, minor coding style cleanup. 2007-07-12 01:45:34 +02:00
README.silent
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
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
README.xpedite1k
README.zeus ppc4xx: Add initial Zeus (PPC405EP) board support 2007-08-14 14:44:41 +02:00
TODO-i386

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>