Changeset 89983 in vbox for trunk/src/VBox/Devices/EFI/FirmwareNew/MdePkg/Include/Library/PcdLib.h
- Timestamp:
- Jul 1, 2021 8:17:41 AM (4 years ago)
- Location:
- trunk/src/VBox/Devices/EFI/FirmwareNew
- Files:
-
- 2 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/VBox/Devices/EFI/FirmwareNew
-
Property svn:mergeinfo
changed from (toggle deleted branches)
to (toggle deleted branches)/vendor/edk2/current 103735-103757,103769-103776,129194-139864 /vendor/edk2/current 103735-103757,103769-103776,129194-145445
-
Property svn:mergeinfo
changed from (toggle deleted branches)
-
trunk/src/VBox/Devices/EFI/FirmwareNew/MdePkg/Include/Library/PcdLib.h
r80721 r89983 482 482 #define PcdGetExSize(Guid, TokenName) LibPcdGetExSize ((Guid), PcdTokenEx(Guid,TokenName)) 483 483 484 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES485 /**486 Sets an 8-bit PCD token value based on a token name.487 488 Sets the 8-bit value for the token specified by TokenName. Value is returned.489 If TokenName is not a valid token in the token space, then the module will not build.490 491 @param TokenName The name of the PCD token to retrieve a current value for.492 @param Value The 8-bit value to set.493 494 @return Return the Value that was set.495 496 **/497 #define PcdSet8(TokenName, Value) _PCD_SET_MODE_8_##TokenName ((Value))498 499 500 /**501 Sets a 16-bit PCD token value based on a token name.502 503 Sets the 16-bit value for the token specified by TokenName. Value is returned.504 If TokenName is not a valid token in the token space, then the module will not build.505 506 @param TokenName The name of the PCD token to retrieve a current value for.507 @param Value The 16-bit value to set.508 509 @return Return the Value that was set.510 511 **/512 #define PcdSet16(TokenName, Value) _PCD_SET_MODE_16_##TokenName ((Value))513 514 515 /**516 Sets a 32-bit PCD token value based on a token name.517 518 Sets the 32-bit value for the token specified by TokenName. Value is returned.519 If TokenName is not a valid token in the token space, then the module will not build.520 521 @param TokenName The name of the PCD token to retrieve a current value for.522 @param Value The 32-bit value to set.523 524 @return Return the Value that was set.525 526 **/527 #define PcdSet32(TokenName, Value) _PCD_SET_MODE_32_##TokenName ((Value))528 529 530 /**531 Sets a 64-bit PCD token value based on a token name.532 533 Sets the 64-bit value for the token specified by TokenName. Value is returned.534 If TokenName is not a valid token in the token space, then the module will not build.535 536 @param TokenName The name of the PCD token to retrieve a current value for.537 @param Value The 64-bit value to set.538 539 @return Return the Value that was set.540 541 **/542 #define PcdSet64(TokenName, Value) _PCD_SET_MODE_64_##TokenName ((Value))543 544 545 /**546 Sets a pointer to a PCD token buffer based on a token name.547 548 Sets the buffer for the token specified by TokenName. Buffer is returned.549 If SizeOfBuffer is greater than the maximum size supported by TokenName,550 then set SizeOfBuffer to the maximum size supported by TokenName and return NULL551 to indicate that the set operation was not actually performed. If SizeOfBuffer552 is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported553 by TokenName and NULL must be returned.554 If TokenName is not a valid token in the token space, then the module will not build.555 556 If SizeOfBuffer is NULL, then ASSERT().557 If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().558 559 @param TokenName The name of the PCD token to set the current value for.560 @param SizeOfBuffer A pointer to the size, in bytes, of Buffer.561 @param Buffer A pointer to the buffer to set.562 563 @return Return the pointer to the Buffer that was set.564 565 **/566 #define PcdSetPtr(TokenName, SizeOfBuffer, Buffer) \567 _PCD_SET_MODE_PTR_##TokenName ((SizeOfBuffer), (Buffer))568 569 /**570 Sets a Boolean PCD token value based on a token name.571 572 Sets the Boolean value for the token specified by TokenName. Value is returned.573 If TokenName is not a valid token in the token space, then the module will not build.574 575 @param TokenName The name of the PCD token to set the current value for.576 @param Buffer The Boolean value to set.577 578 @return Return the Value that was set.579 580 **/581 #define PcdSetBool(TokenName, Value) _PCD_SET_MODE_BOOL_##TokenName ((Value))582 #endif583 584 484 /** 585 485 Sets a 8-bit PCD token value based on a token name. … … 806 706 807 707 808 809 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES810 /**811 Sets an 8-bit PCD token value based on a GUID and a token name.812 813 Sets the 8-bit value for the token specified by Guid and TokenName. Value is returned.814 If TokenName is not a valid token in the token space specified by Guid,815 then the module will not build.816 817 If Guid is NULL, then ASSERT().818 819 @param Guid Pointer to a 128-bit unique value that designates820 which namespace to retrieve a value from.821 @param TokenName The name of the PCD token to set the current value for.822 @param Value The 8-bit value to set.823 824 @return Return the Value that was set.825 826 **/827 #define PcdSetEx8(Guid, TokenName, Value) LibPcdSetEx8 ((Guid), PcdTokenEx(Guid,TokenName), (Value))828 829 830 /**831 Sets a 16-bit PCD token value based on a GUID and a token name.832 833 Sets the 16-bit value for the token specified by Guid and TokenName. Value is returned.834 If TokenName is not a valid token in the token space specified by Guid,835 then the module will not build.836 837 If Guid is NULL, then ASSERT().838 839 @param Guid Pointer to a 128-bit unique value that designates840 which namespace to retrieve a value from.841 @param TokenName The name of the PCD token to set the current value for.842 @param Value The 16-bit value to set.843 844 @return Return the Value that was set.845 846 **/847 #define PcdSetEx16(Guid, TokenName, Value) LibPcdSetEx16 ((Guid), PcdTokenEx(Guid,TokenName), (Value))848 849 850 /**851 Sets a 32-bit PCD token value based on a GUID and a token name.852 853 Sets the 32-bit value for the token specified by Guid and TokenName. Value is returned.854 If TokenName is not a valid token in the token space specified by Guid,855 then the module will not build.856 857 If Guid is NULL, then ASSERT().858 859 @param Guid Pointer to a 128-bit unique value that designates860 which namespace to retrieve a value from.861 @param TokenName The name of the PCD token to set the current value for.862 @param Value The 32-bit value to set.863 864 @return Return the Value that was set.865 866 **/867 #define PcdSetEx32(Guid, TokenName, Value) LibPcdSetEx32 ((Guid), PcdTokenEx(Guid,TokenName), (Value))868 869 870 /**871 Sets a 64-bit PCD token value based on a GUID and a token name.872 873 Sets the 64-bit value for the token specified by Guid and TokenName. Value is returned.874 If TokenName is not a valid token in the token space specified by Guid,875 then the module will not build.876 877 If Guid is NULL, then ASSERT().878 879 @param Guid Pointer to a 128-bit unique value that designates880 which namespace to retrieve a value from.881 @param TokenName The name of the PCD token to set the current value for.882 @param Value The 64-bit value to set.883 884 @return Return the Value that was set.885 886 **/887 #define PcdSetEx64(Guid, TokenName, Value) LibPcdSetEx64 ((Guid), PcdTokenEx(Guid,TokenName), (Value))888 889 890 /**891 Sets a pointer to a PCD token buffer based on a GUID and a token name.892 893 Sets the buffer for the token specified by Guid and TokenName. Buffer is returned.894 If SizeOfBuffer is greater than the maximum size supported by Guid and TokenName,895 then set SizeOfBuffer to the maximum size supported by Guid and TokenName and return896 NULL to indicate that the set operation was not actually performed. If SizeOfBuffer897 is set to MAX_ADDRESS, then SizeOfBuffer must be set to the maximum size supported by898 Guid and TokenName and NULL must be returned.899 If TokenName is not a valid token in the token space specified by Guid,900 then the module will not build.901 902 If Guid is NULL, then ASSERT().903 If SizeOfBuffer is NULL, then ASSERT().904 If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().905 906 @param Guid Pointer to a 128-bit unique value that designates907 which namespace to retrieve a value from.908 @param TokenName The name of the PCD token to set the current value for.909 @param SizeOfBuffer A pointer to the size, in bytes, of Buffer.910 @param Buffer Pointer to the buffer to set.911 912 @return Return the pointer to the Buffer that was set.913 914 **/915 #define PcdSetExPtr(Guid, TokenName, SizeOfBuffer, Buffer) \916 LibPcdSetExPtr ((Guid), PcdTokenEx(Guid,TokenName), (SizeOfBuffer), (Buffer))917 918 919 /**920 Sets a Boolean PCD token value based on a GUID and a token name.921 922 Sets the Boolean value for the token specified by Guid and TokenName. Value is returned.923 If TokenName is not a valid token in the token space specified by Guid,924 then the module will not build.925 926 If Guid is NULL, then ASSERT().927 928 @param Guid Pointer to a 128-bit unique value that designates929 which namespace to retrieve a value from.930 @param TokenName The name of the PCD token to set the current value for.931 @param Value The Boolean value to set.932 933 @return Return the Value that was set.934 935 **/936 #define PcdSetExBool(Guid, TokenName, Value) \937 LibPcdSetExBool((Guid), PcdTokenEx(Guid,TokenName), (Value))938 #endif939 708 940 709 /** … … 1348 1117 ); 1349 1118 1350 1351 #ifndef DISABLE_NEW_DEPRECATED_INTERFACES1352 /**1353 This function provides a means by which to set a value for a given PCD token.1354 1355 Sets the 8-bit value for the token specified by TokenNumber1356 to the value specified by Value. Value is returned.1357 1358 @param[in] TokenNumber The PCD token number to set a current value for.1359 @param[in] Value The 8-bit value to set.1360 1361 @return Return the Value that was set.1362 1363 **/1364 UINT81365 EFIAPI1366 LibPcdSet8 (1367 IN UINTN TokenNumber,1368 IN UINT8 Value1369 );1370 1371 1372 /**1373 This function provides a means by which to set a value for a given PCD token.1374 1375 Sets the 16-bit value for the token specified by TokenNumber1376 to the value specified by Value. Value is returned.1377 1378 @param[in] TokenNumber The PCD token number to set a current value for.1379 @param[in] Value The 16-bit value to set.1380 1381 @return Return the Value that was set.1382 1383 **/1384 UINT161385 EFIAPI1386 LibPcdSet16 (1387 IN UINTN TokenNumber,1388 IN UINT16 Value1389 );1390 1391 1392 /**1393 This function provides a means by which to set a value for a given PCD token.1394 1395 Sets the 32-bit value for the token specified by TokenNumber1396 to the value specified by Value. Value is returned.1397 1398 @param[in] TokenNumber The PCD token number to set a current value for.1399 @param[in] Value The 32-bit value to set.1400 1401 @return Return the Value that was set.1402 1403 **/1404 UINT321405 EFIAPI1406 LibPcdSet32 (1407 IN UINTN TokenNumber,1408 IN UINT32 Value1409 );1410 1411 1412 /**1413 This function provides a means by which to set a value for a given PCD token.1414 1415 Sets the 64-bit value for the token specified by TokenNumber1416 to the value specified by Value. Value is returned.1417 1418 @param[in] TokenNumber The PCD token number to set a current value for.1419 @param[in] Value The 64-bit value to set.1420 1421 @return Return the Value that was set.1422 1423 **/1424 UINT641425 EFIAPI1426 LibPcdSet64 (1427 IN UINTN TokenNumber,1428 IN UINT64 Value1429 );1430 1431 1432 /**1433 This function provides a means by which to set a value for a given PCD token.1434 1435 Sets a buffer for the token specified by TokenNumber to the value1436 specified by Buffer and SizeOfBuffer. Buffer is returned.1437 If SizeOfBuffer is greater than the maximum size support by TokenNumber,1438 then set SizeOfBuffer to the maximum size supported by TokenNumber and1439 return NULL to indicate that the set operation was not actually performed.1440 1441 If SizeOfBuffer is set to MAX_ADDRESS, then SizeOfBuffer must be set to the1442 maximum size supported by TokenName and NULL must be returned.1443 1444 If SizeOfBuffer is NULL, then ASSERT().1445 If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().1446 1447 @param[in] TokenNumber The PCD token number to set a current value for.1448 @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.1449 @param[in] Buffer A pointer to the buffer to set.1450 1451 @return Return the pointer for the Buffer that was set.1452 1453 **/1454 VOID *1455 EFIAPI1456 LibPcdSetPtr (1457 IN UINTN TokenNumber,1458 IN OUT UINTN *SizeOfBuffer,1459 IN CONST VOID *Buffer1460 );1461 1462 1463 /**1464 This function provides a means by which to set a value for a given PCD token.1465 1466 Sets the Boolean value for the token specified by TokenNumber1467 to the value specified by Value. Value is returned.1468 1469 @param[in] TokenNumber The PCD token number to set a current value for.1470 @param[in] Value The boolean value to set.1471 1472 @return Return the Value that was set.1473 1474 **/1475 BOOLEAN1476 EFIAPI1477 LibPcdSetBool (1478 IN UINTN TokenNumber,1479 IN BOOLEAN Value1480 );1481 1482 1483 /**1484 This function provides a means by which to set a value for a given PCD token.1485 1486 Sets the 8-bit value for the token specified by TokenNumber and1487 Guid to the value specified by Value. Value is returned.1488 1489 If Guid is NULL, then ASSERT().1490 1491 @param[in] Guid Pointer to a 128-bit unique value that1492 designates which namespace to set a value from.1493 @param[in] TokenNumber The PCD token number to set a current value for.1494 @param[in] Value The 8-bit value to set.1495 1496 @return Return the Value that was set.1497 1498 **/1499 UINT81500 EFIAPI1501 LibPcdSetEx8 (1502 IN CONST GUID *Guid,1503 IN UINTN TokenNumber,1504 IN UINT8 Value1505 );1506 1507 1508 /**1509 This function provides a means by which to set a value for a given PCD token.1510 1511 Sets the 16-bit value for the token specified by TokenNumber and1512 Guid to the value specified by Value. Value is returned.1513 1514 If Guid is NULL, then ASSERT().1515 1516 @param[in] Guid Pointer to a 128-bit unique value that1517 designates which namespace to set a value from.1518 @param[in] TokenNumber The PCD token number to set a current value for.1519 @param[in] Value The 16-bit value to set.1520 1521 @return Return the Value that was set.1522 1523 **/1524 UINT161525 EFIAPI1526 LibPcdSetEx16 (1527 IN CONST GUID *Guid,1528 IN UINTN TokenNumber,1529 IN UINT16 Value1530 );1531 1532 1533 /**1534 This function provides a means by which to set a value for a given PCD token.1535 1536 Sets the 32-bit value for the token specified by TokenNumber and1537 Guid to the value specified by Value. Value is returned.1538 1539 If Guid is NULL, then ASSERT().1540 1541 @param[in] Guid Pointer to a 128-bit unique value that1542 designates which namespace to set a value from.1543 @param[in] TokenNumber The PCD token number to set a current value for.1544 @param[in] Value The 32-bit value to set.1545 1546 @return Return the Value that was set.1547 1548 **/1549 UINT321550 EFIAPI1551 LibPcdSetEx32 (1552 IN CONST GUID *Guid,1553 IN UINTN TokenNumber,1554 IN UINT32 Value1555 );1556 1557 1558 /**1559 This function provides a means by which to set a value for a given PCD token.1560 1561 Sets the 64-bit value for the token specified by TokenNumber and1562 Guid to the value specified by Value. Value is returned.1563 1564 If Guid is NULL, then ASSERT().1565 1566 @param[in] Guid Pointer to a 128-bit unique value that1567 designates which namespace to set a value from.1568 @param[in] TokenNumber The PCD token number to set a current value for.1569 @param[in] Value The 64-bit value to set.1570 1571 @return Return the Value that was set.1572 1573 **/1574 UINT641575 EFIAPI1576 LibPcdSetEx64 (1577 IN CONST GUID *Guid,1578 IN UINTN TokenNumber,1579 IN UINT64 Value1580 );1581 1582 1583 /**1584 This function provides a means by which to set a value for a given PCD token.1585 1586 Sets a buffer for the token specified by TokenNumber to the value specified by1587 Buffer and SizeOfBuffer. Buffer is returned. If SizeOfBuffer is greater than1588 the maximum size support by TokenNumber, then set SizeOfBuffer to the maximum size1589 supported by TokenNumber and return NULL to indicate that the set operation1590 was not actually performed.1591 1592 If Guid is NULL, then ASSERT().1593 If SizeOfBuffer is NULL, then ASSERT().1594 If SizeOfBuffer > 0 and Buffer is NULL, then ASSERT().1595 1596 @param[in] Guid Pointer to a 128-bit unique value that1597 designates which namespace to set a value from.1598 @param[in] TokenNumber The PCD token number to set a current value for.1599 @param[in, out] SizeOfBuffer The size, in bytes, of Buffer.1600 @param[in] Buffer A pointer to the buffer to set.1601 1602 @return Return the pointer to the Buffer that was set.1603 1604 **/1605 VOID *1606 EFIAPI1607 LibPcdSetExPtr (1608 IN CONST GUID *Guid,1609 IN UINTN TokenNumber,1610 IN OUT UINTN *SizeOfBuffer,1611 IN VOID *Buffer1612 );1613 1614 1615 /**1616 This function provides a means by which to set a value for a given PCD token.1617 1618 Sets the Boolean value for the token specified by TokenNumber and1619 Guid to the value specified by Value. Value is returned.1620 1621 If Guid is NULL, then ASSERT().1622 1623 @param[in] Guid Pointer to a 128-bit unique value that1624 designates which namespace to set a value from.1625 @param[in] TokenNumber The PCD token number to set a current value for.1626 @param[in] Value The Boolean value to set.1627 1628 @return Return the Value that was set.1629 1630 **/1631 BOOLEAN1632 EFIAPI1633 LibPcdSetExBool (1634 IN CONST GUID *Guid,1635 IN UINTN TokenNumber,1636 IN BOOLEAN Value1637 );1638 #endif1639 1119 1640 1120 /**
Note:
See TracChangeset
for help on using the changeset viewer.