1 /******************************************************************************
3 * Name: acresrc.h - Resource Manager function prototypes
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12 * All rights reserved.
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
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,
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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
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
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.
115 *****************************************************************************
117 * Alternatively, you may choose to be licensed under the terms of the
120 * Redistribution and use in source and binary forms, with or without
121 * modification, are permitted provided that the following conditions
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.
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.
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.
151 *****************************************************************************/
153 #ifndef __ACRESRC_H__
154 #define __ACRESRC_H__
156 /* Need the AML resource descriptor structs */
158 #include "amlresrc.h"
162 * If possible, pack the following structures to byte alignment, since we
163 * don't care about performance for debug output. Two cases where we cannot
164 * pack the structures:
166 * 1) Hardware does not support misaligned memory transfers
167 * 2) Compiler does not support pointers within packed structures
169 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
174 * Individual entry for the resource conversion tables
176 typedef const struct acpi_rsconvert_info
179 UINT8 ResourceOffset;
183 } ACPI_RSCONVERT_INFO;
185 /* Resource conversion opcodes */
189 ACPI_RSC_INITGET = 0,
201 ACPI_RSC_COUNT_GPIO_PIN,
202 ACPI_RSC_COUNT_GPIO_RES,
203 ACPI_RSC_COUNT_GPIO_VEN,
204 ACPI_RSC_COUNT_SERIAL_RES,
205 ACPI_RSC_COUNT_SERIAL_VEN,
211 ACPI_RSC_MOVE_GPIO_PIN,
212 ACPI_RSC_MOVE_GPIO_RES,
213 ACPI_RSC_MOVE_SERIAL_RES,
214 ACPI_RSC_MOVE_SERIAL_VEN,
223 } ACPI_RSCONVERT_OPCODES;
225 /* Resource Conversion sub-opcodes */
227 #define ACPI_RSC_COMPARE_AML_LENGTH 0
228 #define ACPI_RSC_COMPARE_VALUE 1
230 #define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (ACPI_RSCONVERT_INFO))
232 #define ACPI_RS_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_RESOURCE,f)
233 #define AML_OFFSET(f) (UINT8) ACPI_OFFSET (AML_RESOURCE,f)
237 * Individual entry for the resource dump tables
239 typedef const struct acpi_rsdump_info
244 const char **Pointer;
248 /* Values for the Opcode field above */
271 ACPI_RSD_SOURCE_LABEL,
273 } ACPI_RSDUMP_OPCODES;
275 /* restore default alignment */
280 /* Resource tables indexed by internal resource type */
282 extern const UINT8 AcpiGbl_AmlResourceSizes[];
283 extern const UINT8 AcpiGbl_AmlResourceSerialBusSizes[];
284 extern ACPI_RSCONVERT_INFO *AcpiGbl_SetResourceDispatch[];
286 /* Resource tables indexed by raw AML resource descriptor type */
288 extern const UINT8 AcpiGbl_ResourceStructSizes[];
289 extern const UINT8 AcpiGbl_ResourceStructSerialBusSizes[];
290 extern ACPI_RSCONVERT_INFO *AcpiGbl_GetResourceDispatch[];
292 extern ACPI_RSCONVERT_INFO *AcpiGbl_ConvertResourceSerialBusDispatch[];
294 typedef struct acpi_vendor_walk_info
296 ACPI_VENDOR_UUID *Uuid;
300 } ACPI_VENDOR_WALK_INFO;
307 AcpiRsCreateResourceList (
308 ACPI_OPERAND_OBJECT *AmlBuffer,
309 ACPI_BUFFER *OutputBuffer);
312 AcpiRsCreateAmlResources (
313 ACPI_BUFFER *ResourceList,
314 ACPI_BUFFER *OutputBuffer);
317 AcpiRsCreatePciRoutingTable (
318 ACPI_OPERAND_OBJECT *PackageObject,
319 ACPI_BUFFER *OutputBuffer);
326 AcpiRsGetPrtMethodData (
327 ACPI_NAMESPACE_NODE *Node,
328 ACPI_BUFFER *RetBuffer);
331 AcpiRsGetCrsMethodData (
332 ACPI_NAMESPACE_NODE *Node,
333 ACPI_BUFFER *RetBuffer);
336 AcpiRsGetPrsMethodData (
337 ACPI_NAMESPACE_NODE *Node,
338 ACPI_BUFFER *RetBuffer);
341 AcpiRsGetMethodData (
344 ACPI_BUFFER *RetBuffer);
347 AcpiRsSetSrsMethodData (
348 ACPI_NAMESPACE_NODE *Node,
349 ACPI_BUFFER *RetBuffer);
352 AcpiRsGetAeiMethodData (
353 ACPI_NAMESPACE_NODE *Node,
354 ACPI_BUFFER *RetBuffer);
360 AcpiRsGetListLength (
362 UINT32 AmlBufferLength,
363 ACPI_SIZE *SizeNeeded);
367 ACPI_RESOURCE *ResourceList,
368 ACPI_SIZE ResourceListSize,
369 ACPI_SIZE *SizeNeeded);
372 AcpiRsGetPciRoutingTableLength (
373 ACPI_OPERAND_OBJECT *PackageObject,
374 ACPI_SIZE *BufferSizeNeeded);
377 AcpiRsConvertAmlToResources (
385 AcpiRsConvertResourcesToAml (
386 ACPI_RESOURCE *Resource,
387 ACPI_SIZE AmlSizeNeeded,
388 UINT8 *OutputBuffer);
395 AcpiRsSetAddressCommon (
397 ACPI_RESOURCE *Resource);
400 AcpiRsGetAddressCommon (
401 ACPI_RESOURCE *Resource,
409 AcpiRsConvertAmlToResource (
410 ACPI_RESOURCE *Resource,
412 ACPI_RSCONVERT_INFO *Info);
415 AcpiRsConvertResourceToAml (
416 ACPI_RESOURCE *Resource,
418 ACPI_RSCONVERT_INFO *Info);
432 AcpiRsDecodeBitmask (
437 AcpiRsEncodeBitmask (
442 AcpiRsGetResourceSource (
443 ACPI_RS_LENGTH ResourceLength,
444 ACPI_RS_LENGTH MinimumLength,
445 ACPI_RESOURCE_SOURCE *ResourceSource,
450 AcpiRsSetResourceSource (
452 ACPI_RS_LENGTH MinimumLength,
453 ACPI_RESOURCE_SOURCE *ResourceSource);
456 AcpiRsSetResourceHeader (
457 UINT8 DescriptorType,
458 ACPI_RSDESC_SIZE TotalLength,
462 AcpiRsSetResourceLength (
463 ACPI_RSDESC_SIZE TotalLength,
468 * rsdump - Debugger support
472 AcpiRsDumpResourceList (
473 ACPI_RESOURCE *Resource);
482 * Resource conversion tables
484 extern ACPI_RSCONVERT_INFO AcpiRsConvertDma[];
485 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndDpf[];
486 extern ACPI_RSCONVERT_INFO AcpiRsConvertIo[];
487 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedIo[];
488 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndTag[];
489 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory24[];
490 extern ACPI_RSCONVERT_INFO AcpiRsConvertGenericReg[];
491 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory32[];
492 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedMemory32[];
493 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress32[];
494 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress16[];
495 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtIrq[];
496 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress64[];
497 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtAddress64[];
498 extern ACPI_RSCONVERT_INFO AcpiRsConvertGpio[];
499 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedDma[];
500 extern ACPI_RSCONVERT_INFO AcpiRsConvertCsi2SerialBus[];
501 extern ACPI_RSCONVERT_INFO AcpiRsConvertI2cSerialBus[];
502 extern ACPI_RSCONVERT_INFO AcpiRsConvertSpiSerialBus[];
503 extern ACPI_RSCONVERT_INFO AcpiRsConvertUartSerialBus[];
504 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinFunction[];
505 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinConfig[];
506 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinGroup[];
507 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinGroupFunction[];
508 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinGroupConfig[];
510 /* These resources require separate get/set tables */
512 extern ACPI_RSCONVERT_INFO AcpiRsGetIrq[];
513 extern ACPI_RSCONVERT_INFO AcpiRsGetStartDpf[];
514 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorSmall[];
515 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorLarge[];
517 extern ACPI_RSCONVERT_INFO AcpiRsSetIrq[];
518 extern ACPI_RSCONVERT_INFO AcpiRsSetStartDpf[];
519 extern ACPI_RSCONVERT_INFO AcpiRsSetVendor[];
522 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
526 extern ACPI_RSDUMP_INFO *AcpiGbl_DumpResourceDispatch[];
527 extern ACPI_RSDUMP_INFO *AcpiGbl_DumpSerialBusDispatch[];
532 extern ACPI_RSDUMP_INFO AcpiRsDumpIrq[];
533 extern ACPI_RSDUMP_INFO AcpiRsDumpPrt[];
534 extern ACPI_RSDUMP_INFO AcpiRsDumpDma[];
535 extern ACPI_RSDUMP_INFO AcpiRsDumpStartDpf[];
536 extern ACPI_RSDUMP_INFO AcpiRsDumpEndDpf[];
537 extern ACPI_RSDUMP_INFO AcpiRsDumpIo[];
538 extern ACPI_RSDUMP_INFO AcpiRsDumpIoFlags[];
539 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedIo[];
540 extern ACPI_RSDUMP_INFO AcpiRsDumpVendor[];
541 extern ACPI_RSDUMP_INFO AcpiRsDumpEndTag[];
542 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory24[];
543 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory32[];
544 extern ACPI_RSDUMP_INFO AcpiRsDumpMemoryFlags[];
545 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedMemory32[];
546 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress16[];
547 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress32[];
548 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress64[];
549 extern ACPI_RSDUMP_INFO AcpiRsDumpExtAddress64[];
550 extern ACPI_RSDUMP_INFO AcpiRsDumpExtIrq[];
551 extern ACPI_RSDUMP_INFO AcpiRsDumpGenericReg[];
552 extern ACPI_RSDUMP_INFO AcpiRsDumpGpio[];
553 extern ACPI_RSDUMP_INFO AcpiRsDumpPinFunction[];
554 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedDma[];
555 extern ACPI_RSDUMP_INFO AcpiRsDumpCommonSerialBus[];
556 extern ACPI_RSDUMP_INFO AcpiRsDumpCsi2SerialBus[];
557 extern ACPI_RSDUMP_INFO AcpiRsDumpI2cSerialBus[];
558 extern ACPI_RSDUMP_INFO AcpiRsDumpSpiSerialBus[];
559 extern ACPI_RSDUMP_INFO AcpiRsDumpUartSerialBus[];
560 extern ACPI_RSDUMP_INFO AcpiRsDumpGeneralFlags[];
561 extern ACPI_RSDUMP_INFO AcpiRsDumpPinConfig[];
562 extern ACPI_RSDUMP_INFO AcpiRsDumpPinGroup[];
563 extern ACPI_RSDUMP_INFO AcpiRsDumpPinGroupFunction[];
564 extern ACPI_RSDUMP_INFO AcpiRsDumpPinGroupConfig[];
567 #endif /* __ACRESRC_H__ */