global: Migrate CONFIG_SYS_FSL* symbols to the CFG_SYS namespace

[platform/kernel/u-boot.git] / README

diff --git a/README b/README
index 2c4bde0..d75c3fb 100644 (file)
--- a/README
+++ b/README
@@ -166,27 +166,6 @@ Directory Hierarchy:
 Software Configuration:
 =======================
 
 Software Configuration:
 =======================
 

-Configuration is usually done using C preprocessor defines; the
-rationale behind that is to avoid dead code whenever possible.
-
-There are two classes of configuration variables:
-
-* Configuration _OPTIONS_:
-  These are selectable by the user and have names beginning with
-  "CONFIG_".
-
-* Configuration _SETTINGS_:
-  These depend on the hardware etc. and should not be meddled with if
-  you don't know what you're doing; they have names beginning with
-  "CONFIG_SYS_".
-
-Previously, all configuration was done by hand, which involved creating
-symbolic links and editing configuration files manually. More recently,
-U-Boot has added the Kbuild infrastructure used by the Linux kernel,
-allowing you to use the "make menuconfig" command to configure your
-build.
-
-

 Selection of Processor Architecture and Board Type:
 ---------------------------------------------------
 
 Selection of Processor Architecture and Board Type:
 ---------------------------------------------------
 


@@ -315,22 +294,11 @@ The following options need to be configured:
                the "64" category of the Power ISA). This is necessary for ePAPR
                compliance, among other possible reasons.
 
                the "64" category of the Power ISA). This is necessary for ePAPR
                compliance, among other possible reasons.
 

-               CONFIG_SYS_FSL_TBCLK_DIV
-
-               Defines the core time base clock divider ratio compared to the
-               system clock.  On most PQ3 devices this is 8, on newer QorIQ
-               devices it can be 16 or 32.  The ratio varies from SoC to Soc.
-
-               CONFIG_SYS_FSL_PCIE_COMPAT
-
-               Defines the string to utilize when trying to match PCIe device
-               tree nodes for the given platform.
-

                CONFIG_SYS_FSL_ERRATUM_A004510
 
                Enables a workaround for erratum A004510.  If set,
                then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and
                CONFIG_SYS_FSL_ERRATUM_A004510
 
                Enables a workaround for erratum A004510.  If set,
                then CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV and

-               CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.
+               CFG_SYS_FSL_CORENET_SNOOPVEC_COREONLY must be set.

 
                CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
                CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)
 
                CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV
                CONFIG_SYS_FSL_ERRATUM_A004510_SVR_REV2 (optional)


@@ -346,117 +314,36 @@ The following options need to be configured:
                See Freescale App Note 4493 for more information about
                this erratum.
 
                See Freescale App Note 4493 for more information about
                this erratum.
 

-               CONFIG_SYS_FSL_CORENET_SNOOPVEC_COREONLY
+               CFG_SYS_FSL_CORENET_SNOOPVEC_COREONLY

 
                This is the value to write into CCSR offset 0x18600
                according to the A004510 workaround.
 
 
                This is the value to write into CCSR offset 0x18600
                according to the A004510 workaround.
 

-               CONFIG_SYS_FSL_DSP_DDR_ADDR
-               This value denotes start offset of DDR memory which is
-               connected exclusively to the DSP cores.
-
-               CONFIG_SYS_FSL_DSP_M2_RAM_ADDR
-               This value denotes start offset of M2 memory
-               which is directly connected to the DSP core.
-
-               CONFIG_SYS_FSL_DSP_M3_RAM_ADDR
-               This value denotes start offset of M3 memory which is directly
-               connected to the DSP core.
-
-               CONFIG_SYS_FSL_DSP_CCSRBAR_DEFAULT
-               This value denotes start offset of DSP CCSR space.
-

                CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
                Single Source Clock is clocking mode present in some of FSL SoC's.
                In this mode, a single differential clock is used to supply
                clocks to the sysclock, ddrclock and usbclock.
 
 - Generic CPU options:
                CONFIG_SYS_FSL_SINGLE_SOURCE_CLK
                Single Source Clock is clocking mode present in some of FSL SoC's.
                In this mode, a single differential clock is used to supply
                clocks to the sysclock, ddrclock and usbclock.
 
 - Generic CPU options:

