cleanup: removing NOMANUAL

The \NOMANUAL tag is a remnant from days of yore and is no longer
needed or useful.  Cleaning up the code references to this.

Change-Id: I1b8cc9c9560d1dbb711f05fa63fd23386789875c
Signed-off-by: Dan Kalowsky <daniel.kalowsky@intel.com>
This commit is contained in:
Dan Kalowsky 2015-10-23 10:33:45 -07:00 committed by Anas Nashif
commit 2a63743192
65 changed files with 6 additions and 490 deletions

View file

@ -52,10 +52,7 @@ const NANO_ESF _default_esf = {
* create its own or use a pointer to the global default ESF <_default_esf>.
*
* @return This function does not return.
*
* \NOMANUAL
*/
FUNC_NORETURN void _NanoFatalErrorHandler(unsigned int reason,
const NANO_ESF *pEsf)
{

View file

@ -52,10 +52,7 @@
* (short form).
*
* @return N/A
*
* \NOMANUAL
*/
void _FaultDump(const NANO_ESF *esf, int fault)
{
ARG_UNUSED(esf);
@ -81,10 +78,7 @@ void _FaultDump(const NANO_ESF *esf, int fault)
* responsible for implementing the error handling policy.
*
* @return This function does not return.
*
* \NOMANUAL
*/
void _Fault(void)
{
uint32_t ecr = _arc_v2_aux_reg_read(_ARC_V2_ECR);

View file

@ -65,8 +65,6 @@ static inline void nonEssentialTaskAbort(void)
* @param pEsf pointer to exception stack frame
*
* @return N/A
*
* \NOMANUAL
*/
void _SysFatalErrorHandler(unsigned int reason, const NANO_ESF * pEsf)
{

View file

@ -234,10 +234,7 @@ static ALWAYS_INLINE void nanoArchInit(void)
* the fiber's thread is stored in its struct tcs structure.
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void fiberRtnValueSet(struct tcs *fiber, unsigned int value)
{
fiber->return_value = value;
@ -248,10 +245,7 @@ static ALWAYS_INLINE void fiberRtnValueSet(struct tcs *fiber, unsigned int value
* @brief Indicates if kernel is handling interrupt
*
* @return 1 if interrupt handler is executed, 0 otherwise
*
* \NOMANUAL
*/
static ALWAYS_INLINE int _IS_IN_ISR(void)
{
uint32_t act = _arc_v2_aux_reg_read(_ARC_V2_AUX_IRQ_ACT);

View file

@ -65,10 +65,7 @@ const NANO_ESF _default_esf = {0xdeaddead, /* a1 */
* @param pEsf pointer to the exception stack frame
*
* @return This function does not return.
*
* \NOMANUAL
*/
FUNC_NORETURN void _NanoFatalErrorHandler(unsigned int reason,
const NANO_ESF *pEsf)
{

View file

@ -60,10 +60,7 @@
* BFAR: 0xff001234
*
* @return N/A
*
* \NOMANUAL
*/
void _FaultDump(const NANO_ESF *esf, int fault)
{
int escalation = 0;
@ -111,10 +108,7 @@ void _FaultDump(const NANO_ESF *esf, int fault)
* See _FaultDump() for example.
*
* @return N/A
*
* \NOMANUAL
*/
static void _FaultThreadShow(const NANO_ESF *esf)
{
PR_EXC(" Executing thread ID (thread): 0x%x\n"
@ -130,10 +124,7 @@ static void _FaultThreadShow(const NANO_ESF *esf)
* See _FaultDump() for example.
*
* @return N/A
*
* \NOMANUAL
*/
static void _MpuFault(const NANO_ESF *esf, int fromHardFault)
{
PR_EXC("***** MPU FAULT *****\n");
@ -164,10 +155,7 @@ static void _MpuFault(const NANO_ESF *esf, int fromHardFault)
* See _FaultDump() for example.
*
* @return N/A
*
* \NOMANUAL
*/
static void _BusFault(const NANO_ESF *esf, int fromHardFault)
{
PR_EXC("***** BUS FAULT *****\n");
@ -204,10 +192,7 @@ static void _BusFault(const NANO_ESF *esf, int fromHardFault)
* See _FaultDump() for example.
*
* @return N/A
*
* \NOMANUAL
*/
static void _UsageFault(const NANO_ESF *esf)
{
PR_EXC("***** USAGE FAULT *****\n");
@ -244,10 +229,7 @@ static void _UsageFault(const NANO_ESF *esf)
* See _FaultDump() for example.
*
* @return N/A
*
* \NOMANUAL
*/
static void _HardFault(const NANO_ESF *esf)
{
PR_EXC("***** HARD FAULT *****\n");
@ -272,10 +254,7 @@ static void _HardFault(const NANO_ESF *esf)
* See _FaultDump() for example.
*
* @return N/A
*
* \NOMANUAL
*/
static void _DebugMonitor(const NANO_ESF *esf)
{
PR_EXC("***** Debug monitor exception (not implemented) *****\n");
@ -288,10 +267,7 @@ static void _DebugMonitor(const NANO_ESF *esf)
* See _FaultDump() for example.
*
* @return N/A
*
* \NOMANUAL
*/
static void _ReservedException(const NANO_ESF *esf, int fault)
{
PR_EXC("***** %s %d) *****\n",
@ -317,10 +293,7 @@ static void _ReservedException(const NANO_ESF *esf, int fault)
* Address: 0xff001234
*
* @return N/A
*
* \NOMANUAL
*/
static void _FaultDump(const NANO_ESF *esf, int fault)
{
switch (fault) {
@ -363,10 +336,7 @@ static void _FaultDump(const NANO_ESF *esf, int fault)
* @param psp pointer to potential ESF on PSP
*
* @return This function does not return.
*
* \NOMANUAL
*/
void _Fault(const NANO_ESF *msp, const NANO_ESF *psp)
{
const NANO_ESF *esf = _ScbIsNestedExc() ? msp : psp;
@ -384,10 +354,7 @@ void _Fault(const NANO_ESF *msp, const NANO_ESF *psp)
* Turns on the desired hardware faults.
*
* @return N/A
*
* \NOMANUAL
*/
void _FaultInit(void)
{
_ScbDivByZeroFaultEnable();

View file

@ -66,10 +66,7 @@ static inline void nonEssentialTaskAbort(void)
* @param pEsf pointer to exception stack frame
*
* @return N/A
*
* \NOMANUAL
*/
void _SysFatalErrorHandler(unsigned int reason, const NANO_ESF * pEsf)
{
nano_context_type_t curCtx = sys_execution_context_type_get();

View file

@ -49,10 +49,7 @@ static struct k_args cmd_packet;
* - the task encounters a fatal exception
*
* @return N/A
*
* \NOMANUAL
*/
void _TaskAbort(void)
{
const int taskAbortCode = 1;

View file

@ -33,10 +33,7 @@
* Obtain and return current value of IPSR register.
*
* @return the contents of the IPSR register
*
* \NOMANUAL
*/
static ALWAYS_INLINE uint32_t _IpsrGet(void)
{
uint32_t vector;
@ -52,10 +49,7 @@ static ALWAYS_INLINE uint32_t _IpsrGet(void)
* Store the value of <msp> in MSP register.
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void _MspSet(uint32_t msp /* value to store in MSP */
)
{

View file

@ -43,8 +43,6 @@
* interrupt context.
*
* @return 1 if in ISR, 0 if not.
*
* \NOMANUAL
*/
static ALWAYS_INLINE int _IsInIsr(void)
{
@ -63,10 +61,7 @@ static ALWAYS_INLINE int _IsInIsr(void)
* Enable fault exceptions.
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void _ExcSetup(void)
{
_ScbExcPrioSet(_EXC_PENDSV, _EXC_PRIO(0xff));

View file

@ -52,10 +52,7 @@ extern char _interrupt_stack[CONFIG_ISR_STACK_SIZE];
* pointer) register, and switched to automatically when taking an exception.
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void _InterruptStackSetup(void)
{
uint32_t msp = __GET_MSP();

View file

@ -179,10 +179,7 @@ static ALWAYS_INLINE void nanoArchInit(void)
* @param value is the value to set as a return value
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void fiberRtnValueSet(struct tcs *fiber,
unsigned int value)
{

View file

@ -67,10 +67,7 @@ const NANO_ESF _default_esf = {
* @param pEsf pointer to the exception stack frame
*
* @return This function does not return.
*
* \NOMANUAL
*/
FUNC_NORETURN void _NanoFatalErrorHandler(unsigned int reason,
const NANO_ESF *pEsf)
{

View file

@ -87,10 +87,7 @@ entering and exiting a C interrupt handler.
* C function prototype:
*
* void _IntEnt (void);
*
* NOMANUAL
*/
SECTION_FUNC(TEXT, _IntEnt)
/*
@ -252,10 +249,7 @@ BRANCH_LABEL(_HandleIdle)
* C function prototype:
*
* void _IntExit (void);
*
* NOMANUAL
*/
SECTION_FUNC(TEXT, _IntExit)
cli /* disable interrupts */
@ -409,10 +403,7 @@ BRANCH_LABEL(nestedInterrupt)
* in the EFLAGS register upon execution of the handler,
* thus _SpuriousIntNoErrCodeHandler()/_SpuriousIntHandler() shall be
* invoked with interrupts disabled.
*
* NOMANUAL
*/
SECTION_FUNC(TEXT, _SpuriousIntNoErrCodeHandler)
pushl $0 /* push dummy err code onto stk */

View file

@ -52,10 +52,7 @@
* @param pEsf the pointer to the exception stack frame
*
* @return This function does not return.
*
* \NOMANUAL
*/
FUNC_NORETURN void _SysFatalErrorHandler(unsigned int reason,
const NANO_ESF * pEsf)
{

View file

@ -62,10 +62,7 @@ void _thread_entry_wrapper(_thread_entry_t, _thread_arg_t,
* @param options thread options: USE_FP, USE_SSE
*
* @return N/A
*
* \NOMANUAL
*/
static void _new_thread_internal(char *pStackMem, unsigned stackSize,
int priority, unsigned options)
{
@ -250,10 +247,7 @@ static void _new_thread_internal(char *pStackMem, unsigned stackSize,
* _thread_entry after it has done its work.
*
* @return this routine does NOT return.
*
* \NOMANUAL
*/
__asm__("\t.globl _thread_entry\n"
"\t.section .text\n"
"_thread_entry_wrapper:\n" /* should place this func .S file and use
@ -284,10 +278,7 @@ __asm__("\t.globl _thread_entry\n"
*
*
* @return opaque pointer to initialized TCS structure
*
* \NOMANUAL
*/
void _new_thread(char *pStackMem, unsigned stackSize, _thread_entry_t pEntry,
void *parameter1, void *parameter2, void *parameter3,
int priority, unsigned options)

View file

@ -36,10 +36,7 @@ NANO_CPU_EXC_CONNECT_NO_ERR(handler, vector, 0)
* @brief Return the current value of the EFLAGS register
*
* @return the EFLAGS register.
*
* \NOMANUAL
*/
static inline unsigned int EflagsGet(void)
{
unsigned int eflags; /* EFLAGS register contents */
@ -65,7 +62,6 @@ static inline unsigned int EflagsGet(void)
*
* @return N/A
*/
static inline void _FpAccessDisable(void)
{
void *tempReg;
@ -91,7 +87,6 @@ static inline void _FpAccessDisable(void)
*
* @return N/A
*/
static inline void _do_fp_ctx_save(int flags, void *preemp_float_reg)
{
#ifdef CONFIG_SSE
@ -121,7 +116,6 @@ static inline void _do_fp_ctx_save(int flags, void *preemp_float_reg)
*
* @return N/A
*/
static inline void _do_fp_ctx_init(int flags)
{
/* initialize x87 FPU */

View file

@ -759,10 +759,7 @@ extern unsigned int _interrupt_vectors_allocated[];
* function calls.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void nanoArchInit(void)
{
extern void *__isr___SpuriousIntHandler;
@ -811,10 +808,7 @@ static inline void nanoArchInit(void)
* thus the fibers context is stored in its TCS.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void fiberRtnValueSet(struct tcs *fiber, unsigned int value)
{
/* write into 'eax' slot created in _Swap() entry */

View file

@ -176,10 +176,7 @@ static inline int pci_bar_config_get(union pci_addr_reg pci_ctrl_addr,
* @return -1 on error, 0 if 32 bit BAR retrieved or 1 if 64 bit BAR retrieved
*
* NOTE: Routine does not set up parameters for 64 bit BARS, they are ignored.
*
* \NOMANUAL
*/
static inline int pci_bar_params_get(union pci_addr_reg pci_ctrl_addr,
struct pci_dev_info *dev_info)
{
@ -225,10 +222,7 @@ static inline int pci_bar_params_get(union pci_addr_reg pci_ctrl_addr,
* @brief Scan the specified PCI device for all sub functions
*
* @return 1 if a device has been found, 0 otherwise.
*
* \NOMANUAL
*/
static inline int pci_dev_scan(union pci_addr_reg pci_ctrl_addr,
struct pci_dev_info *dev_info)
{
@ -350,10 +344,7 @@ void pci_bus_scan_init(void)
*
* @return 1 on success, 0 otherwise. On success, dev_info is filled in with
* currently found device information
*
* \NOMANUAL
*/
int pci_bus_scan(struct pci_dev_info *dev_info)
{
union pci_addr_reg pci_ctrl_addr;

View file

@ -65,10 +65,7 @@ static uint32_t clock_accumulated_count;
* - enabling interrupt generation.
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void enable(
uint32_t count /* interrupt triggers when up-counter reaches this value */
)
@ -90,8 +87,6 @@ static ALWAYS_INLINE void enable(
* value is the 'time' elapsed from the starting count (assumed to be 0).
*
* @return the current counter value
*
* \NOMANUAL
*/
static ALWAYS_INLINE uint32_t count_get(void)
{
@ -106,8 +101,6 @@ static ALWAYS_INLINE uint32_t count_get(void)
* value to which the timer will count up to.
*
* @return the limit value
*
* \NOMANUAL
*/
static ALWAYS_INLINE uint32_t limit_get(void)
{
@ -122,10 +115,7 @@ static ALWAYS_INLINE uint32_t limit_get(void)
* event is pushed onto the microkernel stack.
*
* @return N/A
*
* \NOMANUAL
*/
void _timer_int_handler(void *unused)
{
uint32_t zero_ip_bit = _ARC_V2_TMR_CTRL_NH | _ARC_V2_TMR_CTRL_IE;
@ -149,7 +139,6 @@ void _timer_int_handler(void *unused)
*
* @return 0
*/
int _sys_clock_driver_init(struct device *device)
{
int irq = CONFIG_ARCV2_TIMER0_INT_LVL;
@ -185,7 +174,6 @@ int _sys_clock_driver_init(struct device *device)
*
* @return up counter of elapsed clock cycles
*/
uint32_t _sys_clock_cycle_get(void)
{
return (clock_accumulated_count + count_get());
@ -204,7 +192,6 @@ FUNC_ALIAS(_sys_clock_cycle_get, task_cycle_get_32, uint32_t);
*
* @return N/A
*/
void timer_disable(void)
{
unsigned int key; /* interrupt lock level */

View file

@ -120,10 +120,7 @@ static unsigned char idle_mode = IDLE_NOT_TICKLESS;
* This routine disables the systick counter.
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void sysTickStop(void)
{
union __stcsr reg;
@ -149,10 +146,7 @@ static ALWAYS_INLINE void sysTickStop(void)
* This routine enables the systick counter.
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void sysTickStart(void)
{
union __stcsr reg;
@ -178,8 +172,6 @@ static ALWAYS_INLINE void sysTickStart(void)
* interrupt.
*
* @return the current counter value
*
* \NOMANUAL
*/
static ALWAYS_INLINE uint32_t sysTickCurrentGet(void)
{
@ -193,8 +185,6 @@ static ALWAYS_INLINE uint32_t sysTickCurrentGet(void)
* This routine returns the value from the reload value register.
*
* @return the counter's initial count/wraparound value
*
* \NOMANUAL
*/
static ALWAYS_INLINE uint32_t sysTickReloadGet(void)
{
@ -212,10 +202,7 @@ static ALWAYS_INLINE uint32_t sysTickReloadGet(void)
* Note that the value given is assumed to be valid (i.e., count < (1<<24)).
*
* @return N/A
*
* \NOMANUAL
*/
static ALWAYS_INLINE void sysTickReloadSet(
uint32_t count /* count from which timer is to count down */
)
@ -241,10 +228,7 @@ static ALWAYS_INLINE void sysTickReloadSet(
* system operation) or _real_timer_int_handler (when GDB_INFO is enabled).
*
* @return N/A
*
* \NOMANUAL
*/
void _TIMER_INT_HANDLER(void *unused)
{
ARG_UNUSED(unused);
@ -382,10 +366,7 @@ void _TIMER_INT_HANDLER(void *unused)
* more elapsed ticks during a "tickless idle".
*
* @return N/A
*
* \NOMANUAL
*/
static void sysTickTicklessIdleInit(void)
{
/* enable counter, disable interrupt and set clock src to system clock
@ -461,7 +442,6 @@ static void sysTickTicklessIdleInit(void)
*
* @return N/A
*/
void _timer_idle_enter(int32_t ticks /* system ticks */
)
{
@ -519,7 +499,6 @@ void _timer_idle_enter(int32_t ticks /* system ticks */
*
* @return N/A
*/
void _timer_idle_exit(void)
{
uint32_t count; /* timer's current count register value */
@ -650,7 +629,6 @@ int _sys_clock_driver_init(struct device *device)
* systick counter is a 24-bit down counter which is reset to "reload" value
* once it reaches 0.
*/
uint32_t _sys_clock_cycle_get(void)
{
return clock_accumulated_count + (__scs.systick.strvr - __scs.systick.stcvr);
@ -670,7 +648,6 @@ FUNC_ALIAS(_sys_clock_cycle_get, task_cycle_get_32, uint32_t);
*
* @return N/A
*/
void timer_disable(void)
{
unsigned int key; /* interrupt lock level */

View file

@ -216,10 +216,7 @@ static int stale_irq_check;
* significant word is being retrieved (as per HPET documentation).
*
* @return current 64-bit counter value
*
* \NOMANUAL
*/
static uint64_t _hpetMainCounterAtomic(void)
{
uint32_t highBits;
@ -243,10 +240,7 @@ static uint64_t _hpetMainCounterAtomic(void)
* is pushed onto the microkernel stack.
*
* @return N/A
*
* \NOMANUAL
*/
void _timer_int_handler(void *unused)
{
ARG_UNUSED(unused);

View file

@ -158,10 +158,7 @@ extern struct nano_stack _k_command_stack;
* This routine sets the timer for periodic mode.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void periodic_mode_set(void)
{
*_REG_TIMER |= LOAPIC_TIMER_PERIODIC;
@ -177,10 +174,7 @@ static inline void periodic_mode_set(void)
* This routine disables the LOAPIC timer by masking it.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void timer_interrupt_mask(void)
{
*_REG_TIMER |= LOAPIC_LVT_MASKED;
@ -196,10 +190,7 @@ static inline void timer_interrupt_mask(void)
* This routine enables the LOAPIC timer by unmasking it.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void timer_interrupt_unmask(void)
{
*_REG_TIMER &= ~LOAPIC_LVT_MASKED;
@ -214,10 +205,7 @@ static inline void timer_interrupt_unmask(void)
* Note that setting the value to zero stops the timer.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void initial_count_register_set(
uint32_t count /* count from which timer is to count down */
)
@ -233,10 +221,7 @@ static inline void initial_count_register_set(
* This routine sets the timer for one shot mode.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void one_shot_mode_set(void)
{
*_REG_TIMER &= ~LOAPIC_TIMER_PERIODIC;
@ -251,10 +236,7 @@ static inline void one_shot_mode_set(void)
* external bus frequency.
*
* @return N/A
*
* \NOMANUAL
*/
static inline void divide_configuration_register_set(void)
{
*_REG_TIMER_CFG = (*_REG_TIMER_CFG & ~0xf) | LOAPIC_TIMER_DIVBY_1;
@ -269,8 +251,6 @@ static inline void divide_configuration_register_set(void)
* interrupt.
*
* @return N/A
*
* \NOMANUAL
*/
static inline uint32_t current_count_register_get(void)
{
@ -285,8 +265,6 @@ static inline uint32_t current_count_register_get(void)
* This routine gets the value from the initial count register.
*
* @return N/A
*
* \NOMANUAL
*/
static inline uint32_t initial_count_register_get(void)
{
@ -303,7 +281,6 @@ static inline uint32_t initial_count_register_get(void)
*
* @return N/A
*/
void _timer_int_handler(void *unused /* parameter is not used */
)
{
@ -399,10 +376,7 @@ void _timer_int_handler(void *unused /* parameter is not used */
* "tickless idle".
*
* @return N/A
*
* \NOMANUAL
*/
static void tickless_idle_init(void)
{
/*
@ -426,7 +400,6 @@ static void tickless_idle_init(void)
*
* @return N/A
*/
void _timer_idle_enter(int32_t ticks /* system ticks */
)
{
@ -482,7 +455,6 @@ void _timer_idle_enter(int32_t ticks /* system ticks */
*
* @return N/A
*/
void _timer_idle_exit(void)
{
uint32_t remaining_cycles;
@ -578,7 +550,6 @@ void _timer_idle_exit(void)
*
* @return 0
*/
int _sys_clock_driver_init(struct device *device)
{
ARG_UNUSED(device);
@ -617,7 +588,6 @@ int _sys_clock_driver_init(struct device *device)
*
* @return up counter of elapsed clock cycles
*/
uint32_t _sys_clock_cycle_get(void)
{
uint32_t val; /* system clock value */
@ -655,7 +625,6 @@ FUNC_ALIAS(_sys_clock_cycle_get, task_cycle_get_32, uint32_t);
*
* @return N/A
*/
void timer_disable(void)
{
unsigned int key; /* interrupt lock level */

View file

@ -20,8 +20,6 @@
* DESCRIPTION
* This file contains various macros to abstract compiler capabilities that
* utilize toolchain specific attributes and/or pragmas.
*
* \NOMANUAL
*/
#ifndef _TOOLCHAIN_H

View file

@ -19,8 +19,6 @@
/*
* DESCRIPTION
* Macros to abstract compiler capabilities (common to all toolchains).
*
* \NOMANUAL
*/
/*

View file

@ -19,10 +19,7 @@
/*
* DESCRIPTION
* Macros to abstract compiler capabilities for GCC toolchain.
*
* \NOMANUAL
*/
#include <toolchain/common.h>
#define FUNC_ALIAS(real_func, new_alias, return_type) \

View file

@ -38,8 +38,6 @@
* @param ticks the number of ticks to idle
*
* @return N/A
*
* \NOMANUAL
*/
void nano_cpu_set_idle(int32_t ticks)
{

View file

@ -78,8 +78,6 @@
* 0000000c A __tNANO_nested_OFFSET
* 00000000 A __tNANO_fiber_OFFSET
* 00000004 A __tNANO_task_OFFSET
*
* \NOMANUAL
*/
#ifndef _GEN_OFFSET_H

View file

@ -193,8 +193,6 @@ void *nano_task_lifo_get_wait(struct nano_lifo *lifo)
* @param lifo LIFO from which to receive.
*
* @return Pointer to first element in the list
*
* \NOMANUAL
*/
void *_nano_fiber_lifo_get_panic(struct nano_lifo *lifo)
{

View file

@ -44,10 +44,7 @@ int example_handler (int event);
* @brief Event signal speed test
*
* @return N/A
*
* \NOMANUAL
*/
void event_test(void)
{
int nReturn;
@ -168,10 +165,7 @@ void event_test(void)
* This variable is used in the main test.
*
* @return 1
*
* \NOMANUAL
*/
int example_handler (int event)
{
nEventValue = event + 1;

View file

@ -25,10 +25,7 @@
* @brief Queue transfer speed test
*
* @return N/A
*
* \NOMANUAL
*/
void queue_test(void)
{
uint32_t et; /* elapsed time */

View file

@ -27,10 +27,7 @@
* @brief Data receive task
*
* @return N/A
*
* \NOMANUAL
*/
void dequtask(void)
{
int x, i;

View file

@ -81,10 +81,7 @@ void mailbox_put(uint32_t size, int count, uint32_t *time);
* @brief Mailbox transfer speed test
*
* @return N/A
*
* \NOMANUAL
*/
void mailbox_test(void)
{
uint32_t putsize;
@ -131,15 +128,12 @@ void mailbox_test(void)
*
* @brief Write the number of data chunks into the mailbox
*
* @return N/A
*
* @param size The size of the data chunk.
* @param count Number of data chunks.
* @param time The total time.
*
* \NOMANUAL
* @return N/A
*/
void mailbox_put(uint32_t size, int count, uint32_t *time)
{
int i;

View file

@ -37,10 +37,7 @@ int mailbox_get(kmbox_t mailbox,int size,int count,unsigned int* time);
* @brief Receive task
*
* @return N/A
*
* \NOMANUAL
*/
void mailrecvtask(void)
{
int getsize;
@ -77,10 +74,7 @@ void mailrecvtask(void)
* @param size Size of each data portion.
* @param count Number of data portions.
* @param time Resulting time.
*
* \NOMANUAL
*/
int mailbox_get(kmbox_t mailbox, int size, int count, unsigned int* time)
{
int i;

View file

@ -52,10 +52,7 @@ uint32_t tm_off;
* @brief Check for keypress
*
* @return 1 when a keyboard key is pressed, or 0 if no keyboard support
*
* \NOMANUAL
*/
int kbhit(void)
{
return 0;
@ -70,10 +67,7 @@ int kbhit(void)
*
* @param continuously Run test till the user presses the key.
* @param autorun Expect user input.
*
* \NOMANUAL
*/
void init_output(int *continuously, int *autorun)
{
ARG_UNUSED(continuously);
@ -90,10 +84,7 @@ void init_output(int *continuously, int *autorun)
* @brief Close output for the test
*
* @return N/A
*
* \NOMANUAL
*/
void output_close(void)
{
}
@ -105,13 +96,10 @@ void output_close(void)
/**
*
* @brief Perform all selected benchmarks
* see config.h to select or to unselect
*
* @return N/A
*
* \NOMANUAL
*/
/* see config.h to select or to unselect*/
void BenchTask(void)
{
int autorun = 0, continuously = 0;
@ -158,10 +146,7 @@ void BenchTask(void)
* @brief Dummy test
*
* @return N/A
*
* \NOMANUAL
*/
void dummy_test(void)
{
return;

View file

@ -27,10 +27,7 @@
* @brief Memory map get/free test
*
* @return N/A
*
* \NOMANUAL
*/
void memorymap_test(void)
{
uint32_t et; /* elapsed time */

View file

@ -25,10 +25,7 @@
* @brief Memory pool get/free test
*
* @return N/A
*
* \NOMANUAL
*/
void mempool_test(void)
{
uint32_t et; /* elapsed time */

View file

@ -25,10 +25,7 @@
* @brief Mutex lock/unlock test
*
* @return N/A
*
* \NOMANUAL
*/
void mutex_test(void)
{
uint32_t et; /* elapsed time */

View file

@ -29,10 +29,7 @@ extern void _task_nop(void);
* @brief Kernel entry timing test
*
* @return N/A
*
* \NOMANUAL
*/
void call_test(void)
{
uint32_t et; /* Elapsed Time */

View file

@ -98,10 +98,7 @@ int pipeput(kpipe_t pipe, K_PIPE_OPTION
* @brief Test the pipes transfer speed
*
* @return N/A
*
* \NOMANUAL
*/
void pipe_test(void)
{
uint32_t putsize;
@ -199,10 +196,7 @@ void pipe_test(void)
* @param size Data chunk size.
* @param count Number of data chunks.
* @param time Total write time.
*
* \NOMANUAL
*/
int pipeput(kpipe_t pipe, K_PIPE_OPTION option, int size, int count, uint32_t *time)
{
int i;

View file

@ -38,10 +38,7 @@ int pipeget(kpipe_t pipe, K_PIPE_OPTION option,
* @brief Receive task
*
* @return N/A
*
* \NOMANUAL
*/
void piperecvtask(void)
{
int getsize;
@ -95,10 +92,7 @@ void piperecvtask(void)
* @param size Data chunk size.
* @param count Number of data chunks.
* @param time Total write time.
*
* \NOMANUAL
*/
int pipeget(kpipe_t pipe, K_PIPE_OPTION option, int size, int count,
unsigned int* time)
{

View file

@ -39,10 +39,7 @@ void piperecvtask(void);
* @brief Main function of the task that receives data in the test
*
* @return N/A
*
* \NOMANUAL
*/
void recvtask(void)
{
/* order must be compatible with master.c ! */

View file

@ -26,10 +26,7 @@
* @brief Semaphore signal speed test
*
* @return N/A
*
* \NOMANUAL
*/
void sema_test(void)
{
uint32_t et; /* elapsed Time */

View file

@ -28,10 +28,7 @@
* @brief Receive task (Wait task)
*
* @return N/A
*
* \NOMANUAL
*/
void waittask(void)
{
int i;

View file

@ -119,7 +119,6 @@ static pfunc func_array[] = {
*
* @return N/A
*/
void dummyIsr(void *unused)
{
ARG_UNUSED(unused);
@ -136,7 +135,6 @@ void dummyIsr(void *unused)
*
* @return N/A
*/
static void isrDummyIntStub(void *unused)
{
ARG_UNUSED(unused);
@ -155,10 +153,7 @@ static void isrDummyIntStub(void *unused)
* (Gdb can be used to observe the counter as it increases.)
*
* @return N/A
*
* \NOMANUAL
*/
void fgTaskEntry(void)
{
#ifdef TEST_max

View file

@ -35,10 +35,7 @@ int errorCount = 0; /* track number of errors */
* @brief Test latency of nanokernel
*
* @return N/A
*
* \NOMANUAL
*/
void nanoTest(void)
{
PRINT_NANO_BANNER();
@ -66,10 +63,7 @@ void nanoTest(void)
* @brief Nanokernel-only testing entry point
*
* @return N/A
*
* \NOMANUAL
*/
void main(void)
{
bench_test_init();
@ -93,10 +87,7 @@ void microTaskSwitchYield(void);
* @brief Test latency of microkernel
*
* @return N/A
*
* \NOMANUAL
*/
void microTest(void)
{
PRINT_MICRO_BANNER();
@ -123,10 +114,7 @@ void microTest(void)
* @brief Microkernel testing entry point
*
* @return N/A
*
* \NOMANUAL
*/
void microMain(void)
{
bench_test_init();

View file

@ -39,10 +39,7 @@ static uint32_t timestamp;
* The interrupt handler gets the second timestamp.
*
* @return N/A
*
* \NOMANUAL
*/
static void latencyTestIsr(void *unused)
{
ARG_UNUSED(unused);
@ -59,10 +56,7 @@ static void latencyTestIsr(void *unused)
* gets the first timestamp and invokes the software interrupt.
*
* @return N/A
*
* \NOMANUAL
*/
static void makeInt(void)
{
initSwInterrupt(latencyTestIsr);
@ -80,10 +74,7 @@ static void makeInt(void)
* @brief The test main function
*
* @return 0 on success
*
* \NOMANUAL
*/
int microIntToTask(void)
{
PRINT_FORMAT(" 1- Measure time to switch from ISR to back to"

View file

@ -41,10 +41,7 @@ static uint32_t timestamp = 0;
* The interrupt handler gets the second timestamp.
*
* @return N/A
*
* \NOMANUAL
*/
static void latencyTestIsr(void *unused)
{
ARG_UNUSED(unused);
@ -62,10 +59,7 @@ static void latencyTestIsr(void *unused)
* software interrupt
*
* @return 0 on success
*
* \NOMANUAL
*/
void microInt(void)
{
task_sem_take_wait(INTSEMA);
@ -79,10 +73,7 @@ void microInt(void)
* @brief The test main function
*
* @return 0 on success
*
* \NOMANUAL
*/
int microIntToTaskEvt(void)
{
PRINT_FORMAT(" 2- Measure time from ISR to executing a different task"

View file

@ -47,10 +47,7 @@ static uint32_t timestamp;
* acquires them in order to measure the necessary time.
*
* @return 0 on success
*
* \NOMANUAL
*/
int microSemaLockUnlock(void)
{
int i;
@ -97,10 +94,7 @@ int microSemaLockUnlock(void)
* unlocks to measure the necessary time.
*
* @return 0 on success
*
* \NOMANUAL
*/
int microMutexLockUnlock(void)
{
int i;

View file

@ -43,10 +43,7 @@ static uint32_t helper_task_iterations = 0;
* This task is define in .mdef as SEMYIELDTSK
*
* @return N/A
*
* \NOMANUAL
*/
void yieldingTask(void)
{
while (helper_task_iterations < NB_OF_YIELD) {
@ -60,10 +57,7 @@ void yieldingTask(void)
* @brief Entry point for task context switch using yield test
*
* @return N/A
*
* \NOMANUAL
*/
void microTaskSwitchYield(void)
{
uint32_t iterations = 0;

View file

@ -58,10 +58,7 @@ static volatile int ctxSwitchBalancer = 0;
* gets the first timestamp and invokes the software interrupt.
*
* @return N/A
*
* \NOMANUAL
*/
static void fiberOne(void)
{
nano_fiber_sem_take_wait(&syncSema);
@ -82,10 +79,7 @@ static void fiberOne(void)
* the semaphore, fiber measures the time.
*
* @return 0 on success
*
* \NOMANUAL
*/
static void fiberTwo(void)
{
nano_fiber_sem_give(&syncSema);
@ -101,10 +95,7 @@ static void fiberTwo(void)
* @brief The test main function
*
* @return 0 on success
*
* \NOMANUAL
*/
int nanoCtxSwitch(void)
{
PRINT_FORMAT(" 4- Measure average context switch time between fibers");

View file

@ -41,10 +41,7 @@ static uint32_t timestamp;
* The interrupt handler gets the second timestamp.
*
* @return N/A
*
* \NOMANUAL
*/
static void latencyTestIsr(void *unused)
{
ARG_UNUSED(unused);
@ -60,10 +57,7 @@ static void latencyTestIsr(void *unused)
* gets the first timestamp and invokes the software interrupt.
*
* @return N/A
*
* \NOMANUAL
*/
static void fiberInt(void)
{
initSwInterrupt(latencyTestIsr);
@ -76,10 +70,7 @@ static void fiberInt(void)
* @brief The test main function
*
* @return 0 on success
*
* \NOMANUAL
*/
int nanoIntLatency(void)
{
PRINT_FORMAT(" 1- Measure time to switch from fiber to ISR execution");

View file

@ -40,10 +40,7 @@ static uint32_t timestamp = 0;
* @brief The test main function
*
* @return 0 on success
*
* \NOMANUAL
*/
int nanoIntLockUnlock(void)
{
int i;

View file

@ -43,10 +43,7 @@ static uint32_t timestamp;
* The interrupt handler gets the second timestamp.
*
* @return N/A
*
* \NOMANUAL
*/
static void latencyTestIsr(void *unused)
{
ARG_UNUSED(unused);
@ -63,10 +60,7 @@ static void latencyTestIsr(void *unused)
* gets the first timestamp and invokes the software interrupt.
*
* @return N/A
*
* \NOMANUAL
*/
static void fiberInt(void)
{
setSwInterrupt(latencyTestIsr);
@ -84,10 +78,7 @@ static void fiberInt(void)
* @brief The test main function
*
* @return 0 on success
*
* \NOMANUAL
*/
int nanoIntToFiber(void)
{
PRINT_FORMAT(" 2- Measure time to switch from ISR back to interrupted"

View file

@ -54,10 +54,7 @@ static uint32_t timestamp = 0;
* The interrupt handler gets the second timestamp.
*
* @return N/A
*
* \NOMANUAL
*/
static void latencyTestIsr(void *unused)
{
ARG_UNUSED(unused);
@ -74,10 +71,7 @@ static void latencyTestIsr(void *unused)
* gets the first timestamp and invokes the software interrupt.
*
* @return N/A
*
* \NOMANUAL
*/
static void fiberInt(void)
{
setSwInterrupt(latencyTestIsr);
@ -93,10 +87,7 @@ static void fiberInt(void)
* the semaphore, fiber measures the time.
*
* @return N/A
*
* \NOMANUAL
*/
static void fiberWaiter(void)
{
nano_fiber_sem_take_wait(&testSema);
@ -108,10 +99,7 @@ static void fiberWaiter(void)
* @brief The test main function
*
* @return 0 on success
*
* \NOMANUAL
*/
int nanoIntToFiberSem(void)
{
PRINT_FORMAT(" 3- Measure time from ISR to executing a different fiber"

View file

@ -1382,8 +1382,6 @@ static void (*intFPtr[256])(void) = {
* value passed to it (which is essentially the interrupt vector number).
*
* @return N/A
*
* \NOMANUAL
*/
void raiseInt(uint8_t id)
{
@ -1400,10 +1398,7 @@ void raiseInt(uint8_t id)
* Trigger via NVIC. <id> is the IRQ number.
*
* @return N/A
*
* \NOMANUAL
*/
void raiseInt(uint8_t id)
{
_NvicSwInterruptTrigger((unsigned int)id);

View file

@ -44,10 +44,7 @@ char tmpString[TMP_STRING_SIZE];
* the current interrupt service routine and stub code memory block.
*
* @return the allocated interrupt vector
*
* \NOMANUAL
*/
int initSwInterrupt(ptestIsr pIsrHdlr)
{
vector = irq_connect(NANO_SOFT_IRQ, IRQ_PRIORITY, pIsrHdlr,
@ -66,10 +63,7 @@ int initSwInterrupt(ptestIsr pIsrHdlr)
* initialized and connected by initSwInterrupt.
*
* @return N/A
*
* \NOMANUAL
*/
void setSwInterrupt(ptestIsr pIsrHdlr)
{
extern void _irq_handler_set(unsigned int irq, void (*old)(void *arg),
@ -88,8 +82,6 @@ void setSwInterrupt(ptestIsr pIsrHdlr)
* initialized and connected by initSwInterrupt.
*
* @return N/A
*
* \NOMANUAL
*/
void raiseIntFunc(void)
{

View file

@ -48,10 +48,7 @@ extern int errorCount;
* @brief Print dash line
*
* @return N/A
*
* \NOMANUAL
*/
static inline void printDashLine(void)
{
PRINTF("|-----------------------------------------------------------------"
@ -109,10 +106,7 @@ typedef void (*ptestIsr) (void *unused);
* the current interrupt service routine and stub code memory block.
*
* @return the allocated interrupt vector
*
* \NOMANUAL
*/
int initSwInterrupt(ptestIsr pIsrHdlr);
/**
@ -124,8 +118,5 @@ int initSwInterrupt(ptestIsr pIsrHdlr);
* initialized and connected by initSwInterrupt.
*
* @return N/A
*
* \NOMANUAL
*/
void setSwInterrupt(ptestIsr pIsrHdlr);

View file

@ -1382,8 +1382,6 @@ static void (*intFPtr[256])(void) = {
* value passed to it (which is essentially the interrupt vector number).
*
* @return N/A
*
* \NOMANUAL
*/
void raiseInt(uint8_t id)
{
@ -1400,10 +1398,7 @@ void raiseInt(uint8_t id)
* Trigger via NVIC. <id> is the IRQ number.
*
* @return N/A
*
* \NOMANUAL
*/
void raiseInt(uint8_t id)
{
_NvicSwInterruptTrigger((unsigned int)id);

View file

@ -64,10 +64,7 @@ Platform-specific timestamp support for the tickless idle test.
* This routine initializes the timestamp timer.
*
* @return N/A
*
* \NOMANUAL
*/
void _TimestampOpen(void)
{
/* QEMU does not currently support the 32-bit timer modes of the GPTM */
@ -96,10 +93,7 @@ void _TimestampOpen(void)
* This routine returns the timestamp value.
*
* @return timestamp value
*
* \NOMANUAL
*/
uint32_t _TimestampRead(void)
{
static uint32_t lastTimerVal = 0;
@ -132,10 +126,7 @@ uint32_t _TimestampRead(void)
* This routine releases the timestamp timer.
*
* @return N/A
*
* \NOMANUAL
*/
void _TimestampClose(void)
{
@ -179,10 +170,7 @@ void _TimestampClose(void)
* This routine initializes the timestamp timer.
*
* @return N/A
*
* \NOMANUAL
*/
void _TimestampOpen(void)
{
/* enable timer access */
@ -216,10 +204,7 @@ void _TimestampOpen(void)
* This routine returns the timestamp value.
*
* @return timestamp value
*
* \NOMANUAL
*/
uint32_t _TimestampRead(void)
{
static uint32_t lastPrescale = 0;
@ -253,10 +238,7 @@ uint32_t _TimestampRead(void)
* This routine releases the timestamp timer.
*
* @return N/A
*
* \NOMANUAL
*/
void _TimestampClose(void)
{
_TIMESTAMP_STATUS = 0x0; /* disable counter */

View file

@ -28,10 +28,7 @@ static struct nano_fifo nanoFifo_sync; /* for synchronization */
* @brief Initialize LIFOs for the test
*
* @return N/A
*
* \NOMANUAL
*/
void lifo_test_init(void)
{
nano_lifo_init(&nanoLifo1);
@ -47,10 +44,7 @@ void lifo_test_init(void)
* @param par2 Number of test loops.
*
* @return N/A
*
* \NOMANUAL
*/
void lifo_fiber1(int par1, int par2)
{
int i;
@ -87,10 +81,7 @@ void lifo_fiber1(int par1, int par2)
* @param par2 Number of test cycles.
*
* @return N/A
*
* \NOMANUAL
*/
void lifo_fiber2(int par1, int par2)
{
int i;
@ -119,10 +110,7 @@ void lifo_fiber2(int par1, int par2)
* @param par2 Number of test loops.
*
* @return N/A
*
* \NOMANUAL
*/
void lifo_fiber3(int par1, int par2)
{
int i;
@ -150,10 +138,7 @@ void lifo_fiber3(int par1, int par2)
* @brief The main test entry
*
* @return 1 if success and 0 on failure
*
* \NOMANUAL
*/
int lifo_test(void)
{
uint32_t t;

View file

@ -29,10 +29,7 @@ static struct nano_fifo nanoFifo_sync; /* for synchronization */
* @brief Initialize FIFOs for the test
*
* @return N/A
*
* \NOMANUAL
*/
void fifo_test_init(void)
{
nano_fifo_init(&nanoFifo1);
@ -44,14 +41,11 @@ void fifo_test_init(void)
*
* @brief Fifo test fiber
*
* @return N/A
*
* @param par1 Ignored parameter.
* @param par2 Number of test loops.
*
* \NOMANUAL
* @return N/A
*/
void fifo_fiber1(int par1, int par2)
{
int i;
@ -76,14 +70,11 @@ void fifo_fiber1(int par1, int par2)
*
* @brief Fifo test fiber
*
* @return N/A
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
*
* \NOMANUAL
* @return N/A
*/
void fifo_fiber2(int par1, int par2)
{
int i;
@ -109,14 +100,11 @@ void fifo_fiber2(int par1, int par2)
*
* @brief Fifo test fiber
*
* @return N/A
*
* @param par1 Address of the counter.
* @param par2 Number of test cycles.
*
* \NOMANUAL
* @return N/A
*/
void fifo_fiber3(int par1, int par2)
{
int i;
@ -145,10 +133,7 @@ void fifo_fiber3(int par1, int par2)
* @brief The main test entry
*
* @return 1 if success and 0 on failure
*
* \NOMANUAL
*/
int fifo_test(void)
{
uint32_t t;

View file

@ -26,10 +26,7 @@ struct nano_sem nanoSem2;
* @brief Initialize semaphores for the test
*
* @return N/A
*
* \NOMANUAL
*/
void sema_test_init(void)
{
nano_sem_init(&nanoSem1);
@ -45,10 +42,7 @@ void sema_test_init(void)
* @param par2 Number of test loops.
*
* @return N/A
*
* \NOMANUAL
*/
void sema_fiber1(int par1, int par2)
{
int i;
@ -70,10 +64,7 @@ void sema_fiber1(int par1, int par2)
* @param par2 Number of test cycles.
*
* @return N/A
*
* \NOMANUAL
*/
void sema_fiber2(int par1, int par2)
{
int i;
@ -94,10 +85,7 @@ void sema_fiber2(int par1, int par2)
* @param par2 Number of test cycles.
*
* @return N/A
*
* \NOMANUAL
*/
void sema_fiber3(int par1, int par2)
{
int i;
@ -118,10 +106,7 @@ void sema_fiber3(int par1, int par2)
* @brief The main test entry
*
* @return 1 if success and 0 on failure
*
* \NOMANUAL
*/
int sema_test(void)
{
uint32_t t;

View file

@ -30,9 +30,7 @@ uint32_t stack2[2];
*
* @return N/A
*
* \NOMANUAL
*/
void stack_test_init(void)
{
nano_stack_init(&nano_stack_1, stack1);
@ -49,9 +47,7 @@ void stack_test_init(void)
*
* @return N/A
*
* \NOMANUAL
*/
void stack_fiber1(int par1, int par2)
{
int i;
@ -85,9 +81,7 @@ void stack_fiber1(int par1, int par2)
*
* @return N/A
*
* \NOMANUAL
*/
void stack_fiber2(int par1, int par2)
{
int i;
@ -115,9 +109,7 @@ void stack_fiber2(int par1, int par2)
*
* @return N/A
*
* \NOMANUAL
*/
void stack_fiber3(int par1, int par2)
{
int i;
@ -145,9 +137,7 @@ void stack_fiber3(int par1, int par2)
*
* @return 1 if success and 0 on failure
*
* \NOMANUAL
*/
int stack_test(void)
{
uint32_t t;

View file

@ -64,8 +64,6 @@ uint32_t tm_off;
* Routine does necessary preparations for the test to start
*
* @return N/A
*
* \NOMANUAL
*/
void begin_test(void)
{
@ -84,10 +82,7 @@ void begin_test(void)
*
* @param i Number of tests.
* @param t Time in ticks for the whole test.
*
* \NOMANUAL
*/
int check_result(int i, uint32_t t)
{
/*
@ -124,10 +119,7 @@ int check_result(int i, uint32_t t)
* @brief Check for a key press
*
* @return 1 when a keyboard key is pressed, or 0 if no keyboard support
*
* \NOMANUAL
*/
int kbhit(void)
{
return 0;
@ -138,11 +130,9 @@ int kbhit(void)
*
* @brief Prepares the test output
*
* @return N/A
*
* @param continuously Run test till the user presses the key.
*
* \NOMANUAL
* @return N/A
*/
void init_output(int *continuously)
@ -161,10 +151,7 @@ void init_output(int *continuously)
* @brief Close output for the test
*
* @return N/A
*
* \NOMANUAL
*/
void output_close(void)
{
}
@ -174,10 +161,7 @@ void output_close(void)
* @brief Perform all selected benchmarks
*
* @return N/A
*
* \NOMANUAL
*/
#ifdef CONFIG_MICROKERNEL
void SysKernelBench(void)
#else