MdePkg/Library/BasePcdLibNull/PcdLib.c

   1 /** @file
   2   A emptry template implementation of PCD Library.
   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   Module Name:  PcdLib.c
  14
  15 **/
  16
  17
  18
  19 /**
  20   Sets the current SKU in the PCD database to the value specified by SkuId.  SkuId is returned.
  21
  22   @param[in]  SkuId The SKU value that will be used when the PCD service will retrieve and
  23               set values associated with a PCD token.
  24
  25   @retval UINTN Return the SKU ID that just be set.
  26
  27 **/
  28 UINTN
  29 EFIAPI
  30 LibPcdSetSku (
  31   IN UINTN  SkuId
  32   )
  33 {
  34   return SkuId;
  35 }
  36
  37
  38
  39 /**
  40   Returns the 8-bit value for the token specified by TokenNumber.
  41
  42   @param[in]  The PCD token number to retrieve a current value for.
  43
  44   @retval UINT8 Returns the 8-bit value for the token specified by TokenNumber.
  45
  46 **/
  47 UINT8
  48 EFIAPI
  49 LibPcdGet8 (
  50   IN UINTN  TokenNumber
  51   )
  52 {
  53   return 0;
  54 }
  55
  56
  57
  58 /**
  59   Returns the 16-bit value for the token specified by TokenNumber.
  60
  61   @param[in]  The PCD token number to retrieve a current value for.
  62
  63   @retval UINT16 Returns the 16-bit value for the token specified by TokenNumber.
  64
  65 **/
  66 UINT16
  67 EFIAPI
  68 LibPcdGet16 (
  69   IN UINTN  TokenNumber
  70   )
  71 {
  72   return 0;
  73 }
  74
  75
  76
  77 /**
  78   Returns the 32-bit value for the token specified by TokenNumber.
  79
  80   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
  81
  82   @retval UINT32 Returns the 32-bit value for the token specified by TokenNumber.
  83
  84 **/
  85 UINT32
  86 EFIAPI
  87 LibPcdGet32 (
  88   IN UINTN  TokenNumber
  89   )
  90 {
  91   return 0;
  92 }
  93
  94
  95
  96 /**
  97   Returns the 64-bit value for the token specified by TokenNumber.
  98
  99   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 100
 101   @retval UINT64 Returns the 64-bit value for the token specified by TokenNumber.
 102
 103 **/
 104 UINT64
 105 EFIAPI
 106 LibPcdGet64 (
 107   IN UINTN  TokenNumber
 108   )
 109 {
 110   return 0;
 111 }
 112
 113
 114
 115 /**
 116   Returns the pointer to the buffer of the token specified by TokenNumber.
 117
 118   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 119
 120   @retval VOID* Returns the pointer to the token specified by TokenNumber.
 121
 122 **/
 123 VOID *
 124 EFIAPI
 125 LibPcdGetPtr (
 126   IN UINTN  TokenNumber
 127   )
 128 {
 129   return 0;
 130 }
 131
 132
 133
 134 /**
 135   Returns the Boolean value of the token specified by TokenNumber.
 136
 137   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 138
 139   @retval BOOLEAN Returns the Boolean value of the token specified by TokenNumber.
 140
 141 **/
 142 BOOLEAN
 143 EFIAPI
 144 LibPcdGetBool (
 145   IN UINTN  TokenNumber
 146   )
 147 {
 148   return 0;
 149 }
 150
 151
 152
 153 /**
 154   Returns the size of the token specified by TokenNumber.
 155
 156   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 157
 158   @retval UINTN Returns the size of the token specified by TokenNumber.
 159
 160 **/
 161 UINTN
 162 EFIAPI
 163 LibPcdGetSize (
 164   IN UINTN  TokenNumber
 165   )
 166 {
 167   return 0;
 168 }
 169
 170
 171
 172 /**
 173   Returns the 8-bit value for the token specified by TokenNumber and Guid.
 174   If Guid is NULL, then ASSERT().
 175
 176   @param[in]  Guid Pointer to a 128-bit unique value that designates
 177               which namespace to retrieve a value from.
 178   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 179
 180   @retval UINT8 Return the UINT8.
 181
 182 **/
 183 UINT8
 184 EFIAPI
 185 LibPcdGetEx8 (
 186   IN CONST GUID        *Guid,
 187   IN UINTN             TokenNumber
 188   )
 189 {
 190   ASSERT (Guid != NULL);
 191
 192   return 0;
 193 }
 194
 195
 196
 197 /**
 198   Returns the 16-bit value for the token specified by TokenNumber and Guid.
 199   If Guid is NULL, then ASSERT().
 200
 201   @param[in]  Guid Pointer to a 128-bit unique value that designates
 202               which namespace to retrieve a value from.
 203   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 204
 205   @retval UINT16 Return the UINT16.
 206
 207 **/
 208 UINT16
 209 EFIAPI
 210 LibPcdGetEx16 (
 211   IN CONST GUID        *Guid,
 212   IN UINTN             TokenNumber
 213   )
 214 {
 215   ASSERT (Guid != NULL);
 216
 217   return 0;
 218 }
 219
 220
 221
 222 /**
 223   Returns the 32-bit value for the token specified by TokenNumber and Guid.
 224   If Guid is NULL, then ASSERT().
 225
 226   @param[in]  Guid Pointer to a 128-bit unique value that designates
 227               which namespace to retrieve a value from.
 228   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 229
 230   @retval UINT32 Return the UINT32.
 231
 232 **/
 233 UINT32
 234 EFIAPI
 235 LibPcdGetEx32 (
 236   IN CONST GUID        *Guid,
 237   IN UINTN             TokenNumber
 238   )
 239 {
 240   ASSERT (Guid != NULL);
 241
 242   return 0;
 243 }
 244
 245
 246
 247 /**
 248   Returns the 64-bit value for the token specified by TokenNumber and Guid.
 249   If Guid is NULL, then ASSERT().
 250
 251   @param[in]  Guid Pointer to a 128-bit unique value that designates
 252               which namespace to retrieve a value from.
 253   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 254
 255   @retval UINT64 Return the UINT64.
 256
 257 **/
 258 UINT64
 259 EFIAPI
 260 LibPcdGetEx64 (
 261   IN CONST GUID        *Guid,
 262   IN UINTN             TokenNumber
 263   )
 264 {
 265   ASSERT (Guid != NULL);
 266
 267   return 0;
 268 }
 269
 270
 271
 272 /**
 273   Returns the pointer to the buffer of the token specified by TokenNumber and Guid.
 274   If Guid is NULL, then ASSERT().
 275
 276   @param[in]  Guid Pointer to a 128-bit unique value that designates
 277               which namespace to retrieve a value from.
 278   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 279
 280   @retval VOID* Return the VOID* pointer.
 281
 282 **/
 283 VOID *
 284 EFIAPI
 285 LibPcdGetExPtr (
 286   IN CONST GUID        *Guid,
 287   IN UINTN             TokenNumber
 288   )
 289 {
 290   ASSERT (Guid != NULL);
 291
 292   return 0;
 293 }
 294
 295
 296
 297 /**
 298   Returns the Boolean value of the token specified by TokenNumber and Guid.
 299   If Guid is NULL, then ASSERT().
 300
 301   @param[in]  Guid Pointer to a 128-bit unique value that designates
 302               which namespace to retrieve a value from.
 303   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 304
 305   @retval BOOLEAN Return the BOOLEAN.
 306
 307 **/
 308 BOOLEAN
 309 EFIAPI
 310 LibPcdGetExBool (
 311   IN CONST GUID        *Guid,
 312   IN UINTN             TokenNumber
 313   )
 314 {
 315   ASSERT (Guid != NULL);
 316
 317   return 0;
 318 }
 319
 320
 321
 322 /**
 323   Returns the size of the token specified by TokenNumber and Guid.
 324   If Guid is NULL, then ASSERT().
 325
 326   @param[in]  Guid Pointer to a 128-bit unique value that designates
 327               which namespace to retrieve a value from.
 328   @param[in]  TokenNumber The PCD token number to retrieve a current value for.
 329
 330   @retval UINTN Return the size.
 331
 332 **/
 333 UINTN
 334 EFIAPI
 335 LibPcdGetExSize (
 336   IN CONST GUID        *Guid,
 337   IN UINTN             TokenNumber
 338   )
 339 {
 340   ASSERT (Guid != NULL);
 341
 342   return 0;
 343 }
 344
 345
 346
 347 /**
 348   Sets the 8-bit value for the token specified by TokenNumber
 349   to the value specified by Value.  Value is returned.
 350
 351   @param[in]  TokenNumber The PCD token number to set a current value for.
 352   @param[in]  Value The 8-bit value to set.
 353
 354   @retval UINT8 Return the value been set.
 355
 356 **/
 357 UINT8
 358 EFIAPI
 359 LibPcdSet8 (
 360   IN UINTN             TokenNumber,
 361   IN UINT8             Value
 362   )
 363 {
 364   return Value;
 365 }
 366
 367
 368
 369 /**
 370   Sets the 16-bit value for the token specified by TokenNumber
 371   to the value specified by Value.  Value is returned.
 372
 373   @param[in]  TokenNumber The PCD token number to set a current value for.
 374   @param[in]  Value The 16-bit value to set.
 375
 376   @retval UINT16 Return the value been set.
 377
 378 **/
 379 UINT16
 380 EFIAPI
 381 LibPcdSet16 (
 382   IN UINTN             TokenNumber,
 383   IN UINT16            Value
 384   )
 385 {
 386   return Value;
 387 }
 388
 389
 390
 391 /**
 392   Sets the 32-bit value for the token specified by TokenNumber
 393   to the value specified by Value.  Value is returned.
 394
 395   @param[in]  TokenNumber The PCD token number to set a current value for.
 396   @param[in]  Value The 32-bit value to set.
 397
 398   @retval UINT32 Return the value been set.
 399
 400 **/
 401 UINT32
 402 EFIAPI
 403 LibPcdSet32 (
 404   IN UINTN              TokenNumber,
 405   IN UINT32             Value
 406   )
 407 {
 408   return Value;
 409 }
 410
 411
 412
 413 /**
 414   Sets the 64-bit value for the token specified by TokenNumber
 415   to the value specified by Value.  Value is returned.
 416
 417   @param[in]  TokenNumber The PCD token number to set a current value for.
 418   @param[in]  Value The 64-bit value to set.
 419
 420   @retval UINT64 Return the value been set.
 421
 422 **/
 423 UINT64
 424 EFIAPI
 425 LibPcdSet64 (
 426   IN UINTN              TokenNumber,
 427   IN UINT64             Value
 428   )
 429 {
 430   return Value;
 431 }
 432
 433
 434
 435 /**
 436   Sets a buffer for the token specified by TokenNumber to
 437   the value specified by Value. Value is returned.
 438   If Value is NULL, then ASSERT().
 439
 440   @param[in]  TokenNumber The PCD token number to set a current value for.
 441   @param[in]  Value A pointer to the buffer to set.
 442
 443   @retval VOID* Return the pointer for the buffer been set.
 444
 445 **/
 446 VOID *
 447 EFIAPI
 448 LibPcdSetPtr (
 449   IN UINTN             TokenNumber,
 450   IN CONST VOID        *Value
 451   )
 452 {
 453   ASSERT (Value != NULL);
 454   //
 455   // Remove the CONST
 456   //
 457   return (VOID *)Value;
 458 }
 459
 460
 461
 462 /**
 463   Sets the Boolean value for the token specified by TokenNumber
 464   to the value specified by Value.  Value is returned.
 465
 466   @param[in]  TokenNumber The PCD token number to set a current value for.
 467   @param[in]  Value The boolean value to set.
 468
 469   @retval BOOLEAN Return the value been set.
 470
 471 **/
 472 BOOLEAN
 473 EFIAPI
 474 LibPcdSetBool (
 475   IN UINTN             TokenNumber,
 476   IN BOOLEAN           Value
 477   )
 478 {
 479   return Value;
 480 }
 481
 482
 483
 484 /**
 485   Sets the 8-bit value for the token specified by TokenNumber and
 486   Guid to the value specified by Value. Value is returned.
 487   If Guid is NULL, then ASSERT().
 488
 489   @param[in]  Guid Pointer to a 128-bit unique value that
 490               designates which namespace to set a value from.
 491   @param[in]  TokenNumber The PCD token number to set a current value for.
 492   @param[in]  Value The 8-bit value to set.
 493
 494   @retval UINT8 Return the value been set.
 495
 496 **/
 497 UINT8
 498 EFIAPI
 499 LibPcdSetEx8 (
 500   IN CONST GUID        *Guid,
 501   IN UINTN             TokenNumber,
 502   IN UINT8             Value
 503   )
 504 {
 505   ASSERT (Guid != NULL);
 506
 507   return Value;
 508 }
 509
 510
 511
 512 /**
 513   Sets the 16-bit value for the token specified by TokenNumber and
 514   Guid to the value specified by Value. Value is returned.
 515   If Guid is NULL, then ASSERT().
 516
 517   @param[in]  Guid Pointer to a 128-bit unique value that
 518               designates which namespace to set a value from.
 519   @param[in]  TokenNumber The PCD token number to set a current value for.
 520   @param[in]  Value The 16-bit value to set.
 521
 522   @retval UINT8 Return the value been set.
 523
 524 **/
 525 UINT16
 526 EFIAPI
 527 LibPcdSetEx16 (
 528   IN CONST GUID        *Guid,
 529   IN UINTN             TokenNumber,
 530   IN UINT16            Value
 531   )
 532 {
 533   ASSERT (Guid != NULL);
 534
 535   return Value;
 536 }
 537
 538
 539
 540 /**
 541   Sets the 32-bit value for the token specified by TokenNumber and
 542   Guid to the value specified by Value. Value is returned.
 543   If Guid is NULL, then ASSERT().
 544
 545   @param[in]  Guid Pointer to a 128-bit unique value that
 546               designates which namespace to set a value from.
 547   @param[in]  TokenNumber The PCD token number to set a current value for.
 548   @param[in]  Value The 32-bit value to set.
 549
 550   @retval UINT32 Return the value been set.
 551
 552 **/
 553 UINT32
 554 EFIAPI
 555 LibPcdSetEx32 (
 556   IN CONST GUID        *Guid,
 557   IN UINTN             TokenNumber,
 558   IN UINT32            Value
 559   )
 560 {
 561   ASSERT (Guid != NULL);
 562
 563   return Value;
 564 }
 565
 566
 567
 568 /**
 569   Sets the 64-bit value for the token specified by TokenNumber and
 570   Guid to the value specified by Value. Value is returned.
 571   If Guid is NULL, then ASSERT().
 572
 573   @param[in]  Guid Pointer to a 128-bit unique value that
 574               designates which namespace to set a value from.
 575   @param[in]  TokenNumber The PCD token number to set a current value for.
 576   @param[in]  Value The 64-bit value to set.
 577
 578   @retval UINT64 Return the value been set.
 579
 580 **/
 581 UINT64
 582 EFIAPI
 583 LibPcdSetEx64 (
 584   IN CONST GUID        *Guid,
 585   IN UINTN             TokenNumber,
 586   IN UINT64            Value
 587   )
 588 {
 589   ASSERT (Guid != NULL);
 590
 591   return Value;
 592 }
 593
 594
 595
 596 /**
 597   Sets a buffer for the token specified by TokenNumber and
 598   Guid to the value specified by Value. Value is returned.
 599   If Guid is NULL, then ASSERT().
 600   If Value is NULL, then ASSERT().
 601
 602   @param[in]  Guid Pointer to a 128-bit unique value that
 603               designates which namespace to set a value from.
 604   @param[in]  TokenNumber The PCD token number to set a current value for.
 605   @param[in]  Value The 8-bit value to set.
 606
 607   @retval VOID * Return the value been set.
 608
 609 **/
 610 VOID *
 611 EFIAPI
 612 LibPcdSetExPtr (
 613   IN CONST GUID        *Guid,
 614   IN UINTN             TokenNumber,
 615   IN CONST VOID        *Value
 616   )
 617 {
 618   //
 619   // Remove the CONST
 620   //
 621   ASSERT (Guid != NULL);
 622   ASSERT (Value != NULL);
 623
 624   return (VOID *)Value;
 625 }
 626
 627
 628
 629 /**
 630   Sets the Boolean value for the token specified by TokenNumber and
 631   Guid to the value specified by Value. Value is returned.
 632   If Guid is NULL, then ASSERT().
 633
 634   @param[in]  Guid Pointer to a 128-bit unique value that
 635               designates which namespace to set a value from.
 636   @param[in]  TokenNumber The PCD token number to set a current value for.
 637   @param[in]  Value The Boolean value to set.
 638
 639   @retval Boolean Return the value been set.
 640
 641 **/
 642 BOOLEAN
 643 EFIAPI
 644 LibPcdSetExBool (
 645   IN CONST GUID        *Guid,
 646   IN UINTN             TokenNumber,
 647   IN BOOLEAN           Value
 648   )
 649 {
 650   ASSERT (Guid != NULL);
 651
 652   return Value;
 653 }
 654
 655
 656
 657 /**
 658   When the token specified by TokenNumber and Guid is set,
 659   then notification function specified by NotificationFunction is called.
 660   If Guid is NULL, then the default token space is used.
 661   If NotificationFunction is NULL, then ASSERT().
 662
 663   @param[in]  Guid Pointer to a 128-bit unique value that designates which
 664               namespace to set a value from.  If NULL, then the default
 665               token space is used.
 666   @param[in]  TokenNumber The PCD token number to monitor.
 667   @param[in]  NotificationFunction The function to call when the token
 668               specified by Guid and TokenNumber is set.
 669
 670   @retval VOID
 671
 672 **/
 673 VOID
 674 EFIAPI
 675 LibPcdCallbackOnSet (
 676   IN CONST GUID               *Guid,       OPTIONAL
 677   IN UINTN                    TokenNumber,
 678   IN PCD_CALLBACK             NotificationFunction
 679   )
 680 {
 681   ASSERT (NotificationFunction != NULL);
 682 }
 683
 684
 685
 686 /**
 687   Disable a notification function that was established with LibPcdCallbackonSet().
 688   If NotificationFunction is NULL, then ASSERT().
 689
 690   @param[in]  Guid Specify the GUID token space.
 691   @param[in]  TokenNumber Specify the token number.
 692   @param[in]  NotificationFunction The callback function to be unregistered.
 693
 694   @retval VOID
 695
 696 **/
 697 VOID
 698 EFIAPI
 699 LibPcdCancelCallback (
 700   IN CONST GUID               *Guid,       OPTIONAL
 701   IN UINTN                    TokenNumber,
 702   IN PCD_CALLBACK             NotificationFunction
 703   )
 704 {
 705   ASSERT (NotificationFunction != NULL);
 706 }
 707
 708
 709
 710 /**
 711   Retrieves the next PCD token number from the token space specified by Guid.
 712   If Guid is NULL, then the default token space is used.  If TokenNumber is 0,
 713   then the first token number is returned.  Otherwise, the token number that
 714   follows TokenNumber in the token space is returned.  If TokenNumber is the last
 715   token number in the token space, then 0 is returned.  If TokenNumber is not 0 and
 716   is not in the token space specified by Guid, then ASSERT().
 717
 718   @param[in]  Pointer to a 128-bit unique value that designates which namespace
 719               to set a value from.  If NULL, then the default token space is used.
 720   @param[in]  The previous PCD token number.  If 0, then retrieves the first PCD
 721               token number.
 722
 723   @retval UINTN The next valid token number.
 724
 725 **/
 726 UINTN
 727 EFIAPI
 728 LibPcdGetNextToken (
 729   IN CONST GUID             *Guid, OPTIONAL
 730   IN OUT UINTN              *TokenNumber
 731   )
 732 {
 733   return 0;
 734 }