doxygen: change comment style to match javadoc
The change replaces multiple asterisks to ** at the beginning of comments and adds a space before the asterisks at the beginning of lines. Change-Id: I7656bde3bf4d9a31e38941e43b580520432dabc1 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
parent
20764a2e8d
commit
ea0d0b220c
305 changed files with 11249 additions and 11249 deletions
|
@ -35,7 +35,7 @@ DESCRIPTION
|
|||
|
||||
Interrupt management: enabling/disabling and dynamic ISR connecting/replacing.
|
||||
SW_ISR_TABLE_DYNAMIC has to be enabled for connecting ISRs at runtime.
|
||||
*/
|
||||
*/
|
||||
|
||||
#include <nanokernel.h>
|
||||
#include <arch/cpu.h>
|
||||
|
@ -46,18 +46,18 @@ SW_ISR_TABLE_DYNAMIC has to be enabled for connecting ISRs at runtime.
|
|||
|
||||
extern void __reserved(void);
|
||||
|
||||
/*******************************************************************************
|
||||
*
|
||||
* irq_handler_set - 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.
|
||||
*
|
||||
* This routine will hang if <old> is not found in the table and ASSERT_ON is
|
||||
* enabled.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
/**
|
||||
*
|
||||
* irq_handler_set - 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.
|
||||
*
|
||||
* This routine will hang if <old> is not found in the table and ASSERT_ON is
|
||||
* enabled.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
|
||||
void irq_handler_set(unsigned int irq,
|
||||
void (*old)(void *arg),
|
||||
|
@ -76,16 +76,16 @@ void irq_handler_set(unsigned int irq,
|
|||
irq_unlock_inline(key);
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
*
|
||||
* irq_enable - 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
|
||||
* <irq>.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
/**
|
||||
*
|
||||
* irq_enable - 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
|
||||
* <irq>.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
|
||||
void irq_enable(unsigned int irq)
|
||||
{
|
||||
|
@ -94,35 +94,35 @@ void irq_enable(unsigned int irq)
|
|||
_NvicIrqEnable(irq);
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
*
|
||||
* irq_disable - disable an interrupt line
|
||||
*
|
||||
* Disable an interrupt line. After this call, the CPU will stop receiving
|
||||
* interrupts for the specified <irq>.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
/**
|
||||
*
|
||||
* irq_disable - disable an interrupt line
|
||||
*
|
||||
* Disable an interrupt line. After this call, the CPU will stop receiving
|
||||
* interrupts for the specified <irq>.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
|
||||
void irq_disable(unsigned int irq)
|
||||
{
|
||||
_NvicIrqDisable(irq);
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
*
|
||||
* irq_priority_set - 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
|
||||
* installed with priority 1 interrupts cannot make kernel calls.
|
||||
*
|
||||
* Priority 0 is reserved for kernel usage and cannot be used.
|
||||
*
|
||||
* The priority is verified if ASSERT_ON is enabled.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
/**
|
||||
*
|
||||
* irq_priority_set - 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
|
||||
* installed with priority 1 interrupts cannot make kernel calls.
|
||||
*
|
||||
* Priority 0 is reserved for kernel usage and cannot be used.
|
||||
*
|
||||
* The priority is verified if ASSERT_ON is enabled.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
|
||||
void irq_priority_set(unsigned int irq,
|
||||
unsigned int prio)
|
||||
|
@ -131,17 +131,17 @@ void irq_priority_set(unsigned int irq,
|
|||
_NvicIrqPrioSet(irq, _EXC_PRIO(prio));
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
*
|
||||
* _irq_spurious - spurious interrupt handler
|
||||
*
|
||||
* Installed in all dynamic interrupt slots at boot time. Throws an error if
|
||||
* called.
|
||||
*
|
||||
* See __reserved().
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
/**
|
||||
*
|
||||
* _irq_spurious - spurious interrupt handler
|
||||
*
|
||||
* Installed in all dynamic interrupt slots at boot time. Throws an error if
|
||||
* called.
|
||||
*
|
||||
* See __reserved().
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
|
||||
void _irq_spurious(void *unused)
|
||||
{
|
||||
|
@ -149,18 +149,18 @@ void _irq_spurious(void *unused)
|
|||
__reserved();
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
*
|
||||
* irq_connect - connect an ISR to an interrupt line
|
||||
*
|
||||
* <isr> is connected to interrupt line <irq> (exception #<irq>+16). No prior
|
||||
* ISR can have been connected on <irq> interrupt line since the system booted.
|
||||
*
|
||||
* This routine will hang if another ISR was connected for interrupt line <irq>
|
||||
* and ASSERT_ON is enabled; if ASSERT_ON is disabled, it will fail silently.
|
||||
*
|
||||
* RETURNS: the interrupt line number
|
||||
*/
|
||||
/**
|
||||
*
|
||||
* irq_connect - connect an ISR to an interrupt line
|
||||
*
|
||||
* <isr> is connected to interrupt line <irq> (exception #<irq>+16). No prior
|
||||
* ISR can have been connected on <irq> interrupt line since the system booted.
|
||||
*
|
||||
* This routine will hang if another ISR was connected for interrupt line <irq>
|
||||
* and ASSERT_ON is enabled; if ASSERT_ON is disabled, it will fail silently.
|
||||
*
|
||||
* RETURNS: the interrupt line number
|
||||
*/
|
||||
|
||||
int irq_connect(unsigned int irq,
|
||||
unsigned int prio,
|
||||
|
@ -172,16 +172,16 @@ int irq_connect(unsigned int irq,
|
|||
return irq;
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
*
|
||||
* irq_disconnect - disconnect an ISR from an interrupt line
|
||||
*
|
||||
* Interrupt line <irq> (exception #<irq>+16) is disconnected from its ISR and
|
||||
* the latter is replaced by _irq_spurious(). irq_disable() should have
|
||||
* been called before invoking this routine.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
/**
|
||||
*
|
||||
* irq_disconnect - disconnect an ISR from an interrupt line
|
||||
*
|
||||
* Interrupt line <irq> (exception #<irq>+16) is disconnected from its ISR and
|
||||
* the latter is replaced by _irq_spurious(). irq_disable() should have
|
||||
* been called before invoking this routine.
|
||||
*
|
||||
* RETURNS: N/A
|
||||
*/
|
||||
|
||||
void irq_disconnect(unsigned int irq)
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue