]> git.proxmox.com Git - mirror_edk2.git/blame - IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.c
Code scrub for VgaMiniPortDxe.
[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / VgaMiniPortDxe / VgaMiniPort.c
CommitLineData
733f03aa 1/** @file\r
269e4559 2 Implements EFI Driver Binding Protocol and VGA Mini Port Protocol for VGA Mini Port Driver.\r
733f03aa 3\r
269e4559 4Copyright (c) 2006 - 2009 Intel Corporation. All rights reserved\r
733f03aa 5This program and the accompanying materials\r
6are licensed and made available under the terms and conditions of the BSD License\r
7which accompanies this distribution. The full text of the license may be found at\r
8http://opensource.org/licenses/bsd-license.php\r
9\r
10THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "VgaMiniPort.h"\r
16\r
17//\r
18// EFI Driver Binding Protocol Instance\r
19//\r
20// This driver has a version value of 0x00000000. This is the\r
21// lowest possible priority for a driver. This is done on purpose to help\r
22// the developers of UGA drivers. This driver can bind if no UGA driver\r
23// is present, so a console is available. Then, when a UGA driver is loaded\r
24// this driver can be disconnected, and the UGA driver can be connected.\r
25// As long as the UGA driver has a version value greater than 0x00000000, it\r
26// will be connected first and will block this driver from connecting.\r
27//\r
28EFI_DRIVER_BINDING_PROTOCOL gPciVgaMiniPortDriverBinding = {\r
29 PciVgaMiniPortDriverBindingSupported,\r
30 PciVgaMiniPortDriverBindingStart,\r
31 PciVgaMiniPortDriverBindingStop,\r
32 0x00000000,\r
33 NULL,\r
34 NULL\r
35};\r
36\r
fcf03596 37/**\r
269e4559 38 Entrypoint of VGA Mini Port Driver.\r
39\r
40 This function is the entrypoint of UVGA Mini Port Driver. It installs Driver Binding\r
41 Protocols together with Component Name Protocols.\r
42\r
43 @param ImageHandle The firmware allocated handle for the EFI image.\r
44 @param SystemTable A pointer to the EFI System Table.\r
45\r
46 @retval EFI_SUCCESS The entry point is executed successfully.\r
47\r
fcf03596 48**/\r
733f03aa 49EFI_STATUS\r
50EFIAPI\r
51PciVgaMiniPortDriverEntryPoint (\r
52 IN EFI_HANDLE ImageHandle,\r
53 IN EFI_SYSTEM_TABLE *SystemTable\r
54 )\r
733f03aa 55{\r
269e4559 56 EFI_STATUS Status;\r
57\r
58 Status = EfiLibInstallDriverBindingComponentName2 (\r
59 ImageHandle,\r
60 SystemTable,\r
61 &gPciVgaMiniPortDriverBinding,\r
62 ImageHandle,\r
63 &gPciVgaMiniPortComponentName,\r
64 &gPciVgaMiniPortComponentName2\r
65 );\r
66 ASSERT_EFI_ERROR (Status);\r
67\r
68 return EFI_SUCCESS;\r
733f03aa 69}\r
70\r
71\r
72/**\r
269e4559 73 Check whether VGA Mini Port driver supports this device.\r
733f03aa 74\r
eeefcb9d 75 @param This The driver binding protocol.\r
76 @param Controller The controller handle to check.\r
77 @param RemainingDevicePath The remaining device path.\r
78\r
79 @retval EFI_SUCCESS The driver supports this controller.\r
80 @retval EFI_UNSUPPORTED This device isn't supported.\r
733f03aa 81\r
82**/\r
83EFI_STATUS\r
84EFIAPI\r
85PciVgaMiniPortDriverBindingSupported (\r
86 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
87 IN EFI_HANDLE Controller,\r
88 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
89 )\r
90{\r
91 EFI_STATUS Status;\r
92 EFI_PCI_IO_PROTOCOL *PciIo;\r
93 PCI_TYPE00 Pci;\r
94\r
95 //\r
96 // Open the IO Abstraction(s) needed to perform the supported test\r
97 //\r
98 Status = gBS->OpenProtocol (\r
99 Controller,\r
100 &gEfiPciIoProtocolGuid,\r
101 (VOID **) &PciIo,\r
102 This->DriverBindingHandle,\r
103 Controller,\r
104 EFI_OPEN_PROTOCOL_BY_DRIVER\r
105 );\r
106 if (EFI_ERROR (Status)) {\r
107 return Status;\r
108 }\r
109 //\r
110 // See if this is a PCI VGA Controller by looking at the Command register and\r
111 // Class Code Register\r
112 //\r
113 Status = PciIo->Pci.Read (\r
114 PciIo,\r
115 EfiPciIoWidthUint32,\r
116 0,\r
117 sizeof (Pci) / sizeof (UINT32),\r
118 &Pci\r
119 );\r
120 if (EFI_ERROR (Status)) {\r
121 goto Done;\r
122 }\r
123\r
124 Status = EFI_UNSUPPORTED;\r
125 //\r
126 // See if the device is an enabled VGA device.\r
127 // Most systems can only have on VGA device on at a time.\r
128 //\r
129 if (((Pci.Hdr.Command & 0x03) == 0x03) && IS_PCI_VGA (&Pci)) {\r
130 Status = EFI_SUCCESS;\r
131 }\r
132\r
133Done:\r
134 gBS->CloseProtocol (\r
269e4559 135 Controller,\r
136 &gEfiPciIoProtocolGuid,\r
137 This->DriverBindingHandle,\r
138 Controller\r
139 );\r
733f03aa 140\r
141 return Status;\r
142}\r
143\r
144\r
145/**\r
269e4559 146 Starts the VGA device with this driver.\r
733f03aa 147\r
269e4559 148 This function consumes PCI I/O Protocol, and installs VGA Mini Port Protocol\r
149 onto the VGA device handle.\r
733f03aa 150\r
eeefcb9d 151 @param This The driver binding instance.\r
152 @param Controller The controller to check.\r
153 @param RemainingDevicePath The remaining device patch.\r
154\r
155 @retval EFI_SUCCESS The controller is controlled by the driver.\r
156 @retval EFI_ALREADY_STARTED The controller is already controlled by the driver.\r
157 @retval EFI_OUT_OF_RESOURCES Failed to allocate resources.\r
733f03aa 158\r
159**/\r
160EFI_STATUS\r
161EFIAPI\r
162PciVgaMiniPortDriverBindingStart (\r
163 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
164 IN EFI_HANDLE Controller,\r
165 IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
166 )\r
167{\r
168 EFI_STATUS Status;\r
169 EFI_PCI_IO_PROTOCOL *PciIo;\r
170 PCI_VGA_MINI_PORT_DEV *PciVgaMiniPortPrivate;\r
171\r
172 PciVgaMiniPortPrivate = NULL;\r
173 PciIo = NULL;\r
174 //\r
175 // Open the IO Abstraction(s) needed\r
176 //\r
177 Status = gBS->OpenProtocol (\r
178 Controller,\r
179 &gEfiPciIoProtocolGuid,\r
180 (VOID **) &PciIo,\r
181 This->DriverBindingHandle,\r
182 Controller,\r
183 EFI_OPEN_PROTOCOL_BY_DRIVER\r
184 );\r
185 if (EFI_ERROR (Status)) {\r
186 goto Done;\r
187 }\r
188 //\r
189 // Allocate the private device structure\r
190 //\r
269e4559 191 PciVgaMiniPortPrivate = AllocateZeroPool (sizeof (PCI_VGA_MINI_PORT_DEV));\r
192 ASSERT (PciVgaMiniPortPrivate != NULL);\r
733f03aa 193\r
194 //\r
195 // Initialize the private device structure\r
196 //\r
197 PciVgaMiniPortPrivate->Signature = PCI_VGA_MINI_PORT_DEV_SIGNATURE;\r
198 PciVgaMiniPortPrivate->Handle = Controller;\r
199 PciVgaMiniPortPrivate->PciIo = PciIo;\r
200\r
201 PciVgaMiniPortPrivate->VgaMiniPort.SetMode = PciVgaMiniPortSetMode;\r
202 PciVgaMiniPortPrivate->VgaMiniPort.VgaMemoryOffset = 0xb8000;\r
203 PciVgaMiniPortPrivate->VgaMiniPort.CrtcAddressRegisterOffset = 0x3d4;\r
204 PciVgaMiniPortPrivate->VgaMiniPort.CrtcDataRegisterOffset = 0x3d5;\r
205 PciVgaMiniPortPrivate->VgaMiniPort.VgaMemoryBar = EFI_PCI_IO_PASS_THROUGH_BAR;\r
206 PciVgaMiniPortPrivate->VgaMiniPort.CrtcAddressRegisterBar = EFI_PCI_IO_PASS_THROUGH_BAR;\r
207 PciVgaMiniPortPrivate->VgaMiniPort.CrtcDataRegisterBar = EFI_PCI_IO_PASS_THROUGH_BAR;\r
208 PciVgaMiniPortPrivate->VgaMiniPort.MaxMode = 1;\r
209\r
210 //\r
269e4559 211 // Install VGA Mini Port Protocol\r
733f03aa 212 //\r
213 Status = gBS->InstallMultipleProtocolInterfaces (\r
214 &Controller,\r
215 &gEfiVgaMiniPortProtocolGuid,\r
216 &PciVgaMiniPortPrivate->VgaMiniPort,\r
217 NULL\r
218 );\r
219Done:\r
220 if (EFI_ERROR (Status)) {\r
221 gBS->CloseProtocol (\r
269e4559 222 Controller,\r
223 &gEfiPciIoProtocolGuid,\r
224 This->DriverBindingHandle,\r
225 Controller\r
226 );\r
eeefcb9d 227 if (PciVgaMiniPortPrivate != NULL) {\r
269e4559 228 FreePool (PciVgaMiniPortPrivate);\r
733f03aa 229 }\r
230 }\r
231\r
232 return Status;\r
233}\r
234\r
235\r
236/**\r
269e4559 237 Stop the VGA device with this driver.\r
733f03aa 238\r
269e4559 239 This function uninstalls VGA Mini Port Protocol from the VGA device handle,\r
240 and closes PCI I/O Protocol.\r
733f03aa 241\r
eeefcb9d 242 @param This The driver binding protocol.\r
243 @param Controller The controller to release.\r
244 @param NumberOfChildren The child number that opened controller\r
245 BY_CHILD.\r
246 @param ChildHandleBuffer The array of child handle.\r
247\r
248 @retval EFI_SUCCESS The controller or children are stopped.\r
249 @retval EFI_DEVICE_ERROR Failed to stop the driver.\r
733f03aa 250\r
251**/\r
252EFI_STATUS\r
253EFIAPI\r
254PciVgaMiniPortDriverBindingStop (\r
255 IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
256 IN EFI_HANDLE Controller,\r
257 IN UINTN NumberOfChildren,\r
258 IN EFI_HANDLE *ChildHandleBuffer\r
259 )\r
260{\r
261 EFI_STATUS Status;\r
262 EFI_VGA_MINI_PORT_PROTOCOL *VgaMiniPort;\r
263 PCI_VGA_MINI_PORT_DEV *PciVgaMiniPortPrivate;\r
264\r
265 Status = gBS->OpenProtocol (\r
266 Controller,\r
267 &gEfiVgaMiniPortProtocolGuid,\r
268 (VOID **) &VgaMiniPort,\r
269 This->DriverBindingHandle,\r
270 Controller,\r
271 EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
272 );\r
273 if (EFI_ERROR (Status)) {\r
274 return Status;\r
275 }\r
276\r
277 PciVgaMiniPortPrivate = PCI_VGA_MINI_PORT_DEV_FROM_THIS (VgaMiniPort);\r
278\r
279 Status = gBS->UninstallProtocolInterface (\r
280 Controller,\r
281 &gEfiVgaMiniPortProtocolGuid,\r
282 &PciVgaMiniPortPrivate->VgaMiniPort\r
283 );\r
284 if (EFI_ERROR (Status)) {\r
285 return Status;\r
286 }\r
287\r
288 gBS->CloseProtocol (\r
269e4559 289 Controller,\r
290 &gEfiPciIoProtocolGuid,\r
291 This->DriverBindingHandle,\r
292 Controller\r
293 );\r
733f03aa 294\r
269e4559 295 FreePool (PciVgaMiniPortPrivate);\r
733f03aa 296\r
297 return EFI_SUCCESS;\r
298}\r
299//\r
300// VGA Mini Port Protocol Functions\r
301//\r
302\r
303/**\r
269e4559 304 Sets the text display mode of a VGA controller.\r
733f03aa 305\r
269e4559 306 This function implements EFI_VGA_MINI_PORT_PROTOCOL.SetMode().\r
307 If ModeNumber exceeds the valid range, then EFI_UNSUPPORTED is returned.\r
308 Otherwise, EFI_SUCCESS is directly returned without real operation.\r
309 \r
310 @param This Protocol instance pointer.\r
311 @param ModeNumber Mode number. 0 - 80x25 1-80x50\r
733f03aa 312\r
269e4559 313 @retval EFI_SUCCESS The mode was set\r
314 @retval EFI_UNSUPPORTED ModeNumber is not supported.\r
315 @retval EFI_DEVICE_ERROR The device is not functioning properly.\r
316 \r
733f03aa 317**/\r
318EFI_STATUS\r
319EFIAPI\r
320PciVgaMiniPortSetMode (\r
321 IN EFI_VGA_MINI_PORT_PROTOCOL *This,\r
322 IN UINTN ModeNumber\r
323 )\r
324{\r
325 if (ModeNumber > This->MaxMode) {\r
326 return EFI_UNSUPPORTED;\r
327 }\r
328\r
329 return EFI_SUCCESS;\r
330}\r
fcf03596 331 \r