-               CONFIG_SYS_BIG_ENDIAN, CONFIG_SYS_LITTLE_ENDIAN
-
-               Defines the endianess of the CPU. Implementation of those
-               values is arch specific.

 
                CONFIG_SYS_FSL_DDR
                Freescale DDR driver in use. This type of DDR controller is
                found in mpc83xx, mpc85xx as well as some ARM core SoCs.
 
 
                CONFIG_SYS_FSL_DDR
                Freescale DDR driver in use. This type of DDR controller is
                found in mpc83xx, mpc85xx as well as some ARM core SoCs.
 

-               CONFIG_SYS_FSL_DDR_ADDR
+               CFG_SYS_FSL_DDR_ADDR

                Freescale DDR memory-mapped register base.
 
                Freescale DDR memory-mapped register base.
 

-               CONFIG_SYS_FSL_DDRC_GEN1
-               Freescale DDR1 controller.
-
-               CONFIG_SYS_FSL_DDRC_GEN2
-               Freescale DDR2 controller.
-
-               CONFIG_SYS_FSL_DDRC_GEN3
-               Freescale DDR3 controller.
-
-               CONFIG_SYS_FSL_DDRC_GEN4
-               Freescale DDR4 controller.
-
-               CONFIG_SYS_FSL_DDRC_ARM_GEN3
-               Freescale DDR3 controller for ARM-based SoCs.
-
-               CONFIG_SYS_FSL_DDR1
-               Board config to use DDR1. It can be enabled for SoCs with
-               Freescale DDR1 or DDR2 controllers, depending on the board
-               implemetation.
-
-               CONFIG_SYS_FSL_DDR2
-               Board config to use DDR2. It can be enabled for SoCs with
-               Freescale DDR2 or DDR3 controllers, depending on the board
-               implementation.
-
-               CONFIG_SYS_FSL_DDR3
-               Board config to use DDR3. It can be enabled for SoCs with
-               Freescale DDR3 or DDR3L controllers.
-
-               CONFIG_SYS_FSL_DDR3L
-               Board config to use DDR3L. It can be enabled for SoCs with
-               DDR3L controllers.
-
-               CONFIG_SYS_FSL_IFC_BE
-               Defines the IFC controller register space as Big Endian
-
-               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_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_DDR_BE
-               Defines the DDR controller register space as Big Endian
-
-               CONFIG_SYS_FSL_DDR_LE
-               Defines the DDR controller register space as Little Endian
-
-               CONFIG_SYS_FSL_DDR_SDRAM_BASE_PHY
+               CFG_SYS_FSL_DDR_SDRAM_BASE_PHY

                Physical address from the view of DDR controllers. It is the
                same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
                it could be different for ARM SoCs.
 
                Physical address from the view of DDR controllers. It is the
                same as CONFIG_SYS_DDR_SDRAM_BASE for  all Power SoCs. But
                it could be different for ARM SoCs.
 

-               CONFIG_SYS_FSL_DDR_INTLV_256B
-               DDR controller interleaving on 256-byte. This is a special
-               interleaving mode, handled by Dickens for Freescale layerscape
-               SoCs with ARM core.
-
-               CONFIG_SYS_FSL_DDR_MAIN_NUM_CTRLS
-               Number of controllers used as main memory.
-
-               CONFIG_SYS_FSL_OTHER_DDR_NUM_CTRLS
-               Number of controllers used for other than main memory.
-
-               CONFIG_SYS_FSL_SEC_BE
-               Defines the SEC controller register space as Big Endian
-
-               CONFIG_SYS_FSL_SEC_LE
-               Defines the SEC controller register space as Little Endian
-

 - MIPS CPU options:
                CONFIG_XWAY_SWAP_BYTES
 
 - MIPS CPU options:
                CONFIG_XWAY_SWAP_BYTES
 


@@ -528,8 +415,6 @@ The following options need to be configured:
                the defaults discussed just above.
 
 - Cache Configuration for ARM:
                the defaults discussed just above.
 
 - Cache Configuration for ARM:

