d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add man pages for acpidb and iasl

Browse Source
This commit is contained in:
Nate Lawson 2003-08-07 18:09:17 +00:00
parent b2db7dc658
commit 8285491e78
2 changed files with 317 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

162
usr.sbin/acpi/acpidb/acpidb.8 Normal file
View File

@ -0,0 +1,162 @@
.\"-
.\" Copyright (c) 2003 Nate Lawson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer
.\" in this position and unchanged.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd August 7, 2003
.Dt ACPIDB 8
.Os
.Sh NAME
.Nm acpidb
.Nd ACPI DSDT debugger
.Sh SYNOPSIS
.Nm
.Ar input-file
.Sh DESCRIPTION
The
.Nm
utility is a debugger for the ACPI DSDT. It can parse and execute various
AML methods and display the result.
.Sh COMMANDS
.Ss General-Purpose Commands
.Bl -tag -width indent
.It Ic Allocations
Display list of current memory allocations
.It Ic Dump Ar Address|Namepath Op Byte|Word|Dword|Qword
Display ACPI objects or memory
.It Ic EnableAcpi
Enable ACPI (hardware) mode
.It Ic Help
Show various help screens.
.It Ic History
Display command history buffer
.It Ic Level Ar DebugLevel Op console
Get/Set debug level for file or console
.It Ic Locks
Current status of internal mutexes
.It Ic Quit or Exit
Exit the debugger
.It Ic Stats Op Allocations|Memory|Misc|Objects|Tables
Display namespace and memory statistics
.It Ic Tables
Display info about loaded ACPI tables
.It Ic Unload Ar TableSig Op Instance
Unload an ACPI table
.It Ic ! Ar CommandNumber
Execute command from history buffer
.It Ic !!
Execute last command again
.El
.Ss Namespace Access Commands
.Bl -tag -width indent
.It Ic Event Ar F|G Ar Value
Generate AcpiEvent (Fixed/GPE)
.It Ic Find Ar Name
Find ACPI name(s) with wildcards (? is wildcard).
.It Ic Method
Display list of loaded control methods
.It Ic Namespace Op <Addr>|<Path> Op Depth
Display loaded namespace tree/subtree
.It Ic Notify Ar NamePath Ar Value
Send a notification
.It Ic Objects Ar ObjectType
Display all objects of the given type
.It Ic Owner Ar OwnerId Op Depth
Display loaded namespace by object owner
.It Ic Prefix Op NamePath
Set or Get current execution prefix
.It Ic References Ar Addr
Find all references to object at addr
.It Ic Resources
Get and display resources
.It Ic Terminate
Delete namespace and all internal objects
.It Ic Thread Ar Threads Ar Loops Ar NamePath
Spawn threads to execute method(s)
.El
.Ss Control Method Execution Commands
.Bl -tag -width indent
.It Ic Arguments
.Pq Ic Args
Display method arguments
.It Ic Breakpoint Ar AmlOffset
Set an AML execution breakpoint
.It Ic Call
Run to next control method invocation
.It Ic Debug Ar Namepath Op Arguments
Single Step a control method
.It Ic Execute Ar Namepath Op Arguments
Execute control method
.It Ic Go
Allow method to run to completion
.It Ic Information
Display info about the current method
.It Ic Into
Step into (not over) a method call
.It Ic List Op OpcodeCount
Display method ASL statements
.It Ic Locals
Display method local variables
.It Ic Results
Display method result stack
.It Ic Set Ar A|L Ar # Ar Value
Set method data (Arguments/Locals)
.It Ic Stop
Terminate control method
.It Ic Tree
Display control method calling tree
.It Ic <Enter>
Single step next AML opcode (over calls)
.El
.Ss File I/O Commands
.Bl -tag -width indent
.It Ic Close
Close debug output file
.It Ic Open Ar Filename
Open a file for debug output
.It Ic Load Ar Filename
Load ACPI table from a file
.El
.Sh SEE ALSO
.Xr acpi 4 ,
.Xr acpidump 8 ,
.Xr iasl 8
.Sh HISTORY
The
.Nm
utility first appeared in the acpicatools port.
It was imported for
.Fx 5.2 .
.Sh AUTHORS
.An -nosplit
The
.Nm
utility was written by
.An Mitsuru Iwasaki Aq iwasaki@FreeBSD.org
and uses Intel ACPI-CA for the backend.
This manual page was written by
.An Nate Lawson .

