]> git.sur5r.net Git - u-boot/blobdiff - README
projects / u-boot / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
[new uImage] Fix autoscr command used with new uImage format
[u-boot] / README
diff --git a/README b/README
index 398ea7e791c038dfc479c098be74c5d46bde8cbe..26bd0cf7c152cba10e31529a45f930a51983a91b 100644 (file)
--- a/README
+++ b/README
@@ -136,6 +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
   - 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
   - mips       Files specific to MIPS CPUs
   - mpc5xx     Files specific to Freescale MPC5xx  CPUs
   - mpc5xxx    Files specific to Freescale MPC5xxx CPUs
@@ -233,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)
 - 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
 
 - CPU Module Type: (if CONFIG_COGENT is defined)
                Define exactly one of
@@ -336,7 +338,7 @@ The following options need to be configured:
                CONFIG_OF_LIBFDT
                 * New libfdt-based support
                 * Adds the "fdt" command
                CONFIG_OF_LIBFDT
                 * New libfdt-based support
                 * Adds the "fdt" command
-                * The bootm command does _not_ modify the fdt
+                * The bootm command automatically updates the fdt
 
                CONFIG_OF_FLAT_TREE
                 * Deprecated, see CONFIG_OF_LIBFDT
 
                CONFIG_OF_FLAT_TREE
                 * Deprecated, see CONFIG_OF_LIBFDT
@@ -345,15 +347,13 @@ The following options need to be configured:
                 * The environment variable "disable_of", when set,
                     disables this functionality.
 
                 * The environment variable "disable_of", when set,
                     disables this functionality.
 
-               CONFIG_OF_FLAT_TREE_MAX_SIZE
-
-               The maximum size of the constructed OF tree.
-
                OF_CPU - The proper name of the cpus node.
                OF_SOC - The proper name of the soc node.
                OF_TBCLK - The timebase frequency.
                OF_STDOUT_PATH - The path to the console device
 
                OF_CPU - The proper name of the cpus node.
                OF_SOC - The proper name of the soc node.
                OF_TBCLK - The timebase frequency.
                OF_STDOUT_PATH - The path to the console device
 
+               boards with QUICC Engines require OF_QE to set UCC mac addresses
+
                CONFIG_OF_HAS_BD_T
 
                 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
                CONFIG_OF_HAS_BD_T
 
                 * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
@@ -363,7 +363,7 @@ The following options need to be configured:
 
                CONFIG_OF_HAS_UBOOT_ENV
 
 
                CONFIG_OF_HAS_UBOOT_ENV
 
-                * CONFIG_OF_LIBFDT - enables the "fdt bd_t" command
+                * CONFIG_OF_LIBFDT - enables the "fdt env" command
                 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
                     will have a copy of u-boot's environment variables
 
                 * CONFIG_OF_FLAT_TREE - The resulting flat device tree
                     will have a copy of u-boot's environment variables
 
