1 /******************************************************************************
3 * Name: acresrc.h - Resource Manager function prototypes
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2012, 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 #ifndef __ACRESRC_H__
118 #define __ACRESRC_H__
120 /* Need the AML resource descriptor structs */
122 #include "amlresrc.h"
126 * If possible, pack the following structures to byte alignment, since we
127 * don't care about performance for debug output. Two cases where we cannot
128 * pack the structures:
130 * 1) Hardware does not support misaligned memory transfers
131 * 2) Compiler does not support pointers within packed structures
133 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
138 * Individual entry for the resource conversion tables
140 typedef const struct acpi_rsconvert_info
143 UINT8 ResourceOffset
;
147 } ACPI_RSCONVERT_INFO
;
149 /* Resource conversion opcodes */
153 ACPI_RSC_INITGET
= 0,
164 ACPI_RSC_COUNT_GPIO_PIN
,
165 ACPI_RSC_COUNT_GPIO_RES
,
166 ACPI_RSC_COUNT_GPIO_VEN
,
167 ACPI_RSC_COUNT_SERIAL_RES
,
168 ACPI_RSC_COUNT_SERIAL_VEN
,
174 ACPI_RSC_MOVE_GPIO_PIN
,
175 ACPI_RSC_MOVE_GPIO_RES
,
176 ACPI_RSC_MOVE_SERIAL_RES
,
177 ACPI_RSC_MOVE_SERIAL_VEN
,
186 } ACPI_RSCONVERT_OPCODES
;
188 /* Resource Conversion sub-opcodes */
190 #define ACPI_RSC_COMPARE_AML_LENGTH 0
191 #define ACPI_RSC_COMPARE_VALUE 1
193 #define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (ACPI_RSCONVERT_INFO))
195 #define ACPI_RS_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_RESOURCE,f)
196 #define AML_OFFSET(f) (UINT8) ACPI_OFFSET (AML_RESOURCE,f)
200 * Individual entry for the resource dump tables
202 typedef const struct acpi_rsdump_info
207 const char **Pointer
;
211 /* Values for the Opcode field above */
233 } ACPI_RSDUMP_OPCODES
;
235 /* restore default alignment */
240 /* Resource tables indexed by internal resource type */
242 extern const UINT8 AcpiGbl_AmlResourceSizes
[];
243 extern const UINT8 AcpiGbl_AmlResourceSerialBusSizes
[];
244 extern ACPI_RSCONVERT_INFO
*AcpiGbl_SetResourceDispatch
[];
246 /* Resource tables indexed by raw AML resource descriptor type */
248 extern const UINT8 AcpiGbl_ResourceStructSizes
[];
249 extern const UINT8 AcpiGbl_ResourceStructSerialBusSizes
[];
250 extern ACPI_RSCONVERT_INFO
*AcpiGbl_GetResourceDispatch
[];
252 extern ACPI_RSCONVERT_INFO
*AcpiGbl_ConvertResourceSerialBusDispatch
[];
254 typedef struct acpi_vendor_walk_info
256 ACPI_VENDOR_UUID
*Uuid
;
260 } ACPI_VENDOR_WALK_INFO
;
267 AcpiRsCreateResourceList (
268 ACPI_OPERAND_OBJECT
*AmlBuffer
,
269 ACPI_BUFFER
*OutputBuffer
);
272 AcpiRsCreateAmlResources (
273 ACPI_RESOURCE
*LinkedListBuffer
,
274 ACPI_BUFFER
*OutputBuffer
);
277 AcpiRsCreatePciRoutingTable (
278 ACPI_OPERAND_OBJECT
*PackageObject
,
279 ACPI_BUFFER
*OutputBuffer
);
286 AcpiRsGetPrtMethodData (
287 ACPI_NAMESPACE_NODE
*Node
,
288 ACPI_BUFFER
*RetBuffer
);
291 AcpiRsGetCrsMethodData (
292 ACPI_NAMESPACE_NODE
*Node
,
293 ACPI_BUFFER
*RetBuffer
);
296 AcpiRsGetPrsMethodData (
297 ACPI_NAMESPACE_NODE
*Node
,
298 ACPI_BUFFER
*RetBuffer
);
301 AcpiRsGetMethodData (
304 ACPI_BUFFER
*RetBuffer
);
307 AcpiRsSetSrsMethodData (
308 ACPI_NAMESPACE_NODE
*Node
,
309 ACPI_BUFFER
*RetBuffer
);
312 AcpiRsGetAeiMethodData (
313 ACPI_NAMESPACE_NODE
*Node
,
314 ACPI_BUFFER
*RetBuffer
);
320 AcpiRsGetListLength (
322 UINT32 AmlBufferLength
,
323 ACPI_SIZE
*SizeNeeded
);
327 ACPI_RESOURCE
*LinkedListBuffer
,
328 ACPI_SIZE
*SizeNeeded
);
331 AcpiRsGetPciRoutingTableLength (
332 ACPI_OPERAND_OBJECT
*PackageObject
,
333 ACPI_SIZE
*BufferSizeNeeded
);
336 AcpiRsConvertAmlToResources (
344 AcpiRsConvertResourcesToAml (
345 ACPI_RESOURCE
*Resource
,
346 ACPI_SIZE AmlSizeNeeded
,
347 UINT8
*OutputBuffer
);
354 AcpiRsSetAddressCommon (
356 ACPI_RESOURCE
*Resource
);
359 AcpiRsGetAddressCommon (
360 ACPI_RESOURCE
*Resource
,
368 AcpiRsConvertAmlToResource (
369 ACPI_RESOURCE
*Resource
,
371 ACPI_RSCONVERT_INFO
*Info
);
374 AcpiRsConvertResourceToAml (
375 ACPI_RESOURCE
*Resource
,
377 ACPI_RSCONVERT_INFO
*Info
);
391 AcpiRsDecodeBitmask (
396 AcpiRsEncodeBitmask (
401 AcpiRsGetResourceSource (
402 ACPI_RS_LENGTH ResourceLength
,
403 ACPI_RS_LENGTH MinimumLength
,
404 ACPI_RESOURCE_SOURCE
*ResourceSource
,
409 AcpiRsSetResourceSource (
411 ACPI_RS_LENGTH MinimumLength
,
412 ACPI_RESOURCE_SOURCE
*ResourceSource
);
415 AcpiRsSetResourceHeader (
416 UINT8 DescriptorType
,
417 ACPI_RSDESC_SIZE TotalLength
,
421 AcpiRsSetResourceLength (
422 ACPI_RSDESC_SIZE TotalLength
,
430 AcpiRsDumpResourceList (
431 ACPI_RESOURCE
*Resource
);
439 * Resource conversion tables
441 extern ACPI_RSCONVERT_INFO AcpiRsConvertDma
[];
442 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndDpf
[];
443 extern ACPI_RSCONVERT_INFO AcpiRsConvertIo
[];
444 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedIo
[];
445 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndTag
[];
446 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory24
[];
447 extern ACPI_RSCONVERT_INFO AcpiRsConvertGenericReg
[];
448 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory32
[];
449 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedMemory32
[];
450 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress32
[];
451 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress16
[];
452 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtIrq
[];
453 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress64
[];
454 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtAddress64
[];
455 extern ACPI_RSCONVERT_INFO AcpiRsConvertGpio
[];
456 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedDma
[];
457 extern ACPI_RSCONVERT_INFO AcpiRsConvertI2cSerialBus
[];
458 extern ACPI_RSCONVERT_INFO AcpiRsConvertSpiSerialBus
[];
459 extern ACPI_RSCONVERT_INFO AcpiRsConvertUartSerialBus
[];
461 /* These resources require separate get/set tables */
463 extern ACPI_RSCONVERT_INFO AcpiRsGetIrq
[];
464 extern ACPI_RSCONVERT_INFO AcpiRsGetStartDpf
[];
465 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorSmall
[];
466 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorLarge
[];
468 extern ACPI_RSCONVERT_INFO AcpiRsSetIrq
[];
469 extern ACPI_RSCONVERT_INFO AcpiRsSetStartDpf
[];
470 extern ACPI_RSCONVERT_INFO AcpiRsSetVendor
[];
473 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
477 extern ACPI_RSDUMP_INFO
*AcpiGbl_DumpResourceDispatch
[];
478 extern ACPI_RSDUMP_INFO
*AcpiGbl_DumpSerialBusDispatch
[];
483 extern ACPI_RSDUMP_INFO AcpiRsDumpIrq
[];
484 extern ACPI_RSDUMP_INFO AcpiRsDumpDma
[];
485 extern ACPI_RSDUMP_INFO AcpiRsDumpStartDpf
[];
486 extern ACPI_RSDUMP_INFO AcpiRsDumpEndDpf
[];
487 extern ACPI_RSDUMP_INFO AcpiRsDumpIo
[];
488 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedIo
[];
489 extern ACPI_RSDUMP_INFO AcpiRsDumpVendor
[];
490 extern ACPI_RSDUMP_INFO AcpiRsDumpEndTag
[];
491 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory24
[];
492 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory32
[];
493 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedMemory32
[];
494 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress16
[];
495 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress32
[];
496 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress64
[];
497 extern ACPI_RSDUMP_INFO AcpiRsDumpExtAddress64
[];
498 extern ACPI_RSDUMP_INFO AcpiRsDumpExtIrq
[];
499 extern ACPI_RSDUMP_INFO AcpiRsDumpGenericReg
[];
500 extern ACPI_RSDUMP_INFO AcpiRsDumpGpio
[];
501 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedDma
[];
502 extern ACPI_RSDUMP_INFO AcpiRsDumpCommonSerialBus
[];
503 extern ACPI_RSDUMP_INFO AcpiRsDumpI2cSerialBus
[];
504 extern ACPI_RSDUMP_INFO AcpiRsDumpSpiSerialBus
[];
505 extern ACPI_RSDUMP_INFO AcpiRsDumpUartSerialBus
[];
508 #endif /* __ACRESRC_H__ */