iPXE
Data Structures | Defines | Typedefs | Enumerations | Functions | Variables
DebugSupport.h File Reference

DebugSupport protocol and supporting definitions as defined in the UEFI2.4 specification. More...

#include <ipxe/efi/IndustryStandard/PeImage.h>

Go to the source code of this file.

Data Structures

struct  EFI_FX_SAVE_STATE_IA32
 FXSAVE_STATE. More...
struct  EFI_SYSTEM_CONTEXT_IA32
 IA-32 processor context definition. More...
struct  EFI_FX_SAVE_STATE_X64
 FXSAVE_STATE. More...
struct  EFI_SYSTEM_CONTEXT_X64
 x64 processor context definition. More...
struct  EFI_SYSTEM_CONTEXT_IPF
 IPF processor context definition. More...
struct  EFI_SYSTEM_CONTEXT_EBC
 EBC processor context definition. More...
struct  EFI_SYSTEM_CONTEXT_ARM
 ARM processor context definition. More...
struct  EFI_SYSTEM_CONTEXT_AARCH64
union  EFI_SYSTEM_CONTEXT
 Universal EFI_SYSTEM_CONTEXT definition. More...
struct  _EFI_DEBUG_SUPPORT_PROTOCOL
 This protocol provides the services to allow the debug agent to register callback functions that are called either periodically or when specific processor exceptions occur. More...

Defines

#define EFI_DEBUG_SUPPORT_PROTOCOL_GUID
 Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}.
#define EXCEPT_IA32_DIVIDE_ERROR   0
 IA-32 processor exception types.
#define EXCEPT_IA32_DEBUG   1
#define EXCEPT_IA32_NMI   2
#define EXCEPT_IA32_BREAKPOINT   3
#define EXCEPT_IA32_OVERFLOW   4
#define EXCEPT_IA32_BOUND   5
#define EXCEPT_IA32_INVALID_OPCODE   6
#define EXCEPT_IA32_DOUBLE_FAULT   8
#define EXCEPT_IA32_INVALID_TSS   10
#define EXCEPT_IA32_SEG_NOT_PRESENT   11
#define EXCEPT_IA32_STACK_FAULT   12
#define EXCEPT_IA32_GP_FAULT   13
#define EXCEPT_IA32_PAGE_FAULT   14
#define EXCEPT_IA32_FP_ERROR   16
#define EXCEPT_IA32_ALIGNMENT_CHECK   17
#define EXCEPT_IA32_MACHINE_CHECK   18
#define EXCEPT_IA32_SIMD   19
#define EXCEPT_X64_DIVIDE_ERROR   0
 x64 processor exception types.
#define EXCEPT_X64_DEBUG   1
#define EXCEPT_X64_NMI   2
#define EXCEPT_X64_BREAKPOINT   3
#define EXCEPT_X64_OVERFLOW   4
#define EXCEPT_X64_BOUND   5
#define EXCEPT_X64_INVALID_OPCODE   6
#define EXCEPT_X64_DOUBLE_FAULT   8
#define EXCEPT_X64_INVALID_TSS   10
#define EXCEPT_X64_SEG_NOT_PRESENT   11
#define EXCEPT_X64_STACK_FAULT   12
#define EXCEPT_X64_GP_FAULT   13
#define EXCEPT_X64_PAGE_FAULT   14
#define EXCEPT_X64_FP_ERROR   16
#define EXCEPT_X64_ALIGNMENT_CHECK   17
#define EXCEPT_X64_MACHINE_CHECK   18
#define EXCEPT_X64_SIMD   19
#define EXCEPT_IPF_VHTP_TRANSLATION   0
 Itanium Processor Family Exception types.
#define EXCEPT_IPF_INSTRUCTION_TLB   1
#define EXCEPT_IPF_DATA_TLB   2
#define EXCEPT_IPF_ALT_INSTRUCTION_TLB   3
#define EXCEPT_IPF_ALT_DATA_TLB   4
#define EXCEPT_IPF_DATA_NESTED_TLB   5
#define EXCEPT_IPF_INSTRUCTION_KEY_MISSED   6
#define EXCEPT_IPF_DATA_KEY_MISSED   7
#define EXCEPT_IPF_DIRTY_BIT   8
#define EXCEPT_IPF_INSTRUCTION_ACCESS_BIT   9
#define EXCEPT_IPF_DATA_ACCESS_BIT   10
#define EXCEPT_IPF_BREAKPOINT   11
#define EXCEPT_IPF_EXTERNAL_INTERRUPT   12
#define EXCEPT_IPF_PAGE_NOT_PRESENT   20
#define EXCEPT_IPF_KEY_PERMISSION   21
#define EXCEPT_IPF_INSTRUCTION_ACCESS_RIGHTS   22
#define EXCEPT_IPF_DATA_ACCESS_RIGHTS   23
#define EXCEPT_IPF_GENERAL_EXCEPTION   24
#define EXCEPT_IPF_DISABLED_FP_REGISTER   25
#define EXCEPT_IPF_NAT_CONSUMPTION   26
#define EXCEPT_IPF_SPECULATION   27
#define EXCEPT_IPF_DEBUG   29
#define EXCEPT_IPF_UNALIGNED_REFERENCE   30
#define EXCEPT_IPF_UNSUPPORTED_DATA_REFERENCE   31
#define EXCEPT_IPF_FP_FAULT   32
#define EXCEPT_IPF_FP_TRAP   33
#define EXCEPT_IPF_LOWER_PRIVILEGE_TRANSFER_TRAP   34
#define EXCEPT_IPF_TAKEN_BRANCH   35
#define EXCEPT_IPF_SINGLE_STEP   36
#define EXCEPT_IPF_IA32_EXCEPTION   45
#define EXCEPT_IPF_IA32_INTERCEPT   46
#define EXCEPT_IPF_IA32_INTERRUPT   47
#define EXCEPT_EBC_UNDEFINED   0
 EBC processor exception types.
#define EXCEPT_EBC_DIVIDE_ERROR   1
#define EXCEPT_EBC_DEBUG   2
#define EXCEPT_EBC_BREAKPOINT   3
#define EXCEPT_EBC_OVERFLOW   4
#define EXCEPT_EBC_INVALID_OPCODE   5
 Opcode out of range.
#define EXCEPT_EBC_STACK_FAULT   6
#define EXCEPT_EBC_ALIGNMENT_CHECK   7
#define EXCEPT_EBC_INSTRUCTION_ENCODING   8
 Malformed instruction.
#define EXCEPT_EBC_BAD_BREAK   9
 BREAK 0 or undefined BREAK.
#define EXCEPT_EBC_STEP   10
 To support debug stepping.
#define MAX_EBC_EXCEPTION   EXCEPT_EBC_STEP
 For coding convenience, define the maximum valid EBC exception.
#define EXCEPT_ARM_RESET   0
 ARM processor exception types.
#define EXCEPT_ARM_UNDEFINED_INSTRUCTION   1
#define EXCEPT_ARM_SOFTWARE_INTERRUPT   2
#define EXCEPT_ARM_PREFETCH_ABORT   3
#define EXCEPT_ARM_DATA_ABORT   4
#define EXCEPT_ARM_RESERVED   5
#define EXCEPT_ARM_IRQ   6
#define EXCEPT_ARM_FIQ   7
#define MAX_ARM_EXCEPTION   EXCEPT_ARM_FIQ
 For coding convenience, define the maximum valid ARM exception.
#define EXCEPT_AARCH64_SYNCHRONOUS_EXCEPTIONS   0
 AARCH64 processor exception types.
#define EXCEPT_AARCH64_IRQ   1
#define EXCEPT_AARCH64_FIQ   2
#define EXCEPT_AARCH64_SERROR   3
#define MAX_AARCH64_EXCEPTION   EXCEPT_AARCH64_SERROR
 For coding convenience, define the maximum valid ARM exception.

Typedefs

typedef struct
_EFI_DEBUG_SUPPORT_PROTOCOL 
EFI_DEBUG_SUPPORT_PROTOCOL
typedef INTN EFI_EXCEPTION_TYPE
 Processor exception to be hooked.
typedef VOID(EFIAPIEFI_EXCEPTION_CALLBACK )(IN EFI_EXCEPTION_TYPE ExceptionType, IN OUT EFI_SYSTEM_CONTEXT SystemContext)
 Registers and enables an exception callback function for the specified exception.
typedef VOID(EFIAPIEFI_PERIODIC_CALLBACK )(IN OUT EFI_SYSTEM_CONTEXT SystemContext)
 Registers and enables the on-target debug agent's periodic entry point.
typedef EFI_STATUS(EFIAPIEFI_GET_MAXIMUM_PROCESSOR_INDEX )(IN EFI_DEBUG_SUPPORT_PROTOCOL *This, OUT UINTN *MaxProcessorIndex)
 Returns the maximum value that may be used for the ProcessorIndex parameter in RegisterPeriodicCallback() and RegisterExceptionCallback().
typedef EFI_STATUS(EFIAPIEFI_REGISTER_PERIODIC_CALLBACK )(IN EFI_DEBUG_SUPPORT_PROTOCOL *This, IN UINTN ProcessorIndex, IN EFI_PERIODIC_CALLBACK PeriodicCallback)
 Registers a function to be called back periodically in interrupt context.
typedef EFI_STATUS(EFIAPIEFI_REGISTER_EXCEPTION_CALLBACK )(IN EFI_DEBUG_SUPPORT_PROTOCOL *This, IN UINTN ProcessorIndex, IN EFI_EXCEPTION_CALLBACK ExceptionCallback, IN EFI_EXCEPTION_TYPE ExceptionType)
 Registers a function to be called when a given processor exception occurs.
typedef EFI_STATUS(EFIAPIEFI_INVALIDATE_INSTRUCTION_CACHE )(IN EFI_DEBUG_SUPPORT_PROTOCOL *This, IN UINTN ProcessorIndex, IN VOID *Start, IN UINT64 Length)
 Invalidates processor instruction cache for a memory range.

Enumerations

enum  EFI_INSTRUCTION_SET_ARCHITECTURE {
  IsaIa32 = IMAGE_FILE_MACHINE_I386, IsaX64 = IMAGE_FILE_MACHINE_X64, IsaIpf = IMAGE_FILE_MACHINE_IA64, IsaEbc = IMAGE_FILE_MACHINE_EBC,
  IsaArm = IMAGE_FILE_MACHINE_ARMTHUMB_MIXED, IsaAArch64 = IMAGE_FILE_MACHINE_ARM64
}
 Machine type definition. More...

Functions

 FILE_LICENCE (BSD3)

Variables

EFI_GUID gEfiDebugSupportProtocolGuid

Detailed Description

DebugSupport protocol and supporting definitions as defined in the UEFI2.4 specification.

The DebugSupport protocol is used by source level debuggers to abstract the processor and handle context save and restore operations.

Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.
Portions copyright (c) 2011 - 2013, ARM Ltd. All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License that 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.

Definition in file DebugSupport.h.


Define Documentation

Value:
{ \
    0x2755590C, 0x6F3C, 0x42FA, {0x9E, 0xA4, 0xA3, 0xBA, 0x54, 0x3C, 0xDA, 0x25 } \
  }

Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}.

Definition at line 33 of file DebugSupport.h.

#define EXCEPT_IA32_DIVIDE_ERROR   0

IA-32 processor exception types.

Definition at line 47 of file DebugSupport.h.

#define EXCEPT_IA32_DEBUG   1

Definition at line 48 of file DebugSupport.h.

#define EXCEPT_IA32_NMI   2

Definition at line 49 of file DebugSupport.h.

#define EXCEPT_IA32_BREAKPOINT   3

Definition at line 50 of file DebugSupport.h.

#define EXCEPT_IA32_OVERFLOW   4

Definition at line 51 of file DebugSupport.h.

#define EXCEPT_IA32_BOUND   5

Definition at line 52 of file DebugSupport.h.

Definition at line 53 of file DebugSupport.h.

#define EXCEPT_IA32_DOUBLE_FAULT   8

Definition at line 54 of file DebugSupport.h.

#define EXCEPT_IA32_INVALID_TSS   10

Definition at line 55 of file DebugSupport.h.

#define EXCEPT_IA32_SEG_NOT_PRESENT   11

Definition at line 56 of file DebugSupport.h.

#define EXCEPT_IA32_STACK_FAULT   12

Definition at line 57 of file DebugSupport.h.

#define EXCEPT_IA32_GP_FAULT   13

Definition at line 58 of file DebugSupport.h.

#define EXCEPT_IA32_PAGE_FAULT   14

Definition at line 59 of file DebugSupport.h.

#define EXCEPT_IA32_FP_ERROR   16

Definition at line 60 of file DebugSupport.h.

#define EXCEPT_IA32_ALIGNMENT_CHECK   17

Definition at line 61 of file DebugSupport.h.

#define EXCEPT_IA32_MACHINE_CHECK   18

Definition at line 62 of file DebugSupport.h.

#define EXCEPT_IA32_SIMD   19

Definition at line 63 of file DebugSupport.h.

#define EXCEPT_X64_DIVIDE_ERROR   0

x64 processor exception types.

Definition at line 141 of file DebugSupport.h.

#define EXCEPT_X64_DEBUG   1

Definition at line 142 of file DebugSupport.h.

#define EXCEPT_X64_NMI   2

Definition at line 143 of file DebugSupport.h.

#define EXCEPT_X64_BREAKPOINT   3

Definition at line 144 of file DebugSupport.h.

#define EXCEPT_X64_OVERFLOW   4

Definition at line 145 of file DebugSupport.h.

#define EXCEPT_X64_BOUND   5

Definition at line 146 of file DebugSupport.h.

#define EXCEPT_X64_INVALID_OPCODE   6

Definition at line 147 of file DebugSupport.h.

#define EXCEPT_X64_DOUBLE_FAULT   8

Definition at line 148 of file DebugSupport.h.

#define EXCEPT_X64_INVALID_TSS   10

Definition at line 149 of file DebugSupport.h.

#define EXCEPT_X64_SEG_NOT_PRESENT   11

Definition at line 150 of file DebugSupport.h.

#define EXCEPT_X64_STACK_FAULT   12

Definition at line 151 of file DebugSupport.h.

#define EXCEPT_X64_GP_FAULT   13

Definition at line 152 of file DebugSupport.h.

#define EXCEPT_X64_PAGE_FAULT   14

Definition at line 153 of file DebugSupport.h.

#define EXCEPT_X64_FP_ERROR   16

Definition at line 154 of file DebugSupport.h.

#define EXCEPT_X64_ALIGNMENT_CHECK   17

Definition at line 155 of file DebugSupport.h.

#define EXCEPT_X64_MACHINE_CHECK   18

Definition at line 156 of file DebugSupport.h.

#define EXCEPT_X64_SIMD   19

Definition at line 157 of file DebugSupport.h.

Itanium Processor Family Exception types.

Definition at line 244 of file DebugSupport.h.

Definition at line 245 of file DebugSupport.h.

#define EXCEPT_IPF_DATA_TLB   2

Definition at line 246 of file DebugSupport.h.

Definition at line 247 of file DebugSupport.h.

#define EXCEPT_IPF_ALT_DATA_TLB   4

Definition at line 248 of file DebugSupport.h.

Definition at line 249 of file DebugSupport.h.

Definition at line 250 of file DebugSupport.h.

Definition at line 251 of file DebugSupport.h.

#define EXCEPT_IPF_DIRTY_BIT   8

Definition at line 252 of file DebugSupport.h.

Definition at line 253 of file DebugSupport.h.

#define EXCEPT_IPF_DATA_ACCESS_BIT   10

Definition at line 254 of file DebugSupport.h.

#define EXCEPT_IPF_BREAKPOINT   11

Definition at line 255 of file DebugSupport.h.

Definition at line 256 of file DebugSupport.h.

#define EXCEPT_IPF_PAGE_NOT_PRESENT   20

Definition at line 260 of file DebugSupport.h.

#define EXCEPT_IPF_KEY_PERMISSION   21

Definition at line 261 of file DebugSupport.h.

Definition at line 262 of file DebugSupport.h.

Definition at line 263 of file DebugSupport.h.

Definition at line 264 of file DebugSupport.h.

Definition at line 265 of file DebugSupport.h.

#define EXCEPT_IPF_NAT_CONSUMPTION   26

Definition at line 266 of file DebugSupport.h.

#define EXCEPT_IPF_SPECULATION   27

Definition at line 267 of file DebugSupport.h.

#define EXCEPT_IPF_DEBUG   29

Definition at line 271 of file DebugSupport.h.

Definition at line 272 of file DebugSupport.h.

Definition at line 273 of file DebugSupport.h.

#define EXCEPT_IPF_FP_FAULT   32

Definition at line 274 of file DebugSupport.h.

#define EXCEPT_IPF_FP_TRAP   33

Definition at line 275 of file DebugSupport.h.

Definition at line 276 of file DebugSupport.h.

#define EXCEPT_IPF_TAKEN_BRANCH   35

Definition at line 277 of file DebugSupport.h.

#define EXCEPT_IPF_SINGLE_STEP   36

Definition at line 278 of file DebugSupport.h.

#define EXCEPT_IPF_IA32_EXCEPTION   45

Definition at line 282 of file DebugSupport.h.

#define EXCEPT_IPF_IA32_INTERCEPT   46

Definition at line 283 of file DebugSupport.h.

#define EXCEPT_IPF_IA32_INTERRUPT   47

Definition at line 284 of file DebugSupport.h.

#define EXCEPT_EBC_UNDEFINED   0

EBC processor exception types.

Definition at line 445 of file DebugSupport.h.

#define EXCEPT_EBC_DIVIDE_ERROR   1

Definition at line 446 of file DebugSupport.h.

#define EXCEPT_EBC_DEBUG   2

Definition at line 447 of file DebugSupport.h.

#define EXCEPT_EBC_BREAKPOINT   3

Definition at line 448 of file DebugSupport.h.

#define EXCEPT_EBC_OVERFLOW   4

Definition at line 449 of file DebugSupport.h.

#define EXCEPT_EBC_INVALID_OPCODE   5

Opcode out of range.

Definition at line 450 of file DebugSupport.h.

#define EXCEPT_EBC_STACK_FAULT   6

Definition at line 451 of file DebugSupport.h.

Definition at line 452 of file DebugSupport.h.

Malformed instruction.

Definition at line 453 of file DebugSupport.h.

#define EXCEPT_EBC_BAD_BREAK   9

BREAK 0 or undefined BREAK.

Definition at line 454 of file DebugSupport.h.

#define EXCEPT_EBC_STEP   10

To support debug stepping.

Definition at line 455 of file DebugSupport.h.

For coding convenience, define the maximum valid EBC exception.

Definition at line 459 of file DebugSupport.h.

#define EXCEPT_ARM_RESET   0

ARM processor exception types.

Definition at line 483 of file DebugSupport.h.

Definition at line 484 of file DebugSupport.h.

Definition at line 485 of file DebugSupport.h.

#define EXCEPT_ARM_PREFETCH_ABORT   3

Definition at line 486 of file DebugSupport.h.

#define EXCEPT_ARM_DATA_ABORT   4

Definition at line 487 of file DebugSupport.h.

#define EXCEPT_ARM_RESERVED   5

Definition at line 488 of file DebugSupport.h.

#define EXCEPT_ARM_IRQ   6

Definition at line 489 of file DebugSupport.h.

#define EXCEPT_ARM_FIQ   7

Definition at line 490 of file DebugSupport.h.

For coding convenience, define the maximum valid ARM exception.

Definition at line 495 of file DebugSupport.h.

AARCH64 processor exception types.

Definition at line 528 of file DebugSupport.h.

#define EXCEPT_AARCH64_IRQ   1

Definition at line 529 of file DebugSupport.h.

#define EXCEPT_AARCH64_FIQ   2

Definition at line 530 of file DebugSupport.h.

#define EXCEPT_AARCH64_SERROR   3

Definition at line 531 of file DebugSupport.h.

For coding convenience, define the maximum valid ARM exception.

Definition at line 536 of file DebugSupport.h.


Typedef Documentation

Definition at line 28 of file DebugSupport.h.

Processor exception to be hooked.

All exception types for IA32, X64, Itanium and EBC processors are defined.

Definition at line 42 of file DebugSupport.h.

typedef VOID(EFIAPI * EFI_EXCEPTION_CALLBACK)(IN EFI_EXCEPTION_TYPE ExceptionType, IN OUT EFI_SYSTEM_CONTEXT SystemContext)

Registers and enables an exception callback function for the specified exception.

Parameters:
ExceptionTypeException types in EBC, IA-32, x64, or IPF.
SystemContextException content.

Definition at line 640 of file DebugSupport.h.

Registers and enables the on-target debug agent's periodic entry point.

Parameters:
SystemContextException content.

Definition at line 653 of file DebugSupport.h.

Returns the maximum value that may be used for the ProcessorIndex parameter in RegisterPeriodicCallback() and RegisterExceptionCallback().

Parameters:
ThisA pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
MaxProcessorIndexPointer to a caller-allocated UINTN in which the maximum supported processor index is returned.
Return values:
EFI_SUCCESSThe function completed successfully.

Definition at line 687 of file DebugSupport.h.

Registers a function to be called back periodically in interrupt context.

Parameters:
ThisA pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
ProcessorIndexSpecifies which processor the callback function applies to.
PeriodicCallbackA pointer to a function of type PERIODIC_CALLBACK that is the main periodic entry point of the debug agent.
Return values:
EFI_SUCCESSThe function completed successfully.
EFI_ALREADY_STARTEDNon-NULL PeriodicCallback parameter when a callback function was previously registered.
EFI_OUT_OF_RESOURCESSystem has insufficient memory resources to register new callback function.

Definition at line 709 of file DebugSupport.h.

Registers a function to be called when a given processor exception occurs.

Parameters:
ThisA pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
ProcessorIndexSpecifies which processor the callback function applies to.
ExceptionCallbackA pointer to a function of type EXCEPTION_CALLBACK that is called when the processor exception specified by ExceptionType occurs.
ExceptionTypeSpecifies which processor exception to hook.
Return values:
EFI_SUCCESSThe function completed successfully.
EFI_ALREADY_STARTEDNon-NULL PeriodicCallback parameter when a callback function was previously registered.
EFI_OUT_OF_RESOURCESSystem has insufficient memory resources to register new callback function.

Definition at line 733 of file DebugSupport.h.

Invalidates processor instruction cache for a memory range.

Subsequent execution in this range causes a fresh memory fetch to retrieve code to be executed.

Parameters:
ThisA pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
ProcessorIndexSpecifies which processor's instruction cache is to be invalidated.
StartSpecifies the physical base of the memory range to be invalidated.
LengthSpecifies the minimum number of bytes in the processor's instruction cache to invalidate.
Return values:
EFI_SUCCESSThe function completed successfully.

Definition at line 755 of file DebugSupport.h.


Enumeration Type Documentation

Machine type definition.

Enumerator:
IsaIa32 

0x014C

IsaX64 

0x8664

IsaIpf 

0x0200

IsaEbc 

0x0EBC

IsaArm 

0x01c2

IsaAArch64 

0xAA64

Definition at line 660 of file DebugSupport.h.


Function Documentation

FILE_LICENCE ( BSD3  )

Variable Documentation