-               CONFIG_SYS_L2_PL310 - Enable support for ARM PL310 L2 cache
-                                     controller

                CONFIG_SYS_PL310_BASE - Physical base address of PL310
                                        controller register space
 
                CONFIG_SYS_PL310_BASE - Physical base address of PL310
                                        controller register space
 


@@ -550,15 +435,6 @@ The following options need to be configured:
                Define this variable to enable hw flow control in serial driver.
                Current user of this option is drivers/serial/nsl16550.c driver
 
                Define this variable to enable hw flow control in serial driver.
                Current user of this option is drivers/serial/nsl16550.c driver
 

-- Serial Download Echo Mode:
-               CONFIG_LOADS_ECHO
-               If defined to 1, all characters received during a
-               serial download (using the "loads" command) are
-               echoed back. This might be needed by some terminal
-               emulations (like "cu"), but may as well just take
-               time on others. This setting #define's the initial
-               value of the "loads_echo" environment variable.
-

 - Removal of commands
                If no commands are needed to boot, you can disable
                CONFIG_CMDLINE to remove them. In this case, the command line
 - Removal of commands
                If no commands are needed to boot, you can disable
                CONFIG_CMDLINE to remove them. In this case, the command line


@@ -678,20 +554,6 @@ The following options need to be configured:
                        CONFIG_LAN91C96_USE_32_BIT
                        Define this to enable 32 bit addressing
 
                        CONFIG_LAN91C96_USE_32_BIT
                        Define this to enable 32 bit addressing
 

-               CONFIG_SMC91111
-               Support for SMSC's LAN91C111 chip
-
-                       CONFIG_SMC91111_BASE
-                       Define this to hold the physical address
-                       of the device (I/O space)
-
-                       CONFIG_SMC_USE_32_BIT
-                       Define this if data bus is 32 bits
-
-                       CONFIG_SMC_USE_IOFUNCS
-                       Define this to use i/o functions instead of macros
-                       (some hardware wont work with macros)
-

                        CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
                        Define this if you have more then 3 PHYs.
 
                        CONFIG_SYS_DAVINCI_EMAC_PHY_COUNT
                        Define this if you have more then 3 PHYs.
 


@@ -891,88 +753,9 @@ The following options need to be configured:
                entering dfuMANIFEST state. Host waits this timeout, before
                sending again an USB request to the device.
 
                entering dfuMANIFEST state. Host waits this timeout, before
                sending again an USB request to the device.
 

-- Journaling Flash filesystem support:
-               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
-

 - Keyboard Support:
                See Kconfig help for available keyboard drivers.
 
 - Keyboard Support:
                See Kconfig help for available keyboard drivers.
 

-- LCD Support: CONFIG_LCD
-
-               Define this to enable LCD support (for output to LCD
-               display); also select one of the supported displays
-               by defining one of these:
-
-               CONFIG_NEC_NL6448AC33:
-
-                       NEC NL6448AC33-18. Active, color, single scan.
-
-               CONFIG_NEC_NL6448BC20
-
-                       NEC NL6448BC20-08. 6.5", 640x480.
-                       Active, color, single scan.
-
-               CONFIG_NEC_NL6448BC33_54
-
-                       NEC NL6448BC33-54. 10.4", 640x480.
-                       Active, color, single scan.
-
-               CONFIG_SHARP_16x9
-
-                       Sharp 320x240. Active, color, single scan.
-                       It isn't 16x9, and I am not sure what it is.
-
-               CONFIG_SHARP_LQ64D341
-
-                       Sharp LQ64D341 display, 640x480.
-                       Active, color, single scan.
-
-               CONFIG_HLD1045
-
-                       HLD1045 display, 640x480.
-                       Active, color, single scan.
-
-               CONFIG_OPTREX_BW
-
-                       Optrex   CBL50840-2 NF-FW 99 22 M5
-                       or
-                       Hitachi  LMG6912RPFC-00T
-                       or
-                       Hitachi  SP14Q002
-
-                       320x240. Black & white.
-
-               CONFIG_LCD_ALIGNMENT
-
-               Normally the LCD is page-aligned (typically 4KB). If this is
-               defined then the LCD will be aligned to this value instead.
-               For ARM it is sometimes useful to use MMU_SECTION_SIZE
-               here, since it is cheaper to change data cache settings on
-               a per-section basis.
-
-
-               CONFIG_LCD_ROTATION
-
-               Sometimes, for example if the display is mounted in portrait
-               mode or even if it's mounted landscape but rotated by 180degree,
-               we need to rotate our content of the display relative to the
-               framebuffer, so that user can read the messages which are
-               printed out.
-               Once CONFIG_LCD_ROTATION is defined, the lcd_console will be
-               initialized with a given rotation from "vl_rot" out of
-               "vidinfo_t" which is provided by the board specific code.
-               The value for vl_rot is coded as following (matching to
-               fbcon=rotate:<n> linux-kernel commandline):
-               0 = no rotation respectively 0 degree
-               1 = 90 degree rotation
-               2 = 180 degree rotation
-               3 = 270 degree rotation
-
-               If CONFIG_LCD_ROTATION is not defined, the console will be
-               initialized with 0degree rotation.
-

 - MII/PHY support:
                CONFIG_PHY_CLOCK_FREQ (ppc4xx)
 
 - MII/PHY support:
                CONFIG_PHY_CLOCK_FREQ (ppc4xx)
 


