ArmPkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / ArmPkg / Drivers / ArmGic / ArmGicDxe.h

/*++\r
\r
Copyright (c) 2013-2017, ARM Ltd. All rights reserved.<BR>\r
\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
--*/\r
\r
#ifndef __ARM_GIC_DXE_H__\r
#define __ARM_GIC_DXE_H__\r
\r
#include <Library/ArmGicLib.h>\r
#include <Library/ArmLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/IoLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiLib.h>\r
\r
#include <Protocol/Cpu.h>\r
#include <Protocol/HardwareInterrupt.h>\r
#include <Protocol/HardwareInterrupt2.h>\r
\r
extern UINTN                        mGicNumInterrupts;\r
extern HARDWARE_INTERRUPT_HANDLER  *gRegisteredInterruptHandlers;\r
\r
// Common API\r
EFI_STATUS\r
InstallAndRegisterInterruptService (\r
  IN EFI_HARDWARE_INTERRUPT_PROTOCOL   *InterruptProtocol,\r
  IN EFI_HARDWARE_INTERRUPT2_PROTOCOL  *Interrupt2Protocol,\r
  IN EFI_CPU_INTERRUPT_HANDLER          InterruptHandler,\r
  IN EFI_EVENT_NOTIFY                   ExitBootServicesEvent\r
  );\r
\r
EFI_STATUS\r
EFIAPI\r
RegisterInterruptSource (\r
  IN EFI_HARDWARE_INTERRUPT_PROTOCOL    *This,\r
  IN HARDWARE_INTERRUPT_SOURCE          Source,\r
  IN HARDWARE_INTERRUPT_HANDLER         Handler\r
  );\r
\r
// GicV2 API\r
EFI_STATUS\r
GicV2DxeInitialize (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  );\r
\r
// GicV3 API\r
EFI_STATUS\r
GicV3DxeInitialize (\r
  IN EFI_HANDLE         ImageHandle,\r
  IN EFI_SYSTEM_TABLE   *SystemTable\r
  );\r
\r
\r
// Shared code\r
\r
/**\r
  Calculate GICD_ICFGRn base address and corresponding bit\r
  field Int_config[1] of the GIC distributor register.\r
\r
  @param Source       Hardware source of the interrupt.\r
  @param RegAddress   Corresponding GICD_ICFGRn base address.\r
  @param Config1Bit   Bit number of F Int_config[1] bit in the register.\r
\r
  @retval EFI_SUCCESS       Source interrupt supported.\r
  @retval EFI_UNSUPPORTED   Source interrupt is not supported.\r
**/\r
EFI_STATUS\r
GicGetDistributorIcfgBaseAndBit (\r
  IN HARDWARE_INTERRUPT_SOURCE             Source,\r
  OUT UINTN                               *RegAddress,\r
  OUT UINTN                               *Config1Bit\r
  );\r
\r
#endif\r