1bc36eafdSMike Gerdts /******************************************************************************
2bc36eafdSMike Gerdts *
3bc36eafdSMike Gerdts * Module Name: asldebug -- Debug output support
4bc36eafdSMike Gerdts *
5bc36eafdSMike Gerdts *****************************************************************************/
6bc36eafdSMike Gerdts
7*35786f68SRobert Mustacchi /******************************************************************************
8*35786f68SRobert Mustacchi *
9*35786f68SRobert Mustacchi * 1. Copyright Notice
10*35786f68SRobert Mustacchi *
11*35786f68SRobert Mustacchi * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp.
12bc36eafdSMike Gerdts * All rights reserved.
13bc36eafdSMike Gerdts *
14*35786f68SRobert Mustacchi * 2. License
15*35786f68SRobert Mustacchi *
16*35786f68SRobert Mustacchi * 2.1. This is your license from Intel Corp. under its intellectual property
17*35786f68SRobert Mustacchi * rights. You may have additional license terms from the party that provided
18*35786f68SRobert Mustacchi * you this software, covering your right to use that party's intellectual
19*35786f68SRobert Mustacchi * property rights.
20*35786f68SRobert Mustacchi *
21*35786f68SRobert Mustacchi * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22*35786f68SRobert Mustacchi * copy of the source code appearing in this file ("Covered Code") an
23*35786f68SRobert Mustacchi * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24*35786f68SRobert Mustacchi * base code distributed originally by Intel ("Original Intel Code") to copy,
25*35786f68SRobert Mustacchi * make derivatives, distribute, use and display any portion of the Covered
26*35786f68SRobert Mustacchi * Code in any form, with the right to sublicense such rights; and
27*35786f68SRobert Mustacchi *
28*35786f68SRobert Mustacchi * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29*35786f68SRobert Mustacchi * license (with the right to sublicense), under only those claims of Intel
30*35786f68SRobert Mustacchi * patents that are infringed by the Original Intel Code, to make, use, sell,
31*35786f68SRobert Mustacchi * offer to sell, and import the Covered Code and derivative works thereof
32*35786f68SRobert Mustacchi * solely to the minimum extent necessary to exercise the above copyright
33*35786f68SRobert Mustacchi * license, and in no event shall the patent license extend to any additions
34*35786f68SRobert Mustacchi * to or modifications of the Original Intel Code. No other license or right
35*35786f68SRobert Mustacchi * is granted directly or by implication, estoppel or otherwise;
36*35786f68SRobert Mustacchi *
37*35786f68SRobert Mustacchi * The above copyright and patent license is granted only if the following
38*35786f68SRobert Mustacchi * conditions are met:
39*35786f68SRobert Mustacchi *
40*35786f68SRobert Mustacchi * 3. Conditions
41*35786f68SRobert Mustacchi *
42*35786f68SRobert Mustacchi * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
44*35786f68SRobert Mustacchi * Code or modification with rights to further distribute source must include
45*35786f68SRobert Mustacchi * the above Copyright Notice, the above License, this list of Conditions,
46*35786f68SRobert Mustacchi * and the following Disclaimer and Export Compliance provision. In addition,
47*35786f68SRobert Mustacchi * Licensee must cause all Covered Code to which Licensee contributes to
48*35786f68SRobert Mustacchi * contain a file documenting the changes Licensee made to create that Covered
49*35786f68SRobert Mustacchi * Code and the date of any change. Licensee must include in that file the
50*35786f68SRobert Mustacchi * documentation of any changes made by any predecessor Licensee. Licensee
51*35786f68SRobert Mustacchi * must include a prominent statement that the modification is derived,
52*35786f68SRobert Mustacchi * directly or indirectly, from Original Intel Code.
53*35786f68SRobert Mustacchi *
54*35786f68SRobert Mustacchi * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55*35786f68SRobert Mustacchi * Redistribution of source code of any substantial portion of the Covered
56*35786f68SRobert Mustacchi * Code or modification without rights to further distribute source must
57*35786f68SRobert Mustacchi * include the following Disclaimer and Export Compliance provision in the
58*35786f68SRobert Mustacchi * documentation and/or other materials provided with distribution. In
59*35786f68SRobert Mustacchi * addition, Licensee may not authorize further sublicense of source of any
60*35786f68SRobert Mustacchi * portion of the Covered Code, and must include terms to the effect that the
61*35786f68SRobert Mustacchi * license from Licensee to its licensee is limited to the intellectual
62*35786f68SRobert Mustacchi * property embodied in the software Licensee provides to its licensee, and
63*35786f68SRobert Mustacchi * not to intellectual property embodied in modifications its licensee may
64*35786f68SRobert Mustacchi * make.
65*35786f68SRobert Mustacchi *
66*35786f68SRobert Mustacchi * 3.3. Redistribution of Executable. Redistribution in executable form of any
67*35786f68SRobert Mustacchi * substantial portion of the Covered Code or modification must reproduce the
68*35786f68SRobert Mustacchi * above Copyright Notice, and the following Disclaimer and Export Compliance
69*35786f68SRobert Mustacchi * provision in the documentation and/or other materials provided with the
70*35786f68SRobert Mustacchi * distribution.
71*35786f68SRobert Mustacchi *
72*35786f68SRobert Mustacchi * 3.4. Intel retains all right, title, and interest in and to the Original
73*35786f68SRobert Mustacchi * Intel Code.
74*35786f68SRobert Mustacchi *
75*35786f68SRobert Mustacchi * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76*35786f68SRobert Mustacchi * Intel shall be used in advertising or otherwise to promote the sale, use or
77*35786f68SRobert Mustacchi * other dealings in products derived from or relating to the Covered Code
78*35786f68SRobert Mustacchi * without prior written authorization from Intel.
79*35786f68SRobert Mustacchi *
80*35786f68SRobert Mustacchi * 4. Disclaimer and Export Compliance
81*35786f68SRobert Mustacchi *
82*35786f68SRobert Mustacchi * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83*35786f68SRobert Mustacchi * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84*35786f68SRobert Mustacchi * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85*35786f68SRobert Mustacchi * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86*35786f68SRobert Mustacchi * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87*35786f68SRobert Mustacchi * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88*35786f68SRobert Mustacchi * PARTICULAR PURPOSE.
89*35786f68SRobert Mustacchi *
90*35786f68SRobert Mustacchi * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91*35786f68SRobert Mustacchi * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92*35786f68SRobert Mustacchi * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93*35786f68SRobert Mustacchi * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94*35786f68SRobert Mustacchi * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95*35786f68SRobert Mustacchi * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96*35786f68SRobert Mustacchi * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97*35786f68SRobert Mustacchi * LIMITED REMEDY.
98*35786f68SRobert Mustacchi *
99*35786f68SRobert Mustacchi * 4.3. Licensee shall not export, either directly or indirectly, any of this
100*35786f68SRobert Mustacchi * software or system incorporating such software without first obtaining any
101*35786f68SRobert Mustacchi * required license or other approval from the U. S. Department of Commerce or
102*35786f68SRobert Mustacchi * any other agency or department of the United States Government. In the
103*35786f68SRobert Mustacchi * event Licensee exports any such software from the United States or
104*35786f68SRobert Mustacchi * re-exports any such software from a foreign destination, Licensee shall
105*35786f68SRobert Mustacchi * ensure that the distribution and export/re-export of the software is in
106*35786f68SRobert Mustacchi * compliance with all laws, regulations, orders, or other restrictions of the
107*35786f68SRobert Mustacchi * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108*35786f68SRobert Mustacchi * any of its subsidiaries will export/re-export any technical data, process,
109*35786f68SRobert Mustacchi * software, or service, directly or indirectly, to any country for which the
110*35786f68SRobert Mustacchi * United States government or any agency thereof requires an export license,
111*35786f68SRobert Mustacchi * other governmental approval, or letter of assurance, without first obtaining
112*35786f68SRobert Mustacchi * such license, approval or letter.
113*35786f68SRobert Mustacchi *
114*35786f68SRobert Mustacchi *****************************************************************************
115*35786f68SRobert Mustacchi *
116*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
117*35786f68SRobert Mustacchi * following license:
118*35786f68SRobert Mustacchi *
119bc36eafdSMike Gerdts * Redistribution and use in source and binary forms, with or without
120bc36eafdSMike Gerdts * modification, are permitted provided that the following conditions
121bc36eafdSMike Gerdts * are met:
122bc36eafdSMike Gerdts * 1. Redistributions of source code must retain the above copyright
123bc36eafdSMike Gerdts * notice, this list of conditions, and the following disclaimer,
124bc36eafdSMike Gerdts * without modification.
125bc36eafdSMike Gerdts * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126bc36eafdSMike Gerdts * substantially similar to the "NO WARRANTY" disclaimer below
127bc36eafdSMike Gerdts * ("Disclaimer") and any redistribution must be conditioned upon
128bc36eafdSMike Gerdts * including a substantially similar Disclaimer requirement for further
129bc36eafdSMike Gerdts * binary redistribution.
130bc36eafdSMike Gerdts * 3. Neither the names of the above-listed copyright holders nor the names
131bc36eafdSMike Gerdts * of any contributors may be used to endorse or promote products derived
132bc36eafdSMike Gerdts * from this software without specific prior written permission.
133bc36eafdSMike Gerdts *
134*35786f68SRobert Mustacchi * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135*35786f68SRobert Mustacchi * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136*35786f68SRobert Mustacchi * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137*35786f68SRobert Mustacchi * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138*35786f68SRobert Mustacchi * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139*35786f68SRobert Mustacchi * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140*35786f68SRobert Mustacchi * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141*35786f68SRobert Mustacchi * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142*35786f68SRobert Mustacchi * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143*35786f68SRobert Mustacchi * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144*35786f68SRobert Mustacchi * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145*35786f68SRobert Mustacchi *
146*35786f68SRobert Mustacchi * Alternatively, you may choose to be licensed under the terms of the
147bc36eafdSMike Gerdts * GNU General Public License ("GPL") version 2 as published by the Free
148bc36eafdSMike Gerdts * Software Foundation.
149bc36eafdSMike Gerdts *
150*35786f68SRobert Mustacchi *****************************************************************************/
151bc36eafdSMike Gerdts
152bc36eafdSMike Gerdts #include "aslcompiler.h"
153bc36eafdSMike Gerdts #include "aslcompiler.y.h"
154bc36eafdSMike Gerdts
155bc36eafdSMike Gerdts
156bc36eafdSMike Gerdts #define _COMPONENT ACPI_COMPILER
157bc36eafdSMike Gerdts ACPI_MODULE_NAME ("asldebug")
158bc36eafdSMike Gerdts
159bc36eafdSMike Gerdts
160bc36eafdSMike Gerdts /* Local prototypes */
161bc36eafdSMike Gerdts
162bc36eafdSMike Gerdts static void
163bc36eafdSMike Gerdts UtDumpParseOpName (
164bc36eafdSMike Gerdts ACPI_PARSE_OBJECT *Op,
165bc36eafdSMike Gerdts UINT32 Level,
166bc36eafdSMike Gerdts UINT32 DataLength);
167bc36eafdSMike Gerdts
168*35786f68SRobert Mustacchi static char *
169*35786f68SRobert Mustacchi UtCreateEscapeSequences (
170*35786f68SRobert Mustacchi char *InString);
171*35786f68SRobert Mustacchi
172*35786f68SRobert Mustacchi
173*35786f68SRobert Mustacchi /*******************************************************************************
174*35786f68SRobert Mustacchi *
175*35786f68SRobert Mustacchi * FUNCTION: CvDbgPrint
176*35786f68SRobert Mustacchi *
177*35786f68SRobert Mustacchi * PARAMETERS: Type - Type of output
178*35786f68SRobert Mustacchi * Fmt - Printf format string
179*35786f68SRobert Mustacchi * ... - variable printf list
180*35786f68SRobert Mustacchi *
181*35786f68SRobert Mustacchi * RETURN: None
182*35786f68SRobert Mustacchi *
183*35786f68SRobert Mustacchi * DESCRIPTION: Print statement for debug messages within the converter.
184*35786f68SRobert Mustacchi *
185*35786f68SRobert Mustacchi ******************************************************************************/
186*35786f68SRobert Mustacchi
187*35786f68SRobert Mustacchi void
CvDbgPrint(char * Fmt,...)188*35786f68SRobert Mustacchi CvDbgPrint (
189*35786f68SRobert Mustacchi char *Fmt,
190*35786f68SRobert Mustacchi ...)
191*35786f68SRobert Mustacchi {
192*35786f68SRobert Mustacchi va_list Args;
193*35786f68SRobert Mustacchi
194*35786f68SRobert Mustacchi
195*35786f68SRobert Mustacchi if (!AcpiGbl_CaptureComments || !AcpiGbl_DebugAslConversion)
196*35786f68SRobert Mustacchi {
197*35786f68SRobert Mustacchi return;
198*35786f68SRobert Mustacchi }
199*35786f68SRobert Mustacchi
200*35786f68SRobert Mustacchi va_start (Args, Fmt);
201*35786f68SRobert Mustacchi (void) vfprintf (AcpiGbl_ConvDebugFile, Fmt, Args);
202*35786f68SRobert Mustacchi va_end (Args);
203*35786f68SRobert Mustacchi return;
204*35786f68SRobert Mustacchi }
205*35786f68SRobert Mustacchi
206bc36eafdSMike Gerdts
207bc36eafdSMike Gerdts /*******************************************************************************
208bc36eafdSMike Gerdts *
209bc36eafdSMike Gerdts * FUNCTION: UtDumpIntegerOp
210bc36eafdSMike Gerdts *
211bc36eafdSMike Gerdts * PARAMETERS: Op - Current parse op
212bc36eafdSMike Gerdts * Level - Current output indentation level
213bc36eafdSMike Gerdts * IntegerLength - Output length of the integer (2/4/8/16)
214bc36eafdSMike Gerdts *
215bc36eafdSMike Gerdts * RETURN: None
216bc36eafdSMike Gerdts *
217bc36eafdSMike Gerdts * DESCRIPTION: Emit formatted debug output for "integer" ops.
218bc36eafdSMike Gerdts * Note: IntegerLength must be one of 2,4,8,16.
219bc36eafdSMike Gerdts *
220bc36eafdSMike Gerdts ******************************************************************************/
221bc36eafdSMike Gerdts
222bc36eafdSMike Gerdts void
UtDumpIntegerOp(ACPI_PARSE_OBJECT * Op,UINT32 Level,UINT32 IntegerLength)223bc36eafdSMike Gerdts UtDumpIntegerOp (
224bc36eafdSMike Gerdts ACPI_PARSE_OBJECT *Op,
225bc36eafdSMike Gerdts UINT32 Level,
226bc36eafdSMike Gerdts UINT32 IntegerLength)
227bc36eafdSMike Gerdts {
228bc36eafdSMike Gerdts
229bc36eafdSMike Gerdts /* Emit the ParseOp name, leaving room for the integer */
230bc36eafdSMike Gerdts
231bc36eafdSMike Gerdts UtDumpParseOpName (Op, Level, IntegerLength);
232bc36eafdSMike Gerdts
233bc36eafdSMike Gerdts /* Emit the integer based upon length */
234bc36eafdSMike Gerdts
235bc36eafdSMike Gerdts switch (IntegerLength)
236bc36eafdSMike Gerdts {
237bc36eafdSMike Gerdts case 2: /* Byte */
238bc36eafdSMike Gerdts case 4: /* Word */
239bc36eafdSMike Gerdts case 8: /* Dword */
240bc36eafdSMike Gerdts
241bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT,
242bc36eafdSMike Gerdts "%*.*X", IntegerLength, IntegerLength, Op->Asl.Value.Integer);
243bc36eafdSMike Gerdts break;
244bc36eafdSMike Gerdts
245bc36eafdSMike Gerdts case 16: /* Qword and Integer */
246bc36eafdSMike Gerdts
247bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT,
248bc36eafdSMike Gerdts "%8.8X%8.8X", ACPI_FORMAT_UINT64 (Op->Asl.Value.Integer));
249bc36eafdSMike Gerdts break;
250bc36eafdSMike Gerdts
251bc36eafdSMike Gerdts default:
252bc36eafdSMike Gerdts break;
253bc36eafdSMike Gerdts }
254bc36eafdSMike Gerdts }
255bc36eafdSMike Gerdts
256bc36eafdSMike Gerdts
257bc36eafdSMike Gerdts /*******************************************************************************
258bc36eafdSMike Gerdts *
259bc36eafdSMike Gerdts * FUNCTION: UtDumpStringOp
260bc36eafdSMike Gerdts *
261bc36eafdSMike Gerdts * PARAMETERS: Op - Current parse op
262bc36eafdSMike Gerdts * Level - Current output indentation level
263bc36eafdSMike Gerdts *
264bc36eafdSMike Gerdts * RETURN: None
265bc36eafdSMike Gerdts *
266bc36eafdSMike Gerdts * DESCRIPTION: Emit formatted debug output for String/Pathname ops.
267bc36eafdSMike Gerdts *
268bc36eafdSMike Gerdts ******************************************************************************/
269bc36eafdSMike Gerdts
270bc36eafdSMike Gerdts void
UtDumpStringOp(ACPI_PARSE_OBJECT * Op,UINT32 Level)271bc36eafdSMike Gerdts UtDumpStringOp (
272bc36eafdSMike Gerdts ACPI_PARSE_OBJECT *Op,
273bc36eafdSMike Gerdts UINT32 Level)
274bc36eafdSMike Gerdts {
275bc36eafdSMike Gerdts char *String;
276bc36eafdSMike Gerdts
277bc36eafdSMike Gerdts
278bc36eafdSMike Gerdts String = Op->Asl.Value.String;
279bc36eafdSMike Gerdts if (Op->Asl.ParseOpcode != PARSEOP_STRING_LITERAL)
280bc36eafdSMike Gerdts {
281bc36eafdSMike Gerdts /*
282bc36eafdSMike Gerdts * For the "path" ops NAMEPATH, NAMESEG, METHODCALL -- if the
283bc36eafdSMike Gerdts * ExternalName is valid, it takes precedence. In these cases the
284bc36eafdSMike Gerdts * Value.String is the raw "internal" name from the AML code, which
285bc36eafdSMike Gerdts * we don't want to use, because it contains non-ascii characters.
286bc36eafdSMike Gerdts */
287bc36eafdSMike Gerdts if (Op->Asl.ExternalName)
288bc36eafdSMike Gerdts {
289bc36eafdSMike Gerdts String = Op->Asl.ExternalName;
290bc36eafdSMike Gerdts }
291bc36eafdSMike Gerdts }
292bc36eafdSMike Gerdts
293bc36eafdSMike Gerdts if (!String)
294bc36eafdSMike Gerdts {
295bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT,
296bc36eafdSMike Gerdts " ERROR: Could not find a valid String/Path pointer\n");
297bc36eafdSMike Gerdts return;
298bc36eafdSMike Gerdts }
299bc36eafdSMike Gerdts
300*35786f68SRobert Mustacchi String = UtCreateEscapeSequences (String);
301*35786f68SRobert Mustacchi
302bc36eafdSMike Gerdts /* Emit the ParseOp name, leaving room for the string */
303bc36eafdSMike Gerdts
304bc36eafdSMike Gerdts UtDumpParseOpName (Op, Level, strlen (String));
305bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT, "%s", String);
306bc36eafdSMike Gerdts }
307bc36eafdSMike Gerdts
308bc36eafdSMike Gerdts
309bc36eafdSMike Gerdts /*******************************************************************************
310bc36eafdSMike Gerdts *
311*35786f68SRobert Mustacchi * FUNCTION: UtCreateEscapeSequences
312*35786f68SRobert Mustacchi *
313*35786f68SRobert Mustacchi * PARAMETERS: InString - ASCII string to be expanded
314*35786f68SRobert Mustacchi *
315*35786f68SRobert Mustacchi * RETURN: Expanded string
316*35786f68SRobert Mustacchi *
317*35786f68SRobert Mustacchi * DESCRIPTION: Expand all non-printable ASCII bytes (0-0x1F) to escape
318*35786f68SRobert Mustacchi * sequences. For example, hex 14 becomes \x14
319*35786f68SRobert Mustacchi *
320*35786f68SRobert Mustacchi * NOTE: Since this function is used for debug output only, it does
321*35786f68SRobert Mustacchi * not attempt to translate into the "known" escape sequences
322*35786f68SRobert Mustacchi * such as \a, \f, \t, etc.
323*35786f68SRobert Mustacchi *
324*35786f68SRobert Mustacchi ******************************************************************************/
325*35786f68SRobert Mustacchi
326*35786f68SRobert Mustacchi static char *
UtCreateEscapeSequences(char * InString)327*35786f68SRobert Mustacchi UtCreateEscapeSequences (
328*35786f68SRobert Mustacchi char *InString)
329*35786f68SRobert Mustacchi {
330*35786f68SRobert Mustacchi char *String = InString;
331*35786f68SRobert Mustacchi char *OutString;
332*35786f68SRobert Mustacchi char *OutStringPtr;
333*35786f68SRobert Mustacchi UINT32 InStringLength = 0;
334*35786f68SRobert Mustacchi UINT32 EscapeCount = 0;
335*35786f68SRobert Mustacchi
336*35786f68SRobert Mustacchi
337*35786f68SRobert Mustacchi /*
338*35786f68SRobert Mustacchi * Determine up front how many escapes are within the string.
339*35786f68SRobert Mustacchi * Obtain the input string length while doing so.
340*35786f68SRobert Mustacchi */
341*35786f68SRobert Mustacchi while (*String)
342*35786f68SRobert Mustacchi {
343*35786f68SRobert Mustacchi if ((*String <= 0x1F) || (*String >= 0x7F))
344*35786f68SRobert Mustacchi {
345*35786f68SRobert Mustacchi EscapeCount++;
346*35786f68SRobert Mustacchi }
347*35786f68SRobert Mustacchi
348*35786f68SRobert Mustacchi InStringLength++;
349*35786f68SRobert Mustacchi String++;
350*35786f68SRobert Mustacchi }
351*35786f68SRobert Mustacchi
352*35786f68SRobert Mustacchi if (!EscapeCount)
353*35786f68SRobert Mustacchi {
354*35786f68SRobert Mustacchi return (InString); /* No escapes, nothing to do */
355*35786f68SRobert Mustacchi }
356*35786f68SRobert Mustacchi
357*35786f68SRobert Mustacchi /* New string buffer, 3 extra chars per escape (4 total) */
358*35786f68SRobert Mustacchi
359*35786f68SRobert Mustacchi OutString = UtLocalCacheCalloc (InStringLength + (EscapeCount * 3));
360*35786f68SRobert Mustacchi OutStringPtr = OutString;
361*35786f68SRobert Mustacchi
362*35786f68SRobert Mustacchi /* Convert non-ascii or non-printable chars to escape sequences */
363*35786f68SRobert Mustacchi
364*35786f68SRobert Mustacchi while (*InString)
365*35786f68SRobert Mustacchi {
366*35786f68SRobert Mustacchi if ((*InString <= 0x1F) || (*InString >= 0x7F))
367*35786f68SRobert Mustacchi {
368*35786f68SRobert Mustacchi /* Insert a \x hex escape sequence */
369*35786f68SRobert Mustacchi
370*35786f68SRobert Mustacchi OutStringPtr[0] = '\\';
371*35786f68SRobert Mustacchi OutStringPtr[1] = 'x';
372*35786f68SRobert Mustacchi OutStringPtr[2] = AcpiUtHexToAsciiChar (*InString, 4);
373*35786f68SRobert Mustacchi OutStringPtr[3] = AcpiUtHexToAsciiChar (*InString, 0);
374*35786f68SRobert Mustacchi OutStringPtr += 4;
375*35786f68SRobert Mustacchi }
376*35786f68SRobert Mustacchi else /* Normal ASCII character */
377*35786f68SRobert Mustacchi {
378*35786f68SRobert Mustacchi *OutStringPtr = *InString;
379*35786f68SRobert Mustacchi OutStringPtr++;
380*35786f68SRobert Mustacchi }
381*35786f68SRobert Mustacchi
382*35786f68SRobert Mustacchi InString++;
383*35786f68SRobert Mustacchi }
384*35786f68SRobert Mustacchi
385*35786f68SRobert Mustacchi return (OutString);
386*35786f68SRobert Mustacchi }
387*35786f68SRobert Mustacchi
388*35786f68SRobert Mustacchi
389*35786f68SRobert Mustacchi /*******************************************************************************
390*35786f68SRobert Mustacchi *
391bc36eafdSMike Gerdts * FUNCTION: UtDumpBasicOp
392bc36eafdSMike Gerdts *
393bc36eafdSMike Gerdts * PARAMETERS: Op - Current parse op
394bc36eafdSMike Gerdts * Level - Current output indentation level
395bc36eafdSMike Gerdts *
396bc36eafdSMike Gerdts * RETURN: None
397bc36eafdSMike Gerdts *
398bc36eafdSMike Gerdts * DESCRIPTION: Generic formatted debug output for "basic" ops that have no
399bc36eafdSMike Gerdts * associated strings or integer values.
400bc36eafdSMike Gerdts *
401bc36eafdSMike Gerdts ******************************************************************************/
402bc36eafdSMike Gerdts
403bc36eafdSMike Gerdts void
UtDumpBasicOp(ACPI_PARSE_OBJECT * Op,UINT32 Level)404bc36eafdSMike Gerdts UtDumpBasicOp (
405bc36eafdSMike Gerdts ACPI_PARSE_OBJECT *Op,
406bc36eafdSMike Gerdts UINT32 Level)
407bc36eafdSMike Gerdts {
408bc36eafdSMike Gerdts
409bc36eafdSMike Gerdts /* Just print out the ParseOp name, there is no extra data */
410bc36eafdSMike Gerdts
411bc36eafdSMike Gerdts UtDumpParseOpName (Op, Level, 0);
412bc36eafdSMike Gerdts }
413bc36eafdSMike Gerdts
414bc36eafdSMike Gerdts
415bc36eafdSMike Gerdts /*******************************************************************************
416bc36eafdSMike Gerdts *
417bc36eafdSMike Gerdts * FUNCTION: UtDumpParseOpName
418bc36eafdSMike Gerdts *
419bc36eafdSMike Gerdts * PARAMETERS: Op - Current parse op
420bc36eafdSMike Gerdts * Level - Current output indentation level
421bc36eafdSMike Gerdts * DataLength - Length of data to appear after the name
422bc36eafdSMike Gerdts *
423bc36eafdSMike Gerdts * RETURN: None
424bc36eafdSMike Gerdts *
425bc36eafdSMike Gerdts * DESCRIPTION: Indent and emit the ascii ParseOp name for the op
426bc36eafdSMike Gerdts *
427bc36eafdSMike Gerdts ******************************************************************************/
428bc36eafdSMike Gerdts
429bc36eafdSMike Gerdts static void
UtDumpParseOpName(ACPI_PARSE_OBJECT * Op,UINT32 Level,UINT32 DataLength)430bc36eafdSMike Gerdts UtDumpParseOpName (
431bc36eafdSMike Gerdts ACPI_PARSE_OBJECT *Op,
432bc36eafdSMike Gerdts UINT32 Level,
433bc36eafdSMike Gerdts UINT32 DataLength)
434bc36eafdSMike Gerdts {
435bc36eafdSMike Gerdts char *ParseOpName;
436bc36eafdSMike Gerdts UINT32 IndentLength;
437bc36eafdSMike Gerdts UINT32 NameLength;
438bc36eafdSMike Gerdts UINT32 LineLength;
439bc36eafdSMike Gerdts UINT32 PaddingLength;
440bc36eafdSMike Gerdts
441bc36eafdSMike Gerdts
442bc36eafdSMike Gerdts /* Emit the LineNumber/IndentLevel prefix on each output line */
443bc36eafdSMike Gerdts
444bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT,
445bc36eafdSMike Gerdts "%5.5d [%2d]", Op->Asl.LogicalLineNumber, Level);
446bc36eafdSMike Gerdts
447bc36eafdSMike Gerdts ParseOpName = UtGetOpName (Op->Asl.ParseOpcode);
448bc36eafdSMike Gerdts
449bc36eafdSMike Gerdts /* Calculate various lengths for output alignment */
450bc36eafdSMike Gerdts
451bc36eafdSMike Gerdts IndentLength = Level * DEBUG_SPACES_PER_INDENT;
452bc36eafdSMike Gerdts NameLength = strlen (ParseOpName);
453bc36eafdSMike Gerdts LineLength = IndentLength + 1 + NameLength + 1 + DataLength;
454bc36eafdSMike Gerdts PaddingLength = (DEBUG_MAX_LINE_LENGTH + 1) - LineLength;
455bc36eafdSMike Gerdts
456bc36eafdSMike Gerdts /* Parse tree indentation is based upon the nesting/indent level */
457bc36eafdSMike Gerdts
458bc36eafdSMike Gerdts if (Level)
459bc36eafdSMike Gerdts {
460bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT, "%*s", IndentLength, " ");
461bc36eafdSMike Gerdts }
462bc36eafdSMike Gerdts
463bc36eafdSMike Gerdts /* Emit the actual name here */
464bc36eafdSMike Gerdts
465bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT, " %s", ParseOpName);
466bc36eafdSMike Gerdts
467bc36eafdSMike Gerdts /* Emit extra padding blanks for alignment of later data items */
468bc36eafdSMike Gerdts
469bc36eafdSMike Gerdts if (LineLength > DEBUG_MAX_LINE_LENGTH)
470bc36eafdSMike Gerdts {
471bc36eafdSMike Gerdts /* Split a long line immediately after the ParseOpName string */
472bc36eafdSMike Gerdts
473bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT, "\n%*s",
474bc36eafdSMike Gerdts (DEBUG_FULL_LINE_LENGTH - DataLength), " ");
475bc36eafdSMike Gerdts }
476bc36eafdSMike Gerdts else
477bc36eafdSMike Gerdts {
478bc36eafdSMike Gerdts DbgPrint (ASL_TREE_OUTPUT, "%*s", PaddingLength, " ");
479bc36eafdSMike Gerdts }
480bc36eafdSMike Gerdts }
481