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
+3 -3
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:
+1 -1
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
+1 -1
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
+1 -1
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
*
+1 -1
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
+2 -2
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
+1 -1
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
+1 -1
View File
@@ -70,7 +70,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
************************************************************************************/
+1 -1
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
*
+1 -1
View File
@@ -70,7 +70,7 @@
*
* int up_saveusercontext(uint32_t *saveregs);
*
* Return:
* Returned Value:
* 0: Normal return
* 1: Context switch return
*
+2 -2
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
+2 -2
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)
*
+1 -1
View File
@@ -71,7 +71,7 @@
*
* void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs);
*
* Return:
* Returned Value:
* None
*
************************************************************************************/
+1 -1
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.
+2 -2
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
+1 -1
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
+1 -1
View File
@@ -93,7 +93,7 @@
*
* These functions are provided by the common ARMv7-A logic.
*
* Input parameters:
* Input Parameters:
* None
*
* Returned Value:
+1 -1
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
+1 -1
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
@@ -62,7 +62,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
****************************************************************************/
+2 -2
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
*
+1 -1
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
*
+2 -2
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
+1 -1
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
+2 -2
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,
+2 -2
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)
*
+3 -3
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.
*
****************************************************************************/
+13 -13
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
*
************************************************************************************/
+2 -2
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();
*
@@ -71,7 +71,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
************************************************************************************/
@@ -71,7 +71,7 @@
*
* int up_saveusercontext(uint32_t *saveregs);
*
* Return:
* Returned Value:
* 0: Normal return
* 1: Context switch return
*
+2 -2
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)
*
+1 -1
View File
@@ -72,7 +72,7 @@
*
* void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs);
*
* Return:
* Returned Value:
* None
*
************************************************************************************/
+2 -2
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
@@ -72,7 +72,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
************************************************************************************/
@@ -72,7 +72,7 @@
*
* int up_saveusercontext(uint32_t *saveregs);
*
* Return:
* Returned Value:
* 0: Normal return
* 1: Context switch return
*
+1 -1
View File
@@ -73,7 +73,7 @@
*
* void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs);
*
* Return:
* Returned Value:
* None
*
************************************************************************************/
+2 -2
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
+1 -1
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
+1 -1
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
*
+2 -2
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
+1 -1
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
+1 -1
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
+1 -1
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.
@@ -75,7 +75,7 @@
*
* void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function;
*
* Return:
* Returned Value:
* None
*
****************************************************************************/
+1 -1
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
*
+2 -2
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
+2 -2
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)
*
+1 -1
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
+2 -2
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,

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