@@ -1255,17 +1038,6 @@ The following options need to be configured:
                You should define these to the GPIO value as given directly to
                the generic GPIO functions.
 
                You should define these to the GPIO value as given directly to
                the generic GPIO functions.
 

-               CONFIG_SYS_I2C_INIT_BOARD
-
-               When a board is reset during an i2c bus transfer
-               chips might think that the current transfer is still
-               in progress. On some boards it is possible to access
-               the i2c SCLK line directly, either by using the
-               processor pin as a GPIO or by having a second pin
-               connected to the bus. If this option is defined a
-               custom i2c_init_board() routine in boards/xxx/board.c
-               is run early in the boot sequence.
-

                CONFIG_I2C_MULTI_BUS
 
                This option allows the use of multiple I2C buses, each of which
                CONFIG_I2C_MULTI_BUS
 
                This option allows the use of multiple I2C buses, each of which


@@ -1674,21 +1446,12 @@ Configuration Settings:
                the RAM base is not zero, or RAM is divided into banks,
                this variable needs to be recalcuated to get the address.
 
                the RAM base is not zero, or RAM is divided into banks,
                this variable needs to be recalcuated to get the address.
 

-- CONFIG_SYS_LOADS_BAUD_CHANGE:
-               Enable temporary baudrate change while serial download
-

 - CONFIG_SYS_SDRAM_BASE:
                Physical start address of SDRAM. _Must_ be 0 here.
 
 - CONFIG_SYS_FLASH_BASE:
                Physical start address of Flash memory.
 
 - CONFIG_SYS_SDRAM_BASE:
                Physical start address of SDRAM. _Must_ be 0 here.
 
 - CONFIG_SYS_FLASH_BASE:
                Physical start address of Flash memory.
 

-- CONFIG_SYS_MONITOR_LEN:
-               Size of memory reserved for monitor code, used to
-               determine _at_compile_time_ (!) if the environment is
-               embedded within the U-Boot image, or in a separate
-               flash sector.
-

 - CONFIG_SYS_MALLOC_LEN:
                Size of DRAM reserved for malloc() use.
 
 - CONFIG_SYS_MALLOC_LEN:
                Size of DRAM reserved for malloc() use.
 


@@ -1710,25 +1473,6 @@ Configuration Settings:
                boards which do not use the full malloc in SPL (which is
                enabled with CONFIG_SYS_SPL_MALLOC).
 
                boards which do not use the full malloc in SPL (which is
                enabled with CONFIG_SYS_SPL_MALLOC).
 

