\r
This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation \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
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+Copyright (c) 2006 - 2008, Intel Corporation\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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
(EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE)(\r
IN EFI_CONSOLE_CONTROL_PROTOCOL *This,\r
OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode,\r
- OUT BOOLEAN *GopUgaExists, OPTIONAL \r
+ OUT BOOLEAN *GopUgaExists, OPTIONAL\r
OUT BOOLEAN *StdInLocked OPTIONAL\r
);\r
\r
);\r
\r
/**\r
- If Password is NULL or the Password is too big, then return an error. If the \r
+ If Password is NULL or the Password is too big, then return an error. If the\r
Password is valid, then store the password, lock StdIn and arm the periodic timer.\r
\r
- @param This Console Control protocol pointer.\r
+ @param This Protocol instance pointer.\r
@param Password The password input.\r
\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
+ @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
typedef\r
//\r
if ((Key.UnicodeChar == CHAR_CARRIAGE_RETURN) && (Key.ScanCode == SCAN_NULL)) {\r
mConIn.PwdAttempt[mConIn.PwdIndex] = CHAR_NULL;\r
- if (StrCmp (mConIn.Password, mConIn.PwdAttempt)) {\r
+ if (StrCmp (mConIn.Password, mConIn.PwdAttempt) != 0) {\r
//\r
// Password not match\r
//\r
@param This Console Control protocol pointer.\r
@param Password The password input.\r
\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
+ @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
EFI_STATUS\r
StrCpy (mConIn.Password, Password);\r
mConIn.PasswordEnabled = TRUE;\r
mConIn.PwdIndex = 0;\r
- gBS->SetTimer (mConIn.LockEvent, TimerPeriodic, (10000 * 25));\r
+ //\r
+ // Timer Periodic is 25ms.\r
+ //\r
+ gBS->SetTimer (mConIn.LockEvent, TimerPeriodic, 10000 * 25);\r
\r
return EFI_SUCCESS;\r
}\r
EFI_HANDLE VirtualHandle;\r
EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL TextOut;\r
EFI_SIMPLE_TEXT_OUTPUT_MODE TextOutMode;\r
- \r
+\r
EFI_UGA_DRAW_PROTOCOL UgaDraw;\r
UINT32 UgaHorizontalResolution;\r
UINT32 UgaVerticalResolution;\r
UINT32 UgaColorDepth;\r
UINT32 UgaRefreshRate;\r
EFI_UGA_PIXEL *UgaBlt;\r
- \r
+\r
EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput;\r
EFI_GRAPHICS_OUTPUT_BLT_PIXEL *GraphicsOutputBlt;\r
EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *GraphicsOutputModeBuffer;\r
UINTN CurrentNumberOfGraphicsOutput;\r
UINTN CurrentNumberOfUgaDraw;\r
BOOLEAN HardwareNeedsStarting;\r
- \r
+\r
EFI_CONSOLE_CONTROL_PROTOCOL ConsoleControl;\r
- \r
+\r
UINTN CurrentNumberOfConsoles;\r
TEXT_OUT_AND_GOP_DATA *TextOutList;\r
UINTN TextOutListCount;\r
TEXT_OUT_SPLITTER_QUERY_DATA *TextOutQueryData;\r
UINTN TextOutQueryDataCount;\r
INT32 *TextOutModeMap;\r
- \r
+\r
EFI_CONSOLE_CONTROL_SCREEN_MODE ConsoleOutputMode;\r
- \r
+\r
UINTN DevNullColumns;\r
UINTN DevNullRows;\r
CHAR16 *DevNullScreen;\r
\r
Installs driver module protocols and. Creates virtual device handles for ConIn,\r
ConOut, and StdErr. Installs Simple Text In protocol, Simple Text In Ex protocol,\r
- Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers. \r
+ Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers.\r
Installs Graphics Output protocol and/or UGA Draw protocol if needed.\r
\r
@param[in] ImageHandle The firmware allocated handle for the EFI image.\r
TEXT_OUT_SPLITTER_PRIVATE_DATA *ConOutPrivate\r
);\r
\r
-//\r
-// Driver Binding Functions\r
-//\r
\r
/**\r
- Test to see if Console In Device could be supported on the Controller. \r
+ Test to see if Console In Device could be supported on the Controller.\r
\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
);\r
\r
/**\r
- Test to see if Simple Pointer protocol could be supported on the Controller. \r
+ Test to see if Simple Pointer protocol could be supported on the Controller.\r
\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
);\r
\r
/**\r
- Test to see if Console Out Device could be supported on the Controller. \r
+ Test to see if Console Out Device could be supported on the Controller.\r
\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
);\r
\r
/**\r
- Test to see if Standard Error Device could be supported on the Controller. \r
+ Test to see if Standard Error Device could be supported on the Controller.\r
\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
);\r
\r
/**\r
- Start Console In Consplitter on device handle. \r
- \r
+ Start Console In Consplitter on device handle.\r
+\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
);\r
\r
/**\r
- Start Simple Pointer Consplitter on device handle. \r
- \r
+ Start Simple Pointer Consplitter on device handle.\r
+\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
);\r
\r
/**\r
- Start Console Out Consplitter on device handle. \r
- \r
+ Start Console Out Consplitter on device handle.\r
+\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
);\r
\r
/**\r
- Start Standard Error Consplitter on device handle. \r
- \r
+ Start Standard Error Consplitter on device handle.\r
+\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
\r
\r
/**\r
- Test to see if Absolute Pointer protocol could be supported on the Controller. \r
+ Test to see if Absolute Pointer protocol could be supported on the Controller.\r
\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to test.\r
);\r
\r
/**\r
- Start Absolute Pointer Consplitter on device handle. \r
- \r
+ Start Absolute Pointer Consplitter on device handle.\r
+\r
@param This Driver Binding protocol instance pointer.\r
@param ControllerHandle Handle of device to bind driver to.\r
@param RemainingDevicePath Optional parameter use to pick a specific child\r
// Simple Text Input Ex protocol function prototypes\r
//\r
\r
-\r
/**\r
Reset the input device and optionaly run diagnostics\r
\r
IN EFI_EVENT Event,\r
IN VOID *Context\r
);\r
+\r
/**\r
Return TRUE if StdIn is locked. The ConIn device on the virtual handle is\r
the only device locked.\r
ConSpliterConssoleControlStdInLocked (\r
VOID\r
);\r
+\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
);\r
\r
/**\r
- Set the video device into the specified mode and clears the visible portions of \r
+ Set the video device into the specified mode and clears the visible portions of\r
the output display to black.\r
\r
@param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\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. \r
+ @param Height Hight of rectangle in BltBuffer in pixels.\r
@param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
);\r
\r
/**\r
- Write data from the buffer to video display based on Graphics Output setting. \r
+ Write data from the buffer to video display based on Graphics Output setting.\r
\r
@param Private Consplitter Text Out pointer.\r
@param GraphicsOutput Graphics Output protocol pointer.\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 buffer.\r
- \r
+\r
\r
**/\r
EFI_STATUS\r
(DestinationX, DestinationY)\r
(DestinationX + Width, DestinationY + Height).\r
Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
- EfiUgaVideoToBltBuffer: \r
+ EfiUgaVideoToBltBuffer:\r
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
);\r
\r
/**\r
- Write data from the buffer to video display based on UGA Draw setting. \r
+ Write data from the buffer to video display based on UGA Draw setting.\r
\r
@param Private Consplitter Text Out pointer.\r
@param GraphicsOutput Graphics Output protocol pointer.\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 buffer.\r
- \r
+\r
**/\r
EFI_STATUS\r
DevNullUgaSync (\r
Sets the current coordinates of the cursor position.\r
\r
@param Private Text Out Splitter pointer.\r
- @param Column \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
\r
/**\r
- Set the current mode to either text or graphics. Graphics is\r
+ Set the current video mode to either text or graphics. Graphics is\r
for Quiet Boot.\r
\r
@param This Console Control Protocol instance pointer.\r
- @param Mode Mode to set.\r
+ @param Mode Video mode is to be set.\r
\r
- @retval EFI_SUCCESS Mode information returned.\r
- @retval EFI_INVALID_PARAMETER Invalid parameter.\r
- @retval EFI_UNSUPPORTED Operation unsupported.\r
+ @retval EFI_SUCCESS Mode is set successfully.\r
+ @retval EFI_INVALID_PARAMETER Mode is not the valid mode value.\r
+ @retval EFI_UNSUPPORTED Mode is unsupported by console device.\r
\r
**/\r
EFI_STATUS\r
\r
\r
/**\r
- Set the video device into the specified mode and clears the visible portions of \r
+ Set the video device into the specified mode and clears the visible portions of\r
the output display to black.\r
\r
@param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.\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. \r
+ @param Height Hight of rectangle in BltBuffer in pixels.\r
@param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\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. \r
+ @param Height Hight of rectangle in BltBuffer in pixels.\r
@param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
}\r
\r
/**\r
- Write data from the buffer to video display based on Graphics Output setting. \r
+ Write data from the buffer to video display based on Graphics Output setting.\r
\r
@param Private Consplitter Text Out pointer.\r
@param GraphicsOutput Graphics Output protocol pointer.\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 buffer.\r
- \r
+\r
\r
**/\r
EFI_STATUS\r
ReturnStatus = Status;\r
}\r
}\r
- } \r
+ }\r
}\r
\r
return ReturnStatus;\r
(DestinationX, DestinationY)\r
(DestinationX + Width, DestinationY + Height).\r
Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
- EfiUgaVideoToBltBuffer: \r
+ EfiUgaVideoToBltBuffer:\r
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
@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. \r
+ @param Height Hight of rectangle in BltBuffer in pixels.\r
@param Delta OPTIONAL.\r
\r
@retval EFI_SUCCESS The Blt operation completed.\r
(DestinationX, DestinationY)\r
(DestinationX + Width, DestinationY + Height).\r
Only one pixel will be used from the BltBuffer. Delta is NOT used.\r
- EfiUgaVideoToBltBuffer: \r
+ EfiUgaVideoToBltBuffer:\r
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
}\r
\r
/**\r
- Write data from the buffer to video display based on UGA Draw setting. \r
+ Write data from the buffer to video display based on UGA Draw setting.\r
\r
@param Private Consplitter Text Out pointer.\r
@param GraphicsOutput Graphics Output protocol pointer.\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 buffer.\r
- \r
+\r
**/\r
EFI_STATUS\r
DevNullUgaSync (\r
LastRow = Private->DevNullRows - 1;\r
MaxColumn = Private->DevNullColumns;\r
\r
- if (Mode->Attribute & EFI_WIDE_ATTRIBUTE) {\r
+ if ((Mode->Attribute & EFI_WIDE_ATTRIBUTE) != 0) {\r
CurrentWidth = 2;\r
} else {\r
CurrentWidth = 1;\r
Sets the current coordinates of the cursor position.\r
\r
@param Private Text Out Splitter pointer.\r
- @param Column \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
/** @file\r
IPF specific functions to support Debug Support protocol.\r
\r
-Copyright (c) 2006 - 2008, Intel Corporation \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
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+Copyright (c) 2006 - 2008, Intel Corporation\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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
\r
\r
/**\r
- IPF specific DebugSupport driver initialization. \r
+ IPF specific DebugSupport driver initialization.\r
\r
Must be public because it's referenced from DebugSupport.c\r
\r
\r
/**\r
Unload handler that is called during UnloadImage() - deallocates pool memory\r
- used by the driver. \r
+ used by the driver.\r
\r
Must be public because it's referenced from DebugSuport.c\r
\r
\r
/**\r
C routine that is called for all registered exceptions. This is the main\r
- exception dispatcher. \r
+ exception dispatcher.\r
\r
Must be public because it's referenced from AsmFuncs.s.\r
\r
" Context.SystemContextIpf->CrIip == %LX\n"\r
" Context.SystemContextIpf->CrIpsr == %LX\n"\r
" mInHandler == %X\n",\r
- (INT32)ExceptionType, \r
- Context, \r
+ (INT32)ExceptionType,\r
+ Context,\r
Context.SystemContextIpf->CrIip,\r
Context.SystemContextIpf->CrIpsr,\r
mInHandler));\r
/**\r
Given an integer number, return the physical address of the entry point in the IFT.\r
\r
- @param HandlerIndex Index of the Handler \r
+ @param HandlerIndex Index of the Handler\r
@param EntryPoint IFT Entrypoint\r
\r
**/\r
\r
/**\r
Returns the maximum value that may be used for the ProcessorIndex parameter in\r
- RegisterPeriodicCallback() and RegisterExceptionCallback(). \r
- \r
+ RegisterPeriodicCallback() and RegisterExceptionCallback().\r
+\r
Hard coded to support only 1 processor for now.\r
\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param MaxProcessorIndex Pointer to a caller-allocated UINTN in which the maximum supported\r
- processor index is returned. Always 0 returned. \r
- \r
+ processor index is returned. Always 0 returned.\r
+\r
@retval EFI_SUCCESS Always returned with **MaxProcessorIndex set to 0.\r
\r
**/\r
\r
/**\r
Registers a function to be called back periodically in interrupt context.\r
- \r
+\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param ProcessorIndex Specifies which processor the callback function applies to.\r
@param PeriodicCallback A pointer to a function of type PERIODIC_CALLBACK that is the main\r
periodic entry point of the debug agent.\r
- \r
- @retval EFI_SUCCESS The function completed successfully. \r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback\r
- function was previously registered. \r
- @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback \r
- function. \r
+ function was previously registered.\r
+ @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback\r
+ function.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Registers a function to be called when a given processor exception occurs.\r
\r
This code executes in boot services context.\r
- \r
+\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param ProcessorIndex Specifies which processor the callback function applies to.\r
@param ExceptionCallback A pointer to a function of type EXCEPTION_CALLBACK that is called\r
- when the processor exception specified by ExceptionType occurs. \r
- @param ExceptionType Specifies which processor exception to hook. \r
- \r
- @retval EFI_SUCCESS The function completed successfully. \r
+ when the processor exception specified by ExceptionType occurs.\r
+ @param ExceptionType Specifies which processor exception to hook.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback\r
- function was previously registered. \r
- @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback \r
+ function was previously registered.\r
+ @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback\r
function.\r
**/\r
EFI_STATUS\r
RegisterExceptionCallback (\r
IN EFI_DEBUG_SUPPORT_PROTOCOL *This,\r
IN UINTN ProcessorIndex,\r
- IN EFI_EXCEPTION_CALLBACK NewCallback,\r
+ IN EFI_EXCEPTION_CALLBACK ExceptionCallback,\r
IN EFI_EXCEPTION_TYPE ExceptionType\r
)\r
{\r
return ManageIvtEntryTable (\r
ExceptionType,\r
(BUNDLE *) ((EFI_PLABEL *) HookStub)->EntryPoint,\r
- NewCallback\r
+ ExceptionCallback\r
);\r
}\r
\r
/**\r
Invalidates processor instruction cache for a memory range. Subsequent execution in this range\r
- causes a fresh memory fetch to retrieve code to be executed. \r
- \r
+ causes a fresh memory fetch to retrieve code to be executed.\r
+\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param ProcessorIndex Specifies which processor's instruction cache is to be invalidated.\r
- @param Start Specifies the physical base of the memory range to be invalidated. \r
+ @param Start Specifies the physical base of the memory range to be invalidated.\r
@param Length Specifies the minimum number of bytes in the processor's instruction\r
- cache to invalidate. \r
- \r
+ cache to invalidate.\r
+\r
@retval EFI_SUCCESS Always returned.\r
\r
**/\r
/** @file\r
IPF specific types, macros, and definitions for Debug Support Driver.\r
- \r
-Copyright (c) 2004 - 2008, Intel Corporation \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
-http://opensource.org/licenses/bsd-license.php \r
- \r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r
+\r
+Copyright (c) 2004 - 2008, Intel Corporation\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
+http://opensource.org/licenses/bsd-license.php\r
+\r
+THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
} BUNDLE;\r
\r
/**\r
- IPF specific DebugSupport driver initialization. \r
+ IPF specific DebugSupport driver initialization.\r
\r
Must be public because it's referenced from DebugSupport.c\r
\r
\r
/**\r
Unload handler that is called during UnloadImage() - deallocates pool memory\r
- used by the driver. \r
+ used by the driver.\r
\r
Must be public because it's referenced from DebugSuport.c\r
\r
\r
/**\r
Returns the maximum value that may be used for the ProcessorIndex parameter in\r
- RegisterPeriodicCallback() and RegisterExceptionCallback(). \r
- \r
+ RegisterPeriodicCallback() and RegisterExceptionCallback().\r
+\r
Hard coded to support only 1 processor for now.\r
\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param MaxProcessorIndex Pointer to a caller-allocated UINTN in which the maximum supported\r
- processor index is returned. Always 0 returned. \r
- \r
+ processor index is returned. Always 0 returned.\r
+\r
@retval EFI_SUCCESS Always returned with **MaxProcessorIndex set to 0.\r
\r
**/\r
\r
/**\r
Registers a function to be called back periodically in interrupt context.\r
- \r
+\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param ProcessorIndex Specifies which processor the callback function applies to.\r
@param PeriodicCallback A pointer to a function of type PERIODIC_CALLBACK that is the main\r
periodic entry point of the debug agent.\r
- \r
- @retval EFI_SUCCESS The function completed successfully. \r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback\r
- function was previously registered. \r
- @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback \r
- function. \r
+ function was previously registered.\r
+ @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback\r
+ function.\r
**/\r
EFI_STATUS\r
EFIAPI\r
Registers a function to be called when a given processor exception occurs.\r
\r
This code executes in boot services context.\r
- \r
+\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param ProcessorIndex Specifies which processor the callback function applies to.\r
@param ExceptionCallback A pointer to a function of type EXCEPTION_CALLBACK that is called\r
when the processor exception specified by ExceptionType occurs. \r
- @param ExceptionType Specifies which processor exception to hook. \r
- \r
- @retval EFI_SUCCESS The function completed successfully. \r
+ @param ExceptionType Specifies which processor exception to hook.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
@retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback\r
- function was previously registered. \r
- @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback \r
+ function was previously registered.\r
+ @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback\r
function.\r
**/\r
EFI_STATUS\r
RegisterExceptionCallback (\r
IN EFI_DEBUG_SUPPORT_PROTOCOL *This,\r
IN UINTN ProcessorIndex,\r
- IN EFI_EXCEPTION_CALLBACK NewCallback,\r
+ IN EFI_EXCEPTION_CALLBACK ExceptionCallback,\r
IN EFI_EXCEPTION_TYPE ExceptionType\r
);\r
\r
/**\r
Invalidates processor instruction cache for a memory range. Subsequent execution in this range\r
- causes a fresh memory fetch to retrieve code to be executed. \r
- \r
+ causes a fresh memory fetch to retrieve code to be executed.\r
+\r
@param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.\r
@param ProcessorIndex Specifies which processor's instruction cache is to be invalidated.\r
- @param Start Specifies the physical base of the memory range to be invalidated. \r
+ @param Start Specifies the physical base of the memory range to be invalidated.\r
@param Length Specifies the minimum number of bytes in the processor's instruction\r
- cache to invalidate. \r
- \r
+ cache to invalidate.\r
+\r
@retval EFI_SUCCESS Always returned.\r
\r
**/\r
\r
/**\r
C routine that is called for all registered exceptions. This is the main\r
- exception dispatcher. \r
+ exception dispatcher.\r
\r
Must be public because it's referenced from AsmFuncs.s.\r
\r
/**\r
Given an integer number, return the physical address of the entry point in the IFT.\r
\r
- @param HandlerIndex Index of the Handler \r
+ @param HandlerIndex Index of the Handler\r
@param EntryPoint IFT Entrypoint\r
\r
**/\r
projects / mirror_edk2.git / commitdiff