Skip to content
Snippets Groups Projects
README 205 KiB
Newer Older
  • Learn to ignore specific revisions
  • 		    CONFIG_SYS_I2C_SOFT_SPEED_4 and CONFIG_SYS_I2C_SOFT_SLAVE_4
    		    for defining speed and slave address
    
    		- drivers/i2c/fsl_i2c.c:
    		  - activate i2c driver with CONFIG_SYS_I2C_FSL
    		    define CONFIG_SYS_FSL_I2C_OFFSET for setting the register
    		    offset CONFIG_SYS_FSL_I2C_SPEED for the i2c speed and
    		    CONFIG_SYS_FSL_I2C_SLAVE for the slave addr of the first
    		    bus.
    
    		  - If your board supports a second fsl i2c bus, define
    
    		    CONFIG_SYS_FSL_I2C2_OFFSET for the register offset
    		    CONFIG_SYS_FSL_I2C2_SPEED for the speed and
    		    CONFIG_SYS_FSL_I2C2_SLAVE for the slave address of the
    		    second bus.
    
    
    		- drivers/i2c/tegra_i2c.c:
    
    		  - activate this driver with CONFIG_SYS_I2C_TEGRA
    		  - This driver adds 4 i2c buses with a fix speed from
    		    100000 and the slave addr 0!
    
    		- drivers/i2c/ppc4xx_i2c.c
    		  - activate this driver with CONFIG_SYS_I2C_PPC4XX
    		  - CONFIG_SYS_I2C_PPC4XX_CH0 activate hardware channel 0
    		  - CONFIG_SYS_I2C_PPC4XX_CH1 activate hardware channel 1
    
    
    trem's avatar
    trem committed
    		- drivers/i2c/i2c_mxc.c
    		  - activate this driver with CONFIG_SYS_I2C_MXC
    		  - define speed for bus 1 with CONFIG_SYS_MXC_I2C1_SPEED
    		  - define slave for bus 1 with CONFIG_SYS_MXC_I2C1_SLAVE
    		  - define speed for bus 2 with CONFIG_SYS_MXC_I2C2_SPEED
    		  - define slave for bus 2 with CONFIG_SYS_MXC_I2C2_SLAVE
    		  - define speed for bus 3 with CONFIG_SYS_MXC_I2C3_SPEED
    		  - define slave for bus 3 with CONFIG_SYS_MXC_I2C3_SLAVE
    		If thoses defines are not set, default value is 100000
    		for speed, and 0 for slave.
    
    
    		- drivers/i2c/rcar_i2c.c:
    		  - activate this driver with CONFIG_SYS_I2C_RCAR
    		  - This driver adds 4 i2c buses
    
    		  - CONFIG_SYS_RCAR_I2C0_BASE for setting the register channel 0
    		  - CONFIG_SYS_RCAR_I2C0_SPEED for for the speed channel 0
    		  - CONFIG_SYS_RCAR_I2C1_BASE for setting the register channel 1
    		  - CONFIG_SYS_RCAR_I2C1_SPEED for for the speed channel 1
    		  - CONFIG_SYS_RCAR_I2C2_BASE for setting the register channel 2
    		  - CONFIG_SYS_RCAR_I2C2_SPEED for for the speed channel 2
    		  - CONFIG_SYS_RCAR_I2C3_BASE for setting the register channel 3
    		  - CONFIG_SYS_RCAR_I2C3_SPEED for for the speed channel 3
    		  - CONFIF_SYS_RCAR_I2C_NUM_CONTROLLERS for number of i2c buses
    
    
    		- drivers/i2c/sh_i2c.c:
    		  - activate this driver with CONFIG_SYS_I2C_SH
    		  - This driver adds from 2 to 5 i2c buses
    
    		  - CONFIG_SYS_I2C_SH_BASE0 for setting the register channel 0
    		  - CONFIG_SYS_I2C_SH_SPEED0 for for the speed channel 0
    		  - CONFIG_SYS_I2C_SH_BASE1 for setting the register channel 1
    		  - CONFIG_SYS_I2C_SH_SPEED1 for for the speed channel 1
    		  - CONFIG_SYS_I2C_SH_BASE2 for setting the register channel 2
    		  - CONFIG_SYS_I2C_SH_SPEED2 for for the speed channel 2
    		  - CONFIG_SYS_I2C_SH_BASE3 for setting the register channel 3
    		  - 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
    		  - CONFIF_SYS_I2C_SH_NUM_CONTROLLERS for nummber of i2c buses
    
    
    		- drivers/i2c/omap24xx_i2c.c
    		  - activate this driver with CONFIG_SYS_I2C_OMAP24XX
    		  - CONFIG_SYS_OMAP24_I2C_SPEED speed channel 0
    		  - CONFIG_SYS_OMAP24_I2C_SLAVE slave addr channel 0
    		  - CONFIG_SYS_OMAP24_I2C_SPEED1 speed channel 1
    		  - CONFIG_SYS_OMAP24_I2C_SLAVE1 slave addr channel 1
    		  - CONFIG_SYS_OMAP24_I2C_SPEED2 speed channel 2
    		  - CONFIG_SYS_OMAP24_I2C_SLAVE2 slave addr channel 2
    		  - CONFIG_SYS_OMAP24_I2C_SPEED3 speed channel 3
    		  - CONFIG_SYS_OMAP24_I2C_SLAVE3 slave addr channel 3
    		  - CONFIG_SYS_OMAP24_I2C_SPEED4 speed channel 4
    		  - CONFIG_SYS_OMAP24_I2C_SLAVE4 slave addr channel 4
    
    
    		- drivers/i2c/zynq_i2c.c
    		  - activate this driver with CONFIG_SYS_I2C_ZYNQ
    		  - set CONFIG_SYS_I2C_ZYNQ_SPEED for speed setting
    		  - set CONFIG_SYS_I2C_ZYNQ_SLAVE for slave addr
    
    
    		additional defines:
    
    		CONFIG_SYS_NUM_I2C_BUSES
    		Hold the number of i2c busses 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.
    
    		CONFIG_SYS_I2C_DIRECT_BUS
    		define this, if you don't use i2c muxes on your hardware.
    		if CONFIG_SYS_I2C_MAX_HOPS is not defined or == 0 you can
    		omit this define.
    
    		CONFIG_SYS_I2C_MAX_HOPS
    		define how many muxes are maximal consecutively connected
    		on one i2c bus. If you not use i2c muxes, omit this
    		define.
    
    		CONFIG_SYS_I2C_BUSES
    		hold a list of busses you want to use, only used if
    		CONFIG_SYS_I2C_DIRECT_BUS is not defined, for example
    		a board with CONFIG_SYS_I2C_MAX_HOPS = 1 and
    		CONFIG_SYS_NUM_I2C_BUSES = 9:
    
    		 CONFIG_SYS_I2C_BUSES	{{0, {I2C_NULL_HOP}}, \
    					{0, {{I2C_MUX_PCA9547, 0x70, 1}}}, \
    					{0, {{I2C_MUX_PCA9547, 0x70, 2}}}, \
    					{0, {{I2C_MUX_PCA9547, 0x70, 3}}}, \
    					{0, {{I2C_MUX_PCA9547, 0x70, 4}}}, \
    					{0, {{I2C_MUX_PCA9547, 0x70, 5}}}, \
    					{1, {I2C_NULL_HOP}}, \
    					{1, {{I2C_MUX_PCA9544, 0x72, 1}}}, \
    					{1, {{I2C_MUX_PCA9544, 0x72, 2}}}, \
    					}
    
    		which defines
    			bus 0 on adapter 0 without a mux
    
    			bus 1 on adapter 0 with a PCA9547 on address 0x70 port 1
    			bus 2 on adapter 0 with a PCA9547 on address 0x70 port 2
    			bus 3 on adapter 0 with a PCA9547 on address 0x70 port 3
    			bus 4 on adapter 0 with a PCA9547 on address 0x70 port 4
    			bus 5 on adapter 0 with a PCA9547 on address 0x70 port 5
    
    			bus 6 on adapter 1 without a mux
    
    			bus 7 on adapter 1 with a PCA9544 on address 0x72 port 1
    			bus 8 on adapter 1 with a PCA9544 on address 0x72 port 2
    
    
    		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.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		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.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_HARD_I2C selects a hardware I2C controller.
    
    		There are several other quantities that must also be
    
    		defined when you define CONFIG_HARD_I2C.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		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.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		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.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		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):
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		I2C_INIT
    
    
    		(Optional). Any commands necessary to enable the I2C
    
    		controller or configure ports.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=	PB_SCL)
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		I2C_PORT
    
    
    		(Only for MPC8260 CPU). The I/O port to use (the code
    		assumes both bits are on the same port). Valid values
    		are 0..3 for ports A..D.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		I2C_ACTIVE
    
    		The code necessary to make the I2C data line active
    		(driven).  If the data line is open collector, this
    		define can be null.
    
    
    		eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		I2C_TRISTATE
    
    		The code necessary to make the I2C data line tri-stated
    		(inactive).  If the data line is open collector, this
    		define can be null.
    
    
    		eg: #define I2C_TRISTATE (immr->im_cpm.cp_pbdir &= ~PB_SDA)
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		I2C_READ
    
    
    York Sun's avatar
    York Sun committed
    		Code that returns true if the I2C data line is high,
    		false if it is low.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		I2C_SDA(bit)
    
    
    York Sun's avatar
    York Sun committed
    		If <bit> is true, sets the I2C data line high. If it
    		is false, it clears it (low).
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		eg: #define I2C_SDA(bit) \
    
    			if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
    
    			else	immr->im_cpm.cp_pbdat &= ~PB_SDA
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		I2C_SCL(bit)
    
    
    York Sun's avatar
    York Sun committed
    		If <bit> is true, sets the I2C clock line high. If it
    		is false, it clears it (low).
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		eg: #define I2C_SCL(bit) \
    
    			if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
    
    			else	immr->im_cpm.cp_pbdat &= ~PB_SCL
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		I2C_DELAY
    
    		This delay is invoked four times per clock cycle so this
    		controls the rate of data transfer.  The data rate thus
    
    		is 1 / (I2C_DELAY * 4). Often defined to be something
    
    		#define I2C_DELAY  udelay(2)
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_SOFT_I2C_GPIO_SCL / CONFIG_SOFT_I2C_GPIO_SDA
    
    		If your arch supports the generic GPIO framework (asm/gpio.h),
    		then you may alternatively define the two GPIOs that are to be
    		used as SCL / SDA.  Any of the previous I2C_xxx macros will
    		have GPIO-based defaults assigned to them as appropriate.
    
    		You should define these to the GPIO value as given directly to
    		the generic GPIO functions.
    
    
    		CONFIG_SYS_I2C_INIT_BOARD
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		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_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
    
    		must have a controller.	 At any point in time, only one bus is
    		active.	 To switch to a different bus, use the 'i2c dev' command.
    
    		Note that bus numbering is zero-based.
    
    
    		CONFIG_SYS_I2C_NOPROBES
    
    
    		This option specifies a list of I2C devices that will be skipped
    
    		when the 'i2c probe' command is issued.	 If CONFIG_I2C_MULTI_BUS
    
    		is set, specify a list of bus-device pairs.  Otherwise, specify
    		a 1D array of device addresses
    
    
    		e.g.
    			#undef	CONFIG_I2C_MULTI_BUS
    
    			#define CONFIG_SYS_I2C_NOPROBES {0x50,0x68}
    
    
    		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}}
    
    
    		will skip addresses 0x50 and 0x68 on bus 0 and address 0x54 on bus 1
    
    
    		CONFIG_SYS_SPD_BUS_NUM
    
    
    		If defined, then this indicates the I2C bus number for DDR SPD.
    		If not defined, then U-Boot assumes that SPD is on I2C bus 0.
    
    
    		CONFIG_SYS_RTC_BUS_NUM
    
    
    		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
    		the soft_i2c driver to perform an I2C repeated start
    		between writing the address pointer and reading the
    		data.  If this define is omitted the default behaviour
    		of doing a stop-start sequence will be used.  Most I2C
    		devices can use either method, but some require one or
    		the other.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    - SPI Support:	CONFIG_SPI
    
    		Enables SPI driver (so far only tested with
    		SPI EEPROM, also an instance works with Crystal A/D and
    		D/As on the SACSng board)
    
    
    		CONFIG_SH_SPI
    
    		Enables the driver for SPI controller on SuperH. Currently
    		only SH7757 is supported.
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		CONFIG_SPI_X
    
    		Enables extended (16-bit) SPI EEPROM addressing.
    		(symmetrical to CONFIG_I2C_X)
    
    		CONFIG_SOFT_SPI
    
    
    		Enables a software (bit-bang) SPI driver rather than
    		using hardware support. This is a general purpose
    		driver that only requires three general I/O port pins
    		(two outputs, one input) to function. If this is
    		defined, the board configuration must define several
    		SPI configuration items (port pins to use, etc). For
    		an example, see include/configs/sacsng.h.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_HARD_SPI
    
    		Enables a hardware SPI driver for general-purpose reads
    		and writes.  As with CONFIG_SOFT_SPI, the board configuration
    		must define a list of chip-select function pointers.
    
    		Currently supported on some MPC8xxx processors.	 For an
    
    		example, see include/configs/mpc8349emds.h.
    
    
    		CONFIG_MXC_SPI
    
    		Enables the driver for the SPI controllers on i.MX and MXC
    
    		SoCs. Currently i.MX31/35/51 are supported.
    
    - FPGA Support: CONFIG_FPGA
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Enables FPGA subsystem.
    
    		CONFIG_FPGA_<vendor>
    
    		Enables support for specific chip vendors.
    		(ALTERA, XILINX)
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_FPGA_<family>
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Enables support for FPGA family.
    		(SPARTAN2, SPARTAN3, VIRTEX2, CYCLONE2, ACEX1K, ACEX)
    
    		CONFIG_FPGA_COUNT
    
    		Specify the number of FPGA devices to support.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_SYS_FPGA_PROG_FEEDBACK
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		Enable printing of hash marks during FPGA configuration.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_SYS_FPGA_CHECK_BUSY
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Enable checks on FPGA configuration interface busy
    		status by the configuration function. This option
    		will require a board or device specific function to
    		be written.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		CONFIG_FPGA_DELAY
    
    		If defined, a function that provides delays in the FPGA
    		configuration driver.
    
    
    		CONFIG_SYS_FPGA_CHECK_CTRLC
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		Allow Control-C to interrupt FPGA configuration
    
    
    		CONFIG_SYS_FPGA_CHECK_ERROR
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Check for configuration errors during FPGA bitfile
    		loading. For example, abort during Virtex II
    		configuration if the INIT_B line goes low (which
    		indicated a CRC error).
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_SYS_FPGA_WAIT_INIT
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Maximum time to wait for the INIT_B line to deassert
    		after PROB_B has been deasserted during a Virtex II
    		FPGA configuration sequence. The default time is 500
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_SYS_FPGA_WAIT_BUSY
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Maximum time to wait for BUSY to deassert during
    
    		Virtex II FPGA configuration. The default is 5 ms.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_SYS_FPGA_WAIT_CONFIG
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Time to wait after FPGA configuration. The default is
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    - Configuration Management:
    		CONFIG_IDENT_STRING
    
    
    		If defined, this string will be added to the U-Boot
    		version information (U_BOOT_VERSION)
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    - Vendor Parameter Protection:
    
    
    		U-Boot considers the values of the environment
    		variables "serial#" (Board Serial Number) and
    
    		"ethaddr" (Ethernet Address) to be parameters that
    
    		are set once by the board vendor / manufacturer, and
    		protects these variables from casual modification by
    		the user. Once set, these variables are read-only,
    		and write or delete attempts are rejected. You can
    
    		change this behaviour:
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		If CONFIG_ENV_OVERWRITE is #defined in your config
    		file, the write protection for vendor parameters is
    
    		completely disabled. Anybody can change or delete
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		these parameters.
    
    		Alternatively, if you #define _both_ CONFIG_ETHADDR
    		_and_ CONFIG_OVERWRITE_ETHADDR_ONCE, a default
    
    		Ethernet address is installed in the environment,
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		which can be changed exactly ONCE by the user. [The
    		serial# is unaffected by this, i. e. it remains
    		read-only.]
    
    
    		The same can be accomplished in a more flexible way
    		for any variable by configuring the type of access
    		to allow for those variables in the ".flags" variable
    		or define CONFIG_ENV_FLAGS_LIST_STATIC.
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    - Protected RAM:
    		CONFIG_PRAM
    
    		Define this variable to enable the reservation of
    		"protected RAM", i. e. RAM which is not overwritten
    		by U-Boot. Define CONFIG_PRAM to hold the number of
    		kB you want to reserve for pRAM. You can overwrite
    		this default value by defining an environment
    		variable "pram" to the number of kB you want to
    		reserve. Note that the board info structure will
    		still show the full amount of RAM. If pRAM is
    		reserved, a new environment variable "mem" will
    		automatically be defined to hold the amount of
    		remaining RAM in a form that can be passed as boot
    		argument to Linux, for instance like that:
    
    
    			setenv bootargs ... mem=\${mem}
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    			saveenv
    
    		This way you can tell Linux not to use this memory,
    		either, which results in a memory region that will
    		not be affected by reboots.
    
    		*WARNING* If your board configuration uses automatic
    		detection of the RAM size, you must make sure that
    		this memory test is non-destructive. So far, the
    		following board configurations are known to be
    		"pRAM-clean":
    
    
    			IVMS8, IVML24, SPD8xx, TQM8xxL,
    			HERMES, IP860, RPXlite, LWMON,
    
    			FLAGADM, TQM8260
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    - Access to physical memory region (> 4GB)
    		Some basic support is provided for operations on memory not
    		normally accessible to U-Boot - e.g. some architectures
    		support access to more than 4GB of memory on 32-bit
    		machines using physical address extension or similar.
    		Define CONFIG_PHYSMEM to access this basic support, which
    		currently only supports clearing the memory.
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    - Error Recovery:
    		CONFIG_PANIC_HANG
    
    		Define this variable to stop the system in case of a
    		fatal error, so that you have to reset it manually.
    		This is probably NOT a good idea for an embedded
    
    		system where you want the system to reboot
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		automatically as fast as possible, but it may be
    		useful during development since you can try to debug
    		the conditions that lead to the situation.
    
    		CONFIG_NET_RETRY_COUNT
    
    
    		This variable defines the number of retries for
    		network operations like ARP, RARP, TFTP, or BOOTP
    		before giving up the operation. If not defined, a
    		default value of 5 is used.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_ARP_TIMEOUT
    
    		Timeout waiting for an ARP reply in milliseconds.
    
    
    		CONFIG_NFS_TIMEOUT
    
    		Timeout in milliseconds used in NFS protocol.
    		If you encounter "ERROR: Cannot umount" in nfs command,
    		try longer timeout such as
    		#define CONFIG_NFS_TIMEOUT 10000UL
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    - Command Interpreter:
    
    
    		Enable auto completion of commands using TAB.
    
    
    		Note that this feature has NOT been implemented yet
    		for the "hush" shell.
    
    		CONFIG_SYS_HUSH_PARSER
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		Define this variable to enable the "hush" shell (from
    		Busybox) as command line interpreter, thus enabling
    		powerful command line syntax like
    		if...then...else...fi conditionals or `&&' and '||'
    		constructs ("shell scripts").
    
    		If undefined, you get the old, much simpler behaviour
    		with a somewhat smaller memory footprint.
    
    
    
    		CONFIG_SYS_PROMPT_HUSH_PS2
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		This defines the secondary prompt string, which is
    		printed when the command interpreter needs more input
    		to complete a command. Usually "> ".
    
    	Note:
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		In the current implementation, the local variables
    		space and global environment variables space are
    		separated. Local variables are those you define by
    		simply typing `name=value'. To access a local
    		variable later on, you have write `$name' or
    		`${name}'; to execute the contents of a variable
    		directly type `$name' at the command prompt.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		Global environment variables are those you use
    		setenv/printenv to work with. To run a command stored
    		in such a variable, you need to use the run command,
    		and you must not use the '$' sign to access them.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		To store commands and special characters in a
    		variable, please use double quotation marks
    		surrounding the whole text of the variable, instead
    		of the backslashes before semicolons and special
    		symbols.
    
    
    - Commandline Editing and History:
    		CONFIG_CMDLINE_EDITING
    
    
    		Enable editing and History functions for interactive
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		commandline input operations
    
    - Default Environment:
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		CONFIG_EXTRA_ENV_SETTINGS
    
    
    		Define this to contain any number of null terminated
    		strings (variable = value pairs) that will be part of
    
    		the default environment compiled into the boot image.
    
    		For example, place something like this in your
    		board's config file:
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		#define CONFIG_EXTRA_ENV_SETTINGS \
    			"myvar1=value1\0" \
    			"myvar2=value2\0"
    
    
    		Warning: This method is based on knowledge about the
    		internal format how the environment is stored by the
    		U-Boot code. This is NOT an official, exported
    		interface! Although it is unlikely that this format
    
    		will change soon, there is no guarantee either.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		You better know what you are doing here.
    
    
    		Note: overly (ab)use of the default environment is
    		discouraged. Make sure to check other ways to preset
    
    		the environment like the "source" command or the
    
    		boot command first.
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    		CONFIG_ENV_VARS_UBOOT_CONFIG
    
    		Define this in order to add variables describing the
    		U-Boot build configuration to the default environment.
    		These will be named arch, cpu, board, vendor, and soc.
    
    		Enabling this option will cause the following to be defined:
    
    		- CONFIG_SYS_ARCH
    		- CONFIG_SYS_CPU
    		- CONFIG_SYS_BOARD
    		- CONFIG_SYS_VENDOR
    		- CONFIG_SYS_SOC
    
    
    		CONFIG_ENV_VARS_UBOOT_RUNTIME_CONFIG
    
    		Define this in order to add variables describing certain
    		run-time determined information about the hardware to the
    		environment.  These will be named board_name, board_rev.
    
    
    		CONFIG_DELAY_ENVIRONMENT
    
    		Normally the environment is loaded when the board is
    		intialised so that it is available to U-Boot. This inhibits
    		that so that the environment is not available until
    		explicitly loaded later by U-Boot code. With CONFIG_OF_CONTROL
    		this is instead controlled by the value of
    		/config/load-environment.
    
    
    - DataFlash Support:
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		Defining this option enables DataFlash features and
    		allows to read/write in Dataflash via the standard
    		commands cp, md...
    
    - Serial Flash support
    		CONFIG_CMD_SF
    
    		Defining this option enables SPI flash commands
    		'sf probe/read/write/erase/update'.
    
    		Usage requires an initial 'probe' to define the serial
    		flash parameters, followed by read/write/erase/update
    		commands.
    
    		The following defaults may be provided by the platform
    		to handle the common case when only a single serial
    		flash is present on the system.
    
    		CONFIG_SF_DEFAULT_BUS		Bus identifier
    		CONFIG_SF_DEFAULT_CS		Chip-select
    		CONFIG_SF_DEFAULT_MODE 		(see include/spi.h)
    		CONFIG_SF_DEFAULT_SPEED		in Hz
    
    
    Simon Glass's avatar
    Simon Glass committed
    		CONFIG_CMD_SF_TEST
    
    		Define this option to include a destructive SPI flash
    		test ('sf test').
    
    
    		CONFIG_SPI_FLASH_BAR		Ban/Extended Addr Reg
    
    		Define this option to use the Bank addr/Extended addr
    		support on SPI flashes which has size > 16Mbytes.
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    - SystemACE Support:
    		CONFIG_SYSTEMACE
    
    		Adding this option adds support for Xilinx SystemACE
    		chips attached via some sort of local bus. The address
    
    		of the chip must also be defined in the
    
    		CONFIG_SYS_SYSTEMACE_BASE macro. For example:
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		#define CONFIG_SYSTEMACE
    
    		#define CONFIG_SYS_SYSTEMACE_BASE 0xf0000000
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    		When SystemACE support is added, the "ace" device type
    		becomes available to the fat commands, i.e. fatls.
    
    
    - TFTP Fixed UDP Port:
    		CONFIG_TFTP_PORT
    
    
    		If this is defined, the environment variable tftpsrcp
    
    		is used to supply the TFTP UDP source port value.
    
    		If tftpsrcp isn't defined, the normal pseudo-random port
    
    		number generator is used.
    
    
    		Also, the environment variable tftpdstp is used to supply
    		the TFTP UDP destination port value.  If tftpdstp isn't
    		defined, the normal port 69 is used.
    
    		The purpose for tftpsrcp is to allow a TFTP server to
    
    		blindly start the TFTP transfer using the pre-configured
    		target IP address and UDP port. This has the effect of
    		"punching through" the (Windows XP) firewall, allowing
    		the remainder of the TFTP transfer to proceed normally.
    		A better solution is to properly configure the firewall,
    		but sometimes that is not allowed.
    
    
    - Hashing support:
    		CONFIG_CMD_HASH
    
    		This enables a generic 'hash' command which can produce
    		hashes / digests from a few algorithms (e.g. SHA1, SHA256).
    
    		CONFIG_HASH_VERIFY
    
    		Enable the hash verify command (hash -v). This adds to code
    		size a little.
    
    		CONFIG_SHA1 - support SHA1 hashing
    		CONFIG_SHA256 - support SHA256 hashing
    
    		Note: There is also a sha1sum command, which should perhaps
    		be deprecated in favour of 'hash sha1'.
    
    
    - Freescale i.MX specific commands:
    		CONFIG_CMD_HDMIDETECT
    		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.
    
    
    - Signing support:
    		CONFIG_RSA
    
    		This enables the RSA algorithm used for FIT image verification
    		in U-Boot. See doc/uImage/signature for more information.
    
    		The signing part is build into mkimage regardless of this
    		option.
    
    
    
    - Show boot progress:
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    		CONFIG_SHOW_BOOT_PROGRESS
    
    
    		Defining this option allows to add some board-
    		specific code (calling a user-provided function
    		"show_boot_progress(int)") that enables you to show
    		the system's boot progress on some display (for
    		example, some LED's) on your board. At the moment,
    		the following checkpoints are implemented:
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    - Detailed boot stage timing
    		CONFIG_BOOTSTAGE
    		Define this option to get detailed timing of each stage
    		of the boot process.
    
    		CONFIG_BOOTSTAGE_USER_COUNT
    		This is the number of available user bootstage records.
    		Each time you call bootstage_mark(BOOTSTAGE_ID_ALLOC, ...)
    		a new ID will be allocated from this stash. If you exceed
    		the limit, recording will stop.
    
    		CONFIG_BOOTSTAGE_REPORT
    		Define this to print a report before boot, similar to this:
    
    		Timer summary in microseconds:
    		       Mark    Elapsed  Stage
    			  0          0  reset
    		  3,575,678  3,575,678  board_init_f start
    		  3,575,695         17  arch_cpu_init A9
    		  3,575,777         82  arch_cpu_init done
    		  3,659,598     83,821  board_init_r start
    		  3,910,375    250,777  main_loop
    		 29,916,167 26,005,792  bootm_start
    		 30,361,327    445,160  start_kernel
    
    
    		CONFIG_CMD_BOOTSTAGE
    		Add a 'bootstage' command which supports printing a report
    		and un/stashing of bootstage data.
    
    
    		CONFIG_BOOTSTAGE_FDT
    		Stash the bootstage information in the FDT. A root 'bootstage'
    		node is created with each bootstage id as a child. Each child
    		has a 'name' property and either 'mark' containing the
    		mark time in microsecond, or 'accum' containing the
    		accumulated time for that bootstage id in microseconds.
    		For example:
    
    		bootstage {
    			154 {
    				name = "board_init_f";
    				mark = <3575678>;
    			};
    			170 {
    				name = "lcd";
    				accum = <33482>;
    			};
    		};
    
    		Code in the Linux kernel can find this in /proc/devicetree.
    
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
      Arg	Where			When
        1	common/cmd_bootm.c	before attempting to boot an image
    
       -1	common/cmd_bootm.c	Image header has bad	 magic number
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
        2	common/cmd_bootm.c	Image header has correct magic number
    
       -2	common/cmd_bootm.c	Image header has bad	 checksum
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
        3	common/cmd_bootm.c	Image header has correct checksum
    
       -3	common/cmd_bootm.c	Image data   has bad	 checksum
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
        4	common/cmd_bootm.c	Image data   has correct checksum
       -4	common/cmd_bootm.c	Image is for unsupported architecture
        5	common/cmd_bootm.c	Architecture check OK
    
       -5	common/cmd_bootm.c	Wrong Image Type (not kernel, multi)
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
        6	common/cmd_bootm.c	Image Type check OK
       -6	common/cmd_bootm.c	gunzip uncompression error
       -7	common/cmd_bootm.c	Unimplemented compression type
        7	common/cmd_bootm.c	Uncompression OK
    
        8	common/cmd_bootm.c	No uncompress/copy overwrite error
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
       -9	common/cmd_bootm.c	Unsupported OS (not Linux, BSD, VxWorks, QNX)
    
    
        9	common/image.c		Start initial ramdisk verification
      -10	common/image.c		Ramdisk header has bad	   magic number
      -11	common/image.c		Ramdisk header has bad	   checksum
       10	common/image.c		Ramdisk header is OK
      -12	common/image.c		Ramdisk data   has bad	   checksum
       11	common/image.c		Ramdisk data   has correct checksum
       12	common/image.c		Ramdisk verification complete, start loading
    
      -13	common/image.c		Wrong Image Type (not PPC Linux ramdisk)
    
       13	common/image.c		Start multifile image verification
       14	common/image.c		No initial ramdisk, no multifile, continue.
    
    
       15	arch/<arch>/lib/bootm.c All preparation done, transferring control to OS
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
      -30	arch/powerpc/lib/board.c	Fatal error, hang the system
    
      -31	post/post.c		POST test failed, detected by post_output_backlog()
      -32	post/post.c		POST test failed, detected by post_run_single()
    
       34	common/cmd_doc.c	before loading a Image from a DOC device
      -35	common/cmd_doc.c	Bad usage of "doc" command
       35	common/cmd_doc.c	correct usage of "doc" command
      -36	common/cmd_doc.c	No boot device
       36	common/cmd_doc.c	correct boot device
      -37	common/cmd_doc.c	Unknown Chip ID on boot device
       37	common/cmd_doc.c	correct chip ID found, device available
      -38	common/cmd_doc.c	Read Error on boot device
       38	common/cmd_doc.c	reading Image header from DOC device OK
      -39	common/cmd_doc.c	Image header has bad magic number
       39	common/cmd_doc.c	Image header has correct magic number
      -40	common/cmd_doc.c	Error reading Image from DOC device
       40	common/cmd_doc.c	Image header has correct magic number
       41	common/cmd_ide.c	before loading a Image from a IDE device
      -42	common/cmd_ide.c	Bad usage of "ide" command
       42	common/cmd_ide.c	correct usage of "ide" command
      -43	common/cmd_ide.c	No boot device
       43	common/cmd_ide.c	boot device found
      -44	common/cmd_ide.c	Device not available
       44	common/cmd_ide.c	Device available
      -45	common/cmd_ide.c	wrong partition selected
       45	common/cmd_ide.c	partition selected
      -46	common/cmd_ide.c	Unknown partition table
       46	common/cmd_ide.c	valid partition table found
      -47	common/cmd_ide.c	Invalid partition type
       47	common/cmd_ide.c	correct partition type
      -48	common/cmd_ide.c	Error reading Image Header on boot device
       48	common/cmd_ide.c	reading Image Header from IDE device OK
      -49	common/cmd_ide.c	Image header has bad magic number
       49	common/cmd_ide.c	Image header has correct magic number
      -50	common/cmd_ide.c	Image header has bad	 checksum
       50	common/cmd_ide.c	Image header has correct checksum
      -51	common/cmd_ide.c	Error reading Image from IDE device
       51	common/cmd_ide.c	reading Image from IDE device OK
       52	common/cmd_nand.c	before loading a Image from a NAND device
      -53	common/cmd_nand.c	Bad usage of "nand" command
       53	common/cmd_nand.c	correct usage of "nand" command
      -54	common/cmd_nand.c	No boot device
       54	common/cmd_nand.c	boot device found
      -55	common/cmd_nand.c	Unknown Chip ID on boot device
       55	common/cmd_nand.c	correct chip ID found, device available
      -56	common/cmd_nand.c	Error reading Image Header on boot device
       56	common/cmd_nand.c	reading Image Header from NAND device OK
      -57	common/cmd_nand.c	Image header has bad magic number
       57	common/cmd_nand.c	Image header has correct magic number
      -58	common/cmd_nand.c	Error reading Image from NAND device
       58	common/cmd_nand.c	reading Image from NAND device OK
    
      -60	common/env_common.c	Environment has a bad CRC, using default
    
    
       64	net/eth.c		starting with Ethernet configuration.
    
      -64	net/eth.c		no Ethernet found.
       65	net/eth.c		Ethernet found.
    
      -80	common/cmd_net.c	usage wrong
       80	common/cmd_net.c	before calling NetLoop()
    
      -81	common/cmd_net.c	some error in NetLoop() occurred
    
       81	common/cmd_net.c	NetLoop() back without error
      -82	common/cmd_net.c	size == 0 (File with size 0 loaded)
       82	common/cmd_net.c	trying automatic boot
    
       83	common/cmd_net.c	running "source" command
      -83	common/cmd_net.c	some error in automatic boot or "source" command
    
       84	common/cmd_net.c	end without errors
    
    Wolfgang Denk's avatar
    Wolfgang Denk committed
    
    
    FIT uImage format:
    
      Arg	Where			When
      100	common/cmd_bootm.c	Kernel FIT Image has correct format
     -100	common/cmd_bootm.c	Kernel FIT Image has incorrect format
      101	common/cmd_bootm.c	No Kernel subimage unit name, using configuration
     -101	common/cmd_bootm.c	Can't get configuration for kernel subimage
      102	common/cmd_bootm.c	Kernel unit name specified
     -103	common/cmd_bootm.c	Can't get kernel subimage node offset
    
      103	common/cmd_bootm.c	Found configuration node
    
      104	common/cmd_bootm.c	Got kernel subimage node offset
     -104	common/cmd_bootm.c	Kernel subimage hash verification failed
      105	common/cmd_bootm.c	Kernel subimage hash verification OK
     -105	common/cmd_bootm.c	Kernel subimage is for unsupported architecture
      106	common/cmd_bootm.c	Architecture check OK
    
     -106	common/cmd_bootm.c	Kernel subimage has wrong type
      107	common/cmd_bootm.c	Kernel subimage type OK
    
     -107	common/cmd_bootm.c	Can't get kernel subimage data/size
      108	common/cmd_bootm.c	Got kernel subimage data/size
     -108	common/cmd_bootm.c	Wrong image type (not legacy, FIT)
     -109	common/cmd_bootm.c	Can't get kernel subimage type
     -110	common/cmd_bootm.c	Can't get kernel subimage comp
     -111	common/cmd_bootm.c	Can't get kernel subimage os
     -112	common/cmd_bootm.c	Can't get kernel subimage load address
     -113	common/cmd_bootm.c	Image uncompress/copy overwrite error
    
      120	common/image.c		Start initial ramdisk verification
     -120	common/image.c		Ramdisk FIT image has incorrect format
      121	common/image.c		Ramdisk FIT image has correct format
    
      122	common/image.c		No ramdisk subimage unit name, using configuration
    
     -122	common/image.c		Can't get configuration for ramdisk subimage
      123	common/image.c		Ramdisk unit name specified
     -124	common/image.c		Can't get ramdisk subimage node offset
      125	common/image.c		Got ramdisk subimage node offset
     -125	common/image.c		Ramdisk subimage hash verification failed
      126	common/image.c		Ramdisk subimage hash verification OK
     -126	common/image.c		Ramdisk subimage for unsupported architecture
      127	common/image.c		Architecture check OK
     -127	common/image.c		Can't get ramdisk subimage data/size
      128	common/image.c		Got ramdisk subimage data/size
      129	common/image.c		Can't get ramdisk load address
     -129	common/image.c		Got ramdisk load address
    
    
     -130	common/cmd_doc.c	Incorrect FIT image format
    
      131	common/cmd_doc.c	FIT image format OK
    
    
     -140	common/cmd_ide.c	Incorrect FIT image format
    
      141	common/cmd_ide.c	FIT image format OK
    
    
     -150	common/cmd_nand.c	Incorrect FIT image format
    
      151	common/cmd_nand.c	FIT image format OK
    
    
    - FIT image support:
    		CONFIG_FIT
    		Enable support for the FIT uImage format.
    
    		CONFIG_FIT_BEST_MATCH
    		When no configuration is explicitly selected, default to the
    		one whose fdt's compatibility field best matches that of
    		U-Boot itself. A match is considered "best" if it matches the
    		most specific compatibility entry of U-Boot's fdt's root node.
    		The order of entries in the configuration's fdt is ignored.
    
    
    		CONFIG_FIT_SIGNATURE
    		This option enables signature verification of FIT uImages,
    		using a hash signed and verified using RSA. See
    		doc/uImage.FIT/signature.txt for more details.
    
    
    - Standalone program support:
    		CONFIG_STANDALONE_LOAD_ADDR
    
    
    		This option defines a board specific value for the
    		address where standalone program gets loaded, thus