TianoCore EDK2 master
Loading...
Searching...
No Matches
PiPcdInfo.h File Reference

Go to the source code of this file.

Data Structures

struct  _EFI_GET_PCD_INFO_PROTOCOL
 

Macros

#define EFI_GET_PCD_INFO_PROTOCOL_GUID    { 0xfd0f4478, 0xefd, 0x461d, { 0xba, 0x2d, 0xe5, 0x8c, 0x45, 0xfd, 0x5f, 0x5e } }
 

Typedefs

typedef struct _EFI_GET_PCD_INFO_PROTOCOL EFI_GET_PCD_INFO_PROTOCOL
 
typedef EFI_STATUS(EFIAPI * EFI_GET_PCD_INFO_PROTOCOL_GET_INFO) (IN CONST EFI_GUID *Guid, IN UINTN TokenNumber, OUT EFI_PCD_INFO *PcdInfo)
 
typedef UINTN(EFIAPI * EFI_GET_PCD_INFO_PROTOCOL_GET_SKU) (VOID)
 

Variables

EFI_GUID gEfiGetPcdInfoProtocolGuid
 

Detailed Description

Platform Configuration Database (PCD) Info Protocol defined in PI 1.2.1 Vol3.

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

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

Revision Reference:
PI Version 1.2.1 Vol 3.

Definition in file PiPcdInfo.h.

Macro Definition Documentation

◆ EFI_GET_PCD_INFO_PROTOCOL_GUID

#define EFI_GET_PCD_INFO_PROTOCOL_GUID    { 0xfd0f4478, 0xefd, 0x461d, { 0xba, 0x2d, 0xe5, 0x8c, 0x45, 0xfd, 0x5f, 0x5e } }

Definition at line 18 of file PiPcdInfo.h.

Typedef Documentation

◆ EFI_GET_PCD_INFO_PROTOCOL

The forward declaration for EFI_GET_PCD_INFO_PROTOCOL.

Definition at line 24 of file PiPcdInfo.h.

◆ EFI_GET_PCD_INFO_PROTOCOL_GET_INFO

typedef EFI_STATUS(EFIAPI * EFI_GET_PCD_INFO_PROTOCOL_GET_INFO) (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]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.

Definition at line 40 of file PiPcdInfo.h.

◆ EFI_GET_PCD_INFO_PROTOCOL_GET_SKU

typedef UINTN(EFIAPI * EFI_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 55 of file PiPcdInfo.h.