aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChangbin Du <changbin.du@gmail.com>2019-04-24 13:52:48 -0400
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>2019-04-25 17:07:19 -0400
commit97a63dd43477a93fa0fc53ff082af8d64ff618e1 (patch)
tree59a66bb2331c973123fa3033dc29b6a68bd0a51c
parent25710e23cdee4d4cfc140d34dd627b76be62c9c1 (diff)
Documentation: ACPI: move scan_handlers.txt to driver-api/acpi and convert to reST
This converts the plain text documentation to reStructuredText format and adds it to Sphinx TOC tree. No essential content change. Signed-off-by: Changbin Du <changbin.du@gmail.com> Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
-rw-r--r--Documentation/driver-api/acpi/index.rst1
-rw-r--r--Documentation/driver-api/acpi/scan_handlers.rst (renamed from Documentation/acpi/scan_handlers.txt)24
2 files changed, 16 insertions, 9 deletions
diff --git a/Documentation/driver-api/acpi/index.rst b/Documentation/driver-api/acpi/index.rst
index 12649947b19b..ace0008e54c2 100644
--- a/Documentation/driver-api/acpi/index.rst
+++ b/Documentation/driver-api/acpi/index.rst
@@ -6,3 +6,4 @@ ACPI Support
6 :maxdepth: 2 6 :maxdepth: 2
7 7
8 linuxized-acpica 8 linuxized-acpica
9 scan_handlers
diff --git a/Documentation/acpi/scan_handlers.txt b/Documentation/driver-api/acpi/scan_handlers.rst
index 3246ccf15992..7a197b3a33fc 100644
--- a/Documentation/acpi/scan_handlers.txt
+++ b/Documentation/driver-api/acpi/scan_handlers.rst
@@ -1,7 +1,13 @@
1.. SPDX-License-Identifier: GPL-2.0
2.. include:: <isonum.txt>
3
4==================
1ACPI Scan Handlers 5ACPI Scan Handlers
6==================
7
8:Copyright: |copy| 2012, Intel Corporation
2 9
3Copyright (C) 2012, Intel Corporation 10:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
4Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
5 11
6During system initialization and ACPI-based device hot-add, the ACPI namespace 12During system initialization and ACPI-based device hot-add, the ACPI namespace
7is scanned in search of device objects that generally represent various pieces 13is scanned in search of device objects that generally represent various pieces
@@ -30,14 +36,14 @@ to configure that link so that the kernel can use it.
30Those additional configuration tasks usually depend on the type of the hardware 36Those additional configuration tasks usually depend on the type of the hardware
31component represented by the given device node which can be determined on the 37component represented by the given device node which can be determined on the
32basis of the device node's hardware ID (HID). They are performed by objects 38basis of the device node's hardware ID (HID). They are performed by objects
33called ACPI scan handlers represented by the following structure: 39called ACPI scan handlers represented by the following structure::
34 40
35struct acpi_scan_handler { 41 struct acpi_scan_handler {
36 const struct acpi_device_id *ids; 42 const struct acpi_device_id *ids;
37 struct list_head list_node; 43 struct list_head list_node;
38 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); 44 int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
39 void (*detach)(struct acpi_device *dev); 45 void (*detach)(struct acpi_device *dev);
40}; 46 };
41 47
42where ids is the list of IDs of device nodes the given handler is supposed to 48where ids is the list of IDs of device nodes the given handler is supposed to
43take care of, list_node is the hook to the global list of ACPI scan handlers 49take care of, list_node is the hook to the global list of ACPI scan handlers