* Patch by Rishi Bhattacharya, 08 May 2004:
[oweals/u-boot.git] / README
diff --git a/README b/README
index 1df1ef0639e1d7a18ac162b261ed4adee413b1b4..db3e4f58b675d61b43ab055881f9a810562ae8bb 100644 (file)
--- a/README
+++ b/README
@@ -240,57 +240,68 @@ The following options need to be configured:
                CONFIG_ARM7
                CONFIG_PXA250
 
+               MicroBlaze based CPUs:
+               ----------------------
+               CONFIG_MICROBLZE
+
 
 - Board Type:  Define exactly one of
 
                PowerPC based boards:
                ---------------------
 
-               CONFIG_ADCIOP,     CONFIG_ICU862      CONFIG_RPXsuper,
-               CONFIG_ADS860,     CONFIG_IP860,      CONFIG_SM850,
-               CONFIG_AMX860,     CONFIG_IPHASE4539, CONFIG_SPD823TS,
-               CONFIG_AR405,      CONFIG_IVML24,     CONFIG_SXNI855T,
-               CONFIG_BAB7xx,     CONFIG_IVML24_128, CONFIG_Sandpoint8240,
-               CONFIG_CANBT,      CONFIG_IVML24_256, CONFIG_Sandpoint8245,
-               CONFIG_CCM,        CONFIG_IVMS8,      CONFIG_TQM823L,
-               CONFIG_CPCI405,    CONFIG_IVMS8_128,  CONFIG_TQM850L,
-               CONFIG_CPCI4052,   CONFIG_IVMS8_256,  CONFIG_TQM855L,
-               CONFIG_CPCIISER4,  CONFIG_LANTEC,     CONFIG_TQM860L,
-               CONFIG_CPU86,      CONFIG_MBX,        CONFIG_TQM8260,
-               CONFIG_CRAYL1,     CONFIG_MBX860T,    CONFIG_TTTech,
-               CONFIG_CU824,      CONFIG_MHPC,       CONFIG_UTX8245,
-               CONFIG_DASA_SIM,   CONFIG_MIP405,     CONFIG_W7OLMC,
-               CONFIG_DU405,      CONFIG_MOUSSE,     CONFIG_W7OLMG,
-               CONFIG_ELPPC,      CONFIG_MPC8260ADS, CONFIG_WALNUT405,
-               CONFIG_ERIC,       CONFIG_MUSENKI,    CONFIG_ZUMA,
-               CONFIG_ESTEEM192E, CONFIG_MVS1,       CONFIG_c2mon,
-               CONFIG_ETX094,     CONFIG_NX823,      CONFIG_cogent_mpc8260,
-               CONFIG_EVB64260,   CONFIG_OCRTC,      CONFIG_cogent_mpc8xx,
-               CONFIG_FADS823,    CONFIG_ORSG,       CONFIG_ep8260,
-               CONFIG_FADS850SAR, CONFIG_OXC,        CONFIG_gw8260,
-               CONFIG_FADS860T,   CONFIG_PCI405,     CONFIG_hermes,
-               CONFIG_FLAGADM,    CONFIG_PCIPPC2,    CONFIG_hymod,
-               CONFIG_FPS850L,    CONFIG_PCIPPC6,    CONFIG_lwmon,
-               CONFIG_GEN860T,    CONFIG_PIP405,     CONFIG_pcu_e,
-               CONFIG_GENIETV,    CONFIG_PM826,      CONFIG_ppmc8260,
-               CONFIG_GTH,        CONFIG_RPXClassic, CONFIG_rsdproto,
-               CONFIG_IAD210,     CONFIG_RPXlite,    CONFIG_sbc8260,
-               CONFIG_EBONY,      CONFIG_sacsng,     CONFIG_FPS860L,
-               CONFIG_V37,        CONFIG_ELPT860,    CONFIG_CMI,
-               CONFIG_NETVIA,     CONFIG_RBC823,     CONFIG_ZPC1900,
-               CONFIG_MPC8540ADS, CONFIG_MPC8560ADS, CONFIG_QS850,
-               CONFIG_QS823,      CONFIG_QS860T,     CONFIG_DB64360,
-               CONFIG_DB64460,    CONFIG_DUET_ADS
+               CONFIG_ADCIOP           CONFIG_GEN860T          CONFIG_PCI405
+               CONFIG_ADS860           CONFIG_GENIETV          CONFIG_PCIPPC2
+               CONFIG_AMX860           CONFIG_GTH              CONFIG_PCIPPC6
+               CONFIG_AR405            CONFIG_gw8260           CONFIG_pcu_e
+               CONFIG_BAB7xx           CONFIG_hermes           CONFIG_PIP405
+               CONFIG_c2mon            CONFIG_hymod            CONFIG_PM826
+               CONFIG_CANBT            CONFIG_IAD210           CONFIG_ppmc8260
+               CONFIG_CCM              CONFIG_ICU862           CONFIG_QS823
+               CONFIG_CMI              CONFIG_IP860            CONFIG_QS850
+               CONFIG_cogent_mpc8260   CONFIG_IPHASE4539       CONFIG_QS860T
+               CONFIG_cogent_mpc8xx    CONFIG_IVML24           CONFIG_RBC823
+               CONFIG_CPCI405          CONFIG_IVML24_128       CONFIG_RPXClassic
+               CONFIG_CPCI4052         CONFIG_IVML24_256       CONFIG_RPXlite
+               CONFIG_CPCIISER4        CONFIG_IVMS8            CONFIG_RPXsuper
+               CONFIG_CPU86            CONFIG_IVMS8_128        CONFIG_rsdproto
+               CONFIG_CRAYL1           CONFIG_IVMS8_256        CONFIG_sacsng
+               CONFIG_CSB272           CONFIG_JSE              CONFIG_Sandpoint8240
+               CONFIG_CU824            CONFIG_LANTEC           CONFIG_Sandpoint8245
+               CONFIG_DASA_SIM         CONFIG_lwmon            CONFIG_sbc8260
+               CONFIG_DB64360          CONFIG_MBX              CONFIG_SM850
+               CONFIG_DB64460          CONFIG_MBX860T          CONFIG_SPD823TS
+               CONFIG_DU405            CONFIG_MHPC             CONFIG_STXGP3
+               CONFIG_DUET_ADS         CONFIG_MIP405           CONFIG_SXNI855T
+               CONFIG_EBONY            CONFIG_MOUSSE           CONFIG_TQM823L
+               CONFIG_ELPPC            CONFIG_MPC8260ADS       CONFIG_TQM8260
+               CONFIG_ELPT860          CONFIG_MPC8540ADS       CONFIG_TQM850L
+               CONFIG_ep8260           CONFIG_MPC8560ADS       CONFIG_TQM855L
+               CONFIG_ERIC             CONFIG_MUSENKI          CONFIG_TQM860L
+               CONFIG_ESTEEM192E       CONFIG_MVS1             CONFIG_TTTech
+               CONFIG_ETX094           CONFIG_NETPHONE         CONFIG_UTX8245
+               CONFIG_EVB64260         CONFIG_NETTA            CONFIG_V37
+               CONFIG_FADS823          CONFIG_NETVIA           CONFIG_W7OLMC
+               CONFIG_FADS850SAR       CONFIG_NX823            CONFIG_W7OLMG
+               CONFIG_FADS860T         CONFIG_OCRTC            CONFIG_WALNUT405
+               CONFIG_FLAGADM          CONFIG_ORSG             CONFIG_ZPC1900
+               CONFIG_FPS850L          CONFIG_OXC              CONFIG_ZUMA
+               CONFIG_FPS860L
 
                ARM based boards:
                -----------------
 
