-
Notifications
You must be signed in to change notification settings - Fork 33
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(linux): Power_Management: LPM documentation cleanups #102
Conversation
New warnings found with rstcheck:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Most of this is useful. Just a nitpick about pins and device specific sections.
source/linux/Foundational_Components/Power_Management/pm_sw_arch.rst
Outdated
Show resolved
Hide resolved
source/linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst
Show resolved
Hide resolved
source/linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check if all below references are still valid, if they are use 10.01.10
tag in URLs
linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst:182:
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=10.00.07`
linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst:241:
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=10.00.07`
linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst:284:main_uart0 node in
k3-am62x-sk-common.dtsi https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/arch/arm64/boot/dts/ti/k3-am62x-sk-common.dtsi?h=10.00.07`
linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst:347:gpio_key node in
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=10.00.07#n21`
linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst:350:
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=10.00.07`
linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst:374:
k3-am62-wakeup.dtsi https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/arch/arm64/boot/dts/ti/k3-am62-wakeup.dtsi?h=10.00.07#n36`
linux/Foundational_Components/Power_Management/pm_sw_arch.rst:154:#. TISCI PM Domain driver: https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/drivers/pmdomain/ti/ti_sci_pm_domains.c?h=10.00.07
linux/Foundational_Components/Power_Management/pm_sw_arch.rst:155:#. TISCI driver: https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/drivers/pmdomain/ti/ti_sci_pm_domains.c?h=10.00.07
linux/Foundational_Components/Power_Management/pm_sw_arch.rst:180:https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/drivers/remoteproc/ti_k3_r5_remoteproc.c?h=10.00.07#n535
linux/Foundational_Components/Power_Management/pm_low_power_modes.rst:241:when
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=10.00.07`
linux/Foundational_Components/Kernel/Kernel_Drivers/E5010_JPEG_Encoder.rst:16: <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/drivers/media/platform/imagination/e5010/e5010-jpeg-enc.c?h=10.00.07>
linux/Foundational_Components/U-Boot/UG-Splash-Screen.rst:219: *
Splash screen config fragment for AM62x and AM62P https://git.ti.com/cgit/ti-u-boot/ti-u-boot/tree/configs/am62x_a53_splashscreen.config?h=10.00.07`
linux/Foundational_Components/U-Boot/UG-Splash-Screen.rst:226: *
Splash screen config fragment for AM62x and AM62P https://git.ti.com/cgit/ti-u-boot/ti-u-boot/tree/configs/am62x_a53_splashscreen.config?h=10.00.07`
source/linux/Foundational_Components/Power_Management/pm_sw_arch.rst
Outdated
Show resolved
Hide resolved
source/linux/Foundational_Components/Power_Management/pm_sw_arch.rst
Outdated
Show resolved
Hide resolved
@kwillis01 can you resolve the merge conflicts |
06e9062
to
cb08031
Compare
Author has updated the PR
@DhruvaG2000 @akashdeep-ti for reviews |
source/linux/Foundational_Components/Power_Management/pm_low_power_modes.rst
Outdated
Show resolved
Hide resolved
source/linux/Foundational_Components/Power_Management/pm_wakeup_sources.rst
Outdated
Show resolved
Hide resolved
Fixes whitespace and grammar 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]>
Documentation details a resume latency constraint that would allow a device to not be powered off during suspend/resume in the device constraint section. This puts the resume latency constraint into the correct section. It also cleans up the constraint wording. Signed-off-by: Kendall Willis <[email protected]>
The MCU GPIO wakeup pin was incorrect in the documentation. Updated to specify the correct pin. Signed-off-by: Kendall Willis <[email protected]>
Update any link tags to 10.01.10 if needed. Correct a misdirected link to the correct resource. Signed-off-by: Kendall Willis <[email protected]>
Move a detailed latency constraint from device constraint section to the latency constraint section. Fix the MCU GPIO wakeup pin which was documented incorrectly. Cleanup capitalization and whitespace errors.