79964ac8 |
1 | /** @file\r |
2 | This file declares PlatfromOpRom protocols.\r |
3 | \r |
4 | Copyright (c) 2007, Intel Corporation\r |
5 | All rights reserved. This program and the accompanying materials\r |
6 | are licensed and made available under the terms and conditions of the BSD License\r |
7 | which accompanies this distribution. The full text of the license may be found at\r |
8 | http://opensource.org/licenses/bsd-license.php\r |
9 | \r |
10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r |
11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r |
12 | \r |
13 | Module Name: PciPlatform.h\r |
14 | \r |
15 | @par Revision Reference:\r |
16 | This protocol is defined in PCI Platform Support Specification\r |
17 | Version 0.9\r |
18 | \r |
19 | **/\r |
20 | \r |
21 | #ifndef _PCI_PLATFORM_H_\r |
22 | #define _PCI_PLATFORM_H_\r |
23 | \r |
b80fbe85 |
24 | #include <PiDxe.h>\r |
25 | #include <Protocol/PciHostBridgeResourceAllocation.h>\r |
26 | \r |
79964ac8 |
27 | //\r |
28 | // Protocol for GUID.\r |
29 | //\r |
30 | \r |
31 | #define EFI_PCI_PLATFORM_PROTOCOL_GUID \\r |
32 | { 0x7d75280, 0x27d4, 0x4d69, {0x90, 0xd0, 0x56, 0x43, 0xe2, 0x38, 0xb3, 0x41} }\r |
33 | \r |
34 | typedef struct _EFI_PCI_PLATFORM_PROTOCOL EFI_PCI_PLATFORM_PROTOCOL;\r |
35 | \r |
36 | typedef UINT32 EFI_PCI_PLATFORM_POLICY;\r |
37 | \r |
38 | \r |
39 | #define EFI_RESERVE_NONE_IO_ALIAS 0x0000\r |
40 | #define EFI_RESERVE_ISA_IO_ALIAS 0x0001\r |
41 | #define EFI_RESERVE_ISA_IO_NO_ALIAS 0x0002\r |
42 | #define EFI_RESERVE_VGA_IO_ALIAS 0x0004\r |
43 | #define EFI_RESERVE_VGA_IO_NO_ALIAS 0x0008\r |
44 | \r |
45 | \r |
46 | typedef enum {\r |
47 | ChipsetEntry,\r |
48 | ChipsetExit,\r |
49 | MaximumChipsetPhase\r |
50 | } EFI_PCI_CHIPSET_EXECUTION_PHASE;\r |
51 | \r |
52 | \r |
53 | /**\r |
54 | The PlatformNotify() function can be used to notify the platform driver so that\r |
55 | it can perform platform-specific actions. No specific actions are required.\r |
56 | Eight notification points are defined at this time. More synchronization points\r |
57 | may be added as required in the future. The PCI bus driver calls the platform driver\r |
58 | twice for every Phase-once before the PCI Host Bridge Resource Allocation Protocol\r |
59 | driver is notified, and once after the PCI Host Bridge Resource Allocation Protocol\r |
60 | driver has been notified.\r |
61 | This member function may not perform any error checking on the input parameters. It\r |
62 | also does not return any error codes. If this member function detects any error condition,\r |
63 | it needs to handle those errors on its own because there is no way to surface any\r |
64 | errors to the caller.\r |
65 | \r |
66 | @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r |
67 | @param HostBridge The handle of the host bridge controller.\r |
68 | @param Phase The phase of the PCI bus enumeration.\r |
69 | @param ChipsetPhase Defines the execution phase of the PCI chipset driver.\r |
70 | \r |
71 | @retval EFI_SUCCESS The function completed successfully.\r |
72 | \r |
73 | **/\r |
74 | typedef\r |
75 | EFI_STATUS\r |
76 | (EFIAPI *EFI_PCI_PLATFORM_PHASE_NOTIFY) (\r |
77 | IN EFI_PCI_PLATFORM_PROTOCOL *This,\r |
78 | IN EFI_HANDLE HostBridge,\r |
79 | IN EFI_PCI_HOST_BRIDGE_RESOURCE_ALLOCATION_PHASE Phase,\r |
80 | IN EFI_PCI_CHIPSET_EXECUTION_PHASE ChipsetPhase\r |
81 | )\r |
82 | ;\r |
83 | \r |
84 | \r |
85 | /**\r |
86 | The PlatformPrepController() function can be used to notify the platform driver so that\r |
87 | it can perform platform-specific actions. No specific actions are required.\r |
88 | Several notification points are defined at this time. More synchronization points may be\r |
89 | added as required in the future. The PCI bus driver calls the platform driver twice for\r |
90 | every PCI controller-once before the PCI Host Bridge Resource Allocation Protocol driver\r |
91 | is notified, and once after the PCI Host Bridge Resource Allocation Protocol driver has\r |
92 | been notified.\r |
93 | This member function may not perform any error checking on the input parameters. It also\r |
94 | does not return any error codes. If this member function detects any error condition, it\r |
95 | needs to handle those errors on its own because there is no way to surface any errors to\r |
96 | the caller.\r |
97 | \r |
98 | @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r |
99 | @param HostBridge The associated PCI host bridge handle.\r |
100 | @param RootBridge The associated PCI root bridge handle.\r |
101 | @param PciAddress The address of the PCI device on the PCI bus.\r |
102 | @param Phase The phase of the PCI controller enumeration.\r |
103 | @param ChipsetPhase Defines the execution phase of the PCI chipset driver.\r |
104 | \r |
105 | @retval EFI_SUCCESS The function completed successfully.\r |
106 | \r |
107 | **/\r |
108 | typedef\r |
109 | EFI_STATUS\r |
110 | (EFIAPI *EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER) (\r |
111 | IN EFI_PCI_PLATFORM_PROTOCOL *This,\r |
112 | IN EFI_HANDLE HostBridge,\r |
113 | IN EFI_HANDLE RootBridge,\r |
114 | IN EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL_PCI_ADDRESS PciAddress,\r |
115 | IN EFI_PCI_CONTROLLER_RESOURCE_ALLOCATION_PHASE Phase,\r |
116 | IN EFI_PCI_CHIPSET_EXECUTION_PHASE ChipsetPhase\r |
117 | )\r |
118 | ;\r |
119 | \r |
120 | \r |
121 | /**\r |
122 | The GetPlatformPolicy() function retrieves the platform policy regarding PCI\r |
123 | enumeration. The PCI bus driver and the PCI Host Bridge Resource Allocation Protocol\r |
124 | driver can call this member function to retrieve the policy.\r |
125 | \r |
126 | @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r |
127 | @param PciPolicy The platform policy with respect to VGA and ISA aliasing.\r |
128 | \r |
129 | @retval EFI_SUCCESS The function completed successfully.\r |
130 | @retval EFI_INVALID_PARAMETER PciPolicy is NULL.\r |
131 | \r |
132 | **/\r |
133 | typedef\r |
134 | EFI_STATUS\r |
135 | (EFIAPI *EFI_PCI_PLATFORM_GET_PLATFORM_POLICY) (\r |
136 | IN EFI_PCI_PLATFORM_PROTOCOL *This,\r |
137 | OUT EFI_PCI_PLATFORM_POLICY *PciPolicy\r |
138 | )\r |
139 | ;\r |
140 | \r |
141 | \r |
142 | /**\r |
143 | The GetPciRom() function gets the PCI device's option ROM from a platform-specific location.\r |
144 | The option ROM will be loaded into memory. This member function is used to return an image\r |
145 | that is packaged as a PCI 2.2 option ROM. The image may contain both legacy and EFI option\r |
146 | ROMs. See the EFI 1.10 Specification for details. This member function can be used to return\r |
147 | option ROM images for embedded controllers. Option ROMs for embedded controllers are typically\r |
148 | stored in platform-specific storage, and this member function can retrieve it from that storage\r |
149 | and return it to the PCI bus driver. The PCI bus driver will call this member function before\r |
150 | scanning the ROM that is attached to any controller, which allows a platform to specify a ROM\r |
151 | image that is different from the ROM image on a PCI card.\r |
152 | \r |
153 | @param This Pointer to the EFI_PCI_PLATFORM_PROTOCOL instance.\r |
154 | @param PciHandle The handle of the PCI device.\r |
155 | @param RomImage If the call succeeds, the pointer to the pointer to the option ROM image.\r |
156 | Otherwise, this field is undefined. The memory for RomImage is allocated\r |
157 | by EFI_PCI_PLATFORM_PROTOCOL.GetPciRom() using the EFI Boot Service AllocatePool().\r |
158 | It is the caller's responsibility to free the memory using the EFI Boot Service\r |
159 | FreePool(), when the caller is done with the option ROM.\r |
160 | @param RomSize If the call succeeds, a pointer to the size of the option ROM size. Otherwise,\r |
161 | this field is undefined.\r |
162 | \r |
163 | @retval EFI_SUCCESS The option ROM was available for this device and loaded into memory.\r |
164 | @retval EFI_NOT_FOUND No option ROM was available for this device.\r |
165 | @retval EFI_OUT_OF_RESOURCES No memory was available to load the option ROM.\r |
166 | @retval EFI_DEVICE_ERROR An error occurred in getting the option ROM.\r |
167 | \r |
168 | **/\r |
169 | typedef\r |
170 | EFI_STATUS\r |
171 | (EFIAPI *EFI_PCI_PLATFORM_GET_PCI_ROM) (\r |
172 | IN EFI_PCI_PLATFORM_PROTOCOL *This,\r |
173 | IN EFI_HANDLE PciHandle,\r |
174 | OUT VOID **RomImage,\r |
175 | OUT UINTN *RomSize\r |
176 | )\r |
177 | ;\r |
178 | \r |
179 | /**\r |
180 | @par Protocol Description:\r |
181 | This protocol provides the interface between the PCI bus driver/PCI Host\r |
182 | Bridge Resource Allocation driver and a platform-specific driver to describe\r |
183 | the unique features of a platform.\r |
184 | \r |
185 | @param PlatformNotify\r |
186 | The notification from the PCI bus enumerator to the platform that it is\r |
187 | about to enter a certain phase during the enumeration process.\r |
188 | \r |
189 | @param PlatformPrepController\r |
190 | The notification from the PCI bus enumerator to the platform for each PCI\r |
191 | controller at several predefined points during PCI controller initialization.\r |
192 | \r |
193 | @param GetPlatformPolicy\r |
194 | Retrieves the platform policy regarding enumeration.\r |
195 | \r |
196 | @param GetPciRom\r |
197 | Gets the PCI device's option ROM from a platform-specific location.\r |
198 | \r |
199 | **/\r |
200 | struct _EFI_PCI_PLATFORM_PROTOCOL {\r |
201 | EFI_PCI_PLATFORM_PHASE_NOTIFY PhaseNotify;\r |
202 | EFI_PCI_PLATFORM_PREPROCESS_CONTROLLER PlatformPrepController;\r |
203 | EFI_PCI_PLATFORM_GET_PLATFORM_POLICY GetPlatformPolicy;\r |
204 | EFI_PCI_PLATFORM_GET_PCI_ROM GetPciRom;\r |
205 | };\r |
206 | \r |
207 | extern EFI_GUID gEfiPciPlatformProtocolGuid;\r |
208 | \r |
209 | #endif\r |