]> git.sur5r.net Git - u-boot/blobdiff - README
* Make BMS2003 use a separate config file to avoid #ifdef mess;
[u-boot] / README
diff --git a/README b/README
index 1471cb5dee69a5c798d5557ea355dbc139bd54e8..c223d4c399201d6cc39e931cbe42fed197631751 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 #
-# (C) Copyright 2000 - 2002
+# (C) Copyright 2000 - 2004
 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 #
 # See file CREDITS for list of people who contributed to this
@@ -146,6 +146,7 @@ Directory Hierarchy:
 - cpu/mpc8xx   Files specific to Motorola MPC8xx  CPUs
 - cpu/mpc824x  Files specific to Motorola MPC824x CPUs
 - cpu/mpc8260  Files specific to Motorola MPC8260 CPU
+- cpu/mpc85xx  Files specific to Motorola MPC85xx CPUs
 - cpu/ppc4xx   Files specific to IBM      4xx     CPUs
 
 
@@ -196,9 +197,16 @@ Directory Hierarchy:
 - board/ivm    Files specific to IVMS8/IVML24 boards
 - board/lantec Files specific to LANTEC     boards
 - board/lwmon  Files specific to LWMON      boards
+- board/Marvell Files specific to Marvell development boards
+- board/Marvell/db64360 Files specific to db64360 board
+- board/Marvell/db64460 Files specific to db64460 board
 - board/mbx8xx Files specific to MBX        boards
 - board/mpc8260ads
-               Files specific to MPC8260ADS and PQ2FADS-ZU boards
+               Files specific to MPC826xADS and PQ2FADS-ZU/VR boards
+- board/mpc8540ads
+               Files specific to MPC8540ADS boards
+- board/mpc8560ads
+               Files specific to MPC8560ADS boards
 - board/mpl/   Files specific to boards manufactured by MPL
 - board/mpl/common     Common files for MPL boards
 - board/mpl/pip405     Files specific to PIP405     boards
@@ -210,12 +218,14 @@ Directory Hierarchy:
 - board/oxc    Files specific to OXC        boards
 - board/omap1510inn
                Files specific to OMAP 1510 Innovator boards
-- board/omap1610inn  
+- board/omap1610inn
                Files specific to OMAP 1610 Innovator boards
 - board/pcippc2        Files specific to PCIPPC2/PCIPPC6 boards
 - board/pm826  Files specific to PM826      boards
 - board/ppmc8260
                Files specific to PPMC8260   boards
+- board/snmc/qs850     Files specific to QS850/823  boards
+- board/snmc/qs860t    Files specific to QS860T     boards
 - board/rpxsuper
                Files specific to RPXsuper   boards
 - board/rsdproto
@@ -239,6 +249,7 @@ Directory Hierarchy:
 - board/westel/        Files specific to boards manufactured by Westel Wireless
 - board/westel/amx860  Files specific to AMX860     boards
 - board/utx8245        Files specific to UTX8245   boards
+- board/zpc1900        Files specific to Zephyr Engineering ZPC.1900 board
 
 Software Configuration:
 =======================
@@ -305,6 +316,7 @@ The following options need to be configured:
                CONFIG_MPC823,  CONFIG_MPC850,  CONFIG_MPC855,  CONFIG_MPC860
        or      CONFIG_MPC5xx
        or      CONFIG_MPC824X, CONFIG_MPC8260
+       or      CONFIG_MPC85xx
        or      CONFIG_IOP480
        or      CONFIG_405GP
        or      CONFIG_405EP
@@ -355,7 +367,10 @@ The following options need to be configured:
                CONFIG_IAD210,     CONFIG_RPXlite,    CONFIG_sbc8260,
                CONFIG_EBONY,      CONFIG_sacsng,     CONFIG_FPS860L,
                CONFIG_V37,        CONFIG_ELPT860,    CONFIG_CMI,
-               CONFIG_NETVIA,     CONFIG_RBC823
+               CONFIG_NETVIA,     CONFIG_RBC823,     CONFIG_ZPC1900,
+               CONFIG_MPC8540ADS, CONFIG_MPC8560ADS, CONFIG_QS850,
+               CONFIG_QS823,      CONFIG_QS860T,     CONFIG_DB64360,
+               CONFIG_DB64460,    CONFIG_DUET_ADS
 
                ARM based boards:
                -----------------
@@ -392,20 +407,21 @@ The following options need to be configured:
                CONFIG_ADSTYPE
                Possible values are:
                        CFG_8260ADS     - original MPC8260ADS
-                       CFG_8266ADS     - MPC8266ADS (untested)
-                       CFG_PQ2FADS     - PQ2FADS-ZU
+                       CFG_8266ADS     - MPC8266ADS
+                       CFG_PQ2FADS     - PQ2FADS-ZU or PQ2FADS-VR
 
 
 - MPC824X Family Member (if CONFIG_MPC824X is defined)
