MdePkg/Include/Library/PcdLib.h

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