Make sure that labeling is used consistently in all function headers.

This commit is contained in:
Gregory Nutt 2018-02-01 10:00:02 -06:00
parent a096bc1266
commit 7cf88d7dbd
1171 changed files with 3042 additions and 3039 deletions

View File

@ -377,7 +377,7 @@
* ldr r3, =MMUFLAGS <-- L2 MMU flags
* pg_l2map r0, r1, r2, r3, r4
*
* Inputs:
* Input Parameters:
* l2 - Physical or virtual start address in the L2 page table, depending
* upon the context. (modified)
* ppage - The physical address of the start of the region to span. Must
@ -448,7 +448,7 @@
* ldr r4, =MMU_L1_PGTABFLAGS <-- L1 MMU flags
* pg_l1span r0, r1, r2, r3, r4, r4
*
* Inputs (unmodified unless noted):
* Input Parameters (unmodified unless noted):
* l1 - Physical or virtual address in the L1 table to begin writing (modified)
* l2 - Physical start address in the L2 page table (modified)
* npages - Number of pages to required to span that memory region (modified)
@ -462,7 +462,7 @@
* ppage - After the first page, this will be the full number of pages.
* tmp - scratch
*
* Return:
* Returned Value:
* Nothing of interest.
*
* Assumptions:

View File

@ -62,7 +62,7 @@
* the ready to run list must be stopped. Save its context
* and move it to the inactive list specified by task_state.
*
* Inputs:
* Input Parameters:
* tcb: Refers to a task in the ready-to-run list (normally
* the task at the head of the list). It most be
* stopped, its context saved and moved into one of the

View File

@ -59,7 +59,7 @@
/****************************************************************************
* Name: up_dataabort
*
* Input parameters:
* Input Parameters:
* regs - The standard, ARM register save array.
*
* If CONFIG_PAGING is selected in the NuttX configuration file, then these

View File

@ -68,7 +68,7 @@
* the priority of the current, running task and it now has the
* priority.
*
* Inputs:
* Input Parameters:
* tcb: The TCB of the task that has been reprioritized
* priority: The new task priority
*

View File

@ -61,7 +61,7 @@
* but has been prepped to execute. Move the TCB to the
* ready-to-run list, restore its context, and start execution.
*
* Inputs:
* Input Parameters:
* tcb: Refers to the tcb to be unblocked. This tcb is
* in one of the waiting tasks lists. It must be moved to
* the ready-to-run list and, if it is the highest priority

View File

@ -86,10 +86,10 @@
* 5) up_vfork() then calls task_vforkstart()
* 6) task_vforkstart() then executes the child thread.
*
* Input Paremeters:
* Input Parameters:
* None
*
* Return:
* Returned Value:
* Upon successful completion, vfork() returns 0 to the child process and returns
* the process ID of the child process to the parent process. Otherwise, -1 is
* returned to the parent, no child process is created, and errno is set to

View File

@ -61,7 +61,7 @@
* be stopped. Save its context and move it to the inactive list specified
* by task_state.
*
* Inputs:
* Input Parameters:
* tcb: Refers to a task in the ready-to-run list (normally the task at
* the head of the list). It most be stopped, its context saved and
* moved into one of the waiting task lists. It it was the task at the

View File

@ -70,7 +70,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
************************************************************************************/

View File

@ -67,7 +67,7 @@
* the priority of the current, running task and it now has the
* priority.
*
* Inputs:
* Input Parameters:
* tcb: The TCB of the task that has been reprioritized
* priority: The new task priority
*

View File

@ -70,7 +70,7 @@
*
* int up_saveusercontext(uint32_t *saveregs);
*
* Return:
* Returned Value:
* 0: Normal return
* 1: Context switch return
*

View File

@ -78,12 +78,12 @@
* user-space, signal handler trampoline function. It is called from
* up_signal_dispatch() in user-mode.
*
* Inputs:
* Input Parameters:
* sighand - The address user-space signal handling function
* signo, info, and ucontext - Standard arguments to be passed to the
* signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via an architecture specific system call made by up_signal_handler().
* However, this will look like a normal return by the caller of

View File

@ -65,13 +65,13 @@
* This function is the user-space, signal handler trampoline function. It
* is called from up_signal_dispatch() in user-mode.
*
* Inputs:
* Input Parameters:
* R0 = sighand
* The address user-space signal handling function
* R1-R3 = signo, info, and ucontext
* Standard arguments to be passed to the signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via the SYS_signal_handler_return (see svcall.h)
*

View File

@ -71,7 +71,7 @@
*
* void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs);
*
* Return:
* Returned Value:
* None
*
************************************************************************************/

View File

@ -60,7 +60,7 @@
* execute. Move the TCB to the ready-to-run list, restore its context,
* and start execution.
*
* Inputs:
* Input Parameters:
* tcb: Refers to the tcb to be unblocked. This tcb is in one of the
* waiting tasks lists. It must be moved to the ready-to-run list and,
* if it is the highest priority ready to run taks, executed.

View File

@ -87,10 +87,10 @@
* 5) up_vfork() then calls task_vforkstart()
* 6) task_vforkstart() then executes the child thread.
*
* Input Paremeters:
* Input Parameters:
* None
*
* Return:
* Returned Value:
* Upon successful completion, vfork() returns 0 to the child process and returns
* the process ID of the child process to the parent process. Otherwise, -1 is
* returned to the parent, no child process is created, and errno is set to

View File

@ -62,7 +62,7 @@
* the ready to run list must be stopped. Save its context
* and move it to the inactive list specified by task_state.
*
* Inputs:
* Input Parameters:
* tcb: Refers to a task in the ready-to-run list (normally
* the task at the head of the list). It most be
* stopped, its context saved and moved into one of the

View File

@ -93,7 +93,7 @@
*
* These functions are provided by the common ARMv7-A logic.
*
* Input parameters:
* Input Parameters:
* None
*
* Returned Value:

View File

@ -112,7 +112,7 @@ static FAR const uint32_t *g_cpu_stackalloc[CONFIG_SMP_NCPUS] =
* - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of
* the stack pointer.
*
* Inputs:
* Input Parameters:
* - cpu: CPU index that indicates which CPU the IDLE task is
* being created for.
* - tcb: The TCB of new CPU IDLE task

