diff --git a/arch/arc/core/atomic.S b/arch/arc/core/atomic.S index d21d5740146..d587a027aee 100644 --- a/arch/arc/core/atomic.S +++ b/arch/arc/core/atomic.S @@ -69,7 +69,7 @@ GTEXT(atomic_cas) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -92,7 +92,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_clear_set, atomic_clear) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -141,7 +141,7 @@ SECTION_FUNC(TEXT, atomic_get) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -167,7 +167,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_inc) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -202,7 +202,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_add) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -228,7 +228,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_dec_sub, atomic_dec) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -264,7 +264,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_dec_sub, atomic_sub) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -301,7 +301,7 @@ SECTION_FUNC(TEXT, atomic_nand) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -337,7 +337,7 @@ SECTION_FUNC(TEXT, atomic_and) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -373,7 +373,7 @@ SECTION_FUNC(TEXT, atomic_or) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -409,7 +409,7 @@ SECTION_FUNC(TEXT, atomic_xor) * * This routine can be used from both task and interrupt level. * - * RETURNS: 1 if the swap is actually executed, 0 otherwise. + * @return 1 if the swap is actually executed, 0 otherwise. * * ERRNO: N/A * diff --git a/arch/arc/core/context.c b/arch/arc/core/context.c index 36dcfdbad16..4cad5afe2ee 100644 --- a/arch/arc/core/context.c +++ b/arch/arc/core/context.c @@ -69,7 +69,7 @@ tNANO _nanokernel = {0}; * * Currently only inserts the new context in the list of active contexts. * - * RETURNS: N/A + * @return N/A */ static ALWAYS_INLINE void context_monitor_init(struct ccs *pCcs /* context */ @@ -105,7 +105,7 @@ static ALWAYS_INLINE void context_monitor_init(struct ccs *pCcs /* context */ * * is currently unused. * - * RETURNS: N/A + * @return N/A */ void _NewContext( diff --git a/arch/arc/core/context_wrapper.S b/arch/arc/core/context_wrapper.S index 8bab258a33d..3c379c6c467 100644 --- a/arch/arc/core/context_wrapper.S +++ b/arch/arc/core/context_wrapper.S @@ -51,7 +51,7 @@ GTEXT(_context_entry) * The routine pops parameters for the _context_entry from * stack frame, prepared by the _NewContext() routine * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _ContextEntryWrapper) diff --git a/arch/arc/core/fast_irq.S b/arch/arc/core/fast_irq.S index 12c75736e32..ab80d533d2f 100644 --- a/arch/arc/core/fast_irq.S +++ b/arch/arc/core/fast_irq.S @@ -70,7 +70,7 @@ SECTION_VAR(NOINIT, _firq_stack) * * Assumption by _isr_demux: r3 is untouched by _firq_enter. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _firq_enter) @@ -101,7 +101,7 @@ SECTION_FUNC(TEXT, _firq_enter) * * _firq_exit - work to be done exiting a FIRQ * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _firq_exit) @@ -260,7 +260,7 @@ _firq_no_reschedule: * * _firq_stack_setup - install the FIRQ stack in register bank 1 * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _firq_stack_setup) diff --git a/arch/arc/core/fatal.c b/arch/arc/core/fatal.c index 36999da42c8..c951abfbf26 100644 --- a/arch/arc/core/fatal.c +++ b/arch/arc/core/fatal.c @@ -65,7 +65,7 @@ const NANO_ESF _default_esf = { * fatal error does not have a hardware generated ESF, the caller should either * create its own or use a pointer to the global default ESF <_default_esf>. * - * RETURNS: This function does not return. + * @return This function does not return. * * \NOMANUAL */ diff --git a/arch/arc/core/fault.c b/arch/arc/core/fault.c index e996e1ac022..6125fca1dec 100644 --- a/arch/arc/core/fault.c +++ b/arch/arc/core/fault.c @@ -65,7 +65,7 @@ * Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 1 * (short form). * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -92,7 +92,7 @@ void _FaultDump(const NANO_ESF *esf, int fault) * invokes the user provided routine _SysFatalErrorHandler() which is * responsible for implementing the error handling policy. * - * RETURNS: This function does not return. + * @return This function does not return. * * \NOMANUAL */ diff --git a/arch/arc/core/ffs.S b/arch/arc/core/ffs.S index 67c5ab06072..34260d87567 100644 --- a/arch/arc/core/ffs.S +++ b/arch/arc/core/ffs.S @@ -55,7 +55,7 @@ GTEXT(nanoFfsLsb) * at 1 from the least significant bit. A return value of zero indicates that * the value passed is zero. * - * RETURNS: most significant bit set + * @return most significant bit set */ SECTION_FUNC(TEXT, nanoFfsMsb) @@ -78,7 +78,7 @@ SECTION_FUNC(TEXT, nanoFfsMsb) * at 1 from the least significant bit. A return value of zero indicates that * the value passed is zero. * - * RETURNS: least significant bit set + * @return least significant bit set */ SECTION_FUNC(TEXT, nanoFfsLsb) diff --git a/arch/arc/core/irq_lock.S b/arch/arc/core/irq_lock.S index 7d369991990..1f5f8b0f7e0 100644 --- a/arch/arc/core/irq_lock.S +++ b/arch/arc/core/irq_lock.S @@ -65,7 +65,7 @@ * disable state will be restored when the context is later rescheduled * for execution. * - * RETURNS: An architecture-dependent lock-out key representing the + * @return An architecture-dependent lock-out key representing the * "interrupt disable state" prior to the call. * * \NOMANUAL @@ -85,7 +85,7 @@ SECTION_FUNC(TEXT, irq_lock) * * This routine can be called from either interrupt, task or fiber level. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arc/core/irq_manage.c b/arch/arc/core/irq_manage.c index 83a358497ba..e2304aca947 100644 --- a/arch/arc/core/irq_manage.c +++ b/arch/arc/core/irq_manage.c @@ -60,7 +60,7 @@ * This routine will hang if is not found in the table and ASSERT_ON is * enabled. * - * RETURNS: N/A + * @return N/A */ void irq_handler_set( @@ -91,7 +91,7 @@ void irq_handler_set( * line. After this call, the CPU will receive interrupts for the specified * . * - * RETURNS: N/A + * @return N/A */ void irq_enable(unsigned int irq) @@ -108,7 +108,7 @@ void irq_enable(unsigned int irq) * Disable an interrupt line. After this call, the CPU will stop receiving * interrupts for the specified . * - * RETURNS: N/A + * @return N/A */ void irq_disable(unsigned int irq) @@ -128,7 +128,7 @@ void irq_disable(unsigned int irq) * * The priority is verified if ASSERT_ON is enabled. * - * RETURNS: N/A + * @return N/A */ void irq_priority_set( @@ -150,7 +150,7 @@ void irq_priority_set( * Installed in all dynamic interrupt slots at boot time. Throws an error if * called. * - * RETURNS: N/A + * @return N/A */ #include @@ -172,7 +172,7 @@ void _irq_spurious(void *unused) * This routine will hang if another ISR was connected for interrupt line * and ASSERT_ON is enabled; if ASSERT_ON is disabled, it will fail silently. * - * RETURNS: the interrupt line number + * @return the interrupt line number */ int irq_connect( @@ -194,7 +194,7 @@ int irq_connect( * replaced by _irq_spurious(). irq_disable() should have been called before * invoking this routine. * - * RETURNS: N/A + * @return N/A */ void irq_disconnect(unsigned int irq) diff --git a/arch/arc/core/regular_irq.S b/arch/arc/core/regular_irq.S index 81d2946307f..f178df1dc68 100644 --- a/arch/arc/core/regular_irq.S +++ b/arch/arc/core/regular_irq.S @@ -59,7 +59,7 @@ GTEXT(_rirq_exit) * * Assumption by _isr_demux: r3 is untouched by _rirq_enter. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _rirq_enter) @@ -79,7 +79,7 @@ SECTION_FUNC(TEXT, _rirq_enter) * * _rirq_exit - work to be done exiting an IRQ * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _rirq_exit) diff --git a/arch/arc/core/swap.S b/arch/arc/core/swap.S index 1641645d8a3..aefdd905c38 100644 --- a/arch/arc/core/swap.S +++ b/arch/arc/core/swap.S @@ -75,7 +75,7 @@ GDATA(_nanokernel) * When _Swap() is invoked, we know the decision to perform a context switch or * not has already been taken and a context switch must happen. * - * RETURNS: may contain a return value setup by a call to fiberRtnValueSet() + * @return may contain a return value setup by a call to fiberRtnValueSet() * * C function prototype: * diff --git a/arch/arc/fatal_error.c b/arch/arc/fatal_error.c index e391c56c307..d427d28a4f4 100644 --- a/arch/arc/fatal_error.c +++ b/arch/arc/fatal_error.c @@ -76,7 +76,7 @@ static inline void nonEssentialTaskAbort(void) * implementation to take other actions, such as logging error (or debug) * information to a persistent repository and/or rebooting the system. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arc/include/nano_private.h b/arch/arc/include/nano_private.h index 4789d11b714..c7806aa19a2 100644 --- a/arch/arc/include/nano_private.h +++ b/arch/arc/include/nano_private.h @@ -246,7 +246,7 @@ static ALWAYS_INLINE void nanoArchInit(void) * to . It is assumed that the specified is pending, and thus * the fiber's context is stored in its tCCS structure. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -260,7 +260,7 @@ static ALWAYS_INLINE void fiberRtnValueSet(tCCS *fiber, unsigned int value) * * _IS_IN_ISR - indicates if kernel is handling interrupt * - * RETURNS: 1 if interrupt handler is executed, 0 otherwise + * @return 1 if interrupt handler is executed, 0 otherwise * * \NOMANUAL */ diff --git a/arch/arc/prep_c.c b/arch/arc/prep_c.c index e228cf7f452..03b99a3b760 100644 --- a/arch/arc/prep_c.c +++ b/arch/arc/prep_c.c @@ -50,7 +50,7 @@ initialization is performed. * * This routine clears the BSS region, so all bytes are 0. * - * RETURNS: N/A + * @return N/A */ static void bssZero(void) @@ -69,7 +69,7 @@ static void bssZero(void) * * This routine copies the data section from ROM to RAM. * - * RETURNS: N/A + * @return N/A */ #ifdef CONFIG_XIP @@ -96,7 +96,7 @@ extern FUNC_NORETURN void _Cstart(void); * * This routine prepares for the execution of and runs C code. * - * RETURNS: N/A + * @return N/A */ void _PrepC(void) diff --git a/arch/arc/reset.S b/arch/arc/reset.S index 5a38f438b70..1748869f9f4 100644 --- a/arch/arc/reset.S +++ b/arch/arc/reset.S @@ -57,7 +57,7 @@ GTEXT(__reset) * When these steps are completed, jump to _PrepC(), which will finish setting * up the system for running C code. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT,__reset) diff --git a/arch/arm/bsp/CortexM/nmi.c b/arch/arm/bsp/CortexM/nmi.c index 81e27892ed3..36a9496805b 100644 --- a/arch/arm/bsp/CortexM/nmi.c +++ b/arch/arm/bsp/CortexM/nmi.c @@ -59,7 +59,7 @@ static _NmiHandler_t handler = _SysNmiOnReset; * The default handler outputs a error message and reboots the target. It is * installed by calling _NmiInit(); * - * RETURNS: N/A + * @return N/A */ static void _DefaultHandler(void) @@ -76,7 +76,7 @@ static void _DefaultHandler(void) * that reboots the target. It should be installed after the console is * initialized. * - * RETURNS: N/A + * @return N/A */ void _NmiInit(void) @@ -92,7 +92,7 @@ void _NmiInit(void) * that reboots. It should be installed after the console is initialized if it is * meant to output to the console. * - * RETURNS: N/A + * @return N/A */ void _NmiHandlerSet(void (*pHandler)(void)) @@ -107,7 +107,7 @@ void _NmiHandlerSet(void (*pHandler)(void)) * * Simply call what is installed in 'static void(*handler)(void)'. * - * RETURNS: N/A + * @return N/A */ void __nmi(void) diff --git a/arch/arm/bsp/CortexM/prep_c.c b/arch/arm/bsp/CortexM/prep_c.c index d8a1cfa3790..6a5a673e31e 100644 --- a/arch/arm/bsp/CortexM/prep_c.c +++ b/arch/arm/bsp/CortexM/prep_c.c @@ -50,7 +50,7 @@ initialization is performed. * * This routine clears the BSS region, so all bytes are 0. * - * RETURNS: N/A + * @return N/A */ static void bssZero(void) @@ -69,7 +69,7 @@ static void bssZero(void) * * This routine copies the data section from ROM to RAM. * - * RETURNS: N/A + * @return N/A */ #ifdef CONFIG_XIP @@ -96,7 +96,7 @@ extern FUNC_NORETURN void _Cstart(void); * * This routine prepares for the execution of and runs C code. * - * RETURNS: N/A + * @return N/A */ void _PrepC(void) diff --git a/arch/arm/bsp/CortexM/reset.S b/arch/arm/bsp/CortexM/reset.S index 8029bf224ec..fe5b55e4299 100644 --- a/arch/arm/bsp/CortexM/reset.S +++ b/arch/arm/bsp/CortexM/reset.S @@ -67,7 +67,7 @@ GTEXT(__reset) * When these steps are completed, jump to _PrepC(), which will finish setting * up the system for running C code. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT,__reset) diff --git a/arch/arm/bsp/CortexM/scb.c b/arch/arm/bsp/CortexM/scb.c index 6999645c431..21aa0daa3d8 100644 --- a/arch/arm/bsp/CortexM/scb.c +++ b/arch/arm/bsp/CortexM/scb.c @@ -50,7 +50,7 @@ definitions and more complex routines, if needed. * * This routine resets the processor. * - * RETURNS: N/A + * @return N/A */ void _ScbSystemReset(void) @@ -74,7 +74,7 @@ void _ScbSystemReset(void) * * The number of priorities has to be a power of two, from 1 to 128. * - * RETURNS: N/A + * @return N/A */ void _ScbNumPriGroupSet(unsigned int n /* number of priorities */ diff --git a/arch/arm/bsp/sysFatalErrorHandler.c b/arch/arm/bsp/sysFatalErrorHandler.c index 2c8fc06cad3..7530dd40bf4 100644 --- a/arch/arm/bsp/sysFatalErrorHandler.c +++ b/arch/arm/bsp/sysFatalErrorHandler.c @@ -76,7 +76,7 @@ static inline void nonEssentialTaskAbort(void) * implementation to take other actions, such as logging error (or debug) * information to a persistent repository and/or rebooting the system. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arm/core/atomic.S b/arch/arm/core/atomic.S index 815e86c8c6c..2376a531a18 100644 --- a/arch/arm/core/atomic.S +++ b/arch/arm/core/atomic.S @@ -68,7 +68,7 @@ GTEXT(atomic_cas) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -91,7 +91,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_clear_set, atomic_clear) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -144,7 +144,7 @@ SECTION_FUNC(TEXT, atomic_get) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -170,7 +170,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_inc) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -204,7 +204,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_add) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -230,7 +230,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_decSub, atomic_dec) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -264,7 +264,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_decSub, atomic_sub) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -299,7 +299,7 @@ SECTION_FUNC(TEXT, atomic_nand) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -333,7 +333,7 @@ SECTION_FUNC(TEXT, atomic_and) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -367,7 +367,7 @@ SECTION_FUNC(TEXT, atomic_or) * * This routine can be used from both task and interrupt level. * - * RETURNS: Contents of before the atomic operation + * @return Contents of before the atomic operation * * ERRNO: N/A * @@ -401,7 +401,7 @@ SECTION_FUNC(TEXT, atomic_xor) * * This routine can be used from both task and interrupt level. * - * RETURNS: 1 if the swap is actually executed, 0 otherwise. + * @return 1 if the swap is actually executed, 0 otherwise. * * ERRNO: N/A * diff --git a/arch/arm/core/basepri.S b/arch/arm/core/basepri.S index 7729d9b3ee6..68ae17148c9 100644 --- a/arch/arm/core/basepri.S +++ b/arch/arm/core/basepri.S @@ -69,7 +69,7 @@ GTEXT(irq_unlock) * This function can be called recursively: it will return a key to return the * state of interrupt locking to the previous level. * - * RETURNS: a key to return to the previous interrupt locking level + * @return a key to return to the previous interrupt locking level */ SECTION_FUNC(TEXT,irq_lock) @@ -85,7 +85,7 @@ SECTION_FUNC(TEXT,irq_lock) * Return the state of interrupt locking to a previous level, passed in via the * parameter, obtained from a previous call to irq_lock(). * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT,irq_unlock) diff --git a/arch/arm/core/context.c b/arch/arm/core/context.c index b796aede60a..b7ed5fc88e3 100644 --- a/arch/arm/core/context.c +++ b/arch/arm/core/context.c @@ -59,7 +59,7 @@ tNANO _nanokernel = {0}; * * Currently only inserts the new context in the list of active contexts. * - * RETURNS: N/A + * @return N/A */ static ALWAYS_INLINE void _context_monitor_init(struct ccs *pCcs /* context */ @@ -99,7 +99,7 @@ static ALWAYS_INLINE void _context_monitor_init(struct ccs *pCcs /* context */ * * is currently unused. * - * RETURNS: N/A + * @return N/A */ void _NewContext( diff --git a/arch/arm/core/cpu_idle.S b/arch/arm/core/cpu_idle.S index a135e76c3bc..6e2146b4d18 100644 --- a/arch/arm/core/cpu_idle.S +++ b/arch/arm/core/cpu_idle.S @@ -63,7 +63,7 @@ GTEXT(nano_cpu_atomic_idle) * Only called by nanoArchInit(). Sets SEVONPEND bit once for the system's * duration. * - * RETURNS: N/A + * @return N/A * * C function prototype: * @@ -84,7 +84,7 @@ SECTION_FUNC(TEXT, _CpuIdleInit) * * Returns the nanokernel idle setting, in ticks. Only called by __systick(). * - * RETURNS: the requested number of ticks for the kernel to be idle + * @return the requested number of ticks for the kernel to be idle * * C function prototype: * @@ -102,7 +102,7 @@ SECTION_FUNC(TEXT, _NanoIdleValGet) * * Sets the nanokernel idle setting to 0. Only called by __systick(). * - * RETURNS: N/A + * @return N/A * * C function prototype: * @@ -126,7 +126,7 @@ SECTION_FUNC(TEXT, _NanoIdleValClear) * '_sys_power_save_flag' variable is non-zero. The ARM 'wfi' instruction * will be issued, causing a low-power consumption sleep mode. * - * RETURNS: N/A + * @return N/A * * C function prototype: * @@ -161,7 +161,7 @@ SECTION_FUNC(TEXT, nano_cpu_idle) * 2) After waking up from the low-power mode, the interrupt lockout state * must be restored as indicated in the 'imask' input parameter. * - * RETURNS: N/A + * @return N/A * * C function prototype: * diff --git a/arch/arm/core/exc_exit.S b/arch/arm/core/exc_exit.S index 8c38ae5bce2..aef35b3dd8f 100644 --- a/arch/arm/core/exc_exit.S +++ b/arch/arm/core/exc_exit.S @@ -84,7 +84,7 @@ GDATA(_nanokernel) * _IntExit(); * } * - * RETURNS: N/A + * @return N/A */ SECTION_SUBSEC_FUNC(TEXT, _HandlerModeExit, _IntExit) @@ -99,7 +99,7 @@ SECTION_SUBSEC_FUNC(TEXT, _HandlerModeExit, _IntExit) * * See _IntExit(). * - * RETURNS: N/A + * @return N/A */ SECTION_SUBSEC_FUNC(TEXT, _HandlerModeExit, _ExcExit) diff --git a/arch/arm/core/fatal.c b/arch/arm/core/fatal.c index f648e7a3faf..d57e944ff98 100644 --- a/arch/arm/core/fatal.c +++ b/arch/arm/core/fatal.c @@ -75,7 +75,7 @@ const NANO_ESF _default_esf = {0xdeaddead, /* a1 */ * fatal error does not have a hardware generated ESF, the caller should either * create its own or use a pointer to the global default ESF <_default_esf>. * - * RETURNS: This function does not return. + * @return This function does not return. * * \NOMANUAL */ diff --git a/arch/arm/core/fault.c b/arch/arm/core/fault.c index 6710e04b5c9..92feff8ea6c 100644 --- a/arch/arm/core/fault.c +++ b/arch/arm/core/fault.c @@ -73,7 +73,7 @@ Common fault handler for ARM Cortex-M processors. * MMFSR: 0x00000000, BFSR: 0x00000082, UFSR: 0x00000000 * BFAR: 0xff001234 * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -124,7 +124,7 @@ void _FaultDump(const NANO_ESF *esf, int fault) * * See _FaultDump() for example. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -143,7 +143,7 @@ static void _FaultContextShow(const NANO_ESF *esf) * * See _FaultDump() for example. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -178,7 +178,7 @@ static void _MpuFault(const NANO_ESF *esf, * * See _FaultDump() for example. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -219,7 +219,7 @@ static void _BusFault(const NANO_ESF *esf, * * See _FaultDump() for example. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -259,7 +259,7 @@ static void _UsageFault(const NANO_ESF *esf) * * See _FaultDump() for example. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -287,7 +287,7 @@ static void _HardFault(const NANO_ESF *esf) * * See _FaultDump() for example. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -303,7 +303,7 @@ static void _DebugMonitor(const NANO_ESF *esf) * * See _FaultDump() for example. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -333,7 +333,7 @@ static void _ReservedException(const NANO_ESF *esf, * Precise data bus error * Address: 0xff001234 * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -376,7 +376,7 @@ static void _FaultDump(const NANO_ESF *esf, int fault) * interrupt was already being handled, it is passed a pointer to both and has * to find out on which the ESP is present. * - * RETURNS: This function does not return. + * @return This function does not return. * * \NOMANUAL */ @@ -400,7 +400,7 @@ void _Fault( * * Turns on the desired hardware faults. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arm/core/ffs.S b/arch/arm/core/ffs.S index 417a9494612..72289bf5733 100644 --- a/arch/arm/core/ffs.S +++ b/arch/arm/core/ffs.S @@ -57,7 +57,7 @@ GTEXT(find_first_set) * at 1 from the least significant bit. A return value of zero indicates that * the value passed is zero. * - * RETURNS: most significant bit set + * @return most significant bit set */ SECTION_FUNC(TEXT, find_last_set) @@ -78,7 +78,7 @@ SECTION_FUNC(TEXT, find_last_set) * at 1 from the least significant bit. A return value of zero indicates that * the value passed is zero. * - * RETURNS: least significant bit set + * @return least significant bit set */ SECTION_FUNC(TEXT, find_first_set) diff --git a/arch/arm/core/fiber_abort.c b/arch/arm/core/fiber_abort.c index 9be6351b940..93b148cf309 100644 --- a/arch/arm/core/fiber_abort.c +++ b/arch/arm/core/fiber_abort.c @@ -61,7 +61,7 @@ the PendSV exception. * - the fiber implicitly aborts by returning from its entry point * - the fiber encounters a fatal exception * - * RETURNS: N/A + * @return N/A */ void fiber_abort(void) diff --git a/arch/arm/core/gdb_stub.S b/arch/arm/core/gdb_stub.S index 621671dc329..03b8ee62be7 100644 --- a/arch/arm/core/gdb_stub.S +++ b/arch/arm/core/gdb_stub.S @@ -70,7 +70,7 @@ _ASM_FILE_PROLOGUE * - must be called with interrupts locked * - cannot use r0 without saving it first * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _GdbStubExcEntry) @@ -107,7 +107,7 @@ SECTION_FUNC(TEXT, _GdbStubExcEntry) * - must be called with interrupts locked * - cannot use r0 without saving it first * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _GdbStubExcExit) @@ -145,7 +145,7 @@ SECTION_FUNC(TEXT, _GdbStubExcExit) * This stub must also act as a demuxer that find the running exception and * invoke the user's real ISR. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _irq_vector_table_entry_with_gdb_stub) diff --git a/arch/arm/core/irq_init.c b/arch/arm/core/irq_init.c index 390950a3487..3cf367b890d 100644 --- a/arch/arm/core/irq_init.c +++ b/arch/arm/core/irq_init.c @@ -53,7 +53,7 @@ the PendSV exception. * not 0, which they have it set to when coming out of reset. This ensures that * interrupt locking via BASEPRI works as expected. * - * RETURNS: N/A + * @return N/A */ void _IntLibInit(void) diff --git a/arch/arm/core/irq_manage.c b/arch/arm/core/irq_manage.c index 2d2155f65df..6a1a433c03c 100644 --- a/arch/arm/core/irq_manage.c +++ b/arch/arm/core/irq_manage.c @@ -56,7 +56,7 @@ extern void __reserved(void); * This routine will hang if is not found in the table and ASSERT_ON is * enabled. * - * RETURNS: N/A + * @return N/A */ void irq_handler_set(unsigned int irq, @@ -84,7 +84,7 @@ void irq_handler_set(unsigned int irq, * line. After this call, the CPU will receive interrupts for the specified * . * - * RETURNS: N/A + * @return N/A */ void irq_enable(unsigned int irq) @@ -101,7 +101,7 @@ void irq_enable(unsigned int irq) * Disable an interrupt line. After this call, the CPU will stop receiving * interrupts for the specified . * - * RETURNS: N/A + * @return N/A */ void irq_disable(unsigned int irq) @@ -121,7 +121,7 @@ void irq_disable(unsigned int irq) * * The priority is verified if ASSERT_ON is enabled. * - * RETURNS: N/A + * @return N/A */ void irq_priority_set(unsigned int irq, @@ -140,7 +140,7 @@ void irq_priority_set(unsigned int irq, * * See __reserved(). * - * RETURNS: N/A + * @return N/A */ void _irq_spurious(void *unused) @@ -159,7 +159,7 @@ void _irq_spurious(void *unused) * This routine will hang if another ISR was connected for interrupt line * and ASSERT_ON is enabled; if ASSERT_ON is disabled, it will fail silently. * - * RETURNS: the interrupt line number + * @return the interrupt line number */ int irq_connect(unsigned int irq, @@ -180,7 +180,7 @@ int irq_connect(unsigned int irq, * the latter is replaced by _irq_spurious(). irq_disable() should have * been called before invoking this routine. * - * RETURNS: N/A + * @return N/A */ void irq_disconnect(unsigned int irq) diff --git a/arch/arm/core/isr_wrapper.S b/arch/arm/core/isr_wrapper.S index 3ce5b05c00a..b93935afe80 100644 --- a/arch/arm/core/isr_wrapper.S +++ b/arch/arm/core/isr_wrapper.S @@ -64,7 +64,7 @@ GTEXT(_IntExit) * pends the PendSV exception if so: the latter will perform the context switch * itself. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _isr_wrapper) diff --git a/arch/arm/core/swap.S b/arch/arm/core/swap.S index 9413a49afe2..0797012ba15 100644 --- a/arch/arm/core/swap.S +++ b/arch/arm/core/swap.S @@ -153,7 +153,7 @@ SECTION_FUNC(TEXT, __pendsv) * The service call (svc) is only used in _Swap() to enter handler mode so we * can go through the PendSV exception to perform a context switch. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, __svc) @@ -203,7 +203,7 @@ SECTION_FUNC(TEXT, __svc) * outgoing context. This is all performed by the hardware, which stores it in * its exception stack frame, created when handling the svc exception. * - * RETURNS: may contain a return value setup by a call to fiberRtnValueSet() + * @return may contain a return value setup by a call to fiberRtnValueSet() * * C function prototype: * diff --git a/arch/arm/core/task_abort.c b/arch/arm/core/task_abort.c index da2ac9b46fd..251d1eed456 100644 --- a/arch/arm/core/task_abort.c +++ b/arch/arm/core/task_abort.c @@ -62,7 +62,7 @@ static struct k_args cmd_packet; * - the task implicitly aborts by returning from its entry point * - the task encounters a fatal exception * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arm/fsl_frdm_k64f/system.c b/arch/arm/fsl_frdm_k64f/system.c index 2ac57cdaa73..be91ab6af15 100644 --- a/arch/arm/fsl_frdm_k64f/system.c +++ b/arch/arm/fsl_frdm_k64f/system.c @@ -106,7 +106,7 @@ uint8_t __security_frdm_k64f_section __security_frdm_k64f[] = { * PLL Bypassed External (PBE) modes to get to the desired * PLL Engaged External (PEE) mode and generate the maximum 120 MHz system clock. * - * RETURNS: N/A + * @return N/A * */ @@ -253,7 +253,7 @@ static void clkInit(void) * * Only used for debugging. * - * RETURNS: N/A + * @return N/A * */ @@ -306,7 +306,7 @@ static void consoleInit(void) * Kinetis UART device driver. * Also initialize the timer device driver, if required. * - * RETURNS: N/A + * @return N/A */ void _InitHardware(void) diff --git a/arch/arm/fsl_frdm_k64f/wdog.S b/arch/arm/fsl_frdm_k64f/wdog.S index 7fd151ebac2..2dad1dd79b7 100644 --- a/arch/arm/fsl_frdm_k64f/wdog.S +++ b/arch/arm/fsl_frdm_k64f/wdog.S @@ -59,7 +59,7 @@ GTEXT(_WdogInit) * * This routine will disable the watchdog timer. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT,_WdogInit) diff --git a/arch/arm/include/CortexM/asm_inline_gcc.h b/arch/arm/include/CortexM/asm_inline_gcc.h index ad0ed246a92..2191d2aa8f6 100644 --- a/arch/arm/include/CortexM/asm_inline_gcc.h +++ b/arch/arm/include/CortexM/asm_inline_gcc.h @@ -46,7 +46,7 @@ * * Obtain and return current value of IPSR register. * - * RETURNS: the contents of the IPSR register + * @return the contents of the IPSR register * * \NOMANUAL */ @@ -65,7 +65,7 @@ static ALWAYS_INLINE uint32_t _IpsrGet(void) * * Store the value of in MSP register. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arm/include/CortexM/exc.h b/arch/arm/include/CortexM/exc.h index d498d94e33e..fd150c74e8f 100644 --- a/arch/arm/include/CortexM/exc.h +++ b/arch/arm/include/CortexM/exc.h @@ -56,7 +56,7 @@ Exception/interrupt context helpers. * interrupts. Taking a fault within an exception is also considered in * interrupt context. * - * RETURNS: 1 if in ISR, 0 if not. + * @return 1 if in ISR, 0 if not. * * \NOMANUAL */ @@ -76,7 +76,7 @@ static ALWAYS_INLINE int _IsInIsr(void) * * Enable fault exceptions. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arm/include/CortexM/stack.h b/arch/arm/include/CortexM/stack.h index 9984215defb..8d8ef8cfe66 100644 --- a/arch/arm/include/CortexM/stack.h +++ b/arch/arm/include/CortexM/stack.h @@ -75,7 +75,7 @@ extern char _interrupt_stack[CONFIG_ISR_STACK_SIZE]; * On Cortex-M, the interrupt stack is registered in the MSP (main stack * pointer) register, and switched to automatically when taking an exception. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arm/include/nano_private.h b/arch/arm/include/nano_private.h index 775a99037a1..8a3876bd80e 100644 --- a/arch/arm/include/nano_private.h +++ b/arch/arm/include/nano_private.h @@ -192,7 +192,7 @@ static ALWAYS_INLINE void nanoArchInit(void) * to . It is assumed that the specified is pending, and thus * the fiber's context is stored in its tCCS structure. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/arm/ti_lm3s6965/scp.c b/arch/arm/ti_lm3s6965/scp.c index 3d9fbb7a734..1a135aaed54 100644 --- a/arch/arm/ti_lm3s6965/scp.c +++ b/arch/arm/ti_lm3s6965/scp.c @@ -53,7 +53,7 @@ volatile struct __scp __scp_section __scp; * * _ScpMainOscEnable - enable main oscillator with default frequency of 6MHz * - * RETURNS: N/A + * @return N/A */ void _ScpMainOscEnable(void) { diff --git a/arch/arm/ti_lm3s6965/system.c b/arch/arm/ti_lm3s6965/system.c index a0b2ae78562..cd5819c95be 100644 --- a/arch/arm/ti_lm3s6965/system.c +++ b/arch/arm/ti_lm3s6965/system.c @@ -63,7 +63,7 @@ extern void _NmiInit(void); * * uart_generic_info_init - initialize generic information for one UART * - * RETURNS: N/A + * @return N/A * */ @@ -85,7 +85,7 @@ inline void uart_generic_info_init(struct uart_init_info *pInfo) * * Only used for debugging. * - * RETURNS: N/A + * @return N/A * */ @@ -140,7 +140,7 @@ static void bluetooth_init(void) * integrated 16550-compatible UART device driver. * Also initialize the timer device driver, if required. * - * RETURNS: N/A + * @return N/A */ void _InitHardware(void) diff --git a/arch/x86/cache.c b/arch/x86/cache.c index 16a4e080926..7a932c79805 100644 --- a/arch/x86/cache.c +++ b/arch/x86/cache.c @@ -55,7 +55,7 @@ This module contains functions for manipulation caches. * The cache line size is specified via the CONFIG_CACHE_LINE_SIZE kconfig * option. * - * RETURNS: N/A + * @return N/A */ void _SysCacheFlush(VIRT_ADDR virt, size_t size) diff --git a/arch/x86/cache_s.S b/arch/x86/cache_s.S index 373c3cb8142..770072e4a31 100644 --- a/arch/x86/cache_s.S +++ b/arch/x86/cache_s.S @@ -54,7 +54,7 @@ This module contains functions for manipulating caches. * * Both parameters are ignored in this implementation. * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _SysCacheFlush) diff --git a/arch/x86/core/atomic.S b/arch/x86/core/atomic.S index ecee894ba6f..560a31c0346 100644 --- a/arch/x86/core/atomic.S +++ b/arch/x86/core/atomic.S @@ -81,7 +81,7 @@ as there is no requirement for this capability. * and the write of the new value (if it occurs) all happen atomically with * respect to both interrupts and accesses of other processors to . * - * RETURNS: Returns 1 if is written, 0 otherwise. + * @return Returns 1 if is written, 0 otherwise. * * int atomic_cas * ( @@ -121,7 +121,7 @@ BRANCH_LABEL(atomic_cas1) * atomically added to the value at , placing the result at , * and the old value from is returned. * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_add * ( @@ -153,7 +153,7 @@ SECTION_FUNC(TEXT, atomic_add) * atomically subtracted from the value at , placing the result at * , and the old value from is returned. * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_sub * ( @@ -185,7 +185,7 @@ SECTION_FUNC(TEXT, atomic_sub) * This routine provides the atomic increment operator. The value at * is atomically incremented by 1, and the old value from is returned. * - * RETURNS: The value from before the increment + * @return The value from before the increment * * atomic_val_t atomic_inc * ( @@ -217,7 +217,7 @@ SECTION_FUNC(TEXT, atomic_inc) * This routine provides the atomic decrement operator. The value at * is atomically decremented by 1, and the old value from is returned. * - * RETURNS: The value from prior to the decrement + * @return The value from prior to the decrement * * atomic_val_t atomic_dec * ( @@ -248,7 +248,7 @@ SECTION_FUNC(TEXT, atomic_dec) * a value from . It simply does an ordinary load. Note that * is expected to be aligned to a 4-byte boundary. * - * RETURNS: The value read from + * @return The value read from * * atomic_t atomic_get * ( @@ -271,7 +271,7 @@ SECTION_FUNC(TEXT, atomic_get) * This routine provides the atomic set operator. The is atomically * written at and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_set * ( @@ -312,7 +312,7 @@ SECTION_FUNC(TEXT, atomic_set) * written at and the previous value at is returned. (Hence, * atomic_clear(pAtomicVar) is equivalent to atomic_set(pAtomicVar, 0).) * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_clear * ( @@ -349,7 +349,7 @@ SECTION_FUNC(TEXT, atomic_clear) * is atomically bitwise OR'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_or * ( @@ -387,7 +387,7 @@ BRANCH_LABEL(atomic_or_retry) * is atomically bitwise XOR'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_xor * ( @@ -425,7 +425,7 @@ BRANCH_LABEL(atomic_xor_retry) * atomically bitwise AND'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_and * ( @@ -463,7 +463,7 @@ BRANCH_LABEL(atomic_and_retry) * atomically bitwise NAND'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from * * atomic_val_t atomic_nand * ( diff --git a/arch/x86/core/atomic_nolock.c b/arch/x86/core/atomic_nolock.c index 2ac8b238271..441167e1918 100644 --- a/arch/x86/core/atomic_nolock.c +++ b/arch/x86/core/atomic_nolock.c @@ -65,7 +65,7 @@ as there is no requirement for this capability. * and the write of the new value (if it occurs) all happen atomically with * respect to both interrupts and accesses of other processors to . * - * RETURNS: Returns 1 if is written, 0 otherwise. + * @return Returns 1 if is written, 0 otherwise. */ int atomic_cas( @@ -96,7 +96,7 @@ int atomic_cas( * atomically added to the value at , placing the result at , * and the old value from is returned. * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_add( @@ -122,7 +122,7 @@ atomic_val_t atomic_add( * atomically subtracted from the value at , placing the result at * , and the old value from is returned. * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_sub( @@ -147,7 +147,7 @@ atomic_val_t atomic_sub( * This routine provides the atomic increment operator. The value at * is atomically incremented by 1, and the old value from is returned. * - * RETURNS: The value from before the increment + * @return The value from before the increment */ atomic_val_t atomic_inc( @@ -171,7 +171,7 @@ atomic_val_t atomic_inc( * This routine provides the atomic decrement operator. The value at * is atomically decremented by 1, and the old value from is returned. * - * RETURNS: The value from prior to the decrement + * @return The value from prior to the decrement */ atomic_val_t atomic_dec( @@ -196,7 +196,7 @@ atomic_val_t atomic_dec( * a value from . It simply does an ordinary load. Note that * is expected to be aligned to a 4-byte boundary. * - * RETURNS: The value read from + * @return The value read from */ atomic_val_t atomic_get(const atomic_t *target /* memory location to read from */ @@ -212,7 +212,7 @@ atomic_val_t atomic_get(const atomic_t *target /* memory location to read from * * This routine provides the atomic set operator. The is atomically * written at and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_set( @@ -238,7 +238,7 @@ atomic_val_t atomic_set( * written at and the previous value at is returned. (Hence, * atomic_clear(pAtomicVar) is equivalent to atomic_set(pAtomicVar, 0).) * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_clear( @@ -263,7 +263,7 @@ atomic_val_t atomic_clear( * is atomically bitwise OR'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_or( @@ -289,7 +289,7 @@ atomic_val_t atomic_or( * is atomically bitwise XOR'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_xor( @@ -315,7 +315,7 @@ atomic_val_t atomic_xor( * atomically bitwise AND'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_and( @@ -341,7 +341,7 @@ atomic_val_t atomic_and( * atomically bitwise NAND'ed with the value at , placing the result * at , and the previous value at is returned. * - * RETURNS: The previous value from + * @return The previous value from */ atomic_val_t atomic_nand( diff --git a/arch/x86/core/context.c b/arch/x86/core/context.c index 0787fcd23e0..a1b4d355967 100644 --- a/arch/x86/core/context.c +++ b/arch/x86/core/context.c @@ -67,7 +67,7 @@ void _ContextEntryWrapper(_ContextEntry, _ContextArg, _ContextArg, _ContextArg); * * This function is called by _NewContext() to initialize task contexts. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -260,7 +260,7 @@ static void _NewContextInternal( * first time that the new context is swapped in, and it jumps to * _context_entry after it has done its work. * - * RETURNS: this routine does NOT return. + * @return this routine does NOT return. * * \NOMANUAL */ @@ -283,7 +283,7 @@ __asm__("\t.globl _context_entry\n" * The "context control block" (CCS) is carved from the "end" of the specified * context stack memory. * - * RETURNS: opaque pointer to initialized CCS structure + * @return opaque pointer to initialized CCS structure * * \NOMANUAL */ diff --git a/arch/x86/core/cpuhalt.S b/arch/x86/core/cpuhalt.S index deabf725d1e..fcd23a9e945 100644 --- a/arch/x86/core/cpuhalt.S +++ b/arch/x86/core/cpuhalt.S @@ -73,7 +73,7 @@ by nano_cpu_atomic_idle(). * '_sys_power_save_flag' variable is non-zero. The IA-32 'hlt' instruction * will be issued causing a low-power consumption sleep mode. * - * RETURNS: N/A + * @return N/A * * C function prototype: * @@ -113,7 +113,7 @@ SECTION_FUNC(TEXT, nano_cpu_idle) * 2) After waking up from the low-power mode, the interrupt lockout state * must be restored as indicated in the 'imask' input parameter. * - * RETURNS: N/A + * @return N/A * * C function prototype: * diff --git a/arch/x86/core/excconnect.c b/arch/x86/core/excconnect.c index 4babb07934e..1bb9bf3de36 100644 --- a/arch/x86/core/excconnect.c +++ b/arch/x86/core/excconnect.c @@ -110,7 +110,7 @@ void _NanoCpuExcConnectAtDpl(unsigned int vector, * The handler is connected via an interrupt-gate descriptor having a * descriptor privilege level (DPL) equal to zero. * - * RETURNS: N/A + * @return N/A * * INTERNAL * The function prototype for nanoCpuExcConnect() only exists in nano_private.h, @@ -150,7 +150,7 @@ void nanoCpuExcConnect(unsigned int vector, /* interrupt vector: 0 to 255 on * The handler is connected via an interrupt-gate descriptor having the supplied * descriptor privilege level (DPL). * - * RETURNS: N/A + * @return N/A * * INTERNAL * The function prototype for nanoCpuExcConnect() only exists in nano_private.h, diff --git a/arch/x86/core/excstub.S b/arch/x86/core/excstub.S index 8a7aaf5830f..4255d45bda7 100644 --- a/arch/x86/core/excstub.S +++ b/arch/x86/core/excstub.S @@ -75,7 +75,7 @@ and exiting a C exception handler. * created by this routine to determine the locations of volatile registers. * These tools must be updated to reflect any changes to the stack frame. * - * RETURNS: N/A + * @return N/A * * C function prototype: * @@ -224,7 +224,7 @@ BRANCH_LABEL(allDone) * completed. This routine restores the volatile integer registers and * then control is returned back to the interrupted context or ISR. * - * RETURNS: N/A + * @return N/A * * C function prototype: * diff --git a/arch/x86/core/fatal.c b/arch/x86/core/fatal.c index 16ed6d61ebc..b2ed06ad1dd 100644 --- a/arch/x86/core/fatal.c +++ b/arch/x86/core/fatal.c @@ -76,7 +76,7 @@ const NANO_ESF _default_esf = { * fatal error does not have a hardware generated ESF, the caller should either * create its own or use a pointer to the global default ESF <_default_esf>. * - * RETURNS: This function does not return. + * @return This function does not return. * * \NOMANUAL */ diff --git a/arch/x86/core/ffs.S b/arch/x86/core/ffs.S index cd8b570fcac..6cf16bd53db 100644 --- a/arch/x86/core/ffs.S +++ b/arch/x86/core/ffs.S @@ -60,7 +60,7 @@ are defined in arch.h. * at 1 from the least significant bit to 32 for the most significant bit. * A return value of zero indicates that the value passed is zero. * - * RETURNS: bit position from 1 to 32, or 0 if the argument is zero. + * @return bit position from 1 to 32, or 0 if the argument is zero. * * INTERNAL * For Intel64 (x86_64) architectures, the 'cmovz' can be removed @@ -103,7 +103,7 @@ BRANCH_LABEL(ffsLsb_argNotZero) /* this label serves find_first_set() & find_las * at 1 from the least significant bit to 32 for the most significant bit. * A return value of zero indicates that the value passed is zero. * - * RETURNS: bit position from 1 to 32, or 0 if the argument is zero. + * @return bit position from 1 to 32, or 0 if the argument is zero. * * INTERNAL * For Intel64 (x86_64) architectures, the 'cmovz' can be removed diff --git a/arch/x86/core/float.c b/arch/x86/core/float.c index 73df54ca2c6..3f0c32eeeae 100644 --- a/arch/x86/core/float.c +++ b/arch/x86/core/float.c @@ -120,7 +120,7 @@ extern uint32_t _sse_mxcsr_default_value; /* SSE control/status register default * specified CCS. If the specified task or fiber supports SSE then * x87/MMX/SSEx context info is saved, otherwise only x87/MMX context is saved. * - * RETURNS: N/A + * @return N/A */ static void _FpCtxSave(tCCS *ccs) @@ -134,7 +134,7 @@ static void _FpCtxSave(tCCS *ccs) * * This routine initializes the system's "live" non-integer context. * - * RETURNS: N/A + * @return N/A */ static inline void _FpCtxInit(tCCS *ccs) @@ -163,7 +163,7 @@ static inline void _FpCtxInit(tCCS *ccs) * This routine should only be used to enable floating point support for a * task/fiber that does not currently have such support enabled already. * - * RETURNS: N/A + * @return N/A * * INTERNAL * Since the transition from "non-FP supporting" to "FP supporting" must be done @@ -296,7 +296,7 @@ void _FpEnable(tCCS *ccs, * * See the description of _FpEnable() for further details. * - * RETURNS: N/A + * @return N/A */ FUNC_ALIAS(_FpEnable, fiber_float_enable, void); @@ -310,7 +310,7 @@ FUNC_ALIAS(_FpEnable, fiber_float_enable, void); * * See the description of _FpEnable() for further details. * - * RETURNS: N/A + * @return N/A */ FUNC_ALIAS(_FpEnable, task_float_enable, void); @@ -327,7 +327,7 @@ FUNC_ALIAS(_FpEnable, task_float_enable, void); * This routine should only be used to disable floating point support for * a task/fiber that currently has such support enabled. * - * RETURNS: N/A + * @return N/A * * INTERNAL * Since the transition from "FP supporting" to "non-FP supporting" must be done @@ -389,7 +389,7 @@ void _FpDisable(tCCS *ccs) * This routine should only be used to disable floating point support for * a task/fiber that currently has such support enabled. * - * RETURNS: N/A + * @return N/A */ FUNC_ALIAS(_FpDisable, fiber_float_disable, void); @@ -406,7 +406,7 @@ FUNC_ALIAS(_FpDisable, fiber_float_disable, void); * This routine should only be used to disable floating point support for * a task/fiber that currently has such support enabled. * - * RETURNS: N/A + * @return N/A */ FUNC_ALIAS(_FpDisable, task_float_disable, void); @@ -426,7 +426,7 @@ FUNC_ALIAS(_FpDisable, task_float_disable, void); * current task or fiber with the USE_FP option (or the USE_SSE option if the * SSE configuration option has been enabled). * - * RETURNS: N/A + * @return N/A */ void _FpNotAvailableExcHandler(NANO_ESF * pEsf /* not used */ diff --git a/arch/x86/core/intconnect.c b/arch/x86/core/intconnect.c index d77344f4585..f17f26006c9 100644 --- a/arch/x86/core/intconnect.c +++ b/arch/x86/core/intconnect.c @@ -162,7 +162,7 @@ static NANO_INT_STUB dynamic_stubs[ALL_DYNAMIC_STUBS] = { /** * _int_stub_alloc - allocate dynamic interrupt stub * - * RETURNS: index of the first available element of the STUB array or -1 + * @return index of the first available element of the STUB array or -1 * if all elements are used */ static int _int_stub_alloc(void) @@ -192,7 +192,7 @@ static int _int_stub_alloc(void) * and exceptions should specify a level of 0, whereas handlers for user-mode * software generated interrupts should specify 3. * - * RETURNS: N/A + * @return N/A * * INTERNAL * Unlike nanoCpuExcConnect() and irq_connect(), the _IntVecSet() routine @@ -260,7 +260,7 @@ void _IntVecSet( * The routine searches for the first available element in the synamic_stubs * array and uses it for the stub. * - * RETURNS: the allocated interrupt vector + * @return the allocated interrupt vector * * WARNINGS * Some boards utilize interrupt controllers where the interrupt vector @@ -502,7 +502,7 @@ int irq_connect( * For example, the local APIC on Pentium4 and later processors, the in-service * register (ISR) and the interrupt request register (IRR) are 256 bits wide. * - * RETURNS: allocated interrupt vector + * @return allocated interrupt vector * * INTERNAL * For debug kernels, this routine shall return -1 when there are no @@ -610,7 +610,7 @@ int _IntVecAlloc(unsigned int priority) * as allocated so that any future invocations of _IntVecAllocate() will not * return that vector. * - * RETURNS: N/A + * @return N/A * */ diff --git a/arch/x86/core/inthndlset.c b/arch/x86/core/inthndlset.c index 99cb9ebdafb..342ee56ed01 100644 --- a/arch/x86/core/inthndlset.c +++ b/arch/x86/core/inthndlset.c @@ -76,7 +76,7 @@ extern unsigned char _idt_base_address[]; * and/or parameter. If possible, silence the source of the associated interrupt * only, rather than locking out all interrupts. * - * RETURNS: N/A + * @return N/A * */ diff --git a/arch/x86/core/intstub.S b/arch/x86/core/intstub.S index 731346f60f3..86ab2e0c248 100644 --- a/arch/x86/core/intstub.S +++ b/arch/x86/core/intstub.S @@ -101,7 +101,7 @@ entering and exiting a C interrupt handler. * created by this routine to determine the locations of volatile registers. * These tools must be updated to reflect any changes to the stack frame. * - * RETURNS: N/A + * @return N/A * * C function prototype: * @@ -255,7 +255,7 @@ BRANCH_LABEL(_HandleIdle) * in which case one or more other fiber and task contexts will execute before * this routine resumes and control gets returned to the interrupted task. * - * RETURNS: N/A + * @return N/A * * C function prototype: * @@ -405,7 +405,7 @@ BRANCH_LABEL(nestedInterrupt) * to return to the interrupted context and thus the volatile registers * are not saved. * - * RETURNS: Never returns + * @return Never returns * * C function prototype: * @@ -487,7 +487,7 @@ BRANCH_LABEL(callFatalHandler) * to block, the interrupt disable state will be restored when the context is * later rescheduled for execution. * - * RETURNS: An architecture-dependent lock-out key representing the + * @return An architecture-dependent lock-out key representing the * "interrupt disable state" prior to the call. */ diff --git a/arch/x86/core/msr.S b/arch/x86/core/msr.S index a5d0d822e00..9755cee57a7 100644 --- a/arch/x86/core/msr.S +++ b/arch/x86/core/msr.S @@ -65,7 +65,7 @@ utilities. * 2) The 'wrmsr' uses the ECX, EDX, and EAX registers which matches the set of * volatile registers! * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _MsrWrite) @@ -96,7 +96,7 @@ SECTION_FUNC(TEXT, _MsrWrite) * 2) The 'rdmsr' uses the ECX, EDX, and EAX registers which matches the set of * volatile registers! * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _MsrRead) diff --git a/arch/x86/core/swap.S b/arch/x86/core/swap.S index cefcd96bd27..c137b381842 100644 --- a/arch/x86/core/swap.S +++ b/arch/x86/core/swap.S @@ -99,7 +99,7 @@ save frame on the stack. * no runnable FIBER contexts, then schedule the TASK context represented * by _nanokernel.task. The _nanokernel.task field will never be NULL. * - * RETURNS: may contain a return value setup by a call to fiberRtnValueSet() + * @return may contain a return value setup by a call to fiberRtnValueSet() * * C function prototype: * diff --git a/arch/x86/generic_pc/system.c b/arch/x86/generic_pc/system.c index 78383eb97f8..c9b70e3bbc2 100644 --- a/arch/x86/generic_pc/system.c +++ b/arch/x86/generic_pc/system.c @@ -90,7 +90,7 @@ static inline void ioapicInit(void) * * uart_generic_info_init - initialize initialization information for one UART * - * RETURNS: N/A + * @return N/A * */ @@ -112,7 +112,7 @@ void uart_generic_info_init(struct uart_init_info *p_info) * * Only used for debugging. * - * RETURNS: N/A + * @return N/A * */ @@ -157,7 +157,7 @@ static void bluetooth_init(void) * Intel 8250 UART device driver. * Also initialize the timer device driver, if required. * - * RETURNS: N/A + * @return N/A */ void _InitHardware(void) diff --git a/arch/x86/include/advidle.h b/arch/x86/include/advidle.h index a5e21b06869..29a26861982 100644 --- a/arch/x86/include/advidle.h +++ b/arch/x86/include/advidle.h @@ -48,7 +48,7 @@ and _AdvIdleStart() functions. * This routine checks if the system is recovering from advanced * sleep or cold booting. * - * RETURNS: 0 if the system is cold booting on a non-zero + * @return 0 if the system is cold booting on a non-zero * value if the system is recovering from advanced sleep. */ @@ -63,7 +63,7 @@ extern int _AdvIdleCheckSleep(void); * passes to the _AdvIdleFunc() that put the system to sleep, which then * finishes executing. * - * RETURNS: does not return to caller + * @return does not return to caller */ extern void _AdvIdleStart( @@ -80,7 +80,7 @@ extern void _AdvIdleStart( * to sleep and then later allows it to resume processing; if not, the routine * returns immediately without sleeping. * - * RETURNS: non-zero if advanced sleep occurred; otherwise zero + * @return non-zero if advanced sleep occurred; otherwise zero */ extern int _AdvIdleFunc(int32_t ticks /* upcoming kernel idle time */ diff --git a/arch/x86/include/asm_inline_gcc.h b/arch/x86/include/asm_inline_gcc.h index 94218736c4e..594b5e6633d 100644 --- a/arch/x86/include/asm_inline_gcc.h +++ b/arch/x86/include/asm_inline_gcc.h @@ -49,7 +49,7 @@ NANO_CPU_EXC_CONNECT_NO_ERR(handler,vector,0) * * EflagsGet - return the current value of the EFLAGS register * - * RETURNS: the EFLAGS register. + * @return the EFLAGS register. * * \NOMANUAL */ @@ -77,7 +77,7 @@ static inline unsigned int EflagsGet(void) * This routine sets CR0[TS] to 1, which disallows the use of FP instructions * by the currently executing context. * - * RETURNS: N/A + * @return N/A */ static inline void _FpAccessDisable(void) @@ -103,7 +103,7 @@ static inline void _FpAccessDisable(void) * x87/MMX/SSEx context info is saved, otherwise only x87/MMX context is saved. * Function is invoked by _FpCtxSave(tCCS *ccs) * - * RETURNS: N/A + * @return N/A */ static inline void _do_fp_ctx_save(int flags, void *preemp_float_reg) @@ -133,7 +133,7 @@ static inline void _do_fp_ctx_save(int flags, void *preemp_float_reg) * This routine initializes the system's "live" non-integer context. * Function is invoked by _FpCtxInit(tCCS *ccs) * - * RETURNS: N/A + * @return N/A */ static inline void _do_fp_ctx_init(int flags) diff --git a/arch/x86/include/nano_private.h b/arch/x86/include/nano_private.h index 28f43317510..96e3149759c 100644 --- a/arch/x86/include/nano_private.h +++ b/arch/x86/include/nano_private.h @@ -768,7 +768,7 @@ extern tNANO _nanokernel; * Trivial stuff is done inline; more complex initialization is done via * function calls. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -817,7 +817,7 @@ static inline void nanoArchInit(void) * set to . It is assumed that the specified is pending, and * thus the fibers context is stored in its tCCS structure. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/arch/x86/quark/board.h b/arch/x86/quark/board.h index d1bd1a6538c..e567281114b 100644 --- a/arch/x86/quark/board.h +++ b/arch/x86/quark/board.h @@ -156,7 +156,7 @@ the 'Quark' BSP. * * outByte - output byte to memory location * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -173,7 +173,7 @@ static inline void outByte(uint8_t data, uint32_t addr) * This function issues the 'move' instruction to read a byte from the specified * memory address. * - * RETURNS: the byte read from the specified memory address + * @return the byte read from the specified memory address * * NOMANUAL */ @@ -198,7 +198,7 @@ static inline uint8_t inByte(uint32_t addr) * * outWord - output word to memory location * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -215,7 +215,7 @@ static inline void outWord(uint16_t data, uint32_t addr) * This function issues the 'move' instruction to read a word from the specified * memory address. * - * RETURNS: the word read from the specified memory address + * @return the word read from the specified memory address * * NOMANUAL */ @@ -240,7 +240,7 @@ static inline uint16_t inWord(uint32_t addr) * * outLong - output long word to memory location * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -257,7 +257,7 @@ static inline void outLong(uint32_t data, uint32_t addr) * This function issues the 'move' instruction to read a word from the specified * memory address. * - * RETURNS: the long word read from the specified memory address + * @return the long word read from the specified memory address * * NOMANUAL */ @@ -278,7 +278,7 @@ static inline uint32_t inLong(uint32_t addr) * INTC (pin 3) -> IRQ 18 * INTD (pin 4) -> IRQ 19 * - * RETURNS: IRQ number, -1 if the result is incorrect + * @return IRQ number, -1 if the result is incorrect * */ @@ -293,7 +293,7 @@ static inline int pci_pin2irq(int pin) * * pci_irq2pin - convert IRQ to PCI interrupt pin * - * RETURNS: pin number, -1 if the result is incorrect + * @return pin number, -1 if the result is incorrect * */ diff --git a/arch/x86/quark/system.c b/arch/x86/quark/system.c index 82489e66181..66249a24671 100644 --- a/arch/x86/quark/system.c +++ b/arch/x86/quark/system.c @@ -59,7 +59,7 @@ Handlers for the secondary serial port have not been added. * * uart_generic_info_init - initialize initialization information for one UART * - * RETURNS: N/A + * @return N/A * */ @@ -80,7 +80,7 @@ void uart_generic_info_init(struct uart_init_info *p_info) * * Only used for debugging. * - * RETURNS: N/A + * @return N/A * */ @@ -109,7 +109,7 @@ static void consoleInit(void) * Intel 8250 UART device driver. * Also initialize the timer device driver, if required. * - * RETURNS: N/A + * @return N/A */ void _InitHardware(void) diff --git a/arch/x86/sys_fatal_error_handler.c b/arch/x86/sys_fatal_error_handler.c index 5211439494b..8b6b5627386 100644 --- a/arch/x86/sys_fatal_error_handler.c +++ b/arch/x86/sys_fatal_error_handler.c @@ -62,7 +62,7 @@ supported BSPs. * implementation to take other actions, such as logging error (or debug) * information to a persistent repository and/or rebooting the system. * - * RETURNS: This function does not return. + * @return This function does not return. * * \NOMANUAL */ diff --git a/arch/x86/task/strtask.c b/arch/x86/task/strtask.c index 6da2eb26b9d..94c5d934563 100644 --- a/arch/x86/task/strtask.c +++ b/arch/x86/task/strtask.c @@ -55,7 +55,7 @@ Intel-specific parts of start_task(). Only FP functionality currently. * * _StartTaskArch - Intel-specifc parts of task initialization * - * RETURNS: N/A + * @return N/A */ void _StartTaskArch( diff --git a/drivers/console/uart_console.c b/drivers/console/uart_console.c index 0b26ebb5f99..7791feeb715 100644 --- a/drivers/console/uart_console.c +++ b/drivers/console/uart_console.c @@ -60,7 +60,7 @@ * * consoleIn - get a character from UART * - * RETURNS: the character or EOF if nothing present + * @return the character or EOF if nothing present */ static int consoleIn(void) @@ -80,7 +80,7 @@ static int consoleIn(void) * * Outputs both line feed and carriage return in the case of a '\n'. * - * RETURNS: The character passed as input. + * @return The character passed as input. */ static int consoleOut(int c /* character to output */ @@ -213,7 +213,7 @@ void uart_register_input(struct nano_fifo *avail, struct nano_fifo *lines) * * uart_console_init - initialize one UART as the console/debug port * - * RETURNS: N/A + * @return N/A */ void uart_console_init(void) diff --git a/drivers/interrupt_controller/arcv2_irq_unit.c b/drivers/interrupt_controller/arcv2_irq_unit.c index dc062c8de0e..2ca2cef2fd7 100644 --- a/drivers/interrupt_controller/arcv2_irq_unit.c +++ b/drivers/interrupt_controller/arcv2_irq_unit.c @@ -53,7 +53,7 @@ * the window between a write to IRQ_SELECT and subsequent writes to the * selected IRQ's registers. * - * RETURNS: N/A + * @return N/A */ void _arc_v2_irq_unit_init(void) @@ -77,7 +77,7 @@ void _arc_v2_irq_unit_init(void) * Interrupts must be locked or the ISR operating at P0 when invoking this * function. * - * RETURNS: N/A + * @return N/A */ void _arc_v2_irq_unit_int_eoi(int irq) @@ -93,7 +93,7 @@ void _arc_v2_irq_unit_int_eoi(int irq) * edge of the signal. Valid values for are _ARC_V2_INT_LEVEL and * _ARC_V2_INT_PULSE. * - * RETURNS: N/A + * @return N/A */ void _arc_v2_irq_unit_trigger_set(int irq, unsigned int trigger) diff --git a/drivers/interrupt_controller/i8259.c b/drivers/interrupt_controller/i8259.c index 7cc1539f1db..2e58f8da1a8 100644 --- a/drivers/interrupt_controller/i8259.c +++ b/drivers/interrupt_controller/i8259.c @@ -123,7 +123,7 @@ FUNC_ALIAS(_i8259_irq_disable, irq_disable, void); * This routine initializes the Intel 8259A PIC device driver and the device * itself. * - * RETURNS: N/A + * @return N/A */ void _i8259_init(void) @@ -191,7 +191,7 @@ void _i8259_init(void) * * This routine is called at the end of the interrupt handler. * - * RETURNS: N/A + * @return N/A * * ERRNO */ @@ -214,7 +214,7 @@ void _i8259_eoi_master(unsigned int irq /* IRQ number to * This routine is called at the end of the interrupt handler in the Normal * Fully Nested Mode. * - * RETURNS: N/A + * @return N/A * * ERRNO */ @@ -251,7 +251,7 @@ void _i8259_eoi_slave(unsigned int irq /* IRQ number to * This function is called by _i8259_irq_enable() and _i8259_irq_disable() to * perform the actual enabling/disabling of an IRQ to minimize footprint. * - * RETURNS: N/A + * @return N/A * * see also: _i8259_irq_disable()/_i8259_irq_enable */ @@ -296,7 +296,7 @@ static void __I8259IntEnable( * * This routine disables a specified PIC interrupt input line. * - * RETURNS: N/A + * @return N/A * * SEE ALSO: _i8259_irq_enable() */ @@ -313,7 +313,7 @@ void _i8259_irq_disable(unsigned int irq /* IRQ number to disable */ * * This routine enables a specified PIC interrupt input line. * - * RETURNS: N/A + * @return N/A * * SEE ALSO: _i8259_irq_disable() */ diff --git a/drivers/interrupt_controller/i8259_boi.S b/drivers/interrupt_controller/i8259_boi.S index e5f4b04f7f3..7726b08875b 100644 --- a/drivers/interrupt_controller/i8259_boi.S +++ b/drivers/interrupt_controller/i8259_boi.S @@ -71,7 +71,7 @@ a real IRQ has been inserted. * * void _i8259_boi_master (void) * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _i8259_boi_master) @@ -105,7 +105,7 @@ SECTION_FUNC(TEXT, _i8259_boi_master) * * void _i8259_boi_slave (void) * - * RETURNS: N/A + * @return N/A */ SECTION_FUNC(TEXT, _i8259_boi_slave) diff --git a/drivers/interrupt_controller/ioapic_intr.c b/drivers/interrupt_controller/ioapic_intr.c index 0bc97a69119..3e73c742469 100644 --- a/drivers/interrupt_controller/ioapic_intr.c +++ b/drivers/interrupt_controller/ioapic_intr.c @@ -215,7 +215,7 @@ static void _IoApicRedUpdateLo(unsigned int irq, uint32_t value, * * This routine initializes the IO APIC or xAPIC. * - * RETURNS: N/A + * @return N/A */ void _ioapic_init(void) @@ -267,7 +267,7 @@ void _ioapic_init(void) * * This routine sends an EOI signal to the IO APIC's interrupting source. * - * RETURNS: N/A + * @return N/A */ void _ioapic_eoi(unsigned int irq /* INT number to send EOI */ @@ -283,7 +283,7 @@ void _ioapic_eoi(unsigned int irq /* INT number to send EOI */ * * This routine returns EOI signalling information for a specific IRQ. * - * RETURNS: address of routine to be called to signal EOI; + * @return address of routine to be called to signal EOI; * as a side effect, also passes back indication if routine requires * an interrupt vector argument and what the argument value should be */ @@ -323,7 +323,7 @@ void *_ioapic_eoi_get(unsigned int irq, /* INTIN number of interest */ * * This routine enables a specified APIC interrupt input line. * - * RETURNS: N/A + * @return N/A */ void _ioapic_irq_enable(unsigned int irq /* INTIN number to enable */ @@ -338,7 +338,7 @@ void _ioapic_irq_enable(unsigned int irq /* INTIN number to enable */ * * This routine disables a specified APIC interrupt input line. * - * RETURNS: N/A + * @return N/A */ void _ioapic_irq_disable(unsigned int irq /* INTIN number to disable */ @@ -353,7 +353,7 @@ void _ioapic_irq_disable(unsigned int irq /* INTIN number to disable */ * * This routine sets up the redirection table entry for the specified IRQ * - * RETURNS: N/A + * @return N/A */ void _ioapic_irq_set(unsigned int irq, /* virtualized IRQ */ unsigned int vector, /* vector number */ @@ -375,7 +375,7 @@ void _ioapic_irq_set(unsigned int irq, /* virtualized IRQ */ * The routine writes the interrupt vector in the Interrupt Redirection * Table for specified irq number * - * RETURNS: N/A + * @return N/A */ void _ioapic_int_vec_set(unsigned int irq, /* INT number */ unsigned int vector /* vector number */ @@ -392,7 +392,7 @@ void _ioapic_int_vec_set(unsigned int irq, /* INT number */ * * This routine reads the specified IO APIC register using indirect addressing. * - * RETURNS: register value + * @return register value */ static uint32_t __IoApicGet( @@ -420,7 +420,7 @@ static uint32_t __IoApicGet( * * This routine writes the specified IO APIC register using indirect addressing. * - * RETURNS: N/A + * @return N/A */ static void __IoApicSet( @@ -448,7 +448,7 @@ static void __IoApicSet( * * This routine reads the low-order 32 bits of a Redirection Table entry. * - * RETURNS: 32 low-order bits + * @return 32 low-order bits */ static uint32_t ioApicRedGetLo(unsigned int irq /* INTIN number */ @@ -474,7 +474,7 @@ static uint32_t ioApicRedGetLo(unsigned int irq /* INTIN number */ * * This routine writes the low-order 32 bits of a Redirection Table entry. * - * RETURNS: N/A + * @return N/A */ static void ioApicRedSetLo(unsigned int irq, /* INTIN number */ @@ -501,7 +501,7 @@ static void ioApicRedSetLo(unsigned int irq, /* INTIN number */ * * This routine writes the high-order 32 bits of a Redirection Table entry. * - * RETURNS: N/A + * @return N/A */ static void ioApicRedSetHi(unsigned int irq, /* INTIN number */ @@ -529,7 +529,7 @@ static void ioApicRedSetHi(unsigned int irq, /* INTIN number */ * This routine modifies selected portions of the low-order 32 bits of a * Redirection Table entry, as indicated by the associate bit mask. * - * RETURNS: N/A + * @return N/A */ static void _IoApicRedUpdateLo( @@ -555,7 +555,7 @@ static void _IoApicRedUpdateLo( * This routine writes the specified 32-bit into the RTE configuration * register for the specified (0 to (IOAPIC_NUM_RTES - 1)) * - * RETURNS: void + * @return void */ static void _IoApicRteConfigSet(unsigned int irq, /* INTIN number */ @@ -583,7 +583,7 @@ static void _IoApicRteConfigSet(unsigned int irq, /* INTIN number */ * This routine writes the 32-bit into the redirection register * specified by . * - * RETURNS: void + * @return void */ static void _IoApicRedirRegSet(unsigned int reg, uint32_t value) diff --git a/drivers/interrupt_controller/loapic_intr.c b/drivers/interrupt_controller/loapic_intr.c index ae724fdc44b..5460e5cb148 100644 --- a/drivers/interrupt_controller/loapic_intr.c +++ b/drivers/interrupt_controller/loapic_intr.c @@ -204,7 +204,7 @@ INCLUDE FILES: loapic.h * * This routine initializes Local APIC or xAPIC. * - * RETURNS: N/A + * @return N/A * */ @@ -266,7 +266,7 @@ void _loapic_init(void) * * This routine enables the Local xAPIC. * - * RETURNS: N/A + * @return N/A */ void _loapic_enable(void) @@ -284,7 +284,7 @@ void _loapic_enable(void) * * This routine disables the Local xAPIC. * - * RETURNS: N/A + * @return N/A */ void _loapic_disable(void) @@ -302,7 +302,7 @@ void _loapic_disable(void) * * This routine sends an EOI signal to the Local APIC's interrupting source. * - * RETURNS: N/A + * @return N/A */ void _loapic_eoi(unsigned int irq) @@ -320,7 +320,7 @@ void _loapic_eoi(unsigned int irq) * a vector has been allocated, this routine is invoked to update the LVT * entry associated with with the vector. * - * RETURNS: N/A + * @return N/A */ void _loapic_int_vec_set(unsigned int irq, /* IRQ number of the @@ -360,7 +360,7 @@ void _loapic_int_vec_set(unsigned int irq, /* IRQ number of the * * This routine clears the interrupt mask bit in the LVT for the specified IRQ * - * RETURNS: N/A + * @return N/A */ void _loapic_irq_enable(unsigned int irq /* IRQ number of @@ -390,7 +390,7 @@ void _loapic_irq_enable(unsigned int irq /* IRQ number of * * This routine clears the interrupt mask bit in the LVT for the specified IRQ * - * RETURNS: N/A + * @return N/A */ void _loapic_irq_disable(unsigned int irq /* IRQ number of the diff --git a/drivers/interrupt_controller/system_apic.c b/drivers/interrupt_controller/system_apic.c index aab8ec8bbb0..5c357f8a8e4 100644 --- a/drivers/interrupt_controller/system_apic.c +++ b/drivers/interrupt_controller/system_apic.c @@ -81,7 +81,7 @@ for the atom_n28xx variant of generic_pc BSP. * The IOAPIC_NUM_RTES macro is provided by board.h, and it specifies the number * of IRQs supported by the on-board I/O APIC device. * - * RETURNS: the allocated interrupt vector + * @return the allocated interrupt vector * * INTERNAL * For debug kernels, this routine will return -1 if there are no vectors @@ -219,7 +219,7 @@ void _SysIntVecProgram(unsigned int vector, /* vector number */ * IRQ virtualization that is performed by this BSP. See the comments * in _SysIntVecAlloc() for more information regarding IRQ virtualization. * - * RETURNS: N/A + * @return N/A */ void irq_enable(unsigned int irq) @@ -239,7 +239,7 @@ void irq_enable(unsigned int irq) * IRQ virtualization that is performed by this BSP. See the comments * in _SysIntVecAlloc() for more information regarding IRQ virtualization. * - * RETURNS: N/A + * @return N/A */ void irq_disable(unsigned int irq) diff --git a/drivers/interrupt_controller/system_pic.c b/drivers/interrupt_controller/system_pic.c index b7cba127794..72e5e4c23aa 100644 --- a/drivers/interrupt_controller/system_pic.c +++ b/drivers/interrupt_controller/system_pic.c @@ -67,7 +67,7 @@ IRQ_CONNECT_STATIC(pic_slave, PIC_SLAVE_STRAY_INT_LVL, 0, _i8259_boi_slave, 0); * - IRQ0 to IRQ7 are provided by the master i8259 PIC * - IRQ8 to IRQ15 are provided by the slave i8259 PIC * - * RETURNS: the allocated interrupt vector + * @return the allocated interrupt vector * * INTERNAL * For debug kernels, this routine will return -1 for invalid or diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c index 5e763052199..43a9e54d897 100644 --- a/drivers/pci/pci.c +++ b/drivers/pci/pci.c @@ -171,7 +171,7 @@ static struct lookup_data __noinit lookup; * * pci_get_bar_config - return the configuration for the specified BAR * - * RETURNS: 0 if BAR is implemented, -1 if not. + * @return 0 if BAR is implemented, -1 if not. */ static inline int pci_bar_config_get(union pci_addr_reg pci_ctrl_addr, @@ -216,7 +216,7 @@ static inline int pci_bar_config_get(union pci_addr_reg pci_ctrl_addr, * * pci_bar_params_get - retrieve the I/O address and IRQ of the specified BAR * - * RETURNS: -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved + * @return -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved * * NOTE: Routine does not set up parameters for 64 bit BARS, they are ignored. * @@ -267,7 +267,7 @@ static inline int pci_bar_params_get(union pci_addr_reg pci_ctrl_addr, * * pci_dev_scan - scan the specified PCI device for all sub functions * - * RETURNS: 1 if a device has been found, 0 otherwise. + * @return 1 if a device has been found, 0 otherwise. * * \NOMANUAL */ @@ -382,7 +382,7 @@ void pci_bus_scan_init(void) * given dev_info at first call. Which criterias can be class and/or * vendor_id/device_id. * - * RETURNS: 1 on success, 0 otherwise. On success, dev_info is filled in with + * @return 1 on success, 0 otherwise. On success, dev_info is filled in with * currently found device information * * \NOMANUAL @@ -434,7 +434,7 @@ int pci_bus_scan(struct pci_dev_info *dev_info) * * Shows the PCI device found provided as parameter. * - * RETURNS: N/A + * @return N/A */ void pci_show(struct pci_dev_info *dev_info) diff --git a/drivers/pci/pci_config.c b/drivers/pci/pci_config.c index 2d46dcc7b3d..c859d680e78 100644 --- a/drivers/pci/pci_config.c +++ b/drivers/pci/pci_config.c @@ -62,7 +62,7 @@ This module implements the PCI config space access functions * @param offset Offset into the configuration space. * @param data Data written to the offset. * - * RETURNS: N/A + * @return N/A */ void pci_config_out_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no, uint32_t offset, uint32_t data) @@ -92,7 +92,7 @@ void pci_config_out_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no, * @param offset Offset into the configuration space. * @param data Data written to the offset. * - * RETURNS: N/A + * @return N/A */ void pci_config_out_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no, uint32_t offset, uint16_t data) @@ -122,7 +122,7 @@ void pci_config_out_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no, * @param offset Offset into the configuration space. * @param data Data written to the offset. * - * RETURNS: N/A + * @return N/A */ void pci_config_out_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no, uint32_t offset, uint8_t data) @@ -152,7 +152,7 @@ void pci_config_out_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no, * @param offset Offset into the configuration space. * @param data Data read from the offset. * - * RETURNS: N/A + * @return N/A * */ void pci_config_in_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no, @@ -183,7 +183,7 @@ void pci_config_in_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no, * @param offset Offset into the configuration space. * @param data Data read from the offset. * - * RETURNS: N/A + * @return N/A * */ @@ -220,7 +220,7 @@ void pci_config_in_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no, * @param offset Offset into the configuration space. * @param data Data read from the offset. * - * RETURNS: N/A + * @return N/A * */ @@ -261,7 +261,7 @@ void pci_config_in_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no, * @param function PCI function number. * @param p_offset Returned config space offset. * - * RETURNS: 0 if Extended Capability found, -1 otherwise + * @return 0 if Extended Capability found, -1 otherwise * */ diff --git a/drivers/pci/pci_interface.c b/drivers/pci/pci_interface.c index 97430de6e3a..4af32526546 100644 --- a/drivers/pci/pci_interface.c +++ b/drivers/pci/pci_interface.c @@ -59,7 +59,7 @@ This module implements the PCI H/W access functions. * This routine reads the specified register from the PCI controller and * places the data into the provided buffer. * - * RETURNS: N/A + * @return N/A * */ @@ -93,7 +93,7 @@ static void pci_ctrl_read(uint32_t reg, /* PCI register to read */ * This routine writes the provided data to the specified register in the PCI * controller. * - * RETURNS: N/A + * @return N/A * */ @@ -127,7 +127,7 @@ static void pci_ctrl_write(uint32_t reg, /* PCI register to write */ * * This routine reads the data register of the specified PCI controller. * - * RETURNS: 0 or -1 + * @return 0 or -1 * */ @@ -154,7 +154,7 @@ static int pci_ctrl_data_read(uint32_t controller, /* controller number */ * This routine writes the provided data to the data register of the * specified PCI controller. * - * RETURNS: 0 or -1 + * @return 0 or -1 * */ @@ -181,7 +181,7 @@ static int pci_ctrl_data_write(uint32_t controller, /* controller number */ * This routine writes the provided data to the address register of the * specified PCI controller. * - * RETURNS: 0 or -1 + * @return 0 or -1 * */ @@ -243,7 +243,7 @@ static int pci_ctrl_addr_write(uint32_t controller, /* controller number */ * Reading of PCI data must be performed as an atomic operation. It is up to * the caller to enforce this. * - * RETURNS: N/A + * @return N/A * */ @@ -333,7 +333,7 @@ void pci_read(uint32_t controller, /* PCI controller to use */ * the caller to enforce this. * * - * RETURNS: N/A + * @return N/A * */ @@ -386,7 +386,7 @@ void pci_write(uint32_t controller, /* controller to use */ * This routine reads the PCI header for the specified device and puts the * result in the supplied header structure. * - * RETURNS: N/A + * @return N/A */ void pci_header_get(uint32_t controller, diff --git a/drivers/random/rand32-timer.c b/drivers/random/rand32-timer.c index f0adc5e5db3..18672d757c1 100644 --- a/drivers/random/rand32-timer.c +++ b/drivers/random/rand32-timer.c @@ -61,7 +61,7 @@ static atomic_val_t _rand32_counter = 0; * This routine is automatically invoked by the kernel during system * initialization. * - * RETURNS: N/A + * @return N/A */ @@ -77,7 +77,7 @@ void sys_rand32_init(void) * target's clock counter, which means that successive calls will return * different values. * - * RETURNS: a 32-bit number + * @return a 32-bit number */ uint32_t sys_rand32_get(void) diff --git a/drivers/random/rand32-timestamp.c b/drivers/random/rand32-timestamp.c index fdaa381a688..157d054bd07 100644 --- a/drivers/random/rand32-timestamp.c +++ b/drivers/random/rand32-timestamp.c @@ -49,7 +49,7 @@ number generator. * The non-random number generator does not require any initialization. * Routine is automatically invoked by the kernel during system startup. * - * RETURNS: N/A + * @return N/A */ void sys_rand32_init(void) @@ -64,7 +64,7 @@ void sys_rand32_init(void) * CPU's timestamp counter, which means that successive calls will normally * display ever-increasing values. * - * RETURNS: a 32-bit number + * @return a 32-bit number */ uint32_t sys_rand32_get(void) diff --git a/drivers/serial/k20UartDrv.c b/drivers/serial/k20UartDrv.c index e7af9b9711b..783abe8a298 100644 --- a/drivers/serial/k20UartDrv.c +++ b/drivers/serial/k20UartDrv.c @@ -66,7 +66,7 @@ UART_PORTS_CONFIGURE(_k20Uart_t, uart); * This routine is called to reset the chip in a quiescent state. * It is assumed that this function is called only once per UART. * - * RETURNS: N/A + * @return N/A */ void uart_init(int port, /* UART channel to initialize */ @@ -111,7 +111,7 @@ void uart_init(int port, /* UART channel to initialize */ * * uart_poll_in - poll the device for input. * - * RETURNS: 0 if a character arrived, -1 if the input buffer if empty. + * @return 0 if a character arrived, -1 if the input buffer if empty. */ int uart_poll_in(int port, /* UART channel to select for input */ @@ -139,7 +139,7 @@ int uart_poll_in(int port, /* UART channel to select for input */ * If the hardware flow control is enabled then the handshake signal CTS has to * be asserted in order to send a character. * - * RETURNS: sent character + * @return sent character */ unsigned char uart_poll_out( int port, /* UART channel to select for output */ @@ -163,7 +163,7 @@ unsigned char uart_poll_out( * * uart_fifo_fill - fill FIFO with data - * RETURNS: number of bytes sent + * @return number of bytes sent */ int uart_fifo_fill(int port, /* UART on port to send */ @@ -185,7 +185,7 @@ int uart_fifo_fill(int port, /* UART on port to send */ * * uart_fifo_read - read data from FIFO * - * RETURNS: number of bytes read + * @return number of bytes read */ int uart_fifo_read(int port, /* UART to receive from */ @@ -207,7 +207,7 @@ int uart_fifo_read(int port, /* UART to receive from */ * * uart_irq_tx_enable - enable TX interrupt * - * RETURNS: N/A + * @return N/A */ void uart_irq_tx_enable(int port /* UART to enable Tx @@ -223,7 +223,7 @@ void uart_irq_tx_enable(int port /* UART to enable Tx * * uart_irq_tx_disable - disable TX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_tx_disable( @@ -239,7 +239,7 @@ void uart_irq_tx_disable( * * uart_irq_tx_ready - check if Tx IRQ has been raised * - * RETURNS: 1 if an IRQ is ready, 0 otherwise + * @return 1 if an IRQ is ready, 0 otherwise */ int uart_irq_tx_ready(int port /* UART to check */ @@ -254,7 +254,7 @@ int uart_irq_tx_ready(int port /* UART to check */ * * uart_irq_rx_enable - enable RX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_rx_enable(int port /* UART to enable Rx @@ -270,7 +270,7 @@ void uart_irq_rx_enable(int port /* UART to enable Rx * * uart_irq_rx_disable - disable RX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_rx_disable( @@ -286,7 +286,7 @@ void uart_irq_rx_disable( * * uart_irq_rx_ready - check if Rx IRQ has been raised * - * RETURNS: 1 if an IRQ is ready, 0 otherwise + * @return 1 if an IRQ is ready, 0 otherwise */ int uart_irq_rx_ready(int port /* UART to check */ @@ -301,7 +301,7 @@ int uart_irq_rx_ready(int port /* UART to check */ * * uart_irq_err_enable - enable error interrupt * - * RETURNS: N/A + * @return N/A */ void uart_irq_err_enable(int port) @@ -320,7 +320,7 @@ void uart_irq_err_enable(int port) * * uart_irq_err_disable - disable error interrupt * - * RETURNS: N/A + * @return N/A */ void uart_irq_err_disable(int port /* UART to disable Rx interrupt */ @@ -340,7 +340,7 @@ void uart_irq_err_disable(int port /* UART to disable Rx interrupt */ * * uart_irq_is_pending - check if Tx or Rx IRQ is pending * - * RETURNS: 1 if a Tx or Rx IRQ is pending, 0 otherwise + * @return 1 if a Tx or Rx IRQ is pending, 0 otherwise */ int uart_irq_is_pending(int port /* UART to check */ @@ -359,7 +359,7 @@ int uart_irq_is_pending(int port /* UART to check */ * * uart_irq_update - update IRQ status * - * RETURNS: always 1 + * @return always 1 */ int uart_irq_update(int port) @@ -373,7 +373,7 @@ int uart_irq_update(int port) * * Returns the IRQ number used by the specified UART port * - * RETURNS: N/A + * @return N/A */ unsigned int uart_irq_get(int port /* UART port */ diff --git a/drivers/serial/ns16550.c b/drivers/serial/ns16550.c index cfdad555994..125fc3e084d 100644 --- a/drivers/serial/ns16550.c +++ b/drivers/serial/ns16550.c @@ -263,7 +263,7 @@ UART_PORTS_CONFIGURE(struct ns16550, uart); * * This routine is called to reset the chip in a quiescent state. * - * RETURNS: N/A + * @return N/A */ void uart_init(int port, /* UART channel to initialize */ @@ -314,7 +314,7 @@ void uart_init(int port, /* UART channel to initialize */ * * uart_poll_in - poll the device for input. * - * RETURNS: 0 if a character arrived, -1 if the input buffer if empty. + * @return 0 if a character arrived, -1 if the input buffer if empty. */ int uart_poll_in(int port, /* UART channel to select for input */ @@ -340,7 +340,7 @@ int uart_poll_in(int port, /* UART channel to select for input */ * If the hardware flow control is enabled then the handshake signal CTS has to * be asserted in order to send a character. * - * RETURNS: sent character + * @return sent character */ unsigned char uart_poll_out( int port, /* UART channel to select for output */ @@ -361,7 +361,7 @@ unsigned char uart_poll_out( * * uart_fifo_fill - fill FIFO with data * - * RETURNS: number of bytes sent + * @return number of bytes sent */ int uart_fifo_fill(int port, /* UART on port to send */ @@ -381,7 +381,7 @@ int uart_fifo_fill(int port, /* UART on port to send */ * * uart_fifo_read - read data from FIFO * - * RETURNS: number of bytes read + * @return number of bytes read */ int uart_fifo_read(int port, /* UART to receive from */ @@ -402,7 +402,7 @@ int uart_fifo_read(int port, /* UART to receive from */ * * uart_irq_tx_enable - enable TX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_tx_enable(int port /* UART to enable Tx @@ -416,7 +416,7 @@ void uart_irq_tx_enable(int port /* UART to enable Tx * * uart_irq_tx_disable - disable TX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_tx_disable(int port /* UART to disable Tx interrupt */ @@ -429,7 +429,7 @@ void uart_irq_tx_disable(int port /* UART to disable Tx interrupt */ * * uart_irq_tx_ready - check if Tx IRQ has been raised * - * RETURNS: N/A + * @return N/A */ int uart_irq_tx_ready(int port /* UART to check */ @@ -442,7 +442,7 @@ int uart_irq_tx_ready(int port /* UART to check */ * * _uart_irq_rx_enable - enable RX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_rx_enable(int port /* UART to enable Rx @@ -456,7 +456,7 @@ void uart_irq_rx_enable(int port /* UART to enable Rx * * uart_irq_rx_disable - disable RX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_rx_disable(int port /* UART to disable Rx interrupt */ @@ -469,7 +469,7 @@ void uart_irq_rx_disable(int port /* UART to disable Rx interrupt */ * * uart_irq_rx_ready - check if Rx IRQ has been raised * - * RETURNS: 1 if an IRQ is ready, 0 otherwise + * @return 1 if an IRQ is ready, 0 otherwise */ int uart_irq_rx_ready(int port /* UART to check */ @@ -482,7 +482,7 @@ int uart_irq_rx_ready(int port /* UART to check */ * * uart_irq_err_enable - enable error interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_err_enable(int port /* UART to enable Rx interrupt */ @@ -495,7 +495,7 @@ void uart_irq_err_enable(int port /* UART to enable Rx interrupt */ * * uart_irq_err_disable - disable error interrupt in IER * - * RETURNS: 1 if an IRQ is ready, 0 otherwise + * @return 1 if an IRQ is ready, 0 otherwise */ void uart_irq_err_disable(int port /* UART to disable Rx interrupt */ @@ -508,7 +508,7 @@ void uart_irq_err_disable(int port /* UART to disable Rx interrupt */ * * uart_irq_is_pending - check if any IRQ is pending * - * RETURNS: 1 if an IRQ is pending, 0 otherwise + * @return 1 if an IRQ is pending, 0 otherwise */ int uart_irq_is_pending(int port /* UART to check */ @@ -521,7 +521,7 @@ int uart_irq_is_pending(int port /* UART to check */ * * uart_irq_update - update cached contents of IIR * - * RETURNS: always 1 + * @return always 1 */ int uart_irq_update(int port /* UART to update */ @@ -538,7 +538,7 @@ int uart_irq_update(int port /* UART to update */ * * Returns the IRQ number used by the specified UART port * - * RETURNS: N/A + * @return N/A */ unsigned int uart_irq_get(int port /* UART port */ diff --git a/drivers/serial/stellarisUartDrv.c b/drivers/serial/stellarisUartDrv.c index 9dfe206cd4b..da99c71f4e9 100644 --- a/drivers/serial/stellarisUartDrv.c +++ b/drivers/serial/stellarisUartDrv.c @@ -159,7 +159,7 @@ UART_PORTS_CONFIGURE(struct _StellarisUartPort, ports); * * This routine set the given baud rate for the UART. * - * RETURNS: N/A + * @return N/A */ static void baudrateSet(int port, uint32_t baudrate, uint32_t sysClkFreqInHz) @@ -190,7 +190,7 @@ static void baudrateSet(int port, uint32_t baudrate, uint32_t sysClkFreqInHz) * * This routine enables the given UART. * - * RETURNS: N/A + * @return N/A */ static inline void enable(int port) @@ -206,7 +206,7 @@ static inline void enable(int port) * * This routine disables the given UART. * - * RETURNS: N/A + * @return N/A */ static inline void disable(int port) @@ -239,7 +239,7 @@ static inline void disable(int port) * * This routine sets the given UART's line controls to their default settings. * - * RETURNS: N/A + * @return N/A */ static inline void lineControlDefaultsSet(int port) @@ -256,7 +256,7 @@ static inline void lineControlDefaultsSet(int port) * This routine is called to reset the chip in a quiescent state. * It is assumed that this function is called only once per UART. * - * RETURNS: N/A + * @return N/A */ void uart_init(int port, /* UART channel to initialize */ const struct uart_init_info * const init_info @@ -276,7 +276,7 @@ void uart_init(int port, /* UART channel to initialize */ * * This routine returns the given UART's transmit ready status. * - * RETURNS: 0 if ready to transmit, 1 otherwise + * @return 0 if ready to transmit, 1 otherwise */ static int pollTxReady(int port) @@ -290,7 +290,7 @@ static int pollTxReady(int port) * * uart_poll_in - poll the device for input. * - * RETURNS: 0 if a character arrived, -1 if the input buffer if empty. + * @return 0 if a character arrived, -1 if the input buffer if empty. */ int uart_poll_in(int port, /* UART channel to select for input */ @@ -315,7 +315,7 @@ int uart_poll_in(int port, /* UART channel to select for input */ * Checks if the transmitter is empty. If empty, a character is written to * the data register. * - * RETURNS: sent character + * @return sent character */ unsigned char uart_poll_out(int port, unsigned char c) { @@ -335,7 +335,7 @@ unsigned char uart_poll_out(int port, unsigned char c) * * uart_fifo_fill - fill FIFO with data * - * RETURNS: number of bytes sent + * @return number of bytes sent */ int uart_fifo_fill(int port, /* UART on which to send */ @@ -357,7 +357,7 @@ int uart_fifo_fill(int port, /* UART on which to send */ * * uart_fifo_read - read data from FIFO * - * RETURNS: number of bytes read + * @return number of bytes read */ int uart_fifo_read(int port, /* UART to receive from */ @@ -379,7 +379,7 @@ int uart_fifo_read(int port, /* UART to receive from */ * * uart_irq_tx_enable - enable TX interrupt * - * RETURNS: N/A + * @return N/A */ void uart_irq_tx_enable(int port /* UART to enable Tx interrupt */ @@ -434,7 +434,7 @@ void uart_irq_tx_enable(int port /* UART to enable Tx interrupt */ * * uart_irq_tx_disable - disable TX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_tx_disable(int port /* UART to disable Tx interrupt */ @@ -449,7 +449,7 @@ void uart_irq_tx_disable(int port /* UART to disable Tx interrupt */ * * uart_irq_tx_ready - check if Tx IRQ has been raised * - * RETURNS: 1 if a Tx IRQ is pending, 0 otherwise + * @return 1 if a Tx IRQ is pending, 0 otherwise */ int uart_irq_tx_ready(int port /* UART to check */ @@ -464,7 +464,7 @@ int uart_irq_tx_ready(int port /* UART to check */ * * uart_irq_rx_enable - enable RX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_rx_enable(int port /* UART to enable Rx interrupt */ @@ -479,7 +479,7 @@ void uart_irq_rx_enable(int port /* UART to enable Rx interrupt */ * * uart_irq_rx_disable - disable RX interrupt in IER * - * RETURNS: N/A + * @return N/A */ void uart_irq_rx_disable(int port /* UART to disable Rx interrupt */ @@ -494,7 +494,7 @@ void uart_irq_rx_disable(int port /* UART to disable Rx interrupt */ * * uart_irq_rx_ready - check if Rx IRQ has been raised * - * RETURNS: 1 if an IRQ is ready, 0 otherwise + * @return 1 if an IRQ is ready, 0 otherwise */ int uart_irq_rx_ready(int port /* UART to check */ @@ -509,7 +509,7 @@ int uart_irq_rx_ready(int port /* UART to check */ * * uart_irq_err_enable - enable error interrupts * - * RETURNS: N/A + * @return N/A */ void uart_irq_err_enable(int port /* UART to enable interrupts for */ @@ -525,7 +525,7 @@ void uart_irq_err_enable(int port /* UART to enable interrupts for */ * * uart_irq_err_disable - disable error interrupts * - * RETURNS: N/A + * @return N/A */ void uart_irq_err_disable(int port /* UART to disable interrupts for */ @@ -541,7 +541,7 @@ void uart_irq_err_disable(int port /* UART to disable interrupts for */ * * uart_irq_is_pending - check if Tx or Rx IRQ is pending * - * RETURNS: 1 if a Tx or Rx IRQ is pending, 0 otherwise + * @return 1 if a Tx or Rx IRQ is pending, 0 otherwise */ int uart_irq_is_pending(int port /* UART to check */ @@ -557,7 +557,7 @@ int uart_irq_is_pending(int port /* UART to check */ * * uart_irq_update - update IRQ status * - * RETURNS: always 1 + * @return always 1 */ int uart_irq_update(int port) @@ -571,7 +571,7 @@ int uart_irq_update(int port) * * Returns the IRQ number used by the specified UART port * - * RETURNS: N/A + * @return N/A */ unsigned int uart_irq_get(int port /* UART port */ diff --git a/drivers/timer/arcv2_timer0.c b/drivers/timer/arcv2_timer0.c index 8752c0ac2cd..e1661244278 100644 --- a/drivers/timer/arcv2_timer0.c +++ b/drivers/timer/arcv2_timer0.c @@ -77,7 +77,7 @@ static uint32_t clock_accumulated_count = 0; * - setting the timer's start value to zero; and * - enabling interrupt generation. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -102,7 +102,7 @@ static ALWAYS_INLINE void enable( * This routine gets the value from the timer's count register. This * value is the 'time' elapsed from the starting count (assumed to be 0). * - * RETURNS: the current counter value + * @return the current counter value * * \NOMANUAL */ @@ -118,7 +118,7 @@ static ALWAYS_INLINE uint32_t count_get(void) * This routine gets the value from the timer's limit register, which is the * value to which the timer will count up to. * - * RETURNS: the limit value + * @return the limit value * * \NOMANUAL */ @@ -134,7 +134,7 @@ static ALWAYS_INLINE uint32_t limit_get(void) * This routine handles the system clock periodic tick interrupt. A TICK_EVENT * event is pushed onto the microkernel stack. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -160,7 +160,7 @@ void _timer_int_handler(void *unused) * This routine is used to program the ARCv2 timer to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. * - * RETURNS: N/A + * @return N/A */ void timer_driver( @@ -195,7 +195,7 @@ void timer_driver( * * This routine returns the current time in terms of timer hardware clock cycles. * - * RETURNS: up counter of elapsed clock cycles + * @return up counter of elapsed clock cycles */ uint32_t timer_read(void) @@ -211,7 +211,7 @@ uint32_t timer_read(void) * This routine disables timer interrupt generation and delivery. * Note that the timer's counting cannot be stopped by software. * - * RETURNS: N/A + * @return N/A */ void timer_disable(void) diff --git a/drivers/timer/cortex_m_timer.c b/drivers/timer/cortex_m_timer.c index be7ffef4abf..84a6d5e0f66 100644 --- a/drivers/timer/cortex_m_timer.c +++ b/drivers/timer/cortex_m_timer.c @@ -133,7 +133,7 @@ static unsigned char idle_mode = IDLE_NOT_TICKLESS; * * This routine disables the systick counter. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -162,7 +162,7 @@ static ALWAYS_INLINE void sysTickStop(void) * * This routine enables the systick counter. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -191,7 +191,7 @@ static ALWAYS_INLINE void sysTickStart(void) * value is the 'time' remaining to decrement before the timer triggers an * interrupt. * - * RETURNS: the current counter value + * @return the current counter value * * \NOMANUAL */ @@ -206,7 +206,7 @@ static ALWAYS_INLINE uint32_t sysTickCurrentGet(void) * * This routine returns the value from the reload value register. * - * RETURNS: the counter's initial count/wraparound value + * @return the counter's initial count/wraparound value * * \NOMANUAL */ @@ -225,7 +225,7 @@ static ALWAYS_INLINE uint32_t sysTickReloadGet(void) * sets the timer's current value register to zero. * Note that the value given is assumed to be valid (i.e., count < (1<<24)). * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -254,7 +254,7 @@ static ALWAYS_INLINE void sysTickReloadSet( * The symbol for this routine is either _timer_int_handler (for normal * system operation) or _real_timer_int_handler (when GDB_INFO is enabled). * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -390,7 +390,7 @@ void _TIMER_INT_HANDLER(void *unused) * Conversely, the smaller the value (the higher the tick frequency), the * more elapsed ticks during a "tickless idle". * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -467,7 +467,7 @@ static void sysTickTicklessIdleInit(void) * ticks supplied or the maximum number of ticks that can be programmed into * hardware. A value of -1 will result in the maximum number of ticks. * - * RETURNS: N/A + * @return N/A */ void _timer_idle_enter(int32_t ticks /* system ticks */ @@ -526,7 +526,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ * ticker has done its work and consumed all the ticks. This has to be true * otherwise idle mode wouldn't have been entered in the first place. * - * RETURNS: N/A + * @return N/A */ void _timer_idle_exit(void) @@ -613,7 +613,7 @@ void _timer_idle_exit(void) * This routine is used to program the systick to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. * - * RETURNS: N/A + * @return N/A */ void timer_driver(int priority /* priority parameter is ignored by this driver */ @@ -654,7 +654,7 @@ void timer_driver(int priority /* priority parameter is ignored by this driver * Some kernel facilities (e.g. benchmarking code) directly call timer_read() * instead of utilizing the 'timer_read_fptr' function pointer. * - * RETURNS: up counter of elapsed clock cycles + * @return up counter of elapsed clock cycles * * \INTERNAL WARNING * systick counter is a 24-bit down counter which is reset to "reload" value @@ -675,7 +675,7 @@ uint32_t timer_read(void) * This routine disables the systick so that timer interrupts are no * longer delivered. * - * RETURNS: N/A + * @return N/A */ void timer_disable(void) diff --git a/drivers/timer/hpet.c b/drivers/timer/hpet.c index dc5d74ab170..3d363e016cb 100644 --- a/drivers/timer/hpet.c +++ b/drivers/timer/hpet.c @@ -228,7 +228,7 @@ static int stale_irq_check = * of the counter is read twice to ensure it doesn't change while the least * significant word is being retrieved (as per HPET documentation). * - * RETURNS: current 64-bit counter value + * @return current 64-bit counter value * * \NOMANUAL */ @@ -255,7 +255,7 @@ static uint64_t _hpetMainCounterAtomic(void) * This routine handles the system clock tick interrupt. A TICK_EVENT event * is pushed onto the microkernel stack. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -356,7 +356,7 @@ void _timer_int_handler(void *unused) * Re-program the timer to enter into the idle state for the given number of * ticks (-1 means infinite number of ticks). * - * RETURNS: N/A + * @return N/A * * \INTERNAL IMPLEMENTATION DETAILS * Called while interrupts are locked. @@ -389,7 +389,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ * ticker has done its work and consumed all the ticks. This has to be true * otherwise idle mode wouldn't have been entered in the first place. * - * RETURNS: N/A + * @return N/A * * \INTERNAL IMPLEMENTATION DETAILS * Called by _IntEnt() while interrupts are locked. @@ -494,7 +494,7 @@ void _timer_idle_exit(void) * This routine is used to program the HPET to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. * - * RETURNS: N/A + * @return N/A */ void timer_driver(int priority /* priority parameter is ignored by this driver @@ -626,7 +626,7 @@ void timer_driver(int priority /* priority parameter is ignored by this driver * * This routine returns the current time in terms of timer hardware clock cycles. * - * RETURNS: up counter of elapsed clock cycles + * @return up counter of elapsed clock cycles * * \INTERNAL WARNING * If this routine is ever enhanced to return all 64 bits of the counter @@ -647,7 +647,7 @@ uint32_t timer_read(void) * This routine disables the HPET so that timer interrupts are no * longer delivered. * - * RETURNS: N/A + * @return N/A */ void timer_disable(void) diff --git a/drivers/timer/i8253.c b/drivers/timer/i8253.c index 0a4052ab020..677a26effac 100644 --- a/drivers/timer/i8253.c +++ b/drivers/timer/i8253.c @@ -148,7 +148,7 @@ extern struct nano_stack _k_command_stack; * * This routine reads the 16 bit value from the i8253 counter register. * - * RETURNS: counter register's 16 bit value + * @return counter register's 16 bit value * * \NOMANUAL */ @@ -176,7 +176,7 @@ static inline uint16_t _i8253CounterRead(void) * This routine sets the 16 bit value from which the i8253 timer will * decrement and sets that counter register to its value. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -198,7 +198,7 @@ static inline void _i8253CounterSet( * * This routine sets the i8253 to fire on a periodic basis. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -218,7 +218,7 @@ static inline void _i8253CounterPeriodic( * * This routine sets the i8253 to fire once only. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -239,7 +239,7 @@ static inline void _i8253CounterOneShot( * This routine handles the system clock periodic tick interrupt. A TICK_EVENT * event is pushed onto the microkernel stack. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -316,7 +316,7 @@ void _timer_int_handler(void *unusedArg /* not used */ * value (the higher the tick frequency), the more elapsed ticks during a * "tickless idle". * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -332,7 +332,7 @@ static void _i8253TicklessIdleInit(void) * * _i8253TicklessIdleSkew - * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -413,7 +413,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ * * Called in _IntEnt() * - * RETURNS: N/A + * @return N/A */ void _timer_idle_exit(void) @@ -473,7 +473,7 @@ void _timer_idle_exit(void) * This routine is used to program the PIT to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. * - * RETURNS: N/A + * @return N/A */ void timer_driver(int priority /* priority parameter ignored by this driver */ @@ -507,7 +507,7 @@ void timer_driver(int priority /* priority parameter ignored by this driver */ * * This routine returns the current time in terms of timer hardware clock cycles. * - * RETURNS: up counter of elapsed clock cycles + * @return up counter of elapsed clock cycles */ uint32_t timer_read(void) @@ -563,7 +563,7 @@ uint32_t timer_read(void) * This routine simply disables the PIT counter such that interrupts are no * longer delivered. * - * RETURNS: N/A + * @return N/A */ void timer_disable(void) diff --git a/drivers/timer/loapic_timer.c b/drivers/timer/loapic_timer.c index 58dc39bb288..2f46fba84a7 100644 --- a/drivers/timer/loapic_timer.c +++ b/drivers/timer/loapic_timer.c @@ -138,7 +138,7 @@ extern struct nano_stack _k_command_stack; * * This routine sets the timer for periodic mode. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -157,7 +157,7 @@ static inline void _loApicTimerPeriodic(void) * * This routine stops the timer. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -176,7 +176,7 @@ static inline void _loApicTimerStop(void) * * This routine starts the timer. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -193,7 +193,7 @@ static inline void _loApicTimerStart(void) * * This routine sets value from which the timer will count down. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -212,7 +212,7 @@ static inline void _loApicTimerSetCount( * * This routine sets the timer for one shot mode. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -230,7 +230,7 @@ static inline void _loApicTimerOneShot(void) * This routine sets rate at which the timer is decremented to match the * external bus frequency. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -248,7 +248,7 @@ static inline void _loApicTimerSetDivider(void) * value is the 'time' remaining to decrement before the timer triggers an * interrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -264,7 +264,7 @@ static inline uint32_t _loApicTimerGetRemaining(void) * * This routine gets the value from the initial count register. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -281,7 +281,7 @@ static inline uint32_t _loApicTimerGetCount(void) * This routine handles the system clock tick interrupt. A TICK_EVENT event * is pushed onto the microkernel stack. * - * RETURNS: N/A + * @return N/A */ void _timer_int_handler(void *unused /* parameter is not used */ @@ -361,7 +361,7 @@ void _timer_int_handler(void *unused /* parameter is not used */ * value (the higher the tick frequency), the more elapsed ticks during a * "tickless idle". * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -384,7 +384,7 @@ static void _loApicTimerTicklessIdleInit(void) * 3. Set timer mode to periodic/one-shot * 4. Start timer. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -416,7 +416,7 @@ static void _loApicTimerTicklessIdleSkew(void) * ticks supplied or the maximum number of ticks that can be programmed into * hardware. A value of -1 means inifinite number of ticks. * - * RETURNS: N/A + * @return N/A */ void _timer_idle_enter(int32_t ticks /* system ticks */ @@ -473,7 +473,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ * * Called in _IntEnt() * - * RETURNS: N/A + * @return N/A */ void _timer_idle_exit(void) @@ -537,7 +537,7 @@ void _timer_idle_exit(void) * This routine is used to program the PIT to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. * - * RETURNS: N/A + * @return N/A */ void timer_driver(int priority /* priority parameter ignored by this driver */ @@ -576,7 +576,7 @@ void timer_driver(int priority /* priority parameter ignored by this driver */ * * This routine returns the current time in terms of timer hardware clock cycles. * - * RETURNS: up counter of elapsed clock cycles + * @return up counter of elapsed clock cycles */ uint32_t timer_read(void) @@ -606,7 +606,7 @@ uint32_t timer_read(void) * This routine simply disables the LOAPIC counter such that interrupts are no * longer delivered. * - * RETURNS: N/A + * @return N/A */ void timer_disable(void) diff --git a/include/arch/arc/v2/arcv2_irq_unit.h b/include/arch/arc/v2/arcv2_irq_unit.h index f0c4dd14010..4de0b3ecf1d 100644 --- a/include/arch/arc/v2/arcv2_irq_unit.h +++ b/include/arch/arc/v2/arcv2_irq_unit.h @@ -65,7 +65,7 @@ * * Enables or disables the specified interrupt * - * RETURNS: N/A + * @return N/A */ static inline void _arc_v2_irq_unit_irq_enable_set( @@ -82,7 +82,7 @@ static inline void _arc_v2_irq_unit_irq_enable_set( * * Enables the specified interrupt * - * RETURNS: N/A + * @return N/A */ static inline void _arc_v2_irq_unit_int_enable(int irq) @@ -95,7 +95,7 @@ static inline void _arc_v2_irq_unit_int_enable(int irq) * * Disables the specified interrupt * - * RETURNS: N/A + * @return N/A */ static inline void _arc_v2_irq_unit_int_disable(int irq) @@ -108,7 +108,7 @@ static inline void _arc_v2_irq_unit_int_disable(int irq) * * Set the priority of the specified interrupt * - * RETURNS: N/A + * @return N/A */ static inline void _arc_v2_irq_unit_prio_set(int irq, unsigned char prio) diff --git a/include/arch/arc/v2/ffs.h b/include/arch/arc/v2/ffs.h index 848a4837fa9..1a41afed6f8 100644 --- a/include/arch/arc/v2/ffs.h +++ b/include/arch/arc/v2/ffs.h @@ -54,7 +54,7 @@ extern unsigned nanoFfsMsb(unsigned int); * significant bit. A return value of zero indicates that the value passed * is zero. * - * RETURNS: most significant bit set + * @return most significant bit set */ #if defined(__GNUC__) @@ -83,7 +83,7 @@ static ALWAYS_INLINE unsigned int nanoFfsMsb_inline(unsigned int op) * at 1 from the least significant bit. A return value of zero indicates that * the value passed is zero. * - * RETURNS: least significant bit set + * @return least significant bit set */ #if defined(__GNUC__) diff --git a/include/arch/arc/v2/irq.h b/include/arch/arc/v2/irq.h index 82945d3e48b..383edd1c9ea 100644 --- a/include/arch/arc/v2/irq.h +++ b/include/arch/arc/v2/irq.h @@ -77,7 +77,7 @@ extern void _irq_exit(void); * * See irq_lock() for full description * - * RETURNS: An architecture-dependent lock-out key representing the + * @return An architecture-dependent lock-out key representing the * "interrupt disable state" prior to the call. * * \NOMANUAL @@ -97,7 +97,7 @@ static ALWAYS_INLINE unsigned int irq_lock_inline(void) * * See irq_unlock() for full description * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/include/arch/arm/CortexM/asm_inline_gcc.h b/include/arch/arm/CortexM/asm_inline_gcc.h index 20330dd2afc..110bc983cda 100644 --- a/include/arch/arm/CortexM/asm_inline_gcc.h +++ b/include/arch/arm/CortexM/asm_inline_gcc.h @@ -61,7 +61,7 @@ * significant bit. A return value of zero indicates that the value passed * is zero. * - * RETURNS: most significant bit set + * @return most significant bit set */ static ALWAYS_INLINE unsigned int find_last_set_inline(unsigned int op) @@ -89,7 +89,7 @@ static ALWAYS_INLINE unsigned int find_last_set_inline(unsigned int op) * at 1 from the least significant bit. A return value of zero indicates that * the value passed is zero. * - * RETURNS: least significant bit set + * @return least significant bit set */ static ALWAYS_INLINE unsigned int find_first_set_inline(unsigned int op) @@ -134,7 +134,7 @@ static ALWAYS_INLINE unsigned int find_first_set_inline(unsigned int op) * disable state will be restored when the context is later rescheduled * for execution. * - * RETURNS: An architecture-dependent lock-out key representing the + * @return An architecture-dependent lock-out key representing the * "interrupt disable state" prior to the call. * * \NOMANUAL @@ -166,7 +166,7 @@ static ALWAYS_INLINE unsigned int irq_lock_inline(void) * * This routine can be called from either interrupt, task or fiber level. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/include/arch/arm/CortexM/irq.h b/include/arch/arm/CortexM/irq.h index 31a14818b0d..6a957a33678 100644 --- a/include/arch/arm/CortexM/irq.h +++ b/include/arch/arm/CortexM/irq.h @@ -88,7 +88,7 @@ extern void _IntExit(void); * with the interrupt routine , that receives parameter * * - * RETURNS: N/A + * @return N/A * */ #define IRQ_CONNECT_STATIC(device, irq, priority, isr, parameter) \ @@ -104,7 +104,7 @@ extern void _IntExit(void); * For the given device do the neccessary configuration steps. * Fpr ARM platform, set the interrupt priority * - * RETURNS: N/A + * @return N/A * */ #define IRQ_CONFIG(device, irq) irq_priority_set(irq, _##device##_int_priority) diff --git a/include/arch/arm/CortexM/nvic.h b/include/arch/arm/CortexM/nvic.h index 91f7936e168..a9eacae770c 100644 --- a/include/arch/arm/CortexM/nvic.h +++ b/include/arch/arm/CortexM/nvic.h @@ -91,7 +91,7 @@ Supports up to 240 IRQs and 256 priority levels. * * Enable IRQ #, which is equivalent to exception #+16 * - * RETURNS: N/A + * @return N/A */ static inline void _NvicIrqEnable(unsigned int irq /* IRQ number */ @@ -106,7 +106,7 @@ static inline void _NvicIrqEnable(unsigned int irq /* IRQ number */ * * Find out if IRQ # is enabled. * - * RETURNS: 1 if IRQ is enabled, 0 otherwise + * @return 1 if IRQ is enabled, 0 otherwise */ static inline int _NvicIsIrqEnabled(unsigned int irq /* IRQ number */ @@ -121,7 +121,7 @@ static inline int _NvicIsIrqEnabled(unsigned int irq /* IRQ number */ * * Disable IRQ #, which is equivalent to exception #+16 * - * RETURNS: N/A + * @return N/A */ static inline void _NvicIrqDisable(unsigned int irq /* IRQ number */ @@ -138,7 +138,7 @@ static inline void _NvicIrqDisable(unsigned int irq /* IRQ number */ * the IRQ when interrupts are enabled and/or returning from a higher priority * interrupt. * - * RETURNS: N/A + * @return N/A */ static inline void _NvicIrqPend(unsigned int irq /* IRQ number */ @@ -153,7 +153,7 @@ static inline void _NvicIrqPend(unsigned int irq /* IRQ number */ * * Find out if IRQ # is pending * - * RETURNS: 1 if IRQ is pending, 0 otherwise + * @return 1 if IRQ is pending, 0 otherwise */ static inline int _NvicIsIrqPending(unsigned int irq /* IRQ number */ @@ -170,7 +170,7 @@ static inline int _NvicIsIrqPending(unsigned int irq /* IRQ number */ * pending interrupt will be ignored when either unlocking interrupts or * returning from a higher priority exception. * - * RETURNS: N/A + * @return N/A */ static inline void _NvicIrqUnpend(unsigned int irq /* IRQ number */ @@ -185,7 +185,7 @@ static inline void _NvicIrqUnpend(unsigned int irq /* IRQ number */ * * Set priority of IRQ # to . There are 256 priority levels. * - * RETURNS: N/A + * @return N/A */ static inline void _NvicIrqPrioSet(unsigned int irq, /* IRQ number */ @@ -202,7 +202,7 @@ static inline void _NvicIrqPrioSet(unsigned int irq, /* IRQ number */ * * Get priority of IRQ #. * - * RETURNS: the priority level of the IRQ + * @return the priority level of the IRQ */ static inline uint32_t _NvicIrqPrioGet(unsigned int irq /* IRQ number */ @@ -218,7 +218,7 @@ static inline uint32_t _NvicIrqPrioGet(unsigned int irq /* IRQ number */ * Trigger interrupt #. The CPU will handle the IRQ when interrupts are * enabled and/or returning from a higher priority interrupt. * - * RETURNS: N/A + * @return N/A */ static inline void _NvicSwInterruptTrigger(unsigned int irq /* IRQ number */ diff --git a/include/arch/arm/CortexM/scb.h b/include/arch/arm/CortexM/scb.h index 5298af1ac25..6b27347bb03 100644 --- a/include/arch/arm/CortexM/scb.h +++ b/include/arch/arm/CortexM/scb.h @@ -77,7 +77,7 @@ extern void _ScbNumPriGroupSet(unsigned int n); * * _ScbIsNmiPending - find out if the NMI exception is pending * - * RETURNS: 1 if it is pending, 0 otherwise + * @return 1 if it is pending, 0 otherwise */ static inline int _ScbIsNmiPending(void) @@ -91,7 +91,7 @@ static inline int _ScbIsNmiPending(void) * * Pend the NMI exception: it should fire immediately. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbNmiPend(void) @@ -103,7 +103,7 @@ static inline void _ScbNmiPend(void) * * _ScbIsPendsvPending - find out if the PendSV exception is pending * - * RETURNS: 1 if it is pending, 0 otherwise + * @return 1 if it is pending, 0 otherwise */ static inline int _ScbIsPendsvPending(void) @@ -118,7 +118,7 @@ static inline int _ScbIsPendsvPending(void) * Set the PendSV exception: it will be handled when the last nested exception * returns, or immediately if running in thread mode. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbPendsvSet(void) @@ -132,7 +132,7 @@ static inline void _ScbPendsvSet(void) * * This routine clears the PendSV exception. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbPendsvClear(void) @@ -146,7 +146,7 @@ static inline void _ScbPendsvClear(void) * * This routine determines if the SYSTICK exception is pending. * - * RETURNS: 1 if it is pending, 0 otherwise + * @return 1 if it is pending, 0 otherwise */ static inline int _ScbIsSystickPending(void) @@ -162,7 +162,7 @@ static inline int _ScbIsSystickPending(void) * priority exception or immediately if in thread mode or handling a lower * priority exception. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSystickPendSet(void) @@ -176,7 +176,7 @@ static inline void _ScbSystickPendSet(void) * * This routine clears the SYSTICK exception. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSystickPendClear(void) @@ -190,7 +190,7 @@ static inline void _ScbSystickPendClear(void) * * Find out if an external interrupt, generated by the NVIC, is pending. * - * RETURNS: 1 if one or more interrupt is pending, 0 otherwise + * @return 1 if one or more interrupt is pending, 0 otherwise */ static inline int _ScbIsIrqPending(void) @@ -206,7 +206,7 @@ static inline int _ScbIsIrqPending(void) * If one or more exceptions are pending, return the exception number of the * highest-priority one; otherwise, return 0. * - * RETURNS: the exception number if one is pending, 0 otherwise + * @return the exception number if one is pending, 0 otherwise */ static inline int _ScbHiPriVectorPendingGet(void) @@ -223,7 +223,7 @@ static inline int _ScbHiPriVectorPendingGet(void) * * This routine determines if the currently executing exception is nested. * - * RETURNS: 1 if nested, 0 otherwise + * @return 1 if nested, 0 otherwise */ static inline int _ScbIsNestedExc(void) @@ -238,7 +238,7 @@ static inline int _ScbIsNestedExc(void) * * This routine determines if the current mode is thread mode. * - * RETURNS: 1 if in thread mode, 0 otherwise + * @return 1 if in thread mode, 0 otherwise */ static inline int _ScbIsInThreadMode(void) @@ -253,7 +253,7 @@ static inline int _ScbIsInThreadMode(void) * * This routine determines if the current mode is handler mode. * - * RETURNS: 1 if in handler mode, 0 otherwise + * @return 1 if in handler mode, 0 otherwise */ static inline int _ScbIsInHandlerMode(void) @@ -267,7 +267,7 @@ static inline int _ScbIsInHandlerMode(void) * * This routine determines if an exception is being handled (handler mode). * - * RETURNS: 1 if handling an exception, 0 otherwise + * @return 1 if handling an exception, 0 otherwise */ static inline int _ScbIsInExc(void) @@ -282,7 +282,7 @@ static inline int _ScbIsInExc(void) * If currently handling an exception/interrupt, return the exceuting vector * number. If not, return 0. * - * RETURNS: the currently excecuting vector number, 0 if in thread mode. + * @return the currently excecuting vector number, 0 if in thread mode. */ static inline uint32_t _ScbActiveVectorGet(void) @@ -296,7 +296,7 @@ static inline uint32_t _ScbActiveVectorGet(void) * * This routine determines if the currently executing exception is nested. * - * RETURNS: 1 if in SRAM, 0 if in ROM + * @return 1 if in SRAM, 0 if in ROM */ static inline uint32_t _ScbIsVtableInSram(void) @@ -310,7 +310,7 @@ static inline uint32_t _ScbIsVtableInSram(void) * * This routine moves the vector table to the given memory region. * - * RETURNS: 1 if in SRAM, 0 if in ROM + * @return 1 if in SRAM, 0 if in ROM */ static inline void _ScbVtableLocationSet( @@ -327,7 +327,7 @@ static inline void _ScbVtableLocationSet( * * This routine returs the vector table's base address. * - * RETURNS: the base address of the vector table + * @return the base address of the vector table */ static inline uint32_t _ScbVtableAddrGet(void) @@ -350,7 +350,7 @@ static inline uint32_t _ScbVtableAddrGet(void) * 48 <= num_interrupts < 112: multiple 0x200 * .... * - * RETURNS: N/A + * @return N/A */ static inline void _ScbVtableAddrSet(uint32_t addr /* base address, aligned on @@ -368,7 +368,7 @@ static inline void _ScbVtableAddrSet(uint32_t addr /* base address, aligned on * Data regions on Cortex-M devices can be either little or big endian. Code * regions are always little endian. * - * RETURNS: 1 if little endian, 0 if big endian + * @return 1 if little endian, 0 if big endian */ static inline int _ScbIsDataLittleEndian(void) @@ -384,7 +384,7 @@ static inline int _ScbIsDataLittleEndian(void) * Within these groups, exceptions do not preempt each other. The sub-priorities * are only used to decide which exception will run when several are pending. * - * RETURNS: the number of priority groups + * @return the number of priority groups */ static inline int _ScbNumPriGroupGet(void) @@ -400,7 +400,7 @@ static inline int _ScbNumPriGroupGet(void) * * This enables the feature until it is cancelled. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSleepOnExitSet(void) @@ -415,7 +415,7 @@ static inline void _ScbSleepOnExitSet(void) * This routine prevents CPU sleep mode upon exiting an ISR. * This is the normal operating mode. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSleepOnExitClear(void) @@ -436,7 +436,7 @@ static inline void _ScbSleepOnExitClear(void) * * This enables the feature until it is cancelled. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSevOnPendSet(void) @@ -450,7 +450,7 @@ static inline void _ScbSevOnPendSet(void) * * See _ScbSevOnPendSet(). * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSevOnPendClear(void) @@ -467,7 +467,7 @@ static inline void _ScbSevOnPendClear(void) * * Behaviour is processor-specific. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSleepDeepSet(void) @@ -481,7 +481,7 @@ static inline void _ScbSleepDeepSet(void) * * This routine prevents CPU deep sleep mode. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbSleepDeepClear(void) @@ -496,7 +496,7 @@ static inline void _ScbSleepDeepClear(void) * This routine enables the divide by zero fault. * By default, the CPU ignores the error. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbDivByZeroFaultEnable(void) @@ -511,7 +511,7 @@ static inline void _ScbDivByZeroFaultEnable(void) * This routine disables the divide by zero fault. * This is the default behaviour. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbDivByZeroFaultDisable(void) @@ -526,7 +526,7 @@ static inline void _ScbDivByZeroFaultDisable(void) * This routine enables the unaligned access fault. * By default, the CPU ignores the error. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUnalignedFaultEnable(void) @@ -541,7 +541,7 @@ static inline void _ScbUnalignedFaultEnable(void) * This routine disables the divide by zero fault. * This is the default behaviour. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUnalignedFaultDisable(void) @@ -555,7 +555,7 @@ static inline void _ScbUnalignedFaultDisable(void) * * This routine writes the given value to the Configuration Control Register. * - * RETURNS: N/A + * @return N/A */ static inline void ScbCcrSet(uint32_t val /* value to write to CCR */ @@ -573,7 +573,7 @@ static inline void ScbCcrSet(uint32_t val /* value to write to CCR */ * * Exceptions 1 to 3 priorities are fixed (-3, -2, -1). * - * RETURNS: priority of exception + * @return priority of exception */ static inline uint8_t _ScbExcPrioGet(uint8_t exc /* exception number, 4 to 15 */ @@ -596,7 +596,7 @@ static inline uint8_t _ScbExcPrioGet(uint8_t exc /* exception number, 4 to 15 */ * * Exceptions 1 to 3 priorities are fixed (-3, -2, -1). * - * RETURNS: N/A + * @return N/A */ static inline void _ScbExcPrioSet(uint8_t exc, /* exception number, 4 to 15 */ @@ -615,7 +615,7 @@ static inline void _ScbExcPrioSet(uint8_t exc, /* exception number, 4 to 15 */ * This routine enables usage faults. * By default, the CPU does not raise usage fault exceptions. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultEnable(void) @@ -630,7 +630,7 @@ static inline void _ScbUsageFaultEnable(void) * This routine disables usage faults. * This is the default behaviour. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultDisable(void) @@ -645,7 +645,7 @@ static inline void _ScbUsageFaultDisable(void) * This routine enables bus faults. * By default, the CPU does not raise bus fault exceptions. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbBusFaultEnable(void) @@ -660,7 +660,7 @@ static inline void _ScbBusFaultEnable(void) * This routine disables bus faults. * This is the default behaviour. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbBusFaultDisable(void) @@ -675,7 +675,7 @@ static inline void _ScbBusFaultDisable(void) * This routine enables the MPU faults. * By default, the CPU does not raise MPU fault exceptions. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbMemFaultEnable(void) @@ -690,7 +690,7 @@ static inline void _ScbMemFaultEnable(void) * This routine disables MPU faults. * This is the default behaviour. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbMemFaultDisable(void) @@ -706,7 +706,7 @@ static inline void _ScbMemFaultDisable(void) * This routine determines if a hard fault is caused by a bus error during * a vector table read operation. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbHardFaultIsBusErrOnVectorRead(void) @@ -721,7 +721,7 @@ static inline int _ScbHardFaultIsBusErrOnVectorRead(void) * Happens if a fault cannot be triggered because of priority or because it was * disabled. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbHardFaultIsForced(void) @@ -735,7 +735,7 @@ static inline int _ScbHardFaultIsForced(void) * * HFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbHardFaultAllFaultsReset(void) @@ -749,7 +749,7 @@ static inline int _ScbHardFaultAllFaultsReset(void) * * This routine determines if a hard fault is an MPU fault. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbIsMemFault(void) @@ -764,7 +764,7 @@ static inline int _ScbIsMemFault(void) * * The MMFAR register contains the faulting address on an MPU fault. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbMemFaultIsMmfarValid(void) @@ -779,7 +779,7 @@ static inline int _ScbMemFaultIsMmfarValid(void) * This routine invalidates the MMFAR value. This should be done after * processing an MPU fault. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbMemFaultMmfarReset(void) @@ -793,7 +793,7 @@ static inline void _ScbMemFaultMmfarReset(void) * * CFSR/MMFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline void _ScbMemFaultAllFaultsReset(void) @@ -808,7 +808,7 @@ static inline void _ScbMemFaultAllFaultsReset(void) * This routine determines if an MPU fault is a stacking fault. * This may occur upon exception entry. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbMemFaultIsStacking(void) @@ -823,7 +823,7 @@ static inline int _ScbMemFaultIsStacking(void) * This routine determines if an MPU fault is an unstacking fault. * This may occur upon exception exit. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbMemFaultIsUnstacking(void) @@ -839,7 +839,7 @@ static inline int _ScbMemFaultIsUnstacking(void) * If this routine returns 1, read the MMFAR register via _ScbMemFaultAddrGet() * to get the faulting address. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbMemFaultIsDataAccessViolation(void) @@ -855,7 +855,7 @@ static inline int _ScbMemFaultIsDataAccessViolation(void) * This routine determines if an MPU fault is due to an instruction access * violation. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbMemFaultIsInstrAccessViolation(void) @@ -867,7 +867,7 @@ static inline int _ScbMemFaultIsInstrAccessViolation(void) * * _ScbMemFaultAddrGet - find out the faulting address on an MPU fault * - * RETURNS: the faulting address + * @return the faulting address */ static inline uint32_t _ScbMemFaultAddrGet(void) @@ -881,7 +881,7 @@ static inline uint32_t _ScbMemFaultAddrGet(void) * * This routine determines if a hard fault is a bus fault. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbIsBusFault(void) @@ -896,7 +896,7 @@ static inline int _ScbIsBusFault(void) * * The BFAR register contains the faulting address on bus fault. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbBusFaultIsBfarValid(void) @@ -911,7 +911,7 @@ static inline int _ScbBusFaultIsBfarValid(void) * This routine clears/invalidates the Bus Fault Address Register. * It should be done after processing a bus fault. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbBusFaultBfarReset(void) @@ -925,7 +925,7 @@ static inline void _ScbBusFaultBfarReset(void) * * CFSR/BFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbBusFaultAllFaultsReset(void) @@ -940,7 +940,7 @@ static inline void _ScbBusFaultAllFaultsReset(void) * This routine determines if a bus fault is a stacking fault. * This may occurs upon exception entry. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbBusFaultIsStacking(void) @@ -955,7 +955,7 @@ static inline int _ScbBusFaultIsStacking(void) * This routine determines if a bus fault is an unstacking fault. * This may occur upon exception exit. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbBusFaultIsUnstacking(void) @@ -969,7 +969,7 @@ static inline int _ScbBusFaultIsUnstacking(void) * * This routine determines if a bus fault is an imprecise error. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbBusFaultIsImprecise(void) @@ -984,7 +984,7 @@ static inline int _ScbBusFaultIsImprecise(void) * Read the BFAR register via _ScbBusFaultAddrGet() if this routine returns 1, * as it will contain the faulting address. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbBusFaultIsPrecise(void) @@ -1000,7 +1000,7 @@ static inline int _ScbBusFaultIsPrecise(void) * This routine determines if a bus fault is an instruction bus error. * It is signalled only if the instruction is issued. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbBusFaultIsInstrBusErr(void) @@ -1014,7 +1014,7 @@ static inline int _ScbBusFaultIsInstrBusErr(void) * * This routine returns the faulting address for a precise bus fault. * - * RETURNS: the faulting address + * @return the faulting address */ static inline uint32_t _ScbBusFaultAddrGet(void) @@ -1028,7 +1028,7 @@ static inline uint32_t _ScbBusFaultAddrGet(void) * * This routine determines if a hard fault is a usage fault. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbIsUsageFault(void) @@ -1043,7 +1043,7 @@ static inline int _ScbIsUsageFault(void) * * This routine determines if a usage fault is a 'divde by zero' fault. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbUsageFaultIsDivByZero(void) @@ -1058,7 +1058,7 @@ static inline int _ScbUsageFaultIsDivByZero(void) * * This routine determines if a usage fault is an unaligned access error. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbUsageFaultIsUnaligned(void) @@ -1074,7 +1074,7 @@ static inline int _ScbUsageFaultIsUnaligned(void) * This routine determines if a usage fault is caused by a coprocessor access. * This happens if the coprocessor is either absent or disabled. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbUsageFaultIsNoCp(void) @@ -1090,7 +1090,7 @@ static inline int _ScbUsageFaultIsNoCp(void) * Happens if the the instruction address on an exception return is not * halfword-aligned. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbUsageFaultIsInvalidPcLoad(void) @@ -1107,7 +1107,7 @@ static inline int _ScbUsageFaultIsInvalidPcLoad(void) * POP, or if the instruction address installed in a exception vector, does not * have bit 0 set, ie., is not halfword-aligned. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbUsageFaultIsInvalidState(void) @@ -1122,7 +1122,7 @@ static inline int _ScbUsageFaultIsInvalidState(void) * * The processor tried to execute an invalid opcode. * - * RETURNS: 1 if so, 0 otherwise + * @return 1 if so, 0 otherwise */ static inline int _ScbUsageFaultIsUndefinedInstr(void) @@ -1136,7 +1136,7 @@ static inline int _ScbUsageFaultIsUndefinedInstr(void) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultDivByZeroReset(void) @@ -1150,7 +1150,7 @@ static inline void _ScbUsageFaultDivByZeroReset(void) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultUnalignedReset(void) @@ -1164,7 +1164,7 @@ static inline void _ScbUsageFaultUnalignedReset(void) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultNoCpReset(void) @@ -1178,7 +1178,7 @@ static inline void _ScbUsageFaultNoCpReset(void) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultInvalidPcLoadReset(void) @@ -1192,7 +1192,7 @@ static inline void _ScbUsageFaultInvalidPcLoadReset(void) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultInvalidStateReset(void) @@ -1206,7 +1206,7 @@ static inline void _ScbUsageFaultInvalidStateReset(void) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultUndefinedInstrReset(void) @@ -1220,7 +1220,7 @@ static inline void _ScbUsageFaultUndefinedInstrReset(void) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * - * RETURNS: N/A + * @return N/A */ static inline void _ScbUsageFaultAllFaultsReset(void) diff --git a/include/arch/arm/CortexM/scs.h b/include/arch/arm/CortexM/scs.h index fb50b4ad31f..9c60ed8a606 100644 --- a/include/arch/arm/CortexM/scs.h +++ b/include/arch/arm/CortexM/scs.h @@ -435,7 +435,7 @@ extern volatile struct __scs __scs; * * _ScsNumIrqGet - obtain the number of interrupt lines on the target * - * RETURNS: the number of interrupts + * @return the number of interrupts */ static inline int _ScsNumIrqGet(void) @@ -453,7 +453,7 @@ static inline int _ScsNumIrqGet(void) * they must complete before the processor can stack the current state and invoke * the interrupt handler. * - * RETURNS: N/A + * @return N/A */ static inline void _ScsIntMultiCycleInstDisable(void) @@ -467,7 +467,7 @@ static inline void _ScsIntMultiCycleInstDisable(void) * * See _ScsIntMultiCycleInstDisable(). * - * RETURNS: N/A + * @return N/A */ static inline void _ScsIntMultiCycleInstEnable(void) @@ -485,7 +485,7 @@ static inline void _ScsIntMultiCycleInstEnable(void) * BusFaults to be precise BusFaults but decreases performance because any store * to memory must complete before the processor can execute the next instruction. * - * RETURNS: N/A + * @return N/A */ static inline void _ScsWriteBufDisable(void) @@ -499,7 +499,7 @@ static inline void _ScsWriteBufDisable(void) * * See _ScsWriteBufDisable(). * - * RETURNS: N/A + * @return N/A */ static inline void _ScsWriteBufEnable(void) @@ -519,7 +519,7 @@ static inline void _ScsWriteBufEnable(void) * jitter in looping. If a task must avoid jitter, set the DISFOLD bit to 1 * before executing the task, to disable IT folding. * - * RETURNS: N/A + * @return N/A */ static inline void _ScsFoldItDisable(void) @@ -533,7 +533,7 @@ static inline void _ScsFoldItDisable(void) * * See _ScsFoldItDisable(). * - * RETURNS: N/A + * @return N/A */ static inline void _ScsFoldItEnable(void) diff --git a/include/arch/x86/arch.h b/include/arch/x86/arch.h index 508f4a568d1..c36e8b32b03 100644 --- a/include/arch/x86/arch.h +++ b/include/arch/x86/arch.h @@ -122,7 +122,7 @@ typedef struct s_isrList { * descriptor; (hardware) interrupts and exceptions should specify a level of 0, * whereas handlers for user-mode software generated interrupts should specify 3. * - * RETURNS: N/A + * @return N/A * */ @@ -146,7 +146,7 @@ typedef struct s_isrList { * with the interrupt routine , that receives parameter * * - * RETURNS: N/A + * @return N/A * */ #define IRQ_CONNECT_STATIC(device, irq, priority, isr, parameter) \ @@ -162,7 +162,7 @@ typedef struct s_isrList { * For the given device do the neccessary configuration steps. * For x86 platform configure APIC and mark interrupt vector allocated * - * RETURNS: N/A + * @return N/A * */ #define IRQ_CONFIG(device, irq) \ @@ -299,7 +299,7 @@ void _int_latency_stop(void); * disable state will be restored when the context is later rescheduled * for execution. * - * RETURNS: An architecture-dependent lock-out key representing the + * @return An architecture-dependent lock-out key representing the * "interrupt disable state" prior to the call. * * \NOMANUAL @@ -328,7 +328,7 @@ static inline __attribute__((always_inline)) * * This routine can be called from either interrupt, task or fiber level. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/include/arch/x86/asm_inline_gcc.h b/include/arch/x86/asm_inline_gcc.h index ee475c3cb47..9ce35452791 100644 --- a/include/arch/x86/asm_inline_gcc.h +++ b/include/arch/x86/asm_inline_gcc.h @@ -69,7 +69,7 @@ * disable state will be restored when the context is later rescheduled * for execution. * - * RETURNS: An architecture-dependent lock-out key representing the + * @return An architecture-dependent lock-out key representing the * "interrupt disable state" prior to the call. * * \NOMANUAL @@ -100,7 +100,7 @@ static inline __attribute__((always_inline)) * This routine can be called from either interrupt, task or fiber level. * Invoked by kernel or by irq_unlock_inline() * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -124,7 +124,7 @@ static inline __attribute__((always_inline)) * at 1 from the least significant bit to 32 for the most significant bit. * A return value of zero indicates that the value passed is zero. * - * RETURNS: bit position from 1 to 32, or 0 if the argument is zero. + * @return bit position from 1 to 32, or 0 if the argument is zero. * * INTERNAL * For Intel64 (x86_64) architectures, the 'cmovzl' can be removed @@ -175,7 +175,7 @@ static inline __attribute__((always_inline)) * at 1 from the least significant bit to 32 for the most significant bit. * A return value of zero indicates that the value passed is zero. * - * RETURNS: bit position from 1 to 32, or 0 if the argument is zero. + * @return bit position from 1 to 32, or 0 if the argument is zero. * * INTERNAL * For Intel64 (x86_64) architectures, the 'cmovzl' can be removed @@ -254,7 +254,7 @@ static inline uint64_t _NanoTscRead(void) * * _do_read_cpu_timestamp - get a 32 bit CPU timestamp counter * - * RETURNS: a 32-bit number + * @return a 32-bit number */ static inline inline __attribute__((always_inline)) @@ -275,7 +275,7 @@ static inline inline __attribute__((always_inline)) * This function issues the 'out' instruction to write a byte to the specified * I/O port. * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -294,7 +294,7 @@ static inline inline __attribute__((always_inline)) * This function issues the 'in' instruction to read a byte from the specified * I/O port. * - * RETURNS: the byte read from the specified I/O port + * @return the byte read from the specified I/O port * * NOMANUAL */ @@ -316,7 +316,7 @@ static inline inline __attribute__((always_inline)) * This function issues the 'out' instruction to write a word to the * specified I/O port. * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -335,7 +335,7 @@ static inline inline __attribute__((always_inline)) * This function issues the 'in' instruction to read a word from the * specified I/O port. * - * RETURNS: the word read from the specified I/O port + * @return the word read from the specified I/O port * * NOMANUAL */ @@ -357,7 +357,7 @@ static inline inline __attribute__((always_inline)) * This function issues the 'out' instruction to write a long word to the * specified I/O port. * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -376,7 +376,7 @@ static inline inline __attribute__((always_inline)) * This function issues the 'in' instruction to read a long word from the * specified I/O port. * - * RETURNS: the long read from the specified I/O port + * @return the long read from the specified I/O port * * NOMANUAL */ diff --git a/include/drivers/k20_watchdog.h b/include/drivers/k20_watchdog.h index 4750dcd2fb5..3b2e0acfc1d 100644 --- a/include/drivers/k20_watchdog.h +++ b/include/drivers/k20_watchdog.h @@ -99,7 +99,7 @@ typedef volatile struct { * Writing 0xC520 followed by 0xD928 will unlock the write-once registers * in the WDOG so they are writable within the WCT period. * - * RETURNS: N/A + * @return N/A */ static ALWAYS_INLINE void wdog_unlock(K20_WDOG_t *wdog_p) { @@ -130,7 +130,7 @@ static ALWAYS_INLINE void wdog_unlock(K20_WDOG_t *wdog_p) * * This routine will disable the watchdog timer. * - * RETURNS: N/A + * @return N/A */ static ALWAYS_INLINE void wdog_disable(K20_WDOG_t *wdog_p) { diff --git a/kernel/microkernel/k_command_packet.c b/kernel/microkernel/k_command_packet.c index 2c49c419783..603d3f5730e 100644 --- a/kernel/microkernel/k_command_packet.c +++ b/kernel/microkernel/k_command_packet.c @@ -73,7 +73,7 @@ uint32_t _k_test_cmd_pkt_size * * This routine gets the next command packet from the specified set. * - * RETURNS: pointer to the command packet + * @return pointer to the command packet */ cmdPkt_t *_cmd_pkt_get( @@ -97,7 +97,7 @@ cmdPkt_t *_cmd_pkt_get( * * _k_task_call - send command packet to be processed by K_swapper * - * RETURNS: N/A + * @return N/A */ void _k_task_call(struct k_args *cmd_packet) diff --git a/kernel/microkernel/k_event.c b/kernel/microkernel/k_event.c index 2890215f585..b48affbcde3 100644 --- a/kernel/microkernel/k_event.c +++ b/kernel/microkernel/k_event.c @@ -41,7 +41,7 @@ extern struct evstr _k_event_list[]; * * _k_event_handler_set - perform set event handler request * - * RETURNS: N/A + * @return N/A */ void _k_event_handler_set(struct k_args *A) @@ -84,7 +84,7 @@ void _k_event_handler_set(struct k_args *A) * the old handler must be removed first. However, it is permitted to replace * the NULL event handler with itself. * - * RETURNS: RC_FAIL if an event handler exists or the event number is invalid, + * @return RC_FAIL if an event handler exists or the event number is invalid, * else RC_OK */ @@ -105,7 +105,7 @@ int task_event_set_handler(kevent_t event, /* event upon which to reigster * * * _k_event_test_timeout - finish handling a test for event request that timed out * - * RETURNS: N/A + * @return N/A */ void _k_event_test_timeout(struct k_args *A) @@ -123,7 +123,7 @@ void _k_event_test_timeout(struct k_args *A) * * _k_event_test - perform test for event request * - * RETURNS: N/A + * @return N/A */ void _k_event_test(struct k_args *A) @@ -172,7 +172,7 @@ void _k_event_test(struct k_args *A) * * This routine tests an event to see if it has been signaled. * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively */ int _task_event_recv( @@ -197,7 +197,7 @@ int _task_event_recv( * signal is issued by a task and indirectly when the signal is issued by a * fiber or ISR. The specified event number must be valid. * - * RETURNS: N/A + * @return N/A */ void _k_do_event_signal(kevent_t event) @@ -237,7 +237,7 @@ void _k_do_event_signal(kevent_t event) * * _k_event_signal - perform signal an event request * - * RETURNS: N/A + * @return N/A */ void _k_event_signal(struct k_args *A) @@ -260,7 +260,7 @@ void _k_event_signal(struct k_args *A) * is installed for that event, it will run; if no event handler is installed, * any task waiting on the event is released. * - * RETURNS: RC_FAIL if event number is invalid, else RC_OK + * @return RC_FAIL if event number is invalid, else RC_OK */ int task_event_send(kevent_t event /* event to signal */ @@ -280,7 +280,7 @@ int task_event_send(kevent_t event /* event to signal */ * * This routine does NOT validate the specified event number. * - * RETURNS: N/A + * @return N/A */ FUNC_ALIAS(isr_event_send, fiber_event_send, void); @@ -291,7 +291,7 @@ FUNC_ALIAS(isr_event_send, fiber_event_send, void); * * This routine does NOT validate the specified event number. * - * RETURNS: N/A + * @return N/A */ void isr_event_send(kevent_t event /* event to signal */ diff --git a/kernel/microkernel/k_fifo.c b/kernel/microkernel/k_fifo.c index df4b9e4afcf..2e0aa51236c 100644 --- a/kernel/microkernel/k_fifo.c +++ b/kernel/microkernel/k_fifo.c @@ -39,7 +39,7 @@ * * _k_fifo_enque_reply - finish performing an incomplete FIFO enqueue request * - * RETURNS: N/A + * @return N/A */ void _k_fifo_enque_reply(struct k_args *A) @@ -64,7 +64,7 @@ void _k_fifo_enque_reply(struct k_args *A) * * _k_fifo_enque_request - perform a FIFO enqueue request * - * RETURNS: N/A + * @return N/A */ void _k_fifo_enque_request(struct k_args *A) @@ -142,7 +142,7 @@ void _k_fifo_enque_request(struct k_args *A) * * This routine puts an entry at the end of the FIFO queue. * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively */ int _task_fifo_put(kfifo_t queue, /* FIFO queue */ @@ -166,7 +166,7 @@ int _task_fifo_put(kfifo_t queue, /* FIFO queue */ * * _k_fifo_deque_reply - finish performing an incomplete FIFO dequeue request * - * RETURNS: N/A + * @return N/A */ void _k_fifo_deque_reply(struct k_args *A) @@ -191,7 +191,7 @@ void _k_fifo_deque_reply(struct k_args *A) * * _k_fifo_deque_request - perform FIFO dequeue request * - * RETURNS: N/A + * @return N/A */ void _k_fifo_deque_request(struct k_args *A) @@ -275,7 +275,7 @@ void _k_fifo_deque_request(struct k_args *A) * If the FIFO is not empty, the oldest entry is removed and copied to the * address provided by the caller. * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively */ int _task_fifo_get(kfifo_t queue, /* FIFO queue */ @@ -299,7 +299,7 @@ int _task_fifo_get(kfifo_t queue, /* FIFO queue */ * * _k_fifo_ioctl - perform miscellaneous FIFO request * - * RETURNS: N/A + * @return N/A */ void _k_fifo_ioctl(struct k_args *A) @@ -343,7 +343,7 @@ void _k_fifo_ioctl(struct k_args *A) * 1. = 0 : query the number of FIFO entries * 2. = 1 : purge the FIFO of its entries * - * RETURNS: # of FIFO entries on query; RC_OK on purge + * @return # of FIFO entries on query; RC_OK on purge */ int _task_fifo_ioctl(kfifo_t queue, /* FIFO queue */ diff --git a/kernel/microkernel/k_idle.c b/kernel/microkernel/k_idle.c index 80fab76637c..8cb437f92bc 100644 --- a/kernel/microkernel/k_idle.c +++ b/kernel/microkernel/k_idle.c @@ -76,7 +76,7 @@ static extern uint32_t _k_workload_scale; * _k_workload_n1 is updated by the system tick handler, and both are kept * in close synchronization. * - * RETURNS: N/A + * @return N/A * */ @@ -107,7 +107,7 @@ static void workload_loop(void) * Measures the time required to do a fixed amount of "dummy work", and * sets default values for the workload measuring period. * - * RETURNS: N/A + * @return N/A * */ @@ -140,7 +140,7 @@ void _k_workload_monitor_calibrate(void) * If workload monitor is configured this routine updates the global variables * it uses to record the passage of time. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -162,7 +162,7 @@ void _k_workload_monitor_update(void) * * Records time when idle task was selected for execution by the microkernel. * - * RETURNS: N/A + * @return N/A */ void _k_workload_monitor_idle_start(void) @@ -177,7 +177,7 @@ void _k_workload_monitor_idle_start(void) * Records time when idle task was no longer selected for execution by the * microkernel, and updates amount of time spent idling. * - * RETURNS: N/A + * @return N/A */ void _k_workload_monitor_idle_end(void) @@ -193,7 +193,7 @@ void _k_workload_monitor_idle_end(void) * * Computes workload, or uses 0 if workload monitoring is not configured. * - * RETURNS: N/A + * @return N/A */ void _k_workload_get(struct k_args *P) @@ -243,7 +243,7 @@ void _k_workload_get(struct k_args *P) * up to 100% of its time servicing ISRs and fibers, yet report a workload of 0% * because the idle task is always the task selected by the microkernel. * - * RETURNS: workload + * @return workload */ int task_workload_get(void) @@ -261,7 +261,7 @@ int task_workload_get(void) * * This routine specifies the workload measuring period for task_workload_get(). * - * RETURNS: N/A + * @return N/A */ void sys_workload_time_slice_set(int32_t t) @@ -311,7 +311,7 @@ int32_t _sys_idle_threshold_ticks = CONFIG_TICKLESS_IDLE_THRESH; * until the timer expires, in system ticks. * Routine is invoked from the idle task with interrupts disabled * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -356,7 +356,7 @@ void _sys_power_save_idle(int32_t ticks) * Routine can be modified to wake up other devices. * The routine is invoked from interrupt context, with interrupts disabled. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -381,7 +381,7 @@ void _sys_power_save_idle_exit(int32_t ticks) * Must be called with interrupts locked to prevent the timer queues from * changing. * - * RETURNS: Number of ticks until next timer expires. + * @return Number of ticks until next timer expires. * */ @@ -406,7 +406,7 @@ static inline int32_t _get_next_timer_expiry(void) * this routine will fall through and _k_kernel_idle() will try the next idling * mechanism. * - * RETURNS: N/A + * @return N/A * */ @@ -453,7 +453,7 @@ static void _power_save(void) * * If power save is on, we sleep; if power save is off, we "busy wait". * - * RETURNS: N/A + * @return N/A * */ diff --git a/kernel/microkernel/k_irq.c b/kernel/microkernel/k_irq.c index 1ee5199585f..b764462d2a4 100644 --- a/kernel/microkernel/k_irq.c +++ b/kernel/microkernel/k_irq.c @@ -116,7 +116,7 @@ extern const kevent_t _TaskIrqEvt0_objId; * This ISR does not facilitate an int acknowledgment as it presumes that an * End of Interrupt (EOI) routine is provided by the PIC that is being used. * - * RETURNS: N/A + * @return N/A */ static void task_irq_int_handler( @@ -137,7 +137,7 @@ static void task_irq_int_handler( * is flushed; the object's interrupt vector is then freed, and the object's * global array entry is marked as unused. * - * RETURNS: N/A + * @return N/A */ void task_irq_free(kirq_t irq_obj /* IRQ object identifier */ @@ -159,7 +159,7 @@ void task_irq_free(kirq_t irq_obj /* IRQ object identifier */ * * This re-enables the interrupt for a task IRQ object. * - * RETURNS: N/A + * @return N/A */ void task_irq_ack(kirq_t irq_obj /* IRQ object identifier */ @@ -178,7 +178,7 @@ void task_irq_ack(kirq_t irq_obj /* IRQ object identifier */ * * This tests a task IRQ object to see if it has signalled an interrupt. * - * RETURNS: RC_OK, RC_FAIL, or RC_TIME + * @return RC_OK, RC_FAIL, or RC_TIME */ int _task_irq_test(kirq_t irq_obj, /* IRQ object identifier */ @@ -198,7 +198,7 @@ int _task_irq_test(kirq_t irq_obj, /* IRQ object identifier */ * * This routine allocates a task IRQ object to a task. * - * RETURNS: ptr to allocated task IRQ object if successful, NULL if not + * @return ptr to allocated task IRQ object if successful, NULL if not */ static int _k_task_irq_alloc( @@ -245,7 +245,7 @@ static int _k_task_irq_alloc( * IRQ allocation is done via K_swapper so that simultaneous allocation * requests are single-threaded. * - * RETURNS: assigned interrupt vector if successful, INVALID_VECTOR if not + * @return assigned interrupt vector if successful, INVALID_VECTOR if not */ uint32_t task_irq_alloc( diff --git a/kernel/microkernel/k_mailbox.c b/kernel/microkernel/k_mailbox.c index 1d26ea9e39a..8b7cc3b139f 100644 --- a/kernel/microkernel/k_mailbox.c +++ b/kernel/microkernel/k_mailbox.c @@ -54,7 +54,7 @@ * * copy_packet - copy a packet * - * RETURNS: N/A + * @return N/A */ static void copy_packet(struct k_args **out, struct k_args *in) @@ -74,7 +74,7 @@ static void copy_packet(struct k_args **out, struct k_args *in) * * match - determine if there is a match between the mailbox sender and receiver * - * RETURNS: matched message size, or -1 if no match + * @return matched message size, or -1 if no match */ static int match(struct k_args *Reader, struct k_args *Writer) @@ -130,7 +130,7 @@ static int match(struct k_args *Reader, struct k_args *Writer) * * prepare_transfer - * - * RETURNS: true or false + * @return true or false */ static bool prepare_transfer(struct k_args *move, @@ -214,7 +214,7 @@ static bool prepare_transfer(struct k_args *move, * * transfer - * - * RETURNS: N/A + * @return N/A */ static void transfer(struct k_args *pMvdReq) @@ -230,7 +230,7 @@ static void transfer(struct k_args *pMvdReq) * * _k_mbox_send_ack - process the acknowledgment to a mailbox send request * - * RETURNS: N/A + * @return N/A */ void _k_mbox_send_ack(struct k_args *pCopyWriter) @@ -302,7 +302,7 @@ void _k_mbox_send_ack(struct k_args *pCopyWriter) * * _k_mbox_send_reply - process the timeout for a mailbox send request * - * RETURNS: N/A + * @return N/A */ void _k_mbox_send_reply(struct k_args *pCopyWriter) @@ -318,7 +318,7 @@ void _k_mbox_send_reply(struct k_args *pCopyWriter) * * _k_mbox_send_request - process a mailbox send request * - * RETURNS: N/A + * @return N/A */ void _k_mbox_send_request(struct k_args *Writer) @@ -480,7 +480,7 @@ void _k_mbox_send_request(struct k_args *Writer) * * This routine sends a message to a mailbox and looks for a matching receiver. * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively */ int _task_mbox_put(kmbox_t mbox, /* mailbox */ @@ -523,7 +523,7 @@ int _task_mbox_put(kmbox_t mbox, /* mailbox */ * * INTERNAL: This routine frees the packet * - * RETURNS: N/A + * @return N/A */ void _k_mbox_receive_ack(struct k_args *pCopyReader) @@ -549,7 +549,7 @@ void _k_mbox_receive_ack(struct k_args *pCopyReader) * * _k_mbox_receive_reply - process the timeout for a mailbox receive request * - * RETURNS: N/A + * @return N/A */ void _k_mbox_receive_reply(struct k_args *pCopyReader) @@ -567,7 +567,7 @@ void _k_mbox_receive_reply(struct k_args *pCopyReader) * * _k_mbox_receive_request - process a mailbox receive request * - * RETURNS: N/A + * @return N/A */ void _k_mbox_receive_request(struct k_args *Reader) @@ -695,7 +695,7 @@ void _k_mbox_receive_request(struct k_args *Reader) * _task_mbox_get - gets struct k_msg message header structure information * from a mailbox * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively */ int _task_mbox_get(kmbox_t mbox, /* mailbox */ @@ -732,7 +732,7 @@ int _task_mbox_get(kmbox_t mbox, /* mailbox */ * receiver. There is no exchange header returned to the sender. When the data * has been transferred to the receiver, the semaphore signaling is performed. * - * RETURNS: N/A + * @return N/A */ void _task_mbox_put_async(kmbox_t mbox, /* mailbox to which to send message */ @@ -771,7 +771,7 @@ void _task_mbox_put_async(kmbox_t mbox, /* mailbox to which to send message */ * * _k_mbox_receive_data - process a mailbox receive data request * - * RETURNS: N/A + * @return N/A */ void _k_mbox_receive_data(struct k_args *Starter) @@ -822,7 +822,7 @@ void _k_mbox_receive_data(struct k_args *Starter) * 2. To wake up and release a transmitting task that is blocked on a call to * task_mbox_put[wait|wait_timeout](). * - * RETURNS: N/A + * @return N/A */ void _task_mbox_data_get(struct k_msg *M /* message from which to get data */ @@ -850,7 +850,7 @@ void _task_mbox_data_get(struct k_msg *M /* message from which to get data */ * _task_mbox_data_get_async_block - get the mailbox data and place * in a memory pool block * - * RETURNS: RC_OK upon success, RC_FAIL upon failure, or RC_TIME upon timeout + * @return RC_OK upon success, RC_FAIL upon failure, or RC_TIME upon timeout */ int _task_mbox_data_get_async_block(struct k_msg *message, @@ -948,7 +948,7 @@ int _task_mbox_data_get_async_block(struct k_msg *message, * * _k_mbox_send_data - process a mailbox send data request * - * RETURNS: N/A + * @return N/A */ void _k_mbox_send_data(struct k_args *Starter) diff --git a/kernel/microkernel/k_memory_map.c b/kernel/microkernel/k_memory_map.c index 623b72fd152..82d77a5a0ab 100644 --- a/kernel/microkernel/k_memory_map.c +++ b/kernel/microkernel/k_memory_map.c @@ -39,7 +39,7 @@ * * Perform any initialization of memory maps that wasn't done at build time. * - * RETURNS: N/A + * @return N/A */ void _k_mem_map_init(void) @@ -74,7 +74,7 @@ void _k_mem_map_init(void) * * _k_mem_map_alloc_timeout - finish handling a memory map block request that timed out * - * RETURNS: N/A + * @return N/A */ void _k_mem_map_alloc_timeout(struct k_args *A) @@ -89,7 +89,7 @@ void _k_mem_map_alloc_timeout(struct k_args *A) * * _k_mem_map_alloc - perform allocate memory map block request * - * RETURNS: N/A + * @return N/A */ void _k_mem_map_alloc(struct k_args *A) @@ -136,7 +136,7 @@ void _k_mem_map_alloc(struct k_args *A) * * This routine is used to request a block of memory from the memory map. * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, error, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, error, timeout respectively */ int _task_mem_map_alloc(kmemory_map_t mmap, /* memory map from which to request block */ @@ -158,7 +158,7 @@ int _task_mem_map_alloc(kmemory_map_t mmap, /* memory map from which to request * * _k_mem_map_dealloc - perform return memory map block request * - * RETURNS: N/A + * @return N/A */ void _k_mem_map_dealloc(struct k_args *A) @@ -202,7 +202,7 @@ void _k_mem_map_dealloc(struct k_args *A) * priority task is waiting for a block from the same map a task switch * takes place. * - * RETURNS: N/A + * @return N/A */ void _task_mem_map_free(kmemory_map_t mmap, /* memory map */ @@ -223,7 +223,7 @@ void _task_mem_map_free(kmemory_map_t mmap, /* memory map */ * * This routine returns the number of blocks in use for the memory map. * - * RETURNS: number of used blocks + * @return number of used blocks */ int task_mem_map_used_get(kmemory_map_t mmap /* memory map */ diff --git a/kernel/microkernel/k_memory_pool.c b/kernel/microkernel/k_memory_pool.c index 2916a86e616..2c3007d2877 100644 --- a/kernel/microkernel/k_memory_pool.c +++ b/kernel/microkernel/k_memory_pool.c @@ -49,7 +49,7 @@ * * Perform any initialization of memory pool that wasn't done at build time. * - * RETURNS: N/A + * @return N/A */ void _k_mem_pool_init(void) @@ -105,7 +105,7 @@ void _k_mem_pool_init(void) * * marks ptr as free block in the given list [MYSTERIOUS LEGACY COMMENT] * - * RETURNS: N/A + * @return N/A */ static void search_bp(char *ptr, struct pool_struct *P, int index) @@ -138,7 +138,7 @@ static void search_bp(char *ptr, struct pool_struct *P, int index) * * defrag - defragmentation algorithm for memory pool * - * RETURNS: N/A + * @return N/A */ static void defrag(struct pool_struct *P, @@ -194,7 +194,7 @@ static void defrag(struct pool_struct *P, * * _k_defrag - perform defragment memory pool request * - * RETURNS: N/A + * @return N/A */ void _k_defrag(struct k_args *A) @@ -229,7 +229,7 @@ void _k_defrag(struct k_args *A) * * This routine concatenates unused memory in a memory pool. * - * RETURNS: N/A + * @return N/A */ void task_mem_pool_defragment(kmemory_pool_t Pid /* pool to defragment */ @@ -248,7 +248,7 @@ void task_mem_pool_defragment(kmemory_pool_t Pid /* pool to defragment */ * * This routine attempts to allocate a free block. [NEED TO EXPAND THIS] * - * RETURNS: pointer to allocated block, or NULL if none available + * @return pointer to allocated block, or NULL if none available */ static char *search_block_on_frag_level(struct pool_block *pfraglevelinfo, @@ -333,7 +333,7 @@ static char *search_block_on_frag_level(struct pool_block *pfraglevelinfo, * not implemented: check if we go below the minimal number of blocks with * the maximum size * - * RETURNS: pointer to allocated block, or NULL if none available + * @return pointer to allocated block, or NULL if none available */ static char *get_block_recusive(struct pool_struct *P, int index, int startindex) @@ -417,7 +417,7 @@ static char *get_block_recusive(struct pool_struct *P, int index, int startindex * of a used block or as a result of defragmenting the pool (which may create * one or more new, larger blocks). * - * RETURNS: N/A + * @return N/A */ void _k_block_waiters_get(struct k_args *A) @@ -482,7 +482,7 @@ void _k_block_waiters_get(struct k_args *A) * * _k_mem_pool_block_get_timeout_handle - finish handling an allocate block request that timed out * - * RETURNS: N/A + * @return N/A */ void _k_mem_pool_block_get_timeout_handle(struct k_args *A) @@ -497,7 +497,7 @@ void _k_mem_pool_block_get_timeout_handle(struct k_args *A) * * _k_mem_pool_block_get - perform allocate memory pool block request * - * RETURNS: N/A + * @return N/A */ void _k_mem_pool_block_get(struct k_args *A) @@ -562,7 +562,7 @@ void _k_mem_pool_block_get(struct k_args *A) * This routine allocates a free block from the specified memory pool, ensuring * that its size is at least as big as the size requested (in bytes). * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively */ int _task_mem_pool_alloc(struct k_block *blockptr, /* ptr to requested block */ @@ -596,7 +596,7 @@ int _task_mem_pool_alloc(struct k_block *blockptr, /* ptr to requested block */ * Marks a block belonging to a pool as free; if there are waiters that can use * the the block it is passed to a waiting task. * - * RETURNS: N/A + * @return N/A */ void _k_mem_pool_block_release(struct k_args *A) @@ -668,7 +668,7 @@ void _k_mem_pool_block_release(struct k_args *A) * The struct k_block structure contains the block details, including the pool to * which it should be returned. * - * RETURNS: N/A + * @return N/A */ void task_mem_pool_free(struct k_block *blockptr /* pointer to block to free */ diff --git a/kernel/microkernel/k_move_data.c b/kernel/microkernel/k_move_data.c index 712f3b66695..f033d4b7958 100644 --- a/kernel/microkernel/k_move_data.c +++ b/kernel/microkernel/k_move_data.c @@ -40,7 +40,7 @@ * * mvdreq_docont - * - * RETURNS: N/A + * @return N/A */ static void mvdreq_docont(struct k_args *Cont) @@ -58,7 +58,7 @@ static void mvdreq_docont(struct k_args *Cont) * * mvdreq_copy - perform movedata request * - * RETURNS: N/A + * @return N/A */ static void mvdreq_copy(struct moved_req *ReqArgs) @@ -76,7 +76,7 @@ static void mvdreq_copy(struct moved_req *ReqArgs) * * _k_movedata_request - process a movedata request * - * RETURNS: N/A + * @return N/A */ void _k_movedata_request(struct k_args *Req) diff --git a/kernel/microkernel/k_mutex.c b/kernel/microkernel/k_mutex.c index 5a939345f4e..cf0bc0af6a0 100644 --- a/kernel/microkernel/k_mutex.c +++ b/kernel/microkernel/k_mutex.c @@ -66,7 +66,7 @@ NOMANUAL * This routine replies to a mutex lock request. This will occur if either * the waiting task times out or acquires the mutex lock. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -152,7 +152,7 @@ void _k_mutex_lock_reply( * is already locked, and the timeout is non-zero then the priority inheritance * algorithm may be applied to prevent priority inversion scenarios. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -273,7 +273,7 @@ void _k_mutex_lock_request(struct k_args *A /* pointer to mutex lock * * This routine is the entry to the mutex lock kernel service. * - * RETURNS: RC_OK on success, RC_FAIL on error, RC_TIME on timeout + * @return RC_OK on success, RC_FAIL on error, RC_TIME on timeout */ int _task_mutex_lock( @@ -300,7 +300,7 @@ int _task_mutex_lock( * of the current owner to the priority level it had when it acquired the * mutex. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -391,7 +391,7 @@ void _k_mutex_unlock(struct k_args *A /* pointer to mutex unlock * * This routine is the entry to the mutex unlock kernel service. * - * RETURNS: N/A + * @return N/A */ void _task_mutex_unlock(kmutex_t mutex /* mutex to unlock */ diff --git a/kernel/microkernel/k_nop.c b/kernel/microkernel/k_nop.c index ec75e747f49..7ea2ca6c456 100644 --- a/kernel/microkernel/k_nop.c +++ b/kernel/microkernel/k_nop.c @@ -48,7 +48,7 @@ a task to measure the overhead involved in issuing a kernel service request. * * _k_nop - perform "do nothing" kernel request * - * RETURNS: N/A + * @return N/A */ void _k_nop(struct k_args *A) @@ -62,7 +62,7 @@ void _k_nop(struct k_args *A) * * This routine is a request for the K_swapper to run a "do nothing" routine. * - * RETURNS: N/A + * @return N/A */ void _task_nop(void) diff --git a/kernel/microkernel/k_offload.c b/kernel/microkernel/k_offload.c index 07ec979217c..0870a12bd9b 100644 --- a/kernel/microkernel/k_offload.c +++ b/kernel/microkernel/k_offload.c @@ -40,7 +40,7 @@ * This routine simply invokes the requested function from within the context * of the K_swapper() fiber and saves the result. * - * RETURNS: N/A + * @return N/A */ void _k_offload_to_fiber(struct k_args *A) @@ -58,7 +58,7 @@ void _k_offload_to_fiber(struct k_args *A) * This routine issues a request to execute a function from within the context * of the K_swapper() fiber. * - * RETURNS: return value from custom call + * @return return value from custom call */ int task_offload_to_fiber(int (*func)(), void *argp) diff --git a/kernel/microkernel/k_pipe.c b/kernel/microkernel/k_pipe.c index dde0db22707..05cbef1a047 100644 --- a/kernel/microkernel/k_pipe.c +++ b/kernel/microkernel/k_pipe.c @@ -42,7 +42,7 @@ * Performs any initialization of statically-defined pipes that wasn't done * at build time. (Note: most pipe structure fields are set to zero by sysgen.) * - * RETURNS: N/A + * @return N/A */ void _k_pipe_init(void) @@ -64,7 +64,7 @@ void _k_pipe_init(void) * This routine attempts to read data into a memory buffer area from the * specified pipe. * - * RETURNS: RC_OK, RC_INCOMPLETE, RC_FAIL, RC_TIME, or RC_ALIGNMENT + * @return RC_OK, RC_INCOMPLETE, RC_FAIL, RC_TIME, or RC_ALIGNMENT */ int _task_pipe_get(kpipe_t Id, void *pBuffer, @@ -119,7 +119,7 @@ int _task_pipe_get(kpipe_t Id, void *pBuffer, * This routine attempts to write data from a memory buffer area to the * specified pipe. * - * RETURNS: RC_OK, RC_INCOMPLETE, RC_FAIL, RC_TIME, or RC_ALIGNMENT + * @return RC_OK, RC_INCOMPLETE, RC_FAIL, RC_TIME, or RC_ALIGNMENT */ int _task_pipe_put(kpipe_t Id, void *pBuffer, @@ -175,7 +175,7 @@ int _task_pipe_put(kpipe_t Id, void *pBuffer, * specified pipe. (Note that partial transfers and timeouts are not * supported, unlike the case for synchronous write requests.) * - * RETURNS: RC_OK, RC_FAIL, or RC_ALIGNMENT + * @return RC_OK, RC_FAIL, or RC_ALIGNMENT */ int _task_pipe_put_async(kpipe_t Id, struct k_block Block, diff --git a/kernel/microkernel/k_pipe_get.c b/kernel/microkernel/k_pipe_get.c index 7040bdfebc3..35f465a1ab2 100644 --- a/kernel/microkernel/k_pipe_get.c +++ b/kernel/microkernel/k_pipe_get.c @@ -40,7 +40,7 @@ * * _k_pipe_get_request - process request command for a pipe get operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_get_request(struct k_args *RequestOrig) @@ -192,7 +192,7 @@ void _k_pipe_get_request(struct k_args *RequestOrig) * * _k_pipe_get_timeout - process timeout command for a pipe get operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_get_timeout(struct k_args *ReqProc) @@ -212,7 +212,7 @@ void _k_pipe_get_timeout(struct k_args *ReqProc) * * _k_pipe_get_reply - process reply command for a pipe get operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_get_reply(struct k_args *ReqProc) @@ -263,7 +263,7 @@ void _k_pipe_get_reply(struct k_args *ReqProc) * * _k_pipe_get_ack - process acknowledgment command for a pipe get operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_get_ack(struct k_args *Request) diff --git a/kernel/microkernel/k_pipe_put.c b/kernel/microkernel/k_pipe_put.c index b33fb94e199..b4df5818429 100644 --- a/kernel/microkernel/k_pipe_put.c +++ b/kernel/microkernel/k_pipe_put.c @@ -41,7 +41,7 @@ * * _k_pipe_put_request - process request command for a pipe put operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_put_request(struct k_args *RequestOrig) @@ -211,7 +211,7 @@ void _k_pipe_put_request(struct k_args *RequestOrig) * * _k_pipe_put_timeout - perform timeout command for a pipe put operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_put_timeout(struct k_args *ReqProc) @@ -231,7 +231,7 @@ void _k_pipe_put_timeout(struct k_args *ReqProc) * * _k_pipe_put_reply - process reply command for a pipe put operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_put_reply(struct k_args *ReqProc) @@ -284,7 +284,7 @@ void _k_pipe_put_reply(struct k_args *ReqProc) * * _k_pipe_put_ack - process acknowledgment command for a pipe put operation * - * RETURNS: N/A + * @return N/A */ void _k_pipe_put_ack(struct k_args *Request) diff --git a/kernel/microkernel/k_pipe_xfer.c b/kernel/microkernel/k_pipe_xfer.c index bc6e699236e..ded7dbfab2a 100644 --- a/kernel/microkernel/k_pipe_xfer.c +++ b/kernel/microkernel/k_pipe_xfer.c @@ -58,7 +58,7 @@ possibly copy the remaining data * * _k_pipe_movedata_ack - * - * RETURNS: N/A + * @return N/A */ void _k_pipe_movedata_ack(struct k_args *pEOXfer) @@ -213,7 +213,7 @@ void _k_pipe_movedata_ack(struct k_args *pEOXfer) * * Note: It's OK to have one or two participants, but there can't be none! * - * RETURNS: N/A + * @return N/A */ static kpriority_t move_priority_compute(struct k_args *pWriter, @@ -237,7 +237,7 @@ static kpriority_t move_priority_compute(struct k_args *pWriter, * * setup_movedata - * - * RETURNS: N/A + * @return N/A */ static void setup_movedata(struct k_args *A, @@ -416,7 +416,7 @@ static int WriterInProgressIsBlocked(struct pipe_struct *pPipe, * as the reader. Otherwise it takes the reader from the channel * structure. * - * RETURNS: N/A + * @return N/A */ static void pipe_read(struct pipe_struct *pPipe, struct k_args *pNewReader) @@ -485,7 +485,7 @@ static void pipe_read(struct pipe_struct *pPipe, struct k_args *pNewReader) * as the writer. Otherwise it takes the writer from the channel * structure. * - * RETURNS: N/A + * @return N/A */ static void pipe_write(struct pipe_struct *pPipe, struct k_args *pNewWriter) @@ -552,7 +552,7 @@ static void pipe_write(struct pipe_struct *pPipe, struct k_args *pNewWriter) * * pipe_xfer_status_update - update the channel transfer status * - * RETURNS: N/A + * @return N/A */ static void pipe_xfer_status_update( @@ -579,7 +579,7 @@ static void pipe_xfer_status_update( * * pipe_read_write - read and/or write from/to the channel * - * RETURNS: N/A + * @return N/A */ static void pipe_read_write( diff --git a/kernel/microkernel/k_semaphore.c b/kernel/microkernel/k_semaphore.c index 1c5463954c9..6b7babb7581 100644 --- a/kernel/microkernel/k_semaphore.c +++ b/kernel/microkernel/k_semaphore.c @@ -40,7 +40,7 @@ * * signal_semaphore - common code for signaling a semaphore * - * RETURNS: N/A + * @return N/A */ static void signal_semaphore(int n, struct sem_struct *S) @@ -98,7 +98,7 @@ static void signal_semaphore(int n, struct sem_struct *S) * * _k_sem_group_wait - finish handling incomplete waits on semaphores * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_wait(struct k_args *R) @@ -120,7 +120,7 @@ void _k_sem_group_wait(struct k_args *R) * for each semaphore in the semaphore group that "lost" the semaphore group * wait request. * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_wait_cancel(struct k_args *A) @@ -185,7 +185,7 @@ void _k_sem_group_wait_cancel(struct k_args *A) * the request for the one semaphore in the group that "wins" the semaphore * group wait request. * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_wait_accept(struct k_args *A) @@ -220,7 +220,7 @@ void _k_sem_group_wait_accept(struct k_args *A) * * _k_sem_group_wait_timeout - handle semaphore group timeout request * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_wait_timeout(struct k_args *A) @@ -255,7 +255,7 @@ void _k_sem_group_wait_timeout(struct k_args *A) * the one semaphore in the group that "won" the semaphore group wait request * before triggering the semaphore group timeout handler. * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_ready(struct k_args *R) @@ -279,7 +279,7 @@ void _k_sem_group_ready(struct k_args *R) * * _k_sem_wait_reply - reply to a semaphore wait request * - * RETURNS: N/A + * @return N/A */ void _k_sem_wait_reply(struct k_args *A) @@ -302,7 +302,7 @@ void _k_sem_wait_reply(struct k_args *A) * _k_sem_group_wait_request - handle internal wait request on a semaphore involved in a * semaphore group wait request * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_wait_request(struct k_args *A) @@ -346,7 +346,7 @@ void _k_sem_group_wait_request(struct k_args *A) * This routine splits the single semaphore group wait request into several * internal wait requests--one for each semaphore in the group. * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_wait_any(struct k_args *A) @@ -392,7 +392,7 @@ void _k_sem_group_wait_any(struct k_args *A) * * _k_sem_wait_request - handle semaphore test and wait request * - * RETURNS: N/A + * @return N/A */ void _k_sem_wait_request(struct k_args *A) @@ -435,7 +435,7 @@ void _k_sem_wait_request(struct k_args *A) * @param sema Semaphore to test. * @param time Maximum number of ticks to wait. * - * RETURNS: RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively + * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively */ int _task_sem_take(ksem_t sema, int32_t time) @@ -462,7 +462,7 @@ int _task_sem_take(ksem_t sema, int32_t time) * @param group Group of semaphores to test. * @param time Maximum number of ticks to wait. * - * RETURNS: N/A + * @return N/A */ ksem_t _task_sem_group_take(ksemg_t group, int32_t time) @@ -481,7 +481,7 @@ ksem_t _task_sem_group_take(ksemg_t group, int32_t time) * * _k_sem_signal - handle semaphore signal request * - * RETURNS: N/A + * @return N/A */ void _k_sem_signal(struct k_args *A) @@ -495,7 +495,7 @@ void _k_sem_signal(struct k_args *A) * * _k_sem_group_signal - handle signal semaphore group request * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_signal(struct k_args *A) @@ -515,7 +515,7 @@ void _k_sem_group_signal(struct k_args *A) * * @param sema Semaphore to signal. * - * RETURNS: N/A + * @return N/A */ void task_sem_give(ksem_t sema) @@ -542,7 +542,7 @@ void task_sem_give(ksem_t sema) * * @param group Group of semaphores to signal. * - * RETURNS: N/A + * @return N/A */ void task_sem_group_give(ksemg_t group) @@ -563,7 +563,7 @@ void task_sem_group_give(ksemg_t group) * that is implicitly released once the command packet has been processed. * To signal a semaphore from a task, task_sem_give() should be used instead. * - * RETURNS: N/A + * @return N/A */ FUNC_ALIAS(isr_sem_give, fiber_sem_give, void); @@ -580,7 +580,7 @@ FUNC_ALIAS(isr_sem_give, fiber_sem_give, void); * @param sema Semaphore to signal. * @param pSet Pointer to command packet set. * - * RETURNS: N/A + * @return N/A */ void isr_sem_give(ksem_t sema, struct cmd_pkt_set *pSet) @@ -604,7 +604,7 @@ void isr_sem_give(ksem_t sema, struct cmd_pkt_set *pSet) * * _k_sem_reset - handle semaphore reset request * - * RETURNS: N/A + * @return N/A */ void _k_sem_reset(struct k_args *A) @@ -618,7 +618,7 @@ void _k_sem_reset(struct k_args *A) * * _k_sem_group_reset - handle semaphore group reset request * - * RETURNS: N/A + * @return N/A */ void _k_sem_group_reset(struct k_args *A) @@ -638,7 +638,7 @@ void _k_sem_group_reset(struct k_args *A) * * @param sema Semaphore to reset. * - * RETURNS: N/A + * @return N/A */ void task_sem_reset(ksem_t sema) @@ -660,7 +660,7 @@ void task_sem_reset(ksem_t sema) * * @param group Group of semaphores to reset. * - * RETURNS: N/A + * @return N/A */ void task_sem_group_reset(ksemg_t group) @@ -676,7 +676,7 @@ void task_sem_group_reset(ksemg_t group) * * _k_sem_inquiry - handle semaphore inquiry request * - * RETURNS: N/A + * @return N/A */ void _k_sem_inquiry(struct k_args *A) @@ -697,7 +697,7 @@ void _k_sem_inquiry(struct k_args *A) * * @param sema Semaphore to query. * - * RETURNS: signal count + * @return signal count */ int task_sem_count_get(ksem_t sema) diff --git a/kernel/microkernel/k_server.c b/kernel/microkernel/k_server.c index 25f2a3cb090..da4b4398658 100644 --- a/kernel/microkernel/k_server.c +++ b/kernel/microkernel/k_server.c @@ -58,7 +58,7 @@ extern const kernelfunc _k_server_dispatch_table[]; * task at the head of that queue. It's guaranteed that there will always be * a non-empty queue, since the idle task is always executable. * - * RETURNS: pointer to selected task + * @return pointer to selected task */ static struct k_proc *next_task_select(void) @@ -94,7 +94,7 @@ static struct k_proc *next_task_select(void) * stack and then sets up the next task that is ready to run. Next it * goes to wait on further inputs on its stack channel. * - * RETURNS: Does not return. + * @return Does not return. */ FUNC_NORETURN void K_swapper(int parameter1, /* not used */ diff --git a/kernel/microkernel/k_task.c b/kernel/microkernel/k_task.c index f15b871c011..c68c7170249 100644 --- a/kernel/microkernel/k_task.c +++ b/kernel/microkernel/k_task.c @@ -47,7 +47,7 @@ * * task_id_get - get task identifer * - * RETURNS: identifier for current task + * @return identifier for current task */ ktask_t task_id_get(void) @@ -64,7 +64,7 @@ ktask_t task_id_get(void) * bitmask of the TF_xxx bits. Each TF_xxx bit indicates a reason why the task * must not be scheduled to run. * - * RETURNS: N/A + * @return N/A */ void _k_state_bit_reset(struct k_proc *X, /* ptr to task */ @@ -116,7 +116,7 @@ void _k_state_bit_reset(struct k_proc *X, /* ptr to task */ * are a bitmask of the TF_xxx bits. Each TF_xxx bit indicates a reason why * the task must not be scheduled to run. * - * RETURNS: N/A + * @return N/A */ void _k_state_bit_set( @@ -197,7 +197,7 @@ void _k_state_bit_set( * * start_task - initialize and start a task * - * RETURNS: N/A + * @return N/A */ static void start_task(struct k_proc *X, /* ptr to task control block */ @@ -241,7 +241,7 @@ static void start_task(struct k_proc *X, /* ptr to task control block */ * * This routine aborts the specified task. * - * RETURNS: N/A + * @return N/A */ static void abort_task(struct k_proc *X) @@ -270,7 +270,7 @@ static void abort_task(struct k_proc *X) * To be invoked when a task aborts implicitly, either by returning from its * entry point or due to a software or hardware fault. * - * RETURNS: does not return + * @return does not return * * \NOMANUAL */ @@ -304,7 +304,7 @@ FUNC_NORETURN void _TaskAbort(void) * To remove an abort handler, set the parameter to NULL as below: * task_abort_handler_set (NULL) * - * RETURNS: N/A + * @return N/A */ void task_abort_handler_set(void (*func)(void) /* abort handler */ @@ -321,7 +321,7 @@ void task_abort_handler_set(void (*func)(void) /* abort handler */ * starting either a kernel or user task, aborting a task, suspending a task, * resuming a task, blocking a task or unblocking a task * - * RETURNS: N/A + * @return N/A */ void _k_task_op(struct k_args *A) @@ -355,7 +355,7 @@ void _k_task_op(struct k_args *A) * * _task_ioctl - task operations * - * RETURNS: N/A + * @return N/A */ void _task_ioctl(ktask_t task, /* task on which to operate */ @@ -378,7 +378,7 @@ void _task_ioctl(ktask_t task, /* task on which to operate */ * starting either kernel or user tasks, aborting tasks, suspending tasks, * resuming tasks, blocking tasks or unblocking tasks * - * RETURNS: N/A + * @return N/A */ void _k_task_group_op(struct k_args *A) @@ -426,7 +426,7 @@ void _k_task_group_op(struct k_args *A) * * _task_group_ioctl - task group operations * - * RETURNS: N/A + * @return N/A */ void _task_group_ioctl(ktask_group_t group, /* task group */ @@ -445,7 +445,7 @@ void _task_group_ioctl(ktask_group_t group, /* task group */ * * task_group_mask_get - get task groups for task * - * RETURNS: task groups associated with current task + * @return task groups associated with current task */ kpriority_t task_group_mask_get(void) @@ -457,7 +457,7 @@ kpriority_t task_group_mask_get(void) * * task_group_join - add task to task group(s) * - * RETURNS: N/A + * @return N/A */ void task_group_join(uint32_t groups) @@ -469,7 +469,7 @@ void task_group_join(uint32_t groups) * * task_group_leave - remove task from task group(s) * - * RETURNS: N/A + * @return N/A */ void task_group_leave(uint32_t groups) @@ -481,7 +481,7 @@ void task_group_leave(uint32_t groups) * * task_priority_get - get task priority * - * RETURNS: priority of current task + * @return priority of current task */ kpriority_t task_priority_get(void) @@ -493,7 +493,7 @@ kpriority_t task_priority_get(void) * * _k_task_priority_set - handle task set priority request * - * RETURNS: N/A + * @return N/A */ void _k_task_priority_set(struct k_args *A) @@ -521,7 +521,7 @@ void _k_task_priority_set(struct k_args *A) * The priority should be specified in the range 0 to 62. 0 is the highest * priority. * - * RETURNS: N/A + * @return N/A */ void task_priority_set(ktask_t task, /* task whose priority is to be set */ @@ -540,7 +540,7 @@ void task_priority_set(ktask_t task, /* task whose priority is to be set */ * * _k_task_yield - handle task yield request * - * RETURNS: N/A + * @return N/A */ void _k_task_yield(struct k_args *A) @@ -566,7 +566,7 @@ void _k_task_yield(struct k_args *A) * robin scheduling. If no task with the same priority is runnable then no task * switch occurs and the calling task resumes execution. * - * RETURNS: N/A + * @return N/A */ void task_yield(void) @@ -589,7 +589,7 @@ void task_yield(void) * * The routine is executed when the task is started * - * RETURNS: N/A + * @return N/A */ void task_entry_set(ktask_t task, /* task */ diff --git a/kernel/microkernel/k_ticker.c b/kernel/microkernel/k_ticker.c index 72b6665be39..af873aa17fb 100644 --- a/kernel/microkernel/k_ticker.c +++ b/kernel/microkernel/k_ticker.c @@ -79,7 +79,7 @@ int sys_clock_hw_cycles_per_tick; * "high resolution" timer. This is in contrast to nano_tick_get_32() and * task_tick_get_32() which return the value of the kernel ticks variable. * - * RETURNS: current high precision clock value + * @return current high precision clock value */ uint32_t task_cycle_get_32(void) @@ -94,7 +94,7 @@ uint32_t task_cycle_get_32(void) * This routine returns the lower 32-bits of the current system clock value * as measured in ticks. * - * RETURNS: lower 32-bit of the current system clock value + * @return lower 32-bit of the current system clock value */ int32_t task_tick_get_32(void) @@ -111,7 +111,7 @@ int32_t task_tick_get_32(void) * Interrupts are locked while updating clock since some CPUs do not support * native atomic operations on 64 bit values. * - * RETURNS: current system clock value + * @return current system clock value */ int64_t task_tick_get(void) @@ -131,7 +131,7 @@ int64_t task_tick_get(void) * Interrupts are locked while updating clock since some CPUs do not support * native atomic operations on 64 bit values. * - * RETURNS: N/A + * @return N/A */ static void sys_clock_increment(int inc) @@ -149,7 +149,7 @@ static void sys_clock_increment(int inc) * If task level debugging is configured this routine updates the low resolution * debugging timer and determines if task level processing should be suspended. * - * RETURNS: 0 if task level processing should be halted or 1 if not + * @return 0 if task level processing should be halted or 1 if not * * \NOMANUAL */ @@ -173,7 +173,7 @@ static inline int _TlDebugUpdate(int32_t ticks) * This routine checks to see if it is time for the current task * to relinquish control, and yields CPU if so. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -203,7 +203,7 @@ static inline void _TimeSliceUpdate(void) * tick counter. * If tickless idle support is not configured in it simply returns 1. * - * RETURNS: number of ticks to process + * @return number of ticks to process * * \NOMANUAL */ @@ -232,7 +232,7 @@ static inline int32_t _SysIdleElapsedTicksGet(void) * This routine informs other microkernel subsystems that a tick event has * occurred. * - * RETURNS: 1 + * @return 1 */ int _k_ticker(int event) @@ -282,7 +282,7 @@ int _k_ticker(int event) * * To disable timeslicing, call the API with both parameters set to zero. * - * RETURNS: N/A + * @return N/A */ void sys_scheduler_time_slice_set(int32_t t, kpriority_t p) @@ -300,7 +300,7 @@ void sys_scheduler_time_slice_set(int32_t t, kpriority_t p) * This routine, called by K_swapper(), handles the request for calculating the * time elapsed since the specified reference time. * - * RETURNS: N/A + * @return N/A */ void _k_time_elapse(struct k_args *P) @@ -328,7 +328,7 @@ void _k_time_elapse(struct k_args *P) * * Note that it is not necessary to allocate a timer to use this call. * - * RETURNS: elapsed time in system ticks + * @return elapsed time in system ticks */ int64_t task_tick_delta(int64_t *reftime /* pointer to reference time */ diff --git a/kernel/microkernel/k_timer.c b/kernel/microkernel/k_timer.c index 0329fba4109..78a7770f593 100644 --- a/kernel/microkernel/k_timer.c +++ b/kernel/microkernel/k_timer.c @@ -56,7 +56,7 @@ struct k_timer *_k_timer_list_tail = NULL; * This algorithm also set the upper 16 bits of the object identifier * to the same value utilized by the microkernel system generator. * - * RETURNS: timer object identifier + * @return timer object identifier */ static inline ktimer_t _timer_ptr_to_id(struct k_timer *timer) @@ -70,7 +70,7 @@ static inline ktimer_t _timer_ptr_to_id(struct k_timer *timer) * * This routine converts a timer object identifier into a timer pointer. * - * RETURNS: timer pointer + * @return timer pointer */ static inline struct k_timer *_timer_id_to_ptr(ktimer_t timer) @@ -82,7 +82,7 @@ static inline struct k_timer *_timer_id_to_ptr(ktimer_t timer) * * _k_timer_enlist - insert a timer into the timer queue * - * RETURNS: N/A + * @return N/A */ void _k_timer_enlist(struct k_timer *T) @@ -114,7 +114,7 @@ void _k_timer_enlist(struct k_timer *T) * * _k_timer_delist - remove a timer from the timer queue * - * RETURNS: N/A + * @return N/A */ void _k_timer_delist(struct k_timer *T) @@ -140,7 +140,7 @@ void _k_timer_delist(struct k_timer *T) * * Allocates timer for command packet and inserts it into the timer queue. * - * RETURNS: N/A + * @return N/A */ void _k_timeout_alloc(struct k_args *P) @@ -165,7 +165,7 @@ void _k_timeout_alloc(struct k_args *P) * The command that is processed following cancellation is typically NOT the * command that would have occurred had the timeout expired on its own. * - * RETURNS: N/A + * @return N/A */ void _k_timeout_cancel(struct k_args *A) @@ -184,7 +184,7 @@ void _k_timeout_cancel(struct k_args *A) * * Cancels timer (if not already expired), then frees it. * - * RETURNS: N/A + * @return N/A */ void _k_timeout_free(struct k_timer *T) @@ -209,7 +209,7 @@ void _k_timeout_free(struct k_timer *T) * and that a periodic timer may exhibit a slow, ever-increasing degree of drift * from the main system timer over long intervals. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -253,7 +253,7 @@ void _k_timer_list_update(int ticks) * * @param P Pointer to timer allocation request arguments. * - * RETURNS: N/A + * @return N/A */ void _k_timer_alloc(struct k_args *P) @@ -273,7 +273,7 @@ void _k_timer_alloc(struct k_args *P) * * task_timer_alloc - allocate a timer and return its object identifier * - * RETURNS: timer identifier + * @return timer identifier */ ktimer_t task_timer_alloc(void) @@ -293,7 +293,7 @@ ktimer_t task_timer_alloc(void) * This routine, called by K_swapper(), handles the request for deallocating a * timer. * - * RETURNS: N/A + * @return N/A */ void _k_timer_dealloc(struct k_args *P) @@ -317,7 +317,7 @@ void _k_timer_dealloc(struct k_args *P) * * @param timer Timer to deallocate. * - * RETURNS: N/A + * @return N/A */ void task_timer_free(ktimer_t timer) @@ -338,7 +338,7 @@ void task_timer_free(ktimer_t timer) * * @param P Pointer to timer start request arguments. * - * RETURNS: N/A + * @return N/A */ void _k_timer_start(struct k_args *P) @@ -400,7 +400,7 @@ void _k_timer_start(struct k_args *P) * @param period Repetition interval in ticks. * @param sema Semaphore to signal. * - * RETURNS: N/A + * @return N/A */ void task_timer_start(ktimer_t timer, int32_t duration, int32_t period, @@ -426,7 +426,7 @@ void task_timer_start(ktimer_t timer, int32_t duration, int32_t period, * @param duration Initial delay. * @param period Repetition interval. * - * RETURNS: N/A + * @return N/A */ void task_timer_restart(ktimer_t timer, int32_t duration, int32_t period) @@ -448,7 +448,7 @@ void task_timer_restart(ktimer_t timer, int32_t duration, int32_t period) * This routine, called by K_swapper(), handles the request for stopping a * timer. * - * RETURNS: N/A + * @return N/A */ void _k_timer_stop(struct k_args *P) @@ -468,7 +468,7 @@ void _k_timer_stop(struct k_args *P) * * @param timer Timer to stop. * - * RETURNS: N/A + * @return N/A */ void task_timer_stop(ktimer_t timer) @@ -487,7 +487,7 @@ void task_timer_stop(ktimer_t timer) * This routine, called by K_swapper(), handles the request for waking a task * at the end of its sleep period. * - * RETURNS: N/A + * @return N/A */ void _k_task_wakeup(struct k_args *P) @@ -509,7 +509,7 @@ void _k_task_wakeup(struct k_args *P) * This routine, called by K_swapper(), handles the request for putting a task * to sleep. * - * RETURNS: N/A + * @return N/A */ void _k_task_sleep(struct k_args *P) @@ -543,7 +543,7 @@ void _k_task_sleep(struct k_args *P) * * @param ticks Number of ticks for which to sleep. * - * RETURNS: N/A + * @return N/A */ void task_sleep(int32_t ticks) diff --git a/kernel/nanokernel/compiler_stack_protect.c b/kernel/nanokernel/compiler_stack_protect.c index 7bea0e907ec..4792855d350 100644 --- a/kernel/nanokernel/compiler_stack_protect.c +++ b/kernel/nanokernel/compiler_stack_protect.c @@ -54,7 +54,7 @@ function __stack_chk_fail and global variable __stack_chk_guard. * * This function is invoked when a stack canary error is detected. * - * RETURNS: Does not return + * @return Does not return */ void FUNC_NORETURN _StackCheckHandler(void) diff --git a/kernel/nanokernel/idle.c b/kernel/nanokernel/idle.c index d42ac041ad8..c5fd199236a 100644 --- a/kernel/nanokernel/idle.c +++ b/kernel/nanokernel/idle.c @@ -49,7 +49,7 @@ data structure. * * Sets the nanokernel data structure idle field to a non-zero value. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/kernel/nanokernel/int_latency_bench.c b/kernel/nanokernel/int_latency_bench.c index 454054e81e7..103ea5ce073 100644 --- a/kernel/nanokernel/int_latency_bench.c +++ b/kernel/nanokernel/int_latency_bench.c @@ -73,7 +73,7 @@ uint32_t _hw_irq_to_c_handler_latency = ULONG_MAX; * calls to lock interrupt can nest, so this routine can be called numerous * times before interrupt are unlocked * - * RETURNS: N/A + * @return N/A * */ @@ -93,7 +93,7 @@ void _int_latency_start(void) * * This is only call once when the interrupt are being reenabled * - * RETURNS: N/A + * @return N/A * */ @@ -144,7 +144,7 @@ void _int_latency_stop(void) * * int_latency_init - initialize interrupt latency benchmark * - * RETURNS: N/A + * @return N/A * */ @@ -197,7 +197,7 @@ void int_latency_init(void) * * The interrupt latency value measures * - * RETURNS: N/A + * @return N/A * */ diff --git a/kernel/nanokernel/nano_context.c b/kernel/nanokernel/nano_context.c index c12ea9f1b39..18ab7b6a2a5 100644 --- a/kernel/nanokernel/nano_context.c +++ b/kernel/nanokernel/nano_context.c @@ -49,7 +49,7 @@ tasks or fibers. * This routine returns a pointer to the context control block of the currently * executing context. It is cast to a nano_context_id_t for use publically. * - * RETURNS: nano_context_id_t of the currently executing context. + * @return nano_context_id_t of the currently executing context. */ nano_context_id_t context_self_get(void) @@ -63,7 +63,7 @@ nano_context_id_t context_self_get(void) * * This routine returns the type of context currently executing. * - * RETURNS: nano_context_type_t of the currently executing context. + * @return nano_context_type_t of the currently executing context. */ nano_context_type_t context_type_get(void) @@ -85,7 +85,7 @@ nano_context_type_t context_type_get(void) * option; exceptions raised by this context will be treated as a fatal * system error. * - * RETURNS: N/A + * @return N/A */ void _context_essential_set(void) @@ -101,7 +101,7 @@ void _context_essential_set(void) * option; exceptions raised by this context may be recoverable. * (This is the default tag for a context.) * - * RETURNS: N/A + * @return N/A */ void _context_essential_clear(void) @@ -117,7 +117,7 @@ void _context_essential_clear(void) * context. A NULL context pointer indicates that the current context is * to be queried. * - * RETURNS: Non-zero if specified context is essential, zero if it is not + * @return Non-zero if specified context is essential, zero if it is not */ int _context_essential_check(tCCS *pCtx /* pointer to context */ @@ -136,7 +136,7 @@ int _context_essential_check(tCCS *pCtx /* pointer to context */ * Custom data is not used by the kernel itself, and is freely available * for the context to use as it sees fit. * - * RETURNS: N/A + * @return N/A */ void context_custom_data_set(void *value /* new value */ @@ -151,7 +151,7 @@ void context_custom_data_set(void *value /* new value */ * * This function returns the custom data value for the current task or fiber. * - * RETURNS: current handle value + * @return current handle value */ void *context_custom_data_get(void) @@ -173,7 +173,7 @@ void *context_custom_data_get(void) * This routine must be invoked from a fiber to guarantee that the list * of contexts does not change in mid-operation. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -220,7 +220,7 @@ void _context_exit(tCCS *pContext) * The analogous entry point function for user-mode task contexts is called * _ContextUsrEntryRtn(). * - * RETURNS: Does not return + * @return Does not return * * \NOMANUAL */ diff --git a/kernel/nanokernel/nano_fiber.c b/kernel/nanokernel/nano_fiber.c index be6490d0585..906fd97196f 100644 --- a/kernel/nanokernel/nano_fiber.c +++ b/kernel/nanokernel/nano_fiber.c @@ -52,7 +52,7 @@ either in the form of an actual function or an alias to a function. * Interrupts must already be locked to ensure list cannot change * while this routine is executing! * - * RETURNS: N/A + * @return N/A */ void _nano_fiber_schedule(tCCS *ccs) @@ -99,7 +99,7 @@ FUNC_ALIAS(_fiber_start, fiber_start, void); * performance critical, a runtime check to differentiate between a calling * task or fiber is performed in order to conserve footprint. * - * RETURNS: N/A + * @return N/A */ void _fiber_start(char *pStack, @@ -156,7 +156,7 @@ void _fiber_start(char *pStack, * * This routine can only be called from a fiber context. * - * RETURNS: N/A + * @return N/A */ void fiber_yield(void) @@ -185,7 +185,7 @@ void fiber_yield(void) * * This routine can only be called from a fiber context. * - * RETURNS: This function never returns + * @return This function never returns */ FUNC_NORETURN void _nano_fiber_swap(void) @@ -224,7 +224,7 @@ FUNC_NORETURN void _nano_fiber_swap(void) * * This routine can only be called from a fiber context. * - * RETURNS: This function never returns + * @return This function never returns */ FUNC_NORETURN void fiber_abort(void) diff --git a/kernel/nanokernel/nano_fifo.c b/kernel/nanokernel/nano_fifo.c index 88b1a1acdc4..8dcdc0604f8 100644 --- a/kernel/nanokernel/nano_fifo.c +++ b/kernel/nanokernel/nano_fifo.c @@ -60,7 +60,7 @@ APIs to the same function, since they have identical implementations. * * It may be called from either a fiber or task context. * - * RETURNS: N/A + * @return N/A * * INTERNAL * Although the existing implementation will support invocation from an ISR @@ -98,7 +98,7 @@ FUNC_ALIAS(_fifo_put_non_preemptible, nano_fiber_fifo_put, void); * * enqueue_data - internal routine to append data to a fifo * - * RETURNS: N/A + * @return N/A */ static inline void enqueue_data(struct nano_fifo *fifo, void *data) @@ -119,7 +119,7 @@ static inline void enqueue_data(struct nano_fifo *fifo, void *data) * If a fiber is waiting on the fifo, the address of the element is returned to * the waiting fiber. Otherwise, the element is linked to the end of the list. * - * RETURNS: N/A + * @return N/A * * INTERNAL * This function is capable of supporting invocations from both a fiber and an @@ -160,7 +160,7 @@ void _fifo_put_non_preemptible( * If a fiber is waiting on the fifo, the address of the element is returned to * the waiting fiber. Otherwise, the element is linked to the end of the list. * - * RETURNS: N/A + * @return N/A */ void nano_task_fifo_put( @@ -212,7 +212,7 @@ FUNC_ALIAS(_fifo_get, nano_fifo_get, void *); * * dequeue_data - internal routine to remove data from a fifo * - * RETURNS: the data item removed + * @return the data item removed */ static inline void *dequeue_data(struct nano_fifo *fifo) @@ -244,7 +244,7 @@ static inline void *dequeue_data(struct nano_fifo *fifo) * element contains invalid data because that memory location was used to store * a pointer to the next element in the linked list. * - * RETURNS: Pointer to head element in the list if available, otherwise NULL + * @return Pointer to head element in the list if available, otherwise NULL * * INTERNAL * This function is capable of supporting invocations from fiber, task, and ISR @@ -284,7 +284,7 @@ void *_fifo_get( * The first word in the element contains invalid data because that memory * location was used to store a pointer to the next element in the linked list. * - * RETURNS: Pointer to head element in the list + * @return Pointer to head element in the list * * INTERNAL There exists a separate nano_task_fifo_get_wait() implementation * since a task context cannot pend on a nanokernel object. Instead tasks will @@ -325,7 +325,7 @@ void *nano_fiber_fifo_get_wait( * The first word in the element contains invalid data because that memory * location was used to store a pointer to the next element in the linked list. * - * RETURNS: Pointer to head element in the list + * @return Pointer to head element in the list */ void *nano_task_fifo_get_wait( diff --git a/kernel/nanokernel/nano_init.c b/kernel/nanokernel/nano_init.c index e44dd5d7db3..88442ecf4ac 100644 --- a/kernel/nanokernel/nano_init.c +++ b/kernel/nanokernel/nano_init.c @@ -158,7 +158,7 @@ static void _main(void) * Note that all fields of "_nanokernel" are set to zero on entry, which may * be all the initialization many of them require. * - * RETURNS: N/A + * @return N/A */ static void nano_init(tCCS *dummyOutContext) @@ -262,7 +262,7 @@ extern void *__stack_chk_guard; * The processor must be running in 32-bit mode, and the BSS must have been * cleared/zeroed. * - * RETURNS: Does not return + * @return Does not return */ FUNC_NORETURN void _Cstart(void) diff --git a/kernel/nanokernel/nano_lifo.c b/kernel/nanokernel/nano_lifo.c index 38c05e94aad..0dc403008d7 100644 --- a/kernel/nanokernel/nano_lifo.c +++ b/kernel/nanokernel/nano_lifo.c @@ -59,7 +59,7 @@ APIs to the same function, since they have identical implementations. * * It may be called from either a fiber or task context. * - * RETURNS: N/A + * @return N/A * * INTERNAL * Although the existing implementation will support invocation from an ISR @@ -86,7 +86,7 @@ FUNC_ALIAS(_lifo_put_non_preemptible, nano_fiber_lifo_put, void); * called from either a fiber or an ISR context. A fiber pending on the lifo * object will be made ready, but will NOT be scheduled to execute. * - * RETURNS: N/A + * @return N/A * * INTERNAL * This function is capable of supporting invocations from both a fiber and an @@ -126,7 +126,7 @@ void _lifo_put_non_preemptible( * * This routine is only callable by a task. * - * RETURNS: N/A + * @return N/A */ void nano_task_lifo_put( @@ -167,7 +167,7 @@ FUNC_ALIAS(_lifo_get, nano_task_lifo_get, void *); * element contains invalid data because that memory location was used to store * a pointer to the next element in the linked list. * - * RETURNS: Pointer to first element in the list if available, otherwise NULL + * @return Pointer to first element in the list if available, otherwise NULL * * INTERNAL * This function is capable of supporting invocations from fiber, task, and ISR @@ -209,7 +209,7 @@ void *_lifo_get( * The first word in the element contains invalid data because that memory * location was used to store a pointer to the next element in the linked list. * - * RETURNS: Pointer to first element in the list + * @return Pointer to first element in the list * * INTERNAL * There exists a separate nano_task_lifo_get_wait() implementation since a @@ -251,7 +251,7 @@ void *nano_fiber_lifo_get_wait( * The first word in the element contains invalid data because that memory * location was used to store a pointer to the next element in the linked list. * - * RETURNS: Pointer to first element in the list + * @return Pointer to first element in the list */ void *nano_task_lifo_get_wait( @@ -294,7 +294,7 @@ void *nano_task_lifo_get_wait( * Get the first element from the specified lifo but generate a fatal error * if the element is NULL. * - * RETURNS: Pointer to first element in the list + * @return Pointer to first element in the list * * \NOMANUAL */ diff --git a/kernel/nanokernel/nano_sema.c b/kernel/nanokernel/nano_sema.c index 11a2244f6fe..3811c1fecac 100644 --- a/kernel/nanokernel/nano_sema.c +++ b/kernel/nanokernel/nano_sema.c @@ -65,7 +65,7 @@ APIs to the same function, since they have identical implementations. * * It may be called from either a fiber or task context. * - * RETURNS: N/A + * @return N/A * * INTERNAL * Although the existing implementation will support invocation from an ISR @@ -99,7 +99,7 @@ FUNC_ALIAS(_sem_give_non_preemptible, nano_fiber_sem_give, void); * the semaphore object will be made ready, but will NOT be scheduled to * execute. * - * RETURNS: N/A + * @return N/A * * INTERNAL * This function is capable of supporting invocations from both a fiber and an @@ -136,7 +136,7 @@ void _sem_give_non_preemptible( * semaphore object will be made ready, and will preempt the running task * immediately. * - * RETURNS: N/A + * @return N/A */ void nano_task_sem_give( @@ -192,7 +192,7 @@ FUNC_ALIAS(_sem_take, nano_task_sem_take, int); * If the semaphore is not available, this function returns immediately, i.e. * a wait (pend) operation will NOT be performed. * - * RETURNS: 1 if semaphore is available, 0 otherwise + * @return 1 if semaphore is available, 0 otherwise */ int _sem_take( @@ -220,7 +220,7 @@ int _sem_take( * is 0, the calling fiber context will wait (pend) until the semaphore is * given (via nano_fiber_sem_give/nano_task_sem_give/nano_isr_sem_give). * - * RETURNS: N/A + * @return N/A * * INTERNAL * There exists a separate nano_task_sem_take_wait() implementation since a task @@ -254,7 +254,7 @@ void nano_fiber_sem_take_wait( * is 0, the calling task will poll until the semaphore is given * (via nano_fiber_sem_give/nano_task_sem_give/nano_isr_sem_give). * - * RETURNS: N/A + * @return N/A */ void nano_task_sem_take_wait( diff --git a/kernel/nanokernel/nano_stack.c b/kernel/nanokernel/nano_stack.c index 308c55a301d..48a97d515b3 100644 --- a/kernel/nanokernel/nano_stack.c +++ b/kernel/nanokernel/nano_stack.c @@ -58,7 +58,7 @@ APIs to the same function, since they have identical implementations. * * It may be called from either a fiber or a task context. * - * RETURNS: N/A + * @return N/A * * INTERNAL * Although the existing implementation will support invocation from an ISR @@ -86,7 +86,7 @@ FUNC_ALIAS(_stack_push_non_preemptible, nano_fiber_stack_push, void); * either a fiber or ISR context. A fiber pending on the stack object will be * made ready, but will NOT be scheduled to execute. * - * RETURNS: N/A + * @return N/A * * INTERNAL * This function is capable of supporting invocations from both a fiber and an @@ -126,7 +126,7 @@ void _stack_push_non_preemptible( * from a task context. A fiber pending on the stack object will be * made ready, and will preempt the running task immediately. * - * RETURNS: N/A + * @return N/A */ void nano_task_stack_push( @@ -169,7 +169,7 @@ FUNC_ALIAS(_stack_pop, nano_task_stack_pop, int); * address and a non-zero value is returned. If the stack is empty, * zero is returned. * - * RETURNS: 1 if stack is not empty, 0 otherwise + * @return 1 if stack is not empty, 0 otherwise * * INTERNAL * This function is capable of supporting invocations from fiber, task, and @@ -209,7 +209,7 @@ int _stack_pop( * If data is not available the calling fiber will pend until data is pushed * onto the stack. * - * RETURNS: the data popped from the stack + * @return the data popped from the stack * * INTERNAL * There exists a separate nano_task_stack_pop_wait() implementation since a @@ -248,7 +248,7 @@ uint32_t nano_fiber_stack_pop_wait( * If data is not available the calling task will poll until data is pushed * onto the stack. * - * RETURNS: the data popped from the stack + * @return the data popped from the stack */ uint32_t nano_task_stack_pop_wait( diff --git a/kernel/nanokernel/nano_sys_clock.c b/kernel/nanokernel/nano_sys_clock.c index 23a30455f90..58211678e36 100644 --- a/kernel/nanokernel/nano_sys_clock.c +++ b/kernel/nanokernel/nano_sys_clock.c @@ -57,7 +57,7 @@ uint32_t _sys_idle_elapsed_ticks = 1; * * nano_time_init - constructor that initializes nanokernel time tracking system * - * RETURNS: N/A + * @return N/A * */ @@ -76,7 +76,7 @@ int64_t _nano_ticks = 0; * * nano_tick_get_32 - return the lower part of the current system tick count * - * RETURNS: the current system tick count + * @return the current system tick count * */ @@ -89,7 +89,7 @@ uint32_t nano_tick_get_32(void) * * nano_tick_get - return the current system tick count * - * RETURNS: the current system tick count + * @return the current system tick count * */ @@ -112,7 +112,7 @@ int64_t nano_tick_get(void) * * nano_cycle_get_32 - return a high resolution timestamp * - * RETURNS: the current timer hardware count + * @return the current timer hardware count * */ @@ -144,7 +144,7 @@ uint32_t nano_cycle_get_32(void) * [do more stuff] * y = nano_tick_delta(&reftime); /# how long since [do stuff] #/ * - * RETURNS: tick count since reference time; undefined for first invocation + * @return tick count since reference time; undefined for first invocation * * NOTE: We use inline function for both 64-bit and 32-bit functions. * Compiler optimizes out 64-bit result handling in 32-bit version. @@ -174,7 +174,7 @@ static ALWAYS_INLINE int64_t _nano_tick_delta(int64_t *reftime) * * nano_tick_delta - return number of ticks since a reference time * - * RETURNS: tick count since reference time; undefined for first invocation + * @return tick count since reference time; undefined for first invocation */ int64_t nano_tick_delta(int64_t *reftime) @@ -186,7 +186,7 @@ int64_t nano_tick_delta(int64_t *reftime) * * nano_tick_delta_32 - return 32-bit number of ticks since a reference time * - * RETURNS: 32-bit tick count since reference time; undefined for first invocation + * @return 32-bit tick count since reference time; undefined for first invocation */ uint32_t nano_tick_delta_32(int64_t *reftime) @@ -242,7 +242,7 @@ static inline void handle_expired_nano_timers(int ticks) * tick is to be announced to the nanokernel. It takes care of dequeuing the * timers that have expired and wake up the fibers pending on them. * - * RETURNS: N/A + * @return N/A */ void _nano_sys_clock_tick_announce(uint32_t ticks) diff --git a/kernel/nanokernel/nano_timer.c b/kernel/nanokernel/nano_timer.c index f677f6b1f64..b71d12e6d6d 100644 --- a/kernel/nanokernel/nano_timer.c +++ b/kernel/nanokernel/nano_timer.c @@ -46,7 +46,7 @@ struct nano_timer *_nano_timer_list = NULL; * in its first field, that may be overwritten when the timer expires, plus * whatever data the user wishes to store and recover when the timer expires. * - * RETURNS: N/A + * @return N/A * */ @@ -63,7 +63,7 @@ void nano_timer_init(struct nano_timer *timer, void *userData) * This function starts a previously initialized nanokernel timer object. * The timer will expire in system clock ticks. * - * RETURNS: N/A + * @return N/A * */ @@ -76,7 +76,7 @@ FUNC_ALIAS(_timer_start, nano_fiber_timer_start, void); * This function starts a previously initialized nanokernel timer object. * The timer will expire in system clock ticks. * - * RETURNS: N/A + * @return N/A * */ @@ -89,7 +89,7 @@ FUNC_ALIAS(_timer_start, nano_task_timer_start, void); * This function starts a previously initialized nanokernel timer object. * The timer will expire in system clock ticks. * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -133,7 +133,7 @@ void _timer_start(struct nano_timer *timer, /* timer to start */ * * This function stops a previously started nanokernel timer object. * - * RETURNS: N/A + * @return N/A * * NOMANUAL */ @@ -182,7 +182,7 @@ static void _timer_stop(struct nano_timer *timer /* timer to stop */ * * This function stops a previously started nanokernel timer object. * - * RETURNS: N/A + * @return N/A * */ @@ -204,7 +204,7 @@ void nano_fiber_timer_stop(struct nano_timer *timer /* timer to stop */ * * This function stops a previously started nanokernel timer object. * - * RETURNS: N/A + * @return N/A * */ @@ -228,7 +228,7 @@ void nano_task_timer_stop(struct nano_timer *timer /* timer to stop */ * have been initialized by nano_timer_init() and started via either * nano_fiber_timer_start() or nano_task_timer_start() first. * - * RETURNS: pointer to timer initialization data, or NULL if timer not expired + * @return pointer to timer initialization data, or NULL if timer not expired * */ @@ -247,7 +247,7 @@ void *nano_fiber_timer_test(struct nano_timer *timer /* timer to check */ * nano_fiber_timer_start() or nano_task_timer_start() first and must not * have been stopped via nano_task_timer_stop() or nano_fiber_timer_stop(). * - * RETURNS: pointer to timer initialization data + * @return pointer to timer initialization data * */ @@ -265,7 +265,7 @@ void *nano_fiber_timer_wait(struct nano_timer *timer /* timer to pend on */ * have been initialized by nano_timer_init() and started via either * nano_fiber_timer_start() or nano_task_timer_start() first. * - * RETURNS: pointer to timer initialization data, or NULL if timer not expired + * @return pointer to timer initialization data, or NULL if timer not expired * */ @@ -284,7 +284,7 @@ void *nano_task_timer_test(struct nano_timer *timer /* timer to check */ * nano_fiber_timer_start() or nano_task_timer_start() first and must not * have been stopped via nano_task_timer_stop() or nano_fiber_timer_stop(). * - * RETURNS: pointer to timer initialization data + * @return pointer to timer initialization data * */ diff --git a/kernel/nanokernel/version.c b/kernel/nanokernel/version.c index 28d7761d039..7215ff1e216 100644 --- a/kernel/nanokernel/version.c +++ b/kernel/nanokernel/version.c @@ -42,7 +42,7 @@ static uint32_t kernel_version = KERNELVERSION; * The kernel version is a four-byte value, whose format is decribed in the * file "kernel_version.h". * - * RETURNS: kernel version + * @return kernel version */ uint32_t sys_kernel_version_get(void) diff --git a/lib/libc/minimal/source/stdout/prf.c b/lib/libc/minimal/source/stdout/prf.c index 5c908ec3dfe..ce72b00c0e6 100644 --- a/lib/libc/minimal/source/stdout/prf.c +++ b/lib/libc/minimal/source/stdout/prf.c @@ -508,7 +508,7 @@ static int _to_float(char *buf, uint32_t double_temp[], int full, int c, * primitive that is footprint conversative, i.e. it does not utilize a * lookup table. * - * RETURNS: non-zero if input integer in an ASCII digit character + * @return non-zero if input integer in an ASCII digit character * * INTERNAL */ diff --git a/lib/libc/minimal/source/string/string.c b/lib/libc/minimal/source/string/string.c index 75d2cde2828..b2d81b969cf 100644 --- a/lib/libc/minimal/source/string/string.c +++ b/lib/libc/minimal/source/string/string.c @@ -36,7 +36,7 @@ * * strcpy - copy a string * - * RETURNS: pointer to destination buffer + * @return pointer to destination buffer */ char *strcpy(char *restrict d, const char *restrict s) @@ -58,7 +58,7 @@ char *strcpy(char *restrict d, const char *restrict s) * * strncpy - copy part of a string * - * RETURNS: pointer to destination buffer + * @return pointer to destination buffer */ char *strncpy(char *restrict d, const char *restrict s, size_t n) @@ -85,7 +85,7 @@ char *strncpy(char *restrict d, const char *restrict s, size_t n) * * strchr - string scanning operation * - * RETURNS: pointer to 1st instance of found byte, or NULL if not found + * @return pointer to 1st instance of found byte, or NULL if not found */ char *strchr(const char *s, int c) @@ -102,7 +102,7 @@ char *strchr(const char *s, int c) * * strlen - get string length * - * RETURNS: number of bytes in string + * @return number of bytes in string */ size_t strlen(const char *s) @@ -121,7 +121,7 @@ size_t strlen(const char *s) * * strcmp - compare two strings * - * RETURNS: negative # if < , 0 if == , else positive # + * @return negative # if < , 0 if == , else positive # */ int strcmp(const char *s1, const char *s2) @@ -138,7 +138,7 @@ int strcmp(const char *s1, const char *s2) * * strncmp - compare part of two strings * - * RETURNS: negative # if < , 0 if == , else positive # + * @return negative # if < , 0 if == , else positive # */ int strncmp(const char *s1, const char *s2, size_t n) @@ -156,7 +156,7 @@ int strncmp(const char *s1, const char *s2, size_t n) * * memcmp - compare two memory areas * - * RETURNS: negative # if < , 0 if == , else positive # + * @return negative # if < , 0 if == , else positive # */ int memcmp(const void *m1, const void *m2, size_t n) @@ -179,7 +179,7 @@ int memcmp(const void *m1, const void *m2, size_t n) * * memmove - copy bytes in memory with overlapping areas * - * RETURNS: pointer to destination buffer + * @return pointer to destination buffer */ void *memmove(void *d, const void *s, size_t n) @@ -214,7 +214,7 @@ void *memmove(void *d, const void *s, size_t n) * * memcpy - copy bytes in memory * - * RETURNS: pointer to start of destination buffer + * @return pointer to start of destination buffer */ void *memcpy(void *restrict d, const void *restrict s, size_t n) @@ -264,7 +264,7 @@ void *memcpy(void *restrict d, const void *restrict s, size_t n) * * memset - set bytes in memory * - * RETURNS: pointer to start of buffer + * @return pointer to start of buffer */ void *memset(void *buf, int c, size_t n) diff --git a/misc/printk.c b/misc/printk.c index 352722fdc4b..b0cd61bd791 100644 --- a/misc/printk.c +++ b/misc/printk.c @@ -50,7 +50,7 @@ static void _printk_hex_ulong(const unsigned long num); * * _nop_char_out - default character output routine that does nothing * - * RETURNS: 0 + * @return 0 */ static int _nop_char_out(int c /* character to swallow */ @@ -72,7 +72,7 @@ static int (*_char_out)(int) = _nop_char_out; * To be called by the BSP's console driver at init time. Installs a routine * that outputs one ASCII character at a time. * - * RETURNS: N/A + * @return N/A */ void __printk_hook_install(int (*fn)(int) /* putc routine to install */ @@ -87,7 +87,7 @@ void __printk_hook_install(int (*fn)(int) /* putc routine to install */ * * See printk() for description. * - * RETURNS: N/A + * @return N/A */ static inline void _vprintk(const char *fmt, /* format string */ @@ -169,7 +169,7 @@ static inline void _vprintk(const char *fmt, /* format string */ * - %p: pointer, same as %x * - %d/%i/%u: outputs a 32-bit number in unsigned decimal format. * - * RETURNS: N/A + * @return N/A */ void printk(const char *fmt, /* formatted string to output */ @@ -189,7 +189,7 @@ void printk(const char *fmt, /* formatted string to output */ * Output an unsigned long on output installed by BSP at init time. Should be * able to handle an unsigned long of any size, 32 or 64 bit. * - * RETURNS: N/A + * @return N/A */ static void _printk_hex_ulong( @@ -212,7 +212,7 @@ static void _printk_hex_ulong( * Output an unsigned long on output installed by BSP at init time. Only works * with 32-bit values. * - * RETURNS: N/A + * @return N/A */ static void _printk_dec_ulong( @@ -242,7 +242,7 @@ static void _printk_dec_ulong( * * Debugging output is dropped if it is not to be sent to the console. * - * RETURNS: N/A + * @return N/A */ void printk(const char *fmt, ...) diff --git a/samples/microkernel/apps/philosophers/src/phil_fiber.c b/samples/microkernel/apps/philosophers/src/phil_fiber.c index 4d3bbb02ed7..06cb2f1f500 100644 --- a/samples/microkernel/apps/philosophers/src/phil_fiber.c +++ b/samples/microkernel/apps/philosophers/src/phil_fiber.c @@ -68,7 +68,7 @@ kmutex_t forks[] = {forkMutex0, forkMutex1, forkMutex2, forkMutex3, forkMutex4, * @param id Philosopher ID. * @param str EATING or THINKING. * - * RETURNS: N/A + * @return N/A */ static void myPrint(int id, char *str) @@ -82,7 +82,7 @@ static void myPrint(int id, char *str) * * @param ticks Number of ticks to delay. * - * RETURNS: N/A + * @return N/A */ static void myDelay(int ticks) @@ -105,7 +105,7 @@ static void myDelay(int ticks) * This routine runs as a task in the microkernel environment * and as a fiber in the nanokernel environment. * - * RETURNS: N/A + * @return N/A */ void philEntry(void) diff --git a/samples/microkernel/apps/philosophers/src/phil_task.c b/samples/microkernel/apps/philosophers/src/phil_task.c index f4a1dc82e70..65329c4f612 100644 --- a/samples/microkernel/apps/philosophers/src/phil_task.c +++ b/samples/microkernel/apps/philosophers/src/phil_task.c @@ -65,7 +65,7 @@ struct nano_sem forks[N_PHILOSOPHERS]; * * main - nanokernel entry point * - * RETURNS: does not return + * @return does not return */ int main(void) @@ -97,7 +97,7 @@ int main(void) * * philDemo - routine to start dining philosopher demo * - * RETURNS: does not return + * @return does not return */ void philDemo(void) diff --git a/samples/microkernel/benchmark/app_kernel/src/event_b.c b/samples/microkernel/benchmark/app_kernel/src/event_b.c index 568a9552fcc..20920987928 100644 --- a/samples/microkernel/benchmark/app_kernel/src/event_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/event_b.c @@ -60,7 +60,7 @@ int example_handler (int event); * * event_test - event signal speed test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -184,7 +184,7 @@ void event_test(void) * The event handler for the test. Sets up nEventValue global variable. * This variable is used in the main test. * - * RETURNS: 1 + * @return 1 * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/fifo_b.c b/samples/microkernel/benchmark/app_kernel/src/fifo_b.c index b993cf4eb2b..209dcb56922 100644 --- a/samples/microkernel/benchmark/app_kernel/src/fifo_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/fifo_b.c @@ -38,7 +38,7 @@ * * queue_test - queue transfer speed test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/fifo_r.c b/samples/microkernel/benchmark/app_kernel/src/fifo_r.c index 17a64a19eaa..eb3144f2946 100644 --- a/samples/microkernel/benchmark/app_kernel/src/fifo_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/fifo_r.c @@ -40,7 +40,7 @@ * * dequtask - data receive task * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c b/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c index cf96fbc194b..4426dfe82ef 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c @@ -94,7 +94,7 @@ void mailbox_put(uint32_t size, int count, uint32_t *time); * * mailbox_test - mailbox transfer speed test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -145,7 +145,7 @@ void mailbox_test(void) * * mailbox_put - write the number of data chunks into the mailbox * - * RETURNS: N/A + * @return N/A * * @param size The size of the data chunk. * @param count Number of data chunks. diff --git a/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c b/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c index 0433e33371e..eaf1d785253 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c @@ -50,7 +50,7 @@ int mailbox_get(kmbox_t mailbox,int size,int count,unsigned int* time); * * mailrecvtask - receive task * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -85,7 +85,7 @@ void mailrecvtask(void) * * mailbox_get - receive data portions from the specified mailbox * - * RETURNS: 0 + * @return 0 * * @param mailbox The mailbox to read data from. * @param size Size of each data portion. diff --git a/samples/microkernel/benchmark/app_kernel/src/master.c b/samples/microkernel/benchmark/app_kernel/src/master.c index 006ea99b0de..167ccfb9fa4 100644 --- a/samples/microkernel/benchmark/app_kernel/src/master.c +++ b/samples/microkernel/benchmark/app_kernel/src/master.c @@ -65,7 +65,7 @@ uint32_t tm_off; * * kbhit - check for keypress * - * RETURNS: 1 when a keyboard key is pressed, or 0 if no keyboard support + * @return 1 when a keyboard key is pressed, or 0 if no keyboard support * * \NOMANUAL */ @@ -80,7 +80,7 @@ int kbhit(void) * * init_output - prepares the test output * - * RETURNS: N/A + * @return N/A * * @param continuously Run test till the user presses the key. * @param autorun Expect user input. @@ -103,7 +103,7 @@ void init_output(int *continuously, int *autorun) * * output_close - close output for the test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -120,7 +120,7 @@ void output_close(void) * * BenchTask - perform all selected benchmarks * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -175,7 +175,7 @@ void BenchTask(void) * * dummy_test - dummy test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/memmap_b.c b/samples/microkernel/benchmark/app_kernel/src/memmap_b.c index aa30ba16873..2b0fa7a538b 100644 --- a/samples/microkernel/benchmark/app_kernel/src/memmap_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/memmap_b.c @@ -40,7 +40,7 @@ * * memorymap_test - memory map get/free test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/mempool_b.c b/samples/microkernel/benchmark/app_kernel/src/mempool_b.c index 8d40ff531d4..a95ced8336c 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mempool_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/mempool_b.c @@ -38,7 +38,7 @@ * * mempool_test - memory pool get/free test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/mutex_b.c b/samples/microkernel/benchmark/app_kernel/src/mutex_b.c index 03afeb05f62..84aa2a5c1c5 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mutex_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/mutex_b.c @@ -38,7 +38,7 @@ * * mutex_test - mutex lock/unlock test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/nop_b.c b/samples/microkernel/benchmark/app_kernel/src/nop_b.c index 8576882decc..bdcf320e848 100644 --- a/samples/microkernel/benchmark/app_kernel/src/nop_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/nop_b.c @@ -42,7 +42,7 @@ extern void _task_nop(void); * * call_test - Kernel entry timing test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/pipe_b.c b/samples/microkernel/benchmark/app_kernel/src/pipe_b.c index 4bd5152f668..6ca66887f1a 100644 --- a/samples/microkernel/benchmark/app_kernel/src/pipe_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/pipe_b.c @@ -111,7 +111,7 @@ int pipeput(kpipe_t pipe, K_PIPE_OPTION * * pipe_test - test the pipes transfer speed * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -206,7 +206,7 @@ void pipe_test(void) * * pipeput - write a data portion to the pipe and measure time * - * RETURNS: 0 on success, 1 on error + * @return 0 on success, 1 on error * * @param pipe The pipe to be tested. * @param option _ALL_TO_N or _1_TO_N. diff --git a/samples/microkernel/benchmark/app_kernel/src/pipe_r.c b/samples/microkernel/benchmark/app_kernel/src/pipe_r.c index 89df6948d99..297dc98d4f9 100644 --- a/samples/microkernel/benchmark/app_kernel/src/pipe_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/pipe_r.c @@ -51,7 +51,7 @@ int pipeget(kpipe_t pipe, K_PIPE_OPTION option, * * piperecvtask - receive task * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -102,7 +102,7 @@ void piperecvtask(void) * * pipeget - read a data portion from the pipe and measure time * - * RETURNS: 0 on success, 1 on error + * @return 0 on success, 1 on error * * @param pipe Pipe to read data from. * @param option _ALL_TO_N or _1_TO_N. diff --git a/samples/microkernel/benchmark/app_kernel/src/receiver.c b/samples/microkernel/benchmark/app_kernel/src/receiver.c index 37a77537881..6151917de10 100644 --- a/samples/microkernel/benchmark/app_kernel/src/receiver.c +++ b/samples/microkernel/benchmark/app_kernel/src/receiver.c @@ -52,7 +52,7 @@ void piperecvtask(void); * * recvtask - main function of the task that receives data in the test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/sema_b.c b/samples/microkernel/benchmark/app_kernel/src/sema_b.c index 7bea6778a5e..db59a4794a9 100644 --- a/samples/microkernel/benchmark/app_kernel/src/sema_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/sema_b.c @@ -39,7 +39,7 @@ * * sema_test - semaphore signal speed test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/app_kernel/src/sema_r.c b/samples/microkernel/benchmark/app_kernel/src/sema_r.c index 259db13567d..c56590e4963 100644 --- a/samples/microkernel/benchmark/app_kernel/src/sema_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/sema_r.c @@ -41,7 +41,7 @@ * * waittask - receive task (Wait task) * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/boot_time/src/boot_time.c b/samples/microkernel/benchmark/boot_time/src/boot_time.c index e53daa85f81..3d92a7f7241 100644 --- a/samples/microkernel/benchmark/boot_time/src/boot_time.c +++ b/samples/microkernel/benchmark/boot_time/src/boot_time.c @@ -125,7 +125,7 @@ char __stack fiberStack[512]; * * main - nanokernel entry point * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c b/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c index a580ad9d063..0e79716f8db 100644 --- a/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c +++ b/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c @@ -132,7 +132,7 @@ static pfunc func_array[] = { * * dummyIsr - dummy ISR * - * RETURNS: N/A + * @return N/A */ void dummyIsr(void *unused) @@ -149,7 +149,7 @@ void dummyIsr(void *unused) * to avoid the preamble code the compiler automatically generates. However, * the unwanted preamble has an insignificant impact on total footprint. * - * RETURNS: N/A + * @return N/A */ static void isrDummyIntStub(void *unused) @@ -169,7 +169,7 @@ static void isrDummyIntStub(void *unused) * This routine prints a message, then simply increments a global counter. * (Gdb can be used to observe the counter as it increases.) * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/main.c b/samples/microkernel/benchmark/latency_measure/src/main.c index 5bd1d442948..0a6d39a77ee 100644 --- a/samples/microkernel/benchmark/latency_measure/src/main.c +++ b/samples/microkernel/benchmark/latency_measure/src/main.c @@ -48,7 +48,7 @@ int errorCount = 0; /* track number of errors */ * * nanoTest - test latency of nanokernel * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -79,7 +79,7 @@ void nanoTest(void) * * main - nanokernel-only testing entry point * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -106,7 +106,7 @@ void microTaskSwitchYield(void); * * microTest - test latency of microkernel * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -136,7 +136,7 @@ void microTest(void) * * main - microkernel testing entry point * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c index c2a78608e9b..1e7f1402c48 100644 --- a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c +++ b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task.c @@ -52,7 +52,7 @@ static uint32_t timestamp; * * The interrupt handler gets the second timestamp. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -72,7 +72,7 @@ static void latencyTestIsr(void *unused) * Function makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -93,7 +93,7 @@ static void makeInt(void) * * microIntToTask - the test main function * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c index ffa422d275f..4bce0a1d069 100644 --- a/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c +++ b/samples/microkernel/benchmark/latency_measure/src/micro_int_to_task_evt.c @@ -54,7 +54,7 @@ static uint32_t timestamp = 0; * * The interrupt handler gets the second timestamp. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -75,7 +75,7 @@ static void latencyTestIsr(void *unused) * released by the main task, sets up the interrupt handler and generates the * software interrupt * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ @@ -92,7 +92,7 @@ void microInt(void) * * microIntToTaskEvt - the test main function * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c b/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c index 8d500d5665a..92468a28cf1 100644 --- a/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c +++ b/samples/microkernel/benchmark/latency_measure/src/micro_sema_lock_release.c @@ -60,7 +60,7 @@ static uint32_t timestamp; * The routine performs unlock the quite amount of semaphores and then * acquires them in order to measure the necessary time. * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ @@ -110,7 +110,7 @@ int microSemaLockUnlock(void) * The routine performs multiple mutex locks and then multiple mutex * unlocks to measure the necessary time. * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c b/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c index 606b5b6727e..57d727e867e 100644 --- a/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c +++ b/samples/microkernel/benchmark/latency_measure/src/micro_task_switch_yield.c @@ -56,7 +56,7 @@ static uint32_t helper_task_iterations = 0; * * This task is define in .mdef as SEMYIELDTSK * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -73,7 +73,7 @@ void yieldingTask(void) * * microTaskSwitchYield - entry point for task context switch using yield test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c b/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c index 02c43f2c9c4..56c93bb314c 100644 --- a/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c +++ b/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c @@ -71,7 +71,7 @@ static volatile int ctxSwitchBalancer = 0; * Fiber makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -95,7 +95,7 @@ static void fiberOne(void) * Fiber starts, waits on semaphore. When the interrupt handler releases * the semaphore, fiber measures the time. * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ @@ -114,7 +114,7 @@ static void fiberTwo(void) * * nanoCtxSwitch - the test main function * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int.c b/samples/microkernel/benchmark/latency_measure/src/nano_int.c index d738aa7ad00..88b2f4b2d5b 100644 --- a/samples/microkernel/benchmark/latency_measure/src/nano_int.c +++ b/samples/microkernel/benchmark/latency_measure/src/nano_int.c @@ -54,7 +54,7 @@ static uint32_t timestamp; * * The interrupt handler gets the second timestamp. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -73,7 +73,7 @@ static void latencyTestIsr(void *unused) * Fiber makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -89,7 +89,7 @@ static void fiberInt(void) * * nanoIntLatency - the test main function * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c b/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c index 5c225840647..1389cab9786 100644 --- a/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c +++ b/samples/microkernel/benchmark/latency_measure/src/nano_int_lock_unlock.c @@ -53,7 +53,7 @@ static uint32_t timestamp = 0; * * nanoIntLockUnlock - the test main function * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c index ca83635d6ac..29ccd126a3b 100644 --- a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c +++ b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber.c @@ -56,7 +56,7 @@ static uint32_t timestamp; * * The interrupt handler gets the second timestamp. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -76,7 +76,7 @@ static void latencyTestIsr(void *unused) * Fiber makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -97,7 +97,7 @@ static void fiberInt(void) * * nanoIntToFiber - the test main function * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c index 7066356be9b..eebd3167800 100644 --- a/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c +++ b/samples/microkernel/benchmark/latency_measure/src/nano_int_to_fiber_sem.c @@ -67,7 +67,7 @@ static uint32_t timestamp = 0; * * The interrupt handler gets the second timestamp. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -87,7 +87,7 @@ static void latencyTestIsr(void *unused) * Fiber makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -106,7 +106,7 @@ static void fiberInt(void) * Fiber starts, waits on semaphore. When the interrupt handler releases * the semaphore, fiber measures the time. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -121,7 +121,7 @@ static void fiberWaiter(void) * * nanoIntToFiberSem - the test main function * - * RETURNS: 0 on success + * @return 0 on success * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/raise_int.c b/samples/microkernel/benchmark/latency_measure/src/raise_int.c index b1401c819a2..df3d79d50aa 100644 --- a/samples/microkernel/benchmark/latency_measure/src/raise_int.c +++ b/samples/microkernel/benchmark/latency_measure/src/raise_int.c @@ -1395,7 +1395,7 @@ static void (*intFPtr[256])(void) = { * This routine will call one of the genInt functions based upon the * value passed to it (which is essentially the interrupt vector number). * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -1413,7 +1413,7 @@ void raiseInt(uint8_t id) * * Trigger via NVIC. is the IRQ number. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/utils.c b/samples/microkernel/benchmark/latency_measure/src/utils.c index 1a4c5dd8699..d5c7807f316 100644 --- a/samples/microkernel/benchmark/latency_measure/src/utils.c +++ b/samples/microkernel/benchmark/latency_measure/src/utils.c @@ -64,7 +64,7 @@ char tmpString[TMP_STRING_SIZE]; * provided as an argument. It sets up allocated interrupt vector, pointer to * the current interrupt service routine and stub code memory block. * - * RETURNS: the allocated interrupt vector + * @return the allocated interrupt vector * * \NOMANUAL */ @@ -86,7 +86,7 @@ int initSwInterrupt(ptestIsr pIsrHdlr) * provided. This routine can be invoked only after the interrupt has been * initialized and connected by initSwInterrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -106,7 +106,7 @@ void setSwInterrupt(ptestIsr pIsrHdlr) * This routine can be invoked only after the interrupt has been * initialized and connected by initSwInterrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/benchmark/latency_measure/src/utils.h b/samples/microkernel/benchmark/latency_measure/src/utils.h index 63c0157124a..9bf35222f04 100644 --- a/samples/microkernel/benchmark/latency_measure/src/utils.h +++ b/samples/microkernel/benchmark/latency_measure/src/utils.h @@ -61,7 +61,7 @@ extern int errorCount; * * printDashLine - print dash line * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -122,7 +122,7 @@ typedef void (*ptestIsr) (void *unused); * provided as an argument. It sets up allocated interrupt vector, pointer to * the current interrupt service routine and stub code memory block. * - * RETURNS: the allocated interrupt vector + * @return the allocated interrupt vector * * \NOMANUAL */ @@ -137,7 +137,7 @@ int initSwInterrupt(ptestIsr pIsrHdlr); * provided. This routine can be invoked only after the interrupt has been * initialized and connected by initSwInterrupt. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/test/test_critical/src/critical.c b/samples/microkernel/test/test_critical/src/critical.c index 5b7b4cbd0c9..2db0c6271eb 100644 --- a/samples/microkernel/test/test_critical/src/critical.c +++ b/samples/microkernel/test/test_critical/src/critical.c @@ -51,7 +51,7 @@ static uint32_t altTaskIterations = 0; * * This routine increments the global variable . * - * RETURNS: 0 + * @return 0 */ int criticalRtn(void) @@ -70,7 +70,7 @@ int criticalRtn(void) * * @param count number of critical section calls made thus far * - * RETURNS: number of critical section calls made by task + * @return number of critical section calls made by task */ uint32_t criticalLoop(uint32_t count) @@ -92,7 +92,7 @@ uint32_t criticalLoop(uint32_t count) * * This routine calls task_offload_to_fiber() many times. * - * RETURNS: N/A + * @return N/A */ void AlternateTask(void) @@ -118,7 +118,7 @@ void AlternateTask(void) * ensure that the number of times it is called matches the global variable * . * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_events/src/events.c b/samples/microkernel/test/test_events/src/events.c index 66fbe3d0184..0221f5b5427 100644 --- a/samples/microkernel/test/test_events/src/events.c +++ b/samples/microkernel/test/test_events/src/events.c @@ -69,7 +69,7 @@ extern const int _k_num_events; /* non-public microkernel global variable */ * * isr_event_signal_handler - ISR handler to signal an event * - * RETURNS: N/A + * @return N/A */ void isr_event_signal_handler(void *data) @@ -83,7 +83,7 @@ void isr_event_signal_handler(void *data) * * releaseTestFiber - release the test fiber * - * RETURNS: N/A + * @return N/A */ void releaseTestFiber(void) @@ -95,7 +95,7 @@ void releaseTestFiber(void) * * microObjectsInit - initialize objects used in this microkernel test suite * - * RETURNS: N/A + * @return N/A */ void microObjectsInit(void) @@ -121,7 +121,7 @@ void microObjectsInit(void) * of the event gets confirmed by the order in which the latter two checks are * done. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int eventNoWaitTest(void) @@ -166,7 +166,7 @@ int eventNoWaitTest(void) * 2. The current task must wait on the event until it is signalled * from either another task, an ISR or a fiber. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int eventWaitTest(void) @@ -239,7 +239,7 @@ int eventWaitTest(void) * 3. The current task must wait on the event until it is signalled * from either another task, an ISR or a fiber. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int eventTimeoutTest(void) @@ -289,7 +289,7 @@ int eventTimeoutTest(void) * "queue" events. That is, should two or more signals of the same event occur * before it is tested, it can only be tested for successfully once. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int isrEventSignalTest(void) @@ -330,7 +330,7 @@ int isrEventSignalTest(void) * events. That is, should two or more signals of the same event occur before * it is tested, it can only be tested for successfully once. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int fiberEventSignalTest(void) @@ -365,7 +365,7 @@ int fiberEventSignalTest(void) * * @param event signalled event * - * RETURNS: + * @return */ int eventHandler(int event) @@ -383,7 +383,7 @@ int eventHandler(int event) * * @param event signalled event * - * RETURNS: 1 + * @return 1 */ int altEventHandler(int event) @@ -404,7 +404,7 @@ int altEventHandler(int event) * to the specified event and that the return value from the handler affects * whether the event wakes a task waiting upon that event. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int eventSignalHandlerTest(void) @@ -522,7 +522,7 @@ int eventSignalHandlerTest(void) * * AlternateTask - alternate task to signal various events to a waiting task * - * RETURNS: N/A + * @return N/A */ void AlternateTask(void) @@ -560,7 +560,7 @@ void AlternateTask(void) * * RegressionTask - main entry point to the test suite * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_events/src/test_fiber.c b/samples/microkernel/test/test_events/src/test_fiber.c index b1026fb7870..86dc95edd9d 100644 --- a/samples/microkernel/test/test_events/src/test_fiber.c +++ b/samples/microkernel/test/test_events/src/test_fiber.c @@ -57,7 +57,7 @@ static char __stack fiberStack[FIBER_STACK_SIZE]; /* test fiber stack size */ * It signals the event for the eventWaitTest() function * in single and cycle test, for eventTimeoutTest() * - * RETURNS: N/A + * @return N/A */ static void testFiberEntry(void) { @@ -86,7 +86,7 @@ static void testFiberEntry(void) * * testFiberInit - initializes variables and starts the test fiber * - * RETURNS: N/A + * @return N/A */ void testFiberInit(void) diff --git a/samples/microkernel/test/test_fifo/src/fifo.c b/samples/microkernel/test/test_fifo/src/fifo.c index 82cdd3171db..8fcb9ed6a46 100644 --- a/samples/microkernel/test/test_fifo/src/fifo.c +++ b/samples/microkernel/test/test_fifo/src/fifo.c @@ -68,7 +68,7 @@ static int tcRC = TC_PASS; /* test case return code */ * * This routine initializes the myData array used in the FIFO tests. * - * RETURNS: N/A + * @return N/A */ void initMyData(void) @@ -84,7 +84,7 @@ void initMyData(void) * * This routine prints myData array. * - * RETURNS: N/A + * @return N/A */ void printMyData(void) @@ -105,7 +105,7 @@ void printMyData(void) * @param expectRetValue expect value * @param currentRetValue current value * - * RETURNS: true, false + * @return true, false */ bool verifyRetValue(int expectRetValue, int currentRetValue) @@ -119,7 +119,7 @@ bool verifyRetValue(int expectRetValue, int currentRetValue) * * This routine initializes the microkernel objects used in the FIFO tests. * - * RETURNS: N/A + * @return N/A */ void initMicroObjects(void) @@ -138,7 +138,7 @@ void initMicroObjects(void) * @param queue FIFO queue * @param numElements Number of elements used to inserted into the queue * - * RETURNS: TC_PASS, TC_FAIL + * @return TC_PASS, TC_FAIL * * Also updates tcRC when result is TC_FAIL. */ @@ -194,7 +194,7 @@ exitTest3: * - it purges the FIFO queue * - it dequeues an element from the FIFO queue * - * RETURNS: N/A + * @return N/A */ void MicroTestFifoTask(void) { @@ -281,7 +281,7 @@ exitTest4: * * @param loopCnt number of elements passed to the for loop * - * RETURNS: TC_PASS, TC_FAIL + * @return TC_PASS, TC_FAIL * * Also updates tcRC when result is TC_FAIL. */ @@ -360,7 +360,7 @@ exitTest2: * The get wait interfaces (with and without timeouts) are also tested * and data verified. * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h b/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h index fbe8430f81d..e286a2254a9 100644 --- a/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h +++ b/samples/microkernel/test/test_fp_sharing/src/float_regs_x86_gcc.h @@ -57,7 +57,7 @@ * _LoadAllFloatRegisters(), _StoreAllFloatRegisters(), and * _LoadThenStoreAllFloatRegisters agree on the format. * - * RETURNS: N/A + * @return N/A */ static inline void _LoadAllFloatRegisters(FP_REG_SET *pFromBuffer) @@ -124,7 +124,7 @@ static inline void _LoadAllFloatRegisters(FP_REG_SET *pFromBuffer) * floating point operations was also co-operatively switched out and simply * inherits the existing x87 FPU state (expecting the stack to be empty). * - * RETURNS: N/A + * @return N/A */ static inline void _LoadThenStoreAllFloatRegisters(FP_REG_SET *pFromToBuffer) @@ -173,7 +173,7 @@ static inline void _LoadThenStoreAllFloatRegisters(FP_REG_SET *pFromToBuffer) * _LoadAllFloatRegisters() occured to load all the floating point registers * from a memory buffer. * - * RETURNS: N/A + * @return N/A */ static inline void _StoreAllFloatRegisters(FP_REG_SET *pToBuffer) @@ -213,7 +213,7 @@ static inline void _StoreAllFloatRegisters(FP_REG_SET *pToBuffer) * a function call, regardless of whether the call results in the context being * pended. * - * RETURNS: N/A + * @return N/A */ void _StoreNonVolatileFloatRegisters(FP_NONVOLATILE_REG_SET *pToBuffer) diff --git a/samples/microkernel/test/test_fp_sharing/src/main.c b/samples/microkernel/test/test_fp_sharing/src/main.c index d16b1113fd4..08503423bbc 100644 --- a/samples/microkernel/test/test_fp_sharing/src/main.c +++ b/samples/microkernel/test/test_fp_sharing/src/main.c @@ -142,7 +142,7 @@ static volatile unsigned int load_store_high_count = 0; * main - * load_store_low - low priority FPU load/store context * - * RETURNS: N/A + * @return N/A */ #ifdef CONFIG_NANOKERNEL @@ -310,7 +310,7 @@ void load_store_low(void) * * load_store_high - high priority FPU load/store context * - * RETURNS: N/A + * @return N/A */ #ifdef CONFIG_NANOKERNEL diff --git a/samples/microkernel/test/test_fp_sharing/src/pi.c b/samples/microkernel/test/test_fp_sharing/src/pi.c index 248b4945127..c9d13133d82 100644 --- a/samples/microkernel/test/test_fp_sharing/src/pi.c +++ b/samples/microkernel/test/test_fp_sharing/src/pi.c @@ -77,7 +77,7 @@ static volatile unsigned int calc_pi_high_count = 0; * * calculate_pi_low - entry point for the low priority pi compute task * - * RETURNS: N/A + * @return N/A */ void calculate_pi_low(void) @@ -120,7 +120,7 @@ void calculate_pi_low(void) * * calculate_pi_high - entry point for the high priority pi compute task * - * RETURNS: N/A + * @return N/A */ void calculate_pi_high(void) diff --git a/samples/microkernel/test/test_libs/src/libraries.c b/samples/microkernel/test/test_libs/src/libraries.c index 042b6467150..8402d9e9903 100644 --- a/samples/microkernel/test/test_libs/src/libraries.c +++ b/samples/microkernel/test/test_libs/src/libraries.c @@ -61,7 +61,7 @@ volatile long longOne = 1L; * * limitsTest - test implementation-defined constants library * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int limitsTest(void) @@ -79,7 +79,7 @@ int limitsTest(void) * * stdboolTest - test boolean types and values library * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int stdboolTest(void) @@ -105,7 +105,7 @@ volatile size_t sizeOfLongVariable = sizeof(longVariable); * * stddefTest - test standard type definitions library * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int stddefTest(void) @@ -131,7 +131,7 @@ volatile uint32_t unsignedInt = 0xffffff00; * * stdintTest - test integer types library * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int stdintTest(void) @@ -157,7 +157,7 @@ char buffer[BUFSIZE]; * * memset_test - test string memset * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int memset_test(void) @@ -178,7 +178,7 @@ int memset_test(void) * * strlen_test - test string length function * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int strlen_test(void) @@ -200,7 +200,7 @@ int strlen_test(void) * * strcmp_test - test string compare function * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int strcmp_test(void) @@ -238,7 +238,7 @@ int strcmp_test(void) * * strncmp_test - test string N compare function * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int strncmp_test(void) @@ -277,7 +277,7 @@ int strncmp_test(void) * * strcpy_test - test string copy function * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int strcpy_test(void) @@ -300,7 +300,7 @@ int strcpy_test(void) * * strncpy_test - test string N copy function * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int strncpy_test(void) @@ -324,7 +324,7 @@ int strncpy_test(void) * * strchr_test - test string scanning function * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int strchr_test(void) @@ -355,7 +355,7 @@ int strchr_test(void) * * memcmp_test - test memory comparison function * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int memcmp_test(void) @@ -382,7 +382,7 @@ int memcmp_test(void) /** * * stringTest - test string operations library - * * RETURNS: TC_PASS or TC_FAIL + * * @return TC_PASS or TC_FAIL */ int stringTest(void) @@ -406,7 +406,7 @@ int stringTest(void) * suite. It tests each library in turn until a failure is detected or all * libraries have been tested successfully. * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int RegressionTask(void) diff --git a/samples/microkernel/test/test_libs/src/main.c b/samples/microkernel/test/test_libs/src/main.c index 32a47fadbe4..679a21578bb 100644 --- a/samples/microkernel/test/test_libs/src/main.c +++ b/samples/microkernel/test/test_libs/src/main.c @@ -68,7 +68,7 @@ static ksem_t resultSems[] = { SEM_TASKDONE, SEM_TASKFAIL, ENDLIST }; * This routine signals "task done" or "task fail", based on the return code of * RegressionTask. * - * RETURNS: N/A + * @return N/A */ void RegressionTaskEntry(void) @@ -85,7 +85,7 @@ void RegressionTaskEntry(void) * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. * - * RETURNS: N/A + * @return N/A */ void MonitorTaskEntry(void) diff --git a/samples/microkernel/test/test_mail/src/mail.c b/samples/microkernel/test/test_mail/src/mail.c index a3c4363ed38..57e9a323d01 100644 --- a/samples/microkernel/test/test_mail/src/mail.c +++ b/samples/microkernel/test/test_mail/src/mail.c @@ -99,7 +99,7 @@ extern kmemory_pool_t smallBlkszPool; * @param dataSize Size of (optional) buffer to send. * @param info Additional (optional) info to send. * - * RETURNS: N/A + * @return N/A */ static void setMsg_Sender(struct k_msg *inMsg, kmbox_t inMbox, ktask_t receiverTask, @@ -128,7 +128,7 @@ static void setMsg_Sender(struct k_msg *inMsg, kmbox_t inMbox, ktask_t receiverT * @param inBuffer Incoming data area * @param inBufferSize Size of incoming data area. * - * RETURNS: N/A + * @return N/A */ static void setMsg_Receiver(struct k_msg *inMsg, kmbox_t inMbox, ktask_t senderTask, @@ -151,7 +151,7 @@ static void setMsg_Receiver(struct k_msg *inMsg, kmbox_t inMbox, ktask_t senderT * @param inBuffer Incoming data area. * @param inBufferSize Size of incoming data area. * - * RETURNS: N/A + * @return N/A */ static void setMsg_RecvBuf(struct k_msg *inMsg, char *inBuffer, uint32_t inBufferSize) @@ -169,7 +169,7 @@ static void setMsg_RecvBuf(struct k_msg *inMsg, char *inBuffer, uint32_t inBuffe * * This routine exercises the task_mbox_put[_wait[_timeout]] APIs. * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int MsgSenderTask(void) @@ -364,7 +364,7 @@ int MsgSenderTask(void) * * This routine exercises the task_mbox_get[_wait[_timeout]] and task_mbox_data_get[xxx] APIs. * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int MsgRcvrTask(void) diff --git a/samples/microkernel/test/test_mail/src/main.c b/samples/microkernel/test/test_mail/src/main.c index 5c15f3523bd..5c705a729fc 100644 --- a/samples/microkernel/test/test_mail/src/main.c +++ b/samples/microkernel/test/test_mail/src/main.c @@ -76,7 +76,7 @@ kmemory_pool_t smallBlkszPool = SMALLBLKSZPOOL; * This routine signals "task done" or "task fail", based on the return code of * MsgSenderTask. * - * RETURNS: N/A + * @return N/A */ void MsgSenderTaskEntry(void) @@ -93,7 +93,7 @@ void MsgSenderTaskEntry(void) * This routine signals "task done" or "task fail", based on the return code of * MsgRcvrTask. * - * RETURNS: N/A + * @return N/A */ void MsgRcvrTaskEntry(void) @@ -110,7 +110,7 @@ void MsgRcvrTaskEntry(void) * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. * - * RETURNS: N/A + * @return N/A */ void MonitorTaskEntry(void) diff --git a/samples/microkernel/test/test_map/src/map.c b/samples/microkernel/test/test_map/src/map.c index b6c0a8c021b..a29df5a9674 100644 --- a/samples/microkernel/test/test_map/src/map.c +++ b/samples/microkernel/test/test_map/src/map.c @@ -70,7 +70,7 @@ int testMapFreeAllBlocks(void **P); * @param expectRetValue expect value * @param currentRetValue current value * - * RETURNS: true, false + * @return true, false */ bool verifyRetValue(int expectRetValue, int currentRetValue) @@ -87,7 +87,7 @@ bool verifyRetValue(int expectRetValue, int currentRetValue) * SEM_REGRESDONE and SEM_HELPERDONE to synchronize between different parts * of the test. * - * RETURNS: N/A + * @return N/A */ void HelperTask(void) @@ -154,7 +154,7 @@ exitTest1: * * @param p pointer to pointer of allocated blocks * - * RETURNS: TC_PASS, TC_FAIL + * @return TC_PASS, TC_FAIL */ int testMapGetAllBlocks(void **p) @@ -226,7 +226,7 @@ int testMapGetAllBlocks(void **p) * * @param p pointer to pointer of allocated blocks * - * RETURNS: TC_PASS, TC_FAIL + * @return TC_PASS, TC_FAIL */ int testMapFreeAllBlocks(void **p) @@ -281,7 +281,7 @@ int testMapFreeAllBlocks(void **p) * * @param pointer pointer to pointer of allocated blocks * - * RETURNS: N/A + * @return N/A */ void printPointers(void **pointer) { @@ -307,7 +307,7 @@ void printPointers(void **pointer) * * task_mem_map_alloc_wait, task_mem_map_alloc_wait_timeout * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_mutex/src/mutex.c b/samples/microkernel/test/test_mutex/src/mutex.c index 4deadbc103d..b3ca68489e2 100644 --- a/samples/microkernel/test/test_mutex/src/mutex.c +++ b/samples/microkernel/test/test_mutex/src/mutex.c @@ -79,7 +79,7 @@ static int tcRC = TC_PASS; /* test case return code */ * * Task10 - * - * RETURNS: N/A + * @return N/A */ void Task10(void) @@ -102,7 +102,7 @@ void Task10(void) * * Task15 - * - * RETURNS: N/A + * @return N/A */ void Task15(void) @@ -134,7 +134,7 @@ void Task15(void) * * Task20 - * - * RETURNS: N/A + * @return N/A */ void Task20(void) @@ -164,7 +164,7 @@ void Task20(void) * * Task25 - * - * RETURNS: N/A + * @return N/A */ void Task25(void) @@ -187,7 +187,7 @@ void Task25(void) * * Task30 - * - * RETURNS: N/A + * @return N/A */ void Task30(void) @@ -218,7 +218,7 @@ void Task30(void) * * Task45 - * - * RETURNS: N/A + * @return N/A */ void Task45(void) @@ -241,7 +241,7 @@ void Task45(void) * * This task will lock on Mutex1, Mutex2, Mutex3 and Mutex4. * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_pipe/src/main.c b/samples/microkernel/test/test_pipe/src/main.c index 98fe09dc90a..38674e617db 100644 --- a/samples/microkernel/test/test_pipe/src/main.c +++ b/samples/microkernel/test/test_pipe/src/main.c @@ -70,7 +70,7 @@ kpipe_t pipeId = PIPE_ID; * This routine signals "task done" or "task fail", based on the return code of * RegressionTask. * - * RETURNS: N/A + * @return N/A */ void RegressionTaskEntry(void) @@ -87,7 +87,7 @@ void RegressionTaskEntry(void) * This routine signals "task done" or "task fail", based on the return code of * AlternateTask. * - * RETURNS: N/A + * @return N/A */ void AlternateTaskEntry(void) @@ -104,7 +104,7 @@ void AlternateTaskEntry(void) * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. * - * RETURNS: N/A + * @return N/A */ void MonitorTaskEntry(void) diff --git a/samples/microkernel/test/test_pipe/src/pipe.c b/samples/microkernel/test/test_pipe/src/pipe.c index ce3da7bcb98..2fb2d905863 100644 --- a/samples/microkernel/test/test_pipe/src/pipe.c +++ b/samples/microkernel/test/test_pipe/src/pipe.c @@ -160,7 +160,7 @@ extern kpipe_t pipeId; * * microObjectsInit - initialize objects used in this microkernel test suite * - * RETURNS: N/A + * @return N/A */ void microObjectsInit(void) @@ -179,7 +179,7 @@ void microObjectsInit(void) * @param buffer pointer to buffer to check * @param size number of bytes to check * - * RETURNS: on success, index of wrong character on failure + * @return on success, index of wrong character on failure */ int receiveBufferCheck(char *buffer, int size) @@ -204,7 +204,7 @@ int receiveBufferCheck(char *buffer, int size) * @param manyItems testcase list (many items in the pipe) * @param nMany number of items in testcase * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutHelperWork(SIZE_EXPECT *singleItems, int nSingles, @@ -299,7 +299,7 @@ int pipePutHelperWork(SIZE_EXPECT *singleItems, int nSingles, * * pipePutHelper - helper routine to pipePutTest() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutHelper(void) @@ -341,7 +341,7 @@ int pipePutHelper(void) * @param manyItems testcase list (many items in the pipe) * @param nMany number of items in testcase * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutTestWork(SIZE_EXPECT *singleItems, int nSingles, @@ -425,7 +425,7 @@ int pipePutTestWork(SIZE_EXPECT *singleItems, int nSingles, * * This routine tests the task_pipe_put() API. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutTest(void) @@ -460,7 +460,7 @@ int pipePutTest(void) * * pipePutWaitHelper - help test task_pipe_put_wait() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutWaitHelper(void) @@ -524,7 +524,7 @@ int pipePutWaitHelper(void) * * pipePutWaitTest - test task_pipe_put_wait() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutWaitTest(void) @@ -584,7 +584,7 @@ int pipePutWaitTest(void) * * pipePutTimeoutHelper - test task_pipe_get_wait_timeout() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutTimeoutHelper(void) @@ -648,7 +648,7 @@ int pipePutTimeoutHelper(void) * * pipePutTimeoutTest - test task_pipe_put_wait_timeout() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipePutTimeoutTest(void) @@ -733,7 +733,7 @@ int pipePutTimeoutTest(void) * only remaining functionality that needs to be checked are attempts to get * data from an empty pipe. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipeGetTest(void) @@ -780,7 +780,7 @@ int pipeGetTest(void) * @param items testcase list for task_pipe_get_wait() * @param nItems number of items in list * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipeGetWaitHelperWork(SIZE_EXPECT *items, int nItems) @@ -814,7 +814,7 @@ int pipeGetWaitHelperWork(SIZE_EXPECT *items, int nItems) * * pipeGetWaitHelper - test task_pipe_get_wait() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipeGetWaitHelper(void) @@ -845,7 +845,7 @@ int pipeGetWaitHelper(void) * @param items testcase list for task_pipe_get_wait() * @param nItems number of items in list * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipeGetWaitTestWork(SIZE_EXPECT *items, int nItems) @@ -878,7 +878,7 @@ int pipeGetWaitTestWork(SIZE_EXPECT *items, int nItems) * * pipeGetWaitTest - test task_pipe_get_wait() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipeGetWaitTest(void) @@ -914,7 +914,7 @@ int pipeGetWaitTest(void) * * pipeGetTimeoutTest - test remaining task_pipe_get_wait_timeout() functionality * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int pipeGetTimeoutTest(void) @@ -946,7 +946,7 @@ int pipeGetTimeoutTest(void) * * This routine runs at a lower priority than RegressionTask(). * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int AlternateTask(void) @@ -993,7 +993,7 @@ int AlternateTask(void) * * This is the entry point to the pipe test suite. * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int RegressionTask(void) diff --git a/samples/microkernel/test/test_pool/src/pool.c b/samples/microkernel/test/test_pool/src/pool.c index c691d5fc55b..301695cd280 100644 --- a/samples/microkernel/test/test_pool/src/pool.c +++ b/samples/microkernel/test/test_pool/src/pool.c @@ -113,7 +113,7 @@ static TEST_CASE defrag[] = { * * blockCompare - compare the two blocks * - * RETURNS: 0 if the same, non-zero if not the same + * @return 0 if the same, non-zero if not the same */ int blockCompare(struct k_block *b1, struct k_block *b2) @@ -137,7 +137,7 @@ int blockCompare(struct k_block *b1, struct k_block *b2) * * poolBlockGetFunc - wrapper for task_mem_pool_alloc() * - * RETURNS: task_mem_pool_alloc() return value + * @return task_mem_pool_alloc() return value */ int poolBlockGetFunc(struct k_block *block, kmemory_pool_t pool, int size, @@ -152,7 +152,7 @@ int poolBlockGetFunc(struct k_block *block, kmemory_pool_t pool, int size, * * poolBlockGetWFunc - wrapper for task_mem_pool_alloc_wait() * - * RETURNS: task_mem_pool_alloc_wait() return value + * @return task_mem_pool_alloc_wait() return value */ int poolBlockGetWFunc(struct k_block *block, kmemory_pool_t pool, int size, @@ -167,7 +167,7 @@ int poolBlockGetWFunc(struct k_block *block, kmemory_pool_t pool, int size, * * poolBlockGetWTFunc - wrapper for task_mem_pool_alloc_wait_timeout() * - * RETURNS: task_mem_pool_alloc_wait_timeout() return value + * @return task_mem_pool_alloc_wait_timeout() return value */ int poolBlockGetWTFunc(struct k_block *block, kmemory_pool_t pool, @@ -180,7 +180,7 @@ int poolBlockGetWTFunc(struct k_block *block, kmemory_pool_t pool, * * freeBlocks - free any blocks allocated in the test set * - * RETURNS: N/A + * @return N/A */ void freeBlocks(TEST_CASE *tests, int nTests) @@ -198,7 +198,7 @@ void freeBlocks(TEST_CASE *tests, int nTests) * * poolBlockGetWork - perform the work of getting blocks * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int poolBlockGetWork(char *string, poolBlockGetFunc_t func, @@ -227,7 +227,7 @@ int poolBlockGetWork(char *string, poolBlockGetFunc_t func, * * The pool is 4 kB in size. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int poolBlockGetTest(void) @@ -260,7 +260,7 @@ int poolBlockGetTest(void) * * HelperTask - helper task to poolBlockGetTimeoutTest() * - * RETURNS: N/A + * @return N/A */ void HelperTask(void) @@ -275,7 +275,7 @@ void HelperTask(void) * * poolBlockGetTimeoutTest - test task_mem_pool_alloc_wait_timeout() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int poolBlockGetTimeoutTest(void) @@ -328,7 +328,7 @@ int poolBlockGetTimeoutTest(void) * * poolBlockGetWaitTest - * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int poolBlockGetWaitTest(void) @@ -370,7 +370,7 @@ int poolBlockGetWaitTest(void) * * DefragTask - task responsible for defragmenting the pool POOL_ID * - * RETURNS: N/A + * @return N/A */ void DefragTask(void) @@ -386,7 +386,7 @@ void DefragTask(void) * * poolDefragTest - * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int poolDefragTest(void) @@ -437,7 +437,7 @@ int poolDefragTest(void) * * This routine runs at a lower priority than RegressionTask(). * - * RETURNS: N/A + * @return N/A */ void AlternateTask(void) @@ -457,7 +457,7 @@ void AlternateTask(void) * * This is the entry point to the memory pool test suite. * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_rand32/src/test-rand32.c b/samples/microkernel/test/test_rand32/src/test-rand32.c index f38f9784a39..d52e5cde391 100644 --- a/samples/microkernel/test/test_rand32/src/test-rand32.c +++ b/samples/microkernel/test/test_rand32/src/test-rand32.c @@ -46,7 +46,7 @@ * RegressionTaskEntry - regression test's entry point * * - * RETURNS: N/A + * @return N/A */ void RegressionTaskEntry(void) diff --git a/samples/microkernel/test/test_sema/src/main.c b/samples/microkernel/test/test_sema/src/main.c index a5e23d67e4a..47908589fe2 100644 --- a/samples/microkernel/test/test_sema/src/main.c +++ b/samples/microkernel/test/test_sema/src/main.c @@ -98,7 +98,7 @@ static vvfn _trigger_isrSemaSignal = (vvfn) sw_isr_trigger_0; * This routine signals "task done" or "task fail", based on the return code of * RegressionTask. * - * RETURNS: N/A + * @return N/A */ void RegressionTaskEntry(void) @@ -115,7 +115,7 @@ void RegressionTaskEntry(void) * This routine signals "task done" or "task fail", based on the return code of * MsgRcvrTask. * - * RETURNS: N/A + * @return N/A */ void AlternateTaskEntry(void) @@ -132,7 +132,7 @@ void AlternateTaskEntry(void) * This routine signals "task done" or "task fail", based on the return code of * HighPriTask. * - * RETURNS: N/A + * @return N/A */ void HighPriTaskEntry(void) @@ -149,7 +149,7 @@ void HighPriTaskEntry(void) * This routine signals "task done" or "task fail", based on the return code of * LowPriTask. * - * RETURNS: N/A + * @return N/A */ void LowPriTaskEntry(void) @@ -165,7 +165,7 @@ void LowPriTaskEntry(void) * * @param isrData pointer to semaphore to be given * - * RETURNS: N/A + * @return N/A */ static void testIsrHandler(void *isrData) @@ -179,7 +179,7 @@ static void testIsrHandler(void *isrData) * * @param semaphore semaphore to be given * - * RETURNS: N/A + * @return N/A */ void trigger_isrSemaSignal(ksem_t semaphore) @@ -192,7 +192,7 @@ void trigger_isrSemaSignal(ksem_t semaphore) * * releaseTestFiber - release the test fiber * - * RETURNS: N/A + * @return N/A */ void releaseTestFiber(void) @@ -207,7 +207,7 @@ void releaseTestFiber(void) * Binds an ISR to the interrupt vector used to give semaphores from interrupt * level. * - * RETURNS: N/A + * @return N/A */ static void testInterruptsInit(void) @@ -227,7 +227,7 @@ static void testInterruptsInit(void) * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. * - * RETURNS: N/A + * @return N/A */ void MonitorTaskEntry(void) diff --git a/samples/microkernel/test/test_sema/src/sema.c b/samples/microkernel/test/test_sema/src/sema.c index ecf816f8940..6cbf895531d 100644 --- a/samples/microkernel/test/test_sema/src/sema.c +++ b/samples/microkernel/test/test_sema/src/sema.c @@ -74,7 +74,7 @@ extern ksem_t semList[]; * * simpleSemaTest - signal semaphore that has no waiting tasks from ISR * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int simpleSemaTest(void) @@ -167,7 +167,7 @@ int simpleSemaTest(void) * * simpleSemaWaitTest - test the waiting of a semaphore * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int simpleSemaWaitTest(void) @@ -225,7 +225,7 @@ int simpleSemaWaitTest(void) * * simpleGroupTest - test for a group of semaphores * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int simpleGroupTest(void) @@ -308,7 +308,7 @@ int simpleGroupTest(void) * This routine tests the waiting feature on a group of semaphores. Note that * timing out on a wait has already been tested so it need not be done again. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int simpleGroupWaitTest(void) @@ -376,7 +376,7 @@ int simpleGroupWaitTest(void) * * See also: testFiber.c * - * RETURNS: TC_PASS on success or TC_FAIL on failure + * @return TC_PASS on success or TC_FAIL on failure */ static int simpleFiberSemTest(void) { @@ -423,7 +423,7 @@ static int simpleFiberSemTest(void) * * HighPriTask - a high priority task * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int HighPriTask(void) @@ -457,7 +457,7 @@ int HighPriTask(void) * * LowPriTask - a low priority task * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int LowPriTask(void) @@ -484,7 +484,7 @@ int LowPriTask(void) * * This routine runs at a lower priority than RegressionTask(). * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int AlternateTask(void) @@ -563,7 +563,7 @@ int AlternateTask(void) * * This is the entry point to the semaphore test suite. * - * RETURNS: TC_PASS or TC_FAIL + * @return TC_PASS or TC_FAIL */ int RegressionTask(void) diff --git a/samples/microkernel/test/test_sema/src/test_fiber.c b/samples/microkernel/test/test_sema/src/test_fiber.c index 2dd00da8c78..56906091e3c 100644 --- a/samples/microkernel/test/test_sema/src/test_fiber.c +++ b/samples/microkernel/test/test_sema/src/test_fiber.c @@ -66,7 +66,7 @@ static CMD_PKT_SET_INSTANCE(cmdPktSet, N_TESTS + 1) * Then fiber signals each of the semaphores in the group. Test * task checks this. * - * RETURNS: N/A + * @return N/A */ static void testFiberEntry(void) { @@ -92,7 +92,7 @@ static void testFiberEntry(void) * * testFiberInit - initializes variables and starts the test fiber * - * RETURNS: N/A + * @return N/A */ void testFiberInit(void) diff --git a/samples/microkernel/test/test_sprintf/src/test_sprintf.c b/samples/microkernel/test/test_sprintf/src/test_sprintf.c index 74b5a0ae43c..01bd2b4497c 100644 --- a/samples/microkernel/test/test_sprintf/src/test_sprintf.c +++ b/samples/microkernel/test/test_sprintf/src/test_sprintf.c @@ -77,7 +77,7 @@ typedef union { * * sprintfDoubleTest - test sprintf with doubles * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int sprintfDoubleTest(void) @@ -255,7 +255,7 @@ int tvsnprintf(char *s, size_t len, const char *format, ...) * vsnprintf(). Instead of calling vsnprintf() directly, it invokes the wrapper * routine tvsnprintf(). * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int vsnprintfTest(void) @@ -342,7 +342,7 @@ int tvsprintf(char *s, const char *format, ...) * sprintfTest(). Instead it tries to limit it to functionality specific to * vsprintf(). * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int vsprintfTest(void) @@ -376,7 +376,7 @@ int vsprintfTest(void) * sprintfTest(). Instead it tries to limit it to functionality specific to * snprintf(). * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int snprintfTest(void) @@ -442,7 +442,7 @@ int snprintfTest(void) * * sprintfMiscTest - test the sprintf() routine with miscellaneous specifiers * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int sprintfMiscTest(void) @@ -518,7 +518,7 @@ int sprintfMiscTest(void) * * sprintfIntegerTest - test the sprintf() routine with integers * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int sprintfIntegerTest(void) @@ -671,7 +671,7 @@ int sprintfIntegerTest(void) * * sprintfStringTest - test sprintf with strings * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int sprintfStringTest(void) @@ -717,7 +717,7 @@ int sprintfStringTest(void) * * RegressionTask - test entry point * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_stackprot/src/stackprot.c b/samples/microkernel/test/test_stackprot/src/stackprot.c index 44ae5835562..434e8242db5 100644 --- a/samples/microkernel/test/test_stackprot/src/stackprot.c +++ b/samples/microkernel/test/test_stackprot/src/stackprot.c @@ -73,7 +73,7 @@ void check_input(const char *name, const char *input); * * @param name task or fiber identification string * - * RETURNS: N/A + * @return N/A */ void printLoop(const char *name) @@ -98,7 +98,7 @@ void printLoop(const char *name) * When stack protection feature is not enabled, the system crashes with * error like: Trying to execute code outside RAM or ROM. * - * RETURNS: N/A + * @return N/A */ void check_input(const char *name, const char *input) @@ -120,7 +120,7 @@ void check_input(const char *name, const char *input) * feature is enabled. Hence it will not execute the printLoop function and will * not set tcRC to TC_FAIL. Control is transferred back to the other task. * - * RETURNS: N/A + * @return N/A */ #ifdef CONFIG_MICROKERNEL void AlternateTask(void) @@ -148,7 +148,7 @@ void fiber1(void) * printLoop to print a string and alternates execution with AlternateTask * when the task goes to sleep in printLoop. * - * RETURNS: N/A + * @return N/A */ #ifdef CONFIG_MICROKERNEL diff --git a/samples/microkernel/test/test_static_idt/src/static_idt.c b/samples/microkernel/test/test_static_idt/src/static_idt.c index 37654247afa..7c2f6e1dc5a 100644 --- a/samples/microkernel/test/test_static_idt/src/static_idt.c +++ b/samples/microkernel/test/test_static_idt/src/static_idt.c @@ -81,7 +81,7 @@ static char __stack fiberStack[512]; * * This routine is the ISR handler for _trigger_isrHandler(). * - * RETURNS: N/A + * @return N/A */ void isr_handler(void) @@ -106,7 +106,7 @@ void isr_handler(void) * done, then control goes back to the offending instruction and an infinite * loop of divide-by-zero errors would be created.) * - * RETURNS: N/A + * @return N/A */ void exc_divide_error_handler(NANO_ESF *pEsf) @@ -123,7 +123,7 @@ void exc_divide_error_handler(NANO_ESF *pEsf) * This test examines the IDT and verifies that the static interrupt and * exception stubs are installed at the correct place. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int nanoIdtStubTest(void) @@ -176,7 +176,7 @@ int nanoIdtStubTest(void) * * idtSpurTask/Fiber - task/fiber to test spurious handlers * - * RETURNS: 0 + * @return 0 */ #ifdef CONFIG_MICROKERNEL @@ -205,7 +205,7 @@ static void idtSpurFiber(int a1, int a2) * * This is the entry point to the static IDT tests. * - * RETURNS: N/A + * @return N/A */ #ifdef CONFIG_MICROKERNEL diff --git a/samples/microkernel/test/test_task/src/task.c b/samples/microkernel/test/test_task/src/task.c index efd295d0c5b..c78cc166089 100644 --- a/samples/microkernel/test/test_task/src/task.c +++ b/samples/microkernel/test/test_task/src/task.c @@ -74,7 +74,7 @@ static volatile int mainTaskNotReady = 0; * * isr_task_command_handler - ISR handler to call isr_task_id_get() and isr_task_priority_get() * - * RETURNS: N/A + * @return N/A */ void isr_task_command_handler(void *data) @@ -99,7 +99,7 @@ void isr_task_command_handler(void *data) * * isrAPIsTest - test isr_task_id_get() and isr_task_priority_get * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int isrAPIsTest(int taskId, int taskPrio) @@ -127,7 +127,7 @@ int isrAPIsTest(int taskId, int taskPrio) * * taskMacrosTest - test task_id_get() and task_priority_get() macros * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int taskMacrosTest(int taskId, int taskPrio) @@ -155,7 +155,7 @@ int taskMacrosTest(int taskId, int taskPrio) * * microObjectsInit - initialize objects used in this microkernel test suite * - * RETURNS: N/A + * @return N/A */ void microObjectsInit(void) @@ -174,7 +174,7 @@ void microObjectsInit(void) * * helperTaskSetPrioTest - helper task portion to test setting the priority * - * RETURNS: N/A + * @return N/A */ void helperTaskSetPrioTest(void) @@ -196,7 +196,7 @@ void helperTaskSetPrioTest(void) * * taskSetPrioTest - test the task_priority_set() API * - * RETURNS: N/A + * @return N/A */ int taskSetPrioTest(void) @@ -270,7 +270,7 @@ int taskSetPrioTest(void) * * helperTaskSleepTest - helper task portion to test task_sleep() * - * RETURNS: N/A + * @return N/A */ void helperTaskSleepTest(void) @@ -291,7 +291,7 @@ void helperTaskSleepTest(void) * * taskSleepTest - test task_sleep() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int taskSleepTest(void) @@ -322,7 +322,7 @@ int taskSleepTest(void) * * helperTaskYieldTest - helper task portion of task_yield() test * - * RETURNS: N/A + * @return N/A */ void helperTaskYieldTest(void) @@ -342,7 +342,7 @@ void helperTaskYieldTest(void) * * taskYieldTest - test task_yield() * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int taskYieldTest(void) @@ -381,7 +381,7 @@ int taskYieldTest(void) * helperTaskSuspendTest - helper task portion of task_suspend() and * task_resume() tests * - * RETURNS: N/A + * @return N/A */ void helperTaskSuspendTest(void) @@ -401,7 +401,7 @@ void helperTaskSuspendTest(void) * the helper task is resumed, and the main task sleeps once more. If the * helper task has truly resumed, it will modify . * - * RETURNS: TC_PASS on success or TC_FAIL on failure + * @return TC_PASS on success or TC_FAIL on failure */ int taskSuspendTest(void) @@ -434,7 +434,7 @@ int taskSuspendTest(void) * * HelperTask - helper task to test the task APIs * - * RETURNS: N/A + * @return N/A */ void HelperTask(void) @@ -470,7 +470,7 @@ void HelperTask(void) * * RegressionTask - main task to test the task APIs * - * RETURNS: N/A + * @return N/A */ void RegressionTask(void) diff --git a/samples/microkernel/test/test_task_irq/src/main.c b/samples/microkernel/test/test_task_irq/src/main.c index 8dca86180b7..0d8c20a7893 100644 --- a/samples/microkernel/test/test_task_irq/src/main.c +++ b/samples/microkernel/test/test_task_irq/src/main.c @@ -61,7 +61,7 @@ extern uint32_t irq_vectors[NUM_OBJECTS]; * This routine signals "task done" or "task fail", based on the return code of * taskA. * - * RETURNS: N/A + * @return N/A */ void taskAMain(void) @@ -77,7 +77,7 @@ void taskAMain(void) * This routine signals "task done" or "task fail", based on the return code of * taskB. * - * RETURNS: N/A + * @return N/A */ void taskBMain(void) @@ -94,7 +94,7 @@ void taskBMain(void) * then generates SW interrupts for all IRQs. Signals "task done" if all task * indicated the IRQs are allocated or signals "task fail"if not. * - * RETURNS: N/A + * @return N/A */ void registerWait(void) { @@ -129,7 +129,7 @@ void registerWait(void) * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. * - * RETURNS: N/A + * @return N/A */ void MonitorTaskEntry(void) diff --git a/samples/microkernel/test/test_task_irq/src/raise_int.c b/samples/microkernel/test/test_task_irq/src/raise_int.c index 50302252270..7d5f24f2b26 100644 --- a/samples/microkernel/test/test_task_irq/src/raise_int.c +++ b/samples/microkernel/test/test_task_irq/src/raise_int.c @@ -1395,7 +1395,7 @@ static void (*intFPtr[256])(void) = { * This routine will call one of the genInt functions based upon the * value passed to it (which is essentially the interrupt vector number). * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -1413,7 +1413,7 @@ void raiseInt(uint8_t id) * * Trigger via NVIC. is the IRQ number. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/test/test_task_irq/src/test_device.c b/samples/microkernel/test/test_task_irq/src/test_device.c index 3d2ec35775b..20200d905ae 100644 --- a/samples/microkernel/test/test_task_irq/src/test_device.c +++ b/samples/microkernel/test/test_task_irq/src/test_device.c @@ -76,7 +76,7 @@ uint32_t irq_vectors[NUM_OBJECTS] = {[0 ... (NUM_OBJECTS - 1)] = INVALID_VECTOR} * interrupt associated with those IRQs. The function then attempts to allocate * a device that has already been allocate from taskB. * - * RETURNS: TC_PASS, TC_FAIL + * @return TC_PASS, TC_FAIL */ int taskA(ksem_t semRdy) @@ -148,7 +148,7 @@ int taskA(ksem_t semRdy) * interrupt associated with those IRQs. The function then frees an IRQ object * using task_irq_free(). * - * RETURNS: TC_PASS, TC_FAIL + * @return TC_PASS, TC_FAIL */ int taskB(ksem_t semRdy) diff --git a/samples/microkernel/test/test_tickless/src/timestamps.c b/samples/microkernel/test/test_tickless/src/timestamps.c index 53330782e99..9fa8d8466e4 100644 --- a/samples/microkernel/test/test_tickless/src/timestamps.c +++ b/samples/microkernel/test/test_tickless/src/timestamps.c @@ -77,7 +77,7 @@ BSP-specific timestamp support for the tickless idle test. * * This routine initializes the timestamp timer. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -109,7 +109,7 @@ void _TimestampOpen(void) * * This routine returns the timestamp value. * - * RETURNS: timestamp value + * @return timestamp value * * \NOMANUAL */ @@ -145,7 +145,7 @@ uint32_t _TimestampRead(void) * * This routine releases the timestamp timer. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -192,7 +192,7 @@ void _TimestampClose(void) * * This routine initializes the timestamp timer. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -229,7 +229,7 @@ void _TimestampOpen(void) * * This routine returns the timestamp value. * - * RETURNS: timestamp value + * @return timestamp value * * \NOMANUAL */ @@ -266,7 +266,7 @@ uint32_t _TimestampRead(void) * * This routine releases the timestamp timer. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/microkernel/test/test_timer/src/timer.c b/samples/microkernel/test/test_timer/src/timer.c index 40d3bcfb65f..b41b429d6c8 100644 --- a/samples/microkernel/test/test_timer/src/timer.c +++ b/samples/microkernel/test/test_timer/src/timer.c @@ -56,7 +56,7 @@ static ktimer_t pTimer[NTIMERS + 1]; * * testLowTimerStop - test that task_timer_stop() does stop a timer * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int testLowTimerStop(void) @@ -83,7 +83,7 @@ int testLowTimerStop(void) * * testLowTimerPeriodicity - test the periodic feature of a timer * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int testLowTimerPeriodicity(void) @@ -156,7 +156,7 @@ int testLowTimerPeriodicity(void) * This test checks that the timer does not start under a variety of * circumstances. * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int testLowTimerDoesNotStart(void) @@ -192,7 +192,7 @@ int testLowTimerDoesNotStart(void) * * testLowTimerOneShot - test the one shot feature of a timer * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int testLowTimerOneShot(void) @@ -248,7 +248,7 @@ int testLowTimerOneShot(void) * it checks that timers that have been freed are available to be allocated * again at a later time. * - * RETURNS: TC_PASS on success, TC_FAIL otherwise + * @return TC_PASS on success, TC_FAIL otherwise */ int testLowTimerGet(void) @@ -321,7 +321,7 @@ static void test_nano_timers(int unused1, int unused2) * * RegressionTaskEntry - regression test's entry point * - * RETURNS: N/A + * @return N/A */ void RegressionTaskEntry(void) diff --git a/samples/microkernel/test/test_xip/src/test_xip.c b/samples/microkernel/test/test_xip/src/test_xip.c index 570025f9973..c9ffe124588 100644 --- a/samples/microkernel/test/test_xip/src/test_xip.c +++ b/samples/microkernel/test/test_xip/src/test_xip.c @@ -50,7 +50,7 @@ global variables for completeness sake. * * Entry point for nanokernel only builds. * - * RETURNS: N/A + * @return N/A */ void main(void) @@ -59,7 +59,7 @@ void main(void) * * RegressionTaskEntry - regression test's entry point * - * RETURNS: N/A + * @return N/A */ void RegressionTaskEntry(void) diff --git a/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c b/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c index 2b594cbbb4a..59824d86770 100644 --- a/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c +++ b/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c @@ -107,7 +107,7 @@ volatile pfunc func_array[] = { * * dummyIsr - dummy ISR * - * RETURNS: N/A + * @return N/A */ void dummyIsr(void *unused) @@ -124,7 +124,7 @@ void dummyIsr(void *unused) * to avoid the preamble code the compiler automatically generates. However, * the unwanted preamble has an insignificant impact on total footprint. * - * RETURNS: N/A + * @return N/A */ static void isrDummyIntStub(void *unused) @@ -144,7 +144,7 @@ static void isrDummyIntStub(void *unused) * @param message Message to be printed. * @param arg1 Unused. * - * RETURNS: N/A + * @return N/A */ static void fiberEntry(int message, int arg1) @@ -167,7 +167,7 @@ static void fiberEntry(int message, int arg1) * This routine simply increments a global counter. * (Gdb can be used to observe the counter as it increases.) * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/nanokernel/benchmark/sys_kernel/src/lifo.c b/samples/nanokernel/benchmark/sys_kernel/src/lifo.c index ab39d413476..067a28b2740 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/lifo.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/lifo.c @@ -41,7 +41,7 @@ static struct nano_fifo nanoFifo_sync; /* for synchronization */ * * lifo_test_init - initialize LIFOs for the test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -60,7 +60,7 @@ void lifo_test_init(void) * @param par1 Ignored parameter. * @param par2 Number of test loops. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -100,7 +100,7 @@ void lifo_fiber1(int par1, int par2) * @param par1 Address of the counter. * @param par2 Number of test cycles. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -132,7 +132,7 @@ void lifo_fiber2(int par1, int par2) * @param par1 Address of the counter. * @param par2 Number of test loops. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -163,7 +163,7 @@ void lifo_fiber3(int par1, int par2) * * lifo_test - the main test entry * - * RETURNS: 1 if success and 0 on failure + * @return 1 if success and 0 on failure * * \NOMANUAL */ diff --git a/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c b/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c index 799da022ec7..db8b7653b74 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c @@ -42,7 +42,7 @@ static struct nano_fifo nanoFifo_sync; /* for synchronization */ * * fifo_test_init - initialize FIFOs for the test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -58,7 +58,7 @@ void fifo_test_init(void) * * fifo_fiber1 - fifo test context * - * RETURNS: N/A + * @return N/A * * @param par1 Ignored parameter. * @param par2 Number of test loops. @@ -90,7 +90,7 @@ void fifo_fiber1(int par1, int par2) * * fifo_fiber2 - fifo test context * - * RETURNS: N/A + * @return N/A * * @param par1 Address of the counter. * @param par2 Number of test cycles. @@ -123,7 +123,7 @@ void fifo_fiber2(int par1, int par2) * * fifo_fiber3 - fifo test context * - * RETURNS: N/A + * @return N/A * * @param par1 Address of the counter. * @param par2 Number of test cycles. @@ -158,7 +158,7 @@ void fifo_fiber3(int par1, int par2) * * fifo_test - the main test entry * - * RETURNS: 1 if success and 0 on failure + * @return 1 if success and 0 on failure * * \NOMANUAL */ diff --git a/samples/nanokernel/benchmark/sys_kernel/src/sema.c b/samples/nanokernel/benchmark/sys_kernel/src/sema.c index 12bf14d808a..5bdd86314a3 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/sema.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/sema.c @@ -39,7 +39,7 @@ struct nano_sem nanoSem2; * * sema_test_init - initialize semaphores for the test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -58,7 +58,7 @@ void sema_test_init(void) * @param par1 Ignored parameter. * @param par2 Number of test loops. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -83,7 +83,7 @@ void sema_fiber1(int par1, int par2) * @param par1 Address of the counter. * @param par2 Number of test cycles. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -107,7 +107,7 @@ void sema_fiber2(int par1, int par2) * @param par1 Address of the counter. * @param par2 Number of test cycles. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -131,7 +131,7 @@ void sema_fiber3(int par1, int par2) * * sema_test - the main test entry * - * RETURNS: 1 if success and 0 on failure + * @return 1 if success and 0 on failure * * \NOMANUAL */ diff --git a/samples/nanokernel/benchmark/sys_kernel/src/stack.c b/samples/nanokernel/benchmark/sys_kernel/src/stack.c index 0386bc80571..a3c77afd150 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/stack.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/stack.c @@ -42,7 +42,7 @@ uint32_t stack2[2]; * * stack_test_init - initialize stacks for the test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -61,7 +61,7 @@ void stack_test_init(void) * @param par1 Ignored parameter. * @param par2 Number of test loops. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -97,7 +97,7 @@ void stack_fiber1(int par1, int par2) * @param par1 Address of the counter. * @param par2 Number of test cycles. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -127,7 +127,7 @@ void stack_fiber2(int par1, int par2) * @param par1 Address of the counter. * @param par2 Number of test cycles. * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -157,7 +157,7 @@ void stack_fiber3(int par1, int par2) * * stack_test - the main test entry * - * RETURNS: 1 if success and 0 on failure + * @return 1 if success and 0 on failure * * \NOMANUAL */ diff --git a/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c b/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c index a17b0d30bb0..408501d291f 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c @@ -82,7 +82,7 @@ uint32_t tm_off; * * Routine does necessary preparations for the test to start * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -99,7 +99,7 @@ void begin_test(void) * * check_result - checks number of tests and calculate average time * - * RETURNS: 1 if success and 0 on failure + * @return 1 if success and 0 on failure * * @param i Number of tests. * @param t Time in ticks for the whole test. @@ -142,7 +142,7 @@ int check_result(int i, uint32_t t) * * kbhit - check for a key press * - * RETURNS: 1 when a keyboard key is pressed, or 0 if no keyboard support + * @return 1 when a keyboard key is pressed, or 0 if no keyboard support * * \NOMANUAL */ @@ -157,7 +157,7 @@ int kbhit(void) * * init_output - prepares the test output * - * RETURNS: N/A + * @return N/A * * @param continuously Run test till the user presses the key. * @@ -179,7 +179,7 @@ void init_output(int *continuously) * * output_close - close output for the test * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ @@ -192,7 +192,7 @@ void output_close(void) * * SysKernelBench - perform all selected benchmarks * - * RETURNS: N/A + * @return N/A * * \NOMANUAL */ diff --git a/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c b/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c index bc30b73e9b4..9f53c2b976a 100644 --- a/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c +++ b/samples/nanokernel/test/test_arm_m3_irq_vector_table/src/main.c @@ -53,7 +53,7 @@ struct nano_sem sem[3]; * * isr0 - ISR for IRQ0 * - * RETURNS: N/A + * @return N/A */ void isr0(void) @@ -67,7 +67,7 @@ void isr0(void) * * isr1 - ISR for IRQ1 * - * RETURNS: N/A + * @return N/A */ void isr1(void) @@ -81,7 +81,7 @@ void isr1(void) * * isr2 - ISR for IRQ2 * - * RETURNS: N/A + * @return N/A */ void isr2(void) @@ -95,7 +95,7 @@ void isr2(void) * * main - task entry point * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/nanokernel/test/test_context/src/context.c b/samples/nanokernel/test/test_context/src/context.c index f0838144b66..c59125a1a57 100644 --- a/samples/nanokernel/test/test_context/src/context.c +++ b/samples/nanokernel/test/test_context/src/context.c @@ -124,7 +124,7 @@ static void (*_trigger_isrHandler)(void) = (vvfn)sw_isr_trigger_0; * This routine is the ISR handler for _trigger_isrHandler(). It performs * the command requested in . * - * RETURNS: N/A + * @return N/A */ void isr_handler(void *data) @@ -159,7 +159,7 @@ void isr_handler(void *data) * thereby preventing the infinite loop of divide-by-zero errors which would * arise if control simply returns to that instruction. * - * RETURNS: N/A + * @return N/A */ void exc_divide_error_handler(NANO_ESF *pEsf) @@ -175,7 +175,7 @@ void exc_divide_error_handler(NANO_ESF *pEsf) * * This routine initializes the nanokernel objects used in this module's tests. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int initNanoObjects(void) @@ -206,7 +206,7 @@ int initNanoObjects(void) * expected to be the tick clock timer which should wake the CPU. Thus after * each call to nano_cpu_idle(), the tick count should be one higher. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int nano_cpu_idleTest(void) @@ -235,7 +235,7 @@ int nano_cpu_idleTest(void) * * irq_lockWrapper - a wrapper for irq_lock() * - * RETURNS: irq_lock() return value + * @return irq_lock() return value */ int irq_lockWrapper(int unused) @@ -249,7 +249,7 @@ int irq_lockWrapper(int unused) * * irq_unlockWrapper - a wrapper for irq_unlock() * - * RETURNS: N/A + * @return N/A */ void irq_unlockWrapper(int imask) @@ -261,7 +261,7 @@ void irq_unlockWrapper(int imask) * * irq_lock_inlineWrapper - a wrapper for irq_lock_inline() * - * RETURNS: irq_lock_inline() return value + * @return irq_lock_inline() return value */ int irq_lock_inlineWrapper(int unused) @@ -275,7 +275,7 @@ int irq_lock_inlineWrapper(int unused) * * irq_unlock_inlineWrapper - a wrapper for irq_unlock_inline() * - * RETURNS: N/A + * @return N/A */ void irq_unlock_inlineWrapper(int imask) @@ -287,7 +287,7 @@ void irq_unlock_inlineWrapper(int imask) * * irq_disableWrapper - a wrapper for irq_disable() * - * RETURNS: + * @return */ int irq_disableWrapper(int irq) @@ -300,7 +300,7 @@ int irq_disableWrapper(int irq) * * irq_enableWrapper - a wrapper for irq_enable() * - * RETURNS: N/A + * @return N/A */ void irq_enableWrapper(int irq) @@ -316,7 +316,7 @@ void irq_enableWrapper(int irq) * include irq_lock() and irq_unlock(), irq_lock_inline() and * irq_unlock_inline(), irq_disable() and irq_enable(). * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int nanoCpuDisableInterruptsTest(disable_interrupt_func disableRtn, @@ -382,7 +382,7 @@ int nanoCpuDisableInterruptsTest(disable_interrupt_func disableRtn, * a task and an ISR (that interrupted a task). Checking those routines with * fibers are done elsewhere. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int nanoCtxTaskTest(void) @@ -432,7 +432,7 @@ int nanoCtxTaskTest(void) * 3 - context_type_get() when called from an ISR is not NANO_TYPE_ISR * 3 - context_type_get() when called from a fiber is not NANO_TYPE_FIBER * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int nanoCtxFiberTest(nano_context_id_t taskCtxId) @@ -483,7 +483,7 @@ int nanoCtxFiberTest(nano_context_id_t taskCtxId) * @param arg1 unused * @param arg2 unused * - * RETURNS: N/A + * @return N/A */ static void fiberHelper(int arg1, int arg2) @@ -525,7 +525,7 @@ static void fiberHelper(int arg1, int arg2) * 12 - fiber_yield() did not yield to an equal prioirty fiber * 13 - fiber_yield() yielded to a lower priority fiber * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int fiber_yieldTest(void) @@ -601,7 +601,7 @@ int fiber_yieldTest(void) * @param taskCtxId context ID of the spawning task * @param arg1 unused * - * RETURNS: N/A + * @return N/A */ static void fiberEntry(int taskCtxId, int arg1) @@ -821,7 +821,7 @@ static int test_timeout(void) * * This is the entry point to the CPU and context tests. * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/nanokernel/test/test_fifo/src/fifo.c b/samples/nanokernel/test/test_fifo/src/fifo.c index cdda3984542..2309af8c6a3 100644 --- a/samples/nanokernel/test/test_fifo/src/fifo.c +++ b/samples/nanokernel/test/test_fifo/src/fifo.c @@ -153,7 +153,7 @@ extern int test_fifo_timeout(void); * * @param parameter pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_fifo_put(void *parameter) @@ -172,7 +172,7 @@ void isr_fifo_put(void *parameter) * * @param parameter pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_fifo_get(void *parameter) @@ -187,7 +187,7 @@ void isr_fifo_get(void *parameter) * * fiber1 - entry point for the first fiber * - * RETURNS: N/A + * @return N/A */ void fiber1(void) @@ -259,7 +259,7 @@ void fiber1(void) * This function tests the fifo put and get wait interfaces in the fiber context. * It gets data from nanoFifoObj2 queue and puts data to nanoFifoObj queue. * - * RETURNS: N/A + * @return N/A */ void testFiberFifoGetW(void) @@ -308,7 +308,7 @@ void testFiberFifoGetW(void) * * We use nanoFifoObj queue to put and get data. * - * RETURNS: N/A + * @return N/A */ void testIsrFifoFromFiber(void) @@ -362,7 +362,7 @@ void testIsrFifoFromFiber(void) * * We use nanoFifoObj queue to put and get data. * - * RETURNS: N/A + * @return N/A */ void testIsrFifoFromTask(void) @@ -420,7 +420,7 @@ void testIsrFifoFromTask(void) * * fiber2 - entry point for the second fiber * - * RETURNS: N/A + * @return N/A */ void fiber2(void) @@ -476,7 +476,7 @@ void fiber2(void) * * fiber3 - entry point for the third fiber * - * RETURNS: N/A + * @return N/A */ void fiber3(void) @@ -525,7 +525,7 @@ void fiber3(void) * This is in the task context. It puts data to nanoFifoObj2 queue and gets * data from nanoFifoObj queue. * - * RETURNS: N/A + * @return N/A */ void testTaskFifoGetW(void) @@ -564,7 +564,7 @@ void testTaskFifoGetW(void) * * This routine initializes the nanokernel objects used in the FIFO tests. * - * RETURNS: N/A + * @return N/A */ void initNanoObjects(void) @@ -594,7 +594,7 @@ void initNanoObjects(void) * * This is the entry point to the FIFO tests. * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/nanokernel/test/test_lifo/src/lifo.c b/samples/nanokernel/test/test_lifo/src/lifo.c index ae42be83fec..1d872b73fe4 100644 --- a/samples/nanokernel/test/test_lifo/src/lifo.c +++ b/samples/nanokernel/test/test_lifo/src/lifo.c @@ -114,7 +114,7 @@ static struct nano_sem reply_multi_waiters; * * @param data pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_lifo_put(void *data) @@ -133,7 +133,7 @@ void isr_lifo_put(void *data) * * @param data pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_lifo_get(void *data) @@ -151,7 +151,7 @@ void isr_lifo_get(void *data) * of items to/from a LIFO. The cases covered will have a fiber or task waiting * on an empty LIFO. * - * RETURNS: 0 on success, -1 on failure + * @return 0 on success, -1 on failure */ int fiberLifoWaitTest(void) @@ -211,7 +211,7 @@ int fiberLifoWaitTest(void) * This routine works with fiberLifoNonWaitTest() to test the addition and * removal of items from a LIFO without having to wait. * - * RETURNS: 0 on success, -1 on failure + * @return 0 on success, -1 on failure */ int fiberLifoNonWaitTest(void) @@ -292,7 +292,7 @@ errorReturn: * @param arg1 unused * @param arg2 unused * - * RETURNS: N/A + * @return N/A */ static void fiberEntry(int arg1, int arg2) @@ -318,7 +318,7 @@ static void fiberEntry(int arg1, int arg2) * of items to/from a LIFO. The cases covered will have a fiber or task waiting * on an empty LIFO. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int taskLifoWaitTest(void) @@ -375,7 +375,7 @@ int taskLifoWaitTest(void) * This routine works with fiberLifoNonWaitTest() to test the addition and * removal of items from a LIFO without having to wait. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int taskLifoNonWaitTest(void) @@ -452,7 +452,7 @@ int taskLifoNonWaitTest(void) * * This routine initializes the nanokernel objects used in the LIFO tests. * - * RETURNS: N/A + * @return N/A */ void initNanoObjects(void) @@ -496,7 +496,7 @@ static LIFO_ITEM multi_waiters_items[NUM_WAITERS] = { * * fiber_multi_waiters - fiber entry point for multiple-waiters test * - * RETURNS: N/A + * @return N/A */ static void fiber_multi_waiters(int arg1, int arg2) @@ -522,7 +522,7 @@ static void fiber_multi_waiters(int arg1, int arg2) * * do_test_multiple_waiters - task part of multiple-waiter test, repeatable * - * RETURNS: N/A + * @return N/A */ static int do_test_multiple_waiters(void) @@ -563,7 +563,7 @@ static int do_test_multiple_waiters(void) * * test_multiple_waiters - entry point for multiple-waiters test * - * RETURNS: N/A + * @return N/A */ static int test_multiple_waiters(void) @@ -1055,7 +1055,7 @@ static int test_timeout(void) * * This is the entry point to the LIFO tests. * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/nanokernel/test/test_sema/src/sema.c b/samples/nanokernel/test/test_sema/src/sema.c index aeaca30903a..3506e22787c 100644 --- a/samples/nanokernel/test/test_sema/src/sema.c +++ b/samples/nanokernel/test/test_sema/src/sema.c @@ -104,7 +104,7 @@ static struct nano_sem reply_multi_waiters; * * @param data pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_sem_take(void *data) @@ -123,7 +123,7 @@ void isr_sem_take(void *data) * * @param data pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_sem_give(void *data) @@ -141,7 +141,7 @@ void isr_sem_give(void *data) * This test gives and takes the test semaphore in the context of a fiber * without blocking on the semaphore. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int testSemFiberNoWait(void) @@ -188,7 +188,7 @@ errorReturn: * @param arg1 unused * @param arg2 unused * - * RETURNS: N/A + * @return N/A */ static void fiberEntry(int arg1, int arg2) @@ -260,7 +260,7 @@ static void fiberEntry(int arg1, int arg2) * * This routine initializes the nanokernel objects used in the semaphore tests. * - * RETURNS: N/A + * @return N/A */ void initNanoObjects(void) @@ -287,7 +287,7 @@ void initNanoObjects(void) * This test gives and takes the test semaphore in the context of an ISR without * blocking on the semaphore. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int testSemIsrNoWait(void) @@ -334,7 +334,7 @@ errorReturn: * This test gives and takes the test semaphore in the context of a task without * blocking on the semaphore. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int testSemTaskNoWait(void) @@ -377,7 +377,7 @@ errorReturn: * This routine works with fiberEntry() to perform the tests that wait on * a semaphore. * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int testSemWait(void) @@ -432,7 +432,7 @@ static char __stack fiber_multi_waiters_stacks[NUM_WAITERS][FIBER_STACKSIZE]; * * fiber_multi_waiters - fiber entry point for multiple-waiters test * - * RETURNS: N/A + * @return N/A */ static void fiber_multi_waiters(int arg1, int arg2) @@ -448,7 +448,7 @@ static void fiber_multi_waiters(int arg1, int arg2) * * do_test_multiple_waiters - task part of multiple-waiter test, repeatable * - * RETURNS: N/A + * @return N/A */ static int do_test_multiple_waiters(void) @@ -494,7 +494,7 @@ static int do_test_multiple_waiters(void) * * test_multiple_waiters - entry point for multiple-waiters test * - * RETURNS: N/A + * @return N/A */ static int test_multiple_waiters(void) @@ -940,7 +940,7 @@ static int test_timeout(void) * * This is the entry point to the semaphore tests. * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/nanokernel/test/test_stack/src/stack.c b/samples/nanokernel/test/test_stack/src/stack.c index 96e31108cdd..9c0db86a940 100644 --- a/samples/nanokernel/test/test_stack/src/stack.c +++ b/samples/nanokernel/test/test_stack/src/stack.c @@ -132,7 +132,7 @@ void testIsrStackFromTask(void); * * Initialize myData and myIsrData arrays. * - * RETURNS: none + * @return none */ void initData(void) @@ -152,7 +152,7 @@ void initData(void) * * @param parameter pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_stack_push(void *parameter) @@ -173,7 +173,7 @@ void isr_stack_push(void *parameter) * * @param parameter pointer to ISR handler parameter * - * RETURNS: N/A + * @return N/A */ void isr_stack_pop(void *parameter) @@ -196,7 +196,7 @@ void isr_stack_pop(void *parameter) * the STACK queue and puts four items back to the STACK queue. Control is * transferred back to the main task. * - * RETURNS: N/A + * @return N/A */ void fiber1(void) @@ -243,7 +243,7 @@ void fiber1(void) * This function tests the stack push and pop wait interfaces in the fiber context. * It gets data from nanoStackObj2 queue and puts data to nanoStackObj queue. * - * RETURNS: N/A + * @return N/A */ void testFiberStackPopW(void) @@ -290,7 +290,7 @@ void testFiberStackPopW(void) * * We use nanoStackObj queue to push and pop data. * - * RETURNS: N/A + * @return N/A */ void testIsrStackFromFiber(void) @@ -346,7 +346,7 @@ void testIsrStackFromFiber(void) * * We use nanoStackObj queue to push and pop data. * - * RETURNS: N/A + * @return N/A */ void testIsrStackFromTask(void) @@ -401,7 +401,7 @@ void testIsrStackFromTask(void) * * This is the fiber started from the testTaskStackPopW function. * - * RETURNS: N/A + * @return N/A */ void fiber2(void) @@ -421,7 +421,7 @@ void fiber2(void) * This is in the task context. It puts data to nanoStackObj2 queue and gets * data from nanoStackObj queue. * - * RETURNS: N/A + * @return N/A */ void testTaskStackPopW(void) @@ -461,7 +461,7 @@ void testTaskStackPopW(void) * This fiber blocks for one second before pushing an item onto the stack. * The main task, which was waiting for item from the stack then unblocks. * - * RETURNS: N/A + * @return N/A */ void fiber3(void) @@ -477,7 +477,7 @@ void fiber3(void) * * This routine initializes the nanokernel objects used in the STACK tests. * - * RETURNS: N/A + * @return N/A */ void initNanoObjects(void) @@ -501,7 +501,7 @@ void initNanoObjects(void) * * This is the entry point to the STACK tests. * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/samples/nanokernel/test/test_timer/src/timer.c b/samples/nanokernel/test/test_timer/src/timer.c index 026463dd854..a62528fda64 100644 --- a/samples/nanokernel/test/test_timer/src/timer.c +++ b/samples/nanokernel/test/test_timer/src/timer.c @@ -83,7 +83,7 @@ static char __stack fiber2Stack[FIBER2_STACKSIZE]; * * This routine initializes the nanokernel objects used in the LIFO tests. * - * RETURNS: N/A + * @return N/A */ void initNanoObjects(void) @@ -117,7 +117,7 @@ void initNanoObjects(void) * @param pTimerData pointer to the expected timer data * @param ticks number of ticks to wait * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int basicTimerWait(timer_start_func startRtn, timer_getw_func waitRtn, @@ -195,7 +195,7 @@ int basicTimerWait(timer_start_func startRtn, timer_getw_func waitRtn, * * @param startRtn routine to start the timers * - * RETURNS: N/A + * @return N/A */ void startTimers(timer_start_func startRtn) @@ -224,7 +224,7 @@ void startTimers(timer_start_func startRtn) * * @param getRtn timer get routine (fiber or task) * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int busyWaitTimers(timer_get_func getRtn) @@ -294,7 +294,7 @@ int busyWaitTimers(timer_get_func getRtn) * @param stopRtn routine to stop timer (fiber or task) * @param getRtn timer get routine (fiber or task) * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int stopTimers(timer_stop_func stopRtn, timer_get_func getRtn) @@ -335,7 +335,7 @@ int stopTimers(timer_stop_func stopRtn, timer_get_func getRtn) * @param arg1 unused * @param arg2 unused * - * RETURNS: N/A + * @return N/A */ static void fiber2Entry(int arg1, int arg2) @@ -356,7 +356,7 @@ static void fiber2Entry(int arg1, int arg2) * @param arg1 unused * @param arg2 unused * - * RETURNS: N/A + * @return N/A */ static void fiberEntry(int arg1, int arg2) @@ -431,7 +431,7 @@ static void fiberEntry(int arg1, int arg2) * * nano_cycle_get_32Test - test the nano_cycle_get_32() API * - * RETURNS: TC_PASS on success, TC_FAIL on failure + * @return TC_PASS on success, TC_FAIL on failure */ int nano_cycle_get_32Test(void) @@ -460,7 +460,7 @@ int nano_cycle_get_32Test(void) * * This is the entry point to the timer tests. * - * RETURNS: N/A + * @return N/A */ void main(void) diff --git a/shared/include/nanokernel/x86/idtEnt.h b/shared/include/nanokernel/x86/idtEnt.h index 04fa8cf0849..0a44977217d 100644 --- a/shared/include/nanokernel/x86/idtEnt.h +++ b/shared/include/nanokernel/x86/idtEnt.h @@ -90,7 +90,7 @@ typedef struct idtEntry { * should specify a level of 0, whereas handlers for user-mode software generated * interrupts should specify 3. * - * RETURNS: N/A + * @return N/A * * INTERNAL * This is a shared routine between the IA-32 nanokernel runtime code and the