Skip to content

Commit 964783a

Browse files
committed
style(pm_wakeup_sources): reword CAN wakeup section
Reword CAN wakeup section to be more readable for users. Remove UART from section name since CAN is the wakeup source and CAN UART is the bank of pins the CAN is in. Signed-off-by: Kendall Willis <k-willis@ti.com>
1 parent afd8f7f commit 964783a

1 file changed

Lines changed: 15 additions & 31 deletions

File tree

source/linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst

Lines changed: 15 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ valid for given low power modes:
2727
+------------------------------------------------+------------+----------+-------------+
2828
| MCU IPC (for MCU Only mode) | No | Yes | No |
2929
+------------------------------------------------+------------+----------+-------------+
30-
| CAN UART I/O Daisy Chain | Yes | Yes | Yes |
30+
| CAN I/O Daisy Chain | Yes | Yes | Yes |
3131
+------------------------------------------------+------------+----------+-------------+
3232

3333
.. ifconfig:: CONFIG_part_variant in ('AM62AX', 'AM62PX')
@@ -48,7 +48,7 @@ valid for given low power modes:
4848
+------------------------------------------------+-------+------+---------+----------+
4949
| MCU IPC (for MCU Only mode) | No | Yes | No | No |
5050
+------------------------------------------------+-------+------+---------+----------+
51-
| CAN UART I/O Daisy Chain | Yes | Yes | Yes | Yes |
51+
| CAN I/O Daisy Chain | Yes | Yes | Yes | Yes |
5252
+------------------------------------------------+-------+------+---------+----------+
5353

5454
.. ifconfig:: CONFIG_part_variant in ('AM62LX')
@@ -982,45 +982,29 @@ MCU IPC based Wakeup
982982
983983
[IPC RPMSG ECHO] Main domain resumed due to MCU UART
984984
985-
************************
986-
CAN UART I/O Daisy Chain
987-
************************
985+
986+
*******************
987+
CAN I/O Daisy Chain
988+
*******************
988989

989990
.. ifconfig:: CONFIG_part_variant in ('AM62LX')
990991

991-
CAN UART wakeup is not supported on AM62LX.
992+
CAN wakeup is not supported on AM62LX.
992993

993994
.. ifconfig:: CONFIG_part_variant in ('AM62X', 'AM62AX', 'AM62PX')
994995

995-
It is possible to wakeup the system from CAN UART pins in all supported low
996-
power modes. This is possible once CAN UART is configured.
997-
998-
To set CAN UART as a wakeup source, a pinctrl state called "wakeup" needs to be
999-
added to the device tree. The "wakeup" pinctrl state will set the WKUP_EN flag
1000-
on the desired padconfig register. When the WKUP_EN flag (29th bit) is set, it
1001-
allows the pad to act as a wakeup source. If CAN UART has the "wakeup" pinctrl
1002-
state defined, then the Linux mcan driver is able to switch to the pinctrl
1003-
"wakeup" state during suspend which enables CAN UART wakeup.
996+
CAN pins can be used to wake the system from any supported low power mode.
997+
To enable this, in the device tree configure a "wakeup" pinctrl state that sets
998+
the WKUP_EN flag (29th bit) on the desired padconfig register. This allows the
999+
mcan driver to switch to the wakeup state during suspend.
10041000

1005-
The mcan_uart0 and mcan_uart1 nodes in
1006-
`k3-am62x-sk-lpm-io-ddr-wkup-sources.dtso <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/arch/arm64/boot/dts/ti/k3-am62x-sk-lpm-io-ddr-wkup-sources.dtso?h=11.02.08>`__
1007-
can be used as a reference for enabling CAN UART wakeup.
1001+
Refer to the mcu_mcan0 and mcu_mcan1 nodes in
1002+
`k3-am62x-sk-lpm-wkup-sources.dtso <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/arch/arm64/boot/dts/ti/k3-am62x-sk-lpm-wkup-sources.dtso?h=11.02.08>`__
1003+
for a complete example:
10081004

1009-
.. code-block:: text
1005+
.. code-block:: dts
10101006
10111007
&mcu_pmx0 {
1012-
mcu_mcan0_tx_pins_default: mcu-mcan0-tx-pins-default {
1013-
pinctrl-single,pins = <
1014-
AM62X_IOPAD(0x034, PIN_OUTPUT, 0) /* (D6) MCU_MCAN0_TX */
1015-
>;
1016-
};
1017-
1018-
mcu_mcan0_rx_pins_default: mcu-mcan0-rx-pins-default {
1019-
pinctrl-single,pins = <
1020-
AM62X_IOPAD(0x038, PIN_INPUT, 0) /* (B3) MCU_MCAN0_RX */
1021-
>;
1022-
};
1023-
10241008
mcu_mcan0_rx_pins_wakeup: mcu-mcan0-rx-pins-wakeup {
10251009
pinctrl-single,pins = <
10261010
AM62X_IOPAD(0x038, PIN_INPUT | WKUP_EN, 0) /* (B3) MCU_MCAN0_RX */

0 commit comments

Comments
 (0)