Re: [PATCH] doc: ti: Add switch setting for boot modes on AM62 SK

2023-04-06 Thread Mendez, Judith

Hello,

On 4/4/2023 9:22 AM, Tom Rini wrote:

On Tue, Apr 04, 2023 at 03:59:56PM +0200, Heinrich Schuchardt wrote:

On 3/31/23 22:36, Judith Mendez wrote:

List some common boot modes and their corresponding switch
settings for AM62 SK.

Signed-off-by: Judith Mendez 
---

Changes from v1: Change table format from ascii-art to list-table

   doc/board/ti/am62x_sk.rst | 36 
   1 file changed, 36 insertions(+)

diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
index b1b7d99befb..3d85400b1a1 100644
--- a/doc/board/ti/am62x_sk.rst
+++ b/doc/board/ti/am62x_sk.rst
@@ -229,3 +229,39 @@ Image formats:
   | |   SPL DTB 1...N   | |
   | +---+ |
   +---+
+
+Switch Setting for Boot Mode
+
+
+Boot Mode pins provide means to select the boot mode and options before the
+device is powered up. After every POR, they are the main source to populate
+the Boot Parameter Tables.
+
+The following table shows some common boot modes used on AM62 platform. More
+details can be found in the Technical Reference Manual:
+https://www.ti.com/lit/pdf/spruiv7 under the `Boot Mode Pins` section.
+
+.. list-table:: Boot Modes
+   :widths: 32 32 32
+   :header-rows: 1
+
+   * - Switch Label
+ - SW2: 12345678
+ - SW3: 12345678
+   * - SD
+ - 0100
+ - 1110
+   * - OSPI
+ - 
+ - 11001110
+   * - EMMC
+ - 
+ - 11010010
+   * - UART
+ - 
+ - 11011100
+   * - USB DFU
+ - 
+ - 11001010


Hello Judith,

ReStructured text allows different flavors of formatting tables.

The HTML output for the table above is correct but the .rst file is hard
to read in a text-editor. I would prefer:

*Boot Modes*

 = =
Switch Label SW2: 12345678 SW3: 12345678
 = =
SD   0100  1110
OSPI   11001110
EMMC   11010010
UART   11011100
USB DFU    11001010
 = =


There's other list-table entires in the docs today. I'm fine either way,
but we need to be consistent in the docs, and should update perhaps
doc/develop/codingstyle.rst should get a section too on docs?



I will send again with the ASCII-style so y'all have the option.

regards,
Judith


Re: [PATCH] doc: ti: Add switch setting for boot modes on AM62 SK

2023-04-04 Thread Tom Rini
On Tue, Apr 04, 2023 at 03:59:56PM +0200, Heinrich Schuchardt wrote:
> On 3/31/23 22:36, Judith Mendez wrote:
> > List some common boot modes and their corresponding switch
> > settings for AM62 SK.
> > 
> > Signed-off-by: Judith Mendez 
> > ---
> > 
> > Changes from v1: Change table format from ascii-art to list-table
> > 
> >   doc/board/ti/am62x_sk.rst | 36 
> >   1 file changed, 36 insertions(+)
> > 
> > diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
> > index b1b7d99befb..3d85400b1a1 100644
> > --- a/doc/board/ti/am62x_sk.rst
> > +++ b/doc/board/ti/am62x_sk.rst
> > @@ -229,3 +229,39 @@ Image formats:
> >   | |   SPL DTB 1...N   | |
> >   | +---+ |
> >   +---+
> > +
> > +Switch Setting for Boot Mode
> > +
> > +
> > +Boot Mode pins provide means to select the boot mode and options before the
> > +device is powered up. After every POR, they are the main source to populate
> > +the Boot Parameter Tables.
> > +
> > +The following table shows some common boot modes used on AM62 platform. 
> > More
> > +details can be found in the Technical Reference Manual:
> > +https://www.ti.com/lit/pdf/spruiv7 under the `Boot Mode Pins` section.
> > +
> > +.. list-table:: Boot Modes
> > +   :widths: 32 32 32
> > +   :header-rows: 1
> > +
> > +   * - Switch Label
> > + - SW2: 12345678
> > + - SW3: 12345678
> > +   * - SD
> > + - 0100
> > + - 1110
> > +   * - OSPI
> > + - 
> > + - 11001110
> > +   * - EMMC
> > + - 
> > + - 11010010
> > +   * - UART
> > + - 
> > + - 11011100
> > +   * - USB DFU
> > + - 
> > + - 11001010
> 
> Hello Judith,
> 
> ReStructured text allows different flavors of formatting tables.
> 
> The HTML output for the table above is correct but the .rst file is hard
> to read in a text-editor. I would prefer:
> 
> *Boot Modes*
> 
>  = =
> Switch Label SW2: 12345678 SW3: 12345678
>  = =
> SD   0100  1110
> OSPI   11001110
> EMMC   11010010
> UART   11011100
> USB DFU    11001010
>  = =

There's other list-table entires in the docs today. I'm fine either way,
but we need to be consistent in the docs, and should update perhaps
doc/develop/codingstyle.rst should get a section too on docs?

-- 
Tom


signature.asc
Description: PGP signature


Re: [PATCH] doc: ti: Add switch setting for boot modes on AM62 SK

2023-04-04 Thread Heinrich Schuchardt

On 3/31/23 22:36, Judith Mendez wrote:

List some common boot modes and their corresponding switch
settings for AM62 SK.

