]> git.ipfire.org Git - people/ms/u-boot.git/blobdiff - README
Convert CONFIG_VIDEO to Kconfig
[people/ms/u-boot.git] / README
diff --git a/README b/README
index 6f4c09a3a1fc13b47a6510b01c5c96a260c503ff..4f9d29c032e20194eb0613ffb104179cec5f1510 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
@@ -511,7 +491,7 @@ The following options need to be configured:
                implemetation.
 
                CONFIG_SYS_FSL_DDR2
-               Board config to use DDR2. It can be eanbeld for SoCs with
+               Board config to use DDR2. It can be enabled for SoCs with
                Freescale DDR2 or DDR3 controllers, depending on the board
                implementation.
 
@@ -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.
@@ -840,6 +801,9 @@ The following options need to be configured:
                        CONFIG_CONSOLE_EXTRA_INFO
                                                additional board info beside
                                                the logo
+                       CONFIG_HIDE_LOGO_VERSION
+                                               do not display bootloader
+                                               version string
 
                When CONFIG_CFB_CONSOLE_ANSI is defined, console will support
                a limited number of ANSI escape sequences (cursor control,
@@ -849,11 +813,6 @@ The following options need to be configured:
                default i/o. Serial console can be forced with
                environment 'console=serial'.
 
-               When CONFIG_SILENT_CONSOLE is defined, all console
-               messages (by U-Boot and Linux!) can be silenced with
-               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
@@ -873,40 +832,6 @@ The following options need to be configured:
                must be defined, to setup the maximum idle timeout for
                the SMC.
 
-- Pre-Console Buffer:
-               Prior to the console being initialised (i.e. serial UART
-               initialised etc) all console output is silently discarded.
-               Defining CONFIG_PRE_CONSOLE_BUFFER will cause U-Boot to
-               buffer any console messages prior to the console being
-               initialised to a buffer of size CONFIG_PRE_CON_BUF_SZ
-               bytes located at CONFIG_PRE_CON_BUF_ADDR. The buffer is
-               a circular buffer, so if more than CONFIG_PRE_CON_BUF_SZ
-               bytes are output before the console is initialised, the
-               earlier bytes are discarded.
-
-               Note that when printing the buffer a copy is made on the
-               stack so CONFIG_PRE_CON_BUF_SZ must fit on the stack.
-
-               'Sane' compilers will generate smaller code if
-               CONFIG_PRE_CON_BUF_SZ is a power of 2
-
-- Boot Delay:  CONFIG_BOOTDELAY - in seconds
-               Delay before automatically booting the default image;
-               set to -1 to disable autoboot.
-               set to -2 to autoboot with no delay and not check for abort
-               (even when CONFIG_ZERO_BOOTDELAY_CHECK is defined).
-
-               See doc/README.autoboot for these options that
-               work with CONFIG_BOOTDELAY. None are required.
-               CONFIG_BOOT_RETRY_TIME
-               CONFIG_BOOT_RETRY_MIN
-               CONFIG_AUTOBOOT_KEYED
-               CONFIG_AUTOBOOT_PROMPT
-               CONFIG_AUTOBOOT_DELAY_STR
-               CONFIG_AUTOBOOT_STOP_STR
-               CONFIG_ZERO_BOOTDELAY_CHECK
-               CONFIG_RESET_TO_RETRY
-
 - Autoboot Command:
                CONFIG_BOOTCOMMAND
                Only needed when CONFIG_BOOTDELAY is enabled;
@@ -1350,10 +1275,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
 
@@ -1418,7 +1339,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
@@ -1538,10 +1459,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
@@ -1694,26 +1611,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
 
@@ -1748,11 +1662,6 @@ CBFS (Coreboot Filesystem) support
                instead.
 
 - Video support:
-               CONFIG_VIDEO
-
-               Define this to enable video support (for output to
-               video).
-
                CONFIG_VIDEO_CT69000
 
                Enable Chips & Technologies 69000 Video chip
@@ -2344,8 +2253,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
@@ -2399,10 +2306,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.
@@ -2616,7 +2520,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
 
@@ -2770,7 +2674,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
 
@@ -3522,21 +3426,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
@@ -3560,12 +3449,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
 
@@ -3600,18 +3483,14 @@ FIT uImage format:
                Support for NAND boot using simple NAND drivers that
                expose the cmd_ctrl() interface.
 
-               CONFIG_SPL_MTD_SUPPORT
-               Support for the MTD subsystem within SPL.  Useful for
-               environment on NAND support within SPL.
+               CONFIG_SPL_UBI
+               Support for a lightweight UBI (fastmap) scanner and
+               loader
 
                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.
@@ -3647,29 +3526,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
@@ -3783,10 +3642,11 @@ Configuration Settings:
                You only need to set this if address zero isn't writeable
 
 - CONFIG_SYS_MEM_RESERVE_SECURE
+               Only implemented for ARMv8 for now.
                If defined, the size of CONFIG_SYS_MEM_RESERVE_SECURE memory
                is substracted from total RAM and won't be reported to OS.
                This memory can be used as secure memory. A variable
-               gd->secure_ram is used to track the location. In systems
+               gd->arch.secure_ram is used to track the location. In systems
                the RAM base is not zero, or RAM is divided into banks,
                this variable needs to be recalcuated to get the address.
 
@@ -3817,10 +3677,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.
 
@@ -3852,9 +3708,6 @@ Configuration Settings:
                The memory will be freed (or in fact just forgotten) when
                U-Boot relocates itself.
 
-               Pre-relocation malloc() is only supported on ARM and sandbox
-               at present but is fairly easy to enable for other archs.
-
 - CONFIG_SYS_MALLOC_SIMPLE
                Provides a simple and small malloc() and calloc() for those
                boards which do not use the full malloc in SPL (which is
@@ -4048,16 +3901,6 @@ Configuration Settings:
        If defined, don't allow the -f switch to env set override variable
        access flags.
 
-- CONFIG_SYS_GENERIC_BOARD
-       This selects the architecture-generic board system instead of the
-       architecture-specific board files. It is intended to move boards
-       to this new framework over time. Defining this will disable the
-       arch/foo/lib/board.c file and use common/board_f.c and
-       common/board_r.c instead. To use this option your architecture
-       must support it (i.e. must select HAVE_GENERIC_BOARD in arch/Kconfig).
-       If you find problems enabling this option on your board please report
-       the problem and send patches!
-
 - CONFIG_OMAP_PLATFORM_RESET_TIME_MAX_USEC (OMAP only)
        This is set by OMAP boards for the max time that reset should
        be asserted. See doc/README.omap-reset-time for details on how
@@ -4265,7 +4108,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):
@@ -4316,7 +4159,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):
@@ -4617,7 +4460,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.
 
@@ -4676,11 +4519,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
@@ -4834,6 +4672,11 @@ Low Level (hardware related) configuration options:
                other boot loader or by a debugger which performs
                these initializations itself.
 
+- CONFIG_SKIP_LOWLEVEL_INIT_ONLY
+               [ARM926EJ-S only] This allows just the call to lowlevel_init()
+               to be skipped. The normal CP15 init (such as enabling the
+               instruction cache) is still performed.
+
 - CONFIG_SPL_BUILD
                Modifies the behaviour of start.S when compiling a loader
                that is executed before the actual U-Boot. E.g. when
@@ -4919,10 +4762,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
@@ -4941,34 +4780,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
 
@@ -5100,33 +4917,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.
@@ -6582,7 +6376,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.