dts: atmel sam: Document what rxpo and txpo mean.

The meaning of txpo is was a bit confusing, as it's an enumeration
rather than a pad number. This confusion extended to the atsamd21_xpro
board using the wrong pins.

This commit adds ASCII-art tables that explain the meaning of rxpo
and txpo on different platforms.

Signed-off-by: Tom Rothamel <tom@rothamel.us>
This commit is contained in:
Tom Rothamel 2023-02-21 10:16:28 -05:00 committed by Henrik Brix Andersen
parent e9b26b5eb6
commit d1bfea0e4e

View file

@ -22,12 +22,82 @@ properties:
rxpo:
type: int
required: true
description: Receive Data Pinout
description: |
Receive Data Pinout. An enumeration with the following values:
+-------+---------------+
| Value | RX Pin |
+-------+---------------+
| 0 | SERCOM_PAD[0] |
+-------+---------------+
| 1 | SERCOM_PAD[1] |
+-------+---------------+
| 2 | SERCOM_PAD[2] |
+-------+---------------+
| 3 | SERCOM_PAD[3] |
+-------+---------------+
txpo:
type: int
required: true
description: Transmit Data Pinout
description: |
Transmit Data Pinout. An enumeration with values that depend on the
hardware being used. This controls both the transmit pins and if
hardware flow control is used.
SAMD20:
+-------+---------------+
| Value | TX Pin |
+-------+---------------+
| 0 | SERCOM_PAD[0] |
+-------+---------------+
| 1 | SERCOM_PAD[2] |
+-------+---------------+
SAMD21/DA21/R21:
+-------+---------------+---------------+---------------+
| Value | TX Pin | RTS | CTS |
+-------+---------------+---------------+---------------+
| 0 | SERCOM_PAD[0] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 1 | SERCOM_PAD[2] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 2 | SERCOM_PAD[0] | SERCOM_PAD[2] | SERCOM_PAD[3] |
+-------+---------------+---------------+---------------+
| 3 | Reserved |
+-------+-----------------------------------------------+
SAML2x/C2x:
+-------+----------------+---------------+--------------+
| Value | TX Pin | RTS | CTS |
+-------+---------------+---------------+---------------+
| 0 | SERCOM_PAD[0] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 1 | SERCOM_PAD[2] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 2 | SERCOM_PAD[0] | SERCOM_PAD[2] | SERCOM_PAD[3] |
+-------+---------------+---------------+---------------+
| 3 | SERCOM_PAD[0] | SERCOM_PAD[2] | N/A |
+-------+---------------+---------------+---------------+
SAMD5/E5:
+-------+---------------+---------------+---------------+
| Value | TX Pin | RTS | CTS |
+-------+---------------+---------------+---------------+
| 0 | SERCOM_PAD[0] | N/A | N/A |
+-------+---------------+---------------+---------------+
| 1 | Reserved |
+-------+---------------+---------------+---------------+
| 2 | SERCOM_PAD[0] | SERCOM_PAD[2] | SERCOM_PAD[3] |
+-------+---------------+---------------+---------------+
| 3 | SERCOM_PAD[0] | SERCOM_PAD[2] | N/A |
+-------+---------------+---------------+---------------+
collision-detection:
type: boolean