iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: ACPI: move scan_handlers.txt to driver-api/acpi and convert to reST

Browse Source 
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>
This commit is contained in:
Changbin Du 2019-04-25 01:52:48 +08:00 committed by Rafael J. Wysocki
parent 25710e23cd
commit 97a63dd434
2 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/driver-api/acpi/index.rst
View File

@ -6,3 +6,4 @@ ACPI Support
:maxdepth: 2 :maxdepth: 2
linuxized-acpica linuxized-acpica
scan_handlers

26
Documentation/acpi/scan_handlers.txt → Documentation/driver-api/acpi/scan_handlers.rst
View File

@ -1,7 +1,13 @@
ACPI Scan Handlers .. SPDX-License-Identifier: GPL-2.0
.. include:: <isonum.txt>
Copyright (C) 2012, Intel Corporation ==================
Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com> ACPI Scan Handlers
==================
:Copyright: |copy| 2012, Intel Corporation
:Author: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
During system initialization and ACPI-based device hot-add, the ACPI namespace During system initialization and ACPI-based device hot-add, the ACPI namespace
is scanned in search of device objects that generally represent various pieces is 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.
Those additional configuration tasks usually depend on the type of the hardware Those additional configuration tasks usually depend on the type of the hardware
component represented by the given device node which can be determined on the component represented by the given device node which can be determined on the
basis of the device node's hardware ID (HID). They are performed by objects basis of the device node's hardware ID (HID). They are performed by objects
called ACPI scan handlers represented by the following structure: called ACPI scan handlers represented by the following structure::
struct acpi_scan_handler { struct acpi_scan_handler {
const struct acpi_device_id *ids; const struct acpi_device_id *ids;
struct list_head list_node; struct list_head list_node;
int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id); int (*attach)(struct acpi_device *dev, const struct acpi_device_id *id);
void (*detach)(struct acpi_device *dev); void (*detach)(struct acpi_device *dev);
}; };
where ids is the list of IDs of device nodes the given handler is supposed to where ids is the list of IDs of device nodes the given handler is supposed to
take care of, list_node is the hook to the global list of ACPI scan handlers take care of, list_node is the hook to the global list of ACPI scan handlers