lm75: fix Codingstyle issues.

[oweals/u-boot.git] / README

diff --git a/README b/README
index 37449d161014fe13d9a3c8b73f6b90768f94682e..b10b539fa8d3362dc476a5e7b8dd20e4e5740e73 100644 (file)
--- a/README
+++ b/README
@@ -60,10 +60,10 @@ Where to get help:
 
 In case you have questions about, problems with or contributions for
 U-Boot you should send a message to the U-Boot mailing list at
 
 In case you have questions about, problems with or contributions for
 U-Boot you should send a message to the U-Boot mailing list at

-<u-boot-users@lists.sourceforge.net>. There is also an archive of
-previous traffic on the mailing list - please search the archive
-before asking FAQ's. Please see
-http://lists.sourceforge.net/lists/listinfo/u-boot-users/
+<u-boot@lists.denx.de>. There is also an archive of previous traffic
+on the mailing list - please search the archive before asking FAQ's.
+Please see http://lists.denx.de/pipermail/u-boot and
+http://dir.gmane.org/gmane.comp.boot-loaders.u-boot

 
 
 Where to get source code:
 
 
 Where to get source code:


@@ -380,11 +380,11 @@ The following options need to be configured:
                param header, the default value is zero if undefined.
 
 - Serial Ports:
                param header, the default value is zero if undefined.
 
 - Serial Ports:

-               CFG_PL010_SERIAL
+               CONFIG_PL010_SERIAL

 
                Define this if you want support for Amba PrimeCell PL010 UARTs.
 
 
                Define this if you want support for Amba PrimeCell PL010 UARTs.
 

-               CFG_PL011_SERIAL
+               CONFIG_PL011_SERIAL

 
                Define this if you want support for Amba PrimeCell PL011 UARTs.
 
 
                Define this if you want support for Amba PrimeCell PL011 UARTs.
 


@@ -687,7 +687,7 @@ The following options need to be configured:
 
 - Partition Support:
                CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION
 
 - Partition Support:
                CONFIG_MAC_PARTITION and/or CONFIG_DOS_PARTITION

-               and/or CONFIG_ISO_PARTITION
+               and/or CONFIG_ISO_PARTITION and/or CONFIG_EFI_PARTITION

 
                If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
                CONFIG_CMD_SCSI) you must configure support for at
 
                If IDE or SCSI support is enabled (CONFIG_CMD_IDE or
                CONFIG_CMD_SCSI) you must configure support for at


@@ -1044,6 +1044,29 @@ The following options need to be configured:
                the malloc area (as defined by CFG_MALLOC_LEN) should
                be at least 4MB.
 
                the malloc area (as defined by CFG_MALLOC_LEN) should
                be at least 4MB.
 

+               CONFIG_LZMA
+
+               If this option is set, support for lzma compressed
+               images is included.
+
+               Note: The LZMA algorithm adds between 2 and 4KB of code and it
+               requires an amount of dynamic memory that is given by the
+               formula:
+
+                       (1846 + 768 << (lc + lp)) * sizeof(uint16)
+
+               Where lc and lp stand for, respectively, Literal context bits
+               and Literal pos bits.
+
+               This value is upper-bounded by 14MB in the worst case. Anyway,
+               for a ~4MB large kernel image, we have lc=3 and lp=0 for a
+               total amount of (1846 + 768 << (3 + 0)) * 2 = ~41KB... that is
+               a very small buffer.
+
+               Use the lzmainfo tool to determinate the lc and lp values and
+               then calculate the amount of needed dynamic memory (ensuring
+               the appropriate CFG_MALLOC_LEN value).
+

 - MII/PHY support:
                CONFIG_PHY_ADDR
 
 - MII/PHY support:
                CONFIG_PHY_ADDR
 


@@ -1072,8 +1095,11 @@ The following options need to be configured:
 
 - Ethernet address:
                CONFIG_ETHADDR
 
 - Ethernet address:
                CONFIG_ETHADDR

+               CONFIG_ETH1ADDR

                CONFIG_ETH2ADDR
                CONFIG_ETH3ADDR
                CONFIG_ETH2ADDR
                CONFIG_ETH3ADDR

+               CONFIG_ETH4ADDR
+               CONFIG_ETH5ADDR

 
                Define a default value for Ethernet address to use
                for the respective Ethernet interface, in case this
 
                Define a default value for Ethernet address to use
                for the respective Ethernet interface, in case this


@@ -1392,6 +1418,12 @@ The following options need to be configured:
                If defined, then this indicates the I2C bus number for the DTT.
                If not defined, then U-Boot assumes that DTT is on I2C bus 0.
 
                If defined, then this indicates the I2C bus number for the DTT.
                If not defined, then U-Boot assumes that DTT is on I2C bus 0.
 

+               CFG_I2C_DTT_ADDR:
+
+               If defined, specifies the I2C address of the DTT device.
+               If not defined, then U-Boot uses predefined value for
+               specified DTT device.
+

                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


