2018-02-10 08:56:57

by Aishwarya Pant

[permalink] [raw]
Subject: [PATCH v2 0/2] acpi: document sysfs interfaces

Patchset contains documentation for two acpi drivers- dock and dptf. Description
was collected from git history and reading through code. This might be useful
for tracking changes in the ABI.

Changes in v2:
- Split up multiple attribute definitions

Aishwarya Pant (2):
acpi/dptf: document sysfs atttributes
acpi/dock: document sysfs interface

.../ABI/testing/sysfs-devices-platform-dock | 39 +++++++++++++++++++++
Documentation/ABI/testing/sysfs-platform-dptf | 40 ++++++++++++++++++++++
2 files changed, 79 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-dock
create mode 100644 Documentation/ABI/testing/sysfs-platform-dptf

--
2.16.1



2018-02-10 08:58:35

by Aishwarya Pant

[permalink] [raw]
Subject: [PATCH v2 1/2] acpi/dptf: document sysfs atttributes

The descriptions have been collected from git commit logs and reading
through code.

Signed-off-by: Aishwarya Pant <[email protected]>
---
Changes in v2:
- Split up attribute definitions

Documentation/ABI/testing/sysfs-platform-dptf | 40 +++++++++++++++++++++++++++
1 file changed, 40 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-platform-dptf

diff --git a/Documentation/ABI/testing/sysfs-platform-dptf b/Documentation/ABI/testing/sysfs-platform-dptf
new file mode 100644
index 000000000000..325dc0667dbb
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-dptf
@@ -0,0 +1,40 @@
+What: /sys/bus/platform/devices/INT3407:00/dptf_power/charger_type
+Date: Jul, 2016
+KernelVersion: v4.10
+Contact: [email protected]
+Description:
+ (RO) The charger type - Traditional, Hybrid or NVDC.
+
+What: /sys/bus/platform/devices/INT3407:00/dptf_power/adapter_rating_mw
+Date: Jul, 2016
+KernelVersion: v4.10
+Contact: [email protected]
+Description:
+ (RO) Adapter rating in milliwatts (the maximum Adapter power).
+ Must be 0 if no AC Adaptor is plugged in.
+
+What: /sys/bus/platform/devices/INT3407:00/dptf_power/max_platform_power_mw
+Date: Jul, 2016
+KernelVersion: v4.10
+Contact: [email protected]
+Description:
+ (RO) Maximum platform power that can be supported by the battery
+ in milliwatts.
+
+What: /sys/bus/platform/devices/INT3407:00/dptf_power/platform_power_source
+Date: Jul, 2016
+KernelVersion: v4.10
+Contact: [email protected]
+Description:
+ (RO) Display the platform power source
+ 0x00 = DC
+ 0x01 = AC
+ 0x02 = USB
+ 0x03 = Wireless Charger
+
+What: /sys/bus/platform/devices/INT3407:00/dptf_power/battery_steady_power
+Date: Jul, 2016
+KernelVersion: v4.10
+Contact: [email protected]
+Description:
+ (RO) The maximum sustained power for battery in milliwatts.
--
2.16.1


2018-02-10 08:58:44

by Aishwarya Pant

[permalink] [raw]
Subject: [PATCH v2 2/2] acpi/dock: document sysfs interface

Description has been collected from git commit history and reading
through code.

Signed-off-by: Aishwarya Pant <[email protected]>
---
Changes in v2:
- Split up attribute definitions

.../ABI/testing/sysfs-devices-platform-dock | 39 ++++++++++++++++++++++
1 file changed, 39 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-dock

diff --git a/Documentation/ABI/testing/sysfs-devices-platform-dock b/Documentation/ABI/testing/sysfs-devices-platform-dock
new file mode 100644
index 000000000000..1d8c18f905c7
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-devices-platform-dock
@@ -0,0 +1,39 @@
+What: /sys/devices/platform/dock.N/docked
+Date: Dec, 2006
+KernelVersion: 2.6.19
+Contact: [email protected]
+Description:
+ (RO) Value 1 or 0 indicates whether the software believes the
+ laptop is docked in a docking station.
+
+What: /sys/devices/platform/dock.N/undock
+Date: Dec, 2006
+KernelVersion: 2.6.19
+Contact: [email protected]
+Description:
+ (WO) Writing to this file causes the software to initiate an
+ undock request to the firmware.
+
+What: /sys/devices/platform/dock.N/uid
+Date: Feb, 2007
+KernelVersion: v2.6.21
+Contact: [email protected]
+Description:
+ (RO) Displays the docking station the laptop is docked to.
+
+What: /sys/devices/platform/dock.N/flags
+Date: May, 2007
+KernelVersion: v2.6.21
+Contact: [email protected]
+Description:
+ (RO) Show dock station flags, useful for checking if undock
+ request has been made by the user (from the immediate_undock
+ option).
+
+What: /sys/devices/platform/dock.N/type
+Date: Aug, 2008
+KernelVersion: v2.6.27
+Contact: [email protected]
+Description:
+ (RO) Display the dock station type- dock_station, ata_bay or
+ battery_bay.
--
2.16.1


2018-02-14 09:30:11

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH v2 0/2] acpi: document sysfs interfaces

On Saturday, February 10, 2018 9:55:53 AM CET Aishwarya Pant wrote:
> Patchset contains documentation for two acpi drivers- dock and dptf. Description
> was collected from git history and reading through code. This might be useful
> for tracking changes in the ABI.
>
> Changes in v2:
> - Split up multiple attribute definitions
>
> Aishwarya Pant (2):
> acpi/dptf: document sysfs atttributes
> acpi/dock: document sysfs interface
>
> .../ABI/testing/sysfs-devices-platform-dock | 39 +++++++++++++++++++++
> Documentation/ABI/testing/sysfs-platform-dptf | 40 ++++++++++++++++++++++
> 2 files changed, 79 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-dock
> create mode 100644 Documentation/ABI/testing/sysfs-platform-dptf

Both patches applied with minor modifications, thanks!