michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doxygen: add @brief and capitalize

Browse source 
Remove function name from comment and add @brief instead.
Also capitilize first letter.

Change-Id: Ib708b49bf02e5bc89b0066637a55874e659637e0
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-07-01 17:51:40 -04:00
commit f367f071b6
223 changed files with 1146 additions and 1147 deletions
Download patch file Download diff file Expand all files Collapse all files

6
drivers/interrupt_controller/arcv2_irq_unit.c
View file

@ -44,7 +44,7 @@
#include <board.h>
/*
* _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 <irq> to trigger an interrupt based on the level or the
* edge of the signal. Valid values for <trigger> are _ARC_V2_INT_LEVEL and

12
drivers/interrupt_controller/i8259.c
View file

@ -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 <enable> 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.
*

4
drivers/interrupt_controller/i8259_boi.S
View file

@ -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

30
drivers/interrupt_controller/ioapic_intr.c
View file

@ -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 <value> into the RTE configuration
* register for the specified <irq> (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 <value> into the redirection register
* specified by <reg>.

14
drivers/interrupt_controller/loapic_intr.c
View file

@ -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
*

20
drivers/interrupt_controller/system_apic.c
View file

@ -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

8
drivers/interrupt_controller/system_pic.c
View file

@ -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.