X-Git-Url: https://git.karo-electronics.de/?a=blobdiff_plain;f=doc%2FREADME.mxsimage;h=c3975ee5e66246a3a27c3b1b45ae8a0371d071ff;hb=d4aa4e0e768ee6842ffb02dec49dec0ba022e981;hp=88a2caf3e62ab8bb7600ee6f1176d9bcec230a8a;hpb=3be2bdf5dc69b3142c1162a59bc67191c9077567;p=karo-tx-uboot.git diff --git a/doc/README.mxsimage b/doc/README.mxsimage index 88a2caf3e6..c3975ee5e6 100644 --- a/doc/README.mxsimage +++ b/doc/README.mxsimage @@ -10,7 +10,7 @@ The mxsimage tool is targeted to be a simple replacement for the elftosb2 . To generate an image, write an image configuration file and run: mkimage -A arm -O u-boot -T mxsimage -n \ - + The output bootstream file is usually using the .sb file extension. Note that the example configuration files for producing bootable BootStream with @@ -27,7 +27,7 @@ These semantics and rules will be outlined now. - Each line of the configuration file contains exactly one instruction. - Every numeric value must be encoded in hexadecimal and in format 0xabcdef12 . - The configuration file is a concatenation of blocks called "sections" and - optionally "DCD blocks" (see below). + optionally "DCD blocks" (see below), and optional flags lines. - Each "section" is started by the "SECTION" instruction. - The "SECTION" instruction has the following semantics: @@ -54,33 +54,33 @@ These semantics and rules will be outlined now. LOAD u32_address string_filename - Instructs the BootROM to load file pointed by "string_filename" onto - address "u32_address". + address "u32_address". LOAD IVT u32_address u32_IVT_entry_point - Crafts and loads IVT onto address "u32_address" with the entry point - of u32_IVT_entry_point. + of u32_IVT_entry_point. - i.MX28-specific instruction! LOAD DCD u32_address u32_DCD_block_ID - Loads the DCD block with ID "u32_DCD_block_ID" onto address - "u32_address" and executes the contents of this DCD block + "u32_address" and executes the contents of this DCD block - i.MX28-specific instruction! FILL u32_address u32_pattern u32_length - Starts to write memory from addres "u32_address" with a pattern - specified by "u32_pattern". Writes exactly "u32_length" bytes of the + specified by "u32_pattern". Writes exactly "u32_length" bytes of the pattern. JUMP [HAB] u32_address [u32_r0_arg] - Jumps onto memory address specified by "u32_address" by setting this - address in PT. The BootROM will pass the "u32_r0_arg" value in ARM + address in PT. The BootROM will pass the "u32_r0_arg" value in ARM register "r0" to the executed code if this option is specified. Otherwise, ARM register "r0" will default to value 0x00000000. The optional "HAB" flag is i.MX28-specific flag turning on the HAB boot. CALL [HAB] u32_address [u32_r0_arg] - See JUMP instruction above, as the operation is exactly the same with - one difference. The CALL instruction does allow returning into the + one difference. The CALL instruction does allow returning into the BootROM from the executed code. U-Boot makes use of this in it's SPL code. @@ -88,10 +88,10 @@ These semantics and rules will be outlined now. - Restart the CPU and start booting from device specified by the "string_mode" argument. The "string_mode" differs for each CPU and can be: - i.MX23, string_mode = USB/I2C/SPI1_FLASH/SPI2_FLASH/NAND_BCH - JTAG/SPI3_EEPROM/SD_SSP0/SD_SSP1 - i.MX28, string_mode = USB/I2C/SPI2_FLASH/SPI3_FLASH/NAND_BCH - JTAG/SPI2_EEPROM/SD_SSP0/SD_SSP1 + i.MX23, string_mode = USB/I2C/SPI1_FLASH/SPI2_FLASH/NAND_BCH + JTAG/SPI3_EEPROM/SD_SSP0/SD_SSP1 + i.MX28, string_mode = USB/I2C/SPI2_FLASH/SPI3_FLASH/NAND_BCH + JTAG/SPI2_EEPROM/SD_SSP0/SD_SSP1 - An optional "DCD" blocks can be added at the begining of the configuration file. Note that the DCD is only supported on i.MX28. @@ -99,7 +99,7 @@ These semantics and rules will be outlined now. configuration file. - The DCD block has the following semantics: - DCD u32_DCD_block_ID + DCD u32_DCD_block_ID - u32_DCD_block_ID :: The ID number of the DCD block, must match the ID number used by "LOAD DCD" instruction. @@ -139,9 +139,14 @@ These semantics and rules will be outlined now. NOOP - This instruction does nothing. -- If the verbose output from the BootROM is enabled, the BootROM will produce a - letter on the Debug UART for each instruction it started processing. Here is a - mapping between the above instructions and the BootROM verbose output: + - An optional flags lines can be one of the following: + + DISPLAYPROGRESS + - Enable boot progress output form the BootROM. + +- If the boot progress output from the BootROM is enabled, the BootROM will + produce a letter on the Debug UART for each instruction it started processing. + Here is a mapping between the above instructions and the BootROM output: H -- SB Image header loaded T -- TAG instruction