[mirror_edk2.git] / UefiCpuPkg / Library / CpuExceptionHandlerLib / PeiDxeSmmCpuException.c

/** @file\r
  CPU Exception Library provides PEI/DXE/SMM CPU common exception handler.\r
\r
Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#include "CpuExceptionCommon.h"\r
#include <Library/DebugLib.h>\r
\r
/**\r
  Internal worker function for common exception handler.\r
\r
  @param ExceptionType         Exception type.\r
  @param SystemContext         Pointer to EFI_SYSTEM_CONTEXT.\r
  @param ExceptionHandlerData  Pointer to exception handler data.\r
**/\r
VOID\r
CommonExceptionHandlerWorker (\r
  IN EFI_EXCEPTION_TYPE          ExceptionType,\r
  IN EFI_SYSTEM_CONTEXT          SystemContext,\r
  IN EXCEPTION_HANDLER_DATA      *ExceptionHandlerData\r
  )\r
{\r
  EXCEPTION_HANDLER_CONTEXT      *ExceptionHandlerContext;\r
  RESERVED_VECTORS_DATA          *ReservedVectors;\r
  EFI_CPU_INTERRUPT_HANDLER      *ExternalInterruptHandler;\r
\r
  ExceptionHandlerContext  = (EXCEPTION_HANDLER_CONTEXT *) (UINTN) (SystemContext.SystemContextIa32);\r
  ReservedVectors          = ExceptionHandlerData->ReservedVectors;\r
  ExternalInterruptHandler = ExceptionHandlerData->ExternalInterruptHandler;\r
\r
  switch (ReservedVectors[ExceptionType].Attribute) {\r
  case EFI_VECTOR_HANDOFF_HOOK_BEFORE:\r
    //\r
    // The new exception handler registered by RegisterCpuInterruptHandler() is executed BEFORE original handler.\r
    // Save the original handler to stack so the assembly code can jump to it instead of returning from handler.\r
    //\r
    ExceptionHandlerContext->ExceptionDataFlag = (mErrorCodeFlag & (1 << ExceptionType)) ? TRUE : FALSE;\r
    ExceptionHandlerContext->OldIdtHandler     = ReservedVectors[ExceptionType].ExceptonHandler;\r
    break;\r
  case EFI_VECTOR_HANDOFF_HOOK_AFTER:\r
    while (TRUE) {\r
      //\r
      // If spin-lock can be acquired, it's the first time entering here.\r
      //\r
      if (AcquireSpinLockOrFail (&ReservedVectors[ExceptionType].SpinLock)) {\r
        //\r
        // The new exception handler registered by RegisterCpuInterruptHandler() is executed AFTER original handler.\r
        // Save the original handler to stack but skip running the new handler so the original handler is executed\r
        // firstly.\r
        //\r
        ReservedVectors[ExceptionType].ApicId = GetApicId ();\r
        ArchSaveExceptionContext (ExceptionType, SystemContext, ExceptionHandlerData);\r
        ExceptionHandlerContext->ExceptionDataFlag = (mErrorCodeFlag & (1 << ExceptionType)) ? TRUE : FALSE;\r
        ExceptionHandlerContext->OldIdtHandler     = ReservedVectors[ExceptionType].ExceptonHandler;\r
        return;\r
      }\r
      //\r
      // If spin-lock cannot be acquired, it's the second time entering here.\r
      // 'break' instead of 'return' is used so the new exception handler can be executed.\r
      //\r
      if (ReservedVectors[ExceptionType].ApicId == GetApicId ()) {\r
        //\r
        // Old IDT handler has been executed, then restore CPU exception content to\r
        // run new exception handler.\r
        //\r
        ArchRestoreExceptionContext (ExceptionType, SystemContext, ExceptionHandlerData);\r
        //\r
        // Release spin lock for ApicId\r
        //\r
        ReleaseSpinLock (&ReservedVectors[ExceptionType].SpinLock);\r
        break;\r
      }\r
      CpuPause ();\r
    }\r
    break;\r
  case 0xffffffff:\r
    break;\r
  default:\r
    //\r
    // It should never reach here\r
    //\r
    CpuDeadLoop ();\r
    break;\r
  }\r
\r
  if (ExternalInterruptHandler != NULL &&\r
      ExternalInterruptHandler[ExceptionType] != NULL) {\r
    (ExternalInterruptHandler[ExceptionType]) (ExceptionType, SystemContext);\r
  } else if (ExceptionType < CPU_EXCEPTION_NUM) {\r
    //\r
    // Get Spinlock to display CPU information\r
    //\r
    while (!AcquireSpinLockOrFail (&ExceptionHandlerData->DisplayMessageSpinLock)) {\r
      CpuPause ();\r
    }\r
    //\r
    // Initialize the serial port before dumping.\r
    //\r
    SerialPortInitialize ();\r
    //\r
    // Display ExceptionType, CPU information and Image information\r
    //\r
    DumpImageAndCpuContent (ExceptionType, SystemContext);\r
    //\r
    // Release Spinlock of output message\r
    //\r
    ReleaseSpinLock (&ExceptionHandlerData->DisplayMessageSpinLock);\r
    //\r
    // Enter a dead loop if needn't to execute old IDT handler further\r
    //\r
    if (ReservedVectors[ExceptionType].Attribute != EFI_VECTOR_HANDOFF_HOOK_BEFORE) {\r
      CpuDeadLoop ();\r
    }\r
  }\r
}\r
\r
/**\r
  Internal worker function to update IDT entries accordling to vector attributes.\r
\r
  @param[in] IdtTable              Pointer to IDT table.\r
  @param[in] TemplateMap           Pointer to a buffer where the address map is\r
                                   returned.\r
  @param[in] ExceptionHandlerData  Pointer to exception handler data.\r
\r
**/\r
VOID\r
UpdateIdtTable (\r
  IN IA32_IDT_GATE_DESCRIPTOR        *IdtTable,\r
  IN EXCEPTION_HANDLER_TEMPLATE_MAP  *TemplateMap,\r
  IN EXCEPTION_HANDLER_DATA          *ExceptionHandlerData\r
  )\r
{\r
  UINT16                             CodeSegment;\r
  UINTN                              Index;\r
  UINTN                              InterruptHandler;\r
  RESERVED_VECTORS_DATA              *ReservedVectors;\r
\r
  ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
  //\r
  // Use current CS as the segment selector of interrupt gate in IDT\r
  //\r
  CodeSegment = AsmReadCs ();\r
\r
  for (Index = 0; Index < ExceptionHandlerData->IdtEntryCount; Index ++) {\r
    IdtTable[Index].Bits.Selector = CodeSegment;\r
    //\r
    // Check reserved vectors attributes\r
    //\r
    switch (ReservedVectors[Index].Attribute) {\r
    case EFI_VECTOR_HANDOFF_DO_NOT_HOOK:\r
      //\r
      // Keep original IDT entry\r
      //\r
      continue;\r
    case EFI_VECTOR_HANDOFF_HOOK_AFTER:\r
      InitializeSpinLock (&ReservedVectors[Index].SpinLock);\r
      CopyMem (\r
        (VOID *) ReservedVectors[Index].HookAfterStubHeaderCode,\r
        (VOID *) TemplateMap->HookAfterStubHeaderStart,\r
        TemplateMap->ExceptionStubHeaderSize\r
        );\r
      AsmVectorNumFixup (\r
        (VOID *) ReservedVectors[Index].HookAfterStubHeaderCode,\r
        (UINT8) Index,\r
        (VOID *) TemplateMap->HookAfterStubHeaderStart\r
        );\r
      //\r
      // Go on the following code\r
      //\r
    case EFI_VECTOR_HANDOFF_HOOK_BEFORE:\r
      //\r
      // Save original IDT handler address\r
      //\r
      ReservedVectors[Index].ExceptonHandler = ArchGetIdtHandler (&IdtTable[Index]);\r
      //\r
      // Go on the following code\r
      //\r
    default:\r
      //\r
      // Update new IDT entry\r
      //\r
      InterruptHandler = TemplateMap->ExceptionStart + Index * TemplateMap->ExceptionStubHeaderSize;\r
      ArchUpdateIdtEntry (&IdtTable[Index], InterruptHandler);\r
      break;\r
    }\r
  }\r
}\r
\r
/**\r
  Internal worker function to initialize exception handler.\r
\r
  @param[in]      VectorInfo            Pointer to reserved vector list.\r
  @param[in, out] ExceptionHandlerData  Pointer to exception handler data.\r
\r
  @retval EFI_SUCCESS           CPU Exception Entries have been successfully initialized\r
                                with default exception handlers.\r
  @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.\r
  @retval EFI_UNSUPPORTED       This function is not supported.\r
\r
**/\r
EFI_STATUS\r
InitializeCpuExceptionHandlersWorker (\r
  IN EFI_VECTOR_HANDOFF_INFO       *VectorInfo OPTIONAL,\r
  IN OUT EXCEPTION_HANDLER_DATA    *ExceptionHandlerData\r
  )\r
{\r
  EFI_STATUS                       Status;\r
  IA32_DESCRIPTOR                  IdtDescriptor;\r
  UINTN                            IdtEntryCount;\r
  EXCEPTION_HANDLER_TEMPLATE_MAP   TemplateMap;\r
  IA32_IDT_GATE_DESCRIPTOR         *IdtTable;\r
  RESERVED_VECTORS_DATA            *ReservedVectors;\r
\r
  ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
  SetMem ((VOID *) ReservedVectors, sizeof (RESERVED_VECTORS_DATA) * CPU_EXCEPTION_NUM, 0xff);\r
  if (VectorInfo != NULL) {\r
    Status = ReadAndVerifyVectorInfo (VectorInfo, ReservedVectors, CPU_EXCEPTION_NUM);\r
    if (EFI_ERROR (Status)) {\r
      return EFI_INVALID_PARAMETER;\r
    }\r
  }\r
\r
  //\r
  // Read IDT descriptor and calculate IDT size\r
  //\r
  AsmReadIdtr (&IdtDescriptor);\r
  IdtEntryCount = (IdtDescriptor.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR);\r
  if (IdtEntryCount > CPU_EXCEPTION_NUM) {\r
    //\r
    // CPU exception library only setup CPU_EXCEPTION_NUM exception handler at most\r
    //\r
    IdtEntryCount = CPU_EXCEPTION_NUM;\r
  }\r
\r
  IdtTable = (IA32_IDT_GATE_DESCRIPTOR *) IdtDescriptor.Base;\r
  AsmGetTemplateAddressMap (&TemplateMap);\r
  ASSERT (TemplateMap.ExceptionStubHeaderSize <= HOOKAFTER_STUB_SIZE);\r
\r
  ExceptionHandlerData->IdtEntryCount = IdtEntryCount;\r
  UpdateIdtTable (IdtTable, &TemplateMap, ExceptionHandlerData);\r
\r
  return EFI_SUCCESS;\r
}\r
\r
/**\r
  Registers a function to be called from the processor interrupt handler.\r
\r
  @param[in]  InterruptType        Defines which interrupt or exception to hook.\r
  @param[in]  InterruptHandler     A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r
                                   when a processor interrupt occurs. If this parameter is NULL, then the handler\r
                                   will be uninstalled\r
  @param[in] ExceptionHandlerData  Pointer to exception handler data.\r
\r
  @retval EFI_SUCCESS           The handler for the processor interrupt was successfully installed or uninstalled.\r
  @retval EFI_ALREADY_STARTED   InterruptHandler is not NULL, and a handler for InterruptType was\r
                                previously installed.\r
  @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
                                previously installed.\r
  @retval EFI_UNSUPPORTED       The interrupt specified by InterruptType is not supported,\r
                                or this function is not supported.\r
**/\r
EFI_STATUS\r
RegisterCpuInterruptHandlerWorker (\r
  IN EFI_EXCEPTION_TYPE            InterruptType,\r
  IN EFI_CPU_INTERRUPT_HANDLER     InterruptHandler,\r
  IN EXCEPTION_HANDLER_DATA        *ExceptionHandlerData\r
  )\r
{\r
  UINTN                          EnabledInterruptNum;\r
  RESERVED_VECTORS_DATA          *ReservedVectors;\r
  EFI_CPU_INTERRUPT_HANDLER      *ExternalInterruptHandler;\r
\r
  EnabledInterruptNum      = ExceptionHandlerData->IdtEntryCount;\r
  ReservedVectors          = ExceptionHandlerData->ReservedVectors;\r
  ExternalInterruptHandler = ExceptionHandlerData->ExternalInterruptHandler;\r
\r
  if (InterruptType < 0 || InterruptType >= (EFI_EXCEPTION_TYPE)EnabledInterruptNum ||\r
      ReservedVectors[InterruptType].Attribute == EFI_VECTOR_HANDOFF_DO_NOT_HOOK) {\r
    return EFI_UNSUPPORTED;\r
  }\r
\r
  if (InterruptHandler == NULL && ExternalInterruptHandler[InterruptType] == NULL) {\r
    return EFI_INVALID_PARAMETER;\r
  }\r
\r
  if (InterruptHandler != NULL && ExternalInterruptHandler[InterruptType] != NULL) {\r
    return EFI_ALREADY_STARTED;\r
  }\r
\r
  ExternalInterruptHandler[InterruptType] = InterruptHandler;\r
  return EFI_SUCCESS;\r
}\r
\r
Commit	Line	Data
8f07f895	1	/** @file\r
9b4aa760	2	CPU Exception Library provides PEI/DXE/SMM CPU common exception handler.\r
8f07f895	3	\r
7230212a	4	Copyright (c) 2012 - 2018, Intel Corporation. All rights reserved.<BR>\r
0acd8697	5	SPDX-License-Identifier: BSD-2-Clause-Patent\r
8f07f895	6	\r
	7	**/\r
	8	\r
