tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
Documentation: ACPI: move aml-debugger.txt to firmware-guide/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>
authored by
Changbin Du
and committed by
Rafael J. Wysocki
472e89b4
3c03a1bd
+76
-66
-66
Documentation/acpi/aml-debugger.txt
-66
Documentation/acpi/aml-debugger.txt
···
1
-
The AML Debugger
2
-
3
-
Copyright (C) 2016, Intel Corporation
4
-
Author: Lv Zheng <lv.zheng@intel.com>
5
-
6
-
7
-
This document describes the usage of the AML debugger embedded in the Linux
8
-
kernel.
9
-
10
-
1. Build the debugger
11
-
12
-
The following kernel configuration items are required to enable the AML
13
-
debugger interface from the Linux kernel:
14
-
15
-
CONFIG_ACPI_DEBUGGER=y
16
-
CONFIG_ACPI_DEBUGGER_USER=m
17
-
18
-
The userspace utilities can be built from the kernel source tree using
19
-
the following commands:
20
-
21
-
$ cd tools
22
-
$ make acpi
23
-
24
-
The resultant userspace tool binary is then located at:
25
-
26
-
tools/power/acpi/acpidbg
27
-
28
-
It can be installed to system directories by running "make install" (as a
29
-
sufficiently privileged user).
30
-
31
-
2. Start the userspace debugger interface
32
-
33
-
After booting the kernel with the debugger built-in, the debugger can be
34
-
started by using the following commands:
35
-
36
-
# mount -t debugfs none /sys/kernel/debug
37
-
# modprobe acpi_dbg
38
-
# tools/power/acpi/acpidbg
39
-
40
-
That spawns the interactive AML debugger environment where you can execute
41
-
debugger commands.
42
-
43
-
The commands are documented in the "ACPICA Overview and Programmer Reference"
44
-
that can be downloaded from
45
-
46
-
https://acpica.org/documentation
47
-
48
-
The detailed debugger commands reference is located in Chapter 12 "ACPICA
49
-
Debugger Reference". The "help" command can be used for a quick reference.
50
-
51
-
3. Stop the userspace debugger interface
52
-
53
-
The interactive debugger interface can be closed by pressing Ctrl+C or using
54
-
the "quit" or "exit" commands. When finished, unload the module with:
55
-
56
-
# rmmod acpi_dbg
57
-
58
-
The module unloading may fail if there is an acpidbg instance running.
59
-
60
-
4. Run the debugger in a script
61
-
62
-
It may be useful to run the AML debugger in a test script. "acpidbg" supports
63
-
this in a special "batch" mode. For example, the following command outputs
64
-
the entire ACPI namespace:
65
-
66
-
# acpidbg -b "namespace"
+75
Documentation/firmware-guide/acpi/aml-debugger.rst
+75
Documentation/firmware-guide/acpi/aml-debugger.rst
···
1
+
.. SPDX-License-Identifier: GPL-2.0
2
+
.. include:: <isonum.txt>
3
+
4
+
================
5
+
The AML Debugger
6
+
================
7
+
8
+
:Copyright: |copy| 2016, Intel Corporation
9
+
:Author: Lv Zheng <lv.zheng@intel.com>
10
+
11
+
12
+
This document describes the usage of the AML debugger embedded in the Linux
13
+
kernel.
14
+
15
+
1. Build the debugger
16
+
=====================
17
+
18
+
The following kernel configuration items are required to enable the AML
19
+
debugger interface from the Linux kernel::
20
+
21
+
CONFIG_ACPI_DEBUGGER=y
22
+
CONFIG_ACPI_DEBUGGER_USER=m
23
+
24
+
The userspace utilities can be built from the kernel source tree using
25
+
the following commands::
26
+
27
+
$ cd tools
28
+
$ make acpi
29
+
30
+
The resultant userspace tool binary is then located at::
31
+
32
+
tools/power/acpi/acpidbg
33
+
34
+
It can be installed to system directories by running "make install" (as a
35
+
sufficiently privileged user).
36
+
37
+
2. Start the userspace debugger interface
38
+
=========================================
39
+
40
+
After booting the kernel with the debugger built-in, the debugger can be
41
+
started by using the following commands::
42
+
43
+
# mount -t debugfs none /sys/kernel/debug
44
+
# modprobe acpi_dbg
45
+
# tools/power/acpi/acpidbg
46
+
47
+
That spawns the interactive AML debugger environment where you can execute
48
+
debugger commands.
49
+
50
+
The commands are documented in the "ACPICA Overview and Programmer Reference"
51
+
that can be downloaded from
52
+
53
+
https://acpica.org/documentation
54
+
55
+
The detailed debugger commands reference is located in Chapter 12 "ACPICA
56
+
Debugger Reference". The "help" command can be used for a quick reference.
57
+
58
+
3. Stop the userspace debugger interface
59
+
========================================
60
+
61
+
The interactive debugger interface can be closed by pressing Ctrl+C or using
62
+
the "quit" or "exit" commands. When finished, unload the module with::
63
+
64
+
# rmmod acpi_dbg
65
+
66
+
The module unloading may fail if there is an acpidbg instance running.
67
+
68
+
4. Run the debugger in a script
69
+
===============================
70
+
71
+
It may be useful to run the AML debugger in a test script. "acpidbg" supports
72
+
this in a special "batch" mode. For example, the following command outputs
73
+
the entire ACPI namespace::
74
+
75
+
# acpidbg -b "namespace"