From: Eddie James <eajames@linux.vnet.ibm.com>
To: linux-kernel@vger.kernel.org
Cc: linux-hwmon@vger.kernel.org, devicetree@vger.kernel.org,
linux-doc@vger.kernel.org, linux@roeck-us.net, jdelvare@suse.com,
corbet@lwn.net, mark.rutland@arm.com, robh+dt@kernel.org,
joel@jms.id.au, eajames@linux.vnet.ibm.com,
"Edward A. James" <eajames@us.ibm.com>
Subject: [PATCH v3 02/12] Documentation: ABI: Add occ-hwmon driver sysfs documentation
Date: Mon, 20 Nov 2017 17:53:31 -0600 [thread overview]
Message-ID: <1511222021-562-3-git-send-email-eajames@linux.vnet.ibm.com> (raw)
In-Reply-To: <1511222021-562-1-git-send-email-eajames@linux.vnet.ibm.com>
From: "Edward A. James" <eajames@us.ibm.com>
Detail the sysfs attributes provided by the occ-hwmon driver.
Signed-off-by: Edward A. James <eajames@us.ibm.com>
---
Documentation/ABI/testing/sysfs-driver-occ-hwmon | 85 ++++++++++++++++++++++++
1 file changed, 85 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-driver-occ-hwmon
diff --git a/Documentation/ABI/testing/sysfs-driver-occ-hwmon b/Documentation/ABI/testing/sysfs-driver-occ-hwmon
new file mode 100644
index 0000000..8873cc3
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-driver-occ-hwmon
@@ -0,0 +1,85 @@
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_active
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates (with a "1" or a "0",
+ respectively) whether or not this OCC is in the "active" state.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_dvfs_ot
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates (with a "1" or a "0",
+ respectively) whether or not this OCC has limited the processor
+ frequency due to over-temperature.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_dvfs_power
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates (with a "1" or a "0",
+ respectively) whether or not this OCC has limited the processor
+ frequency due to power usage.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_error
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates any error condition
+ observed by the OCC or detected by the driver. Reading the
+ attribute will return an integer. A negative integer indicates
+ either an error response from the OCC or bus error or other
+ error condition detected by the driver. A "0" indicates no
+ error.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_master
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates (with a "1" or a "0",
+ respectively) whether or not this OCC is the "master" OCC.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_mem_throttle
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates (with a "1" or a "0",
+ respectively) whether or not the OCC has throttled memory due
+ to over-temperature.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occs_present
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates the number of OCCs present
+ on the system.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_quick_drop
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates (with a "1" or a "0",
+ respectively) whether or not this OCC has asserted the "quick
+ power drop" signal.
+
+What: /sys/bus/platform/drivers/occ-hwmon/<dev>/occ_status
+Date: November 2017
+KernelVersion: 4.14
+Contact: eajames@us.ibm.com
+Description:
+ A read-only attribute that indicates the current OCC state. The
+ value of the attribute will be one of the following states:
+ 0: Reserved
+ 1: Standby
+ 2: Observation
+ 3: Active
+ 4: Safe
+ 5: Characterization
--
1.8.3.1
next prev parent reply other threads:[~2017-11-20 23:53 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-11-20 23:53 [PATCH v3 00/12] hwmon: Add On-Chip Controller hwmon driver Eddie James
2017-11-20 23:53 ` [PATCH v3 01/12] Documentation: hwmon: Add OCC documentation Eddie James
2017-11-20 23:53 ` Eddie James [this message]
2017-11-22 15:15 ` [v3, 02/12] Documentation: ABI: Add occ-hwmon driver sysfs documentation Guenter Roeck
2017-11-20 23:53 ` [PATCH v3 03/12] dt-bindings: i2c: Add P8 OCC hwmon device documentation Eddie James
2017-11-21 18:34 ` Rob Herring
2017-11-20 23:53 ` [PATCH v3 04/12] dt-bindings: fsi: Add P9 " Eddie James
[not found] ` <1511222021-562-5-git-send-email-eajames-23VcF4HTsmIX0ybBhKVfKdBPR1lH4CV8@public.gmane.org>
2017-11-21 18:36 ` Rob Herring
2017-11-20 23:53 ` [PATCH v3 05/12] hwmon: Add On-Chip Controller (OCC) hwmon driver Eddie James
2017-11-20 23:53 ` [PATCH v3 07/12] hwmon (occ): Parse OCC poll response Eddie James
2017-11-20 23:53 ` [PATCH v3 08/12] hwmon (occ): Add sensor types and versions Eddie James
2017-11-20 23:53 ` [PATCH v3 09/12] hwmon (occ): Add sensor attributes and register hwmon device Eddie James
2017-11-22 15:22 ` [v3, " Guenter Roeck
[not found] ` <1511222021-562-1-git-send-email-eajames-23VcF4HTsmIX0ybBhKVfKdBPR1lH4CV8@public.gmane.org>
2017-11-20 23:53 ` [PATCH v3 06/12] hwmon (occ): Add command transport method for P8 and P9 Eddie James
2017-11-20 23:53 ` [PATCH v3 10/12] hwmon (occ): Add non-hwmon attributes Eddie James
[not found] ` <1511222021-562-11-git-send-email-eajames-23VcF4HTsmIX0ybBhKVfKdBPR1lH4CV8@public.gmane.org>
2017-11-22 15:23 ` [v3,10/12] " Guenter Roeck
2017-11-20 23:53 ` [PATCH v3 11/12] hwmon (occ): Add error handling Eddie James
2017-11-20 23:53 ` [PATCH v3 12/12] hwmon (occ): Add sysfs notification for errors and throttling Eddie James
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1511222021-562-3-git-send-email-eajames@linux.vnet.ibm.com \
--to=eajames@linux.vnet.ibm.com \
--cc=corbet@lwn.net \
--cc=devicetree@vger.kernel.org \
--cc=eajames@us.ibm.com \
--cc=jdelvare@suse.com \
--cc=joel@jms.id.au \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
--cc=mark.rutland@arm.com \
--cc=robh+dt@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).