View File

@ -59,7 +59,7 @@
/****************************************************************************
* Name: arm_dataabort
*
* Input parameters:
* Input Parameters:
* regs - The standard, ARM register save array.
*
* If CONFIG_PAGING is selected in the NuttX configuration file, then these

View File

@ -62,7 +62,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
****************************************************************************/

View File

@ -372,7 +372,7 @@ void arm_gic_initialize(void)
* the irq number of the interrupt and then to call arm_doirq to dispatch
* the interrupt.
*
* Input parameters:
* Input Parameters:
* regs - A pointer to the register save area on the stack.
*
****************************************************************************/
@ -532,7 +532,7 @@ int up_prioritize_irq(int irq, int priority)
* Since this API is not supported on all architectures, it should be
* avoided in common implementations where possible.
*
* Input Paramters:
* Input Parameters:
* irq - The interrupt request to modify.
* edge - False: Active HIGH level sensitive, True: Rising edge sensitive
*

View File

@ -68,7 +68,7 @@
* the priority of the current, running task and it now has the
* priority.
*
* Inputs:
* Input Parameters:
* tcb: The TCB of the task that has been reprioritized
* priority: The new task priority
*

View File

@ -67,12 +67,12 @@
* user-space, signal handler trampoline function. It is called from
* up_signal_dispatch() in user-mode.
*
* Inputs:
* Input Parameters:
* sighand - The address user-space signal handling function
* signo, info, and ucontext - Standard arguments to be passed to the
* signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via an architecture specific system call made by up_signal_handler().
* However, this will look like a normal return by the caller of

View File

@ -61,7 +61,7 @@
* but has been prepped to execute. Move the TCB to the
* ready-to-run list, restore its context, and start execution.
*
* Inputs:
* Input Parameters:
* tcb: Refers to the tcb to be unblocked. This tcb is
* in one of the waiting tasks lists. It must be moved to
* the ready-to-run list and, if it is the highest priority

View File

@ -88,10 +88,10 @@
* 5) up_vfork() then calls task_vforkstart()
* 6) task_vforkstart() then executes the child thread.
*
* Input Paremeters:
* Input Parameters:
* None
*
* Return:
* Returned Value:
* Upon successful completion, vfork() returns 0 to the child process and
* returns the process ID of the child process to the parent process.
* Otherwise, -1 is returned to the parent, no child process is created,

View File

@ -67,13 +67,13 @@ int main(int argc, char *argv[]);
* R4-R10 - static registers must be preserved
* R12-R14 - LR and SP must be preserved
*
* Inputs:
* Input Parameters:
* R0 = sighand
* The address user-space signal handling function
* R1-R3 = signo, info, and ucontext
* Standard arguments to be passed to the signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via the SYS_signal_handler_return (see svcall.h)
*

View File

@ -634,7 +634,7 @@ static inline unsigned int arm_gic_nlines(void)
* If CONFIG_SMP is not selected, the cpuset is ignored and SGI is sent
* only to the current CPU.
*
* Input Paramters
* Input Parameters:
* sgi - The SGI interrupt ID (0-15)
* cpuset - The set of CPUs to receive the SGI
*
@ -714,7 +714,7 @@ void arm_gic_initialize(void);
* Since this API is not supported on all architectures, it should be
* avoided in common implementations where possible.
*
* Input Paramters:
* Input Parameters:
* irq - The interrupt request to modify.
* edge - False: Active HIGH level sensitive, True: Rising edge sensitive
*
@ -735,7 +735,7 @@ int arm_gic_irq_trigger(int irq, bool edge);
* the irq number of the interrupt and then to call arm_doirq to dispatch
* the interrupt.
*
* Input parameters:
* Input Parameters:
* regs - A pointer to the register save area on the stack.
*
****************************************************************************/

View File

@ -897,7 +897,7 @@ struct section_mapping_s
* Description:
* Disable the MMU
*
* Inputs:
* Input Parameters:
* None
*
************************************************************************************/
@ -919,7 +919,7 @@ struct section_mapping_s
* instruction that performs the operation. Software does not have to write a
* value to the register before issuing the MCR instruction.
*
* Inputs:
* Input Parameters:
* None
*
************************************************************************************/
@ -934,7 +934,7 @@ struct section_mapping_s
* Description:
* Invalidate unified TLB entry by MVA all ASID Inner Shareable
*
* Inputs:
* Input Parameters:
* vaddr - The virtual address to be invalidated
*
************************************************************************************/
@ -952,7 +952,7 @@ struct section_mapping_s
* Description:
* Write the Domain Access Control Register (DACR)
*
* Inputs:
* Input Parameters:
* dacr - The new value of the DACR
*
************************************************************************************/
@ -979,7 +979,7 @@ struct section_mapping_s
* Table Base Register 0 (TTBR0). Then it clears the TTB control
* register (TTBCR), indicating that we are using TTBR0.
*
* Inputs:
* Input Parameters:
* ttb - The new value of the TTBR0 register
*
************************************************************************************/
@ -1012,7 +1012,7 @@ struct section_mapping_s
* ldr r3, =MMUFLAGS <-- L2 MMU flags
* pg_l2map r0, r1, r2, r3, r4
*
* Inputs:
* Input Parameters:
* l2 - Physical or virtual start address in the L2 page table, depending
* upon the context. (modified)
* ppage - The physical address of the start of the region to span. Must
@ -1083,7 +1083,7 @@ struct section_mapping_s
* ldr r4, =MMU_L1_PGTABFLAGS <-- L1 MMU flags
* pg_l1span r0, r1, r2, r3, r4, r4
*
* Inputs (unmodified unless noted):
* Input Parameters (unmodified unless noted):
* l1 - Physical or virtual address in the L1 table to begin writing (modified)
* l2 - Physical start address in the L2 page table (modified)
* npages - Number of pages to required to span that memory region (modified)
@ -1097,7 +1097,7 @@ struct section_mapping_s
* ppage - After the first page, this will be the full number of pages.
* tmp - scratch
*
* Return:
* Returned Value:
* Nothing of interest.
*
* Assumptions:
@ -1159,7 +1159,7 @@ struct section_mapping_s
* Description:
* Disable the MMU
*
* Inputs:
* Input Parameters:
* None
*
************************************************************************************/
@ -1188,7 +1188,7 @@ static inline void cp15_disable_mmu(void)
* instruction that performs the operation. Software does not have to write a
* value to the register before issuing the MCR instruction.
*
* Inputs:
* Input Parameters:
* None
*
************************************************************************************/
@ -1210,7 +1210,7 @@ static inline void cp15_invalidate_tlbs(void)
* Description:
* Invalidate unified TLB entry by MVA all ASID Inner Shareable
*
* Inputs:
* Input Parameters:
* vaddr - The virtual address to be invalidated
*
************************************************************************************/
@ -1235,7 +1235,7 @@ static inline void cp15_invalidate_tlb_bymva(uint32_t vaddr)
* Description:
* Write the Domain Access Control Register (DACR)
*
* Inputs:
* Input Parameters:
* dacr - The new value of the DACR
*
************************************************************************************/
@ -1269,7 +1269,7 @@ static inline void cp15_wrdacr(unsigned int dacr)
* Table Base Register 0 (TTBR0). Then it clears the TTB control
* register (TTBCR), indicating that we are using TTBR0.
*
* Inputs:
* Input Parameters:
* ttb - The new value of the TTBR0 register
*
************************************************************************************/

