]> git.ipfire.org Git - people/ms/u-boot.git/blobdiff - README
Convert CONFIG_CMD_EEPROM et al to Kconfig
[people/ms/u-boot.git] / README
diff --git a/README b/README
index 47bc215fe9c57829090679585c409451aeefc578..a6af0a209c3f314ecdffbeba7ee1ae42ee7aebc5 100644 (file)
--- a/README
+++ b/README
@@ -137,7 +137,6 @@ Directory Hierarchy:
   /arc                 Files generic to ARC architecture
   /arm                 Files generic to ARM architecture
   /avr32               Files generic to AVR32 architecture
-  /blackfin            Files generic to Analog Devices Blackfin architecture
   /m68k                        Files generic to m68k architecture
   /microblaze          Files generic to microblaze architecture
   /mips                        Files generic to MIPS architecture
@@ -147,7 +146,6 @@ Directory Hierarchy:
   /powerpc             Files generic to PowerPC architecture
   /sandbox             Files generic to HW-independent "sandbox"
   /sh                  Files generic to SH architecture
-  /sparc               Files generic to SPARC architecture
   /x86                 Files generic to x86 architecture
 /api                   Machine/arch independent API for external apps
 /board                 Board dependent files
@@ -294,7 +292,7 @@ board_init_r():
        - stack is optionally in SDRAM, if CONFIG_SPL_STACK_R is defined and
                CONFIG_SPL_STACK_R_ADDR points into SDRAM
        - preloader_console_init() can be called here - typically this is
-               done by defining CONFIG_SPL_BOARD_INIT and then supplying a
+               done by selecting CONFIG_SPL_BOARD_INIT and then supplying a
                spl_board_init() function containing this call
        - loads U-Boot or (in falcon mode) Linux
 
@@ -376,15 +374,6 @@ The following options need to be configured:
                Defines the string to utilize when trying to match PCIe device
                tree nodes for the given platform.
 
-               CONFIG_SYS_PPC_E500_DEBUG_TLB
-
-               Enables a temporary TLB entry to be used during boot to work
-               around limitations in e500v1 and e500v2 external debugger
-               support. This reduces the portions of the boot code where
-               breakpoints and single stepping do not work.  The value of this
-               symbol should be set to the TLB1 entry to be used for this
-               purpose.
-
                CONFIG_SYS_FSL_ERRATUM_A004510
 
                Enables a workaround for erratum A004510.  If set,
@@ -513,6 +502,12 @@ The following options need to be configured:
                CONFIG_SYS_FSL_IFC_LE
                Defines the IFC controller register space as Little Endian
 
+               CONFIG_SYS_FSL_IFC_CLK_DIV
+               Defines divider of platform clock(clock input to IFC controller).
+
+               CONFIG_SYS_FSL_LBC_CLK_DIV
+               Defines divider of platform clock(clock input to eLBC controller).
+
                CONFIG_SYS_FSL_PBL_PBI
                It enables addition of RCW (Power on reset configuration) in built image.
                Please refer doc/README.pblimage for more details
@@ -595,29 +590,6 @@ The following options need to be configured:
                Select high exception vectors of the ARM core, e.g., do not
                clear the V bit of the c1 register of CP15.
 
-               CONFIG_SYS_THUMB_BUILD
-
-               Use this flag to build U-Boot using the Thumb instruction
-               set for ARM architectures. Thumb instruction set provides
-               better code density. For ARM architectures that support
-               Thumb2 this flag will result in Thumb2 code generated by
-               GCC.
-
-               CONFIG_ARM_ERRATA_716044
-               CONFIG_ARM_ERRATA_742230
-               CONFIG_ARM_ERRATA_743622
-               CONFIG_ARM_ERRATA_751472
-               CONFIG_ARM_ERRATA_761320
-               CONFIG_ARM_ERRATA_773022
-               CONFIG_ARM_ERRATA_774769
-               CONFIG_ARM_ERRATA_794072
-
-               If set, the workarounds for these ARM errata are applied early
-               during U-Boot startup. Note that these options force the
-               workarounds to be applied; no CPU-type/version detection
-               exists, unlike the similar options in the Linux kernel. Do not
-               set these options unless they apply!
-
                COUNTER_FREQUENCY
                Generic timer clock source frequency.
 