-               CONFIG_HHP_CRADLE,  CONFIG_DNP1110,     CONFIG_EP7312,
-               CONFIG_IMPA7,       CONFIG_LART,        CONFIG_LUBBOCK,
-               CONFIG_INNOVATOROMAP1510,      CONFIG_INNOVATOROMAP1610,
-               CONFIG_H2_OMAP1610, CONFIG_SHANNON,     CONFIG_SMDK2400,
-               CONFIG_SMDK2410,    CONFIG_TRAB,        CONFIG_VCMA9,
-               CONFIG_AT91RM9200DK
+               CONFIG_AT91RM9200DK,            CONFIG_DNP1110,         CONFIG_EP7312,
+               CONFIG_H2_OMAP1610,             CONFIG_HHP_CRADLE,      CONFIG_IMPA7,
+               CONFIG_INNOVATOROMAP1510,   CONFIG_INNOVATOROMAP1610,   CONFIG_LART,
+               CONFIG_LUBBOCK,                 CONFIG_OSK_OMAP5912,    CONFIG_SHANNON,
+               CONFIG_P2_OMAP730,              CONFIG_SMDK2400,        CONFIG_SMDK2410,
+               CONFIG_TRAB,                    CONFIG_VCMA9
+
+               MicroBlaze based boards:
+               ------------------------
+
+               CONFIG_SUZAKU
 
 
 - CPU Module Type: (if CONFIG_COGENT is defined)