View File

@ -93,7 +93,7 @@ extern uint32_t g_cpu3_idlestack[SMP_STACK_WORDS];
*
* These functions are provided by the common ARMv7-A logic.
*
* Input parameters:
* Input Parameters:
* None
*
* Returned Value:
@ -129,7 +129,7 @@ void __cpu3_start(void);
* This function must be provided by the each ARMv7-A MCU and implement
* MCU-specific initialization logic.
*
* Input parameters:
* Input Parameters:
* cpu - The CPU index. This is the same value that would be obtained by
* calling up_cpu_index();
*

View File

@ -71,7 +71,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
************************************************************************************/

View File

@ -71,7 +71,7 @@
*
* int up_saveusercontext(uint32_t *saveregs);
*
* Return:
* Returned Value:
* 0: Normal return
* 1: Context switch return
*

View File

@ -71,13 +71,13 @@
* R4-R10 - static registers must be preserved
* R12-R14 - LR and SP must be preserved
*
* Inputs:
* Input Parameters:
* R0 = sighand
* The address user-space signal handling function
* R1-R3 = signo, info, and ucontext
* Standard arguments to be passed to the signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via the SYS_signal_handler_return (see svcall.h)
*

View File

@ -72,7 +72,7 @@
*
* void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs);
*
* Return:
* Returned Value:
* None
*
************************************************************************************/

View File

@ -88,10 +88,10 @@
* 5) up_vfork() then calls task_vforkstart()
* 6) task_vforkstart() then executes the child thread.
*
* Input Paremeters:
* Input Parameters:
* None
*
* Return:
* Returned Value:
* Upon successful completion, vfork() returns 0 to the child process and returns
* the process ID of the child process to the parent process. Otherwise, -1 is
* returned to the parent, no child process is created, and errno is set to

View File

@ -72,7 +72,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
************************************************************************************/

View File

@ -72,7 +72,7 @@
*
* int up_saveusercontext(uint32_t *saveregs);
*
* Return:
* Returned Value:
* 0: Normal return
* 1: Context switch return
*

View File

@ -73,7 +73,7 @@
*
* void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs);
*
* Return:
* Returned Value:
* None
*
************************************************************************************/

View File

@ -89,10 +89,10 @@
* 5) up_vfork() then calls task_vforkstart()
* 6) task_vforkstart() then executes the child thread.
*
* Input Paremeters:
* Input Parameters:
* None
*
* Return:
* Returned Value:
* Upon successful completion, vfork() returns 0 to the child process and returns
* the process ID of the child process to the parent process. Otherwise, -1 is
* returned to the parent, no child process is created, and errno is set to

View File

@ -61,7 +61,7 @@
* the ready to run list must be stopped. Save its context
* and move it to the inactive list specified by task_state.
*
* Inputs:
* Input Parameters:
* tcb: Refers to a task in the ready-to-run list (normally
* the task at the head of the list). It most be
* stopped, its context saved and moved into one of the

View File

@ -67,7 +67,7 @@
* the priority of the current, running task and it now has the
* priority.
*
* Inputs:
* Input Parameters:
* tcb: The TCB of the task that has been reprioritized
* priority: The new task priority
*

View File

@ -66,12 +66,12 @@
* user-space, signal handler trampoline function. It is called from
* up_signal_dispatch() in user-mode.
*
* Inputs:
* Input Parameters:
* sighand - The address user-space signal handling function
* signo, info, and ucontext - Standard arguments to be passed to the
* signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via an architecture specific system call made by up_signal_handler().
* However, this will look like a normal return by the caller of

View File

@ -60,7 +60,7 @@
* but has been prepped to execute. Move the TCB to the
* ready-to-run list, restore its context, and start execution.
*
* Inputs:
* Input Parameters:
* tcb: Refers to the tcb to be unblocked. This tcb is
* in one of the waiting tasks lists. It must be moved to
* the ready-to-run list and, if it is the highest priority

View File

@ -62,7 +62,7 @@
* the ready to run list must be stopped. Save its context
* and move it to the inactive list specified by task_state.
*
* Inputs:
* Input Parameters:
* tcb: Refers to a task in the ready-to-run list (normally
* the task at the head of the list). It most be
* stopped, its context saved and moved into one of the

View File

@ -54,7 +54,7 @@
/****************************************************************************
* Name: arm_dataabort
*
* Input parameters:
* Input Parameters:
* regs - The standard, ARM register save array.
* dfar - Fault address register.
* dfsr - Fault status register.

View File

@ -75,7 +75,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
****************************************************************************/

View File

@ -68,7 +68,7 @@
* the priority of the current, running task and it now has the
* priority.
*
* Inputs:
* Input Parameters:
* tcb: The TCB of the task that has been reprioritized
* priority: The new task priority
*

View File

