gpio: am43xx: expand gpio support

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

diff --git a/doc/README.imximage b/doc/README.imximage
index 3378f7efdb1fe7d12e6630139cd03e2c8404101a..27d335456997a702ff072f870e7e97fc5d91c74a 100644 (file)
--- a/doc/README.imximage
+++ b/doc/README.imximage
@@ -2,21 +2,19 @@
 Imximage Boot Image generation using mkimage
 ---------------------------------------------
 
-This document describes how to set up a U-Boot image
-that can be booted by Freescale MX25, MX35 and MX51
-processors via internal boot mode.
+This document describes how to set up a U-Boot image that can be booted
+by Freescale MX25, MX35, MX51, MX53 and MX6 processors via internal boot
+mode.
 
 These processors can boot directly from NAND, SPI flash and SD card flash
-using its internal boot ROM support. They can boot from an internal
+using its internal boot ROM support. MX6 processors additionally support
+boot from NOR flash and SATA disks. All processors can boot from an internal
 UART, if booting from device media fails.
 Booting from NOR flash does not require to use this image type.
 
 For more details refer Chapter 2 - System Boot and section 2.14
 (flash header description) of the processor's manual.
 
-This implementation does not use at the moment the secure boot feature
-of the processor. The image is generated disabling all security fields.
-
 Command syntax:
 --------------
 ./tools/mkimage -l <mx u-boot_file>
@@ -57,9 +55,61 @@ Configuration command line syntax:
 2. Following are the valid command strings and associated data strings:-
        Command string          data string
        --------------          -----------
-       BOOT_FROM               nand/spi/sd/onenand
+       IMXIMAGE_VERSION        1/2
+                               1 is for mx25/mx35/mx51 compatible,
+                               2 is for mx53/mx6 compatible,
+                               others is invalid and error is generated.
+                               This command need appear the fist before
+                               other valid commands in configuration file.
+
+       BOOT_OFFSET             value
+
+                               This command is parallel to BOOT_FROM and
+                               is preferred over BOOT_FROM.
+
+                               value:  Offset of the image header, this
+                                       value shall be set to one of the
+                                       values found in the file:
+                                               arch/arm/include/asm/\
+                                               imx-common/imximage.cfg
+                               Example:
+                               BOOT_OFFSET FLASH_OFFSET_STANDARD
+
+       BOOT_FROM               nand/spi/sd/onenand/nor/sata
+
+                               This command is parallel to BOOT_OFFSET and
+                               is to be deprecated in favor of BOOT_OFFSET.
+
                                Example:
                                BOOT_FROM spi
+
+       CSF                     value
+
+                               Total size of CSF (Command Sequence File)
+                               used for Secure Boot/ High Assurance Boot
+                               (HAB).
+
+                               Using this command will populate the IVT
+                               (Initial Vector Table) CSF pointer and adjust
+                               the length fields only. The CSF itself needs
+                               to be generated with Freescale tools and
+                               'manually' appended to the u-boot.imx file.
+
+                               The CSF is then simply concatenated
+                               to the u-boot image, making a signed bootloader,
+                               that the processor can verify
+                               if the fuses for the keys are burned.
+
+                               Further infos how to configure the SOC to verify
+                               the bootloader can be found in the "High
+                               Assurance Boot Version Application Programming
+                               Interface Reference Manual" as part of the
+                               Freescale Code Signing Tool, available on the
+                               manufacturer's website.
+
+                               Example:
+                               CSF 0x2000
+
        DATA                    type address value
 
                                type: word=4, halfword=2, byte=1
@@ -69,8 +119,9 @@ Configuration command line syntax:
                                Example (write to IOMUXC):
                                DATA 4 0x73FA88a0 0x200
 
-The processor support up to 60 register programming commands. An error
-is generated if more commands are found in the configuration file.
+The processor support up to 60 register programming commands for IMXIMAGE_VERSION 1
+and 220 register programming commands for IMXIMAGE_VERSION 2.
+An error is generated if more commands are found in the configuration file.
 
 3. All commands are optional to program.