summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlbert ARIBAUD <albert.u.boot@aribaud.net>2013-06-28 17:51:13 +0200
committerAlbert ARIBAUD <albert.u.boot@aribaud.net>2013-06-28 17:51:13 +0200
commite6c7f86f03b0ad25e9ef70df3ee1989b6b789d7c (patch)
treefb7b4ca068bf10217d28af5c33e7a0a9c9961c6a /doc
parent9dc8fef2583f23ca6a99c6f5e709a8b80018364f (diff)
parentd6c6d127c5b948ec381fad5b24a2bc5497720644 (diff)
downloadu-boot-imx-e6c7f86f03b0ad25e9ef70df3ee1989b6b789d7c.zip
u-boot-imx-e6c7f86f03b0ad25e9ef70df3ee1989b6b789d7c.tar.gz
u-boot-imx-e6c7f86f03b0ad25e9ef70df3ee1989b6b789d7c.tar.bz2
Merge branch 'u-boot-imx/master' into 'u-boot-arm/master'
Diffstat (limited to 'doc')
-rw-r--r--doc/README.m2813
-rw-r--r--doc/README.mx28_common75
-rw-r--r--doc/README.mx28evk47
3 files changed, 42 insertions, 93 deletions
diff --git a/doc/README.m28 b/doc/README.m28
deleted file mode 100644
index 2a92226..0000000
--- a/doc/README.m28
+++ /dev/null
@@ -1,13 +0,0 @@
-DENX M28EVK
-===========
-
-Files of the M28/M28EVK port
-----------------------------
-
-arch/arm/cpu/arm926ejs/mxs/ - The CPU support code for the Freescale i.MX28
-arch/arm/include/asm/arch-mxs/ - Header files for the Freescale i.MX28
-board/denx/m28evk/ - M28EVK board specific files
-include/configs/m28evk.h - M28EVK configuration file
-
-Follow the instructions from doc/README.mx28_common to generate a bootable SD
-card or to boot from NAND flash.
diff --git a/doc/README.mx28_common b/doc/README.mx28_common
index 8bacaf8..5d9e72f 100644
--- a/doc/README.mx28_common
+++ b/doc/README.mx28_common
@@ -1,12 +1,15 @@
-Booting U-boot on a MX28 processor
-==================================
+Booting U-boot on a MXS processor
+=================================
-This document describes the MX28 U-Boot port. This document mostly
-covers topics related to making the module/board bootable.
+This document describes the MXS U-Boot port. This document mostly covers topics
+related to making the module/board bootable.
Terminology
-----------
+The term "MXS" refers to a family of Freescale SoCs that is composed by MX23
+and MX28.
+
The dollar symbol ($) introduces a snipped of shell code. This shall be typed
into the unix command prompt in U-Boot source code root directory.
@@ -17,16 +20,16 @@ Contents
--------
1) Prerequisites
-2) Compiling U-Boot for a MX28 based board
-3) Installation of U-Boot for a MX28 based board to SD card
-4) Installation of U-Boot into NAND flash
+2) Compiling U-Boot for a MXS based board
+3) Installation of U-Boot for a MXS based board to SD card
+4) Installation of U-Boot into NAND flash on a MX28 based board
1) Prerequisites
----------------
-To make a MX28 based board bootable, some tools are necessary. The first one
-is the "elftosb" tool distributed by Freescale Semiconductor. The other one
-is the "mxsboot" tool found in U-Boot source tree.
+To make a MXS based board bootable, some tools are necessary. The first one is
+the "elftosb" tool distributed by Freescale Semiconductor. The other one is the
+"mxsboot" tool found in U-Boot source tree.
Firstly, obtain the elftosb archive from the following location:
@@ -60,18 +63,18 @@ copy the binary by hand:
Make sure the "elftosb" binary can be found in your $PATH, in this case this
means "/usr/local/bin/" has to be in your $PATH.
-2) Compiling U-Boot for a MX28 based board
+2) Compiling U-Boot for a MXS based board
-------------------------------------------
-Compiling the U-Boot for a MX28 board is straightforward and done as compiling U-Boot
-for any other ARM device. For cross-compiler setup, please refer to ELDK5.0
-documentation. First, clean up the source code:
+Compiling the U-Boot for a MXS board is straightforward and done as compiling
+U-Boot for any other ARM device. For cross-compiler setup, please refer to
+ELDK5.0 documentation. First, clean up the source code:
$ make mrproper
-Next, configure U-Boot for a MX28 based board
+Next, configure U-Boot for a MXS based board
- $ make <mx28_based_board_name>_config
+ $ make <mxs_based_board_name>_config
Examples:
@@ -83,8 +86,16 @@ Examples:
$ make mx28evk_config
+3. For building U-boot for Freescale MX23EVK board:
+
+ $ make mx23evk_config
+
+4. For building U-boot for Olimex MX23 Olinuxino board:
+
+ $ make mx23_olinuxino_config
+
Lastly, compile U-Boot and prepare a "BootStream". The "BootStream" is a special
-type of file, which the i.MX28 CPU can boot. This is handled by the following
+type of file, which MXS CPUs can boot. This is handled by the following
command:
$ make u-boot.sb
@@ -96,18 +107,16 @@ The code produces "u-boot.sb" file. This file needs to be augmented with a
proper header to allow successful boot from SD or NAND. Adding the header is
discussed in the following chapters.
-3) Installation of U-Boot for a MX28 based board to SD card
------------------------------------------------------------
-
-To boot a MX28 based board from SD, set the boot mode DIP switches according
-to i.MX28 manual chapter 12.2.1 (Table 12-2), PORT=SSP0, SD/MMC master on
-SSP0, 3.3V.
+3) Installation of U-Boot for a MXS based board to SD card
+----------------------------------------------------------
+To boot a MXS based board from SD, set the boot mode DIP switches according to
+to MX28 manual, section 12.2.1 (Table 12-2) or MX23 manual, section 35.1.2
+(Table 35-3).
-An SD card the i.MX28 CPU can use to boot U-Boot must contain a DOS partition
-table, which in turn carries a partition of special type and which contains a
-special header. The rest of partitions in the DOS partition table can be used
-by the user.
+The SD card used to boot U-Boot must contain a DOS partition table, which in
+turn carries a partition of special type and which contains a special header.
+The rest of partitions in the DOS partition table can be used by the user.
To prepare such partition, use your favourite partitioning tool. The partition
must have the following parameters:
@@ -141,17 +150,17 @@ case, we assume the first partition of the SD card is /dev/mmcblk0p1:
$ dd if=u-boot.sd of=/dev/mmcblk0p1
-Last step is to insert the card into MX28 based board and boot.
+Last step is to insert the card into the MXS based board and boot.
NOTE: If the user needs to adjust the start sector, the "mxsboot" tool contains
a "-p" switch for that purpose. The "-p" switch takes the sector number as
an argument.
-4) Installation of U-Boot into NAND flash
------------------------------------------
+4) Installation of U-Boot into NAND flash on a MX28 based board
+---------------------------------------------------------------
-To boot a MX28 based board from NAND, set the boot mode DIP switches according to i.MX28
-manual chapter 12.2.1 (Table 12-2), PORT=GPMI, NAND 1.8 V.
+To boot a MX28 based board from NAND, set the boot mode DIP switches according
+to MX28 manual section 12.2.1 (Table 12-2), PORT=GPMI, NAND 1.8 V.
There are two possibilities when preparing an image writable to NAND flash.
@@ -214,7 +223,7 @@ There are two possibilities when preparing an image writable to NAND flash.
--------------------------------------------
There is a slight possibility of the user wanting to adjust the
STRIDE and COUNT options of the NAND boot. For description of these,
- see i.MX28 manual section 12.12.1.2 and 12.12.1.3.
+ see MX28 manual section 12.12.1.2 and 12.12.1.3.
The update scripts take this possibility into account. In case the
user changes STRIDE by blowing fuses, the user also has to change
diff --git a/doc/README.mx28evk b/doc/README.mx28evk
deleted file mode 100644
index 76db474..0000000
--- a/doc/README.mx28evk
+++ /dev/null
@@ -1,47 +0,0 @@
-FREESCALE MX28EVK
-==================
-
-Supported hardware: only MX28EVK rev D is supported in U-boot.
-
-Files of the MX28EVK port
---------------------------
-
-arch/arm/cpu/arm926ejs/mxs/ - The CPU support code for the Freescale i.MX28
-arch/arm/include/asm/arch-mxs/ - Header files for the Freescale i.MX28
-board/freescale/mx28evk/ - MX28EVK board specific files
-include/configs/mx28evk.h - MX28EVK configuration file
-
-Jumper configuration
----------------------
-
-To boot MX28EVK from an SD card, set the boot mode DIP switches as:
-
- * Boot Mode Select: 1 0 0 1 (Boot from SD card Slot 0 - U42)
- * JTAG PSWITCH RESET: To the right (reset disabled)
- * Battery Source: Down
- * Wall 5V: Up
- * VDD 5V: To the left (off)
- * Hold Button: Down (off)
-
-
-Environment Storage
--------------------
-
-There are two targets for mx28evk:
-
-"make mx28evk_config" - store enviroment variables into MMC
-
-or
-
-"make mx28evk_nand_config" - store enviroment variables into NAND flash
-
-Choose the target accordingly.
-
-Note: The mx28evk board does not come with a NAND flash populated from the
-factory. It comes with an empty slot (U23), which allows the insertion of a
-48-pin TSOP flash device.
-
-Follow the instructions from doc/README.mx28_common to generate a bootable SD
-card.
-
-Insert the SD card in slot 0, power up the board and U-boot will boot.