@@ -320,7 +331,7 @@ The following options need to be configured:
                        CFG_8260ADS     - original MPC8260ADS
                        CFG_8266ADS     - MPC8266ADS
                        CFG_PQ2FADS     - PQ2FADS-ZU or PQ2FADS-VR
-
+                       CFG_8272ADS     - MPC8272ADS
 
 - MPC824X Family Member (if CONFIG_MPC824X is defined)
                Define exactly one of
@@ -441,8 +452,8 @@ The following options need to be configured:
                (RTS/CTS) and UART's built-in FIFO. Set the number of
                bytes the interrupt driven input buffer should have.
 
-               Set to 0 to disable this feature (this is the default).
-               This will also disable hardware handshake.
+               Leave undefined to disable this feature, including
+               disable the buffer and hardware handshake.
 
 - Console UART Number:
                CONFIG_UART1_CONSOLE
@@ -581,6 +592,7 @@ The following options need to be configured:
                CFG_CMD_USB     * USB support
                CFG_CMD_VFD     * VFD support (TRAB)
                CFG_CMD_BSP     * Board SPecific functions
+               CFG_CMD_CDP     * Cisco Discover Protocol support
                -----------------------------------------------
                CFG_CMD_ALL     all
 
@@ -778,17 +790,30 @@ The following options need to be configured:
                Enable Chips & Technologies 69000 Video chip
 
                CONFIG_VIDEO_SMI_LYNXEM
-               Enable Silicon Motion SMI 712/710/810 Video chip
-               Videomode are selected via environment 'videomode' with
-               standard LiLo mode numbers.
-               Following modes are supported  (* is default):
-
-                           800x600  1024x768  1280x1024
-             256  (8bit)     303*      305       307
-           65536 (16bit)     314       317       31a
-       16,7 Mill (24bit)     315       318       31b
+               Enable Silicon Motion SMI 712/710/810 Video chip. The
+               video output is selected via environment 'videoout'
+               (1 = LCD and 2 = CRT). If videoout is undefined, CRT is
+               assumed.
+
+               For the CT69000 and SMI_LYNXEM drivers, videomode is
+               selected via environment 'videomode'. Two diferent ways
+               are possible:
+               - "videomode=num"   'num' is a standard LiLo mode numbers.
+               Following standard modes are supported  (* is default):
+
+                     Colors    640x480 800x600 1024x768 1152x864 1280x1024
+               -------------+---------------------------------------------
+                     8 bits |  0x301*  0x303    0x305    0x161     0x307
+                    15 bits |  0x310   0x313    0x316    0x162     0x319
+                    16 bits |  0x311   0x314    0x317    0x163     0x31A
+                    24 bits |  0x312   0x315    0x318      ?       0x31B
+               -------------+---------------------------------------------
                (i.e. setenv videomode 317; saveenv; reset;)
 
+               - "videomode=bootargs" all the video parameters are parsed
+               from the bootargs. (See drivers/videomodes.c)
+
+
                CONFIG_VIDEO_SED13806
                Enable Epson SED13806 driver. This driver supports 8bpp
                and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
