2 Console Platform DXE Driver, install Console Device Guids and update Console
5 Copyright (c) 2006 - 2010, Intel Corporation. <BR>
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which accompanies this distribution. The full text of the license may be found at
9 http://opensource.org/licenses/bsd-license.php
11 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
12 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
16 #include "ConPlatform.h"
19 EFI_DRIVER_BINDING_PROTOCOL gConPlatformTextInDriverBinding
= {
20 ConPlatformTextInDriverBindingSupported
,
21 ConPlatformTextInDriverBindingStart
,
22 ConPlatformTextInDriverBindingStop
,
28 EFI_DRIVER_BINDING_PROTOCOL gConPlatformTextOutDriverBinding
= {
29 ConPlatformTextOutDriverBindingSupported
,
30 ConPlatformTextOutDriverBindingStart
,
31 ConPlatformTextOutDriverBindingStop
,
38 Entrypoint of this module.
40 This function is the entrypoint of this module. It installs Driver Binding
41 Protocols together with Component Name Protocols.
43 @param ImageHandle The firmware allocated handle for the EFI image.
44 @param SystemTable A pointer to the EFI System Table.
46 @retval EFI_SUCCESS The entry point is executed successfully.
51 InitializeConPlatform(
52 IN EFI_HANDLE ImageHandle
,
53 IN EFI_SYSTEM_TABLE
*SystemTable
58 Status
= EfiLibInstallDriverBindingComponentName2 (
61 &gConPlatformTextInDriverBinding
,
63 &gConPlatformComponentName
,
64 &gConPlatformComponentName2
66 ASSERT_EFI_ERROR (Status
);
68 Status
= EfiLibInstallDriverBindingComponentName2 (
71 &gConPlatformTextOutDriverBinding
,
73 &gConPlatformComponentName
,
74 &gConPlatformComponentName2
76 ASSERT_EFI_ERROR (Status
);
83 Test to see if EFI_SIMPLE_TEXT_INPUT_PROTOCOL is supported on ControllerHandle.
85 @param This Protocol instance pointer.
86 @param ControllerHandle Handle of device to test.
87 @param RemainingDevicePath Optional parameter use to pick a specific child
90 @retval EFI_SUCCESS This driver supports this device.
91 @retval other This driver does not support this device.
96 ConPlatformTextInDriverBindingSupported (
97 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
98 IN EFI_HANDLE ControllerHandle
,
99 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
102 return ConPlatformDriverBindingSupported (
105 &gEfiSimpleTextInProtocolGuid
111 Test to see if EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL is supported on ControllerHandle.
113 @param This Protocol instance pointer.
114 @param ControllerHandle Handle of device to test.
115 @param RemainingDevicePath Optional parameter use to pick a specific child
118 @retval EFI_SUCCESS This driver supports this device.
119 @retval other This driver does not support this device.
124 ConPlatformTextOutDriverBindingSupported (
125 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
126 IN EFI_HANDLE ControllerHandle
,
127 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath OPTIONAL
130 return ConPlatformDriverBindingSupported (
133 &gEfiSimpleTextOutProtocolGuid
139 Test to see if the specified protocol is supported on ControllerHandle.
141 @param This Protocol instance pointer.
142 @param ControllerHandle Handle of device to test.
143 @param ProtocolGuid The specfic protocol.
145 @retval EFI_SUCCESS This driver supports this device.
146 @retval other This driver does not support this device.
150 ConPlatformDriverBindingSupported (
151 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
152 IN EFI_HANDLE ControllerHandle
,
153 IN EFI_GUID
*ProtocolGuid
160 // Test to see if this is a physical device by checking if
161 // it has a Device Path Protocol.
163 Status
= gBS
->OpenProtocol (
165 &gEfiDevicePathProtocolGuid
,
167 This
->DriverBindingHandle
,
169 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
171 if (EFI_ERROR (Status
)) {
175 // Test to see if this device supports the specified Protocol.
177 Status
= gBS
->OpenProtocol (
180 (VOID
**) &Interface
,
181 This
->DriverBindingHandle
,
183 EFI_OPEN_PROTOCOL_BY_DRIVER
185 if (EFI_ERROR (Status
)) {
192 This
->DriverBindingHandle
,
200 Start this driver on the device for console input.
202 Start this driver on ControllerHandle by opening Simple Text Input Protocol,
203 reading Device Path, and installing Console In Devcice GUID on ControllerHandle.
205 If this devcie is not one hot-plug devce, append its device path into the
206 console environment variables ConInDev.
208 @param This Protocol instance pointer.
209 @param ControllerHandle Handle of device to bind driver to
210 @param RemainingDevicePath Optional parameter use to pick a specific child
213 @retval EFI_SUCCESS This driver is added to ControllerHandle
214 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
215 @retval other This driver does not support this device.
220 ConPlatformTextInDriverBindingStart (
221 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
222 IN EFI_HANDLE ControllerHandle
,
223 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
227 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
228 EFI_SIMPLE_TEXT_INPUT_PROTOCOL
*TextIn
;
229 BOOLEAN IsInConInVariable
;
232 // Get the Device Path Protocol so the environment variables can be updated
234 Status
= gBS
->OpenProtocol (
236 &gEfiDevicePathProtocolGuid
,
237 (VOID
**) &DevicePath
,
238 This
->DriverBindingHandle
,
240 EFI_OPEN_PROTOCOL_GET_PROTOCOL
242 if (EFI_ERROR (Status
)) {
246 // Open the Simple Text Input Protocol BY_DRIVER
248 Status
= gBS
->OpenProtocol (
250 &gEfiSimpleTextInProtocolGuid
,
252 This
->DriverBindingHandle
,
254 EFI_OPEN_PROTOCOL_BY_DRIVER
256 if (EFI_ERROR (Status
)) {
260 // Check if the device path is in ConIn Variable
262 IsInConInVariable
= FALSE
;
263 Status
= ConPlatformUpdateDeviceVariable (
268 if (!EFI_ERROR (Status
)) {
269 IsInConInVariable
= TRUE
;
273 // Check the device path, if it is a hot plug device,
274 // do not put the device path into ConInDev, and install
275 // gEfiConsoleInDeviceGuid to the device handle directly.
276 // The policy is, make hot plug device plug in and play immediately.
278 if (IsHotPlugDevice (DevicePath
)) {
279 gBS
->InstallMultipleProtocolInterfaces (
281 &gEfiConsoleInDeviceGuid
,
286 // Append the device path to ConInDev only if it is in ConIn variable.
288 if (IsInConInVariable
) {
289 ConPlatformUpdateDeviceVariable (
297 // If it is not a hot-plug device, append the device path to the
298 // ConInDev environment variable
300 ConPlatformUpdateDeviceVariable (
307 // If the device path is an instance in the ConIn environment variable,
308 // then install EfiConsoleInDeviceGuid onto ControllerHandle
310 if (IsInConInVariable
) {
311 gBS
->InstallMultipleProtocolInterfaces (
313 &gEfiConsoleInDeviceGuid
,
320 &gEfiSimpleTextInProtocolGuid
,
321 This
->DriverBindingHandle
,
331 Start this driver on the device for console output and stardard error output.
333 Start this driver on ControllerHandle by opening Simple Text Output Protocol,
334 reading Device Path, and installing Console Out Devcic GUID, Standard Error
335 Device GUID on ControllerHandle.
337 If this devcie is not one hot-plug devce, append its device path into the
338 console environment variables ConOutDev, ErrOutDev.
340 @param This Protocol instance pointer.
341 @param ControllerHandle Handle of device to bind driver to
342 @param RemainingDevicePath Optional parameter use to pick a specific child
345 @retval EFI_SUCCESS This driver is added to ControllerHandle
346 @retval EFI_ALREADY_STARTED This driver is already running on ControllerHandle
347 @retval other This driver does not support this device
352 ConPlatformTextOutDriverBindingStart (
353 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
354 IN EFI_HANDLE ControllerHandle
,
355 IN EFI_DEVICE_PATH_PROTOCOL
*RemainingDevicePath
359 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
360 EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL
*TextOut
;
362 BOOLEAN IsInConOutVariable
;
363 BOOLEAN IsInErrOutVariable
;
368 // Get the Device Path Protocol so the environment variables can be updated
370 Status
= gBS
->OpenProtocol (
372 &gEfiDevicePathProtocolGuid
,
373 (VOID
**) &DevicePath
,
374 This
->DriverBindingHandle
,
376 EFI_OPEN_PROTOCOL_GET_PROTOCOL
378 if (EFI_ERROR (Status
)) {
382 // Open the Simple Text Output Protocol BY_DRIVER
384 Status
= gBS
->OpenProtocol (
386 &gEfiSimpleTextOutProtocolGuid
,
388 This
->DriverBindingHandle
,
390 EFI_OPEN_PROTOCOL_BY_DRIVER
392 if (EFI_ERROR (Status
)) {
396 // Check if the device path is in ConOut & ErrOut Variable
398 IsInConOutVariable
= FALSE
;
399 Status
= ConPlatformUpdateDeviceVariable (
404 if (!EFI_ERROR (Status
)) {
405 IsInConOutVariable
= TRUE
;
408 IsInErrOutVariable
= FALSE
;
409 Status
= ConPlatformUpdateDeviceVariable (
414 if (!EFI_ERROR (Status
)) {
415 IsInErrOutVariable
= TRUE
;
419 // Check the device path, if it is a hot plug device,
420 // do not put the device path into ConOutDev and ErrOutDev,
421 // and install gEfiConsoleOutDeviceGuid to the device handle directly.
422 // The policy is, make hot plug device plug in and play immediately.
424 if (IsHotPlugDevice (DevicePath
)) {
425 gBS
->InstallMultipleProtocolInterfaces (
427 &gEfiConsoleOutDeviceGuid
,
432 // Append the device path to ConOutDev only if it is in ConOut variable.
434 if (IsInConOutVariable
) {
435 ConPlatformUpdateDeviceVariable (
442 // Append the device path to ErrOutDev only if it is in ErrOut variable.
444 if (IsInErrOutVariable
) {
445 ConPlatformUpdateDeviceVariable (
453 // If it is not a hot-plug device, first append the device path to the
454 // ConOutDev environment variable
456 ConPlatformUpdateDeviceVariable (
462 // Then append the device path to the ErrOutDev environment variable
464 ConPlatformUpdateDeviceVariable (
471 // If the device path is an instance in the ConOut environment variable,
472 // then install EfiConsoleOutDeviceGuid onto ControllerHandle
474 if (IsInConOutVariable
) {
476 Status
= gBS
->InstallMultipleProtocolInterfaces (
478 &gEfiConsoleOutDeviceGuid
,
484 // If the device path is an instance in the ErrOut environment variable,
485 // then install EfiStandardErrorDeviceGuid onto ControllerHandle
487 if (IsInErrOutVariable
) {
489 gBS
->InstallMultipleProtocolInterfaces (
491 &gEfiStandardErrorDeviceGuid
,
500 &gEfiSimpleTextOutProtocolGuid
,
501 This
->DriverBindingHandle
,
511 Stop this driver on ControllerHandle by removing Console In Devcice GUID
512 and closing the Simple Text Input protocol on ControllerHandle.
514 @param This Protocol instance pointer.
515 @param ControllerHandle Handle of device to stop driver on
516 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
517 children is zero stop the entire bus driver.
518 @param ChildHandleBuffer List of Child Handles to Stop.
520 @retval EFI_SUCCESS This driver is removed ControllerHandle
521 @retval other This driver was not removed from this device
526 ConPlatformTextInDriverBindingStop (
527 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
528 IN EFI_HANDLE ControllerHandle
,
529 IN UINTN NumberOfChildren
,
530 IN EFI_HANDLE
*ChildHandleBuffer
534 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
537 // Get the Device Path Protocol firstly
539 Status
= gBS
->OpenProtocol (
541 &gEfiDevicePathProtocolGuid
,
542 (VOID
**) &DevicePath
,
543 This
->DriverBindingHandle
,
545 EFI_OPEN_PROTOCOL_GET_PROTOCOL
548 // If there is device path on ControllerHandle
550 if (!EFI_ERROR (Status
)) {
552 // Remove DevicePath from ConInDev if exists.
554 ConPlatformUpdateDeviceVariable (
562 // Uninstall the Console Device GUIDs from Controller Handle
564 ConPlatformUnInstallProtocol (
567 &gEfiConsoleInDeviceGuid
571 // Close the Simple Text Input Protocol
575 &gEfiSimpleTextInProtocolGuid
,
576 This
->DriverBindingHandle
,
585 Stop this driver on ControllerHandle by removing Console Out Devcice GUID
586 and closing the Simple Text Output protocol on ControllerHandle.
588 @param This Protocol instance pointer.
589 @param ControllerHandle Handle of device to stop driver on
590 @param NumberOfChildren Number of Handles in ChildHandleBuffer. If number of
591 children is zero stop the entire bus driver.
592 @param ChildHandleBuffer List of Child Handles to Stop.
594 @retval EFI_SUCCESS This driver is removed ControllerHandle
595 @retval other This driver was not removed from this device
600 ConPlatformTextOutDriverBindingStop (
601 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
602 IN EFI_HANDLE ControllerHandle
,
603 IN UINTN NumberOfChildren
,
604 IN EFI_HANDLE
*ChildHandleBuffer
608 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
611 // Get the Device Path Protocol firstly
613 Status
= gBS
->OpenProtocol (
615 &gEfiDevicePathProtocolGuid
,
616 (VOID
**) &DevicePath
,
617 This
->DriverBindingHandle
,
619 EFI_OPEN_PROTOCOL_GET_PROTOCOL
621 if (!EFI_ERROR (Status
)) {
623 // Remove DevicePath from ConOutDev and ErrOutDev if exists.
625 ConPlatformUpdateDeviceVariable (
630 ConPlatformUpdateDeviceVariable (
638 // Uninstall the Console Device GUIDs from Controller Handle
640 ConPlatformUnInstallProtocol (
643 &gEfiConsoleOutDeviceGuid
646 ConPlatformUnInstallProtocol (
649 &gEfiStandardErrorDeviceGuid
653 // Close the Simple Text Output Protocol
657 &gEfiSimpleTextOutProtocolGuid
,
658 This
->DriverBindingHandle
,
667 Uninstall the specified protocol.
669 @param This Protocol instance pointer.
670 @param Handle Handle of device to uninstall protocol on.
671 @param ProtocolGuid The specified protocol need to be uninstalled.
675 ConPlatformUnInstallProtocol (
676 IN EFI_DRIVER_BINDING_PROTOCOL
*This
,
677 IN EFI_HANDLE Handle
,
678 IN EFI_GUID
*ProtocolGuid
683 Status
= gBS
->OpenProtocol (
687 This
->DriverBindingHandle
,
689 EFI_OPEN_PROTOCOL_TEST_PROTOCOL
692 if (!EFI_ERROR (Status
)) {
693 gBS
->UninstallMultipleProtocolInterfaces (
705 Get the necessary size of buffer and read the variable.
707 First get the necessary size of buffer. Then read the
708 EFI variable (Name) and return a dynamically allocated
709 buffer. On failure return NULL.
711 @param Name String part of EFI variable name
713 @return Dynamically allocated memory that contains a copy of the EFI variable.
714 Caller is repsoncible freeing the buffer. Return NULL means Variable
719 ConPlatformGetVariable (
731 // Test to see if the variable exists. If it doesn't, return NULL.
733 Status
= gRT
->GetVariable (
735 &gEfiGlobalVariableGuid
,
741 if (Status
== EFI_BUFFER_TOO_SMALL
) {
743 // Allocate the buffer to return
745 Buffer
= AllocatePool (BufferSize
);
746 if (Buffer
== NULL
) {
750 // Read variable into the allocated buffer.
752 Status
= gRT
->GetVariable (
754 &gEfiGlobalVariableGuid
,
759 if (EFI_ERROR (Status
)) {
762 // To make sure Buffer is NULL if any error occurs.
772 Function compares a device path data structure to that of all the nodes of a
773 second device path instance.
775 @param Multi A pointer to a multi-instance device path data structure.
776 @param Single A pointer to a single-instance device path data structure.
777 @param NewDevicePath If Delete is TRUE, this parameter must not be null, and it
778 points to the remaining device path data structure.
779 (remaining device path = Multi - Single.)
780 @param Delete If TRUE, means removing Single from Multi.
781 If FALSE, the routine just check whether Single matches
782 with any instance in Multi.
784 @retval EFI_SUCCESS If the Single is contained within Multi.
785 @retval EFI_NOT_FOUND If the Single is not contained within Multi.
786 @retval EFI_INVALID_PARAMETER Multi is NULL.
787 @retval EFI_INVALID_PARAMETER Single is NULL.
788 @retval EFI_INVALID_PARAMETER NewDevicePath is NULL when Delete is TRUE.
792 ConPlatformMatchDevicePaths (
793 IN EFI_DEVICE_PATH_PROTOCOL
*Multi
,
794 IN EFI_DEVICE_PATH_PROTOCOL
*Single
,
795 OUT EFI_DEVICE_PATH_PROTOCOL
**NewDevicePath OPTIONAL
,
799 EFI_DEVICE_PATH_PROTOCOL
*DevicePath
;
800 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath1
;
801 EFI_DEVICE_PATH_PROTOCOL
*TempDevicePath2
;
802 EFI_DEVICE_PATH_PROTOCOL
*DevicePathInst
;
806 // The passed in DevicePath should not be NULL
808 if ((Multi
== NULL
) || (Single
== NULL
)) {
809 return EFI_INVALID_PARAMETER
;
813 // If performing Delete operation, the NewDevicePath must not be NULL.
816 if (NewDevicePath
== NULL
) {
817 return EFI_INVALID_PARAMETER
;
821 TempDevicePath1
= NULL
;
824 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
827 // Search for the match of 'Single' in 'Multi'
829 while (DevicePathInst
!= NULL
) {
830 if (CompareMem (Single
, DevicePathInst
, Size
) == 0) {
833 // If Delete is FALSE, return EFI_SUCCESS if Single is found in Multi.
835 FreePool (DevicePathInst
);
841 // If the node of Multi does not match Single, then added it back to the result.
842 // That is, the node matching Single will be dropped and deleted from result.
844 TempDevicePath2
= AppendDevicePathInstance (
848 if (TempDevicePath1
!= NULL
) {
849 FreePool (TempDevicePath1
);
851 TempDevicePath1
= TempDevicePath2
;
855 FreePool (DevicePathInst
);
856 DevicePathInst
= GetNextDevicePathInstance (&DevicePath
, &Size
);
861 // Return the new device path data structure with specified node deleted.
863 *NewDevicePath
= TempDevicePath1
;
867 return EFI_NOT_FOUND
;
871 Update console environment variables.
873 @param VariableName Console environment variables, ConOutDev, ConInDev
874 ErrOutDev, ConIn ,ConOut or ErrOut.
875 @param DevicePath Console devcie's device path.
876 @param Operation Variable operations, including APPEND, CHECK and DELETE.
878 @retval EFI_SUCCESS Variable operates successfully.
879 @retval EFI_OUT_OF_RESOURCES If variable cannot be appended.
880 @retval other Variable updating failed.
884 ConPlatformUpdateDeviceVariable (
885 IN CHAR16
*VariableName
,
886 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
,
887 IN CONPLATFORM_VAR_OPERATION Operation
891 EFI_DEVICE_PATH_PROTOCOL
*VariableDevicePath
;
892 EFI_DEVICE_PATH_PROTOCOL
*NewVariableDevicePath
;
894 VariableDevicePath
= NULL
;
895 NewVariableDevicePath
= NULL
;
898 // Get Variable according to variable name.
899 // The memory for Variable is allocated within ConPlatformGetVarible(),
900 // it is the caller's responsibility to free the memory before return.
902 VariableDevicePath
= ConPlatformGetVariable (VariableName
);
904 if (Operation
!= Delete
) {
906 // Match specified DevicePath in Console Variable.
908 Status
= ConPlatformMatchDevicePaths (
915 if ((Operation
== Check
) || (!EFI_ERROR (Status
))) {
917 // Branch here includes 2 cases:
918 // 1. Operation is CHECK, simply return Status.
919 // 2. Operation is APPEND, and device path already exists in variable, also return.
921 if (VariableDevicePath
!= NULL
) {
922 FreePool (VariableDevicePath
);
928 // We reach here to append a device path that does not exist in variable.
930 Status
= EFI_SUCCESS
;
931 NewVariableDevicePath
= AppendDevicePathInstance (
935 if (NewVariableDevicePath
== NULL
) {
936 Status
= EFI_OUT_OF_RESOURCES
;
941 // We reach here to remove DevicePath from the environment variable that
942 // is a multi-instance device path.
944 Status
= ConPlatformMatchDevicePaths (
947 &NewVariableDevicePath
,
952 if (VariableDevicePath
!= NULL
) {
953 FreePool (VariableDevicePath
);
956 if (EFI_ERROR (Status
)) {
960 if (NewVariableDevicePath
!= NULL
) {
962 // Update Console Environment Variable.
964 Status
= gRT
->SetVariable (
966 &gEfiGlobalVariableGuid
,
967 EFI_VARIABLE_BOOTSERVICE_ACCESS
| EFI_VARIABLE_RUNTIME_ACCESS
,
968 GetDevicePathSize (NewVariableDevicePath
),
969 NewVariableDevicePath
972 FreePool (NewVariableDevicePath
);
979 Check if the device supports hot-plug through its device path.
981 This function could be updated to check more types of Hot Plug devices.
982 Currently, it checks USB and PCCard device.
984 @param DevicePath Pointer to device's device path.
986 @retval TRUE The devcie is a hot-plug device
987 @retval FALSE The devcie is not a hot-plug device.
992 IN EFI_DEVICE_PATH_PROTOCOL
*DevicePath
995 EFI_DEVICE_PATH_PROTOCOL
*CheckDevicePath
;
997 CheckDevicePath
= DevicePath
;
998 while (!IsDevicePathEnd (CheckDevicePath
)) {
1000 // Check device whether is hot plug device or not throught Device Path
1002 if ((DevicePathType (CheckDevicePath
) == MESSAGING_DEVICE_PATH
) &&
1003 (DevicePathSubType (CheckDevicePath
) == MSG_USB_DP
||
1004 DevicePathSubType (CheckDevicePath
) == MSG_USB_CLASS_DP
||
1005 DevicePathSubType (CheckDevicePath
) == MSG_USB_WWID_DP
)) {
1007 // If Device is USB device
1011 if ((DevicePathType (CheckDevicePath
) == HARDWARE_DEVICE_PATH
) &&
1012 (DevicePathSubType (CheckDevicePath
) == HW_PCCARD_DP
)) {
1014 // If Device is PCCard
1019 CheckDevicePath
= NextDevicePathNode (CheckDevicePath
);