]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - README
Prepare for 0.3.0 release
[karo-tx-uboot.git] / README
diff --git a/README b/README
index 7e9f458516c3042fb023853600ef8f14a0e3ec74..45b1c57cf30867b72e90c26299ef9a18dfc9ac1e 100644 (file)
--- a/README
+++ b/README
@@ -140,6 +140,7 @@ 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/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
@@ -151,6 +152,7 @@ Directory Hierarchy:
                Files specific to RPXClassic boards
 - board/RPXlite        Files specific to RPXlite    boards
 - board/c2mon  Files specific to c2mon      boards
+- board/cmi    Files specific to cmi        boards
 - board/cogent Files specific to Cogent     boards
                (need further configuration)
                Files specific to CPCIISER4  boards
@@ -292,6 +294,7 @@ The following options need to be configured:
                PowerPC based CPUs:
                -------------------
                CONFIG_MPC823,  CONFIG_MPC850,  CONFIG_MPC855,  CONFIG_MPC860
+       or      CONFIG_MPC5xx
        or      CONFIG_MPC824X, CONFIG_MPC8260
        or      CONFIG_IOP480
        or      CONFIG_405GP
@@ -340,7 +343,7 @@ The following options need to be configured:
                CONFIG_GTH,        CONFIG_RPXClassic, CONFIG_rsdproto,
                CONFIG_IAD210,     CONFIG_RPXlite,    CONFIG_sbc8260,
                CONFIG_EBONY,      CONFIG_sacsng,     CONFIG_FPS860L,
-               CONFIG_V37,        CONFIG_ELPT860
+               CONFIG_V37,        CONFIG_ELPT860,    CONFIG_CMI
 
                ARM based boards:
                -----------------
@@ -617,6 +620,13 @@ The following options need to be configured:
                SIU Watchdog feature is enabled in the SYPCR
                register.
 
+- U-Boot Version:
+               CONFIG_VERSION_VARIABLE
+               If this variable is defined, an environment variable
+               named "ver" is created by U-Boot showing the U-Boot
+               version as printed by the "version" command.
+               This variable is readonly.
+
 - Real-Time Clock:
 
                When CFG_CMD_DATE is selected, the type of the RTC
@@ -730,7 +740,7 @@ The following options need to be configured:
        16,7 Mill (24bit)     315       318       31b
                (i.e. setenv videomode 317; saveenv; reset;)
 
-               CONFIG_VIDEO_SED13806 
+               CONFIG_VIDEO_SED13806
                Enable Epson SED13806 driver. This driver supports 8bpp
                and 16bpp modes defined by CONFIG_VIDEO_SED13806_8BPP
                or CONFIG_VIDEO_SED13806_16BPP
@@ -1245,7 +1255,7 @@ The following options need to be configured:
 Modem Support:
 --------------
 
-[so far only for SMDK2400 board]
+[so far only for SMDK2400 and TRAB boards]
 
 - Modem support endable:
                CONFIG_MODEM_SUPPORT
@@ -1452,7 +1462,7 @@ following configurations:
 
           These settings describe a second storage area used to hold
           a redundand copy of the environment data, so that there is
-          a valid backup copy in case there is a power failur during
+          a valid backup copy in case there is a power failure during
           a "saveenv" operation.
 
 BE CAREFUL! Any changes to the flash layout, and some changes to the
@@ -1532,20 +1542,16 @@ has been relocated to RAM and a RAM copy of the environment has been
 created; also, when using EEPROM you will have to use getenv_r()
 until then to read environment variables.
 
