README: mx28_common: Keep the text within 80 columns

PATCH New Fabio Estevam 4 participants 21 messages May 3, 2013 – Jun 26, 2013 Arm i.MX and Layerscape

lore

Share & tools

lore

Fabio Estevam

author reviewer

2013-05-03 18:07 UTC #0 lore raw

PATCH 1/6 README: mx28_common: Keep the text within 80 columns

From: Fabio Estevam <[email protected]>

In order to improve readability keep the text within 80 columns.

Signed-off-by Fabio Estevam <[email protected]>

---
 doc/README.mx28_common |   10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

doc/README.mx28_common +5 -5

index 8bacaf8..6618908 100644
@@ -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.

Signature · 1 line

1.7.9.5

Fabio Estevam

author reviewer

2013-05-03 18:07 UTC #1 lore raw

PATCH 2/6 README: mx28_common: Do not hardcode the SSP port

From: Fabio Estevam <[email protected]>

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 <[email protected]>

---
 doc/README.mx28_common |    4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

doc/README.mx28_common +1 -3

index 6618908..bd12cab 100644
@@ -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

Signature · 1 line

1.7.9.5

Marek Vasut

2013-05-03 19:52 UTC #2 lore raw

PATCH 2/6 README: mx28_common: Do not hardcode the SSP port

Dear Fabio Estevam,

Quoted 20 lines

From: Fabio Estevam <[email protected]>
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 <[email protected]>
---
 doc/README.mx28_common |    4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)
doc/README.mx28_common +0 -0
index 6618908..bd12cab 100644
@@ -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.

doc/README.mx28_common discussed in the following chapters. · line 103

Quoted 2 lines

doc/README.mx28_common +1 -1
-
+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.

Quoted 3 lines

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

Fabio Estevam

author reviewer

2013-05-03 20:42 UTC #3 lore raw

PATCH 2/6 README: mx28_common: Do not hardcode the SSP port

Quoted 8 lines · Marek Vasut

doc/README.mx28_common discussed in the following chapters. · line 103
Quoted 5 lines
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.
doc/README.mx28_common +1 -1
-
+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.

Marek Vasut

2013-05-03 20:47 UTC #4 lore raw

PATCH 2/6 README: mx28_common: Do not hardcode the SSP port

Dear Fabio Estevam,

Quoted 11 lines · Marek Vasut

Quoted 9 lines
doc/README.mx28_common discussed in the following chapters. · line 103
Quoted 6 lines
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.
doc/README.mx28_common +1 -1
-
+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.

Quoted 6 lines

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 ? ;-)

Quoted 5 lines

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

Stefano Babic

2013-06-26 15:42 UTC #5 lore raw

PATCH 2/6 README: mx28_common: Do not hardcode the SSP port

In reply to Fabio Estevam

Quoted 7 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>
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 <[email protected]>
---

Applied to u-boot-imx, thanks.

Best regards,
Stefano Babic

Signature · 5 lines

=====================================================================
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================

Fabio Estevam

author reviewer

2013-05-03 18:07 UTC #6 lore raw

PATCH 3/6 README: mx28_common: Fix structure of sentence

In reply to Fabio Estevam

From: Fabio Estevam <[email protected]>

Re-structure the sentence a bit so that it can clearer.

Signed-off-by Fabio Estevam <[email protected]>

---
 doc/README.mx28_common |    7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

doc/README.mx28_common +3 -4

index bd12cab..c7a6839 100644
@@ -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:

Signature · 1 line

1.7.9.5

Stefano Babic

2013-06-26 15:42 UTC #7 lore raw

PATCH 3/6 README: mx28_common: Fix structure of sentence

Quoted 6 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>
Re-structure the sentence a bit so that it can clearer.
Signed-off-by Fabio Estevam <[email protected]>
---

Applied to u-boot-imx, thanks.

Best regards,
Stefano Babic

Signature · 5 lines

=====================================================================
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================

Fabio Estevam

author reviewer

2013-05-03 18:08 UTC #8 lore raw

PATCH 4/6 README: mxs: Introduce README.mxs

In reply to Fabio Estevam

From: Fabio Estevam <[email protected]>

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 <[email protected]>

---
 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%)

