MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Library / UefiPciSegmentLibPciRootBridgeIo / PciSegmentLib.h

/** @file\r
  Include file of PciSegmentPciRootBridgeIo Library.\r
\r
  Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __DXE_PCI_SEGMENT_LIB__\r
#define __DXE_PCI_SEGMENT_LIB__\r
\r
\r
#include <Protocol/PciRootBridgeIo.h>\r
\r
#include <Library/PciSegmentLib.h>\r
#include <Library/BaseLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/DebugLib.h>\r
\r
#include <IndustryStandard/Acpi.h>\r
\r
typedef struct {\r
  EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *PciRootBridgeIo;\r
  UINT32                             SegmentNumber;\r
  UINT64                             MinBusNumber;\r
  UINT64                             MaxBusNumber;\r
} PCI_ROOT_BRIDGE_DATA;\r
\r
/**\r
  Assert the validity of a PCI Segment address.\r
  A valid PCI Segment address should not contain 1's in bits 28..31 and 48..63\r
\r
  @param  A The address to validate.\r
  @param  M Additional bits to assert to be zero.\r
\r
**/\r
#define ASSERT_INVALID_PCI_SEGMENT_ADDRESS(A,M) \\r
  ASSERT (((A) & (0xffff0000f0000000ULL | (M))) == 0)\r
\r
/**\r
  Translate PCI Lib address into format of PCI Root Bridge I/O Protocol\r
\r
  @param  A  The address that encodes the PCI Bus, Device, Function and\r
             Register.\r
\r
**/\r
#define PCI_TO_PCI_ROOT_BRIDGE_IO_ADDRESS(A) \\r
  ((((UINT32)(A) << 4) & 0xff000000) | (((UINT32)(A) >> 4) & 0x00000700) | (((UINT32)(A) << 1) & 0x001f0000) | (LShiftU64((A) & 0xfff, 32)))\r
\r
#endif\r