1/******************************************************************************
2 *
3 * Name: acresrc.h - Resource Manager function prototypes
4 *
5 *****************************************************************************/
6
7/******************************************************************************
8 *
9 * 1. Copyright Notice
10 *
11 * Some or all of this work - Copyright (c) 1999 - 2012, 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
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
28 *
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;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
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.
54 *
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
65 * make.
66 *
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
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
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.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
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
89 * PARTICULAR PURPOSE.
90 *
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
98 * LIMITED REMEDY.
99 *
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.
114 *
115 *****************************************************************************/
116
117#ifndef __ACRESRC_H__
118#define __ACRESRC_H__
119
120/* Need the AML resource descriptor structs */
121
122#include "amlresrc.h"
123
124
125/*
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:
129 *
130 * 1) Hardware does not support misaligned memory transfers
131 * 2) Compiler does not support pointers within packed structures
132 */
133#if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED))
134#pragma pack(1)
135#endif
136
137/*
138 * Individual entry for the resource conversion tables
139 */
140typedef const struct acpi_rsconvert_info
141{
142    UINT8                   Opcode;
143    UINT8                   ResourceOffset;
144    UINT8                   AmlOffset;
145    UINT8                   Value;
146
147} ACPI_RSCONVERT_INFO;
148
149/* Resource conversion opcodes */
150
151typedef enum
152{
153    ACPI_RSC_INITGET        = 0,
154    ACPI_RSC_INITSET,
155    ACPI_RSC_FLAGINIT,
156    ACPI_RSC_1BITFLAG,
157    ACPI_RSC_2BITFLAG,
158    ACPI_RSC_3BITFLAG,
159    ACPI_RSC_ADDRESS,
160    ACPI_RSC_BITMASK,
161    ACPI_RSC_BITMASK16,
162    ACPI_RSC_COUNT,
163    ACPI_RSC_COUNT16,
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,
169    ACPI_RSC_DATA8,
170    ACPI_RSC_EXIT_EQ,
171    ACPI_RSC_EXIT_LE,
172    ACPI_RSC_EXIT_NE,
173    ACPI_RSC_LENGTH,
174    ACPI_RSC_MOVE_GPIO_PIN,
175    ACPI_RSC_MOVE_GPIO_RES,
176    ACPI_RSC_MOVE_SERIAL_RES,
177    ACPI_RSC_MOVE_SERIAL_VEN,
178    ACPI_RSC_MOVE8,
179    ACPI_RSC_MOVE16,
180    ACPI_RSC_MOVE32,
181    ACPI_RSC_MOVE64,
182    ACPI_RSC_SET8,
183    ACPI_RSC_SOURCE,
184    ACPI_RSC_SOURCEX
185
186} ACPI_RSCONVERT_OPCODES;
187
188/* Resource Conversion sub-opcodes */
189
190#define ACPI_RSC_COMPARE_AML_LENGTH     0
191#define ACPI_RSC_COMPARE_VALUE          1
192
193#define ACPI_RSC_TABLE_SIZE(d)          (sizeof (d) / sizeof (ACPI_RSCONVERT_INFO))
194
195#define ACPI_RS_OFFSET(f)               (UINT8) ACPI_OFFSET (ACPI_RESOURCE,f)
196#define AML_OFFSET(f)                   (UINT8) ACPI_OFFSET (AML_RESOURCE,f)
197
198
199/*
200 * Individual entry for the resource dump tables
201 */
202typedef const struct acpi_rsdump_info
203{
204    UINT8                   Opcode;
205    UINT8                   Offset;
206    char                    *Name;
207    const char              **Pointer;
208
209} ACPI_RSDUMP_INFO;
210
211/* Values for the Opcode field above */
212
213typedef enum
214{
215    ACPI_RSD_TITLE          = 0,
216    ACPI_RSD_1BITFLAG,
217    ACPI_RSD_2BITFLAG,
218    ACPI_RSD_3BITFLAG,
219    ACPI_RSD_ADDRESS,
220    ACPI_RSD_DWORDLIST,
221    ACPI_RSD_LITERAL,
222    ACPI_RSD_LONGLIST,
223    ACPI_RSD_SHORTLIST,
224    ACPI_RSD_SHORTLISTX,
225    ACPI_RSD_SOURCE,
226    ACPI_RSD_STRING,
227    ACPI_RSD_UINT8,
228    ACPI_RSD_UINT16,
229    ACPI_RSD_UINT32,
230    ACPI_RSD_UINT64,
231    ACPI_RSD_WORDLIST
232
233} ACPI_RSDUMP_OPCODES;
234
235/* restore default alignment */
236
237#pragma pack()
238
239
240/* Resource tables indexed by internal resource type */
241
242extern const UINT8              AcpiGbl_AmlResourceSizes[];
243extern const UINT8              AcpiGbl_AmlResourceSerialBusSizes[];
244extern ACPI_RSCONVERT_INFO      *AcpiGbl_SetResourceDispatch[];
245
246/* Resource tables indexed by raw AML resource descriptor type */
247
248extern const UINT8              AcpiGbl_ResourceStructSizes[];
249extern const UINT8              AcpiGbl_ResourceStructSerialBusSizes[];
250extern ACPI_RSCONVERT_INFO      *AcpiGbl_GetResourceDispatch[];
251
252extern ACPI_RSCONVERT_INFO      *AcpiGbl_ConvertResourceSerialBusDispatch[];
253
254typedef struct acpi_vendor_walk_info
255{
256    ACPI_VENDOR_UUID        *Uuid;
257    ACPI_BUFFER             *Buffer;
258    ACPI_STATUS             Status;
259
260} ACPI_VENDOR_WALK_INFO;
261
262
263/*
264 * rscreate
265 */
266ACPI_STATUS
267AcpiRsCreateResourceList (
268    ACPI_OPERAND_OBJECT     *AmlBuffer,
269    ACPI_BUFFER             *OutputBuffer);
270
271ACPI_STATUS
272AcpiRsCreateAmlResources (
273    ACPI_RESOURCE           *LinkedListBuffer,
274    ACPI_BUFFER             *OutputBuffer);
275
276ACPI_STATUS
277AcpiRsCreatePciRoutingTable (
278    ACPI_OPERAND_OBJECT     *PackageObject,
279    ACPI_BUFFER             *OutputBuffer);
280
281
282/*
283 * rsutils
284 */
285ACPI_STATUS
286AcpiRsGetPrtMethodData (
287    ACPI_NAMESPACE_NODE     *Node,
288    ACPI_BUFFER             *RetBuffer);
289
290ACPI_STATUS
291AcpiRsGetCrsMethodData (
292    ACPI_NAMESPACE_NODE     *Node,
293    ACPI_BUFFER             *RetBuffer);
294
295ACPI_STATUS
296AcpiRsGetPrsMethodData (
297    ACPI_NAMESPACE_NODE     *Node,
298    ACPI_BUFFER             *RetBuffer);
299
300ACPI_STATUS
301AcpiRsGetMethodData (
302    ACPI_HANDLE             Handle,
303    char                    *Path,
304    ACPI_BUFFER             *RetBuffer);
305
306ACPI_STATUS
307AcpiRsSetSrsMethodData (
308    ACPI_NAMESPACE_NODE     *Node,
309    ACPI_BUFFER             *RetBuffer);
310
311ACPI_STATUS
312AcpiRsGetAeiMethodData (
313    ACPI_NAMESPACE_NODE     *Node,
314    ACPI_BUFFER             *RetBuffer);
315
316/*
317 * rscalc
318 */
319ACPI_STATUS
320AcpiRsGetListLength (
321    UINT8                   *AmlBuffer,
322    UINT32                  AmlBufferLength,
323    ACPI_SIZE               *SizeNeeded);
324
325ACPI_STATUS
326AcpiRsGetAmlLength (
327    ACPI_RESOURCE           *LinkedListBuffer,
328    ACPI_SIZE               *SizeNeeded);
329
330ACPI_STATUS
331AcpiRsGetPciRoutingTableLength (
332    ACPI_OPERAND_OBJECT     *PackageObject,
333    ACPI_SIZE               *BufferSizeNeeded);
334
335ACPI_STATUS
336AcpiRsConvertAmlToResources (
337    UINT8                   *Aml,
338    UINT32                  Length,
339    UINT32                  Offset,
340    UINT8                   ResourceIndex,
341    void                    *Context);
342
343ACPI_STATUS
344AcpiRsConvertResourcesToAml (
345    ACPI_RESOURCE           *Resource,
346    ACPI_SIZE               AmlSizeNeeded,
347    UINT8                   *OutputBuffer);
348
349
350/*
351 * rsaddr
352 */
353void
354AcpiRsSetAddressCommon (
355    AML_RESOURCE            *Aml,
356    ACPI_RESOURCE           *Resource);
357
358BOOLEAN
359AcpiRsGetAddressCommon (
360    ACPI_RESOURCE           *Resource,
361    AML_RESOURCE            *Aml);
362
363
364/*
365 * rsmisc
366 */
367ACPI_STATUS
368AcpiRsConvertAmlToResource (
369    ACPI_RESOURCE           *Resource,
370    AML_RESOURCE            *Aml,
371    ACPI_RSCONVERT_INFO     *Info);
372
373ACPI_STATUS
374AcpiRsConvertResourceToAml (
375    ACPI_RESOURCE           *Resource,
376    AML_RESOURCE            *Aml,
377    ACPI_RSCONVERT_INFO     *Info);
378
379
380/*
381 * rsutils
382 */
383void
384AcpiRsMoveData (
385    void                    *Destination,
386    void                    *Source,
387    UINT16                  ItemCount,
388    UINT8                   MoveType);
389
390UINT8
391AcpiRsDecodeBitmask (
392    UINT16                  Mask,
393    UINT8                   *List);
394
395UINT16
396AcpiRsEncodeBitmask (
397    UINT8                   *List,
398    UINT8                   Count);
399
400ACPI_RS_LENGTH
401AcpiRsGetResourceSource (
402    ACPI_RS_LENGTH          ResourceLength,
403    ACPI_RS_LENGTH          MinimumLength,
404    ACPI_RESOURCE_SOURCE    *ResourceSource,
405    AML_RESOURCE            *Aml,
406    char                    *StringPtr);
407
408ACPI_RSDESC_SIZE
409AcpiRsSetResourceSource (
410    AML_RESOURCE            *Aml,
411    ACPI_RS_LENGTH          MinimumLength,
412    ACPI_RESOURCE_SOURCE    *ResourceSource);
413
414void
415AcpiRsSetResourceHeader (
416    UINT8                   DescriptorType,
417    ACPI_RSDESC_SIZE        TotalLength,
418    AML_RESOURCE            *Aml);
419
420void
421AcpiRsSetResourceLength (
422    ACPI_RSDESC_SIZE        TotalLength,
423    AML_RESOURCE            *Aml);
424
425
426/*
427 * rsdump
428 */
429void
430AcpiRsDumpResourceList (
431    ACPI_RESOURCE           *Resource);
432
433void
434AcpiRsDumpIrqList (
435    UINT8                   *RouteTable);
436
437
438/*
439 * Resource conversion tables
440 */
441extern ACPI_RSCONVERT_INFO      AcpiRsConvertDma[];
442extern ACPI_RSCONVERT_INFO      AcpiRsConvertEndDpf[];
443extern ACPI_RSCONVERT_INFO      AcpiRsConvertIo[];
444extern ACPI_RSCONVERT_INFO      AcpiRsConvertFixedIo[];
445extern ACPI_RSCONVERT_INFO      AcpiRsConvertEndTag[];
446extern ACPI_RSCONVERT_INFO      AcpiRsConvertMemory24[];
447extern ACPI_RSCONVERT_INFO      AcpiRsConvertGenericReg[];
448extern ACPI_RSCONVERT_INFO      AcpiRsConvertMemory32[];
449extern ACPI_RSCONVERT_INFO      AcpiRsConvertFixedMemory32[];
450extern ACPI_RSCONVERT_INFO      AcpiRsConvertAddress32[];
451extern ACPI_RSCONVERT_INFO      AcpiRsConvertAddress16[];
452extern ACPI_RSCONVERT_INFO      AcpiRsConvertExtIrq[];
453extern ACPI_RSCONVERT_INFO      AcpiRsConvertAddress64[];
454extern ACPI_RSCONVERT_INFO      AcpiRsConvertExtAddress64[];
455extern ACPI_RSCONVERT_INFO      AcpiRsConvertGpio[];
456extern ACPI_RSCONVERT_INFO      AcpiRsConvertFixedDma[];
457extern ACPI_RSCONVERT_INFO      AcpiRsConvertI2cSerialBus[];
458extern ACPI_RSCONVERT_INFO      AcpiRsConvertSpiSerialBus[];
459extern ACPI_RSCONVERT_INFO      AcpiRsConvertUartSerialBus[];
460
461/* These resources require separate get/set tables */
462
463extern ACPI_RSCONVERT_INFO      AcpiRsGetIrq[];
464extern ACPI_RSCONVERT_INFO      AcpiRsGetStartDpf[];
465extern ACPI_RSCONVERT_INFO      AcpiRsGetVendorSmall[];
466extern ACPI_RSCONVERT_INFO      AcpiRsGetVendorLarge[];
467
468extern ACPI_RSCONVERT_INFO      AcpiRsSetIrq[];
469extern ACPI_RSCONVERT_INFO      AcpiRsSetStartDpf[];
470extern ACPI_RSCONVERT_INFO      AcpiRsSetVendor[];
471
472
473#if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER)
474/*
475 * rsinfo
476 */
477extern ACPI_RSDUMP_INFO         *AcpiGbl_DumpResourceDispatch[];
478extern ACPI_RSDUMP_INFO         *AcpiGbl_DumpSerialBusDispatch[];
479
480/*
481 * rsdump
482 */
483extern ACPI_RSDUMP_INFO         AcpiRsDumpIrq[];
484extern ACPI_RSDUMP_INFO         AcpiRsDumpDma[];
485extern ACPI_RSDUMP_INFO         AcpiRsDumpStartDpf[];
486extern ACPI_RSDUMP_INFO         AcpiRsDumpEndDpf[];
487extern ACPI_RSDUMP_INFO         AcpiRsDumpIo[];
488extern ACPI_RSDUMP_INFO         AcpiRsDumpFixedIo[];
489extern ACPI_RSDUMP_INFO         AcpiRsDumpVendor[];
490extern ACPI_RSDUMP_INFO         AcpiRsDumpEndTag[];
491extern ACPI_RSDUMP_INFO         AcpiRsDumpMemory24[];
492extern ACPI_RSDUMP_INFO         AcpiRsDumpMemory32[];
493extern ACPI_RSDUMP_INFO         AcpiRsDumpFixedMemory32[];
494extern ACPI_RSDUMP_INFO         AcpiRsDumpAddress16[];
495extern ACPI_RSDUMP_INFO         AcpiRsDumpAddress32[];
496extern ACPI_RSDUMP_INFO         AcpiRsDumpAddress64[];
497extern ACPI_RSDUMP_INFO         AcpiRsDumpExtAddress64[];
498extern ACPI_RSDUMP_INFO         AcpiRsDumpExtIrq[];
499extern ACPI_RSDUMP_INFO         AcpiRsDumpGenericReg[];
500extern ACPI_RSDUMP_INFO         AcpiRsDumpGpio[];
501extern ACPI_RSDUMP_INFO         AcpiRsDumpFixedDma[];
502extern ACPI_RSDUMP_INFO         AcpiRsDumpCommonSerialBus[];
503extern ACPI_RSDUMP_INFO         AcpiRsDumpI2cSerialBus[];
504extern ACPI_RSDUMP_INFO         AcpiRsDumpSpiSerialBus[];
505extern ACPI_RSDUMP_INFO         AcpiRsDumpUartSerialBus[];
506#endif
507
508#endif  /* __ACRESRC_H__ */
509