]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - README
* Allow crc32 to be used at address 0x000
[karo-tx-uboot.git] / README
diff --git a/README b/README
index 668c4e0bfd4ab0a3ffa740f26dd95ff13575216a..1c40711837cc9339cae6dd572eed0974fcc29b52 100644 (file)
--- a/README
+++ b/README
@@ -140,12 +140,14 @@ Directory Hierarchy:
 - tools                Tools to build S-Record or U-Boot images, etc.
 
 - cpu/74xx_7xx Files specific to Motorola MPC74xx and 7xx CPUs
+- cpu/arm925t  Files specific to ARM      925     CPUs
 - cpu/mpc5xx   Files specific to Motorola MPC5xx  CPUs
 - cpu/mpc8xx   Files specific to Motorola MPC8xx  CPUs
 - cpu/mpc824x  Files specific to Motorola MPC824x CPUs
 - cpu/mpc8260  Files specific to Motorola MPC8260 CPU
 - cpu/ppc4xx   Files specific to IBM      4xx     CPUs
 
+
 - board/LEOX/   Files specific to boards manufactured by The LEOX team
 - board/LEOX/elpt860   Files specific to ELPT860 boards
 - board/RPXClassic
@@ -195,7 +197,7 @@ Directory Hierarchy:
 - board/lwmon  Files specific to LWMON      boards
 - board/mbx8xx Files specific to MBX        boards
 - board/mpc8260ads
-               Files specific to MMPC8260ADS boards
+               Files specific to MPC8260ADS and PQ2FADS-ZU boards
 - board/mpl/   Files specific to boards manufactured by MPL
 - board/mpl/common     Common files for MPL boards
 - board/mpl/pip405     Files specific to PIP405     boards
@@ -204,6 +206,8 @@ Directory Hierarchy:
 - board/mvs1   Files specific to MVS1       boards
 - board/nx823   Files specific to NX823      boards
 - board/oxc    Files specific to OXC        boards
+- board/omap1510inn
+               Files specific to OMAP 1510 Innovator boards
 - board/pcippc2        Files specific to PCIPPC2/PCIPPC6 boards
 - board/pm826  Files specific to PM826      boards
 - board/ppmc8260
@@ -353,6 +357,7 @@ The following options need to be configured:
 
                CONFIG_HHP_CRADLE,  CONFIG_DNP1110,    CONFIG_EP7312,
                CONFIG_IMPA7,       CONFIG_LART,       CONFIG_LUBBOCK,
+               CONFIG_INNOVATOROMAP1510,
                CONFIG_SHANNON,     CONFIG_SMDK2400,   CONFIG_SMDK2410,
                CONFIG_TRAB,        CONFIG_AT91RM9200DK
 
@@ -378,6 +383,14 @@ The following options need to be configured:
                                          the lcd display every second with
                                          a "rotator" |\-/|\-/
 
+- Board flavour: (if CONFIG_MPC8260ADS is defined)
+               CONFIG_ADSTYPE
+               Possible values are:
+                       CFG_8260ADS     - original MPC8260ADS
+                       CFG_8266ADS     - MPC8266ADS (untested)
+                       CFG_PQ2FADS     - PQ2FADS-ZU
+
+
 - MPC824X Family Member (if CONFIG_MPC824X is defined)
        Define exactly one of
        CONFIG_MPC8240, CONFIG_MPC8245
@@ -653,6 +666,9 @@ The following options need to be configured:
                CONFIG_RTC_DS1338       - use Maxim, Inc. DS1338 RTC
                CONFIG_RTC_DS164x       - use Dallas DS164x RTC
 
+               Note that if the RTC uses I2C, then the I2C interface
+               must also be configured. See I2C Support, below.
+
 - Timestamp Support:
 
                When CONFIG_TIMESTAMP is selected, the timestamp
@@ -904,29 +920,48 @@ The following options need to be configured:
 
 - I2C Support: CONFIG_HARD_I2C | CONFIG_SOFT_I2C
 
-               Enables I2C serial bus commands.  If this is selected,
-               either CONFIG_HARD_I2C or CONFIG_SOFT_I2C must be defined
-               to include the appropriate I2C driver.
+               These enable I2C serial bus commands. Defining either of
+               (but not both of) CONFIG_HARD_I2C or CONFIG_SOFT_I2C will
+               include the appropriate I2C driver for the selected cpu.
 