155
usr.sbin/acpi/iasl/iasl.8 Normal file
View File

@ -0,0 +1,155 @@
.\"-
.\" Copyright (c) 2003 Nate Lawson
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer
.\" in this position and unchanged.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. The name of the author may not be used to endorse or promote products
.\" derived from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd August 7, 2003
.Dt IASL 8
.Os
.Sh NAME
.Nm iasl
.Nd Intel ACPI compiler/decompiler
.Sh SYNOPSIS
.Nm
.Op Fl cefghl
.Op Fl b Ar type
.Op Fl d Ar file
.Op Fl dc Ar file
.Op Fl hc
.Op Fl hr
.Op Fl i Ar type
.Op Fl ln
.Op Fl ls
.Op Fl oa
.Op Fl of
.Op Fl oi
.Op Fl on
.Op Fl ot
.Op Fl p Ar prefix
.Op Fl s Ar type
.Op Fl t Ar type
.Op Fl vi
.Op Fl vo
.Op Fl vr
.Op Fl vs
.Op Fl x Ar level
.Ar input-file
.Sh DESCRIPTION
The
.Nm
utility is a compiler/decompiler for ACPI Source Language (ASL)
and ACPI Machine Language (AML). Major features of
.Nm
include:
.Pp
.Bl -bullet -compact -offset indent
.It
Full support for the ACPI 2.0b Specification including ASL grammar
elements and operators.
.It
Extensive compiler syntax and semantic error checking, especially in
the area of control methods. This reduces the number of errors that are
not discovered until the AML code is actually interpreted (i.e., the
compile-time error checking reduces the number of run-time errors.)
.It
Multiple types of output files, including formatted listing files with
intermixed source, several types of AML files, and error messages.
.El
.Sh OPTIONS
.Bl -tag -width indent
.It Fl b Ar p|t|b
Create compiler debug/trace file (*.txt). Types: Parse/Tree/Both
.It Fl c
Parse only, no output generation
.It Fl d Ar file
Disassemble AML to ASL source code file (*.dsl)
.It Fl dc Ar file
Disassemble AML and immediately compile it
(Obtain DSDT from current system if no input file)
.It Fl e
Generate External() statements for unresolved symbols
.It Fl f
Ignore errors, force creation of AML output file(s)
.It Fl g
Get ACPI tables and write to files (*.dat)
.It Fl h
Additional help and compiler debug options
.It Fl hc
Display operators allowed in constant expressions
.It Fl hr
Display ACPI reserved method names
.It Fl i Ar a|c
Create assembler or C include file (*.inc or *.h)
.It Fl l
Create mixed listing file (ASL source and AML) (*.lst)
.It Fl ln
Create namespace file (*.nsp)
.It Fl ls
Create combined source file (expanded includes) (*.src)
.It Fl oa
Disable all optimizations (compatibility mode)
.It Fl of
Disable constant folding
.It Fl oi
Disable integer optimization to Zero/One/Ones
.It Fl on
Disable named reference string optimization
.It Fl ot
Display compile times
.It Fl p Ar prefix
Specify filename prefix for all output files (including .aml)
.It Fl s Ar a|c
Create AML in assembler or C source file (*.asm or *.c)
.It Fl t Ar a|c
Create AML in assembler or C hex table (*.hex)
.It Fl vi
Less verbose errors and warnings for use with IDEs
.It Fl vo
Enable optimization comments
.It Fl vr
Disable remarks
.It Fl vs
Disable signon
.It Fl x Ar level
Set debug level for trace output
.El
.Sh SEE ALSO
.Xr acpi 4 ,
.Xr acpidump 8
.Sh HISTORY
The
.Nm
utility is provided with Intel ACPI-CA. It first appeared in
.Fx 5.2 .
.Sh AUTHORS
.An -nosplit
The
.Nm
utility was written by
.An Intel .
This manual page was written by
.An Nate Lawson .