From ed055f1b633092d91850079ff2328dabc6ab75c9 Mon Sep 17 00:00:00 2001 From: vanjeff Date: Thu, 8 Jan 2009 08:21:40 +0000 Subject: [PATCH] ECC clean up. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7211 6f19259b-4bc3-4df7-8a09-765794883524 --- .../Include/Protocol/ConsoleControl.h | 28 +++---- .../Console/ConSplitterDxe/ConSplitter.c | 13 ++-- .../Console/ConSplitterDxe/ConSplitter.h | 66 ++++++++-------- .../ConSplitterDxe/ConSplitterGraphics.c | 36 ++++----- .../DebugSupportDxe/Ipf/PlDebugSupport.c | 76 +++++++++---------- .../DebugSupportDxe/Ipf/PlDebugSupport.h | 70 ++++++++--------- 6 files changed, 145 insertions(+), 144 deletions(-) diff --git a/MdeModulePkg/Include/Protocol/ConsoleControl.h b/MdeModulePkg/Include/Protocol/ConsoleControl.h index e55e6b2938..bf662f2b79 100644 --- a/MdeModulePkg/Include/Protocol/ConsoleControl.h +++ b/MdeModulePkg/Include/Protocol/ConsoleControl.h @@ -2,14 +2,14 @@ This protocol provides the interfaces to Get/Set the current video mode for GOP/UGA screen -Copyright (c) 2006 - 2008, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2008, Intel Corporation +All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -48,7 +48,7 @@ EFI_STATUS (EFIAPI *EFI_CONSOLE_CONTROL_PROTOCOL_GET_MODE)( IN EFI_CONSOLE_CONTROL_PROTOCOL *This, OUT EFI_CONSOLE_CONTROL_SCREEN_MODE *Mode, - OUT BOOLEAN *GopUgaExists, OPTIONAL + OUT BOOLEAN *GopUgaExists, OPTIONAL OUT BOOLEAN *StdInLocked OPTIONAL ); @@ -72,15 +72,15 @@ EFI_STATUS ); /** - If Password is NULL or the Password is too big, then return an error. If the + If Password is NULL or the Password is too big, then return an error. If the Password is valid, then store the password, lock StdIn and arm the periodic timer. - @param This Console Control protocol pointer. + @param This Protocol instance pointer. @param Password The password input. - @retval EFI_SUCCESS Lock the StdIn device - @retval EFI_INVALID_PARAMETER Password is NULL - @retval EFI_OUT_OF_RESOURCES Buffer allocation to store the password fails + @retval EFI_SUCCESS Lock the StdIn device. + @retval EFI_INVALID_PARAMETER Password is NULL. + @retval EFI_OUT_OF_RESOURCES Buffer allocation to store the password fails. **/ typedef diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c index 8c4395c3a7..0c0bd30336 100644 --- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c +++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.c @@ -3418,7 +3418,7 @@ ConSpliterConsoleControlLockStdInEvent ( // if ((Key.UnicodeChar == CHAR_CARRIAGE_RETURN) && (Key.ScanCode == SCAN_NULL)) { mConIn.PwdAttempt[mConIn.PwdIndex] = CHAR_NULL; - if (StrCmp (mConIn.Password, mConIn.PwdAttempt)) { + if (StrCmp (mConIn.Password, mConIn.PwdAttempt) != 0) { // // Password not match // @@ -3475,9 +3475,9 @@ ConSpliterConsoleControlLockStdInEvent ( @param This Console Control protocol pointer. @param Password The password input. - @retval EFI_SUCCESS Lock the StdIn device - @retval EFI_INVALID_PARAMETER Password is NULL - @retval EFI_OUT_OF_RESOURCES Buffer allocation to store the password fails + @retval EFI_SUCCESS Lock the StdIn device. + @retval EFI_INVALID_PARAMETER Password is NULL. + @retval EFI_OUT_OF_RESOURCES Buffer allocation to store the password fails. **/ EFI_STATUS @@ -3503,7 +3503,10 @@ ConSpliterConsoleControlLockStdIn ( StrCpy (mConIn.Password, Password); mConIn.PasswordEnabled = TRUE; mConIn.PwdIndex = 0; - gBS->SetTimer (mConIn.LockEvent, TimerPeriodic, (10000 * 25)); + // + // Timer Periodic is 25ms. + // + gBS->SetTimer (mConIn.LockEvent, TimerPeriodic, 10000 * 25); return EFI_SUCCESS; } diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h index 75df3555d7..5ff5e6adac 100644 --- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h +++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitter.h @@ -207,32 +207,32 @@ typedef struct { EFI_HANDLE VirtualHandle; EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL TextOut; EFI_SIMPLE_TEXT_OUTPUT_MODE TextOutMode; - + EFI_UGA_DRAW_PROTOCOL UgaDraw; UINT32 UgaHorizontalResolution; UINT32 UgaVerticalResolution; UINT32 UgaColorDepth; UINT32 UgaRefreshRate; EFI_UGA_PIXEL *UgaBlt; - + EFI_GRAPHICS_OUTPUT_PROTOCOL GraphicsOutput; EFI_GRAPHICS_OUTPUT_BLT_PIXEL *GraphicsOutputBlt; EFI_GRAPHICS_OUTPUT_MODE_INFORMATION *GraphicsOutputModeBuffer; UINTN CurrentNumberOfGraphicsOutput; UINTN CurrentNumberOfUgaDraw; BOOLEAN HardwareNeedsStarting; - + EFI_CONSOLE_CONTROL_PROTOCOL ConsoleControl; - + UINTN CurrentNumberOfConsoles; TEXT_OUT_AND_GOP_DATA *TextOutList; UINTN TextOutListCount; TEXT_OUT_SPLITTER_QUERY_DATA *TextOutQueryData; UINTN TextOutQueryDataCount; INT32 *TextOutModeMap; - + EFI_CONSOLE_CONTROL_SCREEN_MODE ConsoleOutputMode; - + UINTN DevNullColumns; UINTN DevNullRows; CHAR16 *DevNullScreen; @@ -277,7 +277,7 @@ typedef struct { Installs driver module protocols and. Creates virtual device handles for ConIn, ConOut, and StdErr. Installs Simple Text In protocol, Simple Text In Ex protocol, - Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers. + Simple Pointer protocol, Absolute Pointer protocol on those virtual handlers. Installs Graphics Output protocol and/or UGA Draw protocol if needed. @param[in] ImageHandle The firmware allocated handle for the EFI image. @@ -325,12 +325,9 @@ ConSplitterTextOutConstructor ( TEXT_OUT_SPLITTER_PRIVATE_DATA *ConOutPrivate ); -// -// Driver Binding Functions -// /** - Test to see if Console In Device could be supported on the Controller. + Test to see if Console In Device could be supported on the Controller. @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to test. @@ -350,7 +347,7 @@ ConSplitterConInDriverBindingSupported ( ); /** - Test to see if Simple Pointer protocol could be supported on the Controller. + Test to see if Simple Pointer protocol could be supported on the Controller. @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to test. @@ -370,7 +367,7 @@ ConSplitterSimplePointerDriverBindingSupported ( ); /** - Test to see if Console Out Device could be supported on the Controller. + Test to see if Console Out Device could be supported on the Controller. @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to test. @@ -390,7 +387,7 @@ ConSplitterConOutDriverBindingSupported ( ); /** - Test to see if Standard Error Device could be supported on the Controller. + Test to see if Standard Error Device could be supported on the Controller. @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to test. @@ -410,8 +407,8 @@ ConSplitterStdErrDriverBindingSupported ( ); /** - Start Console In Consplitter on device handle. - + Start Console In Consplitter on device handle. + @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to bind driver to. @param RemainingDevicePath Optional parameter use to pick a specific child @@ -430,8 +427,8 @@ ConSplitterConInDriverBindingStart ( ); /** - Start Simple Pointer Consplitter on device handle. - + Start Simple Pointer Consplitter on device handle. + @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to bind driver to. @param RemainingDevicePath Optional parameter use to pick a specific child @@ -450,8 +447,8 @@ ConSplitterSimplePointerDriverBindingStart ( ); /** - Start Console Out Consplitter on device handle. - + Start Console Out Consplitter on device handle. + @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to bind driver to. @param RemainingDevicePath Optional parameter use to pick a specific child @@ -470,8 +467,8 @@ ConSplitterConOutDriverBindingStart ( ); /** - Start Standard Error Consplitter on device handle. - + Start Standard Error Consplitter on device handle. + @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to bind driver to. @param RemainingDevicePath Optional parameter use to pick a specific child @@ -580,7 +577,7 @@ ConSplitterStdErrDriverBindingStop ( /** - Test to see if Absolute Pointer protocol could be supported on the Controller. + Test to see if Absolute Pointer protocol could be supported on the Controller. @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to test. @@ -600,8 +597,8 @@ ConSplitterAbsolutePointerDriverBindingSupported ( ); /** - Start Absolute Pointer Consplitter on device handle. - + Start Absolute Pointer Consplitter on device handle. + @param This Driver Binding protocol instance pointer. @param ControllerHandle Handle of device to bind driver to. @param RemainingDevicePath Optional parameter use to pick a specific child @@ -1346,7 +1343,6 @@ ConSplitterTextInExDeleteDevice ( // Simple Text Input Ex protocol function prototypes // - /** Reset the input device and optionaly run diagnostics @@ -1479,6 +1475,7 @@ ConSplitterTextInWaitForKey ( IN EFI_EVENT Event, IN VOID *Context ); + /** Return TRUE if StdIn is locked. The ConIn device on the virtual handle is the only device locked. @@ -1491,6 +1488,7 @@ BOOLEAN ConSpliterConssoleControlStdInLocked ( VOID ); + /** This timer event will fire when StdIn is locked. It will check the key sequence on StdIn to see if it matches the password. Any error in the @@ -1903,7 +1901,7 @@ ConSpliterGraphicsOutputQueryMode ( ); /** - Set the video device into the specified mode and clears the visible portions of + Set the video device into the specified mode and clears the visible portions of the output display to black. @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance. @@ -1959,7 +1957,7 @@ ConSpliterGraphicsOutputSetMode ( @param DestinationX X coordinate of destination for the BltBuffer. @param DestinationY Y coordinate of destination for the BltBuffer. @param Width Width of rectangle in BltBuffer in pixels. - @param Height Hight of rectangle in BltBuffer in pixels. + @param Height Hight of rectangle in BltBuffer in pixels. @param Delta OPTIONAL. @retval EFI_SUCCESS The Blt operation completed. @@ -1984,7 +1982,7 @@ ConSpliterGraphicsOutputBlt ( ); /** - Write data from the buffer to video display based on Graphics Output setting. + Write data from the buffer to video display based on Graphics Output setting. @param Private Consplitter Text Out pointer. @param GraphicsOutput Graphics Output protocol pointer. @@ -1994,7 +1992,7 @@ ConSpliterGraphicsOutputBlt ( @retval EFI_SUCCESS The Blt operation completed. @retval EFI_INVALID_PARAMETER BltOperation is not valid. @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer. - + **/ EFI_STATUS @@ -2063,7 +2061,7 @@ ConSpliterUgaDrawSetMode ( (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). Only one pixel will be used from the BltBuffer. Delta is NOT used. - EfiUgaVideoToBltBuffer: + EfiUgaVideoToBltBuffer: Read data from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in the BltBuffer rectangle (DestinationX, DestinationY ) @@ -2117,7 +2115,7 @@ ConSpliterUgaDrawBlt ( ); /** - Write data from the buffer to video display based on UGA Draw setting. + Write data from the buffer to video display based on UGA Draw setting. @param Private Consplitter Text Out pointer. @param GraphicsOutput Graphics Output protocol pointer. @@ -2127,7 +2125,7 @@ ConSpliterUgaDrawBlt ( @retval EFI_SUCCESS The Blt operation completed. @retval EFI_INVALID_PARAMETER BltOperation is not valid. @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer. - + **/ EFI_STATUS DevNullUgaSync ( @@ -2202,7 +2200,7 @@ DevNullTextOutClearScreen ( Sets the current coordinates of the cursor position. @param Private Text Out Splitter pointer. - @param Column + @param Column @param Row the position to set the cursor to. Must be greater than or equal to zero and less than the number of columns and rows by QueryMode (). diff --git a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c index 686a47331f..251ab5dcb2 100644 --- a/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c +++ b/MdeModulePkg/Universal/Console/ConSplitterDxe/ConSplitterGraphics.c @@ -76,15 +76,15 @@ ConSpliterConsoleControlGetMode ( /** - Set the current mode to either text or graphics. Graphics is + Set the current video mode to either text or graphics. Graphics is for Quiet Boot. @param This Console Control Protocol instance pointer. - @param Mode Mode to set. + @param Mode Video mode is to be set. - @retval EFI_SUCCESS Mode information returned. - @retval EFI_INVALID_PARAMETER Invalid parameter. - @retval EFI_UNSUPPORTED Operation unsupported. + @retval EFI_SUCCESS Mode is set successfully. + @retval EFI_INVALID_PARAMETER Mode is not the valid mode value. + @retval EFI_UNSUPPORTED Mode is unsupported by console device. **/ EFI_STATUS @@ -205,7 +205,7 @@ ConSpliterGraphicsOutputQueryMode ( /** - Set the video device into the specified mode and clears the visible portions of + Set the video device into the specified mode and clears the visible portions of the output display to black. @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance. @@ -361,7 +361,7 @@ ConSpliterGraphicsOutputSetMode ( @param DestinationX X coordinate of destination for the BltBuffer. @param DestinationY Y coordinate of destination for the BltBuffer. @param Width Width of rectangle in BltBuffer in pixels. - @param Height Hight of rectangle in BltBuffer in pixels. + @param Height Hight of rectangle in BltBuffer in pixels. @param Delta OPTIONAL. @retval EFI_SUCCESS The Blt operation completed. @@ -525,7 +525,7 @@ DevNullGraphicsOutputBlt ( @param DestinationX X coordinate of destination for the BltBuffer. @param DestinationY Y coordinate of destination for the BltBuffer. @param Width Width of rectangle in BltBuffer in pixels. - @param Height Hight of rectangle in BltBuffer in pixels. + @param Height Hight of rectangle in BltBuffer in pixels. @param Delta OPTIONAL. @retval EFI_SUCCESS The Blt operation completed. @@ -634,7 +634,7 @@ ConSpliterGraphicsOutputBlt ( } /** - Write data from the buffer to video display based on Graphics Output setting. + Write data from the buffer to video display based on Graphics Output setting. @param Private Consplitter Text Out pointer. @param GraphicsOutput Graphics Output protocol pointer. @@ -644,7 +644,7 @@ ConSpliterGraphicsOutputBlt ( @retval EFI_SUCCESS The Blt operation completed. @retval EFI_INVALID_PARAMETER BltOperation is not valid. @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer. - + **/ EFI_STATUS @@ -842,7 +842,7 @@ ConSpliterUgaDrawSetMode ( ReturnStatus = Status; } } - } + } } return ReturnStatus; @@ -859,7 +859,7 @@ ConSpliterUgaDrawSetMode ( (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). Only one pixel will be used from the BltBuffer. Delta is NOT used. - EfiUgaVideoToBltBuffer: + EfiUgaVideoToBltBuffer: Read data from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in the BltBuffer rectangle (DestinationX, DestinationY ) @@ -891,7 +891,7 @@ ConSpliterUgaDrawSetMode ( @param DestinationX X coordinate of destination for the BltBuffer. @param DestinationY Y coordinate of destination for the BltBuffer. @param Width Width of rectangle in BltBuffer in pixels. - @param Height Hight of rectangle in BltBuffer in pixels. + @param Height Hight of rectangle in BltBuffer in pixels. @param Delta OPTIONAL. @retval EFI_SUCCESS The Blt operation completed. @@ -1028,7 +1028,7 @@ DevNullUgaBlt ( (DestinationX, DestinationY) (DestinationX + Width, DestinationY + Height). Only one pixel will be used from the BltBuffer. Delta is NOT used. - EfiUgaVideoToBltBuffer: + EfiUgaVideoToBltBuffer: Read data from the video display rectangle (SourceX, SourceY) (SourceX + Width, SourceY + Height) and place it in the BltBuffer rectangle (DestinationX, DestinationY ) @@ -1163,7 +1163,7 @@ ConSpliterUgaDrawBlt ( } /** - Write data from the buffer to video display based on UGA Draw setting. + Write data from the buffer to video display based on UGA Draw setting. @param Private Consplitter Text Out pointer. @param GraphicsOutput Graphics Output protocol pointer. @@ -1173,7 +1173,7 @@ ConSpliterUgaDrawBlt ( @retval EFI_SUCCESS The Blt operation completed. @retval EFI_INVALID_PARAMETER BltOperation is not valid. @retval EFI_DEVICE_ERROR A hardware error occured writting to the video buffer. - + **/ EFI_STATUS DevNullUgaSync ( @@ -1261,7 +1261,7 @@ DevNullTextOutOutputString ( LastRow = Private->DevNullRows - 1; MaxColumn = Private->DevNullColumns; - if (Mode->Attribute & EFI_WIDE_ATTRIBUTE) { + if ((Mode->Attribute & EFI_WIDE_ATTRIBUTE) != 0) { CurrentWidth = 2; } else { CurrentWidth = 1; @@ -1561,7 +1561,7 @@ DevNullTextOutClearScreen ( Sets the current coordinates of the cursor position. @param Private Text Out Splitter pointer. - @param Column + @param Column @param Row the position to set the cursor to. Must be greater than or equal to zero and less than the number of columns and rows by QueryMode (). diff --git a/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.c b/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.c index e23a6759eb..fa70100333 100644 --- a/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.c +++ b/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.c @@ -1,14 +1,14 @@ /** @file IPF specific functions to support Debug Support protocol. -Copyright (c) 2006 - 2008, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. +Copyright (c) 2006 - 2008, Intel Corporation +All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -44,7 +44,7 @@ UINTN ExternalInterruptCount; /** - IPF specific DebugSupport driver initialization. + IPF specific DebugSupport driver initialization. Must be public because it's referenced from DebugSupport.c @@ -63,7 +63,7 @@ PlInitializeDebugSupportDriver ( /** Unload handler that is called during UnloadImage() - deallocates pool memory - used by the driver. + used by the driver. Must be public because it's referenced from DebugSuport.c @@ -89,7 +89,7 @@ PlUnloadDebugSupportDriver ( /** C routine that is called for all registered exceptions. This is the main - exception dispatcher. + exception dispatcher. Must be public because it's referenced from AsmFuncs.s. @@ -110,8 +110,8 @@ CommonHandler ( " Context.SystemContextIpf->CrIip == %LX\n" " Context.SystemContextIpf->CrIpsr == %LX\n" " mInHandler == %X\n", - (INT32)ExceptionType, - Context, + (INT32)ExceptionType, + Context, Context.SystemContextIpf->CrIip, Context.SystemContextIpf->CrIpsr, mInHandler)); @@ -136,7 +136,7 @@ CommonHandler ( /** Given an integer number, return the physical address of the entry point in the IFT. - @param HandlerIndex Index of the Handler + @param HandlerIndex Index of the Handler @param EntryPoint IFT Entrypoint **/ @@ -360,14 +360,14 @@ UnchainExternalInterrupt ( /** Returns the maximum value that may be used for the ProcessorIndex parameter in - RegisterPeriodicCallback() and RegisterExceptionCallback(). - + RegisterPeriodicCallback() and RegisterExceptionCallback(). + Hard coded to support only 1 processor for now. @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param MaxProcessorIndex Pointer to a caller-allocated UINTN in which the maximum supported - processor index is returned. Always 0 returned. - + processor index is returned. Always 0 returned. + @retval EFI_SUCCESS Always returned with **MaxProcessorIndex set to 0. **/ @@ -384,17 +384,17 @@ GetMaximumProcessorIndex ( /** Registers a function to be called back periodically in interrupt context. - + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor the callback function applies to. @param PeriodicCallback A pointer to a function of type PERIODIC_CALLBACK that is the main periodic entry point of the debug agent. - - @retval EFI_SUCCESS The function completed successfully. + + @retval EFI_SUCCESS The function completed successfully. @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback - function was previously registered. - @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback - function. + function was previously registered. + @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback + function. **/ EFI_STATUS EFIAPI @@ -411,17 +411,17 @@ RegisterPeriodicCallback ( Registers a function to be called when a given processor exception occurs. This code executes in boot services context. - + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor the callback function applies to. @param ExceptionCallback A pointer to a function of type EXCEPTION_CALLBACK that is called - when the processor exception specified by ExceptionType occurs. - @param ExceptionType Specifies which processor exception to hook. - - @retval EFI_SUCCESS The function completed successfully. + when the processor exception specified by ExceptionType occurs. + @param ExceptionType Specifies which processor exception to hook. + + @retval EFI_SUCCESS The function completed successfully. @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback - function was previously registered. - @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback + function was previously registered. + @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback function. **/ EFI_STATUS @@ -429,27 +429,27 @@ EFIAPI RegisterExceptionCallback ( IN EFI_DEBUG_SUPPORT_PROTOCOL *This, IN UINTN ProcessorIndex, - IN EFI_EXCEPTION_CALLBACK NewCallback, + IN EFI_EXCEPTION_CALLBACK ExceptionCallback, IN EFI_EXCEPTION_TYPE ExceptionType ) { return ManageIvtEntryTable ( ExceptionType, (BUNDLE *) ((EFI_PLABEL *) HookStub)->EntryPoint, - NewCallback + ExceptionCallback ); } /** Invalidates processor instruction cache for a memory range. Subsequent execution in this range - causes a fresh memory fetch to retrieve code to be executed. - + causes a fresh memory fetch to retrieve code to be executed. + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor's instruction cache is to be invalidated. - @param Start Specifies the physical base of the memory range to be invalidated. + @param Start Specifies the physical base of the memory range to be invalidated. @param Length Specifies the minimum number of bytes in the processor's instruction - cache to invalidate. - + cache to invalidate. + @retval EFI_SUCCESS Always returned. **/ diff --git a/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.h b/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.h index 9d556a17fe..9f6bd3efdd 100644 --- a/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.h +++ b/MdeModulePkg/Universal/DebugSupportDxe/Ipf/PlDebugSupport.h @@ -1,14 +1,14 @@ /** @file IPF specific types, macros, and definitions for Debug Support Driver. - -Copyright (c) 2004 - 2008, Intel Corporation -All rights reserved. This program and the accompanying materials -are licensed and made available under the terms and conditions of the BSD License -which accompanies this distribution. The full text of the license may be found at -http://opensource.org/licenses/bsd-license.php - -THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, -WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. + +Copyright (c) 2004 - 2008, Intel Corporation +All rights reserved. This program and the accompanying materials +are licensed and made available under the terms and conditions of the BSD License +which accompanies this distribution. The full text of the license may be found at +http://opensource.org/licenses/bsd-license.php + +THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -36,7 +36,7 @@ typedef struct { } BUNDLE; /** - IPF specific DebugSupport driver initialization. + IPF specific DebugSupport driver initialization. Must be public because it's referenced from DebugSupport.c @@ -50,7 +50,7 @@ PlInitializeDebugSupportDriver ( /** Unload handler that is called during UnloadImage() - deallocates pool memory - used by the driver. + used by the driver. Must be public because it's referenced from DebugSuport.c @@ -132,14 +132,14 @@ InstructionCacheFlush ( /** Returns the maximum value that may be used for the ProcessorIndex parameter in - RegisterPeriodicCallback() and RegisterExceptionCallback(). - + RegisterPeriodicCallback() and RegisterExceptionCallback(). + Hard coded to support only 1 processor for now. @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param MaxProcessorIndex Pointer to a caller-allocated UINTN in which the maximum supported - processor index is returned. Always 0 returned. - + processor index is returned. Always 0 returned. + @retval EFI_SUCCESS Always returned with **MaxProcessorIndex set to 0. **/ @@ -152,17 +152,17 @@ GetMaximumProcessorIndex ( /** Registers a function to be called back periodically in interrupt context. - + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor the callback function applies to. @param PeriodicCallback A pointer to a function of type PERIODIC_CALLBACK that is the main periodic entry point of the debug agent. - - @retval EFI_SUCCESS The function completed successfully. + + @retval EFI_SUCCESS The function completed successfully. @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback - function was previously registered. - @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback - function. + function was previously registered. + @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback + function. **/ EFI_STATUS EFIAPI @@ -176,17 +176,17 @@ RegisterPeriodicCallback ( Registers a function to be called when a given processor exception occurs. This code executes in boot services context. - + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor the callback function applies to. @param ExceptionCallback A pointer to a function of type EXCEPTION_CALLBACK that is called when the processor exception specified by ExceptionType occurs. - @param ExceptionType Specifies which processor exception to hook. - - @retval EFI_SUCCESS The function completed successfully. + @param ExceptionType Specifies which processor exception to hook. + + @retval EFI_SUCCESS The function completed successfully. @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback - function was previously registered. - @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback + function was previously registered. + @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback function. **/ EFI_STATUS @@ -194,20 +194,20 @@ EFIAPI RegisterExceptionCallback ( IN EFI_DEBUG_SUPPORT_PROTOCOL *This, IN UINTN ProcessorIndex, - IN EFI_EXCEPTION_CALLBACK NewCallback, + IN EFI_EXCEPTION_CALLBACK ExceptionCallback, IN EFI_EXCEPTION_TYPE ExceptionType ); /** Invalidates processor instruction cache for a memory range. Subsequent execution in this range - causes a fresh memory fetch to retrieve code to be executed. - + causes a fresh memory fetch to retrieve code to be executed. + @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance. @param ProcessorIndex Specifies which processor's instruction cache is to be invalidated. - @param Start Specifies the physical base of the memory range to be invalidated. + @param Start Specifies the physical base of the memory range to be invalidated. @param Length Specifies the minimum number of bytes in the processor's instruction - cache to invalidate. - + cache to invalidate. + @retval EFI_SUCCESS Always returned. **/ @@ -222,7 +222,7 @@ InvalidateInstructionCache ( /** C routine that is called for all registered exceptions. This is the main - exception dispatcher. + exception dispatcher. Must be public because it's referenced from AsmFuncs.s. @@ -306,7 +306,7 @@ UnchainExternalInterrupt ( /** Given an integer number, return the physical address of the entry point in the IFT. - @param HandlerIndex Index of the Handler + @param HandlerIndex Index of the Handler @param EntryPoint IFT Entrypoint **/ -- 2.39.2