Minki/linux
1
0
Fork 1
mirror of https://github.com/torvalds/linux.git synced 2024-11-21 19:41:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Documentation: Add TI TPS6594 PFSM

Browse Source 
This patch adds documentation for the TPS6594 PFSM driver.

The PFSM controls the operational states of the TPS6594 PMIC.
Depending on the operational mode, some power domain networks
remain energized while others can be off.

Signed-off-by: Julien Panis <jpanis@baylibre.com>
Message-ID: <20230511095126.105104-6-jpanis@baylibre.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Julien Panis 2023-05-11 11:51:25 +02:00 committed by Greg Kroah-Hartman
parent a0df3ef087
commit dce5488896
3 changed files with 89 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/misc-devices/index.rst
View File

@ -28,5 +28,6 @@ fit into other categories.
oxsemi-tornado
pci-endpoint-test
spear-pcie-gadget
tps6594-pfsm
uacce
xilinx_sdfec

87
Documentation/misc-devices/tps6594-pfsm.rst Normal file
View File

@ -0,0 +1,87 @@
.. SPDX-License-Identifier: GPL-2.0
=====================================
Texas Instruments TPS6594 PFSM driver
=====================================
Author: Julien Panis (jpanis@baylibre.com)
Overview
========
Strictly speaking, PFSM (Pre-configurable Finite State Machine) is not
hardware. It is a piece of code.
The TPS6594 PMIC (Power Management IC) integrates a state machine which
manages operational modes. Depending on the current operational mode,
some voltage domains remain energized while others can be off.
The PFSM driver can be used to trigger transitions between configured
states. It also provides R/W access to the device registers.
Supported chips
---------------
- tps6594-q1
- tps6593-q1
- lp8764-q1
Driver location
===============
drivers/misc/tps6594-pfsm.c
Driver type definitions
=======================
include/uapi/linux/tps6594_pfsm.h
Driver IOCTLs
=============
:c:macro::`PMIC_GOTO_STANDBY`
All device resources are powered down. The processor is off, and
no voltage domains are energized.
:c:macro::`PMIC_GOTO_LP_STANDBY`
The digital and analog functions of the PMIC, which are not
required to be always-on, are turned off (low-power).
:c:macro::`PMIC_UPDATE_PGM`
Triggers a firmware update.
:c:macro::`PMIC_SET_ACTIVE_STATE`
One of the operational modes.
The PMICs are fully functional and supply power to all PDN loads.
All voltage domains are energized in both MCU and Main processor
sections.
:c:macro::`PMIC_SET_MCU_ONLY_STATE`
One of the operational modes.
Only the power resources assigned to the MCU Safety Island are on.
:c:macro::`PMIC_SET_RETENTION_STATE`
One of the operational modes.
Depending on the triggers set, some DDR/GPIO voltage domains can
remain energized, while all other domains are off to minimize
total system power.
Driver usage
============
See available PFSMs::
# ls /dev/pfsm*
Dump the registers of pages 0 and 1::
# hexdump -C /dev/pfsm-0-0x48
See PFSM events::
# cat /proc/interrupts
Userspace code example
----------------------
samples/pfsm/pfsm-wakeup.c

1
Documentation/userspace-api/ioctl/ioctl-number.rst
View File

@ -180,6 +180,7 @@ Code Seq# Include File Comments
'P' 00-0F drivers/usb/class/usblp.c conflict!
'P' 01-09 drivers/misc/pci_endpoint_test.c conflict!
'P' 00-0F xen/privcmd.h conflict!
'P' 00-05 linux/tps6594_pfsm.h conflict!
'Q' all linux/soundcard.h
'R' 00-1F linux/random.h conflict!
'R' 01 linux/rfkill.h conflict!