The DebugSupport protocol is used by source level debuggers to abstract the\r
processor and handle context save and restore operations.\r
\r
-Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>\r
+Copyright (c) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.<BR>\r
\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution. \r
+This program and the accompanying materials are licensed and made available under\r
+the terms and conditions of the BSD License that accompanies this distribution.\r
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
+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
UINT8 Xmm6[16];\r
UINT8 Xmm7[16];\r
//\r
- // NOTE: UEFI 2.0 spec definition as follows. \r
+ // NOTE: UEFI 2.0 spec definition as follows.\r
//\r
UINT8 Reserved11[14 * 16];\r
} EFI_FX_SAVE_STATE_X64;\r
// DebugSupport callback function prototypes\r
//\r
\r
-/** \r
+/**\r
Registers and enables an exception callback function for the specified exception.\r
- \r
+\r
@param ExceptionType Exception types in EBC, IA-32, x64, or IPF.\r
@param SystemContext Exception content.\r
- \r
+\r
**/\r
typedef\r
VOID\r
IN OUT EFI_SYSTEM_CONTEXT SystemContext\r
);\r
\r
-/** \r
+/**\r
Registers and enables the on-target debug agent's periodic entry point.\r
- \r
+\r
@param SystemContext Exception content.\r
- \r
+\r
**/\r
typedef\r
VOID\r
// DebugSupport member function definitions\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
@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. \r
- \r
- @retval EFI_SUCCESS The function completed successfully. \r
- \r
+ processor index is returned.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
OUT UINTN *MaxProcessorIndex\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
- \r
+ function was previously registered.\r
+ @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback\r
+ function.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_PERIODIC_CALLBACK PeriodicCallback\r
);\r
\r
-/** \r
+/**\r
Registers a function to be called when a given processor exception occurs.\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. \r
- \r
+ function was previously registered.\r
+ @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback\r
+ function.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
IN EFI_EXCEPTION_TYPE ExceptionType\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
- @retval EFI_SUCCESS The function completed successfully. \r
- \r
+ cache to invalidate.\r
+\r
+ @retval EFI_SUCCESS The function completed successfully.\r
+\r
**/\r
typedef\r
EFI_STATUS\r
);\r
\r
///\r
-/// This protocol provides the services to allow the debug agent to register \r
-/// callback functions that are called either periodically or when specific \r
+/// This protocol provides the services to allow the debug agent to register\r
+/// callback functions that are called either periodically or when specific\r
/// processor exceptions occur.\r
///\r
struct _EFI_DEBUG_SUPPORT_PROTOCOL {\r
\r
extern EFI_GUID gEfiDebugSupportProtocolGuid;\r
\r
-#endif \r
+#endif\r
projects / mirror_edk2.git / blobdiff