diff --git a/arch/arc/core/atomic.S b/arch/arc/core/atomic.S index d587a027aee..daf675ef7cb 100644 --- a/arch/arc/core/atomic.S +++ b/arch/arc/core/atomic.S @@ -62,7 +62,7 @@ GTEXT(atomic_cas) /** * - * atomic_clear - atomically clear a memory location + * @brief Atomically clear a memory location * * This routine atomically clears the contents of and returns the old * value that was in . @@ -85,7 +85,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_clear_set, atomic_clear) /** * - * atomic_set - atomically set a memory location + * @brief Atomically set a memory location * * This routine atomically sets the contents of to and returns * the old value that was in . @@ -113,7 +113,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_clear_set, atomic_set) /** * - * atomic_get - Get the value of a shared memory atomically + * @brief Get the value of a shared memory atomically * * This routine atomically retrieves the value in *target * @@ -132,7 +132,7 @@ SECTION_FUNC(TEXT, atomic_get) /** * - * atomic_inc - atomically increment a memory location + * @brief Atomically increment a memory location * * This routine atomically increments the value in . The operation is * done using unsigned integer arithmetic. Various CPU architectures may impose @@ -158,7 +158,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_inc) /** * - * atomic_add - atomically add a value to a memory location + * @brief Atomically add a value to a memory location * * This routine atomically adds the contents of and , placing * the result in . The operation is done using signed integer arithmetic. @@ -193,7 +193,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_add) /** * - * atomic_dec - atomically decrement a memory location + * @brief Atomically decrement a memory location * * This routine atomically decrements the value in . The operation is * done using unsigned integer arithmetic. Various CPU architectures may impose @@ -219,7 +219,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_dec_sub, atomic_dec) /** * - * atomic_sub - atomically subtract a value from a memory location + * @brief Atomically subtract a value from a memory location * * This routine atomically subtracts from the contents of , * placing the result in . The operation is done using signed integer @@ -255,7 +255,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_dec_sub, atomic_sub) /** * - * atomic_nand - atomically perform a bitwise NAND on a memory location + * @brief Atomically perform a bitwise NAND on a memory location * * This routine atomically performs a bitwise NAND operation of the contents of * and , placing the result in . @@ -292,7 +292,7 @@ SECTION_FUNC(TEXT, atomic_nand) /** * - * atomic_and - atomically perform a bitwise AND on a memory location + * @brief Atomically perform a bitwise AND on a memory location * * This routine atomically performs a bitwise AND operation of the contents of * and , placing the result in . @@ -328,7 +328,7 @@ SECTION_FUNC(TEXT, atomic_and) /** * - * atomic_or - atomically perform a bitwise OR on memory location + * @brief Atomically perform a bitwise OR on memory location * * This routine atomically performs a bitwise OR operation of the contents of * and , placing the result in . @@ -364,7 +364,7 @@ SECTION_FUNC(TEXT, atomic_or) /** * - * atomic_xor - atomically perform a bitwise XOR on a memory location + * @brief Atomically perform a bitwise XOR on a memory location * * This routine atomically performs a bitwise XOR operation of the contents of * and , placing the result in . @@ -400,7 +400,7 @@ SECTION_FUNC(TEXT, atomic_xor) /** * - * atomic_cas - atomically compare-and-swap the contents of a memory location + * @brief Atomically compare-and-swap the contents of a memory location * * This routine performs an atomic compare-and-swap. testing that the contents of * contains , and if it does, setting the value of diff --git a/arch/arc/core/context.c b/arch/arc/core/context.c index 4cad5afe2ee..4f8c8cdc24d 100644 --- a/arch/arc/core/context.c +++ b/arch/arc/core/context.c @@ -65,7 +65,7 @@ tNANO _nanokernel = {0}; #if defined(CONFIG_CONTEXT_MONITOR) /* - * context_monitor_init - initialize context monitoring support + * @brief Initialize context monitoring support * * Currently only inserts the new context in the list of active contexts. * @@ -92,7 +92,7 @@ static ALWAYS_INLINE void context_monitor_init(struct ccs *pCcs /* context */ #endif /* CONFIG_CONTEXT_MONITOR */ /* - * _NewContext - initialize a new context (thread) from its stack space + * @brief Initialize a new context (thread) from its stack space * * The control structure (CCS) is put at the lower address of the stack. An * initial context, to be "restored" by __return_from_coop(), is put at diff --git a/arch/arc/core/context_wrapper.S b/arch/arc/core/context_wrapper.S index 3c379c6c467..3a6bed1db56 100644 --- a/arch/arc/core/context_wrapper.S +++ b/arch/arc/core/context_wrapper.S @@ -46,7 +46,7 @@ GTEXT(_context_entry) /* - * _ContextEntryWrapper - wrapper for _context_entry + * @brief Wrapper for _context_entry * * The routine pops parameters for the _context_entry from * stack frame, prepared by the _NewContext() routine diff --git a/arch/arc/core/cpu_idle.S b/arch/arc/core/cpu_idle.S index d11b768fc94..2cd45cbf9bd 100644 --- a/arch/arc/core/cpu_idle.S +++ b/arch/arc/core/cpu_idle.S @@ -51,7 +51,7 @@ SECTION_VAR(BSS, nano_cpu_sleep_mode) .word 0 /* - * nano_cpu_idle - put the CPU in low-power mode + * @brief Put the CPU in low-power mode * * This function always exits with interrupts unlocked. * @@ -65,7 +65,7 @@ SECTION_FUNC(TEXT, nano_cpu_idle) nop /* - * nano_cpu_atomic_idle - put the CPU in low-power mode, entered with IRQs locked + * @brief Put the CPU in low-power mode, entered with IRQs locked * * This function exits with interrupts restored to . * diff --git a/arch/arc/core/fast_irq.S b/arch/arc/core/fast_irq.S index ab80d533d2f..9e43b707f63 100644 --- a/arch/arc/core/fast_irq.S +++ b/arch/arc/core/fast_irq.S @@ -55,7 +55,7 @@ SECTION_VAR(NOINIT, _firq_stack) /** * - * _firq_enter - work to be done before handing control to a FIRQ ISR + * @brief Work to be done before handing control to a FIRQ ISR * * The processor switches to a second register bank so registers from the * current bank do not have to be preserved yet. The only issue is the LP_START/ @@ -99,7 +99,7 @@ SECTION_FUNC(TEXT, _firq_enter) /** * - * _firq_exit - work to be done exiting a FIRQ + * @brief Work to be done exiting a FIRQ * * @return N/A */ @@ -258,7 +258,7 @@ _firq_no_reschedule: /** * - * _firq_stack_setup - install the FIRQ stack in register bank 1 + * @brief Install the FIRQ stack in register bank 1 * * @return N/A */ diff --git a/arch/arc/core/fatal.c b/arch/arc/core/fatal.c index c951abfbf26..52d19a830f0 100644 --- a/arch/arc/core/fatal.c +++ b/arch/arc/core/fatal.c @@ -54,7 +54,7 @@ const NANO_ESF _default_esf = { /** * - * _NanoFatalErrorHandler - nanokernel fatal error handler + * @brief Nanokernel fatal error handler * * This routine is called when fatal error conditions are detected by software * and is responsible only for reporting the error. Once reported, it then diff --git a/arch/arc/core/fault.c b/arch/arc/core/fault.c index 6125fca1dec..60c17f11361 100644 --- a/arch/arc/core/fault.c +++ b/arch/arc/core/fault.c @@ -60,7 +60,7 @@ #if (CONFIG_FAULT_DUMP > 0) /* - * _FaultDump - dump information regarding fault (FAULT_DUMP > 0) + * @brief Dump information regarding fault (FAULT_DUMP > 0) * * Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 1 * (short form). @@ -85,7 +85,7 @@ void _FaultDump(const NANO_ESF *esf, int fault) #endif /* CONFIG_FAULT_DUMP */ /* - * _Fault - fault handler + * @brief Fault handler * * This routine is called when fatal error conditions are detected by hardware * and is responsible only for reporting the error. Once reported, it then diff --git a/arch/arc/core/fault_s.S b/arch/arc/core/fault_s.S index 9863f323f18..29c2dafcd4a 100644 --- a/arch/arc/core/fault_s.S +++ b/arch/arc/core/fault_s.S @@ -64,7 +64,7 @@ SECTION_VAR(BSS, saved_stack_pointer) .word 0 /* - * __fault - fault handler installed in the fault and reserved vectors + * @brief Fault handler installed in the fault and reserved vectors */ SECTION_SUBSEC_FUNC(TEXT,__fault,__memory_error) diff --git a/arch/arc/core/ffs.S b/arch/arc/core/ffs.S index 34260d87567..fc55449cbeb 100644 --- a/arch/arc/core/ffs.S +++ b/arch/arc/core/ffs.S @@ -48,7 +48,7 @@ GTEXT(nanoFfsLsb) /** * - * nanoFfsMsb - find first set bit (searching from the most significant bit) + * @brief Find first set bit (searching from the most significant bit) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting @@ -71,7 +71,7 @@ SECTION_FUNC(TEXT, nanoFfsMsb) /** * - * nanoFfsLsb - find first set bit (searching from the least significant bit) + * @brief Find first set bit (searching from the least significant bit) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting diff --git a/arch/arc/core/irq_lock.S b/arch/arc/core/irq_lock.S index 1f5f8b0f7e0..fa40e5b8f6e 100644 --- a/arch/arc/core/irq_lock.S +++ b/arch/arc/core/irq_lock.S @@ -42,7 +42,7 @@ /** * - * irq_lock - disable all interrupts on the local CPU + * @brief Disable all interrupts on the local CPU * * This routine disables interrupts. It can be called from either interrupt, * task or fiber level. This routine returns an architecture-dependent @@ -77,7 +77,7 @@ SECTION_FUNC(TEXT, irq_lock) /** * - * irq_unlock - enable all interrupts on the local CPU + * @brief Enable all interrupts on the local CPU * * This routine re-enables interrupts on the local CPU. The parameter * is an architecture-dependent lock-out key that is returned by a previous diff --git a/arch/arc/core/irq_manage.c b/arch/arc/core/irq_manage.c index e2304aca947..13b231eb37c 100644 --- a/arch/arc/core/irq_manage.c +++ b/arch/arc/core/irq_manage.c @@ -52,7 +52,7 @@ #include /* - * irq_handler_set - replace an interrupt handler by another + * @brief Replace an interrupt handler by another * * An interrupt's ISR can be replaced at runtime. Care must be taken that the * interrupt is disabled before doing this. @@ -85,7 +85,7 @@ void irq_handler_set( } /* - * irq_enable - enable an interrupt line + * @brief Enable an interrupt line * * Clear possible pending interrupts on the line, and enable the interrupt * line. After this call, the CPU will receive interrupts for the specified @@ -103,7 +103,7 @@ void irq_enable(unsigned int irq) } /* - * irq_disable - disable an interrupt line + * @brief Disable an interrupt line * * Disable an interrupt line. After this call, the CPU will stop receiving * interrupts for the specified . @@ -120,7 +120,7 @@ void irq_disable(unsigned int irq) } /* - * irq_priority_set - set an interrupt's priority + * @brief Set an interrupt's priority * * Valid values are from 0 to 15. Interrupts of priority 1 are not masked when * interrupts are locked system-wide, so care must be taken when using them. ISR @@ -145,7 +145,7 @@ void irq_priority_set( } /* - * _irq_spurious - spurious interrupt handler + * @brief Spurious interrupt handler * * Installed in all dynamic interrupt slots at boot time. Throws an error if * called. @@ -163,7 +163,7 @@ void _irq_spurious(void *unused) } /* - * irq_connect - connect an ISR to an interrupt line + * @brief Connect an ISR to an interrupt line * * is connected to interrupt line , a number greater than or equal * 16. No prior ISR can have been connected on interrupt line since the @@ -188,7 +188,7 @@ int irq_connect( } /* - * irq_disconnect - disconnect an ISR from an interrupt line + * @brief Disconnect an ISR from an interrupt line * * Interrupt line is disconnected from its ISR and the latter is * replaced by _irq_spurious(). irq_disable() should have been called before diff --git a/arch/arc/core/regular_irq.S b/arch/arc/core/regular_irq.S index f178df1dc68..ee1039da266 100644 --- a/arch/arc/core/regular_irq.S +++ b/arch/arc/core/regular_irq.S @@ -51,7 +51,7 @@ GTEXT(_rirq_exit) /** * - * _rirq_enter - work to be done before handing control to an IRQ ISR + * @brief Work to be done before handing control to an IRQ ISR * * The processor pushes automatically all registers that need to be saved. * However, since the processor always runs at kernel privilege there is no @@ -77,7 +77,7 @@ SECTION_FUNC(TEXT, _rirq_enter) /** * - * _rirq_exit - work to be done exiting an IRQ + * @brief Work to be done exiting an IRQ * * @return N/A */ diff --git a/arch/arc/core/swap.S b/arch/arc/core/swap.S index aefdd905c38..51708ae92a3 100644 --- a/arch/arc/core/swap.S +++ b/arch/arc/core/swap.S @@ -53,7 +53,7 @@ GDATA(_nanokernel) /** * - * _Swap - initiate a cooperative context switch + * @brief Initiate a cooperative context switch * * The _Swap() routine is invoked by various nanokernel services to effect * a cooperative context context switch. Prior to invoking _Swap(), the caller diff --git a/arch/arc/fatal_error.c b/arch/arc/fatal_error.c index d427d28a4f4..b2ef099231f 100644 --- a/arch/arc/fatal_error.c +++ b/arch/arc/fatal_error.c @@ -63,7 +63,7 @@ static inline void nonEssentialTaskAbort(void) /** * - * _SysFatalErrorHandler - fatal error handler + * @brief Fatal error handler * * This routine implements the corrective action to be taken when the system * detects a fatal error. diff --git a/arch/arc/include/nano_private.h b/arch/arc/include/nano_private.h index c7806aa19a2..b82296672cb 100644 --- a/arch/arc/include/nano_private.h +++ b/arch/arc/include/nano_private.h @@ -240,7 +240,7 @@ static ALWAYS_INLINE void nanoArchInit(void) /** * - * fiberRtnValueSet - set the return value for the specified fiber (inline) + * @brief Set the return value for the specified fiber (inline) * * The register used to store the return value from a function call invocation * to . It is assumed that the specified is pending, and thus @@ -258,7 +258,7 @@ static ALWAYS_INLINE void fiberRtnValueSet(tCCS *fiber, unsigned int value) /** * - * _IS_IN_ISR - indicates if kernel is handling interrupt + * @brief Indicates if kernel is handling interrupt * * @return 1 if interrupt handler is executed, 0 otherwise * diff --git a/arch/arc/include/v2/cache.h b/arch/arc/include/v2/cache.h index b7167c22b3a..68777868aea 100644 --- a/arch/arc/include/v2/cache.h +++ b/arch/arc/include/v2/cache.h @@ -49,7 +49,7 @@ #define CACHE_CACHE_CONTROLLED 0x20 /* - * _icache_enable - sets the I-cache + * @brief Sets the I-cache * * Enables cache and sets the direct access. */ diff --git a/arch/arc/prep_c.c b/arch/arc/prep_c.c index 03b99a3b760..1b55900b5e7 100644 --- a/arch/arc/prep_c.c +++ b/arch/arc/prep_c.c @@ -46,7 +46,7 @@ initialization is performed. /** * - * bssZero - clear BSS + * @brief Clear BSS * * This routine clears the BSS region, so all bytes are 0. * @@ -65,7 +65,7 @@ static void bssZero(void) /** * - * dataCopy - copy the data section from ROM to RAM + * @brief Copy the data section from ROM to RAM * * This routine copies the data section from ROM to RAM. * @@ -92,7 +92,7 @@ static void dataCopy(void) extern FUNC_NORETURN void _Cstart(void); /** * - * _PrepC - prepare to and run C code + * @brief Prepare to and run C code * * This routine prepares for the execution of and runs C code. * diff --git a/arch/arc/reset.S b/arch/arc/reset.S index 1748869f9f4..a6ae8265fa8 100644 --- a/arch/arc/reset.S +++ b/arch/arc/reset.S @@ -48,7 +48,7 @@ GTEXT(__reset) /** * - * __reset - reset vector + * @brief Reset vector * * Ran when the system comes out of reset. The processor is at supervisor level. * diff --git a/arch/arm/bsp/CortexM/nmi.c b/arch/arm/bsp/CortexM/nmi.c index 36a9496805b..ebab58ae13a 100644 --- a/arch/arm/bsp/CortexM/nmi.c +++ b/arch/arm/bsp/CortexM/nmi.c @@ -54,7 +54,7 @@ static _NmiHandler_t handler = _SysNmiOnReset; /** * - * _DefaultHandler - default NMI handler installed when kernel is up + * @brief Default NMI handler installed when kernel is up * * The default handler outputs a error message and reboots the target. It is * installed by calling _NmiInit(); @@ -70,7 +70,7 @@ static void _DefaultHandler(void) /** * - * _NmiInit - install default runtime NMI handler + * @brief Install default runtime NMI handler * * Meant to be called by BSP code if they want to install a simple NMI handler * that reboots the target. It should be installed after the console is @@ -86,7 +86,7 @@ void _NmiInit(void) /** * - * _NmiHandlerSet - install a custom runtime NMI handler + * @brief Install a custom runtime NMI handler * * Meant to be called by BSP code if they want to install a custom NMI handler * that reboots. It should be installed after the console is initialized if it is @@ -103,7 +103,7 @@ void _NmiHandlerSet(void (*pHandler)(void)) /** * - * __nmi - handler installed in the vector table + * @brief Handler installed in the vector table * * Simply call what is installed in 'static void(*handler)(void)'. * diff --git a/arch/arm/bsp/CortexM/prep_c.c b/arch/arm/bsp/CortexM/prep_c.c index 6a5a673e31e..65d3887caf9 100644 --- a/arch/arm/bsp/CortexM/prep_c.c +++ b/arch/arm/bsp/CortexM/prep_c.c @@ -46,7 +46,7 @@ initialization is performed. /** * - * bssZero - clear BSS + * @brief Clear BSS * * This routine clears the BSS region, so all bytes are 0. * @@ -65,7 +65,7 @@ static void bssZero(void) /** * - * dataCopy - copy the data section from ROM to RAM + * @brief Copy the data section from ROM to RAM * * This routine copies the data section from ROM to RAM. * @@ -92,7 +92,7 @@ static void dataCopy(void) extern FUNC_NORETURN void _Cstart(void); /** * - * _PrepC - prepare to and run C code + * @brief Prepare to and run C code * * This routine prepares for the execution of and runs C code. * diff --git a/arch/arm/bsp/CortexM/reset.S b/arch/arm/bsp/CortexM/reset.S index fe5b55e4299..aaae4973ffc 100644 --- a/arch/arm/bsp/CortexM/reset.S +++ b/arch/arm/bsp/CortexM/reset.S @@ -49,7 +49,7 @@ GTEXT(__reset) /** * - * __reset - reset vector + * @brief Reset vector * * Ran when the system comes out of reset. The processor is in thread mode with * privileged level. At this point, the main stack pointer (MSP) is already diff --git a/arch/arm/bsp/CortexM/scb.c b/arch/arm/bsp/CortexM/scb.c index 21aa0daa3d8..8deb9f37922 100644 --- a/arch/arm/bsp/CortexM/scb.c +++ b/arch/arm/bsp/CortexM/scb.c @@ -46,7 +46,7 @@ definitions and more complex routines, if needed. /** * - * _ScbSystemReset - reset the system + * @brief Reset the system * * This routine resets the processor. * @@ -65,7 +65,7 @@ void _ScbSystemReset(void) /** * - * _ScbNumPriGroupSet - set the number of priority groups based on the number + * @brief Set the number of priority groups based on the number * of exception priorities desired * * Exception priorities can be divided in priority groups, inside which there is diff --git a/arch/arm/bsp/sysFatalErrorHandler.c b/arch/arm/bsp/sysFatalErrorHandler.c index 7530dd40bf4..75e1f014305 100644 --- a/arch/arm/bsp/sysFatalErrorHandler.c +++ b/arch/arm/bsp/sysFatalErrorHandler.c @@ -63,7 +63,7 @@ static inline void nonEssentialTaskAbort(void) /** * - * _SysFatalErrorHandler - fatal error handler + * @brief Fatal error handler * * This routine implements the corrective action to be taken when the system * detects a fatal error. diff --git a/arch/arm/core/atomic.S b/arch/arm/core/atomic.S index 2376a531a18..0d290bb7883 100644 --- a/arch/arm/core/atomic.S +++ b/arch/arm/core/atomic.S @@ -61,7 +61,7 @@ GTEXT(atomic_cas) /** * - * atomic_clear - atomically clear a memory location + * @brief Atomically clear a memory location * * This routine atomically clears the contents of and returns the old * value that was in . @@ -84,7 +84,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_clear_set, atomic_clear) /** * - * atomic_set - atomically set a memory location + * @brief Atomically set a memory location * * This routine atomically sets the contents of to and returns * the old value that was in . @@ -116,7 +116,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_clear_set, atomic_set) /** * - * atomic_get - Get the value of a shared memory atomically + * @brief Get the value of a shared memory atomically * * This routine atomically retrieves the value in *target * @@ -135,7 +135,7 @@ SECTION_FUNC(TEXT, atomic_get) /** * - * atomic_inc - atomically increment a memory location + * @brief Atomically increment a memory location * * This routine atomically increments the value in . The operation is * done using unsigned integer arithmetic. Various CPU architectures may impose @@ -161,7 +161,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_inc) /** * - * atomic_add - atomically add a value to a memory location + * @brief Atomically add a value to a memory location * * This routine atomically adds the contents of and , placing * the result in . The operation is done using signed integer arithmetic. @@ -195,7 +195,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_inc_add, atomic_add) /** * - * atomic_dec - atomically decrement a memory location + * @brief Atomically decrement a memory location * * This routine atomically decrements the value in . The operation is * done using unsigned integer arithmetic. Various CPU architectures may impose @@ -221,7 +221,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_decSub, atomic_dec) /** * - * atomic_sub - atomically subtract a value from a memory location + * @brief Atomically subtract a value from a memory location * * This routine atomically subtracts from the contents of , * placing the result in . The operation is done using signed integer @@ -255,7 +255,7 @@ SECTION_SUBSEC_FUNC(TEXT, atomic_decSub, atomic_sub) /** * - * atomic_nand - atomically perform a bitwise NAND on a memory location + * @brief Atomically perform a bitwise NAND on a memory location * * This routine atomically performs a bitwise NAND operation of the contents of * and , placing the result in . @@ -290,7 +290,7 @@ SECTION_FUNC(TEXT, atomic_nand) /** * - * atomic_and - atomically perform a bitwise AND on a memory location + * @brief Atomically perform a bitwise AND on a memory location * * This routine atomically performs a bitwise AND operation of the contents of * and , placing the result in . @@ -324,7 +324,7 @@ SECTION_FUNC(TEXT, atomic_and) /** * - * atomic_or - atomically perform a bitwise OR on memory location + * @brief Atomically perform a bitwise OR on memory location * * This routine atomically performs a bitwise OR operation of the contents of * and , placing the result in . @@ -358,7 +358,7 @@ SECTION_FUNC(TEXT, atomic_or) /** * - * atomic_xor - atomically perform a bitwise XOR on a memory location + * @brief Atomically perform a bitwise XOR on a memory location * * This routine atomically performs a bitwise XOR operation of the contents of * and , placing the result in . @@ -392,7 +392,7 @@ SECTION_FUNC(TEXT, atomic_xor) /** * - * atomic_cas - atomically compare-and-swap the contents of a memory location + * @brief Atomically compare-and-swap the contents of a memory location * * This routine performs an atomic compare-and-swap. testing that the contents of * contains , and if it does, setting the value of diff --git a/arch/arm/core/basepri.S b/arch/arm/core/basepri.S index 68ae17148c9..5fe6c6b9d84 100644 --- a/arch/arm/core/basepri.S +++ b/arch/arm/core/basepri.S @@ -61,7 +61,7 @@ GTEXT(irq_unlock) /** * - * irq_lock - lock interrupts + * @brief Lock interrupts * * Prevent exceptions of priority lower than to the two highest priorities from * interrupting the CPU. @@ -80,7 +80,7 @@ SECTION_FUNC(TEXT,irq_lock) /** * - * irq_unlock - unlock interrupts + * @brief Unlock interrupts * * Return the state of interrupt locking to a previous level, passed in via the * parameter, obtained from a previous call to irq_lock(). diff --git a/arch/arm/core/context.c b/arch/arm/core/context.c index b7ed5fc88e3..2b48c65864f 100644 --- a/arch/arm/core/context.c +++ b/arch/arm/core/context.c @@ -55,7 +55,7 @@ tNANO _nanokernel = {0}; #if defined(CONFIG_CONTEXT_MONITOR) /** * - * _context_monitor_init - initialize context monitoring support + * @brief Initialize context monitoring support * * Currently only inserts the new context in the list of active contexts. * @@ -83,7 +83,7 @@ static ALWAYS_INLINE void _context_monitor_init(struct ccs *pCcs /* context */ /** * - * _NewContext - intialize a new context (thread) from its stack space + * @brief Intialize a new context (thread) from its stack space * * The control structure (CCS) is put at the lower address of the stack. An * initial context, to be "restored" by __pendsv(), is put at the other end of diff --git a/arch/arm/core/cpu_idle.S b/arch/arm/core/cpu_idle.S index 6e2146b4d18..3cf5fdce526 100644 --- a/arch/arm/core/cpu_idle.S +++ b/arch/arm/core/cpu_idle.S @@ -58,7 +58,7 @@ GTEXT(nano_cpu_atomic_idle) /** * - * _CpuIdleInit - initialization of CPU idle + * @brief Initialization of CPU idle * * Only called by nanoArchInit(). Sets SEVONPEND bit once for the system's * duration. @@ -80,7 +80,7 @@ SECTION_FUNC(TEXT, _CpuIdleInit) /** * - * _NanoIdleValGet - get the kernel idle setting + * @brief Get the kernel idle setting * * Returns the nanokernel idle setting, in ticks. Only called by __systick(). * @@ -98,7 +98,7 @@ SECTION_FUNC(TEXT, _NanoIdleValGet) /** * - * _NanoIdleValClear - clear the kernel idle setting + * @brief Clear the kernel idle setting * * Sets the nanokernel idle setting to 0. Only called by __systick(). * @@ -119,7 +119,7 @@ SECTION_FUNC(TEXT, _NanoIdleValClear) /** * - * nano_cpu_idle - power save idle routine for ARM Cortex-M + * @brief Power save idle routine for ARM Cortex-M * * This function will be called by the nanokernel idle loop or possibly within * an implementation of _sys_power_save_idle in the microkernel when the @@ -144,7 +144,7 @@ SECTION_FUNC(TEXT, nano_cpu_idle) /** * - * nano_cpu_atomic_idle - atomically re-enable interrupts and enter low power mode + * @brief Atomically re-enable interrupts and enter low power mode * * This function is utilized by the nanokernel object "wait" APIs for task * contexts, e.g. nano_task_lifo_get_wait(), nano_task_sem_take_wait(), nano_task_stack_pop_wait(), diff --git a/arch/arm/core/exc_exit.S b/arch/arm/core/exc_exit.S index aef35b3dd8f..f28fc27eafe 100644 --- a/arch/arm/core/exc_exit.S +++ b/arch/arm/core/exc_exit.S @@ -63,7 +63,7 @@ GDATA(_nanokernel) /** * - * _IntExit - kernel housekeeping when exiting interrupt handler installed + * @brief Kernel housekeeping when exiting interrupt handler installed * directly in vector table * * Kernel allows installing interrupt handlers (ISRs) directly into the vector @@ -94,7 +94,7 @@ SECTION_SUBSEC_FUNC(TEXT, _HandlerModeExit, _IntExit) /** * - * _ExcExit - kernel housekeeping when exiting exception handler installed + * @brief Kernel housekeeping when exiting exception handler installed * directly in vector table * * See _IntExit(). diff --git a/arch/arm/core/fatal.c b/arch/arm/core/fatal.c index d57e944ff98..99a872bfd78 100644 --- a/arch/arm/core/fatal.c +++ b/arch/arm/core/fatal.c @@ -64,7 +64,7 @@ const NANO_ESF _default_esf = {0xdeaddead, /* a1 */ /** * - * _NanoFatalErrorHandler - nanokernel fatal error handler + * @brief Nanokernel fatal error handler * * This routine is called when fatal error conditions are detected by software * and is responsible only for reporting the error. Once reported, it then diff --git a/arch/arm/core/fault.c b/arch/arm/core/fault.c index 92feff8ea6c..b7b6090cc98 100644 --- a/arch/arm/core/fault.c +++ b/arch/arm/core/fault.c @@ -61,7 +61,7 @@ Common fault handler for ARM Cortex-M processors. #if (CONFIG_FAULT_DUMP == 1) /** * - * _FaultDump - dump information regarding fault (FAULT_DUMP == 1) + * @brief Dump information regarding fault (FAULT_DUMP == 1) * * Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 1 * (short form). @@ -120,7 +120,7 @@ void _FaultDump(const NANO_ESF *esf, int fault) #if (CONFIG_FAULT_DUMP == 2) /** * - * _FaultContextShow - dump context information + * @brief Dump context information * * See _FaultDump() for example. * @@ -139,7 +139,7 @@ static void _FaultContextShow(const NANO_ESF *esf) /** * - * _MpuFault - dump MPU fault information + * @brief Dump MPU fault information * * See _FaultDump() for example. * @@ -174,7 +174,7 @@ static void _MpuFault(const NANO_ESF *esf, /** * - * _BusFault - dump bus fault information + * @brief Dump bus fault information * * See _FaultDump() for example. * @@ -215,7 +215,7 @@ static void _BusFault(const NANO_ESF *esf, /** * - * _UsageFault - dump usage fault information + * @brief Dump usage fault information * * See _FaultDump() for example. * @@ -255,7 +255,7 @@ static void _UsageFault(const NANO_ESF *esf) /** * - * _HardFault - dump hard fault information + * @brief Dump hard fault information * * See _FaultDump() for example. * @@ -283,7 +283,7 @@ static void _HardFault(const NANO_ESF *esf) /** * - * _DebugMonitor - dump debug monitor exception information + * @brief Dump debug monitor exception information * * See _FaultDump() for example. * @@ -299,7 +299,7 @@ static void _DebugMonitor(const NANO_ESF *esf) /** * - * _ReservedException - dump reserved exception information + * @brief Dump reserved exception information * * See _FaultDump() for example. * @@ -318,7 +318,7 @@ static void _ReservedException(const NANO_ESF *esf, /** * - * _FaultDump - dump information regarding fault (FAULT_DUMP == 2) + * @brief Dump information regarding fault (FAULT_DUMP == 2) * * Dump information regarding the fault when CONFIG_FAULT_DUMP is set to 2 * (long form). @@ -365,7 +365,7 @@ static void _FaultDump(const NANO_ESF *esf, int fault) /** * - * _Fault - fault handler + * @brief Fault handler * * This routine is called when fatal error conditions are detected by hardware * and is responsible only for reporting the error. Once reported, it then @@ -396,7 +396,7 @@ void _Fault( /** * - * _FaultInit - initialization of fault handling + * @brief Initialization of fault handling * * Turns on the desired hardware faults. * diff --git a/arch/arm/core/fault_s.S b/arch/arm/core/fault_s.S index ab67aa507d9..3fb5cc51006 100644 --- a/arch/arm/core/fault_s.S +++ b/arch/arm/core/fault_s.S @@ -54,7 +54,7 @@ GTEXT(__reserved) /** * - * __fault - fault handler installed in the fault and reserved vectors + * @brief Fault handler installed in the fault and reserved vectors * * Entry point for the hard fault, MPU fault, bus fault, usage fault, debug * monitor and reserved exceptions. diff --git a/arch/arm/core/ffs.S b/arch/arm/core/ffs.S index 72289bf5733..61118486b32 100644 --- a/arch/arm/core/ffs.S +++ b/arch/arm/core/ffs.S @@ -50,7 +50,7 @@ GTEXT(find_first_set) /** * - * find_last_set - find first set bit (searching from the most significant bit) + * @brief Find first set bit (searching from the most significant bit) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting @@ -71,7 +71,7 @@ SECTION_FUNC(TEXT, find_last_set) /** * - * find_first_set - find first set bit (searching from the least significant bit) + * @brief Find first set bit (searching from the least significant bit) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting diff --git a/arch/arm/core/fiber_abort.c b/arch/arm/core/fiber_abort.c index 93b148cf309..9cfcb33f8d4 100644 --- a/arch/arm/core/fiber_abort.c +++ b/arch/arm/core/fiber_abort.c @@ -53,7 +53,7 @@ the PendSV exception. /** * - * fiber_abort - abort the currently executing fiber + * @brief Abort the currently executing fiber * * Possible reasons for a fiber aborting: * diff --git a/arch/arm/core/gdb_stub.S b/arch/arm/core/gdb_stub.S index 03b8ee62be7..56e2d4baf44 100644 --- a/arch/arm/core/gdb_stub.S +++ b/arch/arm/core/gdb_stub.S @@ -53,7 +53,7 @@ _ASM_FILE_PROLOGUE /** * - * _GdbStubExcEntry - exception entry extra work when GDB_INFO is enabled + * @brief Exception entry extra work when GDB_INFO is enabled * * During normal system operation, the callee-saved registers are saved lazily * only when a context switch is required. To allow looking at the current @@ -97,7 +97,7 @@ SECTION_FUNC(TEXT, _GdbStubExcEntry) /** * - * _GdbStubExcExit - exception exit extra clean up when GDB_INFO is enabled + * @brief Exception exit extra clean up when GDB_INFO is enabled * * Record the fact that the thread is not interrupted anymore so that VQEMU * looks at the CPU registers and not into the CCS to obtain the current @@ -131,8 +131,7 @@ SECTION_FUNC(TEXT, _GdbStubExcExit) /** * - * _irq_vector_table_entry_with_gdb_stub - stub for ISRs installed directly in - * vector table + * @brief Stub for ISRs installed directly in vector table * * The kernel on Cortex-M3/4 can be configured so that ISRs * are installed directly in the vector table for maximum efficiency. diff --git a/arch/arm/core/irq_init.c b/arch/arm/core/irq_init.c index 3cf367b890d..d39e5b49df8 100644 --- a/arch/arm/core/irq_init.c +++ b/arch/arm/core/irq_init.c @@ -47,7 +47,7 @@ the PendSV exception. /** * - * _IntLibInit - initialize interrupts + * @brief Initialize interrupts * * Ensures all interrupts have their priority set to _EXC_IRQ_DEFAULT_PRIO and * not 0, which they have it set to when coming out of reset. This ensures that diff --git a/arch/arm/core/irq_manage.c b/arch/arm/core/irq_manage.c index 6a1a433c03c..088a59df662 100644 --- a/arch/arm/core/irq_manage.c +++ b/arch/arm/core/irq_manage.c @@ -48,7 +48,7 @@ extern void __reserved(void); /** * - * irq_handler_set - replace an interrupt handler by another + * @brief Replace an interrupt handler by another * * An interrupt's ISR can be replaced at runtime. Care must be taken that the * interrupt is disabled before doing this. @@ -78,7 +78,7 @@ void irq_handler_set(unsigned int irq, /** * - * irq_enable - enable an interrupt line + * @brief Enable an interrupt line * * Clear possible pending interrupts on the line, and enable the interrupt * line. After this call, the CPU will receive interrupts for the specified @@ -96,7 +96,7 @@ void irq_enable(unsigned int irq) /** * - * irq_disable - disable an interrupt line + * @brief Disable an interrupt line * * Disable an interrupt line. After this call, the CPU will stop receiving * interrupts for the specified . @@ -111,7 +111,7 @@ void irq_disable(unsigned int irq) /** * - * irq_priority_set - set an interrupt's priority + * @brief Set an interrupt's priority * * Valid values are from 1 to 255. Interrupts of priority 1 are not masked when * interrupts are locked system-wide, so care must be taken when using them. ISR @@ -133,7 +133,7 @@ void irq_priority_set(unsigned int irq, /** * - * _irq_spurious - spurious interrupt handler + * @brief Spurious interrupt handler * * Installed in all dynamic interrupt slots at boot time. Throws an error if * called. @@ -151,7 +151,7 @@ void _irq_spurious(void *unused) /** * - * irq_connect - connect an ISR to an interrupt line + * @brief Connect an ISR to an interrupt line * * is connected to interrupt line (exception #+16). No prior * ISR can have been connected on interrupt line since the system booted. @@ -174,7 +174,7 @@ int irq_connect(unsigned int irq, /** * - * irq_disconnect - disconnect an ISR from an interrupt line + * @brief Disconnect an ISR from an interrupt line * * Interrupt line (exception #+16) is disconnected from its ISR and * the latter is replaced by _irq_spurious(). irq_disable() should have diff --git a/arch/arm/core/isr_wrapper.S b/arch/arm/core/isr_wrapper.S index b93935afe80..f7fd7b552cc 100644 --- a/arch/arm/core/isr_wrapper.S +++ b/arch/arm/core/isr_wrapper.S @@ -55,7 +55,7 @@ GTEXT(_IntExit) /** * - * _isr_wrapper - wrapper around ISRs when inserted in software ISR table + * @brief Wrapper around ISRs when inserted in software ISR table * * When inserted in the vector table, _isr_wrapper() demuxes the ISR table using * the running interrupt number as the index, and invokes the registered ISR diff --git a/arch/arm/core/swap.S b/arch/arm/core/swap.S index 0797012ba15..0e296c5396b 100644 --- a/arch/arm/core/swap.S +++ b/arch/arm/core/swap.S @@ -53,7 +53,7 @@ GDATA(_nanokernel) /** * - * __pendsv - PendSV exception handler, handling context switches + * @brief PendSV exception handler, handling context switches * * The PendSV exception is the only context in the system that can perform * context switching. When an execution context finds out it has to switch @@ -148,7 +148,7 @@ SECTION_FUNC(TEXT, __pendsv) /** * - * __svc - service call handler + * @brief Service call handler * * 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. @@ -180,7 +180,7 @@ SECTION_FUNC(TEXT, __svc) /** * - * _Swap - initiate a cooperative context switch + * @brief Initiate a cooperative context switch * * The _Swap() routine is invoked by various nanokernel services to effect * a cooperative context context switch. Prior to invoking _Swap(), the caller diff --git a/arch/arm/core/task_abort.c b/arch/arm/core/task_abort.c index 251d1eed456..c0c3f6d4ddd 100644 --- a/arch/arm/core/task_abort.c +++ b/arch/arm/core/task_abort.c @@ -54,7 +54,7 @@ static struct k_args cmd_packet; /** * - * _TaskAbort - abort the current task + * @brief Abort the current task * * Possible reasons for a task aborting: * diff --git a/arch/arm/fsl_frdm_k64f/system.c b/arch/arm/fsl_frdm_k64f/system.c index be91ab6af15..6f43ec6331e 100644 --- a/arch/arm/fsl_frdm_k64f/system.c +++ b/arch/arm/fsl_frdm_k64f/system.c @@ -96,7 +96,7 @@ uint8_t __security_frdm_k64f_section __security_frdm_k64f[] = { /** * - * clkInit - initialize the system clock + * @brief Initialize the system clock * * This routine will configure the multipurpose clock generator (MCG) to * set up the system clock. @@ -249,7 +249,7 @@ static void clkInit(void) /** * - * consoleInit - initialize target-only console + * @brief Initialize target-only console * * Only used for debugging. * @@ -300,7 +300,7 @@ static void consoleInit(void) /** * - * _InitHardware - perform basic hardware initialization + * @brief Perform basic hardware initialization * * Initialize the interrupt controller device drivers and the * Kinetis UART device driver. diff --git a/arch/arm/fsl_frdm_k64f/wdog.S b/arch/arm/fsl_frdm_k64f/wdog.S index 2dad1dd79b7..952a8ecf4f1 100644 --- a/arch/arm/fsl_frdm_k64f/wdog.S +++ b/arch/arm/fsl_frdm_k64f/wdog.S @@ -55,7 +55,7 @@ GTEXT(_WdogInit) /** * - * _WdogInit - Watchdog timer disable routine + * @brief Watchdog timer disable routine * * This routine will disable the watchdog timer. * diff --git a/arch/arm/include/CortexM/asm_inline_gcc.h b/arch/arm/include/CortexM/asm_inline_gcc.h index 2191d2aa8f6..9faa3418ad1 100644 --- a/arch/arm/include/CortexM/asm_inline_gcc.h +++ b/arch/arm/include/CortexM/asm_inline_gcc.h @@ -42,7 +42,7 @@ /** * - * _IpsrGet - obtain value of IPSR register + * @brief Obtain value of IPSR register * * Obtain and return current value of IPSR register. * @@ -61,7 +61,7 @@ static ALWAYS_INLINE uint32_t _IpsrGet(void) /** * - * _MspSet - set the value of the Main Stack Pointer register + * @brief Set the value of the Main Stack Pointer register * * Store the value of in MSP register. * diff --git a/arch/arm/include/CortexM/exc.h b/arch/arm/include/CortexM/exc.h index fd150c74e8f..4fc5f8e3565 100644 --- a/arch/arm/include/CortexM/exc.h +++ b/arch/arm/include/CortexM/exc.h @@ -49,7 +49,7 @@ Exception/interrupt context helpers. /** * - * _IsInIsr - find out if running in an ISR context + * @brief Find out if running in an ISR context * * The current executing vector is found in the IPSR register. We consider the * IRQs (exception 16 and up), and the PendSV and SYSTICK exceptions, to be @@ -69,7 +69,7 @@ static ALWAYS_INLINE int _IsInIsr(void) } /** - * _ExcSetup - setup system exceptions + * @brief Setup system exceptions * * Set exception priorities to conform with the BASEPRI locking mechanism. * Set PendSV priority to lowest possible. diff --git a/arch/arm/include/CortexM/stack.h b/arch/arm/include/CortexM/stack.h index 8d8ef8cfe66..e5af10416bb 100644 --- a/arch/arm/include/CortexM/stack.h +++ b/arch/arm/include/CortexM/stack.h @@ -70,7 +70,7 @@ extern char _interrupt_stack[CONFIG_ISR_STACK_SIZE]; /** * - * _InterruptStackSetup - setup interrupt stack + * @brief Setup interrupt stack * * On Cortex-M, the interrupt stack is registered in the MSP (main stack * pointer) register, and switched to automatically when taking an exception. diff --git a/arch/arm/include/nano_private.h b/arch/arm/include/nano_private.h index 8a3876bd80e..af086ea5ce9 100644 --- a/arch/arm/include/nano_private.h +++ b/arch/arm/include/nano_private.h @@ -186,7 +186,7 @@ static ALWAYS_INLINE void nanoArchInit(void) /** * - * fiberRtnValueSet - set the return value for the specified fiber (inline) + * @brief Set the return value for the specified fiber (inline) * * The register used to store the return value from a function call invocation * to . It is assumed that the specified is pending, and thus diff --git a/arch/arm/ti_lm3s6965/scp.c b/arch/arm/ti_lm3s6965/scp.c index 1a135aaed54..dfe1aaedc7a 100644 --- a/arch/arm/ti_lm3s6965/scp.c +++ b/arch/arm/ti_lm3s6965/scp.c @@ -51,7 +51,7 @@ volatile struct __scp __scp_section __scp; /** * - * _ScpMainOscEnable - enable main oscillator with default frequency of 6MHz + * @brief Enable main oscillator with default frequency of 6MHz * * @return N/A */ diff --git a/arch/arm/ti_lm3s6965/system.c b/arch/arm/ti_lm3s6965/system.c index cd5819c95be..7b996e373e2 100644 --- a/arch/arm/ti_lm3s6965/system.c +++ b/arch/arm/ti_lm3s6965/system.c @@ -61,7 +61,7 @@ extern void _NmiInit(void); /** * - * uart_generic_info_init - initialize generic information for one UART + * @brief Initialize generic information for one UART * * @return N/A * @@ -81,7 +81,7 @@ inline void uart_generic_info_init(struct uart_init_info *pInfo) /** * - * consoleInit - initialize target-only console + * @brief Initialize target-only console * * Only used for debugging. * @@ -134,7 +134,7 @@ static void bluetooth_init(void) /** * - * _InitHardware - perform basic hardware initialization + * @brief Perform basic hardware initialization * * Initialize the interrupt controller device drivers and the * integrated 16550-compatible UART device driver. diff --git a/arch/x86/cache.c b/arch/x86/cache.c index 7a932c79805..f4971b1ea12 100644 --- a/arch/x86/cache.c +++ b/arch/x86/cache.c @@ -46,7 +46,7 @@ This module contains functions for manipulation caches. /** * - * _SysCacheFlush - flush a page to main memory + * @brief Flush a page to main memory * * No alignment is required for either or , but since * _SysCacheFlush() iterates on the cache lines, a cache line alignment for both diff --git a/arch/x86/cache_s.S b/arch/x86/cache_s.S index 770072e4a31..cee55c2c9f2 100644 --- a/arch/x86/cache_s.S +++ b/arch/x86/cache_s.S @@ -44,7 +44,7 @@ This module contains functions for manipulating caches. /** * - * _SysCacheFlush - flush a page to main memory + * @brief Flush a page to main memory * * This implementation flushes the whole cache. * diff --git a/arch/x86/core/atomic.S b/arch/x86/core/atomic.S index 560a31c0346..ae20617882e 100644 --- a/arch/x86/core/atomic.S +++ b/arch/x86/core/atomic.S @@ -68,7 +68,7 @@ as there is no requirement for this capability. /** * - * atomic_cas - atomic compare-and-set primitive + * @brief Atomic compare-and-set primitive * * This routine provides the compare-and-set operator. If the original value at * equals , then is stored at and the @@ -115,7 +115,7 @@ BRANCH_LABEL(atomic_cas1) /** * - * atomic_add - atomic add primitive + * @brief Atomic add primitive * * This routine provides the atomic addition operator. The is * atomically added to the value at , placing the result at , @@ -147,7 +147,7 @@ SECTION_FUNC(TEXT, atomic_add) /** * - * atomic_sub - atomic subtraction primitive + * @brief Atomic subtraction primitive * * This routine provides the atomic subtraction operator. The is * atomically subtracted from the value at , placing the result at @@ -180,7 +180,7 @@ SECTION_FUNC(TEXT, atomic_sub) /** * - * atomic_inc - atomic increment primitive + * @brief Atomic increment primitive * * This routine provides the atomic increment operator. The value at * is atomically incremented by 1, and the old value from is returned. @@ -212,7 +212,7 @@ SECTION_FUNC(TEXT, atomic_inc) /** * - * atomic_dec - atomic decrement primitive + * @brief Atomic decrement primitive * * This routine provides the atomic decrement operator. The value at * is atomically decremented by 1, and the old value from is returned. @@ -242,7 +242,7 @@ SECTION_FUNC(TEXT, atomic_dec) /** * - * atomic_get - atomic get primitive + * @brief Atomic get primitive * * This routine provides the atomic get primitive to atomically read * a value from . It simply does an ordinary load. Note that @@ -266,7 +266,7 @@ SECTION_FUNC(TEXT, atomic_get) /** * - * atomic_set - atomic get-and-set primitive + * @brief Atomic get-and-set primitive * * This routine provides the atomic set operator. The is atomically * written at and the previous value at is returned. @@ -306,7 +306,7 @@ SECTION_FUNC(TEXT, atomic_set) /** * - * atomic_clear - atomic clear primitive + * @brief Atomic clear primitive * * This routine provides the atomic clear operator. The value of 0 is atomically * written at and the previous value at is returned. (Hence, @@ -343,7 +343,7 @@ SECTION_FUNC(TEXT, atomic_clear) /** * - * atomic_or - atomic bitwise inclusive OR primitive + * @brief Atomic bitwise inclusive OR primitive * * This routine provides the atomic bitwise inclusive OR operator. The * is atomically bitwise OR'ed with the value at , placing the result @@ -381,7 +381,7 @@ BRANCH_LABEL(atomic_or_retry) /** * - * atomic_xor - atomic bitwise exclusive OR (XOR) primitive + * @brief Atomic bitwise exclusive OR (XOR) primitive * * This routine provides the atomic bitwise exclusive OR operator. The * is atomically bitwise XOR'ed with the value at , placing the result @@ -419,7 +419,7 @@ BRANCH_LABEL(atomic_xor_retry) /** * - * atomic_and - atomic bitwise AND primitive + * @brief Atomic bitwise AND primitive * * This routine provides the atomic bitwise AND operator. The is * atomically bitwise AND'ed with the value at , placing the result @@ -457,7 +457,7 @@ BRANCH_LABEL(atomic_and_retry) /** * - * atomic_nand - atomic bitwise NAND primitive + * @brief Atomic bitwise NAND primitive * * This routine provides the atomic bitwise NAND operator. The is * atomically bitwise NAND'ed with the value at , placing the result diff --git a/arch/x86/core/atomic_nolock.c b/arch/x86/core/atomic_nolock.c index 441167e1918..f3605d6836f 100644 --- a/arch/x86/core/atomic_nolock.c +++ b/arch/x86/core/atomic_nolock.c @@ -52,7 +52,7 @@ as there is no requirement for this capability. /** * - * atomic_cas - atomic compare-and-set primitive + * @brief Atomic compare-and-set primitive * * This routine provides the compare-and-set operator. If the original value at * equals , then is stored at and the @@ -90,7 +90,7 @@ int atomic_cas( /** * - * atomic_add - atomic addition primitive + * @brief Atomic addition primitive * * This routine provides the atomic addition operator. The is * atomically added to the value at , placing the result at , @@ -116,7 +116,7 @@ atomic_val_t atomic_add( /** * - * atomic_sub - atomic subtraction primitive + * @brief Atomic subtraction primitive * * This routine provides the atomic subtraction operator. The is * atomically subtracted from the value at , placing the result at @@ -142,7 +142,7 @@ atomic_val_t atomic_sub( /** * - * atomic_inc - atomic increment primitive + * @brief Atomic increment primitive * * This routine provides the atomic increment operator. The value at * is atomically incremented by 1, and the old value from is returned. @@ -166,7 +166,7 @@ atomic_val_t atomic_inc( /** * - * atomic_dec - atomic decrement primitive + * @brief Atomic decrement primitive * * This routine provides the atomic decrement operator. The value at * is atomically decremented by 1, and the old value from is returned. @@ -190,7 +190,7 @@ atomic_val_t atomic_dec( /** * - * atomic_get - atomic get primitive + * @brief Atomic get primitive * * This routine provides the atomic get primitive to atomically read * a value from . It simply does an ordinary load. Note that @@ -207,7 +207,7 @@ atomic_val_t atomic_get(const atomic_t *target /* memory location to read from * /** * - * atomic_set - atomic get-and-set primitive + * @brief Atomic get-and-set primitive * * This routine provides the atomic set operator. The is atomically * written at and the previous value at is returned. @@ -232,7 +232,7 @@ atomic_val_t atomic_set( /** * - * atomic_clear - atomic clear primitive + * @brief Atomic clear primitive * * This routine provides the atomic clear operator. The value of 0 is atomically * written at and the previous value at is returned. (Hence, @@ -257,7 +257,7 @@ atomic_val_t atomic_clear( /** * - * atomic_or - atomic bitwise inclusive OR primitive + * @brief Atomic bitwise inclusive OR primitive * * This routine provides the atomic bitwise inclusive OR operator. The * is atomically bitwise OR'ed with the value at , placing the result @@ -283,7 +283,7 @@ atomic_val_t atomic_or( /** * - * atomic_xor - atomic bitwise exclusive OR (XOR) primitive + * @brief Atomic bitwise exclusive OR (XOR) primitive * * This routine provides the atomic bitwise exclusive OR operator. The * is atomically bitwise XOR'ed with the value at , placing the result @@ -309,7 +309,7 @@ atomic_val_t atomic_xor( /** * - * atomic_and - atomic bitwise AND primitive + * @brief Atomic bitwise AND primitive * * This routine provides the atomic bitwise AND operator. The is * atomically bitwise AND'ed with the value at , placing the result @@ -335,7 +335,7 @@ atomic_val_t atomic_and( /** * - * atomic_nand - atomic bitwise NAND primitive + * @brief Atomic bitwise NAND primitive * * This routine provides the atomic bitwise NAND operator. The is * atomically bitwise NAND'ed with the value at , placing the result diff --git a/arch/x86/core/context.c b/arch/x86/core/context.c index a1b4d355967..4aa1be51dd4 100644 --- a/arch/x86/core/context.c +++ b/arch/x86/core/context.c @@ -59,7 +59,7 @@ void _ContextEntryWrapper(_ContextEntry, _ContextArg, _ContextArg, _ContextArg); /** * - * _NewContextInternal - initialize a new execution context + * @brief Initialize a new execution context * * This function is utilized to initialize all execution contexts (both fiber * and task). The 'priority' parameter will be set to -1 for the creation of @@ -208,7 +208,7 @@ static void _NewContextInternal( #ifdef CONFIG_GDB_INFO /** * - * _ContextEntryWrapper - adjust stack before invoking _context_entry + * @brief Adjust stack before invoking _context_entry * * This function adjusts the initial stack frame created by _NewContext() * such that the GDB stack frame unwinders recognize it as the outermost frame @@ -275,7 +275,7 @@ __asm__("\t.globl _context_entry\n" /** * - * _NewContext - create a new kernel execution context + * @brief Create a new kernel execution context * * This function is utilized to create execution contexts for both fiber * contexts and kernel task contexts. diff --git a/arch/x86/core/cpuhalt.S b/arch/x86/core/cpuhalt.S index fcd23a9e945..3405eab53b7 100644 --- a/arch/x86/core/cpuhalt.S +++ b/arch/x86/core/cpuhalt.S @@ -66,7 +66,7 @@ by nano_cpu_atomic_idle(). /** * - * nano_cpu_idle - power save idle routine for IA-32 + * @brief Power save idle routine for IA-32 * * This function will be called by the nanokernel idle loop or possibly within * an implementation of _sys_power_save_idle in the microkernel when the @@ -96,7 +96,7 @@ SECTION_FUNC(TEXT, nano_cpu_idle) /** * - * nano_cpu_atomic_idle - atomically re-enable interrupts and enter low power mode + * @brief Atomically re-enable interrupts and enter low power mode * * This function is utilized by the nanokernel object "wait" APIs for task * contexts, e.g. nano_task_lifo_get_wait(), nano_task_sem_take_wait(), nano_task_stack_pop_wait(), diff --git a/arch/x86/core/excconnect.c b/arch/x86/core/excconnect.c index 1bb9bf3de36..b63eb967be5 100644 --- a/arch/x86/core/excconnect.c +++ b/arch/x86/core/excconnect.c @@ -88,7 +88,7 @@ void _NanoCpuExcConnectAtDpl(unsigned int vector, /** * - * nanoCpuExcConnect - connect a C routine to an exception + * @brief Connect a C routine to an exception * * This routine connects an exception handler coded in C to the specified * interrupt vector. An exception is defined as a synchronous interrupt, i.e. @@ -128,7 +128,7 @@ void nanoCpuExcConnect(unsigned int vector, /* interrupt vector: 0 to 255 on /** * - * _NanoCpuExcConnectAtDpl - connect a C routine to an exception + * @brief Connect a C routine to an exception * * This routine connects an exception handler coded in C to the specified * interrupt vector. An exception is defined as a synchronous interrupt, i.e. diff --git a/arch/x86/core/excstub.S b/arch/x86/core/excstub.S index 4255d45bda7..aad74c3fbe1 100644 --- a/arch/x86/core/excstub.S +++ b/arch/x86/core/excstub.S @@ -59,7 +59,7 @@ and exiting a C exception handler. /** * - * _ExcEnt - inform the kernel of an exception + * @brief Inform the kernel of an exception * * This function is called from the exception stub created by nanoCpuExcConnect() * to inform the kernel of an exception. This routine currently does @@ -217,7 +217,7 @@ BRANCH_LABEL(allDone) /** * - * _ExcExit - inform the kernel of an exception exit + * @brief Inform the kernel of an exception exit * * This function is called from the exception stub created by nanoCpuExcConnect() * to inform the kernel that the processing of an exception has diff --git a/arch/x86/core/fatal.c b/arch/x86/core/fatal.c index b2ed06ad1dd..23196fa41cc 100644 --- a/arch/x86/core/fatal.c +++ b/arch/x86/core/fatal.c @@ -67,7 +67,7 @@ const NANO_ESF _default_esf = { /** * - * _NanoFatalErrorHandler - nanokernel fatal error handler + * @brief Nanokernel fatal error handler * * This routine is called when a fatal error condition is detected by either * hardware or software. diff --git a/arch/x86/core/ffs.S b/arch/x86/core/ffs.S index 6cf16bd53db..9cf9884a335 100644 --- a/arch/x86/core/ffs.S +++ b/arch/x86/core/ffs.S @@ -53,7 +53,7 @@ are defined in arch.h. /** * - * find_first_set - find first set bit searching from the LSB + * @brief Find first set bit searching from the LSB * * This routine finds the first bit set in the passed argument and * returns the index of that bit. Bits are numbered starting @@ -96,7 +96,7 @@ BRANCH_LABEL(ffsLsb_argNotZero) /* this label serves find_first_set() & find_las /** * - * find_last_set - find first set bit searching from the MSB + * @brief Find first set bit searching from the MSB * * This routine finds the first bit set in the passed argument and * returns the index of that bit. Bits are numbered starting diff --git a/arch/x86/core/float.c b/arch/x86/core/float.c index 3f0c32eeeae..5c7f6a53adf 100644 --- a/arch/x86/core/float.c +++ b/arch/x86/core/float.c @@ -114,7 +114,7 @@ extern uint32_t _sse_mxcsr_default_value; /* SSE control/status register default /** * - * _FpCtxSave - save non-integer context information + * @brief Save non-integer context information * * This routine saves the system's "live" non-integer context into the * specified CCS. If the specified task or fiber supports SSE then @@ -130,7 +130,7 @@ static void _FpCtxSave(tCCS *ccs) /** * - * _FpCtxInit - initialize non-integer context information + * @brief Initialize non-integer context information * * This routine initializes the system's "live" non-integer context. * @@ -144,7 +144,7 @@ static inline void _FpCtxInit(tCCS *ccs) /** * - * _FpEnable - enable preservation of non-integer context information + * @brief Enable preservation of non-integer context information * * This routine allows the specified task/fiber (which may be the active * task/fiber) to safely share the system's floating point registers with @@ -289,7 +289,7 @@ void _FpEnable(tCCS *ccs, /** * - * fiber_float_enable - enable preservation of non-integer context information + * @brief Enable preservation of non-integer context information * * This routine allows a fiber to permit a task/fiber (including itself) to * safely share the system's floating point registers with other tasks/fibers. @@ -303,7 +303,7 @@ FUNC_ALIAS(_FpEnable, fiber_float_enable, void); /** * - * task_float_enable - enable preservation of non-integer context information + * @brief Enable preservation of non-integer context information * * This routine allows a task to permit a task/fiber (including itself) to * safely share the system's floating point registers with other tasks/fibers. @@ -317,7 +317,7 @@ FUNC_ALIAS(_FpEnable, task_float_enable, void); /** * - * _FpDisable - disable preservation of non-integer context information + * @brief Disable preservation of non-integer context information * * This routine prevents the specified task/fiber (which may be the active * task/fiber) from safely sharing any of the system's floating point registers @@ -378,7 +378,7 @@ void _FpDisable(tCCS *ccs) /** * - * fiber_float_disable - disable preservation of non-integer context + * @brief Disable preservation of non-integer context *information * * This routine allows a fiber to disallow a task/fiber (including itself) from @@ -396,7 +396,7 @@ FUNC_ALIAS(_FpDisable, fiber_float_disable, void); /** * - * task_float_disable - disable preservation of non-integer context information + * @brief Disable preservation of non-integer context information * * This routine allows a task to disallow a task/fiber (including itself) from * safely sharing any of the system's floating point registers with other @@ -415,7 +415,7 @@ FUNC_ALIAS(_FpDisable, task_float_disable, void); /** * - * _FpNotAvailableExcHandler - handler for "device not available" exception + * @brief Handler for "device not available" exception * * This routine is registered to handle the "device not available" exception * (vector = 7) when the AUTOMATIC_FP_ENABLING configuration option has been diff --git a/arch/x86/core/intboiexit.S b/arch/x86/core/intboiexit.S index 5fd85d37f48..3f64b93fc5e 100644 --- a/arch/x86/core/intboiexit.S +++ b/arch/x86/core/intboiexit.S @@ -66,7 +66,7 @@ _IntBoiExit() is present. /** * - * _IntBoiExit - exit interrupt handler stub without invoking ISR + * @brief Exit interrupt handler stub without invoking ISR * * This routine exits an interrupt handler stub without invoking the associated * ISR handler (or the EOI handler, if present). It should only be jumped to diff --git a/arch/x86/core/intconnect.c b/arch/x86/core/intconnect.c index f17f26006c9..0dab75a1a05 100644 --- a/arch/x86/core/intconnect.c +++ b/arch/x86/core/intconnect.c @@ -160,7 +160,7 @@ static NANO_INT_STUB dynamic_stubs[ALL_DYNAMIC_STUBS] = { }; /** - * _int_stub_alloc - allocate dynamic interrupt stub + * @brief Allocate dynamic interrupt stub * * @return index of the first available element of the STUB array or -1 * if all elements are used @@ -181,7 +181,7 @@ static int _int_stub_alloc(void) /** * - * _IntVecSet - connect a routine to an interrupt vector + * @brief Connect a routine to an interrupt vector * * This routine "connects" the specified to the specified interrupt * . On the IA-32 architecture, an interrupt vector is a value from @@ -235,7 +235,7 @@ void _IntVecSet( #if ALL_DYNAMIC_STUBS > 0 /** * - * irq_connect - connect a C routine to a hardware interrupt + * @brief Connect a C routine to a hardware interrupt * * This routine connects an interrupt service routine (ISR) coded in C to * the specified hardware . An interrupt vector will be allocated to @@ -480,7 +480,7 @@ int irq_connect( /** * - * _IntVecAlloc - allocate a free interrupt vector given + * @brief Allocate a free interrupt vector given * * This routine scans the interrupt_vectors_allocated[] array for a free vector that * satisfies the specified . It is a utility function for use only @@ -603,7 +603,7 @@ int _IntVecAlloc(unsigned int priority) /** * - * _IntVecMarkAllocated - mark interrupt vector as allocated + * @brief Mark interrupt vector as allocated * * This routine is used to "reserve" an interrupt vector that is allocated * or assigned by any means other than _IntVecAllocate(). This marks the vector @@ -627,7 +627,7 @@ void _IntVecMarkAllocated(unsigned int vector) /** * - * _IntVecMarkFree - mark interrupt vector as free + * @brief Mark interrupt vector as free * * This routine is used to "free" an interrupt vector that is allocated * or assigned using _IntVecAllocate() or _IntVecMarkAllocated(). This marks the diff --git a/arch/x86/core/inthndlset.c b/arch/x86/core/inthndlset.c index 342ee56ed01..36e02881937 100644 --- a/arch/x86/core/inthndlset.c +++ b/arch/x86/core/inthndlset.c @@ -59,7 +59,7 @@ extern unsigned char _idt_base_address[]; /** * - * irq_handler_set - set the handler in an already connected stub + * @brief Set the handler in an already connected stub * * This routine is used to modify an already fully constructed interrupt stub * to specify a new and/or . diff --git a/arch/x86/core/intstub.S b/arch/x86/core/intstub.S index 86ab2e0c248..58fdca47900 100644 --- a/arch/x86/core/intstub.S +++ b/arch/x86/core/intstub.S @@ -76,7 +76,7 @@ entering and exiting a C interrupt handler. #endif /** * - * _IntEnt - inform the kernel of an interrupt + * @brief Inform the kernel of an interrupt * * This function is called from the interrupt stub created by irq_connect() * to inform the kernel of an interrupt. This routine increments @@ -242,7 +242,7 @@ BRANCH_LABEL(_HandleIdle) /** * - * _IntExit - inform the kernel of an interrupt exit + * @brief Inform the kernel of an interrupt exit * * This function is called from the interrupt stub created by irq_connect() * to inform the kernel that the processing of an interrupt has @@ -391,7 +391,7 @@ BRANCH_LABEL(nestedInterrupt) /** * * _SpuriousIntHandler - - * _SpuriousIntNoErrCodeHandler - spurious interrupt handler stubs + * @brief Spurious interrupt handler stubs * * Interrupt-gate descriptors are statically created for all slots in the IDT * that point to _SpuriousIntHandler() or _SpuriousIntNoErrCodeHandler(). The @@ -464,7 +464,7 @@ BRANCH_LABEL(callFatalHandler) /** * - * irq_lock - disable interrupts on the local CPU + * @brief Disable interrupts on the local CPU * * This routine disables interrupts. It can be called from either interrupt * or context level. This routine returns an architecture-dependent @@ -503,7 +503,7 @@ SECTION_FUNC(TEXT, irq_lock) /** * - * irq_unlock - enable interrupts on the local CPU + * @brief Enable interrupts on the local CPU * * This routine re-enables interrupts on the local CPU. The parameter * is an architecture-dependent lock-out key that is returned by a previous diff --git a/arch/x86/core/msr.S b/arch/x86/core/msr.S index 9755cee57a7..a0fa996369c 100644 --- a/arch/x86/core/msr.S +++ b/arch/x86/core/msr.S @@ -47,7 +47,7 @@ utilities. /** * - * _MsrWrite - write to a model specific register (MSR) + * @brief Write to a model specific register (MSR) * * This function is used to write to an MSR. * @@ -78,7 +78,7 @@ SECTION_FUNC(TEXT, _MsrWrite) /** * - * _MsrRead - read from a model specific register (MSR) + * @brief Read from a model specific register (MSR) * * This function is used to read from an MSR. * diff --git a/arch/x86/core/swap.S b/arch/x86/core/swap.S index c137b381842..3a05c4e4d6f 100644 --- a/arch/x86/core/swap.S +++ b/arch/x86/core/swap.S @@ -56,7 +56,7 @@ save frame on the stack. /** * - * _Swap - initiate a cooperative context switch + * @brief Initiate a cooperative context switch * * The _Swap() routine is invoked by various nanokernel services to effect * a cooperative context context switch. Prior to invoking _Swap(), the diff --git a/arch/x86/core/unaligned.S b/arch/x86/core/unaligned.S index 0e3498bce58..b921d72cc06 100644 --- a/arch/x86/core/unaligned.S +++ b/arch/x86/core/unaligned.S @@ -51,7 +51,7 @@ performed byte-by-byte. /** * - * _Unaligned32Write - perform an unaligned 32-bit write operation + * @brief Perform an unaligned 32-bit write operation * * This function is used during the interrupt and exception stub code * synthesis step when writing out the 32-bit relative jmp/branch @@ -88,7 +88,7 @@ SECTION_FUNC(TEXT, _Unaligned32Write) /** * - * _Unaligned32Read - perform an unaligned 32-bit read operation + * @brief Perform an unaligned 32-bit read operation * * This function is used during the interrupt and exception stub code * synthesis step when reading the 32-bit relative jmp/branch diff --git a/arch/x86/generic_pc/system.c b/arch/x86/generic_pc/system.c index c9b70e3bbc2..e2f53e11920 100644 --- a/arch/x86/generic_pc/system.c +++ b/arch/x86/generic_pc/system.c @@ -88,7 +88,7 @@ static inline void ioapicInit(void) /** * - * uart_generic_info_init - initialize initialization information for one UART + * @brief Initialize initialization information for one UART * * @return N/A * @@ -108,7 +108,7 @@ void uart_generic_info_init(struct uart_init_info *p_info) /** * - * consoleInit - initialize target-only console + * @brief Initialize target-only console * * Only used for debugging. * @@ -151,7 +151,7 @@ static void bluetooth_init(void) /** * - * _InitHardware - perform basic hardware initialization + * @brief Perform basic hardware initialization * * Initialize the Intel 8259A interrupt controller device driver and the * Intel 8250 UART device driver. diff --git a/arch/x86/include/advidle.h b/arch/x86/include/advidle.h index 29a26861982..01fa3a7fcc3 100644 --- a/arch/x86/include/advidle.h +++ b/arch/x86/include/advidle.h @@ -43,7 +43,7 @@ and _AdvIdleStart() functions. #ifdef CONFIG_ADVANCED_IDLE /* - * _AdvIdleCheckSleep - determine if advanced sleep has occurred + * @brief Determine if advanced sleep has occurred * * This routine checks if the system is recovering from advanced * sleep or cold booting. @@ -55,7 +55,7 @@ and _AdvIdleStart() functions. extern int _AdvIdleCheckSleep(void); /* - * _AdvIdleStart - continue kernel start-up or awaken kernel from sleep + * @brief Continue kernel start-up or awaken kernel from sleep * * This routine checks if the system is recovering from advanced sleep and * either continues the kernel's cold boot sequence at _Cstart or resumes @@ -73,7 +73,7 @@ extern void _AdvIdleStart( ); /* - * _AdvIdleFunc - perform advanced sleep + * @brief Perform advanced sleep * * This routine checks if the upcoming kernel idle interval is sufficient to * justify entering advanced sleep mode. If it is, the routine puts the system diff --git a/arch/x86/include/asmPrv.h b/arch/x86/include/asmPrv.h index da87631e6c8..3215555c3f4 100644 --- a/arch/x86/include/asmPrv.h +++ b/arch/x86/include/asmPrv.h @@ -65,7 +65,7 @@ extern "C" { /** * - * NANO_CPU_EXC_CONNECT - to generate and register an exception stub + * @brief To generate and register an exception stub * * Generates an exception stub for the handler, . It is registered * on the vector given by with the privilege level ; should always @@ -81,7 +81,7 @@ extern "C" { /** * - * NANO_CPU_EXC_CONNECT_NO_ERR - to generate and register an exception stub + * @brief To generate and register an exception stub * * Generates an exception stub for the handler, . It is registered * on the vector given by with the privilege level ; should always diff --git a/arch/x86/include/asm_inline_gcc.h b/arch/x86/include/asm_inline_gcc.h index 594b5e6633d..e5284e8cb27 100644 --- a/arch/x86/include/asm_inline_gcc.h +++ b/arch/x86/include/asm_inline_gcc.h @@ -47,7 +47,7 @@ NANO_CPU_EXC_CONNECT_NO_ERR(handler,vector,0) /** * - * EflagsGet - return the current value of the EFLAGS register + * @brief Return the current value of the EFLAGS register * * @return the EFLAGS register. * @@ -72,7 +72,7 @@ static inline unsigned int EflagsGet(void) /** * - * _FpAccessDisable - disallow use of floating point capabilities + * @brief Disallow use of floating point capabilities * * This routine sets CR0[TS] to 1, which disallows the use of FP instructions * by the currently executing context. @@ -96,7 +96,7 @@ static inline void _FpAccessDisable(void) /** * - * _do_fp_ctx_save - save non-integer context information + * @brief Save non-integer context information * * This routine saves the system's "live" non-integer context into the * specified area. If the specified task or fiber supports SSE then @@ -128,7 +128,7 @@ static inline void _do_fp_ctx_save(int flags, void *preemp_float_reg) /** * - * _do_fp_ctx_init - initialize non-integer context information + * @brief Initialize non-integer context information * * This routine initializes the system's "live" non-integer context. * Function is invoked by _FpCtxInit(tCCS *ccs) diff --git a/arch/x86/include/nano_private.h b/arch/x86/include/nano_private.h index 96e3149759c..9fefeb3fa0f 100644 --- a/arch/x86/include/nano_private.h +++ b/arch/x86/include/nano_private.h @@ -762,7 +762,7 @@ extern tNANO _nanokernel; /** * - * nanoArchInit - performs architecture-specific initialization + * @brief Performs architecture-specific initialization * * This routine performs architecture-specific initialization of the nanokernel. * Trivial stuff is done inline; more complex initialization is done via @@ -811,7 +811,7 @@ static inline void nanoArchInit(void) /** * - * fiberRtnValueSet - set the return value for the specified fiber (inline) + * @brief Set the return value for the specified fiber (inline) * * The register used to store the return value from a function call invocation is * set to . It is assumed that the specified is pending, and diff --git a/arch/x86/quark/board.h b/arch/x86/quark/board.h index e567281114b..316bb362b6f 100644 --- a/arch/x86/quark/board.h +++ b/arch/x86/quark/board.h @@ -154,7 +154,7 @@ the 'Quark' BSP. /** * - * outByte - output byte to memory location + * @brief Output byte to memory location * * @return N/A * @@ -168,7 +168,7 @@ static inline void outByte(uint8_t data, uint32_t addr) /** * - * inByte - obtain byte value from memory location + * @brief Obtain byte value from memory location * * This function issues the 'move' instruction to read a byte from the specified * memory address. @@ -196,7 +196,7 @@ static inline uint8_t inByte(uint32_t addr) /** * - * outWord - output word to memory location + * @brief Output word to memory location * * @return N/A * @@ -210,7 +210,7 @@ static inline void outWord(uint16_t data, uint32_t addr) /** * - * inWord - obtain word value from memory location + * @brief Obtain word value from memory location * * This function issues the 'move' instruction to read a word from the specified * memory address. @@ -238,7 +238,7 @@ static inline uint16_t inWord(uint32_t addr) /** * - * outLong - output long word to memory location + * @brief Output long word to memory location * * @return N/A * @@ -252,7 +252,7 @@ static inline void outLong(uint32_t data, uint32_t addr) /** * - * inLong - obtain long word value from memory location + * @brief Obtain long word value from memory location * * This function issues the 'move' instruction to read a word from the specified * memory address. @@ -270,7 +270,7 @@ static inline uint32_t inLong(uint32_t addr) /** * - * pci_pin2irq - convert PCI interrupt PIN to IRQ + * @brief Convert PCI interrupt PIN to IRQ * * The routine uses "standard design consideration" and implies that * INTA (pin 1) -> IRQ 16 @@ -291,7 +291,7 @@ static inline int pci_pin2irq(int pin) /** * - * pci_irq2pin - convert IRQ to PCI interrupt pin + * @brief Convert IRQ to PCI interrupt pin * * @return pin number, -1 if the result is incorrect * diff --git a/arch/x86/quark/system.c b/arch/x86/quark/system.c index 66249a24671..ecec172cf3c 100644 --- a/arch/x86/quark/system.c +++ b/arch/x86/quark/system.c @@ -57,7 +57,7 @@ Handlers for the secondary serial port have not been added. /** * - * uart_generic_info_init - initialize initialization information for one UART + * @brief Initialize initialization information for one UART * * @return N/A * @@ -76,7 +76,7 @@ void uart_generic_info_init(struct uart_init_info *p_info) /** * - * consoleInit - initialize target-only console + * @brief Initialize target-only console * * Only used for debugging. * @@ -103,7 +103,7 @@ static void consoleInit(void) /** * - * _InitHardware - perform basic hardware initialization + * @brief Perform basic hardware initialization * * Initialize the Intel LOAPIC and IOAPIC device driver and the * Intel 8250 UART device driver. diff --git a/arch/x86/sys_fatal_error_handler.c b/arch/x86/sys_fatal_error_handler.c index 8b6b5627386..8344e26f020 100644 --- a/arch/x86/sys_fatal_error_handler.c +++ b/arch/x86/sys_fatal_error_handler.c @@ -49,7 +49,7 @@ supported BSPs. /** * - * _SysFatalErrorHandler - fatal error handler + * @brief Fatal error handler * * This routine implements the corrective action to be taken when the system * detects a fatal error. diff --git a/arch/x86/task/strtask.c b/arch/x86/task/strtask.c index 94c5d934563..7316d26c700 100644 --- a/arch/x86/task/strtask.c +++ b/arch/x86/task/strtask.c @@ -53,7 +53,7 @@ Intel-specific parts of start_task(). Only FP functionality currently. /** * - * _StartTaskArch - Intel-specifc parts of task initialization + * @brief Intel-specifc parts of task initialization * * @return N/A */ diff --git a/drivers/console/uart_console.c b/drivers/console/uart_console.c index 7791feeb715..30a9a04179e 100644 --- a/drivers/console/uart_console.c +++ b/drivers/console/uart_console.c @@ -58,7 +58,7 @@ #if 0 /* NOTUSED */ /** * - * consoleIn - get a character from UART + * @brief Get a character from UART * * @return the character or EOF if nothing present */ @@ -76,7 +76,7 @@ static int consoleIn(void) #if defined(CONFIG_PRINTK) || defined(CONFIG_STDOUT_CONSOLE) /** * - * consoleOut - output one character to UART + * @brief Output one character to UART * * Outputs both line feed and carriage return in the case of a '\n'. * @@ -211,7 +211,7 @@ void uart_register_input(struct nano_fifo *avail, struct nano_fifo *lines) /** * - * uart_console_init - initialize one UART as the console/debug port + * @brief Initialize one UART as the console/debug port * * @return N/A */ diff --git a/drivers/interrupt_controller/arcv2_irq_unit.c b/drivers/interrupt_controller/arcv2_irq_unit.c index 2ca2cef2fd7..afb2b17f19d 100644 --- a/drivers/interrupt_controller/arcv2_irq_unit.c +++ b/drivers/interrupt_controller/arcv2_irq_unit.c @@ -44,7 +44,7 @@ #include /* - * _arc_v2_irq_unit_init - initialize the interrupt unit device driver + * @brief Initialize the interrupt unit device driver * * Initializes the interrupt unit device driver and the device * itself. @@ -69,7 +69,7 @@ void _arc_v2_irq_unit_init(void) } /* - * _arc_v2_irq_unit_int_eoi - send EOI signal to interrupt unit + * @brief Send EOI signal to interrupt unit * * This routine sends an EOI (End Of Interrupt) signal to the interrupt unit * to clear a pulse-triggered interrupt. @@ -87,7 +87,7 @@ void _arc_v2_irq_unit_int_eoi(int irq) } /* - * _arc_v2_irq_unit_int_trigger_set - sets an IRQ line to level/pulse trigger + * @brief Sets an IRQ line to level/pulse trigger * * Sets the IRQ line to trigger an interrupt based on the level or the * edge of the signal. Valid values for are _ARC_V2_INT_LEVEL and diff --git a/drivers/interrupt_controller/i8259.c b/drivers/interrupt_controller/i8259.c index 2e58f8da1a8..6fa4144746b 100644 --- a/drivers/interrupt_controller/i8259.c +++ b/drivers/interrupt_controller/i8259.c @@ -118,7 +118,7 @@ FUNC_ALIAS(_i8259_irq_disable, irq_disable, void); /** * - * _i8259_init - initialize the Intel 8259A PIC device driver + * @brief Initialize the Intel 8259A PIC device driver * * This routine initializes the Intel 8259A PIC device driver and the device * itself. @@ -187,7 +187,7 @@ void _i8259_init(void) #ifndef CONFIG_SHUTOFF_PIC /** * - * _i8259_eoi_master - send EOI(end of interrupt) signal to the master PIC. + * @brief Send EOI(end of interrupt) signal to the master PIC. * * This routine is called at the end of the interrupt handler. * @@ -209,7 +209,7 @@ void _i8259_eoi_master(unsigned int irq /* IRQ number to /** * - * _i8259_eoi_slave - send EOI(end of interrupt) signal to the slave PIC. + * @brief Send EOI(end of interrupt) signal to the slave PIC. * * This routine is called at the end of the interrupt handler in the Normal * Fully Nested Mode. @@ -241,7 +241,7 @@ void _i8259_eoi_slave(unsigned int irq /* IRQ number to /** * - * __I8259IntEnable - enable/disable a specified PIC interrupt input line + * @brief Enable/disable a specified PIC interrupt input line * * This routine enables or disables a specified PIC interrupt input line. To * enable an interrupt input line, the parameter must be non-zero. @@ -292,7 +292,7 @@ static void __I8259IntEnable( /** * - * _i8259_irq_disable - disable a specified PIC interrupt input line + * @brief Disable a specified PIC interrupt input line * * This routine disables a specified PIC interrupt input line. * @@ -309,7 +309,7 @@ void _i8259_irq_disable(unsigned int irq /* IRQ number to disable */ /** * - * _i8259_irq_enable - enable a specified PIC interrupt input line + * @brief Enable a specified PIC interrupt input line * * This routine enables a specified PIC interrupt input line. * diff --git a/drivers/interrupt_controller/i8259_boi.S b/drivers/interrupt_controller/i8259_boi.S index 7726b08875b..410df6de7aa 100644 --- a/drivers/interrupt_controller/i8259_boi.S +++ b/drivers/interrupt_controller/i8259_boi.S @@ -61,7 +61,7 @@ a real IRQ has been inserted. /** * - * _i8259_boi_master - detect whether it is spurious interrupt or not + * @brief Detect whether it is spurious interrupt or not * * This routine is called before the user's interrupt handler to detect the * spurious interrupt on the master PIC. If a spurious interrupt condition is @@ -95,7 +95,7 @@ SECTION_FUNC(TEXT, _i8259_boi_master) /** * - * _i8259_boi_slave - detect whether it is spurious interrupt or not + * @brief Detect whether it is spurious interrupt or not * * This routine is called before the user's interrupt handler to detect the * spurious interrupt on the slave PIC. If a spurious interrupt condition is diff --git a/drivers/interrupt_controller/ioapic_intr.c b/drivers/interrupt_controller/ioapic_intr.c index 3e73c742469..eda4904aa87 100644 --- a/drivers/interrupt_controller/ioapic_intr.c +++ b/drivers/interrupt_controller/ioapic_intr.c @@ -211,7 +211,7 @@ static void _IoApicRedUpdateLo(unsigned int irq, uint32_t value, /** * - * _ioapic_init - initialize the IO APIC or xAPIC + * @brief Initialize the IO APIC or xAPIC * * This routine initializes the IO APIC or xAPIC. * @@ -263,7 +263,7 @@ void _ioapic_init(void) /** * - * _ioapic_eoi - send EOI (End Of Interrupt) signal to IO APIC + * @brief Send EOI (End Of Interrupt) signal to IO APIC * * This routine sends an EOI signal to the IO APIC's interrupting source. * @@ -279,7 +279,7 @@ void _ioapic_eoi(unsigned int irq /* INT number to send EOI */ /** * - * _ioapic_eoi_get - get EOI (End Of Interrupt) information + * @brief Get EOI (End Of Interrupt) information * * This routine returns EOI signalling information for a specific IRQ. * @@ -319,7 +319,7 @@ void *_ioapic_eoi_get(unsigned int irq, /* INTIN number of interest */ /** * - * _ioapic_irq_enable - enable a specified APIC interrupt input line + * @brief Enable a specified APIC interrupt input line * * This routine enables a specified APIC interrupt input line. * @@ -334,7 +334,7 @@ void _ioapic_irq_enable(unsigned int irq /* INTIN number to enable */ /** * - * _ioapic_irq_disable - disable a specified APIC interrupt input line + * @brief Disable a specified APIC interrupt input line * * This routine disables a specified APIC interrupt input line. * @@ -349,7 +349,7 @@ void _ioapic_irq_disable(unsigned int irq /* INTIN number to disable */ /** * - * _ioapic_irq_set - programs the interrupt redirection table + * @brief Programs the interrupt redirection table * * This routine sets up the redirection table entry for the specified IRQ * @@ -370,7 +370,7 @@ void _ioapic_irq_set(unsigned int irq, /* virtualized IRQ */ /** * - * _ioapic_int_vec_set - program interrupt vector for specified irq + * @brief Program interrupt vector for specified irq * * The routine writes the interrupt vector in the Interrupt Redirection * Table for specified irq number @@ -388,7 +388,7 @@ void _ioapic_int_vec_set(unsigned int irq, /* INT number */ /** * - * __IoApicGet - read a 32 bit IO APIC register + * @brief Read a 32 bit IO APIC register * * This routine reads the specified IO APIC register using indirect addressing. * @@ -416,7 +416,7 @@ static uint32_t __IoApicGet( /** * - * __IoApicSet - write a 32 bit IO APIC register + * @brief Write a 32 bit IO APIC register * * This routine writes the specified IO APIC register using indirect addressing. * @@ -444,7 +444,7 @@ static void __IoApicSet( /** * - * ioApicRedGetLo - get low 32 bits of Redirection Table entry + * @brief Get low 32 bits of Redirection Table entry * * This routine reads the low-order 32 bits of a Redirection Table entry. * @@ -470,7 +470,7 @@ static uint32_t ioApicRedGetLo(unsigned int irq /* INTIN number */ /** * - * ioApicRedSetLo - set low 32 bits of Redirection Table entry + * @brief Set low 32 bits of Redirection Table entry * * This routine writes the low-order 32 bits of a Redirection Table entry. * @@ -497,7 +497,7 @@ static void ioApicRedSetLo(unsigned int irq, /* INTIN number */ /** * - * ioApicRedSetHi - set high 32 bits of Redirection Table entry + * @brief Set high 32 bits of Redirection Table entry * * This routine writes the high-order 32 bits of a Redirection Table entry. * @@ -524,7 +524,7 @@ static void ioApicRedSetHi(unsigned int irq, /* INTIN number */ /** * - * _IoApicRedUpdateLo - modify low 32 bits of Redirection Table entry + * @brief Modify low 32 bits of Redirection Table entry * * This routine modifies selected portions of the low-order 32 bits of a * Redirection Table entry, as indicated by the associate bit mask. @@ -550,7 +550,7 @@ static void _IoApicRedUpdateLo( /** * - * _IoApicRteConfigSet - write to the RTE config register for specified IRQ + * @brief Write to the RTE config register for specified IRQ * * This routine writes the specified 32-bit into the RTE configuration * register for the specified (0 to (IOAPIC_NUM_RTES - 1)) @@ -578,7 +578,7 @@ static void _IoApicRteConfigSet(unsigned int irq, /* INTIN number */ /** * - * _IoApicRedirRegSet - write to the specified MSI redirection register + * @brief Write to the specified MSI redirection register * * This routine writes the 32-bit into the redirection register * specified by . diff --git a/drivers/interrupt_controller/loapic_intr.c b/drivers/interrupt_controller/loapic_intr.c index 5460e5cb148..41722bef1da 100644 --- a/drivers/interrupt_controller/loapic_intr.c +++ b/drivers/interrupt_controller/loapic_intr.c @@ -200,7 +200,7 @@ INCLUDE FILES: loapic.h /** * - * _loapic_init - initialize the Local APIC or xAPIC + * @brief Initialize the Local APIC or xAPIC * * This routine initializes Local APIC or xAPIC. * @@ -262,7 +262,7 @@ void _loapic_init(void) /** * - * _loapic_enable - enable the Local xAPIC + * @brief Enable the Local xAPIC * * This routine enables the Local xAPIC. * @@ -280,7 +280,7 @@ void _loapic_enable(void) /** * - * _loapic_disable - disable the Local xAPIC + * @brief Disable the Local xAPIC * * This routine disables the Local xAPIC. * @@ -298,7 +298,7 @@ void _loapic_disable(void) /** * - * _loapic_eoi - send EOI (End Of Interrupt) signal to Local APIC + * @brief send EOI (End Of Interrupt) signal to Local APIC * * This routine sends an EOI signal to the Local APIC's interrupting source. * @@ -313,7 +313,7 @@ void _loapic_eoi(unsigned int irq) /** * - * _loapic_int_vec_set - set the vector field in the specified RTE + * @brief Set the vector field in the specified RTE * * This routine is utilized by the BSP provided routined _SysIntVecAllocate() * which in turn is provided to support the irq_connect() API. Once @@ -356,7 +356,7 @@ void _loapic_int_vec_set(unsigned int irq, /* IRQ number of the /** * - * _loapic_irq_enable - enable an individual LOAPIC interrupt (IRQ) + * @brief Enable an individual LOAPIC interrupt (IRQ) * * This routine clears the interrupt mask bit in the LVT for the specified IRQ * @@ -386,7 +386,7 @@ void _loapic_irq_enable(unsigned int irq /* IRQ number of /** * - * _loapic_irq_disable - disable an individual LOAPIC interrupt (IRQ) + * @brief Disable an individual LOAPIC interrupt (IRQ) * * This routine clears the interrupt mask bit in the LVT for the specified IRQ * diff --git a/drivers/interrupt_controller/system_apic.c b/drivers/interrupt_controller/system_apic.c index 5c357f8a8e4..41a89ce8c4f 100644 --- a/drivers/interrupt_controller/system_apic.c +++ b/drivers/interrupt_controller/system_apic.c @@ -45,7 +45,7 @@ for the atom_n28xx variant of generic_pc BSP. /** * - * _SysIntVecAlloc - allocate interrupt vector + * @brief Allocate interrupt vector * * This BSP provided routine supports the irq_connect() API. This * routine is required to perform the following 3 functions: @@ -63,13 +63,13 @@ for the atom_n28xx variant of generic_pc BSP. * * The board virtualizes IRQs as follows: * - * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC - * - The remaining IRQs are provided by the LOAPIC. + * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC + * - The remaining IRQs are provided by the LOAPIC. * * Thus, for example, if the IOAPIC supports 24 IRQs: * - * - IRQ0 to IRQ23 map to IOAPIC IRQ0 to IRQ23 - * - IRQ24 to IRQ29 map to LOAPIC LVT entries as follows: + * - IRQ0 to IRQ23 map to IOAPIC IRQ0 to IRQ23 + * - IRQ24 to IRQ29 map to LOAPIC LVT entries as follows: * * IRQ24 -> LOAPIC_TIMER * IRQ25 -> LOAPIC_THERMAL @@ -172,7 +172,7 @@ int _SysIntVecAlloc( /** * - * _SysIntVecProgram - program interrupt controller + * @brief Program interrupt controller * * This BSP provided routine programs the appropriate interrupt controller * with the given vector based on the given IRQ parameter. @@ -182,9 +182,9 @@ int _SysIntVecAlloc( * * The Clanton board virtualizes IRQs as follows: * - * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC so the IOAPIC + * - The first IOAPIC_NUM_RTES IRQs are provided by the IOAPIC so the IOAPIC * is programmed for these IRQs - * - The remaining IRQs are provided by the LOAPIC and hence the LOAPIC is + * - The remaining IRQs are provided by the LOAPIC and hence the LOAPIC is * programmed. * * The IOAPIC_NUM_RTES macro is provided by board.h, and it specifies the number @@ -207,7 +207,7 @@ void _SysIntVecProgram(unsigned int vector, /* vector number */ /** * - * irq_enable - enable an individual interrupt (IRQ) + * @brief Enable an individual interrupt (IRQ) * * The public interface for enabling/disabling a specific IRQ for the IA-32 * architecture is defined as follows in include/nanokernel/x86/arch.h @@ -233,7 +233,7 @@ void irq_enable(unsigned int irq) /** * - * irq_disable - disable an individual interrupt (IRQ) + * @brief Disable an individual interrupt (IRQ) * * The irq_disable() routine is provided by the BSP due to the * IRQ virtualization that is performed by this BSP. See the comments diff --git a/drivers/interrupt_controller/system_pic.c b/drivers/interrupt_controller/system_pic.c index 72e5e4c23aa..c68dcb17cdc 100644 --- a/drivers/interrupt_controller/system_pic.c +++ b/drivers/interrupt_controller/system_pic.c @@ -47,7 +47,7 @@ IRQ_CONNECT_STATIC(pic_slave, PIC_SLAVE_STRAY_INT_LVL, 0, _i8259_boi_slave, 0); /** * - * _SysIntVecAlloc - allocate interrupt vector + * @brief Allocate interrupt vector * * This BSP provided routine supports the irq_connect() API. This * routine performs the following functions: @@ -64,8 +64,8 @@ IRQ_CONNECT_STATIC(pic_slave, PIC_SLAVE_STRAY_INT_LVL, 0, _i8259_boi_slave, 0); * * The pcPentium4 board virtualizes IRQs as follows: * - * - IRQ0 to IRQ7 are provided by the master i8259 PIC - * - IRQ8 to IRQ15 are provided by the slave i8259 PIC + * - IRQ0 to IRQ7 are provided by the master i8259 PIC + * - IRQ8 to IRQ15 are provided by the slave i8259 PIC * * @return the allocated interrupt vector * @@ -149,7 +149,7 @@ int _SysIntVecAlloc( /** * - * _SysIntVecProgram - program interrupt controller + * @brief Program interrupt controller * * This BSP provided routine programs the appropriate interrupt controller * with the given vector based on the given IRQ parameter. diff --git a/drivers/pci/pci.c b/drivers/pci/pci.c index 43a9e54d897..291056311ff 100644 --- a/drivers/pci/pci.c +++ b/drivers/pci/pci.c @@ -169,7 +169,7 @@ static struct lookup_data __noinit lookup; /** * - * pci_get_bar_config - return the configuration for the specified BAR + * @brief Return the configuration for the specified BAR * * @return 0 if BAR is implemented, -1 if not. */ @@ -214,7 +214,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 + * @brief Retrieve the I/O address and IRQ of the specified BAR * * @return -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved * @@ -265,7 +265,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 + * @brief Scan the specified PCI device for all sub functions * * @return 1 if a device has been found, 0 otherwise. * @@ -376,7 +376,7 @@ void pci_bus_scan_init(void) /** * - * pci_bus_scan - scans PCI bus for devices + * @brief Scans PCI bus for devices * * The routine scans the PCI bus for the devices on criterias provided in the * given dev_info at first call. Which criterias can be class and/or @@ -430,7 +430,7 @@ int pci_bus_scan(struct pci_dev_info *dev_info) #ifdef CONFIG_PCI_DEBUG /** * - * pci_show - Show PCI device + * @brief Show PCI device * * Shows the PCI device found provided as parameter. * diff --git a/drivers/pci/pci_config.c b/drivers/pci/pci_config.c index c859d680e78..4bdb1adb14b 100644 --- a/drivers/pci/pci_config.c +++ b/drivers/pci/pci_config.c @@ -54,7 +54,7 @@ This module implements the PCI config space access functions /** * - * pci_config_out_long - write a 32bit data to pci reg in offset + * @brief Write a 32bit data to pci reg in offset * * @param bus_no Bus number. * @param device_no Device number @@ -84,7 +84,7 @@ void pci_config_out_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no, /** * - * pci_config_out_word - write a 16bit data to pci reg in offset + * @brief Write a 16bit data to pci reg in offset * * @param bus_no Bus number. * @param device_no Device number. @@ -114,7 +114,7 @@ void pci_config_out_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no, /** * - * pci_config_out_byte - write a 8bit data to pci reg in offset + * @brief Write a 8bit data to pci reg in offset * * @param bus_no Bus number. * @param device_no Device number. @@ -144,7 +144,7 @@ void pci_config_out_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no, /** * - * pci_config_in_long - read a 32bit data from pci reg in offset + * @brief Read a 32bit data from pci reg in offset * * @param bus_no Bus number. * @param device_no Device number. @@ -175,7 +175,7 @@ void pci_config_in_long(uint32_t bus_no, uint32_t device_no, uint32_t func_no, /** * - * pci_config_in_word - read in a 16bit data from a pci reg in offset + * @brief Read in a 16bit data from a pci reg in offset * * @param bus_no Bus number. * @param device_no Device number. @@ -212,7 +212,7 @@ void pci_config_in_word(uint32_t bus_no, uint32_t device_no, uint32_t func_no, /** * - * pci_config_in_byte - read in a 8bit data from a pci reg in offset + * @brief Read in a 8bit data from a pci reg in offset * * @param bus_no Bus number. * @param device_no Device number. @@ -249,7 +249,7 @@ void pci_config_in_byte(uint32_t bus_no, uint32_t device_no, uint32_t func_no, /** * - * pci_config_ext_cap_ptr_find - find extended capability in ECP linked list + * @brief Find extended capability in ECP linked list * * This routine searches for an extended capability in the linked list of * capabilities in config space. If found, the offset of the first byte diff --git a/drivers/pci/pci_interface.c b/drivers/pci/pci_interface.c index 4af32526546..972b9b9f695 100644 --- a/drivers/pci/pci_interface.c +++ b/drivers/pci/pci_interface.c @@ -54,7 +54,7 @@ This module implements the PCI H/W access functions. /** * - * pci_ctrl_read - read a PCI controller register + * @brief Read a PCI controller register * * This routine reads the specified register from the PCI controller and * places the data into the provided buffer. @@ -88,7 +88,7 @@ static void pci_ctrl_read(uint32_t reg, /* PCI register to read */ /** * - * pci_ctrl_write - write a PCI controller register + * @brief Write a PCI controller register * * This routine writes the provided data to the specified register in the PCI * controller. @@ -123,7 +123,7 @@ static void pci_ctrl_write(uint32_t reg, /* PCI register to write */ /** * - * pci_ctrl_data_read - read the PCI controller data register + * @brief Read the PCI controller data register * * This routine reads the data register of the specified PCI controller. * @@ -149,7 +149,7 @@ static int pci_ctrl_data_read(uint32_t controller, /* controller number */ /** * - * pci_ctrl_data_write - write the PCI controller data register + * @brief Write the PCI controller data register * * This routine writes the provided data to the data register of the * specified PCI controller. @@ -176,7 +176,7 @@ static int pci_ctrl_data_write(uint32_t controller, /* controller number */ /** * - * pci_ctrl_addr_write - write the PCI controller address register + * @brief Write the PCI controller address register * * This routine writes the provided data to the address register of the * specified PCI controller. @@ -202,7 +202,7 @@ static int pci_ctrl_addr_write(uint32_t controller, /* controller number */ /** * - * pci_read - read a PCI register from a device + * @brief Read a PCI register from a device * * This routine reads data from a PCI device's configuration space. The * device and register to read is specified by the address parameter ("addr") @@ -292,7 +292,7 @@ void pci_read(uint32_t controller, /* PCI controller to use */ /** * - * pci_write - write a to a PCI register + * @brief Write a to a PCI register * * This routine writes data to a PCI device's configuration space. The * device and register to write is specified by the address parameter ("addr") @@ -381,7 +381,7 @@ void pci_write(uint32_t controller, /* controller to use */ /** * - * pci_header_get - get the PCI header for a device + * @brief Get the PCI header for a device * * This routine reads the PCI header for the specified device and puts the * result in the supplied header structure. diff --git a/drivers/random/rand32-timer.c b/drivers/random/rand32-timer.c index 18672d757c1..a0ef7949c2c 100644 --- a/drivers/random/rand32-timer.c +++ b/drivers/random/rand32-timer.c @@ -55,7 +55,7 @@ static atomic_val_t _rand32_counter = 0; /** * - * sys_rand32_init - initialize the random number generator + * @brief Initialize the random number generator * * The non-random number generator does not require any initialization. * This routine is automatically invoked by the kernel during system @@ -71,7 +71,7 @@ void sys_rand32_init(void) /** * - * sys_rand32_get - get a 32 bit random number + * @brief Get a 32 bit random number * * The non-random number generator returns values that are based off the * target's clock counter, which means that successive calls will return diff --git a/drivers/random/rand32-timestamp.c b/drivers/random/rand32-timestamp.c index 157d054bd07..fa184a044be 100644 --- a/drivers/random/rand32-timestamp.c +++ b/drivers/random/rand32-timestamp.c @@ -44,7 +44,7 @@ number generator. /** * - * sys_rand32_init - initialize the random number generator + * @brief Initialize the random number generator * * The non-random number generator does not require any initialization. * Routine is automatically invoked by the kernel during system startup. @@ -58,7 +58,7 @@ void sys_rand32_init(void) /** * - * sys_rand32_get - get a 32 bit random number + * @brief Get a 32 bit random number * * The non-random number generator returns values that are based off the * CPU's timestamp counter, which means that successive calls will normally diff --git a/drivers/serial/k20UartDrv.c b/drivers/serial/k20UartDrv.c index 783abe8a298..e5f9e663d74 100644 --- a/drivers/serial/k20UartDrv.c +++ b/drivers/serial/k20UartDrv.c @@ -61,7 +61,7 @@ UART_PORTS_CONFIGURE(_k20Uart_t, uart); /** * - * uart_init - initialize UART channel + * @brief Initialize UART channel * * This routine is called to reset the chip in a quiescent state. * It is assumed that this function is called only once per UART. @@ -109,7 +109,7 @@ void uart_init(int port, /* UART channel to initialize */ /** * - * uart_poll_in - poll the device for input. + * @brief Poll the device for input. * * @return 0 if a character arrived, -1 if the input buffer if empty. */ @@ -131,7 +131,7 @@ int uart_poll_in(int port, /* UART channel to select for input */ /** * - * uart_poll_out - output a character in polled mode. + * @brief Output a character in polled mode. * * Checks if the transmitter is empty. If empty, a character is written to * the data register. @@ -161,7 +161,7 @@ unsigned char uart_poll_out( /** * - * uart_fifo_fill - fill FIFO with data + * @brief Fill FIFO with data * @return number of bytes sent */ @@ -183,7 +183,7 @@ int uart_fifo_fill(int port, /* UART on port to send */ /** * - * uart_fifo_read - read data from FIFO + * @brief Read data from FIFO * * @return number of bytes read */ @@ -205,7 +205,7 @@ int uart_fifo_read(int port, /* UART to receive from */ /** * - * uart_irq_tx_enable - enable TX interrupt + * @brief Enable TX interrupt * * @return N/A */ @@ -221,7 +221,7 @@ void uart_irq_tx_enable(int port /* UART to enable Tx /** * - * uart_irq_tx_disable - disable TX interrupt in IER + * @brief Disable TX interrupt in IER * * @return N/A */ @@ -237,7 +237,7 @@ void uart_irq_tx_disable( /** * - * uart_irq_tx_ready - check if Tx IRQ has been raised + * @brief Check if Tx IRQ has been raised * * @return 1 if an IRQ is ready, 0 otherwise */ @@ -252,7 +252,7 @@ int uart_irq_tx_ready(int port /* UART to check */ /** * - * uart_irq_rx_enable - enable RX interrupt in IER + * @brief Enable RX interrupt in IER * * @return N/A */ @@ -268,7 +268,7 @@ void uart_irq_rx_enable(int port /* UART to enable Rx /** * - * uart_irq_rx_disable - disable RX interrupt in IER + * @brief Disable RX interrupt in IER * * @return N/A */ @@ -284,7 +284,7 @@ void uart_irq_rx_disable( /** * - * uart_irq_rx_ready - check if Rx IRQ has been raised + * @brief Check if Rx IRQ has been raised * * @return 1 if an IRQ is ready, 0 otherwise */ @@ -299,7 +299,7 @@ int uart_irq_rx_ready(int port /* UART to check */ /** * - * uart_irq_err_enable - enable error interrupt + * @brief Enable error interrupt * * @return N/A */ @@ -318,7 +318,7 @@ void uart_irq_err_enable(int port) /** * - * uart_irq_err_disable - disable error interrupt + * @brief Disable error interrupt * * @return N/A */ @@ -338,7 +338,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 + * @brief Check if Tx or Rx IRQ is pending * * @return 1 if a Tx or Rx IRQ is pending, 0 otherwise */ @@ -357,7 +357,7 @@ int uart_irq_is_pending(int port /* UART to check */ /** * - * uart_irq_update - update IRQ status + * @brief Update IRQ status * * @return always 1 */ @@ -369,7 +369,7 @@ int uart_irq_update(int port) /** * - * uart_irq_get - returns UART interrupt number + * @brief Returns UART interrupt number * * Returns the IRQ number used by the specified UART port * diff --git a/drivers/serial/ns16550.c b/drivers/serial/ns16550.c index 125fc3e084d..cfb8699f564 100644 --- a/drivers/serial/ns16550.c +++ b/drivers/serial/ns16550.c @@ -259,7 +259,7 @@ UART_PORTS_CONFIGURE(struct ns16550, uart); /** * - * uart_init - initialize the chip + * @brief Initialize the chip * * This routine is called to reset the chip in a quiescent state. * @@ -312,7 +312,7 @@ void uart_init(int port, /* UART channel to initialize */ /** * - * uart_poll_in - poll the device for input. + * @brief Poll the device for input. * * @return 0 if a character arrived, -1 if the input buffer if empty. */ @@ -332,7 +332,7 @@ int uart_poll_in(int port, /* UART channel to select for input */ /** * - * uart_poll_out - output a character in polled mode. + * @brief Output a character in polled mode. * * Checks if the transmitter is empty. If empty, a character is written to * the data register. @@ -359,7 +359,7 @@ unsigned char uart_poll_out( #if CONFIG_UART_INTERRUPT_DRIVEN /** * - * uart_fifo_fill - fill FIFO with data + * @brief Fill FIFO with data * * @return number of bytes sent */ @@ -379,7 +379,7 @@ int uart_fifo_fill(int port, /* UART on port to send */ /** * - * uart_fifo_read - read data from FIFO + * @brief Read data from FIFO * * @return number of bytes read */ @@ -400,7 +400,7 @@ int uart_fifo_read(int port, /* UART to receive from */ /** * - * uart_irq_tx_enable - enable TX interrupt in IER + * @brief Enable TX interrupt in IER * * @return N/A */ @@ -414,7 +414,7 @@ void uart_irq_tx_enable(int port /* UART to enable Tx /** * - * uart_irq_tx_disable - disable TX interrupt in IER + * @brief Disable TX interrupt in IER * * @return N/A */ @@ -427,7 +427,7 @@ void uart_irq_tx_disable(int port /* UART to disable Tx interrupt */ /** * - * uart_irq_tx_ready - check if Tx IRQ has been raised + * @brief Check if Tx IRQ has been raised * * @return N/A */ @@ -440,7 +440,7 @@ int uart_irq_tx_ready(int port /* UART to check */ /** * - * _uart_irq_rx_enable - enable RX interrupt in IER + * @brief Enable RX interrupt in IER * * @return N/A */ @@ -454,7 +454,7 @@ void uart_irq_rx_enable(int port /* UART to enable Rx /** * - * uart_irq_rx_disable - disable RX interrupt in IER + * @brief Disable RX interrupt in IER * * @return N/A */ @@ -467,7 +467,7 @@ void uart_irq_rx_disable(int port /* UART to disable Rx interrupt */ /** * - * uart_irq_rx_ready - check if Rx IRQ has been raised + * @brief Check if Rx IRQ has been raised * * @return 1 if an IRQ is ready, 0 otherwise */ @@ -480,7 +480,7 @@ int uart_irq_rx_ready(int port /* UART to check */ /** * - * uart_irq_err_enable - enable error interrupt in IER + * @brief Enable error interrupt in IER * * @return N/A */ @@ -493,7 +493,7 @@ void uart_irq_err_enable(int port /* UART to enable Rx interrupt */ /** * - * uart_irq_err_disable - disable error interrupt in IER + * @brief Disable error interrupt in IER * * @return 1 if an IRQ is ready, 0 otherwise */ @@ -506,7 +506,7 @@ void uart_irq_err_disable(int port /* UART to disable Rx interrupt */ /** * - * uart_irq_is_pending - check if any IRQ is pending + * @brief Check if any IRQ is pending * * @return 1 if an IRQ is pending, 0 otherwise */ @@ -519,7 +519,7 @@ int uart_irq_is_pending(int port /* UART to check */ /** * - * uart_irq_update - update cached contents of IIR + * @brief Update cached contents of IIR * * @return always 1 */ @@ -534,7 +534,7 @@ int uart_irq_update(int port /* UART to update */ /** * - * uart_irq_get - returns UART interrupt number + * @brief Returns UART interrupt number * * Returns the IRQ number used by the specified UART port * diff --git a/drivers/serial/nsim_uart.c b/drivers/serial/nsim_uart.c index 1fca9f9013d..6f826af674b 100644 --- a/drivers/serial/nsim_uart.c +++ b/drivers/serial/nsim_uart.c @@ -53,7 +53,7 @@ struct uart { static struct uart __noinit uart[CONFIG_UART_NUM_SYSTEM_PORTS]; /* - * uart_init - initialize fake serial port + * @brief Initialize fake serial port * @which: port number * @init_info: pointer to initialization information */ @@ -66,7 +66,7 @@ void uart_init(int which, const struct uart_init_info * const init_info) } /* - * uart_poll_out - output a character to serial port + * @brief Output a character to serial port * @port: port number * @c: character to output */ diff --git a/drivers/serial/stellarisUartDrv.c b/drivers/serial/stellarisUartDrv.c index da99c71f4e9..9e74fb86598 100644 --- a/drivers/serial/stellarisUartDrv.c +++ b/drivers/serial/stellarisUartDrv.c @@ -155,7 +155,7 @@ UART_PORTS_CONFIGURE(struct _StellarisUartPort, ports); /** * - * baudrateSet - set the baud rate + * @brief Set the baud rate * * This routine set the given baud rate for the UART. * @@ -186,7 +186,7 @@ static void baudrateSet(int port, uint32_t baudrate, uint32_t sysClkFreqInHz) /** * - * enable - enable the UART + * @brief Enable the UART * * This routine enables the given UART. * @@ -202,7 +202,7 @@ static inline void enable(int port) /** * - * disable - disable the UART + * @brief Disable the UART * * This routine disables the given UART. * @@ -235,7 +235,7 @@ static inline void disable(int port) /** * - * lineControlDefaultsSet - set the default UART line controls + * @brief Set the default UART line controls * * This routine sets the given UART's line controls to their default settings. * @@ -251,7 +251,7 @@ static inline void lineControlDefaultsSet(int port) /** * - * uart_init - initialize UART channel + * @brief Initialize UART channel * * This routine is called to reset the chip in a quiescent state. * It is assumed that this function is called only once per UART. @@ -272,7 +272,7 @@ void uart_init(int port, /* UART channel to initialize */ /** * - * pollTxReady - get the UART transmit ready status + * @brief Get the UART transmit ready status * * This routine returns the given UART's transmit ready status. * @@ -288,7 +288,7 @@ static int pollTxReady(int port) /** * - * uart_poll_in - poll the device for input. + * @brief Poll the device for input. * * @return 0 if a character arrived, -1 if the input buffer if empty. */ @@ -310,7 +310,7 @@ int uart_poll_in(int port, /* UART channel to select for input */ /** * - * uart_poll_out - output a character in polled mode. + * @brief Output a character in polled mode. * * Checks if the transmitter is empty. If empty, a character is written to * the data register. @@ -333,7 +333,7 @@ unsigned char uart_poll_out(int port, unsigned char c) /** * - * uart_fifo_fill - fill FIFO with data + * @brief Fill FIFO with data * * @return number of bytes sent */ @@ -355,7 +355,7 @@ int uart_fifo_fill(int port, /* UART on which to send */ /** * - * uart_fifo_read - read data from FIFO + * @brief Read data from FIFO * * @return number of bytes read */ @@ -377,7 +377,7 @@ int uart_fifo_read(int port, /* UART to receive from */ /** * - * uart_irq_tx_enable - enable TX interrupt + * @brief Enable TX interrupt * * @return N/A */ @@ -432,7 +432,7 @@ void uart_irq_tx_enable(int port /* UART to enable Tx interrupt */ /** * - * uart_irq_tx_disable - disable TX interrupt in IER + * @brief Disable TX interrupt in IER * * @return N/A */ @@ -447,7 +447,7 @@ void uart_irq_tx_disable(int port /* UART to disable Tx interrupt */ /** * - * uart_irq_tx_ready - check if Tx IRQ has been raised + * @brief Check if Tx IRQ has been raised * * @return 1 if a Tx IRQ is pending, 0 otherwise */ @@ -462,7 +462,7 @@ int uart_irq_tx_ready(int port /* UART to check */ /** * - * uart_irq_rx_enable - enable RX interrupt in IER + * @brief Enable RX interrupt in IER * * @return N/A */ @@ -477,7 +477,7 @@ void uart_irq_rx_enable(int port /* UART to enable Rx interrupt */ /** * - * uart_irq_rx_disable - disable RX interrupt in IER + * @brief Disable RX interrupt in IER * * @return N/A */ @@ -492,7 +492,7 @@ void uart_irq_rx_disable(int port /* UART to disable Rx interrupt */ /** * - * uart_irq_rx_ready - check if Rx IRQ has been raised + * @brief Check if Rx IRQ has been raised * * @return 1 if an IRQ is ready, 0 otherwise */ @@ -507,7 +507,7 @@ int uart_irq_rx_ready(int port /* UART to check */ /** * - * uart_irq_err_enable - enable error interrupts + * @brief Enable error interrupts * * @return N/A */ @@ -523,7 +523,7 @@ void uart_irq_err_enable(int port /* UART to enable interrupts for */ /** * - * uart_irq_err_disable - disable error interrupts + * @brief Disable error interrupts * * @return N/A */ @@ -539,7 +539,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 + * @brief Check if Tx or Rx IRQ is pending * * @return 1 if a Tx or Rx IRQ is pending, 0 otherwise */ @@ -555,7 +555,7 @@ int uart_irq_is_pending(int port /* UART to check */ /** * - * uart_irq_update - update IRQ status + * @brief Update IRQ status * * @return always 1 */ @@ -567,7 +567,7 @@ int uart_irq_update(int port) /** * - * uart_irq_get - returns UART interrupt number + * @brief Returns UART interrupt number * * Returns the IRQ number used by the specified UART port * diff --git a/drivers/timer/arcv2_timer0.c b/drivers/timer/arcv2_timer0.c index e1661244278..a1f56fc83fb 100644 --- a/drivers/timer/arcv2_timer0.c +++ b/drivers/timer/arcv2_timer0.c @@ -70,7 +70,7 @@ static uint32_t clock_accumulated_count = 0; /** * - * enable - enable the timer with the given limit/countup value + * @brief Enable the timer with the given limit/countup value * * This routine sets up the timer for operation by: * - setting value to which the timer will count up to; @@ -97,7 +97,7 @@ static ALWAYS_INLINE void enable( /** * - * count_get - get the current counter value + * @brief Get the current counter value * * 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). @@ -113,7 +113,7 @@ static ALWAYS_INLINE uint32_t count_get(void) /** * - * limit_get - get the limit/countup value + * @brief Get the limit/countup value * * This routine gets the value from the timer's limit register, which is the * value to which the timer will count up to. @@ -129,7 +129,7 @@ static ALWAYS_INLINE uint32_t limit_get(void) /** * - * _timer_int_handler - system clock periodic tick handler + * @brief System clock periodic tick handler * * This routine handles the system clock periodic tick interrupt. A TICK_EVENT * event is pushed onto the microkernel stack. @@ -155,7 +155,7 @@ void _timer_int_handler(void *unused) /** * - * timer_driver - initialize and enable the system clock + * @brief Initialize and enable the system clock * * 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. @@ -191,7 +191,7 @@ void timer_driver( /** * - * timer_read - read the BSP timer hardware + * @brief Read the BSP timer hardware * * This routine returns the current time in terms of timer hardware clock cycles. * @@ -206,7 +206,7 @@ uint32_t timer_read(void) #if defined(CONFIG_SYSTEM_TIMER_DISABLE) /** * - * timer_disable - stop announcing ticks into the kernel + * @brief Stop announcing ticks into the kernel * * This routine disables timer interrupt generation and delivery. * Note that the timer's counting cannot be stopped by software. diff --git a/drivers/timer/cortex_m_timer.c b/drivers/timer/cortex_m_timer.c index 84a6d5e0f66..bb006cd399e 100644 --- a/drivers/timer/cortex_m_timer.c +++ b/drivers/timer/cortex_m_timer.c @@ -129,7 +129,7 @@ static unsigned char idle_mode = IDLE_NOT_TICKLESS; /** * - * sysTickStop - stop the timer + * @brief Stop the timer * * This routine disables the systick counter. * @@ -158,7 +158,7 @@ static ALWAYS_INLINE void sysTickStop(void) /** * - * sysTickStart - start the timer + * @brief Start the timer * * This routine enables the systick counter. * @@ -185,7 +185,7 @@ static ALWAYS_INLINE void sysTickStart(void) /** * - * sysTickCurrentGet - get the current counter value + * @brief Get the current counter value * * This routine gets the value from the timer's current value register. This * value is the 'time' remaining to decrement before the timer triggers an @@ -202,7 +202,7 @@ static ALWAYS_INLINE uint32_t sysTickCurrentGet(void) /** * - * sysTickReloadGet - get the reload/countdown value + * @brief Get the reload/countdown value * * This routine returns the value from the reload value register. * @@ -219,7 +219,7 @@ static ALWAYS_INLINE uint32_t sysTickReloadGet(void) /** * - * sysTickReloadSet - set the reload/countdown value + * @brief Set the reload/countdown value * * This routine sets value from which the timer will count down and also * sets the timer's current value register to zero. @@ -246,7 +246,7 @@ static ALWAYS_INLINE void sysTickReloadSet( /** * - * _TIMER_INT_HANDLER - system clock tick handler + * @brief System clock tick handler * * This routine handles the system clock tick interrupt. A TICK_EVENT event * is pushed onto the microkernel stack. @@ -379,7 +379,7 @@ void _TIMER_INT_HANDLER(void *unused) /** * - * sysTickTicklessIdleInit - initialize the tickless idle feature + * @brief Initialize the tickless idle feature * * This routine initializes the tickless idle feature by calculating the * necessary hardware-specific parameters. @@ -460,7 +460,7 @@ static void sysTickTicklessIdleInit(void) /** * - * _timer_idle_enter - Place the system timer into idle state + * @brief Place the system timer into idle state * * Re-program the timer to enter into the idle state for the given number of * ticks. It is set to a "one shot" mode where it will fire in the number of @@ -516,7 +516,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ /** * - * _timer_idle_exit - handling of tickless idle when interrupted + * @brief Handling of tickless idle when interrupted * * The routine, called by _sys_power_save_idle_exit, is responsible for taking * the timer out of idle mode and generating an interrupt at the next @@ -608,7 +608,7 @@ void _timer_idle_exit(void) /** * - * timer_driver - initialize and enable the system clock + * @brief Initialize and enable the system clock * * This routine is used to program the systick to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. @@ -648,7 +648,7 @@ void timer_driver(int priority /* priority parameter is ignored by this driver /** * - * timer_read - read the BSP timer hardware + * @brief Read the BSP timer hardware * * This routine returns the current time in terms of timer hardware clock cycles. * Some kernel facilities (e.g. benchmarking code) directly call timer_read() @@ -670,7 +670,7 @@ uint32_t timer_read(void) /** * - * timer_disable - stop announcing ticks into the kernel + * @brief Stop announcing ticks into the kernel * * This routine disables the systick so that timer interrupts are no * longer delivered. diff --git a/drivers/timer/hpet.c b/drivers/timer/hpet.c index 3d363e016cb..6710f09b30d 100644 --- a/drivers/timer/hpet.c +++ b/drivers/timer/hpet.c @@ -221,7 +221,7 @@ static int stale_irq_check = /** * - * _hpetMainCounterAtomic - safely read the main HPET up counter + * @brief Safely read the main HPET up counter * * This routine simulates an atomic read of the 64-bit system clock on CPUs * that only support 32-bit memory accesses. The most significant word @@ -250,7 +250,7 @@ static uint64_t _hpetMainCounterAtomic(void) /** * - * _timer_int_handler - system clock tick handler + * @brief System clock tick handler * * This routine handles the system clock tick interrupt. A TICK_EVENT event * is pushed onto the microkernel stack. @@ -351,7 +351,7 @@ void _timer_int_handler(void *unused) /** * - * _timer_idle_enter - Place system timer into idle state + * @brief Place system timer into idle state * * Re-program the timer to enter into the idle state for the given number of * ticks (-1 means infinite number of ticks). @@ -380,7 +380,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ /** * - * _timer_idle_exit - Take system timer out of idle state + * @brief Take system timer out of idle state * * Determine how long timer has been idling and reprogram it to interrupt at the * next tick. @@ -489,7 +489,7 @@ void _timer_idle_exit(void) /** * - * timer_driver - initialize and enable the system clock + * @brief Initialize and enable the system clock * * This routine is used to program the HPET to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. @@ -622,7 +622,7 @@ void timer_driver(int priority /* priority parameter is ignored by this driver /** * - * timer_read - read the BSP timer hardware + * @brief Read the BSP timer hardware * * This routine returns the current time in terms of timer hardware clock cycles. * @@ -642,7 +642,7 @@ uint32_t timer_read(void) /** * - * timer_disable - stop announcing ticks into the kernel + * @brief Stop announcing ticks into the kernel * * This routine disables the HPET so that timer interrupts are no * longer delivered. diff --git a/drivers/timer/i8253.c b/drivers/timer/i8253.c index 677a26effac..f84eefc09ce 100644 --- a/drivers/timer/i8253.c +++ b/drivers/timer/i8253.c @@ -144,7 +144,7 @@ extern struct nano_stack _k_command_stack; /** * - * _i8253CounterRead - read the i8253 counter register's value + * @brief Read the i8253 counter register's value * * This routine reads the 16 bit value from the i8253 counter register. * @@ -171,7 +171,7 @@ static inline uint16_t _i8253CounterRead(void) /** * - * _i8253CounterSet - set the i8253 counter register's value + * @brief Set the i8253 counter register's value * * This routine sets the 16 bit value from which the i8253 timer will * decrement and sets that counter register to its value. @@ -194,7 +194,7 @@ static inline void _i8253CounterSet( /** * - * _i8253CounterPeriodic - set the i8253 timer to fire periodically + * @brief Set the i8253 timer to fire periodically * * This routine sets the i8253 to fire on a periodic basis. * @@ -214,7 +214,7 @@ static inline void _i8253CounterPeriodic( #if defined(TIMER_SUPPORTS_TICKLESS) /** * - * _i8253CounterOneShot - set the i8253 timer to fire once only + * @brief Set the i8253 timer to fire once only * * This routine sets the i8253 to fire once only. * @@ -234,7 +234,7 @@ static inline void _i8253CounterOneShot( /** * - * _timer_int_handler - system clock periodic tick handler + * @brief System clock periodic tick handler * * This routine handles the system clock periodic tick interrupt. A TICK_EVENT * event is pushed onto the microkernel stack. @@ -307,7 +307,7 @@ void _timer_int_handler(void *unusedArg /* not used */ #if defined(TIMER_SUPPORTS_TICKLESS) /** * - * _i8253TicklessIdleInit - initialize the tickless idle feature + * @brief Initialize the tickless idle feature * * This routine initializes the tickless idle feature. Note that maximum * number of ticks that can elapse during a "tickless idle" is limited by @@ -345,7 +345,7 @@ static void _i8253TicklessIdleSkew(void) /** * - * _timer_idle_enter - Place system timer into idle state + * @brief Place system timer into idle state * * Re-program the timer to enter into the idle state for the given number of * ticks. It is placed into one shot mode where it will fire in the number of @@ -402,7 +402,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ /** * - * _timer_idle_exit - handling of tickless idle when interrupted + * @brief Handling of tickless idle when interrupted * * The routine is responsible for taking the timer out of idle mode and * generating an interrupt at the next tick interval. @@ -468,7 +468,7 @@ void _timer_idle_exit(void) /** * - * timer_driver - initialize and enable the system clock + * @brief Initialize and enable the system clock * * This routine is used to program the PIT to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. @@ -503,7 +503,7 @@ void timer_driver(int priority /* priority parameter ignored by this driver */ /** * - * timer_read - read the BSP timer hardware + * @brief Read the BSP timer hardware * * This routine returns the current time in terms of timer hardware clock cycles. * @@ -558,7 +558,7 @@ uint32_t timer_read(void) #if defined(CONFIG_SYSTEM_TIMER_DISABLE) /** * - * timer_disable - stop announcing ticks into the kernel + * @brief Stop announcing ticks into the kernel * * This routine simply disables the PIT counter such that interrupts are no * longer delivered. diff --git a/drivers/timer/loapic_timer.c b/drivers/timer/loapic_timer.c index 2f46fba84a7..f4dec0d4e62 100644 --- a/drivers/timer/loapic_timer.c +++ b/drivers/timer/loapic_timer.c @@ -134,7 +134,7 @@ extern struct nano_stack _k_command_stack; /** * - * _loApicTimerPeriodic - set the timer for periodic mode + * @brief Set the timer for periodic mode * * This routine sets the timer for periodic mode. * @@ -153,7 +153,7 @@ static inline void _loApicTimerPeriodic(void) defined(CONFIG_SYSTEM_TIMER_DISABLE) /** * - * _loApicTimerStop - stop the timer + * @brief Stop the timer * * This routine stops the timer. * @@ -172,7 +172,7 @@ static inline void _loApicTimerStop(void) defined(LOAPIC_TIMER_PERIODIC_WORKAROUND) /** * - * _loApicTimerStart - start the timer + * @brief Start the timer * * This routine starts the timer. * @@ -189,7 +189,7 @@ static inline void _loApicTimerStart(void) /** * - * _loApicTimerSetCount - set countdown value + * @brief Set countdown value * * This routine sets value from which the timer will count down. * @@ -208,7 +208,7 @@ static inline void _loApicTimerSetCount( #if defined(TIMER_SUPPORTS_TICKLESS) /** * - * _loApicTimerOneShot - set the timer for one shot mode + * @brief Set the timer for one shot mode * * This routine sets the timer for one shot mode. * @@ -225,7 +225,7 @@ static inline void _loApicTimerOneShot(void) /** * - * _loApicTimerSetDivider - set the rate at which the timer is decremented + * @brief Set the rate at which the timer is decremented * * This routine sets rate at which the timer is decremented to match the * external bus frequency. @@ -242,7 +242,7 @@ static inline void _loApicTimerSetDivider(void) /** * - * _loApicTimerGetRemaining - get the value from the current count register + * @brief Get the value from the current count register * * This routine gets the value from the timer's current count register. This * value is the 'time' remaining to decrement before the timer triggers an @@ -260,7 +260,7 @@ static inline uint32_t _loApicTimerGetRemaining(void) #if defined(TIMER_SUPPORTS_TICKLESS) /** * - * _loApicTimerGetCount - get the value from the initial count register + * @brief Get the value from the initial count register * * This routine gets the value from the initial count register. * @@ -276,7 +276,7 @@ static inline uint32_t _loApicTimerGetCount(void) /** * - * _timer_int_handler - system clock tick handler + * @brief System clock tick handler * * This routine handles the system clock tick interrupt. A TICK_EVENT event * is pushed onto the microkernel stack. @@ -352,7 +352,7 @@ void _timer_int_handler(void *unused /* parameter is not used */ #if defined(TIMER_SUPPORTS_TICKLESS) /** * - * _loApicTimerTicklessIdleInit - initialize the tickless idle feature + * @brief Initialize the tickless idle feature * * This routine initializes the tickless idle feature. Note that the maximum * number of ticks that can elapse during a "tickless idle" is limited by @@ -375,7 +375,7 @@ static void _loApicTimerTicklessIdleInit(void) /** * - * _i8253TicklessIdleSkew - calculate the skew from idle mode switching + * @brief Calculate the skew from idle mode switching * * This routine calculates the skew from switching the timer in and out of idle * mode. The typical sequence is: @@ -409,7 +409,7 @@ static void _loApicTimerTicklessIdleSkew(void) /** * - * _timer_idle_enter - Place system timer into idle state + * @brief Place system timer into idle state * * Re-program the timer to enter into the idle state for the given number of * ticks. It is placed into one shot mode where it will fire in the number of @@ -462,7 +462,7 @@ void _timer_idle_enter(int32_t ticks /* system ticks */ /** * - * _timer_idle_exit - handling of tickless idle when interrupted + * @brief Handling of tickless idle when interrupted * * The routine is responsible for taking the timer out of idle mode and * generating an interrupt at the next tick interval. @@ -532,7 +532,7 @@ void _timer_idle_exit(void) /** * - * timer_driver - initialize and enable the system clock + * @brief Initialize and enable the system clock * * This routine is used to program the PIT to deliver interrupts at the * rate specified via the 'sys_clock_us_per_tick' global variable. @@ -572,7 +572,7 @@ void timer_driver(int priority /* priority parameter ignored by this driver */ /** * - * timer_read - read the BSP timer hardware + * @brief Read the BSP timer hardware * * This routine returns the current time in terms of timer hardware clock cycles. * @@ -601,7 +601,7 @@ uint32_t timer_read(void) #if defined(CONFIG_SYSTEM_TIMER_DISABLE) /** * - * timer_disable - stop announcing ticks into the kernel + * @brief Stop announcing ticks into the kernel * * This routine simply disables the LOAPIC counter such that interrupts are no * longer delivered. diff --git a/include/arch/arc/v2/arcv2_irq_unit.h b/include/arch/arc/v2/arcv2_irq_unit.h index 4de0b3ecf1d..2bf945cf533 100644 --- a/include/arch/arc/v2/arcv2_irq_unit.h +++ b/include/arch/arc/v2/arcv2_irq_unit.h @@ -61,7 +61,7 @@ */ /* - * _arc_v2_irq_unit_irq_enable_set - enable/disable interrupt + * @brief Enable/disable interrupt * * Enables or disables the specified interrupt * @@ -78,7 +78,7 @@ static inline void _arc_v2_irq_unit_irq_enable_set( } /* - * _arc_v2_irq_unit_int_enable - enable interrupt + * @brief Enable interrupt * * Enables the specified interrupt * @@ -91,7 +91,7 @@ static inline void _arc_v2_irq_unit_int_enable(int irq) } /* - * _arc_v2_irq_unit_int_disable - disable interrupt + * @brief Disable interrupt * * Disables the specified interrupt * @@ -104,7 +104,7 @@ static inline void _arc_v2_irq_unit_int_disable(int irq) } /* - * _arc_v2_irq_unit_prio_set - set interrupt priority + * @brief Set interrupt priority * * Set the priority of the specified interrupt * diff --git a/include/arch/arc/v2/ffs.h b/include/arch/arc/v2/ffs.h index 1a41afed6f8..c702f819f8d 100644 --- a/include/arch/arc/v2/ffs.h +++ b/include/arch/arc/v2/ffs.h @@ -47,7 +47,7 @@ extern unsigned nanoFfsMsb(unsigned int); /** * - * nanoFfsMsb_inline - Find First Set bit (searching from most significant bit) + * @brief Find First Set bit (searching from most significant bit) * * This routine finds the first bit set in the argument passed it and returns * the index of that bit. Bits are numbered starting at 1 from the least @@ -76,7 +76,7 @@ static ALWAYS_INLINE unsigned int nanoFfsMsb_inline(unsigned int op) /** * - * nanoFfsLsb - find first set bit (searching from the least significant bit) + * @brief Find first set bit (searching from the least significant bit) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting diff --git a/include/arch/arc/v2/irq.h b/include/arch/arc/v2/irq.h index 383edd1c9ea..d22028052cd 100644 --- a/include/arch/arc/v2/irq.h +++ b/include/arch/arc/v2/irq.h @@ -73,7 +73,7 @@ extern void _irq_exit(void); /** * - * irq_lock_inline - disable all interrupts on the CPU (inline) + * @brief Disable all interrupts on the CPU (inline) * * See irq_lock() for full description * @@ -93,7 +93,7 @@ static ALWAYS_INLINE unsigned int irq_lock_inline(void) /** * - * irq_unlock_inline - enable all interrupts on the CPU (inline) + * @brief Enable all interrupts on the CPU (inline) * * See irq_unlock() for full description * diff --git a/include/arch/arm/CortexM/asm_inline_gcc.h b/include/arch/arm/CortexM/asm_inline_gcc.h index 110bc983cda..8cd3006420b 100644 --- a/include/arch/arm/CortexM/asm_inline_gcc.h +++ b/include/arch/arm/CortexM/asm_inline_gcc.h @@ -54,7 +54,7 @@ /** * - * find_last_set_inline - find first set bit (searching from most significant bit) + * @brief Find first set bit (searching from most significant bit) * * This routine finds the first bit set in the argument passed it and returns * the index of that bit. Bits are numbered starting at 1 from the least @@ -82,7 +82,7 @@ static ALWAYS_INLINE unsigned int find_last_set_inline(unsigned int op) /** * - * find_first_set_inline - find first set bit (from the least significant bit) + * @brief Find first set bit (from the least significant bit) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting @@ -111,7 +111,7 @@ static ALWAYS_INLINE unsigned int find_first_set_inline(unsigned int op) /** * - * irq_lock_inline - disable all interrupts on the CPU (inline) + * @brief Disable all interrupts on the CPU (inline) * * This routine disables interrupts. It can be called from either interrupt, * task or fiber level. This routine returns an architecture-dependent @@ -158,7 +158,7 @@ static ALWAYS_INLINE unsigned int irq_lock_inline(void) /** * - * irq_unlock_inline - enable all interrupts on the CPU (inline) + * @brief Enable all interrupts on the CPU (inline) * * This routine re-enables interrupts on the CPU. The parameter * is an architecture-dependent lock-out key that is returned by a previous diff --git a/include/arch/arm/CortexM/irq.h b/include/arch/arm/CortexM/irq.h index 6a957a33678..e4be3fdcb37 100644 --- a/include/arch/arm/CortexM/irq.h +++ b/include/arch/arm/CortexM/irq.h @@ -82,7 +82,7 @@ extern void _IntExit(void); /** * - * IRQ_CONNECT_STATIC - connect a routine to interrupt number + * @brief Connect a routine to interrupt number * * For the device associates IRQ number with priority * with the interrupt routine , that receives parameter @@ -99,7 +99,7 @@ extern void _IntExit(void); /** * - * IRQ_CONFIG - configure interrupt for the device + * @brief Configure interrupt for the device * * For the given device do the neccessary configuration steps. * Fpr ARM platform, set the interrupt priority diff --git a/include/arch/arm/CortexM/nvic.h b/include/arch/arm/CortexM/nvic.h index a9eacae770c..7d9c8f40ad9 100644 --- a/include/arch/arm/CortexM/nvic.h +++ b/include/arch/arm/CortexM/nvic.h @@ -87,7 +87,7 @@ Supports up to 240 IRQs and 256 priority levels. /** * - * _NvicIrqEnable - enable an IRQ + * @brief Enable an IRQ * * Enable IRQ #, which is equivalent to exception #+16 * @@ -102,7 +102,7 @@ static inline void _NvicIrqEnable(unsigned int irq /* IRQ number */ /** * - * _NvicIsIrqEnabled - find out if an IRQ is enabled + * @brief Find out if an IRQ is enabled * * Find out if IRQ # is enabled. * @@ -117,7 +117,7 @@ static inline int _NvicIsIrqEnabled(unsigned int irq /* IRQ number */ /** * - * _NvicIrqEnable - disable an IRQ + * @brief Disable an IRQ * * Disable IRQ #, which is equivalent to exception #+16 * @@ -132,7 +132,7 @@ static inline void _NvicIrqDisable(unsigned int irq /* IRQ number */ /** * - * _NvicIrqPend - pend an IRQ + * @brief Pend an IRQ * * Pend IRQ #, which is equivalent to exception #+16. CPU will handle * the IRQ when interrupts are enabled and/or returning from a higher priority @@ -149,7 +149,7 @@ static inline void _NvicIrqPend(unsigned int irq /* IRQ number */ /** * - * _NvicIsIrqPending - find out if an IRQ is pending + * @brief Find out if an IRQ is pending * * Find out if IRQ # is pending * @@ -164,7 +164,7 @@ static inline int _NvicIsIrqPending(unsigned int irq /* IRQ number */ /** * - * _NvicIrqUnpend - unpend an IRQ + * @brief Unpend an IRQ * * Unpend IRQ #, which is equivalent to exception #+16. The previously * pending interrupt will be ignored when either unlocking interrupts or @@ -181,7 +181,7 @@ static inline void _NvicIrqUnpend(unsigned int irq /* IRQ number */ /** * - * _NvicIrqPrioSet - set priority of an IRQ + * @brief Set priority of an IRQ * * Set priority of IRQ # to . There are 256 priority levels. * @@ -198,7 +198,7 @@ static inline void _NvicIrqPrioSet(unsigned int irq, /* IRQ number */ /** * - * _NvicIrqPrioGet - get priority of an IRQ + * @brief Get priority of an IRQ * * Get priority of IRQ #. * @@ -213,7 +213,7 @@ static inline uint32_t _NvicIrqPrioGet(unsigned int irq /* IRQ number */ /** * - * _NvicSwInterruptTrigger - trigger an interrupt via software + * @brief Trigger an interrupt via software * * Trigger interrupt #. The CPU will handle the IRQ when interrupts are * enabled and/or returning from a higher priority interrupt. diff --git a/include/arch/arm/CortexM/scb.h b/include/arch/arm/CortexM/scb.h index 6b27347bb03..d59588bd994 100644 --- a/include/arch/arm/CortexM/scb.h +++ b/include/arch/arm/CortexM/scb.h @@ -75,7 +75,7 @@ extern void _ScbNumPriGroupSet(unsigned int n); /** * - * _ScbIsNmiPending - find out if the NMI exception is pending + * @brief Find out if the NMI exception is pending * * @return 1 if it is pending, 0 otherwise */ @@ -87,7 +87,7 @@ static inline int _ScbIsNmiPending(void) /** * - * _ScbNmiPend - pend the NMI exception + * @brief Pend the NMI exception * * Pend the NMI exception: it should fire immediately. * @@ -101,7 +101,7 @@ static inline void _ScbNmiPend(void) /** * - * _ScbIsPendsvPending - find out if the PendSV exception is pending + * @brief Find out if the PendSV exception is pending * * @return 1 if it is pending, 0 otherwise */ @@ -113,7 +113,7 @@ static inline int _ScbIsPendsvPending(void) /** * - * _ScbPendsvSet - set the PendSV exception + * @brief Set the PendSV exception * * Set the PendSV exception: it will be handled when the last nested exception * returns, or immediately if running in thread mode. @@ -128,7 +128,7 @@ static inline void _ScbPendsvSet(void) /** * - * _ScbPendsvClear - clear the PendSV exception + * @brief Clear the PendSV exception * * This routine clears the PendSV exception. * @@ -142,7 +142,7 @@ static inline void _ScbPendsvClear(void) /** * - * _ScbIsSystickPending - find out if the SYSTICK exception is pending + * @brief Find out if the SYSTICK exception is pending * * This routine determines if the SYSTICK exception is pending. * @@ -156,7 +156,7 @@ static inline int _ScbIsSystickPending(void) /** * - * _ScbSystickPend - pend the SYSTICK exception + * @brief Pend the SYSTICK exception * * Pend the SYSTICK exception: it will be handled when returning from a higher * priority exception or immediately if in thread mode or handling a lower @@ -172,7 +172,7 @@ static inline void _ScbSystickPendSet(void) /** * - * _ScbSystickClear - clear the SYSTICK exception + * @brief Clear the SYSTICK exception * * This routine clears the SYSTICK exception. * @@ -186,7 +186,7 @@ static inline void _ScbSystickPendClear(void) /** * - * _ScbIsIrqPending - find out if an external interrupt is pending + * @brief Find out if an external interrupt is pending * * Find out if an external interrupt, generated by the NVIC, is pending. * @@ -200,7 +200,7 @@ static inline int _ScbIsIrqPending(void) /** * - * _ScbHiPriVectorPendingGet - find out the exception number of highest-priority + * @brief Find out the exception number of highest-priority * pending exception (including interrupts) * * If one or more exceptions are pending, return the exception number of the @@ -219,7 +219,7 @@ static inline int _ScbHiPriVectorPendingGet(void) /** * - * _ScbIsNested - find out if the currently executing exception is nested + * @brief Find out if the currently executing exception is nested * * This routine determines if the currently executing exception is nested. * @@ -234,7 +234,7 @@ static inline int _ScbIsNestedExc(void) /** * - * _ScbIsInThreadMode - find out if running in thread mode + * @brief Find out if running in thread mode * * This routine determines if the current mode is thread mode. * @@ -249,7 +249,7 @@ static inline int _ScbIsInThreadMode(void) /** * - * _ScbIsInHandlerMode - find out if running in handler mode + * @brief Find out if running in handler mode * * This routine determines if the current mode is handler mode. * @@ -263,7 +263,7 @@ static inline int _ScbIsInHandlerMode(void) /** * - * _ScbIsInExc - find out if handling an exception + * @brief Find out if handling an exception * * This routine determines if an exception is being handled (handler mode). * @@ -277,7 +277,7 @@ static inline int _ScbIsInExc(void) /** * - * _ScbActiveVectorGet - obtain the currently executing vector + * @brief Obtain the currently executing vector * * If currently handling an exception/interrupt, return the exceuting vector * number. If not, return 0. @@ -292,7 +292,7 @@ static inline uint32_t _ScbActiveVectorGet(void) /** * - * _ScbIsVtableInSram - find out if vector table is in SRAM or ROM + * @brief Find out if vector table is in SRAM or ROM * * This routine determines if the currently executing exception is nested. * @@ -306,7 +306,7 @@ static inline uint32_t _ScbIsVtableInSram(void) /** * - * _ScbVtableLocationSet - move vector table from SRAM to ROM and vice-versa + * @brief Move vector table from SRAM to ROM and vice-versa * * This routine moves the vector table to the given memory region. * @@ -323,7 +323,7 @@ static inline void _ScbVtableLocationSet( /** * - * _ScbVtableAddrGet - obtain base address of vector table + * @brief Obtain base address of vector table * * This routine returs the vector table's base address. * @@ -337,7 +337,7 @@ static inline uint32_t _ScbVtableAddrGet(void) /** * - * _ScbVtableAddrSet - set base address of vector table + * @brief Set base address of vector table * * must align to the number of exception entries in vector table: * @@ -363,7 +363,7 @@ static inline void _ScbVtableAddrSet(uint32_t addr /* base address, aligned on /** * - * _ScbIsDataLittleEndian - find out if data regions are little endian + * @brief Find out if data regions are little endian * * Data regions on Cortex-M devices can be either little or big endian. Code * regions are always little endian. @@ -378,7 +378,7 @@ static inline int _ScbIsDataLittleEndian(void) /** * - * _ScbNumPriGroupGet - get the programmed number of priority groups + * @brief Get the programmed number of priority groups * * Exception priorities can be sub-divided into groups, with sub-priorities. * Within these groups, exceptions do not preempt each other. The sub-priorities @@ -394,7 +394,7 @@ static inline int _ScbNumPriGroupGet(void) /** * - * _ScbSleepOnExitSet - CPU goes to sleep after exiting an ISR + * @brief CPU goes to sleep after exiting an ISR * * CPU never runs in thread mode until this is cancelled. * @@ -410,7 +410,7 @@ static inline void _ScbSleepOnExitSet(void) /** * - * _ScbSleepOnExitClear - CPU does not go to sleep after exiting an ISR + * @brief CPU does not go to sleep after exiting an ISR * * This routine prevents CPU sleep mode upon exiting an ISR. * This is the normal operating mode. @@ -425,7 +425,7 @@ static inline void _ScbSleepOnExitClear(void) /** * - * _ScbSevOnPendSet - do not put CPU to sleep if pending exception are present + * @brief Do not put CPU to sleep if pending exception are present * when invoking wfe instruction * * By default, when invoking wfi or wfe instructions, if PRIMASK is masking @@ -446,7 +446,7 @@ static inline void _ScbSevOnPendSet(void) /** * - * _ScbSevOnPendClear - clear SEVONPEND bit + * @brief Clear SEVONPEND bit * * See _ScbSevOnPendSet(). * @@ -460,7 +460,7 @@ static inline void _ScbSevOnPendClear(void) /** * - * _ScbSleepDeepSet - when putting the CPU to sleep, put it in deep sleep + * @brief When putting the CPU to sleep, put it in deep sleep * * When wfi/wfe is invoked, the CPU will go into a "deep sleep" mode, using less * power than regular sleep mode, but with some possible side-effect. @@ -477,7 +477,7 @@ static inline void _ScbSleepDeepSet(void) /** * - * _ScbSleepDeepSet - when putting the CPU to sleep, do not put it in deep sleep + * @brief When putting the CPU to sleep, do not put it in deep sleep * * This routine prevents CPU deep sleep mode. * @@ -491,7 +491,7 @@ static inline void _ScbSleepDeepClear(void) /** * - * _ScbDivByZeroFaultEnable - enable faulting on division by zero + * @brief Enable faulting on division by zero * * This routine enables the divide by zero fault. * By default, the CPU ignores the error. @@ -506,7 +506,7 @@ static inline void _ScbDivByZeroFaultEnable(void) /** * - * _ScbDivByZeroFaultDisable - ignore division by zero errors + * @brief Ignore division by zero errors * * This routine disables the divide by zero fault. * This is the default behaviour. @@ -521,7 +521,7 @@ static inline void _ScbDivByZeroFaultDisable(void) /** * - * _ScbUnalignedFaultEnable - enable faulting on unaligned access + * @brief Enable faulting on unaligned access * * This routine enables the unaligned access fault. * By default, the CPU ignores the error. @@ -536,7 +536,7 @@ static inline void _ScbUnalignedFaultEnable(void) /** * - * _ScbUnalignedFaultDisable - ignore unaligned access errors + * @brief Ignore unaligned access errors * * This routine disables the divide by zero fault. * This is the default behaviour. @@ -551,7 +551,7 @@ static inline void _ScbUnalignedFaultDisable(void) /** * - * _ScbCcrSet - write the CCR all at once + * @brief Write the CCR all at once * * This routine writes the given value to the Configuration Control Register. * @@ -566,7 +566,7 @@ static inline void ScbCcrSet(uint32_t val /* value to write to CCR */ /** * - * _ScbExcPrioGet - obtain priority of an exception + * @brief Obtain priority of an exception * * Only works with exceptions 4 to 15, ie. do not use this for interrupts, which * are exceptions 16+. @@ -586,7 +586,7 @@ static inline uint8_t _ScbExcPrioGet(uint8_t exc /* exception number, 4 to 15 */ /** * - * _ScbExcPrioSet - set priority of an exception + * @brief Set priority of an exception * * Only works with exceptions 4 to 15, ie. do not use this for interrupts, which * are exceptions 16+. @@ -610,7 +610,7 @@ static inline void _ScbExcPrioSet(uint8_t exc, /* exception number, 4 to 15 */ /** * - * _ScbUsageFaultEnable - enable usage fault exceptions + * @brief Enable usage fault exceptions * * This routine enables usage faults. * By default, the CPU does not raise usage fault exceptions. @@ -625,7 +625,7 @@ static inline void _ScbUsageFaultEnable(void) /** * - * _ScbUsageFaultDisable - disable usage fault exceptions + * @brief Disable usage fault exceptions * * This routine disables usage faults. * This is the default behaviour. @@ -640,7 +640,7 @@ static inline void _ScbUsageFaultDisable(void) /** * - * _ScbBusFaultEnable - enable bus fault exceptions + * @brief Enable bus fault exceptions * * This routine enables bus faults. * By default, the CPU does not raise bus fault exceptions. @@ -655,7 +655,7 @@ static inline void _ScbBusFaultEnable(void) /** * - * _ScbBusFaultDisable - disable bus fault exceptions + * @brief Disable bus fault exceptions * * This routine disables bus faults. * This is the default behaviour. @@ -670,7 +670,7 @@ static inline void _ScbBusFaultDisable(void) /** * - * _ScbMemFaultEnable - enable MPU faults exceptions + * @brief Enable MPU faults exceptions * * This routine enables the MPU faults. * By default, the CPU does not raise MPU fault exceptions. @@ -685,7 +685,7 @@ static inline void _ScbMemFaultEnable(void) /** * - * _ScbMemFaultDisable - disable MPU fault exceptions + * @brief Disable MPU fault exceptions * * This routine disables MPU faults. * This is the default behaviour. @@ -700,7 +700,7 @@ static inline void _ScbMemFaultDisable(void) /** * - * _ScbHardFaultIsBusErrOnVectorRead - find out if a hard fault is caused by + * @brief Find out if a hard fault is caused by * a bus error on vector read * * This routine determines if a hard fault is caused by a bus error during @@ -716,7 +716,7 @@ static inline int _ScbHardFaultIsBusErrOnVectorRead(void) /** * - * _ScbHardFaultIsForced - find out if a fault was escalated to hard fault + * @brief Find out if a fault was escalated to hard fault * * Happens if a fault cannot be triggered because of priority or because it was * disabled. @@ -731,7 +731,7 @@ static inline int _ScbHardFaultIsForced(void) /** * - * _ScbHardFaultAllFaultsReset - clear all hard faults (HFSR register) + * @brief Clear all hard faults (HFSR register) * * HFSR register is a 'write-one-to-clear' (W1C) register. * @@ -745,7 +745,7 @@ static inline int _ScbHardFaultAllFaultsReset(void) /** * - * _ScbIsMemFault - find out if a hard fault is an MPU fault + * @brief Find out if a hard fault is an MPU fault * * This routine determines if a hard fault is an MPU fault. * @@ -759,7 +759,7 @@ static inline int _ScbIsMemFault(void) /** * - * _ScbMemFaultIsMmfarValid - find out if the MMFAR register contains a valid + * @brief Find out if the MMFAR register contains a valid * value * * The MMFAR register contains the faulting address on an MPU fault. @@ -774,7 +774,7 @@ static inline int _ScbMemFaultIsMmfarValid(void) /** * - * _ScbMemFaultMmfarReset - invalid the value in MMFAR + * @brief Invalid the value in MMFAR * * This routine invalidates the MMFAR value. This should be done after * processing an MPU fault. @@ -789,7 +789,7 @@ static inline void _ScbMemFaultMmfarReset(void) /** * - * _ScbMemFaultAllFaultsReset - clear all MPU faults (MMFSR register) + * @brief Clear all MPU faults (MMFSR register) * * CFSR/MMFSR register is a 'write-one-to-clear' (W1C) register. * @@ -803,7 +803,7 @@ static inline void _ScbMemFaultAllFaultsReset(void) /** * - * _ScbMemFaultIsStacking - find out if an MPU fault is a stacking fault + * @brief Find out if an MPU fault is a stacking fault * * This routine determines if an MPU fault is a stacking fault. * This may occur upon exception entry. @@ -818,7 +818,7 @@ static inline int _ScbMemFaultIsStacking(void) /** * - * _ScbMemFaultIsUnstacking - find out if an MPU fault is an unstacking fault + * @brief Find out if an MPU fault is an unstacking fault * * This routine determines if an MPU fault is an unstacking fault. * This may occur upon exception exit. @@ -833,7 +833,7 @@ static inline int _ScbMemFaultIsUnstacking(void) /** * - * _ScbMemFaultIsDataAccessViolation - find out if an MPU fault is a data access + * @brief Find out if an MPU fault is a data access * violation * * If this routine returns 1, read the MMFAR register via _ScbMemFaultAddrGet() @@ -849,7 +849,7 @@ static inline int _ScbMemFaultIsDataAccessViolation(void) /** * - * _ScbMemFaultIsInstrAccessViolation - find out if an MPU fault is an + * @brief Find out if an MPU fault is an * instruction access violation * * This routine determines if an MPU fault is due to an instruction access @@ -865,7 +865,7 @@ static inline int _ScbMemFaultIsInstrAccessViolation(void) /** * - * _ScbMemFaultAddrGet - find out the faulting address on an MPU fault + * @brief Find out the faulting address on an MPU fault * * @return the faulting address */ @@ -877,7 +877,7 @@ static inline uint32_t _ScbMemFaultAddrGet(void) /** * - * _ScbIsBusFault - find out if a hard fault is a bus fault + * @brief Find out if a hard fault is a bus fault * * This routine determines if a hard fault is a bus fault. * @@ -891,7 +891,7 @@ static inline int _ScbIsBusFault(void) /** * - * _ScbBusFaultIsBfarValid - find out if the BFAR register contains a valid + * @brief Find out if the BFAR register contains a valid * value * * The BFAR register contains the faulting address on bus fault. @@ -906,7 +906,7 @@ static inline int _ScbBusFaultIsBfarValid(void) /** * - * _ScbMemFaultBfarReset - invalid the value in BFAR + * @brief Invalid the value in BFAR * * This routine clears/invalidates the Bus Fault Address Register. * It should be done after processing a bus fault. @@ -921,7 +921,7 @@ static inline void _ScbBusFaultBfarReset(void) /** * - * _ScbBusFaultAllFaultsReset - clear all bus faults (BFSR register) + * @brief Clear all bus faults (BFSR register) * * CFSR/BFSR register is a 'write-one-to-clear' (W1C) register. * @@ -935,7 +935,7 @@ static inline void _ScbBusFaultAllFaultsReset(void) /** * - * _ScbBusFaultIsStacking - find out if a bus fault is a stacking fault + * @brief Find out if a bus fault is a stacking fault * * This routine determines if a bus fault is a stacking fault. * This may occurs upon exception entry. @@ -950,7 +950,7 @@ static inline int _ScbBusFaultIsStacking(void) /** * - * _ScbBusFaultIsUnstacking - find out if a bus fault is an unstacking fault + * @brief Find out if a bus fault is an unstacking fault * * This routine determines if a bus fault is an unstacking fault. * This may occur upon exception exit. @@ -965,7 +965,7 @@ static inline int _ScbBusFaultIsUnstacking(void) /** * - * _ScbBusFaultIsImprecise - find out if a bus fault is an imprecise error + * @brief Find out if a bus fault is an imprecise error * * This routine determines if a bus fault is an imprecise error. * @@ -979,7 +979,7 @@ static inline int _ScbBusFaultIsImprecise(void) /** * - * _ScbBusFaultIsPrecise - find out if a bus fault is an precise error + * @brief Find out if a bus fault is an precise error * * Read the BFAR register via _ScbBusFaultAddrGet() if this routine returns 1, * as it will contain the faulting address. @@ -994,7 +994,7 @@ static inline int _ScbBusFaultIsPrecise(void) /** * - * _ScbBusFaultIsInstrBusErr - find out if a bus fault is an instruction bus + * @brief Find out if a bus fault is an instruction bus * error * * This routine determines if a bus fault is an instruction bus error. @@ -1010,7 +1010,7 @@ static inline int _ScbBusFaultIsInstrBusErr(void) /** * - * _ScbBusFaultAddrGet - get the faulting address on a precise bus fault + * @brief Get the faulting address on a precise bus fault * * This routine returns the faulting address for a precise bus fault. * @@ -1024,7 +1024,7 @@ static inline uint32_t _ScbBusFaultAddrGet(void) /** * - * _ScbIsUsageFault - find out if a hard fault is a usage fault + * @brief Find out if a hard fault is a usage fault * * This routine determines if a hard fault is a usage fault. * @@ -1038,7 +1038,7 @@ static inline int _ScbIsUsageFault(void) /** * - * _ScbUsageFaultIsDivByZero - find out if a usage fault is a 'divide by zero' + * @brief Find out if a usage fault is a 'divide by zero' * fault * * This routine determines if a usage fault is a 'divde by zero' fault. @@ -1053,7 +1053,7 @@ static inline int _ScbUsageFaultIsDivByZero(void) /** * - * _ScbUsageFaultIsUnaligned - find out if a usage fault is a unaligned access + * @brief Find out if a usage fault is a unaligned access * error * * This routine determines if a usage fault is an unaligned access error. @@ -1068,7 +1068,7 @@ static inline int _ScbUsageFaultIsUnaligned(void) /** * - * _ScbUsageFaultIsNoCp - find out if a usage fault is a coprocessor access + * @brief Find out if a usage fault is a coprocessor access * error * * This routine determines if a usage fault is caused by a coprocessor access. @@ -1084,7 +1084,7 @@ static inline int _ScbUsageFaultIsNoCp(void) /** * - * _ScbUsageFaultIsInvalidPcLoad - find out if a usage fault is a invalid PC + * @brief Find out if a usage fault is a invalid PC * load error * * Happens if the the instruction address on an exception return is not @@ -1100,7 +1100,7 @@ static inline int _ScbUsageFaultIsInvalidPcLoad(void) /** * - * _ScbUsageFaultIsInvalidState - find out if a usage fault is a invalid state + * @brief Find out if a usage fault is a invalid state * error * * Happens if the the instruction address loaded in the PC via a branch, LDR or @@ -1117,7 +1117,7 @@ static inline int _ScbUsageFaultIsInvalidState(void) /** * - * _ScbUsageFaultIsUndefinedInstr - find out if a usage fault is a undefined + * @brief Find out if a usage fault is a undefined * instruction error * * The processor tried to execute an invalid opcode. @@ -1132,7 +1132,7 @@ static inline int _ScbUsageFaultIsUndefinedInstr(void) /** * - * _ScbUsageFaultDivByZeroReset - clear the 'division by zero' fault + * @brief Clear the 'division by zero' fault * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * @@ -1146,7 +1146,7 @@ static inline void _ScbUsageFaultDivByZeroReset(void) /** * - * _ScbUsageFaultUnalignedReset - clear the 'unaligned access' fault + * @brief Clear the 'unaligned access' fault * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * @@ -1160,7 +1160,7 @@ static inline void _ScbUsageFaultUnalignedReset(void) /** * - * _ScbUsageFaultNoCpReset - clear the 'no co-processor' fault + * @brief Clear the 'no co-processor' fault * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * @@ -1174,7 +1174,7 @@ static inline void _ScbUsageFaultNoCpReset(void) /** * - * _ScbUsageFaultInvalidPcLoadReset - clear the 'invalid PC load ' fault + * @brief Clear the 'invalid PC load ' fault * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * @@ -1188,7 +1188,7 @@ static inline void _ScbUsageFaultInvalidPcLoadReset(void) /** * - * _ScbUsageFaultInvalidStateReset - clear the 'invalid state' fault + * @brief Clear the 'invalid state' fault * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * @@ -1202,7 +1202,7 @@ static inline void _ScbUsageFaultInvalidStateReset(void) /** * - * _ScbUsageFaultUndefinedInstrReset - clear the 'undefined instruction' fault + * @brief Clear the 'undefined instruction' fault * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * @@ -1216,7 +1216,7 @@ static inline void _ScbUsageFaultUndefinedInstrReset(void) /** * - * _ScbUsageFaultAllFaultsReset - clear all usage faults (UFSR register) + * @brief Clear all usage faults (UFSR register) * * CFSR/UFSR register is a 'write-one-to-clear' (W1C) register. * diff --git a/include/arch/arm/CortexM/scs.h b/include/arch/arm/CortexM/scs.h index 9c60ed8a606..602182d6369 100644 --- a/include/arch/arm/CortexM/scs.h +++ b/include/arch/arm/CortexM/scs.h @@ -433,7 +433,7 @@ extern volatile struct __scs __scs; /** * - * _ScsNumIrqGet - obtain the number of interrupt lines on the target + * @brief Obtain the number of interrupt lines on the target * * @return the number of interrupts */ @@ -445,7 +445,7 @@ static inline int _ScsNumIrqGet(void) /** * - * _ScsIntMultiCycleInstDisable - disable load/store multiple instructions + * @brief Disable load/store multiple instructions * * From the ARM manuals: * @@ -463,7 +463,7 @@ static inline void _ScsIntMultiCycleInstDisable(void) /** * - * _ScsIntMultiCycleInstEnable - enable load/store multiple instructions + * @brief Enable load/store multiple instructions * * See _ScsIntMultiCycleInstDisable(). * @@ -477,7 +477,7 @@ static inline void _ScsIntMultiCycleInstEnable(void) /** * - * _ScsWriteBufDisable - disable write buffer + * @brief Disable write buffer * * From the ARM manuals: * @@ -495,7 +495,7 @@ static inline void _ScsWriteBufDisable(void) /** * - * _ScsWriteBufEnable - enable write buffer + * @brief Enable write buffer * * See _ScsWriteBufDisable(). * @@ -509,7 +509,7 @@ static inline void _ScsWriteBufEnable(void) /** * - * _ScsFoldItDisable - disable IT folding + * @brief Disable IT folding * * From the ARM manuals: * @@ -529,7 +529,7 @@ static inline void _ScsFoldItDisable(void) /** * - * _ScsFoldItEnable - enable IT folding + * @brief Enable IT folding * * See _ScsFoldItDisable(). * diff --git a/include/arch/x86/arch.h b/include/arch/x86/arch.h index c36e8b32b03..8febc500151 100644 --- a/include/arch/x86/arch.h +++ b/include/arch/x86/arch.h @@ -107,7 +107,7 @@ typedef struct s_isrList { /** * - * NANO_CPU_INT_REGISTER - connect a routine to an interrupt vector + * @brief Connect a routine to an interrupt vector * * This macro "connects" the specified routine, , to the specified interrupt * vector, using the descriptor privilege level . On the IA-32 @@ -140,7 +140,7 @@ typedef struct s_isrList { /** * - * IRQ_CONNECT_STATIC - connect a routine to interrupt number + * @brief Connect a routine to interrupt number * * For the device associates IRQ number with priority * with the interrupt routine , that receives parameter @@ -157,7 +157,7 @@ typedef struct s_isrList { /** * - * IRQ_CONFIG - configure interrupt for the device + * @brief Configure interrupt for the device * * For the given device do the neccessary configuration steps. * For x86 platform configure APIC and mark interrupt vector allocated @@ -276,7 +276,7 @@ void _int_latency_stop(void); /** * - * irq_lock_inline - disable all interrupts on the CPU (inline) + * @brief Disable all interrupts on the CPU (inline) * * This routine disables interrupts. It can be called from either interrupt, * task or fiber level. This routine returns an architecture-dependent @@ -320,7 +320,7 @@ static inline __attribute__((always_inline)) /** * - * irq_unlock_inline - enable all interrupts on the CPU (inline) + * @brief Enable all interrupts on the CPU (inline) * * This routine re-enables interrupts on the CPU. The parameter * is an architecture-dependent lock-out key that is returned by a previous diff --git a/include/arch/x86/asm_inline_gcc.h b/include/arch/x86/asm_inline_gcc.h index 9ce35452791..4633bc6d67d 100644 --- a/include/arch/x86/asm_inline_gcc.h +++ b/include/arch/x86/asm_inline_gcc.h @@ -46,7 +46,7 @@ /** * - * _do_irq_lock_inline - disable all interrupts on the CPU (inline) + * @brief Disable all interrupts on the CPU (inline) * * This routine disables interrupts. It can be called from either interrupt, * task or fiber level. This routine returns an architecture-dependent @@ -95,7 +95,7 @@ static inline __attribute__((always_inline)) /** * - * _do_irq_unlock_inline - enable all interrupts on the CPU (inline) + * @brief Enable all interrupts on the CPU (inline) * * This routine can be called from either interrupt, task or fiber level. * Invoked by kernel or by irq_unlock_inline() @@ -117,7 +117,7 @@ static inline __attribute__((always_inline)) /** * - * find_first_set_inline - find first set bit searching from the LSB (inline) + * @brief Find first set bit searching from the LSB (inline) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting @@ -168,7 +168,7 @@ static inline __attribute__((always_inline)) /** * - * find_last_set_inline - find first set bit searching from the MSB (inline) + * @brief Find first set bit searching from the MSB (inline) * * This routine finds the first bit set in the argument passed it and * returns the index of that bit. Bits are numbered starting @@ -252,7 +252,7 @@ static inline uint64_t _NanoTscRead(void) /** * - * _do_read_cpu_timestamp - get a 32 bit CPU timestamp counter + * @brief Get a 32 bit CPU timestamp counter * * @return a 32-bit number */ @@ -270,7 +270,7 @@ static inline inline __attribute__((always_inline)) /** * - * sys_out8 - output a byte to an IA-32 I/O port + * @brief Output a byte to an IA-32 I/O port * * This function issues the 'out' instruction to write a byte to the specified * I/O port. @@ -289,7 +289,7 @@ static inline inline __attribute__((always_inline)) /** * - * sys_in8 - input a byte from an IA-32 I/O port + * @brief Input a byte from an IA-32 I/O port * * This function issues the 'in' instruction to read a byte from the specified * I/O port. @@ -311,7 +311,7 @@ static inline inline __attribute__((always_inline)) /** * - * sys_out16 - output a word to an IA-32 I/O port + * @brief Output a word to an IA-32 I/O port * * This function issues the 'out' instruction to write a word to the * specified I/O port. @@ -330,7 +330,7 @@ static inline inline __attribute__((always_inline)) /** * - * sys_in16 - input a word from an IA-32 I/O port + * @brief Input a word from an IA-32 I/O port * * This function issues the 'in' instruction to read a word from the * specified I/O port. @@ -352,7 +352,7 @@ static inline inline __attribute__((always_inline)) /** * - * sys_out32 - output a long word to an IA-32 I/O port + * @brief Output a long word to an IA-32 I/O port * * This function issues the 'out' instruction to write a long word to the * specified I/O port. @@ -371,7 +371,7 @@ static inline inline __attribute__((always_inline)) /** * - * sys_in32 - input a long word from an IA-32 I/O port + * @brief Input a long word from an IA-32 I/O port * * This function issues the 'in' instruction to read a long word from the * specified I/O port. diff --git a/include/drivers/k20_watchdog.h b/include/drivers/k20_watchdog.h index 3b2e0acfc1d..bca089f2564 100644 --- a/include/drivers/k20_watchdog.h +++ b/include/drivers/k20_watchdog.h @@ -93,7 +93,7 @@ typedef volatile struct { /** * - * wdog_unlock - Watchdog timer unlock routine. + * @brief Watchdog timer unlock routine. * * This routine will unlock the watchdog timer registers for write access. * Writing 0xC520 followed by 0xD928 will unlock the write-once registers @@ -126,7 +126,7 @@ static ALWAYS_INLINE void wdog_unlock(K20_WDOG_t *wdog_p) /** * - * wdog_disable - Watchdog timer disable routine + * @brief Watchdog timer disable routine * * This routine will disable the watchdog timer. * diff --git a/include/microkernel/command_packet.h b/include/microkernel/command_packet.h index 0b0d7fb7224..d51324a35f2 100644 --- a/include/microkernel/command_packet.h +++ b/include/microkernel/command_packet.h @@ -45,7 +45,7 @@ extern "C" { /** * - * CMD_PKT_SET_INSTANCE - define an instance of a command packet set + * @brief Define an instance of a command packet set * * This macro is used to create an instance of a command packet set in the * global namespace. Each instance of the set may have its own unique number @@ -62,7 +62,7 @@ extern "C" { /** * - * CMD_PKT_SET - wrapper for accessing a command packet set + * @brief Wrapper for accessing a command packet set * * As a command packet set is instantiated as an array of uint32_t, it is * necessary to typecast a command packet set before accessing it. diff --git a/kernel/microkernel/k_command_packet.c b/kernel/microkernel/k_command_packet.c index 603d3f5730e..b8d86d1605f 100644 --- a/kernel/microkernel/k_command_packet.c +++ b/kernel/microkernel/k_command_packet.c @@ -69,7 +69,7 @@ uint32_t _k_test_cmd_pkt_size /** * - * _cmd_pkt_get - get the next command packet + * @brief Get the next command packet * * This routine gets the next command packet from the specified set. * @@ -95,7 +95,7 @@ cmdPkt_t *_cmd_pkt_get( /** * - * _k_task_call - send command packet to be processed by K_swapper + * @brief Send command packet to be processed by K_swapper * * @return N/A */ diff --git a/kernel/microkernel/k_event.c b/kernel/microkernel/k_event.c index b48affbcde3..82a25cc9f33 100644 --- a/kernel/microkernel/k_event.c +++ b/kernel/microkernel/k_event.c @@ -39,7 +39,7 @@ extern struct evstr _k_event_list[]; /** * - * _k_event_handler_set - perform set event handler request + * @brief Perform set event handler request * * @return N/A */ @@ -73,7 +73,7 @@ void _k_event_handler_set(struct k_args *A) /** * - * task_event_set_handler - set event handler request + * @brief Set event handler request * * This routine specifies the event handler that runs (in the context of the * K_swapper fiber) when the associated event is signaled. Specifying a non-NULL @@ -103,7 +103,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 + * @brief Finish handling a test for event request that timed out * * @return N/A */ @@ -121,7 +121,7 @@ void _k_event_test_timeout(struct k_args *A) /** * - * _k_event_test - perform test for event request + * @brief Perform test for event request * * @return N/A */ @@ -168,7 +168,7 @@ void _k_event_test(struct k_args *A) /** * - * _task_event_recv - test for event request + * @brief Test for event request * * This routine tests an event to see if it has been signaled. * @@ -191,7 +191,7 @@ int _task_event_recv( /** * - * _k_do_event_signal - signal an event + * @brief Signal an event * * Lowest level event signalling routine, which is invoked directly when the * signal is issued by a task and indirectly when the signal is issued by a @@ -235,7 +235,7 @@ void _k_do_event_signal(kevent_t event) /** * - * _k_event_signal - perform signal an event request + * @brief Perform signal an event request * * @return N/A */ @@ -254,7 +254,7 @@ void _k_event_signal(struct k_args *A) /** * - * task_event_send - signal an event request + * @brief Signal an event request * * This routine signals the specified event from a task. If an event handler * is installed for that event, it will run; if no event handler is installed, @@ -276,7 +276,7 @@ int task_event_send(kevent_t event /* event to signal */ /** * - * fiber_event_send - signal an event from a fiber + * @brief Signal an event from a fiber * * This routine does NOT validate the specified event number. * @@ -287,7 +287,7 @@ FUNC_ALIAS(isr_event_send, fiber_event_send, void); /** * - * isr_event_send - signal an event from an ISR + * @brief Signal an event from an ISR * * This routine does NOT validate the specified event number. * diff --git a/kernel/microkernel/k_fifo.c b/kernel/microkernel/k_fifo.c index 2e0aa51236c..b77725b84ac 100644 --- a/kernel/microkernel/k_fifo.c +++ b/kernel/microkernel/k_fifo.c @@ -37,7 +37,7 @@ /** * - * _k_fifo_enque_reply - finish performing an incomplete FIFO enqueue request + * @brief Finish performing an incomplete FIFO enqueue request * * @return N/A */ @@ -62,7 +62,7 @@ void _k_fifo_enque_reply(struct k_args *A) /** * - * _k_fifo_enque_request - perform a FIFO enqueue request + * @brief Perform a FIFO enqueue request * * @return N/A */ @@ -138,7 +138,7 @@ void _k_fifo_enque_request(struct k_args *A) } /** * - * _task_fifo_put - FIFO enqueue request + * @brief FIFO enqueue request * * This routine puts an entry at the end of the FIFO queue. * @@ -164,7 +164,7 @@ int _task_fifo_put(kfifo_t queue, /* FIFO queue */ /** * - * _k_fifo_deque_reply - finish performing an incomplete FIFO dequeue request + * @brief Finish performing an incomplete FIFO dequeue request * * @return N/A */ @@ -189,7 +189,7 @@ void _k_fifo_deque_reply(struct k_args *A) /** * - * _k_fifo_deque_request - perform FIFO dequeue request + * @brief Perform FIFO dequeue request * * @return N/A */ @@ -268,7 +268,7 @@ void _k_fifo_deque_request(struct k_args *A) /** * - * _task_fifo_get - FIFO dequeue request + * @brief FIFO dequeue request * * This routine tries to read a data element from the FIFO. * @@ -297,7 +297,7 @@ int _task_fifo_get(kfifo_t queue, /* FIFO queue */ /** * - * _k_fifo_ioctl - perform miscellaneous FIFO request + * @brief Perform miscellaneous FIFO request * * @return N/A */ @@ -337,7 +337,7 @@ void _k_fifo_ioctl(struct k_args *A) /** * - * _task_fifo_ioctl - miscellaneous FIFO request + * @brief Miscellaneous FIFO request * * Depending upon the chosen operation, this routine will ... * 1. = 0 : query the number of FIFO entries diff --git a/kernel/microkernel/k_idle.c b/kernel/microkernel/k_idle.c index 8cb437f92bc..47454860a02 100644 --- a/kernel/microkernel/k_idle.c +++ b/kernel/microkernel/k_idle.c @@ -68,7 +68,7 @@ static extern uint32_t _k_workload_scale; /** * - * workload_loop - shared code between workload calibration and monitoring + * @brief Shared code between workload calibration and monitoring * * Perform idle task "dummy work". * @@ -102,7 +102,7 @@ static void workload_loop(void) /** * - * _k_workload_monitor_calibrate - calibrate the workload monitoring subsystem + * @brief Calibrate the workload monitoring subsystem * * Measures the time required to do a fixed amount of "dummy work", and * sets default values for the workload measuring period. @@ -135,7 +135,7 @@ void _k_workload_monitor_calibrate(void) /** * - * _k_workload_monitor_update - workload monitor tick handler + * @brief Workload monitor tick handler * * If workload monitor is configured this routine updates the global variables * it uses to record the passage of time. @@ -158,7 +158,7 @@ void _k_workload_monitor_update(void) /** * - * _k_workload_monitor_idle_start - workload monitor "start idling" handler + * @brief Workload monitor "start idling" handler * * Records time when idle task was selected for execution by the microkernel. * @@ -172,7 +172,7 @@ void _k_workload_monitor_idle_start(void) /** * - * _k_workload_monitor_idle_end - workload monitor "end idling" handler + * @brief Workload monitor "end idling" handler * * Records time when idle task was no longer selected for execution by the * microkernel, and updates amount of time spent idling. @@ -189,7 +189,7 @@ void _k_workload_monitor_idle_end(void) /** * - * _k_workload_get - process request to read the processor workload + * @brief Process request to read the processor workload * * Computes workload, or uses 0 if workload monitoring is not configured. * @@ -231,7 +231,7 @@ void _k_workload_get(struct k_args *P) /** * - * task_workload_get - read the processor workload + * @brief Read the processor workload * * This routine returns the workload as a number ranging from 0 to 1000. * @@ -257,7 +257,7 @@ int task_workload_get(void) /** * - * sys_workload_time_slice_set - set workload period + * @brief Set workload period * * This routine specifies the workload measuring period for task_workload_get(). * @@ -305,7 +305,7 @@ int32_t _sys_idle_threshold_ticks = CONFIG_TICKLESS_IDLE_THRESH; /** * - * _sys_power_save_idle - power management policy when kernel begins idling + * @brief Power management policy when kernel begins idling * * This routine implements the power management policy based on the time * until the timer expires, in system ticks. @@ -350,7 +350,7 @@ void _sys_power_save_idle(int32_t ticks) /** * - * _sys_power_save_idle_exit - power management policy when kernel stops idling + * @brief Power management policy when kernel stops idling * * This routine is invoked when the kernel leaves the idle state. * Routine can be modified to wake up other devices. @@ -376,7 +376,7 @@ void _sys_power_save_idle_exit(int32_t ticks) /** * - * _get_next_timer_expiry - obtain number of ticks until next timer expires + * @brief Obtain number of ticks until next timer expires * * Must be called with interrupts locked to prevent the timer queues from * changing. @@ -399,7 +399,7 @@ static inline int32_t _get_next_timer_expiry(void) /** * - * _power_save - power saving when idle + * @brief Power saving when idle * * If the BSP sets the _sys_power_save_flag flag, this routine will call the * _sys_power_save_idle() routine in an infinite loop. If the flag is not set, @@ -449,7 +449,7 @@ static void _power_save(void) /** * - * _k_kernel_idle - microkernel idle task + * @brief Microkernel idle task * * If power save is on, we sleep; if power save is off, we "busy wait". * diff --git a/kernel/microkernel/k_irq.c b/kernel/microkernel/k_irq.c index b764462d2a4..3870048fc00 100644 --- a/kernel/microkernel/k_irq.c +++ b/kernel/microkernel/k_irq.c @@ -104,7 +104,7 @@ extern const kevent_t _TaskIrqEvt0_objId; /** * - * task_irq_int_handler - ISR for task IRQ objects + * @brief ISR for task IRQ objects * * This ISR handles interrupts generated by registered task IRQ objects. * @@ -131,7 +131,7 @@ static void task_irq_int_handler( /** * - * task_irq_free - free a task IRQ object + * @brief Free a task IRQ object * * The task IRQ object's interrupt is disabled, and the associated event * is flushed; the object's interrupt vector is then freed, and the object's @@ -155,7 +155,7 @@ void task_irq_free(kirq_t irq_obj /* IRQ object identifier */ /** * - * task_irq_ack - re-enable a task IRQ object's interrupt + * @brief Re-enable a task IRQ object's interrupt * * This re-enables the interrupt for a task IRQ object. * @@ -174,7 +174,7 @@ void task_irq_ack(kirq_t irq_obj /* IRQ object identifier */ /** * - * _task_irq_test - determine if a task IRQ object has had an interrupt + * @brief Determine if a task IRQ object has had an interrupt * * This tests a task IRQ object to see if it has signalled an interrupt. * @@ -194,7 +194,7 @@ int _task_irq_test(kirq_t irq_obj, /* IRQ object identifier */ /** * - * _k_task_irq_alloc - allocate a task IRQ object + * @brief Allocate a task IRQ object * * This routine allocates a task IRQ object to a task. * @@ -237,7 +237,7 @@ static int _k_task_irq_alloc( /** * - * task_irq_alloc - register a task IRQ object + * @brief Register a task IRQ object * * This routine connects a task IRQ object to a system interrupt based * upon the specified IRQ and priority values. diff --git a/kernel/microkernel/k_mailbox.c b/kernel/microkernel/k_mailbox.c index 8b7cc3b139f..84517d5be64 100644 --- a/kernel/microkernel/k_mailbox.c +++ b/kernel/microkernel/k_mailbox.c @@ -42,7 +42,7 @@ /** * - * ISASYNCMSG - determines if mailbox message is synchronous or asynchronous + * @brief Determines if mailbox message is synchronous or asynchronous * * Returns a non-zero value if the specified message contains a valid pool ID, * indicating that it is an asynchronous message. @@ -52,7 +52,7 @@ /** * - * copy_packet - copy a packet + * @brief Copy a packet * * @return N/A */ @@ -72,7 +72,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 + * @brief Determine if there is a match between the mailbox sender and receiver * * @return matched message size, or -1 if no match */ @@ -228,7 +228,7 @@ static void transfer(struct k_args *pMvdReq) /** * - * _k_mbox_send_ack - process the acknowledgment to a mailbox send request + * @brief Process the acknowledgment to a mailbox send request * * @return N/A */ @@ -300,7 +300,7 @@ void _k_mbox_send_ack(struct k_args *pCopyWriter) /** * - * _k_mbox_send_reply - process the timeout for a mailbox send request + * @brief Process the timeout for a mailbox send request * * @return N/A */ @@ -316,7 +316,7 @@ void _k_mbox_send_reply(struct k_args *pCopyWriter) /** * - * _k_mbox_send_request - process a mailbox send request + * @brief Process a mailbox send request * * @return N/A */ @@ -476,7 +476,7 @@ void _k_mbox_send_request(struct k_args *Writer) /** * - * _task_mbox_put - send a message to a mailbox + * @brief Send a message to a mailbox * * This routine sends a message to a mailbox and looks for a matching receiver. * @@ -517,7 +517,7 @@ int _task_mbox_put(kmbox_t mbox, /* mailbox */ /** * - * _k_mbox_receive_ack - process a mailbox receive acknowledgment + * @brief Process a mailbox receive acknowledgment * * This routine processes a mailbox receive acknowledgment. * @@ -547,7 +547,7 @@ void _k_mbox_receive_ack(struct k_args *pCopyReader) /** * - * _k_mbox_receive_reply - process the timeout for a mailbox receive request + * @brief Process the timeout for a mailbox receive request * * @return N/A */ @@ -565,7 +565,7 @@ void _k_mbox_receive_reply(struct k_args *pCopyReader) /** * - * _k_mbox_receive_request - process a mailbox receive request + * @brief Process a mailbox receive request * * @return N/A */ @@ -692,7 +692,7 @@ void _k_mbox_receive_request(struct k_args *Reader) /** * - * _task_mbox_get - gets struct k_msg message header structure information + * @brief Gets struct k_msg message header structure information * from a mailbox * * @return RC_OK, RC_FAIL, RC_TIME on success, failure, timeout respectively @@ -726,7 +726,7 @@ int _task_mbox_get(kmbox_t mbox, /* mailbox */ /** * - * _task_mbox_put_async - send a message asynchronously to a mailbox + * @brief Send a message asynchronously to a mailbox * * This routine sends a message to a mailbox and does not wait for a matching * receiver. There is no exchange header returned to the sender. When the data @@ -769,7 +769,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 + * @brief Process a mailbox receive data request * * @return N/A */ @@ -814,7 +814,7 @@ void _k_mbox_receive_data(struct k_args *Starter) /** * - * _task_mbox_data_get - get message data + * @brief Get message data * * This routine is called for either of the two following purposes: * 1. To transfer data if the call to task_mbox_get() resulted in a non-zero size @@ -847,7 +847,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 + * @brief Get the mailbox data and place * in a memory pool block * * @return RC_OK upon success, RC_FAIL upon failure, or RC_TIME upon timeout @@ -946,7 +946,7 @@ int _task_mbox_data_get_async_block(struct k_msg *message, /** * - * _k_mbox_send_data - process a mailbox send data request + * @brief Process a mailbox send data request * * @return N/A */ diff --git a/kernel/microkernel/k_memory_map.c b/kernel/microkernel/k_memory_map.c index 82d77a5a0ab..0044bb31516 100644 --- a/kernel/microkernel/k_memory_map.c +++ b/kernel/microkernel/k_memory_map.c @@ -35,7 +35,7 @@ /** * - * _k_mem_map_init - initialize kernel memory map subsystem + * @brief Initialize kernel memory map subsystem * * Perform any initialization of memory maps that wasn't done at build time. * @@ -72,7 +72,7 @@ void _k_mem_map_init(void) /** * - * _k_mem_map_alloc_timeout - finish handling a memory map block request that timed out + * @brief Finish handling a memory map block request that timed out * * @return N/A */ @@ -87,7 +87,7 @@ void _k_mem_map_alloc_timeout(struct k_args *A) /** * - * _k_mem_map_alloc - perform allocate memory map block request + * @brief Perform allocate memory map block request * * @return N/A */ @@ -132,7 +132,7 @@ void _k_mem_map_alloc(struct k_args *A) /** * - * _task_mem_map_alloc - allocate memory map block request + * @brief Allocate memory map block request * * This routine is used to request a block of memory from the memory map. * @@ -156,7 +156,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 + * @brief Perform return memory map block request * * @return N/A */ @@ -196,7 +196,7 @@ void _k_mem_map_dealloc(struct k_args *A) /** * - * _task_mem_map_free - return memory map block request + * @brief Return memory map block request * * This routine returns a block to the specified memory map. If a higher * priority task is waiting for a block from the same map a task switch @@ -219,7 +219,7 @@ void _task_mem_map_free(kmemory_map_t mmap, /* memory map */ /** * - * task_mem_map_used_get - read the number of used blocks in a memory map + * @brief Read the number of used blocks in a memory map * * This routine returns the number of blocks in use for the memory map. * diff --git a/kernel/microkernel/k_memory_pool.c b/kernel/microkernel/k_memory_pool.c index 2c3007d2877..3f4fb908d4f 100644 --- a/kernel/microkernel/k_memory_pool.c +++ b/kernel/microkernel/k_memory_pool.c @@ -45,7 +45,7 @@ /** * - * _k_mem_pool_init - initialize kernel memory pool subsystem + * @brief Initialize kernel memory pool subsystem * * Perform any initialization of memory pool that wasn't done at build time. * @@ -101,7 +101,7 @@ void _k_mem_pool_init(void) /** * - * search_bp - ??? + * @brief ??? * * marks ptr as free block in the given list [MYSTERIOUS LEGACY COMMENT] * @@ -136,7 +136,7 @@ static void search_bp(char *ptr, struct pool_struct *P, int index) /** * - * defrag - defragmentation algorithm for memory pool + * @brief Defragmentation algorithm for memory pool * * @return N/A */ @@ -192,7 +192,7 @@ static void defrag(struct pool_struct *P, /** * - * _k_defrag - perform defragment memory pool request + * @brief Perform defragment memory pool request * * @return N/A */ @@ -225,7 +225,7 @@ void _k_defrag(struct k_args *A) /** * - * task_mem_pool_defragment - defragment memory pool request + * @brief Defragment memory pool request * * This routine concatenates unused memory in a memory pool. * @@ -244,7 +244,7 @@ void task_mem_pool_defragment(kmemory_pool_t Pid /* pool to defragment */ /** * - * search_block_on_frag_level - allocate block using specified fragmentation level + * @brief Allocate block using specified fragmentation level * * This routine attempts to allocate a free block. [NEED TO EXPAND THIS] * @@ -326,7 +326,7 @@ static char *search_block_on_frag_level(struct pool_block *pfraglevelinfo, /** * - * get_block_recusive - recursively get a block, doing fragmentation if necessary + * @brief Recursively get a block, doing fragmentation if necessary * * [NEED A BETTER DESCRIPTION HERE] * @@ -410,7 +410,7 @@ static char *get_block_recusive(struct pool_struct *P, int index, int startindex /** * - * _k_block_waiters_get - examine tasks that are waiting for memory pool blocks + * @brief Examine tasks that are waiting for memory pool blocks * * This routine attempts to satisfy any incomplete block allocation requests for * the specified memory pool. It can be invoked either by the explicit freeing @@ -480,7 +480,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 + * @brief Finish handling an allocate block request that timed out * * @return N/A */ @@ -495,7 +495,7 @@ void _k_mem_pool_block_get_timeout_handle(struct k_args *A) /** * - * _k_mem_pool_block_get - perform allocate memory pool block request + * @brief Perform allocate memory pool block request * * @return N/A */ @@ -557,7 +557,7 @@ void _k_mem_pool_block_get(struct k_args *A) /** * - * _task_mem_pool_alloc - allocate memory pool block request + * @brief Allocate memory pool block request * * 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). @@ -591,7 +591,7 @@ int _task_mem_pool_alloc(struct k_block *blockptr, /* ptr to requested block */ /** * - * _k_mem_pool_block_release - perform return memory pool block request + * @brief Perform return memory pool block request * * 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. @@ -661,7 +661,7 @@ void _k_mem_pool_block_release(struct k_args *A) /** * - * task_mem_pool_free - return memory pool block request + * @brief Return memory pool block request * * This routine returns a block to a memory pool. * diff --git a/kernel/microkernel/k_move_data.c b/kernel/microkernel/k_move_data.c index f033d4b7958..35f7c5cb342 100644 --- a/kernel/microkernel/k_move_data.c +++ b/kernel/microkernel/k_move_data.c @@ -56,7 +56,7 @@ static void mvdreq_docont(struct k_args *Cont) /** * - * mvdreq_copy - perform movedata request + * @brief Perform movedata request * * @return N/A */ @@ -74,7 +74,7 @@ static void mvdreq_copy(struct moved_req *ReqArgs) /** * - * _k_movedata_request - process a movedata request + * @brief Process a movedata request * * @return N/A */ diff --git a/kernel/microkernel/k_mutex.c b/kernel/microkernel/k_mutex.c index cf0bc0af6a0..9f651e2f98a 100644 --- a/kernel/microkernel/k_mutex.c +++ b/kernel/microkernel/k_mutex.c @@ -61,7 +61,7 @@ NOMANUAL /** * - * _k_mutex_lock_reply - reply to a mutex lock request (LOCK_TMO, LOCK_RPL) + * @brief Reply to a mutex lock request (LOCK_TMO, LOCK_RPL) * * This routine replies to a mutex lock request. This will occur if either * the waiting task times out or acquires the mutex lock. @@ -146,7 +146,7 @@ void _k_mutex_lock_reply( /** * - * _k_mutex_lock_request - process a mutex lock request + * @brief Process a mutex lock request * * This routine processes a mutex lock request (LOCK_REQ). If the mutex * is already locked, and the timeout is non-zero then the priority inheritance @@ -269,7 +269,7 @@ void _k_mutex_lock_request(struct k_args *A /* pointer to mutex lock /** * - * _task_mutex_lock - mutex lock kernel service + * @brief Mutex lock kernel service * * This routine is the entry to the mutex lock kernel service. * @@ -293,7 +293,7 @@ int _task_mutex_lock( /** * - * _k_mutex_unlock - process a mutex unlock request + * @brief Process a mutex unlock request * * This routine processes a mutex unlock request (UNLOCK). If the mutex * was involved in priority inheritance, then it will change the priority level @@ -387,7 +387,7 @@ void _k_mutex_unlock(struct k_args *A /* pointer to mutex unlock /** * - * _task_mutex_unlock - mutex unlock kernel service + * @brief Mutex unlock kernel service * * This routine is the entry to the mutex unlock kernel service. * diff --git a/kernel/microkernel/k_nop.c b/kernel/microkernel/k_nop.c index 7ea2ca6c456..4ecc695a90d 100644 --- a/kernel/microkernel/k_nop.c +++ b/kernel/microkernel/k_nop.c @@ -46,7 +46,7 @@ a task to measure the overhead involved in issuing a kernel service request. /** * - * _k_nop - perform "do nothing" kernel request + * @brief Perform "do nothing" kernel request * * @return N/A */ @@ -58,7 +58,7 @@ void _k_nop(struct k_args *A) /** * - * _task_nop - "do nothing" kernel request + * @brief "do nothing" kernel request * * This routine is a request for the K_swapper to run a "do nothing" routine. * diff --git a/kernel/microkernel/k_offload.c b/kernel/microkernel/k_offload.c index 0870a12bd9b..a0203371c9d 100644 --- a/kernel/microkernel/k_offload.c +++ b/kernel/microkernel/k_offload.c @@ -35,7 +35,7 @@ /** * - * _k_offload_to_fiber - process an "offload to fiber" request + * @brief Process an "offload to fiber" request * * This routine simply invokes the requested function from within the context * of the K_swapper() fiber and saves the result. @@ -50,7 +50,7 @@ void _k_offload_to_fiber(struct k_args *A) /** * - * task_offload_to_fiber - issue a custom call from within K_swapper() + * @brief Issue a custom call from within K_swapper() * * @func: function to call from within K_swapper() * @argp: argument to pass to custom function diff --git a/kernel/microkernel/k_pipe.c b/kernel/microkernel/k_pipe.c index 05cbef1a047..d9acc691fc0 100644 --- a/kernel/microkernel/k_pipe.c +++ b/kernel/microkernel/k_pipe.c @@ -37,7 +37,7 @@ /** * - * _k_pipe_init - initialize kernel pipe subsystem + * @brief Initialize kernel pipe subsystem * * 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.) @@ -59,7 +59,7 @@ void _k_pipe_init(void) /** * - * _task_pipe_get - pipe read request + * @brief Pipe read request * * This routine attempts to read data into a memory buffer area from the * specified pipe. @@ -114,7 +114,7 @@ int _task_pipe_get(kpipe_t Id, void *pBuffer, /** * - * _task_pipe_put - pipe write request + * @brief Pipe write request * * This routine attempts to write data from a memory buffer area to the * specified pipe. @@ -169,7 +169,7 @@ int _task_pipe_put(kpipe_t Id, void *pBuffer, /** * - * _task_pipe_put_async - asynchronous pipe write request + * @brief Asynchronous pipe write request * * This routine attempts to write data from a memory pool block to the * specified pipe. (Note that partial transfers and timeouts are not diff --git a/kernel/microkernel/k_pipe_get.c b/kernel/microkernel/k_pipe_get.c index 35f465a1ab2..c26ee5b8298 100644 --- a/kernel/microkernel/k_pipe_get.c +++ b/kernel/microkernel/k_pipe_get.c @@ -38,7 +38,7 @@ /** * - * _k_pipe_get_request - process request command for a pipe get operation + * @brief Process request command for a pipe get operation * * @return N/A */ @@ -190,7 +190,7 @@ void _k_pipe_get_request(struct k_args *RequestOrig) /** * - * _k_pipe_get_timeout - process timeout command for a pipe get operation + * @brief Process timeout command for a pipe get operation * * @return N/A */ @@ -210,7 +210,7 @@ void _k_pipe_get_timeout(struct k_args *ReqProc) /** * - * _k_pipe_get_reply - process reply command for a pipe get operation + * @brief Process reply command for a pipe get operation * * @return N/A */ @@ -261,7 +261,7 @@ void _k_pipe_get_reply(struct k_args *ReqProc) /** * - * _k_pipe_get_ack - process acknowledgment command for a pipe get operation + * @brief Process acknowledgment command for a pipe get operation * * @return N/A */ diff --git a/kernel/microkernel/k_pipe_put.c b/kernel/microkernel/k_pipe_put.c index b4df5818429..3cd6b15b3bb 100644 --- a/kernel/microkernel/k_pipe_put.c +++ b/kernel/microkernel/k_pipe_put.c @@ -39,7 +39,7 @@ /** * - * _k_pipe_put_request - process request command for a pipe put operation + * @brief Process request command for a pipe put operation * * @return N/A */ @@ -209,7 +209,7 @@ void _k_pipe_put_request(struct k_args *RequestOrig) /** * - * _k_pipe_put_timeout - perform timeout command for a pipe put operation + * @brief Perform timeout command for a pipe put operation * * @return N/A */ @@ -229,7 +229,7 @@ void _k_pipe_put_timeout(struct k_args *ReqProc) /** * - * _k_pipe_put_reply - process reply command for a pipe put operation + * @brief Process reply command for a pipe put operation * * @return N/A */ @@ -282,7 +282,7 @@ void _k_pipe_put_reply(struct k_args *ReqProc) /** * - * _k_pipe_put_ack - process acknowledgment command for a pipe put operation + * @brief Process acknowledgment command for a pipe put operation * * @return N/A */ diff --git a/kernel/microkernel/k_pipe_xfer.c b/kernel/microkernel/k_pipe_xfer.c index ded7dbfab2a..2393bce4da8 100644 --- a/kernel/microkernel/k_pipe_xfer.c +++ b/kernel/microkernel/k_pipe_xfer.c @@ -207,7 +207,7 @@ void _k_pipe_movedata_ack(struct k_args *pEOXfer) /** * - * move_priority_compute - determines priority for data move operation + * @brief Determines priority for data move operation * * Uses priority level of most important participant. * @@ -410,7 +410,7 @@ static int WriterInProgressIsBlocked(struct pipe_struct *pPipe, /** * - * pipe_read - read from the channel + * @brief Read from the channel * * This routine reads from the channel. If is NULL, then it uses * as the reader. Otherwise it takes the reader from the channel @@ -479,7 +479,7 @@ static void pipe_read(struct pipe_struct *pPipe, struct k_args *pNewReader) /** * - * pipe_write - write to the channel + * @brief Write to the channel * * This routine writes to the channel. If is NULL, then it uses * as the writer. Otherwise it takes the writer from the channel @@ -550,7 +550,7 @@ static void pipe_write(struct pipe_struct *pPipe, struct k_args *pNewWriter) /** * - * pipe_xfer_status_update - update the channel transfer status + * @brief Update the channel transfer status * * @return N/A */ @@ -577,7 +577,7 @@ static void pipe_xfer_status_update( /** * - * pipe_read_write - read and/or write from/to the channel + * @brief Read and/or write from/to the channel * * @return N/A */ diff --git a/kernel/microkernel/k_semaphore.c b/kernel/microkernel/k_semaphore.c index 6b7babb7581..7a5c0b98dd1 100644 --- a/kernel/microkernel/k_semaphore.c +++ b/kernel/microkernel/k_semaphore.c @@ -38,7 +38,7 @@ /** * - * signal_semaphore - common code for signaling a semaphore + * @brief Common code for signaling a semaphore * * @return N/A */ @@ -96,7 +96,7 @@ static void signal_semaphore(int n, struct sem_struct *S) /** * - * _k_sem_group_wait - finish handling incomplete waits on semaphores + * @brief Finish handling incomplete waits on semaphores * * @return N/A */ @@ -113,7 +113,7 @@ void _k_sem_group_wait(struct k_args *R) /** * - * _k_sem_group_wait_cancel - handle cancellation of a semaphore involved in a + * @brief Handle cancellation of a semaphore involved in a * semaphore group wait request * * This routine only applies to semaphore group wait requests. It is invoked @@ -179,7 +179,7 @@ void _k_sem_group_wait_cancel(struct k_args *A) /** * - * _k_sem_group_wait_accept - handle acceptance of the ready semaphore request + * @brief Handle acceptance of the ready semaphore request * * This routine only applies to semaphore group wait requests. It handles * the request for the one semaphore in the group that "wins" the semaphore @@ -218,7 +218,7 @@ void _k_sem_group_wait_accept(struct k_args *A) /** * - * _k_sem_group_wait_timeout - handle semaphore group timeout request + * @brief Handle semaphore group timeout request * * @return N/A */ @@ -249,7 +249,7 @@ void _k_sem_group_wait_timeout(struct k_args *A) /** * - * _k_sem_group_ready - handle semaphore ready request + * @brief Handle semaphore ready request * * This routine only applies to semaphore group wait requests. It identifies * the one semaphore in the group that "won" the semaphore group wait request @@ -277,7 +277,7 @@ void _k_sem_group_ready(struct k_args *R) /** * - * _k_sem_wait_reply - reply to a semaphore wait request + * @brief Reply to a semaphore wait request * * @return N/A */ @@ -299,7 +299,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 + * @brief Handle internal wait request on a semaphore involved in a * semaphore group wait request * * @return N/A @@ -341,7 +341,7 @@ void _k_sem_group_wait_request(struct k_args *A) /** * - * _k_sem_group_wait_any - handle semaphore group wait request + * @brief Handle semaphore group wait request * * This routine splits the single semaphore group wait request into several * internal wait requests--one for each semaphore in the group. @@ -390,7 +390,7 @@ void _k_sem_group_wait_any(struct k_args *A) /** * - * _k_sem_wait_request - handle semaphore test and wait request + * @brief Handle semaphore test and wait request * * @return N/A */ @@ -427,7 +427,7 @@ void _k_sem_wait_request(struct k_args *A) /** * - * _task_sem_take - test a semaphore + * @brief Test a semaphore * * This routine tests a semaphore to see if it has been signaled. If the signal * count is greater than zero, it is decremented. @@ -451,7 +451,7 @@ int _task_sem_take(ksem_t sema, int32_t time) /** * - * _task_sem_group_take - test multiple semaphores + * @brief Test multiple semaphores * * This routine tests a group of semaphores. A semaphore group is an array of * semaphore names terminated by the predefined constant ENDLIST. @@ -479,7 +479,7 @@ ksem_t _task_sem_group_take(ksemg_t group, int32_t time) /** * - * _k_sem_signal - handle semaphore signal request + * @brief Handle semaphore signal request * * @return N/A */ @@ -493,7 +493,7 @@ void _k_sem_signal(struct k_args *A) /** * - * _k_sem_group_signal - handle signal semaphore group request + * @brief Handle signal semaphore group request * * @return N/A */ @@ -509,7 +509,7 @@ void _k_sem_group_signal(struct k_args *A) /** * - * task_sem_give - signal a semaphore + * @brief Signal a semaphore * * This routine signals the specified semaphore. * @@ -529,7 +529,7 @@ void task_sem_give(ksem_t sema) /** * - * task_sem_group_give - signal a group of semaphores + * @brief Signal a group of semaphores * * This routine signals a group of semaphores. A semaphore group is an array of * semaphore names terminated by the predefined constant ENDLIST. @@ -556,7 +556,7 @@ void task_sem_group_give(ksemg_t group) /** * - * fiber_sem_give - signal a semaphore from a fiber + * @brief Signal a semaphore from a fiber * * This routine (to only be called from a fiber) signals a semaphore. It * requires a statically allocated command packet (from a command packet set) @@ -570,7 +570,7 @@ FUNC_ALIAS(isr_sem_give, fiber_sem_give, void); /** * - * isr_sem_give - signal a semaphore from an ISR + * @brief Signal a semaphore from an ISR * * This routine (to only be called from an ISR) signals a semaphore. It * requires a statically allocated command packet (from a command packet set) @@ -602,7 +602,7 @@ void isr_sem_give(ksem_t sema, struct cmd_pkt_set *pSet) /** * - * _k_sem_reset - handle semaphore reset request + * @brief Handle semaphore reset request * * @return N/A */ @@ -616,7 +616,7 @@ void _k_sem_reset(struct k_args *A) /** * - * _k_sem_group_reset - handle semaphore group reset request + * @brief Handle semaphore group reset request * * @return N/A */ @@ -632,7 +632,7 @@ void _k_sem_group_reset(struct k_args *A) /** * - * task_sem_reset - reset semaphore count to zero + * @brief Reset semaphore count to zero * * This routine resets the signal count of the specified semaphore to zero. * @@ -652,7 +652,7 @@ void task_sem_reset(ksem_t sema) /** * - * task_sem_group_reset - reset a group of semaphores + * @brief Reset a group of semaphores * * This routine resets the signal count for a group of semaphores. A semaphore * group is an array of semaphore names terminated by the predefined constant @@ -674,7 +674,7 @@ void task_sem_group_reset(ksemg_t group) /** * - * _k_sem_inquiry - handle semaphore inquiry request + * @brief Handle semaphore inquiry request * * @return N/A */ @@ -691,7 +691,7 @@ void _k_sem_inquiry(struct k_args *A) /** * - * task_sem_count_get - read the semaphore signal count + * @brief Read the semaphore signal count * * This routine reads the signal count of the specified semaphore. * diff --git a/kernel/microkernel/k_server.c b/kernel/microkernel/k_server.c index da4b4398658..a895d66b7b1 100644 --- a/kernel/microkernel/k_server.c +++ b/kernel/microkernel/k_server.c @@ -52,7 +52,7 @@ extern const kernelfunc _k_server_dispatch_table[]; /** * - * next_task_select - select task to be executed by microkernel + * @brief Select task to be executed by microkernel * * Locates that highest priority task queue that is non-empty and chooses the * task at the head of that queue. It's guaranteed that there will always be @@ -87,7 +87,7 @@ static struct k_proc *next_task_select(void) /** * - * K_swapper - the microkernel thread entry point + * @brief The microkernel thread entry point * * This function implements the microkernel fiber. It waits for command * packets to arrive on its stack channel. It executes all commands on the diff --git a/kernel/microkernel/k_task.c b/kernel/microkernel/k_task.c index c68c7170249..a2cd18025bf 100644 --- a/kernel/microkernel/k_task.c +++ b/kernel/microkernel/k_task.c @@ -45,7 +45,7 @@ /** * - * task_id_get - get task identifer + * @brief Get task identifer * * @return identifier for current task */ @@ -57,7 +57,7 @@ ktask_t task_id_get(void) /** * - * _k_state_bit_reset - reset the specified task state bits + * @brief Reset the specified task state bits * * This routine resets the specified task state bits. When a task's state bits * are zero, the task may be scheduled to run. The tasks's state bits are a @@ -109,7 +109,7 @@ void _k_state_bit_reset(struct k_proc *X, /* ptr to task */ /** * - * _k_state_bit_set - set specified task state bits + * @brief Set specified task state bits * * This routine sets the specified task state bits. When a task's state bits * are non-zero, the task will not be scheduled to run. The task's state bits @@ -195,7 +195,7 @@ void _k_state_bit_set( /** * - * start_task - initialize and start a task + * @brief Initialize and start a task * * @return N/A */ @@ -237,7 +237,7 @@ static void start_task(struct k_proc *X, /* ptr to task control block */ /** * - * abort_task - abort a task + * @brief Abort a task * * This routine aborts the specified task. * @@ -265,7 +265,7 @@ static void abort_task(struct k_proc *X) #ifndef CONFIG_ARCH_HAS_TASK_ABORT /** * - * _TaskAbort - microkernel handler for fatal task errors + * @brief Microkernel handler for fatal task errors * * To be invoked when a task aborts implicitly, either by returning from its * entry point or due to a software or hardware fault. @@ -291,7 +291,7 @@ FUNC_NORETURN void _TaskAbort(void) /** * - * task_abort_handler_set - install an abort handler + * @brief Install an abort handler * * This routine installs an abort handler for the calling task. * @@ -315,7 +315,7 @@ void task_abort_handler_set(void (*func)(void) /* abort handler */ /** * - * _k_task_op - handle a task operation request + * @brief Handle a task operation request * * This routine handles any one of the following task operation requests: * starting either a kernel or user task, aborting a task, suspending a task, @@ -353,7 +353,7 @@ void _k_task_op(struct k_args *A) /** * - * _task_ioctl - task operations + * @brief Task operations * * @return N/A */ @@ -372,7 +372,7 @@ void _task_ioctl(ktask_t task, /* task on which to operate */ /** * - * _k_task_group_op - handle task group operation request + * @brief Handle task group operation request * * This routine handles any one of the following task group operations requests: * starting either kernel or user tasks, aborting tasks, suspending tasks, @@ -424,7 +424,7 @@ void _k_task_group_op(struct k_args *A) /** * - * _task_group_ioctl - task group operations + * @brief Task group operations * * @return N/A */ @@ -443,7 +443,7 @@ void _task_group_ioctl(ktask_group_t group, /* task group */ /** * - * task_group_mask_get - get task groups for task + * @brief Get task groups for task * * @return task groups associated with current task */ @@ -455,7 +455,7 @@ kpriority_t task_group_mask_get(void) /** * - * task_group_join - add task to task group(s) + * @brief Add task to task group(s) * * @return N/A */ @@ -467,7 +467,7 @@ void task_group_join(uint32_t groups) /** * - * task_group_leave - remove task from task group(s) + * @brief Remove task from task group(s) * * @return N/A */ @@ -479,7 +479,7 @@ void task_group_leave(uint32_t groups) /** * - * task_priority_get - get task priority + * @brief Get task priority * * @return priority of current task */ @@ -491,7 +491,7 @@ kpriority_t task_priority_get(void) /** * - * _k_task_priority_set - handle task set priority request + * @brief Handle task set priority request * * @return N/A */ @@ -511,7 +511,7 @@ void _k_task_priority_set(struct k_args *A) /** * - * task_priority_set - set the priority of a task + * @brief Set the priority of a task * * This routine changes the priority of the specified task. * @@ -538,7 +538,7 @@ void task_priority_set(ktask_t task, /* task whose priority is to be set */ /** * - * _k_task_yield - handle task yield request + * @brief Handle task yield request * * @return N/A */ @@ -559,7 +559,7 @@ void _k_task_yield(struct k_args *A) /** * - * task_yield - yield the CPU to another task + * @brief Yield the CPU to another task * * This routine yields the processor to the next equal priority task that is * runnable. Using task_yield(), it is possible to achieve the effect of round @@ -579,7 +579,7 @@ void task_yield(void) /** * - * task_entry_set - set the entry point of a task + * @brief Set the entry point of a task * * This routine sets the entry point of a task to a given routine. It is only * needed if the entry point is different from that specified in the project diff --git a/kernel/microkernel/k_ticker.c b/kernel/microkernel/k_ticker.c index af873aa17fb..7d73b164271 100644 --- a/kernel/microkernel/k_ticker.c +++ b/kernel/microkernel/k_ticker.c @@ -71,7 +71,7 @@ int sys_clock_hw_cycles_per_tick; /** * - * task_cycle_get_32 - read the processor's high precision timer + * @brief Read the processor's high precision timer * * This routine reads the processor's high precision timer. It reads the * counter register on the timer device. This counter register increments @@ -89,7 +89,7 @@ uint32_t task_cycle_get_32(void) /** * - * task_tick_get_32 - read the current system clock value + * @brief Read the current system clock value * * This routine returns the lower 32-bits of the current system clock value * as measured in ticks. @@ -104,7 +104,7 @@ int32_t task_tick_get_32(void) /** * - * task_tick_get - read the current system clock value + * @brief Read the current system clock value * * This routine returns the current system clock value as measured in ticks. * @@ -126,7 +126,7 @@ int64_t task_tick_get(void) /** * - * sys_clock_increment - increment system clock by "N" ticks + * @brief Increment system clock by "N" ticks * * Interrupts are locked while updating clock since some CPUs do not support * native atomic operations on 64 bit values. @@ -144,7 +144,7 @@ static void sys_clock_increment(int inc) /** * - * _TlDebugUpdate - task level debugging tick handler + * @brief Task level debugging tick handler * * If task level debugging is configured this routine updates the low resolution * debugging timer and determines if task level processing should be suspended. @@ -168,7 +168,7 @@ static inline int _TlDebugUpdate(int32_t ticks) /** * - * _TimeSliceUpdate - tick handler time slice logic + * @brief Tick handler time slice logic * * This routine checks to see if it is time for the current task * to relinquish control, and yields CPU if so. @@ -194,7 +194,7 @@ static inline void _TimeSliceUpdate(void) /** * - * _SysIdleElapsedTicksGet - get elapsed ticks + * @brief Get elapsed ticks * * If tickless idle support is configured this routine returns the number * of ticks since going idle and then resets the global elapsed tick counter back @@ -227,7 +227,7 @@ static inline int32_t _SysIdleElapsedTicksGet(void) /** * - * _k_ticker - microkernel tick handler + * @brief Microkernel tick handler * * This routine informs other microkernel subsystems that a tick event has * occurred. @@ -258,7 +258,7 @@ int _k_ticker(int event) /** * - * sys_scheduler_time_slice_set - set time slicing period and scope + * @brief Set time slicing period and scope * * This routine controls how task time slicing is performed by the task * scheduler, by specifying the maximum time slice length (in ticks) and @@ -295,7 +295,7 @@ void sys_scheduler_time_slice_set(int32_t t, kpriority_t p) /** * - * _k_time_elapse - handle elapsed ticks calculation request + * @brief Handle elapsed ticks calculation request * * This routine, called by K_swapper(), handles the request for calculating the * time elapsed since the specified reference time. @@ -313,7 +313,7 @@ void _k_time_elapse(struct k_args *P) /** * - * task_tick_delta - return ticks between calls + * @brief Return ticks between calls * * This function is meant to be used in contained fragments of code. The first * call to it in a particular code fragment fills in a reference time variable diff --git a/kernel/microkernel/k_timer.c b/kernel/microkernel/k_timer.c index 78a7770f593..8f2729ed07d 100644 --- a/kernel/microkernel/k_timer.c +++ b/kernel/microkernel/k_timer.c @@ -45,7 +45,7 @@ struct k_timer *_k_timer_list_tail = NULL; /** * - * _timer_id_to_ptr - convert timer pointer to timer object identifier + * @brief Convert timer pointer to timer object identifier * * This routine converts a timer pointer into a timer object identifier. * @@ -66,7 +66,7 @@ static inline ktimer_t _timer_ptr_to_id(struct k_timer *timer) /** * - * _timer_id_to_ptr - convert timer object identifier to timer pointer + * @brief Convert timer object identifier to timer pointer * * This routine converts a timer object identifier into a timer pointer. * @@ -80,7 +80,7 @@ static inline struct k_timer *_timer_id_to_ptr(ktimer_t timer) /** * - * _k_timer_enlist - insert a timer into the timer queue + * @brief Insert a timer into the timer queue * * @return N/A */ @@ -112,7 +112,7 @@ void _k_timer_enlist(struct k_timer *T) /** * - * _k_timer_delist - remove a timer from the timer queue + * @brief Remove a timer from the timer queue * * @return N/A */ @@ -136,7 +136,7 @@ void _k_timer_delist(struct k_timer *T) /** * - * _k_timeout_alloc - allocate timer used for command packet timeout + * @brief Allocate timer used for command packet timeout * * Allocates timer for command packet and inserts it into the timer queue. * @@ -157,7 +157,7 @@ void _k_timeout_alloc(struct k_args *P) /** * - * _k_timeout_cancel - cancel timer used for command packet timeout + * @brief Cancel timer used for command packet timeout * * Cancels timer (if not already expired), then reschedules the command packet * for further processing. @@ -180,7 +180,7 @@ void _k_timeout_cancel(struct k_args *A) /** * - * _k_timeout_free - free timer used for command packet timeout + * @brief Free timer used for command packet timeout * * Cancels timer (if not already expired), then frees it. * @@ -196,7 +196,7 @@ void _k_timeout_free(struct k_timer *T) /** * - * _k_timer_list_update - handle expired timers + * @brief Handle expired timers * * Process the sorted list of timers associated with waiting tasks and * activate each task whose timer has now expired. @@ -246,7 +246,7 @@ void _k_timer_list_update(int ticks) /** * - * _k_timer_alloc - handle timer allocation request + * @brief Handle timer allocation request * * This routine, called by K_swapper(), handles the request for allocating a * timer. @@ -271,7 +271,7 @@ void _k_timer_alloc(struct k_args *P) /** * - * task_timer_alloc - allocate a timer and return its object identifier + * @brief Allocate a timer and return its object identifier * * @return timer identifier */ @@ -288,7 +288,7 @@ ktimer_t task_timer_alloc(void) /** * - * _k_timer_dealloc - handle timer deallocation request + * @brief Handle timer deallocation request * * This routine, called by K_swapper(), handles the request for deallocating a * timer. @@ -310,7 +310,7 @@ void _k_timer_dealloc(struct k_args *P) /** * - * task_timer_free - deallocate a timer + * @brief Deallocate a timer * * This routine frees the resources associated with the timer. If a timer was * started, it has to be stopped using task_timer_stop() before it can be freed. @@ -331,7 +331,7 @@ void task_timer_free(ktimer_t timer) /** * - * _k_timer_start - handle start timer request + * @brief Handle start timer request * * This routine, called by K_swapper(), handles the start timer request from * both task_timer_start() and task_timer_restart(). @@ -380,7 +380,7 @@ void _k_timer_start(struct k_args *P) /** * - * task_timer_start - start or restart the specified low resolution timer + * @brief Start or restart the specified low resolution timer * * This routine starts or restarts the specified low resolution timer. * @@ -418,7 +418,7 @@ void task_timer_start(ktimer_t timer, int32_t duration, int32_t period, /** * - * task_timer_restart - restart a timer + * @brief Restart a timer * * This routine restarts the timer specified by . * @@ -443,7 +443,7 @@ void task_timer_restart(ktimer_t timer, int32_t duration, int32_t period) /** * - * _k_timer_stop - handle stop timer request + * @brief Handle stop timer request * * This routine, called by K_swapper(), handles the request for stopping a * timer. @@ -461,7 +461,7 @@ void _k_timer_stop(struct k_args *P) /** * - * task_timer_stop - stop a timer + * @brief Stop a timer * * This routine stops the specified timer. If the timer period has already * elapsed, the call has no effect. @@ -482,7 +482,7 @@ void task_timer_stop(ktimer_t timer) /** * - * _k_task_wakeup - handle internally issued task wakeup request + * @brief Handle internally issued task wakeup request * * This routine, called by K_swapper(), handles the request for waking a task * at the end of its sleep period. @@ -504,7 +504,7 @@ void _k_task_wakeup(struct k_args *P) /** * - * _k_task_sleep - handle task sleep request + * @brief Handle task sleep request * * This routine, called by K_swapper(), handles the request for putting a task * to sleep. @@ -535,7 +535,7 @@ void _k_task_sleep(struct k_args *P) /** * - * task_sleep - sleep for a number of ticks + * @brief Sleep for a number of ticks * * This routine suspends the calling task for the specified number of timer * ticks. When the task is awakened, it is rescheduled according to its diff --git a/kernel/nanokernel/compiler_stack_protect.c b/kernel/nanokernel/compiler_stack_protect.c index 4792855d350..97e6bbcb022 100644 --- a/kernel/nanokernel/compiler_stack_protect.c +++ b/kernel/nanokernel/compiler_stack_protect.c @@ -50,7 +50,7 @@ function __stack_chk_fail and global variable __stack_chk_guard. /** * - * _StackCheckHandler - stack canary error handler + * @brief Stack canary error handler * * This function is invoked when a stack canary error is detected. * @@ -80,7 +80,7 @@ void __noinit *__stack_chk_guard; /** * - * __stack_chk_fail - Referenced by GCC compiler generated code + * @brief Referenced by GCC compiler generated code * * This routine is invoked when a stack canary error is detected, indicating * a buffer overflow or stack corruption problem. diff --git a/kernel/nanokernel/ctors.c b/kernel/nanokernel/ctors.c index 8a59dab09ca..d988d47e737 100644 --- a/kernel/nanokernel/ctors.c +++ b/kernel/nanokernel/ctors.c @@ -63,7 +63,7 @@ extern CtorFuncPtr __CTOR_END__[]; /** * - * _Ctors - invoke all C++ style global object constructors + * @brief Invoke all C++ style global object constructors * * This function is invoked by _Cstart(), which is implemented in the BSP. It * invokes all routines that have been tagged using NANO_INIT_xxx, in order diff --git a/kernel/nanokernel/idle.c b/kernel/nanokernel/idle.c index c5fd199236a..6f6289a296c 100644 --- a/kernel/nanokernel/idle.c +++ b/kernel/nanokernel/idle.c @@ -45,7 +45,7 @@ data structure. /** * - * nano_cpu_set_idle - indicate that nanokernel is idling in tickless mode + * @brief Indicate that nanokernel is idling in tickless mode * * Sets the nanokernel data structure idle field to a non-zero value. * diff --git a/kernel/nanokernel/int_latency_bench.c b/kernel/nanokernel/int_latency_bench.c index 103ea5ce073..bfec9f39761 100644 --- a/kernel/nanokernel/int_latency_bench.c +++ b/kernel/nanokernel/int_latency_bench.c @@ -68,7 +68,7 @@ uint32_t _hw_irq_to_c_handler_latency = ULONG_MAX; /** * - * intLatencyStart - start tracking time spent with interrupts locked + * @brief Start tracking time spent with interrupts locked * * calls to lock interrupt can nest, so this routine can be called numerous * times before interrupt are unlocked @@ -89,7 +89,7 @@ void _int_latency_start(void) /** * - * intLatencyStop - stop accumulating time spent for when interrupts are locked + * @brief Stop accumulating time spent for when interrupts are locked * * This is only call once when the interrupt are being reenabled * @@ -142,7 +142,7 @@ void _int_latency_stop(void) /** * - * int_latency_init - initialize interrupt latency benchmark + * @brief Initialize interrupt latency benchmark * * @return N/A * @@ -193,7 +193,7 @@ void int_latency_init(void) /** * - * int_latency_show - dumps interrupt latency values + * @brief Dumps interrupt latency values * * The interrupt latency value measures * diff --git a/kernel/nanokernel/nano_context.c b/kernel/nanokernel/nano_context.c index 18ab7b6a2a5..37b8693930e 100644 --- a/kernel/nanokernel/nano_context.c +++ b/kernel/nanokernel/nano_context.c @@ -44,7 +44,7 @@ tasks or fibers. /** * - * context_self_get - return the currently executing context + * @brief Return the currently executing context * * 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. @@ -59,7 +59,7 @@ nano_context_id_t context_self_get(void) /** * - * context_type_get - return the type of the currently executing context + * @brief Return the type of the currently executing context * * This routine returns the type of context currently executing. * @@ -79,7 +79,7 @@ nano_context_type_t context_type_get(void) /** * - * _context_essential_set - mark context as essential to system + * @brief Mark context as essential to system * * This function tags the running fiber or task as essential to system * option; exceptions raised by this context will be treated as a fatal @@ -95,7 +95,7 @@ void _context_essential_set(void) /** * - * _context_essential_clear - mark context as not essential to system + * @brief Mark context as not essential to system * * This function tags the running fiber or task as not essential to system * option; exceptions raised by this context may be recoverable. @@ -111,7 +111,7 @@ void _context_essential_clear(void) /** * - * _context_essential_check - is the specified context essential? + * @brief Is the specified context essential? * * This routine indicates if the specified context is an essential system * context. A NULL context pointer indicates that the current context is @@ -130,7 +130,7 @@ int _context_essential_check(tCCS *pCtx /* pointer to context */ /** * - * context_custom_data_set - set context's custom data + * @brief Set context's custom data * * This routine sets the custom data value for the current task or fiber. * Custom data is not used by the kernel itself, and is freely available @@ -147,7 +147,7 @@ void context_custom_data_set(void *value /* new value */ /** * - * context_custom_data_get - get context's custom data + * @brief Get context's custom data * * This function returns the custom data value for the current task or fiber. * @@ -164,7 +164,7 @@ void *context_custom_data_get(void) #if defined(CONFIG_CONTEXT_MONITOR) /** * - * _context_exit - context exit routine + * @brief Context exit routine * * This function is invoked when the specified context is aborted, either * normally or abnormally. It is called for the termination of any context, @@ -202,7 +202,7 @@ void _context_exit(tCCS *pContext) /** * - * _context_entry - common context entry point function for kernel contexts + * @brief Common context entry point function for kernel contexts * * This function serves as the entry point for _all_ kernel contexts, i.e. both * task and fiber contexts are instantiated such that initial execution starts diff --git a/kernel/nanokernel/nano_fiber.c b/kernel/nanokernel/nano_fiber.c index 906fd97196f..784aeeb032f 100644 --- a/kernel/nanokernel/nano_fiber.c +++ b/kernel/nanokernel/nano_fiber.c @@ -43,7 +43,7 @@ either in the form of an actual function or an alias to a function. /** * - * _nano_fiber_schedule - add a fiber to the list of runnable fibers + * @brief Add a fiber to the list of runnable fibers * * The list of runnable fibers is maintained via a single linked list * in priority order. Numerically lower priorities represent higher priority @@ -83,7 +83,7 @@ FUNC_ALIAS(_fiber_start, fiber_start, void); /** * - * _fiber_start - initialize and start a fiber context + * @brief Initialize and start a fiber context * * This routine initilizes and starts a fiber context; it can be called from * either a fiber or a task context. When this routine is called from a @@ -147,7 +147,7 @@ void _fiber_start(char *pStack, /** * - * fiber_yield - yield the current context + * @brief Yield the current context * * Invocation of this routine results in the current context yielding to * another context of the same or higher priority. If there doesn't exist @@ -179,7 +179,7 @@ void fiber_yield(void) /** * - * _nano_fiber_swap - pass control from the currently executing fiber + * @brief Pass control from the currently executing fiber * * This routine is used when a fiber voluntarily gives up control of the CPU. * @@ -214,7 +214,7 @@ FUNC_NORETURN void _nano_fiber_swap(void) #ifndef CONFIG_ARCH_HAS_NANO_FIBER_ABORT /** * - * fiber_abort - abort the currently executing fiber + * @brief Abort the currently executing fiber * * This routine is used to abort the currrently executing fiber. This can occur * because: diff --git a/kernel/nanokernel/nano_fifo.c b/kernel/nanokernel/nano_fifo.c index 8dcdc0604f8..86255223c5f 100644 --- a/kernel/nanokernel/nano_fifo.c +++ b/kernel/nanokernel/nano_fifo.c @@ -53,7 +53,7 @@ APIs to the same function, since they have identical implementations. /** * - * nano_fifo_init - initialize a nanokernel multiple-waiter fifo (fifo) object + * @brief Initialize a nanokernel multiple-waiter fifo (fifo) object * * This function initializes a nanokernel multiple-waiter fifo (fifo) object * structure. @@ -96,7 +96,7 @@ FUNC_ALIAS(_fifo_put_non_preemptible, nano_fiber_fifo_put, void); /** * - * enqueue_data - internal routine to append data to a fifo + * @brief Internal routine to append data to a fifo * * @return N/A */ @@ -110,7 +110,7 @@ static inline void enqueue_data(struct nano_fifo *fifo, void *data) /** * - * _fifo_put_non_preemptible - append an element to a fifo (no context switch) + * @brief Append an element to a fifo (no context switch) * * This routine adds an element to the end of a fifo object; it may be called * from either either a fiber or an ISR context. A fiber pending on the fifo @@ -151,7 +151,7 @@ void _fifo_put_non_preemptible( /** * - * nano_task_fifo_put - add an element to the end of a fifo + * @brief Add an element to the end of a fifo * * This routine adds an element to the end of a fifo object; it can be called * from only a task context. A fiber pending on the fifo object will be made @@ -188,7 +188,7 @@ void nano_task_fifo_put( /** * - * nano_fifo_put - add an element to the end of a fifo + * @brief Add an element to the end of a fifo * * This is a convenience wrapper for the context-specific APIs. This is * helpful whenever the exact scheduling context is not known, but should @@ -210,7 +210,7 @@ FUNC_ALIAS(_fifo_get, nano_fifo_get, void *); /** * - * dequeue_data - internal routine to remove data from a fifo + * @brief Internal routine to remove data from a fifo * * @return the data item removed */ @@ -235,7 +235,7 @@ static inline void *dequeue_data(struct nano_fifo *fifo) /** * - * _fifo_get - get an element from the head a fifo + * @brief Get an element from the head a fifo * * Remove the head element from the specified nanokernel multiple-waiter fifo * linked list fifo; it may be called from a fiber, task, or ISR context. @@ -273,7 +273,7 @@ void *_fifo_get( /** * - * nano_fiber_fifo_get_wait - get the head element of a fifo, wait if emtpy + * @brief Get the head element of a fifo, wait if emtpy * * Remove the head element from the specified system-level multiple-waiter * fifo; it can only be called from a fiber context. @@ -314,7 +314,7 @@ void *nano_fiber_fifo_get_wait( /** * - * nano_task_fifo_get_wait - get the head element of a fifo, poll if empty + * @brief Get the head element of a fifo, poll if empty * * Remove the head element from the specified system-level multiple-waiter * fifo; it can only be called from a task context. @@ -362,7 +362,7 @@ void *nano_task_fifo_get_wait( /** * - * nano_fifo_get_wait - get the head element of a fifo, poll/pend if empty + * @brief Get the head element of a fifo, poll/pend if empty * * This is a convenience wrapper for the context-specific APIs. This is * helpful whenever the exact scheduling context is not known, but should diff --git a/kernel/nanokernel/nano_init.c b/kernel/nanokernel/nano_init.c index 88442ecf4ac..8095e56b190 100644 --- a/kernel/nanokernel/nano_init.c +++ b/kernel/nanokernel/nano_init.c @@ -150,7 +150,7 @@ static void _main(void) /** * - * nano_init - initializes nanokernel data structures + * @brief Initializes nanokernel data structures * * This routine initializes various nanokernel data structures, including * the background (or idle) task and any architecture-specific initialization. @@ -221,7 +221,7 @@ static void nano_init(tCCS *dummyOutContext) #ifdef CONFIG_STACK_CANARIES /** * - * STACK_CANARY_INIT - initialize the kernel's stack canary + * @brief Initialize the kernel's stack canary * * This macro initializes the kernel's stack canary global variable, * __stack_chk_guard, with a random value. @@ -256,7 +256,7 @@ extern void *__stack_chk_guard; /** * - * _Cstart - initialize nanokernel + * @brief Initialize nanokernel * * This routine is invoked by the BSP when the system is ready to run C code. * The processor must be running in 32-bit mode, and the BSS must have been diff --git a/kernel/nanokernel/nano_lifo.c b/kernel/nanokernel/nano_lifo.c index 0dc403008d7..f5c1c3855f9 100644 --- a/kernel/nanokernel/nano_lifo.c +++ b/kernel/nanokernel/nano_lifo.c @@ -52,7 +52,7 @@ APIs to the same function, since they have identical implementations. /** * - * nano_lifo_init - initialize a nanokernel linked list lifo object + * @brief Initialize a nanokernel linked list lifo object * * This function initializes a nanokernel system-level linked list lifo * object structure. @@ -80,7 +80,7 @@ FUNC_ALIAS(_lifo_put_non_preemptible, nano_fiber_lifo_put, void); /** * - * _lifo_put_non_preemptible - prepend an element to a lifo (no context switch) + * @brief Prepend an element to a lifo (no context switch) * * This routine adds an element to the head of a lifo object; it may be * called from either a fiber or an ISR context. A fiber pending on the lifo @@ -118,7 +118,7 @@ void _lifo_put_non_preemptible( /** * - * nano_task_lifo_put - add an element to the head of a linked list lifo + * @brief Add an element to the head of a linked list lifo * * This routine adds an element to the head of a lifo object; it can be * called only from a task context. A fiber pending on the lifo @@ -158,7 +158,7 @@ FUNC_ALIAS(_lifo_get, nano_task_lifo_get, void *); /** * - * _lifo_get - remove the first element from a linked list lifo + * @brief Remove the first element from a linked list lifo * * Remove the first element from the specified nanokernel linked list lifo; * it may be called from a fiber, task, or ISR context. @@ -198,7 +198,7 @@ void *_lifo_get( /** * - * nano_fiber_lifo_get_wait - get the first element from a LIFO, wait if empty + * @brief Get the first element from a LIFO, wait if empty * * Remove the first element from the specified system-level linked list lifo; * it can only be called from a fiber context. @@ -240,7 +240,7 @@ void *nano_fiber_lifo_get_wait( /** * - * nano_task_lifo_get_wait - get the first element from a lifo, poll if empty + * @brief Get the first element from a lifo, poll if empty * * Remove the first element from the specified nanokernel linked list lifo; it * can only be called from a task context. @@ -289,7 +289,7 @@ void *nano_task_lifo_get_wait( /** * - * _nano_fiber_lifo_get_panic - get first element from lifo and panic if NULL + * @brief Get first element from lifo and panic if NULL * * Get the first element from the specified lifo but generate a fatal error * if the element is NULL. diff --git a/kernel/nanokernel/nano_sema.c b/kernel/nanokernel/nano_sema.c index 3811c1fecac..13cf7d473ff 100644 --- a/kernel/nanokernel/nano_sema.c +++ b/kernel/nanokernel/nano_sema.c @@ -58,7 +58,7 @@ APIs to the same function, since they have identical implementations. /** * - * nano_sem_init - initialize a nanokernel semaphore object + * @brief Initialize a nanokernel semaphore object * * This function initializes a nanokernel semaphore object structure. After * initialization, the semaphore count will be 0. @@ -92,7 +92,7 @@ FUNC_ALIAS(_sem_give_non_preemptible, nano_fiber_sem_give, void); /** * - * _sem_give_non_preemptible - give a nanokernel semaphore (no context switch) + * @brief Give a nanokernel semaphore (no context switch) * * This routine performs a "give" operation on a nanokernel sempahore object; * it may be call from either a fiber or an ISR context. A fiber pending on @@ -129,7 +129,7 @@ void _sem_give_non_preemptible( /** * - * nano_task_sem_give - give a nanokernel semaphore + * @brief Give a nanokernel semaphore * * This routine performs a "give" operation on a nanokernel sempahore object; * it can only be called from a task context. A fiber pending on the @@ -162,7 +162,7 @@ void nano_task_sem_give( /** * - * nano_sem_give - give a nanokernel semaphore + * @brief Give a nanokernel semaphore * * This is a convenience wrapper for the context-specific APIs. This is * helpful whenever the exact scheduling context is not known, but should @@ -184,7 +184,7 @@ FUNC_ALIAS(_sem_take, nano_task_sem_take, int); /** * - * _sem_take - take a nanokernel semaphore, fail if unavailable + * @brief Take a nanokernel semaphore, fail if unavailable * * Attempt to take a nanokernel sempahore; it may be called from a fiber, task, * or ISR context. @@ -212,7 +212,7 @@ int _sem_take( /** * - * nano_fiber_sem_take_wait - test a nanokernel semaphore, wait if unavailable + * @brief Test a nanokernel semaphore, wait if unavailable * * Take a nanokernel sempahore; it can only be called from a fiber context. * @@ -246,7 +246,7 @@ void nano_fiber_sem_take_wait( /** * - * nano_task_sem_take_wait - take a nanokernel semaphore, poll if unavailable + * @brief Take a nanokernel semaphore, poll if unavailable * * Take a nanokernel sempahore; it can only be called from a task context. * @@ -287,7 +287,7 @@ void nano_task_sem_take_wait( /** * - * nano_sem_take_wait - take a nanokernel semaphore, poll/pend if not available + * @brief Take a nanokernel semaphore, poll/pend if not available * * This is a convenience wrapper for the context-specific APIs. This is * helpful whenever the exact scheduling context is not known, but should diff --git a/kernel/nanokernel/nano_stack.c b/kernel/nanokernel/nano_stack.c index 48a97d515b3..8cde219ed2f 100644 --- a/kernel/nanokernel/nano_stack.c +++ b/kernel/nanokernel/nano_stack.c @@ -52,7 +52,7 @@ APIs to the same function, since they have identical implementations. /** * - * nano_stack_init - initialize a nanokernel stack object + * @brief Initialize a nanokernel stack object * * This function initializes a nanokernel stack object structure. * @@ -80,7 +80,7 @@ FUNC_ALIAS(_stack_push_non_preemptible, nano_fiber_stack_push, void); /** * - * _stack_push_non_preemptible - push data onto a stack (no context switch) + * @brief Push data onto a stack (no context switch) * * This routine pushes a data item onto a stack object; it may be called from * either a fiber or ISR context. A fiber pending on the stack object will be @@ -120,7 +120,7 @@ void _stack_push_non_preemptible( /** * - * nano_task_stack_push - push data onto a nanokernel stack + * @brief Push data onto a nanokernel stack * * This routine pushes a data item onto a stack object; it may be called only * from a task context. A fiber pending on the stack object will be @@ -160,7 +160,7 @@ FUNC_ALIAS(_stack_pop, nano_task_stack_pop, int); /** * - * _stack_pop - pop data from a nanokernel stack + * @brief Pop data from a nanokernel stack * * Pop the first data word from a nanokernel stack object; it may be called * from a fiber, task, or ISR context. @@ -201,7 +201,7 @@ int _stack_pop( /** * - * nano_fiber_stack_pop_wait - pop data from a nanokernel stack, wait if empty + * @brief Pop data from a nanokernel stack, wait if empty * * Pop the first data word from a nanokernel stack object; it can only be * called from a fiber context @@ -240,7 +240,7 @@ uint32_t nano_fiber_stack_pop_wait( /** * - * nano_task_stack_pop_wait - pop data from a nanokernel stack, poll if empty + * @brief Pop data from a nanokernel stack, poll if empty * * Pop the first data word from a nanokernel stack; it can only be called * from a task context. diff --git a/kernel/nanokernel/nano_sys_clock.c b/kernel/nanokernel/nano_sys_clock.c index 58211678e36..e4703bc0ed0 100644 --- a/kernel/nanokernel/nano_sys_clock.c +++ b/kernel/nanokernel/nano_sys_clock.c @@ -55,7 +55,7 @@ uint32_t _sys_idle_elapsed_ticks = 1; /** * - * nano_time_init - constructor that initializes nanokernel time tracking system + * @brief Constructor that initializes nanokernel time tracking system * * @return N/A * @@ -74,7 +74,7 @@ int64_t _nano_ticks = 0; /** * - * nano_tick_get_32 - return the lower part of the current system tick count + * @brief Return the lower part of the current system tick count * * @return the current system tick count * @@ -87,7 +87,7 @@ uint32_t nano_tick_get_32(void) /** * - * nano_tick_get - return the current system tick count + * @brief Return the current system tick count * * @return the current system tick count * @@ -110,7 +110,7 @@ int64_t nano_tick_get(void) /** * - * nano_cycle_get_32 - return a high resolution timestamp + * @brief Return a high resolution timestamp * * @return the current timer hardware count * @@ -123,7 +123,7 @@ uint32_t nano_cycle_get_32(void) /** * - * nano_tick_delta - return number of ticks since a reference time + * @brief Return number of ticks since a reference time * * This function is meant to be used in contained fragments of code. The first * call to it in a particular code fragment fills in a reference time variable @@ -172,7 +172,7 @@ static ALWAYS_INLINE int64_t _nano_tick_delta(int64_t *reftime) /** * - * nano_tick_delta - return number of ticks since a reference time + * @brief Return number of ticks since a reference time * * @return tick count since reference time; undefined for first invocation */ @@ -184,7 +184,7 @@ int64_t nano_tick_delta(int64_t *reftime) /** * - * nano_tick_delta_32 - return 32-bit number of ticks since a reference time + * @brief Return 32-bit number of ticks since a reference time * * @return 32-bit tick count since reference time; undefined for first invocation */ @@ -236,7 +236,7 @@ static inline void handle_expired_nano_timers(int ticks) #if defined(CONFIG_NANO_TIMEOUTS) || defined(CONFIG_NANO_TIMERS) /** * - * _nano_sys_clock_tick_announce - announce a tick to the nanokernel + * @brief Announce a tick to the nanokernel * * This function is only to be called by the system clock timer driver when a * tick is to be announced to the nanokernel. It takes care of dequeuing the diff --git a/kernel/nanokernel/nano_timer.c b/kernel/nanokernel/nano_timer.c index b71d12e6d6d..1f9be29a443 100644 --- a/kernel/nanokernel/nano_timer.c +++ b/kernel/nanokernel/nano_timer.c @@ -36,7 +36,7 @@ struct nano_timer *_nano_timer_list = NULL; /** * - * nano_timer_init - initialize a nanokernel timer object + * @brief Initialize a nanokernel timer object * * This function initializes a nanokernel timer object structure. * @@ -58,7 +58,7 @@ void nano_timer_init(struct nano_timer *timer, void *userData) /** * - * nano_fiber_timer_start - start a nanokernel timer from a fiber + * @brief Start a nanokernel timer from a fiber * * This function starts a previously initialized nanokernel timer object. * The timer will expire in system clock ticks. @@ -71,7 +71,7 @@ FUNC_ALIAS(_timer_start, nano_fiber_timer_start, void); /** * - * nano_task_timer_start - start a nanokernel timer from a task + * @brief Start a nanokernel timer from a task * * This function starts a previously initialized nanokernel timer object. * The timer will expire in system clock ticks. @@ -84,7 +84,7 @@ FUNC_ALIAS(_timer_start, nano_task_timer_start, void); /** * - * _timer_start - start a nanokernel timer (generic implementation) + * @brief Start a nanokernel timer (generic implementation) * * This function starts a previously initialized nanokernel timer object. * The timer will expire in system clock ticks. @@ -129,7 +129,7 @@ void _timer_start(struct nano_timer *timer, /* timer to start */ /** * - * _timer_stop - stop a nanokernel timer (generic implementation) + * @brief Stop a nanokernel timer (generic implementation) * * This function stops a previously started nanokernel timer object. * @@ -178,7 +178,7 @@ static void _timer_stop(struct nano_timer *timer /* timer to stop */ /** * - * nano_fiber_timer_stop - stop a nanokernel timer from a fiber + * @brief Stop a nanokernel timer from a fiber * * This function stops a previously started nanokernel timer object. * @@ -200,7 +200,7 @@ void nano_fiber_timer_stop(struct nano_timer *timer /* timer to stop */ /** * - * nano_task_timer_stop - stop a nanokernel timer from a task + * @brief Stop a nanokernel timer from a task * * This function stops a previously started nanokernel timer object. * @@ -222,7 +222,7 @@ void nano_task_timer_stop(struct nano_timer *timer /* timer to stop */ /** * - * nano_fiber_timer_test - make the current fiber check for a timer expiry + * @brief Make the current fiber check for a timer expiry * * This function will check if a timer has expired. The timer must * have been initialized by nano_timer_init() and started via either @@ -240,7 +240,7 @@ void *nano_fiber_timer_test(struct nano_timer *timer /* timer to check */ /** * - * nano_fiber_timer_wait - make the current fiber wait for a timer to expire + * @brief Make the current fiber wait for a timer to expire * * This function will pend on a timer if it hasn't expired yet. The timer must * have been initialized by nano_timer_init() and started via either @@ -259,7 +259,7 @@ void *nano_fiber_timer_wait(struct nano_timer *timer /* timer to pend on */ /** * - * nano_task_timer_test - make the current task check for a timer expiry + * @brief Make the current task check for a timer expiry * * This function will check if a timer has expired. The timer must * have been initialized by nano_timer_init() and started via either @@ -277,7 +277,7 @@ void *nano_task_timer_test(struct nano_timer *timer /* timer to check */ /** * - * nano_task_timer_wait - make the current task wait for a timer to expire + * @brief Make the current task wait for a timer to expire * * This function will pend on a timer if it hasn't expired yet. The timer must * have been initialized by nano_timer_init() and started via either diff --git a/kernel/nanokernel/version.c b/kernel/nanokernel/version.c index 7215ff1e216..ebd2d1f1b64 100644 --- a/kernel/nanokernel/version.c +++ b/kernel/nanokernel/version.c @@ -37,7 +37,7 @@ static uint32_t kernel_version = KERNELVERSION; /** * - * sys_kernel_version_get - return the kernel version of the present build + * @brief Return the kernel version of the present build * * The kernel version is a four-byte value, whose format is decribed in the * file "kernel_version.h". diff --git a/lib/libc/minimal/source/stdout/prf.c b/lib/libc/minimal/source/stdout/prf.c index ce72b00c0e6..f16b8af1f3b 100644 --- a/lib/libc/minimal/source/stdout/prf.c +++ b/lib/libc/minimal/source/stdout/prf.c @@ -502,7 +502,7 @@ static int _to_float(char *buf, uint32_t double_temp[], int full, int c, /** * - * _isdigit - is the input value an ASCII digit character? + * @brief Is the input value an ASCII digit character? * * This function provides a traditional implementation of the isdigit() * primitive that is footprint conversative, i.e. it does not utilize a diff --git a/lib/libc/minimal/source/string/string.c b/lib/libc/minimal/source/string/string.c index b2d81b969cf..cdd71374469 100644 --- a/lib/libc/minimal/source/string/string.c +++ b/lib/libc/minimal/source/string/string.c @@ -34,7 +34,7 @@ /** * - * strcpy - copy a string + * @brief Copy a string * * @return pointer to destination buffer */ @@ -56,7 +56,7 @@ char *strcpy(char *restrict d, const char *restrict s) /** * - * strncpy - copy part of a string + * @brief Copy part of a string * * @return pointer to destination buffer */ @@ -83,7 +83,7 @@ char *strncpy(char *restrict d, const char *restrict s, size_t n) /** * - * strchr - string scanning operation + * @brief String scanning operation * * @return pointer to 1st instance of found byte, or NULL if not found */ @@ -100,7 +100,7 @@ char *strchr(const char *s, int c) /** * - * strlen - get string length + * @brief Get string length * * @return number of bytes in string */ @@ -119,7 +119,7 @@ size_t strlen(const char *s) /** * - * strcmp - compare two strings + * @brief Compare two strings * * @return negative # if < , 0 if == , else positive # */ @@ -136,7 +136,7 @@ int strcmp(const char *s1, const char *s2) /** * - * strncmp - compare part of two strings + * @brief Compare part of two strings * * @return negative # if < , 0 if == , else positive # */ @@ -154,7 +154,7 @@ int strncmp(const char *s1, const char *s2, size_t n) /** * - * memcmp - compare two memory areas + * @brief Compare two memory areas * * @return negative # if < , 0 if == , else positive # */ @@ -177,7 +177,7 @@ int memcmp(const void *m1, const void *m2, size_t n) /** * - * memmove - copy bytes in memory with overlapping areas + * @brief Copy bytes in memory with overlapping areas * * @return pointer to destination buffer */ @@ -212,7 +212,7 @@ void *memmove(void *d, const void *s, size_t n) /** * - * memcpy - copy bytes in memory + * @brief Copy bytes in memory * * @return pointer to start of destination buffer */ @@ -262,7 +262,7 @@ void *memcpy(void *restrict d, const void *restrict s, size_t n) /** * - * memset - set bytes in memory + * @brief Set bytes in memory * * @return pointer to start of buffer */ diff --git a/misc/printk.c b/misc/printk.c index b0cd61bd791..223e63da893 100644 --- a/misc/printk.c +++ b/misc/printk.c @@ -48,7 +48,7 @@ static void _printk_hex_ulong(const unsigned long num); /** * - * _nop_char_out - default character output routine that does nothing + * @brief Default character output routine that does nothing * * @return 0 */ @@ -67,7 +67,7 @@ static int (*_char_out)(int) = _nop_char_out; /** * - * __printk_hook_install - install the character output routine for printk + * @brief Install the character output routine for printk * * To be called by the BSP's console driver at init time. Installs a routine * that outputs one ASCII character at a time. @@ -83,7 +83,7 @@ void __printk_hook_install(int (*fn)(int) /* putc routine to install */ /** * - * _vprintk - printk internals + * @brief Printk internals * * See printk() for description. * @@ -156,7 +156,7 @@ static inline void _vprintk(const char *fmt, /* format string */ /** * - * printk - output a string + * @brief Output a string * * Output a string on output installed by BSP at init time. Some printf-like * formatting is available. @@ -184,7 +184,7 @@ void printk(const char *fmt, /* formatted string to output */ /** * - * _printk_hex_ulong - output an unsigned long in hex format + * @brief Output an unsigned long in hex format * * 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. @@ -207,7 +207,7 @@ static void _printk_hex_ulong( /** * - * _printk_dec_ulong - output an unsigned long (32-bit) in decimal format + * @brief Output an unsigned long (32-bit) in decimal format * * Output an unsigned long on output installed by BSP at init time. Only works * with 32-bit values. @@ -238,7 +238,7 @@ static void _printk_dec_ulong( /** * - * printk - output a string + * @brief Output a string * * Debugging output is dropped if it is not to be sent to the console. * diff --git a/samples/include/irq_test_common.h b/samples/include/irq_test_common.h index 1ef4f2eb9f9..14f2924273d 100644 --- a/samples/include/irq_test_common.h +++ b/samples/include/irq_test_common.h @@ -107,7 +107,7 @@ struct isrInitInfo { /** * - * initIRQ - init interrupts + * @brief Init interrupts * */ diff --git a/samples/microkernel/apps/philosophers/src/phil_fiber.c b/samples/microkernel/apps/philosophers/src/phil_fiber.c index 06cb2f1f500..1e4aae41afa 100644 --- a/samples/microkernel/apps/philosophers/src/phil_fiber.c +++ b/samples/microkernel/apps/philosophers/src/phil_fiber.c @@ -63,7 +63,7 @@ kmutex_t forks[] = {forkMutex0, forkMutex1, forkMutex2, forkMutex3, forkMutex4, /** * - * myPrint - print a philosophers state + * @brief Print a philosophers state * * @param id Philosopher ID. * @param str EATING or THINKING. @@ -78,7 +78,7 @@ static void myPrint(int id, char *str) /** * - * myDelay - wait for a number of ticks to elapse + * @brief Wait for a number of ticks to elapse * * @param ticks Number of ticks to delay. * @@ -100,7 +100,7 @@ static void myDelay(int ticks) /** * - * philEntry - entry point to a philosopher's thread + * @brief Entry point to a philosopher's thread * * This routine runs as a task in the microkernel environment * and as a fiber in the nanokernel environment. diff --git a/samples/microkernel/apps/philosophers/src/phil_task.c b/samples/microkernel/apps/philosophers/src/phil_task.c index 65329c4f612..383009304bf 100644 --- a/samples/microkernel/apps/philosophers/src/phil_task.c +++ b/samples/microkernel/apps/philosophers/src/phil_task.c @@ -63,7 +63,7 @@ struct nano_sem forks[N_PHILOSOPHERS]; #ifdef CONFIG_NANOKERNEL /** * - * main - nanokernel entry point + * @brief Nanokernel entry point * * @return does not return */ @@ -95,7 +95,7 @@ int main(void) #else /** * - * philDemo - routine to start dining philosopher demo + * @brief Routine to start dining philosopher demo * * @return does not return */ diff --git a/samples/microkernel/benchmark/app_kernel/src/event_b.c b/samples/microkernel/benchmark/app_kernel/src/event_b.c index 20920987928..876d44b7844 100644 --- a/samples/microkernel/benchmark/app_kernel/src/event_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/event_b.c @@ -58,7 +58,7 @@ int example_handler (int event); /** * - * event_test - event signal speed test + * @brief Event signal speed test * * @return N/A * @@ -179,7 +179,7 @@ void event_test(void) /** * - * example_handler - event handler for the tests + * @brief Event handler for the tests * * The event handler for the test. Sets up nEventValue global variable. * This variable is used in the main test. diff --git a/samples/microkernel/benchmark/app_kernel/src/fifo_b.c b/samples/microkernel/benchmark/app_kernel/src/fifo_b.c index 209dcb56922..88cd8f50b88 100644 --- a/samples/microkernel/benchmark/app_kernel/src/fifo_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/fifo_b.c @@ -36,7 +36,7 @@ /** * - * queue_test - queue transfer speed test + * @brief Queue transfer speed test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/fifo_r.c b/samples/microkernel/benchmark/app_kernel/src/fifo_r.c index eb3144f2946..571556e3791 100644 --- a/samples/microkernel/benchmark/app_kernel/src/fifo_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/fifo_r.c @@ -38,7 +38,7 @@ /* queue transfer speed test */ /** * - * dequtask - data receive task + * @brief Data receive task * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c b/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c index 4426dfe82ef..195a7c85634 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/mailbox_b.c @@ -92,7 +92,7 @@ void mailbox_put(uint32_t size, int count, uint32_t *time); /** * - * mailbox_test - mailbox transfer speed test + * @brief Mailbox transfer speed test * * @return N/A * @@ -143,7 +143,7 @@ void mailbox_test(void) /** * - * mailbox_put - write the number of data chunks into the mailbox + * @brief Write the number of data chunks into the mailbox * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c b/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c index eaf1d785253..270a9e1bf3c 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/mailbox_r.c @@ -48,7 +48,7 @@ int mailbox_get(kmbox_t mailbox,int size,int count,unsigned int* time); /** * - * mailrecvtask - receive task + * @brief Receive task * * @return N/A * @@ -83,7 +83,7 @@ void mailrecvtask(void) /** * - * mailbox_get - receive data portions from the specified mailbox + * @brief Receive data portions from the specified mailbox * * @return 0 * diff --git a/samples/microkernel/benchmark/app_kernel/src/master.c b/samples/microkernel/benchmark/app_kernel/src/master.c index 167ccfb9fa4..b7ca657d472 100644 --- a/samples/microkernel/benchmark/app_kernel/src/master.c +++ b/samples/microkernel/benchmark/app_kernel/src/master.c @@ -63,7 +63,7 @@ uint32_t tm_off; /** * - * kbhit - check for keypress + * @brief Check for keypress * * @return 1 when a keyboard key is pressed, or 0 if no keyboard support * @@ -78,7 +78,7 @@ int kbhit(void) /** * - * init_output - prepares the test output + * @brief Prepares the test output * * @return N/A * @@ -101,7 +101,7 @@ void init_output(int *continuously, int *autorun) /** * - * output_close - close output for the test + * @brief Close output for the test * * @return N/A * @@ -118,7 +118,7 @@ void output_close(void) /** * - * BenchTask - perform all selected benchmarks + * @brief Perform all selected benchmarks * * @return N/A * @@ -173,7 +173,7 @@ void BenchTask(void) /** * - * dummy_test - dummy test + * @brief Dummy test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/memmap_b.c b/samples/microkernel/benchmark/app_kernel/src/memmap_b.c index 2b0fa7a538b..97ab0c6aedb 100644 --- a/samples/microkernel/benchmark/app_kernel/src/memmap_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/memmap_b.c @@ -38,7 +38,7 @@ /** * - * memorymap_test - memory map get/free test + * @brief Memory map get/free test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/mempool_b.c b/samples/microkernel/benchmark/app_kernel/src/mempool_b.c index a95ced8336c..a627c3a7265 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mempool_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/mempool_b.c @@ -36,7 +36,7 @@ /** * - * mempool_test - memory pool get/free test + * @brief Memory pool get/free test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/mutex_b.c b/samples/microkernel/benchmark/app_kernel/src/mutex_b.c index 84aa2a5c1c5..b09ee252cc0 100644 --- a/samples/microkernel/benchmark/app_kernel/src/mutex_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/mutex_b.c @@ -36,7 +36,7 @@ /** * - * mutex_test - mutex lock/unlock test + * @brief Mutex lock/unlock test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/nop_b.c b/samples/microkernel/benchmark/app_kernel/src/nop_b.c index bdcf320e848..30a85975efe 100644 --- a/samples/microkernel/benchmark/app_kernel/src/nop_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/nop_b.c @@ -40,7 +40,7 @@ extern void _task_nop(void); /** * - * call_test - Kernel entry timing test + * @brief Kernel entry timing test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/pipe_b.c b/samples/microkernel/benchmark/app_kernel/src/pipe_b.c index 6ca66887f1a..a5d8dfd9579 100644 --- a/samples/microkernel/benchmark/app_kernel/src/pipe_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/pipe_b.c @@ -109,7 +109,7 @@ int pipeput(kpipe_t pipe, K_PIPE_OPTION /** * - * pipe_test - test the pipes transfer speed + * @brief Test the pipes transfer speed * * @return N/A * @@ -204,7 +204,7 @@ void pipe_test(void) /** * - * pipeput - write a data portion to the pipe and measure time + * @brief Write a data portion to the pipe and measure time * * @return 0 on success, 1 on error * diff --git a/samples/microkernel/benchmark/app_kernel/src/pipe_r.c b/samples/microkernel/benchmark/app_kernel/src/pipe_r.c index 297dc98d4f9..1f2fc068c15 100644 --- a/samples/microkernel/benchmark/app_kernel/src/pipe_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/pipe_r.c @@ -49,7 +49,7 @@ int pipeget(kpipe_t pipe, K_PIPE_OPTION option, /** * - * piperecvtask - receive task + * @brief Receive task * * @return N/A * @@ -100,7 +100,7 @@ void piperecvtask(void) /** * - * pipeget - read a data portion from the pipe and measure time + * @brief Read a data portion from the pipe and measure time * * @return 0 on success, 1 on error * diff --git a/samples/microkernel/benchmark/app_kernel/src/receiver.c b/samples/microkernel/benchmark/app_kernel/src/receiver.c index 6151917de10..ca4f90eb96c 100644 --- a/samples/microkernel/benchmark/app_kernel/src/receiver.c +++ b/samples/microkernel/benchmark/app_kernel/src/receiver.c @@ -50,7 +50,7 @@ void piperecvtask(void); /** * - * recvtask - main function of the task that receives data in the test + * @brief Main function of the task that receives data in the test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/sema_b.c b/samples/microkernel/benchmark/app_kernel/src/sema_b.c index db59a4794a9..5ac7bc1c187 100644 --- a/samples/microkernel/benchmark/app_kernel/src/sema_b.c +++ b/samples/microkernel/benchmark/app_kernel/src/sema_b.c @@ -37,7 +37,7 @@ /** * - * sema_test - semaphore signal speed test + * @brief Semaphore signal speed test * * @return N/A * diff --git a/samples/microkernel/benchmark/app_kernel/src/sema_r.c b/samples/microkernel/benchmark/app_kernel/src/sema_r.c index c56590e4963..5b57abf92cd 100644 --- a/samples/microkernel/benchmark/app_kernel/src/sema_r.c +++ b/samples/microkernel/benchmark/app_kernel/src/sema_r.c @@ -39,7 +39,7 @@ /** * - * waittask - receive task (Wait task) + * @brief Receive task (Wait task) * * @return N/A * diff --git a/samples/microkernel/benchmark/boot_time/src/boot_time.c b/samples/microkernel/benchmark/boot_time/src/boot_time.c index 3d92a7f7241..fb99b457d9f 100644 --- a/samples/microkernel/benchmark/boot_time/src/boot_time.c +++ b/samples/microkernel/benchmark/boot_time/src/boot_time.c @@ -123,7 +123,7 @@ char __stack fiberStack[512]; /** * - * main - nanokernel entry point + * @brief Nanokernel entry point * * @return N/A */ diff --git a/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c b/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c index 0e79716f8db..ff71603b1f6 100644 --- a/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c +++ b/samples/microkernel/benchmark/footprint/src/microkernel_footprint.c @@ -130,7 +130,7 @@ static pfunc func_array[] = { /** * - * dummyIsr - dummy ISR + * @brief Dummy ISR * * @return N/A */ @@ -143,7 +143,7 @@ void dummyIsr(void *unused) #ifdef TEST_reg /** * - * isrDummyIntStub - static interrupt stub that invokes dummy ISR + * @brief Static interrupt stub that invokes dummy ISR * * NOTE: This is typically coded in assembly language, rather than C, * to avoid the preamble code the compiler automatically generates. However, @@ -164,7 +164,7 @@ static void isrDummyIntStub(void *unused) /** * - * fgTaskEntry - entry function for foreground task + * @brief Entry function for foreground task * * This routine prints a message, then simply increments a global counter. * (Gdb can be used to observe the counter as it increases.) diff --git a/samples/microkernel/benchmark/latency_measure/src/main.c b/samples/microkernel/benchmark/latency_measure/src/main.c index 0a6d39a77ee..1c59766c08f 100644 --- a/samples/microkernel/benchmark/latency_measure/src/main.c +++ b/samples/microkernel/benchmark/latency_measure/src/main.c @@ -46,7 +46,7 @@ int errorCount = 0; /* track number of errors */ /** * - * nanoTest - test latency of nanokernel + * @brief Test latency of nanokernel * * @return N/A * @@ -77,7 +77,7 @@ void nanoTest(void) #ifdef CONFIG_NANOKERNEL /** * - * main - nanokernel-only testing entry point + * @brief Nanokernel-only testing entry point * * @return N/A * @@ -104,7 +104,7 @@ void microTaskSwitchYield(void); /** * - * microTest - test latency of microkernel + * @brief Test latency of microkernel * * @return N/A * @@ -134,7 +134,7 @@ void microTest(void) /** * - * main - microkernel testing entry point + * @brief Microkernel testing entry point * * @return N/A * 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 1e7f1402c48..06cd278957d 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 @@ -48,7 +48,7 @@ static uint32_t timestamp; /** * - * latencyTestIsr - test ISR used to measure best case interrupt latency + * @brief Test ISR used to measure best case interrupt latency * * The interrupt handler gets the second timestamp. * @@ -67,7 +67,7 @@ static void latencyTestIsr(void *unused) /** * - * makeInt - interrupt preparation function + * @brief Interrupt preparation function * * Function makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. @@ -91,7 +91,7 @@ static void makeInt(void) /** * - * microIntToTask - the test main function + * @brief The test main function * * @return 0 on success * 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 4bce0a1d069..8e9f7949aed 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 @@ -50,7 +50,7 @@ static uint32_t timestamp = 0; /** * - * latencyTestIsr - test ISR used to measure best case interrupt latency + * @brief Test ISR used to measure best case interrupt latency * * The interrupt handler gets the second timestamp. * @@ -69,7 +69,7 @@ static void latencyTestIsr(void *unused) /** * - * microInt - software interrupt generating task + * @brief Software interrupt generating task * * Lower priority task that, when starts, wats for the semaphore. When gets * released by the main task, sets up the interrupt handler and generates the @@ -90,7 +90,7 @@ void microInt(void) /** * - * microIntToTaskEvt - the test main function + * @brief The test main function * * @return 0 on success * 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 92468a28cf1..c75e88b5c6a 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 @@ -55,7 +55,7 @@ static uint32_t timestamp; /** * - * microSemaLockUnlock - the function tests semaphore lock/unlock time + * @brief The function tests semaphore lock/unlock time * * The routine performs unlock the quite amount of semaphores and then * acquires them in order to measure the necessary time. @@ -105,7 +105,7 @@ int microSemaLockUnlock(void) /** * - * microMutexLockUnlock - test for the multiple mutex lock/unlock time + * @brief Test for the multiple mutex lock/unlock time * * The routine performs multiple mutex locks and then multiple mutex * unlocks to measure the necessary time. 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 57d727e867e..d7698048f21 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 @@ -52,7 +52,7 @@ static uint32_t helper_task_iterations = 0; /** * - * yieldingTask - helper task for measuring task switch latency using yield + * @brief Helper task for measuring task switch latency using yield * * This task is define in .mdef as SEMYIELDTSK * @@ -71,7 +71,7 @@ void yieldingTask(void) /** * - * microTaskSwitchYield - entry point for task context switch using yield test + * @brief Entry point for task context switch using yield test * * @return N/A * 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 56c93bb314c..db2a9845dd9 100644 --- a/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c +++ b/samples/microkernel/benchmark/latency_measure/src/nano_ctx_switch.c @@ -90,7 +90,7 @@ static void fiberOne(void) /** * - * fiberWaiter - check the time when it gets executed after the semaphore + * @brief Check the time when it gets executed after the semaphore * * Fiber starts, waits on semaphore. When the interrupt handler releases * the semaphore, fiber measures the time. @@ -112,7 +112,7 @@ static void fiberTwo(void) /** * - * nanoCtxSwitch - the test main function + * @brief The test main function * * @return 0 on success * diff --git a/samples/microkernel/benchmark/latency_measure/src/nano_int.c b/samples/microkernel/benchmark/latency_measure/src/nano_int.c index 88b2f4b2d5b..88ef50717c6 100644 --- a/samples/microkernel/benchmark/latency_measure/src/nano_int.c +++ b/samples/microkernel/benchmark/latency_measure/src/nano_int.c @@ -50,7 +50,7 @@ static uint32_t timestamp; /** * - * latencyTestIsr - test ISR used to measure best case interrupt latency + * @brief Test ISR used to measure best case interrupt latency * * The interrupt handler gets the second timestamp. * @@ -68,7 +68,7 @@ static void latencyTestIsr(void *unused) /** * - * fiberInt - interrupt preparation fiber + * @brief Interrupt preparation fiber * * Fiber makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. @@ -87,7 +87,7 @@ static void fiberInt(void) /** * - * nanoIntLatency - the test main function + * @brief The test main function * * @return 0 on success * 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 1389cab9786..b5ac6a71883 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 @@ -51,7 +51,7 @@ static uint32_t timestamp = 0; /** * - * nanoIntLockUnlock - the test main function + * @brief The test main function * * @return 0 on success * 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 29ccd126a3b..b4151fc1eb7 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 @@ -52,7 +52,7 @@ static uint32_t timestamp; /** * - * latencyTestIsr - test ISR used to measure best case interrupt latency + * @brief Test ISR used to measure best case interrupt latency * * The interrupt handler gets the second timestamp. * @@ -71,7 +71,7 @@ static void latencyTestIsr(void *unused) /** * - * fiberInt - interrupt preparation fiber + * @brief Interrupt preparation fiber * * Fiber makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. @@ -95,7 +95,7 @@ static void fiberInt(void) /** * - * nanoIntToFiber - the test main function + * @brief The test main function * * @return 0 on success * 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 eebd3167800..fad46c3e836 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 @@ -63,7 +63,7 @@ static uint32_t timestamp = 0; /** * - * latencyTestIsr - test ISR used to measure best case interrupt latency + * @brief Test ISR used to measure best case interrupt latency * * The interrupt handler gets the second timestamp. * @@ -82,7 +82,7 @@ static void latencyTestIsr(void *unused) /** * - * fiberInt - interrupt preparation fiber + * @brief Interrupt preparation fiber * * Fiber makes all the test preparations: registers the interrupt handler, * gets the first timestamp and invokes the software interrupt. @@ -101,7 +101,7 @@ static void fiberInt(void) /** * - * fiberWaiter - check the time when it gets executed after the semaphore + * @brief Check the time when it gets executed after the semaphore * * Fiber starts, waits on semaphore. When the interrupt handler releases * the semaphore, fiber measures the time. @@ -119,7 +119,7 @@ static void fiberWaiter(void) /** * - * nanoIntToFiberSem - the test main function + * @brief The test main function * * @return 0 on success * diff --git a/samples/microkernel/benchmark/latency_measure/src/raise_int.c b/samples/microkernel/benchmark/latency_measure/src/raise_int.c index df3d79d50aa..f7d244740e8 100644 --- a/samples/microkernel/benchmark/latency_measure/src/raise_int.c +++ b/samples/microkernel/benchmark/latency_measure/src/raise_int.c @@ -1390,7 +1390,7 @@ static void (*intFPtr[256])(void) = { /** * - * raiseInt - generate a software interrupt + * @brief Generate a software interrupt * * This routine will call one of the genInt functions based upon the * value passed to it (which is essentially the interrupt vector number). @@ -1409,7 +1409,7 @@ void raiseInt(uint8_t id) #include /** * - * raiseInt - generate a software interrupt + * @brief Generate a software interrupt * * Trigger via NVIC. is the IRQ number. * diff --git a/samples/microkernel/benchmark/latency_measure/src/utils.c b/samples/microkernel/benchmark/latency_measure/src/utils.c index d5c7807f316..6f49fa6b153 100644 --- a/samples/microkernel/benchmark/latency_measure/src/utils.c +++ b/samples/microkernel/benchmark/latency_measure/src/utils.c @@ -58,7 +58,7 @@ char tmpString[TMP_STRING_SIZE]; /** * - * initSwInterrupt - initialize the interrupt handler + * @brief Initialize the interrupt handler * * Function initializes the interrupt handler with the pointer to the function * provided as an argument. It sets up allocated interrupt vector, pointer to @@ -80,7 +80,7 @@ int initSwInterrupt(ptestIsr pIsrHdlr) /** * - * setSwInterrupt - set the new ISR for software interrupt + * @brief Set the new ISR for software interrupt * * The routine shange the ISR for the fully connected interrupt to the routine * provided. This routine can be invoked only after the interrupt has been @@ -99,7 +99,7 @@ void setSwInterrupt(ptestIsr pIsrHdlr) /** * - * raiseIntFunc - generate a software interrupt + * @brief Generate a software interrupt * * This routine will call one of the generate SW interrupt functions based upon * the current vector assigned by the initSwInterrupt() function. diff --git a/samples/microkernel/benchmark/latency_measure/src/utils.h b/samples/microkernel/benchmark/latency_measure/src/utils.h index 9bf35222f04..37ca0d3d38d 100644 --- a/samples/microkernel/benchmark/latency_measure/src/utils.h +++ b/samples/microkernel/benchmark/latency_measure/src/utils.h @@ -59,7 +59,7 @@ extern int errorCount; /** * - * printDashLine - print dash line + * @brief Print dash line * * @return N/A * @@ -116,7 +116,7 @@ typedef void (*ptestIsr) (void *unused); /** * - * initSwInterrupt - initialize the interrupt handler + * @brief Initialize the interrupt handler * * Function initializes the interrupt handler with the pointer to the function * provided as an argument. It sets up allocated interrupt vector, pointer to @@ -131,7 +131,7 @@ int initSwInterrupt(ptestIsr pIsrHdlr); /** * - * setSwInterrupt - set the new ISR for software interrupt + * @brief Set the new ISR for software interrupt * * The routine shange the ISR for the fully connected interrupt to the routine * provided. This routine can be invoked only after the interrupt has been diff --git a/samples/microkernel/test/test_critical/src/critical.c b/samples/microkernel/test/test_critical/src/critical.c index 2db0c6271eb..fe52a3b238b 100644 --- a/samples/microkernel/test/test_critical/src/critical.c +++ b/samples/microkernel/test/test_critical/src/critical.c @@ -47,7 +47,7 @@ static uint32_t altTaskIterations = 0; /** * - * criticalRtn - routine to be called from K_swapper() + * @brief Routine to be called from K_swapper() * * This routine increments the global variable . * @@ -66,7 +66,7 @@ int criticalRtn(void) /** * - * criticalLoop - common code for invoking task_offload_to_fiber() + * @brief Common code for invoking task_offload_to_fiber() * * @param count number of critical section calls made thus far * @@ -88,7 +88,7 @@ uint32_t criticalLoop(uint32_t count) /** * - * AlternateTask - alternate task + * @brief Alternate task * * This routine calls task_offload_to_fiber() many times. * @@ -112,7 +112,7 @@ void AlternateTask(void) /** * - * RegressionTask - regression task + * @brief Regression task * * This routine calls task_offload_to_fiber() many times. It also checks to * ensure that the number of times it is called matches the global variable diff --git a/samples/microkernel/test/test_events/src/events.c b/samples/microkernel/test/test_events/src/events.c index 0221f5b5427..a238a60ee1c 100644 --- a/samples/microkernel/test/test_events/src/events.c +++ b/samples/microkernel/test/test_events/src/events.c @@ -67,7 +67,7 @@ extern const int _k_num_events; /* non-public microkernel global variable */ /** * - * isr_event_signal_handler - ISR handler to signal an event + * @brief ISR handler to signal an event * * @return N/A */ @@ -81,7 +81,7 @@ void isr_event_signal_handler(void *data) /** * - * releaseTestFiber - release the test fiber + * @brief Release the test fiber * * @return N/A */ @@ -93,7 +93,7 @@ void releaseTestFiber(void) /** * - * microObjectsInit - initialize objects used in this microkernel test suite + * @brief Initialize objects used in this microkernel test suite * * @return N/A */ @@ -113,7 +113,7 @@ void microObjectsInit(void) /** * - * eventNoWaitTest - test the task_event_recv() API + * @brief Test the task_event_recv() API * * There are three cases to be tested here. The first is for testing an invalid * event. The second is for testing for an event when there is one. The third @@ -159,7 +159,7 @@ int eventNoWaitTest(void) /** * - * eventWaitTest - test the task_event_recv_wait() API + * @brief Test the task_event_recv_wait() API * * This test checks task_event_recv_wait() against the following cases: * 1. There is already an event waiting (signalled from a task and ISR). @@ -231,7 +231,7 @@ int eventWaitTest(void) /** * - * eventTimeoutTest - test the task_event_recv_wait_timeout() API + * @brief Test the task_event_recv_wait_timeout() API * * This test checks task_event_recv_wait_timeout() against the following cases: * 1. The current task times out while waiting for the event. @@ -282,7 +282,7 @@ int eventTimeoutTest(void) /** * - * isrEventSignalTest - test the isr_event_send() API + * @brief Test the isr_event_send() API * * Although other tests have done some testing using isr_event_send(), none * of them have demonstrated that signalling an event more than once does not @@ -324,7 +324,7 @@ int isrEventSignalTest(void) /** * - * fiberEventSignalTest - test the fiber_event_send() API + * @brief Test the fiber_event_send() API * * Signalling an event by fiber_event_send() more than once does not "queue" * events. That is, should two or more signals of the same event occur before @@ -361,7 +361,7 @@ int fiberEventSignalTest(void) /** * - * eventHandler - handler to run on EVENT_ID event + * @brief Handler to run on EVENT_ID event * * @param event signalled event * @@ -379,7 +379,7 @@ int eventHandler(int event) /** * - * altEventHandler - handler to run on ALT_EVENT event + * @brief Handler to run on ALT_EVENT event * * @param event signalled event * @@ -397,7 +397,7 @@ int altEventHandler(int event) /** * - * eventSignalHandlerTest - test the task_event_set_handler() API + * @brief Test the task_event_set_handler() API * * This test checks that the event handler is set up properly when * task_event_set_handler() is called. It shows that event handlers are tied @@ -520,7 +520,7 @@ int eventSignalHandlerTest(void) /** * - * AlternateTask - alternate task to signal various events to a waiting task + * @brief Alternate task to signal various events to a waiting task * * @return N/A */ @@ -558,7 +558,7 @@ void AlternateTask(void) /** * - * RegressionTask - main entry point to the test suite + * @brief Main entry point to the test suite * * @return N/A */ diff --git a/samples/microkernel/test/test_events/src/test_fiber.c b/samples/microkernel/test/test_events/src/test_fiber.c index 86dc95edd9d..33d96e3c1fb 100644 --- a/samples/microkernel/test/test_events/src/test_fiber.c +++ b/samples/microkernel/test/test_events/src/test_fiber.c @@ -51,7 +51,7 @@ static char __stack fiberStack[FIBER_STACK_SIZE]; /* test fiber stack size */ /** * - * testFiberEntry - the test fiber entry function + * @brief The test fiber entry function * * Fiber waits on the semaphore controlled by the test task * It signals the event for the eventWaitTest() function @@ -84,7 +84,7 @@ static void testFiberEntry(void) /** * - * testFiberInit - initializes variables and starts the test fiber + * @brief Initializes variables and starts the test fiber * * @return N/A */ diff --git a/samples/microkernel/test/test_fifo/src/fifo.c b/samples/microkernel/test/test_fifo/src/fifo.c index 8fcb9ed6a46..8ac43c2ac0b 100644 --- a/samples/microkernel/test/test_fifo/src/fifo.c +++ b/samples/microkernel/test/test_fifo/src/fifo.c @@ -64,7 +64,7 @@ static int tcRC = TC_PASS; /* test case return code */ /** * - * initMyData - initialize data array + * @brief Initialize data array * * This routine initializes the myData array used in the FIFO tests. * @@ -80,7 +80,7 @@ void initMyData(void) /** * - * printMyData - print data array + * @brief Print data array * * This routine prints myData array. * @@ -97,7 +97,7 @@ void printMyData(void) /** * - * verifyRetValue - verify return value + * @brief Verify return value * * This routine verifies current value against expected value * and returns true if they are the same. @@ -115,7 +115,7 @@ bool verifyRetValue(int expectRetValue, int currentRetValue) /** * - * initMicroObjects - initialize microkernel objects + * @brief Initialize microkernel objects * * This routine initializes the microkernel objects used in the FIFO tests. * @@ -130,7 +130,7 @@ void initMicroObjects(void) /** * - * fillFIFO - fills up the FIFO queue + * @brief Fills up the FIFO queue * * This routine fills the FIFO queue with myData array. This assumes the * queue is empty before we put in elements. @@ -187,7 +187,7 @@ exitTest3: /** * - * MicroTestFifoTask - task to test FIFO queue + * @brief Task to test FIFO queue * * This routine is run in three context switches: * - it puts an element to the FIFO queue @@ -272,7 +272,7 @@ exitTest4: /** * - * verifyQueueData - Verifies data in queue is correct + * @brief Verifies data in queue is correct * * This routine assumes that the queue is full when this function is called. * It counts the number of elements in the queue, dequeues elements and verifies @@ -350,7 +350,7 @@ exitTest2: /** * - * RegressionTask - main task to test FIFO queue + * @brief Main task to test FIFO queue * * This routine initializes data, fills the FIFO queue and verifies the * data in the queue is in correct order when items are being dequeued. 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 e286a2254a9..f14726e7ec2 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 @@ -42,7 +42,7 @@ /** * - * _LoadAllFloatRegisters - load all floating point registers + * @brief Load all floating point registers * * This function loads ALL floating point registers from the memory buffer * specified by . It is expected that a subsequent call to @@ -111,7 +111,7 @@ static inline void _LoadAllFloatRegisters(FP_REG_SET *pFromBuffer) /** * - * _LoadThenStoreAllFloatRegisters - load then dump all float registers to memory + * @brief Load then dump all float registers to memory * * This function loads ALL floating point registers from the memory buffer * specified by , and then stores them back to that buffer. @@ -166,7 +166,7 @@ static inline void _LoadThenStoreAllFloatRegisters(FP_REG_SET *pFromToBuffer) /** * - * _StoreAllFloatRegisters - dump all floating point registers to memory + * @brief Dump all floating point registers to memory * * This function stores ALL floating point registers to the memory buffer * specified by . It is expected that a previous invocation of @@ -203,7 +203,7 @@ static inline void _StoreAllFloatRegisters(FP_REG_SET *pToBuffer) /** * - * _StoreNonVolatileFloatRegisters - dump non-volatile FP registers to memory + * @brief Dump non-volatile FP registers to memory * * This routine is called by a high priority context after resuming execution * from calling a primitive that will pend and thus result in a co-operative diff --git a/samples/microkernel/test/test_fp_sharing/src/main.c b/samples/microkernel/test/test_fp_sharing/src/main.c index 08503423bbc..9e1e779feaf 100644 --- a/samples/microkernel/test/test_fp_sharing/src/main.c +++ b/samples/microkernel/test/test_fp_sharing/src/main.c @@ -140,7 +140,7 @@ static volatile unsigned int load_store_high_count = 0; /** * * main - - * load_store_low - low priority FPU load/store context + * @brief Low priority FPU load/store context * * @return N/A */ @@ -308,7 +308,7 @@ void load_store_low(void) /** * - * load_store_high - high priority FPU load/store context + * @brief High priority FPU load/store context * * @return N/A */ diff --git a/samples/microkernel/test/test_fp_sharing/src/pi.c b/samples/microkernel/test/test_fp_sharing/src/pi.c index c9d13133d82..4cc04221310 100644 --- a/samples/microkernel/test/test_fp_sharing/src/pi.c +++ b/samples/microkernel/test/test_fp_sharing/src/pi.c @@ -75,7 +75,7 @@ static volatile unsigned int calc_pi_high_count = 0; /** * - * calculate_pi_low - entry point for the low priority pi compute task + * @brief Entry point for the low priority pi compute task * * @return N/A */ @@ -118,7 +118,7 @@ void calculate_pi_low(void) /** * - * calculate_pi_high - entry point for the high priority pi compute task + * @brief Entry point for the high priority pi compute task * * @return N/A */ diff --git a/samples/microkernel/test/test_libs/src/libraries.c b/samples/microkernel/test/test_libs/src/libraries.c index 8402d9e9903..d556659fdbc 100644 --- a/samples/microkernel/test/test_libs/src/libraries.c +++ b/samples/microkernel/test/test_libs/src/libraries.c @@ -59,7 +59,7 @@ volatile long longOne = 1L; /** * - * limitsTest - test implementation-defined constants library + * @brief Test implementation-defined constants library * * @return TC_PASS or TC_FAIL */ @@ -77,7 +77,7 @@ int limitsTest(void) /** * - * stdboolTest - test boolean types and values library + * @brief Test boolean types and values library * * @return TC_PASS or TC_FAIL */ @@ -103,7 +103,7 @@ volatile size_t sizeOfLongVariable = sizeof(longVariable); /** * - * stddefTest - test standard type definitions library + * @brief Test standard type definitions library * * @return TC_PASS or TC_FAIL */ @@ -129,7 +129,7 @@ volatile uint32_t unsignedInt = 0xffffff00; /** * - * stdintTest - test integer types library + * @brief Test integer types library * * @return TC_PASS or TC_FAIL */ @@ -155,7 +155,7 @@ char buffer[BUFSIZE]; /** * - * memset_test - test string memset + * @brief Test string memset * * @return TC_PASS or TC_FAIL */ @@ -176,7 +176,7 @@ int memset_test(void) /** * - * strlen_test - test string length function + * @brief Test string length function * * @return TC_PASS or TC_FAIL */ @@ -198,7 +198,7 @@ int strlen_test(void) /** * - * strcmp_test - test string compare function + * @brief Test string compare function * * @return TC_PASS or TC_FAIL */ @@ -236,7 +236,7 @@ int strcmp_test(void) /** * - * strncmp_test - test string N compare function + * @brief Test string N compare function * * @return TC_PASS or TC_FAIL */ @@ -275,7 +275,7 @@ int strncmp_test(void) /** * - * strcpy_test - test string copy function + * @brief Test string copy function * * @return TC_PASS or TC_FAIL */ @@ -298,7 +298,7 @@ int strcpy_test(void) /** * - * strncpy_test - test string N copy function + * @brief Test string N copy function * * @return TC_PASS or TC_FAIL */ @@ -322,7 +322,7 @@ int strncpy_test(void) /** * - * strchr_test - test string scanning function + * @brief Test string scanning function * * @return TC_PASS or TC_FAIL */ @@ -353,7 +353,7 @@ int strchr_test(void) /** * - * memcmp_test - test memory comparison function + * @brief Test memory comparison function * * @return TC_PASS or TC_FAIL */ @@ -381,7 +381,7 @@ int memcmp_test(void) /** * - * stringTest - test string operations library + * @brief Test string operations library * * @return TC_PASS or TC_FAIL */ @@ -400,7 +400,7 @@ int stringTest(void) /** * - * RegressionTask - main task in the test suite + * @brief Main task in the test suite * * This is the entry point to the main task used by the standard libraries test * suite. It tests each library in turn until a failure is detected or all diff --git a/samples/microkernel/test/test_libs/src/main.c b/samples/microkernel/test/test_libs/src/main.c index 679a21578bb..744e66b57d0 100644 --- a/samples/microkernel/test/test_libs/src/main.c +++ b/samples/microkernel/test/test_libs/src/main.c @@ -63,7 +63,7 @@ static ksem_t resultSems[] = { SEM_TASKDONE, SEM_TASKFAIL, ENDLIST }; /** * - * RegressionTaskEntry - entry point for RegressionTask + * @brief Entry point for RegressionTask * * This routine signals "task done" or "task fail", based on the return code of * RegressionTask. @@ -80,7 +80,7 @@ void RegressionTaskEntry(void) /** * - * MonitorTaskEntry - entry point for MonitorTask + * @brief Entry point for MonitorTask * * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. diff --git a/samples/microkernel/test/test_mail/src/mail.c b/samples/microkernel/test/test_mail/src/mail.c index 57e9a323d01..0294fd8fb01 100644 --- a/samples/microkernel/test/test_mail/src/mail.c +++ b/samples/microkernel/test/test_mail/src/mail.c @@ -86,7 +86,7 @@ extern kmemory_pool_t smallBlkszPool; /** * - * setMsg_Sender - sets various fields in the message for the sender + * @brief Sets various fields in the message for the sender * * Sets the following fields in the message: * rx_task to receiverTask - destination for the message @@ -114,7 +114,7 @@ static void setMsg_Sender(struct k_msg *inMsg, kmbox_t inMbox, ktask_t receiverT /** * - * setMsg_Receiver - sets various fields in the message for the receiver + * @brief Sets various fields in the message for the receiver * * Sets the following fields in the message: * rx_data to NULL - to allow message transfer to occur @@ -145,7 +145,7 @@ static void setMsg_Receiver(struct k_msg *inMsg, kmbox_t inMbox, ktask_t senderT /** * - * setMsg_RecvBuf - sets rx_data field in msg and clears buffer + * @brief Sets rx_data field in msg and clears buffer * * @param inMsg The message being received. * @param inBuffer Incoming data area. @@ -165,7 +165,7 @@ static void setMsg_RecvBuf(struct k_msg *inMsg, char *inBuffer, uint32_t inBuffe /** * - * MsgSenderTask - task that tests sending of mailbox messages + * @brief Task that tests sending of mailbox messages * * This routine exercises the task_mbox_put[_wait[_timeout]] APIs. * @@ -360,7 +360,7 @@ int MsgSenderTask(void) /** * - * MsgRcvrTask - task that tests receiving of mailbox messages + * @brief Task that tests receiving of mailbox messages * * This routine exercises the task_mbox_get[_wait[_timeout]] and task_mbox_data_get[xxx] APIs. * diff --git a/samples/microkernel/test/test_mail/src/main.c b/samples/microkernel/test/test_mail/src/main.c index 5c705a729fc..8c7830a0bbc 100644 --- a/samples/microkernel/test/test_mail/src/main.c +++ b/samples/microkernel/test/test_mail/src/main.c @@ -71,7 +71,7 @@ kmemory_pool_t smallBlkszPool = SMALLBLKSZPOOL; /** * - * MsgSenderTaskEntry - entry point for MsgSenderTask + * @brief Entry point for MsgSenderTask * * This routine signals "task done" or "task fail", based on the return code of * MsgSenderTask. @@ -88,7 +88,7 @@ void MsgSenderTaskEntry(void) /** * - * MsgRcvrTaskEntry - entry point for MsgRcvrTask + * @brief Entry point for MsgRcvrTask * * This routine signals "task done" or "task fail", based on the return code of * MsgRcvrTask. @@ -105,7 +105,7 @@ void MsgRcvrTaskEntry(void) /** * - * MonitorTaskEntry - entry point for MonitorTask + * @brief Entry point for MonitorTask * * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. diff --git a/samples/microkernel/test/test_map/src/map.c b/samples/microkernel/test/test_map/src/map.c index a29df5a9674..cfae858544c 100644 --- a/samples/microkernel/test/test_map/src/map.c +++ b/samples/microkernel/test/test_map/src/map.c @@ -62,7 +62,7 @@ int testMapFreeAllBlocks(void **P); /** * - * verifyRetValue - verify return value + * @brief Verify return value * * This routine verifies current value against expected value * and returns true if they are the same. @@ -81,7 +81,7 @@ bool verifyRetValue(int expectRetValue, int currentRetValue) /** * - * HelperTask - helper task + * @brief Helper task * * This routine gets all blocks from the memory map. It uses semaphores * SEM_REGRESDONE and SEM_HELPERDONE to synchronize between different parts @@ -143,7 +143,7 @@ exitTest1: /** * - * testMapGetAllBlocks - get all blocks from the memory map + * @brief Get all blocks from the memory map * * Get all blocks from the memory map. It also tries to get one more block * from the map after the map is empty to verify the error return code. @@ -215,7 +215,7 @@ int testMapGetAllBlocks(void **p) /** * - * testMapFreeAllBlocks - free all memeory blocks + * @brief Free all memeory blocks * * This routine frees all memory blocks and also verifies that the number of * blocks used are correct. @@ -275,7 +275,7 @@ int testMapFreeAllBlocks(void **p) /** * - * printPointers - print the pointers + * @brief Print the pointers * * This routine prints out the pointers. * @@ -297,7 +297,7 @@ void printPointers(void **pointer) /** * - * RegressionTask - main task to test task_mem_map_xxx interfaces + * @brief Main task to test task_mem_map_xxx interfaces * * This routine calls testMapGetAllBlocks() to get all memory blocks from the * map and calls testMapFreeAllBlocks() to free all memory blocks. It also diff --git a/samples/microkernel/test/test_mutex/src/mutex.c b/samples/microkernel/test/test_mutex/src/mutex.c index b3ca68489e2..1607c4b4ced 100644 --- a/samples/microkernel/test/test_mutex/src/mutex.c +++ b/samples/microkernel/test/test_mutex/src/mutex.c @@ -237,7 +237,7 @@ void Task45(void) /** * - * RegressionTask - main task to test task_mutex_xxx interfaces + * @brief Main task to test task_mutex_xxx interfaces * * This task will lock on Mutex1, Mutex2, Mutex3 and Mutex4. * diff --git a/samples/microkernel/test/test_pipe/src/main.c b/samples/microkernel/test/test_pipe/src/main.c index 38674e617db..d1cd05fb973 100644 --- a/samples/microkernel/test/test_pipe/src/main.c +++ b/samples/microkernel/test/test_pipe/src/main.c @@ -65,7 +65,7 @@ kpipe_t pipeId = PIPE_ID; /** * - * RegressionTaskEntry - entry point for RegressionTask + * @brief Entry point for RegressionTask * * This routine signals "task done" or "task fail", based on the return code of * RegressionTask. @@ -82,7 +82,7 @@ void RegressionTaskEntry(void) /** * - * AlternateTaskEntry - entry point for AlternateTask + * @brief Entry point for AlternateTask * * This routine signals "task done" or "task fail", based on the return code of * AlternateTask. @@ -99,7 +99,7 @@ void AlternateTaskEntry(void) /** * - * MonitorTaskEntry - entry point for MonitorTask + * @brief Entry point for MonitorTask * * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. diff --git a/samples/microkernel/test/test_pipe/src/pipe.c b/samples/microkernel/test/test_pipe/src/pipe.c index 2fb2d905863..065d4d7edbb 100644 --- a/samples/microkernel/test/test_pipe/src/pipe.c +++ b/samples/microkernel/test/test_pipe/src/pipe.c @@ -158,7 +158,7 @@ extern kpipe_t pipeId; /** * - * microObjectsInit - initialize objects used in this microkernel test suite + * @brief Initialize objects used in this microkernel test suite * * @return N/A */ @@ -174,7 +174,7 @@ void microObjectsInit(void) /** * - * receiveBufferCheck - check the contents of the receive buffer + * @brief Check the contents of the receive buffer * * @param buffer pointer to buffer to check * @param size number of bytes to check @@ -197,7 +197,7 @@ int receiveBufferCheck(char *buffer, int size) /** * - * pipePutHelperWork - helper routine to pipePutTest() + * @brief Helper routine to pipePutTest() * * @param singleItems testcase list (one item in the pipe) * @param nSingles number of items in testcase @@ -297,7 +297,7 @@ int pipePutHelperWork(SIZE_EXPECT *singleItems, int nSingles, /** * - * pipePutHelper - helper routine to pipePutTest() + * @brief Helper routine to pipePutTest() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -332,7 +332,7 @@ int pipePutHelper(void) /** * - * pipePutTestWork - test task_pipe_put() + * @brief Test task_pipe_put() * * This routine tests the task_pipe_put() API. * @@ -421,7 +421,7 @@ int pipePutTestWork(SIZE_EXPECT *singleItems, int nSingles, /** * - * pipePutTest - test task_pipe_put() + * @brief Test task_pipe_put() * * This routine tests the task_pipe_put() API. * @@ -458,7 +458,7 @@ int pipePutTest(void) /** * - * pipePutWaitHelper - help test task_pipe_put_wait() + * @brief Help test task_pipe_put_wait() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -522,7 +522,7 @@ int pipePutWaitHelper(void) /** * - * pipePutWaitTest - test task_pipe_put_wait() + * @brief Test task_pipe_put_wait() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -582,7 +582,7 @@ int pipePutWaitTest(void) /** * - * pipePutTimeoutHelper - test task_pipe_get_wait_timeout() + * @brief Test task_pipe_get_wait_timeout() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -646,7 +646,7 @@ int pipePutTimeoutHelper(void) /** * - * pipePutTimeoutTest - test task_pipe_put_wait_timeout() + * @brief Test task_pipe_put_wait_timeout() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -726,7 +726,7 @@ int pipePutTimeoutTest(void) /** * - * pipeGetTest - routine to test task_pipe_get() + * @brief Routine to test task_pipe_get() * * This routine tests the task_pipe_get() API. Some of this functionality * has already been tested while testing task_pipe_put(). As a result, the @@ -775,7 +775,7 @@ int pipeGetTest(void) /** * - * pipeGetWaitHelperWork - test task_pipe_get_wait() + * @brief Test task_pipe_get_wait() * * @param items testcase list for task_pipe_get_wait() * @param nItems number of items in list @@ -812,7 +812,7 @@ int pipeGetWaitHelperWork(SIZE_EXPECT *items, int nItems) /** * - * pipeGetWaitHelper - test task_pipe_get_wait() + * @brief Test task_pipe_get_wait() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -840,7 +840,7 @@ int pipeGetWaitHelper(void) /** * - * pipeGetWaitTestWork - test task_pipe_get_wait() + * @brief Test task_pipe_get_wait() * * @param items testcase list for task_pipe_get_wait() * @param nItems number of items in list @@ -876,7 +876,7 @@ int pipeGetWaitTestWork(SIZE_EXPECT *items, int nItems) /** * - * pipeGetWaitTest - test task_pipe_get_wait() + * @brief Test task_pipe_get_wait() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -912,7 +912,7 @@ int pipeGetWaitTest(void) /** * - * pipeGetTimeoutTest - test remaining task_pipe_get_wait_timeout() functionality + * @brief Test remaining task_pipe_get_wait_timeout() functionality * * @return TC_PASS on success, TC_FAIL on failure */ @@ -942,7 +942,7 @@ int pipeGetTimeoutTest(void) /** * - * AlternateTask - alternate task in the test suite + * @brief Alternate task in the test suite * * This routine runs at a lower priority than RegressionTask(). * @@ -989,7 +989,7 @@ int AlternateTask(void) /** * - * RegressionTask - main task in the test suite + * @brief Main task in the test suite * * This is the entry point to the pipe test suite. * diff --git a/samples/microkernel/test/test_pool/src/pool.c b/samples/microkernel/test/test_pool/src/pool.c index 301695cd280..de3d4839254 100644 --- a/samples/microkernel/test/test_pool/src/pool.c +++ b/samples/microkernel/test/test_pool/src/pool.c @@ -111,7 +111,7 @@ static TEST_CASE defrag[] = { /** * - * blockCompare - compare the two blocks + * @brief Compare the two blocks * * @return 0 if the same, non-zero if not the same */ @@ -135,7 +135,7 @@ int blockCompare(struct k_block *b1, struct k_block *b2) /** * - * poolBlockGetFunc - wrapper for task_mem_pool_alloc() + * @brief Wrapper for task_mem_pool_alloc() * * @return task_mem_pool_alloc() return value */ @@ -150,7 +150,7 @@ int poolBlockGetFunc(struct k_block *block, kmemory_pool_t pool, int size, /** * - * poolBlockGetWFunc - wrapper for task_mem_pool_alloc_wait() + * @brief Wrapper for task_mem_pool_alloc_wait() * * @return task_mem_pool_alloc_wait() return value */ @@ -165,7 +165,7 @@ int poolBlockGetWFunc(struct k_block *block, kmemory_pool_t pool, int size, /** * - * poolBlockGetWTFunc - wrapper for task_mem_pool_alloc_wait_timeout() + * @brief Wrapper for task_mem_pool_alloc_wait_timeout() * * @return task_mem_pool_alloc_wait_timeout() return value */ @@ -178,7 +178,7 @@ int poolBlockGetWTFunc(struct k_block *block, kmemory_pool_t pool, /** * - * freeBlocks - free any blocks allocated in the test set + * @brief Free any blocks allocated in the test set * * @return N/A */ @@ -196,7 +196,7 @@ void freeBlocks(TEST_CASE *tests, int nTests) /** * - * poolBlockGetWork - perform the work of getting blocks + * @brief Perform the work of getting blocks * * @return TC_PASS on success, TC_FAIL on failure */ @@ -223,7 +223,7 @@ int poolBlockGetWork(char *string, poolBlockGetFunc_t func, /** * - * poolBlockGetTest - test the task_mem_pool_alloc() API + * @brief Test the task_mem_pool_alloc() API * * The pool is 4 kB in size. * @@ -258,7 +258,7 @@ int poolBlockGetTest(void) /** * - * HelperTask - helper task to poolBlockGetTimeoutTest() + * @brief Helper task to poolBlockGetTimeoutTest() * * @return N/A */ @@ -273,7 +273,7 @@ void HelperTask(void) /** * - * poolBlockGetTimeoutTest - test task_mem_pool_alloc_wait_timeout() + * @brief Test task_mem_pool_alloc_wait_timeout() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -368,7 +368,7 @@ int poolBlockGetWaitTest(void) /** * - * DefragTask - task responsible for defragmenting the pool POOL_ID + * @brief Task responsible for defragmenting the pool POOL_ID * * @return N/A */ @@ -433,7 +433,7 @@ int poolDefragTest(void) /** * - * AlternateTask - alternate task in the test suite + * @brief Alternate task in the test suite * * This routine runs at a lower priority than RegressionTask(). * @@ -453,7 +453,7 @@ void AlternateTask(void) /** * - * RegressionTask - main task in the test suite + * @brief Main task in the test suite * * This is the entry point to the memory pool test suite. * diff --git a/samples/microkernel/test/test_rand32/src/test-rand32.c b/samples/microkernel/test/test_rand32/src/test-rand32.c index d52e5cde391..b2d896757b4 100644 --- a/samples/microkernel/test/test_rand32/src/test-rand32.c +++ b/samples/microkernel/test/test_rand32/src/test-rand32.c @@ -43,7 +43,7 @@ /** * - * RegressionTaskEntry - regression test's entry point + * @brief Regression test's entry point * * * @return N/A diff --git a/samples/microkernel/test/test_sema/src/main.c b/samples/microkernel/test/test_sema/src/main.c index 47908589fe2..5974b21c1f3 100644 --- a/samples/microkernel/test/test_sema/src/main.c +++ b/samples/microkernel/test/test_sema/src/main.c @@ -93,7 +93,7 @@ static vvfn _trigger_isrSemaSignal = (vvfn) sw_isr_trigger_0; /** * - * RegressionTaskEntry - entry point for RegressionTask + * @brief Entry point for RegressionTask * * This routine signals "task done" or "task fail", based on the return code of * RegressionTask. @@ -110,7 +110,7 @@ void RegressionTaskEntry(void) /** * - * AlternateTaskEntry - entry point for AlternateTask + * @brief Entry point for AlternateTask * * This routine signals "task done" or "task fail", based on the return code of * MsgRcvrTask. @@ -127,7 +127,7 @@ void AlternateTaskEntry(void) /** * - * HighPriTaskEntry - entry point for HighPriTask + * @brief Entry point for HighPriTask * * This routine signals "task done" or "task fail", based on the return code of * HighPriTask. @@ -144,7 +144,7 @@ void HighPriTaskEntry(void) /** * - * LowPriTaskEntry - entry point for LowPriTask + * @brief Entry point for LowPriTask * * This routine signals "task done" or "task fail", based on the return code of * LowPriTask. @@ -161,7 +161,7 @@ void LowPriTaskEntry(void) /** * - * testIsrHandler - ISR that gives specified semaphore + * @brief ISR that gives specified semaphore * * @param isrData pointer to semaphore to be given * @@ -175,7 +175,7 @@ static void testIsrHandler(void *isrData) /** * - * trigger_isrSemaSignal - generate interrupt that gives specified semaphore + * @brief Generate interrupt that gives specified semaphore * * @param semaphore semaphore to be given * @@ -190,7 +190,7 @@ void trigger_isrSemaSignal(ksem_t semaphore) /** * - * releaseTestFiber - release the test fiber + * @brief Release the test fiber * * @return N/A */ @@ -202,7 +202,7 @@ void releaseTestFiber(void) /** * - * testInterruptsInit - initialize interrupt-related code + * @brief Initialize interrupt-related code * * Binds an ISR to the interrupt vector used to give semaphores from interrupt * level. @@ -222,7 +222,7 @@ static void testInterruptsInit(void) /** * - * MonitorTaskEntry - entry point for MonitorTask + * @brief Entry point for MonitorTask * * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. diff --git a/samples/microkernel/test/test_sema/src/sema.c b/samples/microkernel/test/test_sema/src/sema.c index 6cbf895531d..9cda1503836 100644 --- a/samples/microkernel/test/test_sema/src/sema.c +++ b/samples/microkernel/test/test_sema/src/sema.c @@ -72,7 +72,7 @@ extern ksem_t semList[]; /** * - * simpleSemaTest - signal semaphore that has no waiting tasks from ISR + * @brief Signal semaphore that has no waiting tasks from ISR * * @return TC_PASS on success, TC_FAIL on failure */ @@ -165,7 +165,7 @@ int simpleSemaTest(void) /** * - * simpleSemaWaitTest - test the waiting of a semaphore + * @brief Test the waiting of a semaphore * * @return TC_PASS on success, TC_FAIL on failure */ @@ -223,7 +223,7 @@ int simpleSemaWaitTest(void) /** * - * simpleGroupTest - test for a group of semaphores + * @brief Test for a group of semaphores * * @return TC_PASS on success, TC_FAIL on failure */ @@ -303,7 +303,7 @@ int simpleGroupTest(void) /** * - * simpleGroupWaitTest - test a group of semaphores with waiting + * @brief Test a group of semaphores with waiting * * 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. @@ -366,7 +366,7 @@ int simpleGroupWaitTest(void) /** * - * simpleFiberSemTest - test semaphore signaling from fiber + * @brief Test semaphore signaling from fiber * * Routine starts a fiber and does the following tests: * - fiber signals the semaphore N times, task checks that task_sem_count_get is N @@ -421,7 +421,7 @@ static int simpleFiberSemTest(void) /** * - * HighPriTask - a high priority task + * @brief A high priority task * * @return TC_PASS or TC_FAIL */ @@ -455,7 +455,7 @@ int HighPriTask(void) /** * - * LowPriTask - a low priority task + * @brief A low priority task * * @return TC_PASS or TC_FAIL */ @@ -480,7 +480,7 @@ int LowPriTask(void) /** * - * AlternateTask - alternate task in the test suite + * @brief Alternate task in the test suite * * This routine runs at a lower priority than RegressionTask(). * @@ -559,7 +559,7 @@ int AlternateTask(void) /** * - * RegressionTask - entry point to semaphore test suite + * @brief Entry point to semaphore test suite * * This is the entry point to the semaphore test suite. * diff --git a/samples/microkernel/test/test_sema/src/test_fiber.c b/samples/microkernel/test/test_sema/src/test_fiber.c index 56906091e3c..9e1f2e81fa7 100644 --- a/samples/microkernel/test/test_sema/src/test_fiber.c +++ b/samples/microkernel/test/test_sema/src/test_fiber.c @@ -57,7 +57,7 @@ static CMD_PKT_SET_INSTANCE(cmdPktSet, N_TESTS + 1) /** * - * testFiberEntry - the test fiber entry function + * @brief The test fiber entry function * * Fiber waits on the semaphore controlled by the test task * It signals the semaphore, the testing task waits for, @@ -90,7 +90,7 @@ static void testFiberEntry(void) /** * - * testFiberInit - initializes variables and starts the test fiber + * @brief Initializes variables and starts the test fiber * * @return N/A */ diff --git a/samples/microkernel/test/test_sprintf/src/test_sprintf.c b/samples/microkernel/test/test_sprintf/src/test_sprintf.c index 01bd2b4497c..2cbc63249ed 100644 --- a/samples/microkernel/test/test_sprintf/src/test_sprintf.c +++ b/samples/microkernel/test/test_sprintf/src/test_sprintf.c @@ -75,7 +75,7 @@ typedef union { #ifdef CONFIG_FLOAT /** * - * sprintfDoubleTest - test sprintf with doubles + * @brief Test sprintf with doubles * * @return TC_PASS on success, TC_FAIL otherwise */ @@ -231,7 +231,7 @@ int sprintfDoubleTest(void) /** * - * tvsnprintf - a test wrapper for vsnprintf() + * @brief A test wrapper for vsnprintf() */ int tvsnprintf(char *s, size_t len, const char *format, ...) @@ -248,7 +248,7 @@ int tvsnprintf(char *s, size_t len, const char *format, ...) /** * - * vsnprintfTest - test the vsprintf() routine + * @brief Test the vsprintf() routine * * This routine does not aim to test the same underlying functionality as * sprintfTest(). Instead it tries to limit it to functionality specific to @@ -319,7 +319,7 @@ int vsnprintfTest(void) /** * - * tvsprintf - a test wrapper for vsprintf() + * @brief A test wrapper for vsprintf() */ int tvsprintf(char *s, const char *format, ...) @@ -336,7 +336,7 @@ int tvsprintf(char *s, const char *format, ...) /** * - * vsprintfTest - test the vsprintf() routine + * @brief Test the vsprintf() routine * * This routine does not aim to test the same underlying functionality as * sprintfTest(). Instead it tries to limit it to functionality specific to @@ -370,7 +370,7 @@ int vsprintfTest(void) /** * - * snprintfTest - test the snprintf() routine + * @brief Test the snprintf() routine * * This routine does not aim to test the same underlying functionality as * sprintfTest(). Instead it tries to limit it to functionality specific to @@ -440,7 +440,7 @@ int snprintfTest(void) /** * - * sprintfMiscTest - test the sprintf() routine with miscellaneous specifiers + * @brief Test the sprintf() routine with miscellaneous specifiers * * @return TC_PASS on success, TC_FAIL otherwise */ @@ -516,7 +516,7 @@ int sprintfMiscTest(void) /** * - * sprintfIntegerTest - test the sprintf() routine with integers + * @brief Test the sprintf() routine with integers * * @return TC_PASS on success, TC_FAIL otherwise */ @@ -669,7 +669,7 @@ int sprintfIntegerTest(void) /** * - * sprintfStringTest - test sprintf with strings + * @brief Test sprintf with strings * * @return TC_PASS on success, TC_FAIL otherwise */ @@ -715,7 +715,7 @@ int sprintfStringTest(void) /** * - * RegressionTask - test entry point + * @brief Test entry point * * @return N/A */ 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 7c2f6e1dc5a..2073797d043 100644 --- a/samples/microkernel/test/test_static_idt/src/static_idt.c +++ b/samples/microkernel/test/test_static_idt/src/static_idt.c @@ -118,7 +118,7 @@ void exc_divide_error_handler(NANO_ESF *pEsf) /** * - * nanoIdtStubTest - check the IDT. + * @brief Check the IDT. * * This test examines the IDT and verifies that the static interrupt and * exception stubs are installed at the correct place. @@ -174,7 +174,7 @@ int nanoIdtStubTest(void) /** * - * idtSpurTask/Fiber - task/fiber to test spurious handlers + * @brief Task/fiber to test spurious handlers * * @return 0 */ @@ -201,7 +201,7 @@ static void idtSpurFiber(int a1, int a2) /** * - * idtTestTask/main - entry point to static IDT tests + * @brief Entry point to static IDT tests * * This is the entry point to the static IDT tests. * diff --git a/samples/microkernel/test/test_task/src/task.c b/samples/microkernel/test/test_task/src/task.c index c78cc166089..175f8a31e91 100644 --- a/samples/microkernel/test/test_task/src/task.c +++ b/samples/microkernel/test/test_task/src/task.c @@ -72,7 +72,7 @@ static volatile int mainTaskNotReady = 0; /** * - * isr_task_command_handler - ISR handler to call isr_task_id_get() and isr_task_priority_get() + * @brief ISR handler to call isr_task_id_get() and isr_task_priority_get() * * @return N/A */ @@ -97,7 +97,7 @@ void isr_task_command_handler(void *data) /** * - * isrAPIsTest - test isr_task_id_get() and isr_task_priority_get + * @brief Test isr_task_id_get() and isr_task_priority_get * * @return TC_PASS on success, TC_FAIL on failure */ @@ -125,7 +125,7 @@ int isrAPIsTest(int taskId, int taskPrio) /** * - * taskMacrosTest - test task_id_get() and task_priority_get() macros + * @brief Test task_id_get() and task_priority_get() macros * * @return TC_PASS on success, TC_FAIL on failure */ @@ -153,7 +153,7 @@ int taskMacrosTest(int taskId, int taskPrio) /** * - * microObjectsInit - initialize objects used in this microkernel test suite + * @brief Initialize objects used in this microkernel test suite * * @return N/A */ @@ -172,7 +172,7 @@ void microObjectsInit(void) /** * - * helperTaskSetPrioTest - helper task portion to test setting the priority + * @brief Helper task portion to test setting the priority * * @return N/A */ @@ -194,7 +194,7 @@ void helperTaskSetPrioTest(void) /** * - * taskSetPrioTest - test the task_priority_set() API + * @brief Test the task_priority_set() API * * @return N/A */ @@ -268,7 +268,7 @@ int taskSetPrioTest(void) /** * - * helperTaskSleepTest - helper task portion to test task_sleep() + * @brief Helper task portion to test task_sleep() * * @return N/A */ @@ -289,7 +289,7 @@ void helperTaskSleepTest(void) /** * - * taskSleepTest - test task_sleep() + * @brief Test task_sleep() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -320,7 +320,7 @@ int taskSleepTest(void) /** * - * helperTaskYieldTest - helper task portion of task_yield() test + * @brief Helper task portion of task_yield() test * * @return N/A */ @@ -340,7 +340,7 @@ void helperTaskYieldTest(void) /** * - * taskYieldTest - test task_yield() + * @brief Test task_yield() * * @return TC_PASS on success, TC_FAIL on failure */ @@ -378,7 +378,7 @@ int taskYieldTest(void) /** * - * helperTaskSuspendTest - helper task portion of task_suspend() and + * @brief Helper task portion of task_suspend() and * task_resume() tests * * @return N/A @@ -393,7 +393,7 @@ void helperTaskSuspendTest(void) /** * - * taskSuspendTest - test task_suspend() and task_resume() + * @brief Test task_suspend() and task_resume() * * This test suspends the helper task. Once it is suspended, the main task * (RegressionTask) sleeps for one second. If the helper task is truly @@ -432,7 +432,7 @@ int taskSuspendTest(void) /** * - * HelperTask - helper task to test the task APIs + * @brief Helper task to test the task APIs * * @return N/A */ @@ -468,7 +468,7 @@ void HelperTask(void) /** * - * RegressionTask - main task to test the task APIs + * @brief Main task to test the task APIs * * @return N/A */ diff --git a/samples/microkernel/test/test_task_irq/src/main.c b/samples/microkernel/test/test_task_irq/src/main.c index 0d8c20a7893..d424f414645 100644 --- a/samples/microkernel/test/test_task_irq/src/main.c +++ b/samples/microkernel/test/test_task_irq/src/main.c @@ -56,7 +56,7 @@ extern uint32_t irq_vectors[NUM_OBJECTS]; /** * - * taskAMain - entry point for taskA + * @brief Entry point for taskA * * This routine signals "task done" or "task fail", based on the return code of * taskA. @@ -72,7 +72,7 @@ void taskAMain(void) /** * - * taskBMain - entry point for taskB + * @brief Entry point for taskB * * This routine signals "task done" or "task fail", based on the return code of * taskB. @@ -88,7 +88,7 @@ void taskBMain(void) /** * - * registerWait - wait for devices to be registered and generate SW ints + * @brief Wait for devices to be registered and generate SW ints * * This routine waits for the tasks to indicate the IRQ objects are allocated and * then generates SW interrupts for all IRQs. Signals "task done" if all task @@ -124,7 +124,7 @@ void registerWait(void) /** * - * MonitorTaskEntry - entry point for MonitorTask + * @brief Entry point for MonitorTask * * This routine keeps tabs on the progress of the tasks doing the actual testing * and generates the final test case summary message. 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 7d5f24f2b26..8906174d50b 100644 --- a/samples/microkernel/test/test_task_irq/src/raise_int.c +++ b/samples/microkernel/test/test_task_irq/src/raise_int.c @@ -1390,7 +1390,7 @@ static void (*intFPtr[256])(void) = { /** * - * raiseInt - generate a software interrupt + * @brief Generate a software interrupt * * This routine will call one of the genInt functions based upon the * value passed to it (which is essentially the interrupt vector number). @@ -1409,7 +1409,7 @@ void raiseInt(uint8_t id) #include /** * - * raiseInt - generate a software interrupt + * @brief Generate a software interrupt * * Trigger via NVIC. is the IRQ number. * 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 20200d905ae..a52123c0ba3 100644 --- a/samples/microkernel/test/test_task_irq/src/test_device.c +++ b/samples/microkernel/test/test_task_irq/src/test_device.c @@ -70,7 +70,7 @@ uint32_t irq_vectors[NUM_OBJECTS] = {[0 ... (NUM_OBJECTS - 1)] = INVALID_VECTOR} /** * - * taskA - first of 2 tasks to allocate IRQ objects and check for events + * @brief First of 2 tasks to allocate IRQ objects and check for events * * This task allocates 2 IRQ objects with unique IRQs and then tests for an * interrupt associated with those IRQs. The function then attempts to allocate @@ -142,7 +142,7 @@ int taskA(ksem_t semRdy) /** * - * taskB - second of 2 tasks to allocate IRQ objects and check for events + * @brief Second of 2 tasks to allocate IRQ objects and check for events * * This task allocates 2 IRQ objects with unique IRQs and then tests for an * interrupt associated with those IRQs. The function then frees an IRQ object diff --git a/samples/microkernel/test/test_tickless/src/timestamps.c b/samples/microkernel/test/test_tickless/src/timestamps.c index 9fa8d8466e4..297d3d93af3 100644 --- a/samples/microkernel/test/test_tickless/src/timestamps.c +++ b/samples/microkernel/test/test_tickless/src/timestamps.c @@ -40,7 +40,7 @@ BSP-specific timestamp support for the tickless idle test. #if defined(CONFIG_BSP_TI_LM3S6965_QEMU) /* - * TI LM3S6965EVM QEMU target - use a General Purpose Timer in + * @brief Use a General Purpose Timer in * 32-bit periodic timer mode (down-counter) * (RTC mode's resolution of 1 second is insufficient.) */ @@ -73,7 +73,7 @@ BSP-specific timestamp support for the tickless idle test. /** * - * _TimestampOpen - timestamp initialization + * @brief Timestamp initialization * * This routine initializes the timestamp timer. * @@ -105,7 +105,7 @@ void _TimestampOpen(void) /** * - * _TimestampRead - timestamp timer read + * @brief Timestamp timer read * * This routine returns the timestamp value. * @@ -141,7 +141,7 @@ uint32_t _TimestampRead(void) /** * - * _TimestampClose - timestamp release + * @brief Timestamp release * * This routine releases the timestamp timer. * @@ -188,7 +188,7 @@ void _TimestampClose(void) /** * - * _TimestampOpen - timestamp initialization + * @brief Timestamp initialization * * This routine initializes the timestamp timer. * @@ -225,7 +225,7 @@ void _TimestampOpen(void) /** * - * _TimestampRead - timestamp timer read + * @brief Timestamp timer read * * This routine returns the timestamp value. * @@ -262,7 +262,7 @@ uint32_t _TimestampRead(void) /** * - * _TimestampClose - timestamp release + * @brief Timestamp release * * This routine releases the timestamp timer. * diff --git a/samples/microkernel/test/test_timer/src/timer.c b/samples/microkernel/test/test_timer/src/timer.c index b41b429d6c8..032e57d8692 100644 --- a/samples/microkernel/test/test_timer/src/timer.c +++ b/samples/microkernel/test/test_timer/src/timer.c @@ -54,7 +54,7 @@ static ktimer_t pTimer[NTIMERS + 1]; /** * - * testLowTimerStop - test that task_timer_stop() does stop a timer + * @brief Test that task_timer_stop() does stop a timer * * @return TC_PASS on success, TC_FAIL otherwise */ @@ -81,7 +81,7 @@ int testLowTimerStop(void) /** * - * testLowTimerPeriodicity - test the periodic feature of a timer + * @brief Test the periodic feature of a timer * * @return TC_PASS on success, TC_FAIL otherwise */ @@ -151,7 +151,7 @@ int testLowTimerPeriodicity(void) /** * - * testLowTimerDoesNotStart - test that the timer does not start + * @brief Test that the timer does not start * * This test checks that the timer does not start under a variety of * circumstances. @@ -190,7 +190,7 @@ int testLowTimerDoesNotStart(void) /** * - * testLowTimerOneShot - test the one shot feature of a timer + * @brief Test the one shot feature of a timer * * @return TC_PASS on success, TC_FAIL otherwise */ @@ -238,7 +238,7 @@ int testLowTimerOneShot(void) /** * - * testLowTimerGet - test the task_timer_alloc() API + * @brief Test the task_timer_alloc() API * * This routine allocates all the timers in the system using task_timer_alloc(). * It verifies that all the allocated timers have unique IDs before freeing @@ -319,7 +319,7 @@ static void test_nano_timers(int unused1, int unused2) /** * - * RegressionTaskEntry - regression test's entry point + * @brief Regression test's entry point * * @return N/A */ diff --git a/samples/microkernel/test/test_xip/src/test_xip.c b/samples/microkernel/test/test_xip/src/test_xip.c index c9ffe124588..bd84fa629bb 100644 --- a/samples/microkernel/test/test_xip/src/test_xip.c +++ b/samples/microkernel/test/test_xip/src/test_xip.c @@ -46,7 +46,7 @@ global variables for completeness sake. #if defined(CONFIG_NANOKERNEL) /** * - * main - main task entry point + * @brief Main task entry point * * Entry point for nanokernel only builds. * @@ -57,7 +57,7 @@ void main(void) #else /** * - * RegressionTaskEntry - regression test's entry point + * @brief Regression test's entry point * * @return N/A */ diff --git a/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c b/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c index 59824d86770..bb85e6868b5 100644 --- a/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c +++ b/samples/nanokernel/benchmark/footprint/src/nanokernel_footprint.c @@ -105,7 +105,7 @@ volatile pfunc func_array[] = { /** * - * dummyIsr - dummy ISR + * @brief Dummy ISR * * @return N/A */ @@ -118,7 +118,7 @@ void dummyIsr(void *unused) #ifdef TEST_reg /** * - * isrDummyIntStub - static interrupt stub that invokes dummy ISR + * @brief Static interrupt stub that invokes dummy ISR * * NOTE: This is typically coded in assembly language, rather than C, * to avoid the preamble code the compiler automatically generates. However, @@ -139,7 +139,7 @@ static void isrDummyIntStub(void *unused) /** * - * fiberEntry - trivial fiber + * @brief Trivial fiber * * @param message Message to be printed. * @param arg1 Unused. @@ -162,7 +162,7 @@ static void fiberEntry(int message, int arg1) /** * - * main - mainline for background task + * @brief Mainline for background task * * This routine simply increments a global counter. * (Gdb can be used to observe the counter as it increases.) diff --git a/samples/nanokernel/benchmark/sys_kernel/src/lifo.c b/samples/nanokernel/benchmark/sys_kernel/src/lifo.c index 067a28b2740..0437cac51be 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/lifo.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/lifo.c @@ -39,7 +39,7 @@ static struct nano_fifo nanoFifo_sync; /* for synchronization */ /** * - * lifo_test_init - initialize LIFOs for the test + * @brief Initialize LIFOs for the test * * @return N/A * @@ -55,7 +55,7 @@ void lifo_test_init(void) /** * - * lifo_fiber1 - lifo test context + * @brief Lifo test context * * @param par1 Ignored parameter. * @param par2 Number of test loops. @@ -95,7 +95,7 @@ void lifo_fiber1(int par1, int par2) /** * - * lifo_fiber2 - lifo test context + * @brief Lifo test context * * @param par1 Address of the counter. * @param par2 Number of test cycles. @@ -127,7 +127,7 @@ void lifo_fiber2(int par1, int par2) /** * - * lifo_fiber3 - lifo test context + * @brief Lifo test context * * @param par1 Address of the counter. * @param par2 Number of test loops. @@ -161,7 +161,7 @@ void lifo_fiber3(int par1, int par2) /** * - * lifo_test - the main test entry + * @brief The main test entry * * @return 1 if success and 0 on failure * diff --git a/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c b/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c index db8b7653b74..9e62f3ca545 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/mwfifo.c @@ -40,7 +40,7 @@ static struct nano_fifo nanoFifo_sync; /* for synchronization */ /** * - * fifo_test_init - initialize FIFOs for the test + * @brief Initialize FIFOs for the test * * @return N/A * @@ -56,7 +56,7 @@ void fifo_test_init(void) /** * - * fifo_fiber1 - fifo test context + * @brief Fifo test context * * @return N/A * @@ -88,7 +88,7 @@ void fifo_fiber1(int par1, int par2) /** * - * fifo_fiber2 - fifo test context + * @brief Fifo test context * * @return N/A * @@ -121,7 +121,7 @@ void fifo_fiber2(int par1, int par2) /** * - * fifo_fiber3 - fifo test context + * @brief Fifo test context * * @return N/A * @@ -156,7 +156,7 @@ void fifo_fiber3(int par1, int par2) /** * - * fifo_test - the main test entry + * @brief The main test entry * * @return 1 if success and 0 on failure * diff --git a/samples/nanokernel/benchmark/sys_kernel/src/sema.c b/samples/nanokernel/benchmark/sys_kernel/src/sema.c index 5bdd86314a3..6dbe3f5cd32 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/sema.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/sema.c @@ -37,7 +37,7 @@ struct nano_sem nanoSem2; /** * - * sema_test_init - initialize semaphores for the test + * @brief Initialize semaphores for the test * * @return N/A * @@ -53,7 +53,7 @@ void sema_test_init(void) /** * - * sema_fiber1 - semaphore test context + * @brief Semaphore test context * * @param par1 Ignored parameter. * @param par2 Number of test loops. @@ -78,7 +78,7 @@ void sema_fiber1(int par1, int par2) /** * - * sema_fiber2 - semaphore test context + * @brief Semaphore test context * * @param par1 Address of the counter. * @param par2 Number of test cycles. @@ -102,7 +102,7 @@ void sema_fiber2(int par1, int par2) /** * - * sema_fiber3 - semaphore test context + * @brief Semaphore test context * * @param par1 Address of the counter. * @param par2 Number of test cycles. @@ -129,7 +129,7 @@ void sema_fiber3(int par1, int par2) /** * - * sema_test - the main test entry + * @brief The main test entry * * @return 1 if success and 0 on failure * diff --git a/samples/nanokernel/benchmark/sys_kernel/src/stack.c b/samples/nanokernel/benchmark/sys_kernel/src/stack.c index a3c77afd150..13339c6040a 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/stack.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/stack.c @@ -40,7 +40,7 @@ uint32_t stack2[2]; /** * - * stack_test_init - initialize stacks for the test + * @brief Initialize stacks for the test * * @return N/A * @@ -56,7 +56,7 @@ void stack_test_init(void) /** * - * stack_fiber1 - stack test context + * @brief Stack test context * * @param par1 Ignored parameter. * @param par2 Number of test loops. @@ -92,7 +92,7 @@ void stack_fiber1(int par1, int par2) /** * - * stack_fiber2 - stack test context + * @brief Stack test context * * @param par1 Address of the counter. * @param par2 Number of test cycles. @@ -122,7 +122,7 @@ void stack_fiber2(int par1, int par2) /** * - * stack_fiber2 - stack test context + * @brief Stack test context * * @param par1 Address of the counter. * @param par2 Number of test cycles. @@ -155,7 +155,7 @@ void stack_fiber3(int par1, int par2) /** * - * stack_test - the main test entry + * @brief The main test entry * * @return 1 if success and 0 on failure * diff --git a/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c b/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c index 408501d291f..326fe76c06f 100644 --- a/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c +++ b/samples/nanokernel/benchmark/sys_kernel/src/syskernel.c @@ -78,7 +78,7 @@ uint32_t tm_off; /** * - * begin_test - get the time ticks before test starts + * @brief Get the time ticks before test starts * * Routine does necessary preparations for the test to start * @@ -97,7 +97,7 @@ void begin_test(void) /** * - * check_result - checks number of tests and calculate average time + * @brief Checks number of tests and calculate average time * * @return 1 if success and 0 on failure * @@ -140,7 +140,7 @@ int check_result(int i, uint32_t t) /** * - * kbhit - check for a key press + * @brief Check for a key press * * @return 1 when a keyboard key is pressed, or 0 if no keyboard support * @@ -155,7 +155,7 @@ int kbhit(void) /** * - * init_output - prepares the test output + * @brief Prepares the test output * * @return N/A * @@ -177,7 +177,7 @@ void init_output(int *continuously) /** * - * output_close - close output for the test + * @brief Close output for the test * * @return N/A * @@ -190,7 +190,7 @@ void output_close(void) /** * - * SysKernelBench - perform all selected benchmarks + * @brief Perform all selected benchmarks * * @return N/A * 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 9f53c2b976a..911c50aa8dd 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 @@ -51,7 +51,7 @@ struct nano_sem sem[3]; /** * - * isr0 - ISR for IRQ0 + * @brief ISR for IRQ0 * * @return N/A */ @@ -65,7 +65,7 @@ void isr0(void) /** * - * isr1 - ISR for IRQ1 + * @brief ISR for IRQ1 * * @return N/A */ @@ -79,7 +79,7 @@ void isr1(void) /** * - * isr2 - ISR for IRQ2 + * @brief ISR for IRQ2 * * @return N/A */ @@ -93,7 +93,7 @@ void isr2(void) /** * - * main - task entry point + * @brief Task entry point * * @return N/A */ diff --git a/samples/nanokernel/test/test_context/src/context.c b/samples/nanokernel/test/test_context/src/context.c index c59125a1a57..16258779460 100644 --- a/samples/nanokernel/test/test_context/src/context.c +++ b/samples/nanokernel/test/test_context/src/context.c @@ -119,7 +119,7 @@ static void (*_trigger_isrHandler)(void) = (vvfn)sw_isr_trigger_0; /** * - * isr_handler - handler to perform various actions from within an ISR context + * @brief Handler to perform various actions from within an ISR context * * This routine is the ISR handler for _trigger_isrHandler(). It performs * the command requested in . @@ -150,7 +150,7 @@ void isr_handler(void *data) #if !defined(CONFIG_CPU_CORTEX_M3_M4) /** * - * exc_divide_error_handler - divide by zero exception handler + * @brief Divide by zero exception handler * * This handler is part of a test that is only interested in detecting the * error so that we know the exception connect code is working. It simply @@ -171,7 +171,7 @@ void exc_divide_error_handler(NANO_ESF *pEsf) /** * - * initNanoObjects - initialize nanokernel objects + * @brief Initialize nanokernel objects * * This routine initializes the nanokernel objects used in this module's tests. * @@ -199,7 +199,7 @@ int initNanoObjects(void) /** * - * nano_cpu_idleTest - test the nano_cpu_idle() routine + * @brief Test the nano_cpu_idle() routine * * This tests the nano_cpu_idle() routine. The first thing it does is align to * a tick boundary. The only source of interrupts while the test is running is @@ -233,7 +233,7 @@ int nano_cpu_idleTest(void) /** * - * irq_lockWrapper - a wrapper for irq_lock() + * @brief A wrapper for irq_lock() * * @return irq_lock() return value */ @@ -247,7 +247,7 @@ int irq_lockWrapper(int unused) /** * - * irq_unlockWrapper - a wrapper for irq_unlock() + * @brief A wrapper for irq_unlock() * * @return N/A */ @@ -259,7 +259,7 @@ void irq_unlockWrapper(int imask) /** * - * irq_lock_inlineWrapper - a wrapper for irq_lock_inline() + * @brief A wrapper for irq_lock_inline() * * @return irq_lock_inline() return value */ @@ -273,7 +273,7 @@ int irq_lock_inlineWrapper(int unused) /** * - * irq_unlock_inlineWrapper - a wrapper for irq_unlock_inline() + * @brief A wrapper for irq_unlock_inline() * * @return N/A */ @@ -285,7 +285,7 @@ void irq_unlock_inlineWrapper(int imask) /** * - * irq_disableWrapper - a wrapper for irq_disable() + * @brief A wrapper for irq_disable() * * @return */ @@ -298,7 +298,7 @@ int irq_disableWrapper(int irq) /** * - * irq_enableWrapper - a wrapper for irq_enable() + * @brief A wrapper for irq_enable() * * @return N/A */ @@ -310,7 +310,7 @@ void irq_enableWrapper(int irq) /** * - * nanoCpuDisableInterruptsTest - test routines for disabling and enabling ints + * @brief Test routines for disabling and enabling ints * * This routine tests the routines for disabling and enabling interrupts. These * include irq_lock() and irq_unlock(), irq_lock_inline() and @@ -376,7 +376,7 @@ int nanoCpuDisableInterruptsTest(disable_interrupt_func disableRtn, /** * - * nanoCtxTaskTest - test the various nanoCtxXXX() routines from a task + * @brief Test the various nanoCtxXXX() routines from a task * * This routines tests the context_self_get() and context_type_get() routines from both * a task and an ISR (that interrupted a task). Checking those routines with @@ -420,7 +420,7 @@ int nanoCtxTaskTest(void) /** * - * nanoCtxFiberTest - test the various nanoCtxXXX() routines from a fiber + * @brief Test the various nanoCtxXXX() routines from a fiber * * This routines tests the context_self_get() and context_type_get() routines from both * a fiber and an ISR (that interrupted a fiber). Checking those routines with @@ -475,7 +475,7 @@ int nanoCtxFiberTest(nano_context_id_t taskCtxId) /** * - * fiberHelper - entry point to the fiber's helper + * @brief Entry point to the fiber's helper * * This routine is the entry point to the fiber's helper fiber. It is used to * help test the behaviour of the fiber_yield() routine. @@ -512,7 +512,7 @@ static void fiberHelper(int arg1, int arg2) /** * - * fiber_yieldTest - test the fiber_yield() routine + * @brief Test the fiber_yield() routine * * This routine tests the fiber_yield() routine. It starts another fiber * (thus also testing fiber_fiber_start()) and checks that behaviour of @@ -594,7 +594,7 @@ int fiber_yieldTest(void) /** * - * fiberEntry - entry point to fiber started by the task + * @brief Entry point to fiber started by the task * * This routine is the entry point to the fiber started by the task. * @@ -817,7 +817,7 @@ static int test_timeout(void) /** * - * main - entry point to timer tests + * @brief Entry point to timer tests * * This is the entry point to the CPU and context tests. * diff --git a/samples/nanokernel/test/test_fifo/src/fifo.c b/samples/nanokernel/test/test_fifo/src/fifo.c index 2309af8c6a3..b9b1f332a75 100644 --- a/samples/nanokernel/test/test_fifo/src/fifo.c +++ b/samples/nanokernel/test/test_fifo/src/fifo.c @@ -146,7 +146,7 @@ extern int test_fifo_timeout(void); /** * - * isr_fifo_put - add an item to a FIFO + * @brief Add an item to a FIFO * * This routine is the ISR handler for _trigger_nano_isr_fifo_put(). It adds * an item to the FIFO in the context of an ISR. @@ -165,7 +165,7 @@ void isr_fifo_put(void *parameter) /** * - * isr_fifo_get - get an item from a FIFO + * @brief Get an item from a FIFO * * This routine is the ISR handler for _trigger_nano_isr_fifo_get(). It gets * an item from the FIFO in the context of an ISR. @@ -185,7 +185,7 @@ void isr_fifo_get(void *parameter) /** * - * fiber1 - entry point for the first fiber + * @brief Entry point for the first fiber * * @return N/A */ @@ -254,7 +254,7 @@ void fiber1(void) /** * - * testFiberFifoGetW - test the nano_fiber_fifo_get_wait() interface + * @brief Test the nano_fiber_fifo_get_wait() interface * * 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. @@ -301,7 +301,7 @@ void testFiberFifoGetW(void) /** * - * testIsrFifoFromFiber - test ISR FIFO routines (triggered from fiber) + * @brief Test ISR FIFO routines (triggered from fiber) * * This function tests the fifo put and get interfaces in the isr context. * It is invoked from a fiber. @@ -355,7 +355,7 @@ void testIsrFifoFromFiber(void) /** * - * testIsrFifoFromTask - test ISR FIFO routines (triggered from task) + * @brief Test ISR FIFO routines (triggered from task) * * This function tests the fifo put and get interfaces in the isr context. * It is invoked from a task. @@ -418,7 +418,7 @@ void testIsrFifoFromTask(void) /** * - * fiber2 - entry point for the second fiber + * @brief Entry point for the second fiber * * @return N/A */ @@ -474,7 +474,7 @@ void fiber2(void) /** * - * fiber3 - entry point for the third fiber + * @brief Entry point for the third fiber * * @return N/A */ @@ -520,7 +520,7 @@ void fiber3(void) /** * - * testTaskFifoGetW - test the nano_task_fifo_get_wait() interface + * @brief Test the nano_task_fifo_get_wait() interface * * This is in the task context. It puts data to nanoFifoObj2 queue and gets * data from nanoFifoObj queue. @@ -560,7 +560,7 @@ void testTaskFifoGetW(void) /** * - * initNanoObjects - initialize nanokernel objects + * @brief Initialize nanokernel objects * * This routine initializes the nanokernel objects used in the FIFO tests. * @@ -590,7 +590,7 @@ void initNanoObjects(void) /** * - * main - entry point to FIFO tests + * @brief Entry point to FIFO tests * * This is the entry point to the FIFO tests. * diff --git a/samples/nanokernel/test/test_lifo/src/lifo.c b/samples/nanokernel/test/test_lifo/src/lifo.c index 1d872b73fe4..3f55e76c2d1 100644 --- a/samples/nanokernel/test/test_lifo/src/lifo.c +++ b/samples/nanokernel/test/test_lifo/src/lifo.c @@ -107,7 +107,7 @@ static struct nano_sem reply_multi_waiters; /** * - * isr_lifo_put - add an item to a LIFO + * @brief Add an item to a LIFO * * This routine is the ISR handler for _trigger_nano_isr_lifo_put(). It adds * an item to the LIFO in the context of an ISR. @@ -126,7 +126,7 @@ void isr_lifo_put(void *data) /** * - * isr_lifo_get - get an item from a LIFO + * @brief Get an item from a LIFO * * This routine is the ISR handler for _trigger_nano_isr_lifo_get(). It gets * an item from the LIFO in the context of an ISR. @@ -145,7 +145,7 @@ void isr_lifo_get(void *data) /** * - * fiberLifoWaitTest - fiber portion of test that waits on a LIFO + * @brief Fiber portion of test that waits on a LIFO * * This routine works with taskLifoWaitTest() to test the addition and removal * of items to/from a LIFO. The cases covered will have a fiber or task waiting @@ -206,7 +206,7 @@ int fiberLifoWaitTest(void) /** * - * fiberLifoNonWaitTest - fiber portion of test that does not wait on a LIFO + * @brief Fiber portion of test that does not wait on a LIFO * * This routine works with fiberLifoNonWaitTest() to test the addition and * removal of items from a LIFO without having to wait. @@ -284,7 +284,7 @@ errorReturn: /** * - * fiberEntry - entry point for the fiber portion of the LIFO tests + * @brief Entry point for the fiber portion of the LIFO tests * * NOTE: The fiber portion of the tests have higher priority than the task * portion of the tests. @@ -312,7 +312,7 @@ static void fiberEntry(int arg1, int arg2) /** * - * taskLifoWaitTest - task portion of test that waits on a LIFO + * @brief Task portion of test that waits on a LIFO * * This routine works with fiberLifoWaitTest() to test the addition and removal * of items to/from a LIFO. The cases covered will have a fiber or task waiting @@ -370,7 +370,7 @@ int taskLifoWaitTest(void) /** * - * taskLifoNonWaitTest - task portion of test that does not wait on a LIFO + * @brief Task portion of test that does not wait on a LIFO * * This routine works with fiberLifoNonWaitTest() to test the addition and * removal of items from a LIFO without having to wait. @@ -448,7 +448,7 @@ int taskLifoNonWaitTest(void) /** * - * initNanoObjects - initialize nanokernel objects + * @brief Initialize nanokernel objects * * This routine initializes the nanokernel objects used in the LIFO tests. * @@ -494,7 +494,7 @@ static LIFO_ITEM multi_waiters_items[NUM_WAITERS] = { /** * - * fiber_multi_waiters - fiber entry point for multiple-waiters test + * @brief Fiber entry point for multiple-waiters test * * @return N/A */ @@ -520,7 +520,7 @@ static void fiber_multi_waiters(int arg1, int arg2) /** * - * do_test_multiple_waiters - task part of multiple-waiter test, repeatable + * @brief Task part of multiple-waiter test, repeatable * * @return N/A */ @@ -561,7 +561,7 @@ static int do_test_multiple_waiters(void) /** * - * test_multiple_waiters - entry point for multiple-waiters test + * @brief Entry point for multiple-waiters test * * @return N/A */ @@ -1051,7 +1051,7 @@ static int test_timeout(void) /** * - * main - entry point to LIFO tests + * @brief Entry point to LIFO tests * * This is the entry point to the LIFO tests. * diff --git a/samples/nanokernel/test/test_sema/src/sema.c b/samples/nanokernel/test/test_sema/src/sema.c index 3506e22787c..3a6ef5c1ac8 100644 --- a/samples/nanokernel/test/test_sema/src/sema.c +++ b/samples/nanokernel/test/test_sema/src/sema.c @@ -97,7 +97,7 @@ static struct nano_sem reply_multi_waiters; /** * - * isr_sem_take - take a semaphore + * @brief Take a semaphore * * This routine is the ISR handler for _trigger_nano_isr_sem_take(). It takes a * semaphore within the context of an ISR. @@ -116,7 +116,7 @@ void isr_sem_take(void *data) /** * - * isr_sem_give - give a semaphore + * @brief Give a semaphore * * This routine is the ISR handler for _trigger_nano_isr_sem_take(). It gives a * semaphore within the context of an ISR. @@ -136,7 +136,7 @@ void isr_sem_give(void *data) /** * - * testSemFiberNoWait - give and take the semaphore in a fiber without blocking + * @brief Give and take the semaphore in a fiber without blocking * * This test gives and takes the test semaphore in the context of a fiber * without blocking on the semaphore. @@ -180,7 +180,7 @@ errorReturn: /** * - * fiberEntry - entry point for the fiber portion of the semaphore tests + * @brief Entry point for the fiber portion of the semaphore tests * * NOTE: The fiber portion of the tests have higher priority than the task * portion of the tests. @@ -256,7 +256,7 @@ static void fiberEntry(int arg1, int arg2) /** * - * initNanoObjects - initialize nanokernel objects + * @brief Initialize nanokernel objects * * This routine initializes the nanokernel objects used in the semaphore tests. * @@ -282,7 +282,7 @@ void initNanoObjects(void) /** * - * testSemIsrNoWait - give and take the semaphore in an ISR without blocking + * @brief Give and take the semaphore in an ISR without blocking * * This test gives and takes the test semaphore in the context of an ISR without * blocking on the semaphore. @@ -329,7 +329,7 @@ errorReturn: /** * - * testSemTaskNoWait - give and take the semaphore in a task without blocking + * @brief Give and take the semaphore in a task without blocking * * This test gives and takes the test semaphore in the context of a task without * blocking on the semaphore. @@ -372,7 +372,7 @@ errorReturn: /** * - * testSemWait - perform tests that wait on a semaphore + * @brief Perform tests that wait on a semaphore * * This routine works with fiberEntry() to perform the tests that wait on * a semaphore. @@ -430,7 +430,7 @@ static char __stack fiber_multi_waiters_stacks[NUM_WAITERS][FIBER_STACKSIZE]; /** * - * fiber_multi_waiters - fiber entry point for multiple-waiters test + * @brief Fiber entry point for multiple-waiters test * * @return N/A */ @@ -446,7 +446,7 @@ static void fiber_multi_waiters(int arg1, int arg2) /** * - * do_test_multiple_waiters - task part of multiple-waiter test, repeatable + * @brief Task part of multiple-waiter test, repeatable * * @return N/A */ @@ -492,7 +492,7 @@ static int do_test_multiple_waiters(void) /** * - * test_multiple_waiters - entry point for multiple-waiters test + * @brief Entry point for multiple-waiters test * * @return N/A */ @@ -936,7 +936,7 @@ static int test_timeout(void) /** * - * main - entry point to semaphore tests + * @brief Entry point to semaphore tests * * This is the entry point to the semaphore tests. * diff --git a/samples/nanokernel/test/test_stack/src/stack.c b/samples/nanokernel/test/test_stack/src/stack.c index 9c0db86a940..406edf7953f 100644 --- a/samples/nanokernel/test/test_stack/src/stack.c +++ b/samples/nanokernel/test/test_stack/src/stack.c @@ -145,7 +145,7 @@ void initData(void) /** * - * isr_stack_push - add an item to a STACK + * @brief Add an item to a STACK * * This routine is the ISR handler for _trigger_nano_isr_stack_push(). It adds * an item to the STACK in the context of an ISR. @@ -165,7 +165,7 @@ void isr_stack_push(void *parameter) /** * - * isr_stack_pop - get an item from a STACK + * @brief Get an item from a STACK * * This routine is the ISR handler for _trigger_nano_isr_stack_pop(). It gets * an item from the STACK in the context of an ISR. If the queue is empty, @@ -456,7 +456,7 @@ void testTaskStackPopW(void) /** * - * fiber3 - a fiber to help test nano_task_stack_pop_wait() + * @brief A fiber to help test nano_task_stack_pop_wait() * * 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. @@ -473,7 +473,7 @@ void fiber3(void) /** * - * initNanoObjects - initialize nanokernel objects + * @brief Initialize nanokernel objects * * This routine initializes the nanokernel objects used in the STACK tests. * @@ -497,7 +497,7 @@ void initNanoObjects(void) /** * - * main - entry point to STACK tests + * @brief Entry point to STACK tests * * This is the entry point to the STACK tests. * diff --git a/samples/nanokernel/test/test_timer/src/timer.c b/samples/nanokernel/test/test_timer/src/timer.c index a62528fda64..e158a7ac0e8 100644 --- a/samples/nanokernel/test/test_timer/src/timer.c +++ b/samples/nanokernel/test/test_timer/src/timer.c @@ -79,7 +79,7 @@ static char __stack fiber2Stack[FIBER2_STACKSIZE]; /** * - * initNanoObjects - initialize nanokernel objects + * @brief Initialize nanokernel objects * * This routine initializes the nanokernel objects used in the LIFO tests. * @@ -98,7 +98,7 @@ void initNanoObjects(void) /** * - * basicTimerWait - basic checking of time spent waiting upon a timer + * @brief Basic checking of time spent waiting upon a timer * * This routine can be called from a task or a fiber to wait upon a timer. * It will busy wait until the current tick ends, at which point it will @@ -183,7 +183,7 @@ int basicTimerWait(timer_start_func startRtn, timer_getw_func waitRtn, /** * - * startTimers - start four timers + * @brief Start four timers * * This routine starts four timers. * The first () is added to an empty list of timers. @@ -215,7 +215,7 @@ void startTimers(timer_start_func startRtn) /** * - * busyWaitTimers - busy wait while checking timers expire in the correct order + * @brief Busy wait while checking timers expire in the correct order * * This routine checks that the four timers created using startTimers() finish * in the correct order. It busy waits on all four timers waiting until they @@ -283,7 +283,7 @@ int busyWaitTimers(timer_get_func getRtn) /** * - * stopTimers - stop the four timers and make sure they did not expire + * @brief Stop the four timers and make sure they did not expire * * This routine stops the four started timers and then checks the timers for * six seconds to make sure that they did not fire. The four timers will be @@ -327,7 +327,7 @@ int stopTimers(timer_stop_func stopRtn, timer_get_func getRtn) /** * - * fiber2Entry - entry point for the second fiber + * @brief Entry point for the second fiber * * The second fiber has a lower priority than the first, but is still given * precedence over the task. @@ -348,7 +348,7 @@ static void fiber2Entry(int arg1, int arg2) /** * - * fiberEntry - entry point for the fiber portion of the timer tests + * @brief Entry point for the fiber portion of the timer tests * * NOTE: The fiber portion of the tests have higher priority than the task * portion of the tests. @@ -429,7 +429,7 @@ static void fiberEntry(int arg1, int arg2) /** * - * nano_cycle_get_32Test - test the nano_cycle_get_32() API + * @brief Test the nano_cycle_get_32() API * * @return TC_PASS on success, TC_FAIL on failure */ @@ -456,7 +456,7 @@ int nano_cycle_get_32Test(void) /** * - * main - entry point to timer tests + * @brief Entry point to timer tests * * This is the entry point to the timer tests. * diff --git a/scripts/kconfig/list.h b/scripts/kconfig/list.h index 2cf23f002d3..0e3dea7bac5 100644 --- a/scripts/kconfig/list.h +++ b/scripts/kconfig/list.h @@ -9,7 +9,7 @@ #define offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER) /** - * container_of - cast a member of a structure out to the containing structure + * @brief Cast a member of a structure out to the containing structure * @ptr: the pointer to the member. * @type: the type of the container struct this is embedded in. * @member: the name of the member within the struct. @@ -31,7 +31,7 @@ struct list_head { struct list_head name = LIST_HEAD_INIT(name) /** - * list_entry - get the struct for this entry + * @brief Get the struct for this entry * @ptr: the &struct list_head pointer. * @type: the type of the struct this is embedded in. * @member: the name of the list_head within the struct. @@ -51,7 +51,7 @@ struct list_head { pos = list_entry(pos->member.next, typeof(*pos), member)) /** - * list_for_each_entry_safe - iterate over list of given type safe against removal of list entry + * @brief Iterate over list of given type safe against removal of list entry * @pos: the type * to use as a loop cursor. * @n: another type * to use as temporary storage * @head: the head for your list. @@ -64,7 +64,7 @@ struct list_head { pos = n, n = list_entry(n->member.next, typeof(*n), member)) /** - * list_empty - tests whether a list is empty + * @brief Tests whether a list is empty * @head: the list to test. */ static inline int list_empty(const struct list_head *head) @@ -89,7 +89,7 @@ static inline void __list_add(struct list_head *_new, } /** - * list_add_tail - add a new entry + * @brief Add a new entry * @new: new entry to be added * @head: list head to add it before * @@ -117,7 +117,7 @@ static inline void __list_del(struct list_head *prev, struct list_head *next) #define LIST_POISON1 ((void *) 0x00100100) #define LIST_POISON2 ((void *) 0x00200200) /** - * list_del - deletes entry from list. + * @brief Deletes entry from list. * @entry: the element to delete from the list. * Note: list_empty() on entry does not return true after this, the entry is * in an undefined state. diff --git a/shared/include/nanokernel/x86/idtEnt.h b/shared/include/nanokernel/x86/idtEnt.h index 0a44977217d..ca7988f962c 100644 --- a/shared/include/nanokernel/x86/idtEnt.h +++ b/shared/include/nanokernel/x86/idtEnt.h @@ -81,7 +81,7 @@ typedef struct idtEntry { /** * - * _IdtEntCreate - Create an IDT entry + * @brief Create an IDT entry * * This routine creates an interrupt-gate descriptor at the location defined by * . The entry is created such that is invoked when an