MdePkg/Include/Library/SmmIoLib.h

   1 /** @file
   2   Provides services for SMM IO Operation.
   3
   4   The SMM IO Library provides function for checking if IO resource is accessible inside of SMM.
   5
   6   Copyright (c) 2017, Intel Corporation. All rights reserved.<BR>
   7   SPDX-License-Identifier: BSD-2-Clause-Patent
   8
   9 **/
  10
  11 #ifndef _SMM_IO_LIB_H_
  12 #define _SMM_IO_LIB_H_
  13
  14 /**
  15   This function check if the MMIO resource is valid per processor architecture and
  16   valid per platform design.
  17
  18   @param BaseAddress  The MMIO start address to be checked.
  19   @param Length       The MMIO length to be checked.
  20   @param Owner        A GUID representing the owner of the resource.
  21                       This GUID may be used by producer to correlate the device ownership of the resource.
  22                       NULL means no specific owner.
  23
  24   @retval TRUE  This MMIO resource is valid per processor architecture and valid per platform design.
  25   @retval FALSE This MMIO resource is not valid per processor architecture or valid per platform design.
  26 **/
  27 BOOLEAN
  28 EFIAPI
  29 SmmIsMmioValid (
  30   IN EFI_PHYSICAL_ADDRESS  BaseAddress,
  31   IN UINT64                Length,
  32   IN EFI_GUID              *Owner  OPTIONAL
  33   );
  34
  35 #endif
  36