From: Lv Zheng <lv.zheng@intel.com>
To: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
"Rafael J. Wysocki" <rjw@rjwysocki.net>,
Len Brown <len.brown@intel.com>
Cc: Lv Zheng <lv.zheng@intel.com>, Lv Zheng <zetalog@gmail.com>,
<linux-kernel@vger.kernel.org>,
linux-acpi@vger.kernel.org
Subject: [PATCH 3/5] ACPI / debugger: Add AML debugger documentation
Date: Tue, 5 Jul 2016 19:18:13 +0800 [thread overview]
Message-ID: <8c221ad3601f62334bc4133e31e08285029c45d8.1467717305.git.lv.zheng@intel.com> (raw)
In-Reply-To: <cover.1467717304.git.lv.zheng@intel.com>
This patch adds AML debugger documentation.
Signed-off-by: Lv Zheng <lv.zheng@intel.com>
---
Documentation/acpi/aml-debugger.txt | 56 +++++++++++++++++++++++++++++++++++
1 file changed, 56 insertions(+)
create mode 100644 Documentation/acpi/aml-debugger.txt
diff --git a/Documentation/acpi/aml-debugger.txt b/Documentation/acpi/aml-debugger.txt
new file mode 100644
index 0000000..0789332
--- /dev/null
+++ b/Documentation/acpi/aml-debugger.txt
@@ -0,0 +1,56 @@
+The AML Debugger
+
+Copyright (C) 2016, Intel Corporation
+Author: Lv Zheng <lv.zheng@intel.com>
+
+
+Abstract:
+
+This document describes the usage of the AML debugger embedded in the Linux
+kernel.
+
+1. Build the debugger
+
+ The following kernel configuration items are required to enable the AML
+ debugger interface from the Linux kernel:
+ CONFIG_ACPI_DEBUGGER=y
+ CONFIG_ACPI_DEBUGGER_USER=m
+ The userspace utlities can be built from the kernel source tree using
+ the following commands:
+ # cd tools
+ # make acpi
+ The built userspace tool can be found at:
+ tools/acpi/power/acpi/acpidbg/acpidbg
+ You can install it to the system directories using the following
+ command:
+ # sudo make install
+
+2. Start the userspace debugger interface
+
+ After booting the kernel with the debugger built-in, developers can
+ start the debugger with the following commands:
+ # sudo mount -t debugfs none /sys/kernel/debug
+ # sudo modprobe acpi_dbg
+ # sudo tools/acpi/power/acpi/acpidbg/acpidbg
+ Now you have entered the interactive AML debugger environment, where
+ you can execute the debugger functionalities by typing the debugger
+ commands.
+ You can start to use it from typing "help" command and can download
+ <ACPICA Overview and Programmer Reference> from the following site:
+ https://acpica.org/documentation
+ And find detailed command reference in "Chapter 12. ACPICA Debugger
+ Reference".
+
+3. Stop the userspace debugger interface
+
+ You can type the Ctrl+C, quit, exit to end the interactive debugger
+ interface. And unload the module with the following commands:
+ # sudo rmmod acpi_dbg
+ The module unloading may fail if there is an acpidbg instance running.
+
+4. Run the debugger in a script
+
+ It will be very useful to have the ability 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:
+ # sudo acpidbg -b "namespace"
--
1.7.10
next prev parent reply other threads:[~2016-07-05 11:18 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-07-05 11:17 [PATCH 0/5] ACPI: ACPI documentations and trivial fixes Lv Zheng
2016-07-05 11:17 ` [PATCH 1/5] ACPI: Add documentation describing ACPICA release automation Lv Zheng
2016-07-05 11:18 ` [PATCH 2/5] ACPI / debugger: Fix regressions that AML debugger stops working Lv Zheng
2016-07-05 23:41 ` Rafael J. Wysocki
2016-07-06 2:08 ` Zheng, Lv
2016-07-05 11:18 ` Lv Zheng [this message]
2016-07-05 11:18 ` [PATCH 4/5] ACPI / button: Add SW_ACPI_LID for new usage model Lv Zheng
2016-07-05 11:18 ` [PATCH 5/5] ACPI: Add configuration item to configure ACPICA error logs out Lv Zheng
2016-07-05 23:43 ` Rafael J. Wysocki
2016-07-06 1:46 ` Zheng, Lv
2016-07-07 7:10 ` [PATCH v2 0/4] ACPI: ACPI documentation Lv Zheng
2016-07-07 7:10 ` [PATCH v2 1/4] ACPI: Add documentation describing ACPICA release automation Lv Zheng
2016-07-07 7:10 ` [PATCH v2 2/4] ACPI / debugger: Add AML debugger documentation Lv Zheng
2016-07-07 7:10 ` [PATCH v2 3/4] ACPI / button: Add SW_ACPI_LID for new usage model Lv Zheng
2016-07-08 9:27 ` Benjamin Tissoires
2016-07-08 17:55 ` Dmitry Torokhov
2016-07-07 7:11 ` [PATCH v2 4/4] ACPI / button: Add document for ACPI control method lid device restrictions Lv Zheng
2016-07-08 9:17 ` Benjamin Tissoires
2016-07-08 17:51 ` Dmitry Torokhov
2016-07-11 11:34 ` Benjamin Tissoires
2016-07-12 0:41 ` Dmitry Torokhov
2016-07-12 7:43 ` Zheng, Lv
2016-07-20 3:21 ` Zheng, Lv
2016-07-12 7:13 ` Zheng, Lv
2016-07-19 7:17 ` Zheng, Lv
2016-07-19 8:40 ` Benjamin Tissoires
2016-07-19 8:57 ` Zheng, Lv
2016-07-19 9:07 ` Benjamin Tissoires
2016-07-11 3:20 ` Zheng, Lv
2016-07-11 10:58 ` Bastien Nocera
2016-07-12 7:06 ` Zheng, Lv
2016-07-11 11:42 ` Benjamin Tissoires
2016-07-11 11:47 ` Benjamin Tissoires
2016-07-12 7:34 ` Zheng, Lv
2016-07-12 10:17 ` [PATCH v3 1/2] ACPI / button: Add KEY_LID_CLOSE for new usage model Lv Zheng
2016-07-18 7:53 ` Benjamin Tissoires
2016-07-18 15:51 ` Bastien Nocera
2016-07-19 4:48 ` Zheng, Lv
2016-07-12 10:17 ` [PATCH v3 2/2] ACPI / button: Add document for ACPI control method lid device restrictions Lv Zheng
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=8c221ad3601f62334bc4133e31e08285029c45d8.1467717305.git.lv.zheng@intel.com \
--to=lv.zheng@intel.com \
--cc=len.brown@intel.com \
--cc=linux-acpi@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=rafael.j.wysocki@intel.com \
--cc=rjw@rjwysocki.net \
--cc=zetalog@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).