+++ /dev/null
-/*++ @file\r
-\r
-Copyright (c) 2006, Intel Corporation. All rights reserved.<BR>\r
-Portions copyright (c) 2010,Apple Inc. All rights reserved.<BR>\r
-This program and the accompanying materials \r
-are licensed and made available under the terms and conditions of the BSD License \r
-which accompanies this distribution. The full text of the license may be found at \r
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
-\r
-\r
-**/\r
-\r
-#include "Gop.h"\r
-\r
-\r
-EFI_STATUS\r
-FreeNotifyList (\r
- IN OUT LIST_ENTRY *ListHead\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
- ListHead - The list head\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Free the notify list successfully\r
- EFI_INVALID_PARAMETER - ListHead is invalid.\r
-\r
-**/\r
-{\r
- EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY *NotifyNode;\r
-\r
- if (ListHead == NULL) {\r
- return EFI_INVALID_PARAMETER;\r
- }\r
- while (!IsListEmpty (ListHead)) {\r
- NotifyNode = CR (\r
- ListHead->ForwardLink, \r
- EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY, \r
- NotifyEntry, \r
- EMU_GOP_SIMPLE_TEXTIN_EX_NOTIFY_SIGNATURE\r
- );\r
- RemoveEntryList (ListHead->ForwardLink);\r
- gBS->FreePool (NotifyNode);\r
- }\r
- \r
- return EFI_SUCCESS;\r
-}\r
-\r
-\r
-/**\r
- Tests to see if this driver supports a given controller. If a child device is provided, \r
- it further tests to see if this driver supports creating a handle for the specified child device.\r
-\r
- This function checks to see if the driver specified by This supports the device specified by \r
- ControllerHandle. Drivers will typically use the device path attached to \r
- ControllerHandle and/or the services from the bus I/O abstraction attached to \r
- ControllerHandle to determine if the driver supports ControllerHandle. This function \r
- may be called many times during platform initialization. In order to reduce boot times, the tests \r
- performed by this function must be very small, and take as little time as possible to execute. This \r
- function must not change the state of any hardware devices, and this function must be aware that the \r
- device specified by ControllerHandle may already be managed by the same driver or a \r
- different driver. This function must match its calls to AllocatePages() with FreePages(), \r
- AllocatePool() with FreePool(), and OpenProtocol() with CloseProtocol(). \r
- Because ControllerHandle may have been previously started by the same driver, if a protocol is \r
- already in the opened state, then it must not be closed with CloseProtocol(). This is required \r
- to guarantee the state of ControllerHandle is not modified by this function.\r
-\r
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to test. This handle \r
- must support a protocol interface that supplies \r
- an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For bus drivers, if this parameter is not NULL, then \r
- the bus driver must determine if the bus controller specified \r
- by ControllerHandle and the child controller specified \r
- by RemainingDevicePath are both supported by this \r
- bus driver.\r
-\r
- @retval EFI_SUCCESS The device specified by ControllerHandle and\r
- RemainingDevicePath is supported by the driver specified by This.\r
- @retval EFI_ALREADY_STARTED The device specified by ControllerHandle and\r
- RemainingDevicePath is already being managed by the driver\r
- specified by This.\r
- @retval EFI_ACCESS_DENIED The device specified by ControllerHandle and\r
- RemainingDevicePath is already being managed by a different\r
- driver or an application that requires exclusive access.\r
- Currently not implemented.\r
- @retval EFI_UNSUPPORTED The device specified by ControllerHandle and\r
- RemainingDevicePath is not supported by the driver specified by This.\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EmuGopDriverBindingSupported (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Handle,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- )\r
-{\r
- EFI_STATUS Status;\r
- EMU_IO_THUNK_PROTOCOL *EmuIoThunk;\r
-\r
- //\r
- // Open the IO Abstraction(s) needed to perform the supported test\r
- //\r
- Status = gBS->OpenProtocol (\r
- Handle,\r
- &gEmuIoThunkProtocolGuid,\r
- (VOID **)&EmuIoThunk,\r
- This->DriverBindingHandle,\r
- Handle,\r
- EFI_OPEN_PROTOCOL_BY_DRIVER\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return Status;\r
- }\r
-\r
- Status = EmuGopSupported (EmuIoThunk);\r
-\r
- //\r
- // Close the I/O Abstraction(s) used to perform the supported test\r
- //\r
- gBS->CloseProtocol (\r
- Handle,\r
- &gEmuIoThunkProtocolGuid,\r
- This->DriverBindingHandle,\r
- Handle\r
- );\r
-\r
- return Status;\r
-}\r
-\r
-\r
-/**\r
- Starts a device controller or a bus controller.\r
-\r
- The Start() function is designed to be invoked from the EFI boot service ConnectController().\r
- As a result, much of the error checking on the parameters to Start() has been moved into this \r
- common boot service. It is legal to call Start() from other locations, \r
- but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
- 1. ControllerHandle must be a valid EFI_HANDLE.\r
- 2. If RemainingDevicePath is not NULL, then it must be a pointer to a naturally aligned\r
- EFI_DEVICE_PATH_PROTOCOL.\r
- 3. Prior to calling Start(), the Supported() function for the driver specified by This must\r
- have been called with the same calling parameters, and Supported() must have returned EFI_SUCCESS. \r
-\r
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle The handle of the controller to start. This handle \r
- must support a protocol interface that supplies \r
- an I/O abstraction to the driver.\r
- @param[in] RemainingDevicePath A pointer to the remaining portion of a device path. This \r
- parameter is ignored by device drivers, and is optional for bus \r
- drivers. For a bus driver, if this parameter is NULL, then handles \r
- for all the children of Controller are created by this driver. \r
- If this parameter is not NULL and the first Device Path Node is \r
- not the End of Device Path Node, then only the handle for the \r
- child device specified by the first Device Path Node of \r
- RemainingDevicePath is created by this driver.\r
- If the first Device Path Node of RemainingDevicePath is \r
- the End of Device Path Node, no child handle is created by this\r
- driver.\r
-\r
- @retval EFI_SUCCESS The device was started.\r
- @retval EFI_DEVICE_ERROR The device could not be started due to a device error.Currently not implemented.\r
- @retval EFI_OUT_OF_RESOURCES The request could not be completed due to a lack of resources.\r
- @retval Others The driver failded to start the device.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EmuGopDriverBindingStart (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Handle,\r
- IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
- )\r
-{\r
- EMU_IO_THUNK_PROTOCOL *EmuIoThunk;\r
- EFI_STATUS Status;\r
- GOP_PRIVATE_DATA *Private;\r
-\r
- //\r
- // Grab the protocols we need\r
- //\r
- Status = gBS->OpenProtocol (\r
- Handle,\r
- &gEmuIoThunkProtocolGuid,\r
- (VOID **)&EmuIoThunk,\r
- This->DriverBindingHandle,\r
- Handle,\r
- EFI_OPEN_PROTOCOL_BY_DRIVER\r
- );\r
- if (EFI_ERROR (Status)) {\r
- return EFI_UNSUPPORTED;\r
- }\r
-\r
- //\r
- // Allocate Private context data for SGO inteface.\r
- //\r
- Private = NULL;\r
- Status = gBS->AllocatePool (\r
- EfiBootServicesData,\r
- sizeof (GOP_PRIVATE_DATA),\r
- (VOID **)&Private\r
- );\r
- if (EFI_ERROR (Status)) {\r
- goto Done;\r
- }\r
- //\r
- // Set up context record\r
- //\r
- Private->Signature = GOP_PRIVATE_DATA_SIGNATURE;\r
- Private->Handle = Handle;\r
- Private->EmuIoThunk = EmuIoThunk;\r
- Private->WindowName = EmuIoThunk->ConfigString;\r
- Private->ControllerNameTable = NULL;\r
-\r
- AddUnicodeString (\r
- "eng",\r
- gEmuGopComponentName.SupportedLanguages,\r
- &Private->ControllerNameTable,\r
- EmuIoThunk->ConfigString\r
- );\r
- AddUnicodeString2 (\r
- "en",\r
- gEmuGopComponentName2.SupportedLanguages,\r
- &Private->ControllerNameTable,\r
- EmuIoThunk->ConfigString,\r
- FALSE\r
- );\r
-\r
- Status = EmuGopConstructor (Private);\r
- if (EFI_ERROR (Status)) {\r
- goto Done;\r
- }\r
- //\r
- // Publish the Gop interface to the world\r
- //\r
- Status = gBS->InstallMultipleProtocolInterfaces (\r
- &Private->Handle,\r
- &gEfiGraphicsOutputProtocolGuid, &Private->GraphicsOutput,\r
- &gEfiSimpleTextInProtocolGuid, &Private->SimpleTextIn,\r
- &gEfiSimplePointerProtocolGuid, &Private->SimplePointer,\r
- &gEfiSimpleTextInputExProtocolGuid, &Private->SimpleTextInEx,\r
- NULL\r
- );\r
-\r
-Done:\r
- if (EFI_ERROR (Status)) {\r
-\r
- gBS->CloseProtocol (\r
- Handle,\r
- &gEmuIoThunkProtocolGuid,\r
- This->DriverBindingHandle,\r
- Handle\r
- );\r
-\r
- if (Private != NULL) {\r
- //\r
- // On Error Free back private data\r
- //\r
- if (Private->ControllerNameTable != NULL) {\r
- FreeUnicodeStringTable (Private->ControllerNameTable);\r
- }\r
- if (Private->SimpleTextIn.WaitForKey != NULL) {\r
- gBS->CloseEvent (Private->SimpleTextIn.WaitForKey);\r
- }\r
- if (Private->SimpleTextInEx.WaitForKeyEx != NULL) {\r
- gBS->CloseEvent (Private->SimpleTextInEx.WaitForKeyEx);\r
- }\r
- FreeNotifyList (&Private->NotifyList);\r
-\r
- gBS->FreePool (Private);\r
- }\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-\r
-\r
-/**\r
- Stops a device controller or a bus controller.\r
- \r
- The Stop() function is designed to be invoked from the EFI boot service DisconnectController(). \r
- As a result, much of the error checking on the parameters to Stop() has been moved \r
- into this common boot service. It is legal to call Stop() from other locations, \r
- but the following calling restrictions must be followed, or the system behavior will not be deterministic.\r
- 1. ControllerHandle must be a valid EFI_HANDLE that was used on a previous call to this\r
- same driver's Start() function.\r
- 2. The first NumberOfChildren handles of ChildHandleBuffer must all be a valid\r
- EFI_HANDLE. In addition, all of these handles must have been created in this driver's\r
- Start() function, and the Start() function must have called OpenProtocol() on\r
- ControllerHandle with an Attribute of EFI_OPEN_PROTOCOL_BY_CHILD_CONTROLLER.\r
- \r
- @param[in] This A pointer to the EFI_DRIVER_BINDING_PROTOCOL instance.\r
- @param[in] ControllerHandle A handle to the device being stopped. The handle must \r
- support a bus specific I/O protocol for the driver \r
- to use to stop the device.\r
- @param[in] NumberOfChildren The number of child device handles in ChildHandleBuffer.\r
- @param[in] ChildHandleBuffer An array of child handles to be freed. May be NULL \r
- if NumberOfChildren is 0.\r
-\r
- @retval EFI_SUCCESS The device was stopped.\r
- @retval EFI_DEVICE_ERROR The device could not be stopped due to a device error.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-EmuGopDriverBindingStop (\r
- IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
- IN EFI_HANDLE Handle,\r
- IN UINTN NumberOfChildren,\r
- IN EFI_HANDLE *ChildHandleBuffer\r
- )\r
-{\r
- EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput;\r
- EFI_STATUS Status;\r
- GOP_PRIVATE_DATA *Private;\r
-\r
- Status = gBS->OpenProtocol (\r
- Handle,\r
- &gEfiGraphicsOutputProtocolGuid,\r
- (VOID **)&GraphicsOutput,\r
- This->DriverBindingHandle,\r
- Handle,\r
- EFI_OPEN_PROTOCOL_GET_PROTOCOL\r
- );\r
- if (EFI_ERROR (Status)) {\r
- //\r
- // If the GOP interface does not exist the driver is not started\r
- //\r
- return EFI_NOT_STARTED;\r
- }\r
-\r
- //\r
- // Get our private context information\r
- //\r
- Private = GOP_PRIVATE_DATA_FROM_THIS (GraphicsOutput);\r
-\r
- //\r
- // Remove the SGO interface from the system\r
- //\r
- Status = gBS->UninstallMultipleProtocolInterfaces (\r
- Private->Handle,\r
- &gEfiGraphicsOutputProtocolGuid, &Private->GraphicsOutput,\r
- &gEfiSimpleTextInProtocolGuid, &Private->SimpleTextIn,\r
- &gEfiSimplePointerProtocolGuid, &Private->SimplePointer,\r
- &gEfiSimpleTextInputExProtocolGuid, &Private->SimpleTextInEx,\r
- NULL\r
- );\r
- if (!EFI_ERROR (Status)) {\r
- //\r
- // Shutdown the hardware\r
- //\r
- Status = EmuGopDestructor (Private);\r
- if (EFI_ERROR (Status)) {\r
- return EFI_DEVICE_ERROR;\r
- }\r
-\r
- gBS->CloseProtocol (\r
- Handle,\r
- &gEmuIoThunkProtocolGuid,\r
- This->DriverBindingHandle,\r
- Handle\r
- );\r
-\r
- //\r
- // Free our instance data\r
- //\r
- FreeUnicodeStringTable (Private->ControllerNameTable);\r
- \r
- Status = gBS->CloseEvent (Private->SimpleTextIn.WaitForKey);\r
- ASSERT_EFI_ERROR (Status);\r
- \r
- Status = gBS->CloseEvent (Private->SimpleTextInEx.WaitForKeyEx);\r
- ASSERT_EFI_ERROR (Status);\r
- \r
- FreeNotifyList (&Private->NotifyList);\r
-\r
- gBS->FreePool (Private);\r
-\r
- }\r
-\r
- return Status;\r
-}\r
-\r
-\r
-///\r
-/// This protocol provides the services required to determine if a driver supports a given controller. \r
-/// If a controller is supported, then it also provides routines to start and stop the controller.\r
-///\r
-EFI_DRIVER_BINDING_PROTOCOL gEmuGopDriverBinding = {\r
- EmuGopDriverBindingSupported,\r
- EmuGopDriverBindingStart,\r
- EmuGopDriverBindingStop,\r
- 0xa,\r
- NULL,\r
- NULL\r
-};\r
-\r
-\r
-\r
-/**\r
- The user Entry Point for module EmuGop. The user code starts with this function.\r
-\r
- @param[in] ImageHandle The firmware allocated handle for the EFI image. \r
- @param[in] SystemTable A pointer to the EFI System Table.\r
- \r
- @retval EFI_SUCCESS The entry point is executed successfully.\r
- @retval other Some error occurs when executing this entry point.\r
-\r
-**/\r
-EFI_STATUS\r
-EFIAPI\r
-InitializeEmuGop (\r
- IN EFI_HANDLE ImageHandle,\r
- IN EFI_SYSTEM_TABLE *SystemTable\r
- )\r
-{\r
- EFI_STATUS Status;\r
-\r
- Status = EfiLibInstallDriverBindingComponentName2 (\r
- ImageHandle,\r
- SystemTable,\r
- &gEmuGopDriverBinding,\r
- ImageHandle,\r
- &gEmuGopComponentName,\r
- &gEmuGopComponentName2\r
- );\r
- ASSERT_EFI_ERROR (Status);\r
-\r
-\r
- return Status;\r
-}\r
-\r
projects / mirror_edk2.git / blobdiff