]> git.sur5r.net Git - u-boot/blobdiff - README
[new uImage] Fix autoscr command used with new uImage format
[u-boot] / README
diff --git a/README b/README
index 09eb76fe4528dfedca027b119ac760fce2570e35..26bd0cf7c152cba10e31529a45f930a51983a91b 100644 (file)
--- a/README
+++ b/README
@@ -136,8 +136,10 @@ Directory Hierarchy:
   - i386       Files specific to i386 CPUs
   - ixp                Files specific to Intel XScale IXP CPUs
   - mcf52x2    Files specific to Freescale ColdFire MCF52x2 CPUs
+  - mcf5227x   Files specific to Freescale ColdFire MCF5227x CPUs
   - mcf532x    Files specific to Freescale ColdFire MCF5329 CPUs
   - mcf5445x   Files specific to Freescale ColdFire MCF5445x CPUs
+  - mcf547x_8x Files specific to Freescale ColdFire MCF547x_8x CPUs
   - mips       Files specific to MIPS CPUs
   - mpc5xx     Files specific to Freescale MPC5xx  CPUs
   - mpc5xxx    Files specific to Freescale MPC5xxx CPUs
@@ -235,9 +237,7 @@ The following options need to be configured:
 - Board Type:  Define exactly one, e.g. CONFIG_MPC8540ADS.
 
 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
-               Define exactly one of
-               CONFIG_ATSTK1002
-
+               Define exactly one, e.g. CONFIG_ATSTK1002
 
 - CPU Module Type: (if CONFIG_COGENT is defined)
                Define exactly one of
@@ -926,7 +926,7 @@ The following options need to be configured:
                (i.e. setenv videomode 317; saveenv; reset;)
 
                - "videomode=bootargs" all the video parameters are parsed
-               from the bootargs. (See drivers/videomodes.c)
+               from the bootargs. (See drivers/video/videomodes.c)
 
 
                CONFIG_VIDEO_SED13806
@@ -1355,7 +1355,7 @@ The following options need to be configured:
                CONFIG_FSL_I2C
 
                Define this option if you want to use Freescale's I2C driver in
-               drivers/fsl_i2c.c.
+               drivers/i2c/fsl_i2c.c.
 
 
 - SPI Support: CONFIG_SPI
@@ -1379,14 +1379,31 @@ The following options need to be configured:
                SPI configuration items (port pins to use, etc). For
                an example, see include/configs/sacsng.h.
 
-- FPGA Support: CONFIG_FPGA_COUNT
+               CONFIG_HARD_SPI
 
-               Specify the number of FPGA devices to support.
+               Enables a hardware SPI driver for general-purpose reads
+               and writes.  As with CONFIG_SOFT_SPI, the board configuration
+               must define a list of chip-select function pointers.
+               Currently supported on some MPC8xxx processors.  For an
+               example, see include/configs/mpc8349emds.h.
+
+- FPGA Support: CONFIG_FPGA
+
+               Enables FPGA subsystem.
+
+               CONFIG_FPGA_<vendor>
+
+               Enables support for specific chip vendors.
+               (ALTERA, XILINX)
+
+               CONFIG_FPGA_<family>
 
