MdePkg/Library/UefiPciSegmentLibPciRootBridgeIo/PciSegmentLib.h

   1 /** @file
   2   Include file of PciSegmentPciRootBridgeIo Library.
   3
   4   Copyright (c) 2007 - 2018, Intel Corporation. All rights reserved.<BR>
   5   This program and the accompanying materials are
   6   licensed and made available under the terms and conditions of
   7   the BSD License which accompanies this distribution.  The full
   8   text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php.
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef __DXE_PCI_SEGMENT_LIB__
  17 #define __DXE_PCI_SEGMENT_LIB__
  18
  19
  20 #include <Protocol/PciRootBridgeIo.h>
  21
  22 #include <Library/PciSegmentLib.h>
  23 #include <Library/BaseLib.h>
  24 #include <Library/MemoryAllocationLib.h>
  25 #include <Library/UefiBootServicesTableLib.h>
  26 #include <Library/DebugLib.h>
  27
  28 #include <IndustryStandard/Acpi.h>
  29
  30 typedef struct {
  31   EFI_PCI_ROOT_BRIDGE_IO_PROTOCOL    *PciRootBridgeIo;
  32   UINT32                             SegmentNumber;
  33   UINT64                             MinBusNumber;
  34   UINT64                             MaxBusNumber;
  35 } PCI_ROOT_BRIDGE_DATA;
  36
  37 /**
  38   Assert the validity of a PCI Segment address.
  39   A valid PCI Segment address should not contain 1's in bits 28..31 and 48..63
  40
  41   @param  A The address to validate.
  42   @param  M Additional bits to assert to be zero.
  43
  44 **/
  45 #define ASSERT_INVALID_PCI_SEGMENT_ADDRESS(A,M) \
  46   ASSERT (((A) & (0xffff0000f0000000ULL | (M))) == 0)
  47
  48 /**
  49   Translate PCI Lib address into format of PCI Root Bridge I/O Protocol
  50
  51   @param  A  The address that encodes the PCI Bus, Device, Function and
  52              Register.
  53
  54 **/
  55 #define PCI_TO_PCI_ROOT_BRIDGE_IO_ADDRESS(A) \
  56   ((((UINT32)(A) << 4) & 0xff000000) | (((UINT32)(A) >> 4) & 0x00000700) | (((UINT32)(A) << 1) & 0x001f0000) | (LShiftU64((A) & 0xfff, 32)))
  57
  58 #endif