]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - README
malloc: sbrk() should return MORECORE_FAILURE instead of NULL on failure
[karo-tx-uboot.git] / README
diff --git a/README b/README
index 2c776876e236737f54e3e9b5b72acde4d6938aea..bb13bc62a37e3892ade156979fa9f2f69f92dc3b 100644 (file)
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
 #
 #
-# (C) Copyright 2000 - 2008
+# (C) Copyright 2000 - 2009
 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 #
 # See file CREDITS for list of people who contributed to this
 # Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 #
 # See file CREDITS for list of people who contributed to this
@@ -138,6 +138,7 @@ U-Boot will always have a patchlevel of "0".
 Directory Hierarchy:
 ====================
 
 Directory Hierarchy:
 ====================
 
+- api          Machine/arch independent API for external apps
 - board                Board dependent files
 - common       Misc architecture independent functions
 - cpu          CPU specific files
 - board                Board dependent files
 - common       Misc architecture independent functions
 - cpu          CPU specific files
@@ -178,8 +179,8 @@ Directory Hierarchy:
 - disk         Code for disk drive partition handling
 - doc          Documentation (don't expect too much)
 - drivers      Commonly used device drivers
 - disk         Code for disk drive partition handling
 - doc          Documentation (don't expect too much)
 - drivers      Commonly used device drivers
-- dtt          Digital Thermometer and Thermostat drivers
 - examples     Example code for standalone applications, etc.
 - examples     Example code for standalone applications, etc.
+- fs           Filesystem code (cramfs, ext2, jffs2, etc.)
 - include      Header Files
 - lib_arm      Files generic to ARM     architecture
 - lib_avr32    Files generic to AVR32   architecture
 - include      Header Files
 - lib_arm      Files generic to ARM     architecture
 - lib_avr32    Files generic to AVR32   architecture
@@ -187,9 +188,12 @@ Directory Hierarchy:
 - lib_generic  Files generic to all     architectures
 - lib_i386     Files generic to i386    architecture
 - lib_m68k     Files generic to m68k    architecture
 - lib_generic  Files generic to all     architectures
 - lib_i386     Files generic to i386    architecture
 - lib_m68k     Files generic to m68k    architecture
+- lib_microblaze Files generic to microblaze architecture
 - lib_mips     Files generic to MIPS    architecture
 - lib_nios     Files generic to NIOS    architecture
 - lib_mips     Files generic to MIPS    architecture
 - lib_nios     Files generic to NIOS    architecture
+- lib_nios2    Files generic to NIOS2   architecture
 - lib_ppc      Files generic to PowerPC architecture
 - lib_ppc      Files generic to PowerPC architecture
+- lib_sh       Files generic to SH      architecture
 - lib_sparc    Files generic to SPARC   architecture
 - libfdt       Library files to support flattened device trees
 - net          Networking code
 - lib_sparc    Files generic to SPARC   architecture
 - libfdt       Library files to support flattened device trees
 - net          Networking code
@@ -773,7 +777,7 @@ The following options need to be configured:
                CONFIG_LBA48
 
                Set this to enable support for disks larger than 137GB
                CONFIG_LBA48
 
                Set this to enable support for disks larger than 137GB
-               Also look at CONFIG_SYS_64BIT_LBA ,CONFIG_SYS_64BIT_VSPRINTF and CONFIG_SYS_64BIT_STRTOUL
+               Also look at CONFIG_SYS_64BIT_LBA.
                Whithout these , LBA48 support uses 32bit variables and will 'only'
                support disks up to 2.1TB.
 
                Whithout these , LBA48 support uses 32bit variables and will 'only'
                support disks up to 2.1TB.
 
@@ -818,6 +822,16 @@ The following options need to be configured:
 
 - NETWORK Support (other):
 
 
 - NETWORK Support (other):
 
+               CONFIG_DRIVER_AT91EMAC
+               Support for AT91RM9200 EMAC.
+
+                       CONFIG_RMII
+                       Define this to use reduced MII inteface
+
+                       CONFIG_DRIVER_AT91EMAC_QUIET
+                       If this defined, the driver is quiet.
+                       The driver doen't show link status messages.
+
                CONFIG_DRIVER_LAN91C96
                Support for SMSC's LAN91C96 chips.
 
                CONFIG_DRIVER_LAN91C96
                Support for SMSC's LAN91C96 chips.
 
@@ -842,20 +856,20 @@ The following options need to be configured:
                        Define this to use i/o functions instead of macros
                        (some hardware wont work with macros)
 
                        Define this to use i/o functions instead of macros
                        (some hardware wont work with macros)
 
-               CONFIG_DRIVER_SMC911X
+               CONFIG_SMC911X
                Support for SMSC's LAN911x and LAN921x chips
 
                Support for SMSC's LAN911x and LAN921x chips
 
-                       CONFIG_DRIVER_SMC911X_BASE
+                       CONFIG_SMC911X_BASE
                        Define this to hold the physical address
                        of the device (I/O space)
 
                        Define this to hold the physical address
                        of the device (I/O space)
 
-                       CONFIG_DRIVER_SMC911X_32_BIT
+                       CONFIG_SMC911X_32_BIT
                        Define this if data bus is 32 bits
 
                        Define this if data bus is 32 bits
 
-                       CONFIG_DRIVER_SMC911X_16_BIT
+                       CONFIG_SMC911X_16_BIT
                        Define this if data bus is 16 bits. If your processor
                        automatically converts one 32 bit word to two 16 bit
                        Define this if data bus is 16 bits. If your processor
                        automatically converts one 32 bit word to two 16 bit
-                       words you may also try CONFIG_DRIVER_SMC911X_32_BIT.
+                       words you may also try CONFIG_SMC911X_32_BIT.
 
 - USB Support:
                At the moment only the UHCI host controller is
 
 - USB Support:
                At the moment only the UHCI host controller is
@@ -1119,6 +1133,12 @@ The following options need to be configured:
                images, gzipped BMP images can be displayed via the
                splashscreen support or the bmp command.
 
                images, gzipped BMP images can be displayed via the
                splashscreen support or the bmp command.
 
+- Run length encoded BMP image (RLE8) support: CONFIG_VIDEO_BMP_RLE8
+
+               If this option is set, 8-bit RLE compressed BMP images
+               can be displayed via the splashscreen support or the
+               bmp command.
+
 - Compression support:
                CONFIG_BZIP2
 
 - Compression support:
                CONFIG_BZIP2
 
@@ -1889,25 +1909,6 @@ 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:
 
-- Automatic software updates via TFTP server
-               CONFIG_UPDATE_TFTP
-               CONFIG_UPDATE_TFTP_CNT_MAX
-               CONFIG_UPDATE_TFTP_MSEC_MAX
-
-               These options enable and control the auto-update feature;
-               for a more detailed description refer to doc/README.update.
-
-- MTD Support (mtdparts command, UBI support)
-               CONFIG_MTD_DEVICE
-
-               Adds the MTD device infrastructure from the Linux kernel.
-               Needed for mtdparts command support.
-
-               CONFIG_MTD_PARTITIONS
-
-               Adds the MTD partitioning infrastructure from the Linux
-               kernel. Needed for UBI support.
-
 Legacy uImage format:
 
   Arg  Where                   When
 Legacy uImage format:
 
   Arg  Where                   When
@@ -2061,6 +2062,25 @@ FIT uImage format:
  -150  common/cmd_nand.c       Incorrect FIT image format
   151  common/cmd_nand.c       FIT image format OK
 
  -150  common/cmd_nand.c       Incorrect FIT image format
   151  common/cmd_nand.c       FIT image format OK
 
+- Automatic software updates via TFTP server
+               CONFIG_UPDATE_TFTP
+               CONFIG_UPDATE_TFTP_CNT_MAX
+               CONFIG_UPDATE_TFTP_MSEC_MAX
+
+               These options enable and control the auto-update feature;
+               for a more detailed description refer to doc/README.update.
+
+- MTD Support (mtdparts command, UBI support)
+               CONFIG_MTD_DEVICE
+
+               Adds the MTD device infrastructure from the Linux kernel.
+               Needed for mtdparts command support.
+
+               CONFIG_MTD_PARTITIONS
+
+               Adds the MTD partitioning infrastructure from the Linux
+               kernel. Needed for UBI support.
+
 
 Modem Support:
 --------------
 
 Modem Support:
 --------------
@@ -2443,6 +2463,19 @@ to save the current settings.
        - CONFIG_SYS_EEPROM_SIZE:
          The size in bytes of the EEPROM device.
 
        - CONFIG_SYS_EEPROM_SIZE:
          The size in bytes of the EEPROM device.
 
+       - CONFIG_ENV_EEPROM_IS_ON_I2C
+         define this, if you have I2C and SPI activated, and your
+         EEPROM, which holds the environment, is on the I2C bus.
+
+       - CONFIG_I2C_ENV_EEPROM_BUS
+         if you have an Environment on an EEPROM reached over
+         I2C muxes, you can define here, how to reach this
+         EEPROM. For example:
+
+         #define CONFIG_I2C_ENV_EEPROM_BUS       "pca9547:70:d\0"
+
+         EEPROM which holds the environment, is reached over
+         a pca9547 i2c mux with address 0x70, channel 3.
 
 - CONFIG_ENV_IS_IN_DATAFLASH:
 
 
 - CONFIG_ENV_IS_IN_DATAFLASH:
 
@@ -2520,13 +2553,6 @@ use the "saveenv" command to store a valid environment.
 - CONFIG_SYS_FAULT_MII_ADDR:
                MII address of the PHY to check for the Ethernet link state.
 
 - CONFIG_SYS_FAULT_MII_ADDR:
                MII address of the PHY to check for the Ethernet link state.
 
-- CONFIG_SYS_64BIT_VSPRINTF:
-               Makes vsprintf (and all *printf functions) support printing
-               of 64bit values by using the L quantifier
-
-- CONFIG_SYS_64BIT_STRTOUL:
-               Adds simple_strtoull that returns a 64bit value
-
 - CONFIG_NS16550_MIN_FUNCTIONS:
                Define this if you desire to only have use of the NS16550_init
                and NS16550_putc functions for the serial driver located at
 - CONFIG_NS16550_MIN_FUNCTIONS:
                Define this if you desire to only have use of the NS16550_init
                and NS16550_putc functions for the serial driver located at
@@ -2985,7 +3011,9 @@ environment. As long as you don't save the environment you are
 working with an in-memory copy. In case the Flash area containing the
 environment is erased by accident, a default environment is provided.
 
 working with an in-memory copy. In case the Flash area containing the
 environment is erased by accident, a default environment is provided.
 
-Some configuration options can be set using Environment Variables:
+Some configuration options can be set using Environment Variables.
+
+List of environment variables (most likely not complete):
 
   baudrate     - see CONFIG_BAUDRATE
 
 
   baudrate     - see CONFIG_BAUDRATE
 
@@ -3097,7 +3125,7 @@ Some configuration options can be set using Environment Variables:
                  available network interfaces.
                  It just stays at the currently selected interface.
 
                  available network interfaces.
                  It just stays at the currently selected interface.
 
-   netretry    - When set to "no" each 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
                  fail when all the available network interfaces
                  either succeed or fail without retrying.
                  When set to "once" the network operation will
                  fail when all the available network interfaces
@@ -3113,7 +3141,18 @@ Some configuration options can be set using Environment Variables:
   tftpdstport  - If this is set, the value is used for TFTP's UDP
                  destination port instead of the Well Know Port 69.
 
   tftpdstport  - If this is set, the value is used for TFTP's UDP
                  destination port instead of the Well Know Port 69.
 
-   vlan                - When set to a value < 4095 the traffic over
+  tftpblocksize - Block size to use for TFTP transfers; if not set,
+                 we use the TFTP server's default block size
+
+  tftptimeout  - Retransmission timeout for TFTP packets (in milli-
+                 seconds, minimum value is 1000 = 1 second). Defines
+                 when a packet is considered to be lost so it has to
+                 be retransmitted. The default is 5000 = 5 seconds.
+                 Lowering this value may make downloads succeed
+                 faster in networks with high packet loss rates or
+                 with unreliable TFTP servers.
+
+  vlan         - When set to a value < 4095 the traffic over
                  Ethernet is encapsulated/received over 802.1q
                  VLAN tagged frames.
 
                  Ethernet is encapsulated/received over 802.1q
                  VLAN tagged frames.
 
@@ -3912,7 +3951,9 @@ For PowerPC, the following registers have specific use:
        R30:    GOT pointer
        R31:    frame pointer
 
        R30:    GOT pointer
        R31:    frame pointer
 
-       (U-Boot also uses R14 as internal GOT pointer.)
+       (U-Boot also uses R12 as internal GOT pointer. r12
+       is a volatile register so r12 needs to be reset when
+       going back and forth between asm and C)
 
     ==> U-Boot will use R2 to hold a pointer to the global data
 
 
     ==> U-Boot will use R2 to hold a pointer to the global data