/** @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 / blobdiff