doc/README.m28 +2 -2

index 2a92226..cb3ae20 100644
@@ -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.

doc/README.mx28evk +1 -2

index 76db474..524f3fc 100644
@@ -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.

doc/README.mxs renamed from doc/README.mx28_common +37 ~~-25~~

126 lines not on this page · raw message

Signature · 1 line

1.7.9.5

Marek Vasut

2013-05-03 19:54 UTC #9 lore raw

PATCH 4/6 README: mxs: Introduce README.mxs

Dear Fabio Estevam,

Quoted 56 lines

From: Fabio Estevam <[email protected]>
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 <[email protected]>
---
 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%)
doc/README.m28 +0 -0
index 2a92226..cb3ae20 100644
@@ -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.
doc/README.mx28evk +0 -0
index 76db474..524f3fc 100644
@@ -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.
doc/README.mxs renamed from doc/README.mx28_common +0 -0
similarity index 80%
rename from doc/README.mx28_common
rename to doc/README.mxs
index c7a6839..6d0929a 100644

doc/README.mxs line 1

Quoted 3 lines

doc/README.mxs renamed from doc/README.mx28_common +1 -2

@@ -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

Stefano Babic

2013-06-26 15:42 UTC #10 lore raw

PATCH 4/6 README: mxs: Introduce README.mxs

In reply to Fabio Estevam

Quoted 8 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>
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.

Quoted 7 lines

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 <[email protected]>
---

Applied to u-boot-imx, thanks.

Best regards,
Stefano Babic

Signature · 5 lines

=====================================================================
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================

Fabio Estevam

author reviewer

2013-05-03 18:08 UTC #11 lore raw

PATCH 5/6 mx28evk: Move README file inside board directory

In reply to Fabio Estevam

From: Fabio Estevam <[email protected]>

Board specific READMEs should be located inside the respective board directory.

Signed-off-by Fabio Estevam <[email protected]>

---
 .../freescale/mx28evk/README                       |    0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)

board/freescale/mx28evk/README renamed from doc/README.mx28evk +0 -0

similarity index 100%
rename from doc/README.mx28evk
rename to board/freescale/mx28evk/README

Signature · 1 line

1.7.9.5

Stefano Babic

2013-06-26 15:43 UTC #12 lore raw

PATCH 5/6 mx28evk: Move README file inside board directory

board/freescale/mx28evk/README

Quoted 15 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>
Board specific READMEs should be located inside the respective board directory.
Signed-off-by Fabio Estevam <[email protected]>
---
 .../freescale/mx28evk/README                       |    0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)
board/freescale/mx28evk/README renamed from doc/README.mx28evk +0 -0
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

Signature · 5 lines

=====================================================================
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================

Otavio Salvador

2013-06-26 15:46 UTC #13 lore raw

PATCH 5/6 mx28evk: Move README file inside board directory

Quoted 19 lines · Stefano Babic

board/freescale/mx28evk/README
Quoted 15 lines · Fabio Estevam
From: Fabio Estevam <[email protected]>
Board specific READMEs should be located inside the respective board directory.
Signed-off-by Fabio Estevam <[email protected]>
---
 .../freescale/mx28evk/README                       |    0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)
board/freescale/mx28evk/README renamed from doc/README.mx28evk +0 -0
similarity index 100%
rename from doc/README.mx28evk
rename to board/freescale/mx28evk/README
Strange, I cannot find this patch in patchworks..anyway

Quoted 1 line

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

Marek Vasut

2013-06-26 19:57 UTC #14 lore raw

PATCH 5/6 mx28evk: Move README file inside board directory

Dear Otavio Salvador,

Quoted 21 lines · Stefano Babic

Quoted 20 lines · Fabio Estevam
board/freescale/mx28evk/README
Quoted 16 lines
From: Fabio Estevam <[email protected]>
Board specific READMEs should be located inside the respective board directory.
Signed-off-by Fabio Estevam <[email protected]>
---
 .../freescale/mx28evk/README                       |    0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename doc/README.mx28evk => board/freescale/mx28evk/README (100%)