-               CONFIG_FPGA
+               Enables support for FPGA family.
+               (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
 
-               Used to specify the types of FPGA devices.  For example,
-               #define CONFIG_FPGA  CFG_XILINX_VIRTEX2
+               CONFIG_FPGA_COUNT
+
+               Specify the number of FPGA devices to support.
 
                CFG_FPGA_PROG_FEEDBACK
 
@@ -1642,6 +1659,8 @@ The following options need to be configured:
                example, some LED's) on your board. At the moment,
                the following checkpoints are implemented:
 
+Legacy uImage format:
+
   Arg  Where                   When
     1  common/cmd_bootm.c      before attempting to boot an image
    -1  common/cmd_bootm.c      Image header has bad     magic number
@@ -1652,25 +1671,26 @@ The following options need to be configured:
     4  common/cmd_bootm.c      Image data   has correct checksum
    -4  common/cmd_bootm.c      Image is for unsupported architecture
     5  common/cmd_bootm.c      Architecture check OK
-   -5  common/cmd_bootm.c      Wrong Image Type (not kernel, multi, standalone)
+   -5  common/cmd_bootm.c      Wrong Image Type (not kernel, multi)
     6  common/cmd_bootm.c      Image Type check OK
    -6  common/cmd_bootm.c      gunzip uncompression error
    -7  common/cmd_bootm.c      Unimplemented compression type
     7  common/cmd_bootm.c      Uncompression OK
-   -8  common/cmd_bootm.c      Wrong Image Type (not kernel, multi, standalone)
-    8  common/cmd_bootm.c      Image Type check OK
+    8  common/cmd_bootm.c      No uncompress/copy overwrite error
    -9  common/cmd_bootm.c      Unsupported OS (not Linux, BSD, VxWorks, QNX)
-    9  common/cmd_bootm.c      Start initial ramdisk verification
-  -10  common/cmd_bootm.c      Ramdisk header has bad     magic number
-  -11  common/cmd_bootm.c      Ramdisk header has bad     checksum
-   10  common/cmd_bootm.c      Ramdisk header is OK
-  -12  common/cmd_bootm.c      Ramdisk data   has bad     checksum
-   11  common/cmd_bootm.c      Ramdisk data   has correct checksum
-   12  common/cmd_bootm.c      Ramdisk verification complete, start loading
-  -13  common/cmd_bootm.c      Wrong Image Type (not PPC Linux Ramdisk)
-   13  common/cmd_bootm.c      Start multifile image verification
-   14  common/cmd_bootm.c      No initial ramdisk, no multifile, continue.
-   15  common/cmd_bootm.c      All preparation done, transferring control to OS
+
+    9  common/image.c          Start initial ramdisk verification
+  -10  common/image.c          Ramdisk header has bad     magic number
+  -11  common/image.c          Ramdisk header has bad     checksum
+   10  common/image.c          Ramdisk header is OK
+  -12  common/image.c          Ramdisk data   has bad     checksum
+   11  common/image.c          Ramdisk data   has correct checksum
+   12  common/image.c          Ramdisk verification complete, start loading
+  -13  common/image.c          Wrong Image Type (not PPC Linux Ramdisk)
+   13  common/image.c          Start multifile image verification
+   14  common/image.c          No initial ramdisk, no multifile, continue.
+
+   15  lib_<arch>/bootm.c      All preparation done, transferring control to OS
 
   -30  lib_ppc/board.c         Fatal error, hang the system
   -31  post/post.c             POST test failed, detected by post_output_backlog()
@@ -1740,6 +1760,59 @@ The following options need to be configured:
   -83  common/cmd_net.c        some error in automatic boot or autoscript
    84  common/cmd_net.c        end without errors
 
+FIT uImage format:
+
+  Arg  Where                   When
+  100  common/cmd_bootm.c      Kernel FIT Image has correct format
+ -100  common/cmd_bootm.c      Kernel FIT Image has incorrect format
+  101  common/cmd_bootm.c      No Kernel subimage unit name, using configuration
+ -101  common/cmd_bootm.c      Can't get configuration for kernel subimage
+  102  common/cmd_bootm.c      Kernel unit name specified
+ -103  common/cmd_bootm.c      Can't get kernel subimage node offset
+  103  common/cmd_bootm.c      Found configuration node
+  104  common/cmd_bootm.c      Got kernel subimage node offset
+ -104  common/cmd_bootm.c      Kernel subimage hash verification failed
+  105  common/cmd_bootm.c      Kernel subimage hash verification OK
+ -105  common/cmd_bootm.c      Kernel subimage is for unsupported architecture
+  106  common/cmd_bootm.c      Architecture check OK
+ -106  common/cmd_bootm.c      Kernel subimage has wrong typea
+  107  common/cmd_bootm.c      Kernel subimge type OK
+ -107  common/cmd_bootm.c      Can't get kernel subimage data/size
+  108  common/cmd_bootm.c      Got kernel subimage data/size
+ -108  common/cmd_bootm.c      Wrong image type (not legacy, FIT)
+ -109  common/cmd_bootm.c      Can't get kernel subimage type
+ -110  common/cmd_bootm.c      Can't get kernel subimage comp
+ -111  common/cmd_bootm.c      Can't get kernel subimage os
+ -112  common/cmd_bootm.c      Can't get kernel subimage load address
+ -113  common/cmd_bootm.c      Image uncompress/copy overwrite error
+
+  120  common/image.c          Start initial ramdisk verification
+ -120  common/image.c          Ramdisk FIT image has incorrect format
+  121  common/image.c          Ramdisk FIT image has correct format
+  122  common/image.c          No Ramdisk subimage unit name, using configuration
+ -122  common/image.c          Can't get configuration for ramdisk subimage
+  123  common/image.c          Ramdisk unit name specified
+ -124  common/image.c          Can't get ramdisk subimage node offset
+  125  common/image.c          Got ramdisk subimage node offset
+ -125  common/image.c          Ramdisk subimage hash verification failed
+  126  common/image.c          Ramdisk subimage hash verification OK
+ -126  common/image.c          Ramdisk subimage for unsupported architecture
+  127  common/image.c          Architecture check OK
+ -127  common/image.c          Can't get ramdisk subimage data/size
+  128  common/image.c          Got ramdisk subimage data/size
+  129  common/image.c          Can't get ramdisk load address
+ -129  common/image.c          Got ramdisk load address
+
+ -130  common/cmd_doc.c        Icorrect FIT image format
+  131  common/cmd_doc.c        FIT image format OK
+
+ -140  common/cmd_ide.c        Icorrect FIT image format
+  141  common/cmd_ide.c        FIT image format OK
+
+ -150  common/cmd_nand.c       Icorrect FIT image format
+  151  common/cmd_nand.c       FIT image format OK
+
+
 Modem Support:
 --------------
 
@@ -2123,7 +2196,7 @@ to save the current settings.
        to be a good choice since it makes it far enough from the
        start of the data area as well as from the stack pointer.
 
-Please note that the environment is read-only as long as the monitor
+Please note that the environment is read-only until the monitor
 has been relocated to RAM and a RAM copy of the environment has been
 created; also, when using EEPROM you will have to use getenv_r()
 until then to read environment variables.
@@ -2271,6 +2344,10 @@ Low Level (hardware related) configuration options:
                enable I2C microcode relocation patch (MPC8xx);
                define relocation offset in DPRAM [DSP2]
 
+- CFG_SMC_UCODE_PATCH, CFG_SMC_DPMEM_OFFSET [0x1FC0]:
+               enable SMC microcode relocation patch (MPC8xx);
+               define relocation offset in DPRAM [SMC1]
+
 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
                enable SPI microcode relocation patch (MPC8xx);
                define relocation offset in DPRAM [SCC4]
@@ -2607,6 +2684,14 @@ Some configuration options can be set using Environment Variables:
                  configuration from the BOOTP server, but not try to
                  load any image using TFTP
 
+  autoscript   - if set to "yes" commands like "loadb", "loady",
+                 "bootp", "tftpb", "rarpboot" and "nfs" will attempt
+                 to automatically run script images (by internally
+                 calling "autoscript").
+
+  autoscript_uname - if script image is in a format (FIT) this
+                    variable is used to get script subimage unit name.
+
   autostart    - if set to "yes", an image loaded using the "bootp",
                  "rarpboot", "tftpboot" or "diskboot" commands will
                  be automatically started (by internally calling
@@ -2680,6 +2765,10 @@ Some configuration options can be set using Environment Variables:
                  => setenv ethact SCC ETHERNET
                  => ping 10.0.0.1 # traffic sent on SCC ETHERNET
 
+  ethrotate    - When set to "no" U-Boot does not go through all
+                 available network interfaces.
+                 It just stays at the currently selected interface.
+
    netretry    - When set to "no" each network operation will
                  either succeed or fail without retrying.
                  When set to "once" the network operation will
@@ -2688,6 +2777,9 @@ Some configuration options can be set using Environment Variables:
                  Useful on scripts which control the retry operation
                  themselves.
 
+  npe_ucode    - see CONFIG_IXP4XX_NPE_EXT_UCOD
+                 if set load address for the npe microcode
+
   tftpsrcport  - If this is set, the value is used for TFTP's
                  UDP source port.
 
@@ -2814,10 +2906,24 @@ o If neither SROM nor the environment contain a MAC address, an error
 Image Formats:
 ==============
 
-The "boot" commands of this monitor operate on "image" files which
-can be basicly anything, preceeded by a special header; see the
-definitions in include/image.h for details; basicly, the header
-defines the following image properties:
+U-Boot is capable of booting (and performing other auxiliary operations on)
+images in two formats:
+
+New uImage format (FIT)
+-----------------------
+
+Flexible and powerful format based on Flattened Image Tree -- FIT (similar
+to Flattened Device Tree). It allows the use of images with multiple
+components (several kernels, ramdisks, etc.), with contents protected by
+SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
+
+
+Old uImage format
+-----------------
+
+Old image format is based on binary files which can be basically anything,
+preceded by a special header; see the definitions in include/image.h for
+details; basically, the header defines the following image properties:
 
 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
@@ -3471,7 +3577,7 @@ GCC's implementation.
 
 For PowerPC, the following registers have specific use:
        R1:     stack pointer
-       R2:     TOC pointer
+       R2:     reserved for system use
        R3-R4:  parameter passing and return values
        R5-R10: parameter passing
        R13:    small data area pointer
@@ -3480,7 +3586,7 @@ For PowerPC, the following registers have specific use:
 
        (U-Boot also uses R14 as internal GOT pointer.)
 
-    ==> U-Boot will use R29 to hold a pointer to the global data
+    ==> U-Boot will use R2 to hold a pointer to the global data
 
     Note: on PPC, we could use a static initializer (since the
     address of the global data structure is known at compile time),
@@ -3489,6 +3595,11 @@ For PowerPC, the following registers have specific use:
     average for all boards 752 bytes for the whole U-Boot image,
     624 text + 127 data).
 
+On Blackfin, the normal C ABI (except for P5) is followed as documented here:
+       http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
+
+    ==> U-Boot will use P5 to hold a pointer to the global data
+
 On ARM, the following registers are used:
 
        R0:     function argument word/integer result