summaryrefslogtreecommitdiff
path: root/include/AEEatomic.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/AEEatomic.h')
-rw-r--r--include/AEEatomic.h197
1 files changed, 197 insertions, 0 deletions
diff --git a/include/AEEatomic.h b/include/AEEatomic.h
new file mode 100644
index 0000000..2911455
--- /dev/null
+++ b/include/AEEatomic.h
@@ -0,0 +1,197 @@
+/*
+* Copyright (c) 2017, The Linux Foundation. All rights reserved.
+* All rights reserved.
+*
+* Redistribution and use in source and binary forms, with or without
+* modification, are permitted provided that the following conditions are met:
+*
+* 1. Redistributions of source code must retain the above copyright notice,
+* this list of conditions and the following disclaimer.
+*
+* 2. Redistributions in binary form must reproduce the above copyright notice,
+* this list of conditions and the following disclaimer in the documentation
+* and/or other materials provided with the distribution.
+*
+* 3. Neither the name of the copyright holder nor the names of its contributors
+* may be used to endorse or promote products derived from this software without
+* specific prior written permission.
+*
+* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+* POSSIBILITY OF SUCH DAMAGE.
+*/
+#ifndef AEEATOMIC_H
+#define AEEATOMIC_H
+/*
+=======================================================================
+
+FILE: AEEatomic.h
+
+SERVICES: atomic
+
+DESCRIPTION: Fast Atomic ops
+
+=======================================================================
+*/
+
+#include "AEEStdDef.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* #ifdef __cplusplus */
+
+uint32 atomic_Add(uint32 *volatile puDest, int nAdd);
+uint32 atomic_Exchange(uint32 *volatile puDest, uint32 uVal);
+uint32 atomic_CompareAndExchange(uint32 *volatile puDest, uint32 uExchange, uint32 uCompare);
+uint32 atomic_CompareOrAdd(uint32 *volatile puDest, uint32 uCompare, int nAdd);
+
+#ifdef __cplusplus
+}
+#endif /* #ifdef __cplusplus */
+
+/*=====================================================================
+INTERFACE DOCUMENTATION
+=======================================================================
+atomic Interface
+
+ The atomic interface provides fast "atomic" operations. The
+ operations are defined to be atomic with respect to each other.
+
+=======================================================================
+
+=======================================================================
+
+atomic_Add()
+
+Description:
+
+ Performs an atomic sum operation.
+
+Prototype:
+
+ uint32 atomic_Add(uint32* puDest, int nInc);
+
+Parameters:
+ puDest [in|out] : Points to unsigned number to add nInc and save
+ nInc : increment
+
+Return Value:
+ result.
+
+Comments:
+ None
+
+Side Effects:
+ None
+
+See Also:
+ None
+
+=======================================================================
+
+atomic_Exchange()
+
+Description:
+
+ Atomic exchange of 32bit value. Performs an atomic operation of :
+ write uVal to *puDest
+ return the previous value in *puDest
+
+Prototype:
+
+ uint32 atomic_Exchange(uint32* puDest, uint32 uVal);
+
+Parameters:
+ puDest [in|out] : Points to unsigned number to be exchanged
+ uVal : new value to write.
+
+Return Value:
+ previous value at *puDest.
+
+Comments:
+ None
+
+Side Effects:
+ May cause exception if puDest is not a 32 bit aligned address.
+
+See Also:
+ None
+=======================================================================
+
+atomic_CompareAndExchange()
+
+Description:
+
+ Performs an atomic operation of :
+ if (*puDest == uCompare) {
+ *puDest = uExchange;
+ }
+
+ returns the previous value in *puDest
+
+Prototype:
+
+ uint32 atomic_CompareAndExchange(uint32 *puDest, uint32 uExchange,
+ uint32 uCompare);
+
+Parameters:
+ puDest [in|out] : Points to unsigned number.
+ uExchange : A new value to write to *puDest
+ uCompare : Comparand
+
+Return Value:
+ previous value at *puDest.
+
+Comments:
+ None
+
+Side Effects:
+ May cause exception if puDest is not a 32 bit aligned address.
+
+See Also:
+ None
+
+=======================================================================
+atomic_CompareOrAdd()
+
+Description:
+
+ Performs an atomic operation of :
+ if (*puDest != uCompare) {
+ *puDest += nAdd;
+ }
+
+ returns the new value in *puDest
+
+Prototype:
+
+ uint32 atomic_CompareOrAdd(uint32 *puDest, uint32 uCompare, int nAdd);
+
+Parameters:
+ puDest [in|out] : Points to unsigned number.
+ uCompare : Comparand
+ nAdd : Add to *puDest
+
+Return Value:
+ new value at *puDest.
+
+Comments:
+ None
+
+Side Effects:
+ May cause exception if puDest is not a 32 bit aligned address.
+
+See Also:
+ None
+=======================================================================*/
+
+#endif /* #ifndef AEEATOMIC_H */
+