board/freescale/mx28evk/README renamed from doc/README.mx28evk +0 -0
similarity index 100%
rename from doc/README.mx28evk
rename to board/freescale/mx28evk/README
Strange, I cannot find this patch in patchworks..anyway

Quoted 4 lines

Quoted 1 line
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

Fabio Estevam

author reviewer

2013-05-03 18:08 UTC #15 lore raw

PATCH 6/6 m28evk: Move README file inside board directory

In reply to Fabio Estevam

From: Fabio Estevam <[email protected]>

Board specific READMEs should be located inside the respective board directory.

Signed-off-by Fabio Estevam <[email protected]>

---
 doc/README.m28 => board/denx/m28evk/README |    0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename doc/README.m28 => board/denx/m28evk/README (100%)

board/denx/m28evk/README renamed from doc/README.m28 +0 -0

similarity index 100%
rename from doc/README.m28
rename to board/denx/m28evk/README

Signature · 1 line

1.7.9.5

Marek Vasut

2013-05-03 19:54 UTC #16 lore raw

PATCH 6/6 m28evk: Move README file inside board directory

Dear Fabio Estevam,

Quoted 4 lines

From: Fabio Estevam <[email protected]>
Board specific READMEs should be located inside the respective board directory.

Where did you find this rule?

Best regards,
Marek Vasut

Fabio Estevam

author reviewer

2013-05-03 20:23 UTC #17 lore raw

PATCH 6/6 m28evk: Move README file inside board directory

Quoted 8 lines · Marek Vasut

Dear Fabio Estevam,
Quoted 4 lines
From: Fabio Estevam <[email protected]>
Board specific READMEs should be located inside the respective board directory.
Where did you find this rule?

Here:

commit 702e6014f15b307f144fa03ecaf83a8446c6802a

Author: Wolfgang Denk <[email protected]>
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 <[email protected]>

Cc Prafulla Wadaskar <[email protected]>

Cc Stefan Roese <[email protected]>

Cc Kim Phillips <[email protected]>

Cc Andy Fleming <[email protected]>

Cc Jason Jin <[email protected]>

Cc Stefano Babic <[email protected]>

Cc Daniel Schwierzeck <[email protected]>

Acked-by Stefano Babic <[email protected]>

Acked-by Daniel Schwierzeck <[email protected]>

Marek Vasut

2013-05-03 20:47 UTC #18 lore raw

PATCH 6/6 m28evk: Move README file inside board directory

Dear Fabio Estevam,

Quoted 8 lines · Marek Vasut

Quoted 7 lines
Dear Fabio Estevam,
Quoted 4 lines
From: Fabio Estevam <[email protected]>
Board specific READMEs should be located inside the respective board directory.

Quoted 7 lines

Quoted 1 line
Where did you find this rule?
Here:
commit 702e6014f15b307f144fa03ecaf83a8446c6802a
Author: Wolfgang Denk <[email protected]>
Date:   Sun Apr 29 23:57:39 2012 +0000

I see, thanks.

Best regards,
Marek Vasut

Stefano Babic

2013-06-26 15:44 UTC #19 lore raw

PATCH 6/6 m28evk: Move README file inside board directory

In reply to Fabio Estevam

Quoted 6 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>
Board specific READMEs should be located inside the respective board directory.
Signed-off-by Fabio Estevam <[email protected]>
---

Applied to u-boot-imx, thanks.

Best regards,
Stefano Babic

Signature · 5 lines

=====================================================================
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================

Stefano Babic

2013-06-26 15:43 UTC #20 lore raw

PATCH 1/6 README: mx28_common: Keep the text within 80 columns

In reply to Fabio Estevam

Quoted 6 lines · Fabio Estevam

From: Fabio Estevam <[email protected]>
In order to improve readability keep the text within 80 columns.
Signed-off-by Fabio Estevam <[email protected]>
---

Applied to u-boot-imx, thanks.

Best regards,
Stefano Babic

Signature · 5 lines

=====================================================================
DENX Software Engineering GmbH,     MD: Wolfgang Denk & Detlev Zundel
HRB 165235 Munich, Office: Kirchenstr.5, D-82194 Groebenzell, Germany
Phone: +49-8142-66989-53 Fax: +49-8142-66989-80 Email: sbabic at denx.de
=====================================================================