@ -79,12 +79,12 @@
* user-space, signal handler trampoline function. It is called from
* up_signal_dispatch() in user-mode.
*
* Inputs:
* Input Parameters:
* sighand - The address user-space signal handling function
* signo, info, and ucontext - Standard arguments to be passed to the
* signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via an architecture specific system call made by up_signal_handler().
* However, this will look like a normal return by the caller of

View File

@ -76,13 +76,13 @@
* R4-R10 - static registers must be preserved
* R12-R14 - LR and SP must be preserved
*
* Inputs:
* Input Parameters:
* R0 = sighand
* The address user-space signal handling function
* R1-R3 = signo, info, and ucontext
* Standard arguments to be passed to the signal handling function.
*
* Return:
* Returned Value:
* None. This function does not return in the normal sense. It returns
* via the SYS_signal_handler_return (see svcall.h)
*

View File

@ -73,7 +73,7 @@
* but has been prepped to execute. Move the TCB to the
* ready-to-run list, restore its context, and start execution.
*
* Inputs:
* Input Parameters:
* tcb: Refers to the tcb to be unblocked. This tcb is
* in one of the waiting tasks lists. It must be moved to
* the ready-to-run list and, if it is the highest priority

View File

@ -88,10 +88,10 @@
* 5) up_vfork() then calls task_vforkstart()
* 6) task_vforkstart() then executes the child thread.
*
* Input Paremeters:
* Input Parameters:
* None
*
* Return:
* Returned Value:
* Upon successful completion, vfork() returns 0 to the child process and
* returns the process ID of the child process to the parent process.
* Otherwise, -1 is returned to the parent, no child process is created,

View File

@ -640,7 +640,7 @@ static bool bcm_rxavailable(struct uart_dev_s *dev)
* Return true if UART activated RX flow control to block more incoming
* data
*
* Input parameters:
* Input Parameters:
* dev - UART device instance
* nbuffered - the number of characters currently buffered
* (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is

View File

@ -72,7 +72,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size, bool int_stack);
* alloc - Allocation base address of the stack
* size - The size of the stack in bytes
*
* Returned value:
* Returned Value:
* The estimated amount of stack space used.
*
****************************************************************************/
@ -182,7 +182,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size, bool int_stack)
* Input Parameters:
* None
*
* Returned value:
* Returned Value:
* The estimated amount of stack space used.
*
****************************************************************************/

View File

@ -97,7 +97,7 @@
* - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of
* the stack pointer.
*
* Inputs:
* Input Parameters:
* - tcb: The TCB of new task
* - stack_size: The requested stack size. At least this much
* must be allocated.

View File

@ -69,7 +69,7 @@
* A task has been stopped. Free all stack related resources retained in
* the defunct TCB.
*
* Input Parmeters
* Input Parameters:
* - dtcb: The TCB containing information about the stack to be released
* - ttype: The thread type. This may be one of following (defined in
* include/nuttx/sched.h):

View File

@ -98,7 +98,7 @@
* been removed from the stack. This will still be the initial value
* of the stack pointer when the task is started.
*
* Inputs:
* Input Parameters:
* - tcb: The TCB of new task
* - frame_size: The size of the stack frame to allocate.
*

View File

@ -89,7 +89,7 @@
* - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The
* initial value of the stack pointer.
*
* Inputs:
* Input Parameters:
* - tcb: The TCB of new task
* - stack_size: The allocated stack size.
*

View File

@ -101,7 +101,7 @@
* Input Parameters:
* context - Caller context information saved by vfork()
*
* Return:
* Returned Value:
* Upon successful completion, vfork() returns 0 to the child process and
* returns the process ID of the child process to the parent process.
* Otherwise, -1 is returned to the parent, no child process is created,

View File

@ -1367,7 +1367,7 @@ static int dm320_setcursor(FAR struct fb_vtable_s *vtable, FAR struct fb_setcurs
* Description:
* Initialize the framebuffer video hardware associated with the display.
*
* Input parameters:
* Input Parameters:
* display - In the case of hardware with multiple displays, this
* specifies the display. Normally this is zero.
*
@ -1403,7 +1403,7 @@ int up_fbinitialize(int display)
* Return a a reference to the framebuffer object for the specified video
* plane of the specified plane. Many OSDs support multiple planes of video.
*
* Input parameters:
* Input Parameters:
* display - In the case of hardware with multiple displays, this
* specifies the display. Normally this is zero.
* vplane - Identifies the plane being queried.

View File

@ -705,7 +705,7 @@ endif /* defined(ADC_COUNT) && (ADC_COUNT > 0) */
* Description:
* Dump all timer registers.
*
* Input parameters:
* Input Parameters:
* priv - A reference to the ADC block status
*
* Returned Value:

View File

@ -86,7 +86,7 @@
* Note
* This function is only atomic on cores which fully support bitbanding.
*
* Input Parmeters:
* Input Parameters:
* addr Peripheral address location to modify bit in.
* bit Bit position to modify, 0-31.
* val Value to set bit to, 0 or 1.
@ -115,7 +115,7 @@ inline void bitband_set_peripheral(uint32_t addr, uint32_t bit, uint32_t val)
* Note
* This function is only atomic on cores which fully support bitbanding.
*
* Input Parmeters:
* Input Parameters:
* addr Peripheral address location to read.
* bit Bit position to modify, 0-31.
*
@ -145,7 +145,7 @@ inline uint32_t bitband_get_peripheral(uint32_t addr, uint32_t bit)
* Note
* This function is only atomic on cores which fully support bitbanding.
*
* Input Parmeters:
* Input Parameters:
* addr SRAM address location to modify bit in.
* bit Bit position to modify, 0-31.
* val Value to set bit to, 0 or 1.
@ -174,7 +174,7 @@ inline void bitband_set_sram(uint32_t addr, uint32_t bit, uint32_t val)
* Note
* This function is only atomic on cores which fully support bitbanding.
*
* Input Parmeters:
* Input Parameters:
* addr Peripheral address location to read.
* bit Bit position to modify, 0-31.
*

View File

@ -319,7 +319,7 @@ void weak_function up_dmainitialize(void)
* until the holder of a channel relinquishes the channel by calling
* efm32_dmafree().
*
* Input parameters:
* Input Parameters:
* None
*
* Returned Value:

View File

@ -173,7 +173,7 @@ extern "C"
* If no DMA channel is available, then efm32_dmachannel() will wait until the
* holder of a channel relinquishes the channel by calling efm32_dmafree().
*
* Input parameters:
* Input Parameters:
* None
*
* Returned Value:

View File

@ -56,7 +56,7 @@
* instances of the interface, each of which may be set up with a
* different frequency and slave address.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has multiple I2C interfaces)
*
* Returned Value:
@ -72,7 +72,7 @@ FAR struct i2c_master_s *efm32_i2cbus_initialize(int port);
* Description:
* De-initialize the selected I2C port, and power down the device.
*
* Input Parameter:
* Input Parameters:
* Device structure as returned by the efm32_i2cbus_initialize()
*
* Returned Value:

View File

@ -110,7 +110,7 @@ int efm32_pmstop(bool lpds);
* Input Parameters:
* None
*
* Returned Value.
* Returned Value:
* On success, this function will not return (STANDBY mode can only be
* terminated with a reset event). Otherwise, STANDBY mode did not occur
* and a negated errno value is returned to indicate the cause of the

View File

@ -284,7 +284,7 @@ static void pwm_putreg(struct efm32_pwmtimer_s *priv, int offset, uint32_t value
* Description:
* Dump all timer registers.
*
* Input parameters:
* Input Parameters:
* priv - A reference to the PWM block status
*
* Returned Value:
@ -345,7 +345,7 @@ static void pwm_dumpregs(struct efm32_pwmtimer_s *priv, FAR const char *msg)
* Description:
* (Re-)initialize the timer resources and start the pulsed output
*
* Input parameters:
* Input Parameters:
* priv - A reference to the lower half PWM driver state structure
* info - A reference to the characteristics of the pulsed output
*
@ -433,7 +433,7 @@ static int pwm_timer(FAR struct efm32_pwmtimer_s *priv,
* Description:
* Handle timer interrupts.
*
* Input parameters:
* Input Parameters:
* Standard interrupt handler arguments.
*
* Returned Value:
@ -529,7 +529,7 @@ static int pwm_interrupt(int irq, void *context, FAR void *arg)
* Description:
* Pick an optimal pulse count to program the RCR.
*
* Input parameters:
* Input Parameters:
* count - The total count remaining
*
* Returned Value:
@ -583,7 +583,7 @@ static uint8_t pwm_pulsecount(uint32_t count)
* should configure and initialize the device so that it is ready for use.
* It should not, however, output pulses until the start method is called.
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -643,7 +643,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev)
* stop pulsed output, free any resources, disable the timer hardware, and
* put the system into the lowest possible power usage state
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -678,7 +678,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev)
* Description:
* (Re-)initialize the timer resources and start the pulsed output
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
* info - A reference to the characteristics of the pulsed output
*
@ -717,7 +717,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev,
* Description:
* Stop the pulsed output and reset the timer resources
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -761,7 +761,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev)
* Description:
* Lower-half logic may support platform-specific ioctl commands
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
* cmd - The ioctl command
* arg - The argument accompanying the ioctl command

View File

@ -184,7 +184,7 @@ uint32_t g_efm32_rstcause;
* Description:
* Return next reset cause string, NULL if no more reset cause.
*
* Input Parmeters:
* Input Parameters:
* reg: reset cause register to decode (like g_efm32_rstcause)
* idx: Use to keep in maind reset cause decoding position.
* set *idx to zero before first call.

View File

@ -90,7 +90,7 @@ const char* efm32_reset_cause_list_str(uint32_t reg, unsigned int *idx);
* Description:
* Return next reset cause string, NULL if no more reset cause.
*
* Input Parmeters:
* Input Parameters:
* reg: reset cause register to decode (like g_efm32_rstcause)
* idx: Use to keep in maind reset cause decoding position.
* set *idx to zero before first call.

View File

@ -1570,7 +1570,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *rxbuffer,
* Initialize the selected SPI port in its default state (Master, 8-bit,
* mode 0, etc.)
*
* Input Parameter:
* Input Parameters:
* priv - private SPI device structure
*
* Returned Value:
@ -1695,7 +1695,7 @@ errout:
* Description:
* Initialize the selected SPI port
*
* Input Parameter:
* Input Parameters:
* port - SPI port number to initialize. One of {0,1,2}
*
* Returned Value:

View File

@ -59,7 +59,7 @@ struct spi_dev_s; /* Forward reference */
* Description:
* Initialize the selected SPI port
*
* Input Parameter:
* Input Parameters:
* port - SPI port number to initialize. One of {0,1,2}
*
* Returned Value:

View File

@ -77,7 +77,7 @@
* Description:
* Dump all timer registers.
*
* Input parameters:
* Input Parameters:
* base - A base address of timer
*
* Returned Value:
@ -132,7 +132,7 @@ void efm32_timer_dumpregs(uintptr_t base, FAR const char *msg)
* Description:
* reset timer into reset state
*
* Input parameters:
* Input Parameters:
* base - A base address of timer
*
* Returned Value:
@ -192,7 +192,7 @@ void efm32_timer_reset(uintptr_t base)
* Description:
* set prescaler and top timer with best value to have "freq"
*
* Input parameters:
* Input Parameters:
* base - A base address of timer
* clk_freq - Clock soure of timer.
* freq - Wanted freqency.

View File