@@ -872,6 +897,32 @@ The following options need to be configured:
                the malloc area (as defined by CFG_MALLOC_LEN) should
                be at least 4MB.
 
+- MII/PHY support:
+               CONFIG_PHY_ADDR
+
+               The address of PHY on MII bus.
+
+               CONFIG_PHY_CLOCK_FREQ (ppc4xx)
+
+               The clock frequency of the MII bus
+
+               CONFIG_PHY_GIGE
+
+               If this option is set, support for speed/duplex
+               detection of Gigabit PHY is included.
+
+               CONFIG_PHY_RESET_DELAY
+
+               Some PHY like Intel LXT971A need extra delay after
+               reset before any MII register access is possible.
+               For such PHY, set this option to the usec delay
+               required. (minimum 300usec for LXT971A)
+
+               CONFIG_PHY_CMD_DELAY (ppc4xx)
+
+               Some PHY like Intel LXT971A need extra delay after
+               command issued before MII status register can be read
+
 - Ethernet address:
                CONFIG_ETHADDR
                CONFIG_ETH2ADDR
@@ -936,6 +987,48 @@ The following options need to be configured:
                environment variable is passed as option 12 to
                the DHCP server.
 
+ - CDP Options:
+               CONFIG_CDP_DEVICE_ID
+
+               The device id used in CDP trigger frames.
+
+               CONFIG_CDP_DEVICE_ID_PREFIX
+
+               A two character string which is prefixed to the MAC address
+               of the device.
+
+               CONFIG_CDP_PORT_ID
+
+               A printf format string which contains the ascii name of
+               the port. Normally is set to "eth%d" which sets
+               eth0 for the first ethernet, eth1 for the second etc.
+
+               CONFIG_CDP_CAPABILITIES
+
+               A 32bit integer which indicates the device capabilities;
+               0x00000010 for a normal host which does not forwards.
+
+               CONFIG_CDP_VERSION
+
+               An ascii string containing the version of the software.
+
+               CONFIG_CDP_PLATFORM
+
+               An ascii string containing the name of the platform.
+
+               CONFIG_CDP_TRIGGER
+
+               A 32bit integer sent on the trigger.
+
+               CONFIG_CDP_POWER_CONSUMPTION
+
+               A 16bit integer containing the power consumption of the
+               device in .1 of milliwatts.
+
+               CONFIG_CDP_APPLIANCE_VLAN_TYPE
+
+               A byte containing the id of the VLAN.
+
 - Status LED:  CONFIG_STATUS_LED
 
                Several configurations allow to display the current
@@ -1064,6 +1157,12 @@ The following options need to be configured:
                custom i2c_init_board() routine in boards/xxx/board.c
                is run early in the boot sequence.
 
