]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - README
Merge branch 'master' of git://www.denx.de/git/u-boot-usb
[karo-tx-uboot.git] / README
diff --git a/README b/README
index ccd47fad3ad151b413c4e480827a0f81ac68ee8c..a70475fb05f024e1b580317c0e8723ad4a574c73 100644 (file)
--- a/README
+++ b/README
@@ -139,12 +139,10 @@ Directory Hierarchy:
        /at91           Files specific to Atmel AT91RM9200 CPU
        /imx            Files specific to Freescale MC9328 i.MX CPUs
        /s3c24x0        Files specific to Samsung S3C24X0 CPUs
-      /arm925t         Files specific to ARM 925 CPUs
       /arm926ejs       Files specific to ARM 926 CPUs
       /arm1136         Files specific to ARM 1136 CPUs
       /ixp             Files specific to Intel XScale IXP CPUs
       /pxa             Files specific to Intel XScale PXA CPUs
-      /s3c44b0         Files specific to Samsung S3C44B0 CPUs
       /sa1100          Files specific to Intel StrongARM SA1100 CPUs
     /lib               Architecture specific library files
   /avr32               Files generic to AVR32 architecture
@@ -153,9 +151,6 @@ Directory Hierarchy:
   /blackfin            Files generic to Analog Devices Blackfin architecture
     /cpu               CPU specific files
     /lib               Architecture specific library files
-  /x86                 Files generic to x86 architecture
-    /cpu               CPU specific files
-    /lib               Architecture specific library files
   /m68k                        Files generic to m68k architecture
     /cpu               CPU specific files
       /mcf52x2         Files specific to Freescale ColdFire MCF52x2 CPUs
@@ -179,6 +174,9 @@ Directory Hierarchy:
   /nios2               Files generic to Altera NIOS2 architecture
     /cpu               CPU specific files
     /lib               Architecture specific library files
+  /openrisc            Files generic to OpenRISC architecture
+    /cpu               CPU specific files
+    /lib               Architecture specific library files
   /powerpc             Files generic to PowerPC architecture
     /cpu               CPU specific files
       /74xx_7xx                Files specific to Freescale MPC74xx and 7xx CPUs
@@ -201,12 +199,16 @@ Directory Hierarchy:
       /leon2           Files specific to Gaisler LEON2 SPARC CPU
       /leon3           Files specific to Gaisler LEON3 SPARC CPU
     /lib               Architecture specific library files
