MdePkg[all]  1.08
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Data Structures | Macros | Typedefs | Functions | Variables
PcdInfo.h File Reference

Data Structures

struct  _GET_PCD_INFO_PROTOCOL
 

Macros

#define GET_PCD_INFO_PROTOCOL_GUID   { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } }
 

Typedefs

typedef struct
_GET_PCD_INFO_PROTOCOL 		GET_PCD_INFO_PROTOCOL
 
typedef OUT EFI_PCD_INFO * PcdInfo
 
typedef IN UINTN TokenNumber
 

Functions

typedef EFI_STATUS (EFIAPI *GET_PCD_INFO_PROTOCOL_GET_INFO)(IN UINTN TokenNumber
 
typedef UINTN (EFIAPI *GET_PCD_INFO_PROTOCOL_GET_SKU)(VOID)
 

Variables

EFI_GUID gGetPcdInfoProtocolGuid
 

Detailed Description

Native Platform Configuration Database (PCD) INFO PROTOCOL.

The protocol that provides additional information about items that reside in the PCD database.

Different with the EFI_GET_PCD_INFO_PROTOCOL defined in PI 1.2.1 specification, the native PCD INFO PROTOCOL provide interfaces for dynamic and dynamic-ex type PCD. The interfaces for dynamic type PCD do not require the token space guid as parameter, but interfaces for dynamic-ex type PCD require token space guid as parameter.

Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:
This Protocol was introduced in PI Specification 1.2.

Macro Definition Documentation

#define GET_PCD_INFO_PROTOCOL_GUID   { 0x5be40f57, 0xfa68, 0x4610, { 0xbb, 0xbf, 0xe9, 0xc5, 0xfc, 0xda, 0xd3, 0x65 } }

Typedef Documentation

typedef struct _GET_PCD_INFO_PROTOCOL GET_PCD_INFO_PROTOCOL

The forward declaration for GET_PCD_INFO_PROTOCOL.

typedef IN UINTN OUT EFI_PCD_INFO* PcdInfo
typedef IN UINTN TokenNumber

Function Documentation

typedef EFI_STATUS ( EFIAPI *  GET_PCD_INFO_PROTOCOL_GET_INFO_EX)

Retrieve additional information associated with a PCD token.

This includes information such as the type of value the TokenNumber is associated with as well as possible human readable name that is associated with the token.

Parameters
[in]TokenNumberThe PCD token number.
[out]PcdInfoThe returned information associated with the requested TokenNumber.
Return values
EFI_SUCCESSThe PCD information was returned successfully
EFI_NOT_FOUNDThe PCD service could not find the requested token number.

Retrieve additional information associated with a PCD token.

This includes information such as the type of value the TokenNumber is associated with as well as possible human readable name that is associated with the token.

Parameters
[in]GuidThe 128-bit unique value that designates the namespace from which to extract the value.
[in]TokenNumberThe PCD token number.
[out]PcdInfoThe returned information associated with the requested TokenNumber.
Return values
EFI_SUCCESSThe PCD information was returned successfully
EFI_NOT_FOUNDThe PCD service could not find the requested token number.
typedef UINTN ( EFIAPI *  GET_PCD_INFO_PROTOCOL_GET_SKU)

Retrieve the currently set SKU Id.

Returns
The currently set SKU Id. If the platform has not set at a SKU Id, then the default SKU Id value of 0 is returned. If the platform has set a SKU Id, then the currently set SKU Id is returned.

Variable Documentation

EFI_GUID gGetPcdInfoProtocolGuid