summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMartin Roth <martin.roth@se-eng.com>2014-12-29 22:36:06 -0700
committerMartin Roth <gaumless@gmail.com>2015-01-04 20:03:28 +0100
commit24e2e951b91dd2e177f2ff133362e0cc0cf6b505 (patch)
treec03d21439d42d24d072e461dc50a5d44660c6026 /src
parent6e22225d605b6cfddf3407dfc83f524650851f0e (diff)
downloadcoreboot-24e2e951b91dd2e177f2ff133362e0cc0cf6b505.tar.xz
atomic.h: Fix doxygen errors
- @v & @i need to be @param v & @param i - add the @file command Change-Id: Ib4fb609629bc2dfcf1869bdf7a4d4cd9fea283cc Signed-off-by: Martin Roth <martin.roth@se-eng.com> Reviewed-on: http://review.coreboot.org/8075 Reviewed-by: Edward O'Callaghan <eocallaghan@alterapraxis.com> Tested-by: build bot (Jenkins)
Diffstat (limited to 'src')
-rw-r--r--src/arch/x86/include/arch/smp/atomic.h21
-rw-r--r--src/include/smp/atomic.h22
2 files changed, 24 insertions, 19 deletions
diff --git a/src/arch/x86/include/arch/smp/atomic.h b/src/arch/x86/include/arch/smp/atomic.h
index 18bbae27cb..d7964e5feb 100644
--- a/src/arch/x86/include/arch/smp/atomic.h
+++ b/src/arch/x86/include/arch/smp/atomic.h
@@ -10,35 +10,36 @@ typedef struct { volatile int counter; } atomic_t;
#define ATOMIC_INIT(i) { (i) }
-/*
+/** @file x86/include/arch/smp/atomic.h
+ *
* Atomic operations that C can't guarantee us. Useful for
* resource counting etc..
*/
/**
* atomic_read - read atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically reads the value of @v. Note that the guaranteed
+ * Atomically reads the value of v. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_read(v) ((v)->counter)
/**
* atomic_set - set atomic variable
- * @v: pointer of type atomic_t
- * @i: required value
+ * @param v: pointer of type atomic_t
+ * @param i: required value
*
- * Atomically sets the value of @v to @i. Note that the guaranteed
+ * Atomically sets the value of v to i. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_set(v,i) (((v)->counter) = (i))
/**
* atomic_inc - increment atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically increments @v by 1. Note that the guaranteed
+ * Atomically increments v by 1. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
static __inline__ __attribute__((always_inline)) void atomic_inc(atomic_t *v)
@@ -51,9 +52,9 @@ static __inline__ __attribute__((always_inline)) void atomic_inc(atomic_t *v)
/**
* atomic_dec - decrement atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically decrements @v by 1. Note that the guaranteed
+ * Atomically decrements v by 1. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
static __inline__ __attribute__((always_inline)) void atomic_dec(atomic_t *v)
diff --git a/src/include/smp/atomic.h b/src/include/smp/atomic.h
index 44be4c5c01..bc50534442 100644
--- a/src/include/smp/atomic.h
+++ b/src/include/smp/atomic.h
@@ -9,20 +9,24 @@ typedef struct { int counter; } atomic_t;
#define ATOMIC_INIT(i) { (i) }
/**
+ * @file include/smp/atomic.h
+ */
+
+/**
* atomic_read - read atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically reads the value of @v. Note that the guaranteed
+ * Atomically reads the value of v. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_read(v) ((v)->counter)
/**
* atomic_set - set atomic variable
- * @v: pointer of type atomic_t
- * @i: required value
+ * @param v: pointer of type atomic_t
+ * @param i: required value
*
- * Atomically sets the value of @v to @i. Note that the guaranteed
+ * Atomically sets the value of v to i. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_set(v,i) (((v)->counter) = (i))
@@ -30,9 +34,9 @@ typedef struct { int counter; } atomic_t;
/**
* atomic_inc - increment atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically increments @v by 1. Note that the guaranteed
+ * Atomically increments v by 1. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_inc(v) (((v)->counter)++)
@@ -40,9 +44,9 @@ typedef struct { int counter; } atomic_t;
/**
* atomic_dec - decrement atomic variable
- * @v: pointer of type atomic_t
+ * @param v: pointer of type atomic_t
*
- * Atomically decrements @v by 1. Note that the guaranteed
+ * Atomically decrements v by 1. Note that the guaranteed
* useful range of an atomic_t is only 24 bits.
*/
#define atomic_dec(v) (((v)->counter)--)