Signed-off-by: Judith Mendez 
---

Changes from v1: Change table format from ascii-art to list-table

  doc/board/ti/am62x_sk.rst | 36 
  1 file changed, 36 insertions(+)

diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
index b1b7d99befb..3d85400b1a1 100644
--- a/doc/board/ti/am62x_sk.rst
+++ b/doc/board/ti/am62x_sk.rst
@@ -229,3 +229,39 @@ Image formats:
  | |   SPL DTB 1...N   | |
  | +---+ |
  +---+
+
+Switch Setting for Boot Mode
+
+
+Boot Mode pins provide means to select the boot mode and options before the
+device is powered up. After every POR, they are the main source to populate
+the Boot Parameter Tables.
+
+The following table shows some common boot modes used on AM62 platform. More
+details can be found in the Technical Reference Manual:
+https://www.ti.com/lit/pdf/spruiv7 under the `Boot Mode Pins` section.
+
+.. list-table:: Boot Modes
+   :widths: 32 32 32
+   :header-rows: 1
+
+   * - Switch Label
+ - SW2: 12345678
+ - SW3: 12345678
+   * - SD
+ - 0100
+ - 1110
+   * - OSPI
+ - 
+ - 11001110
+   * - EMMC
+ - 
+ - 11010010
+   * - UART
+ - 
+ - 11011100
+   * - USB DFU
+ - 
+ - 11001010


Hello Judith,

ReStructured text allows different flavors of formatting tables.

The HTML output for the table above is correct but the .rst file is hard
to read in a text-editor. I would prefer:

*Boot Modes*

 = =
Switch Label SW2: 12345678 SW3: 12345678
 = =
SD   0100  1110
OSPI   11001110
EMMC   11010010
UART   11011100
USB DFU    11001010
 = =

Best regards

Heinrich



+
+For SW2 and SW1, the switch state in the "ON" position = 1.




Re: [PATCH] doc: ti: Add switch setting for boot modes on AM62 SK

2023-03-31 Thread Tom Rini
On Fri, Mar 31, 2023 at 03:36:15PM -0500, Judith Mendez wrote:

> List some common boot modes and their corresponding switch
> settings for AM62 SK.
> 
> Signed-off-by: Judith Mendez 

Thanks for reworking.

Reviewed-by: Tom Rini 

-- 
Tom


signature.asc
Description: PGP signature


Re: [PATCH] doc: ti: Add switch setting for boot modes on AM62 SK

2023-03-27 Thread Tom Rini
On Mon, Mar 27, 2023 at 11:15:21AM -0500, Judith Mendez wrote:

> List some common boot modes and their corresponding switch
> settings for AM62 SK.
> 
> Signed-off-by: Judith Mendez 
> ---
>  doc/board/ti/am62x_sk.rst | 29 +
>  1 file changed, 29 insertions(+)

Please see doc/board/apple/m1.rst for an example of list-table rather
than ascii-art tables. We should be adding this information via
list-table and then cleaning up existing parts of the docs to also use
it, thanks.

-- 
Tom


signature.asc
Description: PGP signature


Re: [PATCH] doc: ti: Add switch setting for boot modes on AM62 SK

2023-01-11 Thread Bryan Brattlof
Hi Judith

Wild... I'm not seeing this on the list? did you get a bounce?

On January 10, 2023 thus sayeth Andrew Davis:
> On 1/10/23 3:25 PM, Judith Mendez wrote:
> > List some common boot modes and their corresponding switch
> > settings for AM62 SK.
> > 
> > Signed-off-by: Judith Mendez 
> > ---
> 
> Acked-by: Andrew Davis 

Reviewed-by: Bryan Brattlof  


Re: [PATCH] doc: ti: Add switch setting for boot modes on AM62 SK

2023-01-10 Thread Andrew Davis

On 1/10/23 3:25 PM, Judith Mendez wrote:

List some common boot modes and their corresponding switch
settings for AM62 SK.

Signed-off-by: Judith Mendez 
---


Acked-by: Andrew Davis 


  doc/board/ti/am62x_sk.rst | 29 +
  1 file changed, 29 insertions(+)

diff --git a/doc/board/ti/am62x_sk.rst b/doc/board/ti/am62x_sk.rst
index b1b7d99befb..40d58ea8bfa 100644
--- a/doc/board/ti/am62x_sk.rst
+++ b/doc/board/ti/am62x_sk.rst
@@ -229,3 +229,32 @@ Image formats:
  | |   SPL DTB 1...N   | |
  | +---+ |
  +---+
+
+Switch Setting for Boot Mode
+
+
+Boot Mode pins provide means to select the boot mode and options before the
+device is powered up. After every POR, they are the main source to populate
+the Boot Parameter Tables.
+
+The following table shows some common boot modes used on AM62 platform. More
+details can be found in the Technical Reference Manual:
+https://www.ti.com/lit/pdf/spruiv7 under the `Boot Mode Pins` section.
+
++--+++
+|*Boot Mode*   | *SW2*  | *SW1*  |
++--+++
+| Switch label | 12345678   | 12345678   |
++==+++
+| SD   | 0100   | 1110   |
++--+++
+| OSPI |    | 11001110   |
++--+++
+| EMMC |    | 11010010   |
++--+++
+| UART |    | 11011100   |
++--+++
+| USB DFU  |    | 11001010   |
++--+++
+
+For SW2 and SW1, the switch state in the "ON" position = 1.