Merge branch 'master' of git://git.denx.de/u-boot-nds32

[karo-tx-uboot.git] / doc / README.kwbimage

diff --git a/doc/README.kwbimage b/doc/README.kwbimage
index 2a5b3b3be5d2d46d5fd52d5d25d0e8eac25f31db..e91c387b51ed6df1f21c8491258ff0dcb324557d 100644 (file)
--- a/doc/README.kwbimage
+++ b/doc/README.kwbimage
@@ -17,21 +17,32 @@ Command syntax:
                to list the kwb image file details
 
 ./tools/mkimage -n <board specific configuration file> \
-                -T kwbimage -a <start address> -e <execution address> \
+               -T kwbimage -a <start address> -e <execution address> \
                -d <input_raw_binary> <output_kwboot_file>
 
 for ex.
 ./tools/mkimage -n ./board/Marvell/openrd_base/kwbimage.cfg \
-                -T kwbimage -a 0x00600000 -e 0x00600000 \
+               -T kwbimage -a 0x00600000 -e 0x00600000 \
                -d u-boot.bin u-boot.kwb
 
-kwimage support available with mkimage utility will generate kirkwood boot
-image that can be flashed on the board NAND/SPI flash
+
+kwbimage support available with mkimage utility will generate kirkwood boot
+image that can be flashed on the board NAND/SPI flash.  The make target
+which uses mkimage to produce such an image is "u-boot.kwb".  For example:
+
+  export BUILD_DIR=/tmp/build
+  make distclean
+  make yourboard_config
+  make $BUILD_DIR/u-boot.kwb
+
 
 Board specific configuration file specifications:
 ------------------------------------------------
-1. This file must present in the $(BOARDDIR) and the name should be
-       kwbimage.cfg (since this is used in Makefile)
+1. This file must present in the $(BOARDDIR).  The default name is
+       kwbimage.cfg.  The name can be set as part of the full path
+        to the file using CONFIG_SYS_KWD_CONFIG (probably in
+        include/configs/<yourboard>.h).   The path should look like:
+        $(SRCTREE)/$(CONFIG_BOARDDIR)/<yourkwbimagename>.cfg
 2. This file can have empty lines and lines starting with "#" as first
        character to put comments
 3. This file can have configuration command lines as mentioned below,