| 21b50a27 |
1 | /** @file\r |
| 2 | PCD Library Class Interface Declarations\r |
| 3 | \r |
| 4 | Copyright (c) 2006, Intel Corporation \r |
| 5 | All rights reserved. This program and the accompanying materials \r |
| 6 | are licensed and made available under the terms and conditions of the BSD License \r |
| 7 | which accompanies this distribution. The full text of the license may be found at \r |
| 8 | http://opensource.org/licenses/bsd-license.php \r |
| 9 | \r |
| 10 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, \r |
| 11 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. \r |
| 12 | \r |
| 13 | \r |
| 14 | Module Name: PcdLib.h\r |
| 15 | \r |
| 16 | **/\r |
| 17 | \r |
| 18 | #ifndef __PCD_LIB_H__\r |
| 19 | #define __PCD_LIB_H__\r |
| 20 | \r |
| 21 | #define PCD_INVALID_TOKEN_NUMBER ((UINTN) -1)\r |
| 22 | \r |
| 23 | #define PcdToken(TokenName) _PCD_TOKEN_##TokenName\r |
| 24 | \r |
| 25 | \r |
| 26 | //\r |
| 27 | // Feature Flag is in the form of a global constant\r |
| 28 | //\r |
| 29 | #define FeaturePcdGet(TokenName) _gPcd_FixedAtBuild_##TokenName\r |
| 30 | \r |
| 31 | \r |
| 32 | //\r |
| 33 | // Fixed is fixed at build time\r |
| 34 | //\r |
| 35 | #define FixedPcdGet8(TokenName) _gPcd_FixedAtBuild_##TokenName\r |
| 36 | #define FixedPcdGet16(TokenName) _gPcd_FixedAtBuild_##TokenName\r |
| 37 | #define FixedPcdGet32(TokenName) _gPcd_FixedAtBuild_##TokenName\r |
| 38 | #define FixedPcdGet64(TokenName) _gPcd_FixedAtBuild_##TokenName\r |
| 39 | #define FixedPcdGetBool(TokenName) _gPcd_FixedAtBuild_##TokenName\r |
| 40 | \r |
| 41 | \r |
| 42 | //\r |
| 43 | // BugBug: This works for strings, but not constants.\r |
| 44 | //\r |
| 45 | #define FixedPcdGetPtr(TokenName) ((VOID *)_gPcd_FixedAtBuild_##TokenName)\r |
| 46 | \r |
| 47 | \r |
| 48 | //\r |
| 49 | // (Binary) Patch is in the form of a global variable\r |
| 50 | //\r |
| 51 | #define PatchPcdGet8(TokenName) _gPcd_BinaryPatch_##TokenName\r |
| 52 | #define PatchPcdGet16(TokenName) _gPcd_BinaryPatch_##TokenName\r |
| 53 | #define PatchPcdGet32(TokenName) _gPcd_BinaryPatch_##TokenName\r |
| 54 | #define PatchPcdGet64(TokenName) _gPcd_BinaryPatch_##TokenName\r |
| 55 | #define PatchPcdGetBool(TokenName) _gPcd_BinaryPatch_##TokenName\r |
| 56 | #define PatchPcdGetPtr(TokenName) ((VOID *)_gPcd_BinaryPatch_##TokenName)\r |
| 57 | \r |
| 58 | #define PatchPcdSet8(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r |
| 59 | #define PatchPcdSet16(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r |
| 60 | #define PatchPcdSet32(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r |
| 61 | #define PatchPcdSet64(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r |
| 62 | #define PatchPcdSetBool(TokenName, Value) (_gPcd_BinaryPatch_##TokenName = Value)\r |
| 63 | #define PatchPcdSetPtr(TokenName, Value, Size) CopyMem (_gPcd_BinaryPatch_##TokenName, Value, Size)\r |
| 64 | \r |
| 65 | //\r |
| 66 | // Dynamic is via the protocol with only the TokenNumber as argument\r |
| 67 | // It can also be Patch or Fixed type based on a build option\r |
| 68 | //\r |
| 69 | #define PcdGet8(TokenName) _PCD_MODE_8_##TokenName\r |
| 70 | #define PcdGet16(TokenName) _PCD_MODE_16_##TokenName\r |
| 71 | #define PcdGet32(TokenName) _PCD_MODE_32_##TokenName\r |
| 72 | #define PcdGet64(TokenName) _PCD_MODE_64_##TokenName\r |
| 73 | #define PcdGetPtr(TokenName) _PCD_MODE_PTR_##TokenName\r |
| 74 | #define PcdGetBool(TokenName) _PCD_MODE_BOOL_##TokenName\r |
| 75 | \r |
| 76 | \r |
| 77 | //\r |
| 78 | // Dynamic Ex is to support binary distribution\r |
| 79 | //\r |
| 80 | #define PcdGetEx8(Guid, TokenName) LibPcdGetEx8 (Guid, _PCD_TOKEN_##TokenName)\r |
| 81 | #define PcdGetEx16(Guid, TokenName) LibPcdGetEx16 (Guid, _PCD_TOKEN_##TokenName)\r |
| 82 | #define PcdGetEx32(Guid, TokenName) LibPcdGetEx32 (Guid, _PCD_TOKEN_##TokenName)\r |
| 83 | #define PcdGetEx64(Guid, TokenName) LibPcdGetEx64 (Guid, _PCD_TOKEN_##TokenName)\r |
| 84 | #define PcdGetExPtr(Guid, TokenName) LibPcdGetExPtr (Guid, _PCD_TOKEN_##TokenName)\r |
| 85 | #define PcdGetExBool(Guid, TokenName) LibPcdGetExBool (Guid, _PCD_TOKEN_##TokenName)\r |
| 86 | \r |
| 87 | \r |
| 88 | //\r |
| 89 | // Dynamic Set\r |
| 90 | //\r |
| 91 | #define PcdSet8(TokenName, Value) LibPcdSet8 (_PCD_TOKEN_##TokenName, Value)\r |
| 92 | #define PcdSet16(TokenName, Value) LibPcdSet16 (_PCD_TOKEN_##TokenName, Value)\r |
| 93 | #define PcdSet32(TokenName, Value) LibPcdSet32 (_PCD_TOKEN_##TokenName, Value)\r |
| 94 | #define PcdSet64(TokenName, Value) LibPcdSet64 (_PCD_TOKEN_##TokenName, Value)\r |
| 95 | #define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) LibPcdSetPtr (_PCD_TOKEN_##TokenName, SizeOfBuffer, Buffer)\r |
| 96 | #define PcdSetBool(TokenName, Value) LibPcdSetBool(_PCD_TOKEN_##TokenName, Value)\r |
| 97 | \r |
| 98 | \r |
| 99 | //\r |
| 100 | // Dynamic Set Ex\r |
| 101 | //\r |
| 102 | #define PcdSetEx8(Guid, TokenName, Value) LibPcdSetEx8 (Guid, _PCD_TOKEN_##TokenName, Value)\r |
| 103 | #define PcdSetEx16(Guid, TokenName, Value) LibPcdSetEx16 (Guid, _PCD_TOKEN_##TokenName, Value)\r |
| 104 | #define PcdSetEx32(Guid, TokenName, Value) LibPcdSetEx32 (Guid, _PCD_TOKEN_##TokenName, Value)\r |
| 105 | #define PcdSetEx64(Guid, TokenName, Value) LibPcdSetEx64 (Guid, _PCD_TOKEN_##TokenName, Value)\r |
| 106 | #define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) LibPcdSetExPtr (Guid, _PCD_TOKEN_##TokenName, SizeOfBuffer, Buffer)\r |
| 107 | #define PcdSetExBool(Guid, TokenName, Value) LibPcdSetExBool(Guid, _PCD_TOKEN_##TokenName, Value)\r |
| 108 | \r |
| 109 | \r |
| 110 | /**\r |
| 111 | Sets the current SKU in the PCD database to the value specified by SkuId. SkuId is returned.\r |
| 112 | \r |
| 113 | @param[in] SkuId The SKU value that will be used when the PCD service will retrieve and \r |
| 114 | set values associated with a PCD token.\r |
| 115 | \r |
| 116 | @retval SKU_ID Return the SKU ID that just be set.\r |
| 117 | \r |
| 118 | **/\r |
| 119 | UINTN\r |
| 120 | EFIAPI\r |
| 121 | LibPcdSetSku (\r |
| 122 | IN UINTN SkuId\r |
| 123 | );\r |
| 124 | \r |
| 125 | \r |
| 126 | /**\r |
| 127 | Returns the 8-bit value for the token specified by TokenNumber. \r |
| 128 | \r |
| 129 | @param[in] The PCD token number to retrieve a current value for.\r |
| 130 | \r |
| 131 | @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber. \r |
| 132 | \r |
| 133 | **/\r |
| 134 | UINT8\r |
| 135 | EFIAPI\r |
| 136 | LibPcdGet8 (\r |
| 137 | IN UINTN TokenNumber\r |
| 138 | );\r |
| 139 | \r |
| 140 | \r |
| 141 | /**\r |
| 142 | Returns the 16-bit value for the token specified by TokenNumber. \r |
| 143 | \r |
| 144 | @param[in] The PCD token number to retrieve a current value for.\r |
| 145 | \r |
| 146 | @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber. \r |
| 147 | \r |
| 148 | **/\r |
| 149 | UINT16\r |
| 150 | EFIAPI\r |
| 151 | LibPcdGet16 (\r |
| 152 | IN UINTN TokenNumber\r |
| 153 | );\r |
| 154 | \r |
| 155 | \r |
| 156 | /**\r |
| 157 | Returns the 32-bit value for the token specified by TokenNumber. \r |
| 158 | \r |
| 159 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 160 | \r |
| 161 | @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.\r |
| 162 | \r |
| 163 | **/\r |
| 164 | UINT32\r |
| 165 | EFIAPI\r |
| 166 | LibPcdGet32 (\r |
| 167 | IN UINTN TokenNumber\r |
| 168 | );\r |
| 169 | \r |
| 170 | \r |
| 171 | /**\r |
| 172 | Returns the 64-bit value for the token specified by TokenNumber.\r |
| 173 | \r |
| 174 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 175 | \r |
| 176 | @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.\r |
| 177 | \r |
| 178 | **/\r |
| 179 | UINT64\r |
| 180 | EFIAPI\r |
| 181 | LibPcdGet64 (\r |
| 182 | IN UINTN TokenNumber\r |
| 183 | );\r |
| 184 | \r |
| 185 | \r |
| 186 | /**\r |
| 187 | Returns the pointer to the buffer of the token specified by TokenNumber.\r |
| 188 | \r |
| 189 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 190 | \r |
| 191 | @retval VOID* Returns the pointer to the token specified by TokenNumber.\r |
| 192 | \r |
| 193 | **/\r |
| 194 | VOID *\r |
| 195 | EFIAPI\r |
| 196 | LibPcdGetPtr (\r |
| 197 | IN UINTN TokenNumber\r |
| 198 | );\r |
| 199 | \r |
| 200 | \r |
| 201 | /**\r |
| 202 | Returns the Boolean value of the token specified by TokenNumber. \r |
| 203 | \r |
| 204 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 205 | \r |
| 206 | @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber. \r |
| 207 | \r |
| 208 | **/\r |
| 209 | BOOLEAN \r |
| 210 | EFIAPI\r |
| 211 | LibPcdGetBool (\r |
| 212 | IN UINTN TokenNumber\r |
| 213 | );\r |
| 214 | \r |
| 215 | \r |
| 216 | /**\r |
| 217 | Returns the size of the token specified by TokenNumber. \r |
| 218 | \r |
| 219 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 220 | \r |
| 221 | @retval UINTN Returns the size of the token specified by TokenNumber. \r |
| 222 | \r |
| 223 | **/\r |
| 224 | UINTN\r |
| 225 | EFIAPI\r |
| 226 | LibPcdGetSize (\r |
| 227 | IN UINTN TokenNumber\r |
| 228 | );\r |
| 229 | \r |
| 230 | \r |
| 231 | /**\r |
| 232 | Returns the 8-bit value for the token specified by TokenNumber and Guid.\r |
| 233 | If Guid is NULL, then ASSERT(). \r |
| 234 | \r |
| 235 | @param[in] Guid Pointer to a 128-bit unique value that designates \r |
| 236 | which namespace to retrieve a value from.\r |
| 237 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 238 | \r |
| 239 | @retval UINT8 Return the UINT8.\r |
| 240 | \r |
| 241 | **/\r |
| 242 | UINT8\r |
| 243 | EFIAPI\r |
| 244 | LibPcdGetEx8 (\r |
| 245 | IN CONST GUID *Guid,\r |
| 246 | IN UINTN TokenNumber\r |
| 247 | );\r |
| 248 | \r |
| 249 | \r |
| 250 | /**\r |
| 251 | Returns the 16-bit value for the token specified by TokenNumber and Guid.\r |
| 252 | If Guid is NULL, then ASSERT(). \r |
| 253 | \r |
| 254 | @param[in] Guid Pointer to a 128-bit unique value that designates \r |
| 255 | which namespace to retrieve a value from.\r |
| 256 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 257 | \r |
| 258 | @retval UINT16 Return the UINT16.\r |
| 259 | \r |
| 260 | **/\r |
| 261 | UINT16\r |
| 262 | EFIAPI\r |
| 263 | LibPcdGetEx16 (\r |
| 264 | IN CONST GUID *Guid,\r |
| 265 | IN UINTN TokenNumber\r |
| 266 | );\r |
| 267 | \r |
| 268 | \r |
| 269 | /**\r |
| 270 | Returns the 32-bit value for the token specified by TokenNumber and Guid.\r |
| 271 | If Guid is NULL, then ASSERT(). \r |
| 272 | \r |
| 273 | @param[in] Guid Pointer to a 128-bit unique value that designates \r |
| 274 | which namespace to retrieve a value from.\r |
| 275 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 276 | \r |
| 277 | @retval UINT32 Return the UINT32.\r |
| 278 | \r |
| 279 | **/\r |
| 280 | UINT32\r |
| 281 | EFIAPI\r |
| 282 | LibPcdGetEx32 (\r |
| 283 | IN CONST GUID *Guid,\r |
| 284 | IN UINTN TokenNumber\r |
| 285 | );\r |
| 286 | \r |
| 287 | \r |
| 288 | /**\r |
| 289 | Returns the 64-bit value for the token specified by TokenNumber and Guid.\r |
| 290 | If Guid is NULL, then ASSERT(). \r |
| 291 | \r |
| 292 | @param[in] Guid Pointer to a 128-bit unique value that designates \r |
| 293 | which namespace to retrieve a value from.\r |
| 294 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 295 | \r |
| 296 | @retval UINT64 Return the UINT64.\r |
| 297 | \r |
| 298 | **/\r |
| 299 | UINT64\r |
| 300 | EFIAPI\r |
| 301 | LibPcdGetEx64 (\r |
| 302 | IN CONST GUID *Guid,\r |
| 303 | IN UINTN TokenNumber\r |
| 304 | );\r |
| 305 | \r |
| 306 | \r |
| 307 | /**\r |
| 308 | Returns the pointer to the buffer of token specified by TokenNumber and Guid.\r |
| 309 | If Guid is NULL, then ASSERT(). \r |
| 310 | \r |
| 311 | @param[in] Guid Pointer to a 128-bit unique value that designates \r |
| 312 | which namespace to retrieve a value from.\r |
| 313 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 314 | \r |
| 315 | @retval VOID* Return the VOID* pointer.\r |
| 316 | \r |
| 317 | **/\r |
| 318 | VOID *\r |
| 319 | EFIAPI\r |
| 320 | LibPcdGetExPtr (\r |
| 321 | IN CONST GUID *Guid,\r |
| 322 | IN UINTN TokenNumber\r |
| 323 | );\r |
| 324 | \r |
| 325 | \r |
| 326 | /**\r |
| 327 | Returns the Boolean value of the token specified by TokenNumber and Guid. \r |
| 328 | If Guid is NULL, then ASSERT(). \r |
| 329 | \r |
| 330 | @param[in] Guid Pointer to a 128-bit unique value that designates \r |
| 331 | which namespace to retrieve a value from.\r |
| 332 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 333 | \r |
| 334 | @retval BOOLEAN Return the BOOLEAN.\r |
| 335 | \r |
| 336 | **/\r |
| 337 | BOOLEAN\r |
| 338 | EFIAPI\r |
| 339 | LibPcdGetExBool (\r |
| 340 | IN CONST GUID *Guid,\r |
| 341 | IN UINTN TokenNumber\r |
| 342 | );\r |
| 343 | \r |
| 344 | \r |
| 345 | /**\r |
| 346 | Returns the size of the token specified by TokenNumber and Guid. \r |
| 347 | If Guid is NULL, then ASSERT(). \r |
| 348 | \r |
| 349 | @param[in] Guid Pointer to a 128-bit unique value that designates \r |
| 350 | which namespace to retrieve a value from.\r |
| 351 | @param[in] TokenNumber The PCD token number to retrieve a current value for.\r |
| 352 | \r |
| 353 | @retval UINTN Return the size.\r |
| 354 | \r |
| 355 | **/\r |
| 356 | UINTN\r |
| 357 | EFIAPI\r |
| 358 | LibPcdGetExSize (\r |
| 359 | IN CONST GUID *Guid,\r |
| 360 | IN UINTN TokenNumber\r |
| 361 | );\r |
| 362 | \r |
| 363 | \r |
| 364 | /**\r |
| 365 | Sets the 8-bit value for the token specified by TokenNumber \r |
| 366 | to the value specified by Value. Value is returned.\r |
| 367 | \r |
| 368 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 369 | @param[in] Value The 8-bit value to set.\r |
| 370 | \r |
| 371 | @retval UINT8 Return the value been set.\r |
| 372 | \r |
| 373 | **/\r |
| 374 | UINT8\r |
| 375 | EFIAPI\r |
| 376 | LibPcdSet8 (\r |
| 377 | IN UINTN TokenNumber,\r |
| 378 | IN UINT8 Value\r |
| 379 | );\r |
| 380 | \r |
| 381 | \r |
| 382 | /**\r |
| 383 | Sets the 16-bit value for the token specified by TokenNumber \r |
| 384 | to the value specified by Value. Value is returned.\r |
| 385 | \r |
| 386 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 387 | @param[in] Value The 16-bit value to set.\r |
| 388 | \r |
| 389 | @retval UINT16 Return the value been set.\r |
| 390 | \r |
| 391 | **/\r |
| 392 | UINT16\r |
| 393 | EFIAPI\r |
| 394 | LibPcdSet16 (\r |
| 395 | IN UINTN TokenNumber,\r |
| 396 | IN UINT16 Value\r |
| 397 | );\r |
| 398 | \r |
| 399 | \r |
| 400 | /**\r |
| 401 | Sets the 32-bit value for the token specified by TokenNumber \r |
| 402 | to the value specified by Value. Value is returned.\r |
| 403 | \r |
| 404 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 405 | @param[in] Value The 32-bit value to set.\r |
| 406 | \r |
| 407 | @retval UINT32 Return the value been set.\r |
| 408 | \r |
| 409 | **/\r |
| 410 | UINT32\r |
| 411 | EFIAPI\r |
| 412 | LibPcdSet32 (\r |
| 413 | IN UINTN TokenNumber,\r |
| 414 | IN UINT32 Value\r |
| 415 | );\r |
| 416 | \r |
| 417 | \r |
| 418 | /**\r |
| 419 | Sets the 64-bit value for the token specified by TokenNumber \r |
| 420 | to the value specified by Value. Value is returned.\r |
| 421 | \r |
| 422 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 423 | @param[in] Value The 64-bit value to set.\r |
| 424 | \r |
| 425 | @retval UINT64 Return the value been set.\r |
| 426 | \r |
| 427 | **/\r |
| 428 | UINT64\r |
| 429 | EFIAPI\r |
| 430 | LibPcdSet64 (\r |
| 431 | IN UINTN TokenNumber,\r |
| 432 | IN UINT64 Value\r |
| 433 | );\r |
| 434 | \r |
| 435 | \r |
| 436 | /**\r |
| 437 | Sets a buffer for the token specified by TokenNumber to \r |
| 438 | the value specified by Value. Value is returned.\r |
| 439 | If Value is NULL, then ASSERT().\r |
| 440 | \r |
| 441 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 442 | @param[in] Value A pointer to the buffer to set.\r |
| 443 | \r |
| 444 | @retval VOID* Return the pointer for the buffer been set.\r |
| 445 | \r |
| 446 | **/\r |
| 447 | VOID*\r |
| 448 | EFIAPI\r |
| 449 | LibPcdSetPtr (\r |
| 450 | IN UINTN TokenNumber,\r |
| 451 | IN UINTN SizeOfBuffer,\r |
| 452 | IN VOID *Value\r |
| 453 | );\r |
| 454 | \r |
| 455 | \r |
| 456 | /**\r |
| 457 | Sets the Boolean value for the token specified by TokenNumber \r |
| 458 | to the value specified by Value. Value is returned.\r |
| 459 | \r |
| 460 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 461 | @param[in] Value The boolean value to set.\r |
| 462 | \r |
| 463 | @retval BOOLEAN Return the value been set.\r |
| 464 | \r |
| 465 | **/\r |
| 466 | BOOLEAN\r |
| 467 | EFIAPI\r |
| 468 | LibPcdSetBool (\r |
| 469 | IN UINTN TokenNumber,\r |
| 470 | IN BOOLEAN Value\r |
| 471 | );\r |
| 472 | \r |
| 473 | \r |
| 474 | /**\r |
| 475 | Sets the 8-bit value for the token specified by TokenNumber and \r |
| 476 | Guid to the value specified by Value. Value is returned.\r |
| 477 | If Guid is NULL, then ASSERT().\r |
| 478 | \r |
| 479 | @param[in] Guid Pointer to a 128-bit unique value that \r |
| 480 | designates which namespace to set a value from.\r |
| 481 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 482 | @param[in] Value The 8-bit value to set.\r |
| 483 | \r |
| 484 | @retval UINT8 Return the value been set.\r |
| 485 | \r |
| 486 | **/\r |
| 487 | UINT8\r |
| 488 | EFIAPI\r |
| 489 | LibPcdSetEx8 (\r |
| 490 | IN CONST GUID *Guid,\r |
| 491 | IN UINTN TokenNumber,\r |
| 492 | IN UINT8 Value\r |
| 493 | );\r |
| 494 | \r |
| 495 | \r |
| 496 | /**\r |
| 497 | Sets the 16-bit value for the token specified by TokenNumber and \r |
| 498 | Guid to the value specified by Value. Value is returned.\r |
| 499 | If Guid is NULL, then ASSERT().\r |
| 500 | \r |
| 501 | @param[in] Guid Pointer to a 128-bit unique value that \r |
| 502 | designates which namespace to set a value from.\r |
| 503 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 504 | @param[in] Value The 16-bit value to set.\r |
| 505 | \r |
| 506 | @retval UINT8 Return the value been set.\r |
| 507 | \r |
| 508 | **/\r |
| 509 | UINT16\r |
| 510 | EFIAPI\r |
| 511 | LibPcdSetEx16 (\r |
| 512 | IN CONST GUID *Guid,\r |
| 513 | IN UINTN TokenNumber,\r |
| 514 | IN UINT16 Value\r |
| 515 | );\r |
| 516 | \r |
| 517 | \r |
| 518 | /**\r |
| 519 | Sets the 32-bit value for the token specified by TokenNumber and \r |
| 520 | Guid to the value specified by Value. Value is returned.\r |
| 521 | If Guid is NULL, then ASSERT().\r |
| 522 | \r |
| 523 | @param[in] Guid Pointer to a 128-bit unique value that \r |
| 524 | designates which namespace to set a value from.\r |
| 525 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 526 | @param[in] Value The 32-bit value to set.\r |
| 527 | \r |
| 528 | @retval UINT32 Return the value been set.\r |
| 529 | \r |
| 530 | **/\r |
| 531 | UINT32\r |
| 532 | EFIAPI\r |
| 533 | LibPcdSetEx32 (\r |
| 534 | IN CONST GUID *Guid,\r |
| 535 | IN UINTN TokenNumber,\r |
| 536 | IN UINT32 Value\r |
| 537 | );\r |
| 538 | \r |
| 539 | \r |
| 540 | /**\r |
| 541 | Sets the 64-bit value for the token specified by TokenNumber and \r |
| 542 | Guid to the value specified by Value. Value is returned.\r |
| 543 | If Guid is NULL, then ASSERT().\r |
| 544 | \r |
| 545 | @param[in] Guid Pointer to a 128-bit unique value that \r |
| 546 | designates which namespace to set a value from.\r |
| 547 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 548 | @param[in] Value The 64-bit value to set.\r |
| 549 | \r |
| 550 | @retval UINT64 Return the value been set.\r |
| 551 | \r |
| 552 | **/\r |
| 553 | UINT64\r |
| 554 | EFIAPI\r |
| 555 | LibPcdSetEx64 (\r |
| 556 | IN CONST GUID *Guid,\r |
| 557 | IN UINTN TokenNumber,\r |
| 558 | IN UINT64 Value\r |
| 559 | );\r |
| 560 | \r |
| 561 | \r |
| 562 | /**\r |
| 563 | Sets a buffer for the token specified by TokenNumber and \r |
| 564 | Guid to the value specified by Value. Value is returned.\r |
| 565 | If Guid is NULL, then ASSERT().\r |
| 566 | If Value is NULL, then ASSERT().\r |
| 567 | \r |
| 568 | @param[in] Guid Pointer to a 128-bit unique value that \r |
| 569 | designates which namespace to set a value from.\r |
| 570 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 571 | @param[in] Value The 8-bit value to set.\r |
| 572 | \r |
| 573 | @retval VOID * Return the value been set.\r |
| 574 | \r |
| 575 | **/\r |
| 576 | VOID *\r |
| 577 | EFIAPI\r |
| 578 | LibPcdSetExPtr (\r |
| 579 | IN CONST GUID *Guid,\r |
| 580 | IN UINTN TokenNumber,\r |
| 581 | IN UINTN SizeOfBuffer,\r |
| 582 | IN VOID *Value\r |
| 583 | );\r |
| 584 | \r |
| 585 | \r |
| 586 | /**\r |
| 587 | Sets the Boolean value for the token specified by TokenNumber and \r |
| 588 | Guid to the value specified by Value. Value is returned.\r |
| 589 | If Guid is NULL, then ASSERT().\r |
| 590 | \r |
| 591 | @param[in] Guid Pointer to a 128-bit unique value that \r |
| 592 | designates which namespace to set a value from.\r |
| 593 | @param[in] TokenNumber The PCD token number to set a current value for.\r |
| 594 | @param[in] Value The Boolean value to set.\r |
| 595 | \r |
| 596 | @retval Boolean Return the value been set.\r |
| 597 | \r |
| 598 | **/\r |
| 599 | BOOLEAN\r |
| 600 | EFIAPI\r |
| 601 | LibPcdSetExBool (\r |
| 602 | IN CONST GUID *Guid,\r |
| 603 | IN UINTN TokenNumber,\r |
| 604 | IN BOOLEAN Value\r |
| 605 | );\r |
| 606 | \r |
| 607 | \r |
| 608 | /**\r |
| 609 | When the token specified by TokenNumber and Guid is set, \r |
| 610 | then notification function specified by NotificationFunction is called. \r |
| 611 | If Guid is NULL, then the default token space is used. \r |
| 612 | If NotificationFunction is NULL, then ASSERT().\r |
| 613 | \r |
| 614 | @param[in] CallBackGuid The PCD token GUID being set.\r |
| 615 | @param[in] CallBackToken The PCD token number being set.\r |
| 616 | @param[in] TokenData A pointer to the token data being set.\r |
| 617 | @param[in] TokenDataSize The size, in bytes, of the data being set.\r |
| 618 | \r |
| 619 | @retval VOID\r |
| 620 | \r |
| 621 | **/\r |
| 622 | typedef\r |
| 623 | VOID\r |
| 624 | (EFIAPI *PCD_CALLBACK) (\r |
| 625 | IN CONST GUID *CallBackGuid, OPTIONAL\r |
| 626 | IN UINTN CallBackToken,\r |
| 627 | IN OUT VOID *TokenData,\r |
| 628 | IN UINTN TokenDataSize\r |
| 629 | );\r |
| 630 | \r |
| 631 | \r |
| 632 | /**\r |
| 633 | When the token specified by TokenNumber and Guid is set, \r |
| 634 | then notification function specified by NotificationFunction is called. \r |
| 635 | If Guid is NULL, then the default token space is used. \r |
| 636 | If NotificationFunction is NULL, then ASSERT().\r |
| 637 | \r |
| 638 | @param[in] Guid Pointer to a 128-bit unique value that designates which \r |
| 639 | namespace to set a value from. If NULL, then the default \r |
| 640 | token space is used.\r |
| 641 | @param[in] TokenNumber The PCD token number to monitor.\r |
| 642 | @param[in] NotificationFunction The function to call when the token \r |
| 643 | specified by Guid and TokenNumber is set.\r |
| 644 | \r |
| 645 | @retval VOID\r |
| 646 | \r |
| 647 | **/\r |
| 648 | VOID\r |
| 649 | EFIAPI\r |
| 650 | LibPcdCallbackOnSet (\r |
| 651 | IN CONST GUID *Guid, OPTIONAL\r |
| 652 | IN UINTN TokenNumber,\r |
| 653 | IN PCD_CALLBACK NotificationFunction\r |
| 654 | );\r |
| 655 | \r |
| 656 | \r |
| 657 | /**\r |
| 658 | Disable a notification function that was established with LibPcdCallbackonSet().\r |
| 659 | \r |
| 660 | @param[in] Guid Specify the GUID token space.\r |
| 661 | @param[in] TokenNumber Specify the token number.\r |
| 662 | @param[in] NotificationFunction The callback function to be unregistered.\r |
| 663 | \r |
| 664 | @retval VOID\r |
| 665 | \r |
| 666 | **/\r |
| 667 | VOID\r |
| 668 | EFIAPI\r |
| 669 | LibPcdCancelCallback (\r |
| 670 | IN CONST GUID *Guid, OPTIONAL\r |
| 671 | IN UINTN TokenNumber,\r |
| 672 | IN PCD_CALLBACK NotificationFunction\r |
| 673 | );\r |
| 674 | \r |
| 675 | \r |
| 676 | /**\r |
| 677 | Retrieves the next PCD token number from the token space specified by Guid. \r |
| 678 | If Guid is NULL, then the default token space is used. If TokenNumber is 0, \r |
| 679 | then the first token number is returned. Otherwise, the token number that \r |
| 680 | follows TokenNumber in the token space is returned. If TokenNumber is the last \r |
| 681 | token number in the token space, then 0 is returned. If TokenNumber is not 0 and \r |
| 682 | is not in the token space specified by Guid, then ASSERT().\r |
| 683 | \r |
| 684 | @param[in] Pointer to a 128-bit unique value that designates which namespace \r |
| 685 | to set a value from. If NULL, then the default token space is used.\r |
| 686 | @param[in] The previous PCD token number. If 0, then retrieves the first PCD \r |
| 687 | token number.\r |
| 688 | \r |
| 689 | @retval UINTN The next valid token number.\r |
| 690 | \r |
| 691 | **/\r |
| 692 | UINTN \r |
| 693 | EFIAPI\r |
| 694 | LibPcdGetNextToken (\r |
| 695 | IN CONST GUID *Guid, OPTIONAL\r |
| 696 | IN UINTN TokenNumber\r |
| 697 | );\r |
| 698 | \r |
| 699 | #endif\r |
projects / mirror_edk2.git / blame