@@ -626,15 +598,6 @@ The following options need to be configured:
                different from COUNTER_FREQUENCY, and can only be determined
                at run time.
 
-               NOTE: The following can be machine specific errata. These
-               do have ability to provide rudimentary version and machine
-               specific checks, but expect no product checks.
-               CONFIG_ARM_ERRATA_430973
-               CONFIG_ARM_ERRATA_454179
-               CONFIG_ARM_ERRATA_621766
-               CONFIG_ARM_ERRATA_798870
-               CONFIG_ARM_ERRATA_801819
-
 - Tegra SoC options:
                CONFIG_TEGRA_SUPPORT_NON_SECURE
 
@@ -860,27 +823,15 @@ The following options need to be configured:
                CONFIG_CMD_AES            AES 128 CBC encrypt/decrypt
                CONFIG_CMD_ASKENV       * ask for env variable
                CONFIG_CMD_BDI            bdinfo
-               CONFIG_CMD_BEDBUG       * Include BedBug Debugger
-               CONFIG_CMD_BMP          * BMP support
-               CONFIG_CMD_BSP          * Board specific commands
                CONFIG_CMD_BOOTD          bootd
                CONFIG_CMD_BOOTI        * ARM64 Linux kernel Image support
                CONFIG_CMD_CACHE        * icache, dcache
-               CONFIG_CMD_CLK          * clock command support
                CONFIG_CMD_CONSOLE        coninfo
                CONFIG_CMD_CRC32        * crc32
-               CONFIG_CMD_DATE         * support for RTC, date/time...
                CONFIG_CMD_DHCP         * DHCP support
                CONFIG_CMD_DIAG         * Diagnostics
-               CONFIG_CMD_DS4510       * ds4510 I2C gpio commands
-               CONFIG_CMD_DS4510_INFO  * ds4510 I2C info command
-               CONFIG_CMD_DS4510_MEM   * ds4510 I2C eeprom/sram commansd
-               CONFIG_CMD_DS4510_RST   * ds4510 I2C rst command
-               CONFIG_CMD_DTT          * Digital Therm and Thermostat
                CONFIG_CMD_ECHO           echo arguments
                CONFIG_CMD_EDITENV        edit env variable
-               CONFIG_CMD_EEPROM       * EEPROM read/write support
-               CONFIG_CMD_EEPROM_LAYOUT* EEPROM layout aware commands
                CONFIG_CMD_ELF          * bootelf, bootvx
                CONFIG_CMD_ENV_CALLBACK * display details about env callbacks
                CONFIG_CMD_ENV_FLAGS    * display details about env flags
@@ -1010,7 +961,7 @@ The following options need to be configured:
                tree is available in the global data as gd->fdt_blob.
 
                U-Boot needs to get its device tree from somewhere. This can
-               be done using one of the two options below:
+               be done using one of the three options below:
 
                CONFIG_OF_EMBED
                If this variable is defined, U-Boot will embed a device tree
@@ -1031,6 +982,12 @@ The following options need to be configured:
                still use the individual files if you need something more
                exotic.
 
+               CONFIG_OF_BOARD
+               If this variable is defined, U-Boot will use the device tree
+               provided by the board at runtime instead of embedding one with
+               the image. Only boards defining board_fdt_blob_setup() support
+               this option (see include/fdtdec.h file).
+
 - Watchdog:
                CONFIG_WATCHDOG
                If this variable is defined, it enables watchdog
@@ -1466,9 +1423,6 @@ The following options need to be configured:
                        CONFIG_SH_MMCIF_CLK
                        Define the clock frequency for MMCIF
 
-               CONFIG_GENERIC_MMC
-               Enable the generic MMC driver
-
                CONFIG_SUPPORT_EMMC_BOOT
                Enable some additional features of the eMMC boot partitions.
 
@@ -1589,13 +1543,6 @@ The following options need to be configured:
                This will also enable the command "fatwrite" enabling the
                user to write files to FAT.
 
