Skip to contentSkip to conversation

doc: ti: Add switch setting for boot modes on AM62 SK

PATCH Superseded Judith Mendez 3 participants 5 messages Mar 31, 2023 – Apr 6, 2023

v1 of 3 Superseded Latest is v3 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: ti: Add switch setting for boot modes on AM62 SK

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

---

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

 doc/board/ti/am62x_sk.rst | 36 ++++++++++++++++++++++++++++++++++++
 1 file changed, 36 insertions(+)
doc/board/ti/am62x_sk.rst +36 -0
index b1b7d99befb..3d85400b1a1 100644
@@ -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.
Signature · 1 line
2.17.1
#2 lore raw
In reply to Judith Mendez
Quoted 43 lines · Judith Mendez

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

---

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

  doc/board/ti/am62x_sk.rst | 36 ++++++++++++++++++++++++++++++++++++
  1 file changed, 36 insertions(+)
doc/board/ti/am62x_sk.rst +24 -0
index b1b7d99befb..3d85400b1a1 100644
@@ -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

doc/board/ti/am62x_sk.rst Image formats: · line 265

Quoted 10 lines
doc/board/ti/am62x_sk.rst +10 -0
+     - 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

Quoted 2 lines
doc/board/ti/am62x_sk.rst +2 -0
+
+For SW2 and SW1, the switch state in the "ON" position = 1.
#3 lore raw
Quoted 67 lines · Heinrich Schuchardt
Quoted 43 lines · Judith Mendez

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

---

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

  doc/board/ti/am62x_sk.rst | 36 ++++++++++++++++++++++++++++++++++++
  1 file changed, 36 insertions(+)
doc/board/ti/am62x_sk.rst +24 -0
index b1b7d99befb..3d85400b1a1 100644
@@ -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

doc/board/ti/am62x_sk.rst Image formats: · line 265

Quoted 10 lines
doc/board/ti/am62x_sk.rst +10 -0
+     - 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
============ ============= =============

Quoted 6 lines
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?

Signature · 1 line
Tom
#4 lore raw

Hello,

Quoted 75 lines · Tom Rini
Quoted 67 lines · Heinrich Schuchardt
Quoted 43 lines · Judith Mendez

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

---

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

   doc/board/ti/am62x_sk.rst | 36 ++++++++++++++++++++++++++++++++++++
   1 file changed, 36 insertions(+)
doc/board/ti/am62x_sk.rst +24 -0
index b1b7d99befb..3d85400b1a1 100644
@@ -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

doc/board/ti/am62x_sk.rst Image formats: · line 265

Quoted 10 lines
doc/board/ti/am62x_sk.rst +10 -0
+     - 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
============ ============= =============

Quoted 6 lines
SD           01000000      11000010
OSPI         00000000      11001110
EMMC         00000000      11010010
UART         00000000      11011100
USB DFU      00000000      11001010

============ ============= =============

Quoted 4 lines

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