sravan/system76-coreboot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

atomic.h: Fix doxygen errors

Browse Source 
- @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)
This commit is contained in:
Martin Roth
2014-12-29 22:36:06 -07:00
committed by Martin Roth
parent 6e22225d60
commit 24e2e951b9
2 changed files with 24 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
src/arch/x86/include/arch/smp/atomic.h
View File

@@ -10,35 +10,36 @@ typedef struct { volatile int counter; } atomic_t;
#define ATOMIC_INIT(i) { (i) } #define ATOMIC_INIT(i) { (i) }
/* /** @file x86/include/arch/smp/atomic.h
*
* Atomic operations that C can't guarantee us. Useful for * Atomic operations that C can't guarantee us. Useful for
* resource counting etc.. * resource counting etc..
*/ */
/** /**
* atomic_read - read atomic variable * 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. * useful range of an atomic_t is only 24 bits.
*/ */
#define atomic_read(v) ((v)->counter) #define atomic_read(v) ((v)->counter)
/** /**
* atomic_set - set atomic variable * atomic_set - set atomic variable
* @v: pointer of type atomic_t * @param v: pointer of type atomic_t
* @i: required value * @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. * useful range of an atomic_t is only 24 bits.
*/ */
#define atomic_set(v,i) (((v)->counter) = (i)) #define atomic_set(v,i) (((v)->counter) = (i))
/** /**
* atomic_inc - increment atomic variable * 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. * useful range of an atomic_t is only 24 bits.
*/ */
static __inline__ __attribute__((always_inline)) void atomic_inc(atomic_t *v) 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 * 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. * useful range of an atomic_t is only 24 bits.
*/ */
static __inline__ __attribute__((always_inline)) void atomic_dec(atomic_t *v) static __inline__ __attribute__((always_inline)) void atomic_dec(atomic_t *v)

22
src/include/smp/atomic.h
View File

@@ -8,21 +8,25 @@
typedef struct { int counter; } atomic_t; typedef struct { int counter; } atomic_t;
#define ATOMIC_INIT(i) { (i) } #define ATOMIC_INIT(i) { (i) }
/**
* @file include/smp/atomic.h
*/
/** /**
* atomic_read - read atomic variable * 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. * useful range of an atomic_t is only 24 bits.
*/ */
#define atomic_read(v) ((v)->counter) #define atomic_read(v) ((v)->counter)
/** /**
* atomic_set - set atomic variable * atomic_set - set atomic variable
* @v: pointer of type atomic_t * @param v: pointer of type atomic_t
* @i: required value * @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. * useful range of an atomic_t is only 24 bits.
*/ */
#define atomic_set(v,i) (((v)->counter) = (i)) #define atomic_set(v,i) (((v)->counter) = (i))
@@ -30,9 +34,9 @@ typedef struct { int counter; } atomic_t;
/** /**
* atomic_inc - increment atomic variable * 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. * useful range of an atomic_t is only 24 bits.
*/ */
#define atomic_inc(v) (((v)->counter)++) #define atomic_inc(v) (((v)->counter)++)
@@ -40,9 +44,9 @@ typedef struct { int counter; } atomic_t;
/** /**
* atomic_dec - decrement atomic variable * 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. * useful range of an atomic_t is only 24 bits.
*/ */
#define atomic_dec(v) (((v)->counter)--) #define atomic_dec(v) (((v)->counter)--)