+  /x86                 Files generic to x86 architecture
+    /cpu               CPU specific files
+    /lib               Architecture specific library files
 /api                   Machine/arch independent API for external apps
 /board                 Board dependent files
 /common                        Misc architecture independent functions
 /disk                  Code for disk drive partition handling
 /doc                   Documentation (don't expect too much)
 /drivers               Commonly used device drivers
+/dts                   Contains Makefile for building internal U-Boot fdt.
 /examples              Example code for standalone applications, etc.
 /fs                    Filesystem code (cramfs, ext2, jffs2, etc.)
 /include               Header Files
@@ -216,7 +218,7 @@ Directory Hierarchy:
   /lzo                 Library files to support LZO decompression
 /net                   Networking code
 /post                  Power On Self Test
-/rtc                   Real Time Clock drivers
+/spl                   Secondary Program Loader framework
 /tools                 Tools to build S-Record or U-Boot images, etc.
 
 Software Configuration:
@@ -703,6 +705,11 @@ The following options need to be configured:
                the "silent" environment variable. See
                doc/README.silent for more information.
 
+               CONFIG_SYS_CONSOLE_BG_COL: define the backgroundcolor, default
+                       is 0x00.
+               CONFIG_SYS_CONSOLE_FG_COL: define the foregroundcolor, default
+                       is 0xa0.
+
 - Console Baudrate:
                CONFIG_BAUDRATE - in bps
                Select one of the baudrates listed in
@@ -841,6 +848,7 @@ The following options need to be configured:
                CONFIG_CMD_ELF          * bootelf, bootvx
                CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
                CONFIG_CMD_ENV_FLAGS    * display details about env flags
+               CONFIG_CMD_ENV_EXISTS   * check existence of env variable
                CONFIG_CMD_EXPORTENV    * export the environment
                CONFIG_CMD_EXT2         * ext2 command support
                CONFIG_CMD_EXT4         * ext4 command support
@@ -942,10 +950,10 @@ The following options need to be configured:
 
 - Regular expression support:
                CONFIG_REGEX
-                If this variable is defined, U-Boot is linked against
-                the SLRE (Super Light Regular Expression) library,
-                which adds regex support to some commands, as for
-                example "env grep" and "setexpr".
+               If this variable is defined, U-Boot is linked against
+               the SLRE (Super Light Regular Expression) library,
+               which adds regex support to some commands, as for
+               example "env grep" and "setexpr".
 
 - Device tree:
                CONFIG_OF_CONTROL
@@ -1025,7 +1033,6 @@ The following options need to be configured:
 
 - GPIO Support:
                CONFIG_PCA953X          - use NXP's PCA953X series I2C GPIO
-               CONFIG_PCA953X_INFO     - enable pca953x info command
 
                The CONFIG_SYS_I2C_PCA953X_WIDTH option specifies a list of
                chip-ngpio pairs that tell the PCA953X driver the number of
@@ -1094,8 +1101,8 @@ The following options need to be configured:
                devices.
                CONFIG_SYS_SCSI_SYM53C8XX_CCF to fix clock timing (80Mhz)
 
-                The environment variable 'scsidevs' is set to the number of
-                SCSI devices found during the last scan.
+               The environment variable 'scsidevs' is set to the number of
+               SCSI devices found during the last scan.
 
 - NETWORK Support (PCI):
                CONFIG_E1000
@@ -1360,6 +1367,13 @@ The following options need to be configured:
                        for your device
                        - CONFIG_USBD_PRODUCTID 0xFFFF
 
+               Some USB device drivers may need to check USB cable attachment.
+               In this case you can enable following config in BoardName.h:
+                       CONFIG_USB_CABLE_CHECK
+                       This enables function definition:
+                       - usb_cable_connected() in include/usb.h
+                       Implementation of this function is board-specific.
+
 - ULPI Layer Support:
                The ULPI (UTMI Low Pin (count) Interface) PHYs are supported via
                the generic ULPI layer. The generic layer accesses the ULPI PHY
@@ -1405,6 +1419,12 @@ The following options need to be configured:
                CONFIG_DFU_NAND
                This enables support for exposing NAND devices via DFU.
 
+               CONFIG_DFU_RAM
+               This enables support for exposing RAM via DFU.
+               Note: DFU spec refer to non-volatile memory usage, but
+               allow usages beyond the scope of spec - here RAM usage,
+               one that would help mostly the developer.
+
                CONFIG_SYS_DFU_DATA_BUF_SIZE
                Dfu transfer uses a buffer before writing data to the
                raw storage device. Make the size (in bytes) of this buffer
@@ -1979,22 +1999,47 @@ CBFS (Coreboot Filesystem) support
                    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
                    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
                    bus.
-                  - If your board supports a second fsl i2c bus, define
+                 - If your board supports a second fsl i2c bus, define
                    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
                    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
                    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
                    second bus.
 
                - drivers/i2c/tegra_i2c.c:
-                - activate this driver with CONFIG_SYS_I2C_TEGRA
-                - This driver adds 4 i2c buses with a fix speed from
-                  100000 and the slave addr 0!
+                 - activate this driver with CONFIG_SYS_I2C_TEGRA
+                 - This driver adds 4 i2c buses with a fix speed from
+                   100000 and the slave addr 0!
 
                - drivers/i2c/ppc4xx_i2c.c
                  - activate this driver with CONFIG_SYS_I2C_PPC4XX
                  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
                  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
 
+               - drivers/i2c/i2c_mxc.c
+                 - activate this driver with CONFIG_SYS_I2C_MXC
+                 - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
+                 - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
+                 - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
+                 - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
+                 - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
+                 - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
+               If thoses defines are not set, default value is 100000
+               for speed, and 0 for slave.
+
+               - drivers/i2c/rcar_i2c.c:
+                 - activate this driver with CONFIG_SYS_I2C_RCAR
+                 - This driver adds 4 i2c buses
+
+                 - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
+                 - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
+                 - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
+                 - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
+                 - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
+                 - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
+                 - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
+                 - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
+                 - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
+
                additional defines:
 
                CONFIG_SYS_NUM_I2C_BUSES
@@ -3183,9 +3228,9 @@ FIT uImage format:
                CONFIG_TPL_PAD_TO
                Image offset to which the TPL should be padded before appending
                the TPL payload. By default, this is defined as
-                CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
-                CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
-                payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
+               CONFIG_SPL_MAX_SIZE, or 0 if CONFIG_SPL_MAX_SIZE is undefined.
+               CONFIG_SPL_PAD_TO must be either 0, meaning to append the SPL
+               payload without any padding, or >= CONFIG_SPL_MAX_SIZE.
 
 Modem Support:
 --------------
@@ -3360,7 +3405,7 @@ Configuration Settings:
                the Linux kernel; all data that must be processed by
                the Linux kernel (bd_info, boot arguments, FDT blob if
                used) must be put below this limit, unless "bootm_low"
-               enviroment variable is defined and non-zero. In such case
+               environment variable is defined and non-zero. In such case
                all data for the Linux kernel must be between "bootm_low"
                and "bootm_low" + CONFIG_SYS_BOOTMAPSZ.  The environment
                variable "bootm_mapsize" will override the value of
@@ -3473,7 +3518,7 @@ Configuration Settings:
 
 - CONFIG_ENV_FLAGS_LIST_DEFAULT
 - CONFIG_ENV_FLAGS_LIST_STATIC
-       Enable validation of the values given to enviroment variables when
+       Enable validation of the values given to environment variables when
        calling env set.  Variables can be restricted to only decimal,
        hexadecimal, or boolean.  If CONFIG_CMD_NET is also defined,
        the variables can also be restricted to IP address or MAC address.
@@ -5588,15 +5633,17 @@ On ARM, the following registers are used:
 
        R0:     function argument word/integer result
        R1-R3:  function argument word
-       R9:     GOT pointer
-       R10:    stack limit (used only if stack checking if enabled)
+       R9:     platform specific
+       R10:    stack limit (used only if stack checking is enabled)
        R11:    argument (frame) pointer
        R12:    temporary workspace
        R13:    stack pointer
        R14:    link register
        R15:    program counter
 
-    ==> U-Boot will use R8 to hold a pointer to the global data
+    ==> U-Boot will use R9 to hold a pointer to the global data
+
+    Note: on ARM, only R_ARM_RELATIVE relocations are supported.
 
 On Nios II, the ABI is documented here:
        http://www.altera.com/literature/hb/nios2/n2cpu_nii51016.pdf