Commit 206e1d5b authored by Daniel Leung's avatar Daniel Leung Committed by Anas Nashif
Browse files

sys: atomic: move doxygen doc to atomic.h 



This moves the doxygen doc from atomic_builtin.h to
atomic.h, as the doc should not have been inside
a particular implementation.

Also add an alias @atomic_api to replace the repetitive
wordings in the doc.

Signed-off-by: default avatarDaniel Leung <daniel.leung@intel.com>
parent 0d7d39d4

doc/zephyr.doxyfile.in

+1 −0
Original line number Diff line number Diff line
@@ -286,6 +286,7 @@ ALIASES = "rst=\verbatim embed:rst:leading-asterisk" \ 
                         "isr_ok=\htmlonly isr-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_isr-ok`</verbatim> \endxmlonly" \

                         "pre_kernel_ok=\htmlonly pre-kernel-ok \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_pre-kernel-ok`</verbatim> \endxmlonly" \

                         "async=\htmlonly async \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_async`</verbatim> \endxmlonly" \

                         "atomic_api=As for all atomic APIs, includes a full/sequentially-consistent memory barrier (where applicable)." \

                         "supervisor=\htmlonly supervisor \endhtmlonly \xmlonly <verbatim>embed:rst:inline :ref:`api_term_supervisor`</verbatim> \endxmlonly"



# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources

include/zephyr/sys/atomic.h

+239 −12
Original line number Diff line number Diff line
@@ -117,8 +117,7 @@ extern "C" { 
 * This routine tests whether bit number @a bit of @a target is set or not.

 * The target may be a single atomic variable or an array of them.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 * @note @atomic_api

 *

 * @param target Address of atomic variable or array.

 * @param bit Bit number (starting from 0).
@@ -138,8 +137,7 @@ static inline bool atomic_test_bit(const atomic_t *target, int bit) 
 * Atomically clear bit number @a bit of @a target and return its old value.

 * The target may be a single atomic variable or an array of them.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 * @note @atomic_api

 *

 * @param target Address of atomic variable or array.

 * @param bit Bit number (starting from 0).
@@ -162,8 +160,7 @@ static inline bool atomic_test_and_clear_bit(atomic_t *target, int bit) 
 * Atomically set bit number @a bit of @a target and return its old value.

 * The target may be a single atomic variable or an array of them.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 * @note @atomic_api

 *

 * @param target Address of atomic variable or array.

 * @param bit Bit number (starting from 0).
@@ -186,8 +183,7 @@ static inline bool atomic_test_and_set_bit(atomic_t *target, int bit) 
 * Atomically clear bit number @a bit of @a target.

 * The target may be a single atomic variable or an array of them.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 * @note @atomic_api

 *

 * @param target Address of atomic variable or array.

 * @param bit Bit number (starting from 0).
@@ -205,8 +201,7 @@ static inline void atomic_clear_bit(atomic_t *target, int bit) 
 * Atomically set bit number @a bit of @a target.

 * The target may be a single atomic variable or an array of them.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 * @note @atomic_api

 *

 * @param target Address of atomic variable or array.

 * @param bit Bit number (starting from 0).
@@ -224,8 +219,7 @@ static inline void atomic_set_bit(atomic_t *target, int bit) 
 * Atomically set bit number @a bit of @a target to value @a val.

 * The target may be a single atomic variable or an array of them.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 * @note @atomic_api

 *

 * @param target Address of atomic variable or array.

 * @param bit Bit number (starting from 0).
@@ -242,6 +236,239 @@ static inline void atomic_set_bit_to(atomic_t *target, int bit, bool val) 
	}

}



/**

 * @brief Atomic compare-and-set.

 *

 * This routine performs an atomic compare-and-set on @a target. If the current

 * value of @a target equals @a old_value, @a target is set to @a new_value.

 * If the current value of @a target does not equal @a old_value, @a target

 * is left unchanged.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param old_value Original value to compare against.

 * @param new_value New value to store.

 * @return true if @a new_value is written, false otherwise.

 */

bool atomic_cas(atomic_t *target, atomic_val_t old_value, atomic_val_t new_value);



/**

 * @brief Atomic compare-and-set with pointer values

 *

 * This routine performs an atomic compare-and-set on @a target. If the current

 * value of @a target equals @a old_value, @a target is set to @a new_value.

 * If the current value of @a target does not equal @a old_value, @a target

 * is left unchanged.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param old_value Original value to compare against.

 * @param new_value New value to store.

 * @return true if @a new_value is written, false otherwise.

 */

bool atomic_ptr_cas(atomic_ptr_t *target, atomic_ptr_val_t old_value,

		    atomic_ptr_val_t new_value);



