MdePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdePkg / Include / Ppi / PcdInfo.h

/** @file\r
  Native Platform Configuration Database (PCD) INFO PPI\r
\r
  The PPI that provides additional information about items that reside in the PCD database.\r
\r
  Different with the EFI_GET_PCD_INFO_PPI defined in PI 1.2.1 specification,\r
  the native PCD INFO PPI provide interfaces for dynamic and dynamic-ex type PCD.\r
  The interfaces for dynamic type PCD do not require the token space guid as parameter,\r
  but interfaces for dynamic-ex type PCD require token space guid as parameter.\r
\r
  Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __PCD_INFO_PPI_H__\r
#define __PCD_INFO_PPI_H__\r
\r
extern EFI_GUID gGetPcdInfoPpiGuid;\r
\r
#define GET_PCD_INFO_PPI_GUID \\r
  { 0x4d8b155b, 0xc059, 0x4c8f, { 0x89, 0x26,  0x6, 0xfd, 0x43, 0x31, 0xdb, 0x8a } }\r
\r
///\r
/// The forward declaration for GET_PCD_INFO_PPI.\r
///\r
typedef struct _GET_PCD_INFO_PPI  GET_PCD_INFO_PPI;\r
\r
/**\r
  Retrieve additional information associated with a PCD token in the default token space.\r
\r
  This includes information such as the type of value the TokenNumber is associated with as well as possible\r
  human readable name that is associated with the token.\r
\r
  @param[in]    TokenNumber The PCD token number.\r
  @param[out]   PcdInfo     The returned information associated with the requested TokenNumber.\r
\r
  @retval  EFI_SUCCESS      The PCD information was returned successfully\r
  @retval  EFI_NOT_FOUND    The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *GET_PCD_INFO_PPI_GET_INFO) (\r
  IN        UINTN           TokenNumber,\r
  OUT       EFI_PCD_INFO    *PcdInfo\r
);\r
\r
/**\r
  Retrieve additional information associated with a PCD token.\r
\r
  This includes information such as the type of value the TokenNumber is associated with as well as possible\r
  human readable name that is associated with the token.\r
\r
  @param[in]    Guid        The 128-bit unique value that designates the namespace from which to extract the value.\r
  @param[in]    TokenNumber The PCD token number.\r
  @param[out]   PcdInfo     The returned information associated with the requested TokenNumber.\r
\r
  @retval  EFI_SUCCESS      The PCD information was returned successfully\r
  @retval  EFI_NOT_FOUND    The PCD service could not find the requested token number.\r
**/\r
typedef\r
EFI_STATUS\r
(EFIAPI *GET_PCD_INFO_PPI_GET_INFO_EX) (\r
  IN CONST  EFI_GUID        *Guid,\r
  IN        UINTN           TokenNumber,\r
  OUT       EFI_PCD_INFO    *PcdInfo\r
);\r
\r
/**\r
  Retrieve the currently set SKU Id.\r
\r
  @return   The currently set SKU Id. If the platform has not set at a SKU Id, then the\r
            default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU\r
            Id is returned.\r
**/\r
typedef\r
UINTN\r
(EFIAPI *GET_PCD_INFO_PPI_GET_SKU) (\r
  VOID\r
);\r
\r
///\r
/// This is the PCD service to use when querying for some additional data that can be contained in the\r
/// PCD database.\r
///\r
struct _GET_PCD_INFO_PPI {\r
  ///\r
  /// Retrieve additional information associated with a PCD.\r
  ///\r
  GET_PCD_INFO_PPI_GET_INFO             GetInfo;\r
  GET_PCD_INFO_PPI_GET_INFO_EX          GetInfoEx;\r
  ///\r
  /// Retrieve the currently set SKU Id.\r
  ///\r
  GET_PCD_INFO_PPI_GET_SKU              GetSku;\r
};\r
\r
#endif\r
\r