Fixed a bug in the HardwareInterrupt handler that would blow the stack if you reenabl...
[mirror_edk2.git] / ArmPkg / Drivers / CpuDxe / Exception.c
CommitLineData
2ef2b01e
A
1/** @file\r
2\r
3 Copyright (c) 2008-2009, Apple Inc. All rights reserved.\r
4 \r
5 All rights reserved. This program and the accompanying materials\r
6 are licensed and made available under the terms and conditions of the BSD License\r
7 which accompanies this distribution. The full text of the license may be found at\r
8 http://opensource.org/licenses/bsd-license.php\r
9\r
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
12\r
13**/\r
14\r
15#include "CpuDxe.h" \r
16#include <Library/CacheMaintenanceLib.h>\r
17\r
18VOID\r
19ExceptionHandlersStart (\r
20 VOID\r
21 );\r
22\r
23VOID\r
24ExceptionHandlersEnd (\r
25 VOID\r
26 );\r
27\r
28VOID\r
29CommonExceptionEntry (\r
30 VOID\r
31 );\r
32\r
33VOID\r
34AsmCommonExceptionEntry (\r
35 VOID\r
36 );\r
37\r
38\r
39EFI_EXCEPTION_CALLBACK gExceptionHandlers[MAX_ARM_EXCEPTION + 1];\r
40EFI_EXCEPTION_CALLBACK gDebuggerExceptionHandlers[MAX_ARM_EXCEPTION + 1];\r
41\r
42\r
43\r
44/**\r
45 This function registers and enables the handler specified by InterruptHandler for a processor \r
46 interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the \r
47 handler for the processor interrupt or exception type specified by InterruptType is uninstalled. \r
48 The installed handler is called once for each processor interrupt or exception.\r
49\r
50 @param InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts\r
51 are enabled and FALSE if interrupts are disabled.\r
52 @param InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r
53 when a processor interrupt occurs. If this parameter is NULL, then the handler\r
54 will be uninstalled.\r
55\r
56 @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.\r
57 @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was\r
58 previously installed.\r
59 @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
60 previously installed.\r
61 @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.\r
62\r
63**/\r
64EFI_STATUS\r
65RegisterInterruptHandler (\r
66 IN EFI_EXCEPTION_TYPE InterruptType,\r
67 IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler\r
68 )\r
69{\r
70 if (InterruptType > MAX_ARM_EXCEPTION) {\r
71 return EFI_UNSUPPORTED;\r
72 }\r
73\r
74 if ((InterruptHandler != NULL) && (gExceptionHandlers[InterruptType] != NULL)) {\r
75 return EFI_ALREADY_STARTED;\r
76 }\r
77\r
78 gExceptionHandlers[InterruptType] = InterruptHandler;\r
79\r
80 return EFI_SUCCESS;\r
81}\r
82\r
83\r
84/**\r
85 This function registers and enables the handler specified by InterruptHandler for a processor \r
86 interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the \r
87 handler for the processor interrupt or exception type specified by InterruptType is uninstalled. \r
88 The installed handler is called once for each processor interrupt or exception.\r
89\r
90 @param InterruptType A pointer to the processor's current interrupt state. Set to TRUE if interrupts\r
91 are enabled and FALSE if interrupts are disabled.\r
92 @param InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r
93 when a processor interrupt occurs. If this parameter is NULL, then the handler\r
94 will be uninstalled.\r
95\r
96 @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.\r
97 @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was\r
98 previously installed.\r
99 @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
100 previously installed.\r
101 @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported.\r
102\r
103**/\r
104EFI_STATUS\r
105RegisterDebuggerInterruptHandler (\r
106 IN EFI_EXCEPTION_TYPE InterruptType,\r
107 IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler\r
108 )\r
109{\r
110 if (InterruptType > MAX_ARM_EXCEPTION) {\r
111 return EFI_UNSUPPORTED;\r
112 }\r
113\r
114 if ((InterruptHandler != NULL) && (gDebuggerExceptionHandlers[InterruptType] != NULL)) {\r
115 return EFI_ALREADY_STARTED;\r
116 }\r
117\r
118 gDebuggerExceptionHandlers[InterruptType] = InterruptHandler;\r
119\r
120 return EFI_SUCCESS;\r
121}\r
122\r
8a4d81e6
A
123CHAR8 *gExceptionTypeString[] = {\r
124 "Reset",\r
125 "Undefined Instruction",\r
126 "SWI",\r
127 "Prefetch Abort",\r
128 "Data Abort",\r
129 "Undefined",\r
130 "IRQ",\r
131 "FIQ"\r
132};\r
2ef2b01e
A
133\r
134VOID\r
135EFIAPI\r
136CommonCExceptionHandler (\r
137 IN EFI_EXCEPTION_TYPE ExceptionType,\r
138 IN OUT EFI_SYSTEM_CONTEXT SystemContext\r
139 )\r
140{\r
141 BOOLEAN Dispatched = FALSE;\r
8a4d81e6 142 \r
d213712d 143 \r
2ef2b01e
A
144 if (ExceptionType <= MAX_ARM_EXCEPTION) {\r
145 if (gDebuggerExceptionHandlers[ExceptionType]) {\r
146 //\r
147 // If DebugSupport hooked the interrupt call the handler. This does not disable \r
148 // the normal handler.\r
149 //\r
150 gDebuggerExceptionHandlers[ExceptionType] (ExceptionType, SystemContext);\r
151 Dispatched = TRUE;\r
152 }\r
153 if (gExceptionHandlers[ExceptionType]) {\r
154 gExceptionHandlers[ExceptionType] (ExceptionType, SystemContext);\r
155 Dispatched = TRUE;\r
156 }\r
8a4d81e6
A
157 } else {\r
158 DEBUG ((EFI_D_ERROR, "Unknown exception type %d from %08x\n", ExceptionType, SystemContext.SystemContextArm->PC));\r
159 ASSERT (FALSE);\r
2ef2b01e
A
160 }\r
161\r
162 if (Dispatched) {\r
163 //\r
164 // We did work so this was an expected ExceptionType\r
165 //\r
166 return;\r
167 }\r
168 \r
169 if (ExceptionType == EXCEPT_ARM_SOFTWARE_INTERRUPT) {\r
170 //\r
171 // ARM JTAG debuggers some times use this vector, so it is not an error to get one\r
172 //\r
173 return;\r
174 }\r
175\r
176 //\r
177 // Code after here is the default exception handler...\r
178 //\r
8a4d81e6 179 DEBUG ((EFI_D_ERROR, "%a Exception from %08x\n", gExceptionTypeString[ExceptionType], SystemContext.SystemContextArm->PC));\r
2ef2b01e
A
180 ASSERT (FALSE);\r
181\r
182}\r
183\r
184\r
185\r
186EFI_STATUS\r
187InitializeExceptions (\r
188 IN EFI_CPU_ARCH_PROTOCOL *Cpu\r
189 )\r
190{\r
191 EFI_STATUS Status;\r
192 UINTN Offset;\r
193 UINTN Length;\r
194 UINTN Index;\r
195 BOOLEAN Enabled;\r
196 EFI_PHYSICAL_ADDRESS Base;\r
197\r
198 //\r
199 // Disable interrupts\r
200 //\r
201 Cpu->GetInterruptState (Cpu, &Enabled);\r
202 Cpu->DisableInterrupt (Cpu);\r
203\r
204 //\r
205 // Initialize the C entry points for interrupts\r
206 //\r
207 for (Index = 0; Index <= MAX_ARM_EXCEPTION; Index++) {\r
208 Status = RegisterInterruptHandler (Index, NULL);\r
209 ASSERT_EFI_ERROR (Status);\r
210 \r
211 Status = RegisterDebuggerInterruptHandler (Index, NULL);\r
212 ASSERT_EFI_ERROR (Status);\r
213 }\r
214 \r
215 //\r
8a4d81e6 216 // Copy an implementation of the ARM exception vectors to PcdCpuVectorBaseAddress.\r
2ef2b01e
A
217 //\r
218 Length = (UINTN)ExceptionHandlersEnd - (UINTN)ExceptionHandlersStart;\r
219\r
220 //\r
221 // Reserve space for the exception handlers\r
222 //\r
223 Base = (EFI_PHYSICAL_ADDRESS)PcdGet32 (PcdCpuVectorBaseAddress);\r
224 Status = gBS->AllocatePages (AllocateAddress, EfiBootServicesCode, EFI_SIZE_TO_PAGES (Length), &Base);\r
225 // If the request was for memory that's not in the memory map (which is often the case for 0x00000000\r
226 // on embedded systems, for example, we don't want to hang up. So we'll check here for a status of \r
227 // EFI_NOT_FOUND, and continue in that case.\r
228 if (EFI_ERROR(Status) && (Status != EFI_NOT_FOUND)) {\r
8a4d81e6 229 ASSERT_EFI_ERROR (Status);\r
2ef2b01e
A
230 }\r
231\r
232 CopyMem ((VOID *)(UINTN)PcdGet32 (PcdCpuVectorBaseAddress), (VOID *)ExceptionHandlersStart, Length);\r
233\r
234 //\r
235 // Patch in the common Assembly exception handler\r
236 //\r
237 Offset = (UINTN)CommonExceptionEntry - (UINTN)ExceptionHandlersStart;\r
238 *(UINTN *) ((UINT8 *)(UINTN)PcdGet32 (PcdCpuVectorBaseAddress) + Offset) = (UINTN)AsmCommonExceptionEntry;\r
239\r
240 // Flush Caches since we updated executable stuff\r
8a4d81e6 241 InvalidateInstructionCacheRange ((VOID *)PcdGet32(PcdCpuVectorBaseAddress), Length);\r
2ef2b01e
A
242\r
243 if (Enabled) {\r
244 // \r
245 // Restore interrupt state\r
246 //\r
247 Status = Cpu->EnableInterrupt (Cpu);\r
248 }\r
249\r
250 return Status;\r
251}\r