-The environment is now protected by a CRC32 checksum. Before the
-monitor is relocated into RAM, as a result of a bad CRC you will be
-working with the compiled-in default environment - *silently*!!!
-[This is necessary, because the first environment variable we need is
-the "baudrate" setting for the console - if we have a bad CRC, we
-don't have any device yet where we could complain.]
+The environment is protected by a CRC32 checksum. Before the monitor
+is relocated into RAM, as a result of a bad CRC you will be working
+with the compiled-in default environment - *silently*!!! [This is
+necessary, because the first environment variable we need is the
+"baudrate" setting for the console - if we have a bad CRC, we don't
+have any device yet where we could complain.]
 
 Note: once the monitor has been relocated, then it will complain if
 the default environment is used; a new CRC is computed as soon as you
-use the "setenv" command to modify / delete / add any environment
-variable [even when you try to delete a non-existing variable!].
-
-Note2: you must edit your u-boot.lds file to reflect this
-configuration.
+use the "saveenv" command to store a valid environment.
 
 
 Low Level (hardware related) configuration options:
@@ -1605,16 +1611,16 @@ Low Level (hardware related) configuration options:
                - MPC824X: data cache
                - PPC4xx:  data cache
 
-- CFG_INIT_DATA_OFFSET:
+- CFG_GBL_DATA_OFFSET:
 
                Offset of the initial data structure in the memory
                area defined by CFG_INIT_RAM_ADDR. Usually
-               CFG_INIT_DATA_OFFSET is chosen such that the initial
+               CFG_GBL_DATA_OFFSET is chosen such that the initial
                data is located at the end of the available space
                (sometimes written as (CFG_INIT_RAM_END -
                CFG_INIT_DATA_SIZE), and the initial stack is just
                below that area (growing from (CFG_INIT_RAM_ADDR +
-               CFG_INIT_DATA_OFFSET) downward.
+               CFG_GBL_DATA_OFFSET) downward.
 
        Note:
                On the MPC824X (or other systems that use the data
@@ -1720,7 +1726,7 @@ configurations; the following names are supported:
     FPS850L_config       Sandpoint8240_config  sbc8260_config
     GENIETV_config       TQM823L_config        PIP405_config
     GEN860T_config       EBONY_config          FPS860L_config
-    ELPT860_config
+    ELPT860_config       cmi_mpc5xx_config
 
 Note: for some board special configuration names may exist; check  if
       additional  information is available from the board vendor; for
@@ -1771,14 +1777,21 @@ to port U-Boot to your hardware platform. To do this, follow these
 steps:
 
 1.  Add a new configuration option for your board to the toplevel
-    "Makefile", using the existing entries as examples.
+    "Makefile" and to the "MAKEALL" script, using the existing
+    entries as examples. Note that here and at many other places
+    boards and other names are listed alphabetically sorted. Please
+    keep this order.
 2.  Create a new directory to hold your board specific code. Add any
-    files you need.
+    files you need. In your board directory, you will need at least
+    the "Makefile", a "<board>.c", "flash.c" and "u-boot.lds".
+3.  Create a new configuration file "include/configs/<board>.h" for
+    your board
 3.  If you're porting U-Boot to a new CPU, then also create a new
     directory to hold your CPU specific code. Add any files you need.
-4.  Run "make config_name" with your new name.
+4.  Run "make <board>_config" with your new name.
 5.  Type "make", and you should get a working "u-boot.srec" file
     to be installed on your target system.
+6.  Debug and solve any problems that might arise.
     [Of course, this last step is much harder than it sounds.]
 
 
@@ -1967,6 +1980,13 @@ the board). U-Boot refuses to delete or overwrite these variables
 once they have been set once.
 
 
+Further special Environment Variables:
+
+  ver          - Contains the U-Boot version string as printed
+                 with the "version" command. This variable is
+                 readonly (see CONFIG_VERSION_VARIABLE).
+
+
 Please note that changes to some configuration parameters may take
 only effect after the next boot (yes, that's just like Windoze :-).
 
@@ -2375,18 +2395,18 @@ U-Boot supports the following image types:
        to boot over the network using BOOTP etc., where the boot
        server provides just a single image file, but you want to get
        for instance an OS kernel and a RAMDisk image.
-  
+
        "Multi-File Images" start with a list of image sizes, each
        image size (in bytes) specified by an "uint32_t" in network
        byte order. This list is terminated by an "(uint32_t)0".
        Immediately after the terminating 0 follow the images, one by
        one, all aligned on "uint32_t" boundaries (size rounded up to
        a multiple of 4 bytes).
-  
+
    "Firmware Images" are binary images containing firmware (like
        U-Boot or FPGA images) which usually will be programmed to
        flash memory.
-  
+
    "Script files" are command sequences that will be executed by
        U-Boot's command interpreter; this feature is especially
        useful when you configure U-Boot to use a real shell (hush)
@@ -2481,6 +2501,17 @@ Hit 'q':
        [q, b, e, ?] ## Application terminated, rc = 0x0
 
 
+
+Minicom warning:
+================
+
+Over time, many people have reported problems when trying to used the
+"minicom" terminal emulation program  for  serial  download.  I  (wd)
+consider  minicom  to  be  broken, and recommend not to use it. Under
+Unix, I recommend  to  use  CKermit  for  general  purpose  use  (and
+especially for kermit binary protocol download ("loadb" command), and
+use "cu" for S-Record download ("loads" command).
+
 NetBSD Notes:
 =============