michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Fix up API description for IRQ_CONNECT()

Browse source 
Change-Id: I5ea1bd28f355d78c724948568c160ef1b32b5eb5
Signed-off-by: Allan Stephens <allan.stephens@windriver.com>
This commit is contained in:
Allan Stephens 2016-11-16 16:44:06 -05:00 • committed by Anas Nashif
commit fb513eb1c8
1 changed files with 14 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

22
include/irq.h
View file

@ -38,17 +38,23 @@ extern "C" {
*/
/**
* Configure a static interrupt.
* @brief Initialize an interrupt handler.
*
* All arguments must be computable by the compiler at build time.
* This routine initializes an interrupt handler for an IRQ. The IRQ must be
* subsequently enabled before the interrupt handler begins servicing
* interrupts.
*
* @param irq_p IRQ line number
* @param priority_p Interrupt priority
* @param isr_p Interrupt service routine
* @param isr_param_p ISR parameter
* @param flags_p Arch-specific IRQ configuration flags
* @warning
* Although this routine is invoked at run-time, all of its arguments must be
* computable by the compiler at build time.
*
* @return The vector assigned to this interrupt
* @param irq_p IRQ line number.
* @param priority_p Interrupt priority.
* @param isr_p Address of interrupt service routine.
* @param isr_param_p Parameter passed to interrupt service routine.
* @param flags_p Architecture-specific IRQ configuration flags..
*
* @return Interrupt vector assigned to this interrupt.
*/
#define IRQ_CONNECT(irq_p, priority_p, isr_p, isr_param_p, flags_p) \
_ARCH_IRQ_CONNECT(irq_p, priority_p, isr_p, isr_param_p, flags_p)