Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Documentation: tps6594-pfsm: Fix macro cross-reference syntax 

C macro references are erroneously written using :c:macro:: (note the
double colon). This causes the references to be outputted as combination
of verbatim roles and italicized names instead.

Correct the syntax.

Fixes: dce5488896 ("Documentation: Add TI TPS6594 PFSM")
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251104041812.31402-4-bagasdotme@gmail.com>
This commit is contained in:
Bagas Sanjaya 2025-11-04 11:18:12 +07:00 committed by Jonathan Corbet
parent 3ba679d443
commit 77cbf5fbe5
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Documentation/misc-devices/tps6594-pfsm.rst
View File

@ -39,28 +39,28 @@ include/uapi/linux/tps6594_pfsm.h
Driver IOCTLs Driver IOCTLs
============= =============
:c:macro::`PMIC_GOTO_STANDBY` :c:macro:`PMIC_GOTO_STANDBY`
All device resources are powered down. The processor is off, and All device resources are powered down. The processor is off, and
no voltage domains are energized. no voltage domains are energized.
:c:macro::`PMIC_GOTO_LP_STANDBY` :c:macro:`PMIC_GOTO_LP_STANDBY`
The digital and analog functions of the PMIC, which are not The digital and analog functions of the PMIC, which are not
required to be always-on, are turned off (low-power). required to be always-on, are turned off (low-power).
:c:macro::`PMIC_UPDATE_PGM` :c:macro:`PMIC_UPDATE_PGM`
Triggers a firmware update. Triggers a firmware update.
:c:macro::`PMIC_SET_ACTIVE_STATE` :c:macro:`PMIC_SET_ACTIVE_STATE`
One of the operational modes. One of the operational modes.
The PMICs are fully functional and supply power to all PDN loads. The PMICs are fully functional and supply power to all PDN loads.
All voltage domains are energized in both MCU and Main processor All voltage domains are energized in both MCU and Main processor
sections. sections.
:c:macro::`PMIC_SET_MCU_ONLY_STATE` :c:macro:`PMIC_SET_MCU_ONLY_STATE`
One of the operational modes. One of the operational modes.
Only the power resources assigned to the MCU Safety Island are on. Only the power resources assigned to the MCU Safety Island are on.
:c:macro::`PMIC_SET_RETENTION_STATE` :c:macro:`PMIC_SET_RETENTION_STATE`
One of the operational modes. One of the operational modes.
Depending on the triggers set, some DDR/GPIO voltage domains can Depending on the triggers set, some DDR/GPIO voltage domains can
remain energized, while all other domains are off to minimize remain energized, while all other domains are off to minimize