-- CBFS (Coreboot Filesystem) support:
-               CONFIG_CMD_CBFS
-
-               Define this to enable support for reading from a Coreboot
-               filesystem. Available commands are cbfsinit, cbfsinfo, cbfsls
-               and cbfsload.
-
 - FAT(File Allocation Table) filesystem cluster size:
                CONFIG_FS_FAT_MAX_CLUSTSIZE
 
@@ -1621,7 +1568,6 @@ The following options need to be configured:
 
                        CONFIG_SYS_DIU_ADDR
                        CONFIG_VIDEO
-                       CONFIG_CMD_BMP
                        CONFIG_CFB_CONSOLE
                        CONFIG_VIDEO_SW_CURSOR
                        CONFIG_VGA_AS_SINGLE_DEVICE
@@ -1682,9 +1628,6 @@ The following options need to be configured:
 
                        320x240. Black & white.
 
-               Normally display is black on white background; define
-               CONFIG_SYS_WHITE_ON_BLACK to get it inverted.
-
                CONFIG_LCD_ALIGNMENT
 
                Normally the LCD is page-aligned (typically 4KB). If this is
@@ -1777,12 +1720,6 @@ The following options need to be configured:
                can be displayed via the splashscreen support or the
                bmp command.
 
-- Do compressing for memory range:
-               CONFIG_CMD_ZIP
-
-               If this option is set, it would use zlib deflate method
-               to compress the specified memory at its best effort.
-
 - Compression support:
                CONFIG_GZIP
 
@@ -2042,7 +1979,7 @@ The following options need to be configured:
 
                A byte containing the id of the VLAN.
 
-- Status LED:  CONFIG_STATUS_LED
+- Status LED:  CONFIG_LED_STATUS
 
                Several configurations allow to display the current
                status using a LED. For instance, the LED will blink
@@ -2050,15 +1987,15 @@ The following options need to be configured:
                soon as a reply to a BOOTP request was received, and
                start blinking slow once the Linux kernel is running
                (supported by a status LED driver in the Linux
-               kernel). Defining CONFIG_STATUS_LED enables this
+               kernel). Defining CONFIG_LED_STATUS enables this
                feature in U-Boot.
 
                Additional options:
 
-               CONFIG_GPIO_LED
+               CONFIG_LED_STATUS_GPIO
                The status LED can be connected to a GPIO pin.
                In such cases, the gpio_led driver can be used as a
-               status LED backend implementation. Define CONFIG_GPIO_LED
+               status LED backend implementation. Define CONFIG_LED_STATUS_GPIO
                to include the gpio_led driver in the U-Boot binary.
 
                CONFIG_GPIO_LED_INVERTED_TABLE
@@ -2260,52 +2197,7 @@ The following options need to be configured:
 
                If you do not have i2c muxes on your board, omit this define.
 
