]> git.proxmox.com Git - mirror_edk2.git/blame - QuarkPlatformPkg/Acpi/Dxe/AcpiPlatform/AcpiPciUpdate.h
QuarkPlatformPkg: Replace BSD License with BSD+Patent License
[mirror_edk2.git] / QuarkPlatformPkg / Acpi / Dxe / AcpiPlatform / AcpiPciUpdate.h
CommitLineData
b303605e
MK
1/** @file\r
2Update the _PRT and _PRW method for pci devices\r
3\r
4Copyright (c) 2013-2015 Intel Corporation.\r
5\r
0eb3de2e 6SPDX-License-Identifier: BSD-2-Clause-Patent\r
b303605e
MK
7\r
8\r
9**/\r
10#ifndef _ACPI_PCI_UPDATE_H_\r
11#define _ACPI_PCI_UPDATE_H_\r
12\r
13\r
14//\r
15// Primary OpCode\r
16//\r
17#define AML_ZERO_OP 0x00\r
18#define AML_ONE_OP 0x01\r
19#define AML_ALIAS_OP 0x06\r
20#define AML_NAME_OP 0x08\r
21#define AML_BYTE_PREFIX 0x0a\r
22#define AML_WORD_PREFIX 0x0b\r
23#define AML_DWORD_PREFIX 0x0c\r
24#define AML_STRING_PREFIX 0x0d\r
25#define AML_QWORD_PREFIX 0x0e\r
26#define AML_SCOPE_OP 0x10\r
27#define AML_BUFFER_OP 0x11\r
28#define AML_PACKAGE_OP 0x12\r
29#define AML_VAR_PACKAGE_OP 0x13\r
30#define AML_METHOD_OP 0x14\r
31#define AML_DUAL_NAME_PREFIX 0x2e\r
32#define AML_MULTI_NAME_PREFIX 0x2f\r
33#define AML_NAME_CHAR_A 0x41\r
34#define AML_NAME_CHAR_B 0x42\r
35#define AML_NAME_CHAR_C 0x43\r
36#define AML_NAME_CHAR_D 0x44\r
37#define AML_NAME_CHAR_E 0x45\r
38#define AML_NAME_CHAR_F 0x46\r
39#define AML_NAME_CHAR_G 0x47\r
40#define AML_NAME_CHAR_H 0x48\r
41#define AML_NAME_CHAR_I 0x49\r
42#define AML_NAME_CHAR_J 0x4a\r
43#define AML_NAME_CHAR_K 0x4b\r
44#define AML_NAME_CHAR_L 0x4c\r
45#define AML_NAME_CHAR_M 0x4d\r
46#define AML_NAME_CHAR_N 0x4e\r
47#define AML_NAME_CHAR_O 0x4f\r
48#define AML_NAME_CHAR_P 0x50\r
49#define AML_NAME_CHAR_Q 0x51\r
50#define AML_NAME_CHAR_R 0x52\r
51#define AML_NAME_CHAR_S 0x53\r
52#define AML_NAME_CHAR_T 0x54\r
53#define AML_NAME_CHAR_U 0x55\r
54#define AML_NAME_CHAR_V 0x56\r
55#define AML_NAME_CHAR_W 0x57\r
56#define AML_NAME_CHAR_X 0x58\r
57#define AML_NAME_CHAR_Y 0x59\r
58#define AML_NAME_CHAR_Z 0x5a\r
59#define AML_ROOT_CHAR 0x5c\r
60#define AML_PARENT_PREFIX_CHAR 0x5e\r
61#define AML_NAME_CHAR__ 0x5f\r
62#define AML_LOCAL0 0x60\r
63#define AML_LOCAL1 0x61\r
64#define AML_LOCAL2 0x62\r
65#define AML_LOCAL3 0x63\r
66#define AML_LOCAL4 0x64\r
67#define AML_LOCAL5 0x65\r
68#define AML_LOCAL6 0x66\r
69#define AML_LOCAL7 0x67\r
70#define AML_ARG0 0x68\r
71#define AML_ARG1 0x69\r
72#define AML_ARG2 0x6a\r
73#define AML_ARG3 0x6b\r
74#define AML_ARG4 0x6c\r
75#define AML_ARG5 0x6d\r
76#define AML_ARG6 0x6e\r
77#define AML_STORE_OP 0x70\r
78#define AML_REF_OF_OP 0x71\r
79#define AML_ADD_OP 0x72\r
80#define AML_CONCAT_OP 0x73\r
81#define AML_SUBTRACT_OP 0x74\r
82#define AML_INCREMENT_OP 0x75\r
83#define AML_DECREMENT_OP 0x76\r
84#define AML_MULTIPLY_OP 0x77\r
85#define AML_DIVIDE_OP 0x78\r
86#define AML_SHIFT_LEFT_OP 0x79\r
87#define AML_SHIFT_RIGHT_OP 0x7a\r
88#define AML_AND_OP 0x7b\r
89#define AML_NAND_OP 0x7c\r
90#define AML_OR_OP 0x7d\r
91#define AML_NOR_OP 0x7e\r
92#define AML_XOR_OP 0x7f\r
93#define AML_NOT_OP 0x80\r
94#define AML_FIND_SET_LEFT_BIT_OP 0x81\r
95#define AML_FIND_SET_RIGHT_BIT_OP 0x82\r
96#define AML_DEREF_OF_OP 0x83\r
97#define AML_CONCAT_RES_OP 0x84\r
98#define AML_MOD_OP 0x85\r
99#define AML_NOTIFY_OP 0x86\r
100#define AML_SIZE_OF_OP 0x87\r
101#define AML_INDEX_OP 0x88\r
102#define AML_MATCH_OP 0x89\r
103#define AML_CREATE_DWORD_FIELD_OP 0x8a\r
104#define AML_CREATE_WORD_FIELD_OP 0x8b\r
105#define AML_CREATE_BYTE_FIELD_OP 0x8c\r
106#define AML_CREATE_BIT_FIELD_OP 0x8d\r
107#define AML_OBJECT_TYPE_OP 0x8e\r
108#define AML_CREATE_QWORD_FIELD_OP 0x8f\r
109#define AML_LAND_OP 0x90\r
110#define AML_LOR_OP 0x91\r
111#define AML_LNOT_OP 0x92\r
112#define AML_LEQUAL_OP 0x93\r
113#define AML_LGREATER_OP 0x94\r
114#define AML_LLESS_OP 0x95\r
115#define AML_TO_BUFFER_OP 0x96\r
116#define AML_TO_DEC_STRING_OP 0x97\r
117#define AML_TO_HEX_STRING_OP 0x98\r
118#define AML_TO_INTEGER_OP 0x99\r
119#define AML_TO_STRING_OP 0x9c\r
120#define AML_COPY_OBJECT_OP 0x9d\r
121#define AML_MID_OP 0x9e\r
122#define AML_CONTINUE_OP 0x9f\r
123#define AML_IF_OP 0xa0\r
124#define AML_ELSE_OP 0xa1\r
125#define AML_WHILE_OP 0xa2\r
126#define AML_NOOP_OP 0xa3\r
127#define AML_RETURN_OP 0xa4\r
128#define AML_BREAK_OP 0xa5\r
129#define AML_BREAK_POINT_OP 0xcc\r
130#define AML_ONES_OP 0xff\r
131\r
132//\r
133// Extended OpCode\r
134//\r
135#define AML_EXT_OP 0x5b\r
136\r
137#define AML_EXT_MUTEX_OP 0x01\r
138#define AML_EXT_EVENT_OP 0x02\r
139#define AML_EXT_COND_REF_OF_OP 0x12\r
140#define AML_EXT_CREATE_FIELD_OP 0x13\r
141#define AML_EXT_LOAD_TABLE_OP 0x1f\r
142#define AML_EXT_LOAD_OP 0x20\r
143#define AML_EXT_STALL_OP 0x21\r
144#define AML_EXT_SLEEP_OP 0x22\r
145#define AML_EXT_ACQUIRE_OP 0x23\r
146#define AML_EXT_SIGNAL_OP 0x24\r
147#define AML_EXT_WAIT_OP 0x25\r
148#define AML_EXT_RESET_OP 0x26\r
149#define AML_EXT_RELEASE_OP 0x27\r
150#define AML_EXT_FROM_BCD_OP 0x28\r
151#define AML_EXT_TO_BCD_OP 0x29\r
152#define AML_EXT_UNLOAD_OP 0x2a\r
153#define AML_EXT_REVISION_OP 0x30\r
154#define AML_EXT_DEBUG_OP 0x31\r
155#define AML_EXT_FATAL_OP 0x32\r
156#define AML_EXT_TIMER_OP 0x33\r
157#define AML_EXT_REGION_OP 0x80\r
158#define AML_EXT_FIELD_OP 0x81\r
159#define AML_EXT_DEVICE_OP 0x82\r
160#define AML_EXT_PROCESSOR_OP 0x83\r
161#define AML_EXT_POWER_RES_OP 0x84\r
162#define AML_EXT_THERMAL_ZONE_OP 0x85\r
163#define AML_EXT_INDEX_FIELD_OP 0x86\r
164#define AML_EXT_BANK_FIELD_OP 0x87\r
165#define AML_EXT_DATA_REGION_OP 0x88\r
166\r
167#pragma pack(1)\r
168\r
169typedef struct {\r
170 UINT32 BridgeAddress;\r
171 UINT32 DeviceAddress;\r
172 UINT8 INTA[2]; // the first member record the 8259 link, the second member record the io apic irq number\r
173 UINT8 INTB[2];\r
174 UINT8 INTC[2];\r
175 UINT8 INTD[2];\r
176\r
177 UINT8 GPEPin;\r
178 UINT8 SxNum;\r
179} PCI_DEVICE_INFO;\r
180\r
181#pragma pack()\r
182\r
183#define PCI_DEVICE_INFO_MAX_NUM 50\r
184#define CURRENT_PCI_DEVICE_NUM 13\r
185\r
186#define PIRQ_LINKA 1\r
187#define PIRQ_LINKB 2\r
188#define PIRQ_LINKC 3\r
189#define PIRQ_LINKD 4\r
190#define PIRQ_LINKE 5\r
191#define PIRQ_LINKF 6\r
192#define PIRQ_LINKG 7\r
193#define PIRQ_LINKH 8\r
194#define PIRQ_INVALID 0xFF\r
195\r
196typedef struct _PCI_DEVICE_SETTING{\r
197 UINT8 PciDeviceInfoNumber;\r
198 PCI_DEVICE_INFO PciDeviceInfo[PCI_DEVICE_INFO_MAX_NUM];\r
199}PCI_DEVICE_SETTING;\r
200\r
201typedef struct _AML_BYTE_ENCODING AML_BYTE_ENCODING;\r
202\r
203//\r
204// AML Handle Entry definition.\r
205//\r
206// Signature must be set to EFI_AML_HANDLE_SIGNATURE or EFI_AML_ROOT_HANDLE_SIGNATURE\r
207// Buffer is the ACPI node buffer pointer, the first/second bytes are opcode.\r
208// This buffer should not be freed.\r
209// Size is the total size of this ACPI node buffer.\r
210//\r
211typedef struct {\r
212 UINT32 Signature;\r
213 UINT8 *Buffer;\r
214 UINTN Size;\r
215 AML_BYTE_ENCODING *AmlByteEncoding;\r
216 BOOLEAN Modified;\r
217} EFI_AML_HANDLE;\r
218\r
219typedef UINT32 AML_OP_PARSE_INDEX;\r
220\r
221typedef UINT32 AML_OP_PARSE_FORMAT;\r
222\r
223typedef UINT32 AML_OP_ATTRIBUTE;\r
224\r
225struct _AML_BYTE_ENCODING {\r
226 UINT8 OpCode;\r
227 UINT8 SubOpCode;\r
228 AML_OP_PARSE_INDEX MaxIndex;\r
229 AML_OP_PARSE_FORMAT Format[6];\r
230 AML_OP_ATTRIBUTE Attribute;\r
231};\r
232\r
233\r
234//\r
235// Check device info fucntion prototype\r
236//\r
237typedef\r
238BOOLEAN\r
239(* CHECK_HANDLE_INFO) (\r
240 IN EFI_ACPI_SDT_PROTOCOL *AcpiSdt,\r
241 IN EFI_ACPI_HANDLE CheckHandle,\r
242 IN VOID *Context\r
243 );\r
244\r
245extern EFI_ACPI_HANDLE mDsdtHandle;\r
246extern EFI_ACPI_SDT_PROTOCOL *mAcpiSdt;\r
247\r
248/**\r
249 Init Pci Device Structure\r
250\r
251 @param mConfigData - Pointer of Pci Device information Structure\r
252\r
253**/\r
254VOID\r
255InitPciDeviceInfoStructure (\r
256 PCI_DEVICE_SETTING *mConfigData\r
257 );\r
258/**\r
259 update pci routing information in acpi table based on pcd settings\r
260\r
261 @param AcpiSdt Pointer to Acpi SDT protocol\r
262 @param DsdtHandle ACPI root handle\r
263 @param PciDeviceInfo Pointer to PCI_DEVICE_INFO\r
264\r
265**/\r
266EFI_STATUS\r
267SdtUpdatePciRouting (\r
268 IN EFI_ACPI_SDT_PROTOCOL *AcpiSdt,\r
269 IN EFI_ACPI_HANDLE DsdtHandle,\r
270 IN PCI_DEVICE_INFO *PciDeviceInfo\r
271 );\r
272\r
273\r
274/**\r
275 update power resource wake up information in acpi table based on pcd settings\r
276\r
277 @param AcpiSdt Pointer to Acpi SDT protocol\r
278 @param DsdtHandle ACPI root handle\r
279 @param PciDeviceInfo Pointer to PCI_DEVICE_INFO\r
280\r
281**/\r
282EFI_STATUS\r
283SdtUpdatePowerWake (\r
284 IN EFI_ACPI_SDT_PROTOCOL *AcpiSdt,\r
285 IN EFI_ACPI_HANDLE DsdtHandle,\r
286 IN PCI_DEVICE_INFO *PciDeviceInfo\r
287 );\r
288\r
289/**\r
290 Get the root bridge handle by scanning the acpi table\r
291\r
292 @param AcpiSdt Pointer to Acpi SDT protocol\r
293 @param DsdtHandle ACPI root handle\r
294\r
295 @retval EFI_ACPI_HANDLE the handle of the root bridge\r
296**/\r
297EFI_ACPI_HANDLE\r
298SdtGetRootBridgeHandle (\r
299 IN EFI_ACPI_SDT_PROTOCOL *AcpiSdt,\r
300 IN EFI_ACPI_HANDLE DsdtHandle\r
301 );\r
302\r
303/**\r
304 Check input Pci device info is changed from the default values\r
305 @param PciDeviceInfo Pointer to PCI_DEVICE_INFO\r
306 @param UpdatePRT Pointer to BOOLEAN\r
307 @param UpdatePRW Pointer to BOOLEAN\r
308\r
309**/\r
310VOID\r
311SdtCheckPciDeviceInfoChanged (\r
312 IN PCI_DEVICE_INFO *PciDeviceInfo,\r
313 IN BOOLEAN *UpdatePRT,\r
314 IN BOOLEAN *UpdatePRW\r
315 );\r
316#endif\r