-- CONFIG_SYS_NONCACHED_MEMORY:
-               Size of non-cached memory area. This area of memory will be
-               typically located right below the malloc() area and mapped
-               uncached in the MMU. This is useful for drivers that would
-               otherwise require a lot of explicit cache maintenance. For
-               some drivers it's also impossible to properly maintain the
-               cache. For example if the regions that need to be flushed
-               are not a multiple of the cache-line size, *and* padding
-               cannot be allocated between the regions to align them (i.e.
-               if the HW requires a contiguous array of regions, and the
-               size of each region is not cache-aligned), then a flush of
-               one region may result in overwriting data that hardware has
-               written to another region in the same cache-line. This can
-               happen for example in network drivers where descriptors for
-               buffers are typically smaller than the CPU cache-line (e.g.
-               16 bytes vs. 32 or 64 bytes).
-
-               Non-cached memory is only supported on 32-bit ARM at present.
-

 - CONFIG_SYS_BOOTMAPSZ:
                Maximum size of memory mapped by the startup code of
                the Linux kernel; all data that must be processed by
 - CONFIG_SYS_BOOTMAPSZ:
                Maximum size of memory mapped by the startup code of
                the Linux kernel; all data that must be processed by


@@ -1749,38 +1493,10 @@ Configuration Settings:
                Enables allocating and saving a kernel copy of the bd_info in
                space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
 
                Enables allocating and saving a kernel copy of the bd_info in
                space between "bootm_low" and "bootm_low" + BOOTMAPSZ.
 

-- CONFIG_SYS_MAX_FLASH_SECT:
-               Max number of sectors on a Flash chip
-
-- CONFIG_SYS_FLASH_ERASE_TOUT:
-               Timeout for Flash erase operations (in ms)
-
-- CONFIG_SYS_FLASH_WRITE_TOUT:
-               Timeout for Flash write operations (in ms)
-
-- CONFIG_SYS_FLASH_LOCK_TOUT
-               Timeout for Flash set sector lock bit operation (in ms)
-
-- CONFIG_SYS_FLASH_UNLOCK_TOUT
-               Timeout for Flash clear lock bits operation (in ms)
-

 - CONFIG_SYS_FLASH_PROTECTION
                If defined, hardware flash sectors protection is used
                instead of U-Boot software protection.
 
 - CONFIG_SYS_FLASH_PROTECTION
                If defined, hardware flash sectors protection is used
                instead of U-Boot software protection.
 

-- CONFIG_SYS_DIRECT_FLASH_TFTP:
-
-               Enable TFTP transfers directly to flash memory;
-               without this option such a download has to be
-               performed in two steps: (1) download to RAM, and (2)
-               copy from RAM to flash.
-
-               The two-step approach is usually more reliable, since
-               you can check if the download worked before you erase
-               the flash, but in some situations (when system RAM is
-               too limited to allow for a temporary copy of the
-               downloaded image) this option may be very useful.
-

 - CONFIG_SYS_FLASH_CFI:
                Define if the flash driver uses extra elements in the
                common flash structure for storing flash geometry.
 - CONFIG_SYS_FLASH_CFI:
                Define if the flash driver uses extra elements in the
                common flash structure for storing flash geometry.


@@ -1801,12 +1517,6 @@ Configuration Settings:
                s29ws-n MirrorBit flash has non-standard addresses for buffered
                write commands.
 
                s29ws-n MirrorBit flash has non-standard addresses for buffered
                write commands.
 

-- CONFIG_SYS_FLASH_QUIET_TEST
-               If this option is defined, the common CFI flash doesn't
-               print it's warning upon not recognized FLASH banks. This
-               is useful, if some of the configured banks are only
-               optionally available.
-

 - CONFIG_FLASH_SHOW_PROGRESS
                If defined (must be an integer), print out countdown
                digits and dots.  Recommended value: 45 (9..1) for 80
 - CONFIG_FLASH_SHOW_PROGRESS
                If defined (must be an integer), print out countdown
                digits and dots.  Recommended value: 45 (9..1) for 80


@@ -1988,9 +1698,6 @@ Low Level (hardware related) configuration options:
 - CONFIG_SYS_OR_TIMING_SDRAM:
                SDRAM timing
 
 - CONFIG_SYS_OR_TIMING_SDRAM:
                SDRAM timing
 

-- CONFIG_SYS_MAMR_PTA:
-               periodic timer for refresh
-

 - CONFIG_SYS_SRIO:
                Chip has SRIO or not
 
 - CONFIG_SYS_SRIO:
                Chip has SRIO or not