-- Legacy I2C Support:  CONFIG_HARD_I2C
-
-               NOTE: It is intended to move drivers to CONFIG_SYS_I2C which
-               provides the following compelling advantages:
-
-               - more than one i2c adapter is usable
-               - approved multibus support
-               - better i2c mux support
-
-               ** Please consider updating your I2C driver now. **
-
-               These enable legacy I2C serial bus commands. Defining
-               CONFIG_HARD_I2C will include the appropriate I2C driver
-               for the selected CPU.
-
-               This will allow you to use i2c commands at the u-boot
-               command line (as long as you set CONFIG_CMD_I2C in
-               CONFIG_COMMANDS) and communicate with i2c based realtime
-               clock chips. See common/cmd_i2c.c for a description of the
-               command line interface.
-
-               CONFIG_HARD_I2C selects a hardware I2C controller.
-
-               There are several other quantities that must also be
-               defined when you define CONFIG_HARD_I2C.
-
-               In both cases you will need to define CONFIG_SYS_I2C_SPEED
-               to be the frequency (in Hz) at which you wish your i2c bus
-               to run and CONFIG_SYS_I2C_SLAVE to be the address of this node (ie
-               the CPU's i2c node address).
-
-               Now, the u-boot i2c code for the mpc8xx
-               (arch/powerpc/cpu/mpc8xx/i2c.c) sets the CPU up as a master node
-               and so its address should therefore be cleared to 0 (See,
-               eg, MPC823e User's Manual p.16-473). So, set
-               CONFIG_SYS_I2C_SLAVE to 0.
-
-               CONFIG_SYS_I2C_INIT_MPC5XXX
-
-               When a board is reset during an i2c bus transfer
-               chips might think that the current transfer is still
-               in progress.  Reset the slave devices by sending start
-               commands until the slave device responds.
-
-               That's all that's required for CONFIG_HARD_I2C.
-
+- Legacy I2C Support:
                If you use the software i2c interface (CONFIG_SYS_I2C_SOFT)
                then the following macros need to be defined (examples are
                from include/configs/lwmon.h):
@@ -2394,23 +2286,6 @@ The following options need to be configured:
                custom i2c_init_board() routine in boards/xxx/board.c
                is run early in the boot sequence.
 
-               CONFIG_SYS_I2C_BOARD_LATE_INIT
-
-               An alternative to CONFIG_SYS_I2C_INIT_BOARD. If this option is
-               defined a custom i2c_board_late_init() routine in
-               boards/xxx/board.c is run AFTER the operations in i2c_init()
-               is completed. This callpoint can be used to unreset i2c bus
-               using CPU i2c controller register accesses for CPUs whose i2c
-               controller provide such a method. It is called at the end of
-               i2c_init() to allow i2c_init operations to setup the i2c bus
-               controller on the CPU (e.g. setting bus speed & slave address).
-
-               CONFIG_I2CFAST (PPC405GP|PPC405EP only)
-
-               This option enables configuration of bi_iic_fast[] flags
-               in u-boot bd_info structure based on u-boot environment
-               variable "i2cfast". (see also i2cfast)
-
                CONFIG_I2C_MULTI_BUS
 
                This option allows the use of multiple I2C buses, each of which
@@ -2446,17 +2321,6 @@ The following options need to be configured:
                If defined, then this indicates the I2C bus number for the RTC.
                If not defined, then U-Boot assumes that RTC is on I2C bus 0.
 
-               CONFIG_SYS_DTT_BUS_NUM
-
-               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.
-
-               CONFIG_SYS_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_SOFT_I2C_READ_REPEATED_START
 
                defining this will force the i2c_read() function in
@@ -2792,19 +2656,6 @@ The following options need to be configured:
                this is instead controlled by the value of
                /config/load-environment.
 
-- Parallel Flash support:
-               CONFIG_SYS_NO_FLASH
-
-               Traditionally U-Boot was run on systems with parallel NOR
-               flash. This option is used to disable support for parallel NOR
-               flash. This option should be defined if the board does not have
-               parallel flash.
-
-               If this option is not defined one of the generic flash drivers
-               (e.g.  CONFIG_FLASH_CFI_DRIVER or CONFIG_ST_SMI) must be
-               selected or the board must provide an implementation of the
-               flash API (see include/flash.h).
-
 - DataFlash Support:
                CONFIG_HAS_DATAFLASH
 
@@ -2887,19 +2738,6 @@ The following options need to be configured:
                Enable the hash verify command (hash -v). This adds to code
                size a little.
 
-               CONFIG_SHA1 - This option enables support of hashing using SHA1
-               algorithm. The hash is calculated in software.
-               CONFIG_SHA256 - This option enables support of hashing using
-               SHA256 algorithm. The hash is calculated in software.
-               CONFIG_SHA_HW_ACCEL - This option enables hardware acceleration
-               for SHA1/SHA256 hashing.
-               This affects the 'hash' command and also the
-               hash_lookup_algo() function.
-               CONFIG_SHA_PROG_HW_ACCEL - This option enables
-               hardware-acceleration for SHA1/SHA256 progressive hashing.
-               Data can be streamed in a block at a time and the hashing
-               is performed in hardware.
-
                Note: There is also a sha1sum command, which should perhaps
                be deprecated in favour of 'hash sha1'.
 
@@ -2908,16 +2746,6 @@ The following options need to be configured:
                This enables 'hdmidet' command which returns true if an
                HDMI monitor is detected.  This command is i.MX 6 specific.
 
-               CONFIG_CMD_BMODE
-               This enables the 'bmode' (bootmode) command for forcing
-               a boot from specific media.
-
-               This is useful for forcing the ROM's usb downloader to
-               activate upon a watchdog reset which is nice when iterating
-               on U-Boot.  Using the reset button or running bmode normal
-               will set it back to normal.  This command currently
-               supports i.MX53 and i.MX6.
-
 - bootcount support:
                CONFIG_BOOTCOUNT_LIMIT
 
@@ -2926,8 +2754,6 @@ The following options need to be configured:
 
                CONFIG_AT91SAM9XE
                enable special bootcounter support on at91sam9xe based boards.
-               CONFIG_BLACKFIN
-               enable special bootcounter support on blackfin based boards.
                CONFIG_SOC_DA8XX
                enable special bootcounter support on da850 based boards.
                CONFIG_BOOTCOUNT_RAM
@@ -3116,15 +2942,6 @@ FIT uImage format:
                This define is introduced, as the legacy image format is
                enabled per default for backward compatibility.
 
-- FIT image support:
-               CONFIG_FIT_DISABLE_SHA256
-               Supporting SHA256 hashes has quite an impact on binary size.
-               For constrained systems sha256 hash support can be disabled
-               with this option.
-
-               TODO(sjg@chromium.org): Adjust this option to be positive,
-               and move it to Kconfig
-
 - Standalone program support:
                CONFIG_STANDALONE_LOAD_ADDR
 
@@ -3304,10 +3121,6 @@ FIT uImage format:
                consider that a completely unreadable NAND block is bad,
                and thus should be skipped silently.
 
-               CONFIG_SPL_ABORT_ON_RAW_IMAGE
-               When defined, SPL will proceed to another boot method
-               if the image it has loaded does not have a signature.
-
                CONFIG_SPL_RELOC_STACK
                Adress of the start of the stack SPL will use after
                relocation.  If unspecified, this is equal to
@@ -3793,11 +3606,6 @@ Configuration Settings:
        If defined, don't allow the -f switch to env set override variable
        access flags.
 
-- 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
-       the value can be calculated on a given board.
-
 - CONFIG_USE_STDINT
        If stdint.h is available with your toolchain you can define this
        option to enable it. You can provide option 'USE_STDINT=1' when
@@ -4110,7 +3918,7 @@ but it can not erase, write this NOR flash by SRIO or PCIE interface.
 
          Define this to a string that is the name of the block device.
 
-       - FAT_ENV_DEV_AND_PART:
+       - FAT_ENV_DEVICE_AND_PART:
 
          Define this to a string to specify the partition of the device. It can
          be as following:
@@ -4593,21 +4401,10 @@ Low Level (hardware related) configuration options:
                addressable memory. This option causes some memory accesses
                to be mapped through map_sysmem() / unmap_sysmem().
 
-- CONFIG_USE_ARCH_MEMCPY
-  CONFIG_USE_ARCH_MEMSET
-               If these options are used a optimized version of memcpy/memset will
-               be used if available. These functions may be faster under some
-               conditions but may increase the binary size.
-
 - CONFIG_X86_RESET_VECTOR
                If defined, the x86 reset vector code is included. This is not
                needed when U-Boot is running from Coreboot.
 
-- CONFIG_SYS_MPUCLK
-               Defines the MPU clock speed (in MHz).
-
-               NOTE : currently only supported on AM335x platforms.
-
 - CONFIG_SPL_AM33XX_ENABLE_RTC32K_OSC:
                Enables the RTC32K OSC on AM33xx based plattforms
 
@@ -5978,11 +5775,6 @@ For PowerPC, the following registers have specific use:
     average for all boards 752 bytes for the whole U-Boot image,
     624 text + 127 data).
 
-On Blackfin, the normal C ABI (except for P3) is followed as documented here:
-       http://docs.blackfin.uclinux.org/doku.php?id=application_binary_interface
-
-    ==> U-Boot will use P3 to hold a pointer to the global data
-
 On ARM, the following registers are used:
 
        R0:     function argument word/integer result