-               See also: common/cmd_i2c.c for a description of the
+               This will allow you to use i2c commands at the u-boot
+               command line (as long as you set CFG_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 the CPM hardware driver for I2C.
+
+               CONFIG_SOFT_I2C configures u-boot to use a software (aka
+               bit-banging) driver instead of CPM or similar hardware
+               support for I2C.
 
-               CONFIG_HARD_I2C
+               There are several other quantities that must also be
+               defined when you define CONFIG_HARD_I2C or CONFIG_SOFT_I2C.
 
-               Selects the CPM hardware driver for I2C.
+               In both cases you will need to define CFG_I2C_SPEED
+               to be the frequency (in Hz) at which you wish your i2c bus
+               to run and CFG_I2C_SLAVE to be the address of this node (ie
+               the cpu's i2c node address).
 
-               CONFIG_SOFT_I2C
+               Now, the u-boot i2c code for the mpc8xx (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 CFG_I2C_SLAVE to 0.
 
-               Use software (aka bit-banging) driver instead of CPM
-               or similar hardware support for I2C.  This is configured
-               via the following defines.
+               That's all that's required for CONFIG_HARD_I2C.
+
+               If you use the software i2c interface (CONFIG_SOFT_I2C)
+               then the following macros need to be defined (examples are
+               from include/configs/lwmon.h):
 
                I2C_INIT
 
-               (Optional). Any commands necessary to enable I2C
+               (Optional). Any commands necessary to enable the I2C
                controller or configure ports.
 
+               eg: #define I2C_INIT (immr->im_cpm.cp_pbdir |=  PB_SCL)
+
                I2C_PORT
 
                (Only for MPC8260 CPU). The I/O port to use (the code
@@ -939,32 +974,49 @@ The following options need to be configured:
                (driven).  If the data line is open collector, this
                define can be null.
 
+               eg: #define I2C_ACTIVE (immr->im_cpm.cp_pbdir |=  PB_SDA)
+
                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)
+
                I2C_READ
 
                Code that returns TRUE if the I2C data line is high,
                FALSE if it is low.
 
+               eg: #define I2C_READ ((immr->im_cpm.cp_pbdat & PB_SDA) != 0)
+
                I2C_SDA(bit)
 
                If <bit> is TRUE, sets the I2C data line high. If it
                is FALSE, it clears it (low).
 
+               eg: #define I2C_SDA(bit) \
+                       if(bit) immr->im_cpm.cp_pbdat |=  PB_SDA; \
+                       else    immr->im_cpm.cp_pbdat &= ~PB_SDA
+
                I2C_SCL(bit)
 
                If <bit> is TRUE, sets the I2C clock line high. If it
                is FALSE, it clears it (low).
 
+               eg: #define I2C_SCL(bit) \
+                       if(bit) immr->im_cpm.cp_pbdat |=  PB_SCL; \
+                       else    immr->im_cpm.cp_pbdat &= ~PB_SCL
+
                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).
+               is 1 / (I2C_DELAY * 4). Often defined to be something
+               like:
+
+               #define I2C_DELAY  udelay(2)
 
                CFG_I2C_INIT_BOARD
 
@@ -1442,6 +1494,16 @@ Configuration Settings:
 - CFG_FLASH_WRITE_TOUT:
                Timeout for Flash write operations (in ms)
 
+- CFG_FLASH_LOCK_TOUT
+               Timeout for Flash set sector lock bit operation (in ms)
+
+- CFG_FLASH_UNLOCK_TOUT
+               Timeout for Flash clear lock bits operation (in ms)
+
+- CFG_FLASH_PROTECTION
+               If defined, hardware flash sectors protection is used
+               instead of U-Boot software protection.
+
 - CFG_DIRECT_FLASH_TFTP:
 
                Enable TFTP transfers directly to flash memory;
@@ -1633,9 +1695,10 @@ Low Level (hardware related) configuration options:
 
 - CFG_DEFAULT_IMMR:
                Default address of the IMMR after system reset.
-               Needed on some 8260 systems (MPC8260ADS and RPXsuper)
-               to be able to adjust the position of the IMMR
-               register after a reset.
+
+                Needed on some 8260 systems (MPC8260ADS, PQ2FADS-ZU,
+                and RPXsuper) to be able to adjust the position of
+                the IMMR register after a reset.
 
 - Floppy Disk Support:
                CFG_FDC_DRIVE_NUMBER
@@ -1808,7 +1871,7 @@ configurations; the following names are supported:
     GENIETV_config       TQM823L_config        PIP405_config
     GEN860T_config       EBONY_config          FPS860L_config
     ELPT860_config       cmi_mpc5xx_config     NETVIA_config
-    at91rm9200dk_config
+    at91rm9200dk_config          omap1510inn_config    MPC8260ADS_config
 
 Note: for some board special configuration names may exist; check  if
       additional  information is available from the board vendor; for
@@ -2999,6 +3062,11 @@ it:
   version of diff does not support these options, then get the latest
   version of GNU diff.
 
+  The current directory when running this command shall be the top
+  level directory of the U-Boot source tree, or it's parent directory
+  (i. e. please make sure that your patch includes sufficient
+  directory information for the affected files).
+
   We accept patches as plain text, MIME attachments or as uuencoded
   gzipped text.