usr.sbin/acpi/acpidb/acpidb.8

   1 .\"-
   2 .\" Copyright (c) 2003 Nate Lawson
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer
  10 .\"    in this position and unchanged.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. The name of the author may not be used to endorse or promote products
  15 .\"    derived from this software without specific prior written permission.
  16 .\"
  17 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD: src/usr.sbin/acpi/acpidb/acpidb.8,v 1.2 2004/06/06 17:49:57 ru Exp $
  29 .\" $DragonFly: src/usr.sbin/acpi/acpidb/acpidb.8,v 1.1 2004/07/05 00:22:43 dillon Exp $
  30 .\"
  31 .Dd August 7, 2003
  32 .Dt ACPIDB 8
  33 .Os
  34 .Sh NAME
  35 .Nm acpidb
  36 .Nd ACPI DSDT debugger
  37 .Sh SYNOPSIS
  38 .Nm
  39 .Ar input-file
  40 .Sh DESCRIPTION
  41 The
  42 .Nm
  43 utility is a debugger for the ACPI DSDT.
  44 It can parse and execute various
  45 AML methods and display the result.
  46 .Sh COMMANDS
  47 .Ss General-Purpose Commands
  48 .Bl -tag -width indent
  49 .It Ic Allocations
  50 Display list of current memory allocations
  51 .It Ic Dump Ar Address | Namepath Op Cm Byte | Word | Dword | Qword
  52 Display ACPI objects or memory
  53 .It Ic EnableAcpi
  54 Enable ACPI (hardware) mode
  55 .It Ic Help
  56 Show various help screens
  57 .It Ic History
  58 Display command history buffer
  59 .It Ic Level Ar DebugLevel Op Cm console
  60 Get/Set debug level for file or console
  61 .It Ic Locks
  62 Current status of internal mutexes
  63 .It Ic Quit No or Ic Exit
  64 Exit the debugger
  65 .It Ic Stats Op Cm Allocations | Memory | Misc | Objects | Tables
  66 Display namespace and memory statistics
  67 .It Ic Tables
  68 Display info about loaded ACPI tables
  69 .It Ic Unload Ar TableSig Op Ar Instance
  70 Unload an ACPI table
  71 .It Ic !\& Ar CommandNumber
  72 Execute command from history buffer
  73 .It Ic !!
  74 Execute last command again
  75 .El
  76 .Ss Namespace Access Commands
  77 .Bl -tag -width indent
  78 .It Ic Event Cm F | G Ar Value
  79 Generate AcpiEvent (Fixed/GPE)
  80 .It Ic Find Ar Name
  81 Find ACPI name(s) with wildcards
  82 .Ql ( ?\&
  83 is wildcard)
  84 .It Ic Method
  85 Display list of loaded control methods
  86 .It Ic Namespace Oo Ar Addr | Path Oc Op Ar Depth
  87 Display loaded namespace tree/subtree
  88 .It Ic Notify Ar NamePath Value
  89 Send a notification
  90 .It Ic Objects Ar ObjectType
  91 Display all objects of the given type
  92 .It Ic Owner Ar OwnerId Op Ar Depth
  93 Display loaded namespace by object owner
  94 .It Ic Prefix Op Ar NamePath
  95 Set or Get current execution prefix
  96 .It Ic References Ar Addr
  97 Find all references to object at addr
  98 .It Ic Resources
  99 Get and display resources
 100 .It Ic Terminate
 101 Delete namespace and all internal objects
 102 .It Ic Thread Ar Threads Loops NamePath
 103 Spawn threads to execute method(s)
 104 .El
 105 .Ss Control Method Execution Commands
 106 .Bl -tag -width indent
 107 .It Ic Arguments
 108 .Pq Ic Args
 109 Display method arguments
 110 .It Ic Breakpoint Ar AmlOffset
 111 Set an AML execution breakpoint
 112 .It Ic Call
 113 Run to next control method invocation
 114 .It Ic Debug Ar Namepath Op Ar Arguments
 115 Single Step a control method
 116 .It Ic Execute Ar Namepath Op Arguments
 117 Execute control method
 118 .It Ic Go
 119 Allow method to run to completion
 120 .It Ic Information
 121 Display info about the current method
 122 .It Ic Into
 123 Step into (not over) a method call
 124 .It Ic List Op OpcodeCount
 125 Display method ASL statements
 126 .It Ic Locals
 127 Display method local variables
 128 .It Ic Results
 129 Display method result stack
 130 .It Ic Set Cm A | L Ar # Value
 131 Set method data (Arguments/Locals)
 132 .It Ic Stop
 133 Terminate control method
 134 .It Ic Tree
 135 Display control method calling tree
 136 .It Ic <Enter>
 137 Single step next AML opcode (over calls)
 138 .El
 139 .Ss File I/O Commands
 140 .Bl -tag -width indent
 141 .It Ic Close
 142 Close debug output file
 143 .It Ic Open Ar Filename
 144 Open a file for debug output
 145 .It Ic Load Ar Filename
 146 Load ACPI table from a file
 147 .El
 148 .Sh SEE ALSO
 149 .Xr acpi 4 ,
 150 .Xr acpidump 8 ,
 151 .Xr iasl 8
 152 .Sh HISTORY
 153 The
 154 .Nm
 155 utility first appeared in the
 156 .Nm acpicatools
 157 port.
 158 It was imported for
 159 .Fx 5.2 .
 160 .Sh AUTHORS
 161 .An -nosplit
 162 The
 163 .Nm
 164 utility was written by
 165 .An Mitsuru Iwasaki Aq iwasaki@FreeBSD.org
 166 and uses Intel ACPI-CA for the backend.
 167 This manual page was written by
 168 .An Nate Lawson .