]> git.sur5r.net Git - u-boot/blobdiff - README
patman: Use items() to iterate over dictionaries
[u-boot] / README
diff --git a/README b/README
index cadb571166bf4117730f81fd044d0beb21b8f1b3..68d6a499c09f8166baa475f575bdd29ebebc59be 100644 (file)
--- a/README
+++ b/README
@@ -151,6 +151,7 @@ Directory Hierarchy:
   /x86                 Files generic to x86 architecture
 /api                   Machine/arch independent API for external apps
 /board                 Board dependent files
+/cmd                   U-Boot commands functions
 /common                        Misc architecture independent functions
 /configs               Board default configuration files
 /disk                  Code for disk drive partition handling
@@ -324,27 +325,6 @@ The following options need to be configured:
 - CPU Daughterboard Type: (if CONFIG_ATSTK1000 is defined)
                Define exactly one, e.g. CONFIG_ATSTK1002
 
-- CPU Module Type: (if CONFIG_COGENT is defined)
-               Define exactly one of
-               CONFIG_CMA286_60_OLD
---- FIXME --- not tested yet:
-               CONFIG_CMA286_60, CONFIG_CMA286_21, CONFIG_CMA286_60P,
-               CONFIG_CMA287_23, CONFIG_CMA287_50
-
-- Motherboard Type: (if CONFIG_COGENT is defined)
-               Define exactly one of
-               CONFIG_CMA101, CONFIG_CMA102
-
-- Motherboard I/O Modules: (if CONFIG_COGENT is defined)
-               Define one or more of
-               CONFIG_CMA302
-
-- Motherboard Options: (if CONFIG_CMA101 or CONFIG_CMA102 are defined)
-               Define one or more of
-               CONFIG_LCD_HEARTBEAT    - update a character position on
-                                         the LCD display every second with
-                                         a "rotator" |\-/|\-/
-
 - Marvell Family Member
                CONFIG_SYS_MVFS         - define it if you want to enable
                                          multiple fs option at one time
@@ -577,20 +557,6 @@ The following options need to be configured:
                CONFIG_SYS_FSL_SEC_LE
                Defines the SEC controller register space as Little Endian
 
-- Intel Monahans options:
-               CONFIG_SYS_MONAHANS_RUN_MODE_OSC_RATIO
-
-               Defines the Monahans run mode to oscillator
-               ratio. Valid values are 8, 16, 24, 31. The core
-               frequency is this value multiplied by 13 MHz.
-
-               CONFIG_SYS_MONAHANS_TURBO_RUN_MODE_RATIO
-
-               Defines the Monahans turbo mode to oscillator
-               ratio. Valid values are 1 (default if undefined) and
-               2. The core frequency as calculated above is multiplied
-               by this value.
-
 - MIPS CPU options:
                CONFIG_SYS_INIT_SP_OFFSET
 
@@ -729,11 +695,6 @@ The following options need to be configured:
                This causes ft_system_setup() to be called before booting
                the kernel.
 
-               CONFIG_OF_BOOT_CPU
-
-               This define fills in the correct boot CPU in the boot
-               param header, the default value is zero if undefined.
-
                CONFIG_OF_IDE_FIXUP
 
                U-Boot can detect if an IDE device is present or not.
@@ -1336,10 +1297,6 @@ The following options need to be configured:
                CONFIG_LAN91C96
                Support for SMSC's LAN91C96 chips.
 
-                       CONFIG_LAN91C96_BASE
-                       Define this to hold the physical address
-                       of the LAN91C96's I/O space
-
                        CONFIG_LAN91C96_USE_32_BIT
                        Define this to enable 32 bit addressing
 
@@ -1404,7 +1361,7 @@ The following options need to be configured:
 
 - PWM Support:
                CONFIG_PWM_IMX
-               Support for PWM modul on the imx6.
+               Support for PWM module on the imx6.
 
 - TPM Support:
                CONFIG_TPM
@@ -1524,10 +1481,6 @@ The following options need to be configured:
                                Derive USB clock from external clock "blah"
                                - CONFIG_SYS_USB_EXTC_CLK 0x02
 
-                               CONFIG_SYS_USB_BRG_CLK 0xBLAH
-                               Derive USB clock from brgclk
-                               - CONFIG_SYS_USB_BRG_CLK 0x04
-
                If you have a USB-IF assigned VendorID then you may wish to
                define your own vendor specific values either in BoardName.h
                or directly in usbd_vendor_info.h. If you don't define
@@ -1680,26 +1633,23 @@ The following options need to be configured:
                to generate and write the Backup GUID Partition Table.)
                This occurs when the specified "partition name" on the
                "fastboot flash" command line matches this value.