-       Define exactly one of
-       CONFIG_MPC8240, CONFIG_MPC8245
+               Define exactly one of
+               CONFIG_MPC8240, CONFIG_MPC8245
 
 - 8xx CPU Options: (if using an 8xx cpu)
                Define one or more of
-               CONFIG_8xx_GCLK_FREQ    - if get_gclk_freq() can not work e.g.
-                                         no 32KHz reference PIT/RTC clock
+               CONFIG_8xx_GCLK_FREQ    - if get_gclk_freq() cannot work
+                                         e.g. if there is no 32KHz
+                                         reference PIT/RTC clock
 
-- Clock Interface:
+- Linux Kernel Interface:
                CONFIG_CLOCKS_IN_MHZ
 
                U-Boot stores all clock information in Hz
@@ -415,11 +431,16 @@ The following options need to be configured:
                "clocks_in_mhz" can be defined so that U-Boot
                converts clock data to MHZ before passing it to the
                Linux kernel.
-
                When CONFIG_CLOCKS_IN_MHZ is defined, a definition of
                "clocks_in_mhz=1" is  automatically  included  in  the
                default environment.
 
+               CONFIG_MEMSIZE_IN_BYTES         [relevant for MIPS only]
+
+               When transfering memsize parameter to linux, some versions
+               expect it to be in bytes, others in MB.
+               Define CONFIG_MEMSIZE_IN_BYTES to make it in bytes.
+
 - Console Interface:
                Depending on board, define exactly one serial port
                (like CONFIG_8xx_CONS_SMC1, CONFIG_8xx_CONS_SMC2,
@@ -473,10 +494,16 @@ The following options need to be configured:
                default i/o. Serial console can be forced with
                environment 'console=serial'.
 
+               When CONFIG_SILENT_CONSOLE is defined, all console
+               messages (by U-Boot and Linux!) can be silenced with
+               the "silent" environment variable. See
+               doc/README.silent for more information.
+
 - Console Baudrate:
                CONFIG_BAUDRATE - in bps
                Select one of the baudrates listed in
                CFG_BAUDRATE_TABLE, see below.
+               CFG_BRGCLK_PRESCALE, baudrate prescale
 
 - Interrupt driven serial port input:
                CONFIG_SERIAL_SOFTWARE_FIFO
@@ -584,7 +611,7 @@ The following options need to be configured:
                CFG_CMD_DHCP      DHCP support
                CFG_CMD_DIAG    * Diagnostics
                CFG_CMD_DOC     * Disk-On-Chip Support
-               CFG_CMD_DTT       Digital Therm and Thermostat 
+               CFG_CMD_DTT       Digital Therm and Thermostat
                CFG_CMD_ECHO    * echo arguments
                CFG_CMD_EEPROM  * EEPROM read/write support
                CFG_CMD_ELF       bootelf, bootvx
@@ -615,7 +642,7 @@ The following options need to be configured:
                CFG_CMD_PCI     * pciinfo
                CFG_CMD_PCMCIA  * PCMCIA support
                CFG_CMD_PING    * send ICMP ECHO_REQUEST to network host
-               CFG_CMD_PORTIO    Port I/O
+               CFG_CMD_PORTIO  * Port I/O
                CFG_CMD_REGINFO * Register dump
                CFG_CMD_RUN       run command in env variable
                CFG_CMD_SAVES     save S record dump
@@ -831,13 +858,18 @@ The following options need to be configured:
                display); also select one of the supported displays
                by defining one of these:
 
-               CONFIG_NEC_NL6648AC33:
+               CONFIG_NEC_NL6448AC33:
 
-                       NEC NL6648AC33-18. Active, color, single scan.
+                       NEC NL6448AC33-18. Active, color, single scan.
 
-               CONFIG_NEC_NL6648BC20
+               CONFIG_NEC_NL6448BC20
 
-                       NEC NL6648BC20-08. 6.5", 640x480.
+                       NEC NL6448BC20-08. 6.5", 640x480.
+                       Active, color, single scan.
+
+               CONFIG_NEC_NL6448BC33_54
+
+                       NEC NL6448BC33-54. 10.4", 640x480.
                        Active, color, single scan.
 
                CONFIG_SHARP_16x9
@@ -886,9 +918,9 @@ The following options need to be configured:
                images is included. If not, only uncompressed and gzip
                compressed images are supported.
 
-                NOTE: the bzip2 algorithm requires a lot of RAM, so
-                the malloc area (as defined by CFG_MALLOC_LEN) should
-                be at least 4MB.
+               NOTE: the bzip2 algorithm requires a lot of RAM, so
+               the malloc area (as defined by CFG_MALLOC_LEN) should
+               be at least 4MB.
 
 - Ethernet address:
                CONFIG_ETHADDR
@@ -1329,7 +1361,7 @@ The following options need to be configured:
                of the backslashes before semicolons and special
                symbols.
 
-- Default Environment
+- Default Environment:
                CONFIG_EXTRA_ENV_SETTINGS
 
                Define this to contain any number of null terminated
@@ -1355,14 +1387,14 @@ The following options need to be configured:
                the environment like the autoscript function or the
                boot command first.
 