/**

 * @brief Atomic addition.

 *

 * This routine performs an atomic addition on @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param value Value to add.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_add(atomic_t *target, atomic_val_t value);



/**

 * @brief Atomic subtraction.

 *

 * This routine performs an atomic subtraction on @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param value Value to subtract.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_sub(atomic_t *target, atomic_val_t value);



/**

 * @brief Atomic increment.

 *

 * This routine performs an atomic increment by 1 on @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_inc(atomic_t *target);



/**

 * @brief Atomic decrement.

 *

 * This routine performs an atomic decrement by 1 on @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_dec(atomic_t *target);



/**

 * @brief Atomic get.

 *

 * This routine performs an atomic read on @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 *

 * @return Value of @a target.

 */

atomic_val_t atomic_get(const atomic_t *target);



/**

 * @brief Atomic get a pointer value

 *

 * This routine performs an atomic read on @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of pointer variable.

 *

 * @return Value of @a target.

 */

atomic_ptr_val_t atomic_ptr_get(const atomic_ptr_t *target);



/**

 * @brief Atomic get-and-set.

 *

 * This routine atomically sets @a target to @a value and returns

 * the previous value of @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param value Value to write to @a target.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_set(atomic_t *target, atomic_val_t value);



/**

 * @brief Atomic get-and-set for pointer values

 *

 * This routine atomically sets @a target to @a value and returns

 * the previous value of @a target.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param value Value to write to @a target.

 *

 * @return Previous value of @a target.

 */

atomic_ptr_val_t atomic_ptr_set(atomic_ptr_t *target, atomic_ptr_val_t value);



/**

 * @brief Atomic clear.

 *

 * This routine atomically sets @a target to zero and returns its previous

 * value. (Hence, it is equivalent to atomic_set(target, 0).)

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_clear(atomic_t *target);



/**

 * @brief Atomic clear of a pointer value

 *

 * This routine atomically sets @a target to zero and returns its previous

 * value. (Hence, it is equivalent to atomic_set(target, 0).)

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

atomic_ptr_val_t atomic_ptr_clear(atomic_ptr_t *target);



/**

 * @brief Atomic bitwise inclusive OR.

 *

 * This routine atomically sets @a target to the bitwise inclusive OR of

 * @a target and @a value.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param value Value to OR.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_or(atomic_t *target, atomic_val_t value);



/**

 * @brief Atomic bitwise exclusive OR (XOR).

 *

 * @note @atomic_api

 *

 * This routine atomically sets @a target to the bitwise exclusive OR (XOR) of

 * @a target and @a value.

 *

 * @param target Address of atomic variable.

 * @param value Value to XOR

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_xor(atomic_t *target, atomic_val_t value);



/**

 * @brief Atomic bitwise AND.

 *

 * This routine atomically sets @a target to the bitwise AND of @a target

 * and @a value.

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param value Value to AND.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_and(atomic_t *target, atomic_val_t value);



/**

 * @brief Atomic bitwise NAND.

 *

 * This routine atomically sets @a target to the bitwise NAND of @a target

 * and @a value. (This operation is equivalent to target = ~(target & value).)

 *

 * @note @atomic_api

 *

 * @param target Address of atomic variable.

 * @param value Value to NAND.

 *

 * @return Previous value of @a target.

 */

atomic_val_t atomic_nand(atomic_t *target, atomic_val_t value);



/**

 * @}

 */

include/zephyr/sys/atomic_builtin.h

