diff mbox

[v1,2/2] acpi/dock: document sysfs interface

Message ID 9dff9dee68daf82305de32c45604757eca93afaf.1518009225.git.aishpant@gmail.com (mailing list archive)
State Changes Requested, archived
Headers show

Commit Message

Aishwarya Pant Feb. 7, 2018, 1:18 p.m. UTC
Description has been collected from git commit history and reading
through code.

Signed-off-by: Aishwarya Pant <aishpant@gmail.com>
---
 .../ABI/testing/sysfs-devices-platform-dock        | 38 ++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-devices-platform-dock

Comments

Rafael J. Wysocki Feb. 9, 2018, 10:26 a.m. UTC | #1
On Wed, Feb 7, 2018 at 2:18 PM, Aishwarya Pant <aishpant@gmail.com> wrote:
> Description has been collected from git commit history and reading
> through code.
>
> Signed-off-by: Aishwarya Pant <aishpant@gmail.com>
> ---
>  .../ABI/testing/sysfs-devices-platform-dock        | 38 ++++++++++++++++++++++
>  1 file changed, 38 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..0bb0d42e9126
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-devices-platform-dock
> @@ -0,0 +1,38 @@
> +sysfs interface for ACPI dock station driver
> +--------------------------------------------
> +
> +What:          /sys/devices/platform/dock.N/docked
> +What:          /sys/devices/platform/dock.N/undock
> +Date:          Dec, 2006
> +KernelVersion: 2.6.19
> +Contact:       linux-acpi@vger.kernel.org
> +Description:
> +               docked: (RO) Value 1 or 0 indicates whether the software
> +               believes the laptop is docked in a docking station.
> +
> +               undock: (WO) Writing to this file causes the software to
> +               initiate an undock request to the firmware.

Please split the above into two entries.

Apart from that it looks OK to me.
--
To unsubscribe from this list: send the line "unsubscribe linux-acpi" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/ABI/testing/sysfs-devices-platform-dock b/Documentation/ABI/testing/sysfs-devices-platform-dock
new file mode 100644
index 000000000000..0bb0d42e9126
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-devices-platform-dock
@@ -0,0 +1,38 @@ 
+sysfs interface for ACPI dock station driver
+--------------------------------------------
+
+What:		/sys/devices/platform/dock.N/docked
+What:		/sys/devices/platform/dock.N/undock
+Date:		Dec, 2006
+KernelVersion:	2.6.19
+Contact:	linux-acpi@vger.kernel.org
+Description:
+		docked: (RO) Value 1 or 0 indicates whether the software
+		believes the laptop is docked in a docking station.
+
+		undock: (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:	linux-acpi@vger.kernel.org
+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:	linux-acpi@vger.kernel.org
+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:	linux-acpi@vger.kernel.org
+Description:
+		(RO) Display the dock station type- dock_station, ata_bay or
+		battery_bay.