1 /** @file 2 Declaration of internal functions in BaseSynchronizationLib. 3 4 Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> 5 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 15 #ifndef __BASE_SYNCHRONIZATION_LIB_INTERNALS__ 16 #define __BASE_SYNCHRONIZATION_LIB_INTERNALS__ 17 18 #include <Base.h> 19 #include <Library/SynchronizationLib.h> 20 #include <Library/BaseLib.h> 21 #include <Library/DebugLib.h> 22 #include <Library/TimerLib.h> 23 #include <Library/PcdLib.h> 24 25 /** 26 Performs an atomic increment of an 32-bit unsigned integer. 27 28 Performs an atomic increment of the 32-bit unsigned integer specified by 29 Value and returns the incremented value. The increment operation must be 30 performed using MP safe mechanisms. The state of the return value is not 31 guaranteed to be MP safe. 32 33 @param Value A pointer to the 32-bit value to increment. 34 35 @return The incremented value. 36 37 **/ 38 UINT32 39 EFIAPI 40 InternalSyncIncrement ( 41 IN volatile UINT32 *Value 42 ); 43 44 45 /** 46 Performs an atomic decrement of an 32-bit unsigned integer. 47 48 Performs an atomic decrement of the 32-bit unsigned integer specified by 49 Value and returns the decrement value. The decrement operation must be 50 performed using MP safe mechanisms. The state of the return value is not 51 guaranteed to be MP safe. 52 53 @param Value A pointer to the 32-bit value to decrement. 54 55 @return The decrement value. 56 57 **/ 58 UINT32 59 EFIAPI 60 InternalSyncDecrement ( 61 IN volatile UINT32 *Value 62 ); 63 64 65 /** 66 Performs an atomic compare exchange operation on a 16-bit unsigned integer. 67 68 Performs an atomic compare exchange operation on the 16-bit unsigned integer 69 specified by Value. If Value is equal to CompareValue, then Value is set to 70 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, 71 then Value is returned. The compare exchange operation must be performed using 72 MP safe mechanisms. 73 74 @param Value A pointer to the 16-bit value for the compare exchange 75 operation. 76 @param CompareValue A 16-bit value used in compare operation. 77 @param ExchangeValue A 16-bit value used in exchange operation. 78 79 @return The original *Value before exchange. 80 81 **/ 82 UINT16 83 EFIAPI 84 InternalSyncCompareExchange16 ( 85 IN volatile UINT16 *Value, 86 IN UINT16 CompareValue, 87 IN UINT16 ExchangeValue 88 ); 89 90 91 /** 92 Performs an atomic compare exchange operation on a 32-bit unsigned integer. 93 94 Performs an atomic compare exchange operation on the 32-bit unsigned integer 95 specified by Value. If Value is equal to CompareValue, then Value is set to 96 ExchangeValue and CompareValue is returned. If Value is not equal to CompareValue, 97 then Value is returned. The compare exchange operation must be performed using 98 MP safe mechanisms. 99 100 @param Value A pointer to the 32-bit value for the compare exchange 101 operation. 102 @param CompareValue A 32-bit value used in compare operation. 103 @param ExchangeValue A 32-bit value used in exchange operation. 104 105 @return The original *Value before exchange. 106 107 **/ 108 UINT32 109 EFIAPI 110 InternalSyncCompareExchange32 ( 111 IN volatile UINT32 *Value, 112 IN UINT32 CompareValue, 113 IN UINT32 ExchangeValue 114 ); 115 116 117 /** 118 Performs an atomic compare exchange operation on a 64-bit unsigned integer. 119 120 Performs an atomic compare exchange operation on the 64-bit unsigned integer specified 121 by Value. If Value is equal to CompareValue, then Value is set to ExchangeValue and 122 CompareValue is returned. If Value is not equal to CompareValue, then Value is returned. 123 The compare exchange operation must be performed using MP safe mechanisms. 124 125 @param Value A pointer to the 64-bit value for the compare exchange 126 operation. 127 @param CompareValue A 64-bit value used in compare operation. 128 @param ExchangeValue A 64-bit value used in exchange operation. 129 130 @return The original *Value before exchange. 131 132 **/ 133 UINT64 134 EFIAPI 135 InternalSyncCompareExchange64 ( 136 IN volatile UINT64 *Value, 137 IN UINT64 CompareValue, 138 IN UINT64 ExchangeValue 139 ); 140 141 #endif 142