MdePkg/Include/Ppi/PcdInfo.h File Reference


Data Structures

struct  _GET_PCD_INFO_PPI

Defines

#define GET_PCD_INFO_PPI_GUID   { 0x4d8b155b, 0xc059, 0x4c8f, { 0x89, 0x26, 0x6, 0xfd, 0x43, 0x31, 0xdb, 0x8a } }

Typedefs

typedef struct _GET_PCD_INFO_PPI GET_PCD_INFO_PPI
typedef OUT EFI_PCD_INFOPcdInfo
typedef IN UINTN TokenNumber

Functions

typedef EFI_STATUS (EFIAPI *GET_PCD_INFO_PPI_GET_INFO)(IN UINTN TokenNumber
typedef UINTN (EFIAPI *GET_PCD_INFO_PPI_GET_SKU)(VOID)

Variables

EFI_GUID gGetPcdInfoPpiGuid

Detailed Description

Native Platform Configuration Database (PCD) INFO PPI

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

Different with the EFI_GET_PCD_INFO_PPI defined in PI 1.2.1 specification, the native PCD INFO PPI 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, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define GET_PCD_INFO_PPI_GUID   { 0x4d8b155b, 0xc059, 0x4c8f, { 0x89, 0x26, 0x6, 0xfd, 0x43, 0x31, 0xdb, 0x8a } }


Typedef Documentation

The forward declaration for GET_PCD_INFO_PPI.

typedef IN UINTN OUT EFI_PCD_INFO * PcdInfo

typedef IN UINTN TokenNumber


Function Documentation

typedef EFI_STATUS ( EFIAPI *  GET_PCD_INFO_PPI_GET_INFO_EX  ) 

Retrieve additional information associated with a PCD token in the default token space.

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.
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.

typedef UINTN ( EFIAPI *  GET_PCD_INFO_PPI_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


Generated on Wed Sep 23 16:24:22 2015 for MdePkg[ALL] by  doxygen 1.5.7.1