]>
Commit | Line | Data |
---|---|---|
18c97f53 | 1 | /** @file\r |
2 | EFI PCAT ISA ACPI Driver for a Generic PC Platform\r | |
c69dd9df | 3 | \r |
e8bce4b4 | 4 | Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>\r |
18c97f53 | 5 | This program and the accompanying materials \r |
c69dd9df | 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 | |
18c97f53 | 13 | **/\r |
c69dd9df | 14 | \r |
15 | #ifndef _PCAT_ISA_ACPI_H_\r | |
16 | #define _PCAT_ISA_ACPI_H_\r | |
17 | \r | |
18 | #include <PiDxe.h>\r | |
19 | \r | |
20 | #include <IndustryStandard/Pci.h>\r | |
21 | \r | |
22 | #include <Protocol/DevicePath.h>\r | |
23 | #include <Protocol/PciIo.h>\r | |
24 | #include <Protocol/IsaIo.h>\r | |
25 | #include <Protocol/DriverBinding.h>\r | |
26 | #include <Protocol/ComponentName.h>\r | |
27 | #include <Protocol/ComponentName2.h>\r | |
28 | \r | |
29 | \r | |
30 | #include <Library/UefiLib.h>\r | |
31 | #include <Library/UefiBootServicesTableLib.h>\r | |
e8bce4b4 RN |
32 | #include <Library/BaseMemoryLib.h>\r |
33 | #include <Library/PcdLib.h>\r | |
c69dd9df | 34 | \r |
35 | #include <Protocol/IsaAcpi.h>\r | |
36 | //\r | |
37 | // PCAT ISA ACPI device private data structure\r | |
38 | //\r | |
eea53ce1 | 39 | #define PCAT_ISA_ACPI_DEV_SIGNATURE SIGNATURE_32('L','P','C','D')\r |
c69dd9df | 40 | \r |
41 | typedef struct {\r | |
42 | UINTN Signature;\r | |
43 | EFI_HANDLE Handle; \r | |
44 | EFI_ISA_ACPI_PROTOCOL IsaAcpi;\r | |
45 | EFI_PCI_IO_PROTOCOL *PciIo;\r | |
46 | } PCAT_ISA_ACPI_DEV;\r | |
47 | \r | |
a75ff28a | 48 | #define PCAT_ISA_ACPI_DEV_FROM_THIS(a) BASE_CR(a, PCAT_ISA_ACPI_DEV, IsaAcpi)\r |
c69dd9df | 49 | \r |
50 | //\r | |
51 | // Global Variables\r | |
52 | //\r | |
53 | extern EFI_DRIVER_BINDING_PROTOCOL gPcatIsaAcpiDriverBinding;\r | |
54 | \r | |
55 | extern EFI_COMPONENT_NAME2_PROTOCOL gPcatIsaAcpiComponentName2;\r | |
56 | \r | |
57 | extern EFI_COMPONENT_NAME_PROTOCOL gPcatIsaAcpiComponentName;\r | |
58 | \r | |
59 | \r | |
60 | //\r | |
61 | // Prototypes for Driver model protocol interface\r | |
62 | //\r | |
18c97f53 | 63 | /**\r |
64 | ControllerDriver Protocol Method\r | |
65 | \r | |
66 | @param This Driver Binding protocol instance pointer. \r | |
67 | @param Controller Handle of device to test.\r | |
68 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
69 | device to start.\r | |
70 | @retval EFI_SUCCESS This driver supports this device.\r | |
71 | @retval other This driver does not support this device.\r | |
72 | \r | |
73 | **/\r | |
c69dd9df | 74 | EFI_STATUS\r |
75 | EFIAPI\r | |
76 | PcatIsaAcpiDriverBindingSupported (\r | |
77 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
78 | IN EFI_HANDLE Controller,\r | |
79 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
80 | );\r | |
81 | \r | |
18c97f53 | 82 | /**\r |
83 | Install EFI_ISA_ACPI_PROTOCOL.\r | |
84 | \r | |
85 | @param This Driver Binding protocol instance pointer.\r | |
86 | @param ControllerHandle Handle of device to bind driver to.\r | |
87 | @param RemainingDevicePath Optional parameter use to pick a specific child\r | |
88 | device to start.\r | |
89 | \r | |
90 | @retval EFI_SUCCESS This driver is added to ControllerHandle\r | |
91 | @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle\r | |
92 | @retval other This driver does not support this device\r | |
93 | **/\r | |
c69dd9df | 94 | EFI_STATUS\r |
95 | EFIAPI\r | |
96 | PcatIsaAcpiDriverBindingStart (\r | |
97 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
98 | IN EFI_HANDLE Controller,\r | |
99 | IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r | |
100 | );\r | |
101 | \r | |
18c97f53 | 102 | /**\r |
103 | Stop this driver on ControllerHandle. Support stopping any child handles\r | |
104 | created by this driver.\r | |
105 | \r | |
106 | @param This Protocol instance pointer.\r | |
107 | @param ControllerHandle Handle of device to stop driver on\r | |
108 | @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of\r | |
109 | children is zero stop the entire bus driver.\r | |
110 | @param ChildHandleBuffer List of Child Handles to Stop.\r | |
111 | \r | |
112 | @retval EFI_SUCCESS This driver is removed ControllerHandle\r | |
113 | @retval other This driver was not removed from this device\r | |
114 | \r | |
115 | **/\r | |
c69dd9df | 116 | EFI_STATUS\r |
117 | EFIAPI\r | |
118 | PcatIsaAcpiDriverBindingStop (\r | |
119 | IN EFI_DRIVER_BINDING_PROTOCOL *This,\r | |
120 | IN EFI_HANDLE Controller,\r | |
121 | IN UINTN NumberOfChildren,\r | |
122 | IN EFI_HANDLE *ChildHandleBuffer\r | |
123 | );\r | |
124 | \r | |
125 | //\r | |
126 | // Prototypes for the ISA ACPI protocol interface\r | |
127 | //\r | |
18c97f53 | 128 | /**\r |
129 | Enumerate the ISA devices on the ISA bus\r | |
130 | \r | |
131 | \r | |
132 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
133 | @param Device Point to device ID instance \r | |
134 | \r | |
135 | @retval EFI_NOT_FOUND Can not found the next Isa device.\r | |
136 | @retval EFI_SUCESS Success retrieve the next Isa device for enumration.\r | |
137 | \r | |
138 | **/\r | |
c69dd9df | 139 | EFI_STATUS\r |
140 | EFIAPI\r | |
141 | IsaDeviceEnumerate (\r | |
142 | IN EFI_ISA_ACPI_PROTOCOL *This,\r | |
143 | OUT EFI_ISA_ACPI_DEVICE_ID **Device\r | |
144 | );\r | |
145 | \r | |
18c97f53 | 146 | /**\r |
147 | Set ISA device power\r | |
148 | \r | |
149 | \r | |
150 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
151 | @param Device Point to device ID instance \r | |
152 | @param OnOff TRUE for setting isa device power on,\r | |
153 | FALSE for setting isa device power off\r | |
154 | \r | |
155 | @return EFI_SUCCESS Sucess to change power status for isa device.\r | |
156 | **/\r | |
c69dd9df | 157 | EFI_STATUS\r |
158 | EFIAPI\r | |
159 | IsaDeviceSetPower (\r | |
160 | IN EFI_ISA_ACPI_PROTOCOL *This,\r | |
161 | IN EFI_ISA_ACPI_DEVICE_ID *Device,\r | |
162 | IN BOOLEAN OnOff\r | |
163 | );\r | |
164 | \r | |
18c97f53 | 165 | /**\r |
166 | Get current resource for the specific ISA device.\r | |
167 | \r | |
168 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
169 | @param Device Point to device ID instance \r | |
170 | @param ResourceList On return, point to resources instances for given isa device\r | |
171 | \r | |
172 | @retval EFI_NOT_FOUND Can not found the resource instance for given isa device\r | |
173 | @retval EFI_SUCCESS Success to get resource instance for given isa device.\r | |
174 | **/\r | |
c69dd9df | 175 | EFI_STATUS\r |
176 | EFIAPI\r | |
177 | IsaGetCurrentResource (\r | |
178 | IN EFI_ISA_ACPI_PROTOCOL *This,\r | |
179 | IN EFI_ISA_ACPI_DEVICE_ID *Device,\r | |
180 | OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList\r | |
181 | );\r | |
182 | \r | |
18c97f53 | 183 | /**\r |
184 | Get possible resource for the specific ISA device.\r | |
185 | \r | |
186 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
187 | @param Device Point to device ID instance \r | |
188 | @param ResourceList On return, point to resources instances for given isa device\r | |
189 | \r | |
190 | @retval EFI_SUCCESS Success to get resource instance for given isa device.\r | |
191 | **/\r | |
c69dd9df | 192 | EFI_STATUS\r |
193 | EFIAPI\r | |
194 | IsaGetPossibleResource (\r | |
195 | IN EFI_ISA_ACPI_PROTOCOL *This,\r | |
196 | IN EFI_ISA_ACPI_DEVICE_ID *Device, \r | |
197 | OUT EFI_ISA_ACPI_RESOURCE_LIST **ResourceList\r | |
198 | );\r | |
199 | \r | |
18c97f53 | 200 | /**\r |
201 | Set resource for the specific ISA device.\r | |
202 | \r | |
203 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
204 | @param Device Point to device ID instance \r | |
205 | @param ResourceList Point to resources instances for given isa device\r | |
206 | \r | |
207 | @return EFI_SUCESS Success to set resource.\r | |
208 | \r | |
209 | **/\r | |
c69dd9df | 210 | EFI_STATUS\r |
211 | EFIAPI\r | |
212 | IsaSetResource (\r | |
213 | IN EFI_ISA_ACPI_PROTOCOL *This,\r | |
214 | IN EFI_ISA_ACPI_DEVICE_ID *Device,\r | |
215 | IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList\r | |
216 | );\r | |
217 | \r | |
18c97f53 | 218 | /**\r |
219 | Enable/Disable the specific ISA device.\r | |
220 | \r | |
221 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
222 | @param Device Point to device ID instance \r | |
223 | @param Enable Enable/Disable\r | |
224 | \r | |
225 | @return EFI_SUCESS Success to enable/disable.\r | |
226 | \r | |
227 | **/\r | |
c69dd9df | 228 | EFI_STATUS\r |
229 | EFIAPI\r | |
230 | IsaEnableDevice (\r | |
231 | IN EFI_ISA_ACPI_PROTOCOL *This,\r | |
232 | IN EFI_ISA_ACPI_DEVICE_ID *Device,\r | |
233 | IN BOOLEAN Enable\r | |
234 | );\r | |
235 | \r | |
18c97f53 | 236 | /**\r |
237 | Initialize the specific ISA device.\r | |
238 | \r | |
239 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
240 | @param Device Point to device ID instance \r | |
241 | \r | |
242 | @return EFI_SUCESS Success to initialize.\r | |
243 | \r | |
244 | **/\r | |
c69dd9df | 245 | EFI_STATUS\r |
246 | EFIAPI\r | |
247 | IsaInitDevice (\r | |
248 | IN EFI_ISA_ACPI_PROTOCOL *This,\r | |
249 | IN EFI_ISA_ACPI_DEVICE_ID *Device\r | |
250 | );\r | |
251 | \r | |
18c97f53 | 252 | /**\r |
253 | Initialize the ISA interface.\r | |
254 | \r | |
255 | @param This Point to instance of EFI_ISA_ACPI_PROTOCOL\r | |
256 | \r | |
257 | @return EFI_SUCESS Success to initialize ISA interface.\r | |
258 | \r | |
259 | **/\r | |
c69dd9df | 260 | EFI_STATUS\r |
261 | EFIAPI\r | |
262 | IsaInterfaceInit (\r | |
263 | IN EFI_ISA_ACPI_PROTOCOL *This\r | |
264 | ); \r | |
265 | \r | |
e8bce4b4 RN |
266 | /**\r |
267 | Initialize the ISA device list.\r | |
268 | **/\r | |
269 | VOID\r | |
270 | InitializePcatIsaAcpiDeviceList (\r | |
271 | VOID\r | |
272 | );\r | |
273 | \r | |
c69dd9df | 274 | #endif\r |