+0 −239
Original line number Diff line number Diff line
@@ -19,28 +19,6 @@ extern "C" { 


/* Included from <atomic.h> */



/**

 * @addtogroup atomic_apis Atomic Services APIs

 * @ingroup kernel_apis

 * @{

 */



/**

 * @brief Atomic compare-and-set.

 *

 * This routine performs an atomic compare-and-set on @a target. If the current

 * value of @a target equals @a old_value, @a target is set to @a new_value.

 * If the current value of @a target does not equal @a old_value, @a target

 * is left unchanged.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param old_value Original value to compare against.

 * @param new_value New value to store.

 * @return true if @a new_value is written, false otherwise.

 */

static inline bool atomic_cas(atomic_t *target, atomic_val_t old_value,

			  atomic_val_t new_value)

{
@@ -49,22 +27,6 @@ static inline bool atomic_cas(atomic_t *target, atomic_val_t old_value, 
					   __ATOMIC_SEQ_CST);

}



/**

 * @brief Atomic compare-and-set with pointer values

 *

 * This routine performs an atomic compare-and-set on @a target. If the current

 * value of @a target equals @a old_value, @a target is set to @a new_value.

 * If the current value of @a target does not equal @a old_value, @a target

 * is left unchanged.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param old_value Original value to compare against.

 * @param new_value New value to store.

 * @return true if @a new_value is written, false otherwise.

 */

static inline bool atomic_ptr_cas(atomic_ptr_t *target, atomic_ptr_val_t old_value,

				  atomic_ptr_val_t new_value)

{
@@ -73,131 +35,36 @@ static inline bool atomic_ptr_cas(atomic_ptr_t *target, atomic_ptr_val_t old_val 
					   __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic addition.

 *

 * This routine performs an atomic addition on @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param value Value to add.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_add(atomic_t *target, atomic_val_t value)

{

	return __atomic_fetch_add(target, value, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic subtraction.

 *

 * This routine performs an atomic subtraction on @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param value Value to subtract.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_sub(atomic_t *target, atomic_val_t value)

{

	return __atomic_fetch_sub(target, value, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic increment.

 *

 * This routine performs an atomic increment by 1 on @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_inc(atomic_t *target)

{

	return atomic_add(target, 1);

}



/**

 *

 * @brief Atomic decrement.

 *

 * This routine performs an atomic decrement by 1 on @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_dec(atomic_t *target)

{

	return atomic_sub(target, 1);

}



/**

 *

 * @brief Atomic get.

 *

 * This routine performs an atomic read on @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 *

 * @return Value of @a target.

 */

static inline atomic_val_t atomic_get(const atomic_t *target)

{

	return __atomic_load_n(target, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic get a pointer value

 *

 * This routine performs an atomic read on @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of pointer variable.

 *

 * @return Value of @a target.

 */

static inline atomic_ptr_val_t atomic_ptr_get(const atomic_ptr_t *target)

{

	return __atomic_load_n(target, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic get-and-set.

 *

 * This routine atomically sets @a target to @a value and returns

 * the previous value of @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param value Value to write to @a target.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_set(atomic_t *target, atomic_val_t value)

{

	/* This builtin, as described by Intel, is not a traditional
@@ -207,147 +74,41 @@ static inline atomic_val_t atomic_set(atomic_t *target, atomic_val_t value) 
	return __atomic_exchange_n(target, value, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic get-and-set for pointer values

 *

 * This routine atomically sets @a target to @a value and returns

 * the previous value of @a target.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param value Value to write to @a target.

 *

 * @return Previous value of @a target.

 */

static inline atomic_ptr_val_t atomic_ptr_set(atomic_ptr_t *target, atomic_ptr_val_t value)

{

	return __atomic_exchange_n(target, value, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic clear.

 *

 * This routine atomically sets @a target to zero and returns its previous

 * value. (Hence, it is equivalent to atomic_set(target, 0).)

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_clear(atomic_t *target)

{

	return atomic_set(target, 0);

}



/**

 *

 * @brief Atomic clear of a pointer value

 *

 * This routine atomically sets @a target to zero and returns its previous

 * value. (Hence, it is equivalent to atomic_set(target, 0).)

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 *

 * @return Previous value of @a target.

 */

static inline atomic_ptr_val_t atomic_ptr_clear(atomic_ptr_t *target)

{

	return atomic_ptr_set(target, NULL);

}



/**

 *

 * @brief Atomic bitwise inclusive OR.

 *

 * This routine atomically sets @a target to the bitwise inclusive OR of

 * @a target and @a value.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param value Value to OR.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_or(atomic_t *target, atomic_val_t value)

{

	return __atomic_fetch_or(target, value, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic bitwise exclusive OR (XOR).

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * This routine atomically sets @a target to the bitwise exclusive OR (XOR) of

 * @a target and @a value.

 *

 * @param target Address of atomic variable.

 * @param value Value to XOR

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_xor(atomic_t *target, atomic_val_t value)

{

	return __atomic_fetch_xor(target, value, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic bitwise AND.

 *

 * This routine atomically sets @a target to the bitwise AND of @a target

 * and @a value.

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param value Value to AND.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_and(atomic_t *target, atomic_val_t value)

{

	return __atomic_fetch_and(target, value, __ATOMIC_SEQ_CST);

}



/**

 *

 * @brief Atomic bitwise NAND.

 *

 * This routine atomically sets @a target to the bitwise NAND of @a target

 * and @a value. (This operation is equivalent to target = ~(target & value).)

 *

 * @note As for all atomic APIs, includes a

 * full/sequentially-consistent memory barrier (where applicable).

 *

 * @param target Address of atomic variable.

 * @param value Value to NAND.

 *

 * @return Previous value of @a target.

 */

static inline atomic_val_t atomic_nand(atomic_t *target, atomic_val_t value)

{

	return __atomic_fetch_nand(target, value, __ATOMIC_SEQ_CST);

}



/** @} */





#ifdef __cplusplus

}

#endif

CRA Git | Maintained and supported by SUSTech CRA and CCSE