8f07f895	9	#include "CpuExceptionCommon.h"\r
e41aad15	10	#include <Library/DebugLib.h>\r
8f07f895	11	\r
8f07f895	12	/**\r
44ecbc28	13	Internal worker function for common exception handler.\r
8f07f895	14	\r
44ecbc28 JF	15	@param ExceptionType Exception type.\r
	16	@param SystemContext Pointer to EFI_SYSTEM_CONTEXT.\r
	17	@param ExceptionHandlerData Pointer to exception handler data.\r
8f07f895	18	**/\r
8f07f895	19	VOID\r
44ecbc28	20	CommonExceptionHandlerWorker (\r
dd563742	21	IN EFI_EXCEPTION_TYPE ExceptionType,\r
44ecbc28 JF	22	IN EFI_SYSTEM_CONTEXT SystemContext,\r
44ecbc28 JF	23	IN EXCEPTION_HANDLER_DATA *ExceptionHandlerData\r
8f07f895	24	)\r
8f07f895	25	{\r
e41aad15	26	EXCEPTION_HANDLER_CONTEXT *ExceptionHandlerContext;\r
44ecbc28 JF	27	RESERVED_VECTORS_DATA *ReservedVectors;\r
44ecbc28 JF	28	EFI_CPU_INTERRUPT_HANDLER *ExternalInterruptHandler;\r
e41aad15	29	\r
44ecbc28 JF	30	ExceptionHandlerContext = (EXCEPTION_HANDLER_CONTEXT *) (UINTN) (SystemContext.SystemContextIa32);\r
	31	ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
	32	ExternalInterruptHandler = ExceptionHandlerData->ExternalInterruptHandler;\r
e41aad15	33	\r
44ecbc28	34	switch (ReservedVectors[ExceptionType].Attribute) {\r
e41aad15 JF	35	case EFI_VECTOR_HANDOFF_HOOK_BEFORE:\r
e41aad15 JF	36	//\r
87a9dd0d RN	37	// The new exception handler registered by RegisterCpuInterruptHandler() is executed BEFORE original handler.\r
87a9dd0d RN	38	// Save the original handler to stack so the assembly code can jump to it instead of returning from handler.\r
e41aad15 JF	39	//\r
e41aad15 JF	40	ExceptionHandlerContext->ExceptionDataFlag = (mErrorCodeFlag & (1 << ExceptionType)) ? TRUE : FALSE;\r
44ecbc28	41	ExceptionHandlerContext->OldIdtHandler = ReservedVectors[ExceptionType].ExceptonHandler;\r
e41aad15 JF	42	break;\r
	43	case EFI_VECTOR_HANDOFF_HOOK_AFTER:\r
	44	while (TRUE) {\r
	45	//\r
87a9dd0d	46	// If spin-lock can be acquired, it's the first time entering here.\r
e41aad15	47	//\r
44ecbc28	48	if (AcquireSpinLockOrFail (&ReservedVectors[ExceptionType].SpinLock)) {\r
e41aad15	49	//\r
87a9dd0d RN	50	// The new exception handler registered by RegisterCpuInterruptHandler() is executed AFTER original handler.\r
	51	// Save the original handler to stack but skip running the new handler so the original handler is executed\r
	52	// firstly.\r
e41aad15	53	//\r
44ecbc28	54	ReservedVectors[ExceptionType].ApicId = GetApicId ();\r
81b21fc2	55	ArchSaveExceptionContext (ExceptionType, SystemContext, ExceptionHandlerData);\r
e41aad15	56	ExceptionHandlerContext->ExceptionDataFlag = (mErrorCodeFlag & (1 << ExceptionType)) ? TRUE : FALSE;\r
44ecbc28	57	ExceptionHandlerContext->OldIdtHandler = ReservedVectors[ExceptionType].ExceptonHandler;\r
e41aad15 JF	58	return;\r
	59	}\r
	60	//\r
87a9dd0d RN	61	// If spin-lock cannot be acquired, it's the second time entering here.\r
87a9dd0d RN	62	// 'break' instead of 'return' is used so the new exception handler can be executed.\r
e41aad15	63	//\r
44ecbc28	64	if (ReservedVectors[ExceptionType].ApicId == GetApicId ()) {\r
e41aad15	65	//\r
438f1766	66	// Old IDT handler has been executed, then restore CPU exception content to\r
e41aad15 JF	67	// run new exception handler.\r
e41aad15 JF	68	//\r
368c54e7	69	ArchRestoreExceptionContext (ExceptionType, SystemContext, ExceptionHandlerData);\r
e41aad15	70	//\r
418aded9	71	// Release spin lock for ApicId\r
e41aad15	72	//\r
44ecbc28	73	ReleaseSpinLock (&ReservedVectors[ExceptionType].SpinLock);\r
e41aad15 JF	74	break;\r
	75	}\r
	76	CpuPause ();\r
	77	}\r
	78	break;\r
	79	case 0xffffffff:\r
	80	break;\r
	81	default:\r
	82	//\r
	83	// It should never reach here\r
	84	//\r
	85	CpuDeadLoop ();\r
	86	break;\r
8f07f895	87	}\r
dd563742	88	\r
44ecbc28 JF	89	if (ExternalInterruptHandler != NULL &&\r
	90	ExternalInterruptHandler[ExceptionType] != NULL) {\r
	91	(ExternalInterruptHandler[ExceptionType]) (ExceptionType, SystemContext);\r
f3b113bf	92	} else if (ExceptionType < CPU_EXCEPTION_NUM) {\r
e41aad15 JF	93	//\r
	94	// Get Spinlock to display CPU information\r
	95	//\r
44ecbc28	96	while (!AcquireSpinLockOrFail (&ExceptionHandlerData->DisplayMessageSpinLock)) {\r
e41aad15 JF	97	CpuPause ();\r
	98	}\r
	99	//\r
7230212a RN	100	// Initialize the serial port before dumping.\r
	101	//\r
	102	SerialPortInitialize ();\r
	103	//\r
e41aad15	104	// Display ExceptionType, CPU information and Image information\r
dd563742	105	//\r
1b2f7b3e	106	DumpImageAndCpuContent (ExceptionType, SystemContext);\r
e41aad15 JF	107	//\r
	108	// Release Spinlock of output message\r
	109	//\r
44ecbc28	110	ReleaseSpinLock (&ExceptionHandlerData->DisplayMessageSpinLock);\r
e41aad15 JF	111	//\r
	112	// Enter a dead loop if needn't to execute old IDT handler further\r
	113	//\r
44ecbc28	114	if (ReservedVectors[ExceptionType].Attribute != EFI_VECTOR_HANDOFF_HOOK_BEFORE) {\r
e41aad15 JF	115	CpuDeadLoop ();\r
	116	}\r
	117	}\r
	118	}\r
