xref: /freebsd/sys/contrib/dev/acpica/components/namespace/nsdumpdv.c (revision ebacd8013fe5f7fdf9f6a5b286f6680dd2891036)
1 /******************************************************************************
2  *
3  * Module Name: nsdump - table dumping routines for debug
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2022, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25 
26  * make derivatives, distribute, use and display any portion of the Covered
27  * Code in any form, with the right to sublicense such rights; and
28  *
29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30  * license (with the right to sublicense), under only those claims of Intel
31  * patents that are infringed by the Original Intel Code, to make, use, sell,
32  * offer to sell, and import the Covered Code and derivative works thereof
33  * solely to the minimum extent necessary to exercise the above copyright
34  * license, and in no event shall the patent license extend to any additions
35  * to or modifications of the Original Intel Code. No other license or right
36  * is granted directly or by implication, estoppel or otherwise;
37  *
38  * The above copyright and patent license is granted only if the following
39  * conditions are met:
40  *
41  * 3. Conditions
42  *
43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44  * Redistribution of source code of any substantial portion of the Covered
45  * Code or modification with rights to further distribute source must include
46  * the above Copyright Notice, the above License, this list of Conditions,
47  * and the following Disclaimer and Export Compliance provision. In addition,
48  * Licensee must cause all Covered Code to which Licensee contributes to
49  * contain a file documenting the changes Licensee made to create that Covered
50  * Code and the date of any change. Licensee must include in that file the
51  * documentation of any changes made by any predecessor Licensee. Licensee
52  * must include a prominent statement that the modification is derived,
53  * directly or indirectly, from Original Intel Code.
54  *
55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56  * Redistribution of source code of any substantial portion of the Covered
57  * Code or modification without rights to further distribute source must
58  * include the following Disclaimer and Export Compliance provision in the
59  * documentation and/or other materials provided with distribution. In
60  * addition, Licensee may not authorize further sublicense of source of any
61  * portion of the Covered Code, and must include terms to the effect that the
62  * license from Licensee to its licensee is limited to the intellectual
63  * property embodied in the software Licensee provides to its licensee, and
64  * not to intellectual property embodied in modifications its licensee may
65  * make.
66  *
67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
68  * substantial portion of the Covered Code or modification must reproduce the
69  * above Copyright Notice, and the following Disclaimer and Export Compliance
70  * provision in the documentation and/or other materials provided with the
71  * distribution.
72  *
73  * 3.4. Intel retains all right, title, and interest in and to the Original
74  * Intel Code.
75  *
76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77  * Intel shall be used in advertising or otherwise to promote the sale, use or
78  * other dealings in products derived from or relating to the Covered Code
79  * without prior written authorization from Intel.
80  *
81  * 4. Disclaimer and Export Compliance
82  *
83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89  * PARTICULAR PURPOSE.
90  *
91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98  * LIMITED REMEDY.
99  *
100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
101  * software or system incorporating such software without first obtaining any
102  * required license or other approval from the U. S. Department of Commerce or
103  * any other agency or department of the United States Government. In the
104  * event Licensee exports any such software from the United States or
105  * re-exports any such software from a foreign destination, Licensee shall
106  * ensure that the distribution and export/re-export of the software is in
107  * compliance with all laws, regulations, orders, or other restrictions of the
108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109  * any of its subsidiaries will export/re-export any technical data, process,
110  * software, or service, directly or indirectly, to any country for which the
111  * United States government or any agency thereof requires an export license,
112  * other governmental approval, or letter of assurance, without first obtaining
113  * such license, approval or letter.
114  *
115  *****************************************************************************
116  *
117  * Alternatively, you may choose to be licensed under the terms of the
118  * following license:
119  *
120  * Redistribution and use in source and binary forms, with or without
121  * modification, are permitted provided that the following conditions
122  * are met:
123  * 1. Redistributions of source code must retain the above copyright
124  *    notice, this list of conditions, and the following disclaimer,
125  *    without modification.
126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127  *    substantially similar to the "NO WARRANTY" disclaimer below
128  *    ("Disclaimer") and any redistribution must be conditioned upon
129  *    including a substantially similar Disclaimer requirement for further
130  *    binary redistribution.
131  * 3. Neither the names of the above-listed copyright holders nor the names
132  *    of any contributors may be used to endorse or promote products derived
133  *    from this software without specific prior written permission.
134  *
135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146  *
147  * Alternatively, you may choose to be licensed under the terms of the
148  * GNU General Public License ("GPL") version 2 as published by the Free
149  * Software Foundation.
150  *
151  *****************************************************************************/
152 
153 #include <contrib/dev/acpica/include/acpi.h>
154 
155 
156 /* TBD: This entire module is apparently obsolete and should be removed */
157 
158 #define _COMPONENT          ACPI_NAMESPACE
159         ACPI_MODULE_NAME    ("nsdumpdv")
160 
161 #ifdef ACPI_OBSOLETE_FUNCTIONS
162 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
163 
164 #include <contrib/dev/acpica/include/acnamesp.h>
165 
166 /*******************************************************************************
167  *
168  * FUNCTION:    AcpiNsDumpOneDevice
169  *
170  * PARAMETERS:  Handle              - Node to be dumped
171  *              Level               - Nesting level of the handle
172  *              Context             - Passed into WalkNamespace
173  *              ReturnValue         - Not used
174  *
175  * RETURN:      Status
176  *
177  * DESCRIPTION: Dump a single Node that represents a device
178  *              This procedure is a UserFunction called by AcpiNsWalkNamespace.
179  *
180  ******************************************************************************/
181 
182 static ACPI_STATUS
183 AcpiNsDumpOneDevice (
184     ACPI_HANDLE             ObjHandle,
185     UINT32                  Level,
186     void                    *Context,
187     void                    **ReturnValue)
188 {
189     ACPI_BUFFER             Buffer;
190     ACPI_DEVICE_INFO        *Info;
191     ACPI_STATUS             Status;
192     UINT32                  i;
193 
194 
195     ACPI_FUNCTION_NAME (NsDumpOneDevice);
196 
197 
198     Status = AcpiNsDumpOneObject (ObjHandle, Level, Context, ReturnValue);
199 
200     Buffer.Length = ACPI_ALLOCATE_LOCAL_BUFFER;
201     Status = AcpiGetObjectInfo (ObjHandle, &Buffer);
202     if (ACPI_SUCCESS (Status))
203     {
204         Info = Buffer.Pointer;
205         for (i = 0; i < Level; i++)
206         {
207             ACPI_DEBUG_PRINT_RAW ((ACPI_DB_TABLES, " "));
208         }
209 
210         ACPI_DEBUG_PRINT_RAW ((ACPI_DB_TABLES,
211             "    HID: %s, ADR: %8.8X%8.8X\n",
212             Info->HardwareId.Value, ACPI_FORMAT_UINT64 (Info->Address)));
213         ACPI_FREE (Info);
214     }
215 
216     return (Status);
217 }
218 
219 
220 /*******************************************************************************
221  *
222  * FUNCTION:    AcpiNsDumpRootDevices
223  *
224  * PARAMETERS:  None
225  *
226  * RETURN:      None
227  *
228  * DESCRIPTION: Dump all objects of type "device"
229  *
230  ******************************************************************************/
231 
232 void
233 AcpiNsDumpRootDevices (
234     void)
235 {
236     ACPI_HANDLE             SysBusHandle;
237     ACPI_STATUS             Status;
238 
239 
240     ACPI_FUNCTION_NAME (NsDumpRootDevices);
241 
242 
243     /* Only dump the table if tracing is enabled */
244 
245     if (!(ACPI_LV_TABLES & AcpiDbgLevel))
246     {
247         return;
248     }
249 
250     Status = AcpiGetHandle (NULL, METHOD_NAME__SB_, &SysBusHandle);
251     if (ACPI_FAILURE (Status))
252     {
253         return;
254     }
255 
256     ACPI_DEBUG_PRINT ((ACPI_DB_TABLES,
257         "Display of all devices in the namespace:\n"));
258 
259     Status = AcpiNsWalkNamespace (ACPI_TYPE_DEVICE, SysBusHandle,
260         ACPI_UINT32_MAX, ACPI_NS_WALK_NO_UNLOCK,
261         AcpiNsDumpOneDevice, NULL, NULL, NULL);
262 }
263 
264 #endif
265 #endif
266