]>
Commit | Line | Data |
---|---|---|
e41aad15 JF |
1 | /** @file\r |
2 | CPU exception handler library implemenation for DXE modules.\r | |
3 | \r | |
1b2f7b3e | 4 | Copyright (c) 2013 - 2017, Intel Corporation. All rights reserved.<BR>\r |
0acd8697 | 5 | SPDX-License-Identifier: BSD-2-Clause-Patent\r |
e41aad15 JF |
6 | \r |
7 | **/\r | |
8 | \r | |
9 | #include <PiDxe.h>\r | |
10 | #include "CpuExceptionCommon.h"\r | |
11 | #include <Library/DebugLib.h>\r | |
12 | #include <Library/MemoryAllocationLib.h>\r | |
fceafda5 | 13 | #include <Library/UefiBootServicesTableLib.h>\r |
e41aad15 | 14 | \r |
053e878b | 15 | CONST UINTN mDoFarReturnFlag = 0;\r |
e41aad15 | 16 | \r |
2fbc5ff0 RN |
17 | RESERVED_VECTORS_DATA mReservedVectorsData[CPU_INTERRUPT_NUM];\r |
18 | EFI_CPU_INTERRUPT_HANDLER mExternalInterruptHandlerTable[CPU_INTERRUPT_NUM];\r | |
34d50512 RN |
19 | EXCEPTION_HANDLER_DATA mExceptionHandlerData = {\r |
20 | 0, // To be fixed\r | |
21 | 0, // To be fixed\r | |
22 | mReservedVectorsData,\r | |
23 | mExternalInterruptHandlerTable\r | |
24 | };\r | |
e41aad15 | 25 | \r |
053e878b MK |
26 | UINT8 mNewStack[CPU_STACK_SWITCH_EXCEPTION_NUMBER *\r |
27 | CPU_KNOWN_GOOD_STACK_SIZE];\r | |
28 | UINT8 mNewGdt[CPU_TSS_GDT_SIZE];\r | |
0ff5aa9c | 29 | \r |
44ecbc28 JF |
30 | /**\r |
31 | Common exception handler.\r | |
32 | \r | |
33 | @param ExceptionType Exception type.\r | |
34 | @param SystemContext Pointer to EFI_SYSTEM_CONTEXT.\r | |
35 | **/\r | |
36 | VOID\r | |
37 | EFIAPI\r | |
38 | CommonExceptionHandler (\r | |
053e878b MK |
39 | IN EFI_EXCEPTION_TYPE ExceptionType,\r |
40 | IN EFI_SYSTEM_CONTEXT SystemContext\r | |
44ecbc28 JF |
41 | )\r |
42 | {\r | |
43 | CommonExceptionHandlerWorker (ExceptionType, SystemContext, &mExceptionHandlerData);\r | |
44 | }\r | |
45 | \r | |
e41aad15 JF |
46 | /**\r |
47 | Initializes all CPU exceptions entries and provides the default exception handlers.\r | |
dd563742 | 48 | \r |
e41aad15 JF |
49 | Caller should try to get an array of interrupt and/or exception vectors that are in use and need to\r |
50 | persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.\r | |
dd563742 | 51 | If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.\r |
e41aad15 JF |
52 | If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.\r |
53 | \r | |
54 | @param[in] VectorInfo Pointer to reserved vector list.\r | |
dd563742 JF |
55 | \r |
56 | @retval EFI_SUCCESS CPU Exception Entries have been successfully initialized\r | |
e41aad15 JF |
57 | with default exception handlers.\r |
58 | @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.\r | |
59 | @retval EFI_UNSUPPORTED This function is not supported.\r | |
60 | \r | |
61 | **/\r | |
62 | EFI_STATUS\r | |
63 | EFIAPI\r | |
64 | InitializeCpuExceptionHandlers (\r | |
053e878b | 65 | IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL\r |
e41aad15 JF |
66 | )\r |
67 | {\r | |
ab95e54d JF |
68 | InitializeSpinLock (&mExceptionHandlerData.DisplayMessageSpinLock);\r |
69 | return InitializeCpuExceptionHandlersWorker (VectorInfo, &mExceptionHandlerData);\r | |
e41aad15 JF |
70 | }\r |
71 | \r | |
72 | /**\r | |
73 | Initializes all CPU interrupt/exceptions entries and provides the default interrupt/exception handlers.\r | |
dd563742 | 74 | \r |
e41aad15 JF |
75 | Caller should try to get an array of interrupt and/or exception vectors that are in use and need to\r |
76 | persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification.\r | |
dd563742 | 77 | If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL.\r |
e41aad15 JF |
78 | If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly.\r |
79 | \r | |
80 | @param[in] VectorInfo Pointer to reserved vector list.\r | |
dd563742 JF |
81 | \r |
82 | @retval EFI_SUCCESS All CPU interrupt/exception entries have been successfully initialized\r | |
e41aad15 JF |
83 | with default interrupt/exception handlers.\r |
84 | @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.\r | |
85 | @retval EFI_UNSUPPORTED This function is not supported.\r | |
86 | \r | |
87 | **/\r | |
88 | EFI_STATUS\r | |
89 | EFIAPI\r | |
90 | InitializeCpuInterruptHandlers (\r | |
053e878b | 91 | IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL\r |
e41aad15 JF |
92 | )\r |
93 | {\r | |
053e878b MK |
94 | EFI_STATUS Status;\r |
95 | IA32_IDT_GATE_DESCRIPTOR *IdtTable;\r | |
96 | IA32_DESCRIPTOR IdtDescriptor;\r | |
97 | UINTN IdtEntryCount;\r | |
98 | EXCEPTION_HANDLER_TEMPLATE_MAP TemplateMap;\r | |
2fbc5ff0 RN |
99 | \r |
100 | SetMem ((VOID *)mReservedVectorsData, sizeof (RESERVED_VECTORS_DATA) * CPU_INTERRUPT_NUM, 0xff);\r | |
e41aad15 | 101 | if (VectorInfo != NULL) {\r |
2fbc5ff0 | 102 | Status = ReadAndVerifyVectorInfo (VectorInfo, mReservedVectorsData, CPU_INTERRUPT_NUM);\r |
e41aad15 | 103 | if (EFI_ERROR (Status)) {\r |
e41aad15 JF |
104 | return EFI_INVALID_PARAMETER;\r |
105 | }\r | |
106 | }\r | |
44ecbc28 | 107 | \r |
e41aad15 JF |
108 | //\r |
109 | // Read IDT descriptor and calculate IDT size\r | |
110 | //\r | |
111 | AsmReadIdtr (&IdtDescriptor);\r | |
112 | IdtEntryCount = (IdtDescriptor.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR);\r | |
113 | if (IdtEntryCount > CPU_INTERRUPT_NUM) {\r | |
114 | IdtEntryCount = CPU_INTERRUPT_NUM;\r | |
115 | }\r | |
053e878b | 116 | \r |
e41aad15 JF |
117 | //\r |
118 | // Create Interrupt Descriptor Table and Copy the old IDT table in\r | |
119 | //\r | |
120 | IdtTable = AllocateZeroPool (sizeof (IA32_IDT_GATE_DESCRIPTOR) * CPU_INTERRUPT_NUM);\r | |
121 | ASSERT (IdtTable != NULL);\r | |
122 | CopyMem (IdtTable, (VOID *)IdtDescriptor.Base, sizeof (IA32_IDT_GATE_DESCRIPTOR) * IdtEntryCount);\r | |
123 | \r | |
124 | AsmGetTemplateAddressMap (&TemplateMap);\r | |
125 | ASSERT (TemplateMap.ExceptionStubHeaderSize <= HOOKAFTER_STUB_SIZE);\r | |
fceafda5 | 126 | \r |
9db15f81 | 127 | mExceptionHandlerData.IdtEntryCount = CPU_INTERRUPT_NUM;\r |
9db15f81 JF |
128 | InitializeSpinLock (&mExceptionHandlerData.DisplayMessageSpinLock);\r |
129 | \r | |
130 | UpdateIdtTable (IdtTable, &TemplateMap, &mExceptionHandlerData);\r | |
e41aad15 JF |
131 | \r |
132 | //\r | |
133 | // Load Interrupt Descriptor Table\r | |
134 | //\r | |
053e878b MK |
135 | IdtDescriptor.Base = (UINTN)IdtTable;\r |
136 | IdtDescriptor.Limit = (UINT16)(sizeof (IA32_IDT_GATE_DESCRIPTOR) * CPU_INTERRUPT_NUM - 1);\r | |
137 | AsmWriteIdtr ((IA32_DESCRIPTOR *)&IdtDescriptor);\r | |
e41aad15 JF |
138 | \r |
139 | return EFI_SUCCESS;\r | |
140 | }\r | |
141 | \r | |
142 | /**\r | |
143 | Registers a function to be called from the processor interrupt handler.\r | |
144 | \r | |
dd563742 JF |
145 | This function registers and enables the handler specified by InterruptHandler for a processor\r |
146 | interrupt or exception type specified by InterruptType. If InterruptHandler is NULL, then the\r | |
147 | handler for the processor interrupt or exception type specified by InterruptType is uninstalled.\r | |
e41aad15 JF |
148 | The installed handler is called once for each processor interrupt or exception.\r |
149 | NOTE: This function should be invoked after InitializeCpuExceptionHandlers() or\r | |
150 | InitializeCpuInterruptHandlers() invoked, otherwise EFI_UNSUPPORTED returned.\r | |
151 | \r | |
152 | @param[in] InterruptType Defines which interrupt or exception to hook.\r | |
153 | @param[in] InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r | |
154 | when a processor interrupt occurs. If this parameter is NULL, then the handler\r | |
155 | will be uninstalled.\r | |
156 | \r | |
157 | @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.\r | |
158 | @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was\r | |
159 | previously installed.\r | |
160 | @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r | |
161 | previously installed.\r | |
162 | @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported,\r | |
163 | or this function is not supported.\r | |
3f25e6ea | 164 | **/\r |
e41aad15 JF |
165 | EFI_STATUS\r |
166 | EFIAPI\r | |
167 | RegisterCpuInterruptHandler (\r | |
053e878b MK |
168 | IN EFI_EXCEPTION_TYPE InterruptType,\r |
169 | IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler\r | |
e41aad15 JF |
170 | )\r |
171 | {\r | |
670f13af | 172 | return RegisterCpuInterruptHandlerWorker (InterruptType, InterruptHandler, &mExceptionHandlerData);\r |
e41aad15 | 173 | }\r |
0ff5aa9c JW |
174 | \r |
175 | /**\r | |
176 | Initializes CPU exceptions entries and setup stack switch for given exceptions.\r | |
177 | \r | |
178 | This method will call InitializeCpuExceptionHandlers() to setup default\r | |
179 | exception handlers unless indicated not to do it explicitly.\r | |
180 | \r | |
181 | If InitData is passed with NULL, this method will use the resource reserved\r | |
182 | by global variables to initialize it; Otherwise it will use data in InitData\r | |
183 | to setup stack switch. This is for the different use cases in DxeCore and\r | |
184 | Cpu MP exception initialization.\r | |
185 | \r | |
186 | @param[in] VectorInfo Pointer to reserved vector list.\r | |
187 | @param[in] InitData Pointer to data required to setup stack switch for\r | |
188 | given exceptions.\r | |
189 | \r | |
190 | @retval EFI_SUCCESS The exceptions have been successfully\r | |
191 | initialized.\r | |
192 | @retval EFI_INVALID_PARAMETER VectorInfo or InitData contains invalid\r | |
193 | content.\r | |
194 | \r | |
195 | **/\r | |
196 | EFI_STATUS\r | |
197 | EFIAPI\r | |
198 | InitializeCpuExceptionHandlersEx (\r | |
053e878b MK |
199 | IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL,\r |
200 | IN CPU_EXCEPTION_INIT_DATA *InitData OPTIONAL\r | |
0ff5aa9c JW |
201 | )\r |
202 | {\r | |
053e878b MK |
203 | EFI_STATUS Status;\r |
204 | CPU_EXCEPTION_INIT_DATA EssData;\r | |
205 | IA32_DESCRIPTOR Idtr;\r | |
206 | IA32_DESCRIPTOR Gdtr;\r | |
0ff5aa9c JW |
207 | \r |
208 | //\r | |
209 | // To avoid repeat initialization of default handlers, the caller should pass\r | |
210 | // an extended init data with InitDefaultHandlers set to FALSE. There's no\r | |
211 | // need to call this method to just initialize default handlers. Call non-ex\r | |
212 | // version instead; or this method must be implemented as a simple wrapper of\r | |
213 | // non-ex version of it, if this version has to be called.\r | |
214 | //\r | |
053e878b | 215 | if ((InitData == NULL) || InitData->X64.InitDefaultHandlers) {\r |
0ff5aa9c JW |
216 | Status = InitializeCpuExceptionHandlers (VectorInfo);\r |
217 | } else {\r | |
218 | Status = EFI_SUCCESS;\r | |
219 | }\r | |
220 | \r | |
221 | if (!EFI_ERROR (Status)) {\r | |
222 | //\r | |
223 | // Initializing stack switch is only necessary for Stack Guard functionality.\r | |
224 | //\r | |
225 | if (PcdGetBool (PcdCpuStackGuard)) {\r | |
226 | if (InitData == NULL) {\r | |
227 | SetMem (mNewGdt, sizeof (mNewGdt), 0);\r | |
228 | \r | |
229 | AsmReadIdtr (&Idtr);\r | |
230 | AsmReadGdtr (&Gdtr);\r | |
231 | \r | |
053e878b MK |
232 | EssData.X64.Revision = CPU_EXCEPTION_INIT_DATA_REV;\r |
233 | EssData.X64.KnownGoodStackTop = (UINTN)mNewStack + sizeof (mNewStack);\r | |
234 | EssData.X64.KnownGoodStackSize = CPU_KNOWN_GOOD_STACK_SIZE;\r | |
235 | EssData.X64.StackSwitchExceptions = CPU_STACK_SWITCH_EXCEPTION_LIST;\r | |
0ff5aa9c | 236 | EssData.X64.StackSwitchExceptionNumber = CPU_STACK_SWITCH_EXCEPTION_NUMBER;\r |
053e878b MK |
237 | EssData.X64.IdtTable = (VOID *)Idtr.Base;\r |
238 | EssData.X64.IdtTableSize = Idtr.Limit + 1;\r | |
239 | EssData.X64.GdtTable = mNewGdt;\r | |
240 | EssData.X64.GdtTableSize = sizeof (mNewGdt);\r | |
241 | EssData.X64.ExceptionTssDesc = mNewGdt + Gdtr.Limit + 1;\r | |
242 | EssData.X64.ExceptionTssDescSize = CPU_TSS_DESC_SIZE;\r | |
243 | EssData.X64.ExceptionTss = mNewGdt + Gdtr.Limit + 1 + CPU_TSS_DESC_SIZE;\r | |
244 | EssData.X64.ExceptionTssSize = CPU_TSS_SIZE;\r | |
0ff5aa9c JW |
245 | \r |
246 | InitData = &EssData;\r | |
247 | }\r | |
053e878b | 248 | \r |
7c4207e9 | 249 | Status = ArchSetupExceptionStack (InitData);\r |
0ff5aa9c JW |
250 | }\r |
251 | }\r | |
252 | \r | |
053e878b | 253 | return Status;\r |
0ff5aa9c | 254 | }\r |