1 /******************************************************************************
3 * Name: acresrc.h - Resource Manager function prototypes
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
47 /* Need the AML resource descriptor structs */
53 * If possible, pack the following structures to byte alignment, since we
54 * don't care about performance for debug output. Two cases where we cannot
55 * pack the structures:
57 * 1) Hardware does not support misaligned memory transfers
58 * 2) Compiler does not support pointers within packed structures
60 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
65 * Individual entry for the resource conversion tables
67 typedef const struct acpi_rsconvert_info
74 } ACPI_RSCONVERT_INFO
;
76 /* Resource conversion opcodes */
91 ACPI_RSC_COUNT_GPIO_PIN
,
92 ACPI_RSC_COUNT_GPIO_RES
,
93 ACPI_RSC_COUNT_GPIO_VEN
,
94 ACPI_RSC_COUNT_SERIAL_RES
,
95 ACPI_RSC_COUNT_SERIAL_VEN
,
101 ACPI_RSC_MOVE_GPIO_PIN
,
102 ACPI_RSC_MOVE_GPIO_RES
,
103 ACPI_RSC_MOVE_SERIAL_RES
,
104 ACPI_RSC_MOVE_SERIAL_VEN
,
113 } ACPI_RSCONVERT_OPCODES
;
115 /* Resource Conversion sub-opcodes */
117 #define ACPI_RSC_COMPARE_AML_LENGTH 0
118 #define ACPI_RSC_COMPARE_VALUE 1
120 #define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (ACPI_RSCONVERT_INFO))
122 #define ACPI_RS_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_RESOURCE,f)
123 #define AML_OFFSET(f) (UINT8) ACPI_OFFSET (AML_RESOURCE,f)
127 * Individual entry for the resource dump tables
129 typedef const struct acpi_rsdump_info
134 const char **Pointer
;
138 /* Values for the Opcode field above */
160 ACPI_RSD_SOURCE_LABEL
,
162 } ACPI_RSDUMP_OPCODES
;
164 /* restore default alignment */
169 /* Resource tables indexed by internal resource type */
171 extern const UINT8 AcpiGbl_AmlResourceSizes
[];
172 extern const UINT8 AcpiGbl_AmlResourceSerialBusSizes
[];
173 extern ACPI_RSCONVERT_INFO
*AcpiGbl_SetResourceDispatch
[];
175 /* Resource tables indexed by raw AML resource descriptor type */
177 extern const UINT8 AcpiGbl_ResourceStructSizes
[];
178 extern const UINT8 AcpiGbl_ResourceStructSerialBusSizes
[];
179 extern ACPI_RSCONVERT_INFO
*AcpiGbl_GetResourceDispatch
[];
181 extern ACPI_RSCONVERT_INFO
*AcpiGbl_ConvertResourceSerialBusDispatch
[];
183 typedef struct acpi_vendor_walk_info
185 ACPI_VENDOR_UUID
*Uuid
;
189 } ACPI_VENDOR_WALK_INFO
;
196 AcpiRsCreateResourceList (
197 ACPI_OPERAND_OBJECT
*AmlBuffer
,
198 ACPI_BUFFER
*OutputBuffer
);
201 AcpiRsCreateAmlResources (
202 ACPI_BUFFER
*ResourceList
,
203 ACPI_BUFFER
*OutputBuffer
);
206 AcpiRsCreatePciRoutingTable (
207 ACPI_OPERAND_OBJECT
*PackageObject
,
208 ACPI_BUFFER
*OutputBuffer
);
215 AcpiRsGetPrtMethodData (
216 ACPI_NAMESPACE_NODE
*Node
,
217 ACPI_BUFFER
*RetBuffer
);
220 AcpiRsGetCrsMethodData (
221 ACPI_NAMESPACE_NODE
*Node
,
222 ACPI_BUFFER
*RetBuffer
);
225 AcpiRsGetPrsMethodData (
226 ACPI_NAMESPACE_NODE
*Node
,
227 ACPI_BUFFER
*RetBuffer
);
230 AcpiRsGetMethodData (
233 ACPI_BUFFER
*RetBuffer
);
236 AcpiRsSetSrsMethodData (
237 ACPI_NAMESPACE_NODE
*Node
,
238 ACPI_BUFFER
*RetBuffer
);
241 AcpiRsGetAeiMethodData (
242 ACPI_NAMESPACE_NODE
*Node
,
243 ACPI_BUFFER
*RetBuffer
);
249 AcpiRsGetListLength (
251 UINT32 AmlBufferLength
,
252 ACPI_SIZE
*SizeNeeded
);
256 ACPI_RESOURCE
*ResourceList
,
257 ACPI_SIZE ResourceListSize
,
258 ACPI_SIZE
*SizeNeeded
);
261 AcpiRsGetPciRoutingTableLength (
262 ACPI_OPERAND_OBJECT
*PackageObject
,
263 ACPI_SIZE
*BufferSizeNeeded
);
266 AcpiRsConvertAmlToResources (
274 AcpiRsConvertResourcesToAml (
275 ACPI_RESOURCE
*Resource
,
276 ACPI_SIZE AmlSizeNeeded
,
277 UINT8
*OutputBuffer
);
284 AcpiRsSetAddressCommon (
286 ACPI_RESOURCE
*Resource
);
289 AcpiRsGetAddressCommon (
290 ACPI_RESOURCE
*Resource
,
298 AcpiRsConvertAmlToResource (
299 ACPI_RESOURCE
*Resource
,
301 ACPI_RSCONVERT_INFO
*Info
);
304 AcpiRsConvertResourceToAml (
305 ACPI_RESOURCE
*Resource
,
307 ACPI_RSCONVERT_INFO
*Info
);
321 AcpiRsDecodeBitmask (
326 AcpiRsEncodeBitmask (
331 AcpiRsGetResourceSource (
332 ACPI_RS_LENGTH ResourceLength
,
333 ACPI_RS_LENGTH MinimumLength
,
334 ACPI_RESOURCE_SOURCE
*ResourceSource
,
339 AcpiRsSetResourceSource (
341 ACPI_RS_LENGTH MinimumLength
,
342 ACPI_RESOURCE_SOURCE
*ResourceSource
);
345 AcpiRsSetResourceHeader (
346 UINT8 DescriptorType
,
347 ACPI_RSDESC_SIZE TotalLength
,
351 AcpiRsSetResourceLength (
352 ACPI_RSDESC_SIZE TotalLength
,
357 * rsdump - Debugger support
361 AcpiRsDumpResourceList (
362 ACPI_RESOURCE
*Resource
);
371 * Resource conversion tables
373 extern ACPI_RSCONVERT_INFO AcpiRsConvertDma
[];
374 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndDpf
[];
375 extern ACPI_RSCONVERT_INFO AcpiRsConvertIo
[];
376 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedIo
[];
377 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndTag
[];
378 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory24
[];
379 extern ACPI_RSCONVERT_INFO AcpiRsConvertGenericReg
[];
380 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory32
[];
381 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedMemory32
[];
382 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress32
[];
383 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress16
[];
384 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtIrq
[];
385 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress64
[];
386 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtAddress64
[];
387 extern ACPI_RSCONVERT_INFO AcpiRsConvertGpio
[];
388 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedDma
[];
389 extern ACPI_RSCONVERT_INFO AcpiRsConvertI2cSerialBus
[];
390 extern ACPI_RSCONVERT_INFO AcpiRsConvertSpiSerialBus
[];
391 extern ACPI_RSCONVERT_INFO AcpiRsConvertUartSerialBus
[];
392 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinFunction
[];
393 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinConfig
[];
394 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinGroup
[];
395 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinGroupFunction
[];
396 extern ACPI_RSCONVERT_INFO AcpiRsConvertPinGroupConfig
[];
398 /* These resources require separate get/set tables */
400 extern ACPI_RSCONVERT_INFO AcpiRsGetIrq
[];
401 extern ACPI_RSCONVERT_INFO AcpiRsGetStartDpf
[];
402 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorSmall
[];
403 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorLarge
[];
405 extern ACPI_RSCONVERT_INFO AcpiRsSetIrq
[];
406 extern ACPI_RSCONVERT_INFO AcpiRsSetStartDpf
[];
407 extern ACPI_RSCONVERT_INFO AcpiRsSetVendor
[];
410 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
414 extern ACPI_RSDUMP_INFO
*AcpiGbl_DumpResourceDispatch
[];
415 extern ACPI_RSDUMP_INFO
*AcpiGbl_DumpSerialBusDispatch
[];
420 extern ACPI_RSDUMP_INFO AcpiRsDumpIrq
[];
421 extern ACPI_RSDUMP_INFO AcpiRsDumpPrt
[];
422 extern ACPI_RSDUMP_INFO AcpiRsDumpDma
[];
423 extern ACPI_RSDUMP_INFO AcpiRsDumpStartDpf
[];
424 extern ACPI_RSDUMP_INFO AcpiRsDumpEndDpf
[];
425 extern ACPI_RSDUMP_INFO AcpiRsDumpIo
[];
426 extern ACPI_RSDUMP_INFO AcpiRsDumpIoFlags
[];
427 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedIo
[];
428 extern ACPI_RSDUMP_INFO AcpiRsDumpVendor
[];
429 extern ACPI_RSDUMP_INFO AcpiRsDumpEndTag
[];
430 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory24
[];
431 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory32
[];
432 extern ACPI_RSDUMP_INFO AcpiRsDumpMemoryFlags
[];
433 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedMemory32
[];
434 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress16
[];
435 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress32
[];
436 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress64
[];
437 extern ACPI_RSDUMP_INFO AcpiRsDumpExtAddress64
[];
438 extern ACPI_RSDUMP_INFO AcpiRsDumpExtIrq
[];
439 extern ACPI_RSDUMP_INFO AcpiRsDumpGenericReg
[];
440 extern ACPI_RSDUMP_INFO AcpiRsDumpGpio
[];
441 extern ACPI_RSDUMP_INFO AcpiRsDumpPinFunction
[];
442 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedDma
[];
443 extern ACPI_RSDUMP_INFO AcpiRsDumpCommonSerialBus
[];
444 extern ACPI_RSDUMP_INFO AcpiRsDumpI2cSerialBus
[];
445 extern ACPI_RSDUMP_INFO AcpiRsDumpSpiSerialBus
[];
446 extern ACPI_RSDUMP_INFO AcpiRsDumpUartSerialBus
[];
447 extern ACPI_RSDUMP_INFO AcpiRsDumpGeneralFlags
[];
448 extern ACPI_RSDUMP_INFO AcpiRsDumpPinConfig
[];
449 extern ACPI_RSDUMP_INFO AcpiRsDumpPinGroup
[];
450 extern ACPI_RSDUMP_INFO AcpiRsDumpPinGroupFunction
[];
451 extern ACPI_RSDUMP_INFO AcpiRsDumpPinGroupConfig
[];
454 #endif /* __ACRESRC_H__ */