Message ID | 20230331203615.8718-1-jm@ti.com |
---|---|
State | Superseded, archived |
Delegated to: | Heinrich Schuchardt |
Headers | show |
Series | doc: ti: Add switch setting for boot modes on AM62 SK | expand |
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 <jm@ti.com> Thanks for reworking. Reviewed-by: Tom Rini <trini@konsulko.com>
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 <jm@ti.com> > --- > > 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 > + - 01000000 > + - 11000010 > + * - OSPI > + - 00000000 > + - 11001110 > + * - EMMC > + - 00000000 > + - 11010010 > + * - UART > + - 00000000 > + - 11011100 > + * - USB DFU > + - 00000000 > + - 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 01000000 11000010 OSPI 00000000 11001110 EMMC 00000000 11010010 UART 00000000 11011100 USB DFU 00000000 11001010 ============ ============= ============= Best regards Heinrich > + > +For SW2 and SW1, the switch state in the "ON" position = 1.
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 <jm@ti.com> > > --- > > > > 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 > > + - 01000000 > > + - 11000010 > > + * - OSPI > > + - 00000000 > > + - 11001110 > > + * - EMMC > > + - 00000000 > > + - 11010010 > > + * - UART > > + - 00000000 > > + - 11011100 > > + * - USB DFU > > + - 00000000 > > + - 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 01000000 11000010 > OSPI 00000000 11001110 > EMMC 00000000 11010010 > UART 00000000 11011100 > USB DFU 00000000 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?
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 <jm@ti.com> >>> --- >>> >>> 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 >>> + - 01000000 >>> + - 11000010 >>> + * - OSPI >>> + - 00000000 >>> + - 11001110 >>> + * - EMMC >>> + - 00000000 >>> + - 11010010 >>> + * - UART >>> + - 00000000 >>> + - 11011100 >>> + * - USB DFU >>> + - 00000000 >>> + - 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 01000000 11000010 >> OSPI 00000000 11001110 >> EMMC 00000000 11010010 >> UART 00000000 11011100 >> USB DFU 00000000 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
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 + - 01000000 + - 11000010 + * - OSPI + - 00000000 + - 11001110 + * - EMMC + - 00000000 + - 11010010 + * - UART + - 00000000 + - 11011100 + * - USB DFU + - 00000000 + - 11001010 + +For SW2 and SW1, the switch state in the "ON" position = 1.
List some common boot modes and their corresponding switch settings for AM62 SK. Signed-off-by: Judith Mendez <jm@ti.com> --- Changes from v1: Change table format from ascii-art to list-table doc/board/ti/am62x_sk.rst | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+)