2 Default exception handler
4 Copyright (c) 2008 - 2010, Apple Inc. All rights reserved.<BR>
5 Copyright (c) 2012, ARM Ltd. All rights reserved.<BR>
7 This program and the accompanying materials
8 are licensed and made available under the terms and conditions of the BSD License
9 which accompanies this distribution. The full text of the license may be found at
10 http://opensource.org/licenses/bsd-license.php
12 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
13 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
18 #include <Library/BaseLib.h>
19 #include <Library/DebugLib.h>
20 #include <Library/PeCoffGetEntryPointLib.h>
21 #include <Library/PrintLib.h>
22 #include <Library/ArmDisassemblerLib.h>
23 #include <Library/SerialPortLib.h>
24 #include <Library/UefiBootServicesTableLib.h>
26 #include <Guid/DebugImageInfoTable.h>
28 #include <Protocol/DebugSupport.h>
29 #include <Library/DefaultExceptionHandlerLib.h>
32 // The number of elements in a CHAR8 array, including the terminating NUL, that
33 // is meant to hold the string rendering of the CPSR.
35 #define CPSR_STRING_SIZE 32
44 IN UINTN FaultAddress
,
46 OUT UINTN
*PeCoffSizeOfHeaders
50 Convert the Current Program Status Register (CPSR) to a string. The string is
51 a defacto standard in the ARM world.
53 It is possible to add extra bits by adding them to CpsrChar array.
55 @param Cpsr ARM CPSR register value
56 @param ReturnStr CPSR_STRING_SIZE byte string that contains string
69 CPSR_CHAR CpsrChar
[] = {
85 for (Index
= 0; CpsrChar
[Index
].BIT
!= 0; Index
++, Str
++) {
86 *Str
= CpsrChar
[Index
].Char
;
87 if ((Cpsr
& (1 << CpsrChar
[Index
].BIT
)) != 0) {
88 // Concert to upper case if bit is set
96 switch (Cpsr
& 0x1f) {
128 // See the interface contract in the leading comment block.
130 AsciiStrCatS (Str
, CPSR_STRING_SIZE
- (Str
- ReturnStr
), ModeStr
);
134 FaultStatusToString (
141 case 0x01: FaultSource
= "Alignment fault"; break;
142 case 0x02: FaultSource
= "Debug event fault"; break;
143 case 0x03: FaultSource
= "Access Flag fault on Section"; break;
144 case 0x04: FaultSource
= "Cache maintenance operation fault[2]"; break;
145 case 0x05: FaultSource
= "Translation fault on Section"; break;
146 case 0x06: FaultSource
= "Access Flag fault on Page"; break;
147 case 0x07: FaultSource
= "Translation fault on Page"; break;
148 case 0x08: FaultSource
= "Precise External Abort"; break;
149 case 0x09: FaultSource
= "Domain fault on Section"; break;
150 case 0x0b: FaultSource
= "Domain fault on Page"; break;
151 case 0x0c: FaultSource
= "External abort on translation, first level"; break;
152 case 0x0d: FaultSource
= "Permission fault on Section"; break;
153 case 0x0e: FaultSource
= "External abort on translation, second level"; break;
154 case 0x0f: FaultSource
= "Permission fault on Page"; break;
155 case 0x16: FaultSource
= "Imprecise External Abort"; break;
156 default: FaultSource
= "No function"; break;
162 STATIC CHAR8
*gExceptionTypeString
[] = {
174 This is the default action to take on an unexpected exception
176 Since this is exception context don't do anything crazy like try to allcoate memory.
178 @param ExceptionType Type of the exception
179 @param SystemContext Register state at the time of the Exception
184 DefaultExceptionHandler (
185 IN EFI_EXCEPTION_TYPE ExceptionType
,
186 IN OUT EFI_SYSTEM_CONTEXT SystemContext
196 CharCount
= AsciiSPrint (Buffer
,sizeof (Buffer
),"\n%a Exception PC at 0x%08x CPSR 0x%08x ",
197 gExceptionTypeString
[ExceptionType
], SystemContext
.SystemContextArm
->PC
, SystemContext
.SystemContextArm
->CPSR
);
198 SerialPortWrite ((UINT8
*)Buffer
, CharCount
);
199 if (gST
->ConOut
!= NULL
) {
206 UINT32 PeCoffSizeOfHeader
;
208 CHAR8 CpsrStr
[CPSR_STRING_SIZE
]; // char per bit. Lower 5-bits are mode
209 // that is a 3 char string
214 CpsrString (SystemContext
.SystemContextArm
->CPSR
, CpsrStr
);
215 DEBUG ((EFI_D_ERROR
, "%a\n", CpsrStr
));
217 Pdb
= GetImageName (SystemContext
.SystemContextArm
->PC
, &ImageBase
, &PeCoffSizeOfHeader
);
218 Offset
= SystemContext
.SystemContextArm
->PC
- ImageBase
;
220 DEBUG ((EFI_D_ERROR
, "%a\n", Pdb
));
223 // A PE/COFF image loads its headers into memory so the headers are
224 // included in the linked addresses. ELF and Mach-O images do not
225 // include the headers so the first byte of the image is usually
226 // text (code). If you look at link maps from ELF or Mach-O images
227 // you need to subtract out the size of the PE/COFF header to get
228 // get the offset that matches the link map.
230 DEBUG ((EFI_D_ERROR
, "loaded at 0x%08x (PE/COFF offset) 0x%x (ELF or Mach-O offset) 0x%x", ImageBase
, Offset
, Offset
- PeCoffSizeOfHeader
));
232 // If we come from an image it is safe to show the instruction. We know it should not fault
233 DisAsm
= (UINT8
*)(UINTN
)SystemContext
.SystemContextArm
->PC
;
235 DisassembleInstruction (&DisAsm
, (SystemContext
.SystemContextArm
->CPSR
& BIT5
) == BIT5
, TRUE
, &ItBlock
, Buffer
, sizeof (Buffer
));
236 DEBUG ((EFI_D_ERROR
, "\n%a", Buffer
));
238 switch (ExceptionType
) {
239 case EXCEPT_ARM_UNDEFINED_INSTRUCTION
:
240 case EXCEPT_ARM_SOFTWARE_INTERRUPT
:
241 case EXCEPT_ARM_PREFETCH_ABORT
:
242 case EXCEPT_ARM_DATA_ABORT
:
243 // advance PC past the faulting instruction
244 PcAdjust
= (UINTN
)DisAsm
- SystemContext
.SystemContextArm
->PC
;
253 DEBUG ((EFI_D_ERROR
, "\n R0 0x%08x R1 0x%08x R2 0x%08x R3 0x%08x\n", SystemContext
.SystemContextArm
->R0
, SystemContext
.SystemContextArm
->R1
, SystemContext
.SystemContextArm
->R2
, SystemContext
.SystemContextArm
->R3
));
254 DEBUG ((EFI_D_ERROR
, " R4 0x%08x R5 0x%08x R6 0x%08x R7 0x%08x\n", SystemContext
.SystemContextArm
->R4
, SystemContext
.SystemContextArm
->R5
, SystemContext
.SystemContextArm
->R6
, SystemContext
.SystemContextArm
->R7
));
255 DEBUG ((EFI_D_ERROR
, " R8 0x%08x R9 0x%08x R10 0x%08x R11 0x%08x\n", SystemContext
.SystemContextArm
->R8
, SystemContext
.SystemContextArm
->R9
, SystemContext
.SystemContextArm
->R10
, SystemContext
.SystemContextArm
->R11
));
256 DEBUG ((EFI_D_ERROR
, " R12 0x%08x SP 0x%08x LR 0x%08x PC 0x%08x\n", SystemContext
.SystemContextArm
->R12
, SystemContext
.SystemContextArm
->SP
, SystemContext
.SystemContextArm
->LR
, SystemContext
.SystemContextArm
->PC
));
257 DEBUG ((EFI_D_ERROR
, "DFSR 0x%08x DFAR 0x%08x IFSR 0x%08x IFAR 0x%08x\n", SystemContext
.SystemContextArm
->DFSR
, SystemContext
.SystemContextArm
->DFAR
, SystemContext
.SystemContextArm
->IFSR
, SystemContext
.SystemContextArm
->IFAR
));
259 // Bit10 is Status[4] Bit3:0 is Status[3:0]
260 DfsrStatus
= (SystemContext
.SystemContextArm
->DFSR
& 0xf) | ((SystemContext
.SystemContextArm
->DFSR
>> 6) & 0x10);
261 DfsrWrite
= (SystemContext
.SystemContextArm
->DFSR
& BIT11
) != 0;
262 if (DfsrStatus
!= 0x00) {
263 DEBUG ((EFI_D_ERROR
, " %a: %a 0x%08x\n", FaultStatusToString (DfsrStatus
), DfsrWrite
? "write to" : "read from", SystemContext
.SystemContextArm
->DFAR
));
266 IfsrStatus
= (SystemContext
.SystemContextArm
->IFSR
& 0xf) | ((SystemContext
.SystemContextArm
->IFSR
>> 6) & 0x10);
267 if (IfsrStatus
!= 0) {
268 DEBUG ((EFI_D_ERROR
, " Instruction %a at 0x%08x\n", FaultStatusToString (SystemContext
.SystemContextArm
->IFSR
& 0xf), SystemContext
.SystemContextArm
->IFAR
));
271 DEBUG ((EFI_D_ERROR
, "\n"));
274 CpuDeadLoop (); // may return if executing under a debugger
276 // Clear the error registers that we have already displayed incase some one wants to keep going
277 SystemContext
.SystemContextArm
->DFSR
= 0;
278 SystemContext
.SystemContextArm
->IFSR
= 0;
280 // If some one is stepping past the exception handler adjust the PC to point to the next instruction
281 SystemContext
.SystemContextArm
->PC
+= PcAdjust
;