tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

MdePkg: Correct comments of macros FixedPcdGetX/PatchPcdXXX in PcdLib.h 

REF: https://bugzilla.tianocore.org/show_bug.cgi?id=311

The patch is also to refine comments of macros PcdToken and PcdTokenEx.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael Kinney <michael.d.kinney@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
This commit is contained in:
Star Zeng 2017-01-17 11:41:57 +08:00
parent 7be6e67762
commit 88fd27e5b2
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
MdePkg/Include/Library/PcdLib.h
View File

@ -14,7 +14,7 @@
There are no restrictions on the use of FeaturePcd(), FixedPcdGetXX(),
PatchPcdGetXX(), and PatchPcdSetXX().
Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>
Copyright (c) 2006 - 2017, Intel Corporation. All rights reserved.<BR>
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
@ -32,9 +32,8 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
/**
Retrieves a token number based on a token name.
Returns the token number associated with the PCD token specified by TokenName.
Returns the token number associated with the PCD token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
@param TokenName The name of the PCD token to retrieve the token number for.
@ -49,7 +48,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the Boolean value for the PCD feature flag specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a feature flag PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -64,7 +63,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 8-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a fixed at build PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -79,7 +78,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 16-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a fixed at build PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -94,7 +93,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 32-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a fixed at build PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -109,7 +108,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 64-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a fixed at build PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -124,7 +123,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the Boolean value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a fixed at build PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -139,7 +138,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns a pointer to the buffer for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a fixed at build PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -154,7 +153,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 8-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -168,7 +167,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 16-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -183,7 +182,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 32-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -198,7 +197,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the 64-bit value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -213,7 +212,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns the Boolean value for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -228,7 +227,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Returns a pointer to the buffer for the token specified by TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the PCD token to retrieve a current value for.
@ -243,7 +242,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Sets the 8-bit value for the token specified by TokenName. Value is returned.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the binary patchable PCD token to set the current value for.
@param Value The 8-bit value to set.
@ -259,7 +258,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Sets the 16-bit value for the token specified by TokenName. Value is returned.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the binary patchable PCD token to set the current value for.
@param Value The 16-bit value to set.
@ -275,7 +274,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Sets the 32-bit value for the token specified by TokenName. Value is returned.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the binary patchable PCD token to set the current value for.
@param Value The 32-bit value to set.
@ -291,7 +290,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Sets the 64-bit value for the token specified by TokenName. Value is returned.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the binary patchable PCD token to set the current value for.
@param Value The 64-bit value to set.
@ -307,7 +306,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Sets the Boolean value for the token specified by TokenName. Value is returned.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
@param TokenName The name of the binary patchable PCD token to set the current value for.
@param Value The boolean value to set.
@ -327,7 +326,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
was not actually performed. If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be
set to the maximum size supported by TokenName and NULL must be returned.
If TokenName is not a valid token in the token space, then the module will not build.
If TokenName is not a feature flag, then the module will not build.
If TokenName is not a patchable in module PCD, then the module will not build.
If SizeOfBuffer is NULL, then ASSERT().
If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().
@ -688,6 +687,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
Retrieves a token number based on a GUID and a token name.
Returns the token number for the token specified by Guid and TokenName.
If TokenName is not a valid token in the token space, then the module will not build.
@param Guid Pointer to a 128-bit unique value that designates
which namespace to retrieve a value from.