xref: /illumos-gate/usr/src/common/acpica/utilities/utresdecode.c (revision eb6b10e69fa5ba733da194d3ad71a0e63338be29)
1 /*******************************************************************************
2  *
3  * Module Name: utresdecode - Resource descriptor keyword strings
4  *
5  ******************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2018, 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  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acresrc.h"
155 
156 
157 #define _COMPONENT          ACPI_UTILITIES
158         ACPI_MODULE_NAME    ("utresdecode")
159 
160 
161 #if defined (ACPI_DEBUG_OUTPUT) || \
162     defined (ACPI_DISASSEMBLER) || \
163     defined (ACPI_DEBUGGER)
164 
165 /*
166  * Strings used to decode resource descriptors.
167  * Used by both the disassembler and the debugger resource dump routines
168  */
169 const char                      *AcpiGbl_BmDecode[] =
170 {
171     "NotBusMaster",
172     "BusMaster"
173 };
174 
175 const char                      *AcpiGbl_ConfigDecode[] =
176 {
177     "0 - Good Configuration",
178     "1 - Acceptable Configuration",
179     "2 - Suboptimal Configuration",
180     "3 - ***Invalid Configuration***",
181 };
182 
183 const char                      *AcpiGbl_ConsumeDecode[] =
184 {
185     "ResourceProducer",
186     "ResourceConsumer"
187 };
188 
189 const char                      *AcpiGbl_DecDecode[] =
190 {
191     "PosDecode",
192     "SubDecode"
193 };
194 
195 const char                      *AcpiGbl_HeDecode[] =
196 {
197     "Level",
198     "Edge"
199 };
200 
201 const char                      *AcpiGbl_IoDecode[] =
202 {
203     "Decode10",
204     "Decode16"
205 };
206 
207 const char                      *AcpiGbl_LlDecode[] =
208 {
209     "ActiveHigh",
210     "ActiveLow",
211     "ActiveBoth",
212     "Reserved"
213 };
214 
215 const char                      *AcpiGbl_MaxDecode[] =
216 {
217     "MaxNotFixed",
218     "MaxFixed"
219 };
220 
221 const char                      *AcpiGbl_MemDecode[] =
222 {
223     "NonCacheable",
224     "Cacheable",
225     "WriteCombining",
226     "Prefetchable"
227 };
228 
229 const char                      *AcpiGbl_MinDecode[] =
230 {
231     "MinNotFixed",
232     "MinFixed"
233 };
234 
235 const char                      *AcpiGbl_MtpDecode[] =
236 {
237     "AddressRangeMemory",
238     "AddressRangeReserved",
239     "AddressRangeACPI",
240     "AddressRangeNVS"
241 };
242 
243 const char                      *AcpiGbl_RngDecode[] =
244 {
245     "InvalidRanges",
246     "NonISAOnlyRanges",
247     "ISAOnlyRanges",
248     "EntireRange"
249 };
250 
251 const char                      *AcpiGbl_RwDecode[] =
252 {
253     "ReadOnly",
254     "ReadWrite"
255 };
256 
257 const char                      *AcpiGbl_ShrDecode[] =
258 {
259     "Exclusive",
260     "Shared",
261     "ExclusiveAndWake",         /* ACPI 5.0 */
262     "SharedAndWake"             /* ACPI 5.0 */
263 };
264 
265 const char                      *AcpiGbl_SizDecode[] =
266 {
267     "Transfer8",
268     "Transfer8_16",
269     "Transfer16",
270     "InvalidSize"
271 };
272 
273 const char                      *AcpiGbl_TrsDecode[] =
274 {
275     "DenseTranslation",
276     "SparseTranslation"
277 };
278 
279 const char                      *AcpiGbl_TtpDecode[] =
280 {
281     "TypeStatic",
282     "TypeTranslation"
283 };
284 
285 const char                      *AcpiGbl_TypDecode[] =
286 {
287     "Compatibility",
288     "TypeA",
289     "TypeB",
290     "TypeF"
291 };
292 
293 const char                      *AcpiGbl_PpcDecode[] =
294 {
295     "PullDefault",
296     "PullUp",
297     "PullDown",
298     "PullNone"
299 };
300 
301 const char                      *AcpiGbl_IorDecode[] =
302 {
303     "IoRestrictionNone",
304     "IoRestrictionInputOnly",
305     "IoRestrictionOutputOnly",
306     "IoRestrictionNoneAndPreserve"
307 };
308 
309 const char                      *AcpiGbl_DtsDecode[] =
310 {
311     "Width8bit",
312     "Width16bit",
313     "Width32bit",
314     "Width64bit",
315     "Width128bit",
316     "Width256bit",
317 };
318 
319 /* GPIO connection type */
320 
321 const char                      *AcpiGbl_CtDecode[] =
322 {
323     "Interrupt",
324     "I/O"
325 };
326 
327 /* Serial bus type */
328 
329 const char                      *AcpiGbl_SbtDecode[] =
330 {
331     "/* UNKNOWN serial bus type */",
332     "I2C",
333     "SPI",
334     "UART"
335 };
336 
337 /* I2C serial bus access mode */
338 
339 const char                      *AcpiGbl_AmDecode[] =
340 {
341     "AddressingMode7Bit",
342     "AddressingMode10Bit"
343 };
344 
345 /* I2C serial bus slave mode */
346 
347 const char                      *AcpiGbl_SmDecode[] =
348 {
349     "ControllerInitiated",
350     "DeviceInitiated"
351 };
352 
353 /* SPI serial bus wire mode */
354 
355 const char                      *AcpiGbl_WmDecode[] =
356 {
357     "FourWireMode",
358     "ThreeWireMode"
359 };
360 
361 /* SPI serial clock phase */
362 
363 const char                      *AcpiGbl_CphDecode[] =
364 {
365     "ClockPhaseFirst",
366     "ClockPhaseSecond"
367 };
368 
369 /* SPI serial bus clock polarity */
370 
371 const char                      *AcpiGbl_CpoDecode[] =
372 {
373     "ClockPolarityLow",
374     "ClockPolarityHigh"
375 };
376 
377 /* SPI serial bus device polarity */
378 
379 const char                      *AcpiGbl_DpDecode[] =
380 {
381     "PolarityLow",
382     "PolarityHigh"
383 };
384 
385 /* UART serial bus endian */
386 
387 const char                      *AcpiGbl_EdDecode[] =
388 {
389     "LittleEndian",
390     "BigEndian"
391 };
392 
393 /* UART serial bus bits per byte */
394 
395 const char                      *AcpiGbl_BpbDecode[] =
396 {
397     "DataBitsFive",
398     "DataBitsSix",
399     "DataBitsSeven",
400     "DataBitsEight",
401     "DataBitsNine",
402     "/* UNKNOWN Bits per byte */",
403     "/* UNKNOWN Bits per byte */",
404     "/* UNKNOWN Bits per byte */"
405 };
406 
407 /* UART serial bus stop bits */
408 
409 const char                      *AcpiGbl_SbDecode[] =
410 {
411     "StopBitsZero",
412     "StopBitsOne",
413     "StopBitsOnePlusHalf",
414     "StopBitsTwo"
415 };
416 
417 /* UART serial bus flow control */
418 
419 const char                      *AcpiGbl_FcDecode[] =
420 {
421     "FlowControlNone",
422     "FlowControlHardware",
423     "FlowControlXON",
424     "/* UNKNOWN flow control keyword */"
425 };
426 
427 /* UART serial bus parity type */
428 
429 const char                      *AcpiGbl_PtDecode[] =
430 {
431     "ParityTypeNone",
432     "ParityTypeEven",
433     "ParityTypeOdd",
434     "ParityTypeMark",
435     "ParityTypeSpace",
436     "/* UNKNOWN parity keyword */",
437     "/* UNKNOWN parity keyword */",
438     "/* UNKNOWN parity keyword */"
439 };
440 
441 /* PinConfig type */
442 
443 const char                      *AcpiGbl_PtypDecode[] =
444 {
445     "Default",
446     "Bias Pull-up",
447     "Bias Pull-down",
448     "Bias Default",
449     "Bias Disable",
450     "Bias High Impedance",
451     "Bias Bus Hold",
452     "Drive Open Drain",
453     "Drive Open Source",
454     "Drive Push Pull",
455     "Drive Strength",
456     "Slew Rate",
457     "Input Debounce",
458     "Input Schmitt Trigger",
459 };
460 
461 #endif
462