8f07f895	119	\r
e41aad15 JF	120	/**\r
	121	Internal worker function to update IDT entries accordling to vector attributes.\r
	122	\r
9db15f81 JF	123	@param[in] IdtTable Pointer to IDT table.\r
	124	@param[in] TemplateMap Pointer to a buffer where the address map is\r
	125	returned.\r
	126	@param[in] ExceptionHandlerData Pointer to exception handler data.\r
e41aad15 JF	127	\r
	128	**/\r
	129	VOID\r
	130	UpdateIdtTable (\r
	131	IN IA32_IDT_GATE_DESCRIPTOR *IdtTable,\r
	132	IN EXCEPTION_HANDLER_TEMPLATE_MAP *TemplateMap,\r
9db15f81	133	IN EXCEPTION_HANDLER_DATA *ExceptionHandlerData\r
e41aad15 JF	134	)\r
	135	{\r
	136	UINT16 CodeSegment;\r
	137	UINTN Index;\r
	138	UINTN InterruptHandler;\r
9db15f81	139	RESERVED_VECTORS_DATA *ReservedVectors;\r
8f07f895	140	\r
9db15f81	141	ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
8f07f895	142	//\r
e41aad15	143	// Use current CS as the segment selector of interrupt gate in IDT\r
8f07f895	144	//\r
e41aad15	145	CodeSegment = AsmReadCs ();\r
8f07f895	146	\r
9db15f81	147	for (Index = 0; Index < ExceptionHandlerData->IdtEntryCount; Index ++) {\r
e41aad15 JF	148	IdtTable[Index].Bits.Selector = CodeSegment;\r
	149	//\r
	150	// Check reserved vectors attributes\r
	151	//\r
9db15f81	152	switch (ReservedVectors[Index].Attribute) {\r
e41aad15 JF	153	case EFI_VECTOR_HANDOFF_DO_NOT_HOOK:\r
	154	//\r
	155	// Keep original IDT entry\r
	156	//\r
	157	continue;\r
	158	case EFI_VECTOR_HANDOFF_HOOK_AFTER:\r
9db15f81	159	InitializeSpinLock (&ReservedVectors[Index].SpinLock);\r
e41aad15	160	CopyMem (\r
9db15f81	161	(VOID *) ReservedVectors[Index].HookAfterStubHeaderCode,\r
e41aad15 JF	162	(VOID *) TemplateMap->HookAfterStubHeaderStart,\r
	163	TemplateMap->ExceptionStubHeaderSize\r
	164	);\r
07da1ac8	165	AsmVectorNumFixup (\r
9db15f81	166	(VOID *) ReservedVectors[Index].HookAfterStubHeaderCode,\r
07da1ac8 AF	167	(UINT8) Index,\r
	168	(VOID *) TemplateMap->HookAfterStubHeaderStart\r
	169	);\r
e41aad15 JF	170	//\r
	171	// Go on the following code\r
	172	//\r
	173	case EFI_VECTOR_HANDOFF_HOOK_BEFORE:\r
	174	//\r
	175	// Save original IDT handler address\r
	176	//\r
9db15f81	177	ReservedVectors[Index].ExceptonHandler = ArchGetIdtHandler (&IdtTable[Index]);\r
e41aad15 JF	178	//\r
	179	// Go on the following code\r
	180	//\r
	181	default:\r
	182	//\r
	183	// Update new IDT entry\r
	184	//\r
	185	InterruptHandler = TemplateMap->ExceptionStart + Index * TemplateMap->ExceptionStubHeaderSize;\r
	186	ArchUpdateIdtEntry (&IdtTable[Index], InterruptHandler);\r
	187	break;\r
	188	}\r
	189	}\r
8f07f895	190	}\r
	191	\r
	192	/**\r
e41aad15	193	Internal worker function to initialize exception handler.\r
8f07f895	194	\r
ab95e54d JF	195	@param[in] VectorInfo Pointer to reserved vector list.\r
ab95e54d JF	196	@param[in, out] ExceptionHandlerData Pointer to exception handler data.\r
dd563742 JF	197	\r
dd563742 JF	198	@retval EFI_SUCCESS CPU Exception Entries have been successfully initialized\r
e41aad15 JF	199	with default exception handlers.\r
	200	@retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL.\r
	201	@retval EFI_UNSUPPORTED This function is not supported.\r
	202	\r
8f07f895	203	**/\r
e41aad15 JF	204	EFI_STATUS\r
e41aad15 JF	205	InitializeCpuExceptionHandlersWorker (\r
ab95e54d JF	206	IN EFI_VECTOR_HANDOFF_INFO *VectorInfo OPTIONAL,\r
ab95e54d JF	207	IN OUT EXCEPTION_HANDLER_DATA *ExceptionHandlerData\r
8f07f895	208	)\r
8f07f895	209	{\r
e41aad15 JF	210	EFI_STATUS Status;\r
	211	IA32_DESCRIPTOR IdtDescriptor;\r
	212	UINTN IdtEntryCount;\r
	213	EXCEPTION_HANDLER_TEMPLATE_MAP TemplateMap;\r
	214	IA32_IDT_GATE_DESCRIPTOR *IdtTable;\r
ab95e54d	215	RESERVED_VECTORS_DATA *ReservedVectors;\r
e41aad15	216	\r
ab95e54d JF	217	ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
ab95e54d JF	218	SetMem ((VOID ) ReservedVectors, sizeof (RESERVED_VECTORS_DATA) CPU_EXCEPTION_NUM, 0xff);\r
e41aad15	219	if (VectorInfo != NULL) {\r
ab95e54d	220	Status = ReadAndVerifyVectorInfo (VectorInfo, ReservedVectors, CPU_EXCEPTION_NUM);\r
e41aad15 JF	221	if (EFI_ERROR (Status)) {\r
	222	return EFI_INVALID_PARAMETER;\r
	223	}\r
	224	}\r
e41aad15	225	\r
e41aad15 JF	226	//\r
	227	// Read IDT descriptor and calculate IDT size\r
	228	//\r
	229	AsmReadIdtr (&IdtDescriptor);\r
	230	IdtEntryCount = (IdtDescriptor.Limit + 1) / sizeof (IA32_IDT_GATE_DESCRIPTOR);\r
	231	if (IdtEntryCount > CPU_EXCEPTION_NUM) {\r
	232	//\r
418aded9	233	// CPU exception library only setup CPU_EXCEPTION_NUM exception handler at most\r
e41aad15 JF	234	//\r
	235	IdtEntryCount = CPU_EXCEPTION_NUM;\r
	236	}\r
	237	\r
	238	IdtTable = (IA32_IDT_GATE_DESCRIPTOR *) IdtDescriptor.Base;\r
	239	AsmGetTemplateAddressMap (&TemplateMap);\r
	240	ASSERT (TemplateMap.ExceptionStubHeaderSize <= HOOKAFTER_STUB_SIZE);\r
9db15f81 JF	241	\r
	242	ExceptionHandlerData->IdtEntryCount = IdtEntryCount;\r
	243	UpdateIdtTable (IdtTable, &TemplateMap, ExceptionHandlerData);\r
d91225cf	244	\r
e41aad15 JF	245	return EFI_SUCCESS;\r
	246	}\r
	247	\r
	248	/**\r
	249	Registers a function to be called from the processor interrupt handler.\r
	250	\r
670f13af JF	251	@param[in] InterruptType Defines which interrupt or exception to hook.\r
	252	@param[in] InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called\r
	253	when a processor interrupt occurs. If this parameter is NULL, then the handler\r
	254	will be uninstalled\r
	255	@param[in] ExceptionHandlerData Pointer to exception handler data.\r
e41aad15 JF	256	\r
	257	@retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled.\r
	258	@retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was\r
	259	previously installed.\r
	260	@retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not\r
	261	previously installed.\r
	262	@retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported,\r
	263	or this function is not supported.\r
3f25e6ea	264	**/\r
e41aad15 JF	265	EFI_STATUS\r
	266	RegisterCpuInterruptHandlerWorker (\r
	267	IN EFI_EXCEPTION_TYPE InterruptType,\r
670f13af JF	268	IN EFI_CPU_INTERRUPT_HANDLER InterruptHandler,\r
670f13af JF	269	IN EXCEPTION_HANDLER_DATA *ExceptionHandlerData\r
e41aad15 JF	270	)\r
e41aad15 JF	271	{\r
670f13af JF	272	UINTN EnabledInterruptNum;\r
	273	RESERVED_VECTORS_DATA *ReservedVectors;\r
	274	EFI_CPU_INTERRUPT_HANDLER *ExternalInterruptHandler;\r
	275	\r
	276	EnabledInterruptNum = ExceptionHandlerData->IdtEntryCount;\r
	277	ReservedVectors = ExceptionHandlerData->ReservedVectors;\r
	278	ExternalInterruptHandler = ExceptionHandlerData->ExternalInterruptHandler;\r
	279	\r
	280	if (InterruptType < 0 \|\| InterruptType >= (EFI_EXCEPTION_TYPE)EnabledInterruptNum \|\|\r
	281	ReservedVectors[InterruptType].Attribute == EFI_VECTOR_HANDOFF_DO_NOT_HOOK) {\r
e41aad15 JF	282	return EFI_UNSUPPORTED;\r
	283	}\r
	284	\r
670f13af	285	if (InterruptHandler == NULL && ExternalInterruptHandler[InterruptType] == NULL) {\r
e41aad15 JF	286	return EFI_INVALID_PARAMETER;\r
	287	}\r
	288	\r
670f13af	289	if (InterruptHandler != NULL && ExternalInterruptHandler[InterruptType] != NULL) {\r
e41aad15 JF	290	return EFI_ALREADY_STARTED;\r
	291	}\r
	292	\r
670f13af	293	ExternalInterruptHandler[InterruptType] = InterruptHandler;\r
e41aad15	294	return EFI_SUCCESS;\r
8f07f895	295	}\r
8f07f895	296	\r