@@ -1708,6 +1740,14 @@ 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.
+

 Legacy uImage format:
 
   Arg  Where                   When
 Legacy uImage format:
 
   Arg  Where                   When


@@ -2098,7 +2138,7 @@ The following definitions that deal with the placement and management
 of environment data (variable area); in general, we support the
 following configurations:
 
 of environment data (variable area); in general, we support the
 following configurations:
 

-- CFG_ENV_IS_IN_FLASH:
+- CONFIG_ENV_IS_IN_FLASH:

 
        Define this if the environment is in flash memory.
 
 
        Define this if the environment is in flash memory.
 


@@ -2114,22 +2154,22 @@ following configurations:
           environment in one of the last sectors, leaving a gap
           between U-Boot and the environment.
 
           environment in one of the last sectors, leaving a gap
           between U-Boot and the environment.
 

-       - CFG_ENV_OFFSET:
+       - CONFIG_ENV_OFFSET:

 
           Offset of environment data (variable area) to the
           beginning of flash memory; for instance, with bottom boot
           type flash chips the second sector can be used: the offset
           for this sector is given here.
 
 
           Offset of environment data (variable area) to the
           beginning of flash memory; for instance, with bottom boot
           type flash chips the second sector can be used: the offset
           for this sector is given here.
 

-          CFG_ENV_OFFSET is used relative to CFG_FLASH_BASE.
+          CONFIG_ENV_OFFSET is used relative to CFG_FLASH_BASE.

 
 

-       - CFG_ENV_ADDR:
+       - CONFIG_ENV_ADDR:

 
           This is just another way to specify the start address of
           the flash sector containing the environment (instead of
 
           This is just another way to specify the start address of
           the flash sector containing the environment (instead of

-          CFG_ENV_OFFSET).
+          CONFIG_ENV_OFFSET).

 
 

-       - CFG_ENV_SECT_SIZE:
+       - CONFIG_ENV_SECT_SIZE:

 
           Size of the sector containing the environment.
 
 
           Size of the sector containing the environment.
 


@@ -2138,10 +2178,10 @@ following configurations:
           In such a case you don't want to spend a whole sector for
           the environment.
 
           In such a case you don't want to spend a whole sector for
           the environment.
 

-       - CFG_ENV_SIZE:
+       - CONFIG_ENV_SIZE:

 
 

-          If you use this in combination with CFG_ENV_IS_IN_FLASH
-          and CFG_ENV_SECT_SIZE, you can specify to use only a part
+          If you use this in combination with CONFIG_ENV_IS_IN_FLASH
+          and CONFIG_ENV_SECT_SIZE, you can specify to use only a part

           of this flash sector for the environment. This saves
           memory for the RAM copy of the environment.
 
           of this flash sector for the environment. This saves
           memory for the RAM copy of the environment.
 


@@ -2155,8 +2195,8 @@ following configurations:
           wrong before the contents has been restored from a copy in
           RAM, your target system will be dead.
 
           wrong before the contents has been restored from a copy in
           RAM, your target system will be dead.
 

-       - CFG_ENV_ADDR_REDUND
-         CFG_ENV_SIZE_REDUND
+       - CONFIG_ENV_ADDR_REDUND
+         CONFIG_ENV_SIZE_REDUND

 
           These settings describe a second storage area used to hold
           a redundant copy of the environment data, so that there is
 
           These settings describe a second storage area used to hold
           a redundant copy of the environment data, so that there is


@@ -2168,14 +2208,14 @@ source code will make it necessary to adapt <board>/u-boot.lds*
 accordingly!
 
 
 accordingly!
 
 

-- CFG_ENV_IS_IN_NVRAM:
+- CONFIG_ENV_IS_IN_NVRAM:

 
        Define this if you have some non-volatile memory device
        (NVRAM, battery buffered SRAM) which you want to use for the
        environment.
 
 
        Define this if you have some non-volatile memory device
        (NVRAM, battery buffered SRAM) which you want to use for the
        environment.
 

-       - CFG_ENV_ADDR:
-       - CFG_ENV_SIZE:
+       - CONFIG_ENV_ADDR:
+       - CONFIG_ENV_SIZE:

 
          These two #defines are used to determine the memory area you
          want to use for environment. It is assumed that this memory
 
          These two #defines are used to determine the memory area you
          want to use for environment. It is assumed that this memory


@@ -2193,13 +2233,13 @@ keep settings there always unmodified except somebody uses "saveenv"
 to save the current settings.
 
 
 to save the current settings.
 
 

-- CFG_ENV_IS_IN_EEPROM:
+- CONFIG_ENV_IS_IN_EEPROM:

 
        Use this if you have an EEPROM or similar serial access
        device and a driver for it.
 
 
        Use this if you have an EEPROM or similar serial access
        device and a driver for it.
 

-       - CFG_ENV_OFFSET:
-       - CFG_ENV_SIZE:
+       - CONFIG_ENV_OFFSET:
+       - CONFIG_ENV_SIZE:

 
          These two #defines specify the offset and size of the
          environment area within the total memory of your EEPROM.
 
          These two #defines specify the offset and size of the
          environment area within the total memory of your EEPROM.