-- DataFlash Support
+- DataFlash Support:
                CONFIG_HAS_DATAFLASH
 
                Defining this option enables DataFlash features and
                allows to read/write in Dataflash via the standard
                commands cp, md...
 
-- Show boot progress
+- Show boot progress:
                CONFIG_SHOW_BOOT_PROGRESS
 
                Defining this option allows to add some board-
@@ -1442,6 +1474,19 @@ Modem Support:
                Enables debugging stuff (char screen[1024], dbg())
                for modem support. Useful only with BDI2000.
 
+- Interrupt support (PPC):
+
+               There are common interrupt_init() and timer_interrupt()
+               for all PPC archs. interrupt_init() calls interrupt_init_cpu()
+               for cpu specific initialization. interrupt_init_cpu()
+               should set decrementer_count to appropriate value. If
+               cpu resets decrementer automatically after interrupt
+               (ppc4xx) it should set decrementer_count to zero.
+               timer_interrupt() calls timer_interrupt_cpu() for cpu
+               specific handling. If board has watchdog / status_led
+               / other_activity_monitor it works automatically from
+               general timer_interrupt().
+
 - General:
 
                In the target system modem support is enabled when a
@@ -1723,6 +1768,20 @@ to save the current settings.
          The size in bytes of the EEPROM device.
 
 
+- CFG_ENV_IS_IN_DATAFLASH:
+
+       Define this if you have a DataFlash memory device which you
+       want to use for the environment.
+
+       - CFG_ENV_OFFSET:
+       - CFG_ENV_ADDR:
+       - CFG_ENV_SIZE:
+
+         These three #defines specify the offset and size of the
+         environment area within the total memory of your DataFlash placed
+         at the specified address.
+
+
 - CFG_SPI_INIT_OFFSET
 
        Defines offset to the initial SPI buffer area in DPRAM. The
@@ -1749,6 +1808,14 @@ Note: once the monitor has been relocated, then it will complain if
 the default environment is used; a new CRC is computed as soon as you
 use the "saveenv" command to store a valid environment.
 
+- CFG_FAULT_ECHO_LINK_DOWN:
+               Echo the inverted Ethernet link state to the fault LED.
+
+               Note: If this option is active, then CFG_FAULT_MII_ADDR
+                     also needs to be defined.
+
+- CFG_FAULT_MII_ADDR:
+               MII address of the PHY to check for the Ethernet link state.
 
 Low Level (hardware related) configuration options:
 ---------------------------------------------------
@@ -1759,9 +1826,9 @@ Low Level (hardware related) configuration options:
 - CFG_DEFAULT_IMMR:
                Default address of the IMMR after system reset.
 
-                Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
-                and RPXsuper) to be able to adjust the position of
-                the IMMR register after a reset.
+               Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
+               and RPXsuper) to be able to adjust the position of
+               the IMMR register after a reset.
 
 - Floppy Disk Support:
                CFG_FDC_DRIVE_NUMBER
@@ -1935,7 +2002,10 @@ configurations; the following names are supported:
     GEN860T_config       EBONY_config          FPS860L_config
     ELPT860_config       cmi_mpc5xx_config     NETVIA_config
     at91rm9200dk_config          omap1510inn_config    MPC8260ADS_config
-    omap1610inn_config
+    omap1610inn_config   ZPC1900_config        MPC8540ADS_config
+    MPC8560ADS_config    QS850_config          QS823_config
+    QS860T_config         DUET_ADS_config
+
 Note: for some board special configuration names may exist; check  if
       additional  information is available from the board vendor; for
       instance, the TQM8xxL systems run normally at 50 MHz and use  a
@@ -2301,8 +2371,8 @@ defines the following image properties:
   LynxOS, pSOS, QNX, RTEMS, ARTOS;
   Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
 * Target CPU Architecture (Provisions for Alpha, ARM, Intel x86,
-  IA64, MIPS, MIPS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
-  Currently supported: PowerPC).
+  IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
+  Currently supported: ARM, Intel x86, MIPS, NIOS, PowerPC).
 * Compression Type (uncompressed, gzip, bzip2)
 * Load Address
 * Entry Point
@@ -3044,7 +3114,7 @@ int main (int argc, char *argv[])
 
        while (learning) {
                Read the README file in the top level directory;
-               Read http://www.denx.de/re/DPLG.html
+               Read http://www.denx.de/twiki/bin/view/DULG/Manual ;
                Read the source, Luke;
        }
 
@@ -3088,6 +3158,13 @@ Please note that U-Boot is implemented in C (and to some small parts
 in Assembler); no C++ is used, so please do not use C++ style
 comments (//) in your code.
 
+Please also stick to the following formatiing rules:
+- remove any trailing white space
+- use TAB characters for indentation, not spaces
+- make sure NOT to use DOS '\r\n' line feeds
+- do not add more than 2 empty lines to source files
+- do not add trailing empty lines to source files
+
 Submissions which do not conform to the standards may be returned
 with a request to reformat the changes.