-               Default is GPT_ENTRY_NAME (currently "gpt") if undefined.
+               The default is "gpt" if undefined.
+
+               CONFIG_FASTBOOT_MBR_NAME
+               The fastboot "flash" command supports writing the downloaded
+               image to DOS MBR.
+               This occurs when the "partition name" specified on the
+               "fastboot flash" command line matches this value.
+               If not defined the default value "mbr" is used.
 
 - Journaling Flash filesystem support:
-               CONFIG_JFFS2_NAND, CONFIG_JFFS2_NAND_OFF, CONFIG_JFFS2_NAND_SIZE,
-               CONFIG_JFFS2_NAND_DEV
+               CONFIG_JFFS2_NAND
                Define these for a default partition on a NAND device
 
                CONFIG_SYS_JFFS2_FIRST_SECTOR,
                CONFIG_SYS_JFFS2_FIRST_BANK, CONFIG_SYS_JFFS2_NUM_BANKS
                Define these for a default partition on a NOR device
 
-               CONFIG_SYS_JFFS_CUSTOM_PART
-               Define this to create an own partition. You have to provide a
-               function struct part_info* jffs2_part_info(int part_num)
-
-               If you define only one JFFS2 partition you may also want to
-               #define CONFIG_SYS_JFFS_SINGLE_PART     1
-               to disable the command chpart. This is the default when you
-               have not defined a custom partition
-
 - FAT(File Allocation Table) filesystem write function support:
                CONFIG_FAT_WRITE
 
@@ -2330,8 +2280,6 @@ CBFS (Coreboot Filesystem) support
                  - CONFIG_SYS_I2C_SH_SPEED3 for for the speed channel 3
                  - CONFIG_SYS_I2C_SH_BASE4 for setting the register channel 4
                  - CONFIG_SYS_I2C_SH_SPEED4 for for the speed channel 4
-                 - CONFIG_SYS_I2C_SH_BASE5 for setting the register channel 5
-                 - CONFIG_SYS_I2C_SH_SPEED5 for for the speed channel 5
                  - CONFIG_SYS_I2C_SH_NUM_CONTROLLERS for number of i2c buses
 
                - drivers/i2c/omap24xx_i2c.c
@@ -2385,10 +2333,7 @@ CBFS (Coreboot Filesystem) support
                additional defines:
 
                CONFIG_SYS_NUM_I2C_BUSES
-               Hold the number of i2c buses you want to use. If you
-               don't use/have i2c muxes on your i2c bus, this
-               is equal to CONFIG_SYS_NUM_I2C_ADAPTERS, and you can
-               omit this define.
+               Hold the number of i2c buses you want to use.
 
                CONFIG_SYS_I2C_DIRECT_BUS
                define this, if you don't use i2c muxes on your hardware.
@@ -2602,7 +2547,7 @@ CBFS (Coreboot Filesystem) support
                will skip addresses 0x50 and 0x68 on a board with one I2C bus
 
                        #define CONFIG_I2C_MULTI_BUS
-                       #define CONFIG_SYS_I2C_MULTI_NOPROBES   {{0,0x50},{0,0x68},{1,0x54}}
+                       #define CONFIG_SYS_I2C_NOPROBES {{0,0x50},{0,0x68},{1,0x54}}
 
                will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
 
@@ -2756,7 +2701,7 @@ CBFS (Coreboot Filesystem) support
                with a special header) as build targets. By defining
                CONFIG_BUILD_TARGET in the SoC / board header, this
                special image will be automatically built upon calling
-               make / MAKEALL.
+               make / buildman.
 
                CONFIG_IDENT_STRING
 
@@ -3508,21 +3453,6 @@ FIT uImage format:
                CONFIG_SPL_INIT_MINIMAL
                Arch init code should be built for a very small image
 
-               CONFIG_SPL_LIBCOMMON_SUPPORT
-               Support for common/libcommon.o in SPL binary
-
-               CONFIG_SPL_LIBDISK_SUPPORT
-               Support for disk/libdisk.o in SPL binary
-
-               CONFIG_SPL_I2C_SUPPORT
-               Support for drivers/i2c/libi2c.o in SPL binary
-
-               CONFIG_SPL_GPIO_SUPPORT
-               Support for drivers/gpio/libgpio.o in SPL binary
-
-               CONFIG_SPL_MMC_SUPPORT
-               Support for drivers/mmc/libmmc.o in SPL binary
-
                CONFIG_SYS_MMCSD_RAW_MODE_U_BOOT_SECTOR,
                CONFIG_SYS_U_BOOT_MAX_SIZE_SECTORS,
                Address and partition on the MMC to load U-Boot from