@@ -2236,39 +2276,39 @@ to save the current settings.
          The size in bytes of the EEPROM device.
 
 
          The size in bytes of the EEPROM device.
 
 

-- CFG_ENV_IS_IN_DATAFLASH:
+- CONFIG_ENV_IS_IN_DATAFLASH:

 
        Define this if you have a DataFlash memory device which you
        want to use for the environment.
 
 
        Define this if you have a DataFlash memory device which you
        want to use for the environment.
 

-       - CFG_ENV_OFFSET:
-       - CFG_ENV_ADDR:
-       - CFG_ENV_SIZE:
+       - CONFIG_ENV_OFFSET:
+       - CONFIG_ENV_ADDR:
+       - CONFIG_ENV_SIZE:

 
          These three #defines specify the offset and size of the
          environment area within the total memory of your DataFlash placed
          at the specified address.
 
 
          These three #defines specify the offset and size of the
          environment area within the total memory of your DataFlash placed
          at the specified address.
 

-- CFG_ENV_IS_IN_NAND:
+- CONFIG_ENV_IS_IN_NAND:

 
        Define this if you have a NAND device which you want to use
        for the environment.
 
 
        Define this if you have a NAND device which you want to use
        for the environment.
 

-       - CFG_ENV_OFFSET:
-       - CFG_ENV_SIZE:
+       - CONFIG_ENV_OFFSET:
+       - CONFIG_ENV_SIZE:

 
          These two #defines specify the offset and size of the environment
          area within the first NAND device.
 
 
          These two #defines specify the offset and size of the environment
          area within the first NAND device.
 

-       - CFG_ENV_OFFSET_REDUND
+       - CONFIG_ENV_OFFSET_REDUND

 
 

-         This setting describes a second storage area of CFG_ENV_SIZE
+         This setting describes a second storage area of CONFIG_ENV_SIZE

          size used to hold a redundant copy of the environment data,
          so that there is a valid backup copy in case there is a
          power failure during a "saveenv" operation.
 
          size used to hold a redundant copy of the environment data,
          so that there is a valid backup copy in case there is a
          power failure during a "saveenv" operation.
 

-       Note: CFG_ENV_OFFSET and CFG_ENV_OFFSET_REDUND must be aligned
-       to a block boundary, and CFG_ENV_SIZE must be a multiple of
+       Note: CONFIG_ENV_OFFSET and CONFIG_ENV_OFFSET_REDUND must be aligned
+       to a block boundary, and CONFIG_ENV_SIZE must be a multiple of

        the NAND devices block size.
 
 - CFG_SPI_INIT_OFFSET
        the NAND devices block size.
 
 - CFG_SPI_INIT_OFFSET


@@ -2782,6 +2822,10 @@ Some configuration options can be set using Environment Variables:
                  allowed for use by the bootm command. See also "bootm_low"
                  environment variable.
 
                  allowed for use by the bootm command. See also "bootm_low"
                  environment variable.
 

+  updatefile   - Location of the software update file on a TFTP server, used
+                 by the automatic software update feature. Please refer to
+                 documentation in doc/README.update for more details.
+

   autoload     - if set to "no" (any string beginning with 'n'),
                  "bootp" will just load perform a lookup of the
                  configuration from the BOOTP server, but not try to
   autoload     - if set to "no" (any string beginning with 'n'),
                  "bootp" will just load perform a lookup of the
                  configuration from the BOOTP server, but not try to


@@ -3030,8 +3074,9 @@ 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,

-  LynxOS, pSOS, QNX, RTEMS, ARTOS;
-  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, ARTOS, LynxOS).
+  LynxOS, pSOS, QNX, RTEMS, INTEGRITY;
+  Currently supported: Linux, NetBSD, VxWorks, QNX, RTEMS, LynxOS,
+  INTEGRITY).

 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
   IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
   Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).
 * Target CPU Architecture (Provisions for Alpha, ARM, AVR32, Intel x86,
   IA64, MIPS, NIOS, PowerPC, IBM S390, SuperH, Sparc, Sparc 64 Bit;
   Currently supported: ARM, AVR32, Intel x86, MIPS, NIOS, PowerPC).


@@ -3089,9 +3134,9 @@ But now you can ignore ALL boot loader code (in arch/ppc/mbxboot).
 
 Just make sure your machine specific header file (for instance
 include/asm-ppc/tqm8xx.h) includes the same definition of the Board
 
 Just make sure your machine specific header file (for instance
 include/asm-ppc/tqm8xx.h) includes the same definition of the Board

-Information structure as we define in include/u-boot.h, and make
-sure that your definition of IMAP_ADDR uses the same value as your
-U-Boot configuration in CFG_IMMR.
+Information structure as we define in include/asm-<arch>/u-boot.h,
+and make sure that your definition of IMAP_ADDR uses the same value
+as your U-Boot configuration in CFG_IMMR.

 
 
 Configuring the Linux kernel:
 
 
 Configuring the Linux kernel: