2 DebugSupport protocol and supporting definitions as defined in the UEFI2.0
5 The DebugSupport protocol is used by source level debuggers to abstract the
6 processor and handle context save and restore operations.
8 Copyright (c) 2006, Intel Corporation
9 All rights reserved. This program and the accompanying materials
10 are licensed and made available under the terms and conditions of the BSD License
11 which accompanies this distribution. The full text of the license may be found at
12 http://opensource.org/licenses/bsd-license.php
14 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
15 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
17 Module Name: DebugSupport.h
21 #ifndef __DEBUG_SUPPORT_H__
22 #define __DEBUG_SUPPORT_H__
24 typedef struct _EFI_DEBUG_SUPPORT_PROTOCOL EFI_DEBUG_SUPPORT_PROTOCOL
;
27 // Debug Support protocol {2755590C-6F3C-42FA-9EA4-A3BA543CDA25}
29 #define EFI_DEBUG_SUPPORT_PROTOCOL_GUID \
31 0x2755590C, 0x6F3C, 0x42FA, {0x9E, 0xA4, 0xA3, 0xBA, 0x54, 0x3C, 0xDA, 0x25 } \
35 // Debug Support definitions
37 typedef INTN EFI_EXCEPTION_TYPE
;
40 // IA-32 processor exception types
42 #define EXCEPT_IA32_DIVIDE_ERROR 0
43 #define EXCEPT_IA32_DEBUG 1
44 #define EXCEPT_IA32_NMI 2
45 #define EXCEPT_IA32_BREAKPOINT 3
46 #define EXCEPT_IA32_OVERFLOW 4
47 #define EXCEPT_IA32_BOUND 5
48 #define EXCEPT_IA32_INVALID_OPCODE 6
49 #define EXCEPT_IA32_DOUBLE_FAULT 8
50 #define EXCEPT_IA32_INVALID_TSS 10
51 #define EXCEPT_IA32_SEG_NOT_PRESENT 11
52 #define EXCEPT_IA32_STACK_FAULT 12
53 #define EXCEPT_IA32_GP_FAULT 13
54 #define EXCEPT_IA32_PAGE_FAULT 14
55 #define EXCEPT_IA32_FP_ERROR 16
56 #define EXCEPT_IA32_ALIGNMENT_CHECK 17
57 #define EXCEPT_IA32_MACHINE_CHECK 18
58 #define EXCEPT_IA32_SIMD 19
61 // IA-32 processor context definition
65 // FP / MMX / XMM registers (see fxrstor instruction definition)
78 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
79 UINT8 St0Mm0
[10], Reserved3
[6];
80 UINT8 St1Mm1
[10], Reserved4
[6];
81 UINT8 St2Mm2
[10], Reserved5
[6];
82 UINT8 St3Mm3
[10], Reserved6
[6];
83 UINT8 St4Mm4
[10], Reserved7
[6];
84 UINT8 St5Mm5
[10], Reserved8
[6];
85 UINT8 St6Mm6
[10], Reserved9
[6];
86 UINT8 St7Mm7
[10], Reserved10
[6];
95 UINT8 Reserved11
[14 * 16];
96 } EFI_FX_SAVE_STATE_IA32
;
98 UINT8 St0Mm0
[10], Reserved3
[6];
99 UINT8 St0Mm1
[10], Reserved4
[6];
100 UINT8 St0Mm2
[10], Reserved5
[6];
101 UINT8 St0Mm3
[10], Reserved6
[6];
102 UINT8 St0Mm4
[10], Reserved7
[6];
103 UINT8 St0Mm5
[10], Reserved8
[6];
104 UINT8 St0Mm6
[10], Reserved9
[6];
105 UINT8 St0Mm7
[10], Reserved10
[6];
106 UINT8 Reserved11
[22 * 16];
111 UINT32 ExceptionData
;
112 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
113 EFI_FX_SAVE_STATE_IA32 FxSaveState
;
115 EFI_FX_SAVE_STATE FxSaveState
;
124 UINT32 Cr1
; /* Reserved */
148 } EFI_SYSTEM_CONTEXT_IA32
;
151 // X64 processor exception types
153 #define EXCEPT_X64_DIVIDE_ERROR 0
154 #define EXCEPT_X64_DEBUG 1
155 #define EXCEPT_X64_NMI 2
156 #define EXCEPT_X64_BREAKPOINT 3
157 #define EXCEPT_X64_OVERFLOW 4
158 #define EXCEPT_X64_BOUND 5
159 #define EXCEPT_X64_INVALID_OPCODE 6
160 #define EXCEPT_X64_DOUBLE_FAULT 8
161 #define EXCEPT_X64_INVALID_TSS 10
162 #define EXCEPT_X64_SEG_NOT_PRESENT 11
163 #define EXCEPT_X64_STACK_FAULT 12
164 #define EXCEPT_X64_GP_FAULT 13
165 #define EXCEPT_X64_PAGE_FAULT 14
166 #define EXCEPT_X64_FP_ERROR 16
167 #define EXCEPT_X64_ALIGNMENT_CHECK 17
168 #define EXCEPT_X64_MACHINE_CHECK 18
169 #define EXCEPT_X64_SIMD 19
172 // X64 processor context definition
175 // FP / MMX / XMM registers (see fxrstor instruction definition)
185 UINT8 St0Mm0
[10], Reserved2
[6];
186 UINT8 St1Mm1
[10], Reserved3
[6];
187 UINT8 St2Mm2
[10], Reserved4
[6];
188 UINT8 St3Mm3
[10], Reserved5
[6];
189 UINT8 St4Mm4
[10], Reserved6
[6];
190 UINT8 St5Mm5
[10], Reserved7
[6];
191 UINT8 St6Mm6
[10], Reserved8
[6];
192 UINT8 St7Mm7
[10], Reserved9
[6];
201 #if (EFI_SPECIFICATION_VERSION >= 0x00020000)
203 // NOTE: UEFI 2.0 spec definition as follows. It should be updated
204 // after spec update.
206 UINT8 Reserved11
[14 * 16];
216 UINT8 Reserved10
[6 * 16];
218 } EFI_FX_SAVE_STATE_X64
;
221 UINT64 ExceptionData
;
222 EFI_FX_SAVE_STATE_X64 FxSaveState
;
230 UINT64 Cr1
; /* Reserved */
263 } EFI_SYSTEM_CONTEXT_X64
;
266 // IPF processor exception types
268 #define EXCEPT_IPF_VHTP_TRANSLATION 0
269 #define EXCEPT_IPF_INSTRUCTION_TLB 1
270 #define EXCEPT_IPF_DATA_TLB 2
271 #define EXCEPT_IPF_ALT_INSTRUCTION_TLB 3
272 #define EXCEPT_IPF_ALT_DATA_TLB 4
273 #define EXCEPT_IPF_DATA_NESTED_TLB 5
274 #define EXCEPT_IPF_INSTRUCTION_KEY_MISSED 6
275 #define EXCEPT_IPF_DATA_KEY_MISSED 7
276 #define EXCEPT_IPF_DIRTY_BIT 8
277 #define EXCEPT_IPF_INSTRUCTION_ACCESS_BIT 9
278 #define EXCEPT_IPF_DATA_ACCESS_BIT 10
279 #define EXCEPT_IPF_BREAKPOINT 11
280 #define EXCEPT_IPF_EXTERNAL_INTERRUPT 12
284 #define EXCEPT_IPF_PAGE_NOT_PRESENT 20
285 #define EXCEPT_IPF_KEY_PERMISSION 21
286 #define EXCEPT_IPF_INSTRUCTION_ACCESS_RIGHTS 22
287 #define EXCEPT_IPF_DATA_ACCESS_RIGHTS 23
288 #define EXCEPT_IPF_GENERAL_EXCEPTION 24
289 #define EXCEPT_IPF_DISABLED_FP_REGISTER 25
290 #define EXCEPT_IPF_NAT_CONSUMPTION 26
291 #define EXCEPT_IPF_SPECULATION 27
295 #define EXCEPT_IPF_DEBUG 29
296 #define EXCEPT_IPF_UNALIGNED_REFERENCE 30
297 #define EXCEPT_IPF_UNSUPPORTED_DATA_REFERENCE 31
298 #define EXCEPT_IPF_FP_FAULT 32
299 #define EXCEPT_IPF_FP_TRAP 33
300 #define EXCEPT_IPF_LOWER_PRIVILEGE_TRANSFER_TRAP 34
301 #define EXCEPT_IPF_TAKEN_BRANCH 35
302 #define EXCEPT_IPF_SINGLE_STEP 36
306 #define EXCEPT_IPF_IA32_EXCEPTION 45
307 #define EXCEPT_IPF_IA32_INTERCEPT 46
308 #define EXCEPT_IPF_IA32_INTERRUPT 47
311 // IPF processor context definition
315 // The first reserved field is necessary to preserve alignment for the correct
316 // bits in UNAT and to insure F2 is 16 byte aligned..
394 // application registers
460 // virtual registers - nat bits for R1-R31
464 } EFI_SYSTEM_CONTEXT_IPF
;
467 // EBC processor exception types
469 #define EXCEPT_EBC_UNDEFINED 0
470 #define EXCEPT_EBC_DIVIDE_ERROR 1
471 #define EXCEPT_EBC_DEBUG 2
472 #define EXCEPT_EBC_BREAKPOINT 3
473 #define EXCEPT_EBC_OVERFLOW 4
474 #define EXCEPT_EBC_INVALID_OPCODE 5 // opcode out of range
475 #define EXCEPT_EBC_STACK_FAULT 6
476 #define EXCEPT_EBC_ALIGNMENT_CHECK 7
477 #define EXCEPT_EBC_INSTRUCTION_ENCODING 8 // malformed instruction
478 #define EXCEPT_EBC_BAD_BREAK 9 // BREAK 0 or undefined BREAK
479 #define EXCEPT_EBC_STEP 10 // to support debug stepping
481 // For coding convenience, define the maximum valid EBC exception.
483 #define MAX_EBC_EXCEPTION EXCEPT_EBC_STEP
486 // EBC processor context definition
500 } EFI_SYSTEM_CONTEXT_EBC
;
503 // Universal EFI_SYSTEM_CONTEXT definition
506 EFI_SYSTEM_CONTEXT_EBC
*SystemContextEbc
;
507 EFI_SYSTEM_CONTEXT_IA32
*SystemContextIa32
;
508 EFI_SYSTEM_CONTEXT_X64
*SystemContextX64
;
509 EFI_SYSTEM_CONTEXT_IPF
*SystemContextIpf
;
510 } EFI_SYSTEM_CONTEXT
;
513 // DebugSupport callback function prototypes
517 Registers and enables an exception callback function for the specified exception.
519 @param ExceptionType Exception types in EBC, IA-32, X64, or IPF
520 @param SystemContext Exception content.
525 (*EFI_EXCEPTION_CALLBACK
) (
526 IN EFI_EXCEPTION_TYPE ExceptionType
,
527 IN OUT EFI_SYSTEM_CONTEXT SystemContext
531 Registers and enables the on-target debug agent's periodic entry point.
533 @param SystemContext Exception content.
538 (*EFI_PERIODIC_CALLBACK
) (
539 IN OUT EFI_SYSTEM_CONTEXT SystemContext
543 // Machine type definition
546 IsaIa32
= IMAGE_FILE_MACHINE_I386
, // 0x014C
547 IsaX64
= IMAGE_FILE_MACHINE_X64
, // 0x8664
548 IsaIpf
= IMAGE_FILE_MACHINE_IA64
, // 0x0200
549 IsaEbc
= IMAGE_FILE_MACHINE_EBC
// 0x0EBC
550 } EFI_INSTRUCTION_SET_ARCHITECTURE
;
554 // DebugSupport member function definitions
558 Returns the maximum value that may be used for the ProcessorIndex parameter in
559 RegisterPeriodicCallback() and RegisterExceptionCallback().
561 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
562 @param MaxProcessorIndex Pointer to a caller-allocated UINTN in which the maximum supported
563 processor index is returned.
565 @retval EFI_SUCCESS The function completed successfully.
570 (EFIAPI
*EFI_GET_MAXIMUM_PROCESSOR_INDEX
) (
571 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
572 OUT UINTN
*MaxProcessorIndex
576 Registers a function to be called back periodically in interrupt context.
578 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
579 @param ProcessorIndex Specifies which processor the callback function applies to.
580 @param PeriodicCallback A pointer to a function of type PERIODIC_CALLBACK that is the main
581 periodic entry point of the debug agent.
583 @retval EFI_SUCCESS The function completed successfully.
584 @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback
585 function was previously registered.
586 @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback
592 (EFIAPI
*EFI_REGISTER_PERIODIC_CALLBACK
) (
593 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
594 IN UINTN ProcessorIndex
,
595 IN EFI_PERIODIC_CALLBACK PeriodicCallback
599 Registers a function to be called when a given processor exception occurs.
601 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
602 @param ProcessorIndex Specifies which processor the callback function applies to.
603 @param PeriodicCallback A pointer to a function of type EXCEPTION_CALLBACK that is called
604 when the processor exception specified by ExceptionType occurs.
605 @param ExceptionType Specifies which processor exception to hook.
607 @retval EFI_SUCCESS The function completed successfully.
608 @retval EFI_ALREADY_STARTED Non-NULL PeriodicCallback parameter when a callback
609 function was previously registered.
610 @retval EFI_OUT_OF_RESOURCES System has insufficient memory resources to register new callback
616 (EFIAPI
*EFI_REGISTER_EXCEPTION_CALLBACK
) (
617 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
618 IN UINTN ProcessorIndex
,
619 IN EFI_EXCEPTION_CALLBACK ExceptionCallback
,
620 IN EFI_EXCEPTION_TYPE ExceptionType
624 Invalidates processor instruction cache for a memory range. Subsequent execution in this range
625 causes a fresh memory fetch to retrieve code to be executed.
627 @param This A pointer to the EFI_DEBUG_SUPPORT_PROTOCOL instance.
628 @param ProcessorIndex Specifies which processor's instruction cache is to be invalidated.
629 @param Start Specifies the physical base of the memory range to be invalidated.
630 @param Length Specifies the minimum number of bytes in the processor's instruction
633 @retval EFI_SUCCESS The function completed successfully.
638 (EFIAPI
*EFI_INVALIDATE_INSTRUCTION_CACHE
) (
639 IN EFI_DEBUG_SUPPORT_PROTOCOL
*This
,
640 IN UINTN ProcessorIndex
,
646 // DebugSupport protocol definition
648 struct _EFI_DEBUG_SUPPORT_PROTOCOL
{
649 EFI_INSTRUCTION_SET_ARCHITECTURE Isa
;
650 EFI_GET_MAXIMUM_PROCESSOR_INDEX GetMaximumProcessorIndex
;
651 EFI_REGISTER_PERIODIC_CALLBACK RegisterPeriodicCallback
;
652 EFI_REGISTER_EXCEPTION_CALLBACK RegisterExceptionCallback
;
653 EFI_INVALIDATE_INSTRUCTION_CACHE InvalidateInstructionCache
;
656 extern EFI_GUID gEfiDebugSupportProtocolGuid
;