doxygen: add @brief and capitalize 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>
diff --git a/drivers/console/uart_console.c b/drivers/console/uart_console.c index 7791fee..30a9a04 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 @@ #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 @@ /** * - * 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 2ca2cef..afb2b17 100644 --- a/drivers/interrupt_controller/arcv2_irq_unit.c +++ b/drivers/interrupt_controller/arcv2_irq_unit.c
@@ -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 @@ } /* - * _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 @@ } /* - * _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
diff --git a/drivers/interrupt_controller/i8259.c b/drivers/interrupt_controller/i8259.c index 2e58f8d..6fa4144 100644 --- a/drivers/interrupt_controller/i8259.c +++ b/drivers/interrupt_controller/i8259.c
@@ -118,7 +118,7 @@ /** * - * _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 @@ #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 @@ /** * - * _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 @@ /** * - * __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 @@ /** * - * _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 @@ /** * - * _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 7726b08..410df6d 100644 --- a/drivers/interrupt_controller/i8259_boi.S +++ b/drivers/interrupt_controller/i8259_boi.S
@@ -61,7 +61,7 @@ /** * - * _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 @@ /** * - * _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 3e73c74..eda4904 100644 --- a/drivers/interrupt_controller/ioapic_intr.c +++ b/drivers/interrupt_controller/ioapic_intr.c
@@ -211,7 +211,7 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * __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 @@ /** * - * __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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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>.
diff --git a/drivers/interrupt_controller/loapic_intr.c b/drivers/interrupt_controller/loapic_intr.c index 5460e5c..41722be 100644 --- a/drivers/interrupt_controller/loapic_intr.c +++ b/drivers/interrupt_controller/loapic_intr.c
@@ -200,7 +200,7 @@ /** * - * _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 @@ /** * - * _loapic_enable - enable the Local xAPIC + * @brief Enable the Local xAPIC * * This routine enables the Local xAPIC. * @@ -280,7 +280,7 @@ /** * - * _loapic_disable - disable the Local xAPIC + * @brief Disable the Local xAPIC * * This routine disables the Local xAPIC. * @@ -298,7 +298,7 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 5c357f8..41a89ce 100644 --- a/drivers/interrupt_controller/system_apic.c +++ b/drivers/interrupt_controller/system_apic.c
@@ -45,7 +45,7 @@ /** * - * _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 @@ * * 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 @@ /** * - * _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 @@ * * 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 @@ /** * - * 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 @@ /** * - * 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 72e5e4c..c68dcb1 100644 --- a/drivers/interrupt_controller/system_pic.c +++ b/drivers/interrupt_controller/system_pic.c
@@ -47,7 +47,7 @@ /** * - * _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 @@ * * 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 @@ /** * - * _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 43a9e54..2910563 100644 --- a/drivers/pci/pci.c +++ b/drivers/pci/pci.c
@@ -169,7 +169,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ #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 c859d68..4bdb1ad 100644 --- a/drivers/pci/pci_config.c +++ b/drivers/pci/pci_config.c
@@ -54,7 +54,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 4af3252..972b9b9 100644 --- a/drivers/pci/pci_interface.c +++ b/drivers/pci/pci_interface.c
@@ -54,7 +54,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 18672d7..a0ef794 100644 --- a/drivers/random/rand32-timer.c +++ b/drivers/random/rand32-timer.c
@@ -55,7 +55,7 @@ /** * - * 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 @@ /** * - * 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 157d054..fa184a0 100644 --- a/drivers/random/rand32-timestamp.c +++ b/drivers/random/rand32-timestamp.c
@@ -44,7 +44,7 @@ /** * - * 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 @@ /** * - * 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 783abe8..e5f9e66 100644 --- a/drivers/serial/k20UartDrv.c +++ b/drivers/serial/k20UartDrv.c
@@ -61,7 +61,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * uart_fifo_fill - fill FIFO with data + * @brief Fill FIFO with data * @return number of bytes sent */ @@ -183,7 +183,7 @@ /** * - * uart_fifo_read - read data from FIFO + * @brief Read data from FIFO * * @return number of bytes read */ @@ -205,7 +205,7 @@ /** * - * uart_irq_tx_enable - enable TX interrupt + * @brief Enable TX interrupt * * @return N/A */ @@ -221,7 +221,7 @@ /** * - * uart_irq_tx_disable - disable TX interrupt in IER + * @brief Disable TX interrupt in IER * * @return N/A */ @@ -237,7 +237,7 @@ /** * - * 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 @@ /** * - * uart_irq_rx_enable - enable RX interrupt in IER + * @brief Enable RX interrupt in IER * * @return N/A */ @@ -268,7 +268,7 @@ /** * - * uart_irq_rx_disable - disable RX interrupt in IER + * @brief Disable RX interrupt in IER * * @return N/A */ @@ -284,7 +284,7 @@ /** * - * 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 @@ /** * - * uart_irq_err_enable - enable error interrupt + * @brief Enable error interrupt * * @return N/A */ @@ -318,7 +318,7 @@ /** * - * uart_irq_err_disable - disable error interrupt + * @brief Disable error interrupt * * @return N/A */ @@ -338,7 +338,7 @@ /** * - * 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 @@ /** * - * uart_irq_update - update IRQ status + * @brief Update IRQ status * * @return always 1 */ @@ -369,7 +369,7 @@ /** * - * 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 125fc3e..cfb8699 100644 --- a/drivers/serial/ns16550.c +++ b/drivers/serial/ns16550.c
@@ -259,7 +259,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ #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 @@ /** * - * uart_fifo_read - read data from FIFO + * @brief Read data from FIFO * * @return number of bytes read */ @@ -400,7 +400,7 @@ /** * - * uart_irq_tx_enable - enable TX interrupt in IER + * @brief Enable TX interrupt in IER * * @return N/A */ @@ -414,7 +414,7 @@ /** * - * uart_irq_tx_disable - disable TX interrupt in IER + * @brief Disable TX interrupt in IER * * @return N/A */ @@ -427,7 +427,7 @@ /** * - * 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 @@ /** * - * _uart_irq_rx_enable - enable RX interrupt in IER + * @brief Enable RX interrupt in IER * * @return N/A */ @@ -454,7 +454,7 @@ /** * - * uart_irq_rx_disable - disable RX interrupt in IER + * @brief Disable RX interrupt in IER * * @return N/A */ @@ -467,7 +467,7 @@ /** * - * 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 @@ /** * - * uart_irq_err_enable - enable error interrupt in IER + * @brief Enable error interrupt in IER * * @return N/A */ @@ -493,7 +493,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * uart_irq_update - update cached contents of IIR + * @brief Update cached contents of IIR * * @return always 1 */ @@ -534,7 +534,7 @@ /** * - * 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 1fca9f9..6f826af 100644 --- a/drivers/serial/nsim_uart.c +++ b/drivers/serial/nsim_uart.c
@@ -53,7 +53,7 @@ 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 @@ } /* - * 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 da99c71..9e74fb8 100644 --- a/drivers/serial/stellarisUartDrv.c +++ b/drivers/serial/stellarisUartDrv.c
@@ -155,7 +155,7 @@ /** * - * baudrateSet - set the baud rate + * @brief Set the baud rate * * This routine set the given baud rate for the UART. * @@ -186,7 +186,7 @@ /** * - * enable - enable the UART + * @brief Enable the UART * * This routine enables the given UART. * @@ -202,7 +202,7 @@ /** * - * disable - disable the UART + * @brief Disable the UART * * This routine disables the given UART. * @@ -235,7 +235,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * uart_fifo_fill - fill FIFO with data + * @brief Fill FIFO with data * * @return number of bytes sent */ @@ -355,7 +355,7 @@ /** * - * uart_fifo_read - read data from FIFO + * @brief Read data from FIFO * * @return number of bytes read */ @@ -377,7 +377,7 @@ /** * - * uart_irq_tx_enable - enable TX interrupt + * @brief Enable TX interrupt * * @return N/A */ @@ -432,7 +432,7 @@ /** * - * uart_irq_tx_disable - disable TX interrupt in IER + * @brief Disable TX interrupt in IER * * @return N/A */ @@ -447,7 +447,7 @@ /** * - * 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 @@ /** * - * uart_irq_rx_enable - enable RX interrupt in IER + * @brief Enable RX interrupt in IER * * @return N/A */ @@ -477,7 +477,7 @@ /** * - * uart_irq_rx_disable - disable RX interrupt in IER + * @brief Disable RX interrupt in IER * * @return N/A */ @@ -492,7 +492,7 @@ /** * - * 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 @@ /** * - * uart_irq_err_enable - enable error interrupts + * @brief Enable error interrupts * * @return N/A */ @@ -523,7 +523,7 @@ /** * - * uart_irq_err_disable - disable error interrupts + * @brief Disable error interrupts * * @return N/A */ @@ -539,7 +539,7 @@ /** * - * 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 @@ /** * - * uart_irq_update - update IRQ status + * @brief Update IRQ status * * @return always 1 */ @@ -567,7 +567,7 @@ /** * - * 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 e166124..a1f56fc 100644 --- a/drivers/timer/arcv2_timer0.c +++ b/drivers/timer/arcv2_timer0.c
@@ -70,7 +70,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * _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 @@ /** * - * 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 @@ /** * - * 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 @@ #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 84a6d5e..bb006cd 100644 --- a/drivers/timer/cortex_m_timer.c +++ b/drivers/timer/cortex_m_timer.c
@@ -129,7 +129,7 @@ /** * - * sysTickStop - stop the timer + * @brief Stop the timer * * This routine disables the systick counter. * @@ -158,7 +158,7 @@ /** * - * sysTickStart - start the timer + * @brief Start the timer * * This routine enables the systick counter. * @@ -185,7 +185,7 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * _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 @@ /** * - * 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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 3d363e0..6710f09 100644 --- a/drivers/timer/hpet.c +++ b/drivers/timer/hpet.c
@@ -221,7 +221,7 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * 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 @@ /** * - * 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 @@ /** * - * 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 677a26e..f84eefc 100644 --- a/drivers/timer/i8253.c +++ b/drivers/timer/i8253.c
@@ -144,7 +144,7 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ #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 @@ /** * - * _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 @@ #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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * 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 @@ /** * - * 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 @@ #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 2f46fba..f4dec0d 100644 --- a/drivers/timer/loapic_timer.c +++ b/drivers/timer/loapic_timer.c
@@ -134,7 +134,7 @@ /** * - * _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 @@ defined(CONFIG_SYSTEM_TIMER_DISABLE) /** * - * _loApicTimerStop - stop the timer + * @brief Stop the timer * * This routine stops the timer. * @@ -172,7 +172,7 @@ defined(LOAPIC_TIMER_PERIODIC_WORKAROUND) /** * - * _loApicTimerStart - start the timer + * @brief Start the timer * * This routine starts the timer. * @@ -189,7 +189,7 @@ /** * - * _loApicTimerSetCount - set countdown value + * @brief Set countdown value * * This routine sets value from which the timer will count down. * @@ -208,7 +208,7 @@ #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 @@ /** * - * _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 @@ /** * - * _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 @@ #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 @@ /** * - * _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 @@ #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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * _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 @@ /** * - * 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 @@ /** * - * 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 @@ #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.