@@ -3546,12 +3476,6 @@ FIT uImage format:
                Partition on the MMC to load U-Boot from when the MMC is being
                used in fs mode
 
-               CONFIG_SPL_FAT_SUPPORT
-               Support for fs/fat/libfat.o in SPL binary
-
-               CONFIG_SPL_EXT_SUPPORT
-               Support for EXT filesystem in SPL binary
-
                CONFIG_SPL_FS_LOAD_PAYLOAD_NAME
                Filename to read to load U-Boot when reading from filesystem
 
@@ -3590,18 +3514,10 @@ FIT uImage format:
                Support for a lightweight UBI (fastmap) scanner and
                loader
 
-               CONFIG_SPL_MTD_SUPPORT
-               Support for the MTD subsystem within SPL.  Useful for
-               environment on NAND support within SPL.
-
                CONFIG_SPL_NAND_RAW_ONLY
                Support to boot only raw u-boot.bin images. Use this only
                if you need to save space.
 
-               CONFIG_SPL_MPC8XXX_INIT_DDR_SUPPORT
-               Set for the SPL on PPC mpc8xxx targets, support for
-               drivers/ddr/fsl/libddr.o in SPL binary.
-
                CONFIG_SPL_COMMON_INIT_DDR
                Set for common ddr init with serial presence detect in
                SPL binary.
@@ -3637,29 +3553,9 @@ FIT uImage format:
                Support for an OMAP3-specific set of functions to return the
                ID and MFR of the first attached NAND chip, if present.
 
-               CONFIG_SPL_SERIAL_SUPPORT
-               Support for drivers/serial/libserial.o in SPL binary
-
-               CONFIG_SPL_SPI_FLASH_SUPPORT
-               Support for drivers/mtd/spi/libspi_flash.o in SPL binary
-
-               CONFIG_SPL_SPI_SUPPORT
-               Support for drivers/spi/libspi.o in SPL binary
-
                CONFIG_SPL_RAM_DEVICE
                Support for running image already present in ram, in SPL binary
 
-               CONFIG_SPL_LIBGENERIC_SUPPORT
-               Support for lib/libgeneric.o in SPL binary
-
-               CONFIG_SPL_ENV_SUPPORT
-               Support for the environment operating in SPL binary
-
-               CONFIG_SPL_NET_SUPPORT
-               Support for the net/libnet.o in SPL binary.
-               It conflicts with SPL env from storage medium specified by
-               CONFIG_ENV_IS_xxx but CONFIG_ENV_IS_NOWHERE
-
                CONFIG_SPL_PAD_TO
                Image offset to which the SPL should be padded before appending
                the SPL payload. By default, this is defined as
@@ -3808,10 +3704,6 @@ Configuration Settings:
 - CONFIG_SYS_SDRAM_BASE:
                Physical start address of SDRAM. _Must_ be 0 here.
 
-- CONFIG_SYS_MBIO_BASE:
-               Physical start address of Motherboard I/O (if using a
-               Cogent motherboard)
-
 - CONFIG_SYS_FLASH_BASE:
                Physical start address of Flash memory.
 
@@ -4243,7 +4135,7 @@ to save the current settings.
          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. CONFIG_ENV_OFFSET_RENDUND must be
+         during a "saveenv" operation. CONFIG_ENV_OFFSET_REDUND must be
          aligned to an erase sector boundary.
 
        - CONFIG_ENV_SPI_BUS (optional):
@@ -4294,7 +4186,7 @@ but it can not erase, write this NOR flash by SRIO or PCIE interface.
          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.  CONFIG_ENV_OFFSET_RENDUND must be
+         during a "saveenv" operation.  CONFIG_ENV_OFFSET_REDUND must be
          aligned to an erase block boundary.
 
        - CONFIG_ENV_RANGE (optional):
