[U-Boot] [PATCH 1/6] README: mx28_common: Keep the text within 80 columns
From: Fabio Estevam fabio.estevam@freescale.com
In order to improve readability keep the text within 80 columns.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com --- doc/README.mx28_common | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/README.mx28_common b/doc/README.mx28_common index 8bacaf8..6618908 100644 --- a/doc/README.mx28_common +++ b/doc/README.mx28_common @@ -63,9 +63,9 @@ means "/usr/local/bin/" has to be in your $PATH. 2) Compiling U-Boot for a MX28 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 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:
$ make mrproper
@@ -150,8 +150,8 @@ NOTE: If the user needs to adjust the start sector, the "mxsboot" tool contains 4) Installation of U-Boot into NAND flash -----------------------------------------
-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 i.MX28 manual chapter 12.2.1 (Table 12-2), PORT=GPMI, NAND 1.8 V.
There are two possibilities when preparing an image writable to NAND flash.
From: Fabio Estevam fabio.estevam@freescale.com
MX28 can boot from SSP0 or SSP1, so it is better not to hardcode the SSP port in the instructions.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com --- doc/README.mx28_common | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/doc/README.mx28_common b/doc/README.mx28_common index 6618908..bd12cab 100644 --- a/doc/README.mx28_common +++ b/doc/README.mx28_common @@ -100,9 +100,7 @@ discussed in the following chapters. -----------------------------------------------------------
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. - +to i.MX28 manual chapter 12.2.1 (Table 12-2).
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
Dear Fabio Estevam,
From: Fabio Estevam fabio.estevam@freescale.com
MX28 can boot from SSP0 or SSP1, so it is better not to hardcode the SSP port in the instructions.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
doc/README.mx28_common | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/doc/README.mx28_common b/doc/README.mx28_common index 6618908..bd12cab 100644 --- a/doc/README.mx28_common +++ b/doc/README.mx28_common @@ -100,9 +100,7 @@ discussed in the following chapters.
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.
+to i.MX28 manual chapter 12.2.1 (Table 12-2).
Make sure to leave the 3V3 thing there. PORT=SSPn would be a better solution here too.
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
Best regards, Marek Vasut
On Fri, May 3, 2013 at 4:52 PM, Marek Vasut marex@denx.de wrote:
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.
+to i.MX28 manual chapter 12.2.1 (Table 12-2).
Make sure to leave the 3V3 thing there. PORT=SSPn would be a better solution here too.
Sorry, but I disagree.
Please check table 12-2 from mx28 reference manual and you will see that SD boot is also possible in 1.8V, so in the common README file it makes no sense to hardcode the boot voltage. Besides that, mx23 does not refer to 3.3V in its boot mode table.
PORT=SSPn is also noisy. Let's get rid of all this. People will have to look the reference manual anyway.
Also, in v2 I will change "set the boot mode DIP switches" to "set the boot mode pins", as not all boards use DIP switches.
Dear Fabio Estevam,
On Fri, May 3, 2013 at 4:52 PM, Marek Vasut marex@denx.de wrote:
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.
+to i.MX28 manual chapter 12.2.1 (Table 12-2).
Make sure to leave the 3V3 thing there. PORT=SSPn would be a better solution here too.
Sorry, but I disagree.
Please check table 12-2 from mx28 reference manual and you will see that SD boot is also possible in 1.8V, so in the common README file it makes no sense to hardcode the boot voltage. Besides that, mx23 does not refer to 3.3V in its boot mode table.
When was the last time you saw 1V8 SD card ? ;-)
PORT=SSPn is also noisy. Let's get rid of all this. People will have to look the reference manual anyway.
Also, in v2 I will change "set the boot mode DIP switches" to "set the boot mode pins", as not all boards use DIP switches.
Best regards, Marek Vasut
On 03/05/2013 20:07, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
MX28 can boot from SSP0 or SSP1, so it is better not to hardcode the SSP port in the instructions.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
Applied to u-boot-imx, thanks.
Best regards, Stefano Babic
From: Fabio Estevam fabio.estevam@freescale.com
Re-structure the sentence a bit so that it can clearer.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com --- doc/README.mx28_common | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/doc/README.mx28_common b/doc/README.mx28_common index bd12cab..c7a6839 100644 --- a/doc/README.mx28_common +++ b/doc/README.mx28_common @@ -102,10 +102,9 @@ discussed in the following chapters. 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).
-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:
On 03/05/2013 20:07, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
Re-structure the sentence a bit so that it can clearer.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
Applied to u-boot-imx, thanks.
Best regards, Stefano Babic
From: Fabio Estevam fabio.estevam@freescale.com
Create a README.mxs file that contains instructions on how to use U-boot for both MX23 and MX28.
As boot from NAND has only been tested on mx28, make it clear that it only applies to MX28.
While at it, do some small cleanups for the sake of consistency: - Use "MX28" instead of "i.MX28" - Use "section" instead of "chapter" when referring to specific parts of the reference manual chapters.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com --- doc/README.m28 | 4 +-- doc/README.mx28evk | 3 +- doc/{README.mx28_common => README.mxs} | 62 +++++++++++++++++++------------- 3 files changed, 40 insertions(+), 29 deletions(-) rename doc/{README.mx28_common => README.mxs} (80%)
diff --git a/doc/README.m28 b/doc/README.m28 index 2a92226..cb3ae20 100644 --- a/doc/README.m28 +++ b/doc/README.m28 @@ -9,5 +9,5 @@ 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. +Follow the instructions from doc/README.mxs to generate a bootable SD card or to +boot from NAND flash. diff --git a/doc/README.mx28evk b/doc/README.mx28evk index 76db474..524f3fc 100644 --- a/doc/README.mx28evk +++ b/doc/README.mx28evk @@ -41,7 +41,6 @@ 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. +Follow the instructions from doc/README.mxs to generate a bootable SD card.
Insert the SD card in slot 0, power up the board and U-boot will boot. diff --git a/doc/README.mx28_common b/doc/README.mxs similarity index 80% rename from doc/README.mx28_common rename to doc/README.mxs index c7a6839..6d0929a 100644 --- a/doc/README.mx28_common +++ b/doc/README.mxs @@ -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 +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,11 +107,12 @@ 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 ------------------------------------------------------------ +3) Installation of U-Boot for a MXS 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). +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).
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. @@ -138,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 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.
@@ -211,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
Dear Fabio Estevam,
From: Fabio Estevam fabio.estevam@freescale.com
Create a README.mxs file that contains instructions on how to use U-boot for both MX23 and MX28.
As boot from NAND has only been tested on mx28, make it clear that it only applies to MX28.
While at it, do some small cleanups for the sake of consistency:
- Use "MX28" instead of "i.MX28"
- Use "section" instead of "chapter" when referring to specific parts of
the reference manual chapters.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
doc/README.m28 | 4 +-- doc/README.mx28evk | 3 +- doc/{README.mx28_common => README.mxs} | 62 +++++++++++++++++++------------- 3 files changed, 40 insertions(+), 29 deletions(-) rename doc/{README.mx28_common => README.mxs} (80%)
diff --git a/doc/README.m28 b/doc/README.m28 index 2a92226..cb3ae20 100644 --- a/doc/README.m28 +++ b/doc/README.m28 @@ -9,5 +9,5 @@ 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. +Follow the instructions from doc/README.mxs to generate a bootable SD card or to +boot from NAND flash. diff --git a/doc/README.mx28evk b/doc/README.mx28evk index 76db474..524f3fc 100644 --- a/doc/README.mx28evk +++ b/doc/README.mx28evk @@ -41,7 +41,6 @@ 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. +Follow the instructions from doc/README.mxs to generate a bootable SD card.
Insert the SD card in slot 0, power up the board and U-boot will boot. diff --git a/doc/README.mx28_common b/doc/README.mxs similarity index 80% rename from doc/README.mx28_common rename to doc/README.mxs index c7a6839..6d0929a 100644 --- a/doc/README.mx28_common +++ b/doc/README.mxs @@ -1,12 +1,15 @@
-Booting U-boot on a MX28 processor
+Booting U-boot on a MXS processor
i.MX23 / i.MX28 instead of MXS ? MXS is no processor, maybe processor family?
[...]
Best regards, Marek Vasut
On 03/05/2013 20:08, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
Create a README.mxs file that contains instructions on how to use U-boot for both MX23 and MX28.
As boot from NAND has only been tested on mx28, make it clear that it only applies to MX28.
While at it, do some small cleanups for the sake of consistency:
- Use "MX28" instead of "i.MX28"
- Use "section" instead of "chapter" when referring to specific parts of the
reference manual chapters.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
Applied to u-boot-imx, thanks.
Best regards, Stefano Babic
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com --- .../freescale/mx28evk/README | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)
diff --git a/doc/README.mx28evk b/board/freescale/mx28evk/README similarity index 100% rename from doc/README.mx28evk rename to board/freescale/mx28evk/README
On 03/05/2013 20:08, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
.../freescale/mx28evk/README | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)
diff --git a/doc/README.mx28evk b/board/freescale/mx28evk/README similarity index 100% rename from doc/README.mx28evk rename to board/freescale/mx28evk/README
Strange, I cannot find this patch in patchworks..anyway
Applied to u-boot-imx, thanks.
Best regards, Stefano Babic
On Wed, Jun 26, 2013 at 12:43 PM, Stefano Babic sbabic@denx.de wrote:
On 03/05/2013 20:08, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
.../freescale/mx28evk/README | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)
diff --git a/doc/README.mx28evk b/board/freescale/mx28evk/README similarity index 100% rename from doc/README.mx28evk rename to board/freescale/mx28evk/README
Strange, I cannot find this patch in patchworks..anyway
Applied to u-boot-imx, thanks.
This is because it was a rename so patchwork does not track it. It is a bug ...
-- Otavio Salvador O.S. Systems http://www.ossystems.com.br http://projetos.ossystems.com.br Mobile: +55 (53) 9981-7854 Mobile: +1 (347) 903-9750
Dear Otavio Salvador,
On Wed, Jun 26, 2013 at 12:43 PM, Stefano Babic sbabic@denx.de wrote:
On 03/05/2013 20:08, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
.../freescale/mx28evk/README | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)
diff --git a/doc/README.mx28evk b/board/freescale/mx28evk/README similarity index 100% rename from doc/README.mx28evk rename to board/freescale/mx28evk/README
Strange, I cannot find this patch in patchworks..anyway
Applied to u-boot-imx, thanks.
This is because it was a rename so patchwork does not track it. It is a bug ...
Fix it and send patch ;-)
Best regards, Marek Vasut
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com --- doc/README.m28 => board/denx/m28evk/README | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename doc/README.m28 => board/denx/m28evk/README (100%)
diff --git a/doc/README.m28 b/board/denx/m28evk/README similarity index 100% rename from doc/README.m28 rename to board/denx/m28evk/README
Dear Fabio Estevam,
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Where did you find this rule?
Best regards, Marek Vasut
On Fri, May 3, 2013 at 4:54 PM, Marek Vasut marex@denx.de wrote:
Dear Fabio Estevam,
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Where did you find this rule?
Here:
commit 702e6014f15b307f144fa03ecaf83a8446c6802a Author: Wolfgang Denk wd@denx.de Date: Sun Apr 29 23:57:39 2012 +0000
doc: cleanup - move board READMEs into respective board directories
Also drop a few files referring to no longer / not yet supported boards.
Signed-off-by: Wolfgang Denk wd@denx.de Cc: Prafulla Wadaskar prafulla@marvell.com Cc: Stefan Roese sr@denx.de Cc: Kim Phillips kim.phillips@freescale.com Cc: Andy Fleming afleming@gmail.com Cc: Jason Jin jason.jin@freescale.com Cc: Stefano Babic sbabic@denx.de Cc: Daniel Schwierzeck daniel.schwierzeck@googlemail.com Acked-by: Stefano Babic sbabic@denx.de Acked-by: Daniel Schwierzeck daniel.schwierzeck@googlemail.com
Dear Fabio Estevam,
On Fri, May 3, 2013 at 4:54 PM, Marek Vasut marex@denx.de wrote:
Dear Fabio Estevam,
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Where did you find this rule?
Here:
commit 702e6014f15b307f144fa03ecaf83a8446c6802a Author: Wolfgang Denk wd@denx.de Date: Sun Apr 29 23:57:39 2012 +0000
I see, thanks.
Best regards, Marek Vasut
On 03/05/2013 20:08, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
Board specific READMEs should be located inside the respective board directory.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
Applied to u-boot-imx, thanks.
Best regards, Stefano Babic
On 03/05/2013 20:07, Fabio Estevam wrote:
From: Fabio Estevam fabio.estevam@freescale.com
In order to improve readability keep the text within 80 columns.
Signed-off-by: Fabio Estevam fabio.estevam@freescale.com
Applied to u-boot-imx, thanks.
Best regards, Stefano Babic
participants (4)
-
Fabio Estevam -
Marek Vasut -
Otavio Salvador -
Stefano Babic