remove PCD_INVALID_TOKEN_NUMBER, that is not defined in PCD Spec.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6123 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
vanjeff 2008-10-16 09:08:44 +00:00
parent 1003f96692
commit b05ac954ab
2 changed files with 135 additions and 122 deletions

View File

@ -1,7 +1,7 @@
/** @file /** @file
Platform Configuration Database (PCD) PPI Platform Configuration Database (PCD) PPI
Copyright (c) 2006 - 2007, Intel Corporation Copyright (c) 2006 - 2008, Intel Corporation
All rights reserved. This program and the accompanying materials All rights reserved. This program and the accompanying materials
are licensed and made available under the terms and conditions of the BSD License 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 which accompanies this distribution. The full text of the license may be found at
@ -18,9 +18,6 @@
#define PCD_PPI_GUID \ #define PCD_PPI_GUID \
{ 0x6e81c58, 0x4ad7, 0x44bc, { 0x83, 0x90, 0xf1, 0x2, 0x65, 0xf7, 0x24, 0x80 } } { 0x6e81c58, 0x4ad7, 0x44bc, { 0x83, 0x90, 0xf1, 0x2, 0x65, 0xf7, 0x24, 0x80 } }
#define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)
/** /**
Sets the SKU value for subsequent calls to set or get PCD token values. Sets the SKU value for subsequent calls to set or get PCD token values.
@ -73,7 +70,7 @@ UINT8
/** /**
Retrieves an 16-bit value for a given PCD token. Retrieves a 16-bit value for a given PCD token.
Retrieves the current 16-bits value for a PCD token number. Retrieves the current 16-bits value for a PCD token number.
If the TokenNumber is invalid, the results are unpredictable. If the TokenNumber is invalid, the results are unpredictable.
@ -92,7 +89,7 @@ UINT16
/** /**
Retrieves an 32-bit value for a given PCD token. Retrieves a 32-bit value for a given PCD token.
Retrieves the current 32-bits value for a PCD token number. Retrieves the current 32-bits value for a PCD token number.
If the TokenNumber is invalid, the results are unpredictable. If the TokenNumber is invalid, the results are unpredictable.
@ -111,7 +108,7 @@ UINT32
/** /**
Retrieves an 64-bit value for a given PCD token. Retrieves a 64-bit value for a given PCD token.
Retrieves the current 64-bits value for a PCD token number. Retrieves the current 64-bits value for a PCD token number.
If the TokenNumber is invalid, the results are unpredictable. If the TokenNumber is invalid, the results are unpredictable.
@ -214,7 +211,7 @@ UINT8
/** /**
Retrieves an 16-bit value for a given PCD token and token space. Retrieves a 16-bit value for a given PCD token and token space.
Retrieves the 16-bit value of a particular PCD token. Retrieves the 16-bit value of a particular PCD token.
If the TokenNumber is invalid or the token space If the TokenNumber is invalid or the token space
@ -237,7 +234,7 @@ UINT16
/** /**
Retrieves an 32-bit value for a given PCD token and token space. Retrieves a 32-bit value for a given PCD token and token space.
Retrieves the 32-bit value of a particular PCD token. Retrieves the 32-bit value of a particular PCD token.
If the TokenNumber is invalid or the token space If the TokenNumber is invalid or the token space
@ -260,7 +257,7 @@ UINT32
/** /**
Retrieves an 64-bit value for a given PCD token and token space. Retrieves a 64-bit value for a given PCD token and token space.
Retrieves the 64-bit value of a particular PCD token. Retrieves the 64-bit value of a particular PCD token.
If the TokenNumber is invalid or the token space If the TokenNumber is invalid or the token space
@ -376,7 +373,7 @@ EFI_STATUS
/** /**
Sets an 16-bit value for a given PCD token. Sets a 16-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition. size of the value being set is compatible with the Token's existing definition.
@ -402,7 +399,7 @@ EFI_STATUS
/** /**
Sets an 32-bit value for a given PCD token. Sets a 32-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition. size of the value being set is compatible with the Token's existing definition.
@ -428,7 +425,7 @@ EFI_STATUS
/** /**
Sets an 64-bit value for a given PCD token. Sets a 64-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition. size of the value being set is compatible with the Token's existing definition.
@ -482,6 +479,12 @@ EFI_STATUS
IN OUT UINTN *SizeOfBuffer, IN OUT UINTN *SizeOfBuffer,
IN VOID *Buffer IN VOID *Buffer
); );
///EFI_STATUS
///(EFIAPI *PCD_PPI_SET_POINTER) (
///IN PCD_TOKEN_NUMBER TokenNumber,
///IN UINTN SizeOfValue,
///IN VOID *Buffer
/// );
@ -540,7 +543,7 @@ EFI_STATUS
/** /**
Sets an 16-bit value for a given PCD token. Sets a 16-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition. size of the value being set is compatible with the Token's existing definition.
@ -568,7 +571,7 @@ EFI_STATUS
/** /**
Sets an 32-bit value for a given PCD token. Sets a 32-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition. size of the value being set is compatible with the Token's existing definition.
@ -596,7 +599,7 @@ EFI_STATUS
/** /**
Sets an 64-bit value for a given PCD token. Sets a 64-bit value for a given PCD token.
When the PCD service sets a value, it will check to ensure that the When the PCD service sets a value, it will check to ensure that the
size of the value being set is compatible with the Token's existing definition. size of the value being set is compatible with the Token's existing definition.
@ -653,7 +656,15 @@ EFI_STATUS
IN OUT UINTN *SizeOfBuffer, IN OUT UINTN *SizeOfBuffer,
IN VOID *Buffer IN VOID *Buffer
); );
/// different with PCD Spec 0.54
///EFI_STATUS
///(EFIAPI *PCD_PPI_SET_EX_POINTER) (
/// IN CONST EFI_GUID *Guid,
/// IN PCD_TOKEN_NUMBER TokenNumber,
/// IN UINTN SizeOfValue,
/// IN VOID *Buffer
/// );
///
/** /**
@ -760,14 +771,17 @@ EFI_STATUS
/** /**
Retrieves the next valid PCD token for a given namespace. Retrieves the next valid PCD token for a given namespace.
@param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
@param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number.
If the input token namespace or token number does not exist on the platform, an error is If the input token namespace or token number does not exist on the platform, an error is
returned and the value of *TokenNumber is undefined. To retrieve the "first" token, returned and the value of *TokenNumber is undefined. To retrieve the "first" token,
have the pointer reference a TokenNumber value of 0. If the input token number is 0 have the pointer reference a TokenNumber value of 0.
and there is no valid token number for this token namespace, *TokenNumber will be If the input token number is 0 and there is no valid token number for this token namespace,
assigned to 0 and the function return EFI_SUCCESS. If the token number is the last valid *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS.
token number, *TokenNumber will be assigned to 0 and the function return EFI_SUCCESS. If the token number is the last valid token number, *TokenNumber will be assigned to 0 and
the function return EFI_SUCCESS.
@param[in] Guid The 128-bit unique value that designates the namespace from which to extract the value.
@param[in, out] TokenNumber A pointer to the PCD token number to use to find the subsequent token number.
@retval EFI_SUCCESS The PCD service has retrieved the next valid token number. @retval EFI_SUCCESS The PCD service has retrieved the next valid token number.
Or the input token number is already the last valid token number in the PCD database. Or the input token number is already the last valid token number in the PCD database.
@ -787,17 +801,19 @@ EFI_STATUS
/** /**
Retrieves the next valid PCD token namespace for a given namespace. Retrieves the next valid PCD token namespace for a given namespace.
@param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known If *Guid is NULL, then the GUID of the first token space of the
token namespace from which the search will start. On output, it designates
the next valid token namespace on the platform. If the input token namespace
does not exist on the platform, an error is returned and the value of *Guid is
undefined. If *Guid is NULL, then the GUID of the first token space of the
current platform is assigned to *Guid the function return EFI_SUCCESS. current platform is assigned to *Guid the function return EFI_SUCCESS.
If *Guid is NULL and there is no namespace exist in the platform other than the default If *Guid is NULL and there is no namespace exist in the platform other than the default
(NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS. (NULL) tokennamespace, *Guid is unchanged and the function return EFI_SUCCESS.
If this input token namespace is the last namespace on the platform, If this input token namespace is the last namespace on the platform,
*Guid will be assigned to NULL and the function return EFI_SUCCESS. *Guid will be assigned to NULL and the function return EFI_SUCCESS.
@param[in, out] Guid An indirect pointer to EFI_GUID. On input it designates a known
token namespace from which the search will start. On output, it designates
the next valid token namespace on the platform. If the input token namespace
does not exist on the platform, an error is returned and the value of *Guid is
undefined.
@retval EFI_SUCCESS The PCD service has retrieved the next valid token namespace. @retval EFI_SUCCESS The PCD service has retrieved the next valid token namespace.
Or the input token namespace is already the last valid token Or the input token namespace is already the last valid token
number in the PCD database. In the later case, *Guid is updated number in the PCD database. In the later case, *Guid is updated

View File

@ -20,9 +20,6 @@ extern EFI_GUID gPcdProtocolGuid;
#define PCD_PROTOCOL_GUID \ #define PCD_PROTOCOL_GUID \
{ 0x11b34006, 0xd85b, 0x4d0a, { 0xa2, 0x90, 0xd5, 0xa5, 0x71, 0x31, 0xe, 0xf7 } } { 0x11b34006, 0xd85b, 0x4d0a, { 0xa2, 0x90, 0xd5, 0xa5, 0x71, 0x31, 0xe, 0xf7 } }
#define PCD_INVALID_TOKEN_NUMBER ((UINTN) 0)
/** /**
Sets the SKU value for subsequent calls to set or get PCD token values. Sets the SKU value for subsequent calls to set or get PCD token values.