-/**@file\r
+/** @file\r
Console Splitter Driver. Any Handle that attatched\r
EFI_CONSOLE_IDENTIFIER_PROTOCOL can be bound by this driver.\r
\r
The virtual handle are added on driver entry and never removed.\r
Such design ensures sytem function well during none console device situation.\r
\r
-Copyright (c) 2006 - 2007 Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
All rights reserved. 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
(EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL **) NULL,\r
0,\r
{\r
- (struct _LIST_ENTRY *) NULL,\r
- (struct _LIST_ENTRY *) NULL\r
+ (LIST_ENTRY *) NULL,\r
+ (LIST_ENTRY *) NULL\r
},\r
\r
{\r
}\r
\r
\r
+\r
+/**\r
+ Intialize a virtual console device to act as an agrigator of physical console\r
+ devices.\r
+\r
+ @param ImageHandle (Standard EFI Image entry -\r
+ EFI_IMAGE_ENTRY_POINT)\r
+ @param SystemTable (Standard EFI Image entry -\r
+ EFI_IMAGE_ENTRY_POINT)\r
+ EFI_SUCCESS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterDriverEntry (\r
IN EFI_HANDLE ImageHandle,\r
IN EFI_SYSTEM_TABLE *SystemTable\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Intialize a virtual console device to act as an agrigator of physical console\r
- devices.\r
-\r
-Arguments:\r
- ImageHandle - (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
- SystemTable - (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
-Returns:\r
- EFI_SUCCESS\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
-EFI_STATUS\r
-ConSplitterTextInConstructor (\r
- TEXT_IN_SPLITTER_PRIVATE_DATA *ConInPrivate\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
Construct the ConSplitter.\r
\r
-Arguments:\r
+ @param ConInPrivate A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA\r
+ structure.\r
\r
- ConInPrivate - A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA structure.\r
+ @retval EFI_OUT_OF_RESOURCES Out of resources.\r
\r
-Returns:\r
- EFI_OUT_OF_RESOURCES - Out of resources.\r
-\r
---*/\r
+**/\r
+EFI_STATUS\r
+ConSplitterTextInConstructor (\r
+ TEXT_IN_SPLITTER_PRIVATE_DATA *ConInPrivate\r
+ )\r
{\r
EFI_STATUS Status;\r
\r
return Status;\r
}\r
\r
-STATIC\r
+\r
+/**\r
+ Generic Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller Handle.\r
+ @param Guid Guid.\r
+\r
+ @retval EFI_UNSUPPORTED unsupported.\r
+ @retval EFI_SUCCESS operation is OK.\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterSupported (\r
IN EFI_DRIVER_BINDING_PROTOCOL *This,\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_GUID *Guid\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Generic Supported Check\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller Handle.\r
- Guid - Guid.\r
-\r
-Returns:\r
-\r
- EFI_UNSUPPORTED - unsupported.\r
- EFI_SUCCESS - operation is OK.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
VOID *Instance;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Console In Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConInDriverBindingSupported (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Console In Supported Check\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
{\r
return ConSplitterSupported (\r
This,\r
);\r
}\r
\r
+\r
+/**\r
+ Standard Error Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterSimplePointerDriverBindingSupported (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Standard Error Supported Check\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
{\r
return ConSplitterSupported (\r
This,\r
);\r
}\r
\r
+\r
+/**\r
+ Absolute Pointer Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterAbsolutePointerDriverBindingSupported (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Absolute Pointer Supported Check\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
{\r
return ConSplitterSupported (\r
This,\r
);\r
}\r
\r
+\r
+/**\r
+ Console Out Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConOutDriverBindingSupported (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Console Out Supported Check\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
{\r
return ConSplitterSupported (\r
This,\r
);\r
}\r
\r
+\r
+/**\r
+ Standard Error Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterStdErrDriverBindingSupported (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Standard Error Supported Check\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
-\r
---*/\r
{\r
return ConSplitterSupported (\r
This,\r
);\r
}\r
\r
-STATIC\r
+\r
+/**\r
+ Start ConSplitter on ControllerHandle, and create the virtual\r
+ agrogated console device on first call Start for a SimpleTextIn handle.\r
+\r
+ (Standard DriverBinding Protocol Start() function)\r
+\r
+ @return EFI_ERROR if a SimpleTextIn protocol is not started.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterStart (\r
IN EFI_GUID *InterfaceGuid,\r
IN VOID **Interface\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Start ConSplitter on ControllerHandle, and create the virtual\r
- agrogated console device on first call Start for a SimpleTextIn handle.\r
-\r
-Arguments:\r
- (Standard DriverBinding Protocol Start() function)\r
-\r
-Returns:\r
- EFI_ERROR if a SimpleTextIn protocol is not started.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
VOID *Instance;\r
);\r
}\r
\r
+\r
+/**\r
+ Start ConSplitter on ControllerHandle, and create the virtual\r
+ agrogated console device on first call Start for a SimpleTextIn handle.\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+ @return EFI_ERROR if a SimpleTextIn protocol is not started.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConInDriverBindingStart (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Start ConSplitter on ControllerHandle, and create the virtual\r
- agrogated console device on first call Start for a SimpleTextIn handle.\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_STATUS\r
- EFI_ERROR if a SimpleTextIn protocol is not started.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn;\r
return Status;\r
}\r
\r
+\r
+/**\r
+ Start ConSplitter on ControllerHandle, and create the virtual\r
+ agrogated console device on first call Start for a SimpleTextIn handle.\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_ERROR if a SimpleTextIn protocol is not started.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterSimplePointerDriverBindingStart (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Start ConSplitter on ControllerHandle, and create the virtual\r
- agrogated console device on first call Start for a SimpleTextIn handle.\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_ERROR if a SimpleTextIn protocol is not started.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer;\r
return ConSplitterSimplePointerAddDevice (&mConIn, SimplePointer);\r
}\r
\r
+\r
+/**\r
+ Start ConSplitter on ControllerHandle, and create the virtual\r
+ agrogated console device on first call Start for a ConIn handle.\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_ERROR if a AbsolutePointer protocol is not started.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterAbsolutePointerDriverBindingStart (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Start ConSplitter on ControllerHandle, and create the virtual\r
- agrogated console device on first call Start for a ConIn handle.\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
-\r
- EFI_ERROR if a AbsolutePointer protocol is not started.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer;\r
return ConSplitterAbsolutePointerAddDevice (&mConIn, AbsolutePointer);\r
}\r
\r
+\r
+/**\r
+ Start ConSplitter on ControllerHandle, and create the virtual\r
+ agrogated console device on first call Start for a SimpleTextIn handle.\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_ERROR if a SimpleTextIn protocol is not started.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConOutDriverBindingStart (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Start ConSplitter on ControllerHandle, and create the virtual\r
- agrogated console device on first call Start for a SimpleTextIn handle.\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
- EFI_ERROR if a SimpleTextIn protocol is not started.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;\r
return Status;\r
}\r
\r
+\r
+/**\r
+ Start ConSplitter on ControllerHandle, and create the virtual\r
+ agrogated console device on first call Start for a SimpleTextIn handle.\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_ERROR if a SimpleTextIn protocol is not started.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterStdErrDriverBindingStart (\r
IN EFI_HANDLE ControllerHandle,\r
IN EFI_DEVICE_PATH_PROTOCOL *RemainingDevicePath\r
)\r
-/*++\r
-\r
-Routine Description:\r
- Start ConSplitter on ControllerHandle, and create the virtual\r
- agrogated console device on first call Start for a SimpleTextIn handle.\r
-\r
-Arguments:\r
- This - Pointer to protocol.\r
- ControllerHandle - Controller handle.\r
- RemainingDevicePath - Remaining device path.\r
-\r
-Returns:\r
- EFI_ERROR if a SimpleTextIn protocol is not started.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;\r
return Status;\r
}\r
\r
-STATIC\r
+\r
+/**\r
+\r
+ (Standard DriverBinding Protocol Stop() function)\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterStop (\r
IN EFI_GUID *InterfaceGuid,\r
IN VOID **Interface\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
- (Standard DriverBinding Protocol Stop() function)\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+\r
+ (Standard DriverBinding Protocol Stop() function)\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConInDriverBindingStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
- (Standard DriverBinding Protocol Stop() function)\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn;\r
return ConSplitterTextInDeleteDevice (&mConIn, TextIn);\r
}\r
\r
+\r
+/**\r
+\r
+ (Standard DriverBinding Protocol Stop() function)\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterSimplePointerDriverBindingStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
- (Standard DriverBinding Protocol Stop() function)\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer;\r
return ConSplitterSimplePointerDeleteDevice (&mConIn, SimplePointer);\r
}\r
\r
+\r
+/**\r
+\r
+ (Standard DriverBinding Protocol Stop() function)\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterAbsolutePointerDriverBindingStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
- (Standard DriverBinding Protocol Stop() function)\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer;\r
return ConSplitterAbsolutePointerDeleteDevice (&mConIn, AbsolutePointer);\r
}\r
\r
+\r
+/**\r
+\r
+ (Standard DriverBinding Protocol Stop() function)\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConOutDriverBindingStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
- (Standard DriverBinding Protocol Stop() function)\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;\r
return ConSplitterTextOutDeleteDevice (&mConOut, TextOut);\r
}\r
\r
+\r
+/**\r
+\r
+ (Standard DriverBinding Protocol Stop() function)\r
+\r
+ @retval EFI_SUCCESS Complete successfully.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterStdErrDriverBindingStop (\r
IN UINTN NumberOfChildren,\r
IN EFI_HANDLE *ChildHandleBuffer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
- (Standard DriverBinding Protocol Stop() function)\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Complete successfully.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut;\r
return Status;\r
}\r
\r
-EFI_STATUS\r
-ConSplitterGrowBuffer (\r
- IN UINTN SizeOfCount,\r
- IN UINTN *Count,\r
- IN OUT VOID **Buffer\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
Take the passed in Buffer of size SizeOfCount and grow the buffer\r
by MAX (CONSOLE_SPLITTER_CONSOLES_ALLOC_UNIT, MaxGrow) * SizeOfCount\r
bytes. Copy the current data in Buffer to the new version of Buffer\r
and free the old version of buffer.\r
\r
+ @param SizeOfCount Size of element in array\r
+ @param Count Current number of elements in array\r
+ @param Buffer Bigger version of passed in Buffer with all the\r
+ data\r
\r
-Arguments:\r
- SizeOfCount - Size of element in array\r
- Count - Current number of elements in array\r
- Buffer - Bigger version of passed in Buffer with all the data\r
-\r
-Returns:\r
- EFI_SUCCESS - Buffer size has grown\r
- EFI_OUT_OF_RESOURCES - Could not grow the buffer size\r
-\r
- None\r
+ @retval EFI_SUCCESS Buffer size has grown\r
+ @retval EFI_OUT_OF_RESOURCES Could not grow the buffer size\r
+ @return None\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+ConSplitterGrowBuffer (\r
+ IN UINTN SizeOfCount,\r
+ IN UINTN *Count,\r
+ IN OUT VOID **Buffer\r
+ )\r
{\r
UINTN NewSize;\r
UINTN OldSize;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+\r
+\r
+ @return EFI_SUCCESS\r
+ @return EFI_OUT_OF_RESOURCES\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterTextInAddDevice (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS\r
- EFI_OUT_OF_RESOURCES\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+\r
+\r
+ @return EFI_SUCCESS\r
+ @return EFI_NOT_FOUND\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterTextInDeleteDevice (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *TextIn\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS\r
- EFI_NOT_FOUND\r
-\r
---*/\r
{\r
UINTN Index;\r
//\r
return EFI_NOT_FOUND;\r
}\r
\r
+\r
+/**\r
+\r
+\r
+ @return EFI_OUT_OF_RESOURCES\r
+ @return EFI_SUCCESS\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterSimplePointerAddDevice (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- EFI_OUT_OF_RESOURCES\r
- EFI_SUCCESS\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterSimplePointerDeleteDevice (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_SIMPLE_POINTER_PROTOCOL *SimplePointer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
UINTN Index;\r
//\r
return EFI_NOT_FOUND;\r
}\r
\r
+\r
+/**\r
+\r
+\r
+ @return EFI_OUT_OF_RESOURCES\r
+ @return EFI_SUCCESS\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterAbsolutePointerAddDevice (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- EFI_OUT_OF_RESOURCES\r
- EFI_SUCCESS\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterAbsolutePointerDeleteDevice (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *AbsolutePointer\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
UINTN Index;\r
//\r
return EFI_NOT_FOUND;\r
}\r
\r
-STATIC\r
-EFI_STATUS\r
-ConSplitterGrowMapTable (\r
- IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
- )\r
-/*++\r
\r
-Routine Description:\r
-\r
-Arguments:\r
+/**\r
\r
-Returns:\r
\r
- None\r
+ @return None\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+ConSplitterGrowMapTable (\r
+ IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
+ )\r
{\r
UINTN Size;\r
UINTN NewSize;\r
return EFI_SUCCESS;\r
}\r
\r
-STATIC\r
+\r
+/**\r
+\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterAddOutputMode (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
INT32 MaxMode;\r
mode 0 is 80x25, mode 1 is 80x50, this routine will not check the\r
intersection for mode 0 and mode 1.\r
\r
- @parm TextOutModeMap Current text out mode map, begin with the mode 80x25\r
- @parm NewlyAddedMap New text out mode map, begin with the mode 80x25\r
- @parm MapStepSize Mode step size for one console device\r
- @parm NewMapStepSize Mode step size for one console device\r
- @parm MaxMode Current max text mode\r
- @parm CurrentMode Current text mode\r
+ @param TextOutModeMap Current text out mode map, begin with the mode 80x25\r
+ @param NewlyAddedMap New text out mode map, begin with the mode 80x25\r
+ @param MapStepSize Mode step size for one console device\r
+ @param NewMapStepSize Mode step size for one console device\r
+ @param MaxMode Current max text mode\r
+ @param CurrentMode Current text mode\r
\r
@retval None\r
\r
**/\r
-STATIC\r
VOID\r
ConSplitterGetIntersection (\r
IN INT32 *TextOutModeMap,\r
return ;\r
}\r
\r
-STATIC\r
+\r
+/**\r
+\r
+ @param Private Private data structure.\r
+ @param TextOut Text Out Protocol.\r
+\r
+ @return None\r
+\r
+**/\r
VOID\r
ConSplitterSyncOutputMode (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
- Private - Private data structure.\r
- TextOut - Text Out Protocol.\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
INT32 CurrentMaxMode;\r
INT32 Mode;\r
return ;\r
}\r
\r
-STATIC\r
-EFI_STATUS\r
-ConSplitterGetIntersectionBetweenConOutAndStrErr (\r
- VOID\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
-Arguments:\r
+/**\r
\r
-Returns:\r
\r
- EFI_SUCCESS\r
- EFI_OUT_OF_RESOURCES\r
+ @return EFI_SUCCESS\r
+ @return EFI_OUT_OF_RESOURCES\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+ConSplitterGetIntersectionBetweenConOutAndStrErr (\r
+ VOID\r
+ )\r
{\r
UINTN ConOutNumOfConsoles;\r
UINTN StdErrNumOfConsoles;\r
return EFI_SUCCESS;\r
}\r
\r
-STATIC\r
+\r
+/**\r
+\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterAddGraphicsOutputMode (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput,\r
IN EFI_UGA_DRAW_PROTOCOL *UgaDraw\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
UINTN Index;\r
return Status;\r
}\r
\r
-VOID\r
-ConsplitterSetConsoleOutMode (\r
- IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
- )\r
-/*++\r
-\r
-Routine Description:\r
\r
+/**\r
This routine will get the current console mode information (column, row)\r
from ConsoleOutMode variable and set it; if the variable does not exist,\r
set to user defined console mode.\r
\r
-Arguments:\r
-\r
None\r
\r
-Returns:\r
-\r
- None\r
+ @return None\r
\r
---*/\r
+**/\r
+VOID\r
+ConsplitterSetConsoleOutMode (\r
+ IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
+ )\r
{\r
UINTN Col;\r
UINTN Row;\r
ASSERT(ModeInfo != NULL);\r
\r
Status = gRT->GetVariable (\r
- VarConOutMode,\r
+ VARCONOUTMODE,\r
&gEfiGenericPlatformVariableGuid,\r
NULL,\r
&ModeInfoSize,\r
ModeInfo->Column = 80;\r
ModeInfo->Row = 25;\r
Status = gRT->SetVariable (\r
- VarConOutMode,\r
+ VARCONOUTMODE,\r
&gEfiGenericPlatformVariableGuid,\r
EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
sizeof (CONSOLE_OUT_MODE),\r
// Update ConOutMode variable\r
//\r
Status = gRT->SetVariable (\r
- VarConOutMode,\r
+ VARCONOUTMODE,\r
&gEfiGenericPlatformVariableGuid,\r
EFI_VARIABLE_BOOTSERVICE_ACCESS | EFI_VARIABLE_NON_VOLATILE,\r
sizeof (CONSOLE_OUT_MODE),\r
}\r
\r
\r
+\r
+/**\r
+\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterTextOutAddDevice (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_GRAPHICS_OUTPUT_PROTOCOL *GraphicsOutput,\r
IN EFI_UGA_DRAW_PROTOCOL *UgaDraw\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
UINTN CurrentNumOfConsoles;\r
return Status;\r
}\r
\r
+\r
+/**\r
+\r
+\r
+ @return None\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterTextOutDeleteDevice (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *TextOut\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
-Returns:\r
-\r
- None\r
-\r
---*/\r
{\r
INT32 Index;\r
UINTN CurrentNumOfConsoles;\r
//\r
// ConSplitter TextIn member functions\r
//\r
+\r
+/**\r
+ Reset the input device and optionaly run diagnostics\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r
+ not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInReset (\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could\r
- not be reset.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS ReturnStatus;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Key Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The keystroke information was returned.\r
+ @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR The keydtroke information was not returned due\r
+ to hardware errors.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInPrivateReadKeyStroke (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
OUT EFI_INPUT_KEY *Key\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Key - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keydtroke information was not returned due to\r
- hardware errors.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
UINTN Index;\r
return EFI_NOT_READY;\r
}\r
\r
-BOOLEAN\r
-ConSpliterConssoleControlStdInLocked (\r
- VOID\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
Return TRUE if StdIn is locked. The ConIn device on the virtual handle is\r
the only device locked.\r
\r
-Arguments:\r
NONE\r
\r
-Returns:\r
- TRUE - StdIn locked\r
- FALSE - StdIn working normally\r
+ @retval TRUE StdIn locked\r
+ @retval FALSE StdIn working normally\r
\r
---*/\r
+**/\r
+BOOLEAN\r
+ConSpliterConssoleControlStdInLocked (\r
+ VOID\r
+ )\r
{\r
return mConIn.PasswordEnabled;\r
}\r
\r
-VOID\r
-EFIAPI\r
-ConSpliterConsoleControlLockStdInEvent (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
This timer event will fire when StdIn is locked. It will check the key\r
sequence on StdIn to see if it matches the password. Any error in the\r
password will cause the check to reset. As long a mConIn.PasswordEnabled is\r
TRUE the StdIn splitter will not report any input.\r
\r
-Arguments:\r
(Standard EFI_EVENT_NOTIFY)\r
\r
-Returns:\r
- None\r
+ @return None\r
\r
---*/\r
+**/\r
+VOID\r
+EFIAPI\r
+ConSpliterConsoleControlLockStdInEvent (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
{\r
EFI_STATUS Status;\r
EFI_INPUT_KEY Key;\r
mConIn.PwdIndex++;\r
}\r
}\r
- }\r
- } while (!EFI_ERROR (Status));\r
-}\r
-\r
-EFI_STATUS\r
-EFIAPI\r
-ConSpliterConsoleControlLockStdIn (\r
- IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r
- IN CHAR16 *Password\r
- )\r
-/*++\r
+ }\r
+ } while (!EFI_ERROR (Status));\r
+}\r
+\r
\r
-Routine Description:\r
+/**\r
If Password is NULL unlock the password state variable and set the event\r
timer. If the Password is too big return an error. If the Password is valid\r
Copy the Password and enable state variable and then arm the periodic timer\r
\r
-Arguments:\r
\r
-Returns:\r
- EFI_SUCCESS - Lock the StdIn device\r
- EFI_INVALID_PARAMETER - Password is NULL\r
- EFI_OUT_OF_RESOURCES - Buffer allocation to store the password fails\r
+ @retval EFI_SUCCESS Lock the StdIn device\r
+ @retval EFI_INVALID_PARAMETER Password is NULL\r
+ @retval EFI_OUT_OF_RESOURCES Buffer allocation to store the password fails\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+EFIAPI\r
+ConSpliterConsoleControlLockStdIn (\r
+ IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r
+ IN CHAR16 *Password\r
+ )\r
{\r
if (Password == NULL) {\r
return EFI_INVALID_PARAMETER;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+ If the ConIn is password locked make it look like no keystroke is availible\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Key Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The keystroke information was returned.\r
+ @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR The keydtroke information was not returned due\r
+ to hardware errors.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInReadKeyStroke (\r
IN EFI_SIMPLE_TEXT_INPUT_PROTOCOL *This,\r
OUT EFI_INPUT_KEY *Key\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
- If the ConIn is password locked make it look like no keystroke is availible\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Key - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keydtroke information was not returned due to\r
- hardware errors.\r
-\r
---*/\r
{\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
\r
return ConSplitterTextInPrivateReadKeyStroke (Private, Key);\r
}\r
\r
-VOID\r
-EFIAPI\r
-ConSplitterTextInWaitForKey (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
This event agregates all the events of the ConIn devices in the spliter.\r
If the ConIn is password locked then return.\r
If any events of physical ConIn devices are signaled, signal the ConIn\r
spliter event. This will cause the calling code to call\r
ConSplitterTextInReadKeyStroke ().\r
\r
-Arguments:\r
- Event - The Event assoicated with callback.\r
- Context - Context registered when Event was created.\r
+ @param Event The Event assoicated with callback.\r
+ @param Context Context registered when Event was created.\r
\r
-Returns:\r
- None\r
+ @return None\r
\r
---*/\r
+**/\r
+VOID\r
+EFIAPI\r
+ConSplitterTextInWaitForKey (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
{\r
EFI_STATUS Status;\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
}\r
\r
\r
-STATIC\r
+\r
+/**\r
+\r
+ @param RegsiteredData A pointer to a buffer that is filled in with the\r
+ keystroke state data for the key that was\r
+ registered.\r
+ @param InputData A pointer to a buffer that is filled in with the\r
+ keystroke state data for the key that was\r
+ pressed.\r
+\r
+ @retval TRUE Key be pressed matches a registered key.\r
+ @retval FLASE Match failed.\r
+\r
+**/\r
BOOLEAN\r
IsKeyRegistered (\r
IN EFI_KEY_DATA *RegsiteredData,\r
IN EFI_KEY_DATA *InputData\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
-Arguments:\r
-\r
- RegsiteredData - A pointer to a buffer that is filled in with the keystroke\r
- state data for the key that was registered.\r
- InputData - A pointer to a buffer that is filled in with the keystroke\r
- state data for the key that was pressed.\r
-\r
-Returns:\r
- TRUE - Key be pressed matches a registered key.\r
- FLASE - Match failed.\r
-\r
---*/\r
{\r
ASSERT (RegsiteredData != NULL && InputData != NULL);\r
\r
// Simple Text Input Ex protocol functions\r
//\r
\r
+\r
+/**\r
+ Reset the input device and optionaly run diagnostics\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r
+ not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInResetEx (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could\r
- not be reset.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS ReturnStatus;\r
\r
}\r
\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the\r
+ keystroke state data for the key that was\r
+ pressed.\r
+\r
+ @retval EFI_SUCCESS The keystroke information was returned.\r
+ @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR The keystroke information was not returned due\r
+ to hardware errors.\r
+ @retval EFI_INVALID_PARAMETER KeyData is NULL.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInReadKeyStrokeEx (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
OUT EFI_KEY_DATA *KeyData\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke\r
- state data for the key that was pressed.\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to\r
- hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL.\r
-\r
---*/\r
{\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
EFI_STATUS Status;\r
return EFI_NOT_READY;\r
}\r
\r
+\r
+/**\r
+ Set certain state for the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the\r
+ state for the input device.\r
+\r
+ @retval EFI_SUCCESS The device state was set successfully.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning correctly and\r
+ could not have the setting adjusted.\r
+ @retval EFI_UNSUPPORTED The device does not have the ability to set its\r
+ state.\r
+ @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInSetState (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Set certain state for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the\r
- state for the input device.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device state was set successfully.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could\r
- not have the setting adjusted.\r
- EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
- EFI_INVALID_PARAMETER - KeyToggleState is NULL.\r
-\r
---*/\r
{\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
EFI_STATUS Status;\r
\r
}\r
\r
+\r
+/**\r
+ Register a notification function for a particular keystroke for the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the\r
+ keystroke information data for the key that was\r
+ pressed.\r
+ @param KeyNotificationFunction Points to the function to be called when the key\r
+ sequence is typed specified by KeyData.\r
+ @param NotifyHandle Points to the unique handle assigned to the\r
+ registered notification.\r
+\r
+ @retval EFI_SUCCESS The notification function was registered\r
+ successfully.\r
+ @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data\r
+ structures.\r
+ @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInRegisterKeyNotify (\r
IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
OUT EFI_HANDLE *NotifyHandle\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Register a notification function for a particular keystroke for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke\r
- information data for the key that was pressed.\r
- KeyNotificationFunction - Points to the function to be called when the key\r
- sequence is typed specified by KeyData.\r
- NotifyHandle - Points to the unique handle assigned to the registered notification.\r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was registered successfully.\r
- EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
- EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL.\r
-\r
---*/\r
{\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
EFI_STATUS Status;\r
\r
}\r
\r
+\r
+/**\r
+ Remove a registered notification function from a particular keystroke.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param NotificationHandle The handle of the notification function being\r
+ unregistered.\r
+\r
+ @retval EFI_SUCCESS The notification function was unregistered\r
+ successfully.\r
+ @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.\r
+ @retval EFI_NOT_FOUND Can not find the matching entry in database.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInUnregisterKeyNotify (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_HANDLE NotificationHandle\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Remove a registered notification function from a particular keystroke.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- NotificationHandle - The handle of the notification function being unregistered.\r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was unregistered successfully.\r
- EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
- EFI_NOT_FOUND - Can not find the matching entry in database.\r
-\r
---*/\r
{\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
EFI_STATUS Status;\r
\r
}\r
\r
+\r
+/**\r
+ Reset the input device and optionaly run diagnostics\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r
+ not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterSimplePointerReset (\r
IN EFI_SIMPLE_POINTER_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could\r
- not be reset.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS ReturnStatus;\r
return ReturnStatus;\r
}\r
\r
-STATIC\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+\r
+ @param This Protocol instance pointer. State -\r
+\r
+ @retval EFI_SUCCESS The keystroke information was returned.\r
+ @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR The keydtroke information was not returned due\r
+ to hardware errors.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterSimplePointerPrivateGetState (\r
IN TEXT_IN_SPLITTER_PRIVATE_DATA *Private,\r
IN OUT EFI_SIMPLE_POINTER_STATE *State\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- State -\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keydtroke information was not returned due to\r
- hardware errors.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS ReturnStatus;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
+ If the ConIn is password locked make it look like no keystroke is availible\r
+\r
+ @param This Protocol instance pointer. State -\r
+\r
+ @retval EFI_SUCCESS The keystroke information was returned.\r
+ @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR The keydtroke information was not returned due\r
+ to hardware errors.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterSimplePointerGetState (\r
IN EFI_SIMPLE_POINTER_PROTOCOL *This,\r
IN OUT EFI_SIMPLE_POINTER_STATE *State\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
- If the ConIn is password locked make it look like no keystroke is availible\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- State -\r
-\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keydtroke information was not returned due to\r
- hardware errors.\r
-\r
---*/\r
{\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
\r
return ConSplitterSimplePointerPrivateGetState (Private, State);\r
}\r
\r
-VOID\r
-EFIAPI\r
-ConSplitterSimplePointerWaitForInput (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
This event agregates all the events of the ConIn devices in the spliter.\r
If the ConIn is password locked then return.\r
If any events of physical ConIn devices are signaled, signal the ConIn\r
spliter event. This will cause the calling code to call\r
ConSplitterTextInReadKeyStroke ().\r
\r
-Arguments:\r
- Event - The Event assoicated with callback.\r
- Context - Context registered when Event was created.\r
+ @param Event The Event assoicated with callback.\r
+ @param Context Context registered when Event was created.\r
\r
-Returns:\r
- None\r
+ @return None\r
\r
---*/\r
+**/\r
+VOID\r
+EFIAPI\r
+ConSplitterSimplePointerWaitForInput (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
{\r
EFI_STATUS Status;\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
// Absolute Pointer Protocol functions\r
//\r
\r
+\r
+/**\r
+ Resets the pointer device hardware.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning correctly and\r
+ could not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterAbsolutePointerReset (\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Resets the pointer device hardware.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could\r
- not be reset.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS ReturnStatus;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Retrieves the current state of a pointer device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param State A pointer to the state information on the\r
+ pointer device.\r
+\r
+ @retval EFI_SUCCESS The state of the pointer device was returned in\r
+ State..\r
+ @retval EFI_NOT_READY The state of the pointer device has not changed\r
+ since the last call to GetState().\r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to\r
+ retrieve the pointer device's current state.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterAbsolutePointerGetState (\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
IN OUT EFI_ABSOLUTE_POINTER_STATE *State\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Retrieves the current state of a pointer device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- State - A pointer to the state information on the pointer device.\r
-\r
- Returns:\r
- EFI_SUCCESS - The state of the pointer device was returned in State..\r
- EFI_NOT_READY - The state of the pointer device has not changed since the last call to\r
- GetState().\r
- EFI_DEVICE_ERROR - A device error occurred while attempting to retrieve the pointer\r
- device's current state.\r
---*/\r
{\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
EFI_STATUS Status;\r
return ReturnStatus;\r
}\r
\r
-VOID\r
-EFIAPI\r
-ConSplitterAbsolutePointerWaitForInput (\r
- IN EFI_EVENT Event,\r
- IN VOID *Context\r
- )\r
-/*++\r
\r
-Routine Description:\r
+/**\r
This event agregates all the events of the pointer devices in the splitter.\r
If the ConIn is password locked then return.\r
If any events of physical pointer devices are signaled, signal the pointer\r
splitter event. This will cause the calling code to call\r
ConSplitterAbsolutePointerGetState ().\r
\r
-Arguments:\r
- Event - The Event assoicated with callback.\r
- Context - Context registered when Event was created.\r
+ @param Event The Event assoicated with callback.\r
+ @param Context Context registered when Event was created.\r
\r
-Returns:\r
- None\r
+ @return None\r
\r
---*/\r
+**/\r
+VOID\r
+EFIAPI\r
+ConSplitterAbsolutePointerWaitForInput (\r
+ IN EFI_EVENT Event,\r
+ IN VOID *Context\r
+ )\r
{\r
EFI_STATUS Status;\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private;\r
}\r
}\r
\r
+\r
+/**\r
+ Reset the text output device hardware and optionaly run diagnostics\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform more exhaustive verfication\r
+ operation of the device during reset.\r
+\r
+ @retval EFI_SUCCESS The text output device was reset.\r
+ @retval EFI_DEVICE_ERROR The text output device is not functioning\r
+ correctly and could not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutReset (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Reset the text output device hardware and optionaly run diagnostics\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform more exhaustive verfication\r
- operation of the device during reset.\r
-\r
- Returns:\r
- EFI_SUCCESS - The text output device was reset.\r
- EFI_DEVICE_ERROR - The text output device is not functioning correctly and\r
- could not be reset.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Write a Unicode string to the output device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param String The NULL-terminated Unicode string to be\r
+ displayed on the output device(s). All output\r
+ devices must also support the Unicode drawing\r
+ defined in this file.\r
+\r
+ @retval EFI_SUCCESS The string was output to the device.\r
+ @retval EFI_DEVICE_ERROR The device reported an error while attempting to\r
+ output the text.\r
+ @retval EFI_UNSUPPORTED The output device's mode is not currently in a\r
+ defined text mode.\r
+ @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the\r
+ characters in the Unicode string could not be\r
+ rendered and were skipped.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutOutputString (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN CHAR16 *WString\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Write a Unicode string to the output device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- String - The NULL-terminated Unicode string to be displayed on the output\r
- device(s). All output devices must also support the Unicode\r
- drawing defined in this file.\r
-\r
- Returns:\r
- EFI_SUCCESS - The string was output to the device.\r
- EFI_DEVICE_ERROR - The device reported an error while attempting to output\r
- the text.\r
- EFI_UNSUPPORTED - The output device's mode is not currently in a\r
- defined text mode.\r
- EFI_WARN_UNKNOWN_GLYPH - This warning code indicates that some of the\r
- characters in the Unicode string could not be\r
- rendered and were skipped.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
Private = TEXT_OUT_SPLITTER_PRIVATE_DATA_FROM_THIS (This);\r
\r
BackSpaceCount = 0;\r
- for (TargetString = WString; *TargetString; TargetString++) {\r
+ for (TargetString = WString; *TargetString != L'\0'; TargetString++) {\r
if (*TargetString == CHAR_BACKSPACE) {\r
BackSpaceCount++;\r
}\r
}\r
}\r
\r
- if (BackSpaceCount) {\r
+ if (BackSpaceCount > 0) {\r
FreePool (TargetString);\r
}\r
\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Verifies that all characters in a Unicode string can be output to the\r
+ target device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param String The NULL-terminated Unicode string to be\r
+ examined for the output device(s).\r
+\r
+ @retval EFI_SUCCESS The device(s) are capable of rendering the\r
+ output string.\r
+ @retval EFI_UNSUPPORTED Some of the characters in the Unicode string\r
+ cannot be rendered by one or more of the output\r
+ devices mapped by the EFI handle.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutTestString (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN CHAR16 *WString\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Verifies that all characters in a Unicode string can be output to the\r
- target device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- String - The NULL-terminated Unicode string to be examined for the output\r
- device(s).\r
-\r
- Returns:\r
- EFI_SUCCESS - The device(s) are capable of rendering the output string.\r
- EFI_UNSUPPORTED - Some of the characters in the Unicode string cannot be\r
- rendered by one or more of the output devices mapped\r
- by the EFI handle.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Returns information for an available text mode that the output device(s)\r
+ supports.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ModeNumber The mode number to return information on.\r
+ @param Rows Returns the geometry of the text output device\r
+ for the requested ModeNumber.\r
+\r
+ @retval EFI_SUCCESS The requested mode information was returned.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The mode number was not valid.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutQueryMode (\r
OUT UINTN *Columns,\r
OUT UINTN *Rows\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Returns information for an available text mode that the output device(s)\r
- supports.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ModeNumber - The mode number to return information on.\r
- Columns, Rows - Returns the geometry of the text output device for the\r
- requested ModeNumber.\r
-\r
- Returns:\r
- EFI_SUCCESS - The requested mode information was returned.\r
- EFI_DEVICE_ERROR - The device had an error and could not\r
- complete the request.\r
- EFI_UNSUPPORTED - The mode number was not valid.\r
-\r
---*/\r
{\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
UINTN CurrentMode;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Sets the output device(s) to a specified mode.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ModeNumber The mode number to set.\r
+\r
+ @retval EFI_SUCCESS The requested text mode was set.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The mode number was not valid.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutSetMode (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN UINTN ModeNumber\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Sets the output device(s) to a specified mode.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ModeNumber - The mode number to set.\r
-\r
- Returns:\r
- EFI_SUCCESS - The requested text mode was set.\r
- EFI_DEVICE_ERROR - The device had an error and\r
- could not complete the request.\r
- EFI_UNSUPPORTED - The mode number was not valid.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Sets the background and foreground colors for the OutputString () and\r
+ ClearScreen () functions.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Attribute The attribute to set. Bits 0..3 are the\r
+ foreground color, and bits 4..6 are the\r
+ background color. All other bits are undefined\r
+ and must be zero. The valid Attributes are\r
+ defined in this file.\r
+\r
+ @retval EFI_SUCCESS The attribute was set.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The attribute requested is not defined.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutSetAttribute (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN UINTN Attribute\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Sets the background and foreground colors for the OutputString () and\r
- ClearScreen () functions.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Attribute - The attribute to set. Bits 0..3 are the foreground color, and\r
- bits 4..6 are the background color. All other bits are undefined\r
- and must be zero. The valid Attributes are defined in this file.\r
-\r
- Returns:\r
- EFI_SUCCESS - The attribute was set.\r
- EFI_DEVICE_ERROR - The device had an error and\r
- could not complete the request.\r
- EFI_UNSUPPORTED - The attribute requested is not defined.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Clears the output device(s) display to the currently selected background\r
+ color.\r
+\r
+ @param This Protocol instance pointer.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The output device is not in a valid text mode.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutClearScreen (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Clears the output device(s) display to the currently selected background\r
- color.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
-\r
- Returns:\r
- EFI_SUCCESS - The operation completed successfully.\r
- EFI_DEVICE_ERROR - The device had an error and\r
- could not complete the request.\r
- EFI_UNSUPPORTED - The output device is not in a valid text mode.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Sets the current coordinates of the cursor position\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Row the position to set the cursor to. Must be\r
+ greater than or equal to zero and less than the\r
+ number of columns and rows by QueryMode ().\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The output device is not in a valid text mode,\r
+ or the cursor position is invalid for the\r
+ current mode.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutSetCursorPosition (\r
IN UINTN Column,\r
IN UINTN Row\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Sets the current coordinates of the cursor position\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Column, Row - the position to set the cursor to. Must be greater than or\r
- equal to zero and less than the number of columns and rows\r
- by QueryMode ().\r
-\r
- Returns:\r
- EFI_SUCCESS - The operation completed successfully.\r
- EFI_DEVICE_ERROR - The device had an error and\r
- could not complete the request.\r
- EFI_UNSUPPORTED - The output device is not in a valid text mode, or the\r
- cursor position is invalid for the current mode.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
return ReturnStatus;\r
}\r
\r
+\r
+/**\r
+ Makes the cursor visible or invisible\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Visible If TRUE, the cursor is set to be visible. If\r
+ FALSE, the cursor is set to be invisible.\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request, or the device does not support\r
+ changing the cursor mode.\r
+ @retval EFI_UNSUPPORTED The output device is not in a valid text mode.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextOutEnableCursor (\r
IN EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *This,\r
IN BOOLEAN Visible\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Makes the cursor visible or invisible\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Visible - If TRUE, the cursor is set to be visible. If FALSE, the cursor is\r
- set to be invisible.\r
-\r
- Returns:\r
- EFI_SUCCESS - The operation completed successfully.\r
- EFI_DEVICE_ERROR - The device had an error and could not complete the\r
- request, or the device does not support changing\r
- the cursor mode.\r
- EFI_UNSUPPORTED - The output device is not in a valid text mode.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
-/**@file\r
+/** @file\r
Private data structures for the Console Splitter driver\r
\r
-Copyright (c) 2006 - 2007 Intel Corporation. <BR>\r
+Copyright (c) 2006 - 2008 Intel Corporation. <BR>\r
All rights reserved. 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
#define CONSOLE_SPLITTER_MODES_ALLOC_UNIT 32\r
#define MAX_STD_IN_PASSWORD 80\r
\r
-#define VarConOutMode L"ConOutMode"\r
+#define VARCONOUTMODE L"ConOutMode"\r
\r
typedef struct {\r
UINTN Column;\r
)\r
;\r
\r
+/**\r
+ Construct the ConSplitter.\r
+\r
+ @param ConInPrivate A pointer to the TEXT_IN_SPLITTER_PRIVATE_DATA\r
+ structure.\r
+\r
+ @retval EFI_OUT_OF_RESOURCES Out of resources.\r
+\r
+**/\r
EFI_STATUS\r
ConSplitterTextInConstructor (\r
TEXT_IN_SPLITTER_PRIVATE_DATA *Private\r
//\r
// Driver Binding Functions\r
//\r
+\r
+/**\r
+ Console In Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConInDriverBindingSupported (\r
)\r
;\r
\r
+/**\r
+ Standard Error Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterSimplePointerDriverBindingSupported (\r
)\r
;\r
\r
+/**\r
+ Console Out Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterConOutDriverBindingSupported (\r
)\r
;\r
\r
+/**\r
+ Standard Error Supported Check\r
+\r
+ @param This Pointer to protocol.\r
+ @param ControllerHandle Controller handle.\r
+ @param RemainingDevicePath Remaining device path.\r
+\r
+ @return EFI_STATUS\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterStdErrDriverBindingSupported (\r
// Absolute Pointer protocol interfaces\r
//\r
\r
+\r
+/**\r
+ Resets the pointer device hardware.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning correctly and\r
+ could not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterAbsolutePointerReset (\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Resets the pointer device hardware.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
+/**\r
+ Retrieves the current state of a pointer device.\r
\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could\r
- not be reset.\r
+ @param This Protocol instance pointer.\r
+ @param State A pointer to the state information on the\r
+ pointer device.\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS The state of the pointer device was returned in\r
+ State..\r
+ @retval EFI_NOT_READY The state of the pointer device has not changed\r
+ since the last call to GetState().\r
+ @retval EFI_DEVICE_ERROR A device error occurred while attempting to\r
+ retrieve the pointer device's current state.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterAbsolutePointerGetState (\r
IN EFI_ABSOLUTE_POINTER_PROTOCOL *This,\r
IN OUT EFI_ABSOLUTE_POINTER_STATE *State\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Retrieves the current state of a pointer device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- State - A pointer to the state information on the pointer device.\r
-\r
- Returns:\r
- EFI_SUCCESS - The state of the pointer device was returned in State..\r
- EFI_NOT_READY - The state of the pointer device has not changed since the last call to\r
- GetState().\r
- EFI_DEVICE_ERROR - A device error occurred while attempting to retrieve the pointer\r
- device's current state.\r
---*/\r
;\r
\r
VOID\r
// Simple Text Input Ex protocol function prototypes\r
//\r
\r
+\r
+/**\r
+ Reset the input device and optionaly run diagnostics\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ExtendedVerification Driver may perform diagnostics on reset.\r
+\r
+ @retval EFI_SUCCESS The device was reset.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning properly and could\r
+ not be reset.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInResetEx (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN BOOLEAN ExtendedVerification\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Reset the input device and optionaly run diagnostics\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ExtendedVerification - Driver may perform diagnostics on reset.\r
+/**\r
+ Reads the next keystroke from the input device. The WaitForKey Event can\r
+ be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- Returns:\r
- EFI_SUCCESS - The device was reset.\r
- EFI_DEVICE_ERROR - The device is not functioning properly and could\r
- not be reset.\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the\r
+ keystroke state data for the key that was\r
+ pressed.\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS The keystroke information was returned.\r
+ @retval EFI_NOT_READY There was no keystroke data availiable.\r
+ @retval EFI_DEVICE_ERROR The keystroke information was not returned due\r
+ to hardware errors.\r
+ @retval EFI_INVALID_PARAMETER KeyData is NULL.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInReadKeyStrokeEx (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
OUT EFI_KEY_DATA *KeyData\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Reads the next keystroke from the input device. The WaitForKey Event can\r
- be used to test for existance of a keystroke via WaitForEvent () call.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke\r
- state data for the key that was pressed.\r
+/**\r
+ Set certain state for the input device.\r
\r
- Returns:\r
- EFI_SUCCESS - The keystroke information was returned.\r
- EFI_NOT_READY - There was no keystroke data availiable.\r
- EFI_DEVICE_ERROR - The keystroke information was not returned due to\r
- hardware errors.\r
- EFI_INVALID_PARAMETER - KeyData is NULL.\r
+ @param This Protocol instance pointer.\r
+ @param KeyToggleState A pointer to the EFI_KEY_TOGGLE_STATE to set the\r
+ state for the input device.\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS The device state was set successfully.\r
+ @retval EFI_DEVICE_ERROR The device is not functioning correctly and\r
+ could not have the setting adjusted.\r
+ @retval EFI_UNSUPPORTED The device does not have the ability to set its\r
+ state.\r
+ @retval EFI_INVALID_PARAMETER KeyToggleState is NULL.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInSetState (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_KEY_TOGGLE_STATE *KeyToggleState\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Set certain state for the input device.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyToggleState - A pointer to the EFI_KEY_TOGGLE_STATE to set the\r
- state for the input device.\r
+;\r
\r
- Returns:\r
- EFI_SUCCESS - The device state was set successfully.\r
- EFI_DEVICE_ERROR - The device is not functioning correctly and could\r
- not have the setting adjusted.\r
- EFI_UNSUPPORTED - The device does not have the ability to set its state.\r
- EFI_INVALID_PARAMETER - KeyToggleState is NULL.\r
\r
---*/\r
-;\r
+/**\r
+ Register a notification function for a particular keystroke for the input device.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param KeyData A pointer to a buffer that is filled in with the\r
+ keystroke information data for the key that was\r
+ pressed.\r
+ @param KeyNotificationFunction Points to the function to be called when the key\r
+ sequence is typed specified by KeyData.\r
+ @param NotifyHandle Points to the unique handle assigned to the\r
+ registered notification.\r
+\r
+ @retval EFI_SUCCESS The notification function was registered\r
+ successfully.\r
+ @retval EFI_OUT_OF_RESOURCES Unable to allocate resources for necesssary data\r
+ structures.\r
+ @retval EFI_INVALID_PARAMETER KeyData or NotifyHandle is NULL.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInRegisterKeyNotify (\r
IN EFI_KEY_NOTIFY_FUNCTION KeyNotificationFunction,\r
OUT EFI_HANDLE *NotifyHandle\r
)\r
-/*++\r
+;\r
\r
- Routine Description:\r
- Register a notification function for a particular keystroke for the input device.\r
\r
- Arguments:\r
- This - Protocol instance pointer.\r
- KeyData - A pointer to a buffer that is filled in with the keystroke\r
- information data for the key that was pressed.\r
- KeyNotificationFunction - Points to the function to be called when the key\r
- sequence is typed specified by KeyData.\r
- NotifyHandle - Points to the unique handle assigned to the registered notification.\r
+/**\r
+ Remove a registered notification function from a particular keystroke.\r
\r
- Returns:\r
- EFI_SUCCESS - The notification function was registered successfully.\r
- EFI_OUT_OF_RESOURCES - Unable to allocate resources for necesssary data structures.\r
- EFI_INVALID_PARAMETER - KeyData or NotifyHandle is NULL.\r
+ @param This Protocol instance pointer.\r
+ @param NotificationHandle The handle of the notification function being\r
+ unregistered.\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS The notification function was unregistered\r
+ successfully.\r
+ @retval EFI_INVALID_PARAMETER The NotificationHandle is invalid.\r
+ @retval EFI_NOT_FOUND Can not find the matching entry in database.\r
\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSplitterTextInUnregisterKeyNotify (\r
IN EFI_SIMPLE_TEXT_INPUT_EX_PROTOCOL *This,\r
IN EFI_HANDLE NotificationHandle\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Remove a registered notification function from a particular keystroke.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- NotificationHandle - The handle of the notification function being unregistered.\r
-\r
- Returns:\r
- EFI_SUCCESS - The notification function was unregistered successfully.\r
- EFI_INVALID_PARAMETER - The NotificationHandle is invalid.\r
- EFI_NOT_FOUND - Can not find the matching entry in database.\r
-\r
---*/\r
;\r
VOID\r
EFIAPI\r
)\r
;\r
\r
+/**\r
+ This event agregates all the events of the ConIn devices in the spliter.\r
+ If the ConIn is password locked then return.\r
+ If any events of physical ConIn devices are signaled, signal the ConIn\r
+ spliter event. This will cause the calling code to call\r
+ ConSplitterTextInReadKeyStroke ().\r
+\r
+ @param Event The Event assoicated with callback.\r
+ @param Context Context registered when Event was created.\r
+\r
+ @return None\r
+\r
+**/\r
VOID\r
EFIAPI\r
ConSplitterSimplePointerWaitForInput (\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
\r
#include "ConSplitter.h"\r
\r
\r
-static CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL };\r
+STATIC CHAR16 mCrLfString[3] = { CHAR_CARRIAGE_RETURN, CHAR_LINEFEED, CHAR_NULL };\r
+\r
+\r
+/**\r
+ Return the current video mode information. Also returns info about existence\r
+ of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the\r
+ arguments are optional and only returned if a non NULL pointer is passed in.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Mode Are we in text of grahics mode.\r
+ @param GopExists TRUE if GOP Spliter has found a GOP/UGA device\r
+ @param StdInLocked TRUE if StdIn device is keyboard locked\r
\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameters.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterConsoleControlGetMode (\r
OUT BOOLEAN *GopExists,\r
OUT BOOLEAN *StdInLocked\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Return the current video mode information. Also returns info about existence\r
- of Graphics Output devices or UGA Draw devices in system, and if the Std In device is locked. All the\r
- arguments are optional and only returned if a non NULL pointer is passed in.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Mode - Are we in text of grahics mode.\r
- GopExists - TRUE if GOP Spliter has found a GOP/UGA device\r
- StdInLocked - TRUE if StdIn device is keyboard locked\r
-\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
- EFI_INVALID_PARAMETER - Invalid parameters.\r
-\r
---*/\r
{\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
UINTN Index;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Set the current mode to either text or graphics. Graphics is\r
+ for Quiet Boot.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param Mode Mode to set the\r
+\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_INVALID_PARAMETER Invalid parameter.\r
+ @retval EFI_UNSUPPORTED Operation unsupported.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterConsoleControlSetMode (\r
IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r
IN EFI_CONSOLE_CONTROL_SCREEN_MODE Mode\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Set the current mode to either text or graphics. Graphics is\r
- for Quiet Boot.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- Mode - Mode to set the\r
-\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
- EFI_INVALID_PARAMETER - Invalid parameter.\r
- EFI_UNSUPPORTED - Operation unsupported.\r
-\r
---*/\r
{\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
UINTN Index;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Return the current video mode information.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ModeNumber The mode number to return information on.\r
+ @param SizeOfInfo A pointer to the size, in bytes, of the Info\r
+ buffer.\r
+ @param Info Caller allocated buffer that returns information\r
+ about ModeNumber.\r
+\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.\r
+ @retval EFI_DEVICE_ERROR A hardware error occurred trying to retrieve the\r
+ video mode.\r
+ @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
+ @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterGraphicsOutputQueryMode (\r
OUT UINTN *SizeOfInfo,\r
OUT EFI_GRAPHICS_OUTPUT_MODE_INFORMATION **Info\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Return the current video mode information.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ModeNumber - The mode number to return information on.\r
- Info - Caller allocated buffer that returns information about ModeNumber.\r
- SizeOfInfo - A pointer to the size, in bytes, of the Info buffer.\r
-\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
- EFI_BUFFER_TOO_SMALL - The Info buffer was too small.\r
- EFI_DEVICE_ERROR - A hardware error occurred trying to retrieve the video mode.\r
- EFI_NOT_STARTED - Video display is not initialized. Call SetMode ()\r
- EFI_INVALID_PARAMETER - One of the input args was NULL.\r
-\r
---*/\r
{\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Graphics output protocol interface to set video mode\r
+\r
+ @param This Protocol instance pointer.\r
+ @param ModeNumber The mode number to be set.\r
+\r
+ @retval EFI_SUCCESS Graphics mode was changed.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED ModeNumber is not supported by this device.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterGraphicsOutputSetMode (\r
IN EFI_GRAPHICS_OUTPUT_PROTOCOL * This,\r
IN UINT32 ModeNumber\r
)\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Graphics output protocol interface to set video mode\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- ModeNumber - The mode number to be set.\r
-\r
- Returns:\r
- EFI_SUCCESS - Graphics mode was changed.\r
- EFI_DEVICE_ERROR - The device had an error and could not complete the request.\r
- EFI_UNSUPPORTED - ModeNumber is not supported by this device.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
return ReturnStatus;\r
}\r
\r
-STATIC\r
EFI_STATUS\r
DevNullGraphicsOutputBlt (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
\r
BltPtr = (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *) ((UINT8 *) BltBuffer + DestinationY * Delta + DestinationX * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
ScreenPtr = &Private->GraphicsOutputBlt[SourceY * HorizontalResolution + SourceX];\r
- while (Height) {\r
+ while (Height > 0) {\r
CopyMem (BltPtr, ScreenPtr, Width * sizeof (EFI_GRAPHICS_OUTPUT_BLT_PIXEL));\r
BltPtr = (EFI_GRAPHICS_OUTPUT_BLT_PIXEL *) ((UINT8 *) BltPtr + Delta);\r
ScreenPtr += HorizontalResolution;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ The following table defines actions for BltOperations.\r
+\r
+ EfiBltVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)\r
+ directly to every pixel of the video display rectangle\r
+ (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
+ EfiBltVideoToBltBuffer - Read data from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
+ the BltBuffer rectangle (DestinationX, DestinationY )\r
+ (DestinationX + Width, DestinationY + Height). If DestinationX or\r
+ DestinationY is not zero then Delta must be set to the length in bytes\r
+ of a row in the BltBuffer.\r
+ EfiBltBufferToVideo - Write data from the BltBuffer rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
+ video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
+ not zero then Delta must be set to the length in bytes of a row in the\r
+ BltBuffer.\r
+ EfiBltVideoToVideo - Copy from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
+ to the video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ The BltBuffer and Delta are not used in this mode.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param BltBuffer Buffer containing data to blit into video buffer.\r
+ This buffer has a size of\r
+ Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
+ @param BltOperation Operation to perform on BlitBuffer and video\r
+ memory\r
+ @param SourceX X coordinate of source for the BltBuffer.\r
+ @param SourceY Y coordinate of source for the BltBuffer.\r
+ @param DestinationX X coordinate of destination for the BltBuffer.\r
+ @param DestinationY Y coordinate of destination for the BltBuffer.\r
+ @param Width Width of rectangle in BltBuffer in pixels.\r
+ @param Height Hight of rectangle in BltBuffer in pixels. Delta\r
+ -\r
+\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video\r
+ buffer.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterGraphicsOutputBlt (\r
IN UINTN Height,\r
IN UINTN Delta OPTIONAL\r
)\r
-/*++\r
-\r
- Routine Description:\r
- The following table defines actions for BltOperations:\r
- EfiBltVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)\r
- directly to every pixel of the video display rectangle\r
- (DestinationX, DestinationY)\r
- (DestinationX + Width, DestinationY + Height).\r
- Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
- EfiBltVideoToBltBuffer - Read data from the video display rectangle\r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
- the BltBuffer rectangle (DestinationX, DestinationY )\r
- (DestinationX + Width, DestinationY + Height). If DestinationX or\r
- DestinationY is not zero then Delta must be set to the length in bytes\r
- of a row in the BltBuffer.\r
- EfiBltBufferToVideo - Write data from the BltBuffer rectangle\r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
- video display rectangle (DestinationX, DestinationY)\r
- (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
- not zero then Delta must be set to the length in bytes of a row in the\r
- BltBuffer.\r
- EfiBltVideoToVideo - Copy from the video display rectangle\r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
- to the video display rectangle (DestinationX, DestinationY)\r
- (DestinationX + Width, DestinationY + Height).\r
- The BltBuffer and Delta are not used in this mode.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- BltBuffer - Buffer containing data to blit into video buffer. This\r
- buffer has a size of Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL)\r
- BltOperation - Operation to perform on BlitBuffer and video memory\r
- SourceX - X coordinate of source for the BltBuffer.\r
- SourceY - Y coordinate of source for the BltBuffer.\r
- DestinationX - X coordinate of destination for the BltBuffer.\r
- DestinationY - Y coordinate of destination for the BltBuffer.\r
- Width - Width of rectangle in BltBuffer in pixels.\r
- Height - Hight of rectangle in BltBuffer in pixels.\r
- Delta -\r
-\r
- Returns:\r
- EFI_SUCCESS - The Blt operation completed.\r
- EFI_INVALID_PARAMETER - BltOperation is not valid.\r
- EFI_DEVICE_ERROR - A hardware error occured writting to the video\r
- buffer.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
}\r
}\r
\r
+\r
+/**\r
+ Return the current video mode information.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param HorizontalResolution Current video horizontal resolution in pixels\r
+ @param VerticalResolution Current video vertical resolution in pixels\r
+ @param ColorDepth Current video color depth in bits per pixel\r
+ @param RefreshRate Current video refresh rate in Hz.\r
+\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
+ @retval EFI_INVALID_PARAMETER One of the input args was NULL.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterUgaDrawGetMode (\r
OUT UINT32 *ColorDepth,\r
OUT UINT32 *RefreshRate\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Return the current video mode information.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- HorizontalResolution - Current video horizontal resolution in pixels\r
- VerticalResolution - Current video vertical resolution in pixels\r
- ColorDepth - Current video color depth in bits per pixel\r
- RefreshRate - Current video refresh rate in Hz.\r
-\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
- EFI_NOT_STARTED - Video display is not initialized. Call SetMode ()\r
- EFI_INVALID_PARAMETER - One of the input args was NULL.\r
-\r
---*/\r
{\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
\r
- if (!(HorizontalResolution && VerticalResolution && RefreshRate && ColorDepth)) {\r
+ if ((HorizontalResolution == NULL) ||\r
+ (VerticalResolution == NULL) ||\r
+ (RefreshRate == NULL) ||\r
+ (ColorDepth == NULL)) {\r
return EFI_INVALID_PARAMETER;\r
}\r
//\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Return the current video mode information.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param HorizontalResolution Current video horizontal resolution in pixels\r
+ @param VerticalResolution Current video vertical resolution in pixels\r
+ @param ColorDepth Current video color depth in bits per pixel\r
+ @param RefreshRate Current video refresh rate in Hz.\r
+\r
+ @retval EFI_SUCCESS Mode information returned.\r
+ @retval EFI_NOT_STARTED Video display is not initialized. Call SetMode ()\r
+ @retval EFI_OUT_OF_RESOURCES Out of resources.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterUgaDrawSetMode (\r
IN UINT32 ColorDepth,\r
IN UINT32 RefreshRate\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Return the current video mode information.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- HorizontalResolution - Current video horizontal resolution in pixels\r
- VerticalResolution - Current video vertical resolution in pixels\r
- ColorDepth - Current video color depth in bits per pixel\r
- RefreshRate - Current video refresh rate in Hz.\r
-\r
- Returns:\r
- EFI_SUCCESS - Mode information returned.\r
- EFI_NOT_STARTED - Video display is not initialized. Call SetMode ()\r
- EFI_OUT_OF_RESOURCES - Out of resources.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
\r
BltPtr = (EFI_UGA_PIXEL *) ((UINT8 *) BltBuffer + DestinationY * Delta + DestinationX * sizeof (EFI_UGA_PIXEL));\r
ScreenPtr = &Private->UgaBlt[SourceY * HorizontalResolution + SourceX];\r
- while (Height) {\r
+ while (Height > 0) {\r
CopyMem (BltPtr, ScreenPtr, Width * sizeof (EFI_UGA_PIXEL));\r
BltPtr = (EFI_UGA_PIXEL *) ((UINT8 *) BltPtr + Delta);\r
ScreenPtr += HorizontalResolution;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ The following table defines actions for BltOperations.\r
+\r
+ EfiUgaVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)\r
+ directly to every pixel of the video display rectangle\r
+ (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
+ EfiUgaVideoToBltBuffer - Read data from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
+ the BltBuffer rectangle (DestinationX, DestinationY )\r
+ (DestinationX + Width, DestinationY + Height). If DestinationX or\r
+ DestinationY is not zero then Delta must be set to the length in bytes\r
+ of a row in the BltBuffer.\r
+ EfiUgaBltBufferToVideo - Write data from the BltBuffer rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
+ video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
+ not zero then Delta must be set to the length in bytes of a row in the\r
+ BltBuffer.\r
+ EfiUgaVideoToVideo - Copy from the video display rectangle\r
+ (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
+ to the video display rectangle (DestinationX, DestinationY)\r
+ (DestinationX + Width, DestinationY + Height).\r
+ The BltBuffer and Delta are not used in this mode.\r
+\r
+ @param This Protocol instance pointer.\r
+ @param BltBuffer Buffer containing data to blit into video buffer.\r
+ This buffer has a size of\r
+ Width*Height*sizeof(EFI_UGA_PIXEL)\r
+ @param BltOperation Operation to perform on BlitBuffer and video\r
+ memory\r
+ @param SourceX X coordinate of source for the BltBuffer.\r
+ @param SourceY Y coordinate of source for the BltBuffer.\r
+ @param DestinationX X coordinate of destination for the BltBuffer.\r
+ @param DestinationY Y coordinate of destination for the BltBuffer.\r
+ @param Width Width of rectangle in BltBuffer in pixels.\r
+ @param Height Hight of rectangle in BltBuffer in pixels. Delta\r
+ -\r
+\r
+ @retval EFI_SUCCESS The Blt operation completed.\r
+ @retval EFI_INVALID_PARAMETER BltOperation is not valid.\r
+ @retval EFI_DEVICE_ERROR A hardware error occured writting to the video\r
+ buffer.\r
+\r
+**/\r
EFI_STATUS\r
EFIAPI\r
ConSpliterUgaDrawBlt (\r
IN UINTN Height,\r
IN UINTN Delta OPTIONAL\r
)\r
-/*++\r
-\r
- Routine Description:\r
- The following table defines actions for BltOperations:\r
- EfiUgaVideoFill - Write data from the BltBuffer pixel (SourceX, SourceY)\r
- directly to every pixel of the video display rectangle\r
- (DestinationX, DestinationY)\r
- (DestinationX + Width, DestinationY + Height).\r
- Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
- EfiUgaVideoToBltBuffer - Read data from the video display rectangle\r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in\r
- the BltBuffer rectangle (DestinationX, DestinationY )\r
- (DestinationX + Width, DestinationY + Height). If DestinationX or\r
- DestinationY is not zero then Delta must be set to the length in bytes\r
- of a row in the BltBuffer.\r
- EfiUgaBltBufferToVideo - Write data from the BltBuffer rectangle\r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) directly to the\r
- video display rectangle (DestinationX, DestinationY)\r
- (DestinationX + Width, DestinationY + Height). If SourceX or SourceY is\r
- not zero then Delta must be set to the length in bytes of a row in the\r
- BltBuffer.\r
- EfiUgaVideoToVideo - Copy from the video display rectangle\r
- (SourceX, SourceY) (SourceX + Width, SourceY + Height) .\r
- to the video display rectangle (DestinationX, DestinationY)\r
- (DestinationX + Width, DestinationY + Height).\r
- The BltBuffer and Delta are not used in this mode.\r
-\r
- Arguments:\r
- This - Protocol instance pointer.\r
- BltBuffer - Buffer containing data to blit into video buffer. This\r
- buffer has a size of Width*Height*sizeof(EFI_UGA_PIXEL)\r
- BltOperation - Operation to perform on BlitBuffer and video memory\r
- SourceX - X coordinate of source for the BltBuffer.\r
- SourceY - Y coordinate of source for the BltBuffer.\r
- DestinationX - X coordinate of destination for the BltBuffer.\r
- DestinationY - Y coordinate of destination for the BltBuffer.\r
- Width - Width of rectangle in BltBuffer in pixels.\r
- Height - Hight of rectangle in BltBuffer in pixels.\r
- Delta -\r
-\r
- Returns:\r
- EFI_SUCCESS - The Blt operation completed.\r
- EFI_INVALID_PARAMETER - BltOperation is not valid.\r
- EFI_DEVICE_ERROR - A hardware error occured writting to the video\r
- buffer.\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *Private;\r
}\r
}\r
\r
+\r
+/**\r
+ Write a Unicode string to the output device.\r
+\r
+ @param Private Pointer to the console output splitter's private\r
+ data. It indicates the calling context.\r
+ @param WString The NULL-terminated Unicode string to be\r
+ displayed on the output device(s). All output\r
+ devices must also support the Unicode drawing\r
+ defined in this file.\r
+\r
+ @retval EFI_SUCCESS The string was output to the device.\r
+ @retval EFI_DEVICE_ERROR The device reported an error while attempting to\r
+ output the text.\r
+ @retval EFI_UNSUPPORTED The output device's mode is not currently in a\r
+ defined text mode.\r
+ @retval EFI_WARN_UNKNOWN_GLYPH This warning code indicates that some of the\r
+ characters in the Unicode string could not be\r
+ rendered and were skipped.\r
+\r
+**/\r
EFI_STATUS\r
DevNullTextOutOutputString (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN CHAR16 *WString\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Write a Unicode string to the output device.\r
-\r
- Arguments:\r
- Private - Pointer to the console output splitter's private data. It\r
- indicates the calling context.\r
- WString - The NULL-terminated Unicode string to be displayed on the output\r
- device(s). All output devices must also support the Unicode\r
- drawing defined in this file.\r
-\r
- Returns:\r
- EFI_SUCCESS - The string was output to the device.\r
- EFI_DEVICE_ERROR - The device reported an error while attempting to\r
- output the text.\r
- EFI_UNSUPPORTED - The output device's mode is not currently in a\r
- defined text mode.\r
- EFI_WARN_UNKNOWN_GLYPH - This warning code indicates that some of the\r
- characters in the Unicode string could not be\r
- rendered and were skipped.\r
-\r
---*/\r
{\r
UINTN SizeScreen;\r
UINTN SizeAttribute;\r
CurrentWidth = 1;\r
}\r
\r
- while (*WString) {\r
+ while (*WString != L'\0') {\r
\r
if (*WString == CHAR_BACKSPACE) {\r
//\r
//\r
InsertChar = CHAR_BACKSPACE;\r
PStr = WString + 1;\r
- while (*PStr) {\r
+ while (*PStr != L'\0') {\r
TempChar = *PStr;\r
*PStr = InsertChar;\r
InsertChar = TempChar;\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Sets the output device(s) to a specified mode.\r
+\r
+ @param Private Private data structure pointer.\r
+ @param ModeNumber The mode number to set.\r
+\r
+ @retval EFI_SUCCESS The requested text mode was set.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The mode number was not valid.\r
+ @retval EFI_OUT_OF_RESOURCES Out of resources.\r
+\r
+**/\r
EFI_STATUS\r
DevNullTextOutSetMode (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN UINTN ModeNumber\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Sets the output device(s) to a specified mode.\r
-\r
- Arguments:\r
- Private - Private data structure pointer.\r
- ModeNumber - The mode number to set.\r
-\r
- Returns:\r
- EFI_SUCCESS - The requested text mode was set.\r
- EFI_DEVICE_ERROR - The device had an error and\r
- could not complete the request.\r
- EFI_UNSUPPORTED - The mode number was not valid.\r
- EFI_OUT_OF_RESOURCES - Out of resources.\r
-\r
---*/\r
{\r
UINTN Size;\r
INT32 CurrentMode;\r
return EFI_SUCCESS;\r
}\r
\r
-EFI_STATUS\r
-DevNullTextOutClearScreen (\r
- IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
- )\r
-/*++\r
\r
- Routine Description:\r
- Clears the output device(s) display to the currently selected background\r
- color.\r
+/**\r
+ Clears the output device(s) display to the currently selected background\r
+ color.\r
\r
- Arguments:\r
- Private - Protocol instance pointer.\r
+ @param Private Protocol instance pointer.\r
\r
- Returns:\r
- EFI_SUCCESS - The operation completed successfully.\r
- EFI_DEVICE_ERROR - The device had an error and\r
- could not complete the request.\r
- EFI_UNSUPPORTED - The output device is not in a valid text mode.\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The output device is not in a valid text mode.\r
\r
---*/\r
+**/\r
+EFI_STATUS\r
+DevNullTextOutClearScreen (\r
+ IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
+ )\r
{\r
UINTN Row;\r
UINTN Column;\r
return DevNullTextOutEnableCursor (Private, TRUE);\r
}\r
\r
+\r
+/**\r
+ Sets the current coordinates of the cursor position.\r
+\r
+ @param Private Protocol instance pointer.\r
+ @param Column \r
+ @param Row the position to set the cursor to. Must be\r
+ greater than or equal to zero and less than the\r
+ number of columns and rows by QueryMode ().\r
+\r
+ @retval EFI_SUCCESS The operation completed successfully.\r
+ @retval EFI_DEVICE_ERROR The device had an error and could not complete\r
+ the request.\r
+ @retval EFI_UNSUPPORTED The output device is not in a valid text mode, or\r
+ the cursor position is invalid for the current\r
+ mode.\r
+\r
+**/\r
EFI_STATUS\r
DevNullTextOutSetCursorPosition (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN UINTN Column,\r
IN UINTN Row\r
)\r
-/*++\r
-\r
- Routine Description:\r
- Sets the current coordinates of the cursor position\r
-\r
- Arguments:\r
- Private - Protocol instance pointer.\r
- Column, Row - the position to set the cursor to. Must be greater than or\r
- equal to zero and less than the number of columns and rows\r
- by QueryMode ().\r
-\r
- Returns:\r
- EFI_SUCCESS - The operation completed successfully.\r
- EFI_DEVICE_ERROR - The device had an error and\r
- could not complete the request.\r
- EFI_UNSUPPORTED - The output device is not in a valid text mode, or the\r
- cursor position is invalid for the current mode.\r
-\r
---*/\r
{\r
//\r
// No need to do extra check here as whether (Column, Row) is valid has\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Implements SIMPLE_TEXT_OUTPUT.EnableCursor().\r
+ In this driver, the cursor cannot be hidden.\r
+\r
+ @param Private Indicates the calling context.\r
+ @param Visible If TRUE, the cursor is set to be visible, If\r
+ FALSE, the cursor is set to be invisible.\r
+\r
+ @retval EFI_SUCCESS The request is valid.\r
+\r
+**/\r
EFI_STATUS\r
DevNullTextOutEnableCursor (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private,\r
IN BOOLEAN Visible\r
)\r
-/*++\r
- Routine Description:\r
-\r
- Implements SIMPLE_TEXT_OUTPUT.EnableCursor().\r
- In this driver, the cursor cannot be hidden.\r
-\r
- Arguments:\r
-\r
- Private - Indicates the calling context.\r
-\r
- Visible - If TRUE, the cursor is set to be visible, If FALSE, the cursor\r
- is set to be invisible.\r
-\r
- Returns:\r
-\r
- EFI_SUCCESS - The request is valid.\r
-\r
-\r
---*/\r
{\r
Private->TextOutMode.CursorVisible = Visible;\r
\r
return EFI_SUCCESS;\r
}\r
\r
+\r
+/**\r
+ Take the DevNull TextOut device and update the Simple Text Out on every\r
+ UGA device.\r
+\r
+ @param Private Indicates the calling context.\r
+\r
+ @retval EFI_SUCCESS The request is valid.\r
+ @retval other Return status of TextOut->OutputString ()\r
+\r
+**/\r
EFI_STATUS\r
DevNullSyncStdOut (\r
IN TEXT_OUT_SPLITTER_PRIVATE_DATA *Private\r
)\r
-/*++\r
- Routine Description:\r
- Take the DevNull TextOut device and update the Simple Text Out on every\r
- UGA device.\r
-\r
- Arguments:\r
- Private - Indicates the calling context.\r
-\r
- Returns:\r
- EFI_SUCCESS - The request is valid.\r
- other - Return status of TextOut->OutputString ()\r
-\r
---*/\r
{\r
EFI_STATUS Status;\r
EFI_STATUS ReturnStatus;\r
\r
Column = 0;\r
while (Column < MaxColumn) {\r
- if (Screen[Column]) {\r
+ if (Screen[Column] > 0) {\r
CurrentAttribute = Attributes[Column];\r
CurrentColumn = Column;\r
ScreenStart = &Screen[Column];\r
\r
*BufferTail = *Str;\r
BufferTail++;\r
- if (Attributes[Column] & EFI_WIDE_ATTRIBUTE) {\r
+ if ((Attributes[Column] & EFI_WIDE_ATTRIBUTE) != 0) {\r
Str++;\r
Column++;\r
}\r
projects / mirror_edk2.git / commitdiff