+               CONFIG_I2CFAST (PPC405GP|PPC405EP only)
+
+               This option enables configuration of bi_iic_fast[] flags
+               in u-boot bd_info structure based on u-boot environment
+               variable "i2cfast". (see also i2cfast)
+
 - SPI Support: CONFIG_SPI
 
                Enables SPI driver (so far only tested with
@@ -1218,6 +1317,10 @@ The following options need to be configured:
                default value of 5 is used.
 
 - Command Interpreter:
+               CFG_AUTO_COMPLETE
+
+               Enable auto completion of commands using TAB.
+
                CFG_HUSH_PARSER
 
                Define this variable to enable the "hush" shell (from
@@ -1682,6 +1785,17 @@ to save the current settings.
          The length in bytes of the EEPROM memory array address.  Note
          that this is NOT the chip address length!
 
+       - CFG_I2C_EEPROM_ADDR_OVERFLOW:
+         EEPROM chips that implement "address overflow" are ones
+         like Catalyst 24WC04/08/16 which has 9/10/11 bits of
+         address and the extra bits end up in the "chip address" bit
+         slots. This makes a 24WC08 (1Kbyte) chip look like four 256
+         byte chips.
+
+         Note that we consider the length of the address field to
+         still be one byte because the extra address bits are hidden
+         in the chip address.
+
        - CFG_EEPROM_SIZE:
          The size in bytes of the EEPROM device.
 
@@ -1883,6 +1997,36 @@ Low Level (hardware related) configuration options:
   CFG_POCMR2_MASK_ATTRIB: (MPC826x only)
                Overrides the default PCI memory map in cpu/mpc8260/pci.c if set.
 
+- CONFIG_ETHER_ON_FEC[12]
+               Define to enable FEC[12] on a 8xx series processor.
+
+- CONFIG_FEC[12]_PHY
+               Define to the hardcoded PHY address which corresponds
+               to the given FEC; i. e.
+                       #define CONFIG_FEC1_PHY 4
+               means that the PHY with address 4 is connected to FEC1
+
+               When set to -1, means to probe for first available.
+
+- CONFIG_FEC[12]_PHY_NORXERR
+               The PHY does not have a RXERR line (RMII only).
+               (so program the FEC to ignore it).
+
+- CONFIG_RMII
+               Enable RMII mode for all FECs.
+               Note that this is a global option, we can't
+               have one FEC in standard MII mode and another in RMII mode.
+
+- CONFIG_CRC32_VERIFY
+               Add a verify option to the crc32 command.
+               The syntax is:
+
+               => crc32 -v <address> <count> <crc32>
+
+               Where address/count indicate a memory area
+               and crc32 is the correct crc32 which the
+               area should have.
+
 Building the Software:
 ======================
 
@@ -1910,54 +2054,41 @@ is done by typing:
 where "NAME_config" is the name of one of the existing
 configurations; the following names are supported:
 
-    ADCIOP_config        GTH_config            TQM850L_config
-    ADS860_config        IP860_config          TQM855L_config
-    AR405_config         IVML24_config         TQM860L_config
-    CANBT_config         IVMS8_config          WALNUT405_config
-    CPCI405_config       LANTEC_config         cogent_common_config
-    CPCIISER4_config     MBX_config            cogent_mpc8260_config
-    CU824_config         MBX860T_config        cogent_mpc8xx_config
-    ESTEEM192E_config    RPXlite_config        hermes_config
-    ETX094_config        RPXsuper_config       hymod_config
-    FADS823_config       SM850_config          lwmon_config
-    FADS850SAR_config    SPD823TS_config       pcu_e_config
-    FADS860T_config      SXNI855T_config       rsdproto_config
-    FPS850L_config       Sandpoint8240_config  sbc8260_config
-    GENIETV_config       TQM823L_config        PIP405_config
-    GEN860T_config       EBONY_config          FPS860L_config
-    ELPT860_config       cmi_mpc5xx_config     NETVIA_config
-    at91rm9200dk_config          omap1510inn_config    MPC8260ADS_config
-    omap1610inn_config   ZPC1900_config        MPC8540ADS_config
-    MPC8560ADS_config    QS850_config          QS823_config
-    QS860T_config        DUET_ADS_config       omap1610h2_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
-      SCC  for 10baseT  ethernet; there are also systems with 80 MHz
-      CPU clock, and an optional Fast Ethernet module  is  available
-      for  CPU's  with FEC. You can select such additional "features"
+       ADCIOP_config           FPS860L_config          omap730p2_config
+       ADS860_config           GEN860T_config          pcu_e_config
+       AR405_config            GENIETV_config          PIP405_config
+       at91rm9200dk_config     GTH_config              QS823_config
+       CANBT_config            hermes_config           QS850_config
+       cmi_mpc5xx_config       hymod_config            QS860T_config
+       cogent_common_config    IP860_config            RPXlite_config
+       cogent_mpc8260_config   IVML24_config           RPXsuper_config
+       cogent_mpc8xx_config    IVMS8_config            rsdproto_config
+       CPCI405_config          JSE_config              Sandpoint8240_config
+       CPCIISER4_config        LANTEC_config           sbc8260_config
+       csb272_config           lwmon_config            SM850_config
+       CU824_config            MBX860T_config          SPD823TS_config
+       DUET_ADS_config         MBX_config              stxgp3_config
+       EBONY_config            MPC8260ADS_config       SXNI855T_config
+       ELPT860_config          MPC8540ADS_config       TQM823L_config
+       ESTEEM192E_config       MPC8560ADS_config       TQM850L_config
+       ETX094_config           NETVIA_config           TQM855L_config
+       FADS823_config          omap1510inn_config      TQM860L_config
+       FADS850SAR_config       omap1610h2_config       WALNUT405_config
+       FADS860T_config         omap1610inn_config      ZPC1900_config
+       FPS850L_config          omap5912osk_config
+
+Note: for some board special configuration names may exist; check if
+      additional information is available from the board vendor; for
+      instance, the TQM823L systems are available without (standard)
+      or with LCD support. You can select such additional "features"
       when chosing the configuration, i. e.
 
-      make TQM860L_config
-       - will configure for a plain TQM860L, i. e. 50MHz, no FEC
-
-      make TQM860L_FEC_config
-       - will configure for a TQM860L at 50MHz with FEC for ethernet
-
-      make TQM860L_80MHz_config
-       - will configure for a TQM860L at 80 MHz, with normal 10baseT
-         interface
-
-      make TQM860L_FEC_80MHz_config
-       - will configure for a TQM860L at 80 MHz with FEC for ethernet
+      make TQM823L_config
+       - will configure for a plain TQM823L, i. e. no LCD support
 
       make TQM823L_LCD_config
        - will configure for a TQM823L with U-Boot console on LCD
 
-      make TQM823L_LCD_80MHz_config
-       - will configure for a TQM823L at 80 MHz with U-Boot console on LCD
-
       etc.
 
 
@@ -2125,6 +2256,12 @@ Some configuration options can be set using Environment Variables:
                  This can be used to load and uncompress arbitrary
                  data.
 
+  i2cfast      - (PPC405GP|PPC405EP only)
+                 if set to 'y' configures Linux I2C driver for fast
+                 mode (400kHZ). This environment variable is used in
+                 initialization code. So, for changes to be effective
+                 it must be saved and board must be reset.
+
   initrd_high  - restrict positioning of initrd images:
                  If this variable is not set, initrd images will be
                  copied to the highest possible address in RAM; this
@@ -2169,6 +2306,29 @@ Some configuration options can be set using Environment Variables:
 
   bootstopkey  - see CONFIG_AUTOBOOT_STOP_STR
 
+  ethprime     - When CONFIG_NET_MULTI is enabled controls which
+                 interface is used first.
+
+  ethact       - When CONFIG_NET_MULTI is enabled controls which
+                 interface is currently active. For example you
+                 can do the following
+
+                 => setenv ethact FEC ETHERNET
+                 => ping 192.168.0.1 # traffic sent on FEC ETHERNET
+                 => setenv ethact SCC ETHERNET
+                 => ping 10.0.0.1 # traffic sent on SCC ETHERNET
+
+   netretry    - When set to "no" each network operation will
+                 either succeed or fail without retrying.
+                 When set to "once" the network operation will
+                 fail when all the available network interfaces
+                 are tried once without success.
+                 Useful on scripts which control the retry operation
+                 themselves.
+
+   vlan                - When set to a value < 4095 the traffic over
+                 ethernet is encapsulated/received over 802.1q
+                 VLAN tagged frames.
 
 The following environment variables may be used and automatically
 updated by the network boot commands ("bootp" and "rarpboot"),
@@ -2435,8 +2595,9 @@ from a "data file" which is used as image payload:
          -n ==> set image name to 'name'
          -d ==> use image data from 'datafile'
 
-Right now, all Linux kernels use the same load address (0x00000000),
-but the entry point address depends on the kernel version:
+Right now, all Linux kernels for PowerPC systems use the same load
+address (0x00000000), but the entry point address depends on the
+kernel version:
 
 - 2.2.x kernels have the entry point at 0x0000000C,
 - 2.3.x and later kernels have the entry point at 0x00000000.