Skip to content

Commit ad8d3eb

Browse files
committed
docs(linux): Power_Management: Cleanup documentation
Fixes whitespace and capitalization errors found throughout the documentation in the Power_Management section to make it look more professional. Fixes code block to be seen correctly. Signed-off-by: Kendall Willis <[email protected]>
1 parent bd31564 commit ad8d3eb

File tree

4 files changed

+14
-13
lines changed

4 files changed

+14
-13
lines changed

source/linux/Foundational_Components/Power_Management/pm_dfs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,7 @@ table.
332332
};
333333
334334
To disable any of the above OPP's one can simply add
335+
335336
.. code-block:: dts
336337
337338
status = "disabled";

source/linux/Foundational_Components/Power_Management/pm_low_power_modes.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ Similar to Deep Sleep, with the major distinction being that the MCU core is kep
112112
The benefits of using MCU Only mode:
113113

114114
#. Low power consumption: MCU Only mode can save a significant amount of power, especially in battery-powered
115-
devices. This is because The rest of the SoC status is the same as Deep Sleep and DDR is in self-refresh.
115+
devices. This is because the rest of the SoC status is the same as Deep Sleep and DDR is in self-refresh.
116116
#. Run background tasks: This mode can be used to run background tasks that do not require the full power of the system.
117117
For example, you could use the firmware on the MCU core to run a watchdog timer, a sensor polling loop,
118118
or a network communication task.

source/linux/Foundational_Components/Power_Management/pm_sw_arch.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Overview
1111
TI AM62 family of devices support multiple Suspend-to-RAM modes, including Deep Sleep
1212
and MCU Only as described in :ref:`Low Power Modes<lpm_modes>` section.
1313
The SoC consumes very low power overall yet it is not completely shut off in these modes.
14-
For example, During Deep Sleep, Certain IPs
14+
For example, during Deep Sleep, certain IPs
1515
(depending on the power domain to which then belong) will lose context on suspend.
1616
S/W should save and restore the context as required across state transitions. DDR is in self-
1717
refresh to allow context saving.
1818

19-
This section explains the high-level Software Flow of low power modes in AM62 family of devices.
19+
This section explains the high-level software flow of low power modes in AM62 family of devices.
2020
It also introduces the LPM constraints framework that enables seamless management of
2121
multiple Suspend-to-RAM modes.
2222

@@ -27,34 +27,34 @@ System diagram and components
2727
.. Image:: /images/AM62x_Deep_Sleep_Flow.png
2828

2929

30-
Above diagram has software sequence for how deep sleep (ie. Suspend to RAM) works on
30+
Above diagram has software sequence for how Deep Sleep (ie. Suspend to RAM) works on
3131
SK-AM62 ( Read more on the Starter Kit `here <https://www.ti.com/tool/SK-AM62>`__ ).
3232

3333
Deep Sleep Entry
3434
================
3535

36-
#. The user first instructs the System to Suspend. This triggers a suspend
37-
sequence from linux side (which runs on the A53 cluster of the SoC).
36+
#. The user first instructs the system to suspend. This triggers a suspend
37+
sequence from Linux side (which runs on the A53 cluster of the SoC).
3838

3939
#. As part of the TI_SCI driver's suspend hook, I/O isolation is invoked which
4040
isolates all the pads from their respective pinmuxed controllers. Refer to
4141
:ref:`Wakeup sources Documentation<pm_wakeup_sources>` to understand more on this.
4242

4343
#. Linux then suspends all the drivers in the order that they are probed.
44-
After ensuring that there were no faults in suspending the drivers, linux
44+
After ensuring that there were no faults in suspending the drivers, Linux
4545
then issues core system suspend which ultimately is a PSCI system
4646
suspend call. Read more about PSCI `here <https://developer.arm.com/Architectures/Power%20State%20Coordination%20Interface>`__
4747

4848
#. At this point only ATF is running on A53 cores and it does the job of
49-
sending a TISCI Message to the TIFS Core telling it to enter deep sleep
49+
sending a TISCI Message to the TIFS Core telling it to enter Deep Sleep
5050
and then it puts A53 into standby.
5151

5252
#. The TIFS Core then encrypts and writes the contents of it's own SRAM to DDR.
5353

5454
#. Further it stops tick timer, disables interrupts that are not needed, and suspends local drivers.
5555
After the above steps it sends TISCI To DM for Suspend Finish and enters WFI.
5656

57-
#. The DM (Device Manager) is the final entity in this entire deep sleep sequence. It does the following:
57+
#. The DM (Device Manager) is the final entity in this entire Deep Sleep sequence. It does the following:
5858

5959
a. Saves own context to DDR
6060
b. Disables Security IP LPSCs, such as LPSC_SAUL.
@@ -217,15 +217,15 @@ Otherwise, the mode selection is done as described below:
217217

218218
Above diagram shows the mode selection if constraints are set on MCU_WAKEUP devgroup devices.
219219
As shown, if the constraints are set on WAKEUP Domain devices or Always ON MCU domain devices,
220-
deep sleep mode will be selected. Otherwise, MCU Only mode will be selected.
220+
Deep Sleep mode will be selected. Otherwise, MCU Only mode will be selected.
221221

222222
If constraint is put on MAIN devgroup devices, then no low power mode is possible.
223223

224224
.. important::
225225

226226
USB devices are an exception in MAIN devgroup as there is extra hardware logic preventing
227227
reset of USB devices in Deep Sleep and MCU Only mode.
228-
If constraints are set on USB devices, deep sleep mode will be selected even though it's
228+
If constraints are set on USB devices, Deep Sleep mode will be selected even though it's
229229
technically part of MAIN devgroup.
230230

231231
.. ifconfig:: CONFIG_part_variant in ('AM62X')

source/linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ a specific way to be configured as wakeup sources.
262262

263263
For detailed information and sequence please refer to
264264
I/O Power Management and Daisy Chaining section in the TRM. To briefly explain,
265-
Setting the 29th Bit in the desired padconfig register, allows the pad to act as a wakeup source by
265+
setting the 29th Bit in the desired padconfig register, allows the pad to act as a wakeup source by
266266
triggering a wake irq to the DM R5 in deep sleep states.
267267

268268
.. note::
@@ -480,7 +480,7 @@ below command on the Host system
480480

481481
.. code-block:: console
482482
483-
HOST:~$ > lsusb -t
483+
HOST:~$ lsusb -t
484484
485485
486486
********************

0 commit comments

Comments
 (0)