PcdInfo.h File Reference

Go to the source code of this file.

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 EFI_STATUS(EFIAPI *	GET_PCD_INFO_PROTOCOL_GET_INFO) (IN UINTN TokenNumber, OUT EFI_PCD_INFO *PcdInfo)
typedef EFI_STATUS(EFIAPI *	GET_PCD_INFO_PROTOCOL_GET_INFO_EX) (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, OUT EFI_PCD_INFO *PcdInfo)
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.

Definition in file PcdInfo.h.

Macro Definition Documentation

GET_PCD_INFO_PROTOCOL_GUID

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

Definition at line 24 of file PcdInfo.h.

Typedef Documentation

GET_PCD_INFO_PROTOCOL

typedef struct _GET_PCD_INFO_PROTOCOL GET_PCD_INFO_PROTOCOL

The forward declaration for GET_PCD_INFO_PROTOCOL.

Definition at line 30 of file PcdInfo.h.

GET_PCD_INFO_PROTOCOL_GET_INFO

typedef EFI_STATUS(EFIAPI * GET_PCD_INFO_PROTOCOL_GET_INFO) (IN UINTN TokenNumber, OUT EFI_PCD_INFO *PcdInfo)

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]	TokenNumber	The PCD token number.
[out]	PcdInfo	The returned information associated with the requested TokenNumber.

Return values

EFI_SUCCESS	The PCD information was returned successfully
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 45 of file PcdInfo.h.

GET_PCD_INFO_PROTOCOL_GET_INFO_EX

typedef EFI_STATUS(EFIAPI * GET_PCD_INFO_PROTOCOL_GET_INFO_EX) (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, OUT EFI_PCD_INFO *PcdInfo)

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]	Guid	The 128-bit unique value that designates the namespace from which to extract the value.
[in]	TokenNumber	The PCD token number.
[out]	PcdInfo	The returned information associated with the requested TokenNumber.

Return values

EFI_SUCCESS	The PCD information was returned successfully
EFI_NOT_FOUND	The PCD service could not find the requested token number.

Definition at line 65 of file PcdInfo.h.

GET_PCD_INFO_PROTOCOL_GET_SKU

typedef UINTN(EFIAPI * GET_PCD_INFO_PROTOCOL_GET_SKU) (VOID)

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.

Definition at line 80 of file PcdInfo.h.