@ -1340,7 +1340,7 @@ static int efm32_ctrlchan_alloc(FAR struct efm32_usbhost_s *priv,
* ep - A memory location provided by the caller in which to receive the
* allocated endpoint descriptor.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -1402,7 +1402,7 @@ static int efm32_ctrlep_alloc(FAR struct efm32_usbhost_s *priv,
* ep - A memory location provided by the caller in which to receive the
* allocated endpoint descriptor.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -3791,7 +3791,7 @@ static void efm32_txfe_enable(FAR struct efm32_usbhost_s *priv, int chidx)
* hport - The location to return the hub port descriptor that detected the
* connection related event.
*
* Returned Values:
* Returned Value:
* Zero (OK) is returned on success when a device in connected or
* disconnected. This function will not return until either (1) a device is
* connected or disconnect to/from any hub port or until (2) some failure
@ -3882,7 +3882,7 @@ static int efm32_wait(FAR struct usbhost_connection_s *conn,
* hport - The descriptor of the hub port that has the newly connected
* device.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4010,7 +4010,7 @@ static int efm32_enumerate(FAR struct usbhost_connection_s *conn,
* maxpacketsize - The maximum number of bytes that can be sent to or
* received from the endpoint in a single data packet
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4069,7 +4069,7 @@ static int efm32_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep
* ep - A memory location provided by the caller in which to receive the
* allocated endpoint descriptor.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4126,7 +4126,7 @@ static int efm32_epalloc(FAR struct usbhost_driver_s *drvr,
* the class create() method.
* ep - The endpoint to be freed.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4194,7 +4194,7 @@ static int efm32_epfree(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep)
* maxlen - The address of a memory location provided by the caller in which to
* return the maximum size of the allocated buffer memory.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4240,7 +4240,7 @@ static int efm32_alloc(FAR struct usbhost_driver_s *drvr,
* the class create() method.
* buffer - The address of the allocated buffer memory to be freed.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4276,7 +4276,7 @@ static int efm32_free(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer)
* return the allocated buffer memory address.
* buflen - The size of the buffer required.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4320,7 +4320,7 @@ static int efm32_ioalloc(FAR struct usbhost_driver_s *drvr,
* the class create() method.
* buffer - The address of the allocated buffer memory to be freed.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4363,7 +4363,7 @@ static int efm32_iofree(FAR struct usbhost_driver_s *drvr, FAR uint8_t *buffer)
* NOTE: On an IN transaction, req and buffer may refer to the same allocated
* memory.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4566,7 +4566,7 @@ static int efm32_ctrlout(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0,
* (IN endpoint). buffer must have been allocated using DRVR_ALLOC
* buflen - The length of the data to be sent or received.
*
* Returned Values:
* Returned Value:
* On success, a non-negative value is returned that indicates the number
* of bytes successfully transferred. On a failure, a negated errno value is
* returned that indicates the nature of the failure:
@ -4638,7 +4638,7 @@ static ssize_t efm32_transfer(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep
* arg - The arbitrary parameter that will be passed to the callback function
* when the transfer completes.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure
*
@ -4694,7 +4694,7 @@ static int efm32_asynch(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep,
* ep - The IN or OUT endpoint descriptor for the device endpoint on which an
* asynchronous transfer should be transferred.
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure.
*
@ -4783,7 +4783,7 @@ static int efm32_cancel(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep)
* related event
* connected - True: device connected; false: device disconnected
*
* Returned Values:
* Returned Value:
* On success, zero (OK) is returned. On a failure, a negated errno value is
* returned indicating the nature of the failure.
*
@ -4834,7 +4834,7 @@ static int efm32_connect(FAR struct usbhost_driver_s *drvr,
* drvr - The USB host driver instance obtained as a parameter from the call to
* the class create() method.
*
* Returned Values:
* Returned Value:
* None
*
* Assumptions:

View File

@ -193,7 +193,7 @@ struct spi_dev_s; /* Forward reference */
* required. Theregore, all GPIO chip management is deferred to board-
* specific logic.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -1024,7 +1024,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw
* required. Theregore, all GPIO chip management is deferred to board-
* specific logic.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -249,7 +249,7 @@ void imx_cpu_enable(void)
* This function must be provided by the each ARMv7-A MCU and implement
* MCU-specific initialization logic.
*
* Input parameters:
* Input Parameters:
* cpu - The CPU index. This is the same value that would be obtained by
* calling up_cpu_index();
*

View File

@ -1209,7 +1209,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw
* required. Theregore, all GPIO chip management is deferred to board-
* specific logic.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -85,7 +85,7 @@ struct spi_dev_s; /* Forward reference */
* required. Theregore, all GPIO chip management is deferred to board-
* specific logic.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -418,7 +418,7 @@ void kinetis_lowsetup(void);
* Input Parameters:
* first: - First TTY number to assign
*
* Returns Value:
* Returned Value:
* The next TTY number available for assignment
*
****************************************************************************/
@ -437,7 +437,7 @@ unsigned int kinetis_uart_serialinit(unsigned int first);
* Input Parameters:
* first: - First TTY number to assign
*
* Returns Value:
* Returned Value:
* The next TTY number available for assignment
*
****************************************************************************/
@ -587,7 +587,7 @@ void kinetis_pinirqinitialize(void);
* pinisr - Pin interrupt service routine
* arg - An argument that will be provided to the interrupt service routine.
*
* Return Value:
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on any
* failure to indicate the nature of the failure.
*
@ -678,10 +678,10 @@ void kinetis_clrpend(int irq);
* Description:
* Initialize SDIO for operation.
*
* Input parameters:
* Input Parameters:
* slotno - Not used.
*
* Returned Values:
* Returned Value:
* A reference to an SDIO interface structure. NULL is returned on failures.
*
****************************************************************************/
@ -705,7 +705,7 @@ FAR struct sdio_dev_s *sdhc_initialize(int slotno);
* card has been removed from the slot. Only transitions
* (inserted->removed or removed->inserted should be reported)
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@ -725,7 +725,7 @@ void sdhc_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot);
* dev - An instance of the SDIO driver device state structure.
* wrprotect - true is a card is writeprotected.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/

View File

@ -57,7 +57,7 @@
* instances of the interface, each of which may be set up with a
* different frequency and slave address.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has multiple I2C interfaces)
*
* Returned Value:
@ -73,7 +73,7 @@ FAR struct i2c_master_s *kinetis_i2cbus_initialize(int port);
* Description:
* De-initialize the selected I2C port, and power down the device.
*
* Input Parameter:
* Input Parameters:
* Device structure as returned by the lpc43_i2cbus_initialize()
*
* Returned Value:

View File

@ -965,7 +965,7 @@ static bool kinetis_rxavailable(struct uart_dev_s *dev)
* Return true if UART activated RX flow control to block more incoming
* data
*
* Input parameters:
* Input Parameters:
* dev - UART device instance
* nbuffered - the number of characters currently buffered
* (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is
@ -1145,7 +1145,7 @@ void kinetis_lpuart_earlyserialinit(void)
* Input Parameters:
* first: - First TTY number to assign
*
* Returns Value:
* Returned Value:
* The next TTY number available for assignment
*
****************************************************************************/

View File

@ -214,7 +214,7 @@ int kinetis_pinconfig(uint32_t cfgset)
* Configure the digital filter associated with a port. The digital filter
* capabilities of the PORT module are available in all digital pin muxing modes.
*
* Input parmeters:
* Input Parameters:
* port - Port number. See KINETIS_PORTn definitions in kinetis_port.h
* lpo - true: Digital Filters are clocked by the bus clock
* false: Digital Filters are clocked by the 1 kHz LPO clock

View File

@ -267,7 +267,7 @@ void kinetis_pinirqinitialize(void)
* pinisr - Pin interrupt service routine
* arg - An argument that will be provided to the interrupt service routine.
*
* Returns:
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on any
* failure to indicate the nature of the failure.
*

View File

@ -248,7 +248,7 @@ static void pwm_putreg(struct kinetis_pwmtimer_s *priv, int offset, uint32_t val
* Description:
* Dump all timer registers.
*
* Input parameters:
* Input Parameters:
* priv - A reference to the PWM block status
*
* Returned Value:
@ -347,7 +347,7 @@ static void pwm_dumpregs(struct kinetis_pwmtimer_s *priv, FAR const char *msg)
* Description:
* (Re-)initialize the timer resources and start the pulsed output
*
* Input parameters:
* Input Parameters:
* priv - A reference to the lower half PWM driver state structure
* info - A reference to the characteristics of the pulsed output
*
@ -541,7 +541,7 @@ static int pwm_timer(FAR struct kinetis_pwmtimer_s *priv,
* should configure and initialize the device so that it is ready for use.
* It should not, however, output pulses until the start method is called.
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -589,7 +589,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev)
* stop pulsed output, free any resources, disable the timer hardware, and
* put the system into the lowest possible power usage state
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -622,7 +622,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev)
* Description:
* (Re-)initialize the timer resources and start the pulsed output
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
* info - A reference to the characteristics of the pulsed output
*
@ -644,7 +644,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev,
* Description:
* Stop the pulsed output and reset the timer resources
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -728,7 +728,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev)
* Description:
* Lower-half logic may support platform-specific ioctl commands
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
* cmd - The ioctl command
* arg - The argument accompanying the ioctl command

View File

@ -2795,7 +2795,7 @@ static void kinetis_callback(void *arg)
* Input Parameters:
* slotno - Not used.
*
* Returned Values:
* Returned Value:
* A reference to an SDIO interface structure. NULL is returned on failures.
*
****************************************************************************/
@ -2909,7 +2909,7 @@ FAR struct sdio_dev_s *sdhc_initialize(int slotno)
* card has been removed from the slot. Only transitions
* (inserted->removed or removed->inserted should be reported)
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/
@ -2956,7 +2956,7 @@ void sdhc_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot)
* dev - An instance of the SDIO driver device state structure.
* wrprotect - true is a card is writeprotected.
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/

View File

@ -1334,7 +1334,7 @@ static bool up_rxavailable(struct uart_dev_s *dev)
* Return true if UART activated RX flow control to block more incoming
* data
*
* Input parameters:
* Input Parameters:
* dev - UART device instance
* nbuffered - the number of characters currently buffered
* (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is
@ -1561,7 +1561,7 @@ void kinetis_uart_earlyserialinit(void)
* Input Parameters:
* first: - First TTY number to assign
*
* Returns Value:
* Returned Value:
* The next TTY number available for assignment
*
****************************************************************************/

View File

@ -1109,7 +1109,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t
* Description:
* Initialize the selected SPI port.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -75,7 +75,7 @@ struct spi_dev_s;
* Description:
* Initialize the selected SPI bus
*
* Input Parameter:
* Input Parameters:
* bus number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -370,7 +370,7 @@ bool kl_gpioread(uint32_t pinset);
* - pinisr: Pin interrupt service routine
* - pinarg: The argument that will accompany the pin interrupt
*
* Returns:
* Returned Value:
* Zero (OK) is returned on success; On any failure, a negated errno value is
* returned to indicate the nature of the failure.
*

View File

@ -230,8 +230,8 @@ void kl_gpioirqinitialize(void)
* - pinisr: Pin interrupt service routine
* - pinarg: The argument that will accompany the pin interrupt
*
* Returns:
* Returns:
* Returned Value:
* Returned Value:
* Zero (OK) is returned on success; On any failure, a negated errno value is
* returned to indicate the nature of the failure.
*

View File

@ -226,7 +226,7 @@ static void pwm_putreg(struct kl_pwmtimer_s *priv, int offset, uint32_t value)
* Description:
* Dump all timer registers.
*
* Input parameters:
* Input Parameters:
* priv - A reference to the PWM block status
*
* Returned Value:
@ -307,7 +307,7 @@ static void pwm_dumpregs(struct kl_pwmtimer_s *priv, FAR const char *msg)
* Description:
* (Re-)initialize the timer resources and start the pulsed output
*
* Input parameters:
* Input Parameters:
* priv - A reference to the lower half PWM driver state structure
* info - A reference to the characteristics of the pulsed output
*
@ -488,7 +488,7 @@ static int pwm_timer(FAR struct kl_pwmtimer_s *priv,
* should configure and initialize the device so that it is ready for use.
* It should not, however, output pulses until the start method is called.
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -529,7 +529,7 @@ static int pwm_setup(FAR struct pwm_lowerhalf_s *dev)
* stop pulsed output, free any resources, disable the timer hardware, and
* put the system into the lowest possible power usage state
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -562,7 +562,7 @@ static int pwm_shutdown(FAR struct pwm_lowerhalf_s *dev)
* Description:
* (Re-)initialize the timer resources and start the pulsed output
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
* info - A reference to the characteristics of the pulsed output
*
@ -584,7 +584,7 @@ static int pwm_start(FAR struct pwm_lowerhalf_s *dev,
* Description:
* Stop the pulsed output and reset the timer resources
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
*
* Returned Value:
@ -660,7 +660,7 @@ static int pwm_stop(FAR struct pwm_lowerhalf_s *dev)
* Description:
* Lower-half logic may support platform-specific ioctl commands
*
* Input parameters:
* Input Parameters:
* dev - A reference to the lower half PWM driver state structure
* cmd - The ioctl command
* arg - The argument accompanying the ioctl command

View File

@ -612,7 +612,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t
* Description:
* Initialize the selected SPI port.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -71,7 +71,7 @@ struct spi_dev_s; /* Forward reference */
* Description:
* Initialize the selected SPI port.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -82,7 +82,7 @@
* - adj_stack_ptr: Adjusted stack_alloc_ptr for HW. The initial value of
* the stack pointer.
*
* Inputs:
* Input Parameters:
* - cpu: CPU index that indicates which CPU the IDLE task is
* being created for.
* - tcb: The TCB of new CPU IDLE task

View File

@ -355,7 +355,9 @@ int lc823450_sdc_setclock(uint32_t ch, uint32_t limitclk, uint32_t sysclk)
/****************************************************************************
* Name: lc823450_sdc_refmediatype
*
* Return Values: 0(sd), 1(emmc)
* Returned Value:
* 0(sd), 1(emmc)
*
****************************************************************************/
int lc823450_sdc_refmediatype(uint32_t ch)

View File

@ -512,7 +512,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw
* Description:
* Initialize the selected SPI port.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -102,7 +102,7 @@ uint32_t get_cpu_ver(void)
/****************************************************************************
* Name: mod_stby_regs
*
* Input parameters:
* Input Parameters:
* enabits : specify regions to be enabled
* disbits : specify regions to be disabled
*

View File

@ -182,7 +182,7 @@ static void wdg_work_func(void *arg)
* Input Parameters:
* Usual interrupt handler arguments.
*
* Returned Values:
* Returned Value:
* Always returns OK.
*
****************************************************************************/
@ -223,7 +223,7 @@ static int lc823450_wdt_interrupt(int irq, FAR void *context, FAR void *arg)
* lower - A pointer the publicly visible representation of the "lower-half"
* driver state structure.
*
* Returned Values:
* Returned Value:
* Zero on success; a negated errno value on failure.
*
****************************************************************************/
@ -246,7 +246,7 @@ static int lc823450_wdt_start(FAR struct watchdog_lowerhalf_s *lower)
* lower - A pointer the publicly visible representation of the "lower-half"
* driver state structure.
*
* Returned Values:
* Returned Value:
* Zero on success; a negated errno value on failure.
*
****************************************************************************/
@ -271,7 +271,7 @@ static int lc823450_wdt_stop(FAR struct watchdog_lowerhalf_s *lower)
* lower - A pointer the publicly visible representation of the "lower-half"
* driver state structure.
*
* Returned Values:
* Returned Value:
* Zero on success; a negated errno value on failure.
*
****************************************************************************/
@ -299,7 +299,7 @@ static int lc823450_wdt_keepalive(FAR struct watchdog_lowerhalf_s *lower)
* driver state structure.
* stawtus - The location to return the watchdog status information.
*
* Returned Values:
* Returned Value:
* Zero on success; a negated errno value on failure.
*
****************************************************************************/
@ -362,7 +362,7 @@ static int lc823450_wdt_getstatus(FAR struct watchdog_lowerhalf_s *lower,
* driver state structure.
* timeout - The new timeout value in millisecnds.
*
* Returned Values:
* Returned Value:
* Zero on success; a negated errno value on failure.
*
****************************************************************************/
@ -430,7 +430,7 @@ static int lc823450_wdt_settimeout(FAR struct watchdog_lowerhalf_s *lower,
* function pointer is NULL, then the reset-on-expiration
* behavior is restored,
*
* Returned Values:
* Returned Value:
* The previous watchdog expiration function pointer or NULL is there was
* no previous function pointer, i.e., if the previous behavior was
* reset-on-expiration (NULL is also returned if an error occurs).
@ -496,7 +496,7 @@ static xcpt_t lc823450_wdt_capture(FAR struct watchdog_lowerhalf_s *lower,
* interpretation of this argument depends on the particular
* command.
*
* Returned Values:
* Returned Value:
* Zero on success; a negated errno value on failure.
*
****************************************************************************/
@ -526,7 +526,7 @@ static int lc823450_wdt_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd,
* Input Parameters:
* None
*
* Returned Values:
* Returned Value:
* None
*
****************************************************************************/

View File

@ -57,7 +57,7 @@
* instances of the interface, each of which may be set up with a
* different frequency and slave address.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has multiple I2C interfaces)
*
* Returned Value:
@ -73,7 +73,7 @@ FAR struct i2c_master_s *lpc11_i2cbus_initialize(int port);
* Description:
* De-initialize the selected I2C port, and power down the device.
*
* Input Parameter:
* Input Parameters:
* Device structure as returned by the lpc11_i2cbus_initialize()
*
* Returned Value:

View File

@ -526,7 +526,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer,
* Description:
* Initialize the selected SPI port.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has multiple SPI interfaces)
*
* Returned Value:

View File

@ -76,7 +76,7 @@ extern "C"
* Description:
* Initialize the selected SPI port.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has mutiple SPI interfaces)
*
* Returned Value:

View File

@ -776,7 +776,7 @@ static void ssp_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer,
* Description:
* Initialize the SSP0
*
* Input Parameter:
* Input Parameters:
* None
*
* Returned Value:
@ -830,7 +830,7 @@ static inline FAR struct lpc11_sspdev_s *lpc11_ssp0initialize(void)
* Description:
* Initialize the SSP1
*
* Input Parameter:
* Input Parameters:
* None
*
* Returned Value:
@ -884,7 +884,7 @@ static inline FAR struct lpc11_sspdev_s *lpc11_ssp1initialize(void)
* Description:
* Initialize the SSP2
*
* Input Parameter:
* Input Parameters:
* None
*
* Returned Value:
@ -941,7 +941,7 @@ static inline FAR struct lpc11_sspdev_s *lpc11_ssp2initialize(void)
* Description:
* Initialize the selected SSP port.
*
* Input Parameter:
* Input Parameters:
* Port number (for hardware that has multiple SPI interfaces)
*
* Returned Value:

Some files were not shown because too many files have changed in this diff Show More