@@ -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
                (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
 
 
                CONFIG_VIDEO_SED13806
@@ -1066,6 +1066,16 @@ The following options need to be configured:
                Defines a default value for theIP address of a TFTP
                server to contact when using the "tftboot" command.
 
                Defines a default value for theIP address of a TFTP
                server to contact when using the "tftboot" command.
 
+- Multicast TFTP Mode:
+               CONFIG_MCAST_TFTP
+
+               Defines whether you want to support multicast TFTP as per
+               rfc-2090; for example to work with atftp.  Lets lots of targets
+               tftp down the same boot image concurrently.  Note: the ethernet
+               driver in use must provide a function: mcast() to join/leave a
+               multicast group.
+
+               CONFIG_BOOTP_RANDOM_DELAY
 - BOOTP Recovery Mode:
                CONFIG_BOOTP_RANDOM_DELAY
 
 - BOOTP Recovery Mode:
                CONFIG_BOOTP_RANDOM_DELAY
 
@@ -1102,6 +1112,9 @@ The following options need to be configured:
                CONFIG_BOOTP_TIMEOFFSET
                CONFIG_BOOTP_VENDOREX
 
                CONFIG_BOOTP_TIMEOFFSET
                CONFIG_BOOTP_VENDOREX
 
+               CONFIG_BOOTP_SERVERIP - TFTP server will be the serverip
+               environment variable, not the BOOTP server.
+
                CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
                serverip from a DHCP server, it is possible that more
                than one DNS serverip is offered to the client.
                CONFIG_BOOTP_DNS2 - If a DHCP client requests the DNS
                serverip from a DHCP server, it is possible that more
                than one DNS serverip is offered to the client.
@@ -1114,7 +1127,7 @@ The following options need to be configured:
                CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
                to do a dynamic update of a DNS server. To do this, they
                need the hostname of the DHCP requester.
                CONFIG_BOOTP_SEND_HOSTNAME - Some DHCP servers are capable
                to do a dynamic update of a DNS server. To do this, they
                need the hostname of the DHCP requester.
-               If CONFIG_BOOP_SEND_HOSTNAME is defined, the content
+               If CONFIG_BOOTP_SEND_HOSTNAME is defined, the content
                of the "hostname" environment variable is passed as
                option 12 to the DHCP server.
 
                of the "hostname" environment variable is passed as
                option 12 to the DHCP server.
 
@@ -1342,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
                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
 
 
 - SPI Support: CONFIG_SPI
@@ -1366,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.
 
                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
+               CONFIG_FPGA_<family>
 
 
-               Used to specify the types of FPGA devices.  For example,
-               #define CONFIG_FPGA  CFG_XILINX_VIRTEX2
+               Enables support for FPGA family.
+               (SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
+
+               CONFIG_FPGA_COUNT
+
+               Specify the number of FPGA devices to support.
 
                CFG_FPGA_PROG_FEEDBACK
 
 
                CFG_FPGA_PROG_FEEDBACK
 
@@ -1629,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:
 
                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
   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
@@ -1639,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
     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
     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      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()
 
   -30  lib_ppc/board.c         Fatal error, hang the system
   -31  post/post.c             POST test failed, detected by post_output_backlog()
@@ -1727,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
 
   -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:
 --------------
 
 Modem Support:
 --------------
 
@@ -2110,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.
 
        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.
 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.
@@ -2258,6 +2344,10 @@ Low Level (hardware related) configuration options:
                enable I2C microcode relocation patch (MPC8xx);
                define relocation offset in DPRAM [DSP2]
 
                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]
 - CFG_SPI_UCODE_PATCH, CFG_SPI_DPMEM_OFFSET [0x1FC0]:
                enable SPI microcode relocation patch (MPC8xx);
                define relocation offset in DPRAM [SCC4]
@@ -2594,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
 
                  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
   autostart    - if set to "yes", an image loaded using the "bootp",
                  "rarpboot", "tftpboot" or "diskboot" commands will
                  be automatically started (by internally calling
@@ -2667,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
 
                  => 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
    netretry    - When set to "no" each network operation will
                  either succeed or fail without retrying.
                  When set to "once" the network operation will
@@ -2675,6 +2777,9 @@ Some configuration options can be set using Environment Variables:
                  Useful on scripts which control the retry operation
                  themselves.
 
                  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.
 
   tftpsrcport  - If this is set, the value is used for TFTP's
                  UDP source port.
 
@@ -2801,10 +2906,24 @@ o If neither SROM nor the environment contain a MAC address, an error
 Image Formats:
 ==============
 
 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,
 
 * Target Operating System (Provisions for OpenBSD, NetBSD, FreeBSD,
   4.4BSD, Linux, SVR4, Esix, Solaris, Irix, SCO, Dell, NCR, VxWorks,
@@ -3458,7 +3577,7 @@ GCC's implementation.
 
 For PowerPC, the following registers have specific use:
        R1:     stack pointer
 
 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
        R3-R4:  parameter passing and return values
        R5-R10: parameter passing
        R13:    small data area pointer
@@ -3467,7 +3586,7 @@ For PowerPC, the following registers have specific use:
 
        (U-Boot also uses R14 as internal GOT pointer.)
 
 
        (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),
 
     Note: on PPC, we could use a static initializer (since the
     address of the global data structure is known at compile time),
@@ -3476,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).
 
     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
 On ARM, the following registers are used:
 
        R0:     function argument word/integer result
Cloned from git://git.denx.de/u-boot.git