diff mbox series

[v2,3/3] doc: TPMI: Add debugfs documentation

Message ID 20230711220949.71881-4-srinivas.pandruvada@linux.intel.com (mailing list archive)
State Changes Requested, archived
Headers show
Series TPMI control and debugfs support | expand

Commit Message

srinivas pandruvada July 11, 2023, 10:09 p.m. UTC 
Describe fields in the TPMI debugfs folder.

Signed-off-by: Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
---
v2
New.

 Documentation/ABI/testing/debugfs-tpmi | 31 ++++++++++++++++++++++++++
 MAINTAINERS                            |  1 +
 2 files changed, 32 insertions(+)
 create mode 100644 Documentation/ABI/testing/debugfs-tpmi

Comments

Andy Shevchenko July 12, 2023, 3:14 p.m. UTC | #1 
On Tue, Jul 11, 2023 at 03:09:49PM -0700, Srinivas Pandruvada wrote:
> Describe fields in the TPMI debugfs folder.

...

> +What:		/sys/kernel/debug/tpmi-<n>/pfs_dump
> +Date:		December 2023

November ?

> +KernelVersion:	6.6

...

> +Date:		December 2023

> +Date:		December 2023
srinivas pandruvada July 12, 2023, 11:07 p.m. UTC | #2 
On Wed, 2023-07-12 at 18:14 +0300, Andy Shevchenko wrote:
> On Tue, Jul 11, 2023 at 03:09:49PM -0700, Srinivas Pandruvada wrote:
> > Describe fields in the TPMI debugfs folder.
> 
> ...
> 
> > +What:          /sys/kernel/debug/tpmi-<n>/pfs_dump
> > +Date:          December 2023
> 
> November ?
> 
Changed.


Thanks,
Srinivas

> > +KernelVersion: 6.6
> 
> ...
> 
> > +Date:          December 2023
> 
> > +Date:          December 2023
>
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/debugfs-tpmi b/Documentation/ABI/testing/debugfs-tpmi
new file mode 100644
index 000000000000..9b530c1aaa2d
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-tpmi
@@ -0,0 +1,31 @@ 
+What:		/sys/kernel/debug/tpmi-<n>/pfs_dump
+Date:		December 2023
+KernelVersion:	6.6
+Contact:	srinivas.pandruvada@linux.intel.com
+Description:
+The PFS (PM Feature Structure) table, shows details of each power
+management feature. This includes:
+tpmi_id, number of entries, entry size, offset, vsec offset, lock status
+and disabled status.
+Users:		Debugging, any user space test suite
+
+What:		/sys/kernel/debug/tpmi-<n>/tpmi-id-<n>/mem_dump
+Date:		December 2023
+KernelVersion:	6.6
+Contact:	srinivas.pandruvada@linux.intel.com
+Description:
+Shows the memory dump of the MMIO region for a TPMI ID.
+Users:		Debugging, any user space test suite
+
+What:		/sys/kernel/debug/tpmi-<n>/tpmi-id-<n>/mem_write
+Date:		December 2023
+KernelVersion:	6.6
+Contact:	srinivas.pandruvada@linux.intel.com
+Description:
+Allows to write at any offset. It doesn't check for Read/Write access
+as hardware will not allow to write at read-only memory. This write is
+at offset multiples of 4. The format is instance,offset,contents.
+Example:
+echo 0,0x20,0xff > mem_write
+echo 1,64,64 > mem_write
+Users:		Debugging, any user space test suite
diff --git a/MAINTAINERS b/MAINTAINERS
index 5761b02183a7..4d439121fb36 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -10720,6 +10720,7 @@  INTEL TPMI DRIVER
 M:	Srinivas Pandruvada <srinivas.pandruvada@linux.intel.com>
 L:	platform-driver-x86@vger.kernel.org
 S:	Maintained
+F:	Documentation/ABI/testing/debugfs-tpmi
 F:	drivers/platform/x86/intel/tpmi.c
 F:	include/linux/intel_tpmi.h