path: root/Documentation/firmware-guide
diff options
authorChangbin Du <>2019-04-25 01:53:00 +0800
committerRafael J. Wysocki <>2019-04-25 23:07:20 +0200
commit472e89b4e1a87cd7f9b5ae99759a635711cf00fb (patch)
treee908b120cf6dcb3e6af48d08d828af56d6983832 /Documentation/firmware-guide
parent3c03a1bde4dcedef8fb287e348de959d81d04ca6 (diff)
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 <> Reviewed-by: Mauro Carvalho Chehab <> Signed-off-by: Rafael J. Wysocki <>
Diffstat (limited to 'Documentation/firmware-guide')
2 files changed, 76 insertions, 0 deletions
diff --git a/Documentation/firmware-guide/acpi/aml-debugger.rst b/Documentation/firmware-guide/acpi/aml-debugger.rst
new file mode 100644
index 000000000000..a889d43bc6c5
--- /dev/null
+++ b/Documentation/firmware-guide/acpi/aml-debugger.rst
@@ -0,0 +1,75 @@
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
+The AML Debugger
+:Copyright: |copy| 2016, Intel Corporation
+:Author: Lv Zheng <>
+This document describes the usage of the AML debugger embedded in the Linux
+1. Build the debugger
+The following kernel configuration items are required to enable the AML
+debugger interface from the Linux kernel::
+The userspace utilities can be built from the kernel source tree using
+the following commands::
+ $ cd tools
+ $ make acpi
+The resultant userspace tool binary is then located at::
+ tools/power/acpi/acpidbg
+It can be installed to system directories by running "make install" (as a
+sufficiently privileged user).
+2. Start the userspace debugger interface
+After booting the kernel with the debugger built-in, the debugger can be
+started by using the following commands::
+ # mount -t debugfs none /sys/kernel/debug
+ # modprobe acpi_dbg
+ # tools/power/acpi/acpidbg
+That spawns the interactive AML debugger environment where you can execute
+debugger commands.
+The commands are documented in the "ACPICA Overview and Programmer Reference"
+that can be downloaded from
+The detailed debugger commands reference is located in Chapter 12 "ACPICA
+Debugger Reference". The "help" command can be used for a quick reference.
+3. Stop the userspace debugger interface
+The interactive debugger interface can be closed by pressing Ctrl+C or using
+the "quit" or "exit" commands. When finished, unload the module with::
+ # rmmod acpi_dbg
+The module unloading may fail if there is an acpidbg instance running.
+4. Run the debugger in a script
+It may be useful to run the AML debugger in a test script. "acpidbg" supports
+this in a special "batch" mode. For example, the following command outputs
+the entire ACPI namespace::
+ # acpidbg -b "namespace"
diff --git a/Documentation/firmware-guide/acpi/index.rst b/Documentation/firmware-guide/acpi/index.rst
index 287a7cbd82ac..e9f253d54897 100644
--- a/Documentation/firmware-guide/acpi/index.rst
+++ b/Documentation/firmware-guide/acpi/index.rst
@@ -16,6 +16,7 @@ ACPI Support
+ aml-debugger