@@ -4595,7 +4487,7 @@ Low Level (hardware related) configuration options:
                CONFIG_SYS_GBL_DATA_OFFSET is chosen such that the initial
                data is located at the end of the available space
                (sometimes written as (CONFIG_SYS_INIT_RAM_SIZE -
-               CONFIG_SYS_INIT_DATA_SIZE), and the initial stack is just
+               GENERATED_GBL_DATA_SIZE), and the initial stack is just
                below that area (growing from (CONFIG_SYS_INIT_RAM_ADDR +
                CONFIG_SYS_GBL_DATA_OFFSET) downward.
 
@@ -4654,11 +4546,6 @@ Low Level (hardware related) configuration options:
                enable SPI microcode relocation patch (MPC8xx);
                define relocation offset in DPRAM [SCC4]
 
-- CONFIG_SYS_USE_OSCCLK:
-               Use OSCM clock mode on MBX8xx board. Be careful,
-               wrong setting might damage your board. Read
-               doc/README.MBX before setting this variable!
-
 - CONFIG_SYS_CPM_POST_WORD_ADDR: (MPC8xx, MPC8260 only)
                Offset of the bootmode word in DPRAM used by post
                (Power On Self Tests). This definition overrides
@@ -4902,10 +4789,6 @@ within that device.
        Specifies that QE/FMAN firmware is located on the primary SD/MMC
        device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
 
-- CONFIG_SYS_QE_FMAN_FW_IN_SPIFLASH
-       Specifies that QE/FMAN firmware is located on the primary SPI
-       device.  CONFIG_SYS_FMAN_FW_ADDR is the byte offset on that device.
-
 - CONFIG_SYS_QE_FMAN_FW_IN_REMOTE
        Specifies that QE/FMAN firmware is located in the remote (master)
        memory space.   CONFIG_SYS_FMAN_FW_ADDR is a virtual address which
@@ -4924,34 +4807,12 @@ within that device.
 - CONFIG_FSL_MC_ENET
        Enable the MC driver for Layerscape SoCs.
 
-- CONFIG_SYS_LS_MC_FW_ADDR
-       The address in the storage device where the firmware is located.  The
-       meaning of this address depends on which CONFIG_SYS_LS_MC_FW_IN_xxx macro
-       is also specified.
-
-- CONFIG_SYS_LS_MC_FW_LENGTH
-       The maximum possible size of the firmware.  The firmware binary format
-       has a field that specifies the actual size of the firmware, but it
-       might not be possible to read any part of the firmware unless some
-       local storage is allocated to hold the entire firmware first.
-
-- CONFIG_SYS_LS_MC_FW_IN_NOR
-       Specifies that MC firmware is located in NOR flash, mapped as
-       normal addressable memory via the LBC. CONFIG_SYS_LS_MC_FW_ADDR is the
-       virtual address in NOR flash.
-
 Freescale Layerscape Debug Server Support:
 -------------------------------------------
 The Freescale Layerscape Debug Server Support supports the loading of
 "Debug Server firmware" and triggering SP boot-rom.
 This firmware often needs to be loaded during U-Boot booting.
 
-- CONFIG_FSL_DEBUG_SERVER
-       Enable the Debug Server for Layerscape SoCs.
-
-- CONFIG_SYS_DEBUG_SERVER_DRAM_BLOCK_MIN_SIZE
-       Define minimum DDR size required for debug server image
-
 - CONFIG_SYS_MC_RSV_MEM_ALIGN
        Define alignment of reserved memory MC requires
 
@@ -5083,33 +4944,10 @@ official or latest in the git repository) version of U-Boot sources.
 But before you submit such a patch, please verify that your modifi-
 cation did not break existing code. At least make sure that *ALL* of
 the supported boards compile WITHOUT ANY compiler warnings. To do so,
-just run the "MAKEALL" script, which will configure and build U-Boot
-for ALL supported system. Be warned, this will take a while. You can
-select which (cross) compiler to use by passing a `CROSS_COMPILE'
-environment variable to the script, i. e. to use the ELDK cross tools
-you can type
-
-       CROSS_COMPILE=ppc_8xx- MAKEALL
-
-or to build on a native PowerPC system you can type
-
-       CROSS_COMPILE=' ' MAKEALL
-
-When using the MAKEALL script, the default behaviour is to build
-U-Boot in the source directory. This location can be changed by
-setting the BUILD_DIR environment variable. Also, for each target
-built, the MAKEALL script saves two log files (<target>.ERR and
-<target>.MAKEALL) in the <source dir>/LOG directory. This default
-location can be changed by setting the MAKEALL_LOGDIR environment
-variable. For example:
-
-       export BUILD_DIR=/tmp/build
-       export MAKEALL_LOGDIR=/tmp/log
-       CROSS_COMPILE=ppc_8xx- MAKEALL
-
-With the above settings build objects are saved in the /tmp/build,
-log files are saved in the /tmp/log and the source tree remains clean
-during the whole build process.
+just run the buildman script (tools/buildman/buildman), which will
+configure and build U-Boot for ALL supported system. Be warned, this
+will take a while. Please see the buildman README, or run 'buildman -H'
+for documentation.
 
 
 See also "U-Boot Porting Guide" below.
@@ -6565,7 +6403,7 @@ it:
 
 Notes:
 
-* Before sending the patch, run the MAKEALL script on your patched
+* Before sending the patch, run the buildman script on your patched
   source tree and make sure that no errors or warnings are reported
   for any of the boards.