diff --git a/arch/arm/src/arm/pg_macros.h b/arch/arm/src/arm/pg_macros.h index 47616b426ae20f77dfe1dc346c85a8f6acc7afed..94263c7eb533f84421c8ee728284971a1ab30608 100644 --- a/arch/arm/src/arm/pg_macros.h +++ b/arch/arm/src/arm/pg_macros.h @@ -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: diff --git a/arch/arm/src/arm/up_blocktask.c b/arch/arm/src/arm/up_blocktask.c index 716966714561b7eae8a8e399edaa6f471d440f3a..97d1838d8a2f186790b8e3c920432aaf99287ba9 100644 --- a/arch/arm/src/arm/up_blocktask.c +++ b/arch/arm/src/arm/up_blocktask.c @@ -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 diff --git a/arch/arm/src/arm/up_dataabort.c b/arch/arm/src/arm/up_dataabort.c index 318c59232c46ab0464c2a6c3be1ec2885247cdf7..2a348b401e2911e232a8cd057791e44e488cb54c 100644 --- a/arch/arm/src/arm/up_dataabort.c +++ b/arch/arm/src/arm/up_dataabort.c @@ -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 diff --git a/arch/arm/src/arm/up_reprioritizertr.c b/arch/arm/src/arm/up_reprioritizertr.c index 95679e31dd7276d9b11c1c24d8a8dfa25e7c1e1c..10175b0df511ffccea33472afcf1512658ce4d99 100644 --- a/arch/arm/src/arm/up_reprioritizertr.c +++ b/arch/arm/src/arm/up_reprioritizertr.c @@ -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 * diff --git a/arch/arm/src/arm/up_unblocktask.c b/arch/arm/src/arm/up_unblocktask.c index 12cb984d831bb31fc86a9d26052d0ae87972b139..e94c81de0c5cedd835d8c5ccf37f6c01988b0107 100644 --- a/arch/arm/src/arm/up_unblocktask.c +++ b/arch/arm/src/arm/up_unblocktask.c @@ -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 diff --git a/arch/arm/src/arm/vfork.S b/arch/arm/src/arm/vfork.S index 161315466fe81dd18b3bea6b31dd026500ec1244..661546daabe5a3ab79435d4b556fb2ed0e0a5825 100644 --- a/arch/arm/src/arm/vfork.S +++ b/arch/arm/src/arm/vfork.S @@ -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 diff --git a/arch/arm/src/armv6-m/up_blocktask.c b/arch/arm/src/armv6-m/up_blocktask.c index 2a95163cca220e9fedaf323a7f0ebc88d02771d2..c01894715a41cbee523c6c2e6f86b0e913fcd9e2 100644 --- a/arch/arm/src/armv6-m/up_blocktask.c +++ b/arch/arm/src/armv6-m/up_blocktask.c @@ -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 diff --git a/arch/arm/src/armv6-m/up_fullcontextrestore.S b/arch/arm/src/armv6-m/up_fullcontextrestore.S index 048c468749d44feff5c0c0eb6deaf4a23f38fbea..4ec6a32a7ed743d7c59b40bc3a2765c6ad40ffdc 100644 --- a/arch/arm/src/armv6-m/up_fullcontextrestore.S +++ b/arch/arm/src/armv6-m/up_fullcontextrestore.S @@ -70,7 +70,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv6-m/up_reprioritizertr.c b/arch/arm/src/armv6-m/up_reprioritizertr.c index 41f0c8700d33b9b6859c372b6a134087d4ed89e7..0f99b917407ec6efc46c6caa0d1cebc2f3ee95dc 100644 --- a/arch/arm/src/armv6-m/up_reprioritizertr.c +++ b/arch/arm/src/armv6-m/up_reprioritizertr.c @@ -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 * diff --git a/arch/arm/src/armv6-m/up_saveusercontext.S b/arch/arm/src/armv6-m/up_saveusercontext.S index bfc9a70ea884a35f1a6cfb71df9a72e53f60bd16..55e6461b2b40ab27589d4f3badd0b6bf3c457a6f 100644 --- a/arch/arm/src/armv6-m/up_saveusercontext.S +++ b/arch/arm/src/armv6-m/up_saveusercontext.S @@ -70,7 +70,7 @@ * * int up_saveusercontext(uint32_t *saveregs); * - * Return: + * Returned Value: * 0: Normal return * 1: Context switch return * diff --git a/arch/arm/src/armv6-m/up_signal_dispatch.c b/arch/arm/src/armv6-m/up_signal_dispatch.c index fa3cea62224a18debaf5079b8cc5b89c285a155f..45446a2b5e47a3d2dfc4e747fd515cc71c2f5a11 100644 --- a/arch/arm/src/armv6-m/up_signal_dispatch.c +++ b/arch/arm/src/armv6-m/up_signal_dispatch.c @@ -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 diff --git a/arch/arm/src/armv6-m/up_signal_handler.S b/arch/arm/src/armv6-m/up_signal_handler.S index f294db9fc805872e268044ddd079a4791fd9e32d..9ad7ec81330d055ffa60067b8a92fa0e508fdf66 100644 --- a/arch/arm/src/armv6-m/up_signal_handler.S +++ b/arch/arm/src/armv6-m/up_signal_handler.S @@ -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) * diff --git a/arch/arm/src/armv6-m/up_switchcontext.S b/arch/arm/src/armv6-m/up_switchcontext.S index c24f501fc2e6958d588a6e54cc7ad33d5e759a61..dc5aca9169bf56a123c1cc46f96552453390b38f 100644 --- a/arch/arm/src/armv6-m/up_switchcontext.S +++ b/arch/arm/src/armv6-m/up_switchcontext.S @@ -71,7 +71,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv6-m/up_unblocktask.c b/arch/arm/src/armv6-m/up_unblocktask.c index 62ec07d90a31c2688a5283d50d78c2e1de8672d1..1fbae1295093789f78430c893a46a018aad288cc 100644 --- a/arch/arm/src/armv6-m/up_unblocktask.c +++ b/arch/arm/src/armv6-m/up_unblocktask.c @@ -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. diff --git a/arch/arm/src/armv6-m/vfork.S b/arch/arm/src/armv6-m/vfork.S index 20c003d3ea9fbb7b8d7dd22789810c28b31d5192..c64e96e22cff780737965efa18142bb6e0cb32e4 100644 --- a/arch/arm/src/armv6-m/vfork.S +++ b/arch/arm/src/armv6-m/vfork.S @@ -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 diff --git a/arch/arm/src/armv7-a/arm_blocktask.c b/arch/arm/src/armv7-a/arm_blocktask.c index 3f02e46b362b80cc8e1e00311b4c57d6acac62bb..61cce48de27a6ca591515a7b5022e682ccd5655e 100644 --- a/arch/arm/src/armv7-a/arm_blocktask.c +++ b/arch/arm/src/armv7-a/arm_blocktask.c @@ -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 diff --git a/arch/arm/src/armv7-a/arm_cpuhead.S b/arch/arm/src/armv7-a/arm_cpuhead.S index 02735e36d50c39df1d5ff8a558fcf138d66df0fa..3ed001656d387490bcaacb66c744e68573c1cd94 100644 --- a/arch/arm/src/armv7-a/arm_cpuhead.S +++ b/arch/arm/src/armv7-a/arm_cpuhead.S @@ -93,7 +93,7 @@ * * These functions are provided by the common ARMv7-A logic. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/armv7-a/arm_cpuidlestack.c b/arch/arm/src/armv7-a/arm_cpuidlestack.c index dd264d25c148c4e3f42adef1fc36860a5b953909..1648de2fdb89ba1a694d69e28eec8a0e7e96d500 100644 --- a/arch/arm/src/armv7-a/arm_cpuidlestack.c +++ b/arch/arm/src/armv7-a/arm_cpuidlestack.c @@ -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 diff --git a/arch/arm/src/armv7-a/arm_dataabort.c b/arch/arm/src/armv7-a/arm_dataabort.c index 50c95a20188001fd7013b49f8822ce9ec930d9bc..17073a925e0c27a5c4c356fa20c44ac7de7004c2 100644 --- a/arch/arm/src/armv7-a/arm_dataabort.c +++ b/arch/arm/src/armv7-a/arm_dataabort.c @@ -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 diff --git a/arch/arm/src/armv7-a/arm_fullcontextrestore.S b/arch/arm/src/armv7-a/arm_fullcontextrestore.S index 64f74c8a98f9f4ab0b8754f46a20b5a3a6e1e94c..f65adbfadb3ff26d3aa56606a264431dab526f4f 100644 --- a/arch/arm/src/armv7-a/arm_fullcontextrestore.S +++ b/arch/arm/src/armv7-a/arm_fullcontextrestore.S @@ -62,7 +62,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/armv7-a/arm_gicv2.c b/arch/arm/src/armv7-a/arm_gicv2.c index 0232685dc828fa01fde4bddc51a3cd5b7f189655..8c6eee1509ac0372ea477b3f22ec320bc3cfe518 100644 --- a/arch/arm/src/armv7-a/arm_gicv2.c +++ b/arch/arm/src/armv7-a/arm_gicv2.c @@ -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 * diff --git a/arch/arm/src/armv7-a/arm_reprioritizertr.c b/arch/arm/src/armv7-a/arm_reprioritizertr.c index 4381178e05b311e620c620b6d9465e10cec5a333..eb1a4d2e6a15810387a006c6f322daf849892edc 100644 --- a/arch/arm/src/armv7-a/arm_reprioritizertr.c +++ b/arch/arm/src/armv7-a/arm_reprioritizertr.c @@ -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 * diff --git a/arch/arm/src/armv7-a/arm_signal_dispatch.c b/arch/arm/src/armv7-a/arm_signal_dispatch.c index 5925923760fe5aea3ba112b801c821a9038f1430..1b461f5cb922b17e8a4ec0b943f279a0f38ecb62 100644 --- a/arch/arm/src/armv7-a/arm_signal_dispatch.c +++ b/arch/arm/src/armv7-a/arm_signal_dispatch.c @@ -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 diff --git a/arch/arm/src/armv7-a/arm_unblocktask.c b/arch/arm/src/armv7-a/arm_unblocktask.c index e3d2fa3fc79ca0597e0c23195b98320f00adf472..a9b0da6d2f839024663dc3b693a4f0348672d605 100644 --- a/arch/arm/src/armv7-a/arm_unblocktask.c +++ b/arch/arm/src/armv7-a/arm_unblocktask.c @@ -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 diff --git a/arch/arm/src/armv7-a/arm_vfork.S b/arch/arm/src/armv7-a/arm_vfork.S index b7abc1c0f22a306161c9b7fa3f133510370e5857..2e10c9509903ba9242cbb763e09430d995371852 100644 --- a/arch/arm/src/armv7-a/arm_vfork.S +++ b/arch/arm/src/armv7-a/arm_vfork.S @@ -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, diff --git a/arch/arm/src/armv7-a/crt0.c b/arch/arm/src/armv7-a/crt0.c index a06e3f858e24bdeced0d4793a184f30f1228af88..f13148aa9b85669b19ef003b5ecd032f0144f79f 100644 --- a/arch/arm/src/armv7-a/crt0.c +++ b/arch/arm/src/armv7-a/crt0.c @@ -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) * diff --git a/arch/arm/src/armv7-a/gic.h b/arch/arm/src/armv7-a/gic.h index 8c882ad6ddc2c8711c978f0885c83fe11b8a9afa..0281abae6786ffd7b12775fa924c6a82c839a542 100644 --- a/arch/arm/src/armv7-a/gic.h +++ b/arch/arm/src/armv7-a/gic.h @@ -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. * ****************************************************************************/ diff --git a/arch/arm/src/armv7-a/mmu.h b/arch/arm/src/armv7-a/mmu.h index c6338d33378b30395f574085ac6aac80ed98a4f6..ba0870c235234c8b736337948ca14916290978a0 100644 --- a/arch/arm/src/armv7-a/mmu.h +++ b/arch/arm/src/armv7-a/mmu.h @@ -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 * ************************************************************************************/ diff --git a/arch/arm/src/armv7-a/smp.h b/arch/arm/src/armv7-a/smp.h index 7c9d1cc72af68cd3678a4718cd6037a0077ee532..1ae2bbfad8f8552f51ef428167a8b4d7d8a08440 100644 --- a/arch/arm/src/armv7-a/smp.h +++ b/arch/arm/src/armv7-a/smp.h @@ -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(); * diff --git a/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S b/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S index a9ccb0d572c0b9208e25fb3365382d0e1b4436fd..7b5171a449218b47c780853efb54058bfac941a2 100644 --- a/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S +++ b/arch/arm/src/armv7-m/gnu/up_fullcontextrestore.S @@ -71,7 +71,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/gnu/up_saveusercontext.S b/arch/arm/src/armv7-m/gnu/up_saveusercontext.S index 7ebd2e4836a79d94b77c5cbfcd73e86fa444377f..a4d96ef8fa5fa1a3ff6813675b85af155ab877a0 100644 --- a/arch/arm/src/armv7-m/gnu/up_saveusercontext.S +++ b/arch/arm/src/armv7-m/gnu/up_saveusercontext.S @@ -71,7 +71,7 @@ * * int up_saveusercontext(uint32_t *saveregs); * - * Return: + * Returned Value: * 0: Normal return * 1: Context switch return * diff --git a/arch/arm/src/armv7-m/gnu/up_signal_handler.S b/arch/arm/src/armv7-m/gnu/up_signal_handler.S index 2cc31da4d19fe67be41c4caf0ce4a97d16e6b098..daf9448c14e2e3e79b67cbb9918702774c9a5269 100644 --- a/arch/arm/src/armv7-m/gnu/up_signal_handler.S +++ b/arch/arm/src/armv7-m/gnu/up_signal_handler.S @@ -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) * diff --git a/arch/arm/src/armv7-m/gnu/up_switchcontext.S b/arch/arm/src/armv7-m/gnu/up_switchcontext.S index c0ddf151627c485681cdbfc39ee167b908a02c51..7c72411d3e5a16d60f65e8ea3a64ff69f1060cb3 100644 --- a/arch/arm/src/armv7-m/gnu/up_switchcontext.S +++ b/arch/arm/src/armv7-m/gnu/up_switchcontext.S @@ -72,7 +72,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/gnu/vfork.S b/arch/arm/src/armv7-m/gnu/vfork.S index 784ab83ce7b065113b69dd7a3dd48c780ff2644b..fa3cfc1bea621d6116d863378b479c5b12218400 100644 --- a/arch/arm/src/armv7-m/gnu/vfork.S +++ b/arch/arm/src/armv7-m/gnu/vfork.S @@ -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 diff --git a/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S b/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S index 045c903a32ade7ae13a05f8fd18031233a6186ac..034bbfc8e845f7f1ec32c4765290f3b8c10c78cb 100644 --- a/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S +++ b/arch/arm/src/armv7-m/iar/up_fullcontextrestore.S @@ -72,7 +72,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/iar/up_saveusercontext.S b/arch/arm/src/armv7-m/iar/up_saveusercontext.S index b8f27a7772cbac54ea11701e5337a2c2f3e439e3..07a82c620ae9323a066bc6b93b9a74a6c6213989 100644 --- a/arch/arm/src/armv7-m/iar/up_saveusercontext.S +++ b/arch/arm/src/armv7-m/iar/up_saveusercontext.S @@ -72,7 +72,7 @@ * * int up_saveusercontext(uint32_t *saveregs); * - * Return: + * Returned Value: * 0: Normal return * 1: Context switch return * diff --git a/arch/arm/src/armv7-m/iar/up_switchcontext.S b/arch/arm/src/armv7-m/iar/up_switchcontext.S index 5936503d73fe27c3ce9516f4fa2bd209de95c945..a115a498bf0e8ce6d9dd71b89e32138579119407 100644 --- a/arch/arm/src/armv7-m/iar/up_switchcontext.S +++ b/arch/arm/src/armv7-m/iar/up_switchcontext.S @@ -73,7 +73,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/armv7-m/iar/vfork.S b/arch/arm/src/armv7-m/iar/vfork.S index 6018a28a00a7bda8d1f6177d865f9a234cbd6fd9..e7352aee1ee18b857feb532416d4432de0c64493 100644 --- a/arch/arm/src/armv7-m/iar/vfork.S +++ b/arch/arm/src/armv7-m/iar/vfork.S @@ -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 diff --git a/arch/arm/src/armv7-m/up_blocktask.c b/arch/arm/src/armv7-m/up_blocktask.c index 5e62e0fb9fc3c4d9e021e4087560d84ad1efbed1..68151cb09b38cf6ce4330079c30f93511d43c2b8 100644 --- a/arch/arm/src/armv7-m/up_blocktask.c +++ b/arch/arm/src/armv7-m/up_blocktask.c @@ -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 diff --git a/arch/arm/src/armv7-m/up_reprioritizertr.c b/arch/arm/src/armv7-m/up_reprioritizertr.c index 5e65a3d33837b16d3928614b6fbd726d2009b34d..22c80ed298ebaeee8833fc179a233a042fb6f095 100644 --- a/arch/arm/src/armv7-m/up_reprioritizertr.c +++ b/arch/arm/src/armv7-m/up_reprioritizertr.c @@ -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 * diff --git a/arch/arm/src/armv7-m/up_signal_dispatch.c b/arch/arm/src/armv7-m/up_signal_dispatch.c index 9ec7d151529ca35f84e4dc939165e35f8882d9a5..c29d9c769a8d1a1145fbae1878a9255aff8c83ad 100644 --- a/arch/arm/src/armv7-m/up_signal_dispatch.c +++ b/arch/arm/src/armv7-m/up_signal_dispatch.c @@ -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 diff --git a/arch/arm/src/armv7-m/up_unblocktask.c b/arch/arm/src/armv7-m/up_unblocktask.c index 3c9ae8df14780afc49037b67f6666882c72dcffc..7ecbbd0e577f5b2defbd8d2a9f4db8d50420a90f 100644 --- a/arch/arm/src/armv7-m/up_unblocktask.c +++ b/arch/arm/src/armv7-m/up_unblocktask.c @@ -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 diff --git a/arch/arm/src/armv7-r/arm_blocktask.c b/arch/arm/src/armv7-r/arm_blocktask.c index 58cefee3cfe8a4e88fcf9b61b05dddcdc1e0fc1d..c35093df074d85d5b30170d70a91830067208a65 100644 --- a/arch/arm/src/armv7-r/arm_blocktask.c +++ b/arch/arm/src/armv7-r/arm_blocktask.c @@ -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 diff --git a/arch/arm/src/armv7-r/arm_dataabort.c b/arch/arm/src/armv7-r/arm_dataabort.c index 52f5d124365dbe84f502b6f133721e76e174faa2..f5939f80e5fa68ec80d1fa0d6df91527295ab636 100644 --- a/arch/arm/src/armv7-r/arm_dataabort.c +++ b/arch/arm/src/armv7-r/arm_dataabort.c @@ -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. diff --git a/arch/arm/src/armv7-r/arm_fullcontextrestore.S b/arch/arm/src/armv7-r/arm_fullcontextrestore.S index 06daa2218262b5b223219b0f85450e505786911e..9de8e405b75dc918a91d4cca1087e4fcbbc23be5 100644 --- a/arch/arm/src/armv7-r/arm_fullcontextrestore.S +++ b/arch/arm/src/armv7-r/arm_fullcontextrestore.S @@ -75,7 +75,7 @@ * * void up_fullcontextrestore(uint32_t *restoreregs) noreturn_function; * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/armv7-r/arm_reprioritizertr.c b/arch/arm/src/armv7-r/arm_reprioritizertr.c index db96424eb2f4d6042c672334f327784d4fcecbee..85b8ee22c0ce42ff51f77ab2d4e765ff25923669 100644 --- a/arch/arm/src/armv7-r/arm_reprioritizertr.c +++ b/arch/arm/src/armv7-r/arm_reprioritizertr.c @@ -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 * diff --git a/arch/arm/src/armv7-r/arm_signal_dispatch.c b/arch/arm/src/armv7-r/arm_signal_dispatch.c index 5fa1b3a647769ae46991415dd56ee175ac3576a3..c09c1481b6c0b445e30ae5494e9712ee0a8c684f 100644 --- a/arch/arm/src/armv7-r/arm_signal_dispatch.c +++ b/arch/arm/src/armv7-r/arm_signal_dispatch.c @@ -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 diff --git a/arch/arm/src/armv7-r/arm_signal_handler.S b/arch/arm/src/armv7-r/arm_signal_handler.S index 43f629a3ba9254f8e84ab949648e2bdb28ae7296..f2812a934fd06ebb8ac263470157d48b855683e3 100644 --- a/arch/arm/src/armv7-r/arm_signal_handler.S +++ b/arch/arm/src/armv7-r/arm_signal_handler.S @@ -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) * diff --git a/arch/arm/src/armv7-r/arm_unblocktask.c b/arch/arm/src/armv7-r/arm_unblocktask.c index 0361c1cc816f19903bb5c95e52796c25bca5c547..10188aac106458462165ee566dc9184cd2756f7f 100644 --- a/arch/arm/src/armv7-r/arm_unblocktask.c +++ b/arch/arm/src/armv7-r/arm_unblocktask.c @@ -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 diff --git a/arch/arm/src/armv7-r/arm_vfork.S b/arch/arm/src/armv7-r/arm_vfork.S index 635a5759c461a41c2688408c8f1d16c66b68c5ab..5b9a49588fe73264c396d61bf88ec76ad2ea491d 100644 --- a/arch/arm/src/armv7-r/arm_vfork.S +++ b/arch/arm/src/armv7-r/arm_vfork.S @@ -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, diff --git a/arch/arm/src/bcm2708/bcm_miniuart.c b/arch/arm/src/bcm2708/bcm_miniuart.c index dc17851f61f86a965f7f594c6975804437cd98ce..a035bd12136f8f0e16ba34db9cfc2bc339fe6bab 100644 --- a/arch/arm/src/bcm2708/bcm_miniuart.c +++ b/arch/arm/src/bcm2708/bcm_miniuart.c @@ -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 diff --git a/arch/arm/src/common/up_checkstack.c b/arch/arm/src/common/up_checkstack.c index 03423fd426a28deb0cfd3674253a158dee409c65..fe75ed99cd32b4ececd61068b4abe616671afa31 100644 --- a/arch/arm/src/common/up_checkstack.c +++ b/arch/arm/src/common/up_checkstack.c @@ -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. * ****************************************************************************/ diff --git a/arch/arm/src/common/up_createstack.c b/arch/arm/src/common/up_createstack.c index 6643f94def72428f18b55ea1abd5805c581f9d5e..2f3bd3b4d4c1941c29ab7c67f4ea067998de7b8b 100644 --- a/arch/arm/src/common/up_createstack.c +++ b/arch/arm/src/common/up_createstack.c @@ -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. diff --git a/arch/arm/src/common/up_releasestack.c b/arch/arm/src/common/up_releasestack.c index 9be9740a5b5b6f91cbafc41fb596a2a6a7f0fc13..7090916dde2ca6782523f937e9e4182ab2be9089 100644 --- a/arch/arm/src/common/up_releasestack.c +++ b/arch/arm/src/common/up_releasestack.c @@ -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): diff --git a/arch/arm/src/common/up_stackframe.c b/arch/arm/src/common/up_stackframe.c index dace2e9239fa7f4071a5e4ca3491271d9e0d4261..c3a1f055eb449ad42bce0514515452a5c4bb5ec2 100644 --- a/arch/arm/src/common/up_stackframe.c +++ b/arch/arm/src/common/up_stackframe.c @@ -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. * diff --git a/arch/arm/src/common/up_usestack.c b/arch/arm/src/common/up_usestack.c index 55c6a0526f5645787d7ed7d03665015814e1edec..7748fbd652eac64bc458cca79dd5a50652352096 100644 --- a/arch/arm/src/common/up_usestack.c +++ b/arch/arm/src/common/up_usestack.c @@ -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. * diff --git a/arch/arm/src/common/up_vfork.c b/arch/arm/src/common/up_vfork.c index 5a69e310e3815d92adb927e505fa9d283d132c7b..ff43c9cc970fb2fd269512119edafe6b3fbb9c57 100644 --- a/arch/arm/src/common/up_vfork.c +++ b/arch/arm/src/common/up_vfork.c @@ -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, diff --git a/arch/arm/src/dm320/dm320_framebuffer.c b/arch/arm/src/dm320/dm320_framebuffer.c index dcedcb62e5d277cd46d2280e1055017ef09db437..94b69e65d3b96b9e5420586c9b40719c6e1c8ab0 100644 --- a/arch/arm/src/dm320/dm320_framebuffer.c +++ b/arch/arm/src/dm320/dm320_framebuffer.c @@ -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. diff --git a/arch/arm/src/efm32/efm32_adc.c b/arch/arm/src/efm32/efm32_adc.c index e79c2a61ef53b568ffbc67e4557d9e62e2e87f06..a1224e2d75425583f02ffed6990c4f7b83ddd7fb 100644 --- a/arch/arm/src/efm32/efm32_adc.c +++ b/arch/arm/src/efm32/efm32_adc.c @@ -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: diff --git a/arch/arm/src/efm32/efm32_bitband.c b/arch/arm/src/efm32/efm32_bitband.c index fa45b660b8348279fe4c020d3b42c1ff312a9e66..a4810705c35c3d76e2fbc04b1cdfb13dd4f80740 100644 --- a/arch/arm/src/efm32/efm32_bitband.c +++ b/arch/arm/src/efm32/efm32_bitband.c @@ -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. * diff --git a/arch/arm/src/efm32/efm32_dma.c b/arch/arm/src/efm32/efm32_dma.c index ef97e08d6c503fbe163b2ca2f41a881feb6e1547..f93497b4d30d3a4372e9e2146b6ad06e9cf8a0a2 100644 --- a/arch/arm/src/efm32/efm32_dma.c +++ b/arch/arm/src/efm32/efm32_dma.c @@ -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: diff --git a/arch/arm/src/efm32/efm32_dma.h b/arch/arm/src/efm32/efm32_dma.h index 813b30bf703d4cfb63b6e67a150001aefe0fea3d..19eec8b0e930cb1a578cecfe8eb0601b33ed0f30 100644 --- a/arch/arm/src/efm32/efm32_dma.h +++ b/arch/arm/src/efm32/efm32_dma.h @@ -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: diff --git a/arch/arm/src/efm32/efm32_i2c.h b/arch/arm/src/efm32/efm32_i2c.h index 16e51434bef338805e641197a898d2ca2cb2ac98..6218da8435e9ef943717b29c1286b9d5ecaf5a02 100644 --- a/arch/arm/src/efm32/efm32_i2c.h +++ b/arch/arm/src/efm32/efm32_i2c.h @@ -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: diff --git a/arch/arm/src/efm32/efm32_pm.h b/arch/arm/src/efm32/efm32_pm.h index 6846de31a394e61ba9f5c9c0aba60de1401acab2..413eda45c1d51037ad84c09e9ecbbd0482a68b04 100644 --- a/arch/arm/src/efm32/efm32_pm.h +++ b/arch/arm/src/efm32/efm32_pm.h @@ -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 diff --git a/arch/arm/src/efm32/efm32_pwm.c b/arch/arm/src/efm32/efm32_pwm.c index b9c7bd0271d7fc47ec791c2410c2daacc29d8dbd..ec0ac7955515b7aa13bb4a302005e64a02bf6322 100644 --- a/arch/arm/src/efm32/efm32_pwm.c +++ b/arch/arm/src/efm32/efm32_pwm.c @@ -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 diff --git a/arch/arm/src/efm32/efm32_rmu.c b/arch/arm/src/efm32/efm32_rmu.c index 57d7b0e02b76d82a03a67010b6d0da4a6f98163b..fbed325339ef3de000d4006c36395450920d1287 100644 --- a/arch/arm/src/efm32/efm32_rmu.c +++ b/arch/arm/src/efm32/efm32_rmu.c @@ -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. diff --git a/arch/arm/src/efm32/efm32_rmu.h b/arch/arm/src/efm32/efm32_rmu.h index 1bcfec2d33f0952fbd1bc9753dcc1aec951dcda1..9a7a32dbdc810692822c0bcc48dd82a78b16a85b 100644 --- a/arch/arm/src/efm32/efm32_rmu.h +++ b/arch/arm/src/efm32/efm32_rmu.h @@ -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. diff --git a/arch/arm/src/efm32/efm32_spi.c b/arch/arm/src/efm32/efm32_spi.c index d7821a553ebdf15a97e85de72e38d414a54e54a2..7fe5139666d49fb80cf07616a41c5c3454f2b8e3 100644 --- a/arch/arm/src/efm32/efm32_spi.c +++ b/arch/arm/src/efm32/efm32_spi.c @@ -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: diff --git a/arch/arm/src/efm32/efm32_spi.h b/arch/arm/src/efm32/efm32_spi.h index 9e84fb68dc3f0686b4f36214ccefac2c898c5544..bcaff84e134a294386d8cbaf32f57a75c5dd4ff0 100644 --- a/arch/arm/src/efm32/efm32_spi.h +++ b/arch/arm/src/efm32/efm32_spi.h @@ -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: diff --git a/arch/arm/src/efm32/efm32_timer.c b/arch/arm/src/efm32/efm32_timer.c index 6264c3a378243369f4b713c9dae04b20982c787a..f8c1b1eaafea6ba2dae7936a396b1d573f094233 100644 --- a/arch/arm/src/efm32/efm32_timer.c +++ b/arch/arm/src/efm32/efm32_timer.c @@ -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. diff --git a/arch/arm/src/efm32/efm32_usbhost.c b/arch/arm/src/efm32/efm32_usbhost.c index cce11725fdd9454bf69acbb6d19339758a5a5406..8c1866a7977fc9fd1cea06c06f914d925722462f 100644 --- a/arch/arm/src/efm32/efm32_usbhost.c +++ b/arch/arm/src/efm32/efm32_usbhost.c @@ -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: diff --git a/arch/arm/src/imx1/imx_cspi.h b/arch/arm/src/imx1/imx_cspi.h index f15872c49b142751513eb924aacf6120df7b0391..3d80a3d540b161ce041ce3d6adaf5de02fdb54b3 100644 --- a/arch/arm/src/imx1/imx_cspi.h +++ b/arch/arm/src/imx1/imx_cspi.h @@ -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: diff --git a/arch/arm/src/imx1/imx_spi.c b/arch/arm/src/imx1/imx_spi.c index 92208b78be3faf92b3144cab3a2d0f1bcd9b91d4..682805fdb7055a08cc4460e37f4f7d9ce84fdad0 100644 --- a/arch/arm/src/imx1/imx_spi.c +++ b/arch/arm/src/imx1/imx_spi.c @@ -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: diff --git a/arch/arm/src/imx6/imx_cpuboot.c b/arch/arm/src/imx6/imx_cpuboot.c index 818b327a4bc4c3cee317fbefdb7d7c8ee3891685..e747b701cfa19399adb5d842daf08253e331aff7 100644 --- a/arch/arm/src/imx6/imx_cpuboot.c +++ b/arch/arm/src/imx6/imx_cpuboot.c @@ -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(); * diff --git a/arch/arm/src/imx6/imx_ecspi.c b/arch/arm/src/imx6/imx_ecspi.c index 42c8017fc0c0a9c83936230df9dfd0bf0e4eab00..0a20c514b9f47cab28a1f7eab8a83179e676d95d 100644 --- a/arch/arm/src/imx6/imx_ecspi.c +++ b/arch/arm/src/imx6/imx_ecspi.c @@ -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: diff --git a/arch/arm/src/imx6/imx_ecspi.h b/arch/arm/src/imx6/imx_ecspi.h index ac30d2291f9428ff331c50e7a3860450ed13268b..4e3f8b977e12bca4619ab8acfab027bbe409e83f 100644 --- a/arch/arm/src/imx6/imx_ecspi.h +++ b/arch/arm/src/imx6/imx_ecspi.h @@ -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: diff --git a/arch/arm/src/kinetis/kinetis.h b/arch/arm/src/kinetis/kinetis.h index a1558179fd07f1ac446e6cc583a58821cc4b18b1..ef91886626725884639345cf7637dafc3a9fad53 100644 --- a/arch/arm/src/kinetis/kinetis.h +++ b/arch/arm/src/kinetis/kinetis.h @@ -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 * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_i2c.h b/arch/arm/src/kinetis/kinetis_i2c.h index 098e4d39add5981788688eff46db049908210a33..8cb4246a17faba5745ccb6708da4c0fec774a217 100644 --- a/arch/arm/src/kinetis/kinetis_i2c.h +++ b/arch/arm/src/kinetis/kinetis_i2c.h @@ -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: diff --git a/arch/arm/src/kinetis/kinetis_lpserial.c b/arch/arm/src/kinetis/kinetis_lpserial.c index 262bda4a8a4e907e989b5cfaf16a5cf4aae74655..3de8f6e3a6ca63e5facd752602438aa61a7496ad 100644 --- a/arch/arm/src/kinetis/kinetis_lpserial.c +++ b/arch/arm/src/kinetis/kinetis_lpserial.c @@ -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 * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_pin.c b/arch/arm/src/kinetis/kinetis_pin.c index 8a2e3294321a6ce237c2dd19be73404fa4751d50..4a084f6c27527bd7a33ac5a7501bd0893fca4e5c 100644 --- a/arch/arm/src/kinetis/kinetis_pin.c +++ b/arch/arm/src/kinetis/kinetis_pin.c @@ -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 diff --git a/arch/arm/src/kinetis/kinetis_pinirq.c b/arch/arm/src/kinetis/kinetis_pinirq.c index f40be80a8e44cadd302da347df4a194cf10e9588..0a015b6ad49d37006ae78dde156392463d2535ee 100644 --- a/arch/arm/src/kinetis/kinetis_pinirq.c +++ b/arch/arm/src/kinetis/kinetis_pinirq.c @@ -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. * diff --git a/arch/arm/src/kinetis/kinetis_pwm.c b/arch/arm/src/kinetis/kinetis_pwm.c index 83f6c76699bea27e692439aa3d842e97df1e00be..b4dd646c9a641c489db61163b0e5eb16a9a6dfbf 100644 --- a/arch/arm/src/kinetis/kinetis_pwm.c +++ b/arch/arm/src/kinetis/kinetis_pwm.c @@ -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 diff --git a/arch/arm/src/kinetis/kinetis_sdhc.c b/arch/arm/src/kinetis/kinetis_sdhc.c index ef59c16fe07ae59c0a4b02fdac7344183b694ea4..816a4ee18b38c5d4438d53b0d3daaee9755c4f13 100644 --- a/arch/arm/src/kinetis/kinetis_sdhc.c +++ b/arch/arm/src/kinetis/kinetis_sdhc.c @@ -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 * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_serial.c b/arch/arm/src/kinetis/kinetis_serial.c index 0f2a4b2ee46dbdaf05771af1585bf09f8453cc74..23d327ec09acb593403162ba189cc13103a6aaf2 100644 --- a/arch/arm/src/kinetis/kinetis_serial.c +++ b/arch/arm/src/kinetis/kinetis_serial.c @@ -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 * ****************************************************************************/ diff --git a/arch/arm/src/kinetis/kinetis_spi.c b/arch/arm/src/kinetis/kinetis_spi.c index 3fc63b901e4e84328cf3d12e2320ad5f72a9e5fd..ce3971518e8a20878d36d86b26af4691dbb04dc5 100644 --- a/arch/arm/src/kinetis/kinetis_spi.c +++ b/arch/arm/src/kinetis/kinetis_spi.c @@ -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: diff --git a/arch/arm/src/kinetis/kinetis_spi.h b/arch/arm/src/kinetis/kinetis_spi.h index 8222af442467f44bbd8e7e5dfcf519f26ba4a70a..4d3ce60ce241526809b1f7ff54a1c43b49969719 100644 --- a/arch/arm/src/kinetis/kinetis_spi.h +++ b/arch/arm/src/kinetis/kinetis_spi.h @@ -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: diff --git a/arch/arm/src/kl/kl_gpio.h b/arch/arm/src/kl/kl_gpio.h index 4a81acd27e46ce2c5f8f00d050c307fa7e96140c..78f7fdc122273c883fb4cc6452e6aebb3daf51e4 100644 --- a/arch/arm/src/kl/kl_gpio.h +++ b/arch/arm/src/kl/kl_gpio.h @@ -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. * diff --git a/arch/arm/src/kl/kl_gpioirq.c b/arch/arm/src/kl/kl_gpioirq.c index 38f30c0870f1e9f29895ef9744e6e1b1460a75d3..a42be056ab7edd1c3d83532a63519f9526b51a20 100644 --- a/arch/arm/src/kl/kl_gpioirq.c +++ b/arch/arm/src/kl/kl_gpioirq.c @@ -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. * diff --git a/arch/arm/src/kl/kl_pwm.c b/arch/arm/src/kl/kl_pwm.c index a34aa0f8175b08e9130051208edd70ce36301a19..cfa024b4779b246948dbe53beb7c0312bf902c89 100644 --- a/arch/arm/src/kl/kl_pwm.c +++ b/arch/arm/src/kl/kl_pwm.c @@ -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 diff --git a/arch/arm/src/kl/kl_spi.c b/arch/arm/src/kl/kl_spi.c index 81cda9c9da5e159a2c2ee53d0a83c10b27609f00..187ae75e9e1b9ef168ad78c613b1517c4866dd1e 100644 --- a/arch/arm/src/kl/kl_spi.c +++ b/arch/arm/src/kl/kl_spi.c @@ -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: diff --git a/arch/arm/src/kl/kl_spi.h b/arch/arm/src/kl/kl_spi.h index fd621858a61eee7808139f5bd4d2055f29f5921e..968cf6abeff7779ad4bfbe0c56eeb64195cc22ba 100644 --- a/arch/arm/src/kl/kl_spi.h +++ b/arch/arm/src/kl/kl_spi.h @@ -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: diff --git a/arch/arm/src/lc823450/lc823450_cpuidlestack.c b/arch/arm/src/lc823450/lc823450_cpuidlestack.c index e9418abfcc87c142d22a26029967cfbfb1baf1f5..3c7a6e58fdbb99b2f676e543695e1f185b6befaf 100644 --- a/arch/arm/src/lc823450/lc823450_cpuidlestack.c +++ b/arch/arm/src/lc823450/lc823450_cpuidlestack.c @@ -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 diff --git a/arch/arm/src/lc823450/lc823450_sdc.c b/arch/arm/src/lc823450/lc823450_sdc.c index b0f0a357e2e299ce1cff0d3d63df6584e1c7438f..e47ab04dcb6258ec69d5ba4139d1ae15dfa33c98 100644 --- a/arch/arm/src/lc823450/lc823450_sdc.c +++ b/arch/arm/src/lc823450/lc823450_sdc.c @@ -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) diff --git a/arch/arm/src/lc823450/lc823450_spi.c b/arch/arm/src/lc823450/lc823450_spi.c index 038351d79a8c781eee8ed63d94c0bc9f0c33113f..51451b6001db2b9691c4e2a4a5987227159ef717 100644 --- a/arch/arm/src/lc823450/lc823450_spi.c +++ b/arch/arm/src/lc823450/lc823450_spi.c @@ -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: diff --git a/arch/arm/src/lc823450/lc823450_syscontrol.c b/arch/arm/src/lc823450/lc823450_syscontrol.c index 82e6c2ee01885489de549b52033781fe0b4087d2..cd5458729b4cc581f358112d322bcf11c4238a21 100644 --- a/arch/arm/src/lc823450/lc823450_syscontrol.c +++ b/arch/arm/src/lc823450/lc823450_syscontrol.c @@ -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 * diff --git a/arch/arm/src/lc823450/lc823450_wdt.c b/arch/arm/src/lc823450/lc823450_wdt.c index 80f7b49c2153e034f5cc5d49ad76e60e2e01c9a2..cdd351c095ca5c2c7b56703418e0c891bf8313be 100644 --- a/arch/arm/src/lc823450/lc823450_wdt.c +++ b/arch/arm/src/lc823450/lc823450_wdt.c @@ -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 * ****************************************************************************/ diff --git a/arch/arm/src/lpc11xx/lpc11_i2c.h b/arch/arm/src/lpc11xx/lpc11_i2c.h index a9bc6fa3f75fd87660a3fb5d34fd84042a157ae4..cd739be1a3a4c76837a8b3eaf71b498d9a0797ae 100644 --- a/arch/arm/src/lpc11xx/lpc11_i2c.h +++ b/arch/arm/src/lpc11xx/lpc11_i2c.h @@ -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: diff --git a/arch/arm/src/lpc11xx/lpc11_spi.c b/arch/arm/src/lpc11xx/lpc11_spi.c index 363cd6466adde7add1322a675226347c623546ea..e1bb8e0d6cad1d8dab1e697c9619aa59635bcbd9 100644 --- a/arch/arm/src/lpc11xx/lpc11_spi.c +++ b/arch/arm/src/lpc11xx/lpc11_spi.c @@ -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: diff --git a/arch/arm/src/lpc11xx/lpc11_spi.h b/arch/arm/src/lpc11xx/lpc11_spi.h index 1a6786d2180e012ee2f0fcf6657d8e8e4a0f76d0..30ee2bbecff8673b7e1121910ec9705b6e93e8d7 100644 --- a/arch/arm/src/lpc11xx/lpc11_spi.h +++ b/arch/arm/src/lpc11xx/lpc11_spi.h @@ -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: diff --git a/arch/arm/src/lpc11xx/lpc11_ssp.c b/arch/arm/src/lpc11xx/lpc11_ssp.c index 32cccc29f36ff0440a3b5ad16800b5930a03dcc1..c0c1498f7e6cb59ab0a871910f5827c708919245 100644 --- a/arch/arm/src/lpc11xx/lpc11_ssp.c +++ b/arch/arm/src/lpc11xx/lpc11_ssp.c @@ -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: diff --git a/arch/arm/src/lpc11xx/lpc11_ssp.h b/arch/arm/src/lpc11xx/lpc11_ssp.h index f117b1cf034d6b23a5545888779fec7280ccee26..825c67faa3afffbd430f71363baf7d010e454a9f 100644 --- a/arch/arm/src/lpc11xx/lpc11_ssp.h +++ b/arch/arm/src/lpc11xx/lpc11_ssp.h @@ -76,7 +76,7 @@ extern "C" * Description: * Initialize the selected SSP port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc11xx/lpc11_timer.c b/arch/arm/src/lpc11xx/lpc11_timer.c index a9ce65a073a57645e8953559dbad8e060657a096..75d3d334a43234a244a15297f44ff2132d1a2d8e 100644 --- a/arch/arm/src/lpc11xx/lpc11_timer.c +++ b/arch/arm/src/lpc11xx/lpc11_timer.c @@ -214,7 +214,7 @@ static void timer_putreg(struct lpc11_timer_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -256,7 +256,7 @@ static void timer_dumpregs(struct lpc11_timer_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 * @@ -291,7 +291,7 @@ static int timer_timer(FAR struct lpc11_timer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -325,7 +325,7 @@ static int timer_interrupt(struct lpc11_timer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -348,7 +348,7 @@ static int timer_tim1interrupt(int irq, void *context) * 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: @@ -436,7 +436,7 @@ static int timer_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 TIMER driver state structure * * Returned Value: @@ -462,7 +462,7 @@ static int timer_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 TIMER driver state structure * info - A reference to the characteristics of the pulsed output * @@ -484,7 +484,7 @@ static int timer_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 TIMER driver state structure * * Returned Value: @@ -542,7 +542,7 @@ static int timer_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 TIMER driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/lpc17xx/lpc17_can.c b/arch/arm/src/lpc17xx/lpc17_can.c index 94f1987280c41aeadc4ee8ad8c7994231d2be2e5..d7e8fcc461be15152fe07b1593e0457a9529abf0 100644 --- a/arch/arm/src/lpc17xx/lpc17_can.c +++ b/arch/arm/src/lpc17xx/lpc17_can.c @@ -1109,7 +1109,7 @@ static int can12_interrupt(int irq, void *context, FAR void *arg) * Where: * Tcan is the period of the APB clock (PCLK = CCLK / CONFIG_CAN1_DIVISOR). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1210,7 +1210,7 @@ static int can_bittiming(struct up_dev_s *priv) * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_can.h b/arch/arm/src/lpc17xx/lpc17_can.h index e15eaced5a5aa02cb8d9bf787523c9f2480be6d7..2cbb8014a9f8e1c9f3803018e39e40f2a2d09c00 100644 --- a/arch/arm/src/lpc17xx/lpc17_can.h +++ b/arch/arm/src/lpc17xx/lpc17_can.h @@ -71,7 +71,7 @@ extern "C" * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_i2c.h b/arch/arm/src/lpc17xx/lpc17_i2c.h index a7a6322461940cbcc88af415d024d38f12a82437..044f0560c778ba5aaa2941e51b65a963c11cc8ec 100644 --- a/arch/arm/src/lpc17xx/lpc17_i2c.h +++ b/arch/arm/src/lpc17xx/lpc17_i2c.h @@ -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 *lpc17_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 lpc17_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_lcd.c b/arch/arm/src/lpc17xx/lpc17_lcd.c index 90332fc12e9d072bde96e8e135d4deea28650b12..e7aebe109fa6e577d0d442f8878708cda7f1476f 100644 --- a/arch/arm/src/lpc17xx/lpc17_lcd.c +++ b/arch/arm/src/lpc17xx/lpc17_lcd.c @@ -458,7 +458,7 @@ static int lpc17_setcursor(FAR struct fb_vtable_s *vtable, * 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. * @@ -717,7 +717,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. diff --git a/arch/arm/src/lpc17xx/lpc17_mcpwm.c b/arch/arm/src/lpc17xx/lpc17_mcpwm.c index db0d1a9d67de95932697df6894bc0a8bc6e6ff23..c076a10ce5eb6f820fdc9a50ee717f97543a34b8 100644 --- a/arch/arm/src/lpc17xx/lpc17_mcpwm.c +++ b/arch/arm/src/lpc17xx/lpc17_mcpwm.c @@ -215,7 +215,7 @@ static void mcpwm_putreg(struct lpc17_mcpwmtimer_s *priv, int offset, uint32_t v * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -258,7 +258,7 @@ static void mcpwm_dumpregs(FAR struct lpc17_mcpwmtimer_s *priv, * 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 * @@ -290,7 +290,7 @@ static int mcpwm_timer(FAR struct lpc17_mcpwmtimer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -324,7 +324,7 @@ static int mcpwm_interrupt(struct lpc17_mcpwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -343,7 +343,7 @@ static int mcpwm_tim1interrupt(int irq, void *context) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -387,7 +387,7 @@ static void mcpwm_set_apb_clock(FAR struct lpc17_mcpwmtimer_s *priv, bool on) * 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: @@ -488,7 +488,7 @@ static int mcpwm_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: @@ -514,7 +514,7 @@ static int mcpwm_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 * @@ -536,7 +536,7 @@ static int mcpwm_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: @@ -594,7 +594,7 @@ static int mcpwm_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 diff --git a/arch/arm/src/lpc17xx/lpc17_pwm.c b/arch/arm/src/lpc17xx/lpc17_pwm.c index df3be30a74a95a79911ea2983c238f66a6764b7a..f28c0996267123090724dd1d56802c68ae679c99 100644 --- a/arch/arm/src/lpc17xx/lpc17_pwm.c +++ b/arch/arm/src/lpc17xx/lpc17_pwm.c @@ -231,7 +231,7 @@ static void pwm_putreg(struct lpc17_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: @@ -273,7 +273,7 @@ static void pwm_dumpregs(struct lpc17_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 * @@ -308,7 +308,7 @@ static int pwm_timer(FAR struct lpc17_pwmtimer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -342,7 +342,7 @@ static int pwm_interrupt(struct lpc17_pwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -361,7 +361,7 @@ static int pwm_tim1interrupt(int irq, void *context, FAR void *arg) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -405,7 +405,7 @@ static void pwm_set_apb_clock(FAR struct lpc17_pwmtimer_s *priv, bool on) * 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: @@ -459,7 +459,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: @@ -485,7 +485,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 * @@ -507,7 +507,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: @@ -565,7 +565,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 diff --git a/arch/arm/src/lpc17xx/lpc17_sdcard.c b/arch/arm/src/lpc17xx/lpc17_sdcard.c index 96cdb510f9d935b47dccc667f6d816da0e656527..1d21e582c5822e7ebc0e998b2b41ff63e7801d6f 100644 --- a/arch/arm/src/lpc17xx/lpc17_sdcard.c +++ b/arch/arm/src/lpc17xx/lpc17_sdcard.c @@ -2701,7 +2701,7 @@ static void lpc17_default(void) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SD card interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -2787,7 +2787,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -2833,7 +2833,7 @@ void sdio_mediachange(FAR struct sdio_dev_s *dev, bool cardinslot) * dev - An instance of the SD card driver device state structure. * wrprotect - true is a card is writeprotected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc17xx/lpc17_sdcard.h b/arch/arm/src/lpc17xx/lpc17_sdcard.h index 520175ec25c08347e5f7fe6e948102cb7f136e54..82f94264c7c2009da5f96ed23803758d62bd4532 100644 --- a/arch/arm/src/lpc17xx/lpc17_sdcard.h +++ b/arch/arm/src/lpc17xx/lpc17_sdcard.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -93,7 +93,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -111,7 +111,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/lpc17xx/lpc17_spi.c b/arch/arm/src/lpc17xx/lpc17_spi.c index 60deac4fb54f3613e2126b79866f52c33102f862..f653df2d3681914def2e82eecec6b9840c5418d3 100644 --- a/arch/arm/src/lpc17xx/lpc17_spi.c +++ b/arch/arm/src/lpc17xx/lpc17_spi.c @@ -518,7 +518,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: diff --git a/arch/arm/src/lpc17xx/lpc17_spi.h b/arch/arm/src/lpc17xx/lpc17_spi.h index 27d9ba8bb935e429e90d6ebc9aed7b28672c96f4..f0be0e9978184178194c3ae0714006151e83bdf0 100644 --- a/arch/arm/src/lpc17xx/lpc17_spi.h +++ b/arch/arm/src/lpc17xx/lpc17_spi.h @@ -78,7 +78,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: diff --git a/arch/arm/src/lpc17xx/lpc17_ssp.c b/arch/arm/src/lpc17xx/lpc17_ssp.c index 98220105dc0bb0f01df1ae9640ceb2dc1d70c8b5..af8fb4bc422a30f907ba6a47ee6bd2bf6bcbd95c 100644 --- a/arch/arm/src/lpc17xx/lpc17_ssp.c +++ b/arch/arm/src/lpc17xx/lpc17_ssp.c @@ -765,7 +765,7 @@ static void ssp_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the SSP0 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -819,7 +819,7 @@ static inline FAR struct lpc17_sspdev_s *lpc17_ssp0initialize(void) * Description: * Initialize the SSP1 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -873,7 +873,7 @@ static inline FAR struct lpc17_sspdev_s *lpc17_ssp1initialize(void) * Description: * Initialize the SSP2 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -930,7 +930,7 @@ static inline FAR struct lpc17_sspdev_s *lpc17_ssp2initialize(void) * Description: * Initialize the selected SSP port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_ssp.h b/arch/arm/src/lpc17xx/lpc17_ssp.h index c679206ca1e475b6596e59759b14d47975fb3723..dd8ba3c766f3c2d5dc76965c58d8e1caf07bebd7 100644 --- a/arch/arm/src/lpc17xx/lpc17_ssp.h +++ b/arch/arm/src/lpc17xx/lpc17_ssp.h @@ -76,7 +76,7 @@ extern "C" * Description: * Initialize the selected SSP port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc17xx/lpc17_timer.c b/arch/arm/src/lpc17xx/lpc17_timer.c index 434f416021ffaa6775ce31183ba8ba23eb94528f..8540d1b3862c2dde4fc560f03b40c837e810dc9d 100644 --- a/arch/arm/src/lpc17xx/lpc17_timer.c +++ b/arch/arm/src/lpc17xx/lpc17_timer.c @@ -215,7 +215,7 @@ static void timer_putreg(struct lpc17_timer_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -257,7 +257,7 @@ static void timer_dumpregs(struct lpc17_timer_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 * @@ -292,7 +292,7 @@ static int timer_timer(FAR struct lpc17_timer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -326,7 +326,7 @@ static int timer_interrupt(struct lpc17_timer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -349,7 +349,7 @@ static int timer_tim1interrupt(int irq, void *context) * 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: @@ -437,7 +437,7 @@ static int timer_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 TIMER driver state structure * * Returned Value: @@ -463,7 +463,7 @@ static int timer_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 TIMER driver state structure * info - A reference to the characteristics of the pulsed output * @@ -485,7 +485,7 @@ static int timer_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 TIMER driver state structure * * Returned Value: @@ -543,7 +543,7 @@ static int timer_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 TIMER driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command diff --git a/arch/arm/src/lpc17xx/lpc17_usbhost.c b/arch/arm/src/lpc17xx/lpc17_usbhost.c index fd51d9df2c45d3bd5f0529c0a6a9aaf90086decd..fb8abb6467be52b02081c154f3549fd1fb0d479f 100644 --- a/arch/arm/src/lpc17xx/lpc17_usbhost.c +++ b/arch/arm/src/lpc17xx/lpc17_usbhost.c @@ -1933,7 +1933,7 @@ static int lpc17_usbinterrupt(int irq, void *context, FAR void *arg) * 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 @@ -2029,7 +2029,7 @@ static int lpc17_wait(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 * @@ -2128,7 +2128,7 @@ static int lpc17_enumerate(FAR struct usbhost_connection_s *conn, * mps (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 * @@ -2183,7 +2183,7 @@ static int lpc17_ep0configure(struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * 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 * @@ -2339,7 +2339,7 @@ static int lpc17_epalloc(struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint 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 * @@ -2422,7 +2422,7 @@ static int lpc17_epfree(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 * @@ -2468,7 +2468,7 @@ static int lpc17_alloc(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 * @@ -2508,7 +2508,7 @@ static int lpc17_free(struct usbhost_driver_s *drvr, 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 * @@ -2553,7 +2553,7 @@ static int lpc17_ioalloc(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 * @@ -2600,7 +2600,7 @@ static int lpc17_iofree(struct usbhost_driver_s *drvr, 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 * @@ -2701,7 +2701,7 @@ static int lpc17_ctrlout(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, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -2779,7 +2779,7 @@ static int lpc17_transfer_common(struct lpc17_usbhost_s *priv, * buflen - The length of the data to be sent or received. * alloc - The location to return the allocated DMA buffer. * - * 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. * @@ -2851,7 +2851,7 @@ static int lpc17_dma_alloc(struct lpc17_usbhost_s *priv, * buflen - The length of the data to be sent or received. * alloc - The allocated DMA buffer 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. * @@ -2913,7 +2913,7 @@ static void lpc17_dma_free(struct lpc17_usbhost_s *priv, * (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: @@ -3087,7 +3087,7 @@ errout_with_sem: * ep - The IN or OUT endpoint descriptor for the device endpoint on which the * transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3189,7 +3189,7 @@ static void lpc17_asynch_completion(struct lpc17_usbhost_s *priv, * 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 * @@ -3306,7 +3306,7 @@ errout_with_sem: * 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. * @@ -3451,7 +3451,7 @@ static int lpc17_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. * @@ -3502,7 +3502,7 @@ static int lpc17_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3531,7 +3531,7 @@ static void lpc17_disconnect(struct usbhost_driver_s *drvr, * Input Parameters: * priv - private driver state instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc214x/lpc214x_spi.h b/arch/arm/src/lpc214x/lpc214x_spi.h index 69c94d89c0fc782290a96290d4c434e7fe0bbbb2..e4934d9d38c8b255bb0aec572850d61b6121961e 100644 --- a/arch/arm/src/lpc214x/lpc214x_spi.h +++ b/arch/arm/src/lpc214x/lpc214x_spi.h @@ -171,7 +171,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: diff --git a/arch/arm/src/lpc2378/lpc23xx_i2c.h b/arch/arm/src/lpc2378/lpc23xx_i2c.h index 5658269f20ae834b3c7837825e6bee9d2a07e43d..1ae069c5f7699139937df1f3698da507f1cbae76 100644 --- a/arch/arm/src/lpc2378/lpc23xx_i2c.h +++ b/arch/arm/src/lpc2378/lpc23xx_i2c.h @@ -163,7 +163,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: @@ -179,7 +179,7 @@ FAR struct i2c_master_s *lpc2378_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 lpc2378_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc2378/lpc23xx_spi.c b/arch/arm/src/lpc2378/lpc23xx_spi.c index bc7f46cf0727e4af83f59f24ac8925d729d9eb61..b9006f4e5ce67b9c9f4b3dde10605f6e44c684b7 100644 --- a/arch/arm/src/lpc2378/lpc23xx_spi.c +++ b/arch/arm/src/lpc2378/lpc23xx_spi.c @@ -525,7 +525,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 multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc2378/lpc23xx_spi.h b/arch/arm/src/lpc2378/lpc23xx_spi.h index 8b5fbda37c5b14db4acfcdad1094a32a85a106bd..280c2f44e20afee17003ccef5147f7c5111f6762 100644 --- a/arch/arm/src/lpc2378/lpc23xx_spi.h +++ b/arch/arm/src/lpc2378/lpc23xx_spi.h @@ -161,7 +161,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc31xx/lpc31.h b/arch/arm/src/lpc31xx/lpc31.h index 00ce6b8e35c70801957df11c2a8601230bf93db3..ca3c0ad8fbd5e198c0f2c37e255e14bc46ad6d32 100644 --- a/arch/arm/src/lpc31xx/lpc31.h +++ b/arch/arm/src/lpc31xx/lpc31.h @@ -176,7 +176,7 @@ void lpc31_clockconfig(void); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: @@ -315,7 +315,7 @@ void lpc31_usbhost_vbusdrive(int rhport, bool enable); * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -337,7 +337,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -355,7 +355,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/lpc31xx/lpc31_ehci.c b/arch/arm/src/lpc31xx/lpc31_ehci.c index 26772ea81a510f7ace18e3c9efd5b0065270464a..6b90a1b2eb1ca82afc1ed9436a9d40a433be778b 100644 --- a/arch/arm/src/lpc31xx/lpc31_ehci.c +++ b/arch/arm/src/lpc31xx/lpc31_ehci.c @@ -2087,7 +2087,7 @@ static struct lpc31_qtd_s *lpc31_qtd_statusphase(uint32_t tokenbits) * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2368,7 +2368,7 @@ errout_with_qh: * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2475,7 +2475,7 @@ errout_with_qh: * complete, but will be re-acquired when before returning. The state of * EHCI resources could be very different upon return. * - * Returned value: + * Returned Value: * On success, this function returns the number of bytes actually transferred. * For control transfers, this size includes the size of the control request * plus the size of the data (which could be short); For bulk transfers, this @@ -2555,7 +2555,7 @@ static ssize_t lpc31_transfer_wait(struct lpc31_epinfo_s *epinfo) * callback - The function to be called when the completes * arg - An arbitrary argument that will be provided with the callback. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -2608,7 +2608,7 @@ static inline int lpc31_ioc_async_setup(struct lpc31_rhport_s *rhport, * epinfo - The IN or OUT endpoint descriptor for the device endpoint on * which the transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3428,7 +3428,7 @@ static int lpc31_ehci_interrupt(int irq, FAR void *context, FAR void *arg) * 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 @@ -3530,7 +3530,7 @@ static int lpc31_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 * @@ -3839,7 +3839,7 @@ static int lpc31_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 * @@ -3882,7 +3882,7 @@ static int lpc31_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 * @@ -3965,7 +3965,7 @@ static int lpc31_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint 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 * @@ -4010,7 +4010,7 @@ static int lpc31_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 * @@ -4055,7 +4055,7 @@ static int lpc31_alloc(FAR struct usbhost_driver_s *drvr, * to 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 * @@ -4092,7 +4092,7 @@ static int lpc31_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 * @@ -4131,7 +4131,7 @@ static int lpc31_ioalloc(FAR struct usbhost_driver_s *drvr, FAR uint8_t **buffer * 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 * @@ -4176,7 +4176,7 @@ static int lpc31_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 * @@ -4277,7 +4277,7 @@ static int lpc31_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: @@ -4387,7 +4387,7 @@ errout_with_sem: * 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 * @@ -4480,7 +4480,7 @@ errout_with_sem: * 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. * @@ -4677,7 +4677,7 @@ errout_with_sem: * 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. * @@ -4728,7 +4728,7 @@ static int lpc31_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/lpc31xx/lpc31_i2c.h b/arch/arm/src/lpc31xx/lpc31_i2c.h index 10280a577311f83d04b8875b43a37175ca793e2f..ac14998d2224a7c9bed3f6cc6b3582df68611bd4 100644 --- a/arch/arm/src/lpc31xx/lpc31_i2c.h +++ b/arch/arm/src/lpc31xx/lpc31_i2c.h @@ -206,7 +206,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: @@ -222,7 +222,7 @@ FAR struct i2c_master_s *lpc31_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 lpc31_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc31xx/lpc31_spi.c b/arch/arm/src/lpc31xx/lpc31_spi.c index d0275a502d21157f9e3048a3902551f0b1545d25..c4e18511638369831d19c6eba69a90f889d164a6 100644 --- a/arch/arm/src/lpc31xx/lpc31_spi.c +++ b/arch/arm/src/lpc31xx/lpc31_spi.c @@ -903,7 +903,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: diff --git a/arch/arm/src/lpc43xx/lpc43_can.c b/arch/arm/src/lpc43xx/lpc43_can.c index 415a7b28efd163130bac8e6079c611b681dd0643..7013ffd6dd6aaafdd818c39a65e5ade3667e0c8e 100644 --- a/arch/arm/src/lpc43xx/lpc43_can.c +++ b/arch/arm/src/lpc43xx/lpc43_can.c @@ -1152,7 +1152,7 @@ static void can_setuprxobj(struct up_dev_s *priv) * Where: * Tcan is the period of the APB clock (PCLK = CCLK / CONFIG_CAN1_DIVISOR). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1210,7 +1210,7 @@ static int can_bittiming(struct up_dev_s *priv) * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_can.h b/arch/arm/src/lpc43xx/lpc43_can.h index f321c9b72fa087ce403f8e48a75e92847a90b28d..37074c6df34cfd35d5389bf89d2908ae011cc5e0 100644 --- a/arch/arm/src/lpc43xx/lpc43_can.h +++ b/arch/arm/src/lpc43xx/lpc43_can.h @@ -64,7 +64,7 @@ extern "C" * Description: * Initialize the selected can port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple can interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_ehci.c b/arch/arm/src/lpc43xx/lpc43_ehci.c index 3b24b4f282e38b8a4bb32a82405aa389b262f444..3908fb1a8ee177d0c7cda2660123aff3be218e59 100644 --- a/arch/arm/src/lpc43xx/lpc43_ehci.c +++ b/arch/arm/src/lpc43xx/lpc43_ehci.c @@ -1971,7 +1971,7 @@ static struct lpc43_qtd_s *lpc43_qtd_statusphase(uint32_t tokenbits) * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2251,7 +2251,7 @@ errout_with_qh: * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2358,7 +2358,7 @@ errout_with_qh: * complete, but will be re-acquired when before returning. The state of * EHCI resources could be very different upon return. * - * Returned value: + * Returned Value: * On success, this function returns the number of bytes actually transferred. * For control transfers, this size includes the size of the control request * plus the size of the data (which could be short); For bulk transfers, this @@ -2420,7 +2420,7 @@ static ssize_t lpc43_transfer_wait(struct lpc43_epinfo_s *epinfo) * callback - The function to be called when the completes * arg - An arbitrary argument that will be provided with the callback. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -2473,7 +2473,7 @@ static inline int lpc43_ioc_async_setup(struct lpc43_rhport_s *rhport, * epinfo - The IN or OUT endpoint descriptor for the device endpoint on * which the transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3265,7 +3265,7 @@ static int lpc43_ehci_interrupt(int irq, FAR void *context, FAR void *arg) * 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 @@ -3367,7 +3367,7 @@ static int lpc43_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 * @@ -3676,7 +3676,7 @@ static int lpc43_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 * @@ -3719,7 +3719,7 @@ static int lpc43_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 * @@ -3802,7 +3802,7 @@ static int lpc43_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint 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 * @@ -3847,7 +3847,7 @@ static int lpc43_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 * @@ -3889,7 +3889,7 @@ static int lpc43_alloc(FAR struct usbhost_driver_s *drvr, * to 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 * @@ -3926,7 +3926,7 @@ static int lpc43_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 * @@ -3962,7 +3962,7 @@ static int lpc43_ioalloc(FAR struct usbhost_driver_s *drvr, FAR uint8_t **buffer * 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 * @@ -4007,7 +4007,7 @@ static int lpc43_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 * @@ -4108,7 +4108,7 @@ static int lpc43_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: @@ -4218,7 +4218,7 @@ errout_with_sem: * 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 * @@ -4311,7 +4311,7 @@ errout_with_sem: * 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. * @@ -4508,7 +4508,7 @@ errout_with_sem: * 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. * @@ -4559,7 +4559,7 @@ static int lpc43_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/lpc43xx/lpc43_i2c.h b/arch/arm/src/lpc43xx/lpc43_i2c.h index ae8d94a7f883e5f25654ebe699ab1be0379a6af8..224fbaa593e35cb07efcd12bc0b8e88a7a0d3f16 100644 --- a/arch/arm/src/lpc43xx/lpc43_i2c.h +++ b/arch/arm/src/lpc43xx/lpc43_i2c.h @@ -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 *lpc43_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: diff --git a/arch/arm/src/lpc43xx/lpc43_pinconfig.c b/arch/arm/src/lpc43xx/lpc43_pinconfig.c index 0a274dd6a898bac27314835e74a951e71f8aaa35..738b4b8dafd2bf85924260cebf3ae1ff2f672a14 100644 --- a/arch/arm/src/lpc43xx/lpc43_pinconfig.c +++ b/arch/arm/src/lpc43xx/lpc43_pinconfig.c @@ -68,7 +68,7 @@ * Description: * Configure a pin based on bit-encoded description of the pin. * - * Input Value: + * Input Parameters: * 20-bit encoded value describing the pin. * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_pinconfig.h b/arch/arm/src/lpc43xx/lpc43_pinconfig.h index d3a8a822a6a0d70e11621cfdf5bf9e78872c5bdb..6b82878981af7cfd8741cd7c1eb2cd5bd4b48048 100644 --- a/arch/arm/src/lpc43xx/lpc43_pinconfig.h +++ b/arch/arm/src/lpc43xx/lpc43_pinconfig.h @@ -262,7 +262,7 @@ extern "C" * Description: * Configure a pin based on bit-encoded description of the pin. * - * Input Value: + * Input Parameters: * 20-bit encoded value describing the pin. * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_sdmmc.c b/arch/arm/src/lpc43xx/lpc43_sdmmc.c index c3504e7a159025e35a03779115c53174a6fbf36d..a84c6b8de99e490fbebde7e7985bb52e14cecc00 100644 --- a/arch/arm/src/lpc43xx/lpc43_sdmmc.c +++ b/arch/arm/src/lpc43xx/lpc43_sdmmc.c @@ -2709,7 +2709,7 @@ static void lpc43_callback(struct lpc43_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SD card interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_sdmmc.h b/arch/arm/src/lpc43xx/lpc43_sdmmc.h index 7a27088415cf16f294218165fe6fc3f73b2d846d..449ee0f7a508f146eac58e8d5393e50d2ec5297e 100644 --- a/arch/arm/src/lpc43xx/lpc43_sdmmc.h +++ b/arch/arm/src/lpc43xx/lpc43_sdmmc.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_spi.c b/arch/arm/src/lpc43xx/lpc43_spi.c index a77996513bd729c3b9b5a871f9f9b4d40900deeb..2181b4fa2f0b291d31074c4e95f3842208c0a118 100644 --- a/arch/arm/src/lpc43xx/lpc43_spi.c +++ b/arch/arm/src/lpc43xx/lpc43_spi.c @@ -505,7 +505,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t nw * Description: * Initialize the SPI port * - * Input Parameter: + * Input Parameters: * port Port number (must be zero) * * Returned Value: @@ -564,7 +564,7 @@ static FAR struct spi_dev_s *lpc43_spiport_initialize(int port) * 1 - SSP0 * 2 - SSP1 * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_spi.h b/arch/arm/src/lpc43xx/lpc43_spi.h index d0414f9af64b142f2c44317c2ebbd7e650ba5909..b642f9c49083eb967d9606357834fa9353428806 100644 --- a/arch/arm/src/lpc43xx/lpc43_spi.h +++ b/arch/arm/src/lpc43xx/lpc43_spi.h @@ -98,7 +98,7 @@ extern "C" * 1 - SSP0 * 2 - SSP1 * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_spifi.c b/arch/arm/src/lpc43xx/lpc43_spifi.c index 57349370c027b401854c2703903c8f09631a79c0..ed2f01f2c90b40ac31c1d3856c618799952820fe 100644 --- a/arch/arm/src/lpc43xx/lpc43_spifi.c +++ b/arch/arm/src/lpc43xx/lpc43_spifi.c @@ -1132,7 +1132,7 @@ static inline int lpc43_rominit(FAR struct lpc43_dev_s *priv) * Input Parameters: * None * - * Returned value: + * Returned Value: * One success, a reference to the initialized MTD device instance is * returned; NULL is returned on any failure. * @@ -1220,7 +1220,7 @@ FAR struct mtd_dev_s *lpc43_spifi_initialize(void) * Input Parameters: * high * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_spifi.h b/arch/arm/src/lpc43xx/lpc43_spifi.h index 4445919259139dae7d863faf488338fc380666db..30f85b83282f83a33bea41d49218d72a930264bf 100644 --- a/arch/arm/src/lpc43xx/lpc43_spifi.h +++ b/arch/arm/src/lpc43xx/lpc43_spifi.h @@ -118,7 +118,7 @@ extern "C" * Input Parameters: * None * - * Returned value: + * Returned Value: * One success, a reference to the initialized MTD device instance is * returned; NULL is returned on any failure. * diff --git a/arch/arm/src/lpc43xx/lpc43_ssp.c b/arch/arm/src/lpc43xx/lpc43_ssp.c index 2660b00654707eee749b2e10e9f843dda6d404fe..a9816b9366e92bba380fe5d35f2aeffd05b49fc8 100644 --- a/arch/arm/src/lpc43xx/lpc43_ssp.c +++ b/arch/arm/src/lpc43xx/lpc43_ssp.c @@ -664,7 +664,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: @@ -717,7 +717,7 @@ static inline FAR struct lpc43_sspdev_s *lpc43_ssp0initialize(void) * Description: * Initialize the SSP1 * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -777,7 +777,7 @@ static inline FAR struct lpc43_sspdev_s *lpc43_ssp1initialize(void) * Description: * Initialize the selected SSP port (0=SSP0, 1=SSP1) * - * Input Parameter: + * Input Parameters: * port - Port number (0=SSP0, 1=SSP1) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_ssp.h b/arch/arm/src/lpc43xx/lpc43_ssp.h index 5bf708859e6d54d4b416ee70ac50a73c500eaa21..27be5a5130befebad5f48cabc03948645359919b 100644 --- a/arch/arm/src/lpc43xx/lpc43_ssp.h +++ b/arch/arm/src/lpc43xx/lpc43_ssp.h @@ -95,7 +95,7 @@ extern "C" * Description: * Initialize the selected SSP port (0=SSP0, 1=SSP1) * - * Input Parameter: + * Input Parameters: * port - Port number (0=SSP0, 1=SSP1) * * Returned Value: diff --git a/arch/arm/src/lpc43xx/lpc43_timer.c b/arch/arm/src/lpc43xx/lpc43_timer.c index decc110dd49998f13405d6b8e049fe1497d5e766..7c68ffd449a897e70bc917a5a7c6f1685bc1eb92 100644 --- a/arch/arm/src/lpc43xx/lpc43_timer.c +++ b/arch/arm/src/lpc43xx/lpc43_timer.c @@ -331,7 +331,7 @@ void tmr_clk_disable(uint16_t tmrid) * Input Parameters: * Usual interrupt callback arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -401,7 +401,7 @@ static int lpc43_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. * ****************************************************************************/ @@ -465,7 +465,7 @@ static int lpc43_start(FAR struct timer_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. * ****************************************************************************/ @@ -509,7 +509,7 @@ static int lpc43_stop(FAR struct timer_lowerhalf_s *lower) * half" driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -564,7 +564,7 @@ static int lpc43_getstatus(FAR struct timer_lowerhalf_s *lower, * half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -627,7 +627,7 @@ static int lpc43_settimeout(FAR struct timer_lowerhalf_s *lower, * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -667,7 +667,7 @@ static void lpc43_setcallback(FAR struct timer_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. * ****************************************************************************/ @@ -700,7 +700,7 @@ static int lpc43_ioctl(FAR struct timer_lowerhalf_s *lower, int cmd, * devpath - The full path to the timer. This should be of the form * /dev/tmr0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_timer.h b/arch/arm/src/lpc43xx/lpc43_timer.h index 194d917c3179d58837af19a93a1d6fc95043f9dd..7eed9b2dcd39cdb60e56c042a0746cad236ee54a 100644 --- a/arch/arm/src/lpc43xx/lpc43_timer.h +++ b/arch/arm/src/lpc43xx/lpc43_timer.h @@ -80,7 +80,7 @@ extern "C" * devpath - The full path to the timer. This should be of the form * /dev/timer0 * irq - irq associated with the timer - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_wdt.h b/arch/arm/src/lpc43xx/lpc43_wdt.h index af427504e4dc53fa8c75031ea4d12165852756f7..c1d88a01e6b8ee673e66ebbe0e65719fae765d0a 100644 --- a/arch/arm/src/lpc43xx/lpc43_wdt.h +++ b/arch/arm/src/lpc43xx/lpc43_wdt.h @@ -78,7 +78,7 @@ extern "C" * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc43xx/lpc43_wwdt.c b/arch/arm/src/lpc43xx/lpc43_wwdt.c index 872e8d5f3f5b063c11f0b129cabf09bc0ccd397c..fb60102d420924e3cb3c383e8753da3226b396a2 100644 --- a/arch/arm/src/lpc43xx/lpc43_wwdt.c +++ b/arch/arm/src/lpc43xx/lpc43_wwdt.c @@ -206,7 +206,7 @@ static void lpc43_setwarning(uint32_t warning) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -254,7 +254,7 @@ static int lpc43_interrupt(int irq, FAR void *context) * 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. * ****************************************************************************/ @@ -295,7 +295,7 @@ static int lpc43_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. * ****************************************************************************/ @@ -329,7 +329,7 @@ static int lpc43_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. * ****************************************************************************/ @@ -361,7 +361,7 @@ static int lpc43_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -419,7 +419,7 @@ static int lpc43_getstatus(FAR struct watchdog_lowerhalf_s *lower, * "lower-half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -494,7 +494,7 @@ static int lpc43_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). @@ -563,7 +563,7 @@ static xcpt_t lpc43_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. * ****************************************************************************/ @@ -620,7 +620,7 @@ static int lpc43_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_i2c_master.h b/arch/arm/src/lpc54xx/lpc54_i2c_master.h index 1655d0fec5e174af6ad715ed4e683ff22a44fc58..fc9e80f662a83c5a5986302ae06b9063f6d7d472 100644 --- a/arch/arm/src/lpc54xx/lpc54_i2c_master.h +++ b/arch/arm/src/lpc54xx/lpc54_i2c_master.h @@ -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 *lpc54_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 lpc54_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/lpc54xx/lpc54_lcd.c b/arch/arm/src/lpc54xx/lpc54_lcd.c index 25cb80fc3335eae27060095864f2dd7c0591984e..2b8b5aa262cda268b03e7e3996966f2b54d1e6ee 100644 --- a/arch/arm/src/lpc54xx/lpc54_lcd.c +++ b/arch/arm/src/lpc54xx/lpc54_lcd.c @@ -441,7 +441,7 @@ static int lpc54_setcursor(FAR struct fb_vtable_s *vtable, * 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. * @@ -802,7 +802,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. diff --git a/arch/arm/src/lpc54xx/lpc54_sdmmc.c b/arch/arm/src/lpc54xx/lpc54_sdmmc.c index 626db2654f767b364b2fb0d7f5be3405f74bca20..292732040db4e294a422e4c944b26a1e0675a689 100644 --- a/arch/arm/src/lpc54xx/lpc54_sdmmc.c +++ b/arch/arm/src/lpc54xx/lpc54_sdmmc.c @@ -2709,7 +2709,7 @@ static void lpc54_callback(struct lpc54_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SD card interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_sdmmc.h b/arch/arm/src/lpc54xx/lpc54_sdmmc.h index 7eb00403c55dd833eac291f54a6e4e46f500a755..a56fe2095bc5cc4414a35bd05de257a194f2ef15 100644 --- a/arch/arm/src/lpc54xx/lpc54_sdmmc.h +++ b/arch/arm/src/lpc54xx/lpc54_sdmmc.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_serial.c b/arch/arm/src/lpc54xx/lpc54_serial.c index 7c74dec93be5935cdb4497b6b3e5cf894f6f499f..996affee4caef22105b1d138cf5ad2b425376898 100644 --- a/arch/arm/src/lpc54xx/lpc54_serial.c +++ b/arch/arm/src/lpc54xx/lpc54_serial.c @@ -1421,7 +1421,7 @@ void lpc54_earlyserialinit(void) * Input Parameters: * None * - * Returns Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_spi_master.c b/arch/arm/src/lpc54xx/lpc54_spi_master.c index 35dd60ed8f5f2fcc8f6d517285de5e447449194e..443bcb3333cea4e87e32197607f64fe332da0871 100644 --- a/arch/arm/src/lpc54xx/lpc54_spi_master.c +++ b/arch/arm/src/lpc54xx/lpc54_spi_master.c @@ -1665,7 +1665,7 @@ static void lpc54_spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * ... * 9 - SSP9 * - * Input Parameter: + * Input Parameters: * port - SPI peripheral number. 0..9 * * Returned Value: diff --git a/arch/arm/src/lpc54xx/lpc54_spi_master.h b/arch/arm/src/lpc54xx/lpc54_spi_master.h index aba9a30e72d27c80e8fdec868ae9bf63192a2b3e..9205dd66f45942e36fbe6c340157716739979ec9 100644 --- a/arch/arm/src/lpc54xx/lpc54_spi_master.h +++ b/arch/arm/src/lpc54xx/lpc54_spi_master.h @@ -98,7 +98,7 @@ extern "C" * ... * 9 - SPI9 * - * Input Parameter: + * Input Parameters: * port - SPI peripheral number, 0.. 9. * * Returned Value: diff --git a/arch/arm/src/lpc54xx/lpc54_wwdt.c b/arch/arm/src/lpc54xx/lpc54_wwdt.c index a664d2ba99246fd2b6bf40bd1ab3ab31508200e6..c442ee318e888ccd5867b59921f57b6a8eaa4cd0 100644 --- a/arch/arm/src/lpc54xx/lpc54_wwdt.c +++ b/arch/arm/src/lpc54xx/lpc54_wwdt.c @@ -207,7 +207,7 @@ static void lpc54_setwarning(uint32_t warning) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -255,7 +255,7 @@ static int lpc54_wwdt_interrupt(int irq, FAR void *context) * 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. * ****************************************************************************/ @@ -296,7 +296,7 @@ static int lpc54_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. * ****************************************************************************/ @@ -330,7 +330,7 @@ static int lpc54_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. * ****************************************************************************/ @@ -362,7 +362,7 @@ static int lpc54_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -420,7 +420,7 @@ static int lpc54_getstatus(FAR struct watchdog_lowerhalf_s *lower, * "lower-half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -495,7 +495,7 @@ static int lpc54_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). @@ -564,7 +564,7 @@ static xcpt_t lpc54_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. * ****************************************************************************/ @@ -621,7 +621,7 @@ static int lpc54_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/lpc54xx/lpc54_wwdt.h b/arch/arm/src/lpc54xx/lpc54_wwdt.h index db0822a48ea87fbaf877e452eeea182056b9cc4f..baffd8c167e1000195e56d08fd9a8b54b7759726 100644 --- a/arch/arm/src/lpc54xx/lpc54_wwdt.h +++ b/arch/arm/src/lpc54xx/lpc54_wwdt.h @@ -78,7 +78,7 @@ extern "C" * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/nuc1xx/nuc_gpio.c b/arch/arm/src/nuc1xx/nuc_gpio.c index 0e2b11d54c14f22cc81b67225f2a8be2491d82aa..e5c86c29347314ac50aff4461e45a6ba7e7c5b02 100644 --- a/arch/arm/src/nuc1xx/nuc_gpio.c +++ b/arch/arm/src/nuc1xx/nuc_gpio.c @@ -74,7 +74,7 @@ * function, it must be unconfigured with nuc_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * diff --git a/arch/arm/src/nuc1xx/nuc_gpio.h b/arch/arm/src/nuc1xx/nuc_gpio.h index 1fca1dc0e50933c0ae6f6a1142c67d8f7f6cac5a..9d08dbac1ad9cd506bdca38818363ab8c794fadd 100644 --- a/arch/arm/src/nuc1xx/nuc_gpio.h +++ b/arch/arm/src/nuc1xx/nuc_gpio.h @@ -208,7 +208,7 @@ extern "C" * function, it must be unconfigured with nuc_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * diff --git a/arch/arm/src/sam34/sam4cm_cpuidlestack.c b/arch/arm/src/sam34/sam4cm_cpuidlestack.c index 411ebfaad77efb449d82af9a9b3ac502aface7a6..1f3dd7fad8cc85ef6144d55a7d597d90aa5acea1 100644 --- a/arch/arm/src/sam34/sam4cm_cpuidlestack.c +++ b/arch/arm/src/sam34/sam4cm_cpuidlestack.c @@ -115,7 +115,7 @@ void up_idle(void) * - 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 diff --git a/arch/arm/src/sam34/sam_hsmci.c b/arch/arm/src/sam34/sam_hsmci.c index 25006b7f1963d516e92b09d98d5d1e1525bc346a..0a1f1c2d325915fa256d816b9a4c16688c808df7 100644 --- a/arch/arm/src/sam34/sam_hsmci.c +++ b/arch/arm/src/sam34/sam_hsmci.c @@ -2670,7 +2670,7 @@ static void sam_callback(void *arg) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -2745,7 +2745,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -2792,7 +2792,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_hsmci.h b/arch/arm/src/sam34/sam_hsmci.h index 3339c2d2958abf25b50c903c1dd0bc8436eb7d5a..78dc02069c47ef6eddfb3051193597fb388ed583 100644 --- a/arch/arm/src/sam34/sam_hsmci.h +++ b/arch/arm/src/sam34/sam_hsmci.h @@ -87,7 +87,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -109,7 +109,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -127,7 +127,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_rtt.c b/arch/arm/src/sam34/sam_rtt.c index 7978b01bf38467eb798dea642ecf91f37766eb12..1b945e42e8fe12b6158808e5e2d2e42ba56cda98 100644 --- a/arch/arm/src/sam34/sam_rtt.c +++ b/arch/arm/src/sam34/sam_rtt.c @@ -270,7 +270,7 @@ static void sam34_putreg(uint32_t val, uint32_t addr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -354,7 +354,7 @@ static int sam34_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. * ****************************************************************************/ @@ -417,7 +417,7 @@ static int sam34_start(FAR struct timer_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. * ****************************************************************************/ @@ -456,7 +456,7 @@ static int sam34_stop(FAR struct timer_lowerhalf_s *lower) * driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -507,7 +507,7 @@ static int sam34_getstatus(FAR struct timer_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -559,7 +559,7 @@ static int sam34_settimeout(FAR struct timer_lowerhalf_s *lower, * behavior is restored, * arg - Argument that will be provided in the callback * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -599,7 +599,7 @@ static void sam34_setcallback(FAR struct timer_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. * ****************************************************************************/ @@ -632,7 +632,7 @@ static int sam34_ioctl(FAR struct timer_lowerhalf_s *lower, int cmd, * devpath - The full path to the timer. This should be of the form * /dev/rtt0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_rtt.h b/arch/arm/src/sam34/sam_rtt.h index f300747efb3f5aff624ff55f42156273a86f878c..3a00c17fbdd5ff45ec9a562626d5a7125ea03e14 100644 --- a/arch/arm/src/sam34/sam_rtt.h +++ b/arch/arm/src/sam34/sam_rtt.h @@ -80,7 +80,7 @@ extern "C" * devpath - The full path to the timer. This should be of the form * /dev/rtt0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_spi.c b/arch/arm/src/sam34/sam_spi.c index 79bc6ca9eae53197a2f20ba68c9cdf0a70999fdf..212293b26d56b40bfa0130e84ebcb4c058437ca8 100644 --- a/arch/arm/src/sam34/sam_spi.c +++ b/arch/arm/src/sam34/sam_spi.c @@ -1711,7 +1711,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *buffer, size_t nwords) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: diff --git a/arch/arm/src/sam34/sam_spi.h b/arch/arm/src/sam34/sam_spi.h index 8cebb2f121b4864484d74c4864a3fec6baca8528..b9cbcce76df2f724b8a458b1617b9e5a5933e956 100644 --- a/arch/arm/src/sam34/sam_spi.h +++ b/arch/arm/src/sam34/sam_spi.h @@ -117,7 +117,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: @@ -182,7 +182,7 @@ struct spi_dev_s *sam_spibus_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -204,7 +204,7 @@ void sam_spi1select(uint32_t devid, bool selected); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -235,7 +235,7 @@ uint8_t sam_spi1status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_tc.c b/arch/arm/src/sam34/sam_tc.c index 1faab8b159f170cdff8b24429ca733d0c0c16917..3212174623864deadf897dc6ff41b3ee3fa060bf 100644 --- a/arch/arm/src/sam34/sam_tc.c +++ b/arch/arm/src/sam34/sam_tc.c @@ -250,7 +250,7 @@ static void sam34_putreg(uint32_t val, uint32_t addr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -309,7 +309,7 @@ static int sam34_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. * ****************************************************************************/ @@ -365,7 +365,7 @@ static int sam34_start(FAR struct timer_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. * ****************************************************************************/ @@ -401,7 +401,7 @@ static int sam34_stop(FAR struct timer_lowerhalf_s *lower) * driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -454,7 +454,7 @@ static int sam34_getstatus(FAR struct timer_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -507,7 +507,7 @@ static int sam34_settimeout(FAR struct timer_lowerhalf_s *lower, * behavior is restored, * arg - Argument to be provided with the callback. * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -547,7 +547,7 @@ static void sam34_setcallback(FAR struct timer_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. * ****************************************************************************/ @@ -580,7 +580,7 @@ static int sam34_ioctl(FAR struct timer_lowerhalf_s *lower, int cmd, * devpath - The full path to the timer. This should be of the form * /dev/tc0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_tc.h b/arch/arm/src/sam34/sam_tc.h index df7b3caf29011e8e006039bcd58965744577ae79..3667213d75200d75dbfe810ec84ca9f4395c846c 100644 --- a/arch/arm/src/sam34/sam_tc.h +++ b/arch/arm/src/sam34/sam_tc.h @@ -79,7 +79,7 @@ extern "C" * devpath - The full path to the timer. This should be of the form * /dev/tc0 * irq - irq associated with the timer - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_twi.h b/arch/arm/src/sam34/sam_twi.h index 87c31b30321b70017756d42cd83ecb15c9ce5b53..06868044b2a4552575af05aff2d16b2277f92d4e 100644 --- a/arch/arm/src/sam34/sam_twi.h +++ b/arch/arm/src/sam34/sam_twi.h @@ -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 *sam_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 sam_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/sam34/sam_wdt.c b/arch/arm/src/sam34/sam_wdt.c index cf88b37fec1e515a2865e2eccbc152c6ded95302..4e902f46b5ffb229825404c23813b8ead5636e2e 100644 --- a/arch/arm/src/sam34/sam_wdt.c +++ b/arch/arm/src/sam34/sam_wdt.c @@ -251,7 +251,7 @@ static void sam34_putreg(uint32_t val, uint32_t addr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -294,7 +294,7 @@ static int sam34_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. * ****************************************************************************/ @@ -338,7 +338,7 @@ static int sam34_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. * ****************************************************************************/ @@ -369,7 +369,7 @@ static int sam34_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. * ****************************************************************************/ @@ -393,7 +393,7 @@ static int sam34_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -449,7 +449,7 @@ static int sam34_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. * ****************************************************************************/ @@ -516,7 +516,7 @@ static int sam34_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). @@ -589,7 +589,7 @@ static xcpt_t sam34_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. * ****************************************************************************/ @@ -649,7 +649,7 @@ static int sam34_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sam34/sam_wdt.h b/arch/arm/src/sam34/sam_wdt.h index 77a1fbab40e3dd684031c8ab1e7a459c427cf83c..3330cc01e73349e1171b9ff89451ace27ff59396 100644 --- a/arch/arm/src/sam34/sam_wdt.h +++ b/arch/arm/src/sam34/sam_wdt.h @@ -79,7 +79,7 @@ extern "C" * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_adc.c b/arch/arm/src/sama5/sam_adc.c index c61f44a3df5aa90c32b715bc81b79d6bce93ce40..d6975391a4610a21b93ec425da3fc22e9e014d64 100644 --- a/arch/arm/src/sama5/sam_adc.c +++ b/arch/arm/src/sama5/sam_adc.c @@ -591,7 +591,7 @@ static bool sam_adc_checkreg(struct sam_adc_s *priv, bool wr, * thread sets ready when it has completed processing the last sample * data. * - * Input Parameters + * Input Parameters: * arg - The ADC private data structure cast to (void *) * * Returned Value: @@ -838,7 +838,7 @@ static int sam_adc_dmasetup(FAR struct sam_adc_s *priv, FAR uint8_t *buffer, * sam_adc_endconversion will re-enable EOC interrupts when it completes * processing all pending EOC events. * - * Input Parameters + * Input Parameters: * arg - The ADC private data structure cast to (void *) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_can.c b/arch/arm/src/sama5/sam_can.c index 956ae680e8d5b39cbd6d233c78a33142e7d9dc1e..960c2e53467b931234f1b3c4647edafc3a31ea32 100644 --- a/arch/arm/src/sama5/sam_can.c +++ b/arch/arm/src/sama5/sam_can.c @@ -579,7 +579,7 @@ static void can_semtake(FAR struct sam_can_s *priv) * Description: * Allocate one mailbox * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * * Returned Value: @@ -626,7 +626,7 @@ static int can_mballoc(FAR struct sam_can_s *priv) * Description: * Free one mailbox * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * mbndx - Index of the mailbox to be freed * @@ -670,7 +670,7 @@ static void can_mbfree(FAR struct sam_can_s *priv, int mbndx) * Description: * Configure and enable mailbox(es) for reception * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * * Returned Value: @@ -1592,7 +1592,7 @@ static void can_interrupt(int irq, void *context, FAR void *arg) * Tphs1 = Tq * (PHASE1 + 1) * Tphs2 = Tq * (PHASE2 + 1) * - * Input Parameter: + * Input Parameters: * config - A reference to the CAN constant configuration * * Returned Value: @@ -1706,7 +1706,7 @@ static int can_bittiming(struct sam_can_s *priv) * Description: * Use the SAMA5 auto-baud feature to correct the initial timing * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1776,7 +1776,7 @@ static int can_autobaud(struct sam_can_s *priv) * Description: * CAN cell initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN peripheral * * Returned Value: @@ -1889,7 +1889,7 @@ static int can_hwinitialize(struct sam_can_s *priv) * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_can.h b/arch/arm/src/sama5/sam_can.h index 83a08f756bb59a93b5307cec0627a25dcb5c0928..bff7c1efbf007fd2fcb7d708eef27ac0ddbde513 100644 --- a/arch/arm/src/sama5/sam_can.h +++ b/arch/arm/src/sama5/sam_can.h @@ -125,7 +125,7 @@ extern "C" * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number: 0=CAN0, 1=CAN1 * * Returned Value: diff --git a/arch/arm/src/sama5/sam_ehci.c b/arch/arm/src/sama5/sam_ehci.c index 9b25316272fe95c7569e3b103657b962bf3fc4e3..bd87be9f93b252fa2d575f0db20a3e7f934919d2 100644 --- a/arch/arm/src/sama5/sam_ehci.c +++ b/arch/arm/src/sama5/sam_ehci.c @@ -1903,7 +1903,7 @@ static struct sam_qtd_s *sam_qtd_statusphase(uint32_t tokenbits) * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2183,7 +2183,7 @@ errout_with_qh: * * Assumption: The caller holds the EHCI exclsem. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -2290,7 +2290,7 @@ errout_with_qh: * complete, but will be re-acquired when before returning. The state of * EHCI resources could be very different upon return. * - * Returned value: + * Returned Value: * On success, this function returns the number of bytes actually transferred. * For control transfers, this size includes the size of the control request * plus the size of the data (which could be short); For bulk transfers, this @@ -2370,7 +2370,7 @@ static ssize_t sam_transfer_wait(struct sam_epinfo_s *epinfo) * callback - The function to be called when the completes * arg - An arbitrary argument that will be provided with the callback. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -2423,7 +2423,7 @@ static inline int sam_ioc_async_setup(struct sam_rhport_s *rhport, * epinfo - The IN or OUT endpoint descriptor for the device endpoint on * which the transfer was performed. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3265,7 +3265,7 @@ static int sam_uhphs_interrupt(int irq, FAR void *context, FAR void *arg) * 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 @@ -3367,7 +3367,7 @@ static int sam_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 * @@ -3659,7 +3659,7 @@ static int sam_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 * @@ -3703,7 +3703,7 @@ static int sam_ep0configure(FAR struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * 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 * @@ -3786,7 +3786,7 @@ static int sam_epalloc(FAR struct usbhost_driver_s *drvr, * the class create() method. * ep - The endpint 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 * @@ -3831,7 +3831,7 @@ static int sam_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 * @@ -3876,7 +3876,7 @@ static int sam_alloc(FAR struct usbhost_driver_s *drvr, * to 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 * @@ -3913,7 +3913,7 @@ static int sam_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 * @@ -3952,7 +3952,7 @@ static int sam_ioalloc(FAR struct usbhost_driver_s *drvr, FAR uint8_t **buffer, * 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 * @@ -3996,7 +3996,7 @@ static int sam_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 * @@ -4097,7 +4097,7 @@ static int sam_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: @@ -4208,7 +4208,7 @@ errout_with_sem: * 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 * @@ -4301,7 +4301,7 @@ errout_with_sem: * 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. * @@ -4490,7 +4490,7 @@ errout_with_sem: * 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. * @@ -4541,7 +4541,7 @@ static int sam_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/sama5/sam_hsmci.c b/arch/arm/src/sama5/sam_hsmci.c index e47248e2ebb7fcde2d11a1a62ec7929b24a07475..3b8e48610e4e4e9738a2b4a6c5195eaae5ff0c5c 100644 --- a/arch/arm/src/sama5/sam_hsmci.c +++ b/arch/arm/src/sama5/sam_hsmci.c @@ -3160,7 +3160,7 @@ static void sam_callback(void *arg) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3353,7 +3353,7 @@ FAR struct sdio_dev_s *sdio_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 * * Assumptions: @@ -3406,7 +3406,7 @@ void sdio_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 write protected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_hsmci.h b/arch/arm/src/sama5/sam_hsmci.h index c28bf89594f6c3894099cb752c7f25ee3946dde1..a3257e7d588807d65dfbcb46796cfaf4a73a137e 100644 --- a/arch/arm/src/sama5/sam_hsmci.h +++ b/arch/arm/src/sama5/sam_hsmci.h @@ -87,7 +87,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -118,7 +118,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: @@ -143,7 +143,7 @@ uint32_t sam_hsmci_clkdiv(uint32_t target); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -161,7 +161,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_hsmci_clkdiv.c b/arch/arm/src/sama5/sam_hsmci_clkdiv.c index 4ddba13e82b8da3b4514869a8336dddfea447c21..4a56bed140fb3d012a59b12adba992d3dbe821e7 100644 --- a/arch/arm/src/sama5/sam_hsmci_clkdiv.c +++ b/arch/arm/src/sama5/sam_hsmci_clkdiv.c @@ -97,7 +97,7 @@ * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: diff --git a/arch/arm/src/sama5/sam_irq.c b/arch/arm/src/sama5/sam_irq.c index fd4dfd8c5cc246f7e28df209f7212b9c13b05ae7..fbdc1eda5c564d4030c24c1d9f0e0d930a91e13a 100644 --- a/arch/arm/src/sama5/sam_irq.c +++ b/arch/arm/src/sama5/sam_irq.c @@ -261,7 +261,7 @@ static uint32_t *sam_fiqhandler(int irq, uint32_t *regs) * Description: * Return true if the peripheral secure. * - * Input Parameter: + * Input Parameters: * PID = IRQ number * ****************************************************************************/ @@ -576,7 +576,7 @@ void up_irqinitialize(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. * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_lcd.c b/arch/arm/src/sama5/sam_lcd.c index 4e27e1ef2ab5bcf67a244c2faa1ad8ccbe58d87e..67f1ac0628de87f64c75fb0120c3b1f1d6dbbb02 100644 --- a/arch/arm/src/sama5/sam_lcd.c +++ b/arch/arm/src/sama5/sam_lcd.c @@ -2901,7 +2901,7 @@ static void sam_show_hcr(void) * 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. * @@ -3001,7 +3001,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. diff --git a/arch/arm/src/sama5/sam_nand.c b/arch/arm/src/sama5/sam_nand.c index ae0c22936d4c7dde0cfb5757c53305809f0da3b1..a0fb369ce1f4b1719cfd736c56da7b4fb2abe3b4 100644 --- a/arch/arm/src/sama5/sam_nand.c +++ b/arch/arm/src/sama5/sam_nand.c @@ -353,10 +353,10 @@ void nand_unlock(void) * Waiting for the completion of a page program, erase and random read * completion. * - * Input parameters: + * Input Parameters: * priv Pointer to a sam_nandcs_s instance. * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -376,13 +376,13 @@ static void nand_wait_ready(struct sam_nandcs_s *priv) * Description: * Use the HOST NAND FLASH controller to send a command to the NFC. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * cmd - command to send * acycle - address cycle when command access id decoded * cycle0 - address at first cycle * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -414,10 +414,10 @@ static void nand_nfc_cmdsend(struct sam_nandcs_s *priv, uint32_t cmd, * Description: * Check if a program or erase operation completed successfully * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * - * Returned value. + * Returned Value: * OK on success, a negated errnor value on failure * ****************************************************************************/ @@ -451,7 +451,7 @@ static int nand_operation_complete(struct sam_nandcs_s *priv) * address cycles. The resulting values are stored in the provided * variables if they are not null. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * coladdr - Column address to translate. * rowaddr - Row address to translate. @@ -459,7 +459,7 @@ static int nand_operation_complete(struct sam_nandcs_s *priv) * acycle1234 - Four address cycles. * rowonly - True:Only ROW address is used. * - * Returned value. + * Returned Value: * Number of address cycles converted. * ****************************************************************************/ @@ -565,10 +565,10 @@ static int nand_translate_address(struct sam_nandcs_s *priv, * Description: * Map the number of address cycles the bit setting for the NFC command * - * Input parameters: + * Input Parameters: * ncycles - Number of address cycles * - * Returned value. + * Returned Value: * NFC command value * ****************************************************************************/ @@ -602,7 +602,7 @@ static uint32_t nand_get_acycle(int ncycles) * Description: * Sends NAND CLE/ALE command. * - * Input parameters: + * Input Parameters: * priv - Pointer to a sam_nandcs_s instance. * mode - SMC ALE CLE mode parameter. * cmd1 - First command to be sent. @@ -610,7 +610,7 @@ static uint32_t nand_get_acycle(int ncycles) * coladdr - Column address. * rowaddr - Row address. * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -670,10 +670,10 @@ static void nand_nfc_cleale(struct sam_nandcs_s *priv, uint8_t mode, * Description: * Wait for NFC command done * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -716,10 +716,10 @@ static void nand_wait_cmddone(struct sam_nandcs_s *priv) * Description: * Setup to wait for CMDDONE event * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -758,10 +758,10 @@ static void nand_setup_cmddone(struct sam_nandcs_s *priv) * Description: * Wait for a transfer to complete * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -804,10 +804,10 @@ static void nand_wait_xfrdone(struct sam_nandcs_s *priv) * Description: * Setup to wait for XFDONE event * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -846,10 +846,10 @@ static void nand_setup_xfrdone(struct sam_nandcs_s *priv) * Description: * Wait for read/busy edge detection * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -892,10 +892,10 @@ static void nand_wait_rbedge(struct sam_nandcs_s *priv) * Description: * Setup to wait for RBEDGE0 event * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -934,10 +934,10 @@ static void nand_setup_rbedge(struct sam_nandcs_s *priv) * Description: * Wait for NFC not busy * - * Input parameters: + * Input Parameters: * priv - CS state structure instance * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -965,10 +965,10 @@ static void nand_wait_nfcbusy(struct sam_nandcs_s *priv) * This latching capability function is needed to prevent loss of pending * status when sampling the HSMC_SR register. * - * Input parameters: + * Input Parameters: * None * - * Returned value. + * Returned Value: * Current HSMC_SR register value; * ****************************************************************************/ @@ -1041,10 +1041,10 @@ static uint32_t nand_nfc_poll(void) * Description: * HSMC interrupt handler * - * Input parameters: + * Input Parameters: * Standard interrupt arguments * - * Returned value. + * Returned Value: * Always returns OK * ****************************************************************************/ @@ -1203,10 +1203,10 @@ static void nand_dma_sampledone(struct sam_nandcs_s *priv, int result) * Description: * Wait for the completion of a DMA transfer * - * Input parameters: + * Input Parameters: * Wait for read/busy edge detection * - * Returned value. + * Returned Value: * The result of the DMA. OK on success; a negated ernno value on failure. * ****************************************************************************/ @@ -1266,7 +1266,7 @@ static void nand_dmacallback(DMA_HANDLE handle, void *arg, int result) * nbytes - The number of bytes to transfer * dmaflags - Describes the DMA configuration * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1355,7 +1355,7 @@ static int nand_dma_read(struct sam_nandcs_s *priv, * nbytes - The number of bytes to transfer * dmaflags - Describes the DMA configuration * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1440,7 +1440,7 @@ static int nand_dma_write(struct sam_nandcs_s *priv, * offset - If reading from NFC SRAM, this is the offset into * the SRAM. * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1506,7 +1506,7 @@ static int nand_nfcsram_read(struct sam_nandcs_s *priv, uint8_t *buffer, * nfcsram - True: Use NFC Host SRAM * buffer - Buffer that provides the data for the write * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1590,13 +1590,13 @@ static int nand_read(struct sam_nandcs_s *priv, uint8_t *buffer, * Description: * Reads the data area of a page of a NAND FLASH into the provided buffer. * - * Input parameters: + * Input Parameters: * priv - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -1743,7 +1743,7 @@ static int nand_read_pmecc(struct sam_nandcs_s *priv, off_t block, * buffer - Buffer that provides the data for the write * offset - Data offset in bytes * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1806,7 +1806,7 @@ static int nand_nfcsram_write(struct sam_nandcs_s *priv, uint8_t *buffer, * buffer - Buffer that provides the data for the write * offset - Data offset in bytes * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -1891,14 +1891,14 @@ static int nand_write(struct sam_nandcs_s *priv, uint8_t *buffer, * provided buffers. The raw NAND contents are returned with no ECC * corrections. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2007,13 +2007,13 @@ static int nand_readpage_noecc(struct sam_nandcs_s *priv, off_t block, * Reads the data and/or the spare areas of a page of a NAND FLASH into the * provided buffers. PMECC is used * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2127,14 +2127,14 @@ errout: * Writes the data and/or the spare area of a page on a NAND FLASH chip. * No ECC calculations are performed. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer conatining the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2281,13 +2281,13 @@ static int nand_writepage_noecc(struct sam_nandcs_s *priv, off_t block, * performed. The redundancy is appended to the page and written in the * spare area. * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2495,11 +2495,11 @@ errout: * Description: * Erases the specified block of the device. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the physical block to erase. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2575,14 +2575,14 @@ static int nand_eraseblock(struct nand_raw_s *raw, off_t block) * Reads the data and/or the spare areas of a page of a NAND FLASH into the * provided buffers. This is a raw read of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2612,14 +2612,14 @@ static int nand_rawread(struct nand_raw_s *raw, off_t block, * Writes the data and/or the spare area of a page on a NAND FLASH chip. * This is a raw write of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2651,14 +2651,14 @@ static int nand_rawwrite(struct nand_raw_s *raw, off_t block, * provided buffers. Hardware ECC checking will be performed if so * configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2713,14 +2713,14 @@ static int nand_readpage(struct nand_raw_s *raw, off_t block, * Writes the data and/or the spare area of a page on a NAND FLASH chip. * Hardware ECC checking will be performed if so configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer conatining the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -2775,10 +2775,10 @@ static int nand_writepage(struct nand_raw_s *raw, off_t block, * Description: * Resets a NAND FLASH device * - * Input parameters: + * Input Parameters: * priv - Lower-half, private NAND FLASH device state * - * Returned value. + * Returned Value: * None * ****************************************************************************/ @@ -2803,11 +2803,11 @@ static void nand_reset(struct sam_nandcs_s *priv) * performed here. Those necessary NAND features are provided by common, * higher level NAND MTD layers found in drivers/mtd. * - * Input parameters: + * Input Parameters: * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned value. + * Returned Value: * On success a non-NULL pointer to an MTD device structure is returned; * NULL is returned on a failure. * diff --git a/arch/arm/src/sama5/sam_nand.h b/arch/arm/src/sama5/sam_nand.h index 808b719aa52d3a94462fb81a64b8a56afec7e64f..69c6b729e9ed336d00d25ce2c58d6054b3712cef 100644 --- a/arch/arm/src/sama5/sam_nand.h +++ b/arch/arm/src/sama5/sam_nand.h @@ -397,11 +397,11 @@ EXTERN struct sam_nand_s g_nand; * performed here. Those necessary NAND features are provided by common, * higher level NAND MTD layers found in drivers/mtd. * - * Input parameters: + * Input Parameters: * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned value. + * Returned Value: * On success a non-NULL pointer to an MTD device structure is returned; * NULL is returned on a failure. * @@ -428,7 +428,7 @@ struct mtd_dev_s *sam_nand_initialize(int cs); * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested @@ -449,7 +449,7 @@ int board_nandflash_config(int cs); * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * True: NAND is busy, False: NAND is ready * ****************************************************************************/ @@ -470,7 +470,7 @@ bool board_nand_busy(int cs); * are connected on-board). * enable - True: enable Chip Select, False: Disable Chip select * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/arch/arm/src/sama5/sam_ohci.c b/arch/arm/src/sama5/sam_ohci.c index 7b87c382c6952fd6fc4d24261e9def24f55819a3..fac941d686267fa1fb2135ecfa092637b9a18674 100644 --- a/arch/arm/src/sama5/sam_ohci.c +++ b/arch/arm/src/sama5/sam_ohci.c @@ -1543,7 +1543,7 @@ static int sam_enqueuetd(struct sam_rhport_s *rhport, struct sam_eplist_s *eplis * Input Parameters: * rhpndx - Root hub port index. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1629,7 +1629,7 @@ static int sam_ep0enqueue(struct sam_rhport_s *rhport) * ep0 - The control endpoint to be released. May be the control endpoint for * an attached hub. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -2319,7 +2319,7 @@ static void sam_ohci_bottomhalf(void *arg) * 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 @@ -2437,7 +2437,7 @@ static int sam_wait(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 * @@ -2564,7 +2564,7 @@ static int sam_enumerate(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 * @@ -2627,7 +2627,7 @@ static int sam_ep0configure(struct usbhost_driver_s *drvr, usbhost_ep_t ep0, * 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 * @@ -2832,7 +2832,7 @@ errout: * 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 * @@ -2924,7 +2924,7 @@ static int sam_epfree(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 * @@ -2969,7 +2969,7 @@ static int sam_alloc(struct usbhost_driver_s *drvr, * to 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 * @@ -3008,7 +3008,7 @@ static int sam_free(struct usbhost_driver_s *drvr, 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 * @@ -3042,7 +3042,7 @@ static int sam_ioalloc(struct usbhost_driver_s *drvr, uint8_t **buffer, * 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 * @@ -3087,7 +3087,7 @@ static int sam_iofree(struct usbhost_driver_s *drvr, 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 * @@ -3206,7 +3206,7 @@ static int sam_ctrlout(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, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure. * @@ -3296,7 +3296,7 @@ static int sam_transfer_common(struct sam_rhport_s *rhport, * (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, zero (OK) is returned. On a failure, a negated errno value is * returned indicating the nature of the failure: * @@ -3445,7 +3445,7 @@ errout: * eplist - The internal representation of the device endpoint on which * to perform the transfer. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -3555,7 +3555,7 @@ static void sam_asynch_completion(struct sam_eplist_s *eplist) * 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 * @@ -3635,7 +3635,7 @@ errout: * 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. * @@ -3780,7 +3780,7 @@ static int sam_cancel(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. * @@ -3831,7 +3831,7 @@ static int sam_connect(struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/sama5/sam_pwm.c b/arch/arm/src/sama5/sam_pwm.c index 90b204eac30c03d958419e8b082d309dfb90de64..1758bee1a7940aaff5c4322f3dc572a345f3006a 100644 --- a/arch/arm/src/sama5/sam_pwm.c +++ b/arch/arm/src/sama5/sam_pwm.c @@ -754,7 +754,7 @@ static void pwm_chan_putreg(struct sam_pwm_chan_s *chan, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * chan - A reference to the PWM channel instance * * Returned Value: @@ -827,7 +827,7 @@ static void pwm_dumpregs(struct sam_pwm_chan_s *chan, FAR const char *msg) * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * Standard interrupt handler inputs * * Returned Value: @@ -854,7 +854,7 @@ static int pwm_interrupt(int irq, void *context, FAR void *arg) * use. It will 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: @@ -897,7 +897,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: @@ -927,7 +927,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 * @@ -1049,7 +1049,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: @@ -1086,7 +1086,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 @@ -1145,7 +1145,7 @@ static int pwm_ioctl(FAR struct pwm_lowerhalf_s *dev, int cmd, unsigned long arg * regbits = PWM_CLK_PREB_DIV(prelog2); * prescaler = (1 << prelog2) * - * Input parameters: + * Input Parameters: * mck - The main clock frequency * fclk - The desired clock A or B frequency * @@ -1193,7 +1193,7 @@ static unsigned int pwm_clk_prescaler_log2(uint32_t mck, uint32_t fclk) * * div = MCK / prescaler / frequency * - * Input parameters: + * Input Parameters: * mck - The main clock frequency * fclk - The desired clock A or B frequency * prelog2 - The log2(prescaler) value previously selected by @@ -1231,7 +1231,7 @@ static unsigned int pwm_clk_divider(uint32_t mck, uint32_t fclk, * * frequency = MCK / prescaler / div * - * Input parameters: + * Input Parameters: * mck - The main clock frequency * prelog2 - The log2(prescaler) value previously selected by * pwm_prescale_log2(). @@ -1255,7 +1255,7 @@ static uint32_t pwm_clk_frequency(uint32_t mck, unsigned int prelog2, * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * chan - A reference to the PWM channel instance * * Returned Value: diff --git a/arch/arm/src/sama5/sam_spi.c b/arch/arm/src/sama5/sam_spi.c index 457aa04f197ae389c12db0734d62a141a5621fd5..eaf588202065c27cd0b6602d87b991d933d45ff9 100644 --- a/arch/arm/src/sama5/sam_spi.c +++ b/arch/arm/src/sama5/sam_spi.c @@ -1638,7 +1638,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *buffer, size_t nwords) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_spi.h b/arch/arm/src/sama5/sam_spi.h index 705f2248e75fc9df41b9f3440e05e0603e57c126..4a8697f25ab02bab2a9d3d2cd32f9f97247f4288 100644 --- a/arch/arm/src/sama5/sam_spi.h +++ b/arch/arm/src/sama5/sam_spi.h @@ -111,7 +111,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: @@ -175,7 +175,7 @@ struct spi_dev_s *sam_spibus_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -197,7 +197,7 @@ void sam_spi1select(uint32_t devid, bool selected); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -228,7 +228,7 @@ uint8_t sam_spi1status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_ssc.c b/arch/arm/src/sama5/sam_ssc.c index 0c8699103084cc815bbba2cccfa195319d884505..176b2235cc0bee516cb6d22240dd3dfa524e37af 100644 --- a/arch/arm/src/sama5/sam_ssc.c +++ b/arch/arm/src/sama5/sam_ssc.c @@ -2786,7 +2786,7 @@ static int ssc_tx_configure(struct sam_ssc_s *priv) * Setup the MCK/2 divider based on the currently selected data width and * the sample rate * - * Input Parameter: + * Input Parameters: * priv - I2C device structure (only the sample rate and data length is * needed at this point). * @@ -2843,7 +2843,7 @@ static uint32_t ssc_mck2divider(struct sam_ssc_s *priv) * Description: * Enable and configure clocking to the SSC * - * Input Parameter: + * Input Parameters: * priv - Partially initialized I2C device structure (only the PID is * needed at this point). * @@ -3394,7 +3394,7 @@ static void ssc1_configure(struct sam_ssc_s *priv) * Description: * Initialize the selected SSC port * - * Input Parameter: + * Input Parameters: * port - I2S "port" number (identifying the "logical" SSC port) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_ssc.h b/arch/arm/src/sama5/sam_ssc.h index b7ecafe5a454591009f0523c484d68988a21bd2c..7ae4dafe079e0450fe03881c173e303ccbec505f 100644 --- a/arch/arm/src/sama5/sam_ssc.h +++ b/arch/arm/src/sama5/sam_ssc.h @@ -83,7 +83,7 @@ extern "C" * Description: * Initialize the selected I2S port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/sama5/sam_tsd.c b/arch/arm/src/sama5/sam_tsd.c index 36fc9e6d00ef1ee672472a86c54b3600d7add1a9..875091a8780c3879d83f62a403b718e498ff6ed7 100644 --- a/arch/arm/src/sama5/sam_tsd.c +++ b/arch/arm/src/sama5/sam_tsd.c @@ -432,7 +432,7 @@ errout: * The ADC hardware can filter the touchscreen samples by averaging. The * function selects (or de-selects) that filtering. * - * Input Parameters + * Input Parameters: * priv - The touchscreen private data structure * tsav - The new (shifted) value of the TSAV field of the ADC TSMR regsiter. * @@ -494,7 +494,7 @@ static void sam_tsd_setaverage(struct sam_tsd_s *priv, uint32_t tsav) * will re-enable TSD interrupts when it completes processing all pending * TSD events. * - * Input Parameters + * Input Parameters: * arg - The touchscreen private data structure cast to (void *) * * Returned Value: @@ -1707,7 +1707,7 @@ errout_with_priv: * Description: * Handles ADC interrupts associated with touchscreen channels * - * Input parmeters: + * Input Parameters: * pending - Current set of pending interrupts being handled * * Returned Value: diff --git a/arch/arm/src/sama5/sam_tsd.h b/arch/arm/src/sama5/sam_tsd.h index 3ae36434b792a21f213144a98f13694b1981b551..ff0d6a5ead826217c156ca30306c4b58d6681362 100644 --- a/arch/arm/src/sama5/sam_tsd.h +++ b/arch/arm/src/sama5/sam_tsd.h @@ -119,7 +119,7 @@ int sam_tsd_register(FAR struct sam_adc_s *adc, int minor); * Description: * Handles ADC interrupts associated with touchscreen channels * - * Input parmeters: + * Input Parameters: * pending - Current set of pending interrupts being handled * * Returned Value: diff --git a/arch/arm/src/sama5/sam_twi.h b/arch/arm/src/sama5/sam_twi.h index e8d75e133540ecfd66e90cda005cf6bff16832d9..f966bec8f8b5ddd9ec2af97800186f2b9434730a 100644 --- a/arch/arm/src/sama5/sam_twi.h +++ b/arch/arm/src/sama5/sam_twi.h @@ -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 *sam_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 sam_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/sama5/sam_wdt.c b/arch/arm/src/sama5/sam_wdt.c index 9d3f7dd61eaed194699b3e485a7712664a01b036..0fd0fa21ee1b3e8b8f9dbffd11b6324cdde88ae2 100644 --- a/arch/arm/src/sama5/sam_wdt.c +++ b/arch/arm/src/sama5/sam_wdt.c @@ -254,7 +254,7 @@ static void sam_putreg(uint32_t regval, uintptr_t regaddr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -290,7 +290,7 @@ static int sam_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. * ****************************************************************************/ @@ -320,7 +320,7 @@ static int sam_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. * ****************************************************************************/ @@ -350,7 +350,7 @@ static int sam_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. * ****************************************************************************/ @@ -378,7 +378,7 @@ static int sam_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. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int sam_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. * ****************************************************************************/ @@ -554,7 +554,7 @@ static int sam_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). @@ -619,7 +619,7 @@ static xcpt_t sam_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. * ****************************************************************************/ @@ -649,7 +649,7 @@ static int sam_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * Input Parameters: * None * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/sama5/sam_wdt.h b/arch/arm/src/sama5/sam_wdt.h index 0f9eab7b75b871c6e96f466872f916ebc5bb5def..ba3a067b1df0b5277efc4e59b58f12efef6ccc43 100644 --- a/arch/arm/src/sama5/sam_wdt.h +++ b/arch/arm/src/sama5/sam_wdt.h @@ -76,7 +76,7 @@ extern "C" * * At a minimum, this function should call watchdog_register(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/samdl/sam_port.h b/arch/arm/src/samdl/sam_port.h index c03edcbcb5d38494b4be3e9beb3c2a622a9043fa..3227c5480381eaed2efab21bbe291d6366a97396 100644 --- a/arch/arm/src/samdl/sam_port.h +++ b/arch/arm/src/samdl/sam_port.h @@ -343,7 +343,7 @@ extern "C" * Description: * Configure a PORT pin based on bit-encoded description of the pin. * - * Returns: + * Returned Value: * OK (always) * ****************************************************************************/ diff --git a/arch/arm/src/samdl/sam_spi.c b/arch/arm/src/samdl/sam_spi.c index dbecb7e09bb7e4ad74c27842c16d74cb8378ecd4..9f398fd9e9147fbda631ae32900d90f105d950eb 100644 --- a/arch/arm/src/samdl/sam_spi.c +++ b/arch/arm/src/samdl/sam_spi.c @@ -1322,7 +1322,7 @@ static void spi_pad_configure(struct sam_spidev_s *priv) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * port - SPI "port" number (i.e., SERCOM number) * * Returned Value: diff --git a/arch/arm/src/samdl/sam_spi.h b/arch/arm/src/samdl/sam_spi.h index 7e0cbfa9e08d53a0167294d39bd9b3230b622b65..d4044ab19cd820f282e662c23ba129c1fd9462a3 100644 --- a/arch/arm/src/samdl/sam_spi.h +++ b/arch/arm/src/samdl/sam_spi.h @@ -94,7 +94,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * port - SPI "port" number (i.e., SERCOM number) * * Returned Value: @@ -161,7 +161,7 @@ struct spi_dev_s *sam_spibus_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -206,7 +206,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -254,7 +254,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_hsmci.c b/arch/arm/src/samv7/sam_hsmci.c index 4f5e0d87d9b8e83049b53a033c4be40998f3c8d8..213be4f878649dd8b6be4002eddfe1d5282aeea8 100644 --- a/arch/arm/src/samv7/sam_hsmci.c +++ b/arch/arm/src/samv7/sam_hsmci.c @@ -3234,7 +3234,7 @@ static void sam_callback(void *arg) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3385,7 +3385,7 @@ FAR struct sdio_dev_s *sdio_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 * * Assumptions: @@ -3438,7 +3438,7 @@ void sdio_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 write protected. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_hsmci.h b/arch/arm/src/samv7/sam_hsmci.h index fa5992082dacfc7bc58f3334ec5d05371440a315..990ce462d5f6cf968d092fbc2f9b2d25103d13eb 100644 --- a/arch/arm/src/samv7/sam_hsmci.h +++ b/arch/arm/src/samv7/sam_hsmci.h @@ -85,7 +85,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -116,7 +116,7 @@ FAR struct sdio_dev_s *sdio_initialize(int slotno); * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: @@ -141,7 +141,7 @@ uint32_t sam_hsmci_clkdiv(uint32_t target); * card has been removed from the slot. Only transitions * (inserted->removed or removed->inserted should be reported) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -159,7 +159,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_hsmci_clkdiv.c b/arch/arm/src/samv7/sam_hsmci_clkdiv.c index 83b85b6cb691eb54288cac59909168177000356b..0da38726216a29be83e057670f927bdff92d004f 100644 --- a/arch/arm/src/samv7/sam_hsmci_clkdiv.c +++ b/arch/arm/src/samv7/sam_hsmci_clkdiv.c @@ -96,7 +96,7 @@ * bootloader that brought us into SDRAM and it is that bootloader that * has configured the clocking. * - * Input parameters: + * Input Parameters: * target - The target SD frequency * * Returned Value: diff --git a/arch/arm/src/samv7/sam_mcan.c b/arch/arm/src/samv7/sam_mcan.c index e72d089dc73b5bad66367532dda5a48769575ffd..5be48501d1b8d015ad744d0b1c2e8327725cff9c 100644 --- a/arch/arm/src/samv7/sam_mcan.c +++ b/arch/arm/src/samv7/sam_mcan.c @@ -1609,7 +1609,7 @@ static void mcan_buffer_release(FAR struct sam_mcan_s *priv) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * dlc - the DLC value to convert to a byte count * * Returned Value: @@ -1665,7 +1665,7 @@ static uint8_t mcan_dlc2bytes(FAR struct sam_mcan_s *priv, uint8_t dlc) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * nbytes - the byte count to convert to a DLC value * * Returned Value: @@ -3649,7 +3649,7 @@ static int mcan_interrupt(int irq, void *context, FAR void *arg) * Description: * MCAN hardware initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this MCAN peripheral * * Returned Value: @@ -3924,7 +3924,7 @@ static int mcan_hw_initialize(struct sam_mcan_s *priv) * Description: * Initialize the selected MCAN port * - * Input Parameter: + * Input Parameters: * port - Port number (for hardware that has multiple MCAN interfaces), * 0=MCAN0, 1=MCAN1 * diff --git a/arch/arm/src/samv7/sam_mcan.h b/arch/arm/src/samv7/sam_mcan.h index 3672547788ac9fdfc7b7a757f38eb46f253d30eb..0c5dc6c7260093c1c99c5f26580407061f727907 100644 --- a/arch/arm/src/samv7/sam_mcan.h +++ b/arch/arm/src/samv7/sam_mcan.h @@ -88,7 +88,7 @@ extern "C" * Description: * Initialize the selected MCAN port * - * Input Parameter: + * Input Parameters: * port - Port number (for hardware that has multiple CAN interfaces), * 0=MCAN0, 1=NCAN1 * diff --git a/arch/arm/src/samv7/sam_qspi.c b/arch/arm/src/samv7/sam_qspi.c index 7e47c6caf9b8f29639c08d206c0f4302107cde33..6e39c7f8e3ead114f98712705383e9a67aec2832 100644 --- a/arch/arm/src/samv7/sam_qspi.c +++ b/arch/arm/src/samv7/sam_qspi.c @@ -1714,7 +1714,7 @@ static int qspi_hw_initialize(struct sam_qspidev_s *priv) * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_qspi.h b/arch/arm/src/samv7/sam_qspi.h index 85d2e57d6594a7a4984d1b14b3337b2e11e659b3..9b64f0531cb454e41e1363188b49b03c365e58e0 100644 --- a/arch/arm/src/samv7/sam_qspi.h +++ b/arch/arm/src/samv7/sam_qspi.h @@ -87,7 +87,7 @@ extern "C" * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_rswdt.c b/arch/arm/src/samv7/sam_rswdt.c index 6d5add03a23ac158e16eb569deb6ed4c4e1b885b..5651e612ee4eabc69c4ba399fec537478ab991ba 100644 --- a/arch/arm/src/samv7/sam_rswdt.c +++ b/arch/arm/src/samv7/sam_rswdt.c @@ -254,7 +254,7 @@ static void sam_putreg(uint32_t regval, uintptr_t regaddr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -290,7 +290,7 @@ static int sam_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. * ****************************************************************************/ @@ -320,7 +320,7 @@ static int sam_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. * ****************************************************************************/ @@ -350,7 +350,7 @@ static int sam_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. * ****************************************************************************/ @@ -378,7 +378,7 @@ static int sam_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. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int sam_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. * ****************************************************************************/ @@ -554,7 +554,7 @@ static int sam_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). @@ -619,7 +619,7 @@ static xcpt_t sam_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. * ****************************************************************************/ @@ -649,7 +649,7 @@ static int sam_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * Input Parameters: * None * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_spi.c b/arch/arm/src/samv7/sam_spi.c index 0ae37af28b98bde1d14b641da263b22969a505a5..0f4a52c90434484d9d1492fe8fb376c56d0f4e63 100644 --- a/arch/arm/src/samv7/sam_spi.c +++ b/arch/arm/src/samv7/sam_spi.c @@ -1985,7 +1985,7 @@ static void spi_recvblock(struct spi_dev_s *dev, void *buffer, size_t nwords) * Description: * Initialize the selected SPI port in master mode * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_spi.h b/arch/arm/src/samv7/sam_spi.h index 6e5a76e9ef6276dee67e52080a161f03a72a5e13..e7e715fd38a04b6d902a95de141a4766d845f854 100644 --- a/arch/arm/src/samv7/sam_spi.h +++ b/arch/arm/src/samv7/sam_spi.h @@ -166,7 +166,7 @@ struct spi_sctrlr_s; /* Forward reference */ * Description: * Initialize the selected SPI port in master mode * - * Input Parameter: + * Input Parameters: * cs - Chip select number (identifying the "logical" SPI port) * * Returned Value: @@ -182,7 +182,7 @@ FAR struct spi_dev_s *sam_spibus_initialize(int port); * Description: * Initialize the selected SPI port in slave mode. * - * Input Parameter: + * Input Parameters: * port - Chip select number identifying the "logical" SPI port. Includes * encoded port and chip select information. * @@ -248,7 +248,7 @@ FAR struct spi_sctrlr_s *sam_spi_slave_initialize(int port); * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -270,7 +270,7 @@ void sam_spi1select(uint32_t devid, bool selected); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -301,7 +301,7 @@ uint8_t sam_spi1status(FAR struct spi_dev_s *dev, uint32_t devid); * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_spi_slave.c b/arch/arm/src/samv7/sam_spi_slave.c index 19473aa05c553be46c34fbf85506ef5e4dfa0bea..77a2cf67326b67533e458f1230d023a28ea7940c 100644 --- a/arch/arm/src/samv7/sam_spi_slave.c +++ b/arch/arm/src/samv7/sam_spi_slave.c @@ -1059,7 +1059,7 @@ static void spi_qflush(struct spi_sctrlr_s *sctrlr) * Description: * Initialize the selected SPI port in slave mode. * - * Input Parameter: + * Input Parameters: * port - Chip select number identifying the "logical" SPI port. Includes * encoded port and chip select information. * diff --git a/arch/arm/src/samv7/sam_ssc.c b/arch/arm/src/samv7/sam_ssc.c index bb1114c44493d94a9811017ff85659cb4930715b..8d56ff8f383b69d7df6d1f849d795bf9221679c0 100644 --- a/arch/arm/src/samv7/sam_ssc.c +++ b/arch/arm/src/samv7/sam_ssc.c @@ -2765,7 +2765,7 @@ static int ssc_tx_configure(struct sam_ssc_s *priv) * Setup the MCK/2 divider based on the currently selected data width and * the sample rate * - * Input Parameter: + * Input Parameters: * priv - I2C device structure (only the sample rate and data length is * needed at this point). * @@ -2822,7 +2822,7 @@ static uint32_t ssc_mck2divider(struct sam_ssc_s *priv) * Description: * Enable and configure clocking to the SSC * - * Input Parameter: + * Input Parameters: * priv - Partially initialized I2C device structure (only the PID is * needed at this point). * @@ -3370,7 +3370,7 @@ static void ssc1_configure(struct sam_ssc_s *priv) * Description: * Initialize the selected SSC port * - * Input Parameter: + * Input Parameters: * port - I2S "port" number (identifying the "logical" SSC port) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_ssc.h b/arch/arm/src/samv7/sam_ssc.h index 567b655c3629a7bf11d8675f67abc83157d5f7af..0db57fe3615de9a14d1b7c0a902eb931f5a03d3f 100644 --- a/arch/arm/src/samv7/sam_ssc.h +++ b/arch/arm/src/samv7/sam_ssc.h @@ -82,7 +82,7 @@ extern "C" * Description: * Initialize the selected I2S port. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/samv7/sam_twihs.h b/arch/arm/src/samv7/sam_twihs.h index 79f85a70e3894e6ddfc9afe708b496d90905b493..abcaba9b7d27b22b1d36dded9ba2b4cec399d299 100644 --- a/arch/arm/src/samv7/sam_twihs.h +++ b/arch/arm/src/samv7/sam_twihs.h @@ -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 *sam_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 sam_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/samv7/sam_wdt.c b/arch/arm/src/samv7/sam_wdt.c index 4ce21303c33122abc65501edd8292d4ef1a9a528..b6990b9370a07037780cf18323aafbc5a3c13e74 100644 --- a/arch/arm/src/samv7/sam_wdt.c +++ b/arch/arm/src/samv7/sam_wdt.c @@ -254,7 +254,7 @@ static void sam_putreg(uint32_t regval, uintptr_t regaddr) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -290,7 +290,7 @@ static int sam_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. * ****************************************************************************/ @@ -320,7 +320,7 @@ static int sam_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. * ****************************************************************************/ @@ -350,7 +350,7 @@ static int sam_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. * ****************************************************************************/ @@ -378,7 +378,7 @@ static int sam_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. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int sam_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. * ****************************************************************************/ @@ -567,7 +567,7 @@ static int sam_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). @@ -632,7 +632,7 @@ static xcpt_t sam_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. * ****************************************************************************/ @@ -662,7 +662,7 @@ static int sam_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * Input Parameters: * None * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/samv7/sam_wdt.h b/arch/arm/src/samv7/sam_wdt.h index f5ee97a2479e8e84457628b88864daf89818e148..3fe31686caf299ad106c0977b589a7411432b184 100644 --- a/arch/arm/src/samv7/sam_wdt.h +++ b/arch/arm/src/samv7/sam_wdt.h @@ -76,7 +76,7 @@ extern "C" * * At a minimum, this function should call watchdog_register(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -96,7 +96,7 @@ int sam_wdt_initialize(void); * * At a minimum, this function should call watchdog_register(). * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_1wire.c b/arch/arm/src/stm32/stm32_1wire.c index a4157006a62f18976383b8cccd354769c78e1dae..93ab8000eed79ebede7e6b1f0e529a2379844bb8 100644 --- a/arch/arm/src/stm32/stm32_1wire.c +++ b/arch/arm/src/stm32/stm32_1wire.c @@ -500,7 +500,7 @@ static void stm32_1wire_set_baud(struct stm32_1wire_priv_s *priv) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * priv - A reference to the 1-Wire driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -1149,7 +1149,7 @@ static int stm32_1wire_exchange(FAR struct onewire_dev_s *dev, bool reset, * 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 1-Wire interfaces) * * Returned Value: @@ -1245,7 +1245,7 @@ FAR struct onewire_dev_s *stm32_1wireinitialize(int port) * Description: * De-initialize the selected 1-Wire port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32_1wireinitialize() * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_1wire.h b/arch/arm/src/stm32/stm32_1wire.h index 24cfe45592f604a2d85d4595e6ac738c49e77399..7606c8f4610bd598b456ce2ce3dee2b2948ae5eb 100644 --- a/arch/arm/src/stm32/stm32_1wire.h +++ b/arch/arm/src/stm32/stm32_1wire.h @@ -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 1-Wire interfaces) * * Returned Value: @@ -73,7 +73,7 @@ FAR struct onewire_dev_s *stm32_1wireinitialize(int port); * Description: * De-initialize the selected 1-Wire port, and power down the device. * - * Input Parameter: + * Input Parameters: * Device structure as returned by the stm32_1wireinitialize() * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_adc.c b/arch/arm/src/stm32/stm32_adc.c index 7ec37927bd5ee01c8e8f63fa4e91715f7d14771c..89e826f6f0f5e6bd78334aa8ec60fe298e3d998a 100644 --- a/arch/arm/src/stm32/stm32_adc.c +++ b/arch/arm/src/stm32/stm32_adc.c @@ -757,7 +757,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_can.c b/arch/arm/src/stm32/stm32_can.c index a2fc3fac1dfaf2bfae0d013248a910c7fe7a6d0c..2625c9123c51caf8750ef873ddb35dd2174d009b 100644 --- a/arch/arm/src/stm32/stm32_can.c +++ b/arch/arm/src/stm32/stm32_can.c @@ -1644,7 +1644,7 @@ static int stm32can_txinterrupt(int irq, FAR void *context, FAR void *arg) * Where: * Tpclk1 is the period of the APB1 clock (PCLK1). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1743,7 +1743,7 @@ static int stm32can_bittiming(FAR struct stm32_can_s *priv) * peripheral, no registers are changed. The initialization mode is * required to change the baud rate. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1794,7 +1794,7 @@ static int stm32can_enterinitmode(FAR struct stm32_can_s *priv) * Description: * Put the CAN cell out of the Initialization mode (to Normal mode) * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1844,7 +1844,7 @@ static int stm32can_exitinitmode(FAR struct stm32_can_s *priv) * Description: * CAN cell initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1927,7 +1927,7 @@ static int stm32can_cellinit(FAR struct stm32_can_s *priv) * are set to zero thus supressing all filtering because anything masked * with zero matches zero. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -2014,7 +2014,7 @@ static int stm32can_filterinit(FAR struct stm32_can_s *priv) * Description: * Add a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2039,7 +2039,7 @@ static int stm32can_addextfilter(FAR struct stm32_can_s *priv, * Description: * Remove a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_EXTFILTER command @@ -2064,7 +2064,7 @@ static int stm32can_delextfilter(FAR struct stm32_can_s *priv, int arg) * Description: * Add a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2087,7 +2087,7 @@ static int stm32can_addstdfilter(FAR struct stm32_can_s *priv, * Description: * Remove a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_STDFILTER command @@ -2107,7 +2107,7 @@ static int stm32can_delstdfilter(FAR struct stm32_can_s *priv, int arg) /**************************************************************************** * Name: stm32can_txmb0empty * - * Input Parameter: + * Input Parameters: * tsr_regval - value of CAN transmit status register * * Returned Value: @@ -2124,7 +2124,7 @@ static bool stm32can_txmb0empty(uint32_t tsr_regval) /**************************************************************************** * Name: stm32can_txmb1empty * - * Input Parameter: + * Input Parameters: * tsr_regval - value of CAN transmit status register * * Returned Value: @@ -2141,7 +2141,7 @@ static bool stm32can_txmb1empty(uint32_t tsr_regval) /**************************************************************************** * Name: stm32can_txmb2empty * - * Input Parameter: + * Input Parameters: * tsr_regval - value of CAN transmit status register * * Returned Value: @@ -2165,7 +2165,7 @@ static bool stm32can_txmb2empty(uint32_t tsr_regval) * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_can.h b/arch/arm/src/stm32/stm32_can.h index f06231ab60a49fc50e24d8dbf233b0732838cfe0..078e6b2a124d9b70345086ac307f1b27640275ee 100644 --- a/arch/arm/src/stm32/stm32_can.h +++ b/arch/arm/src/stm32/stm32_can.h @@ -125,7 +125,7 @@ extern "C" * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_dma.h b/arch/arm/src/stm32/stm32_dma.h index 965fd6f30fe865c4532d268515ba8d127c8b1342..e9878d1157224d77741d1b9689c9686ab8a79a44 100644 --- a/arch/arm/src/stm32/stm32_dma.h +++ b/arch/arm/src/stm32/stm32_dma.h @@ -175,7 +175,7 @@ extern "C" * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * For the STM32 F1, this is simply the channel number as provided by * the DMACHAN_* definitions in chip/stm32f10xxx_dma.h. @@ -281,7 +281,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle); * only applies to memory addresses, it will return false for any peripheral * address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_dma2d.c b/arch/arm/src/stm32/stm32_dma2d.c index a70ed7508580006f1e1da0552113a2ecd198c790..c9e2a0e54c4275d1c73fcb12829ce3bbaaa5ec15 100644 --- a/arch/arm/src/stm32/stm32_dma2d.c +++ b/arch/arm/src/stm32/stm32_dma2d.c @@ -486,7 +486,7 @@ static int stm32_dma2dirq(int irq, void *context, FAR void *arg) * loading or dma transfer was completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * On success OK otherwise ERROR * ****************************************************************************/ @@ -532,7 +532,7 @@ static int stm32_dma2d_waitforirq(void) * Parameter: * pfcreg - PFC control Register * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -620,7 +620,7 @@ static int stm32_dma2d_start(void) * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * memory address * ****************************************************************************/ @@ -646,7 +646,7 @@ static uint32_t stm32_dma2d_memaddress(FAR const struct stm32_dma2d_s *layer, * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * line offset * ****************************************************************************/ @@ -670,7 +670,7 @@ static fb_coord_t stm32_dma2d_lineoffset(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the common layer state structure * fmt - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -729,7 +729,7 @@ static int stm32_dma2d_pixelformat(uint8_t fmt, uint8_t *fmtmap) * layer - Reference to the common layer state structure * bpp - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -770,7 +770,7 @@ static int stm32_dma2d_bpp(uint8_t fmt, uint8_t *bpp) * Description: * Get a free layer id * - * Return: + * Returned Value: * The number of the free layer * -1 if no free layer is available * @@ -797,7 +797,7 @@ static int stm32_dma2d_lfreelid(void) * Description: * Allocate a new layer structure * - * Return: + * Returned Value: * A new allocated layer structure or NULL on error. * ****************************************************************************/ @@ -886,7 +886,7 @@ static void stm32_dma2d_llayerscleanup(void) * Description: * Helper to validate if the layer is valid * - * Return: + * Returned Value: * true if validates otherwise false * ****************************************************************************/ @@ -908,7 +908,7 @@ static inline bool stm32_dma2d_lvalidate(FAR const struct stm32_dma2d_s *layer) * ypos - The y position inside the whole layer * area - the area inside the whole layer * - * Return: + * Returned Value: * true if area is inside the whole layer otherwise false * ****************************************************************************/ @@ -1162,7 +1162,7 @@ static void stm32_dma2d_lpfc(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1199,7 +1199,7 @@ static int stm32_dma2dgetvideoinfo(FAR struct dma2d_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1235,7 +1235,7 @@ static int stm32_dma2dgetplaneinfo(FAR struct dma2d_layer_s *layer, int planeno, * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1271,7 +1271,7 @@ static int stm32_dma2dgetlid(FAR struct dma2d_layer_s *layer, int *lid) * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1390,7 +1390,7 @@ static int stm32_dma2dsetclut(FAR struct dma2d_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1482,7 +1482,7 @@ static int stm32_dma2dgetclut(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1517,7 +1517,7 @@ static int stm32_dma2dsetalpha(FAR struct dma2d_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1554,7 +1554,7 @@ static int stm32_dma2dgetalpha(FAR struct dma2d_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1603,7 +1603,7 @@ static int stm32_dma2dsetblendmode(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1643,7 +1643,7 @@ static int stm32_dma2dgetblendmode(FAR struct dma2d_layer_s *layer, * src - Valid reference to the source layer * srcarea - Valid reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1752,7 +1752,7 @@ static int stm32_dma2dblit(FAR struct dma2d_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1859,7 +1859,7 @@ static int stm32_dma2dblend(FAR struct dma2d_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -1935,7 +1935,7 @@ static int stm32_dma2dfillarea(FAR struct dma2d_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -1968,7 +1968,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid) * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * @@ -2090,7 +2090,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2132,7 +2132,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer) * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * @@ -2248,7 +2248,7 @@ void up_dma2duninitialize(void) * layer - a valid reference to the low level ltdc layer structure * clut - a pointer to a valid memory region to hold 256 clut colors * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * diff --git a/arch/arm/src/stm32/stm32_dma2d.h b/arch/arm/src/stm32/stm32_dma2d.h index a62d16f7af1416b9d294cf5c03f1b11b90f9d5fb..258ae695317d4cb17ae381154f015d2791cd35d4 100644 --- a/arch/arm/src/stm32/stm32_dma2d.h +++ b/arch/arm/src/stm32/stm32_dma2d.h @@ -74,7 +74,7 @@ struct dma2d_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -92,7 +92,7 @@ struct dma2d_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -109,7 +109,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -127,7 +127,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -145,7 +145,7 @@ struct dma2d_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -167,7 +167,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -183,7 +183,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -201,7 +201,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -230,7 +230,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -250,7 +250,7 @@ struct dma2d_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -281,7 +281,7 @@ struct dma2d_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -308,7 +308,7 @@ struct dma2d_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected area outside the visible area of the layer. @@ -340,7 +340,7 @@ struct stm32_ltdc_s; /* Forward declaration */ * Parameter: * layer - a valid reference to the low level ltdc layer structure * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -358,7 +358,7 @@ FAR struct dma2d_layer_s *stm32_dma2dinitltdc(FAR struct stm32_ltdc_s *layer); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -377,7 +377,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid); * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -399,7 +399,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -413,7 +413,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer); * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * diff --git a/arch/arm/src/stm32/stm32_exti.h b/arch/arm/src/stm32/stm32_exti.h index 8e46e239da27adb3cbc056442dd10553b612eda2..376d65f774aa2dae66c54c5255f7b346fcbbda18 100644 --- a/arch/arm/src/stm32/stm32_exti.h +++ b/arch/arm/src/stm32/stm32_exti.h @@ -123,7 +123,7 @@ int stm32_exti_alarm(bool risingedge, bool fallingedge, bool event, xcpt_t func, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32/stm32_exti_alarm.c b/arch/arm/src/stm32/stm32_exti_alarm.c index 414817a6b84f1ec35767c4e8d0aee3b1d4fd532c..77de848e9f7502f2767caac0e89e6447d254143c 100644 --- a/arch/arm/src/stm32/stm32_exti_alarm.c +++ b/arch/arm/src/stm32/stm32_exti_alarm.c @@ -108,7 +108,7 @@ static int stm32_exti_alarm_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32/stm32_exti_pwr.c b/arch/arm/src/stm32/stm32_exti_pwr.c index 5ab6138ac4bb345729b20edcb879a27804266816..36d2167283bed458a8d024ede3c8ab8f3592ebfc 100644 --- a/arch/arm/src/stm32/stm32_exti_pwr.c +++ b/arch/arm/src/stm32/stm32_exti_pwr.c @@ -114,7 +114,7 @@ static int stm32_exti_pvd_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32/stm32_exti_pwr.h b/arch/arm/src/stm32/stm32_exti_pwr.h index c4841dffebe9d14c3445458e03774644a3baef27..e48ca3f2eed0adaebe3f4bfea111ed23f798c196 100644 --- a/arch/arm/src/stm32/stm32_exti_pwr.h +++ b/arch/arm/src/stm32/stm32_exti_pwr.h @@ -59,7 +59,7 @@ * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32/stm32_exti_wakeup.c b/arch/arm/src/stm32/stm32_exti_wakeup.c index 9dd9ad7d99a4f2cdfe13c49bb263f7cdce0841bb..d265361f87195073bddd52e852c7a352a3d04b14 100644 --- a/arch/arm/src/stm32/stm32_exti_wakeup.c +++ b/arch/arm/src/stm32/stm32_exti_wakeup.c @@ -107,7 +107,7 @@ static int stm32_exti_wakeup_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32/stm32_flash.h b/arch/arm/src/stm32/stm32_flash.h index 6da1b0b70343096d86ca20bcf1e400ccfdf32638..4d5003b056764106dab8763096a27b6fa5831f14 100644 --- a/arch/arm/src/stm32/stm32_flash.h +++ b/arch/arm/src/stm32/stm32_flash.h @@ -56,7 +56,7 @@ * Description: * Get EEPROM data memory size * - * Returns: + * Returned Value: * Length of EEPROM memory region * ************************************************************************************/ @@ -69,7 +69,7 @@ size_t stm32_eeprom_size(void); * Description: * Get EEPROM data memory address * - * Returns: + * Returned Value: * Address of EEPROM memory region * ************************************************************************************/ @@ -82,7 +82,7 @@ size_t stm32_eeprom_getaddress(void); * Description: * Write buffer to EEPROM data memory address * - * Returns: + * Returned Value: * Number of written bytes or error code. * ************************************************************************************/ @@ -95,7 +95,7 @@ ssize_t stm32_eeprom_write(size_t addr, const void *buf, size_t buflen); * Description: * Erase memory on EEPROM data memory address * - * Returns: + * Returned Value: * Number of erased bytes or error code. * ************************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_gpio.c b/arch/arm/src/stm32/stm32_gpio.c index 727f0c943a56ac9f6f794db9c62b0a85bc4e4e87..7a1d7800c4d109698a34af7b60f7d8a0cbe9d034 100644 --- a/arch/arm/src/stm32/stm32_gpio.c +++ b/arch/arm/src/stm32/stm32_gpio.c @@ -261,7 +261,7 @@ void stm32_gpioinit(void) * function, it must be unconfigured with stm32_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono valu on invalid port, or when pin is locked as ALT * function. @@ -667,7 +667,7 @@ int stm32_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32/stm32_hrtim.c b/arch/arm/src/stm32/stm32_hrtim.c index 09da49edf9c2bb6c83988f16bae8579e9c013038..a8069194bba0faadfe22a95edcee6548d4d47911 100644 --- a/arch/arm/src/stm32/stm32_hrtim.c +++ b/arch/arm/src/stm32/stm32_hrtim.c @@ -2560,7 +2560,7 @@ static int hrtim_gpios_config(FAR struct stm32_hrtim_s *priv) * Description: * Configure HRTIM Captures * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * capture - capture trigers configuration @@ -2618,7 +2618,7 @@ errout: * Description: * Configure HRTIM Captures * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * * Returned Value: @@ -2669,7 +2669,7 @@ static int hrtim_capture_config(FAR struct stm32_hrtim_s *priv) * Description: * Get HRTIM Timer Capture register * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * index - Capture register index @@ -4516,7 +4516,7 @@ void hrtim_irq_ack(FAR struct hrtim_dev_s *dev, uint8_t timer, int source); * Description: * Set HRTIM Timer mode * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * mode - Timer mode configuration @@ -4685,7 +4685,7 @@ errout: * Description: * Try update HRTIM Timer compare register. * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * index - Compare register timer @@ -4759,7 +4759,7 @@ errout: * Description: * Try update HRTIM Timer period register. * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * per - New period register value @@ -4784,7 +4784,7 @@ static int hrtim_per_update(FAR struct hrtim_dev_s *dev, uint8_t timer, * Description: * Get HRTIM Timer period value * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * @@ -4806,7 +4806,7 @@ static uint16_t hrtim_per_get(FAR struct hrtim_dev_s *dev, uint8_t timer) * Description: * Get HRTIM Timer compare register * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * index - Compare register timer @@ -4868,7 +4868,7 @@ errout: * Description: * Get HRTIM Timer clock value * - * Input parameters: + * Input Parameters: * dev - HRTIM device structure * timer - HRTIM Timer index * @@ -4904,7 +4904,7 @@ errout: * Description: * Set HRTIM Timer Reset events * - * Input parameters: + * Input Parameters: * priv - A reference to the HRTIM block * timer - HRTIM Timer index * reset - Reset configuration diff --git a/arch/arm/src/stm32/stm32_i2c.h b/arch/arm/src/stm32/stm32_i2c.h index f36ee952f55178cff12bc2a13fb95a6fb85a5182..c61f17332bda21440dcc8332569b40711d874124 100644 --- a/arch/arm/src/stm32/stm32_i2c.h +++ b/arch/arm/src/stm32/stm32_i2c.h @@ -79,7 +79,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: @@ -95,7 +95,7 @@ FAR struct i2c_master_s *stm32_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 stm32_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_i2s.c b/arch/arm/src/stm32/stm32_i2s.c index 46ac8f6eec3c7b0821baa4701a484193953be931..f68eb8683da8249c0a19f6dce4153fdd913f0fb0 100644 --- a/arch/arm/src/stm32/stm32_i2s.c +++ b/arch/arm/src/stm32/stm32_i2s.c @@ -2160,7 +2160,7 @@ errout_with_exclsem: * Setup the MCK divider based on the currently selected data width and * the sample rate * - * Input Parameter: + * Input Parameters: * priv - I2C device structure (only the sample rate and data length is * needed at this point). * @@ -2562,7 +2562,7 @@ static void i2s3_configure(struct stm32_i2s_s *priv) * Description: * Initialize the selected i2S port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_i2s.h b/arch/arm/src/stm32/stm32_i2s.h index 5e6d51b817f27a51b50c628663b149d6d56cb420..fc7a702b7e5f0424adc99149c6cb98a7ea4ba453 100644 --- a/arch/arm/src/stm32/stm32_i2s.h +++ b/arch/arm/src/stm32/stm32_i2s.h @@ -71,7 +71,7 @@ extern "C" * Description: * Initialize the selected I2S port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple I2S interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_iwdg.c b/arch/arm/src/stm32/stm32_iwdg.c index d26ec9f71a375f6c211c1e6c0a87f1c50b15b1e1..2ceaf9bd4bbf2327b59e95022a64016e510fbb32 100644 --- a/arch/arm/src/stm32/stm32_iwdg.c +++ b/arch/arm/src/stm32/stm32_iwdg.c @@ -315,7 +315,7 @@ static inline void stm32_setprescaler(FAR struct stm32_lowerhalf_s *priv) * 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. * ****************************************************************************/ @@ -371,7 +371,7 @@ static int stm32_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. * ****************************************************************************/ @@ -396,7 +396,7 @@ static int stm32_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. * ****************************************************************************/ @@ -429,7 +429,7 @@ static int stm32_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -488,7 +488,7 @@ static int stm32_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -639,7 +639,7 @@ static int stm32_settimeout(FAR struct watchdog_lowerhalf_s *lower, * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_ltdc.c b/arch/arm/src/stm32/stm32_ltdc.c index 5b794d17dd4ac2b2773c8886d5414705f0e7f454..25644116de80fbb4922465657964828e14f25d7c 100644 --- a/arch/arm/src/stm32/stm32_ltdc.c +++ b/arch/arm/src/stm32/stm32_ltdc.c @@ -1162,7 +1162,7 @@ static int stm32_ltdcirq(int irq, void *context, FAR void *arg) * that a register reload was been completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * OK - On success otherwise ERROR * ****************************************************************************/ @@ -1457,7 +1457,7 @@ static inline uint8_t stm32_ltdc_lgetopac(FAR struct stm32_layer_s *layer) * Parameter: * layer - Reference to the layer control structure * - * Return: + * Returned Value: * true - layer valid * false - layer invalid * @@ -1487,7 +1487,7 @@ static inline bool stm32_ltdc_lvalidate(FAR const struct stm32_layer_s *layer) * srcxpos - Top left x position from where data visible in the active area * srcypos - Top left y position from where data visible in the active area * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1958,7 +1958,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer) * layer - Reference to the layer control structure * color - The color to clear * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * @@ -2172,7 +2172,7 @@ static void stm32_ltdc_linit(int lid) * vtable - The framebuffer driver object * vinfo - the videoinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2207,7 +2207,7 @@ static int stm32_getvideoinfo(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * pinfo - the planeinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2242,7 +2242,7 @@ static int stm32_getplaneinfo(struct fb_vtable_s *vtable, int planeno, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2269,7 +2269,7 @@ static int stm32_getcmap(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2296,7 +2296,7 @@ static int stm32_putcmap(struct fb_vtable_s *vtable, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2330,7 +2330,7 @@ static int stm32_lgetvideoinfo(struct ltdc_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2364,7 +2364,7 @@ static int stm32_lgetplaneinfo(struct ltdc_layer_s *layer, int planeno, * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2424,7 +2424,7 @@ static int stm32_setclut(struct ltdc_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2523,7 +2523,7 @@ static int stm32_getclut(struct ltdc_layer_s *layer, * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * OK - On success * Null if invalid flag * @@ -2600,7 +2600,7 @@ static int stm32_getlid(FAR struct ltdc_layer_s *layer, int *lid, * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2636,7 +2636,7 @@ static int stm32_setcolor(FAR struct ltdc_layer_s *layer, uint32_t argb) * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2673,7 +2673,7 @@ static int stm32_getcolor(FAR struct ltdc_layer_s *layer, uint32_t *argb) * layer - Reference to the layer structure * rgb - RGB888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2709,7 +2709,7 @@ static int stm32_setcolorkey(FAR struct ltdc_layer_s *layer, uint32_t rgb) * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2750,7 +2750,7 @@ static int stm32_getcolorkey(FAR struct ltdc_layer_s *layer, uint32_t *rgb) * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2786,7 +2786,7 @@ static int stm32_setalpha(FAR struct ltdc_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2823,7 +2823,7 @@ static int stm32_getalpha(FAR struct ltdc_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2955,7 +2955,7 @@ static int stm32_setblendmode(FAR struct ltdc_layer_s *layer, uint32_t mode) * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL ****************************************************************************/ @@ -2994,7 +2994,7 @@ static int stm32_getblendmode(FAR struct ltdc_layer_s *layer, uint32_t *mode) * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3056,7 +3056,7 @@ static int stm32_setarea(FAR struct ltdc_layer_s *layer, * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3096,7 +3096,7 @@ static int stm32_getarea(FAR struct ltdc_layer_s *layer, * layer - Reference to the layer structure * mode - operation mode * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -3259,7 +3259,7 @@ static int stm32_update(FAR struct ltdc_layer_s *layer, uint32_t mode) * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3310,7 +3310,7 @@ static int stm32_blit(FAR struct ltdc_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3360,7 +3360,7 @@ static int stm32_blend(FAR struct ltdc_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -3402,7 +3402,7 @@ static int stm32_fillarea(FAR struct ltdc_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if lid * is invalid. * @@ -3428,7 +3428,7 @@ FAR struct ltdc_layer_s *stm32_ltdcgetlayer(int lid) * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ****************************************************************************/ @@ -3517,10 +3517,10 @@ int stm32_ltdcinitialize(void) * Return a a reference to the framebuffer object for the specified video * plane. * - * Input parameters: + * Input Parameters: * None * - * Returned value: + * Returned Value: * Reference to the framebuffer object (NULL on failure) * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_ltdc.h b/arch/arm/src/stm32/stm32_ltdc.h index 33ebc3e5580e995df514c57c0381701d9205d9c4..7c73de31fe482d396f68b2081280eb74411888af 100644 --- a/arch/arm/src/stm32/stm32_ltdc.h +++ b/arch/arm/src/stm32/stm32_ltdc.h @@ -133,7 +133,7 @@ struct ltdc_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -151,7 +151,7 @@ struct ltdc_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -171,7 +171,7 @@ struct ltdc_layer_s * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -192,7 +192,7 @@ struct ltdc_layer_s * enable - Enable or disable clut support (if false cmap is ignored and can * be NULL) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -210,7 +210,7 @@ struct ltdc_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -229,7 +229,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -245,7 +245,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -263,7 +263,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -279,7 +279,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -301,7 +301,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -317,7 +317,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -335,7 +335,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -373,7 +373,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -400,7 +400,7 @@ struct ltdc_layer_s * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -426,7 +426,7 @@ struct ltdc_layer_s * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -445,7 +445,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - operation mode (see LTDC_UPDATE_*) * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -489,7 +489,7 @@ struct ltdc_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -518,7 +518,7 @@ struct ltdc_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -543,7 +543,7 @@ struct ltdc_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -607,7 +607,7 @@ struct stm32_ltdc_s * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ************************************************************************************/ @@ -625,7 +625,7 @@ void stm32_ltdcuninitialize(void); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if parameter * invalid. * diff --git a/arch/arm/src/stm32/stm32_otgfshost.c b/arch/arm/src/stm32/stm32_otgfshost.c index 8a6382d345b0bac1274828f69fc4ef199722c731..1b29ae09e5e66cfbcda18e69c37c70745546c5ed 100644 --- a/arch/arm/src/stm32/stm32_otgfshost.c +++ b/arch/arm/src/stm32/stm32_otgfshost.c @@ -1265,7 +1265,7 @@ static int stm32_ctrlchan_alloc(FAR struct stm32_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 * @@ -1327,7 +1327,7 @@ static int stm32_ctrlep_alloc(FAR struct stm32_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 * @@ -3820,7 +3820,7 @@ static void stm32_txfe_enable(FAR struct stm32_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 @@ -3911,7 +3911,7 @@ static int stm32_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 * @@ -4041,7 +4041,7 @@ static int stm32_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 * @@ -4100,7 +4100,7 @@ static int stm32_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 * @@ -4156,7 +4156,7 @@ static int stm32_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 * @@ -4224,7 +4224,7 @@ static int stm32_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 * @@ -4270,7 +4270,7 @@ static int stm32_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 * @@ -4306,7 +4306,7 @@ static int stm32_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 * @@ -4350,7 +4350,7 @@ static int stm32_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 * @@ -4393,7 +4393,7 @@ static int stm32_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 * @@ -4596,7 +4596,7 @@ static int stm32_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: @@ -4668,7 +4668,7 @@ static ssize_t stm32_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 * @@ -4724,7 +4724,7 @@ static int stm32_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. * @@ -4813,7 +4813,7 @@ static int stm32_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. * @@ -4865,7 +4865,7 @@ static int stm32_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_otghshost.c b/arch/arm/src/stm32/stm32_otghshost.c index ad1091d02f76de61f65b18e9c77825710ea571db..c276742ab7e0dc39fe339628f57c405f3b8f8144 100644 --- a/arch/arm/src/stm32/stm32_otghshost.c +++ b/arch/arm/src/stm32/stm32_otghshost.c @@ -1270,7 +1270,7 @@ static int stm32_ctrlchan_alloc(FAR struct stm32_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 * @@ -1332,7 +1332,7 @@ static int stm32_ctrlep_alloc(FAR struct stm32_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 * @@ -3825,7 +3825,7 @@ static void stm32_txfe_enable(FAR struct stm32_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 @@ -3916,7 +3916,7 @@ static int stm32_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 * @@ -4046,7 +4046,7 @@ static int stm32_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 * @@ -4105,7 +4105,7 @@ static int stm32_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 * @@ -4161,7 +4161,7 @@ static int stm32_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 * @@ -4229,7 +4229,7 @@ static int stm32_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 * @@ -4275,7 +4275,7 @@ static int stm32_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 * @@ -4311,7 +4311,7 @@ static int stm32_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 * @@ -4355,7 +4355,7 @@ static int stm32_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 * @@ -4398,7 +4398,7 @@ static int stm32_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 * @@ -4601,7 +4601,7 @@ static int stm32_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: @@ -4673,7 +4673,7 @@ static ssize_t stm32_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 * @@ -4729,7 +4729,7 @@ static int stm32_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. * @@ -4818,7 +4818,7 @@ static int stm32_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. * @@ -4870,7 +4870,7 @@ static int stm32_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_pm.h b/arch/arm/src/stm32/stm32_pm.h index 7fc93ba688f9d324dfc550b647f217c550ffcb0d..8feee1f5666fc1ee29b618fc05475b1f01571b08 100644 --- a/arch/arm/src/stm32/stm32_pm.h +++ b/arch/arm/src/stm32/stm32_pm.h @@ -102,7 +102,7 @@ int stm32_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 diff --git a/arch/arm/src/stm32/stm32_pminitialize.c b/arch/arm/src/stm32/stm32_pminitialize.c index e9b6d4780cb43c27cead52ed1293ac5866134e4d..243bc53aa4e7bce92750c80d3aabe4ed5e2839a2 100644 --- a/arch/arm/src/stm32/stm32_pminitialize.c +++ b/arch/arm/src/stm32/stm32_pminitialize.c @@ -76,10 +76,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_pmstandby.c b/arch/arm/src/stm32/stm32_pmstandby.c index 2b4de6a6f0ec407160bd8f8761b1e2da06c4f00a..952e14317fcd76f6a42b6df9d5de1435c1792003 100644 --- a/arch/arm/src/stm32/stm32_pmstandby.c +++ b/arch/arm/src/stm32/stm32_pmstandby.c @@ -71,7 +71,7 @@ * 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 diff --git a/arch/arm/src/stm32/stm32_pwm.c b/arch/arm/src/stm32/stm32_pwm.c index 0e9db5005947119a375cdffe2e31745a5498f9e3..7aadb98ae7278d4560483fff54e297ead1bb309e 100644 --- a/arch/arm/src/stm32/stm32_pwm.c +++ b/arch/arm/src/stm32/stm32_pwm.c @@ -1095,7 +1095,7 @@ static void pwm_putreg(struct stm32_pwmtimer_s *priv, int offset, uint16_t value * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -1182,7 +1182,7 @@ static void pwm_dumpregs(struct stm32_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 * @@ -1815,7 +1815,7 @@ static int pwm_timer(FAR struct stm32_pwmtimer_s *priv, * Description: * Try to change only channel duty. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * channel - Channel to by updated * duty - New duty. @@ -1897,7 +1897,7 @@ static int pwm_update_duty(FAR struct stm32_pwmtimer_s *priv, uint8_t channel, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -1980,7 +1980,7 @@ static int pwm_interrupt(struct stm32_pwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -2008,7 +2008,7 @@ static int pwm_tim8interrupt(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: @@ -2055,7 +2055,7 @@ static uint8_t pwm_pulsecount(uint32_t count) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2188,7 +2188,7 @@ static void pwm_set_apb_clock(FAR struct stm32_pwmtimer_s *priv, bool on) * 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: @@ -2241,7 +2241,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: @@ -2303,7 +2303,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 * @@ -2390,7 +2390,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: @@ -2549,7 +2549,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 diff --git a/arch/arm/src/stm32/stm32_pwr.c b/arch/arm/src/stm32/stm32_pwr.c index 04cf7e9387cb0efe3991a5571a15db67efb1467a..5a4b863b55db64a3eb018782ed9e251bb6e8864c 100644 --- a/arch/arm/src/stm32/stm32_pwr.c +++ b/arch/arm/src/stm32/stm32_pwr.c @@ -263,7 +263,7 @@ void stm32_pwr_enablebkp(bool writable) * wupin - Selects the WKUP pin to enable/disable * wupon - state to set it to * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on any * failure. The only cause of failure is if the selected MCU does not support * the requested wakeup pin. @@ -359,7 +359,7 @@ bool stm32_pwr_getwuf(void) * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ @@ -390,7 +390,7 @@ void stm32_pwr_enablebreg(bool regon) * Input Parameters: * vos - Properly aligned voltage scaling select bits for the PWR_CR register. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -432,7 +432,7 @@ void stm32_pwr_setvos(uint16_t vos) * Input Parameters: * pls - PVD level * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_pwr.h b/arch/arm/src/stm32/stm32_pwr.h index b93b34108cd66ec652549f5a0a3700b94fcf1268..ee56a40d18e5d8aca5f8cd3d6e465fdb481d8165 100644 --- a/arch/arm/src/stm32/stm32_pwr.h +++ b/arch/arm/src/stm32/stm32_pwr.h @@ -152,7 +152,7 @@ void stm32_pwr_enablebkp(bool writable); * wupin - Selects the WKUP pin to enable/disable * wupon - state to set it to * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on any * failure. The only cause of failure is if the selected MCU does not support * the requested wakeup pin. @@ -195,7 +195,7 @@ bool stm32_pwr_getwuf(void); * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ @@ -215,7 +215,7 @@ void stm32_pwr_enablebreg(bool regon); * Input Parameters: * vos - Properly aligned voltage scaling select bits for the PWR_CR register. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -237,7 +237,7 @@ void stm32_pwr_setvos(uint16_t vos); * Input Parameters: * pls - PVD level * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32/stm32_qencoder.c b/arch/arm/src/stm32/stm32_qencoder.c index 5bc98ad32296f5b7b40ed6f1003608a6cbbfe595..661e737f8a8e736f01a779109ee6a091255fb132 100644 --- a/arch/arm/src/stm32/stm32_qencoder.c +++ b/arch/arm/src/stm32/stm32_qencoder.c @@ -574,7 +574,7 @@ static void stm32_putreg32(FAR struct stm32_lowerhalf_s *priv, int offset, uint3 * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the QENCODER block status * * Returned Value: @@ -1173,7 +1173,7 @@ static int stm32_ioctl(FAR struct qe_lowerhalf_s *lower, int cmd, unsigned long * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_qencoder.h b/arch/arm/src/stm32/stm32_qencoder.h index bea28531b6722f1a9ae9dc81ad54f98027a2994e..98c5b25f11c7bcdaf0e1a6958c746be3a8dbbae2 100644 --- a/arch/arm/src/stm32/stm32_qencoder.h +++ b/arch/arm/src/stm32/stm32_qencoder.h @@ -130,7 +130,7 @@ * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_sdadc.c b/arch/arm/src/stm32/stm32_sdadc.c index e8236a05f93cb247eec7aee1b48dfb2929bc7823..eaaf486e9d12f0c05795fcbe1d7ad89f0043d684 100644 --- a/arch/arm/src/stm32/stm32_sdadc.c +++ b/arch/arm/src/stm32/stm32_sdadc.c @@ -456,7 +456,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the SDADC block state * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_sdio.c b/arch/arm/src/stm32/stm32_sdio.c index 1413334419b315a43b30304d24fb940f0d4bf33f..1d9f99e72b2996366c3463ad440fdbb41552c4f7 100644 --- a/arch/arm/src/stm32/stm32_sdio.c +++ b/arch/arm/src/stm32/stm32_sdio.c @@ -2954,7 +2954,7 @@ static void stm32_default(void) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3028,7 +3028,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -3075,7 +3075,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_sdio.h b/arch/arm/src/stm32/stm32_sdio.h index 04c65ba00f975b35761ef391016503ecb9e5c22d..4fc477a0e44d2cf5e81839d24377cb525f6ccf9a 100644 --- a/arch/arm/src/stm32/stm32_sdio.h +++ b/arch/arm/src/stm32/stm32_sdio.h @@ -71,7 +71,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -93,7 +93,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -111,7 +111,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_serial.c b/arch/arm/src/stm32/stm32_serial.c index 74b70ffd0617aaa5c2b73b50f575bd0844c52a8f..a14404835b9899127329d50204790779592d3229 100644 --- a/arch/arm/src/stm32/stm32_serial.c +++ b/arch/arm/src/stm32/stm32_serial.c @@ -1381,7 +1381,7 @@ static void up_set_format(struct uart_dev_s *dev) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the UART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2274,7 +2274,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 diff --git a/arch/arm/src/stm32/stm32_spi.c b/arch/arm/src/stm32/stm32_spi.c index 1be51d49c2fb783e4b1a395ade740c70d4f09cc5..585a3e9231cd626533916ee60f946c4687d3ec5a 100644 --- a/arch/arm/src/stm32/stm32_spi.c +++ b/arch/arm/src/stm32/stm32_spi.c @@ -1670,7 +1670,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI bus in its default state (Master, 8-bit, mode 0, etc.) * - * Input Parameter: + * Input Parameters: * priv - private SPI device structure * * Returned Value: @@ -1775,7 +1775,7 @@ static void spi_bus_initialize(FAR struct stm32_spidev_s *priv) * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32/stm32_spi.h b/arch/arm/src/stm32/stm32_spi.h index ee99808c6abbee3f0eb8baa843f150ca327ede21..bcc2f0e14bb68c8aa17407b7f781a37c138359cc 100644 --- a/arch/arm/src/stm32/stm32_spi.h +++ b/arch/arm/src/stm32/stm32_spi.h @@ -78,7 +78,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: diff --git a/arch/arm/src/stm32/stm32_tim.h b/arch/arm/src/stm32/stm32_tim.h index bc6ef090c62a94740aefbdb0dabfe131250fe744..2e0828fafa27326e18d4991d07cb18e6cd0dcfd5 100644 --- a/arch/arm/src/stm32/stm32_tim.h +++ b/arch/arm/src/stm32/stm32_tim.h @@ -208,7 +208,7 @@ int stm32_tim_deinit(FAR struct stm32_tim_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32/stm32_tim_lowerhalf.c b/arch/arm/src/stm32/stm32_tim_lowerhalf.c index d8415ac040569c34c9c50eb6d20ae0af1cc7e009..d0a9619517e2e6d2fb9c7ec7d48cfe6375ed1fa1 100644 --- a/arch/arm/src/stm32/stm32_tim_lowerhalf.c +++ b/arch/arm/src/stm32/stm32_tim_lowerhalf.c @@ -261,7 +261,7 @@ static struct stm32_lowerhalf_s g_tim14_lowerhalf = * * Input Parameters: * - * Returned Values: + * Returned Value: * ****************************************************************************/ @@ -297,7 +297,7 @@ static int stm32_timer_handler(int irq, void * context, 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. * ****************************************************************************/ @@ -335,7 +335,7 @@ static int stm32_start(FAR struct timer_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. * ****************************************************************************/ @@ -369,7 +369,7 @@ static int stm32_stop(struct timer_lowerhalf_s *lower) * driver state structure. * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -414,7 +414,7 @@ static int stm32_settimeout(FAR struct timer_lowerhalf_s *lower, uint32_t timeou * behavior is restored, * arg - Argument that will be provided in the callback * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -462,7 +462,7 @@ static void stm32_setcallback(FAR struct timer_lowerhalf_s *lower, * form /dev/timer0 * timer - the timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32/stm32_wdg.h b/arch/arm/src/stm32/stm32_wdg.h index 64815bfe908dc66576aa95528550a7406d05a07e..264734b9f53bcdc63f5829188fc56bb78f666ea3 100644 --- a/arch/arm/src/stm32/stm32_wdg.h +++ b/arch/arm/src/stm32/stm32_wdg.h @@ -79,7 +79,7 @@ extern "C" * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -100,7 +100,7 @@ void stm32_iwdginitialize(FAR const char *devpath, uint32_t lsifreq); * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32_wwdg.c b/arch/arm/src/stm32/stm32_wwdg.c index 79d34656dae29aeb710c5aaed5fe0769ef242d03..ba2b994fa40840b8c47b354042ad56af4f977d92 100644 --- a/arch/arm/src/stm32/stm32_wwdg.c +++ b/arch/arm/src/stm32/stm32_wwdg.c @@ -281,7 +281,7 @@ static void stm32_setwindow(FAR struct stm32_lowerhalf_s *priv, uint8_t window) * Input Parameters: * Usual interrupt handler arguments. * - * Returned Values: + * Returned Value: * Always returns OK. * ****************************************************************************/ @@ -329,7 +329,7 @@ static int stm32_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. * ****************************************************************************/ @@ -361,7 +361,7 @@ static int stm32_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. * ****************************************************************************/ @@ -395,7 +395,7 @@ static int stm32_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. * ****************************************************************************/ @@ -426,7 +426,7 @@ static int stm32_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -482,7 +482,7 @@ static int stm32_getstatus(FAR struct watchdog_lowerhalf_s *lower, * "lower-half" driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -618,7 +618,7 @@ static int stm32_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). @@ -686,7 +686,7 @@ static xcpt_t stm32_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. * ****************************************************************************/ @@ -742,7 +742,7 @@ static int stm32_ioctl(FAR struct watchdog_lowerhalf_s *lower, int cmd, * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f10xxx_dma.c b/arch/arm/src/stm32/stm32f10xxx_dma.c index c3c666e937b5a4deced4a2dc36b7f92f83819de9..72da836ad1b561c0abf4d4ab38b91351d8c022b9 100644 --- a/arch/arm/src/stm32/stm32f10xxx_dma.c +++ b/arch/arm/src/stm32/stm32f10xxx_dma.c @@ -395,7 +395,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chndx - Identifies the stream/channel resource. For the STM32 F1, this * is simply the channel number as provided by the DMACHAN_* definitions * in chip/stm32f10xxx_dma.h. @@ -626,7 +626,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f20xxx_dma.c b/arch/arm/src/stm32/stm32f20xxx_dma.c index 8c06819f7a5db56e83bf8f605713d501a2225245..86b95f7f1379c2244d51fb385c73d466d583488b 100644 --- a/arch/arm/src/stm32/stm32f20xxx_dma.c +++ b/arch/arm/src/stm32/stm32f20xxx_dma.c @@ -525,7 +525,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * dmamap - Identifies the stream/channel resource. For the STM32 F2, this * is a bit-encoded value as provided by the DMAMAP_* definitions * in chip/stm32f20xxx_dma.h @@ -856,7 +856,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f33xxx_adc.c b/arch/arm/src/stm32/stm32f33xxx_adc.c index 4eb887e1484a97afea75710a57901079269086e6..412c3453d79de95b08737271602912683f981d29 100644 --- a/arch/arm/src/stm32/stm32f33xxx_adc.c +++ b/arch/arm/src/stm32/stm32f33xxx_adc.c @@ -804,7 +804,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32/stm32f33xxx_dma.c b/arch/arm/src/stm32/stm32f33xxx_dma.c index af091e2fec6c4278df7634e10673432878589627..1c0c626e601abab15c1fb1f7666f2d188c22f966 100644 --- a/arch/arm/src/stm32/stm32f33xxx_dma.c +++ b/arch/arm/src/stm32/stm32f33xxx_dma.c @@ -343,7 +343,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chndx - Identifies the stream/channel resource. For the STM32 F1, this * is simply the channel number as provided by the DMACHAN_* definitions * in chip/stm32f10xxx_dma.h. @@ -574,7 +574,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32/stm32f40xxx_dma.c b/arch/arm/src/stm32/stm32f40xxx_dma.c index 6dedd5a337de43551eb6624533eca765e8a5adb3..7f528f1a330e471eb1e0bd22f5126cd9dc3a42d8 100644 --- a/arch/arm/src/stm32/stm32f40xxx_dma.c +++ b/arch/arm/src/stm32/stm32f40xxx_dma.c @@ -524,7 +524,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * dmamap - Identifies the stream/channel resource. For the STM32 F4, this * is a bit-encoded value as provided by the DMAMAP_* definitions * in chip/stm32f40xxx_dma.h @@ -863,7 +863,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f0/stm32f0_gpio.c b/arch/arm/src/stm32f0/stm32f0_gpio.c index ffa77a43ecc7c7dcd7488760b7ce7b2f2a49d306..d6ee49b6e92aaba84cf22072dfade5db677204db 100644 --- a/arch/arm/src/stm32f0/stm32f0_gpio.c +++ b/arch/arm/src/stm32f0/stm32f0_gpio.c @@ -115,7 +115,7 @@ void stm32f0_gpioinit(void) * function, it must be unconfigured with stm32f0_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono valu on invalid port, or when pin is locked as ALT * function. @@ -336,7 +336,7 @@ int stm32f0_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32f0/stm32f0_gpio.h b/arch/arm/src/stm32f0/stm32f0_gpio.h index 4cbe0a40dff1058dc404b790d466f1af6e35f87d..14c95cce3f6d3bbf97055e2df1d2c6dd760f6b58 100644 --- a/arch/arm/src/stm32f0/stm32f0_gpio.h +++ b/arch/arm/src/stm32f0/stm32f0_gpio.h @@ -256,7 +256,7 @@ EXTERN const uint32_t g_gpiobase[STM32F0_NPORTS]; * function, it must be unconfigured with stm32f0_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * @@ -277,7 +277,7 @@ int stm32f0_configgpio(uint32_t cfgset); * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port * diff --git a/arch/arm/src/stm32f0/stm32f0_i2c.h b/arch/arm/src/stm32f0/stm32f0_i2c.h index 29bcbdccd1d920f4d89c8aad5bd7cf59c05f7b3f..dd127b788acf7bcc01733d8f3d333febc58703e4 100644 --- a/arch/arm/src/stm32f0/stm32f0_i2c.h +++ b/arch/arm/src/stm32f0/stm32f0_i2c.h @@ -74,7 +74,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: @@ -90,7 +90,7 @@ FAR struct i2c_master_s *stm32f0_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 stm32f0_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32f0/stm32f0_serial.c b/arch/arm/src/stm32f0/stm32f0_serial.c index 91d6cc9828b9469faeb0339f7d92108ba3a465ef..3231ebdf6de485bc6f46c760ef8057b9a5f6bd47 100644 --- a/arch/arm/src/stm32f0/stm32f0_serial.c +++ b/arch/arm/src/stm32f0/stm32f0_serial.c @@ -1033,7 +1033,7 @@ static void stm32f0serial_setformat(FAR struct uart_dev_s *dev) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the USART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -1907,7 +1907,7 @@ static bool stm32f0serial_rxavailable(FAR struct uart_dev_s *dev) * Return true if USART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * dev - USART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/arch/arm/src/stm32f7/stm32_adc.c b/arch/arm/src/stm32f7/stm32_adc.c index 0d226ab46a3e462830b359bf2e52fa329af9a7e2..587983c40ab9e85303d952e7e70dbd7ac0b480f2 100644 --- a/arch/arm/src/stm32f7/stm32_adc.c +++ b/arch/arm/src/stm32f7/stm32_adc.c @@ -568,7 +568,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_dma.c b/arch/arm/src/stm32f7/stm32_dma.c index a5d185944d547b5728037d867f7913287c5c4427..7a083e3239c7ca772ff7fc5002babad9f6b0dbf7 100644 --- a/arch/arm/src/stm32f7/stm32_dma.c +++ b/arch/arm/src/stm32f7/stm32_dma.c @@ -527,7 +527,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * dmamap - Identifies the stream/channel resource. For the STM32 F7, this * is a bit-encoded value as provided by the DMAMAP_* definitions * in chip/stm32f7xxxxxxx_dma.h @@ -874,7 +874,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle) * ccr. * ccr - DMA stream configuration register * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_dma.h b/arch/arm/src/stm32f7/stm32_dma.h index e0494d538129693a0a9d1649ef97f67f486e9f5f..567e2330647a9ff517b9f94ebc370bed128befbe 100644 --- a/arch/arm/src/stm32f7/stm32_dma.h +++ b/arch/arm/src/stm32f7/stm32_dma.h @@ -135,7 +135,7 @@ extern "C" * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * For the STM32 F7, this is a bit encoded value as provided by the * the DMAMAP_* definitions in chip/stm32f7xxxxxxx_dma.h @@ -248,7 +248,7 @@ size_t stm32_dmaresidual(DMA_HANDLE handle); * ccr. * ccr - DMA stream configuration register * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_dma2d.c b/arch/arm/src/stm32f7/stm32_dma2d.c index 8e6276484ebaaa523da03c676ea53d07b8a4ea6d..9e952d2ead31c401ca4421fff941f489f1885946 100644 --- a/arch/arm/src/stm32f7/stm32_dma2d.c +++ b/arch/arm/src/stm32f7/stm32_dma2d.c @@ -481,7 +481,7 @@ static int stm32_dma2dirq(int irq, void *context, FAR void *arg) * loading or dma transfer was completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * On success OK otherwise ERROR * ****************************************************************************/ @@ -526,7 +526,7 @@ static int stm32_dma2d_waitforirq(void) * Parameter: * pfcreg - PFC control Register * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -614,7 +614,7 @@ static int stm32_dma2d_start(void) * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * memory address * ****************************************************************************/ @@ -640,7 +640,7 @@ static uint32_t stm32_dma2d_memaddress(FAR const struct stm32_dma2d_s *layer, * Parameter: * layer - Reference to the common layer state structure * - * Return: + * Returned Value: * line offset * ****************************************************************************/ @@ -664,7 +664,7 @@ static fb_coord_t stm32_dma2d_lineoffset(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the common layer state structure * fmt - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -723,7 +723,7 @@ static int stm32_dma2d_pixelformat(uint8_t fmt, uint8_t *fmtmap) * layer - Reference to the common layer state structure * bpp - Reference to the location to store the pixel format * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -764,7 +764,7 @@ static int stm32_dma2d_bpp(uint8_t fmt, uint8_t *bpp) * Description: * Get a free layer id * - * Return: + * Returned Value: * The number of the free layer * -1 if no free layer is available * @@ -791,7 +791,7 @@ static int stm32_dma2d_lfreelid(void) * Description: * Allocate a new layer structure * - * Return: + * Returned Value: * A new allocated layer structure or NULL on error. * ****************************************************************************/ @@ -880,7 +880,7 @@ static void stm32_dma2d_llayerscleanup(void) * Description: * Helper to validate if the layer is valid * - * Return: + * Returned Value: * true if validates otherwise false * ****************************************************************************/ @@ -902,7 +902,7 @@ static inline bool stm32_dma2d_lvalidate(FAR const struct stm32_dma2d_s *layer) * ypos - The y position inside the whole layer * area - the area inside the whole layer * - * Return: + * Returned Value: * true if area is inside the whole layer otherwise false * ****************************************************************************/ @@ -1156,7 +1156,7 @@ static void stm32_dma2d_lpfc(FAR const struct stm32_dma2d_s *layer, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1193,7 +1193,7 @@ static int stm32_dma2dgetvideoinfo(FAR struct dma2d_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1229,7 +1229,7 @@ static int stm32_dma2dgetplaneinfo(FAR struct dma2d_layer_s *layer, int planeno, * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1265,7 +1265,7 @@ static int stm32_dma2dgetlid(FAR struct dma2d_layer_s *layer, int *lid) * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1384,7 +1384,7 @@ static int stm32_dma2dsetclut(FAR struct dma2d_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1476,7 +1476,7 @@ static int stm32_dma2dgetclut(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1511,7 +1511,7 @@ static int stm32_dma2dsetalpha(FAR struct dma2d_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1548,7 +1548,7 @@ static int stm32_dma2dgetalpha(FAR struct dma2d_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1597,7 +1597,7 @@ static int stm32_dma2dsetblendmode(FAR struct dma2d_layer_s *layer, * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1637,7 +1637,7 @@ static int stm32_dma2dgetblendmode(FAR struct dma2d_layer_s *layer, * src - Valid reference to the source layer * srcarea - Valid reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1746,7 +1746,7 @@ static int stm32_dma2dblit(FAR struct dma2d_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -1853,7 +1853,7 @@ static int stm32_dma2dblend(FAR struct dma2d_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -1929,7 +1929,7 @@ static int stm32_dma2dfillarea(FAR struct dma2d_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -1962,7 +1962,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid) * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * @@ -2082,7 +2082,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2124,7 +2124,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer) * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * @@ -2240,7 +2240,7 @@ void up_dma2duninitialize(void) * layer - a valid reference to the low level ltdc layer structure * clut - a pointer to a valid memory region to hold 256 clut colors * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL * diff --git a/arch/arm/src/stm32f7/stm32_dma2d.h b/arch/arm/src/stm32f7/stm32_dma2d.h index 26d9f0faa8b63722de20fd70a05699b984d507f2..9ffc8289cd7f50531e70346b09ebde86a24c3155 100644 --- a/arch/arm/src/stm32f7/stm32_dma2d.h +++ b/arch/arm/src/stm32f7/stm32_dma2d.h @@ -74,7 +74,7 @@ struct dma2d_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -92,7 +92,7 @@ struct dma2d_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -109,7 +109,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * lid - Reference to store the layer id * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -127,7 +127,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -145,7 +145,7 @@ struct dma2d_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -167,7 +167,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -183,7 +183,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -201,7 +201,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Blend mode (see DMA2D_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -230,7 +230,7 @@ struct dma2d_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -250,7 +250,7 @@ struct dma2d_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -281,7 +281,7 @@ struct dma2d_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected source area outside the visible area of the @@ -308,7 +308,7 @@ struct dma2d_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the * selected area outside the visible area of the layer. @@ -340,7 +340,7 @@ struct stm32_ltdc_s; /* Forward declaration */ * Parameter: * layer - a valid reference to the low level ltdc layer structure * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -358,7 +358,7 @@ FAR struct dma2d_layer_s *stm32_dma2dinitltdc(FAR struct stm32_ltdc_s *layer); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the dma2d layer control structure on success or Null if no * related exist. * @@ -377,7 +377,7 @@ FAR struct dma2d_layer_s *up_dma2dgetlayer(int lid); * height - Layer height * fmt - Pixel format of the layer * - * Return: + * Returned Value: * On success - A valid dma2d layer reference * On error - NULL and errno is set to * -EINVAL if one of the parameter is invalid @@ -399,7 +399,7 @@ FAR struct dma2d_layer_s *up_dma2dcreatelayer(fb_coord_t width, * Parameter: * layer - Reference to the layer to remove * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -413,7 +413,7 @@ int up_dma2dremovelayer(FAR struct dma2d_layer_s *layer); * Description: * Initialize the dma2d controller * - * Return: + * Returned Value: * OK - On success * An error if initializing failed. * diff --git a/arch/arm/src/stm32f7/stm32_exti_alarm.c b/arch/arm/src/stm32f7/stm32_exti_alarm.c index 8fba01b53a4361a2ba34db6728b48e3a29009c92..552241b4907ce2366b9266cc8ad7593f3bf6d1d3 100644 --- a/arch/arm/src/stm32f7/stm32_exti_alarm.c +++ b/arch/arm/src/stm32f7/stm32_exti_alarm.c @@ -116,7 +116,7 @@ static int stm32_exti_alarm_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32f7/stm32_exti_pwr.c b/arch/arm/src/stm32f7/stm32_exti_pwr.c index 3c4f2d07a3be4107326520c4e25a76a0bf0ef5f9..f521aaff24ebf9ae3a50bb42e30569177a64aa65 100644 --- a/arch/arm/src/stm32f7/stm32_exti_pwr.c +++ b/arch/arm/src/stm32f7/stm32_exti_pwr.c @@ -122,7 +122,7 @@ static int stm32_exti_pvd_isr(int irq, void *context, void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32f7/stm32_exti_pwr.h b/arch/arm/src/stm32f7/stm32_exti_pwr.h index 67e22d05ff8400fb6b14f351c19f09f9a724e7f8..90b0185d594f5f5e64189a55709295de91e51fa9 100644 --- a/arch/arm/src/stm32f7/stm32_exti_pwr.h +++ b/arch/arm/src/stm32f7/stm32_exti_pwr.h @@ -60,7 +60,7 @@ * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32f7/stm32_gpio.c b/arch/arm/src/stm32f7/stm32_gpio.c index e9b3f0d8a9ad0d5d4a3c387b6665b6614954f3d5..cf153dd48207fba5e0441271ff441903b47d892f 100644 --- a/arch/arm/src/stm32f7/stm32_gpio.c +++ b/arch/arm/src/stm32f7/stm32_gpio.c @@ -136,7 +136,7 @@ void stm32_gpioinit(void) * function, it must be unconfigured with stm32_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono value on invalid port, or when pin is locked as ALT * function. @@ -359,7 +359,7 @@ int stm32_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32f7/stm32_i2c.h b/arch/arm/src/stm32f7/stm32_i2c.h index c5608176387158c74c643c7d56f6c2606c1af5e6..e2223f53c8f16a7441a313287308d953858008dc 100644 --- a/arch/arm/src/stm32f7/stm32_i2c.h +++ b/arch/arm/src/stm32f7/stm32_i2c.h @@ -74,7 +74,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: @@ -90,7 +90,7 @@ FAR struct i2c_master_s *stm32_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 stm32_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_ltdc.c b/arch/arm/src/stm32f7/stm32_ltdc.c index 3a992d928fad6ff71e94b686e2454a71390f4ec6..c84b766fa2667138adb9803d287771727a91ae88 100644 --- a/arch/arm/src/stm32f7/stm32_ltdc.c +++ b/arch/arm/src/stm32f7/stm32_ltdc.c @@ -1168,7 +1168,7 @@ static int stm32_ltdcirq(int irq, void *context, FAR void *arg) * that a register reload was been completed. * Note! The caller must use this function within a critical section. * - * Return: + * Returned Value: * OK - On success otherwise ERROR * ****************************************************************************/ @@ -1467,7 +1467,7 @@ static inline uint8_t stm32_ltdc_lgetopac(FAR struct stm32_layer_s *layer) * Parameter: * layer - Reference to the layer control structure * - * Return: + * Returned Value: * true - layer valid * false - layer invalid * @@ -1497,7 +1497,7 @@ static inline bool stm32_ltdc_lvalidate(FAR const struct stm32_layer_s *layer) * srcxpos - Top left x position from where data visible in the active area * srcypos - Top left y position from where data visible in the active area * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -1968,7 +1968,7 @@ static void stm32_ltdc_lenable(FAR struct stm32_layer_s *layer) * layer - Reference to the layer control structure * color - The color to clear * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * @@ -2182,7 +2182,7 @@ static void stm32_ltdc_linit(int lid) * vtable - The framebuffer driver object * vinfo - the videoinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2217,7 +2217,7 @@ static int stm32_getvideoinfo(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * pinfo - the planeinfo object * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2252,7 +2252,7 @@ static int stm32_getplaneinfo(struct fb_vtable_s *vtable, int planeno, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2279,7 +2279,7 @@ static int stm32_getcmap(struct fb_vtable_s *vtable, * vtable - The framebuffer driver object * cmap - the color table * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2306,7 +2306,7 @@ static int stm32_putcmap(struct fb_vtable_s *vtable, * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2340,7 +2340,7 @@ static int stm32_lgetvideoinfo(struct ltdc_layer_s *layer, * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2374,7 +2374,7 @@ static int stm32_lgetplaneinfo(struct ltdc_layer_s *layer, int planeno, * layer - Reference to the layer structure * cmap - color lookup table with up the 256 entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2434,7 +2434,7 @@ static int stm32_setclut(struct ltdc_layer_s *layer, * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2533,7 +2533,7 @@ static int stm32_getclut(struct ltdc_layer_s *layer, * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * OK - On success * Null if invalid flag * @@ -2610,7 +2610,7 @@ static int stm32_getlid(FAR struct ltdc_layer_s *layer, int *lid, * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2646,7 +2646,7 @@ static int stm32_setcolor(FAR struct ltdc_layer_s *layer, uint32_t argb) * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2683,7 +2683,7 @@ static int stm32_getcolor(FAR struct ltdc_layer_s *layer, uint32_t *argb) * layer - Reference to the layer structure * rgb - RGB888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2719,7 +2719,7 @@ static int stm32_setcolorkey(FAR struct ltdc_layer_s *layer, uint32_t rgb) * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2760,7 +2760,7 @@ static int stm32_getcolorkey(FAR struct ltdc_layer_s *layer, uint32_t *rgb) * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2796,7 +2796,7 @@ static int stm32_setalpha(FAR struct ltdc_layer_s *layer, uint8_t alpha) * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2833,7 +2833,7 @@ static int stm32_getalpha(FAR struct ltdc_layer_s *layer, uint8_t *alpha) * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -2965,7 +2965,7 @@ static int stm32_setblendmode(FAR struct ltdc_layer_s *layer, uint32_t mode) * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL ****************************************************************************/ @@ -3004,7 +3004,7 @@ static int stm32_getblendmode(FAR struct ltdc_layer_s *layer, uint32_t *mode) * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3066,7 +3066,7 @@ static int stm32_setarea(FAR struct ltdc_layer_s *layer, * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -3106,7 +3106,7 @@ static int stm32_getarea(FAR struct ltdc_layer_s *layer, * layer - Reference to the layer structure * mode - operation mode * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -3269,7 +3269,7 @@ static int stm32_update(FAR struct ltdc_layer_s *layer, uint32_t mode) * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3320,7 +3320,7 @@ static int stm32_blit(FAR struct ltdc_layer_s *dest, * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -3370,7 +3370,7 @@ static int stm32_blend(FAR struct ltdc_layer_s *dest, * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -3412,7 +3412,7 @@ static int stm32_fillarea(FAR struct ltdc_layer_s *layer, * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if lid * is invalid. * @@ -3452,7 +3452,7 @@ void stm32_ltdcreset(void) * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ****************************************************************************/ @@ -3541,10 +3541,10 @@ int stm32_ltdcinitialize(void) * Return a a reference to the framebuffer object for the specified video * plane. * - * Input parameters: + * Input Parameters: * None * - * Returned value: + * Returned Value: * Reference to the framebuffer object (NULL on failure) * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_ltdc.h b/arch/arm/src/stm32f7/stm32_ltdc.h index 8b3593e86da3e41f81cf289861d4b805301dafcb..c2226ec43ef3a9a84e5b0db8678ab3a44b07142f 100644 --- a/arch/arm/src/stm32f7/stm32_ltdc.h +++ b/arch/arm/src/stm32f7/stm32_ltdc.h @@ -125,7 +125,7 @@ struct ltdc_layer_s * layer - Reference to the layer control structure * vinfo - Reference to the video info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -143,7 +143,7 @@ struct ltdc_layer_s * planeno - Number of the plane * pinfo - Reference to the plane info structure * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -163,7 +163,7 @@ struct ltdc_layer_s * e.g. get the current active or inactive layer. * See LTDC_LAYER_* for possible values * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -184,7 +184,7 @@ struct ltdc_layer_s * enable - Enable or disable clut support (if false cmap is ignored and can * be NULL) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -202,7 +202,7 @@ struct ltdc_layer_s * cmap - Reference to valid color lookup table accept up the 256 color * entries * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -221,7 +221,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -237,7 +237,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * argb - Reference to store the ARGB8888 color value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -255,7 +255,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -271,7 +271,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * rgb - Reference to store the RGB888 color key * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -293,7 +293,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -309,7 +309,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * alpha - Reference to store the alpha value * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -327,7 +327,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Blend mode (see LTDC_BLEND_*) * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -365,7 +365,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - Reference to store the blend mode * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -392,7 +392,7 @@ struct ltdc_layer_s * srcxpos - x position of the visible pixel of the whole layer * srcypos - y position of the visible pixel of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL * @@ -418,7 +418,7 @@ struct ltdc_layer_s * srcxpos - Reference to store the referenced x position of the whole layer * srcypos - Reference to store the reterenced y position of the whole layer * - * Return: + * Returned Value: * On success - OK * On error - -EINVAL */ @@ -437,7 +437,7 @@ struct ltdc_layer_s * layer - Reference to the layer structure * mode - operation mode (see LTDC_UPDATE_*) * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid * -ECANCELED - Operation cancelled, something goes wrong @@ -481,7 +481,7 @@ struct ltdc_layer_s * src - Reference to the source layer * srcarea - Reference to the selected area of the source layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -510,7 +510,7 @@ struct ltdc_layer_s * back - Reference to the background layer * backarea - Reference to the selected area of the background layer * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * source area outside the visible area of the destination layer. @@ -535,7 +535,7 @@ struct ltdc_layer_s * color - Color to fill the selected area. Color must be formatted * according to the layer pixel format. * - * Return: + * Returned Value: * OK - On success * -EINVAL - If one of the parameter invalid or if the size of the selected * area outside the visible area of the layer. @@ -609,7 +609,7 @@ struct stm32_ltdc_s * Description: * Initialize the ltdc controller * - * Return: + * Returned Value: * OK * ************************************************************************************/ @@ -627,7 +627,7 @@ void stm32_ltdcuninitialize(void); * Parameter: * lid - Layer identifier * - * Return: + * Returned Value: * Reference to the layer control structure on success or Null if parameter * invalid. * diff --git a/arch/arm/src/stm32f7/stm32_otghost.c b/arch/arm/src/stm32f7/stm32_otghost.c index 548a6f393de2f17754528ee12af09d06024919c5..1a9b8c1feac796e1aa21a129dc81688f8ae8b983 100644 --- a/arch/arm/src/stm32f7/stm32_otghost.c +++ b/arch/arm/src/stm32f7/stm32_otghost.c @@ -1265,7 +1265,7 @@ static int stm32_ctrlchan_alloc(FAR struct stm32_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 * @@ -1327,7 +1327,7 @@ static int stm32_ctrlep_alloc(FAR struct stm32_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 * @@ -3819,7 +3819,7 @@ static void stm32_txfe_enable(FAR struct stm32_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 @@ -3910,7 +3910,7 @@ static int stm32_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 * @@ -4040,7 +4040,7 @@ static int stm32_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 * @@ -4099,7 +4099,7 @@ static int stm32_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 * @@ -4155,7 +4155,7 @@ static int stm32_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 * @@ -4223,7 +4223,7 @@ static int stm32_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 * @@ -4269,7 +4269,7 @@ static int stm32_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 * @@ -4305,7 +4305,7 @@ static int stm32_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 * @@ -4349,7 +4349,7 @@ static int stm32_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 * @@ -4392,7 +4392,7 @@ static int stm32_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 * @@ -4595,7 +4595,7 @@ static int stm32_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: @@ -4667,7 +4667,7 @@ static ssize_t stm32_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 * @@ -4723,7 +4723,7 @@ static int stm32_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. * @@ -4812,7 +4812,7 @@ static int stm32_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. * @@ -4864,7 +4864,7 @@ static int stm32_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32f7/stm32_pwr.c b/arch/arm/src/stm32f7/stm32_pwr.c index c9d2d5dae44159523fb02e629f6873d56350c284..573796a78805d24bb062c841d8be1cf5fe26bad0 100644 --- a/arch/arm/src/stm32f7/stm32_pwr.c +++ b/arch/arm/src/stm32f7/stm32_pwr.c @@ -200,7 +200,7 @@ void stm32_pwr_enablebkp(bool writable) * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ @@ -229,7 +229,7 @@ void stm32_pwr_enablebreg(bool regon) * Input Parameters: * vos - Properly aligned voltage scaling select bits for the PWR_CR register. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -264,7 +264,7 @@ void stm32_pwr_setvos(uint16_t vos) * Input Parameters: * pls - PVD level * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32f7/stm32_pwr.h b/arch/arm/src/stm32f7/stm32_pwr.h index c80de12ae1707689cd498cd13275af2dda22edd2..b332e424a0deb2cd595c6f4fb936511245a707bb 100644 --- a/arch/arm/src/stm32f7/stm32_pwr.h +++ b/arch/arm/src/stm32f7/stm32_pwr.h @@ -119,7 +119,7 @@ void stm32_pwr_enablebkp(bool writable); * Input Parameters: * regon - state to set it to * - * Returned Values: + * Returned Value: * None * ************************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_sdmmc.c b/arch/arm/src/stm32f7/stm32_sdmmc.c index c3530fc3fe2787a76e88bb5e84114fb03fe42f3f..86481dd42fb4d593d77778c5b3e4b677a09737bc 100644 --- a/arch/arm/src/stm32f7/stm32_sdmmc.c +++ b/arch/arm/src/stm32f7/stm32_sdmmc.c @@ -3157,7 +3157,7 @@ static void stm32_default(struct stm32_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3293,7 +3293,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -3340,7 +3340,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_sdmmc.h b/arch/arm/src/stm32f7/stm32_sdmmc.h index 8e722497c5f296141a7fd40b87f4c581c0806c5a..095af548052f433d5f9f6f70f393f4d0de9c3ec2 100644 --- a/arch/arm/src/stm32f7/stm32_sdmmc.h +++ b/arch/arm/src/stm32f7/stm32_sdmmc.h @@ -72,7 +72,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -94,7 +94,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -112,7 +112,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/stm32f7/stm32_serial.c b/arch/arm/src/stm32f7/stm32_serial.c index 3f639e178ef302d4e824be6427490285c20515a1..ba6edead3016e2f3ef828ed96f25b1b5f4d68ef1 100644 --- a/arch/arm/src/stm32f7/stm32_serial.c +++ b/arch/arm/src/stm32f7/stm32_serial.c @@ -1369,7 +1369,7 @@ static void up_set_format(struct uart_dev_s *dev) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the UART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2235,7 +2235,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 diff --git a/arch/arm/src/stm32f7/stm32_spi.c b/arch/arm/src/stm32f7/stm32_spi.c index 9278ebaad752243b13fdcd6a6aaf6526c91874bb..cd1dc679893c6159f57090205a3df5cdbb405389 100644 --- a/arch/arm/src/stm32f7/stm32_spi.c +++ b/arch/arm/src/stm32f7/stm32_spi.c @@ -1699,7 +1699,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI bus in its default state (Master, 8-bit, mode 0, etc.) * - * Input Parameter: + * Input Parameters: * priv - private SPI device structure * * Returned Value: @@ -1788,7 +1788,7 @@ static void spi_bus_initialize(FAR struct stm32_spidev_s *priv) * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_spi.h b/arch/arm/src/stm32f7/stm32_spi.h index 27751073564b3364ffe6cb15bb1ed9df2ad7f26e..f8c1ee9a1fc2dd644b2cc189aa24eb8a5974576e 100644 --- a/arch/arm/src/stm32f7/stm32_spi.h +++ b/arch/arm/src/stm32f7/stm32_spi.h @@ -71,7 +71,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * bus number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32f7/stm32_tim.h b/arch/arm/src/stm32f7/stm32_tim.h index 5f3bf82c1002d61ccb4f46768ba84259f0a0262b..06d7fe8e841035adaab4c793af900871783f49e8 100644 --- a/arch/arm/src/stm32f7/stm32_tim.h +++ b/arch/arm/src/stm32f7/stm32_tim.h @@ -196,7 +196,7 @@ int stm32_tim_deinit(FAR struct stm32_tim_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_adc.c b/arch/arm/src/stm32l4/stm32l4_adc.c index 56a9ae81d769756417303db54d56d21a63b5174a..2576ec182ed409b3d8fb6f08482bed259254e5ee 100644 --- a/arch/arm/src/stm32l4/stm32l4_adc.c +++ b/arch/arm/src/stm32l4/stm32l4_adc.c @@ -592,7 +592,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the ADC block status * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_can.c b/arch/arm/src/stm32l4/stm32l4_can.c index 7667481c6cd31c982f8725ffaa211474c219ecb8..2bc5dcd2e6062cc00953548c8d155770aa782a48 100644 --- a/arch/arm/src/stm32l4/stm32l4_can.c +++ b/arch/arm/src/stm32l4/stm32l4_can.c @@ -1627,7 +1627,7 @@ static int stm32l4can_txinterrupt(int irq, FAR void *context, FAR void *arg) * Where: * Tpclk1 is the period of the APB1 clock (PCLK1). * - * Input Parameter: + * Input Parameters: * priv - A reference to the CAN block status * * Returned Value: @@ -1726,7 +1726,7 @@ static int stm32l4can_bittiming(FAR struct stm32l4_can_s *priv) * peripheral, no registers are changed. The initialization mode is * required to change the baud rate. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1777,7 +1777,7 @@ static int stm32l4can_enterinitmode(FAR struct stm32l4_can_s *priv) * Description: * Put the CAN cell out of the Initialization mode (to Normal mode) * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1827,7 +1827,7 @@ static int stm32l4can_exitinitmode(FAR struct stm32l4_can_s *priv) * Description: * CAN cell initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1905,7 +1905,7 @@ static int stm32l4can_cellinit(FAR struct stm32l4_can_s *priv) * are set to zero thus supressing all filtering because anything masked * with zero matches zero. * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * * Returned Value: @@ -1981,7 +1981,7 @@ static int stm32l4can_filterinit(FAR struct stm32l4_can_s *priv) * Description: * Add a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2006,7 +2006,7 @@ static int stm32l4can_addextfilter(FAR struct stm32l4_can_s *priv, * Description: * Remove a filter for extended CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_EXTFILTER command @@ -2031,7 +2031,7 @@ static int stm32l4can_delextfilter(FAR struct stm32l4_can_s *priv, int arg) * Description: * Add a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - A pointer to a structure describing the filter * @@ -2054,7 +2054,7 @@ static int stm32l4can_addstdfilter(FAR struct stm32l4_can_s *priv, * Description: * Remove a filter for standard CAN IDs * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this CAN block * arg - The filter index previously returned by the * CANIOC_ADD_STDFILTER command @@ -2081,7 +2081,7 @@ static int stm32l4can_delstdfilter(FAR struct stm32l4_can_s *priv, int arg) * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_can.h b/arch/arm/src/stm32l4/stm32l4_can.h index ded35c173ba2eb7c461f0869afea606deced54b4..c7ff34733d576ae07013c4e46e22548ee72220ff 100644 --- a/arch/arm/src/stm32l4/stm32l4_can.h +++ b/arch/arm/src/stm32l4/stm32l4_can.h @@ -122,7 +122,7 @@ extern "C" * Description: * Initialize the selected CAN port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple CAN interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_comp.c b/arch/arm/src/stm32l4/stm32l4_comp.c index 8e2f4ff90868690c01f53b246b6a8326a8536411..0c954c7c8be82b0a6ac6642cb037af705b191862 100644 --- a/arch/arm/src/stm32l4/stm32l4_comp.c +++ b/arch/arm/src/stm32l4/stm32l4_comp.c @@ -342,7 +342,7 @@ static int stm32l4_exti_comp_isr(int irq, void *context, FAR void *arg) * Parameters: * cfg - configuration * - * Returns: + * Returned Value: * 0 on success, a negated errno value on failure * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_dfsdm.c b/arch/arm/src/stm32l4/stm32l4_dfsdm.c index 89a57ea86ec2d229940418e2d7f8639edee76fbe..4e54b77c519e57a2b04976aa1be3af0f2411e4c7 100644 --- a/arch/arm/src/stm32l4/stm32l4_dfsdm.c +++ b/arch/arm/src/stm32l4/stm32l4_dfsdm.c @@ -545,7 +545,7 @@ static void tim_modifyreg(FAR struct stm32_dev_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the DFSDM block status * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_dma.h b/arch/arm/src/stm32l4/stm32l4_dma.h index 5eb679be70bf4c9e8eb70ce75e3ee317f3d60736..c31246526767e3b94301e4bb1a30c5040da938c2 100644 --- a/arch/arm/src/stm32l4/stm32l4_dma.h +++ b/arch/arm/src/stm32l4/stm32l4_dma.h @@ -145,7 +145,7 @@ extern "C" * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * This is a bit encoded value as provided by the DMACHAN_* definitions * in chip/stm32l4x6xx_dma.h @@ -249,7 +249,7 @@ size_t stm32l4_dmaresidual(DMA_HANDLE handle); * only applies to memory addresses, it will return false for any peripheral * address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_exti.h b/arch/arm/src/stm32l4/stm32l4_exti.h index 14d2e7100ae47454d1b6b9bd23516e985acaa48f..098ac6e720a7d35388d52d38bfcf13b53a40fc16 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti.h +++ b/arch/arm/src/stm32l4/stm32l4_exti.h @@ -101,7 +101,7 @@ int stm32l4_gpiosetevent(uint32_t pinset, bool risingedge, bool fallingedge, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * @@ -124,7 +124,7 @@ int stm32l4_exti_alarm(bool risingedge, bool fallingedge, bool event, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * @@ -148,7 +148,7 @@ int stm32l4_exti_wakeup(bool risingedge, bool fallingedge, bool event, * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_alarm.c b/arch/arm/src/stm32l4/stm32l4_exti_alarm.c index 2a0b3fbb0ef469f0762c88c1e2897b9041b82b45..e0016e063768d1540d45541cd2609a163a605d78 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_alarm.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_alarm.c @@ -108,7 +108,7 @@ static int stm32l4_exti_alarm_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_comp.c b/arch/arm/src/stm32l4/stm32l4_exti_comp.c index 147eb3f4b48e7ef294e9c72b78da29e4c46166e2..44d029e0b3e572dea69cdfe63c17ebca0710b246 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_comp.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_comp.c @@ -129,7 +129,7 @@ static int stm32l4_exti_comp_isr(int irq, void *context, FAR void *arg) * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_pwr.c b/arch/arm/src/stm32l4/stm32l4_exti_pwr.c index ab19f6f3cb95384a0c35b84400d606c01fda2f8c..7d5df6709802dce39b672bf11b7b503898953be7 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_pwr.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_pwr.c @@ -113,7 +113,7 @@ static int stm32l4_exti_pvd_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_pwr.h b/arch/arm/src/stm32l4/stm32l4_exti_pwr.h index 27e584779b9fe981ce6fc93a9f2c7b86a764b3de..c6e10a0fa759b9392a275a05e3a8700992e76b48 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_pwr.h +++ b/arch/arm/src/stm32l4/stm32l4_exti_pwr.h @@ -59,7 +59,7 @@ * - func: when non-NULL, generate interrupt * - arg: Argument passed to the interrupt callback * - * Returns: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on * failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c b/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c index 195cf2c1ac0d9f116e7517e3fcb3cc2d88eac0e7..ddac94add35a412ab67c42fd2ae407577182fbb3 100644 --- a/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c +++ b/arch/arm/src/stm32l4/stm32l4_exti_wakeup.c @@ -107,7 +107,7 @@ static int stm32l4_exti_wakeup_isr(int irq, void *context, FAR void *arg) * - event: generate event when set * - func: when non-NULL, generate interrupt * - * Returns: + * Returned Value: * Zero (OK) on success; a negated errno value on failure indicating the * nature of the failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_gpio.c b/arch/arm/src/stm32l4/stm32l4_gpio.c index f46f341662c932c26bee5f1ef467d2f7b9d43a05..a33b88c08fe0eb14742d69db2361d0159ae8aeb6 100644 --- a/arch/arm/src/stm32l4/stm32l4_gpio.c +++ b/arch/arm/src/stm32l4/stm32l4_gpio.c @@ -129,7 +129,7 @@ void stm32l4_gpioinit(void) * function, it must be unconfigured with stm32l4_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * A negated errono valu on invalid port, or when pin is locked as ALT * function. @@ -351,7 +351,7 @@ int stm32l4_configgpio(uint32_t cfgset) * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * A negated errno value on invalid port * diff --git a/arch/arm/src/stm32l4/stm32l4_gpio.h b/arch/arm/src/stm32l4/stm32l4_gpio.h index 3c7b615c4e878aee72cbcf2a696e64f64b7b69b7..56fb77a6bbe5ff43268b2432188ef3fe3826007e 100644 --- a/arch/arm/src/stm32l4/stm32l4_gpio.h +++ b/arch/arm/src/stm32l4/stm32l4_gpio.h @@ -273,7 +273,7 @@ EXTERN const uint32_t g_gpiobase[STM32L4_NPORTS]; * function, it must be unconfigured with stm32l4_unconfiggpio() with * the same cfgset first before it can be set to non-alternative function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port, or when pin is locked as ALT function. * @@ -294,7 +294,7 @@ int stm32l4_configgpio(uint32_t cfgset); * operate in PWM mode could produce excessive on-board currents and trigger * over-current/alarm function. * - * Returns: + * Returned Value: * OK on success * ERROR on invalid port * diff --git a/arch/arm/src/stm32l4/stm32l4_i2c.h b/arch/arm/src/stm32l4/stm32l4_i2c.h index 267ee1d6640509d57d63137356fdaabf784306fb..3a38cc14bdca451a3428e3014e4acb5f5462a3e4 100644 --- a/arch/arm/src/stm32l4/stm32l4_i2c.h +++ b/arch/arm/src/stm32l4/stm32l4_i2c.h @@ -74,7 +74,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: @@ -90,7 +90,7 @@ FAR struct i2c_master_s *stm32l4_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 stm32l4_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_iwdg.c b/arch/arm/src/stm32l4/stm32l4_iwdg.c index 9977e4d727d5c8d886940994754f658c8bb81e00..bf0b1392bb9f7be6e9bbc06b8c24ab07967d5fbd 100644 --- a/arch/arm/src/stm32l4/stm32l4_iwdg.c +++ b/arch/arm/src/stm32l4/stm32l4_iwdg.c @@ -312,7 +312,7 @@ static inline void stm32l4_setprescaler(FAR struct stm32l4_lowerhalf_s *priv) * 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. * ****************************************************************************/ @@ -360,7 +360,7 @@ static int stm32l4_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. * ****************************************************************************/ @@ -385,7 +385,7 @@ static int stm32l4_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. * ****************************************************************************/ @@ -418,7 +418,7 @@ static int stm32l4_keepalive(FAR struct watchdog_lowerhalf_s *lower) * driver state structure. * status - The location to return the watchdog status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -477,7 +477,7 @@ static int stm32l4_getstatus(FAR struct watchdog_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in milliseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -602,7 +602,7 @@ static int stm32l4_settimeout(FAR struct watchdog_lowerhalf_s *lower, * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_otgfshost.c b/arch/arm/src/stm32l4/stm32l4_otgfshost.c index b7e952d23171da1305254c61a83f0b3442e5b08e..e676d9504f2cd052439c44bc4d1ed5c6461e8c0a 100644 --- a/arch/arm/src/stm32l4/stm32l4_otgfshost.c +++ b/arch/arm/src/stm32l4/stm32l4_otgfshost.c @@ -1267,7 +1267,7 @@ static int stm32l4_ctrlchan_alloc(FAR struct stm32l4_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 * @@ -1329,7 +1329,7 @@ static int stm32l4_ctrlep_alloc(FAR struct stm32l4_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 * @@ -3825,7 +3825,7 @@ static void stm32l4_txfe_enable(FAR struct stm32l4_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 @@ -3916,7 +3916,7 @@ static int stm32l4_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 * @@ -4046,7 +4046,7 @@ static int stm32l4_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 * @@ -4105,7 +4105,7 @@ static int stm32l4_ep0configure(FAR struct usbhost_driver_s *drvr, * 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 * @@ -4161,7 +4161,7 @@ static int stm32l4_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 * @@ -4229,7 +4229,7 @@ static int stm32l4_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 * @@ -4275,7 +4275,7 @@ static int stm32l4_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 * @@ -4311,7 +4311,7 @@ static int stm32l4_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 * @@ -4355,7 +4355,7 @@ static int stm32l4_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 * @@ -4398,7 +4398,7 @@ static int stm32l4_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 * @@ -4601,7 +4601,7 @@ static int stm32l4_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: @@ -4673,7 +4673,7 @@ static ssize_t stm32l4_transfer(FAR struct usbhost_driver_s *drvr, usbhost_ep_t * 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 * @@ -4729,7 +4729,7 @@ static int stm32l4_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. * @@ -4818,7 +4818,7 @@ static int stm32l4_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. * @@ -4870,7 +4870,7 @@ static int stm32l4_connect(FAR struct usbhost_driver_s *drvr, * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: diff --git a/arch/arm/src/stm32l4/stm32l4_pm.h b/arch/arm/src/stm32l4/stm32l4_pm.h index fd94299389c910afcafb9f8d6773fbdb1fd91731..530be06fcb4c7a398038fb20d3e8dcbb5cece397 100644 --- a/arch/arm/src/stm32l4/stm32l4_pm.h +++ b/arch/arm/src/stm32l4/stm32l4_pm.h @@ -108,7 +108,7 @@ int stm32l4_pmstop2(void); * 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 diff --git a/arch/arm/src/stm32l4/stm32l4_pminitialize.c b/arch/arm/src/stm32l4/stm32l4_pminitialize.c index 05988f21bf5723da1df9944580531b9fbf187c56..89a8547a58601b51bebf2e75601afe516f1a0436 100644 --- a/arch/arm/src/stm32l4/stm32l4_pminitialize.c +++ b/arch/arm/src/stm32l4/stm32l4_pminitialize.c @@ -60,10 +60,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_pmstandby.c b/arch/arm/src/stm32l4/stm32l4_pmstandby.c index c8730c14f9dcff17cd1eb28c887b40462d5f8c68..331d8446f32a558a1c55e88728f6510d97533a21 100644 --- a/arch/arm/src/stm32l4/stm32l4_pmstandby.c +++ b/arch/arm/src/stm32l4/stm32l4_pmstandby.c @@ -60,7 +60,7 @@ * 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 diff --git a/arch/arm/src/stm32l4/stm32l4_pwm.c b/arch/arm/src/stm32l4/stm32l4_pwm.c index 10531d20a8ccc334f37a9689c88ee2a34f84fc84..03639445845b372a86a85f98462a977a2c2eab48 100644 --- a/arch/arm/src/stm32l4/stm32l4_pwm.c +++ b/arch/arm/src/stm32l4/stm32l4_pwm.c @@ -676,7 +676,7 @@ static void stm32l4pwm_putreg(struct stm32l4_pwmtimer_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the PWM block status * * Returned Value: @@ -734,7 +734,7 @@ static void stm32l4pwm_dumpregs(struct stm32l4_pwmtimer_s *priv, * 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 * @@ -1360,7 +1360,7 @@ static int stm32l4pwm_timer(FAR struct stm32l4_pwmtimer_s *priv, * Description: * Try to change only channel duty. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * channel - Channel to by updated * duty - New duty. @@ -1442,7 +1442,7 @@ static int stm32l4pwm_update_duty(FAR struct stm32l4_pwmtimer_s *priv, * Description: * Handle timer interrupts. * - * Input parameters: + * Input Parameters: * priv - A reference to the lower half PWM driver state structure * * Returned Value: @@ -1525,7 +1525,7 @@ static int stm32l4pwm_interrupt(struct stm32l4_pwmtimer_s *priv) * Description: * Handle timer 1 and 8 interrupts. * - * Input parameters: + * Input Parameters: * Standard NuttX interrupt inputs * * Returned Value: @@ -1553,7 +1553,7 @@ static int stm32l4pwm_tim8interrupt(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: @@ -1600,7 +1600,7 @@ static uint8_t stm32l4pwm_pulsecount(uint32_t count) * Description: * Enable or disable APB clock for the timer peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the lower half PWM driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -1693,7 +1693,7 @@ static void stm32l4pwm_setapbclock(FAR struct stm32l4_pwmtimer_s *priv, bool on) * 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: @@ -1755,7 +1755,7 @@ static int stm32l4pwm_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: @@ -1816,7 +1816,7 @@ static int stm32l4pwm_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 * @@ -1903,7 +1903,7 @@ static int stm32l4pwm_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: @@ -2020,7 +2020,7 @@ static int stm32l4pwm_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 diff --git a/arch/arm/src/stm32l4/stm32l4_qencoder.c b/arch/arm/src/stm32l4/stm32l4_qencoder.c index 9f8a20fc9f83c381fd5df9a2612e6f68fe644e80..683b2f62639e993920d700247057ce7aaea8aac5 100644 --- a/arch/arm/src/stm32l4/stm32l4_qencoder.c +++ b/arch/arm/src/stm32l4/stm32l4_qencoder.c @@ -504,7 +504,7 @@ static void stm32l4_putreg32(FAR struct stm32l4_lowerhalf_s *priv, int offset, * Description: * Dump all timer registers. * - * Input parameters: + * Input Parameters: * priv - A reference to the QENCODER block status * * Returned Value: @@ -1108,7 +1108,7 @@ static int stm32l4_ioctl(FAR struct qe_lowerhalf_s *lower, int cmd, unsigned lon * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_qencoder.h b/arch/arm/src/stm32l4/stm32l4_qencoder.h index 7fccca772b36b5ccd677ab4f95d5c635b9dde563..b2d2b445c6ab9250b748d76d76916be2f2bfd5ba 100644 --- a/arch/arm/src/stm32l4/stm32l4_qencoder.h +++ b/arch/arm/src/stm32l4/stm32l4_qencoder.h @@ -129,7 +129,7 @@ * devpath - The full path to the driver to register. E.g., "/dev/qe0" * tim - The timer number to used. 'tim' must be an element of {1,2,3,4,5,8} * - * Returned Values: + * Returned Value: * Zero on success; A negated errno value is returned on failure. * ************************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_qspi.c b/arch/arm/src/stm32l4/stm32l4_qspi.c index 025e71f6d19e19c0aaaee60f374d29dec14fe33b..cf303e71b430e52978a3489d90766661563e73fa 100644 --- a/arch/arm/src/stm32l4/stm32l4_qspi.c +++ b/arch/arm/src/stm32l4/stm32l4_qspi.c @@ -2421,7 +2421,7 @@ static int qspi_hw_initialize(struct stm32l4_qspidev_s *priv) * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: @@ -2594,7 +2594,7 @@ errout_with_dmahandles: * Description: * Put the QSPI device into memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * meminfo - parameters like for a memory transfer used for reading * @@ -2686,7 +2686,7 @@ void stm32l4_qspi_enter_memorymapped(struct qspi_dev_s* dev, * Description: * Take the QSPI device out of memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_qspi.h b/arch/arm/src/stm32l4/stm32l4_qspi.h index ed65850fc56e69e0e043a761d1f81574f336abd8..c9c87638ee2c7d5293349b1149c997543fd4315a 100644 --- a/arch/arm/src/stm32l4/stm32l4_qspi.h +++ b/arch/arm/src/stm32l4/stm32l4_qspi.h @@ -86,7 +86,7 @@ extern "C" * Description: * Initialize the selected QSPI port in master mode * - * Input Parameter: + * Input Parameters: * intf - Interface number(must be zero) * * Returned Value: @@ -103,7 +103,7 @@ FAR struct qspi_dev_s *stm32l4_qspi_initialize(int intf); * Description: * Put the QSPI device into memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * meminfo - parameters like for a memory transfer used for reading * lpto - number of cycles to wait to automatically de-assert CS @@ -123,7 +123,7 @@ void stm32l4_qspi_enter_memorymapped(struct qspi_dev_s* dev, * Description: * Take the QSPI device out of memory mapped mode * - * Input Parameter: + * Input Parameters: * dev - QSPI device * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_sai.c b/arch/arm/src/stm32l4/stm32l4_sai.c index 80d07f024f37b217a9db77eed4d69ca00d069580..21892409d531e8e953f2abefc8542070535a3b37 100644 --- a/arch/arm/src/stm32l4/stm32l4_sai.c +++ b/arch/arm/src/stm32l4/stm32l4_sai.c @@ -479,7 +479,7 @@ static void sai_exclsem_take(struct stm32l4_sai_s *priv) * Setup the master clock divider based on the currently selected data width * and the sample rate * - * Input Parameter: + * Input Parameters: * priv - SAI device structure (only the sample rate and frequency are * needed at this point). * @@ -1288,7 +1288,7 @@ static void sai_buf_initialize(struct stm32l4_sai_s *priv) * Description: * Initialize the selected SAI port in its default state * - * Input Parameter: + * Input Parameters: * priv - private SAI device structure * * Returned Value: @@ -1353,7 +1353,7 @@ static void sai_portinitialize(struct stm32l4_sai_s *priv) * Description: * Initialize the selected SAI block * - * Input Parameter: + * Input Parameters: * intf - I2S interface number (identifying the "logical" SAI interface) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_sdmmc.c b/arch/arm/src/stm32l4/stm32l4_sdmmc.c index 2078c1625878bddd16035cef224103e55b698127..38a7077d079066f03c500d7369a64395e0a24932 100644 --- a/arch/arm/src/stm32l4/stm32l4_sdmmc.c +++ b/arch/arm/src/stm32l4/stm32l4_sdmmc.c @@ -3099,7 +3099,7 @@ static void stm32_default(struct stm32_dev_s *priv) * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -3234,7 +3234,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -3281,7 +3281,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_sdmmc.h b/arch/arm/src/stm32l4/stm32l4_sdmmc.h index 155cf209f1f29cc4a29e220448b178400a602a79..0882acbb74ed844134742ba087ca86cbeec4ec30 100644 --- a/arch/arm/src/stm32l4/stm32l4_sdmmc.h +++ b/arch/arm/src/stm32l4/stm32l4_sdmmc.h @@ -73,7 +73,7 @@ extern "C" * Input Parameters: * slotno - Not used. * - * Returned Values: + * Returned Value: * A reference to an SDIO interface structure. NULL is returned on failures. * ****************************************************************************/ @@ -95,7 +95,7 @@ FAR struct sdio_dev_s *sdio_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 * ****************************************************************************/ @@ -113,7 +113,7 @@ void sdio_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 * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4_serial.c b/arch/arm/src/stm32l4/stm32l4_serial.c index 67602e3c16909467c7a246bb0efc6dae47a97bfe..1cc67bb148f548095ddbb1f566559e208dfb570c 100644 --- a/arch/arm/src/stm32l4/stm32l4_serial.c +++ b/arch/arm/src/stm32l4/stm32l4_serial.c @@ -1218,7 +1218,7 @@ void stm32l4serial_pm_setsuspend(bool suspend) * Description: * Enable or disable APB clock for the USART peripheral * - * Input parameters: + * Input Parameters: * dev - A reference to the UART driver state structure * on - Enable clock if 'on' is 'true' and disable if 'false' * @@ -2100,7 +2100,7 @@ static bool stm32l4serial_rxavailable(FAR 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 diff --git a/arch/arm/src/stm32l4/stm32l4_spi.c b/arch/arm/src/stm32l4/stm32l4_spi.c index 7f5d1543a1c7c0191a3cc1fb6e0d95ca5bb10a17..b98bd793e299b389ce49533f06dfba994d1bda04 100644 --- a/arch/arm/src/stm32l4/stm32l4_spi.c +++ b/arch/arm/src/stm32l4/stm32l4_spi.c @@ -1481,7 +1481,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *rxbuffer, size_t * Description: * Initialize the selected SPI bus in its default state (Master, 8-bit, mode 0, etc.) * - * Input Parameter: + * Input Parameters: * priv - private SPI device structure * * Returned Value: @@ -1571,7 +1571,7 @@ static void spi_bus_initialize(FAR struct stm32l4_spidev_s *priv) * Description: * Initialize the selected SPI bus * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/stm32l4/stm32l4_spi.h b/arch/arm/src/stm32l4/stm32l4_spi.h index 7f5390f34778aa5636688698f0307cefa948de92..5d9f74db704f63e42b8b86a44da5deec156179f2 100644 --- a/arch/arm/src/stm32l4/stm32l4_spi.h +++ b/arch/arm/src/stm32l4/stm32l4_spi.h @@ -76,7 +76,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: diff --git a/arch/arm/src/stm32l4/stm32l4_tim.h b/arch/arm/src/stm32l4/stm32l4_tim.h index 8362ef13875d1abe30384886dd8777065dcc7111..fa88892d3ad0006e4a5cccdca8a5fc9df5b9906a 100644 --- a/arch/arm/src/stm32l4/stm32l4_tim.h +++ b/arch/arm/src/stm32l4/stm32l4_tim.h @@ -204,7 +204,7 @@ int stm32l4_tim_deinit(FAR struct stm32l4_tim_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c b/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c index 59918c81ba9292ad26e2fa9e6ea98d336dc26af4..76f5bff364807f9d395e85d1bbe08809dc642fc7 100644 --- a/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c +++ b/arch/arm/src/stm32l4/stm32l4_tim_lowerhalf.c @@ -231,7 +231,7 @@ static struct stm32l4_lowerhalf_s g_tim17_lowerhalf = * * Input Parameters: * - * Returned Values: + * Returned Value: * ****************************************************************************/ @@ -267,7 +267,7 @@ static int stm32l4_timer_handler(int irq, void *context, 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. * ****************************************************************************/ @@ -305,7 +305,7 @@ static int stm32l4_start(FAR struct timer_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. * ****************************************************************************/ @@ -339,7 +339,7 @@ static int stm32l4_stop(FAR struct timer_lowerhalf_s *lower) * driver state structure. * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -385,7 +385,7 @@ static int stm32l4_settimeout(FAR struct timer_lowerhalf_s *lower, * behavior is restored, * arg - Argument that will be provided in the callback * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -432,7 +432,7 @@ static void stm32l4_setcallback(FAR struct timer_lowerhalf_s *lower, * form /dev/timer0 * timer - the timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/stm32l4/stm32l4_wdg.h b/arch/arm/src/stm32l4/stm32l4_wdg.h index 794c5e2aef83e3f4a73233171a47a4e93989c33c..0d2b0032538257bad6685d2a0feed1c6a42ccb6e 100644 --- a/arch/arm/src/stm32l4/stm32l4_wdg.h +++ b/arch/arm/src/stm32l4/stm32l4_wdg.h @@ -79,7 +79,7 @@ extern "C" * /dev/watchdog0 * lsifreq - The calibrated LSI clock frequency * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -100,7 +100,7 @@ void stm32l4_iwdginitialize(FAR const char *devpath, uint32_t lsifreq); * devpath - The full path to the watchdog. This should be of the form * /dev/watchdog0 * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/stm32l4/stm32l4x6xx_dma.c b/arch/arm/src/stm32l4/stm32l4x6xx_dma.c index cd194b2cba0b362c3f7a7773d7b404948ecf97b5..d727be752b8bd0deac4500a7d96afea6c53e03f4 100644 --- a/arch/arm/src/stm32l4/stm32l4x6xx_dma.c +++ b/arch/arm/src/stm32l4/stm32l4x6xx_dma.c @@ -394,7 +394,7 @@ void weak_function up_dmainitialize(void) * Hmm.. I suppose this interface could be extended to make a non-blocking * version. Feel free to do that if that is what you need. * - * Input parameter: + * Input Parameters: * chan - Identifies the stream/channel resource * This is a bit encoded value as provided by the DMACHAN_* definitions * in chip/stm32l4x6xx_dma.h @@ -642,7 +642,7 @@ size_t stm32l4_dmaresidual(DMA_HANDLE handle) * of the processor. Note that this only applies to memory addresses, it * will return false for any peripheral address. * - * Returned value: + * Returned Value: * True, if transfer is possible. * ****************************************************************************/ diff --git a/arch/arm/src/str71x/str71x.h b/arch/arm/src/str71x/str71x.h index 7b3bedf1df34e28e851cdd6044d976859cf4d7af..aea504fe89b7f867976f9135051977e2da53483f 100644 --- a/arch/arm/src/str71x/str71x.h +++ b/arch/arm/src/str71x/str71x.h @@ -162,7 +162,7 @@ struct spi_dev_s; /* Forward reference */ * Initialize the selected SPI port. This function could get called * multiple times for each STR7 devices that needs an SPI reference. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_adc.h b/arch/arm/src/tiva/tiva_adc.h index 7f6edd4f9d8b741146a22623f2c3f6fe06c3d9d3..a717ad72f12fbe5a9b8a7d41e3976dfeb3ee03a1 100644 --- a/arch/arm/src/tiva/tiva_adc.h +++ b/arch/arm/src/tiva/tiva_adc.h @@ -405,7 +405,7 @@ void tiva_adc_sample_rate(uint8_t rate); * to the FIFO. This is only required when the trigger source is set to the * processor. * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' sample sequencers to trigger * sse_mask - sample sequencer bitmask, each sse is 1 shifted by the sse * number. e.g. @@ -424,7 +424,7 @@ void tiva_adc_proc_trig(uint8_t adc, uint8_t sse_mask); * Description: * Returns raw interrupt status for the input ADC * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * ****************************************************************************/ @@ -440,12 +440,12 @@ uint32_t tiva_adc_int_status(uint8_t adc); * Sets the operation state of an ADC's sample sequencer (SSE). SSEs must * be configured before being enabled. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable state * - * Return value: + * Returned Value: * Actual state of the ACTSS register. * ****************************************************************************/ @@ -466,7 +466,7 @@ uint8_t tiva_adc_sse_enable(uint8_t adc, uint8_t sse, bool state); * - Always * - !!UNSUPPORTED: Comparators * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * trigger - interrupt trigger @@ -482,7 +482,7 @@ void tiva_adc_sse_trigger(uint8_t adc, uint8_t sse, uint32_t trigger); * Additional triggering configuration for PWM. Sets which PWM and which * generator. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * cfg - which PWM modulator and generator to use, use TIVA_ADC_PWM_TRIG @@ -501,7 +501,7 @@ void tiva_adc_sse_pwm_trig(uint8_t adc, uint8_t sse, uint32_t cfg); * Sets the interrupt state of an ADC's sample sequencer (SSE). SSEs must * be enabled before setting interrupt state. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable interrupt state @@ -516,7 +516,7 @@ void tiva_adc_sse_int_enable(uint8_t adc, uint8_t sse, bool state); * Description: * Returns interrupt status for the specificed SSE * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * sse - which SSE interrupt status to retrieve * @@ -530,7 +530,7 @@ bool tiva_adc_sse_int_status(uint8_t adc, uint8_t sse); * Description: * Clears the interrupt bit for the SSE. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer @@ -547,11 +547,11 @@ void tiva_adc_sse_clear_int(uint8_t adc, uint8_t sse); * The input data buffer MUST be as large or larger than the sample sequencer. * otherwise * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * - * Return value: + * Returned Value: * number of steps read from FIFO. * ****************************************************************************/ @@ -566,7 +566,7 @@ uint8_t tiva_adc_sse_data(uint8_t adc, uint8_t sse, int32_t *buf); * priority value ranges from 0 to 3, 0 being the highest priority, 3 being * the lowest. There can be no duplicate values. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * priority - conversion priority @@ -585,7 +585,7 @@ void tiva_adc_sse_priority(uint8_t adc, uint8_t sse, uint8_t priority); * * *SSEMUX only supported on TM4C129 devices * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer step @@ -601,7 +601,7 @@ void tiva_adc_sse_register_chn(uint8_t adc, uint8_t sse, uint8_t chn, uint32_t a * Description: * Sets the differential capability for a SSE. !! UNSUPPORTED * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -620,7 +620,7 @@ void tiva_adc_sse_differential(uint8_t adc, uint8_t sse, uint8_t chn, uint32_t d * This is not available on all devices, however on devices that do not * support this feature these reserved bits are ignored on write access. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -652,7 +652,7 @@ void tiva_adc_sse_sample_hold_time(uint8_t adc, uint8_t sse, uint8_t chn, uint32 * * *Comparator/Differential functionality is unsupported and ignored. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -669,7 +669,7 @@ void tiva_adc_sse_step_cfg(uint8_t adc, uint8_t sse, uint8_t chn, uint8_t cfg); * Dump all configured registers for the given ADC and SSE. This should * only be used to verify that configuration routines were accurate. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * diff --git a/arch/arm/src/tiva/tiva_adclib.c b/arch/arm/src/tiva/tiva_adclib.c index dc2768fc16300c4b831e15e2bff9a01cef62afc1..8d55333a026950c355446c007c2b4822f668c929 100644 --- a/arch/arm/src/tiva/tiva_adclib.c +++ b/arch/arm/src/tiva/tiva_adclib.c @@ -624,7 +624,7 @@ void tiva_adc_sample_rate(uint8_t rate) * to the FIFO. This is only required when the trigger source is set to the * processor. * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' sample sequencers to trigger * sse_mask - sample sequencer bitmask, each sse is 1 shifted by the sse * number. e.g. @@ -650,7 +650,7 @@ void tiva_adc_proc_trig(uint8_t adc, uint8_t sse_mask) * Description: * Returns raw interrupt status for the input ADC * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * ****************************************************************************/ @@ -670,12 +670,12 @@ uint32_t tiva_adc_int_status(uint8_t adc) * Sets the operation state of an ADC's sample sequencer (SSE). SSEs must * be configured before being enabled. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable state * - * Return value: + * Returned Value: * Actual state of the ACTSS register. * ****************************************************************************/ @@ -711,7 +711,7 @@ uint8_t tiva_adc_sse_enable(uint8_t adc, uint8_t sse, bool state) * - Always * - !!UNSUPPORTED: Comparators * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * trigger - interrupt trigger @@ -736,7 +736,7 @@ void tiva_adc_sse_trigger(uint8_t adc, uint8_t sse, uint32_t trigger) * Additional triggering configuration for PWM. Sets which PWM and which * generator. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * cfg - which PWM modulator and generator to use, use TIVA_ADC_PWM_TRIG @@ -762,7 +762,7 @@ void tiva_adc_sse_pwm_trig(uint8_t adc, uint8_t sse, uint32_t cfg) * Sets the interrupt state of an ADC's sample sequencer (SSE). SSEs must * be enabled before setting interrupt state. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer enable/disable interrupt state @@ -799,7 +799,7 @@ void tiva_adc_sse_int_enable(uint8_t adc, uint8_t sse, bool state) * Description: * Returns interrupt status for the specificed SSE * - * Input parameters: + * Input Parameters: * adc - which ADC peripherals' interrupt status to retrieve * sse - which SSE interrupt status to retrieve * @@ -818,7 +818,7 @@ bool tiva_adc_sse_int_status(uint8_t adc, uint8_t sse) * Description: * Clears the interrupt bit for the SSE. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * state - sample sequencer @@ -839,11 +839,11 @@ void tiva_adc_sse_clear_int(uint8_t adc, uint8_t sse) * The input data buffer MUST be as large or larger than the sample sequencer. * otherwise * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * - * Return value: + * Returned Value: * number of steps read from FIFO. * ****************************************************************************/ @@ -880,7 +880,7 @@ uint8_t tiva_adc_sse_data(uint8_t adc, uint8_t sse, int32_t *buf) * priority value ranges from 0 to 3, 0 being the highest priority, 3 being * the lowest. There can be no duplicate values. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * priority - conversion priority @@ -906,7 +906,7 @@ void tiva_adc_sse_priority(uint8_t adc, uint8_t sse, uint8_t priority) * * *SSEMUX only supported on TM4C129 devices * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer step @@ -940,7 +940,7 @@ void tiva_adc_sse_register_chn(uint8_t adc, uint8_t sse, uint8_t chn, * Description: * Sets the differential capability for a SSE. !! UNSUPPORTED * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -970,7 +970,7 @@ void tiva_adc_sse_differential(uint8_t adc, uint8_t sse, uint8_t chn, uint32_t d * This is not available on all devices, however on devices that do not * support this feature these reserved bits are ignored on write access. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -1007,7 +1007,7 @@ void tiva_adc_sse_sample_hold_time(uint8_t adc, uint8_t sse, * * *Comparator/Differential functionality is unsupported and ignored. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * chn - sample sequencer channel @@ -1029,7 +1029,7 @@ void tiva_adc_sse_step_cfg(uint8_t adc, uint8_t sse, uint8_t chn, uint8_t cfg) * Dump all configured registers for the given ADC and SSE. This should * only be used to verify that configuration routines were accurate. * - * Input parameters: + * Input Parameters: * adc - peripheral state * sse - sample sequencer * diff --git a/arch/arm/src/tiva/tiva_adclow.c b/arch/arm/src/tiva/tiva_adclow.c index 577a430d2f59103922cf151946322917e6837a43..3d7262b0153c62b1855f698f227698807aa20c3c 100644 --- a/arch/arm/src/tiva/tiva_adclow.c +++ b/arch/arm/src/tiva/tiva_adclow.c @@ -655,7 +655,7 @@ static int tiva_adc_ioctl(struct adc_dev_s *dev, int cmd, unsigned long arg) * are disabled when this function runs. tiva_adc_read will * re-enable interrupts when it completes processing all pending events. * - * Input Parameters + * Input Parameters: * arg - The ADC SSE data structure cast to (void *) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_gpioirq.c b/arch/arm/src/tiva/tiva_gpioirq.c index 112887f8bf4bd049717188c797c68affeb835871..a5d0e3dbe3edd6b21de1d1c0216052c157e0824f 100644 --- a/arch/arm/src/tiva/tiva_gpioirq.c +++ b/arch/arm/src/tiva/tiva_gpioirq.c @@ -672,7 +672,7 @@ int tiva_gpioirqinitialize(void) * disabled to stop further interrupts. Otherwise, the new isr is linked * and the pin's interrupt mask is set. * - * Returns: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * return to indicate the nature of the failure. * diff --git a/arch/arm/src/tiva/tiva_i2c.h b/arch/arm/src/tiva/tiva_i2c.h index 33acca1116ca53075dce38f3b3c4a923d53560af..c43e167f8688fe078b2feea51e1591e491303888 100644 --- a/arch/arm/src/tiva/tiva_i2c.h +++ b/arch/arm/src/tiva/tiva_i2c.h @@ -59,7 +59,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: @@ -75,7 +75,7 @@ FAR struct i2c_master_s *tiva_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 tiva_i2cbus_initialize() * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_pwm.c b/arch/arm/src/tiva/tiva_pwm.c index 0e882f0f7c11ccfff7b3564d7ebd4babd1a2f1ec..b25e27225560f9a3db2fbf3efeeab9ba8299146d 100644 --- a/arch/arm/src/tiva/tiva_pwm.c +++ b/arch/arm/src/tiva/tiva_pwm.c @@ -421,7 +421,7 @@ static inline void tiva_pwm_putreg(struct tiva_pwm_chan_s *chan, * use. It will 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: @@ -457,7 +457,7 @@ static int tiva_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: @@ -487,7 +487,7 @@ static int tiva_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 * handle - This is the handle that was provided to the lower-half @@ -569,7 +569,7 @@ static int tiva_pwm_start(FAR struct pwm_lowerhalf_s *dev, * Description: * Configure PWM registers and start the PWM timer * - * 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 * @@ -659,7 +659,7 @@ static inline int tiva_pwm_timer(FAR struct tiva_pwm_chan_s *chan, * 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: @@ -692,7 +692,7 @@ static int tiva_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 diff --git a/arch/arm/src/tiva/tiva_qencoder.c b/arch/arm/src/tiva/tiva_qencoder.c index b25f6dce183f4c4896a9edb1b91bdcefde73aa44..a10eb6577d1a93c19dc120d8196e32bec45ca1ea 100644 --- a/arch/arm/src/tiva/tiva_qencoder.c +++ b/arch/arm/src/tiva/tiva_qencoder.c @@ -177,7 +177,7 @@ static inline void tiva_qe_putreg(struct tiva_qe_s *qe, unsigned int offset, * use. It will not, however, output pulses until the start method is * called. * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * * Returned Value: @@ -260,7 +260,7 @@ static int tiva_qe_setup(FAR struct qe_lowerhalf_s *lower) * stop data collection, free any resources, disable the timer hardware, and * put the system into the lowest possible power usage state * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * * Returned Value: @@ -287,7 +287,7 @@ static int tiva_qe_shutdown(FAR struct qe_lowerhalf_s *lower) * Description: * Reset the position measurement to zero. * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * * Returned Value: @@ -312,7 +312,7 @@ static int tiva_qe_reset(FAR struct qe_lowerhalf_s *lower) * Description: * Return the position mesaured by QEI. * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * pos - pointer to the position returned * @@ -338,7 +338,7 @@ static int tiva_qe_position(FAR struct qe_lowerhalf_s *lower, FAR int32_t *pos) * Description: * Lower-half logic may support platform-specific ioctl commands * - * Input parameters: + * Input Parameters: * lower - A reference to the lower half QEI driver state structure * cmd - The ioctl command * arg - The argument accompanying the ioctl command @@ -383,7 +383,7 @@ static int tiva_qe_ioctl(FAR struct qe_lowerhalf_s *lower, int cmd, * Description: * Return the direction mesaured by QEI. * - * Input parameters: + * Input Parameters: * qe - A reference to the TIVA QEI structure * dir - pointer to the direction returned * @@ -414,7 +414,7 @@ static int tiva_qe_direction(FAR struct tiva_qe_s *qe, unsigned long *dir) * Description: * Return the velocity (A/B pulses per second) mesaured by QEI. * - * Input parameters: + * Input Parameters: * qe - A reference to the TIVA QEI structure * * Returned Value: @@ -437,7 +437,7 @@ static int tiva_qe_velocity(FAR struct tiva_qe_s *qe, unsigned long *vel) * Description: * Set reset mode as MAXPOS and also set maxpos value * - * Input parameters: + * Input Parameters: * qe - A reference to the TIVA QEI structure * ppr - pulses per round of encoder * diff --git a/arch/arm/src/tiva/tiva_ssi.c b/arch/arm/src/tiva/tiva_ssi.c index bd224363b07fa25a4aee39f00f62e319e1f835bb..d64e4dccddf3a14bfe18bdc7326bdf6add73a225 100644 --- a/arch/arm/src/tiva/tiva_ssi.c +++ b/arch/arm/src/tiva/tiva_ssi.c @@ -1495,7 +1495,7 @@ static void ssi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SSI interfaces) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_ssi.h b/arch/arm/src/tiva/tiva_ssi.h index d0976c2aee965aa4cb141ff6d018cd24cebd4242..8027ae33664124fb1e1661e4b841e51585fa2369 100644 --- a/arch/arm/src/tiva/tiva_ssi.h +++ b/arch/arm/src/tiva/tiva_ssi.h @@ -70,7 +70,7 @@ extern "C" * required. Theregore, all GPIO chip management is deferred to board- * specific logic. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SSI interfaces) * * Returned Value: diff --git a/arch/arm/src/tiva/tiva_timer.h b/arch/arm/src/tiva/tiva_timer.h index 547cd117041737a23e8d420c81cf5226d1638c3a..f5d9c6f9fe1c0b1b70efbcf4202d6c591e08dc0e 100644 --- a/arch/arm/src/tiva/tiva_timer.h +++ b/arch/arm/src/tiva/tiva_timer.h @@ -835,7 +835,7 @@ static inline void tiva_gptm0_synchronize(uint32_t sync) * form /dev/timer0 * config - 32-bit timer configuration values. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/tiva/tiva_timerlow32.c b/arch/arm/src/tiva/tiva_timerlow32.c index 91f44618b00f2d3408d6d3def8ae3c3e98192481..9807588ec265518ed79624b49a50196d71c5f629 100644 --- a/arch/arm/src/tiva/tiva_timerlow32.c +++ b/arch/arm/src/tiva/tiva_timerlow32.c @@ -133,7 +133,7 @@ static const struct timer_ops_s g_timer_ops = * priv - A pointer to a private timer driver lower half instance * usecs - The number of usecs to convert * - * Returned Values: + * Returned Value: * The time converted to clock ticks. * ****************************************************************************/ @@ -161,7 +161,7 @@ static uint32_t tiva_usec2ticks(struct tiva_lowerhalf_s *priv, uint32_t usecs) * priv - A pointer to a private timer driver lower half instance * usecs - The number of ticks to convert * - * Returned Values: + * Returned Value: * The time converted to microseconds. * ****************************************************************************/ @@ -189,7 +189,7 @@ static uint32_t tiva_ticks2usec(struct tiva_lowerhalf_s *priv, uint32_t ticks) * priv - A pointer to a private timer driver lower half instance * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -224,7 +224,7 @@ static void tiva_timeout(struct tiva_lowerhalf_s *priv, uint32_t timeout) * Input Parameters: * Usual 32-bit timer interrupt handler arguments. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -287,7 +287,7 @@ static void tiva_timer_handler(TIMER_HANDLE handle, void *arg, uint32_t status) * 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. * ****************************************************************************/ @@ -324,7 +324,7 @@ static int tiva_start(struct timer_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. * ****************************************************************************/ @@ -362,7 +362,7 @@ static int tiva_stop(struct timer_lowerhalf_s *lower) * driver state structure. * status - The location to return the status information. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -415,7 +415,7 @@ static int tiva_getstatus(struct timer_lowerhalf_s *lower, * driver state structure. * timeout - The new timeout value in microseconds. * - * Returned Values: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ @@ -456,7 +456,7 @@ static int tiva_settimeout(struct timer_lowerhalf_s *lower, uint32_t timeout) * function pointer is NULL, then the reset-on-expiration * behavior is restored, * - * Returned Values: + * Returned Value: * The previous timer expiration function pointer or NULL is there was * no previous function pointer. * @@ -496,7 +496,7 @@ static void tiva_setcallback(struct timer_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. * ****************************************************************************/ @@ -535,7 +535,7 @@ static int tiva_ioctl(struct timer_lowerhalf_s *lower, int cmd, * form /dev/timer0 * config - 32-bit timer configuration values. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/arm/src/tms570/tms570_irq.c b/arch/arm/src/tms570/tms570_irq.c index 11d606d637e5cc6a5c26d5cda365e8d9d9e8bd72..33f2890b749f7762d3621921b6fc7f05b02a674b 100644 --- a/arch/arm/src/tms570/tms570_irq.c +++ b/arch/arm/src/tms570/tms570_irq.c @@ -198,7 +198,7 @@ void up_irqinitialize(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. * ****************************************************************************/ @@ -240,7 +240,7 @@ uint32_t *arm_decodeirq(uint32_t *regs) * 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. * ****************************************************************************/ diff --git a/arch/arm/src/tms570/tms570_selftest.h b/arch/arm/src/tms570/tms570_selftest.h index 696bc54fe3b1382d3b95321b9fc1f873fe16ad2f..727510fe329c6e1825a5fb8ce8fbd1e0fc19a864 100644 --- a/arch/arm/src/tms570/tms570_selftest.h +++ b/arch/arm/src/tms570/tms570_selftest.h @@ -90,7 +90,7 @@ void tms570_memtest_selftest(void); * Description: * Start the memory test on the selected set of RAMs. * - * Input Paramters: + * Input Parameters: * rinfol - The OR of each RAM grouping bit. See the PBIST_RINFOL* * definitions in chip/tms570_pbist.h * diff --git a/arch/arm/src/xmc4/xmc4_i2c.h b/arch/arm/src/xmc4/xmc4_i2c.h index f4a167b713da70f745271b81cd65db2ad073c256..74f8acb1684b8a0280772a6af4f523a3c7ec3834 100644 --- a/arch/arm/src/xmc4/xmc4_i2c.h +++ b/arch/arm/src/xmc4/xmc4_i2c.h @@ -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 *xmc4_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: diff --git a/arch/arm/src/xmc4/xmc4_serial.c b/arch/arm/src/xmc4/xmc4_serial.c index fef3ac077343de3e9ec41c502ed8034652afbdf9..36a23e91d768d4f8632d1a5fd129820eed1f98bd 100644 --- a/arch/arm/src/xmc4/xmc4_serial.c +++ b/arch/arm/src/xmc4/xmc4_serial.c @@ -1073,7 +1073,7 @@ void xmc4_earlyserialinit(void) * Input Parameters: * None * - * Returns Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/arch/arm/src/xmc4/xmc4_spi.h b/arch/arm/src/xmc4/xmc4_spi.h index 5113665eda26e05fd911db8e65c08b63efad90c6..73f4d69d4d92d84da1d6903a4f64238c8c534310 100644 --- a/arch/arm/src/xmc4/xmc4_spi.h +++ b/arch/arm/src/xmc4/xmc4_spi.h @@ -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: diff --git a/arch/avr/src/at32uc3/at32uc3_gpioirq.c b/arch/avr/src/at32uc3/at32uc3_gpioirq.c index 66e82476554a7ddedcc92b2e395b74a059a30276..03b704e08adf11ca0f70c10b81c2498ddb36c2f7 100644 --- a/arch/avr/src/at32uc3/at32uc3_gpioirq.c +++ b/arch/avr/src/at32uc3/at32uc3_gpioirq.c @@ -81,7 +81,7 @@ static struct g_gpiohandler_s g_gpiohandler[NR_GPIO_IRQS]; /**************************************************************************** * Name: gpio_baseaddress * - * Input: + * Input Parameters: * irq - A IRQ number in the range of 0 to NR_GPIO_IRQS. * * Description: @@ -114,7 +114,7 @@ static inline uint32_t gpio_baseaddress(unsigned int irq) /**************************************************************************** * Name: gpio_pin * - * Input: + * Input Parameters: * irq - A IRQ number in the range of 0 to NR_GPIO_IRQS. * * Description: diff --git a/arch/avr/src/avr/avr.h b/arch/avr/src/avr/avr.h index 0326d6d8488af3b8cf03c68d63afcb6fdae19bda..2e0c72ee38f9dafa6673b8742f6e51994050f764 100644 --- a/arch/avr/src/avr/avr.h +++ b/arch/avr/src/avr/avr.h @@ -144,7 +144,7 @@ uint8_t *up_doirq(uint8_t irq, uint8_t *regs); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/avr/src/avr/up_blocktask.c b/arch/avr/src/avr/up_blocktask.c index b03b967badadebafc3e5fb5ef845bb3d238e5730..868a517b404cfaef7fb4620b31ecd6e9dbcb1f62 100644 --- a/arch/avr/src/avr/up_blocktask.c +++ b/arch/avr/src/avr/up_blocktask.c @@ -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 diff --git a/arch/avr/src/avr/up_checkstack.c b/arch/avr/src/avr/up_checkstack.c index 725a234d1a3f482626d927192f4fbf2aa533911d..96152af0d6bb53027d5ae0f5f9b32be5cc15be17 100644 --- a/arch/avr/src/avr/up_checkstack.c +++ b/arch/avr/src/avr/up_checkstack.c @@ -74,7 +74,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size); * 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. * ****************************************************************************/ @@ -154,7 +154,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size) * Input Parameters: * None * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ diff --git a/arch/avr/src/avr/up_createstack.c b/arch/avr/src/avr/up_createstack.c index 54efb1a3fb53f917fb55ac1b18116eda1d513715..d54b2049fe63e4008b2903ca820bf376a08118df 100644 --- a/arch/avr/src/avr/up_createstack.c +++ b/arch/avr/src/avr/up_createstack.c @@ -81,7 +81,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. diff --git a/arch/avr/src/avr/up_reprioritizertr.c b/arch/avr/src/avr/up_reprioritizertr.c index 846b59becf62f3f90196124d25eae4a734d899d8..28323ffbb73f606706f08f400e2982633a39cf44 100644 --- a/arch/avr/src/avr/up_reprioritizertr.c +++ b/arch/avr/src/avr/up_reprioritizertr.c @@ -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 * diff --git a/arch/avr/src/avr/up_spi.c b/arch/avr/src/avr/up_spi.c index 24a4f377cbd09f2932a90e03951ef49adaaf7da7..98742cf4e20a185776a72e12946ae2dcc16311ab 100644 --- a/arch/avr/src/avr/up_spi.c +++ b/arch/avr/src/avr/up_spi.c @@ -440,7 +440,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: diff --git a/arch/avr/src/avr/up_stackframe.c b/arch/avr/src/avr/up_stackframe.c index 0f7d3a87463e1148abbd400b557edd8843fc142f..71c38c8aa441291da17fe40405040771db4f7223 100644 --- a/arch/avr/src/avr/up_stackframe.c +++ b/arch/avr/src/avr/up_stackframe.c @@ -86,7 +86,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. * diff --git a/arch/avr/src/avr/up_switchcontext.S b/arch/avr/src/avr/up_switchcontext.S index 3fc1b6ae42e83418d6d2fc069c9f1066530276bb..c6ab3f8c08067e8bf08f76814947de2a3a9780a1 100644 --- a/arch/avr/src/avr/up_switchcontext.S +++ b/arch/avr/src/avr/up_switchcontext.S @@ -74,7 +74,7 @@ * r24-r25: savregs * r22-r23: restoreregs * - * Return: + * Returned Value: * up_switchcontext forces a context switch to the task "canned" in restoreregs. * It does not 'return' in the normal sense, rather, it will context switch back * to the function point. When it does 'return,' it is because the blocked diff --git a/arch/avr/src/avr/up_unblocktask.c b/arch/avr/src/avr/up_unblocktask.c index d70b65405cd2af723ba9e307ab329776c5f5b120..cea4c6df79c1c7c68eb4bea6c5af3d5e212fa3e1 100644 --- a/arch/avr/src/avr/up_unblocktask.c +++ b/arch/avr/src/avr/up_unblocktask.c @@ -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 diff --git a/arch/avr/src/avr/up_usestack.c b/arch/avr/src/avr/up_usestack.c index 0546d8c770ad85b02b724717dfb79d93919349f0..1e451d883c24fa3a425411b5ca3d38684c6ba868 100644 --- a/arch/avr/src/avr/up_usestack.c +++ b/arch/avr/src/avr/up_usestack.c @@ -79,7 +79,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. * diff --git a/arch/avr/src/avr32/up_blocktask.c b/arch/avr/src/avr32/up_blocktask.c index 8449d82cbe0e49331f09abae60b32b7530dcffe0..3e9304be28e2961922665ea7ed3e6d7c99efbf8b 100644 --- a/arch/avr/src/avr32/up_blocktask.c +++ b/arch/avr/src/avr32/up_blocktask.c @@ -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 diff --git a/arch/avr/src/avr32/up_createstack.c b/arch/avr/src/avr32/up_createstack.c index 6bc17519bc26127bace92f63bb728a02f03f1971..2244e9ba4e4860ca716a3789b5ad5546b207f7dd 100644 --- a/arch/avr/src/avr32/up_createstack.c +++ b/arch/avr/src/avr32/up_createstack.c @@ -81,7 +81,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. diff --git a/arch/avr/src/avr32/up_reprioritizertr.c b/arch/avr/src/avr32/up_reprioritizertr.c index 1ce7a4c406e1a9c8e2ee83dcf4ff0d760169bd49..eb8023d72082f8929d97c9fc0cabe39f7aab6de7 100644 --- a/arch/avr/src/avr32/up_reprioritizertr.c +++ b/arch/avr/src/avr32/up_reprioritizertr.c @@ -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 * diff --git a/arch/avr/src/avr32/up_stackframe.c b/arch/avr/src/avr32/up_stackframe.c index acd10d9216f658b7fcab260564d8fc01f6bb7c57..dfcf12800184d97fcc498ad22e521f2c57c730ef 100644 --- a/arch/avr/src/avr32/up_stackframe.c +++ b/arch/avr/src/avr32/up_stackframe.c @@ -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. * diff --git a/arch/avr/src/avr32/up_switchcontext.S b/arch/avr/src/avr32/up_switchcontext.S index 8820427e69ba999e7464345e88633e981d5271a2..1542a645784a698d68f41386b7e19d7b7daa4684 100644 --- a/arch/avr/src/avr32/up_switchcontext.S +++ b/arch/avr/src/avr32/up_switchcontext.S @@ -68,7 +68,7 @@ * * void up_switchcontext(uint32_t *saveregs, uint32_t *restoreregs); * - * Return: + * Returned Value: * up_switchcontext forces a context switch to the task "canned" in restoreregs. * It does not 'return' in the normal sense, rather, it will context switch back * to the function point. When it does 'return,' it is because the blocked diff --git a/arch/avr/src/avr32/up_unblocktask.c b/arch/avr/src/avr32/up_unblocktask.c index d8181344fdd56291cc6839f0a3766c6af357e6e5..c77c5dbdbb2dce8869701b2cc407a36717a5fafd 100644 --- a/arch/avr/src/avr32/up_unblocktask.c +++ b/arch/avr/src/avr32/up_unblocktask.c @@ -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 diff --git a/arch/avr/src/avr32/up_usestack.c b/arch/avr/src/avr32/up_usestack.c index 533c82a16ca887849b6563fccf87bd328697d4d0..4e6de52de83b55abd776bf3a2835891f249b0266 100644 --- a/arch/avr/src/avr32/up_usestack.c +++ b/arch/avr/src/avr32/up_usestack.c @@ -78,7 +78,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. * diff --git a/arch/avr/src/common/up_releasestack.c b/arch/avr/src/common/up_releasestack.c index 9cda128cabf0d7ebe85e959e80e7d89af68046c7..f1abcd15d90c93469a20eb4846a4138c5946569a 100644 --- a/arch/avr/src/common/up_releasestack.c +++ b/arch/avr/src/common/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/hc/src/common/up_blocktask.c b/arch/hc/src/common/up_blocktask.c index f6308cb729056e30f3eae9666ef392e2e4f968fa..9c69ac43db0f410fc7f42e6712861e1f99e54bb5 100644 --- a/arch/hc/src/common/up_blocktask.c +++ b/arch/hc/src/common/up_blocktask.c @@ -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 diff --git a/arch/hc/src/common/up_createstack.c b/arch/hc/src/common/up_createstack.c index f09b98a87a20ad4e710e60609c96a882c2b89e23..5f954588f3cad51f7dd829375706310ad63be86e 100644 --- a/arch/hc/src/common/up_createstack.c +++ b/arch/hc/src/common/up_createstack.c @@ -78,7 +78,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. diff --git a/arch/hc/src/common/up_releasestack.c b/arch/hc/src/common/up_releasestack.c index 03d50098e12dd80ebc952bbb4d952600b22314a2..5280674c99a524f31e877510a86bba6dbb2a88a3 100644 --- a/arch/hc/src/common/up_releasestack.c +++ b/arch/hc/src/common/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/hc/src/common/up_reprioritizertr.c b/arch/hc/src/common/up_reprioritizertr.c index 0b0d400d9a536692f9d7b23e657b9e221cc7d2bc..757f2ad05cdfde526768ee63afa89c8ac7c4be7a 100644 --- a/arch/hc/src/common/up_reprioritizertr.c +++ b/arch/hc/src/common/up_reprioritizertr.c @@ -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 * diff --git a/arch/hc/src/common/up_stackframe.c b/arch/hc/src/common/up_stackframe.c index d712bb7d3b473ef1ade1db3ffa5e602906c0dc09..57d899f08e3ec786529eb1208b0c3cf1c09672a3 100644 --- a/arch/hc/src/common/up_stackframe.c +++ b/arch/hc/src/common/up_stackframe.c @@ -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. * diff --git a/arch/hc/src/common/up_unblocktask.c b/arch/hc/src/common/up_unblocktask.c index c2ed818ac3092f90c73d7e605b5d6cafb5abea86..6ab177ecf1969700211a6bccbc2b8f05f16063cb 100644 --- a/arch/hc/src/common/up_unblocktask.c +++ b/arch/hc/src/common/up_unblocktask.c @@ -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 diff --git a/arch/hc/src/common/up_usestack.c b/arch/hc/src/common/up_usestack.c index 6160e92b5eb1d2ce6cb23d393347c9c22582a7c2..4ecf5351f7ba07b5875fa9dec384d72cff247c23 100644 --- a/arch/hc/src/common/up_usestack.c +++ b/arch/hc/src/common/up_usestack.c @@ -77,7 +77,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. * diff --git a/arch/hc/src/m9s12/m9s12.h b/arch/hc/src/m9s12/m9s12.h index 53da6a772679331310bea74b06696e18e26e5931..48a09dde8863a1775a0879913995b8fa7dd52163 100644 --- a/arch/hc/src/m9s12/m9s12.h +++ b/arch/hc/src/m9s12/m9s12.h @@ -329,7 +329,7 @@ int hcs12_ethinitialize(int intf); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/mips/src/common/up_createstack.c b/arch/mips/src/common/up_createstack.c index 69d5ff04869639cda3aa6e90a9ee77f871a2ef7a..715bf8151e3b01c28cd69e78e1dde5a2bde7daf6 100644 --- a/arch/mips/src/common/up_createstack.c +++ b/arch/mips/src/common/up_createstack.c @@ -99,7 +99,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. diff --git a/arch/mips/src/common/up_releasestack.c b/arch/mips/src/common/up_releasestack.c index a322f4c24c8dddfa34b8aed60bbb43794546011e..d08bc2e6d91d7bb8e49afc3d8b035e6287d3fcf8 100644 --- a/arch/mips/src/common/up_releasestack.c +++ b/arch/mips/src/common/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/mips/src/common/up_stackframe.c b/arch/mips/src/common/up_stackframe.c index 6c631f3e1fc383b8b45b93baa1941d36a92e5fe1..45c8c05908802318c2c7c4128d3d37540df00201 100644 --- a/arch/mips/src/common/up_stackframe.c +++ b/arch/mips/src/common/up_stackframe.c @@ -100,7 +100,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. * diff --git a/arch/mips/src/common/up_usestack.c b/arch/mips/src/common/up_usestack.c index b4e3098fc47af5dcd9cba7649d1746352dc0b87a..041057a40e36ca3ba447deefee8c61a45057b0c1 100644 --- a/arch/mips/src/common/up_usestack.c +++ b/arch/mips/src/common/up_usestack.c @@ -98,7 +98,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. * diff --git a/arch/mips/src/mips32/up_blocktask.c b/arch/mips/src/mips32/up_blocktask.c index 1ad66ce9db6ef2b3eb266560e84c4b37d6c44604..6ee466611de4a21b132375f67a8872593273e598 100644 --- a/arch/mips/src/mips32/up_blocktask.c +++ b/arch/mips/src/mips32/up_blocktask.c @@ -63,7 +63,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 diff --git a/arch/mips/src/mips32/up_reprioritizertr.c b/arch/mips/src/mips32/up_reprioritizertr.c index 22a204d58bafd42d472bfbe288d13475e5836f01..cae6ed3af5ea985d9fec647d0d40dee06d6c1a8b 100644 --- a/arch/mips/src/mips32/up_reprioritizertr.c +++ b/arch/mips/src/mips32/up_reprioritizertr.c @@ -70,7 +70,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 * diff --git a/arch/mips/src/mips32/up_unblocktask.c b/arch/mips/src/mips32/up_unblocktask.c index 9e72ef17a6a811d2019248bce4fe03dae586cb2b..8400b1f7cf3412cfce79ae247b2cc0b12a5b43da 100644 --- a/arch/mips/src/mips32/up_unblocktask.c +++ b/arch/mips/src/mips32/up_unblocktask.c @@ -63,7 +63,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 diff --git a/arch/mips/src/mips32/up_vfork.c b/arch/mips/src/mips32/up_vfork.c index 06b79f7bb13743527e02a91b7ccaa3378aa338e6..d62c2dd62323c1427cc3180a0381f02dac6e9a5d 100644 --- a/arch/mips/src/mips32/up_vfork.c +++ b/arch/mips/src/mips32/up_vfork.c @@ -100,10 +100,10 @@ * * task_vforkabort() may be called if an error occurs between steps 3 and 6. * - * Input Paremeters: + * 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, diff --git a/arch/mips/src/mips32/vfork.S b/arch/mips/src/mips32/vfork.S index 7012b45a41d53c4dc297ddbd0385c46232571343..bfcd9e51f490212202bcb3eec4c89541ac79a01a 100644 --- a/arch/mips/src/mips32/vfork.S +++ b/arch/mips/src/mips32/vfork.S @@ -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 diff --git a/arch/mips/src/pic32mx/pic32mx-spi.c b/arch/mips/src/pic32mx/pic32mx-spi.c index e09688e42c5ee4745729cee8bf9e41dc73fc10cd..ed3e8bae41b6b517ffa099c029ea5cce38cdcbd0 100644 --- a/arch/mips/src/pic32mx/pic32mx-spi.c +++ b/arch/mips/src/pic32mx/pic32mx-spi.c @@ -842,7 +842,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: diff --git a/arch/mips/src/pic32mx/pic32mx.h b/arch/mips/src/pic32mx/pic32mx.h index 480ff80fb8099fa0d6da9a8dd52f68cd619bcb9f..e76f02c8719c0a16f91deace5666dbad15d26723 100644 --- a/arch/mips/src/pic32mx/pic32mx.h +++ b/arch/mips/src/pic32mx/pic32mx.h @@ -391,7 +391,7 @@ void pic32mx_dumpgpio(uint32_t pinset, const char *msg); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/arch/mips/src/pic32mz/pic32mz-spi.c b/arch/mips/src/pic32mz/pic32mz-spi.c index 287c538b7d03c3a74a682f8022fd681d623be3db..ea2f906cb918a2af03f74f0d6460b55cc168063a 100644 --- a/arch/mips/src/pic32mz/pic32mz-spi.c +++ b/arch/mips/src/pic32mz/pic32mz-spi.c @@ -1199,7 +1199,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 mutiple SPI interfaces) * * Returned Value: diff --git a/arch/mips/src/pic32mz/pic32mz-spi.h b/arch/mips/src/pic32mz/pic32mz-spi.h index ce4d772e0a64de925edbf20d9b183f10b076e655..4770661d3f4558171d2b75db8be7d80e0e51e964 100644 --- a/arch/mips/src/pic32mz/pic32mz-spi.h +++ b/arch/mips/src/pic32mz/pic32mz-spi.h @@ -78,7 +78,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: diff --git a/arch/misoc/src/lm32/lm32_blocktask.c b/arch/misoc/src/lm32/lm32_blocktask.c index f313da11cca3f3ad37f01a814c2d89b198e85e0b..7bc951cfbf475b6407ebd14df046be68b71336b9 100644 --- a/arch/misoc/src/lm32/lm32_blocktask.c +++ b/arch/misoc/src/lm32/lm32_blocktask.c @@ -64,7 +64,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 diff --git a/arch/misoc/src/lm32/lm32_createstack.c b/arch/misoc/src/lm32/lm32_createstack.c index 31c7f2422616526e3d2d03c1ddd678a1518a9f11..a9aa3143a1003f0534a4a42bfd5ec8e0e00f3175 100644 --- a/arch/misoc/src/lm32/lm32_createstack.c +++ b/arch/misoc/src/lm32/lm32_createstack.c @@ -99,7 +99,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. diff --git a/arch/misoc/src/lm32/lm32_releasestack.c b/arch/misoc/src/lm32/lm32_releasestack.c index fa88500bf9d04beff9cfea29695be2db3357d557..63f4ab8f993fe6abd2bc641d452d558ad77ced3c 100644 --- a/arch/misoc/src/lm32/lm32_releasestack.c +++ b/arch/misoc/src/lm32/lm32_releasestack.c @@ -59,7 +59,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): diff --git a/arch/misoc/src/lm32/lm32_reprioritizertr.c b/arch/misoc/src/lm32/lm32_reprioritizertr.c index e6b42611018b928e66eca1b246c1489d6710f721..735b69ced743639e8b0de5e8dd3545d7c6fd213e 100644 --- a/arch/misoc/src/lm32/lm32_reprioritizertr.c +++ b/arch/misoc/src/lm32/lm32_reprioritizertr.c @@ -70,7 +70,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 * diff --git a/arch/misoc/src/lm32/lm32_stackframe.c b/arch/misoc/src/lm32/lm32_stackframe.c index 981c655f81f1c5873b4c8ba431a52ba3970ea3cb..0791201b4e8dfa45be58ae2a7202b7af89c59be5 100644 --- a/arch/misoc/src/lm32/lm32_stackframe.c +++ b/arch/misoc/src/lm32/lm32_stackframe.c @@ -94,7 +94,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. * diff --git a/arch/misoc/src/lm32/lm32_unblocktask.c b/arch/misoc/src/lm32/lm32_unblocktask.c index 74b1d92472c890453bebf57fbba8725ce48732b3..8dedd5299325d89c10481ff497b13f33c097208b 100644 --- a/arch/misoc/src/lm32/lm32_unblocktask.c +++ b/arch/misoc/src/lm32/lm32_unblocktask.c @@ -64,7 +64,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 diff --git a/arch/renesas/src/common/up_blocktask.c b/arch/renesas/src/common/up_blocktask.c index 9e8ba57db75b6d0b4c030cd42f7aa0db2267b9bb..9ceda2e1e2f1f793cfba5ad525803243e3a5536d 100644 --- a/arch/renesas/src/common/up_blocktask.c +++ b/arch/renesas/src/common/up_blocktask.c @@ -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 diff --git a/arch/renesas/src/common/up_createstack.c b/arch/renesas/src/common/up_createstack.c index 1bbf3cc8e0f20b89b60c820861ba8855c425bdb4..f4461a08b3dd923fdb7c5993cd1a0b45ab00208b 100644 --- a/arch/renesas/src/common/up_createstack.c +++ b/arch/renesas/src/common/up_createstack.c @@ -78,7 +78,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. diff --git a/arch/renesas/src/common/up_releasestack.c b/arch/renesas/src/common/up_releasestack.c index e2b5948b142fb84272ab588875403528e17dcefc..5b309bde16de376ab45399b212a6dde0ffcbd462 100644 --- a/arch/renesas/src/common/up_releasestack.c +++ b/arch/renesas/src/common/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/renesas/src/common/up_reprioritizertr.c b/arch/renesas/src/common/up_reprioritizertr.c index c476dbad376420d5ff9fc712764c9bdb3d754c0b..2733ecb8d971a4fa8426ab2665bdc20aca692913 100644 --- a/arch/renesas/src/common/up_reprioritizertr.c +++ b/arch/renesas/src/common/up_reprioritizertr.c @@ -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 * diff --git a/arch/renesas/src/common/up_stackframe.c b/arch/renesas/src/common/up_stackframe.c index 811fcd4aad1b007466f7258b522b4dd4a4e8afeb..d3512ec9c95ecba0c5f3e7eba21bc0e68ac67f17 100644 --- a/arch/renesas/src/common/up_stackframe.c +++ b/arch/renesas/src/common/up_stackframe.c @@ -96,7 +96,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. * diff --git a/arch/renesas/src/common/up_unblocktask.c b/arch/renesas/src/common/up_unblocktask.c index de3008f98a00bb11ee11c698d95c9d61b94f1c28..30a9b4af9cb1621ce9a698f74e10bea9cd4fec15 100644 --- a/arch/renesas/src/common/up_unblocktask.c +++ b/arch/renesas/src/common/up_unblocktask.c @@ -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 diff --git a/arch/renesas/src/common/up_usestack.c b/arch/renesas/src/common/up_usestack.c index de4c4aca95f7cdcf5e21539a6badc85171bb01c6..9fce7d59653724620fd0c4a4b822fe8525700d73 100644 --- a/arch/renesas/src/common/up_usestack.c +++ b/arch/renesas/src/common/up_usestack.c @@ -78,7 +78,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. * diff --git a/arch/risc-v/src/common/up_createstack.c b/arch/risc-v/src/common/up_createstack.c index 494d54e4abcb3fe16b5809f51dd6a902acd3132d..1861707685a4e98fe8b8c5840a7cad75b8814fc9 100644 --- a/arch/risc-v/src/common/up_createstack.c +++ b/arch/risc-v/src/common/up_createstack.c @@ -99,7 +99,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. diff --git a/arch/risc-v/src/common/up_releasestack.c b/arch/risc-v/src/common/up_releasestack.c index 15301c49d2704a17134c257572df806930f73511..dac7cea0d6ded0aece92e0171233d40464e04415 100644 --- a/arch/risc-v/src/common/up_releasestack.c +++ b/arch/risc-v/src/common/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/risc-v/src/common/up_stackframe.c b/arch/risc-v/src/common/up_stackframe.c index b3cb9801d4d2bdb09c73f01b627aa0168b291662..be7b797d2c2bd2a9d34f2687d37a181425a781d0 100644 --- a/arch/risc-v/src/common/up_stackframe.c +++ b/arch/risc-v/src/common/up_stackframe.c @@ -100,7 +100,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. * diff --git a/arch/risc-v/src/common/up_usestack.c b/arch/risc-v/src/common/up_usestack.c index 605bb79b045ee06b3a29dc9b50571d252cd8aaac..49333a5a12218b9d4e86b9dad7dabd4f4f111b8c 100644 --- a/arch/risc-v/src/common/up_usestack.c +++ b/arch/risc-v/src/common/up_usestack.c @@ -98,7 +98,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. * diff --git a/arch/risc-v/src/nr5m100/nr5_timer.h b/arch/risc-v/src/nr5m100/nr5_timer.h index 2a6d15c3e3d874a00aa8b718dc0bfffd28050692..5994df9bee110b9d8c7771bfccf2dab97d9727fa 100644 --- a/arch/risc-v/src/nr5m100/nr5_timer.h +++ b/arch/risc-v/src/nr5m100/nr5_timer.h @@ -148,7 +148,7 @@ int nr5_timer_deinit(FAR struct nr5_timer_dev_s *dev); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - the timer number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/arch/risc-v/src/rv32im/up_blocktask.c b/arch/risc-v/src/rv32im/up_blocktask.c index 530797da2b189fee6e7843c5925bc7c72e266d9a..0ac7327e120ef2c9485311758a65d0608bc0df55 100644 --- a/arch/risc-v/src/rv32im/up_blocktask.c +++ b/arch/risc-v/src/rv32im/up_blocktask.c @@ -63,7 +63,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 diff --git a/arch/risc-v/src/rv32im/up_reprioritizertr.c b/arch/risc-v/src/rv32im/up_reprioritizertr.c index 26ed4ab2d10a3f62c6a4a16806004f28b5cb4ae0..e286d5026ec2e97fb35408fb554781930f47ebda 100644 --- a/arch/risc-v/src/rv32im/up_reprioritizertr.c +++ b/arch/risc-v/src/rv32im/up_reprioritizertr.c @@ -70,7 +70,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 * diff --git a/arch/risc-v/src/rv32im/up_unblocktask.c b/arch/risc-v/src/rv32im/up_unblocktask.c index 1b7350e05b1ced91addcd74d8175b14f6ffddf25..3bb71380dde102ea80e4f76b7f3c6eb6406ede1d 100644 --- a/arch/risc-v/src/rv32im/up_unblocktask.c +++ b/arch/risc-v/src/rv32im/up_unblocktask.c @@ -63,7 +63,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 diff --git a/arch/risc-v/src/rv32im/up_vfork.c b/arch/risc-v/src/rv32im/up_vfork.c index f2f5332beceb8417ff9261836ccacd6563e9dc7a..d38d29c158fe7faeb2bd38ccfa9040449d5954fa 100644 --- a/arch/risc-v/src/rv32im/up_vfork.c +++ b/arch/risc-v/src/rv32im/up_vfork.c @@ -100,10 +100,10 @@ * * task_vforkabort() may be called if an error occurs between steps 3 and 6. * - * Input Paremeters: + * 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, diff --git a/arch/sim/src/up_blocktask.c b/arch/sim/src/up_blocktask.c index 27223b19c3bc902fbb2758f8a7bc16aa114b6785..86a46453ecf8f7580fdd36101997b0d3fdeb8bf4 100644 --- a/arch/sim/src/up_blocktask.c +++ b/arch/sim/src/up_blocktask.c @@ -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 diff --git a/arch/sim/src/up_cpuidlestack.c b/arch/sim/src/up_cpuidlestack.c index c11d14e4a9905ff23c15487871d726b6646cbe2d..4a237c1b6bb6290a9f5c0bd476fec0965b3cc2ea 100644 --- a/arch/sim/src/up_cpuidlestack.c +++ b/arch/sim/src/up_cpuidlestack.c @@ -85,7 +85,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 diff --git a/arch/sim/src/up_createstack.c b/arch/sim/src/up_createstack.c index 96a4097a234cfc6444e23b4cd6af7d988ac14d51..2d511ba6c552a968620ca68a9cce8edfeac8bee4 100644 --- a/arch/sim/src/up_createstack.c +++ b/arch/sim/src/up_createstack.c @@ -84,7 +84,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. diff --git a/arch/sim/src/up_framebuffer.c b/arch/sim/src/up_framebuffer.c index 195eadd6a461b3740f4291c0fdcf705095e1bcdf..8e374a2781864341bb98b83bbd7113020610973e 100644 --- a/arch/sim/src/up_framebuffer.c +++ b/arch/sim/src/up_framebuffer.c @@ -356,7 +356,7 @@ static int up_setcursor(FAR struct fb_vtable_s *vtable, * 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. * @@ -384,7 +384,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. diff --git a/arch/sim/src/up_qspiflash.c b/arch/sim/src/up_qspiflash.c index c94986b3d388537d3e71afc2eaa689f5461452cb..f01002d7fe973bca19bf618d9c49cbb3b3857ef1 100644 --- a/arch/sim/src/up_qspiflash.c +++ b/arch/sim/src/up_qspiflash.c @@ -577,7 +577,7 @@ static int qspiflash_command(FAR struct qspi_dev_s *dev, FAR struct qspi_cmdinfo * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/sim/src/up_releasestack.c b/arch/sim/src/up_releasestack.c index e62cf2adf81123fdbc901945b48aec03bffcddf0..87a30261264587d5736e4a574501132d4694ac22 100644 --- a/arch/sim/src/up_releasestack.c +++ b/arch/sim/src/up_releasestack.c @@ -57,7 +57,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): diff --git a/arch/sim/src/up_reprioritizertr.c b/arch/sim/src/up_reprioritizertr.c index 048c311559607353625a2e62729997eb22b7ed5a..36e34230477ef54cca7587e939a7538e66e1a717 100644 --- a/arch/sim/src/up_reprioritizertr.c +++ b/arch/sim/src/up_reprioritizertr.c @@ -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 * diff --git a/arch/sim/src/up_spiflash.c b/arch/sim/src/up_spiflash.c index 677bdafd969271bb0adde863b65eb4d952d9f7e7..a75cb82948b0b83a10a9f2943927bca415d56656 100644 --- a/arch/sim/src/up_spiflash.c +++ b/arch/sim/src/up_spiflash.c @@ -897,7 +897,7 @@ static uint16_t spiflash_readword(FAR struct sim_spiflashdev_s *priv) * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/sim/src/up_stackframe.c b/arch/sim/src/up_stackframe.c index 3e5b8a089deb7798ccf432dff3a125f568b4a325..624520dc208f6f517f80d133cc310eeef0e4bd97 100644 --- a/arch/sim/src/up_stackframe.c +++ b/arch/sim/src/up_stackframe.c @@ -90,7 +90,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. * diff --git a/arch/sim/src/up_unblocktask.c b/arch/sim/src/up_unblocktask.c index 5217efeb8fbe8e4db28d9292b9c712f5788377bd..03e8e847f9eba31afab9e4ea6c2fdfdacf29fa5c 100644 --- a/arch/sim/src/up_unblocktask.c +++ b/arch/sim/src/up_unblocktask.c @@ -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 diff --git a/arch/sim/src/up_usestack.c b/arch/sim/src/up_usestack.c index 3b428d8222cce23f9de39f2a7f7176abf39dd1bd..f31ed5aae3bf42778055f2078bc523051c473701 100644 --- a/arch/sim/src/up_usestack.c +++ b/arch/sim/src/up_usestack.c @@ -85,7 +85,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. * diff --git a/arch/x86/src/common/up_blocktask.c b/arch/x86/src/common/up_blocktask.c index e5a4845e2444f80581581da527e5392ee4b2a633..34f7f9fa26e76e916e791416700a9f9cf99cfc60 100644 --- a/arch/x86/src/common/up_blocktask.c +++ b/arch/x86/src/common/up_blocktask.c @@ -62,7 +62,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 head diff --git a/arch/x86/src/common/up_reprioritizertr.c b/arch/x86/src/common/up_reprioritizertr.c index 110d26a6717924603532138d56d5843e410b851b..75428b84c98b9de1a4fd102def0a392ea941c09d 100644 --- a/arch/x86/src/common/up_reprioritizertr.c +++ b/arch/x86/src/common/up_reprioritizertr.c @@ -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 * diff --git a/arch/x86/src/common/up_unblocktask.c b/arch/x86/src/common/up_unblocktask.c index 706d36808c841d76ae1854a5aabd9a13b5782151..8b3b4b3f2496edab122a4af443f59e8938420bb0 100644 --- a/arch/x86/src/common/up_unblocktask.c +++ b/arch/x86/src/common/up_unblocktask.c @@ -61,7 +61,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 task, executed. diff --git a/arch/x86/src/i486/up_createstack.c b/arch/x86/src/i486/up_createstack.c index f51d6f2ca2b29e9c31d47b29cd7d79c769e79755..8173457e80a0913dd3f4b18871ecb5c52b77af90 100644 --- a/arch/x86/src/i486/up_createstack.c +++ b/arch/x86/src/i486/up_createstack.c @@ -80,7 +80,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. diff --git a/arch/x86/src/i486/up_releasestack.c b/arch/x86/src/i486/up_releasestack.c index 0f23cd3fb7541639a3d05e7d2125001ad2bc6f2c..e83434024ee123ebcd6ea572721a7f112b7f25d6 100644 --- a/arch/x86/src/i486/up_releasestack.c +++ b/arch/x86/src/i486/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/x86/src/i486/up_stackframe.c b/arch/x86/src/i486/up_stackframe.c index fab05bff9c079bbe3e17e4e703f22084a487faf5..62bd968a0f7625a0be3f77f8a43fd8588ba28fbe 100644 --- a/arch/x86/src/i486/up_stackframe.c +++ b/arch/x86/src/i486/up_stackframe.c @@ -99,7 +99,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. * diff --git a/arch/x86/src/i486/up_usestack.c b/arch/x86/src/i486/up_usestack.c index b2005fe2de857a4e3c1f78abba2f10945e2ff677..59221bedd6b5f3a5d8ccb939df9e0c8587ce0df8 100644 --- a/arch/x86/src/i486/up_usestack.c +++ b/arch/x86/src/i486/up_usestack.c @@ -78,7 +78,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. * diff --git a/arch/x86/src/qemu/qemu.h b/arch/x86/src/qemu/qemu.h index 561c68da4427af6baead48357cef4bb4f7312469..80eceb18b301a4af75b98146a9c1b8384f48d356 100644 --- a/arch/x86/src/qemu/qemu.h +++ b/arch/x86/src/qemu/qemu.h @@ -201,7 +201,7 @@ int i486_dumpgpio(uint16_t pinset, const char *msg); * Description: * Initialize the selected SPI port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple SPI interfaces) * * Returned Value: diff --git a/arch/x86/src/qemu/qemu_vga.c b/arch/x86/src/qemu/qemu_vga.c index 151333933207087d0f941465338f757958c862fa..f29b74abc425bbcb77d0073aa522006fad249dc6 100644 --- a/arch/x86/src/qemu/qemu_vga.c +++ b/arch/x86/src/qemu/qemu_vga.c @@ -183,7 +183,8 @@ static const struct file_operations g_vgaops = * you'll need to switch planes to access the whole screen but * that allows you using any resolution, up to 400x600 * - * Returns 0=ok, -n=fail + * Returned Value: + * 0=ok, -n=fail */ static int init_graph_vga(int width, int height,int chain4) diff --git a/arch/xtensa/src/common/xtensa_assert.c b/arch/xtensa/src/common/xtensa_assert.c index 24b7fd7e23b70761a06b0ffa71cf32ccef61ec04..e290be637f9d87251d5efe9817a252ea22eabd3c 100644 --- a/arch/xtensa/src/common/xtensa_assert.c +++ b/arch/xtensa/src/common/xtensa_assert.c @@ -180,7 +180,7 @@ void up_assert(const uint8_t *filename, int lineno) * - Co-processor exception * - High priority level2-6 Exception. * - * Input parameters: + * Input Parameters: * xcptcode - Identifies the unhandled exception (see include/esp32/irq.h) * regs - The register save are at the time of the interrupt. * @@ -280,7 +280,7 @@ void xtensa_panic(int xptcode, uint32_t *regs) * cause varies 32..39. * 40..63 Reserved * - * Input parameters: + * Input Parameters: * exccause - Identifies the EXCCAUSE of the user exception * regs - The register save are at the time of the interrupt. * diff --git a/arch/xtensa/src/common/xtensa_blocktask.c b/arch/xtensa/src/common/xtensa_blocktask.c index fb1c0f910bb1fb8993753da2b643df287c209d1d..592da9a3f7e67068c5974048a142c8ffa14b4f2b 100644 --- a/arch/xtensa/src/common/xtensa_blocktask.c +++ b/arch/xtensa/src/common/xtensa_blocktask.c @@ -63,7 +63,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 diff --git a/arch/xtensa/src/common/xtensa_checkstack.c b/arch/xtensa/src/common/xtensa_checkstack.c index 4853513905721cc9b8242c6eb550ed6cc28ec9a7..bcfbece0d4adc7235e10401da15d41afdf43e2d3 100644 --- a/arch/xtensa/src/common/xtensa_checkstack.c +++ b/arch/xtensa/src/common/xtensa_checkstack.c @@ -72,7 +72,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size); * 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. * ****************************************************************************/ @@ -174,7 +174,7 @@ static size_t do_stackcheck(uintptr_t alloc, size_t size) * Input Parameters: * None * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ diff --git a/arch/xtensa/src/common/xtensa_createstack.c b/arch/xtensa/src/common/xtensa_createstack.c index 68308fb527e2316f18cd32847bd177f2de460a4a..1632ac445fc6d1e299db163bfb080df71f629d86 100644 --- a/arch/xtensa/src/common/xtensa_createstack.c +++ b/arch/xtensa/src/common/xtensa_createstack.c @@ -91,7 +91,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. diff --git a/arch/xtensa/src/common/xtensa_releasestack.c b/arch/xtensa/src/common/xtensa_releasestack.c index 94bb2d8cd8ad91c7164b3871c48525b49766e4cc..738da79284a5c9678331f1f395a1322a58a1ce80 100644 --- a/arch/xtensa/src/common/xtensa_releasestack.c +++ b/arch/xtensa/src/common/xtensa_releasestack.c @@ -58,7 +58,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): diff --git a/arch/xtensa/src/common/xtensa_reprioritizertr.c b/arch/xtensa/src/common/xtensa_reprioritizertr.c index 0226d18f7250ca3bb09143ca126358f6df17ec6e..617bb50c619b385de745f8bf2a1e368673c256e3 100644 --- a/arch/xtensa/src/common/xtensa_reprioritizertr.c +++ b/arch/xtensa/src/common/xtensa_reprioritizertr.c @@ -70,7 +70,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 * diff --git a/arch/xtensa/src/common/xtensa_stackframe.c b/arch/xtensa/src/common/xtensa_stackframe.c index 388238d8de342597a4dfaa962aef5d31f8da488d..884225d69a768c2f24a607c7f3fc9dddf95b1cea 100644 --- a/arch/xtensa/src/common/xtensa_stackframe.c +++ b/arch/xtensa/src/common/xtensa_stackframe.c @@ -92,7 +92,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. * diff --git a/arch/xtensa/src/common/xtensa_unblocktask.c b/arch/xtensa/src/common/xtensa_unblocktask.c index 40ecf73c56b8dbaaf6c1318c84ffe958f6760243..e7fb168ba7a4714a6bc7e49d406e3d3f5ace732b 100644 --- a/arch/xtensa/src/common/xtensa_unblocktask.c +++ b/arch/xtensa/src/common/xtensa_unblocktask.c @@ -63,7 +63,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 diff --git a/arch/xtensa/src/common/xtensa_usestack.c b/arch/xtensa/src/common/xtensa_usestack.c index 0b5db031e91d93d942f11ab484edadb36b066072..4faff7341b2a4ff11fdbfd717e438b731f15758c 100644 --- a/arch/xtensa/src/common/xtensa_usestack.c +++ b/arch/xtensa/src/common/xtensa_usestack.c @@ -90,7 +90,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. * diff --git a/arch/xtensa/src/esp32/esp32_cpuidlestack.c b/arch/xtensa/src/esp32/esp32_cpuidlestack.c index ea475b79b3f6f21036565f6730bd32d29e9a6acb..8239acb96d0dc74c273fddb1a19a94c5789ec884 100644 --- a/arch/xtensa/src/esp32/esp32_cpuidlestack.c +++ b/arch/xtensa/src/esp32/esp32_cpuidlestack.c @@ -83,7 +83,7 @@ uint32_t g_cpu1_idlestack[CPU1_IDLETHREAD_STACKWORDS] * - 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 diff --git a/arch/z16/src/common/up_blocktask.c b/arch/z16/src/common/up_blocktask.c index 8328086de622b75e53dbc2e6b9fde822e465520a..0893c933e636ce02bd71662317d75423ef610b9e 100644 --- a/arch/z16/src/common/up_blocktask.c +++ b/arch/z16/src/common/up_blocktask.c @@ -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 diff --git a/arch/z16/src/common/up_createstack.c b/arch/z16/src/common/up_createstack.c index 2c35e68aef8e40c9bf28c181542b4a2874e44220..0bab2d3ab3621902a33c5948bb3e30265f823469 100644 --- a/arch/z16/src/common/up_createstack.c +++ b/arch/z16/src/common/up_createstack.c @@ -79,7 +79,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. diff --git a/arch/z16/src/common/up_releasestack.c b/arch/z16/src/common/up_releasestack.c index e0f4c4b27fe33a9a0a836ac8ac6af289298029f1..8d0698ecfdc9343869609413a93788c9100b89c9 100644 --- a/arch/z16/src/common/up_releasestack.c +++ b/arch/z16/src/common/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/z16/src/common/up_reprioritizertr.c b/arch/z16/src/common/up_reprioritizertr.c index d4fde47f31d7a94150486ed4db78c776c79c9c69..588ec4d68fd6414682b28659b5f3c081ba44ad2d 100644 --- a/arch/z16/src/common/up_reprioritizertr.c +++ b/arch/z16/src/common/up_reprioritizertr.c @@ -69,7 +69,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 * diff --git a/arch/z16/src/common/up_stackframe.c b/arch/z16/src/common/up_stackframe.c index 6a2fe6d3476cdb9cdfad44943c85df7b22107051..1bed013d99590e313f0ef41e676a9f7d3af24ac6 100644 --- a/arch/z16/src/common/up_stackframe.c +++ b/arch/z16/src/common/up_stackframe.c @@ -97,7 +97,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. * diff --git a/arch/z16/src/common/up_unblocktask.c b/arch/z16/src/common/up_unblocktask.c index d9de4e43b95030761a314d7869f5ffea4f033f25..2b09dbc301ca0b9e757e76ef526e79fc36be32f2 100644 --- a/arch/z16/src/common/up_unblocktask.c +++ b/arch/z16/src/common/up_unblocktask.c @@ -62,7 +62,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 diff --git a/arch/z16/src/common/up_usestack.c b/arch/z16/src/common/up_usestack.c index d65609a67d0cae50da5ce0f309f0b998c26694b3..044ecdc3474924c8c6c545e6417c7a93553bf8f7 100644 --- a/arch/z16/src/common/up_usestack.c +++ b/arch/z16/src/common/up_usestack.c @@ -78,7 +78,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. * diff --git a/arch/z16/src/z16f/z16f_espi.c b/arch/z16/src/z16f/z16f_espi.c index da5b88611ee4d22fb3eb8feb7603d5dc2f5be3eb..2a590d96133defc15ca8b0cb28d7f9404095a60e 100644 --- a/arch/z16/src/z16f/z16f_espi.c +++ b/arch/z16/src/z16f/z16f_espi.c @@ -788,7 +788,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 - Identifies the "logical" SPI port. Must be zero in this case. * * Returned Value: diff --git a/arch/z16/src/z16f/z16f_lowuart.S b/arch/z16/src/z16f/z16f_lowuart.S index ef7c31a6ca4872f4d48be3cee53911625baab5f9..0a893d758583dce81db6aaf5a8397483d2520bc0 100644 --- a/arch/z16/src/z16f/z16f_lowuart.S +++ b/arch/z16/src/z16f/z16f_lowuart.S @@ -191,7 +191,7 @@ _up_lowputc: * Parameters: * r1 = character * - * Return: + * Returned Value: * None * * Modifies r0 @@ -230,7 +230,7 @@ _z16f_xmitc1: * Parmeters: * None * - * Return + * Returned Value: * R0 = Character read * *************************************************************************/ diff --git a/arch/z80/src/common/up_blocktask.c b/arch/z80/src/common/up_blocktask.c index a4aa7b8ed507c28b6f84b03dd56cd6e9445ea59a..6910c87b08edb829efa201610ed85fa93db1f7dd 100644 --- a/arch/z80/src/common/up_blocktask.c +++ b/arch/z80/src/common/up_blocktask.c @@ -63,7 +63,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 diff --git a/arch/z80/src/common/up_createstack.c b/arch/z80/src/common/up_createstack.c index a0a2bc2507d029d3a0fd996d2736c10e2b466171..388cfb184d3e8e616d667891d763f7df385d42ee 100644 --- a/arch/z80/src/common/up_createstack.c +++ b/arch/z80/src/common/up_createstack.c @@ -78,7 +78,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. diff --git a/arch/z80/src/common/up_releasestack.c b/arch/z80/src/common/up_releasestack.c index 31237a3ee669a3750855fb37b1a6e5bbd2b36be3..5862240d1f9ab48d04ce6c22d73c0033ba1c459e 100644 --- a/arch/z80/src/common/up_releasestack.c +++ b/arch/z80/src/common/up_releasestack.c @@ -66,7 +66,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): diff --git a/arch/z80/src/common/up_reprioritizertr.c b/arch/z80/src/common/up_reprioritizertr.c index 04675918fdb2933ffe2bd9ed636d818c2d83b254..118ed179c5d329a43836f88ccafaeb44ec68aa01 100644 --- a/arch/z80/src/common/up_reprioritizertr.c +++ b/arch/z80/src/common/up_reprioritizertr.c @@ -71,7 +71,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 * diff --git a/arch/z80/src/common/up_stackframe.c b/arch/z80/src/common/up_stackframe.c index 8f4a0f180623672827930602707ca523647bce2a..60ad0851ce5378f1bf51bc07b19303613ad59044 100644 --- a/arch/z80/src/common/up_stackframe.c +++ b/arch/z80/src/common/up_stackframe.c @@ -88,7 +88,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. * diff --git a/arch/z80/src/common/up_unblocktask.c b/arch/z80/src/common/up_unblocktask.c index a27a8e1ddd0c9c38e600581856baa268968477f7..66f7337dc6408fbc7806c61771079cf14ca28708 100644 --- a/arch/z80/src/common/up_unblocktask.c +++ b/arch/z80/src/common/up_unblocktask.c @@ -64,7 +64,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 diff --git a/arch/z80/src/common/up_usestack.c b/arch/z80/src/common/up_usestack.c index dd82424d33fc22e0b348906a85f89b2d85f0c713..7c75a14419c7e46b96ff1fb4f0c052ddbada3827 100644 --- a/arch/z80/src/common/up_usestack.c +++ b/arch/z80/src/common/up_usestack.c @@ -77,7 +77,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. * diff --git a/arch/z80/src/ez80/ez80_i2c.c b/arch/z80/src/ez80/ez80_i2c.c index 6413a39d4b6bd860f28b1e44ce4a545cc9cd6c18..a7b7403e672038ece6846095850f675b78a9d5dd 100644 --- a/arch/z80/src/ez80/ez80_i2c.c +++ b/arch/z80/src/ez80/ez80_i2c.c @@ -929,7 +929,7 @@ static int ez80_i2c_transfer(FAR struct i2c_master_s *dev, * 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 mutiple I2C interfaces) * * Returned Value: diff --git a/arch/z80/src/ez80/ez80_spi.c b/arch/z80/src/ez80/ez80_spi.c index d7f14c7e015056ea0f14b28b7cc157b2eaaf4e6f..5f337d441ab2f7dfaa685b951e297bcdf2861f8f 100644 --- a/arch/z80/src/ez80/ez80_spi.c +++ b/arch/z80/src/ez80/ez80_spi.c @@ -438,7 +438,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t bu * 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: diff --git a/arch/z80/src/ez80/ez80f91_i2c.h b/arch/z80/src/ez80/ez80f91_i2c.h index b59d4ffc7b157d164e43d204dd6440f59461d1ba..a296eeab7089a745313e1b55a4e9710c543fc26e 100644 --- a/arch/z80/src/ez80/ez80f91_i2c.h +++ b/arch/z80/src/ez80/ez80f91_i2c.h @@ -150,7 +150,7 @@ extern "C" * 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: @@ -166,7 +166,7 @@ FAR struct i2c_master_s *ez80_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 ez80_i2cbus_initialize() * * Returned Value: diff --git a/arch/z80/src/ez80/ez80f91_spi.h b/arch/z80/src/ez80/ez80f91_spi.h index fe7c34bb7e49e3566de06cdbd8f743046f372e8f..0c49cad1d7b699209d1d93fbf58f1c57e97d894d 100644 --- a/arch/z80/src/ez80/ez80f91_spi.h +++ b/arch/z80/src/ez80/ez80f91_spi.h @@ -114,7 +114,7 @@ extern "C" * 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: diff --git a/arch/z80/src/z8/z8_i2c.c b/arch/z80/src/z8/z8_i2c.c index 465debc4037eb5812b51660a4f407a97ab84c982..599e6adb323bea81e23fd48eb664964d6fbea5ff 100644 --- a/arch/z80/src/z8/z8_i2c.c +++ b/arch/z80/src/z8/z8_i2c.c @@ -638,7 +638,7 @@ static int z8_i2c_reset(FAR struct i2c_master_s * dev) * 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 mutiple I2C interfaces) * * Returned Value: diff --git a/audio/audio.c b/audio/audio.c index e4acb10b895e70a0bcfb1e310ecdd1919abc993b..6149eb592bc499814b670a750d3bd1340bd597a2 100644 --- a/audio/audio.c +++ b/audio/audio.c @@ -680,7 +680,7 @@ static int audio_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * to enqueue additional buffers and "wake them up" for further * processing. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was provided to the lower-half * start() method. * apb - A pointer to the previsously enqueued ap_buffer_s @@ -767,7 +767,7 @@ static inline void audio_complete(FAR struct audio_upperhalf_s *upper, * Provides a callback interface for lower-half drivers to call to the * upper-half for buffer dequeueing, error reporting, etc. * - * Input parameters: + * Input Parameters: * priv - Private context data owned by the upper-half * reason - The reason code for the callback * apb - A pointer to the previsously enqueued ap_buffer_s @@ -854,7 +854,7 @@ static void audio_callback(FAR void *handle, uint16_t reason, * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name Audio drivers * based on the function they provide, such as "/dev/pcm0", "/dev/mp31", diff --git a/binfmt/binfmt.h b/binfmt/binfmt.h index cfde554d4e453f3262db9bed85b9e01685fd4a36..84775cfbd9f4391a30571e208676dd86e79d948a 100644 --- a/binfmt/binfmt.h +++ b/binfmt/binfmt.h @@ -78,7 +78,7 @@ EXTERN FAR struct binfmt_s *g_binfmts; * Description: * Dump the contents of struct binary_s. * - * Input Parameter: + * Input Parameters: * bin - Load structure * * Returned Value: @@ -101,7 +101,7 @@ int dump_module(FAR const struct binary_s *bin); * address environment of the new process address environment. So we * do not have any real option other than to copy the callers argv[] list. * - * Input Parameter: + * Input Parameters: * bin - Load structure * argv - Argument list * @@ -118,7 +118,7 @@ int binfmt_copyargv(FAR struct binary_s *bin, FAR char * const *argv); * Description: * Release the copied argv[] list. * - * Input Parameter: + * Input Parameters: * bin - Load structure * * Returned Value: diff --git a/binfmt/binfmt_copyargv.c b/binfmt/binfmt_copyargv.c index f0a594f5a6d20e2408aad0874d1a207852373aa5..c3f3dbcc083a772d562b25c34825933405b6c8f5 100644 --- a/binfmt/binfmt_copyargv.c +++ b/binfmt/binfmt_copyargv.c @@ -72,7 +72,7 @@ * address environment of the new process address environment. So we * do not have any real option other than to copy the callers argv[] list. * - * Input Parameter: + * Input Parameters: * bin - Load structure * argv - Argument list * @@ -167,7 +167,7 @@ int binfmt_copyargv(FAR struct binary_s *bin, FAR char * const *argv) * Description: * Release the copied argv[] list. * - * Input Parameter: + * Input Parameters: * binp - Load structure * * Returned Value: diff --git a/binfmt/binfmt_schedunload.c b/binfmt/binfmt_schedunload.c index e7b981d2feff071f8bd3211e36e13e68ed329b60..1996acd107544e0d27cad04f8ea978f4005cbd09 100644 --- a/binfmt/binfmt_schedunload.c +++ b/binfmt/binfmt_schedunload.c @@ -74,7 +74,7 @@ FAR struct binary_s *g_unloadhead; * * This function will add one structure to the linked list * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * bin - This structure must have been allocated with kmm_malloc() and must * persist until the task unloads @@ -117,7 +117,7 @@ static void unload_list_add(pid_t pid, FAR struct binary_s *bin) * * This function will remove one structure to the linked list * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * * Returned Value: @@ -184,7 +184,7 @@ static FAR struct binary_s *unload_list_remove(pid_t pid) * bin was allocated with kmm_malloc() or friends and will also automatically * free the structure with kmm_free() when the task exists. * - * Input Parameter: + * Input Parameters: * pid - The ID of the task that just exited * arg - A reference to the load structure cast to FAR void * * @@ -243,7 +243,7 @@ static void unload_callback(int signo, siginfo_t *info, void *ucontext) * or friends. It will also automatically free the structure with kmm_free() * after unloading the module. * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * bin - This structure must have been allocated with kmm_malloc() and must * persist until the task unloads diff --git a/configs/cloudctrl/src/stm32_usb.c b/configs/cloudctrl/src/stm32_usb.c index 7d7ea1732f3eb597f4470efac67bc9e5e290ff38..bf13400a5b804ca8dffb8d10ffdafb2e837ceb70 100644 --- a/configs/cloudctrl/src/stm32_usb.c +++ b/configs/cloudctrl/src/stm32_usb.c @@ -273,11 +273,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/dk-tm4c129x/include/board.h b/configs/dk-tm4c129x/include/board.h index 5279f43cf3264bd6efca01e6bd4c172eef5b179e..c52a8f3b3ef29ce94ebb15a0e841948fd2b14e05 100644 --- a/configs/dk-tm4c129x/include/board.h +++ b/configs/dk-tm4c129x/include/board.h @@ -255,7 +255,7 @@ * Description: * Initialize and register the TMP-100 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/dk-tm4c129x/src/tm4c_tmp100.c b/configs/dk-tm4c129x/src/tm4c_tmp100.c index 29ab1a9aeb1362723c7fcdb7ed4a4c34e96d0af2..0238c62bb5e0b88eb3e70343d976ead17728decc 100644 --- a/configs/dk-tm4c129x/src/tm4c_tmp100.c +++ b/configs/dk-tm4c129x/src/tm4c_tmp100.c @@ -68,7 +68,7 @@ * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/ea3131/src/lpc31_usbhost.c b/configs/ea3131/src/lpc31_usbhost.c index 81c8cfa866a32b2befe9baf7a24794a32cfc70e1..eee4f004decde2e6faec9f919920bb97a97e39e8 100644 --- a/configs/ea3131/src/lpc31_usbhost.c +++ b/configs/ea3131/src/lpc31_usbhost.c @@ -286,11 +286,11 @@ void lpc31_usbhost_vbusdrive(int rhport, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument that will accompany the interrupt * - * Returned value: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on failure. * ************************************************************************************/ diff --git a/configs/freedom-kl25z/src/kl_cc3000.c b/configs/freedom-kl25z/src/kl_cc3000.c index e233a64d062f16223ba31159b02be995d4abe089..c446ff870b6956fb33b51f63755917daedc225f3 100644 --- a/configs/freedom-kl25z/src/kl_cc3000.c +++ b/configs/freedom-kl25z/src/kl_cc3000.c @@ -334,7 +334,7 @@ int wireless_archinitialize(size_t max_rx_size) * Warning: This function must be called before ANY other wlan driver * function * - * Input Parmeters: + * Input Parameters: * sWlanCB Asynchronous events callback. * 0 no event call back. * - Call back parameters: diff --git a/configs/freedom-kl25z/src/kl_spi.c b/configs/freedom-kl25z/src/kl_spi.c index e952963d1be54d780787f9685ad40c56e85b2bcf..566af53909b282b95b4fbfb46bb0a76754218d77 100644 --- a/configs/freedom-kl25z/src/kl_spi.c +++ b/configs/freedom-kl25z/src/kl_spi.c @@ -133,7 +133,7 @@ void weak_function kl_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -182,7 +182,7 @@ void kl_spi1select(FAR struct spi_dev_s *dev, uint32_t devid, * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -213,7 +213,7 @@ uint8_t kl_spi1status(FAR struct spi_dev_s *dev, uint32_t devid) * devid - Identifies the (logical) device * cmd - Determines where command or data should be selected. * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/freedom-kl26z/src/kl_spi.c b/configs/freedom-kl26z/src/kl_spi.c index 4c94db9fa3098019654161242ccfbb95872b5738..01cb52fc912efa632680851155e5d320226d368d 100644 --- a/configs/freedom-kl26z/src/kl_spi.c +++ b/configs/freedom-kl26z/src/kl_spi.c @@ -124,7 +124,7 @@ void weak_function kl_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -156,7 +156,7 @@ void kl_spi1select(FAR struct spi_dev_s *dev, uint32_t devid, * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -187,7 +187,7 @@ uint8_t kl_spi1status(FAR struct spi_dev_s *dev, uint32_t devid) * devid - Identifies the (logical) device * cmd - Determines where command or data should be selected. * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/indium-f7/src/stm32_usb.c b/configs/indium-f7/src/stm32_usb.c index 63d3d5530b20ae59a8f9ce3d32f8416dbec66fc9..9089232cec761d2d6510c4e2574e5ceb689b716c 100644 --- a/configs/indium-f7/src/stm32_usb.c +++ b/configs/indium-f7/src/stm32_usb.c @@ -295,11 +295,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/mcu123-lpc214x/src/lpc2148_spi1.c b/configs/mcu123-lpc214x/src/lpc2148_spi1.c index a5001a5a0c26fff96ee6dee3e704891695b1d4e2..8a4675fc9c7bd6ff6e93175a270c9996b97ec244 100644 --- a/configs/mcu123-lpc214x/src/lpc2148_spi1.c +++ b/configs/mcu123-lpc214x/src/lpc2148_spi1.c @@ -525,7 +525,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: diff --git a/configs/mikroe-stm32f4/src/stm32_pm.c b/configs/mikroe-stm32f4/src/stm32_pm.c index c5f89f50abbdb9f9655bdd3bb187273fa138925b..4ff3d14badd7c162458bcabd48b4cd1f75dad955 100644 --- a/configs/mikroe-stm32f4/src/stm32_pm.c +++ b/configs/mikroe-stm32f4/src/stm32_pm.c @@ -78,10 +78,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/configs/mikroe-stm32f4/src/stm32_usb.c b/configs/mikroe-stm32f4/src/stm32_usb.c index f6114e62b769c8c743416b2b807a6211e7884b3f..e242c690604b2bf28f94a31e6e46e590ed7b6912 100644 --- a/configs/mikroe-stm32f4/src/stm32_usb.c +++ b/configs/mikroe-stm32f4/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/nucleo-144/src/stm32_usb.c b/configs/nucleo-144/src/stm32_usb.c index 00fdaa94156d814660cf75498d4c0ad836a51623..82118d87fac40f578fd190bb00457339c6ab8d61 100644 --- a/configs/nucleo-144/src/stm32_usb.c +++ b/configs/nucleo-144/src/stm32_usb.c @@ -294,11 +294,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/nucleo-f303re/src/nucleo-f303re.h b/configs/nucleo-f303re/src/nucleo-f303re.h index e11495f5f151437efce03975ab336fe790f8ece2..f5ee979d7aa1db82099bffdcbb8c4106b1d53b15 100644 --- a/configs/nucleo-f303re/src/nucleo-f303re.h +++ b/configs/nucleo-f303re/src/nucleo-f303re.h @@ -145,7 +145,7 @@ void weak_function stm32_spidev_initialize(void); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-f303re/src/stm32_timer.c b/configs/nucleo-f303re/src/stm32_timer.c index fd82bb6d4f7d64ab5a99ae7a421002846ea858e8..a13edd2943c7fa8db1b28d52c3ed7ba013c3a636 100644 --- a/configs/nucleo-f303re/src/stm32_timer.c +++ b/configs/nucleo-f303re/src/stm32_timer.c @@ -68,7 +68,7 @@ * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-f334r8/src/nucleo-f334r8.h b/configs/nucleo-f334r8/src/nucleo-f334r8.h index 4b2929f8aac18d730712c67494d713b208b11115..463f20cb24de4401d8cb516a9b5ddd52a5d272c3 100644 --- a/configs/nucleo-f334r8/src/nucleo-f334r8.h +++ b/configs/nucleo-f334r8/src/nucleo-f334r8.h @@ -132,7 +132,7 @@ void weak_function stm32_spidev_initialize(void); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-l432kc/src/stm32_timer.c b/configs/nucleo-l432kc/src/stm32_timer.c index 8750ba76b9f2f35b299e03f00ebf9ce6b9c2a142..f7183936d66c1e1af31fb7a1ce20ab44ca40389e 100644 --- a/configs/nucleo-l432kc/src/stm32_timer.c +++ b/configs/nucleo-l432kc/src/stm32_timer.c @@ -68,7 +68,7 @@ * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-l476rg/src/stm32_timer.c b/configs/nucleo-l476rg/src/stm32_timer.c index 2d6f83835ee1e99656c2a0ff218cc5ae6a25ffe7..9f578b5bc6b2459d5bc83e6d599f574d1b36936e 100644 --- a/configs/nucleo-l476rg/src/stm32_timer.c +++ b/configs/nucleo-l476rg/src/stm32_timer.c @@ -68,7 +68,7 @@ * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/nucleo-l496zg/src/stm32_usb.c b/configs/nucleo-l496zg/src/stm32_usb.c index 50ecd74de4e16dca17c6d932ea6d0ddf48c01587..a5a0937b05922867c45a5ee2c5826a92a4ca4f80 100644 --- a/configs/nucleo-l496zg/src/stm32_usb.c +++ b/configs/nucleo-l496zg/src/stm32_usb.c @@ -294,11 +294,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-lpc-h3131/include/board.h b/configs/olimex-lpc-h3131/include/board.h index a411461668bda0a948d5d7c2506afe113ba069c1..2b9ace582b0a93c87d4292eaa94da13f71df3f23 100644 --- a/configs/olimex-lpc-h3131/include/board.h +++ b/configs/olimex-lpc-h3131/include/board.h @@ -174,11 +174,11 @@ extern "C" * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument that will accompany the interrupt * - * Returned value: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on failure. * ************************************************************************************/ diff --git a/configs/olimex-lpc-h3131/src/lpc31_usbhost.c b/configs/olimex-lpc-h3131/src/lpc31_usbhost.c index 37c08d5c43bdc49b825ed177ba405d28234919b4..f267b235e76ac1667945cc568c0127f90612bcb1 100644 --- a/configs/olimex-lpc-h3131/src/lpc31_usbhost.c +++ b/configs/olimex-lpc-h3131/src/lpc31_usbhost.c @@ -293,11 +293,11 @@ void lpc31_usbhost_vbusdrive(int rhport, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument that will accompany the interrupt * - * Returned value: + * Returned Value: * Zero (OK) returned on success; a negated errno value is returned on failure. * ************************************************************************************/ diff --git a/configs/olimex-stm32-e407/src/stm32_usb.c b/configs/olimex-stm32-e407/src/stm32_usb.c index fc0b45a4db9cad5ca3e4b5b71ed86da6ee80468d..5e28e17faa5a1da67b033682e74348b1a2330fc2 100644 --- a/configs/olimex-stm32-e407/src/stm32_usb.c +++ b/configs/olimex-stm32-e407/src/stm32_usb.c @@ -301,11 +301,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-stm32-h407/src/stm32_usb.c b/configs/olimex-stm32-h407/src/stm32_usb.c index 6c2cf52e5de61ed39ba1aa97b001cbea72fc77eb..584e8c0a4e31c162f585ab8a45fbe94802b2ff95 100644 --- a/configs/olimex-stm32-h407/src/stm32_usb.c +++ b/configs/olimex-stm32-h407/src/stm32_usb.c @@ -283,7 +283,7 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-stm32-p207/src/stm32_usb.c b/configs/olimex-stm32-p207/src/stm32_usb.c index da898fd74da574fc7745eed14285c0326902beb4..8195a326d28f58cb435dddba62a409182f9e015b 100644 --- a/configs/olimex-stm32-p207/src/stm32_usb.c +++ b/configs/olimex-stm32-p207/src/stm32_usb.c @@ -237,11 +237,11 @@ int stm32_usbhost_initialize(void) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-stm32-p407/src/stm32_usb.c b/configs/olimex-stm32-p407/src/stm32_usb.c index 2f0c652f0a69294a5668b9d17267574cede2d293..428b44af6248d58d6ca294312d92345ca5ee4445 100644 --- a/configs/olimex-stm32-p407/src/stm32_usb.c +++ b/configs/olimex-stm32-p407/src/stm32_usb.c @@ -300,11 +300,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/olimex-strp711/src/str71_spi.c b/configs/olimex-strp711/src/str71_spi.c index 1c18a4e5536ee1c7cc08d6a0548b18bd395572b9..f73dc744d511bd66f84bd740a8fc63604960bdc6 100644 --- a/configs/olimex-strp711/src/str71_spi.c +++ b/configs/olimex-strp711/src/str71_spi.c @@ -952,7 +952,7 @@ static void spi_recvblock(FAR struct spi_dev_s *dev, FAR void *buffer, size_t bu * Initialize the selected SPI port. This function could get called * multiple times for each STR7 devices that needs an SPI reference. * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has mutiple SPI interfaces) * * Returned Value: diff --git a/configs/olimexino-stm32/src/olimexino-stm32.h b/configs/olimexino-stm32/src/olimexino-stm32.h index 987c55c00f76913a038456726c5c67b43d5b0797..c3383eb8a2fb4f52441c280d248cde21f8222615 100644 --- a/configs/olimexino-stm32/src/olimexino-stm32.h +++ b/configs/olimexino-stm32/src/olimexino-stm32.h @@ -163,7 +163,7 @@ void stm32_usbinitialize(void); * Description: * Called to setup set a call back for USB power state changes. * - * Inputs: + * Input Parameters: * pwr_changed_handler: An interrupt handler that will be called on VBUS power * state changes. * diff --git a/configs/olimexino-stm32/src/stm32_usbdev.c b/configs/olimexino-stm32/src/stm32_usbdev.c index 148ae44312950c9bb3f53d677e09641c2c07753a..a2814fc361f6e4b0d4ebd16e079d9657e5dbe005 100644 --- a/configs/olimexino-stm32/src/stm32_usbdev.c +++ b/configs/olimexino-stm32/src/stm32_usbdev.c @@ -69,7 +69,7 @@ * Name: stm32_usb_set_pwr_callback() * * Description: - * Inputs: + * Input Parameters: * pwr_changed_handler: An interrupt handler that will be called on VBUS power * state changes. * diff --git a/configs/photon/src/photon.h b/configs/photon/src/photon.h index f98c223341f26e46ff2e0706570cc445cbad4f21..5b2412f7e029ee765b6ba1f7b6e9ea7bbedbf551 100644 --- a/configs/photon/src/photon.h +++ b/configs/photon/src/photon.h @@ -120,7 +120,7 @@ void weak_function stm32_spidev_initialize(void); * Description: * Perform architecture-specific initialization of the Watchdog hardware. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -138,7 +138,7 @@ int photon_watchdog_initialize(void); * Description: * Initialize wlan hardware and driver for Photon board. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/sam3u-ek/src/sam_spi.c b/configs/sam3u-ek/src/sam_spi.c index a6a08e70905f5b063d81e523992f668d5a992dda..7813f8da7aab0bf39c2cb4903a56acb6fcb430a6 100644 --- a/configs/sam3u-ek/src/sam_spi.c +++ b/configs/sam3u-ek/src/sam_spi.c @@ -133,7 +133,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -165,7 +165,7 @@ void sam_spi0select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sam4e-ek/src/sam_spi.c b/configs/sam4e-ek/src/sam_spi.c index 340210ec8c94f287cb22e105cc526d55d79cb467..715f97ce735e8772ca1881d6fb78995fdfbf75e0 100644 --- a/configs/sam4e-ek/src/sam_spi.c +++ b/configs/sam4e-ek/src/sam_spi.c @@ -135,7 +135,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -180,7 +180,7 @@ void sam_spi0select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sam4l-xplained/src/sam_spi.c b/configs/sam4l-xplained/src/sam_spi.c index a6eeee18a21d8a96004260aa9611f74cae8899fb..70787cc011d97a7c6de4a3d71b199fec2859e088 100644 --- a/configs/sam4l-xplained/src/sam_spi.c +++ b/configs/sam4l-xplained/src/sam_spi.c @@ -135,7 +135,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -178,7 +178,7 @@ void sam_spi0select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -225,7 +225,7 @@ uint8_t sam_spi0status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h b/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h index a20eb969deb67155104a0e7a7394cf259bfd02da..e6baf02f1de9e0e4dbe37cc87462427152edd803 100644 --- a/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h +++ b/configs/sam4s-xplained-pro/src/sam4s-xplained-pro.h @@ -221,7 +221,7 @@ bool sam_writeprotected(int slotno); * Description: * Perform architecture-specific initialization of the Watchdog hardware. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/sama5d3-xplained/src/sam_nandflash.c b/configs/sama5d3-xplained/src/sam_nandflash.c index 69157cc3faa7a251d93a51608b1f4dbd5ac9a32c..f53fa352d9f8d26f036c01a491881b5eadadac4c 100644 --- a/configs/sama5d3-xplained/src/sam_nandflash.c +++ b/configs/sama5d3-xplained/src/sam_nandflash.c @@ -91,7 +91,7 @@ * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/configs/sama5d3-xplained/src/sam_spi.c b/configs/sama5d3-xplained/src/sam_spi.c index a4e1b3d95da0e4bdbead690eead2d53570452fb8..ce4bfb64038e5eb9cb6b033d5b213bef9f95565e 100644 --- a/configs/sama5d3-xplained/src/sam_spi.c +++ b/configs/sama5d3-xplained/src/sam_spi.c @@ -134,7 +134,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -168,7 +168,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sama5d3-xplained/src/sam_usb.c b/configs/sama5d3-xplained/src/sam_usb.c index 3189e94774231bb5ba518041faa5fdb770fbf699..8abe5f5493e90739d6ca12b1b9cccf6727b6fa05 100644 --- a/configs/sama5d3-xplained/src/sam_usb.c +++ b/configs/sama5d3-xplained/src/sam_usb.c @@ -487,10 +487,10 @@ void sam_usbhost_vbusdrive(int rhport, bool enable) * REVISIT: Since this is a common signal, we will need to come up with some way * to inform both EHCI and OHCI drivers when this error occurs. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * - * Returned value: + * Returned Value: * Old overcurrent interrupt handler * ************************************************************************************/ diff --git a/configs/sama5d3x-ek/src/sam_nandflash.c b/configs/sama5d3x-ek/src/sam_nandflash.c index 50c327e9f3e9109515fa10a2c2ea3f60f5c7d56e..e212a7f27498e580032016e118e59fcefdf2925c 100644 --- a/configs/sama5d3x-ek/src/sam_nandflash.c +++ b/configs/sama5d3x-ek/src/sam_nandflash.c @@ -91,7 +91,7 @@ * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/configs/sama5d3x-ek/src/sam_spi.c b/configs/sama5d3x-ek/src/sam_spi.c index c9827f9a77d82eb27bd016b5b1a44179237b69c9..be4c0e322b867f05998d0a92f62ac6bd3d4928a9 100644 --- a/configs/sama5d3x-ek/src/sam_spi.c +++ b/configs/sama5d3x-ek/src/sam_spi.c @@ -134,7 +134,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -168,7 +168,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sama5d3x-ek/src/sam_usb.c b/configs/sama5d3x-ek/src/sam_usb.c index 4607f641feed1913a34e38a69815725a852085c0..614b6c31e24ef5a44b81632dafa016e4422c5279 100644 --- a/configs/sama5d3x-ek/src/sam_usb.c +++ b/configs/sama5d3x-ek/src/sam_usb.c @@ -479,10 +479,10 @@ void sam_usbhost_vbusdrive(int rhport, bool enable) * REVISIT: Since this is a common signal, we will need to come up with some way * to inform both EHCI and OHCI drivers when this error occurs. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * - * Returned value: + * Returned Value: * Old overcurrent interrupt handler * ************************************************************************************/ diff --git a/configs/sama5d4-ek/src/sam_nandflash.c b/configs/sama5d4-ek/src/sam_nandflash.c index 6a5c90db285a11e0624f1290df8dea3595a3902d..467ac8b106fcf287252229d2bd751f93a6f08e15 100644 --- a/configs/sama5d4-ek/src/sam_nandflash.c +++ b/configs/sama5d4-ek/src/sam_nandflash.c @@ -91,7 +91,7 @@ * cs - Chip select number (in the event that multiple NAND devices * are connected on-board). * - * Returned Values: + * Returned Value: * OK if the HSMC was successfully configured for this CS. A negated * errno value is returned on a failure. This would fail with -ENODEV, * for example, if the board does not support NAND FLASH on the requested diff --git a/configs/sama5d4-ek/src/sam_spi.c b/configs/sama5d4-ek/src/sam_spi.c index 7534e373b1b59032bd9ebfdb16ae723d0e467793..611378c462ade2677f7ef129d4e6b4e1c5c0dc45 100644 --- a/configs/sama5d4-ek/src/sam_spi.c +++ b/configs/sama5d4-ek/src/sam_spi.c @@ -134,7 +134,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -168,7 +168,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/sama5d4-ek/src/sam_usb.c b/configs/sama5d4-ek/src/sam_usb.c index d6923ea70a5da6e85d9894c1eeeb4bde55ae8093..081197a7fadbe332341277e9346ae8196c56bdf2 100644 --- a/configs/sama5d4-ek/src/sam_usb.c +++ b/configs/sama5d4-ek/src/sam_usb.c @@ -483,7 +483,7 @@ void sam_usbhost_vbusdrive(int rhport, bool enable) * Input Parameters: * handler - New over-current interrupt handler * - * Returned value: + * Returned Value: * Old over-current interrupt handler * ************************************************************************************/ diff --git a/configs/samd20-xplained/src/sam_spi.c b/configs/samd20-xplained/src/sam_spi.c index 2367243fe54038d1baa12b464c46e415c584a9b3..0a15fa4d358df066b7ca0ab9f8fbe9606fcf10a9 100644 --- a/configs/samd20-xplained/src/sam_spi.c +++ b/configs/samd20-xplained/src/sam_spi.c @@ -142,7 +142,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -241,7 +241,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -340,7 +340,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/samd21-xplained/src/sam_spi.c b/configs/samd21-xplained/src/sam_spi.c index 32dbdb62bbaf3044057f6bc537c407386b9ffaf5..624fc59bbaa0f53a8bf96a5b6f2b4360ccdce445 100644 --- a/configs/samd21-xplained/src/sam_spi.c +++ b/configs/samd21-xplained/src/sam_spi.c @@ -142,7 +142,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -241,7 +241,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -340,7 +340,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/same70-xplained/src/sam_spi.c b/configs/same70-xplained/src/sam_spi.c index a9095c462d206aa4585469055d289d5ffdc16521..57bde8904d5ebba4e8a697c7e4101c880895d378 100644 --- a/configs/same70-xplained/src/sam_spi.c +++ b/configs/same70-xplained/src/sam_spi.c @@ -146,7 +146,7 @@ void sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -204,7 +204,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/saml21-xplained/src/sam_spi.c b/configs/saml21-xplained/src/sam_spi.c index 576444508d1ef9c09989179a9ae191a495e88d87..ff654a2d3052872e9c4cd534e3170dcdfbd50f6e 100644 --- a/configs/saml21-xplained/src/sam_spi.c +++ b/configs/saml21-xplained/src/sam_spi.c @@ -142,7 +142,7 @@ void weak_function sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -241,7 +241,7 @@ void sam_spi5select(FAR struct spi_dev_s *dev, uint32_t devid, * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -340,7 +340,7 @@ uint8_t sam_spi5status(FAR struct spi_dev_s *dev, uint32_t devid) * dev - SPI device info * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Zero on success; a negated errno on failure. * ****************************************************************************/ diff --git a/configs/samv71-xult/src/sam_spi.c b/configs/samv71-xult/src/sam_spi.c index 563c03965c9c17e97e784cffaa2663e88d4dc37c..e7e2271f9f14c13ca2e4325822ba75d1b4663760 100644 --- a/configs/samv71-xult/src/sam_spi.c +++ b/configs/samv71-xult/src/sam_spi.c @@ -151,7 +151,7 @@ void sam_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -197,7 +197,7 @@ void sam_spi1select(uint32_t devid, bool selected) * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/shenzhou/src/stm32_usb.c b/configs/shenzhou/src/stm32_usb.c index 91bbe8d84679ea234e671483abae38fada9ee69a..a45f43a83f437b5f67626f5a3bc7b33db1410daa 100644 --- a/configs/shenzhou/src/stm32_usb.c +++ b/configs/shenzhou/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/spark/src/stm32_cc3000.c b/configs/spark/src/stm32_cc3000.c index 92d255d6d9db835c08b23f80e3e532dcb80f4268..8cda9fb6020427ff00e736fdf06f0faad017ce58 100644 --- a/configs/spark/src/stm32_cc3000.c +++ b/configs/spark/src/stm32_cc3000.c @@ -327,7 +327,7 @@ int wireless_archinitialize(size_t max_rx_size) * Warning: This function must be called before ANY other wlan driver * function * - * Input Parmeters: + * Input Parameters: * sWlanCB Asynchronous events callback. * 0 no event call back. * - Call back parameters: diff --git a/configs/stm3210e-eval/include/board.h b/configs/stm3210e-eval/include/board.h index f76389222b7973fe769bd85c2cca7fbdcabd467e..d03816b43992fdd5690cceb6bc0e62e0194ee074 100644 --- a/configs/stm3210e-eval/include/board.h +++ b/configs/stm3210e-eval/include/board.h @@ -261,7 +261,7 @@ void stm3210e_lcdclear(uint16_t color); * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: @@ -279,7 +279,7 @@ int stm32_lm75initialize(FAR const char *devpath); * Description: * Attach the LM-75 interrupt handler * - * Input parameters: + * Input Parameters: * irqhandler - the LM-75 interrupt handler * arg - The argument that will accompany the interrupt * diff --git a/configs/stm3210e-eval/src/stm32_lm75.c b/configs/stm3210e-eval/src/stm32_lm75.c index a083b7838300cc8b28fc31772d2dbef6bd8053d8..52b04c495bed30625486e3a29d6dc4d4483b2354 100644 --- a/configs/stm3210e-eval/src/stm32_lm75.c +++ b/configs/stm3210e-eval/src/stm32_lm75.c @@ -60,7 +60,7 @@ * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: @@ -104,7 +104,7 @@ int stm32_lm75initialize(FAR const char *devpath) * Description: * Attach the LM-75 interrupt handler * - * Input parameters: + * Input Parameters: * irqhandler - the LM-75 interrupt handler * arg - The argument that will accompany the interrupt * diff --git a/configs/stm3210e-eval/src/stm32_pm.c b/configs/stm3210e-eval/src/stm32_pm.c index 1da3078a9c2b698c7c5f8cc66bb117e2f84ae48e..7c7b13f4b93eb89f658a468f177e3ffd836c1b91 100644 --- a/configs/stm3210e-eval/src/stm32_pm.c +++ b/configs/stm3210e-eval/src/stm32_pm.c @@ -78,10 +78,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/configs/stm3220g-eval/src/stm32_usb.c b/configs/stm3220g-eval/src/stm32_usb.c index 328aad2471a3135375b9e91f73b1bfd0ea7560a5..71474fa5ce13e41841c5ba6408bffdce389f0635 100644 --- a/configs/stm3220g-eval/src/stm32_usb.c +++ b/configs/stm3220g-eval/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm3240g-eval/src/stm32_usb.c b/configs/stm3240g-eval/src/stm32_usb.c index e89cf8116f4d6eb35df3c325cfd024d158c4e801..eb1e60d951155376d994c7eaf72bd9f188f2a9bc 100644 --- a/configs/stm3240g-eval/src/stm32_usb.c +++ b/configs/stm3240g-eval/src/stm32_usb.c @@ -272,11 +272,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32butterfly2/src/stm32_boot.c b/configs/stm32butterfly2/src/stm32_boot.c index f42e7a7fd7f788d120d89e38cc0133e965ad8e35..928b558633f4dc4c288d812b56d5553f859440a8 100644 --- a/configs/stm32butterfly2/src/stm32_boot.c +++ b/configs/stm32butterfly2/src/stm32_boot.c @@ -66,7 +66,7 @@ void stm32_boardinitialize(void) * Description: * Initializes upper half drivers with board specific settings * - * Returned value: + * Returned Value: * 0 on sucess or errno value of failed init function. ****************************************************************************/ diff --git a/configs/stm32butterfly2/src/stm32_leds.c b/configs/stm32butterfly2/src/stm32_leds.c index dae6352fa7b7d79e0f641082e3bc84a473bd9e36..4fced6d597839887c4a5e89fa1afe57bed312749 100644 --- a/configs/stm32butterfly2/src/stm32_leds.c +++ b/configs/stm32butterfly2/src/stm32_leds.c @@ -130,7 +130,7 @@ void stm32_led_initialize(void) * Description: * Drives board leds when specific RTOS state led occurs. * - * Input parameters: + * Input Parameters: * led - This is actually an RTOS state not led number of anything like that ****************************************************************************/ @@ -173,7 +173,7 @@ void board_autoled_on(int led) * Description: * Drives board leds when specific RTOS state led ends * - * Input parameters: + * Input Parameters: * led - This is actually an RTOS state not led number of anything like that ****************************************************************************/ @@ -225,7 +225,7 @@ void board_userled_initialize(void) * Description: * Sets led to ledon state. * - * Input parameters: + * Input Parameters: * led - Led to be set, indexed from 0 * ledon - new state for the led. ****************************************************************************/ @@ -251,7 +251,7 @@ void board_userled(int led, bool ledon) * Description: * Sets whole ledset to given state. * - * Input parameters: + * Input Parameters: * ledset - Led bits to be set on or off ****************************************************************************/ diff --git a/configs/stm32f103-minimum/src/stm32_apa102.c b/configs/stm32f103-minimum/src/stm32_apa102.c index 32717b212bd47ac5639734fb93f37fb8a95250bc..88c5a5ae49ffcbbd5c17120b68ce39cad69cc625 100644 --- a/configs/stm32f103-minimum/src/stm32_apa102.c +++ b/configs/stm32f103-minimum/src/stm32_apa102.c @@ -68,7 +68,7 @@ * Description: * Initialize and register the APA102 LED Strip driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/leddrv0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_apds9960.c b/configs/stm32f103-minimum/src/stm32_apds9960.c index 14045df518d848224add9fc8b6e633b8cb345578..614cbcf45db5c9d25804ed55703a3b0e41fd65cd 100644 --- a/configs/stm32f103-minimum/src/stm32_apds9960.c +++ b/configs/stm32f103-minimum/src/stm32_apds9960.c @@ -136,7 +136,7 @@ static int apds9960_irq_attach(FAR struct apds9960_config_s *state, xcpt_t isr, * Description: * Initialize and register the APDS9960 gesture sensor. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/gest0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_lm75.c b/configs/stm32f103-minimum/src/stm32_lm75.c index 7cd9b2422ee5ebe4aab431a4332bf71c11ce1d00..75e193354fac6eb0d064733a429bdda945a16b3f 100644 --- a/configs/stm32f103-minimum/src/stm32_lm75.c +++ b/configs/stm32f103-minimum/src/stm32_lm75.c @@ -60,7 +60,7 @@ * Description: * Initialize and register the LM-75 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: @@ -104,7 +104,7 @@ int stm32_lm75initialize(FAR const char *devpath) * Description: * Attach the LM-75 interrupt handler * - * Input parameters: + * Input Parameters: * irqhandler - the LM-75 interrupt handler * arg - The argument that will accompany the interrupt * diff --git a/configs/stm32f103-minimum/src/stm32_mcp2515.c b/configs/stm32f103-minimum/src/stm32_mcp2515.c index 739cfe884a93c3ea2246d428931270cd035a60c3..a7794603fd1c9c18a97f79d925912777c971acf1 100644 --- a/configs/stm32f103-minimum/src/stm32_mcp2515.c +++ b/configs/stm32f103-minimum/src/stm32_mcp2515.c @@ -173,7 +173,7 @@ static int mcp2515_attach(FAR struct mcp2515_config_s *state, * Description: * Initialize and register the MCP2515 RFID driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/rfid0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_mfrc522.c b/configs/stm32f103-minimum/src/stm32_mfrc522.c index 441bc5a6fa204122c426e7fb91610e6800371611..5fc1db4b4b178f6f985eb44bfd664e828105716c 100644 --- a/configs/stm32f103-minimum/src/stm32_mfrc522.c +++ b/configs/stm32f103-minimum/src/stm32_mfrc522.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MFRC522 RFID driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/rfid0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_nrf24l01.c b/configs/stm32f103-minimum/src/stm32_nrf24l01.c index 6edecba0e010b5ebb99eba7f3fcf77de075a3c9c..34bf775091dd9a5429837f3a2f52bb9f82fac861 100644 --- a/configs/stm32f103-minimum/src/stm32_nrf24l01.c +++ b/configs/stm32f103-minimum/src/stm32_nrf24l01.c @@ -105,7 +105,7 @@ static void stm32tiny_wl_chip_enable(bool enable) * Description: * Initialize the NRF24L01 wireless module * - * Input Parmeters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32_veml6070.c b/configs/stm32f103-minimum/src/stm32_veml6070.c index 5e8765e9e713073940a85f1e8b3a3cb176f6ccc2..8a84517f2f7f2081c2abc01a55e5d23bec8ffe42 100644 --- a/configs/stm32f103-minimum/src/stm32_veml6070.c +++ b/configs/stm32f103-minimum/src/stm32_veml6070.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the VEML6070 UV-A Light sensor. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/uvlight0" * * Returned Value: diff --git a/configs/stm32f103-minimum/src/stm32f103_minimum.h b/configs/stm32f103-minimum/src/stm32f103_minimum.h index f3159c7eacee0825be1354f17da754eb70a15294..18b6a5e41bd705f4f626167a69f662df4a7d422b 100644 --- a/configs/stm32f103-minimum/src/stm32f103_minimum.h +++ b/configs/stm32f103-minimum/src/stm32f103_minimum.h @@ -402,7 +402,7 @@ int stm32_pwm_setup(void); * Description: * Initialize the NRF24L01 wireless module * - * Input Parmeters: + * Input Parameters: * None * * Returned Value: diff --git a/configs/stm32f334-disco/src/stm32f334-disco.h b/configs/stm32f334-disco/src/stm32f334-disco.h index 904c8acc10d45673f232f45ba37e92e0f2f90e90..085d5abe1476d63b2e957028cff61546b930c023 100644 --- a/configs/stm32f334-disco/src/stm32f334-disco.h +++ b/configs/stm32f334-disco/src/stm32f334-disco.h @@ -113,7 +113,7 @@ void weak_function stm32_spidev_initialize(void); * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/stm32f411e-disco/src/stm32_usb.c b/configs/stm32f411e-disco/src/stm32_usb.c index 223fb949328191466dfaed1fda31ff10bb6ed665..2e2861a4cf392cec8475662c926b793ac25d7795 100644 --- a/configs/stm32f411e-disco/src/stm32_usb.c +++ b/configs/stm32f411e-disco/src/stm32_usb.c @@ -312,11 +312,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32f429i-disco/src/stm32_l3gd20.c b/configs/stm32f429i-disco/src/stm32_l3gd20.c index 7a8c449c6240877a0bb00ae4da5c8be4c03bee80..1dcd99c1b355f903fafd60b2699e4df051e92c0b 100644 --- a/configs/stm32f429i-disco/src/stm32_l3gd20.c +++ b/configs/stm32f429i-disco/src/stm32_l3gd20.c @@ -100,7 +100,7 @@ static int l3gd20_attach(FAR struct l3gd20_config_s *cfg, xcpt_t irq) * Description: * Initialize and register the L3GD20 3 axis gyroscope sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/gyro0" * * Returned Value: diff --git a/configs/stm32f429i-disco/src/stm32_lcd.c b/configs/stm32f429i-disco/src/stm32_lcd.c index ab4d43ae38941781394eecc9a23a7e9d58981309..e327c53b5facb162deef011311434b4543c102bb 100644 --- a/configs/stm32f429i-disco/src/stm32_lcd.c +++ b/configs/stm32f429i-disco/src/stm32_lcd.c @@ -420,7 +420,7 @@ static int stm32_ili9341_initialize(void) * * Parameter: * - * Return: + * Returned Value: * ************************************************************************************/ @@ -444,7 +444,7 @@ void board_lcd_uninitialize(void) * Parameter: * lcddev - Number of the LDC Device. * - * Return: + * Returned Value: * Reference to the LCD object if exist otherwise NULL * ************************************************************************************/ @@ -469,7 +469,7 @@ FAR struct lcd_dev_s *board_lcd_getdev(int lcddev) * * Parameter: * - * Return: + * Returned Value: * On success - Ok * On error - Error Code * @@ -515,7 +515,7 @@ int board_lcd_initialize(void) * 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. * @@ -555,7 +555,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. diff --git a/configs/stm32f429i-disco/src/stm32_spi.c b/configs/stm32f429i-disco/src/stm32_spi.c index 16a23cc5647e7c693846b13f80c93a4926c50db3..3aaecc60d1538b914afb162b9105a58ce010f7ea 100644 --- a/configs/stm32f429i-disco/src/stm32_spi.c +++ b/configs/stm32f429i-disco/src/stm32_spi.c @@ -279,7 +279,7 @@ int stm32_spi5cmddata(FAR struct spi_dev_s *dev, uint32_t devid, bool cmd) * device after the first initializing and should be used by each driver who * shares the spi5 bus. * - * Input Parameter: + * Input Parameters: * * Returned Value: * Valid SPI device structure reference on success; a NULL on failure diff --git a/configs/stm32f429i-disco/src/stm32_usb.c b/configs/stm32f429i-disco/src/stm32_usb.c index 3d597eff7c162bc54b7f35d5f8b521c5c6cccb01..b178650480cdb0e435ad0c0e01bf6b887f5c2696 100644 --- a/configs/stm32f429i-disco/src/stm32_usb.c +++ b/configs/stm32f429i-disco/src/stm32_usb.c @@ -282,7 +282,7 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32f429i-disco/src/stm32f429i-disco.h b/configs/stm32f429i-disco/src/stm32f429i-disco.h index d3240608768005c9534fb33814d3a6bef1b856eb..18063a53911c60bb0c1d49cef4892b32f0605c33 100644 --- a/configs/stm32f429i-disco/src/stm32f429i-disco.h +++ b/configs/stm32f429i-disco/src/stm32f429i-disco.h @@ -361,7 +361,7 @@ FAR struct ili9341_lcd_s *stm32_ili93414ws_initialize(void); * the initialized state of the spi device after the first initializing * and should be used by each driver who shares the spi5 bus. * - * Input Parameter: + * Input Parameters: * None * * Returned Value: @@ -379,7 +379,7 @@ FAR struct spi_dev_s *stm32_spi5initialize(void); * Description: * Initialize and register the L3GD20 3 axis gyroscope sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/gyro0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_bh1750fvi.c b/configs/stm32f4discovery/src/stm32_bh1750fvi.c index 8ac3fe68467dd466c856fa5771f11db40ce346b4..2012762d17f2868105234c37d6ee43d6853aff08 100644 --- a/configs/stm32f4discovery/src/stm32_bh1750fvi.c +++ b/configs/stm32f4discovery/src/stm32_bh1750fvi.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/light0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_bmp180.c b/configs/stm32f4discovery/src/stm32_bmp180.c index b7ea5f568dac0dd876d2f3f065a52d5fd225c6f7..41553e1af7c079227f65aec78a1b89d7e9eb9817 100644 --- a/configs/stm32f4discovery/src/stm32_bmp180.c +++ b/configs/stm32f4discovery/src/stm32_bmp180.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/press0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_lis3dsh.c b/configs/stm32f4discovery/src/stm32_lis3dsh.c index b48a5614fa5a106e68491ac8f34bf19aea7ecdb4..600621786fb92af80cf126c7791ac4a07e9890c6 100644 --- a/configs/stm32f4discovery/src/stm32_lis3dsh.c +++ b/configs/stm32f4discovery/src/stm32_lis3dsh.c @@ -68,7 +68,7 @@ * Attach the lis3dsh interrupt handler to PE0/EXT0 on the STM32F4 as wired * on STM32F4Discovery * - * Input parameters: + * Input Parameters: * *config - The lis3dsh instance configuration data containing the IRQ number, * device ID and interrupt handler * interrupt_handler - The interrupt handler to attach @@ -98,7 +98,7 @@ int attach_disc_lis3dsh(FAR struct lis3dsh_config_s *config, xcpt_t interrupt_ha * Description: * Initialize and register the LIS3DSH 3-axis accelerometer. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/acc0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_max31855.c b/configs/stm32f4discovery/src/stm32_max31855.c index 2a03d70d7fc37f5cebec89fe3110ff4924cb5347..388fcf585d4644eb1f30d84177ac0f3ef0eb9261 100644 --- a/configs/stm32f4discovery/src/stm32_max31855.c +++ b/configs/stm32f4discovery/src/stm32_max31855.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MAX31855 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_max6675.c b/configs/stm32f4discovery/src/stm32_max6675.c index 759565c6e27260d5731933f5d571b90ed7aa0b74..d0360c5f33feea83574acd78a823081fb6e3f897 100644 --- a/configs/stm32f4discovery/src/stm32_max6675.c +++ b/configs/stm32f4discovery/src/stm32_max6675.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MAX6675 Temperature Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/temp0" * * Returned Value: diff --git a/configs/stm32f4discovery/src/stm32_pm.c b/configs/stm32f4discovery/src/stm32_pm.c index c012e397c30d10197f86e9fa44f7f1fe83ac923d..0bce85cc54f30ac9e5c2ced9bff6bdc1c61789e8 100644 --- a/configs/stm32f4discovery/src/stm32_pm.c +++ b/configs/stm32f4discovery/src/stm32_pm.c @@ -79,10 +79,10 @@ * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/configs/stm32f4discovery/src/stm32_timer.c b/configs/stm32f4discovery/src/stm32_timer.c index 326f2f25c09a2b73c2310a173c6e930d7c15a900..3586a181aaa18e7f0205c0b7d16960e5650cecf3 100644 --- a/configs/stm32f4discovery/src/stm32_timer.c +++ b/configs/stm32f4discovery/src/stm32_timer.c @@ -67,7 +67,7 @@ * devpath - The full path to the timer device. This should be of the form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/stm32f4discovery/src/stm32_usb.c b/configs/stm32f4discovery/src/stm32_usb.c index 6386b566ac7da73fe4472c7cd61c7ca5dadb01fc..e5fa78951ef0161ed84c633b10759f75a4463587 100644 --- a/configs/stm32f4discovery/src/stm32_usb.c +++ b/configs/stm32f4discovery/src/stm32_usb.c @@ -312,11 +312,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32f4discovery/src/stm32f4discovery.h b/configs/stm32f4discovery/src/stm32f4discovery.h index 51936d9485a0269a50351e62cd441e851dba3200..7a711fc3f1d6fef32016d23617e204c502a4f209 100644 --- a/configs/stm32f4discovery/src/stm32f4discovery.h +++ b/configs/stm32f4discovery/src/stm32f4discovery.h @@ -750,7 +750,7 @@ int stm32_rgbled_setup(void); * form /dev/timer0 * timer - The timer's number. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned * to indicate the nature of any failure. * diff --git a/configs/stm32f746-ws/src/stm32_usb.c b/configs/stm32f746-ws/src/stm32_usb.c index 8fa3f1e8275af20d973502399420dd402db8ddb3..46877033ba60a38de9ae9323e563c3aa9c6ac258 100644 --- a/configs/stm32f746-ws/src/stm32_usb.c +++ b/configs/stm32f746-ws/src/stm32_usb.c @@ -304,11 +304,11 @@ void stm32_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an overcurrent condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New overcurrent interrupt handler * arg - The argument provided for the interrupt handler * - * Returned value: + * Returned Value: * Zero (OK) is returned on success. Otherwise, a negated errno value is returned * to indicate the nature of the failure. * diff --git a/configs/stm32l476vg-disco/src/stm32_usb.c b/configs/stm32l476vg-disco/src/stm32_usb.c index a2c7ddadfaec3adba13213d2bc13b9ff3f5f3855..60858f581ab843e8a16f96309232eb3a6919afa7 100644 --- a/configs/stm32l476vg-disco/src/stm32_usb.c +++ b/configs/stm32l476vg-disco/src/stm32_usb.c @@ -301,10 +301,10 @@ void stm32l4_usbhost_vbusdrive(int iface, bool enable) * Setup to receive an interrupt-level callback if an over current condition is * detected. * - * Input Parameter: + * Input Parameters: * handler - New over current interrupt handler * - * Returned value: + * Returned Value: * Old over current interrupt handler * ************************************************************************************/ diff --git a/configs/teensy-lc/src/kl_spi.c b/configs/teensy-lc/src/kl_spi.c index efd1c96ce37e89286fe16c031b484c9bd8a4394a..17193881f49ef4bd4fc410517d6549af3959bce3 100644 --- a/configs/teensy-lc/src/kl_spi.c +++ b/configs/teensy-lc/src/kl_spi.c @@ -124,7 +124,7 @@ void weak_function kl_spidev_initialize(void) * devid - Identifies the (logical) device * selected - TRUE:Select the device, FALSE:De-select the device * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -156,7 +156,7 @@ void kl_spi1select(FAR struct spi_dev_s *dev, uint32_t devid, * Input Parameters: * devid - Identifies the (logical) device * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ @@ -187,7 +187,7 @@ uint8_t kl_spi1status(FAR struct spi_dev_s *dev, uint32_t devid) * devid - Identifies the (logical) device * cmd - Determines where command or data should be selected. * - * Returned Values: + * Returned Value: * Bit-encoded SPI status (see include/nuttx/spi/spi.h. * ****************************************************************************/ diff --git a/configs/u-blox-c027/src/lpc17_ubxmdm.c b/configs/u-blox-c027/src/lpc17_ubxmdm.c index bd165b96d2282fec664a95040f0c54e10bd6a704..2e333a8fcb9bc8a5eeeb5fa4cabbafce25f6e2cb 100644 --- a/configs/u-blox-c027/src/lpc17_ubxmdm.c +++ b/configs/u-blox-c027/src/lpc17_ubxmdm.c @@ -281,7 +281,7 @@ static int lpc17_ioctl(FAR struct ubxmdm_lower* lower, * Input Parameters: * usb_used - enables the USB sense pin if 'true' * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ diff --git a/configs/viewtool-stm32f107/src/stm32_mpl115a.c b/configs/viewtool-stm32f107/src/stm32_mpl115a.c index c6a1b9e6343896c4149fa841e27584cc2faf7578..2e78e2e5ac4a3bb895501a0fffae4f694f43901e 100644 --- a/configs/viewtool-stm32f107/src/stm32_mpl115a.c +++ b/configs/viewtool-stm32f107/src/stm32_mpl115a.c @@ -67,7 +67,7 @@ * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/press0" * * Returned Value: diff --git a/configs/viewtool-stm32f107/src/viewtool_stm32f107.h b/configs/viewtool-stm32f107/src/viewtool_stm32f107.h index 8a196108c5419c4204a4a151aaec15439253b48e..7aaa0f011469be9f52e36138ffa9225311be9b09 100644 --- a/configs/viewtool-stm32f107/src/viewtool_stm32f107.h +++ b/configs/viewtool-stm32f107/src/viewtool_stm32f107.h @@ -407,7 +407,7 @@ int stm32_can_setup(void); * Description: * Initialize and register the MPL115A Pressure Sensor driver. * - * Input parameters: + * Input Parameters: * devpath - The full path to the driver to register. E.g., "/dev/press0" * * Returned Value: diff --git a/configs/zp214xpa/src/lpc2148_spi1.c b/configs/zp214xpa/src/lpc2148_spi1.c index a7b479082bd72ef2e4b5811a1a81ea3062cf5b7b..f9c1cc269349b32de956e8b550d7ae0f98367e1b 100644 --- a/configs/zp214xpa/src/lpc2148_spi1.c +++ b/configs/zp214xpa/src/lpc2148_spi1.c @@ -569,7 +569,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: diff --git a/crypto/aes.c b/crypto/aes.c index e7c638f71897da335aedfb16a2c82378a8f89175..3927a283608da5c1a60076962d61d9ee3c67cdd3 100644 --- a/crypto/aes.c +++ b/crypto/aes.c @@ -555,7 +555,7 @@ static void aes_decr(FAR uint8_t *state, FAR const uint8_t *expanded_key) * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -580,7 +580,7 @@ void aes_encrypt(FAR uint8_t *state, FAR const uint8_t *key) * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ diff --git a/drivers/analog/ad5410.c b/drivers/analog/ad5410.c index 679edf2c5f25ffdc7ddd393d0746dcfb11237195..ab8609480e735dc4e5a5468d4543bad67f6dae57 100644 --- a/drivers/analog/ad5410.c +++ b/drivers/analog/ad5410.c @@ -270,7 +270,7 @@ static int dac_ioctl(FAR struct dac_dev_s *dev, int cmd, unsigned long arg) * Description: * Initialize the selected DAC port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple DAC interfaces) * * Returned Value: diff --git a/drivers/analog/ads1255.c b/drivers/analog/ads1255.c index 408dd92a29bdab43058cb038dbcd3153b4f9fc67..460f35e380d1c372776c0042b9bb0844f95512d9 100644 --- a/drivers/analog/ads1255.c +++ b/drivers/analog/ads1255.c @@ -502,7 +502,7 @@ static int adc_interrupt(int irq, void *context, FAR void *arg) * Description: * Initialize the selected adc port * - * Input Parameter: + * Input Parameters: * Port number (for hardware that has multiple adc interfaces) * * Returned Value: diff --git a/drivers/analog/dac.c b/drivers/analog/dac.c index 7e028e26f5e496fbff0b65a7288fb5462945b313..bfc2468463553c8d40ed33f8e8ded4b7102c81c8 100644 --- a/drivers/analog/dac.c +++ b/drivers/analog/dac.c @@ -465,7 +465,7 @@ static int dac_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * Description: * Called from the DAC interrupt handler at the completion of a send operation. * - * Return: + * Returned Value: * OK on success; a negated errno on failure. * ************************************************************************************/ diff --git a/drivers/audio/tone.c b/drivers/audio/tone.c index bc5e5740c14acd576d306b22c4ab68543f8c412c..d0dfb4d33bd2ab97e6f12ba7613f0a242afee914 100644 --- a/drivers/audio/tone.c +++ b/drivers/audio/tone.c @@ -922,7 +922,7 @@ static ssize_t tone_write(FAR struct file *filep, FAR const char *buffer, * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name of PWM driver * as "/dev/tone0". diff --git a/drivers/can/can.c b/drivers/can/can.c index 7a590d5a73b114e5a00e991bf0e790d9961fc0f9..6232f70ee867996b7c340d8abf6bb4095963d814 100644 --- a/drivers/can/can.c +++ b/drivers/can/can.c @@ -239,7 +239,7 @@ static void can_pollnotify(FAR struct can_dev_s *dev, pollevent_t eventset) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * dlc - the DLC value to convert to a byte count * * Returned Value: @@ -288,7 +288,7 @@ static uint8_t can_dlc2bytes(uint8_t dlc) * standard CAN. In CAN FD mode, the values 9 to 15 are encoded to values * in the range 12 to 64. * - * Input Parameter: + * Input Parameters: * nbytes - the byte count to convert to a DLC value * * Returned Value: diff --git a/drivers/can/mcp2515.c b/drivers/can/mcp2515.c index 3b68c4d43b9d1dc22cd330f2e6a270e9258433ac..b8ce91bfeb70ad8abb8596591810e7789d26dfa1 100644 --- a/drivers/can/mcp2515.c +++ b/drivers/can/mcp2515.c @@ -2369,7 +2369,7 @@ static int mcp2515_interrupt(FAR struct mcp2515_config_s *config, FAR void *arg) * Description: * MCP2515 hardware initialization * - * Input Parameter: + * Input Parameters: * priv - A pointer to the private data structure for this MCP2515 peripheral * * Returned Value: @@ -2483,7 +2483,7 @@ static int mcp2515_hw_initialize(struct mcp2515_can_s *priv) * Description: * Initialize the selected MCP2515 CAN Bus Controller over SPI * - * Input Parameter: + * Input Parameters: * config - The configuration structure passed by the board. * * Returned Value: @@ -2554,7 +2554,7 @@ FAR struct mcp2515_can_s *mcp2515_instantiate(FAR struct mcp2515_config_s *confi * Description: * Initialize the selected MCP2515 CAN Bus Controller over SPI * - * Input Parameter: + * Input Parameters: * config - The configuration structure passed by the board. * * Returned Value: diff --git a/drivers/contactless/pn532.c b/drivers/contactless/pn532.c index 6f1d8fb531465e6ef9fd5e0533f7de63a8d26cc8..b62e5fa9f2c4df382ea0d3c14bffbeb08494c776 100644 --- a/drivers/contactless/pn532.c +++ b/drivers/contactless/pn532.c @@ -927,8 +927,8 @@ static int _close(FAR struct file *filep) * Description: * This routine is called when the device is read. * - * Returns TAG id as string to buffer. - * or -EIO if no TAG found + * Returned Value: + * TAG id as string to buffer or -EIO if no TAG found * ****************************************************************************/ diff --git a/drivers/input/ajoystick.c b/drivers/input/ajoystick.c index bed67d18901fc39e5232628ce466cd65d9ef306f..233807ddd0d1997f5084533d1a3186ee499ede60 100644 --- a/drivers/input/ajoystick.c +++ b/drivers/input/ajoystick.c @@ -842,7 +842,7 @@ errout_with_dusem: * lower - An instance of the platform-specific analog joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/input/button_upper.c b/drivers/input/button_upper.c index c172ecfa1dc6faecbd31bb8ad2cead3e5f1473af..b60e77f60d99a7d028a4bd32871a910609bcf03b 100644 --- a/drivers/input/button_upper.c +++ b/drivers/input/button_upper.c @@ -823,7 +823,7 @@ errout_with_dusem: * minor device number. * lower - An instance of the platform-specific button lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/input/djoystick.c b/drivers/input/djoystick.c index 6ada3f76e1ebdda0f1bcbadf942de1dfc8948a30..3854e22c93d923ee3f2d8a48be3f824e5b6c8200 100644 --- a/drivers/input/djoystick.c +++ b/drivers/input/djoystick.c @@ -837,7 +837,7 @@ errout_with_dusem: * lower - An instance of the platform-specific discrete joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/input/nunchuck.c b/drivers/input/nunchuck.c index ccd591802a637a4cbb40423be9326ed01d963bf6..b1b2df93f3e54e6ea7844e18eb43fffa2c47d9f6 100644 --- a/drivers/input/nunchuck.c +++ b/drivers/input/nunchuck.c @@ -567,7 +567,7 @@ static int nunchuck_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * minor device number. * i2c - An instance of the platform-specific I2C connected to Nunchuck. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/lcd/ili9341.c b/drivers/lcd/ili9341.c index ad31db450e947cefdaf17135c84f6f3be8451728..b55404fb2c783b671deb7a3385d3cc493cb2c600 100644 --- a/drivers/lcd/ili9341.c +++ b/drivers/lcd/ili9341.c @@ -532,7 +532,7 @@ static struct ili9341_dev_s g_lcddev[CONFIG_LCD_ILI9341_NINTERFACES] = * Parameters: * dev - Reference to private driver structure * - * Return Value: + * Returned Value: * * Horicontal resolution * @@ -560,7 +560,7 @@ static inline uint16_t ili9341_getxres(FAR struct ili9341_dev_s *dev) * Parameter: * dev - Reference to private driver structure * - * Return Value: + * Returned Value: * * Vertical resolution * diff --git a/drivers/lcd/lcd_framebuffer.c b/drivers/lcd/lcd_framebuffer.c index 369d774a214b9e754a9224b4e5c4b91bbaea7032..db9c27ffaa4d17f5d5ccc008c260e26a0ded5f94 100644 --- a/drivers/lcd/lcd_framebuffer.c +++ b/drivers/lcd/lcd_framebuffer.c @@ -451,7 +451,7 @@ static int lcdfb_setcursor(FAR struct fb_vtable_s *vtable, * 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. * @@ -598,7 +598,7 @@ errout_with_state: * 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. diff --git a/drivers/leds/rgbled.c b/drivers/leds/rgbled.c index 0ba2229bdb424b627221adca4d92484669ae508e..1bb4e89f724e1e02374c4686788c1d609a8f17a7 100644 --- a/drivers/leds/rgbled.c +++ b/drivers/leds/rgbled.c @@ -420,7 +420,7 @@ static ssize_t rgbled_write(FAR struct file *filep, FAR const char *buffer, * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/rgdbled0", "/dev/rgbled1", etc. where the driver path diff --git a/drivers/leds/userled_upper.c b/drivers/leds/userled_upper.c index f851f33cce43452ca208f9a16c80aab221d8cbbd..ef414cda8124e29d22405ef7db2c87a0492ed631 100644 --- a/drivers/leds/userled_upper.c +++ b/drivers/leds/userled_upper.c @@ -527,7 +527,7 @@ static int userled_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * minor device number. * lower - An instance of the platform-specific LED lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/mtd/hamming.c b/drivers/mtd/hamming.c index 95d192db11f2360ac514e3a8d2460e9c725ba32f..7628e9d4d0113a7f50c997ae80c0a941f0be71eb 100644 --- a/drivers/mtd/hamming.c +++ b/drivers/mtd/hamming.c @@ -65,7 +65,7 @@ * Input Parameters: * bytes - The byte to use. * - * Returned Values: + * Returned Value: * Returns the number of bits set to '1' in the given byte. * ****************************************************************************/ @@ -95,7 +95,7 @@ static unsigned int hamming_bitsinbyte(uint8_t byte) * Input Parameters: * code - Hamming code * - * Returned Values: + * Returned Value: * Returns the number of bits set to '1' in the given hamming code. * ****************************************************************************/ @@ -117,7 +117,7 @@ static uint8_t hamming_bitsincode256(FAR uint8_t *code) * data - Data buffer to calculate code * code - Pointer to a buffer where the code should be stored * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -272,7 +272,7 @@ static void hamming_compute256(FAR const uint8_t *data, FAR uint8_t *code) * data - Data buffer to check * original - Hamming code to use for verifying the data * - * Returned Values: + * Returned Value: * Zero on success, otherwise returns a HAMMING_ERROR_ code. * ****************************************************************************/ @@ -372,7 +372,7 @@ static int hamming_verify256(FAR uint8_t *data, FAR const uint8_t *original) * size - Data size in bytes * code - Codes buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -408,7 +408,7 @@ void hamming_compute256x(FAR const uint8_t *data, size_t size, uint8_t *code) * size - Size of the data in bytes * code - Original codes * - * Returned Values: + * Returned Value: * Return 0 if the data is correct, HAMMING_ERROR_SINGLEBIT if one or more * block(s) have had a single bit corrected, or either HAMMING_ERROR_ECC * or HAMMING_ERROR_MULTIPLEBITS. diff --git a/drivers/mtd/mtd_config.c b/drivers/mtd/mtd_config.c index 9a0d4077c13c2fb9c3698c723c2eefd6205746e5..32a2a72e59343fc28eb206d1172c6983d0d82d83 100644 --- a/drivers/mtd/mtd_config.c +++ b/drivers/mtd/mtd_config.c @@ -336,7 +336,7 @@ errout: * * Locates the first config entry, even if it is empty. * - * Returns: + * Returned Value: * offset to the start of the entry. * ****************************************************************************/ @@ -435,7 +435,7 @@ static int mtdconfig_findfirstentry(FAR struct mtdconfig_struct_s *dev, * * Locates the next config entry starting at offset, even if it is empty. * - * Returns: + * Returned Value: * offset to the start of the next entry. * ****************************************************************************/ @@ -562,7 +562,7 @@ read_next: * method of consolidation is used when only a single erase * block is available in the partition. * - * Returns: + * Returned Value: * offset to the next available entry (after consolidation).. * ****************************************************************************/ @@ -719,7 +719,7 @@ errout: * erased block. It erases all blocks to the end of the * partition as it goes. * - * Returns: + * Returned Value: * offset to the next available entry (after consolidation).. * ****************************************************************************/ diff --git a/drivers/mtd/mtd_nand.c b/drivers/mtd/mtd_nand.c index 8394af67de61a869d55b6e5b6063d394c66ffe3e..09586f7e1ca67d0132f255782333222c2522b303 100644 --- a/drivers/mtd/mtd_nand.c +++ b/drivers/mtd/mtd_nand.c @@ -372,7 +372,7 @@ static uint32_t nand_chipid(struct nand_raw_s *raw) * block Number of block to erase * scrub True: Erase bad blocks * - * Returned Value + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ @@ -438,13 +438,13 @@ static int nand_eraseblock(FAR struct nand_dev_s *nand, off_t block, * Reads the data area (only) of a page of a NAND FLASH into the * provided buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -493,13 +493,13 @@ static int nand_readpage(FAR struct nand_dev_s *nand, off_t block, * Writes the data area (only) of a page into NAND FLASH from the * provided buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -836,7 +836,7 @@ static int nand_ioctl(struct mtd_dev_s *dev, int cmd, unsigned long arg) * Description: * Probe and initialize NAND. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * cmdaddr - NAND command address base * addraddr - NAND address address base @@ -844,7 +844,7 @@ static int nand_ioctl(struct mtd_dev_s *dev, int cmd, unsigned long arg) * model - A pointer to the model data (probably in the raw MTD * driver instance. * - * Returned value. + * Returned Value: * A non-NULL MTD driver intstance is returned on success. NULL is * returned on any failaure. * diff --git a/drivers/mtd/mtd_nandecc.c b/drivers/mtd/mtd_nandecc.c index e22bc23175a69553a457c13ba92cdb11b5c0a880..47fb3b31be248d983d2f9ac1a612b67ef1ebbbfa 100644 --- a/drivers/mtd/mtd_nandecc.c +++ b/drivers/mtd/mtd_nandecc.c @@ -75,14 +75,14 @@ * the spare area. If a buffer pointer is NULL, then the corresponding area * is not saved. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -166,14 +166,14 @@ int nandecc_readpage(FAR struct nand_dev_s *nand, off_t block, * If no spare buffer is provided, the spare area is still written with the * ECC information calculated on the data buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ diff --git a/drivers/mtd/mtd_nandmodel.c b/drivers/mtd/mtd_nandmodel.c index cd3c324c9c3c033f76b5c8cf15a8ad38f56d6d66..2b9c09472badc4561548eb7cd704f5de0b6dccd4 100644 --- a/drivers/mtd/mtd_nandmodel.c +++ b/drivers/mtd/mtd_nandmodel.c @@ -76,7 +76,7 @@ * chipid Identifier returned by the Nand(id1|(id2<<8)|(id3<<16)|(id4<<24)). * model nand_model_s instance to update with the model parameters. * - * Returned Values: + * Returned Value: * OK is returned on success; -ENODEV is returned on failure. * ****************************************************************************/ @@ -186,7 +186,7 @@ int nandmodel_find(FAR const struct nand_model_s *modeltab, size_t size, * page Stores the first accessed page number inside the first block. * offset Stores the byte offset inside the first accessed page. * - * Returned Values: + * Returned Value: * OK on success; -EPIPE on failure. * ****************************************************************************/ @@ -252,7 +252,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * size of spare area in bytes * ****************************************************************************/ diff --git a/drivers/mtd/mtd_nandscheme.c b/drivers/mtd/mtd_nandscheme.c index cf0557f22ab1fbb85eda8754479eebbb0882e7ce..17269bb09d20690d07d5a1ed12693f02fc8e5c97 100644 --- a/drivers/mtd/mtd_nandscheme.c +++ b/drivers/mtd/mtd_nandscheme.c @@ -182,7 +182,7 @@ const struct nand_scheme_s g_nand_sparescheme4096 = * spare Spare area buffer. * marker Pointer to the variable to store the bad block marker. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -206,7 +206,7 @@ void nandscheme_readbadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * marker Bad block marker to write. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -228,7 +228,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -255,7 +255,7 @@ void nandscheme_readecc(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -285,7 +285,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to read. * offset Index where to read the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -318,7 +318,7 @@ void nandscheme_readextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -349,7 +349,7 @@ void nandscheme_writeextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/mtd/mtd_partition.c b/drivers/mtd/mtd_partition.c index f8438cdd97640e9f2f3e65ea7bd7c01eb032ea49..54c88e981624972d151e37f5fd1f9b066fcc8817 100644 --- a/drivers/mtd/mtd_partition.c +++ b/drivers/mtd/mtd_partition.c @@ -767,7 +767,7 @@ static int part_procfs_stat(const char *relpath, struct stat *buf) * partitions, that mutual exclusion would be provided by the file system * above the FLASH driver. * - * Input parameters: + * Input Parameters: * mtd - The MTD device to be partitioned * firstblock - The offset in bytes to the first block * nblocks - The number of blocks in the partition diff --git a/drivers/net/telnet.c b/drivers/net/telnet.c index 6c849826efdd993c6d2f0d0c64307abafdba674e..db5419125dbfd218a287a88981f1d45e0466930f 100644 --- a/drivers/net/telnet.c +++ b/drivers/net/telnet.c @@ -690,7 +690,7 @@ static ssize_t telnet_read(FAR struct file *filep, FAR char *buffer, size_t len) } while (ret == 0); - /* Return: + /* Returned Value: * * ret > 0: The number of characters copied into the user buffer by * telnet_receive(). @@ -783,7 +783,7 @@ static ssize_t telnet_write(FAR struct file *filep, FAR const char *buffer, size * session - On input, contains the socket descriptor that represents the * new telnet connection. On output, it holds the path to the new Telnet driver. * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -978,7 +978,7 @@ static int common_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * Parameters: * None * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/pipes/fifo.c b/drivers/pipes/fifo.c index 43afa5556f99faf79120c70a39c846fe3926147e..6a8905a6a20893f4c17598468c2ecc1d88f5817a 100644 --- a/drivers/pipes/fifo.c +++ b/drivers/pipes/fifo.c @@ -97,13 +97,13 @@ static const struct file_operations fifo_fops = * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * pathname - The full path to the FIFO instance to attach to or to create * (if not already created). * mode - Ignored for now * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/drivers/pipes/pipe.c b/drivers/pipes/pipe.c index b32ef965e9b57505ee4fba9e163bf3ca508865e5..f3a98e6351900e12551a71d01aa5a64f5ce6a5f9 100644 --- a/drivers/pipes/pipe.c +++ b/drivers/pipes/pipe.c @@ -177,12 +177,12 @@ static int pipe_close(FAR struct file *filep) * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * fd[2] - The user provided array in which to catch the pipe file * descriptors * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/drivers/power/battery_charger.c b/drivers/power/battery_charger.c index 0bacbd90e3769331da1909aec9375fd13a315ef2..5467f4909390b2c6b68bfd931da67e399e737363 100644 --- a/drivers/power/battery_charger.c +++ b/drivers/power/battery_charger.c @@ -270,12 +270,12 @@ static int bat_charger_ioctl(FAR struct file *filep, int cmd, * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/power/battery_gauge.c b/drivers/power/battery_gauge.c index ab97489188bb40a4e36eb2811050c11c311dac13..9936147be1653dc9438e3bed22197f54584313f6 100644 --- a/drivers/power/battery_gauge.c +++ b/drivers/power/battery_gauge.c @@ -233,12 +233,12 @@ static int bat_gauge_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/power/pm_initialize.c b/drivers/power/pm_initialize.c index 83b67645f7d5949f221eec9cecd7c97eefdac848..bb777f9865c2fdf589efbf890819c35a21541bfd 100644 --- a/drivers/power/pm_initialize.c +++ b/drivers/power/pm_initialize.c @@ -70,10 +70,10 @@ struct pm_global_s g_pmglobals; * other device drivers are initialize (since they may attempt to register * with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/drivers/power/pm_register.c b/drivers/power/pm_register.c index b33dab6962d0a5e25d93903dcc36763216987442..060463135856de6714b6cf3081d3e81304a04339 100644 --- a/drivers/power/pm_register.c +++ b/drivers/power/pm_register.c @@ -59,11 +59,11 @@ * This function is called by a device driver in order to register to * receive power management event callbacks. * - * Input parameters: + * Input Parameters: * callbacks - An instance of struct pm_callback_s providing the driver * callback functions. * - * Returned value: + * Returned Value: * Zero (OK) on success; otherwise a negater errno value is returned. * ****************************************************************************/ diff --git a/drivers/pwm.c b/drivers/pwm.c index 44d644cc64f70727010aa7de49dcc6fb0ee1f9dd..085c3065e9e5bb47b61773d86332c0efba362d70 100644 --- a/drivers/pwm.c +++ b/drivers/pwm.c @@ -568,7 +568,7 @@ static int pwm_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registered in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/pwm0", "/dev/pwm1", etc. where the driver path differs only @@ -641,7 +641,7 @@ int pwm_register(FAR const char *path, FAR struct pwm_lowerhalf_s *dev) * interface using the handle that was previously passed to the * start() method * - * Input parameters: + * Input Parameters: * handle - This is the handle that was provided to the lower-half * start() method. * diff --git a/drivers/ramdisk.c b/drivers/ramdisk.c index b31e1f0dd9dd8f01a12487230045766bb7e1bbbf..842c36cd9dbe280247c97e486b2ced2d57a3d1a5 100644 --- a/drivers/ramdisk.c +++ b/drivers/ramdisk.c @@ -428,14 +428,14 @@ static int rd_unlink(FAR struct inode *inode) * Description: * Non-standard function to register a ramdisk or a romdisk * - * Input Parmeters: + * Input Parameters: * minor: Selects suffix of device named /dev/ramN, N={1,2,3...} * nsectors: Number of sectors on device * sectize: The size of one sector * rdflags: See RDFLAG_* definitions * buffer: RAM disk backup memory * - * Returned Valued: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/drivers/syslog/syslog_emergstream.c b/drivers/syslog/syslog_emergstream.c index 8347c15a8e5d961c231b0a8ede30f7dfd9d3074b..e7aef97e2330fbea1ad19eb5cafc979601c3e746 100644 --- a/drivers/syslog/syslog_emergstream.c +++ b/drivers/syslog/syslog_emergstream.c @@ -97,7 +97,7 @@ static void emergstream_putc(FAR struct lib_outstream_s *this, int ch) * Initializes a stream for use with the configured emergency syslog * interface. Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_outstream_s to be initialized. * diff --git a/drivers/syslog/syslog_stream.c b/drivers/syslog/syslog_stream.c index a71bd933d7aa31aece761799a8e510c5ac113777..e3e2b1b57ddaf914052bf64a016b1cd5ebb2d3ed 100644 --- a/drivers/syslog/syslog_stream.c +++ b/drivers/syslog/syslog_stream.c @@ -199,7 +199,7 @@ static void syslogstream_putc(FAR struct lib_outstream_s *this, int ch) * Initializes a stream for use with the configured syslog interface. * Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -245,7 +245,7 @@ void syslogstream_create(FAR struct lib_syslogstream_s *stream) * Description: * Free resources held by the syslog stream. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * diff --git a/drivers/timers/rtc.c b/drivers/timers/rtc.c index f38979ee50be9b2055638fc54afd85f5db8f918f..380bb35419b66085dd3f66eb3c79878f8e7ab556 100644 --- a/drivers/timers/rtc.c +++ b/drivers/timers/rtc.c @@ -784,7 +784,7 @@ static int rtc_unlink(FAR struct inode *inode) * provided to this function. The resulting RTC driver will be registered * at /dev/rtcN where N is the minor number provided to this function. * - * Input parameters: + * Input Parameters: * minor - The minor number of the RTC device. The N in /dev/rtcN * lower - The lower half driver instance. * diff --git a/drivers/timers/timer.c b/drivers/timers/timer.c index d760a2c4c64e7598b268f372bb59aba7eb3970a6..6bb4edeb1962d788d87140dc07459615d607f20a 100644 --- a/drivers/timers/timer.c +++ b/drivers/timers/timer.c @@ -431,7 +431,7 @@ static int timer_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * When this function is called, the "lower half" driver should be in the * disabled state (as if the stop() method had already been called). * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all timer * drivers as "/dev/tc0", "/dev/tc1", etc. where the driver @@ -508,7 +508,7 @@ errout: * This function can be called to disable and unregister the timer * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * * Returned Value: @@ -552,7 +552,7 @@ void timer_unregister(FAR void *handle) * to handle timer expirations. This is a strictly OS internal interface * and may NOT be used by appliction code. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * callback - The new timer interrupt callback * arg - Argument to be provided with the callback diff --git a/drivers/timers/watchdog.c b/drivers/timers/watchdog.c index 06208e49dd0305d1efbdbfab1974d0f45099e443..a1a29fbaf4b81ef12ef3eb6ff1dec4a3b3269b79 100644 --- a/drivers/timers/watchdog.c +++ b/drivers/timers/watchdog.c @@ -439,7 +439,7 @@ static int wdog_ioctl(FAR struct file *filep, int cmd, unsigned long arg) * When this function is called, the "lower half" driver should be in the * disabled state (as if the stop() method had already been called). * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all watchdog * drivers as "/dev/watchdog0", "/dev/watchdog1", etc. where the driver @@ -518,7 +518,7 @@ errout: * This function can be called to disable and unregister the watchdog * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by watchdog_register() * * Returned Value: diff --git a/drivers/usbdev/cdcacm.c b/drivers/usbdev/cdcacm.c index 7593156a9161bbce73f4199220ba1158d521c060..4cd4256f1626595a3b709d8d2cf0bf4c698e24cf 100644 --- a/drivers/usbdev/cdcacm.c +++ b/drivers/usbdev/cdcacm.c @@ -2638,7 +2638,7 @@ static void cdcuart_rxint(FAR struct uart_dev_s *dev, bool enable) * 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 @@ -2869,7 +2869,7 @@ static bool cdcuart_txempty(FAR struct uart_dev_s *dev) * Register USB serial port (and USB serial console if so configured) and * return the class object. * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * classdev - The location to return the CDC serial class' device @@ -3004,7 +3004,7 @@ errout_with_class: * Description: * Register USB serial port (and USB serial console if so configured). * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * handle - An optional opaque reference to the CDC/ACM class object that diff --git a/drivers/usbdev/composite.c b/drivers/usbdev/composite.c index 17204d7f81825e61604b98d1c0c14a09aa39561d..6800cd95dbdaa34ff0787a63fff5e6625108b220 100644 --- a/drivers/usbdev/composite.c +++ b/drivers/usbdev/composite.c @@ -786,7 +786,7 @@ static void composite_resume(FAR struct usbdevclass_driver_s *driver, * board-specific implementations in order to obtain the class objects for * each of the members of the composite. * - * Input Parameter: + * Input Parameters: * None * * Returned Value: diff --git a/drivers/usbdev/rndis.c b/drivers/usbdev/rndis.c index 3e1baf2e08a0a5295c425612318f4607190fd714..bc70bc10366c6e77c20d58faf5ac6c27bcfd889e 100644 --- a/drivers/usbdev/rndis.c +++ b/drivers/usbdev/rndis.c @@ -775,7 +775,7 @@ static void rndis_giverxreq(FAR struct rndis_dev_s *priv) * priv: pointer to RNDIS device driver structure * req: the request whose buffer we should fill * - * Returned value: + * Returned Value: * The total length of the request data * * Assumptions: diff --git a/drivers/usbdev/usbmsc.c b/drivers/usbdev/usbmsc.c index 7fdfcbfc8828400f0c1fb28e28c903f5312492d7..14b735301fd33b248b5952d3bfd352983ff11d71 100644 --- a/drivers/usbdev/usbmsc.c +++ b/drivers/usbdev/usbmsc.c @@ -1231,7 +1231,7 @@ void usbmsc_rdcomplete(FAR struct usbdev_ep_s *ep, * In all cases, the success reponse is a zero-length packet; the failure * response is an EP0 stall. * - * Input parameters: + * Input Parameters: * priv - Private state structure for this USB storage instance * stall - true is the action failed and a stall is required * diff --git a/drivers/usbdev/usbmsc.h b/drivers/usbdev/usbmsc.h index 79d26778e83a703f5156ce3f6d3bdd2edad38cd8..d0d93d3489dcce10f23d7f26db41ad39a14b866b 100644 --- a/drivers/usbdev/usbmsc.h +++ b/drivers/usbdev/usbmsc.h @@ -679,7 +679,7 @@ void usbmsc_rdcomplete(FAR struct usbdev_ep_s *ep, * In all cases, the success reponse is a zero-length packet; the failure * response is an EP0 stall. * - * Input parameters: + * Input Parameters: * priv - Private state structure for this USB storage instance * stall - true is the action failed and a stall is required * diff --git a/drivers/usbdev/usbmsc_scsi.c b/drivers/usbdev/usbmsc_scsi.c index 8b20a008c4364a0f6f78fde38458fa4958f891c9..369d926be1c36edacf2b84ed9f8ba469ccd09970 100644 --- a/drivers/usbdev/usbmsc_scsi.c +++ b/drivers/usbdev/usbmsc_scsi.c @@ -1636,7 +1636,7 @@ static int inline usbmsc_setupcmd(FAR struct usbmsc_dev_s *priv, * Called from the worker thread in the USBMSC_STATE_IDLE state. Checks * for the receipt of a bulk CBW. * - * Returned value: + * Returned Value: * If no new, valid CBW is available, this function returns a negated errno. * Otherwise, when a new CBW is successfully parsed, this function sets * priv->thstate to USBMSC_STATE_CMDPARSE and returns OK. @@ -1781,7 +1781,7 @@ static int usbmsc_idlestate(FAR struct usbmsc_dev_s *priv) * This state is entered when usbmsc_idlestate obtains a valid CBW * containing SCSI commands. This function processes those SCSI commands. * - * Returned value: + * Returned Value: * If no write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDPARSE * state. Otherwise, when the new CBW is successfully process, this @@ -2097,7 +2097,7 @@ static int usbmsc_cmdparsestate(FAR struct usbmsc_dev_s *priv) * of the USBMSC_STATE_CMDPARSE state that handles extended SCSI read * command handling. * - * Returned value: + * Returned Value: * If no USBDEV write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDREAD * state. Otherwise, when the new SCSI read command is fully processed, @@ -2244,7 +2244,7 @@ static int usbmsc_cmdreadstate(FAR struct usbmsc_dev_s *priv) * of the USBMSC_STATE_CMDPARSE state that handles extended SCSI write * command handling. * - * Returned value: + * Returned Value: * If no USBDEV write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDWRITE * state. Otherwise, when the new SCSI write command is fully processed, @@ -2384,7 +2384,7 @@ errout: * The USBMSC_STATE_CMDFINISH state is entered when processing of a * command has finished but before status has been returned. * - * Returned value: + * Returned Value: * If no USBDEV write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDFINISH * state. Otherwise, when the command is fully processed, this function @@ -2527,7 +2527,7 @@ static int usbmsc_cmdfinishstate(FAR struct usbmsc_dev_s *priv) * That state is after a CBW has been fully processed. This function sends * the concluding CSW. * - * Returned value: + * Returned Value: * If no write request is available or certain other errors occur, this * function returns a negated errno and stays in the USBMSC_STATE_CMDSTATUS * state. Otherwise, when the SCSI statis is successfully returned, this diff --git a/drivers/usbhost/hid_parser.c b/drivers/usbhost/hid_parser.c index 59198faa93749bddb80b54f6360b17630794e7b8..88a167beac6f8bae7e3eb046169205441d228968 100644 --- a/drivers/usbhost/hid_parser.c +++ b/drivers/usbhost/hid_parser.c @@ -398,7 +398,7 @@ int hid_parsereport(FAR const uint8_t *report, int rptlen, * report. If the given item does not exist in the report, the function * does not modify the report item's data. * - * Input Parameters + * Input Parameters: * report Buffer containing an IN or FEATURE report from an attached * device. * item Pointer to the report item of interest in a struct hid_rptinfo_s @@ -500,7 +500,7 @@ void hid_putitem(FAR uint8_t *report, struct hid_rptitem_s *item) * Description: * Retrieves the size of a given HID report in bytes from it's Report ID. * - * InputParameters: + * Input Parameters: * rptinfo Pointer to a struct hid_rptinfo_s instance containing the parser output. * id Report ID of the report whose size is to be retrieved. * rpttype Type of the report whose size is to be determined, a valued from the diff --git a/drivers/usbhost/usbhost_cdcacm.c b/drivers/usbhost/usbhost_cdcacm.c index 250e561e23ed1a2a3ad62fce016152dd51a1a123..7353af369ec163cee0152850e38c2c01213a9c85 100644 --- a/drivers/usbhost/usbhost_cdcacm.c +++ b/drivers/usbhost/usbhost_cdcacm.c @@ -2623,7 +2623,7 @@ static bool usbhost_rxavailable(FAR struct uart_dev_s *uartdev) * Return true if UART activated RX flow control to block more incoming * data * - * Input parameters: + * Input Parameters: * uartdev - UART device instance * nbuffered - the number of characters currently buffered * (if CONFIG_SERIAL_IFLOWCONTROL_WATERMARKS is diff --git a/drivers/usbhost/usbhost_enumerate.c b/drivers/usbhost/usbhost_enumerate.c index a6cbddc9ed6169bc07e04c9161c9fe4751e607ee..cb45a191da07a87fc45db5560c7eebe274a8812f 100644 --- a/drivers/usbhost/usbhost_enumerate.c +++ b/drivers/usbhost/usbhost_enumerate.c @@ -280,7 +280,7 @@ static inline int usbhost_classbind(FAR struct usbhost_hubport_s *hport, * and bound to the hub port, the allocated class instance is returned * into this caller-provided memory location. * - * 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 * diff --git a/drivers/usbhost/usbhost_findclass.c b/drivers/usbhost/usbhost_findclass.c index 7ae1cad4dc8d952c38232b4f61bfc220aa3fca5d..f92534fd1f31e8c22f858b6f8d23cf7b807d5aec 100644 --- a/drivers/usbhost/usbhost_findclass.c +++ b/drivers/usbhost/usbhost_findclass.c @@ -64,7 +64,7 @@ * classid - ID info for the class under consideration. * devid - ID info reported by the device. * - * Returned Values: + * Returned Value: * TRUE - the class will support this device. * ****************************************************************************/ @@ -127,7 +127,7 @@ static bool usbhost_idmatch(const struct usbhost_id_s *classid, * Input Parameters: * id - Identifies the USB device class that has connect to the USB host. * - * Returned Values: + * Returned Value: * On success this function will return a non-NULL instance of struct * usbhost_registry_s. NULL will be returned on failure. This function * can only fail if (1) id is NULL, or (2) no USB host class is registered diff --git a/drivers/usbhost/usbhost_hidkbd.c b/drivers/usbhost/usbhost_hidkbd.c index e3a9f192075df42eb7fea052b31abe87293553fd..3a0e07afafcc71c83a8308825d59c0a370fa5570 100644 --- a/drivers/usbhost/usbhost_hidkbd.c +++ b/drivers/usbhost/usbhost_hidkbd.c @@ -653,7 +653,7 @@ static void usbhost_pollnotify(FAR struct usbhost_state_s *priv) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -680,7 +680,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -753,7 +753,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, char *dev * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -824,7 +824,7 @@ static void usbhost_destroy(FAR void *arg) * priv - Driver internal state * keycode - The value to add to the user buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -880,7 +880,7 @@ static void usbhost_putbuffer(FAR struct usbhost_state_s *priv, * stream - The struct lib_outstream_s reference * ch - The character to add to the user buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -908,7 +908,7 @@ static void usbhost_putstream(FAR struct lib_outstream_s *stream, int ch) * scancode - Scan code to be mapped. * modifier - Ctrl,Alt,Shift,GUI modifier bits * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -950,7 +950,7 @@ static inline uint8_t usbhost_mapscancode(uint8_t scancode, uint8_t modifier) * scancode - Scan code to be mapped. * modifier - Ctrl, Alt, Shift, GUI modifier bits * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -999,7 +999,7 @@ static inline void usbhost_encodescancode(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1326,7 +1326,7 @@ static int usbhost_kbdpoll(int argc, char *argv[]) * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1578,7 +1578,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1669,7 +1669,7 @@ errout: * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1689,7 +1689,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1710,7 +1710,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1732,7 +1732,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1756,7 +1756,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1782,7 +1782,7 @@ static inline int usbhost_tdalloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1827,7 +1827,7 @@ static inline int usbhost_tdfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1912,7 +1912,7 @@ static FAR struct usbhost_class_s * * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1981,7 +1981,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * 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 * @@ -2424,7 +2424,7 @@ errout: * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_hidmouse.c b/drivers/usbhost/usbhost_hidmouse.c index 944b939f8959efa4944fb648fa3e2914c197e095..4648c3bdb3c5895629b1b7ccb08caa7e708940fe 100644 --- a/drivers/usbhost/usbhost_hidmouse.c +++ b/drivers/usbhost/usbhost_hidmouse.c @@ -513,7 +513,7 @@ static void usbhost_pollnotify(FAR struct usbhost_state_s *priv) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -540,7 +540,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -614,7 +614,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -676,7 +676,7 @@ static void usbhost_destroy(FAR void *arg) * Description: * Wake any threads waiting for mouse data * - * Input Paramters: + * Input Parameters: * priv - A reference to the mouse state structure. * * Returned Value: @@ -1038,7 +1038,7 @@ static bool usbhost_threshold(FAR struct usbhost_state_s *priv) * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1448,7 +1448,7 @@ errout: * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1648,7 +1648,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1739,7 +1739,7 @@ errout: * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1759,7 +1759,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1780,7 +1780,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1802,7 +1802,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1826,7 +1826,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1852,7 +1852,7 @@ static inline int usbhost_tdalloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On success, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1896,7 +1896,7 @@ static inline int usbhost_tdfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1982,7 +1982,7 @@ static FAR struct usbhost_class_s * * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -2050,7 +2050,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * 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 * @@ -2553,7 +2553,7 @@ errout: * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_hub.c b/drivers/usbhost/usbhost_hub.c index 58d7c64a2dd8a69b500c1213e83d4e5e6abc10ee..b3fecd661786faae8c1d25ea3ef0a68b4edeb790 100644 --- a/drivers/usbhost/usbhost_hub.c +++ b/drivers/usbhost/usbhost_hub.c @@ -222,7 +222,7 @@ static struct usbhost_registry_s g_hub = * Input Parameters: * hport - A reference to the hub port instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -264,7 +264,7 @@ static void usbhost_hport_deactivate(FAR struct usbhost_hubport_s *hport) * Input Parameters: * hport - The hub port to be activated. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned * on any failure. * @@ -308,7 +308,7 @@ static int usbhost_hport_activate(FAR struct usbhost_hubport_s *hport) * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -496,7 +496,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_class_s *hubclass, * Input Parameters: * hubclass - The USB host class instance. * - * 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 * @@ -598,7 +598,7 @@ static inline int usbhost_hubdesc(FAR struct usbhost_class_s *hubclass) * hport - The port on the parent hub where the this hub is connected. * on - True: enable power; false: Disable power * - * 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 * @@ -661,7 +661,7 @@ static int usbhost_hubpwr(FAR struct usbhost_hubpriv_s *priv, * Input Parameters: * xfer - The USB host class instance. * - * 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 * @@ -1010,7 +1010,7 @@ static void usbhost_hub_event(FAR void *arg) * class - The USB host class entry previously obtained from a call to * create(). * - * 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 * @@ -1112,7 +1112,7 @@ static void usbhost_disconnect_event(FAR void *arg) * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1132,7 +1132,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1154,7 +1154,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * nbytes - The number of bytes actually transferred (or a negated errno * value; * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -1244,7 +1244,7 @@ static void usbhost_callback(FAR void *arg, ssize_t nbytes) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1351,7 +1351,7 @@ errout_with_hub: * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1439,7 +1439,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *hubclass, * class - The USB host class entry previously obtained from a call to * create(). * - * 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 * @@ -1497,7 +1497,7 @@ static int usbhost_disconnected(struct usbhost_class_s *hubclass) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_registerclass.c b/drivers/usbhost/usbhost_registerclass.c index a795b88d02a0235b293cec95aed0532adb868737..8cd52dd02dbc81c38cb3b85a221531afd1650656 100644 --- a/drivers/usbhost/usbhost_registerclass.c +++ b/drivers/usbhost/usbhost_registerclass.c @@ -86,7 +86,7 @@ * usbclass - An write-able instance of struct usbhost_registry_s that * will be maintained in a registry. * - * Returned Values: + * Returned Value: * On success, this function will return zero (OK). Otherwise, a negated * errno value is returned. * diff --git a/drivers/usbhost/usbhost_skeleton.c b/drivers/usbhost/usbhost_skeleton.c index 651f99fb52785bc1293115a22558335d28239680..c79d2498aeb113c5e711b596cd6bc2f0e3356d29 100644 --- a/drivers/usbhost/usbhost_skeleton.c +++ b/drivers/usbhost/usbhost_skeleton.c @@ -242,7 +242,7 @@ static void usbhost_takesem(sem_t *sem) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -269,7 +269,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -345,7 +345,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -409,7 +409,7 @@ static void usbhost_destroy(FAR void *arg) * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -623,7 +623,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -700,7 +700,7 @@ static inline int usbhost_devinit(FAR struct usbhost_state_s *priv) * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -720,7 +720,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -741,7 +741,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -763,7 +763,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -785,7 +785,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -811,7 +811,7 @@ static inline int usbhost_talloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -855,7 +855,7 @@ static inline int usbhost_tfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -930,7 +930,7 @@ static FAR struct usbhost_class_s *usbhost_create(FAR struct usbhost_hubport_s * * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -989,7 +989,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * 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 * @@ -1061,7 +1061,7 @@ static int usbhost_disconnected(struct usbhost_class_s *usbclass) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_storage.c b/drivers/usbhost/usbhost_storage.c index f78a58ce545e80bc18bba36896b2ade7f26c946f..89ff54cac7b06e69ac67968e6306954ba8b20638 100644 --- a/drivers/usbhost/usbhost_storage.c +++ b/drivers/usbhost/usbhost_storage.c @@ -357,7 +357,7 @@ static void usbhost_takesem(sem_t *sem) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -411,7 +411,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -502,7 +502,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, char *dev * Input Parameters: * cbw/csw - A reference to the CBW/CSW to dump. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -548,7 +548,7 @@ static void usbhost_dumpcsw(FAR struct usbmsc_csw_s *csw) * Input Parameters: * cbw - A reference to allocated and initialized CBW to be built. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -674,7 +674,7 @@ usbhost_writecbw(size_t startsector, uint16_t blocksize, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -912,7 +912,7 @@ static inline int usbhost_inquiry(FAR struct usbhost_state_s *priv) * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -986,7 +986,7 @@ static void usbhost_destroy(FAR void *arg) * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1209,7 +1209,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1400,7 +1400,7 @@ static inline int usbhost_initvolume(FAR struct usbhost_state_s *priv) * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1419,7 +1419,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * Input Parameters: * val - A pointer to the first byte of the big endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1439,7 +1439,7 @@ static inline uint16_t usbhost_getbe16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1460,7 +1460,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1481,7 +1481,7 @@ static void usbhost_putbe16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1503,7 +1503,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1525,7 +1525,7 @@ static inline uint32_t usbhost_getbe32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1548,7 +1548,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1570,7 +1570,7 @@ static void usbhost_putbe32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1596,7 +1596,7 @@ static inline int usbhost_talloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1630,7 +1630,7 @@ static inline int usbhost_tfree(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1669,7 +1669,7 @@ static FAR struct usbmsc_cbw_s *usbhost_cbwalloc(FAR struct usbhost_state_s *pri * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1748,7 +1748,7 @@ usbhost_create(FAR struct usbhost_hubport_s *hport, * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1807,7 +1807,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * 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 * @@ -2286,7 +2286,7 @@ static int usbhost_ioctl(FAR struct inode *inode, int cmd, unsigned long arg) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbhost/usbhost_xboxcontroller.c b/drivers/usbhost/usbhost_xboxcontroller.c index 3ba40c204f385440e54b7fa7a99b5699986135f3..91b0b5093c8ce50fd773e11d63cec4e4333f6d37 100644 --- a/drivers/usbhost/usbhost_xboxcontroller.c +++ b/drivers/usbhost/usbhost_xboxcontroller.c @@ -365,7 +365,7 @@ static void usbhost_takesem(sem_t *sem) * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s. NULL is returned on failure; this function will * will fail only if there are insufficient resources to create another @@ -392,7 +392,7 @@ static inline FAR struct usbhost_state_s *usbhost_allocclass(void) * Input Parameters: * usbclass - A reference to the class instance to be freed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -468,7 +468,7 @@ static inline void usbhost_mkdevname(FAR struct usbhost_state_s *priv, * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -534,7 +534,7 @@ static void usbhost_destroy(FAR void *arg) * Description: * Wake any threads waiting for controller data * - * Input Paramters: + * Input Parameters: * priv - A reference to the controller state structure. * * Returned Value: @@ -586,7 +586,7 @@ static void usbhost_notify(FAR struct usbhost_state_s *priv) * Input Parameters: * arg - A reference to the class instance to be destroyed. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1060,7 +1060,7 @@ errout: * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1291,7 +1291,7 @@ static inline int usbhost_cfgdesc(FAR struct usbhost_state_s *priv, * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1384,7 +1384,7 @@ errout: * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * ****************************************************************************/ @@ -1404,7 +1404,7 @@ static inline uint16_t usbhost_getle16(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1425,7 +1425,7 @@ static void usbhost_putle16(uint8_t *dest, uint16_t val) * dest - A pointer to the first byte to save the big endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1447,7 +1447,7 @@ static inline uint32_t usbhost_getle32(const uint8_t *val) * dest - A pointer to the first byte to save the little endian value. * val - The 32-bit value to be saved. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -1471,7 +1471,7 @@ static void usbhost_putle32(uint8_t *dest, uint32_t val) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1497,7 +1497,7 @@ static inline int usbhost_talloc(FAR struct usbhost_state_s *priv) * Input Parameters: * priv - A reference to the class instance. * - * Returned Values: + * Returned Value: * On sucess, zero (OK) is returned. On failure, an negated errno value * is returned to indicate the nature of the failure. * @@ -1541,7 +1541,7 @@ static inline int usbhost_tfree(FAR struct usbhost_state_s *priv) * id - In the case where the device supports multiple base classes, * subclasses, or protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate * with the USB host class. NULL is returned on failure; this function @@ -1624,7 +1624,7 @@ static FAR struct usbhost_class_s *usbhost_create(FAR struct usbhost_hubport_s * * descriptor. * desclen - The length in bytes of the configuration 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 * @@ -1683,7 +1683,7 @@ static int usbhost_connect(FAR struct usbhost_class_s *usbclass, * usbclass - The USB host class entry previously obtained from a call to * create(). * - * 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 * @@ -2208,7 +2208,7 @@ errout: * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * diff --git a/drivers/usbmonitor/usbmonitor.c b/drivers/usbmonitor/usbmonitor.c index e3ccb1e821ff5ea608323bd4ca85db84bc5db433..548c39b749933e11ae315741e7a307fa342573bc 100644 --- a/drivers/usbmonitor/usbmonitor.c +++ b/drivers/usbmonitor/usbmonitor.c @@ -197,7 +197,7 @@ static int usbmonitor_daemon(int argc, char **argv) * Input Parameters: * None * - * Returned values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * @@ -259,7 +259,7 @@ int usbmonitor_start(void) * Input Parameters: * None * - * Returned values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * diff --git a/drivers/wireless/cc1101.c b/drivers/wireless/cc1101.c index 9c008f798d83f7d4031688c53f66df87fb78f82c..e31a6e2a1db65d6030f93334d6ba088fa668700d 100644 --- a/drivers/wireless/cc1101.c +++ b/drivers/wireless/cc1101.c @@ -326,7 +326,7 @@ void cc1101_access_end(FAR struct cc1101_dev_s *dev) /* CC1101 Access with Range Check * - * Input Paramters: + * Input Parameters: * dev CC1101 Private Structure * addr CC1101 Address * buf Pointer to buffer, either for read or write access diff --git a/drivers/wireless/cc3000/wlan.c b/drivers/wireless/cc3000/wlan.c index c77488bcf43fba8c067bfca4442db90d4ebf0d74..2e2334393594f09042cd2dc9565696ca71ecf4a4 100644 --- a/drivers/wireless/cc3000/wlan.c +++ b/drivers/wireless/cc3000/wlan.c @@ -1216,7 +1216,7 @@ long wlan_smart_config_set_prefix(FAR char *cNewPrefix) * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ @@ -1242,7 +1242,7 @@ signed long aes_read_key(uint8_t *key) * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ diff --git a/drivers/wireless/ieee802154/xbee/xbee.c b/drivers/wireless/ieee802154/xbee/xbee.c index c0a7fd0ca029227895ecd92242f2b67063066e85..3cd82479df768f6b3dd818ac29cfd865628500ed 100644 --- a/drivers/wireless/ieee802154/xbee/xbee.c +++ b/drivers/wireless/ieee802154/xbee/xbee.c @@ -386,7 +386,7 @@ static void xbee_attnworker(FAR void *arg) * datalen - The size of the data section of the frame. This is the value * included as the second and third byte of the frame. * - * Returns: + * Returned Value: * true - Frame type is known and length is logical * false - Frame type is unknown or length is invalid for frame type * @@ -453,7 +453,7 @@ static bool xbee_validate_apiframe(uint8_t frametype, uint16_t datalen) * frame - pointer to the frame data * framelen - size of the overall frame. NOT the data length field * - * Returns: + * Returned Value: * true - Checksum is valid * false - Checksum is invalid * diff --git a/drivers/wireless/ieee802154/xbee/xbee_netdev.c b/drivers/wireless/ieee802154/xbee/xbee_netdev.c index 1c0c682057d8929618c055f2d94a60814704713d..ea7db25986de180bd8fe7d0d0f578174114118b0 100644 --- a/drivers/wireless/ieee802154/xbee/xbee_netdev.c +++ b/drivers/wireless/ieee802154/xbee/xbee_netdev.c @@ -665,7 +665,7 @@ static void xbeenet_txpoll_expiry(int argc, wdparm_t arg, ...) * Description: * Get the extended address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * eaddr - The location in which to return the extended address. * @@ -702,7 +702,7 @@ static int xbeenet_coord_eaddr(FAR struct radio_driver_s *radio, * Description: * Get the short address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * saddr - The location in which to return the short address. * @@ -1168,7 +1168,7 @@ static int xbeenet_ioctl(FAR struct net_driver_s *dev, int cmd, * Description * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1200,7 +1200,7 @@ static int xbeenet_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the XBee MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1272,7 +1272,7 @@ static int xbeenet_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * @@ -1349,7 +1349,7 @@ static int xbeenet_properties(FAR struct radio_driver_s *netdev, * Input Parameters: * mac - Pointer to the mac layer struct to be registered. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/drivers/wireless/spirit/drivers/spirit_netdev.c b/drivers/wireless/spirit/drivers/spirit_netdev.c index e951f3fe0a9df5e77b9ef8c6e9af7fd6d617664c..4a9ef1e54eb66b473c11c2d2835baf714c1d48d6 100644 --- a/drivers/wireless/spirit/drivers/spirit_netdev.c +++ b/drivers/wireless/spirit/drivers/spirit_netdev.c @@ -2262,7 +2262,7 @@ static int spirit_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -2294,7 +2294,7 @@ static int spirit_get_mhrlen(FAR struct radio_driver_s *netdev, * indirectly as a consequence of a TX poll that generates a series of * 6LoWPAN radio packets. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -2407,7 +2407,7 @@ static int spirit_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/drivers/wireless/spirit/include/spirit_general.h b/drivers/wireless/spirit/include/spirit_general.h index 204b3dfcee24472554b3f98cb8feb96a53459760..aa0b7f4c6df8c068139ad8b5e3f09d7742ee0574 100644 --- a/drivers/wireless/spirit/include/spirit_general.h +++ b/drivers/wireless/spirit/include/spirit_general.h @@ -128,7 +128,7 @@ enum spirit_version_e * * Description: * - * Input parameters: + * Input Parameters: * * Returned Value: * diff --git a/drivers/wireless/spirit/include/spirit_spi.h b/drivers/wireless/spirit/include/spirit_spi.h index 7cc891d603101ff0c3f4cc3079de0f64880b9df2..6fbdff33d8049253af4c4a38b563286c697f1c27 100644 --- a/drivers/wireless/spirit/include/spirit_spi.h +++ b/drivers/wireless/spirit/include/spirit_spi.h @@ -86,7 +86,7 @@ struct spi_dev_s; /* Forward reference */ * Description: * Read single or multiple SPIRIT1 register * - * Input parameters: + * Input Parameters: * regaddr: Base register's address to be read * buffer: Pointer to the buffer of registers' values to be read * buflen: Number of register values to be read @@ -106,7 +106,7 @@ int spirit_reg_read(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Read single or multiple SPIRIT1 register. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * buffer - Pointer to the buffer of register values to write @@ -129,7 +129,7 @@ int spirit_reg_write(FAR struct spirit_library_s *spirit, uint8_t regaddr, * atomic only in the sense that other accesses to the SPI bus are * prohibited throughout the operation. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * clrbits - Bits to clear in the register @@ -150,7 +150,7 @@ int spirit_reg_modify(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Send a command * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * cmd - Command code to be sent * @@ -168,7 +168,7 @@ int spirit_command(FAR struct spirit_library_s *spirit, uint8_t cmd); * Description: * Read data from RX FIFO * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of bytes to be written @@ -188,7 +188,7 @@ int spirit_fifo_read(FAR struct spirit_library_s *spirit, FAR uint8_t *buffer, * Description: * Write data into TX FIFO. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of data values to be written. diff --git a/drivers/wireless/spirit/lib/spirit_spi.c b/drivers/wireless/spirit/lib/spirit_spi.c index 752dc78650cfceb82fb90d2219379b49bd079494..3433dfcafe6e1f318a2b9126886f904860d45152 100644 --- a/drivers/wireless/spirit/lib/spirit_spi.c +++ b/drivers/wireless/spirit/lib/spirit_spi.c @@ -254,7 +254,7 @@ static void spirit_unlock(FAR struct spi_dev_s *spi) * Description: * Read single or multiple SPIRIT1 register * - * Input parameters: + * Input Parameters: * * regaddr: Base register's address to be read * buffer: Pointer to the buffer of registers' values to be read @@ -309,7 +309,7 @@ int spirit_reg_read(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Read single or multiple SPIRIT1 register. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * buffer - Pointer to the buffer of register values to write @@ -363,7 +363,7 @@ int spirit_reg_write(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Perform atomic read/modify/write on a single SPIRIT1 register. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * regaddr - Base register's address to write * clrbits - Bits to clear in the register @@ -442,7 +442,7 @@ int spirit_reg_modify(FAR struct spirit_library_s *spirit, uint8_t regaddr, * Description: * Send a command * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * cmd - Command code to be sent * @@ -489,7 +489,7 @@ int spirit_command(FAR struct spirit_library_s *spirit, uint8_t cmd) * Description: * Read data from RX FIFO * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of bytes to be written @@ -543,7 +543,7 @@ int spirit_fifo_read(FAR struct spirit_library_s *spirit, FAR uint8_t *buffer, * Description: * Write data into TX FIFO. * - * Input parameters: + * Input Parameters: * spirit - Reference to an instance of the driver state stucture. * buffer - Pointer to the buffer of data values to write * buflen - Number of data values to be written. diff --git a/fs/dirent/fs_closedir.c b/fs/dirent/fs_closedir.c index 6b74bbdf19761bad461fcde7a4d0c7bf5d9a28d6..5ab991c3093a112b131645261cc988d13b545eaf 100644 --- a/fs/dirent/fs_closedir.c +++ b/fs/dirent/fs_closedir.c @@ -64,10 +64,10 @@ * 'dirp'. The directory stream descriptor 'dirp' is not available after * this call. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous call to opendir(); * - * Return: + * Returned Value: * The closedir() function returns 0 on success. On error, -1 is * returned, and errno is set appropriately. * diff --git a/fs/dirent/fs_opendir.c b/fs/dirent/fs_opendir.c index 43b62b9c87910196437b71cdce4d556e4f019ad2..e8bedefff7afb00c3f4dbbef6d687218adfe9904 100644 --- a/fs/dirent/fs_opendir.c +++ b/fs/dirent/fs_opendir.c @@ -61,12 +61,12 @@ * Description: * Handle the case where the inode to be opened is within a mountpoint. * - * Inputs: + * Input Parameters: * inode -- the inode of the mountpoint to open * relpath -- the relative path within the mountpoint to open * dir -- the dirent structure to be initialized * - * Return: + * Returned Value: * On success, OK is returned; Otherwise, a positive errno is returned. * ****************************************************************************/ @@ -127,11 +127,11 @@ static inline int open_mountpoint(FAR struct inode *inode, * Handle the case where the inode to be opened is within the top-level * pseudo-file system. * - * Inputs: + * Input Parameters: * inode -- the inode of the mountpoint to open * dir -- the dirent structure to be initialized * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -164,10 +164,10 @@ static void open_pseudodir(FAR struct inode *inode, FAR struct fs_dirent_s *dir) * and, therefore, it must be a directory node. But is has no children * to be enumerated either. * - * Inputs: + * Input Parameters: * dir -- the dirent structure to be initialized * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -204,10 +204,10 @@ static inline void open_emptydir(FAR struct fs_dirent_s *dir) * directory name, and returns a pointer to the directory stream. The * stream is positioned at the first entry in the directory. * - * Inputs: + * Input Parameters: * path -- the directory to open * - * Return: + * Returned Value: * The opendir() function returns a pointer to the directory stream. On * error, NULL is returned, and errno is set appropriately. * diff --git a/fs/dirent/fs_readdir.c b/fs/dirent/fs_readdir.c index 93b2f654fdb5137de93d9dd3b406d80386854f96..f7cc4a69e6384e8e8ba16e05674cababff6d6e27 100644 --- a/fs/dirent/fs_readdir.c +++ b/fs/dirent/fs_readdir.c @@ -153,10 +153,10 @@ static inline int readpseudodir(struct fs_dirent_s *idir) * to by dir. It returns NULL on reaching the end-of-file or if an error * occurred. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous call to opendir(); * - * Return: + * Returned Value: * The readdir() function returns a pointer to a dirent structure, or NULL * if an error occurs or end-of-file is reached. On error, errno is set * appropriately. diff --git a/fs/dirent/fs_rewinddir.c b/fs/dirent/fs_rewinddir.c index 7ad252d8aa5af5d5884e963b8c330cc2e22c7fae..6450a5859f3a6456921c33ef3664d874bd2b8fbb 100644 --- a/fs/dirent/fs_rewinddir.c +++ b/fs/dirent/fs_rewinddir.c @@ -93,11 +93,11 @@ static inline void rewindpseudodir(struct fs_dirent_s *idir) * The rewinddir() function resets the position of the * directory stream dir to the beginning of the directory. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/dirent/fs_seekdir.c b/fs/dirent/fs_seekdir.c index 761dba33cd7578a514123d371297c9e6c598f546..896658b690b2129f32b67ab63030a63708d603f2 100644 --- a/fs/dirent/fs_seekdir.c +++ b/fs/dirent/fs_seekdir.c @@ -188,12 +188,12 @@ static inline void seekmountptdir(struct fs_dirent_s *idir, off_t offset) * which the next readdir() call will start. seekdir() should be used with * an offset returned by telldir(). * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * offset -- offset to seek to * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/driver/driver.h b/fs/driver/driver.h index bbe605602e17835212f5c55f3d70f42554d8e4d0..dd15fb33bb09fb2386ee165f99224dff9da264aa 100644 --- a/fs/driver/driver.h +++ b/fs/driver/driver.h @@ -69,13 +69,13 @@ extern "C" * Description: * Return the inode of the block driver specified by 'pathname' * - * Inputs: + * Input Parameters: * pathname - the full path to the block driver to be located * mountflags - if MS_RDONLY is not set, then driver must support write * operations (see include/sys/mount.h) * ppinode - address of the location to return the inode reference * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - pathname or pinode is NULL @@ -98,7 +98,7 @@ int find_blockdriver(FAR const char *pathname, int mountflags, * Create a temporary char driver using drivers/bch to mediate character * oriented accessed to the block driver. * - * Input parameters: + * Input Parameters: * blkdev - The path to the block driver * oflags - Character driver open flags * diff --git a/fs/driver/fs_blockproxy.c b/fs/driver/fs_blockproxy.c index 1f15370bcdf5107d15b4755f0674d7e10aa91370..74d9b75c89a58d54f24d67880e99055fb68383ba 100644 --- a/fs/driver/fs_blockproxy.c +++ b/fs/driver/fs_blockproxy.c @@ -77,7 +77,7 @@ static sem_t g_devno_sem = SEM_INITIALIZER(1); * psuedo-file system. We cannot use mktemp for this because it will * attempt to open() the file. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -146,7 +146,7 @@ static FAR char *unique_chardev(void) * Create a temporary char driver using drivers/bch to mediate character * oriented accessed to the block driver. * - * Input parameters: + * Input Parameters: * blkdev - The path to the block driver * oflags - Character driver open flags * diff --git a/fs/driver/fs_closeblockdriver.c b/fs/driver/fs_closeblockdriver.c index 7c9c60244d91bb04d416e87d6149136e22491e0f..9ce13df6fda05df65b6b82bf4620d8895d5b4a93 100644 --- a/fs/driver/fs_closeblockdriver.c +++ b/fs/driver/fs_closeblockdriver.c @@ -55,10 +55,10 @@ * Description: * Call the close method and release the inode * - * Inputs: + * Input Parameters: * inode - reference to the inode of a block driver opened by open_blockdriver * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - inode is NULL diff --git a/fs/driver/fs_findblockdriver.c b/fs/driver/fs_findblockdriver.c index 0615a474b233af2d6106f21c649d743ce4575bed..f85bff032f46faf940dc9ed03905b77c2836807f 100644 --- a/fs/driver/fs_findblockdriver.c +++ b/fs/driver/fs_findblockdriver.c @@ -61,13 +61,13 @@ * Description: * Return the inode of the block driver specified by 'pathname' * - * Inputs: + * Input Parameters: * pathname - the full path to the block driver to be located * mountflags - if MS_RDONLY is not set, then driver must support write * operations (see include/sys/mount.h) * ppinode - address of the location to return the inode reference * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - pathname or pinode is NULL diff --git a/fs/driver/fs_openblockdriver.c b/fs/driver/fs_openblockdriver.c index 9a42020bf787bbcfd0ecf03140e7dd6c27f9efa1..e88d05d75241f9762cffcc6f77e9feb1f3ee77b2 100644 --- a/fs/driver/fs_openblockdriver.c +++ b/fs/driver/fs_openblockdriver.c @@ -56,13 +56,13 @@ * Description: * Return the inode of the block driver specified by 'pathname' * - * Inputs: + * Input Parameters: * pathname - the full path to the block driver to be opened * mountflags - if MS_RDONLY is not set, then driver must support write * operations (see include/sys/mount.h) * ppinode - address of the location to return the inode reference * - * Return: + * Returned Value: * Returns zero on success or a negated errno on failure: * * EINVAL - pathname or pinode is NULL diff --git a/fs/driver/fs_registerblockdriver.c b/fs/driver/fs_registerblockdriver.c index 690961907131d025c86371c459494860ca3a62ca..f1da64c9f1a5f120e0eaf7aa6682bbbcf0deb1e5 100644 --- a/fs/driver/fs_registerblockdriver.c +++ b/fs/driver/fs_registerblockdriver.c @@ -58,7 +58,7 @@ * Description: * Register a block driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * bops - The block driver operations structure * mode - inmode priviledges (not used) diff --git a/fs/driver/fs_registerdriver.c b/fs/driver/fs_registerdriver.c index 501bf93f662a518a796acacaa1b17da62a3987ae..85f32e48a94582816edcf89b692718905d62c830 100644 --- a/fs/driver/fs_registerdriver.c +++ b/fs/driver/fs_registerdriver.c @@ -56,7 +56,7 @@ * Description: * Register a character driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * fops - The file operations structure * mode - inmode priviledges (not used) diff --git a/fs/fat/fs_fat32dirent.c b/fs/fat/fs_fat32dirent.c index 7ea497b62a19c492a986d535c294b1cda8c7ff7c..bc2f79801f42c5a90634f5af967737ca93762278 100644 --- a/fs/fat/fs_fat32dirent.c +++ b/fs/fat/fs_fat32dirent.c @@ -213,7 +213,7 @@ static uint8_t fat_lfnchecksum(const uint8_t *sfname) * code pages". The logic below does not, at present, support any other * character sets. * - * Returned value: + * Returned Value: * OK - The path refers to a valid 8.3 FAT file name and has been properly * converted and stored in dirinfo. * <0 - Otherwise an negated error is returned meaning that the string is @@ -468,7 +468,7 @@ errout: * 2. '.' (dot) can occur more than once in a filename. Extension is * the substring after the last dot. * - * Returned value: + * Returned Value: * OK - The path refers to a valid long file name and has been properly * stored in dirinfo. * <0 - Otherwise an negated error is returned meaning that the string is @@ -562,7 +562,7 @@ errout: * * This function is called only from fat_putlfname() * - * Returned value: + * Returned Value: * OK - The alias was created correctly. * <0 - Otherwise an negated error is returned. * @@ -767,7 +767,7 @@ static inline int fat_createalias(struct fat_dirinfo_s *dirinfo) * NOTE: This function does not restore the directory entry that was in the * sector cache * - * Returned value: + * Returned Value: * OK - The alias is unique. * <0 - Otherwise an negated error is returned. * @@ -807,7 +807,7 @@ static inline int fat_findalias(struct fat_mountpt_s *fs, * sector cache * * information upon return. - * Returned value: + * Returned Value: * OK - The alias is unique. * <0 - Otherwise an negated error is returned. * diff --git a/fs/fat/fs_fat32util.c b/fs/fat/fs_fat32util.c index cdbfc2d4cb580718d24520b8a8545f8e66d5c528..47a12574faa72940fe4dabf47d0b5be1ccf19aa9 100644 --- a/fs/fat/fs_fat32util.c +++ b/fs/fat/fs_fat32util.c @@ -813,7 +813,8 @@ off_t fat_cluster2sector(FAR struct fat_mountpt_s *fs, uint32_t cluster) * Description: * Get the next cluster start from the FAT. * - * Return: <0: error, 0:cluster unassigned, >=0: start sector of cluster + * Returned Value: + * <0: error, 0:cluster unassigned, >=0: start sector of cluster * ****************************************************************************/ @@ -1161,7 +1162,7 @@ int fat_removechain(struct fat_mountpt_s *fs, uint32_t cluster) * Add a new cluster to the chain following cluster (if cluster is non- * NULL). if cluster is zero, then a new chain is created. * - * Return: + * Returned Value: * <0:error, 0: no free cluster, >=2: new cluster number * ****************************************************************************/ diff --git a/fs/inode/fs_inodereserve.c b/fs/inode/fs_inodereserve.c index 1c08b0556769e1fa7e259b7aeac5039a300fc0be..f1b0bc685fd31104fee3938d81a885f13a91f745 100644 --- a/fs/inode/fs_inodereserve.c +++ b/fs/inode/fs_inodereserve.c @@ -144,7 +144,7 @@ static void inode_insert(FAR struct inode *node, * Reserve an (initialized) inode the pseudo file system. The initial * reference count on the new inode is zero. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * inode - The location to return the inode pointer * diff --git a/fs/inode/inode.h b/fs/inode/inode.h index 71b1af8e92792bf6d8070079e349dfb7e0c006ea..ae1ef0ce48eb17b86dae90406c52595c47c21a44 100644 --- a/fs/inode/inode.h +++ b/fs/inode/inode.h @@ -293,7 +293,7 @@ const char *inode_nextname(FAR const char *name); * * NOTE: Caller must hold the inode semaphore * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * inode - The location to return the inode pointer * diff --git a/fs/mount/fs_mount.c b/fs/mount/fs_mount.c index 62a982b40e8fdf15858117413be445511564cf03..404b700fce733519a10c62532cbf07a014946b65 100644 --- a/fs/mount/fs_mount.c +++ b/fs/mount/fs_mount.c @@ -214,7 +214,7 @@ mount_findfs(FAR const struct fsmap_t *fstab, FAR const char *filesystemtype) * mount() attaches the filesystem specified by the 'source' block device * name into the root file system at the path specified by 'target.' * - * Return: + * Returned Value: * Zero is returned on success; -1 is returned on an error and errno is * set appropriately: * diff --git a/fs/mount/fs_umount2.c b/fs/mount/fs_umount2.c index e342ae2e16dfd06745113375caf577eb48ad9bf5..598cb7b1967f72cf8e8277533cf15f38d01ea958 100644 --- a/fs/mount/fs_umount2.c +++ b/fs/mount/fs_umount2.c @@ -59,7 +59,7 @@ * umount() detaches the filesystem mounted at the path specified by * 'target.' * - * Return: + * Returned Value: * Zero is returned on success; -1 is returned on an error and errno is * set appropriately: * diff --git a/fs/mqueue/mq_close.c b/fs/mqueue/mq_close.c index 4578c1cc085b9b3153566b3185d7b70bc53febd5..adbe02535021f393b3e0f16b5dbe878179d35a87 100644 --- a/fs/mqueue/mq_close.c +++ b/fs/mqueue/mq_close.c @@ -67,7 +67,7 @@ * mqdes - Message queue descriptor. * group - Group that has the open descriptor. * - * Return Value: + * Returned Value: * Zero (OK) if the message queue is closed successfully. Otherwise, a * negated errno value is returned. * @@ -125,7 +125,7 @@ int nxmq_close_group(mqd_t mqdes, FAR struct task_group_s *group) * Parameters: * mqdes - Message queue descriptor. * - * Return Value: + * Returned Value: * 0 (OK) if the message queue is closed successfully, * otherwise, -1 (ERROR). * @@ -176,7 +176,7 @@ int mq_close(mqd_t mqdes) * Parameters: * inode - The message queue inode * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/mqueue/mq_open.c b/fs/mqueue/mq_open.c index 5c372a50d5bc5ab2b0fb3c5c29b3a75e2a67b71c..2f9a338fdaf7b307abd9ed594a1d32ff439e3ab0 100644 --- a/fs/mqueue/mq_open.c +++ b/fs/mqueue/mq_open.c @@ -79,7 +79,7 @@ * created to determine the maximum number of * messages that may be placed in the message queue. * - * Return Value: + * Returned Value: * A message queue descriptor or (mqd_t)-1 (ERROR) * * Assumptions: diff --git a/fs/mqueue/mq_unlink.c b/fs/mqueue/mq_unlink.c index 9705a0ef8bad8998890e0772e6a4fc22bae6fc4a..7610eee43c03ebec412a44e3da9cb10bb784454a 100644 --- a/fs/mqueue/mq_unlink.c +++ b/fs/mqueue/mq_unlink.c @@ -66,7 +66,7 @@ * Parameters: * mq_name - Name of the message queue * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/fs/mqueue/mqueue.h b/fs/mqueue/mqueue.h index 4edc08ece18b0d2f11e264d8fb94b940746be45b..b8cdb36d206e4c36f6bec2943212dedae8b3f6aa 100644 --- a/fs/mqueue/mqueue.h +++ b/fs/mqueue/mqueue.h @@ -80,7 +80,7 @@ extern "C" * Parameters: * inode - The message queue inode * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/fs/nfs/nfs_util.c b/fs/nfs/nfs_util.c index 8a6967cbbea439ed58765bf98f65cda689cbf53d..71709708920cdd3e8fc63b77dfe7167d91c18b17 100644 --- a/fs/nfs/nfs_util.c +++ b/fs/nfs/nfs_util.c @@ -194,7 +194,7 @@ int nfs_checkmount(struct nfsmount *nmp) * Perform the NFS request. On successful receipt, it verifies the NFS level of the * returned values. * - * Return Value: + * Returned Value: * Zero on success; a positive errno value on failure. * ****************************************************************************/ @@ -380,7 +380,7 @@ int nfs_lookup(struct nfsmount *nmp, FAR const char *filename, * Given a path to something that may or may not be in the file system, * return the handle of the directory entry of the requested object. * - * Return Value: + * Returned Value: * Zero on success; a positive errno value on failure. * ****************************************************************************/ @@ -488,7 +488,7 @@ int nfs_findnode(struct nfsmount *nmp, FAR const char *relpath, * return the handle of the entry of the directory containing the requested * object. * - * Return Value: + * Returned Value: * Zero on success; a positive errno value on failure. * ****************************************************************************/ @@ -577,7 +577,7 @@ int nfs_finddir(struct nfsmount *nmp, FAR const char *relpath, * Desciption: * Update file attributes on write or after the file is modified. * - * Return Value: + * Returned Value: * None. * ****************************************************************************/ diff --git a/fs/nxffs/nxffs.h b/fs/nxffs/nxffs.h index bc979a3050a1f726e3c90cdc98e9f8a8177ff08e..c6ae19bed1a174eb7d9f5f201179aab9e931682a 100644 --- a/fs/nxffs/nxffs.h +++ b/fs/nxffs/nxffs.h @@ -386,7 +386,7 @@ int nxffs_limits(FAR struct nxffs_volume_s *volume); * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint16_t representing the whole 16-bit integer value * * Defined in nxffs_util.c @@ -405,7 +405,7 @@ uint16_t nxffs_rdle16(FAR const uint8_t *val); * dest - A pointer to the first byte to save the little endian value. * val - The 16-bit value to be saved. * - * Returned Values: + * Returned Value: * None * * Defined in nxffs_util.c @@ -423,7 +423,7 @@ void nxffs_wrle16(uint8_t *dest, uint16_t val); * Input Parameters: * val - A pointer to the first byte of the little endian value. * - * Returned Values: + * Returned Value: * A uint32_t representing the whole 32-bit integer value * * Defined in nxffs_util.c @@ -461,7 +461,7 @@ void nxffs_wrle32(uint8_t *dest, uint32_t val); * buffer - Address of the start of the memory to check. * buflen - The number of bytes to check. * - * Returned Values: + * Returned Value: * The number of erased bytes found at the beginning of the memory region. * * Defined in nxffs_util.c @@ -581,7 +581,7 @@ int nxffs_getc(FAR struct nxffs_volume_s *volume, uint16_t reserve); * caller may call kmm_free upon return of this function if necessary to * free the entry container. * - * Input parameters: + * Input Parameters: * entry - The entry to be freed. * * Returned Value: @@ -679,7 +679,7 @@ off_t nxffs_inodeend(FAR struct nxffs_volume_s *volume, * volume - Describes the NXFFS volume * block - The (logical) block number to load and verify. * - * Returned Values: + * Returned Value: * OK (zero( is returned on success. Otherwise, a negated errno value is * returned indicating the nature of the failure: * @@ -836,7 +836,7 @@ FAR struct nxffs_wrfile_s *nxffs_findwriter(FAR struct nxffs_volume_s *volume); * Note that in either case, the inode name has already been written to * FLASH. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the inode header to write * @@ -858,7 +858,7 @@ int nxffs_wrinode(FAR struct nxffs_volume_s *volume, * The packing logic has moved an inode. Check if any open files are using * this inode and, if so, move the data in the open file structure as well. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * @@ -877,7 +877,7 @@ int nxffs_updateinode(FAR struct nxffs_volume_s *volume, * Description: * Zero-extend a file. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * length - The new, extended length of the file @@ -1074,7 +1074,7 @@ int nxffs_rminode(FAR struct nxffs_volume_s *volume, FAR const char *name); * Input Parameters: * volume - The volume to be packed. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * diff --git a/fs/nxffs/nxffs_block.c b/fs/nxffs/nxffs_block.c index c1cad2afe4a3aeed7ff89f1589925d533e972fe7..06d5174949363d5f400c5419f695036d97640c08 100644 --- a/fs/nxffs/nxffs_block.c +++ b/fs/nxffs/nxffs_block.c @@ -66,7 +66,7 @@ * volume - Describes the NXFFS volume * block - The (logical) block number to load and verify. * - * Returned Values: + * Returned Value: * OK (zero( is returned on success. Otherwise, a negated errno value is * returned indicating the nature of the failure: * diff --git a/fs/nxffs/nxffs_inode.c b/fs/nxffs/nxffs_inode.c index 2240c18313f2618283bf0d734a719e472dc4a337..e3c52421a34a65cf221a1e04905bd3ed5423a262 100644 --- a/fs/nxffs/nxffs_inode.c +++ b/fs/nxffs/nxffs_inode.c @@ -213,7 +213,7 @@ errout: * caller may call kmm_free upon return of this function if necessary to * free the entry container. * - * Input parameters: + * Input Parameters: * entry - The entry to be freed. * * Returned Value: diff --git a/fs/nxffs/nxffs_open.c b/fs/nxffs/nxffs_open.c index f5a65e10d2e8150e0cd6f1bf5f4853aabd109103..8276a399a63e12e607fa3b8938c70255cb9ea013 100644 --- a/fs/nxffs/nxffs_open.c +++ b/fs/nxffs/nxffs_open.c @@ -855,7 +855,7 @@ static inline void nxffs_freeofile(FAR struct nxffs_volume_s *volume, * file was open for writing, and finally, * 3. Write the new file inode. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * wrfile - Describes the state of the open file * @@ -1200,7 +1200,7 @@ errout: * Note that in either case, the inode name has already been written to * FLASH. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the inode header to write * @@ -1283,7 +1283,7 @@ errout: * The packing logic has moved an inode. Check if any open files are using * this inode and, if so, move the data in the open file structure as well. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * diff --git a/fs/nxffs/nxffs_pack.c b/fs/nxffs/nxffs_pack.c index 134ee430a63da248c604b823b55ecd9e39796a3a..0c6819a465f1d7d2b62d6d733dce6401763894f6 100644 --- a/fs/nxffs/nxffs_pack.c +++ b/fs/nxffs/nxffs_pack.c @@ -164,7 +164,7 @@ static off_t nxffs_packtell(FAR struct nxffs_volume_s *volume, * Input Parameters: * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -191,7 +191,7 @@ static inline bool nxffs_packvalid(FAR struct nxffs_pack_s *pack) * volume - The volume to be packed. * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * The offset to the data area on the first valid block. Zero is return * if there are no valid blocks or if there are no valid inode headers * after the first valid block. @@ -261,7 +261,7 @@ static inline off_t nxffs_mediacheck(FAR struct nxffs_volume_s *volume, * -- then no packing can be performed. In this case, then the free * flash offset is returned through this location. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. If -ENOSPC is returned then the * free FLASH offset is also returned. @@ -398,7 +398,7 @@ static inline int nxffs_startpos(FAR struct nxffs_volume_s *volume, * offset - FLASH offset to the data block header (will be zero for zero- * files. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -441,7 +441,7 @@ static int nxffs_srcsetup(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -618,7 +618,7 @@ errout: * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure (not used). * @@ -727,7 +727,7 @@ static int nxffs_wrinodehdr(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -782,7 +782,7 @@ static void nxffs_wrdathdr(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * None. * ****************************************************************************/ @@ -830,7 +830,7 @@ static void nxffs_packtransfer(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -872,7 +872,7 @@ static int nxffs_endsrcblock(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -1057,7 +1057,7 @@ static inline int nxffs_packblock(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * If there is an active writer of the volume, its open file instance is * returned. NULL is returned otherwise. * @@ -1125,7 +1125,7 @@ nxffs_setupwriter(FAR struct nxffs_volume_s *volume, * volume - The volume to be packed * pack - The volume packing state structure. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * @@ -1257,7 +1257,7 @@ static inline int nxffs_packwriter(FAR struct nxffs_volume_s *volume, * Input Parameters: * volume - The volume to be packed. * - * Returned Values: + * Returned Value: * Zero on success; Otherwise, a negated errno value is returned to * indicate the nature of the failure. * diff --git a/fs/nxffs/nxffs_util.c b/fs/nxffs/nxffs_util.c index ac51140fa35b8020bf31dd443cc07bd1ae10ef29..7893798ade1a0fcdaefb09657062d3335f598d09 100644 --- a/fs/nxffs/nxffs_util.c +++ b/fs/nxffs/nxffs_util.c @@ -143,7 +143,7 @@ void nxffs_wrle32(uint8_t *dest, uint32_t val) * buffer - Address of the start of the memory to check. * buflen - The number of bytes to check. * - * Returned Values: + * Returned Value: * The number of erased bytes found at the beginning of the memory region. * ****************************************************************************/ diff --git a/fs/nxffs/nxffs_write.c b/fs/nxffs/nxffs_write.c index 1fd761e4401dc0fc05797fe21d56e8830f0dd756..c788947d83be827aea18d32ec44f5c44ca5263f0 100644 --- a/fs/nxffs/nxffs_write.c +++ b/fs/nxffs/nxffs_write.c @@ -633,7 +633,7 @@ errout: * Description: * Zero-extend a file. * - * Input parameters + * Input Parameters: * volume - Describes the NXFFS volume * entry - Describes the new inode entry * length - The new, extended length of the file diff --git a/fs/semaphore/sem_close.c b/fs/semaphore/sem_close.c index ffe687bec86b01252298311f76c1f7c5f887f67b..bd5ab9920519b7a4a69bc2ed91811e14aee4fefc 100644 --- a/fs/semaphore/sem_close.c +++ b/fs/semaphore/sem_close.c @@ -71,7 +71,7 @@ * Parameters: * sem - semaphore descriptor * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if unsuccessful. * * Assumptions: diff --git a/fs/semaphore/sem_open.c b/fs/semaphore/sem_open.c index 4bc91daeb0a4067f4e10c462d8ff1985e5765a72..c09f962798e53f8dcd05a0fc7dc70f34f173fd75 100644 --- a/fs/semaphore/sem_open.c +++ b/fs/semaphore/sem_open.c @@ -93,7 +93,7 @@ * initial values of the semaphore must be less than or equal to * SEM_VALUE_MAX. * - * Return Value: + * Returned Value: * A pointer to sem_t or SEM_FAILED if unsuccessful. * * Assumptions: diff --git a/fs/semaphore/sem_unlink.c b/fs/semaphore/sem_unlink.c index ca73a800418ad55aa1733d7bcf3ccd7016b3198f..647e3cba5c8ca76434d8153f6faffa5cb2af33a8 100644 --- a/fs/semaphore/sem_unlink.c +++ b/fs/semaphore/sem_unlink.c @@ -70,7 +70,7 @@ * Parameters: * name - Semaphore name * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if unsuccessful. * * Assumptions: diff --git a/fs/unionfs/fs_unionfs.c b/fs/unionfs/fs_unionfs.c index 0c61c2e7a0c79caaff46d912ccaf870ddabe361a..27bd733e6e4ebfd3435cb88df602a66687e3fe2a 100644 --- a/fs/unionfs/fs_unionfs.c +++ b/fs/unionfs/fs_unionfs.c @@ -2617,7 +2617,7 @@ errout_with_search: * file system appear a some path below the unionfs mountpoint, * mountpt - The full path to the mountpoint for the union file system * - * Returned value: + * Returned Value: * Zero (OK) is returned if the union file system was correctly created and * mounted. On any failure, a negated error value will be returned to * indicate the nature of the failure. diff --git a/fs/vfs/fs_fstatfs.c b/fs/vfs/fs_fstatfs.c index 80c0d1d7dd3fbbacc9506597c88d4610dc1591d0..7e4ddb3879c7b509b3da78b753d3c9f68d7a7ad6 100644 --- a/fs/vfs/fs_fstatfs.c +++ b/fs/vfs/fs_fstatfs.c @@ -54,7 +54,8 @@ /**************************************************************************** * Name: fstatfs * - * Return: Zero on success; -1 on failure with errno set: + * Returned Value: + * Zero on success; -1 on failure with errno set: * * EACCES Search permission is denied for one of the directories in the * path prefix of path. diff --git a/fs/vfs/fs_ioctl.c b/fs/vfs/fs_ioctl.c index a68dc43ce5c0e17116c04ca4a6b0cc1839751325..3127647869e60b166430c5a2e1c1dd77bffd5587 100644 --- a/fs/vfs/fs_ioctl.c +++ b/fs/vfs/fs_ioctl.c @@ -68,7 +68,7 @@ * req The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * Returns a non-negative number on success; A negated errno value is * returned on any failure (see comments ioctl() for a list of appropriate * errno values). @@ -114,7 +114,7 @@ int file_ioctl(FAR struct file *filep, int req, unsigned long arg) * req The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * -1 on failure with errno set properly: * diff --git a/fs/vfs/fs_lseek.c b/fs/vfs/fs_lseek.c index 6827d931d10a53a905d5e9b02de98b92653efd83..fcdbb85664b112eeafe0d3617c8b5d9fe663c763 100644 --- a/fs/vfs/fs_lseek.c +++ b/fs/vfs/fs_lseek.c @@ -65,7 +65,7 @@ * offset Defines the offset to position to * whence Defines how to use offset * - * Return: + * Returned Value: * The resulting offset on success. A negated errno value is returned on * any failure (see lseek comments). * @@ -146,7 +146,7 @@ off_t file_seek(FAR struct file *filep, off_t offset, int whence) * offset Defines the offset to position to * whence Defines how to use offset * - * Return: + * Returned Value: * The resulting offset on success. -1 on failure withi errno set properly: * * EBADF fd is not an open file descriptor. diff --git a/fs/vfs/fs_poll.c b/fs/vfs/fs_poll.c index 825f8d16d850f35c8c8ff87cce51cc34f662a7f9..d6b32974b4fc7c6858018238c5efc9b8f35a2510 100644 --- a/fs/vfs/fs_poll.c +++ b/fs/vfs/fs_poll.c @@ -357,14 +357,14 @@ int fdesc_poll(int fd, FAR struct pollfd *fds, bool setup) * occurred for any of the file descriptors, then poll() blocks until * one of the events occurs. * - * Inputs: + * Input Parameters: * fds - List of structures describing file descriptors to be monitored * nfds - The number of entries in the list * timeout - Specifies an upper limit on the time for which poll() will * block in milliseconds. A negative value of timeout means an infinite * timeout. * - * Return: + * Returned Value: * On success, the number of structures that have non-zero revents fields. * A value of 0 indicates that the call timed out and no file descriptors * were ready. On error, -1 is returned, and errno is set appropriately: diff --git a/fs/vfs/fs_pread.c b/fs/vfs/fs_pread.c index 782c7448fbde3bf9289630ae67d0bdb49604293a..9c7eb79461e928b1c527cae3f23910824c3b23e3 100644 --- a/fs/vfs/fs_pread.c +++ b/fs/vfs/fs_pread.c @@ -129,7 +129,7 @@ ssize_t file_pread(FAR struct file *filep, FAR void *buf, size_t nbytes, * nbytes The maximum size of the user-provided buffer * offset The file offset * - * Return: + * Returned Value: * The positive non-zero number of bytes read on success, 0 on if an * end-of-file condition, or -1 on failure with errno set appropriately. * See read() return values diff --git a/fs/vfs/fs_pwrite.c b/fs/vfs/fs_pwrite.c index 1a67d915f87fa274bbfcf198933231d525c0f61b..698b6d9eb86a84baad3e82849ee778201c02585b 100644 --- a/fs/vfs/fs_pwrite.c +++ b/fs/vfs/fs_pwrite.c @@ -126,7 +126,7 @@ ssize_t file_pwrite(FAR struct file *filep, FAR const void *buf, * buf Data to write * nbytes Length of data to write * - * Return: + * Returned Value: * The positive non-zero number of bytes read on success, 0 on if an * end-of-file condition, or -1 on failure with errno set appropriately. * See write() return values diff --git a/fs/vfs/fs_select.c b/fs/vfs/fs_select.c index b3ba38bf42cefe5117e0408fc3233074e3eeec63..e7fb11cc4f7393c60be259037d2fc7b4043bd8c7 100644 --- a/fs/vfs/fs_select.c +++ b/fs/vfs/fs_select.c @@ -84,7 +84,7 @@ * is more wasteful of resources and poll() is the recommended API to be * used. * - * Input parameters: + * Input Parameters: * nfds - the maximum fd number (+1) of any descriptor in any of the * three sets. * readfds - the set of descriptions to monitor for read-ready events @@ -93,7 +93,7 @@ * timeout - Return at this time if none of these events of interest * occur. * - * Return: + * Returned Value: * 0: Timer expired * >0: The number of bits set in the three sets of descriptors * -1: An error occurred (errno will be set appropriately) diff --git a/fs/vfs/fs_sendfile.c b/fs/vfs/fs_sendfile.c index a71dbcdf9bb80a1677acd7c1f4689d5b3830ebae..b1ef4ffb2ad33d86e5520db30fa3ea83cd898715 100644 --- a/fs/vfs/fs_sendfile.c +++ b/fs/vfs/fs_sendfile.c @@ -74,7 +74,7 @@ * different semantics and prototypes. sendfile() should not be used * in portable programs. * - * Input Parmeters: + * Input Parameters: * infd - A file (or socket) descriptor opened for reading * outfd - A descriptor opened for writing. * offset - If 'offset' is not NULL, then it points to a variable diff --git a/fs/vfs/fs_statfs.c b/fs/vfs/fs_statfs.c index 0f33c10aba34aec39e42356cf625ee6806d1cee1..4a8f6af7e1f15280d927cd0faea47947ace8a660 100644 --- a/fs/vfs/fs_statfs.c +++ b/fs/vfs/fs_statfs.c @@ -70,7 +70,8 @@ static int statpseudofs(FAR struct inode *inode, FAR struct statfs *buf) /**************************************************************************** * Name: statfs * - * Return: Zero on success; -1 on failure with errno set: + * Returned Value: + * Zero on success; -1 on failure with errno set: * * EACCES Search permission is denied for one of the directories in the * path prefix of path. diff --git a/graphics/nxbe/nxbe.h b/graphics/nxbe/nxbe.h index 5b0743c0d809d344114f0db83aab467f89c9743d..2f9ce9a3f806917e542b82db408853c80f0f7b41 100644 --- a/graphics/nxbe/nxbe.h +++ b/graphics/nxbe/nxbe.h @@ -198,7 +198,7 @@ int nxbe_configure(FAR NX_DRIVERTYPE *dev, FAR struct nxbe_state_s *be); * Input Parameters: * wnd - The window to be closed (and deallocated) * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -261,7 +261,7 @@ void nxbe_lower(FAR struct nxbe_window_s *wnd); * pos - The pixel location to be set * col - The color to use in the set * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -281,7 +281,7 @@ void nxbe_setpixel(FAR struct nxbe_window_s *wnd, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -302,7 +302,7 @@ void nxbe_fill(FAR struct nxbe_window_s *wnd, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -328,7 +328,7 @@ void nxbe_filltrapezoid(FAR struct nxbe_window_s *wnd, * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -349,7 +349,7 @@ void nxbe_getrectangle(FAR struct nxbe_window_s *wnd, * rect - Describes the rectangular region to move * offset - The offset to move the region * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -375,7 +375,7 @@ void nxbe_move(FAR struct nxbe_window_s *wnd, * may lie outside of the display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_bitmap.c b/graphics/nxbe/nxbe_bitmap.c index 61a380ca1046336899448a138b0305e6435c2acc..772b08e46a00949c887c7063470d10f0ca3a8985 100644 --- a/graphics/nxbe/nxbe_bitmap.c +++ b/graphics/nxbe/nxbe_bitmap.c @@ -109,7 +109,7 @@ static void nxs_clipcopy(FAR struct nxbe_clipops_s *cops, * may lie outside of the display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_closewindow.c b/graphics/nxbe/nxbe_closewindow.c index 44520da22c182b4fc43985057b5ee6ca4fa316d5..cec2c5ae9e2bc096b375afb0cc0a004f815ea89f 100644 --- a/graphics/nxbe/nxbe_closewindow.c +++ b/graphics/nxbe/nxbe_closewindow.c @@ -61,7 +61,7 @@ * wnd - The window to be closed (and deallocated using the user-space * allocator) * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_fill.c b/graphics/nxbe/nxbe_fill.c index e2b45fbc96234ff23af85600f869da8748ed2a62..48567ccdcf2a5efaacbc6f44f06537fd9f803a07 100644 --- a/graphics/nxbe/nxbe_fill.c +++ b/graphics/nxbe/nxbe_fill.c @@ -99,7 +99,7 @@ static void nxbe_clipfill(FAR struct nxbe_clipops_s *cops, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_filltrapezoid.c b/graphics/nxbe/nxbe_filltrapezoid.c index 1936a6c4d6297d943f35b50dfb9a895f4a07927d..51fde5728b033036c05e3713b7603ce7d764ae10 100644 --- a/graphics/nxbe/nxbe_filltrapezoid.c +++ b/graphics/nxbe/nxbe_filltrapezoid.c @@ -123,7 +123,7 @@ static void nxbe_clipfilltrapezoid(FAR struct nxbe_clipops_s *cops, * rect - The location to be filled (in relative window coordinates) * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_getrectangle.c b/graphics/nxbe/nxbe_getrectangle.c index 2e707a816cd16cffc3d50e0d68265952065eb209..72073537e663e57ff477f8aa81c16c5440298a37 100644 --- a/graphics/nxbe/nxbe_getrectangle.c +++ b/graphics/nxbe/nxbe_getrectangle.c @@ -76,7 +76,7 @@ struct nxbe_fill_s * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_move.c b/graphics/nxbe/nxbe_move.c index e2eee9f01bbf3ffcb2d779a724cfddf01a1fb1cd..747b4e5a764ff0b86d881598fefd8f85963f0a2d 100644 --- a/graphics/nxbe/nxbe_move.c +++ b/graphics/nxbe/nxbe_move.c @@ -197,7 +197,7 @@ static void nxbe_clipmovedest(FAR struct nxbe_clipops_s *cops, * rect - Describes the rectangular region to move * offset - The offset to move the region * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxbe/nxbe_setpixel.c b/graphics/nxbe/nxbe_setpixel.c index 574a4ee3deb2ef9ba6b89775cc262c273c0f2048..409b11c4423ad421b210c8ce209389b6312d1a87 100644 --- a/graphics/nxbe/nxbe_setpixel.c +++ b/graphics/nxbe/nxbe_setpixel.c @@ -99,7 +99,7 @@ static void nxbe_clipfill(FAR struct nxbe_clipops_s *cops, * rect - The location to be filled * col - The color to use in the fill * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxfe.h b/graphics/nxmu/nxfe.h index 62ae235fedefbc53fdf2e8aa833db4e6f6545419..c1e02b769daaf82c9a336590ae9a0eadf96c8dce 100644 --- a/graphics/nxmu/nxfe.h +++ b/graphics/nxmu/nxfe.h @@ -106,7 +106,7 @@ extern "C" * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -125,7 +125,7 @@ int nxmu_sendclient(FAR struct nxfe_conn_s *conn, * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -143,7 +143,7 @@ int nxmu_sendclientwindow(FAR struct nxbe_window_s *wnd, FAR const void *msg, * be - The back-end status structure * wnd - The pre-allocated window structure to be initialized [IN/OUT] * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -164,7 +164,7 @@ void nxmu_openwindow(FAR struct nxbe_state_s *be, * cb - Callbacks used to process window events * arg - User provided argument (see nx_openwindow, nx_constructwindow) * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -184,7 +184,7 @@ void nxmu_requestbkgd(FAR struct nxfe_conn_s *conn, * Input Parameters: * fe - The front-end state structure * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_openwindow.c b/graphics/nxmu/nxmu_openwindow.c index 01ed612a5b4de640785ac955d8f4d512acb5b49e..0d05ac3700dccbe27de25bb764f0ef871b82c760 100644 --- a/graphics/nxmu/nxmu_openwindow.c +++ b/graphics/nxmu/nxmu_openwindow.c @@ -76,7 +76,7 @@ * be - The back-end status structure * wnd - The pre-allocated window structure to be initialized [IN/OUT] * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_releasebkgd.c b/graphics/nxmu/nxmu_releasebkgd.c index 7f8d2935076f368b2a862b8495c5a0ad4b320e2a..35c65930729c6b680916ede5f5a605a0a874514e 100644 --- a/graphics/nxmu/nxmu_releasebkgd.c +++ b/graphics/nxmu/nxmu_releasebkgd.c @@ -79,7 +79,7 @@ * Input Parameters: * fe - The front-end state structure * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_requestbkgd.c b/graphics/nxmu/nxmu_requestbkgd.c index 72485b6aaa2f8122b7272186a6390ecd5c071d98..fa12750feefae5bd23f70a4887b1ba2be93e3540 100644 --- a/graphics/nxmu/nxmu_requestbkgd.c +++ b/graphics/nxmu/nxmu_requestbkgd.c @@ -63,7 +63,7 @@ * cb - Callbacks used to process window events * arg - User provided argument (see nx_openwindow, nx_constructwindow) * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_sendclient.c b/graphics/nxmu/nxmu_sendclient.c index a26a6d3e96442a6d3ed7f365422be67e7f2a7ffc..21588fbbd254eb122c02be5fd0a477edcedf893a 100644 --- a/graphics/nxmu/nxmu_sendclient.c +++ b/graphics/nxmu/nxmu_sendclient.c @@ -62,7 +62,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_sendclientwindow.c b/graphics/nxmu/nxmu_sendclientwindow.c index e8ce5276a17f5ee9fa08c0f5577cb69cc5b49d48..32d42a3d48e679265688fd1c89944d4885cac55a 100644 --- a/graphics/nxmu/nxmu_sendclientwindow.c +++ b/graphics/nxmu/nxmu_sendclientwindow.c @@ -80,7 +80,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/graphics/nxmu/nxmu_server.c b/graphics/nxmu/nxmu_server.c index a2a2999abdf0da610eea011a96fd0c0e378ca57d..5593c57dd6587b7daecd26c6e58828cc63ef5562 100644 --- a/graphics/nxmu/nxmu_server.c +++ b/graphics/nxmu/nxmu_server.c @@ -270,7 +270,7 @@ static inline int nxmu_setup(FAR const char *mqname, FAR NX_DRIVERTYPE *dev, * mqname - The name for the server incoming message queue * dev - Vtable "object" of the framebuffer/LCD "driver" to use * - * Return: + * Returned Value: * This function usually does not return. If it does return, it will * return ERROR and errno will be set appropriately. * diff --git a/graphics/nxterm/nx_register.c b/graphics/nxterm/nx_register.c index 3da6fd8a658fa8a1a5f20e630557d5dcbc4c4fa7..8c1e0a8018f8b3a506903bcd93f6badee76c36ff 100644 --- a/graphics/nxterm/nx_register.c +++ b/graphics/nxterm/nx_register.c @@ -90,7 +90,7 @@ static const struct nxterm_operations_s g_nxops = * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -114,7 +114,7 @@ static int nxterm_fill(FAR struct nxterm_state_s *priv, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -146,7 +146,7 @@ static int nxterm_move(FAR struct nxterm_state_s *priv, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -177,7 +177,7 @@ static int nxterm_bitmap(FAR struct nxterm_state_s *priv, * wndo - Describes the window and font to be used * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/graphics/nxterm/nxtk_register.c b/graphics/nxterm/nxtk_register.c index ae4e861246441091a71e77abafefc031544fed63..d89f31cd3f5d0921bd67d75285b47f78006b06ee 100644 --- a/graphics/nxterm/nxtk_register.c +++ b/graphics/nxterm/nxtk_register.c @@ -90,7 +90,7 @@ static const struct nxterm_operations_s g_nxtkops = * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -114,7 +114,7 @@ static int nxtkcon_fill(FAR struct nxterm_state_s *priv, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -146,7 +146,7 @@ static int nxtkcon_move(FAR struct nxterm_state_s *priv, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -177,7 +177,7 @@ static int nxtkcon_bitmap(FAR struct nxterm_state_s *priv, * wndo - Describes the window and font to be used * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/graphics/nxterm/nxtool_register.c b/graphics/nxterm/nxtool_register.c index 2a9de5d5596f9ef10dfc26215221cceb9b6fc3db..04849692f345829e17fe08d230c56e00ad9b6695 100644 --- a/graphics/nxterm/nxtool_register.c +++ b/graphics/nxterm/nxtool_register.c @@ -90,7 +90,7 @@ static const struct nxterm_operations_s g_nxtoolops = * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -114,7 +114,7 @@ static int nxtool_fill(FAR struct nxterm_state_s *priv, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -146,7 +146,7 @@ static int nxtool_move(FAR struct nxterm_state_s *priv, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -179,7 +179,7 @@ static int nxtool_bitmap(FAR struct nxterm_state_s *priv, * wndo - Describes the window and font to be used * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/graphics/vnc/server/vnc_fbdev.c b/graphics/vnc/server/vnc_fbdev.c index e5995996547a4748f9392382c225a18a08ffe86f..47badee8f0570dcb5ede0f7b6cd54d24564f7b78 100644 --- a/graphics/vnc/server/vnc_fbdev.c +++ b/graphics/vnc/server/vnc_fbdev.c @@ -412,7 +412,7 @@ static int up_setcursor(FAR struct fb_vtable_s *vtable, * Description: * Start the VNC server. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -470,7 +470,7 @@ static int vnc_start_server(int display) * Description: * Wait for the server to be started. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -525,7 +525,7 @@ static inline int vnc_wait_start(int display) * Wait for the server to be connected to the VNC client. We can do * nothing until that connection is established. * - * Input parameters: + * Input Parameters: * display - In the case of hardware with multiple displays, this * specifies the display. Normally this is zero. * @@ -612,7 +612,7 @@ static inline int vnc_wait_connect(int display) * 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. * @@ -746,7 +746,7 @@ int vnc_fbinitialize(int display, vnc_kbdout_t kbdout, * 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. diff --git a/include/hex2bin.h b/include/hex2bin.h index 3217c54560eeda31e858f6286188dbc7ed885cb2..3ee8e42dd4cfa664d25c8ee694484adb6811497a 100644 --- a/include/hex2bin.h +++ b/include/hex2bin.h @@ -133,7 +133,7 @@ extern "C" * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * @@ -163,7 +163,7 @@ int hex2bin(FAR struct lib_instream_s *instream, * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * @@ -190,7 +190,7 @@ int hex2mem(int fd, uint32_t baseaddr, uint32_t endpaddr, * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * @@ -208,7 +208,7 @@ int fhex2mem(FAR FILE *instream, uint32_t baseaddr, uint32_t endpaddr, * Input Parameters: * Standard task inputs * - * Returned Value + * Returned Value: * EXIT_SUCESS on success; EXIT_FAILURE on failure * ****************************************************************************/ @@ -226,7 +226,7 @@ int hex2bin_main(int argc, char **argv); * Input Parameters: * Standard task inputs * - * Returned Value + * Returned Value: * EXIT_SUCESS on success; EXIT_FAILURE on failure * ****************************************************************************/ diff --git a/include/nuttx/analog/adc.h b/include/nuttx/analog/adc.h index 524773e72906ca194b1316cb57f5d1eb9fd68082..7ce2577fe4ace396b2effdcd1e3816bac1eccc34 100644 --- a/include/nuttx/analog/adc.h +++ b/include/nuttx/analog/adc.h @@ -227,7 +227,7 @@ extern "C" * driver with the "upper half" ADC device and registers that device so that can * be used by application code. * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/adc", "/dev/adc1", etc. where the driver path differs only diff --git a/include/nuttx/analog/dac.h b/include/nuttx/analog/dac.h index 93f1282ef573762536e91d943045ebba04f41b9c..5f9fce131c25ee3953181f3d53b6fa61fae0fd76 100644 --- a/include/nuttx/analog/dac.h +++ b/include/nuttx/analog/dac.h @@ -190,7 +190,7 @@ int dac_register(FAR const char *path, FAR struct dac_dev_s *dev); * Input Parameters: * dev - An instance of the device-specific DAC interface * - * Return: + * Returned Value: * OK on success; a negated errno on failure. * ************************************************************************************/ diff --git a/include/nuttx/arch.h b/include/nuttx/arch.h index 6bbdf758b45e5676ab885fd3820c426e036bfe53..9e52a6b019777746faa3fdcc00363a2dbfc3bff0 100644 --- a/include/nuttx/arch.h +++ b/include/nuttx/arch.h @@ -247,7 +247,7 @@ void up_initial_state(FAR struct tcb_s *tcb); * - 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. @@ -289,7 +289,7 @@ int up_create_stack(FAR struct tcb_s *tcb, size_t stack_size, uint8_t ttype); * - 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: The new stack to be used. * - stack_size: The allocated stack size. @@ -324,7 +324,7 @@ int up_use_stack(FAR struct tcb_s *tcb, FAR void *stack, size_t stack_size); * 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. * @@ -344,7 +344,7 @@ FAR void *up_stack_frame(FAR struct tcb_s *tcb, size_t frame_size); * 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): @@ -382,7 +382,7 @@ void up_release_stack(FAR struct tcb_s *dtcb, uint8_t ttype); * logic. Interrupts will always be disabled when this * function is called. * - * 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 @@ -404,7 +404,7 @@ void up_unblock_task(FAR struct tcb_s *tcb); * logic. Interrupts will always be disabled when this * function is called. * - * 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 @@ -455,7 +455,7 @@ void up_release_pending(void); * logic. Interrupts will always be disabled when this * function is called. * - * Inputs: + * Input Parameters: * tcb: The TCB of the task that has been reprioritized * priority: The new task priority * @@ -601,12 +601,12 @@ void up_pthread_start(pthread_startroutine_t entrypt, pthread_addr_t arg) * function is the 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() * (see below). However, this will look like a normal return by the @@ -628,12 +628,12 @@ void up_signal_dispatch(_sa_sigaction_t sighand, int signo, * must be provided by architecture-specific logic. 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. * @@ -1741,7 +1741,7 @@ int up_cpu_index(void); * - 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 @@ -2015,10 +2015,10 @@ void sched_alarm_expiration(FAR const struct timespec *ts); * Description: * Collect data that can be used for CPU load measurements. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions/Limitations: @@ -2054,7 +2054,7 @@ void irq_dispatch(int irq, FAR void *context); * Input Parameters: * None * - * Returned value: + * Returned Value: * The estimated amount of stack space used. * ****************************************************************************/ diff --git a/include/nuttx/audio/audio.h b/include/nuttx/audio/audio.h index 1bdb9fe7ef4964cb5f98e1561620f2d08fbe4e5e..1395873622bd1848716db91abc7c5c6f2f81829b 100644 --- a/include/nuttx/audio/audio.h +++ b/include/nuttx/audio/audio.h @@ -670,7 +670,7 @@ extern "C" * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * name - The name of the audio device. This name will be used to generate * a full path to the driver in the format "/dev/audio/[name]" in the NuttX * filesystem (i.e. the path "/dev/audio" will be prepended to the supplied @@ -695,7 +695,7 @@ int audio_register(FAR const char *name, FAR struct audio_lowerhalf_s *dev); * Allocated an AP Buffer and prepares it for use. This allocates a dynamically * allocated buffer that has no special DMA capabilities. * - * Input parameters: + * Input Parameters: * bufdesc: Pointer to a buffer descriptor * * Returned Value: diff --git a/include/nuttx/audio/tone.h b/include/nuttx/audio/tone.h index e9a9c0059ac7d43db69074815306609911862d54..f5087ae74361334e645cf310314d56e875e42ce9 100644 --- a/include/nuttx/audio/tone.h +++ b/include/nuttx/audio/tone.h @@ -71,7 +71,7 @@ extern "C" * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/tone0", "/dev/tone1", etc. where the driver path diff --git a/include/nuttx/binfmt/binfmt.h b/include/nuttx/binfmt/binfmt.h index 4ca74f5a01a8c54db4458298f4a638e574c54dac..ab238a2d6cba13eb5782633b0e727b63b3f71a67 100644 --- a/include/nuttx/binfmt/binfmt.h +++ b/include/nuttx/binfmt/binfmt.h @@ -271,7 +271,7 @@ int exec_module(FAR const struct binary_s *bin); * or friends. It will also automatically free the structure with * kmm_free() after unloading the module. * - * Input Parameter: + * Input Parameters: * pid - The task ID of the child task * bin - This structure must have been allocated with kmm_malloc() and must * persist until the task unloads diff --git a/include/nuttx/binfmt/builtin.h b/include/nuttx/binfmt/builtin.h index 6f4a87be2439b5b3bd9b2fff1d03523dec270aed..bb4594bb9a3c92dbac916c558763eebf684c145f 100644 --- a/include/nuttx/binfmt/builtin.h +++ b/include/nuttx/binfmt/builtin.h @@ -117,7 +117,7 @@ void builtin_uninitialize(void); * Description: * Checks for availabiliy of application registerred during compile time. * - * Input Parameter: + * Input Parameters: * filename - Name of the linked-in binary to be started. * * Returned Value: @@ -136,7 +136,7 @@ int builtin_isavail(FAR const char *appname); * Returns pointer to a name of built-in application pointed by the * index. * - * Input Parameter: + * Input Parameters: * index, from 0 and on ... * * Returned Value: @@ -158,7 +158,7 @@ FAR const char *builtin_getname(int index); * If support for builtin functions is enabled in the NuttX configuration, * then this function must be provided by the application code. * - * Input Parameter: + * Input Parameters: * index, from 0 and on... * * Returned Value: diff --git a/include/nuttx/cancelpt.h b/include/nuttx/cancelpt.h index 87b560fd92233ef3b6c0abd91d513b301244c5e3..10cd20bfafb8c33c6479a08829b025a71b92b9df 100644 --- a/include/nuttx/cancelpt.h +++ b/include/nuttx/cancelpt.h @@ -103,7 +103,7 @@ extern "C" * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * @@ -133,7 +133,7 @@ bool enter_cancellation_point(void); * Input Parameters: * None * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -157,7 +157,7 @@ void leave_cancellation_point(void); * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * diff --git a/include/nuttx/clock.h b/include/nuttx/clock.h index d05d49a50eb3e52f00009a6cf0c0923a0e930a79..0892615e3cd5e5a0266418f828b26c676a8c4c0d 100644 --- a/include/nuttx/clock.h +++ b/include/nuttx/clock.h @@ -272,7 +272,7 @@ EXTERN volatile systime_t g_system_timer; * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -302,7 +302,7 @@ void clock_synchronize(void); * Parameters: * diff: amount of time system-time is adjusted forward with RTC * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -329,7 +329,7 @@ void clock_resynchronize(FAR struct timespec *rtc_diff); * Parameters: * None * - * Return Value: + * Returned Value: * The current value of the system timer counter * * Assumptions: @@ -350,7 +350,7 @@ systime_t clock_systimer(void); * Parameters: * ts - Location to return the time * - * Return Value: + * Returned Value: * Current version always returns OK * * Assumptions: @@ -369,7 +369,7 @@ int clock_systimespec(FAR struct timespec *ts); * pid - The task ID of the thread of interest. pid == 0 is the IDLE thread. * cpuload - The location to return the CPU load * - * Return Value: + * Returned Value: * OK (0) on success; a negated errno value on failure. The only reason * that this function can fail is if 'pid' no longer refers to a valid * thread. diff --git a/include/nuttx/crypto/aes.h b/include/nuttx/crypto/aes.h index 5c4d3e805078f942797947abfb9a1560912faeca..af97032e50d3c01d372d3b62592a875926431f95 100644 --- a/include/nuttx/crypto/aes.h +++ b/include/nuttx/crypto/aes.h @@ -75,7 +75,7 @@ extern "C" * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -94,7 +94,7 @@ void aes_encrypt(FAR uint8_t *state, FAR const uint8_t *key); * key AES128 key of size 16 bytes * state 16 bytes of plain text and cipher text * - * Returned Value + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/drivers/drivers.h b/include/nuttx/drivers/drivers.h index 612434d15b7a1948c96a5c2aabd873dd084c6047..b2f1bbf79ec7a957316229004b79f796a02d30d0 100644 --- a/include/nuttx/drivers/drivers.h +++ b/include/nuttx/drivers/drivers.h @@ -227,12 +227,12 @@ ssize_t bchlib_write(FAR void *handle, FAR const char *buffer, size_t offset, * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * fd[2] - The user provided array in which to catch the pipe file * descriptors * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * @@ -264,13 +264,13 @@ int pipe2(int fd[2], size_t bufsize); * the NuttX FIFOs are based in in-memory, circular buffers, the ability * to control the size of those buffers is critical for system tuning. * - * Inputs: + * Input Parameters: * pathname - The full path to the FIFO instance to attach to or to create * (if not already created). * mode - Ignored for now * bufsize - The size of the in-memory, circular buffer in bytes. * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/include/nuttx/drivers/pwm.h b/include/nuttx/drivers/pwm.h index eddea5804e28d78fb25706e14ec30a46d12ba639..2d0a5d2c7db7e408a3cf3ffb4419a9d7079437b3 100644 --- a/include/nuttx/drivers/pwm.h +++ b/include/nuttx/drivers/pwm.h @@ -260,7 +260,7 @@ extern "C" * When this function is called, the "lower half" driver should be in the * reset state (as if the shutdown() method had already been called). * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/pwm0", "/dev/pwm1", etc. where the driver path differs only @@ -301,7 +301,7 @@ int pwm_register(FAR const char *path, FAR struct pwm_lowerhalf_s *dev); * interface using the handle that was previously passed to the * start() method * - * Input parameters: + * Input Parameters: * handle - This is the handle that was provided to the lower-half * start() method. * diff --git a/include/nuttx/drivers/ramdisk.h b/include/nuttx/drivers/ramdisk.h index 27cfb4e992a43855a09682012bf47c6c0b91ba77..86bb5f4effa1b807a3c717c48a43aef6011d05c8 100644 --- a/include/nuttx/drivers/ramdisk.h +++ b/include/nuttx/drivers/ramdisk.h @@ -79,14 +79,14 @@ extern "C" * Description: * Non-standard function to register a ramdisk or a romdisk * - * Input Parmeters: + * Input Parameters: * minor: Selects suffix of device named /dev/ramN, N={1,2,3...} * nsectors: Number of sectors on device * sectize: The size of one sector * rdflags: See RDFLAG_* definitions * buffer: RAM disk backup memory * - * Returned Valued: + * Returned Value: * Zero on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/fs/fs.h b/include/nuttx/fs/fs.h index bb3b989ab4ae270228d8c7af06cb333b4d58fb25..424b8b44773cf3cd95c0536e349aa7b446b685b4 100644 --- a/include/nuttx/fs/fs.h +++ b/include/nuttx/fs/fs.h @@ -496,7 +496,7 @@ void fs_initialize(void); * Description: * Register a character driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * fops - The file operations structure * mode - inmode privileges (not used) @@ -523,7 +523,7 @@ int register_driver(FAR const char *path, * Description: * Register a block driver inode the pseudo file system. * - * Input parameters: + * Input Parameters: * path - The path to the inode to create * bops - The block driver operations structure * mode - inmode privileges (not used) @@ -1051,7 +1051,7 @@ int file_truncate(FAR struct file *filep, off_t length); * req The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * Returns a non-negative number on success; A negated errno value is * returned on any failure (see comments ioctl() for a list of appropriate * errno values). diff --git a/include/nuttx/fs/unionfs.h b/include/nuttx/fs/unionfs.h index 35815de8c3eeb0efc68ecfd71f4b0965af6fa060..485197e129a56f188184e24bb94dcad78a20d31f 100644 --- a/include/nuttx/fs/unionfs.h +++ b/include/nuttx/fs/unionfs.h @@ -83,7 +83,7 @@ extern "C" * file system appear a some path below the unionfs mountpoint, * mountpt - The full path to the mountpoint for the union file system * - * Returned value: + * Returned Value: * Zero (OK) is returned if the union file system was correctly created and * mounted. On any failure, a negated error value will be returned to * indicate the nature of the failure. diff --git a/include/nuttx/fs/userfs.h b/include/nuttx/fs/userfs.h index 29ad9d3d915d0f7ac47f26f1c5bf46d4ca82cbdc..a1b96938ee1bb5d675293c049323c1c2983de235 100644 --- a/include/nuttx/fs/userfs.h +++ b/include/nuttx/fs/userfs.h @@ -549,7 +549,7 @@ extern "C" * NOTE: This is an OS internal function that should not be called from * appliation logic. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -584,7 +584,7 @@ int userfs_register(void); * NOTE: This is a user function that is implemented as part of the * NuttX C library and is intended to be called by appliation logic. * - * Input parameters: + * Input Parameters: * mountpt - Mountpoint path * userops - The caller operations that implement the file system * interface. diff --git a/include/nuttx/input/ajoystick.h b/include/nuttx/input/ajoystick.h index 7cc7d384b0da90987e0164d05cd3bb3c4a85e6d1..9e7d6a0cd0f175988d22365c92c18d909e86d40a 100644 --- a/include/nuttx/input/ajoystick.h +++ b/include/nuttx/input/ajoystick.h @@ -283,7 +283,7 @@ extern "C" * lower - An instance of the platform-specific analog joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/input/buttons.h b/include/nuttx/input/buttons.h index dbaaec45e176026c8f472cf6e7846ddcf3c3464c..601979b462e11b6469e0cbc4b324b2df37b02d0a 100644 --- a/include/nuttx/input/buttons.h +++ b/include/nuttx/input/buttons.h @@ -191,7 +191,7 @@ extern "C" * minor device number. * lower - An instance of the platform-specific button lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/input/djoystick.h b/include/nuttx/input/djoystick.h index 3f0f1e0aa96f7bb37036a9e22e6896bc9ea9b759..21def3909b82f4c521a1ea9291244153255ced07 100644 --- a/include/nuttx/input/djoystick.h +++ b/include/nuttx/input/djoystick.h @@ -260,7 +260,7 @@ extern "C" * lower - An instance of the platform-specific discrete joystick lower * half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/input/nunchuck.h b/include/nuttx/input/nunchuck.h index 844b66abc2cf1eabc5362ca892d5372083261e94..cc0a3b8fcad8fb2fc9d23a9b70f9891316b92fc7 100644 --- a/include/nuttx/input/nunchuck.h +++ b/include/nuttx/input/nunchuck.h @@ -169,7 +169,7 @@ extern "C" * minor device number. * i2c - An instance of the platform-specific I2C connected to Nunchuck. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/kthread.h b/include/nuttx/kthread.h index 254ce870989fbc1a3806ff285ffc8027db8db328..c9f2ffaf70e00ad83658899708cf53e25d03927b 100644 --- a/include/nuttx/kthread.h +++ b/include/nuttx/kthread.h @@ -97,7 +97,7 @@ extern "C" * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. @@ -126,7 +126,7 @@ int nxtask_create(FAR const char *name, int priority, * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. diff --git a/include/nuttx/leds/rgbled.h b/include/nuttx/leds/rgbled.h index 554f0719ffdc1e52e073aabd2d4af02712d0ab0a..4fb192dc330cc5a9c9b1ad3642edc0f53401885e 100644 --- a/include/nuttx/leds/rgbled.h +++ b/include/nuttx/leds/rgbled.h @@ -71,7 +71,7 @@ extern "C" * be used by application code. * * - * Input parameters: + * Input Parameters: * path - The full path to the driver to be registers in the NuttX pseudo- * filesystem. The recommended convention is to name all PWM drivers * as "/dev/rgdbled0", "/dev/rgbled1", etc. where the driver path diff --git a/include/nuttx/leds/userled.h b/include/nuttx/leds/userled.h index 0b9f8b0e25d17c73ba08e9dec8447b77b794c7db..f0a027808a3dfa2cbef5b77e853edbc8b53b6682 100644 --- a/include/nuttx/leds/userled.h +++ b/include/nuttx/leds/userled.h @@ -170,7 +170,7 @@ extern "C" * minor device number. * lower - An instance of the platform-specific LED lower half driver. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/include/nuttx/mqueue.h b/include/nuttx/mqueue.h index b7276a6ff5da70cc7254b4dcc580626d48d137c7..9c6a650c28780247970b70f19aa580f9023e0bef 100644 --- a/include/nuttx/mqueue.h +++ b/include/nuttx/mqueue.h @@ -306,7 +306,7 @@ ssize_t nxmq_timedreceive(mqd_t mqdes, FAR char *msg, size_t msglen, * closed so that no thread will attempt access it while it is being * deleted. * - * Inputs: + * Input Parameters: * msgq - Named essage queue to be freed * * Returned Value: diff --git a/include/nuttx/mtd/configdata.h b/include/nuttx/mtd/configdata.h index 65965c61959516ffc7434268ed302aa289b72277..1dff77f0f2b3954e7d4cde3d39984df78ac691ff 100644 --- a/include/nuttx/mtd/configdata.h +++ b/include/nuttx/mtd/configdata.h @@ -117,7 +117,7 @@ extern "C" * When this function is called, the MTD device pass in should already * be initialized appropriately to access the physical device or partition. * - * Input parameters: + * Input Parameters: * mtd - Pointer to the MTD device to bind with the /dev/config device * * Returned Value: diff --git a/include/nuttx/mtd/hamming.h b/include/nuttx/mtd/hamming.h index 99358e10dcfbb0365746a36b2e33d2b5218d70cc..706cb125f1853737e902112179bd059944b3781a 100644 --- a/include/nuttx/mtd/hamming.h +++ b/include/nuttx/mtd/hamming.h @@ -108,7 +108,7 @@ extern "C" * size - Data size in bytes * code - Codes buffer * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -127,7 +127,7 @@ void hamming_compute256x(FAR const uint8_t *data, size_t size, uint8_t *code); * size - Size of the data in bytes * code - Original codes * - * Returned Values: + * Returned Value: * Return 0 if the data is correct, HAMMING_ERROR_SINGLEBIT if one or more * block(s) have had a single bit corrected, or either HAMMING_ERROR_ECC * or HAMMING_ERROR_MULTIPLEBITS. diff --git a/include/nuttx/mtd/mtd.h b/include/nuttx/mtd/mtd.h index e834469866aeca00392147a1414fb74f12245f0a..f201e9ebbd0fb54958d554384073befcde171eef 100644 --- a/include/nuttx/mtd/mtd.h +++ b/include/nuttx/mtd/mtd.h @@ -243,7 +243,7 @@ extern "C" * partitions, that mutual exclusion would be provided by the file system * above the FLASH driver. * - * Input parameters: + * Input Parameters: * mtd - The MTD device to be partitioned * firstblock - The offset in bytes to the first block * nblocks - The number of blocks in the partition diff --git a/include/nuttx/mtd/nand.h b/include/nuttx/mtd/nand.h index b19c6cb79ad8fcfded62a7167a35c8beffe418b3..ab3b73771f8da5d54bacd4a35c792d5b49549af2 100644 --- a/include/nuttx/mtd/nand.h +++ b/include/nuttx/mtd/nand.h @@ -99,10 +99,10 @@ extern "C" * Description: * Probe and initialize NAND. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * - * Returned value. + * Returned Value: * A non-NULL MTD driver intstance is returned on success. NULL is * returned on any failaure. * diff --git a/include/nuttx/mtd/nand_ecc.h b/include/nuttx/mtd/nand_ecc.h index 7e94d4c373c9f5bb93b274a55c0e19134de0057f..a86b0f2aab414b55e4f8a8535c8ae102cdd54171 100644 --- a/include/nuttx/mtd/nand_ecc.h +++ b/include/nuttx/mtd/nand_ecc.h @@ -86,14 +86,14 @@ extern "C" * the spare area. If a buffer pointer is NULL, then the corresponding area * is not saved. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ @@ -111,14 +111,14 @@ int nandecc_readpage(FAR struct nand_dev_s *nand, off_t block, * If no spare buffer is provided, the spare area is still written with the * ECC information calculated on the data buffer. * - * Input parameters: + * Input Parameters: * nand - Upper-half, NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in success; a negated errno value is returned on failure. * ****************************************************************************/ diff --git a/include/nuttx/mtd/nand_model.h b/include/nuttx/mtd/nand_model.h index bd1363cfdd1b5deae44d8fee54c1677668e5cbb7..0012e339bf35f9acbdc44dce62b31e362e083338 100644 --- a/include/nuttx/mtd/nand_model.h +++ b/include/nuttx/mtd/nand_model.h @@ -127,7 +127,7 @@ EXTERN const struct nand_model_s g_nandmodels[NAND_NMODELS]; * chipid Identifier returned by the Nand(id1|(id2<<8)|(id3<<16)|(id4<<24)). * model nand_model_s instance to update with the model parameters. * - * Returned Values: + * Returned Value: * OK is returned on success; -ENODEV is returned on failure. * ****************************************************************************/ @@ -151,7 +151,7 @@ int nandmodel_find(FAR const struct nand_model_s *modeltab, size_t size, * page Stores the first accessed page number inside the first block. * offset Stores the byte offset inside the first accessed page. * - * Returned Values: + * Returned Value: * OK on success; -EPIPE on failure. * ****************************************************************************/ @@ -170,7 +170,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Spare placement scheme * ****************************************************************************/ @@ -186,7 +186,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Device ID * ****************************************************************************/ @@ -202,7 +202,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Number of blocks in the device * ****************************************************************************/ @@ -220,7 +220,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Size of the device in bytes * ****************************************************************************/ @@ -237,7 +237,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * size of the device in MB. * ****************************************************************************/ @@ -253,7 +253,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Block size in pages * ****************************************************************************/ @@ -270,7 +270,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Number of pages in the device * ****************************************************************************/ @@ -288,7 +288,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Block size in bytes * ****************************************************************************/ @@ -304,7 +304,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Size of data area in bytes * ****************************************************************************/ @@ -320,7 +320,7 @@ int nandmodel_translate(FAR const struct nand_model_s *model, off_t address, * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * size of spare area in bytes * ****************************************************************************/ @@ -336,7 +336,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model); * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * data width * ****************************************************************************/ @@ -354,7 +354,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model); * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Returns true if the given NAND FLASH model uses the "small blocks/pages" * command set; otherwise returns false. * @@ -372,7 +372,7 @@ unsigned int nandmodel_getsparesize(FAR const struct nand_model_s *model); * Input Parameters: * model Pointer to a nand_model_s instance. * - * Returned Values: + * Returned Value: * Returns true if the device supports the copy-back operation. Otherwise * returns false. * diff --git a/include/nuttx/mtd/nand_raw.h b/include/nuttx/mtd/nand_raw.h index f2edd3821e50b1bfcb4be1b50fc2ac550be0dcd9..44cc069000386cefbacf712cc3cf8fc02150cadb 100644 --- a/include/nuttx/mtd/nand_raw.h +++ b/include/nuttx/mtd/nand_raw.h @@ -128,11 +128,11 @@ * Description: * Erases the specified block of the device. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the physical block to erase. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -146,14 +146,14 @@ * Reads the data and/or the spare areas of a page of a NAND FLASH into the * provided buffers. This is a raw read of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -167,14 +167,14 @@ * Writes the data and/or the spare area of a page on a NAND FLASH chip. * This is a raw write of the flash contents. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -189,14 +189,14 @@ * provided buffers. Hardware ECC checking will be performed if so * configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to read resides. * page - Number of the page to read inside the given block. * data - Buffer where the data area will be stored. * spare - Buffer where the spare area will be stored. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ @@ -214,14 +214,14 @@ * Writes the data and/or the spare area of a page on a NAND FLASH chip. * Hardware ECC checking will be performed if so configured. * - * Input parameters: + * Input Parameters: * raw - Lower-half, raw NAND FLASH interface * block - Number of the block where the page to write resides. * page - Number of the page to write inside the given block. * data - Buffer containing the data to be writting * spare - Buffer containing the spare data to be written. * - * Returned value. + * Returned Value: * OK is returned in succes; a negated errno value is returned on failure. * ****************************************************************************/ diff --git a/include/nuttx/mtd/nand_scheme.h b/include/nuttx/mtd/nand_scheme.h index acc4b56f11dca4cde0dd9674d105ecf439f95ae7..a30caae1657be2a384490c09e0dcc83d5abcd457 100644 --- a/include/nuttx/mtd/nand_scheme.h +++ b/include/nuttx/mtd/nand_scheme.h @@ -109,7 +109,7 @@ EXTERN const struct nand_scheme_s g_nand_sparescheme4096; * spare Spare area buffer. * marker Pointer to the variable to store the bad block marker. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -130,7 +130,7 @@ void nandscheme_readbadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * marker Bad block marker to write. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -150,7 +150,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Offset in the spare area to the first ECC byte * ****************************************************************************/ @@ -166,7 +166,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Size of the ECC information in the spare area. * ****************************************************************************/ @@ -184,7 +184,7 @@ void nandscheme_writebadblockmarker(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -203,7 +203,7 @@ void nandscheme_readecc(FAR const struct nand_scheme_s *scheme, * spare Spare area buffer. * ecc ECC buffer. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -223,7 +223,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Offset in the spare area to the first extra byte * ****************************************************************************/ @@ -239,7 +239,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * Input Parameters: * scheme Pointer to a nand_scheme_s instance. * - * Returned Values: + * Returned Value: * Size of the extra information in the spare area. * ****************************************************************************/ @@ -260,7 +260,7 @@ void nandscheme_writeecc(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to read. * offset Index where to read the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -283,7 +283,7 @@ void nandscheme_readextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -305,7 +305,7 @@ void nandscheme_writeextra(FAR const struct nand_scheme_s *scheme, * size Number of extra bytes to write. * offset Index where to write the first extra byte. * - * Returned Values: + * Returned Value: * OK on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/net/ieee802154.h b/include/nuttx/net/ieee802154.h index 20ff4575934103fdd020ee65e1ec5d744fcfbf2c..5f938f329003ee755734f1eb63f4aeb731fbb4f0 100644 --- a/include/nuttx/net/ieee802154.h +++ b/include/nuttx/net/ieee802154.h @@ -71,7 +71,7 @@ * If there are multilple frames in the list, this metadata * must apply to all of the frames in the list. * - * Return: + * Returned Value: * OK The IEEE 802.15.4 has been processed and can be deleted * ERROR Hold the IEEE 802.15.4 and try again later. There is a listening * socket but no recv in place to catch the IEEE 802.15.4 yet. diff --git a/include/nuttx/net/net.h b/include/nuttx/net/net.h index 9e1eec09db0bae03dae37b2be5e5e77d0e969a2e..c24b4245e1786eb90212c66aa9d8a871bda3f7c0 100644 --- a/include/nuttx/net/net.h +++ b/include/nuttx/net/net.h @@ -306,7 +306,7 @@ void net_initialize(void); * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -322,7 +322,7 @@ void net_lock(void); * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -340,7 +340,7 @@ void net_unlock(void); * sem - A reference to the semaphore to be taken. * abstime - The absolute time to wait until a timeout is declared. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * @@ -358,7 +358,7 @@ int net_timedwait(sem_t *sem, FAR const struct timespec *abstime); * Input Parameters: * sem - A reference to the semaphore to be taken. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * @@ -1037,7 +1037,7 @@ int psock_setsockopt(FAR struct socket *psock, int level, int option, * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * @@ -1070,7 +1070,7 @@ int psock_ioctl(FAR struct socket *psock, int cmd, unsigned long arg); * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * diff --git a/include/nuttx/net/pkt.h b/include/nuttx/net/pkt.h index 03e4a0d22afb279a2f4bbfbd4414675775d543d4..fc2d9bd5a27432568e6c31f205c95c6c19a68e2d 100644 --- a/include/nuttx/net/pkt.h +++ b/include/nuttx/net/pkt.h @@ -73,7 +73,7 @@ * Parameters: * dev - The device driver structure containing the received packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR There is a matching connection, but could not dispatch the packet * yet. Useful when a packet arrives before a recv call is in diff --git a/include/nuttx/net/radiodev.h b/include/nuttx/net/radiodev.h index 91cebd35b60616e08b18f126e3d328ef35c85602..b2e95e72725384311901a8344f6213a7a36086cd 100644 --- a/include/nuttx/net/radiodev.h +++ b/include/nuttx/net/radiodev.h @@ -189,7 +189,7 @@ struct radio_driver_s * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to recreate the * radio MAC header @@ -209,7 +209,7 @@ struct radio_driver_s * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The network device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -233,7 +233,7 @@ struct radio_driver_s * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/include/nuttx/net/telnet.h b/include/nuttx/net/telnet.h index c7184c6d6bba53259e66180033af2c11fc502ed9..16668f1d240e579586f69497c269331526298edd 100644 --- a/include/nuttx/net/telnet.h +++ b/include/nuttx/net/telnet.h @@ -85,7 +85,7 @@ struct telnet_session_s * Parameters: * None * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/nx/nx.h b/include/nuttx/nx/nx.h index aec345ac603a1f254ff003ec6f4d6945913aa8c4..4287497017d55eaa44d29cb8fa9fe49fef27e4bb 100644 --- a/include/nuttx/nx/nx.h +++ b/include/nuttx/nx/nx.h @@ -260,7 +260,7 @@ extern "C" * mqname - The name for the server incoming message queue * dev - Vtable "object" of the framebuffer "driver" to use * - * Return: + * Returned Value: * This function usually does not return. If it does return, it will * return ERROR and errno will be set appropriately. * @@ -315,7 +315,7 @@ int nx_start(void); * Input Parameters: * svrmqname - The name for the server incoming message queue * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * @@ -334,7 +334,7 @@ NXHANDLE nx_connectinstance(FAR const char *svrmqname); * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -358,7 +358,7 @@ void nx_disconnect(NXHANDLE handle); * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then * one or more server messages were processed. * ERROR: An error occurred and errno has been set appropriately. Of @@ -385,7 +385,7 @@ int nx_eventhandler(NXHANDLE handle); * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -407,7 +407,7 @@ int nx_eventnotify(NXHANDLE handle, int signo); * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * @@ -425,7 +425,7 @@ NXWINDOW nx_openwindow(NXHANDLE handle, FAR const struct nx_callback_s *cb, * Input Parameters: * wnd - The window to be destroyed * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -456,7 +456,7 @@ int nx_closewindow(NXWINDOW hwnd); * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -497,7 +497,7 @@ int nx_block(NXWINDOW hwnd, FAR void *arg); * cb - Callbacks to use for processing background window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -515,7 +515,7 @@ int nx_requestbkgd(NXHANDLE handle, FAR const struct nx_callback_s *cb, * Input Parameters: * hwnd - The handle returned (indirectly) by nx_requestbkgd * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -533,7 +533,7 @@ int nx_releasebkgd(NXWINDOW hwnd); * Input Parameters: * hwnd - The window handle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -550,7 +550,7 @@ int nx_getposition(NXWINDOW hwnd); * hwnd - The window handle * pos - The new position of the window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -567,7 +567,7 @@ int nx_setposition(NXWINDOW hwnd, FAR const struct nxgl_point_s *pos); * hwnd - The window handle * size - The new size of the window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -580,10 +580,10 @@ int nx_setsize(NXWINDOW hwnd, FAR const struct nxgl_size_s *size); * Description: * Bring the specified window to the top of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be raised * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -596,10 +596,10 @@ int nx_raise(NXWINDOW hwnd); * Description: * Lower the specified window to the bottom of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be lowered * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -618,7 +618,7 @@ int nx_lower(NXWINDOW hwnd); * pos - The pixel location to be set * col - The color to use in the set * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -637,7 +637,7 @@ int nx_setpixel(NXWINDOW hwnd, FAR const struct nxgl_point_s *pos, * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -666,7 +666,7 @@ int nx_fill(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect, * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -687,7 +687,7 @@ int nx_getrectangle(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect, * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -712,7 +712,7 @@ int nx_filltrapezoid(NXWINDOW hwnd, FAR const struct nxgl_rect_s *clip, * caps - Draw a circular on the both ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -734,7 +734,7 @@ int nx_drawline(NXWINDOW hwnd, FAR struct nxgl_vector_s *vector, * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -755,7 +755,7 @@ int nx_drawcircle(NXWINDOW hwnd, FAR const struct nxgl_point_s *center, * radius - The radius of the circle in pixels. * color - The color to use to fill the circle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -774,7 +774,7 @@ int nx_fillcircle(NXWINDOW hwnd, FAR const struct nxgl_point_s *center, * handle - The connection handle * color - The color to use in the background * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -793,7 +793,7 @@ int nx_setbgcolor(NXHANDLE handle, nxgl_mxpixel_t color[CONFIG_NX_NPLANES]); * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -819,7 +819,7 @@ int nx_move(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect, * may lie outside of the display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -936,7 +936,7 @@ void nx_redrawreq(NXWINDOW hwnd, FAR const struct nxgl_rect_s *rect); * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. In the * case of ERROR, NX will have deallocated the pre-allocated window. * diff --git a/include/nuttx/nx/nxfonts.h b/include/nuttx/nx/nxfonts.h index 525a5f56a243a3ea25af63db1e31b5abda669196..47e53aa2cf08d3491217a44ddd43f13f755f84a6 100644 --- a/include/nuttx/nx/nxfonts.h +++ b/include/nuttx/nx/nxfonts.h @@ -603,7 +603,7 @@ int nxf_convert_32bpp(FAR uint32_t *dest, uint16_t height, * bpp - Bits per pixel * maxglyphs - Maximum number of glyphs permitted in the cache * - * Returned value: + * Returned Value: * On success a non-NULL handle is returned that then may sequently be * used with nxf_getglyph() to extract fonts from the font cache. NULL * returned on any failure with the errno value set to indicate the nature @@ -626,7 +626,7 @@ FCACHE nxf_cache_connect(enum nx_fontid_e fontid, * Input Parameters: * fhandle - A font cache handler previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -643,7 +643,7 @@ void nxf_cache_disconnect(FCACHE fhandle); * Input Parameters: * fhandle - A font cache handle previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * Zero (OK) is returned if the metrics were * * Returned Value: diff --git a/include/nuttx/nx/nxglib.h b/include/nuttx/nx/nxglib.h index e0d3f6b846c3de69753510d303ee51b94e0cee3b..89530cac2523595afa7a64e7dffbca8b634e5e5c 100644 --- a/include/nuttx/nx/nxglib.h +++ b/include/nuttx/nx/nxglib.h @@ -679,12 +679,12 @@ bool nxgl_colorcmp(const nxgl_mxpixel_t color1[CONFIG_NX_NPLANES], * this case, 3 trapezoids will be returned, but traps[1] will be * degenerate. * - * Input parameters: + * Input Parameters: * vector - A pointer to the vector described the line to be drawn. * traps - A pointer to a array of trapezoids (size 3). * rect - A pointer to a rectangle. * - * Returned value: + * Returned Value: * 0: Line successfully broken up into three trapezoids. Values in * traps[0], traps[1], and traps[2] are valid. * 1: Line successfully represented by one trapezoid. Value in traps[1] @@ -708,13 +708,13 @@ int nxgl_splitline(FAR struct nxgl_vector_s *vector, * circumference of the circle. These points may then be used by * nx_drawcircle() or related APIs to draw a circle outline. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 16 points where the * circle points will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -730,13 +730,13 @@ void nxgl_circlepts(FAR const struct nxgl_point_s *center, * Given a description of a a circle, return 8 trapezoids that can be * used to fill the circle by nx_fillcircle() and other interfaces. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 8 trapezoids where * the circle description will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/nx/nxmu.h b/include/nuttx/nx/nxmu.h index fe8253bd74a47bec6ccc2ca9c2d88bc719e06b5b..fb6cd68d343726676720b9d4cb0a6ddcd509fad8 100644 --- a/include/nuttx/nx/nxmu.h +++ b/include/nuttx/nx/nxmu.h @@ -495,7 +495,7 @@ extern "C" * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. In the * case of ERROR, NX will have deallocated the pre-allocated window. * @@ -515,7 +515,7 @@ int nxfe_constructwindow(NXHANDLE handle, * Input Parameters: * sem - the semaphore to be taken. * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -533,7 +533,7 @@ void nxmu_semtake(sem_t *sem); * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -553,7 +553,7 @@ int nxmu_sendserver(FAR struct nxfe_conn_s *conn, * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/include/nuttx/nx/nxterm.h b/include/nuttx/nx/nxterm.h index 48347c1fad3aa0ef0596eb0d3d6b3e5c31510fca..dc11a9d10685f3b3b14485d8829755b114605a83 100644 --- a/include/nuttx/nx/nxterm.h +++ b/include/nuttx/nx/nxterm.h @@ -229,7 +229,7 @@ extern "C" * nxtool_register() returns. * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ @@ -252,7 +252,7 @@ NXTERM nx_register(NXWINDOW hwnd, FAR struct nxterm_window_s *wndo, * nxtool_register() returns. * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ @@ -277,7 +277,7 @@ NXTERM nxtk_register(NXTKWINDOW hfwnd, FAR struct nxterm_window_s *wndo, * nxtool_register() returns. * minor - The device minor number * - * Return: + * Returned Value: * A non-NULL handle is returned on success. * ****************************************************************************/ diff --git a/include/nuttx/nx/nxtk.h b/include/nuttx/nx/nxtk.h index 6cd00f01b8d465d48de3ba13036380b52e09c7c8..75b31c21640b69f5d3de75bea86f11e2510d9482 100644 --- a/include/nuttx/nx/nxtk.h +++ b/include/nuttx/nx/nxtk.h @@ -125,7 +125,7 @@ extern "C" * cb - Callbacks used to process window events * arg - User provided value that will be returned with NXTK callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NXTK window accesses * Failure: NULL is returned and errno is set appropriately * @@ -143,7 +143,7 @@ NXTKWINDOW nxtk_openwindow(NXHANDLE handle, * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -176,7 +176,7 @@ int nxtk_closewindow(NXTKWINDOW hfwnd); * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -194,7 +194,7 @@ int nxtk_block(NXTKWINDOW hfwnd, FAR void *arg); * Input Parameters: * hfwnd - The window handle returned by nxtk_openwindow. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -213,7 +213,7 @@ int nxtk_getposition(NXTKWINDOW hfwnd); * hfwnd - The window handle returned by nxtk_openwindow * pos - The new position of the client sub-window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -232,7 +232,7 @@ int nxtk_setposition(NXTKWINDOW hfwnd, FAR const struct nxgl_point_s *pos); * hfwnd - The window handle returned by nxtk_openwindow * size - The new size of the client sub-window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -246,11 +246,11 @@ int nxtk_setsize(NXTKWINDOW hfwnd, FAR const struct nxgl_size_s *size); * Bring the window containing the specified client sub-window to the top * of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be raised. This must have been previously created * by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -264,11 +264,11 @@ int nxtk_raise(NXTKWINDOW hfwnd); * Lower the window containing the specified client sub-window to the * bottom of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be lowered. This must have been previously created * by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -286,7 +286,7 @@ int nxtk_lower(NXTKWINDOW hfwnd); * rect - The location within the client window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -310,7 +310,7 @@ int nxtk_fillwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -330,7 +330,7 @@ int nxtk_getwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -355,7 +355,7 @@ int nxtk_filltrapwindow(NXTKWINDOW hfwnd, * caps - Draw a circular cap the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -377,7 +377,7 @@ int nxtk_drawlinewindow(NXTKWINDOW hfwnd, FAR struct nxgl_vector_s *vector, * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -399,7 +399,7 @@ int nxtk_drawcirclewindow(NXTKWINDOW hfwnd, * radius - The radius of the circle in pixels. * color - The color to use to fill the circle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -423,7 +423,7 @@ int nxtk_fillcirclewindow(NXWINDOW hfwnd, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -449,7 +449,7 @@ int nxtk_movewindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * origin may lie outside of the sub-window display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -471,7 +471,7 @@ int nxtk_bitmapwindow(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *dest, * cb - Callbacks used to process toolbar events * arg - User provided value that will be returned with toolbar callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -488,7 +488,7 @@ int nxtk_opentoolbar(NXTKWINDOW hfwnd, nxgl_coord_t height, * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -511,7 +511,7 @@ int nxtk_closetoolbar(NXTKWINDOW hfwnd); * hfwnd - The handle returned by nxtk_openwindow * bounds - User provided location in which to return the bounding box. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -529,7 +529,7 @@ int nxtk_toolbarbounds(NXTKWINDOW hfwnd, FAR struct nxgl_rect_s *bounds); * rect - The location within the toolbar window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -553,7 +553,7 @@ int nxtk_filltoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -573,7 +573,7 @@ int nxtk_gettoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -599,7 +599,7 @@ int nxtk_filltraptoolbar(NXTKWINDOW hfwnd, * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -621,7 +621,7 @@ int nxtk_drawlinetoolbar(NXTKWINDOW hfwnd, FAR struct nxgl_vector_s *vector, * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -643,7 +643,7 @@ int nxtk_drawcircletoolbar(NXTKWINDOW hfwnd, * radius - The radius of the circle in pixels. * color - The color to use to fill the circle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -668,7 +668,7 @@ int nxtk_fillcircletoolbar(NXWINDOW hfwnd, * offset - The offset to move the region. The rectangular region will be * moved so that the origin is translated by this amount. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -693,7 +693,7 @@ int nxtk_movetoolbar(NXTKWINDOW hfwnd, FAR const struct nxgl_rect_s *rect, * origin may lie outside of the sub-window display. * stride - The width of the full source image in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/include/nuttx/power/battery_charger.h b/include/nuttx/power/battery_charger.h index 997e0fa5c3a610ab3f687d4db389c7a9ff87420a..e17618b2935340d0eb9e3ef269391cad897e3eb2 100644 --- a/include/nuttx/power/battery_charger.h +++ b/include/nuttx/power/battery_charger.h @@ -196,12 +196,12 @@ extern "C" * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/power/battery_gauge.h b/include/nuttx/power/battery_gauge.h index 24a8eb5055d99384c8c268c076c82e3c562401a7..d6bd280cf7c7f7a70d7a9f67a8899c3dcb5e817c 100644 --- a/include/nuttx/power/battery_gauge.h +++ b/include/nuttx/power/battery_gauge.h @@ -158,12 +158,12 @@ extern "C" * Register a lower half battery driver with the common, upper-half * battery driver. * - * Input parameters: + * Input Parameters: * devpath - The location in the pseudo-filesystem to create the driver. * Recommended standard is "/dev/bat0", "/dev/bat1", etc. * dev - An instance of the battery state structure . * - * Returned value: + * Returned Value: * Zero on success or a negated errno value on failure. * ****************************************************************************/ diff --git a/include/nuttx/power/pm.h b/include/nuttx/power/pm.h index 482131911f6c85ba6b0f5896611e51a606b7faa5..92df1c7749165ec690fe0dbeac551fa370e4de7f 100644 --- a/include/nuttx/power/pm.h +++ b/include/nuttx/power/pm.h @@ -364,10 +364,10 @@ extern "C" * *before* any other device drivers are initialized (since they may * attempt to register with the power management subsystem). * - * Input parameters: + * Input Parameters: * None. * - * Returned value: + * Returned Value: * None. * ****************************************************************************/ @@ -381,11 +381,11 @@ void pm_initialize(void); * This function is called by a device driver in order to register to * receive power management event callbacks. * - * Input parameters: + * Input Parameters: * callbacks - An instance of struct pm_callback_s providing the driver * callback functions. * - * Returned value: + * Returned Value: * Zero (OK) on success; otherwise a negater errno value is returned. * ****************************************************************************/ diff --git a/include/nuttx/sched.h b/include/nuttx/sched.h index 3810962c8b3ea765f2e8e03b449527eeaca1849e..8f80165d762b1687986028a7be2142628dc3e0c0 100644 --- a/include/nuttx/sched.h +++ b/include/nuttx/sched.h @@ -823,12 +823,12 @@ FAR struct socketlist *sched_getsockets(void); * The start hook is useful, for example, for setting up automatic * configuration of C++ constructors. * - * Inputs: + * Input Parameters: * tcb - The new, unstarted task task that needs the start hook * starthook - The pointer to the start hook function * arg - The argument to pass to the start hook function. * - * Return: + * Returned Value: * None * ********************************************************************************/ @@ -923,14 +923,14 @@ void sched_suspend_scheduler(FAR struct tcb_s *tcb); * use by application logic. Applications should use the standard * sched_getparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority * of the calling task is returned. * param - A structure whose member sched_priority is the integer * priority. The task's priority is copied to the sched_priority * element of this structure. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -958,14 +958,14 @@ int nxsched_getparam (pid_t pid, FAR struct sched_param *param); * use by application logic. Applications should use the standard * sched_setparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to reprioritize. If pid is zero, the * priority of the calling task is changed. * param - A structure whose member sched_priority is the integer priority. * The range of valid priority numbers is from SCHED_PRIORITY_MIN * through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -995,11 +995,11 @@ int nxsched_setparam(pid_t pid, FAR const struct sched_param *param); * use by application logic. Applications should use the standard * sched_getscheduler(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to query. If pid is zero, the * calling task is queried. * - * Return Value: + * Returned Value: * On success, sched_getscheduler() returns the policy for the task * (either SCHED_FIFO or SCHED_RR). On error, a negated errno value * returned: @@ -1100,12 +1100,12 @@ int nxsched_getaffinity(pid_t pid, size_t cpusetsize, FAR cpu_set_t *mask); * is not intended for use by application logic. Applications should * use the standard sched_setparam(). * - * Inputs: + * Input Parameters: * pid - The ID of thread whose affinity set will be modified. * cpusetsize - Size of mask. MUST be sizeofcpu_set_t(). * mask - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * Zero (OK) if successful. Otherwise, a negated errno value is returned: * * ESRCH The task whose ID is pid could not be found. diff --git a/include/nuttx/semaphore.h b/include/nuttx/semaphore.h index 6e525f6e1c707ed79f01af7b324fb1e9bf1d1915..850e3c77189bc8bdef750a004c2b62f149ec48be 100644 --- a/include/nuttx/semaphore.h +++ b/include/nuttx/semaphore.h @@ -159,7 +159,7 @@ extern "C" * pshared - Process sharing (not used) * value - Semaphore initialization value * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -185,7 +185,7 @@ int nxsem_init(FAR sem_t *sem, int pshared, unsigned int value); * Parameters: * sem - Semaphore to be destroyed. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -211,7 +211,7 @@ int nxsem_destroy (FAR sem_t *sem); * Parameters: * sem - Semaphore descriptor. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -235,7 +235,7 @@ int nxsem_wait(FAR sem_t *sem); * Parameters: * sem - the semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -276,7 +276,7 @@ int nxsem_trywait(FAR sem_t *sem); * sem - Semaphore object * abstime - The absolute time to wait until a timeout is declared. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -313,7 +313,7 @@ int nxsem_timedwait(FAR sem_t *sem, FAR const struct timespec *abstime); * posted. If ticks is zero, then this function is equivalent * to sem_trywait(). * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -342,7 +342,7 @@ int nxsem_tickwait(FAR sem_t *sem, systime_t start, uint32_t delay); * Parameters: * sem - Semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -373,7 +373,7 @@ int nxsem_post(FAR sem_t *sem); * sem - Semaphore descriptor * sval - Buffer by which the value is returned * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -395,7 +395,7 @@ int nxsem_getvalue(FAR sem_t *sem, FAR int *sval); * sem - Semaphore descriptor to be reset * count - The requested semaphore count * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -416,7 +416,7 @@ int nxsem_reset(FAR sem_t *sem, int16_t count); * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -437,7 +437,7 @@ int nxsem_reset(FAR sem_t *sem, int16_t count); * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. @@ -476,7 +476,7 @@ int sem_getprotocol(FAR sem_t *sem, FAR int *protocol); * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -515,7 +515,7 @@ int nxsem_setprotocol(FAR sem_t *sem, int protocol); * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/include/nuttx/signal.h b/include/nuttx/signal.h index 0c9e4107129fd86adb8d16f672521fc5c4e1b94c..51a5dbe0e5f975b2cda6206116331a789a742203 100644 --- a/include/nuttx/signal.h +++ b/include/nuttx/signal.h @@ -127,7 +127,7 @@ struct timespec; /* Forward reference */ * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -160,7 +160,7 @@ int nxsig_procmask(int how, FAR const sigset_t *set, FAR sigset_t *oset); * signo - Signal number * value - Value to pass to task with signal * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -232,7 +232,7 @@ int nxsig_kill(pid_t pid, int signo); * set - The pending signal set * info - The returned value * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -270,7 +270,7 @@ int nxsig_kill(pid_t pid, int signo); * info - The returned value (may be NULL). * timeout - The amount of time to wait (may be NULL) * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/include/nuttx/streams.h b/include/nuttx/streams.h index ccb7054f7fc4527adb7a8f639e4adc98299d10a4..d615c85609e555435d4ae91d01f3d01dec65b575 100644 --- a/include/nuttx/streams.h +++ b/include/nuttx/streams.h @@ -230,7 +230,7 @@ extern "C" * Seekable versions are defined in lib/stdio/lib_memsistream.c and * lib/stdio/lib_memsostream.c. * - * Input parameters: + * Input Parameters: * memstream - User allocated, uninitialized instance of struct * lib_meminstream_s to be initialized. * memstream - User allocated, uninitialized instance of struct @@ -259,7 +259,7 @@ void lib_memsostream(FAR struct lib_memsostream_s *outstream, * Initializes a stream for use with a FILE instance. * Defined in lib/stdio/lib_stdinstream.c and lib/stdio/lib_stdoutstream.c * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_stdinstream_s to be initialized. * outstream - User allocated, uninitialized instance of struct @@ -291,7 +291,7 @@ void lib_stdsostream(FAR struct lib_stdsostream_s *outstream, * Seekable versions are defined in lib/stdio/lib_rawsistream.c and * lib/stdio/lib_rawsostream.c * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_rawinstream_s to be initialized. * outstream - User allocated, uninitialized instance of struct @@ -316,7 +316,7 @@ void lib_rawsostream(FAR struct lib_rawsostream_s *outstream, int fd); * Initializes a stream for use with low-level, architecture-specific output. * Defined in ib/stdio/lib_lowoutstream.c * - * Input parameters: + * Input Parameters: * lowoutstream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -342,7 +342,7 @@ void lib_lowoutstream(FAR struct lib_outstream_s *lowoutstream); * o The stream created by lib_nulloutstream will write all data to the * bit-bucket. Defined in lib/stdio/lib_nulloutstream.c * - * Input parameters: + * Input Parameters: * zeroinstream - User allocated, uninitialized instance of struct * lib_instream_s to be initialized. * nullinstream - User allocated, uninitialized instance of struct @@ -366,7 +366,7 @@ void lib_nulloutstream(FAR struct lib_outstream_s *nulloutstream); * Initializes a stream for use with the configured syslog interface. * Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -383,7 +383,7 @@ void syslogstream_create(FAR struct lib_syslogstream_s *stream); * Description: * Free resources held by the syslog stream. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -405,7 +405,7 @@ void syslogstream_destroy(FAR struct lib_syslogstream_s *stream); * Initializes a stream for use with the configured emergency syslog * interface. Only accessible from with the OS SYSLOG logic. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * @@ -423,7 +423,7 @@ void emergstream(FAR struct lib_outstream_s *stream); * lib_noflush() provides a common, dummy flush method for output streams * that are not flushable. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ @@ -438,7 +438,7 @@ int lib_noflush(FAR struct lib_outstream_s *stream); * streams that are not flushable. * is selected. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/include/nuttx/syslog/syslog.h b/include/nuttx/syslog/syslog.h index bce437d7a76c2b43191491167c96fe329d1fe3f5..1ea41be2ef38139398ad003600cb0af48aefe0ed 100644 --- a/include/nuttx/syslog/syslog.h +++ b/include/nuttx/syslog/syslog.h @@ -149,7 +149,7 @@ extern "C" * Configure the SYSLOGging function to use the provided channel to * generate SYSLOG output. * - * Input buffer: + * Input Parameters: * channel - Provides the interface to the channel to be used. * * Returned Value: diff --git a/include/nuttx/time.h b/include/nuttx/time.h index 2a6c59697878e0b059714f4fa1822987875448ca..ee4705ba30792cd8b5818bfa5058f92637437ded 100644 --- a/include/nuttx/time.h +++ b/include/nuttx/time.h @@ -111,7 +111,7 @@ int clock_daysbeforemonth(int month, bool leapyear); * month - The month of the year 1 - 12 * year - the year including the 1900 * - * Returned value: + * Returned Value: * Zero based day of the week 0-6, 0 = Sunday, 1 = Monday... 6 = Saturday * ****************************************************************************/ diff --git a/include/nuttx/timers/timer.h b/include/nuttx/timers/timer.h index ab78f5ea977516a4de6b508bb61b689e8a6a89cb..db59e81819e077a7adbd834b938480637bcc98a5 100644 --- a/include/nuttx/timers/timer.h +++ b/include/nuttx/timers/timer.h @@ -225,7 +225,7 @@ extern "C" * Rather it is called indirectly through the architecture-specific * initialization. * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all timer * drivers as "/dev/timer0", "/dev/timer1", etc. where the driver @@ -250,7 +250,7 @@ FAR void *timer_register(FAR const char *path, * This function can be called to disable and unregister the timer * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * * Returned Value: @@ -272,7 +272,7 @@ void timer_unregister(FAR void *handle); * to handle timer expirations. This is a strictly OS internal interface * and may NOT be used by appliction code. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by timer_register() * callback - The new timer interrupt callback * arg - Argument provided when the callback is called. diff --git a/include/nuttx/timers/watchdog.h b/include/nuttx/timers/watchdog.h index 9c7d9001fa3ae25796de315e570fd2dd64fec7a9..4759556e81fc7c424e37b5995c77454f6cfe3c05 100644 --- a/include/nuttx/timers/watchdog.h +++ b/include/nuttx/timers/watchdog.h @@ -217,7 +217,7 @@ extern "C" * NOTE: This function would not be called by application code. Rather it is * called indirectly through the architecture-specific interfaces. * - * Input parameters: + * Input Parameters: * dev path - The full path to the driver to be registers in the NuttX * pseudo-filesystem. The recommended convention is to name all watchdog * drivers as "/dev/watchdog0", "/dev/watchdog1", etc. where the driver @@ -242,7 +242,7 @@ FAR void *watchdog_register(FAR const char *path, * This function can be called to disable and unregister the watchdog * device driver. * - * Input parameters: + * Input Parameters: * handle - This is the handle that was returned by watchdog_register() * * Returned Value: diff --git a/include/nuttx/usb/cdcacm.h b/include/nuttx/usb/cdcacm.h index d490adc0985d33ac32944ddb7a595e8004fb60f3..24109a98a0ab5eada14c6efc5770e36ef6647602 100644 --- a/include/nuttx/usb/cdcacm.h +++ b/include/nuttx/usb/cdcacm.h @@ -336,7 +336,7 @@ typedef FAR void (*cdcacm_callback_t)(enum cdcacm_event_e event); * Register USB serial port (and USB serial console if so configured) and * return the class object. * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * classdev - The location to return the CDC serial class' device @@ -360,7 +360,7 @@ int cdcacm_classobject(int minor, FAR struct usbdev_devinfo_s *devinfo, * Description: * Register USB serial port (and USB serial console if so configured). * - * Input Parameter: + * Input Parameters: * minor - Device minor number. E.g., minor 0 would correspond to * /dev/ttyACM0. * handle - An optional opaque reference to the CDC/ACM class object that diff --git a/include/nuttx/usb/composite.h b/include/nuttx/usb/composite.h index 7d5f90c01d52072a166ca7c90d938dfd1c453985..38d0122fa46eb878e652c6993e206841ae99c196 100644 --- a/include/nuttx/usb/composite.h +++ b/include/nuttx/usb/composite.h @@ -88,7 +88,7 @@ extern "C" * board-specific implementations in order to obtain the class objects for * each of the members of the composite. * - * Input Parameter: + * Input Parameters: * None * * Returned Value: diff --git a/include/nuttx/usb/hid_parser.h b/include/nuttx/usb/hid_parser.h index 809a8fb0cadf135504af8a6c5cc802e6a7073897..08fd4b053c093f485225c419109fad61eb729c55 100644 --- a/include/nuttx/usb/hid_parser.h +++ b/include/nuttx/usb/hid_parser.h @@ -227,7 +227,7 @@ struct hid_rptinfo_s * Input Parameters: * item Pointer to the current report item for user checking. * - * Returned value: + * Returned Value: * Boolean true if the item should be stored into the struct hid_rptinfo_s * structure, false if it should be ignored. */ @@ -283,7 +283,7 @@ int hid_parsereport(FAR const uint8_t *report, int rptlen, * report. If the given item does not exist in the report, the function * does not modify the report item's data. * - * Input Parameters + * Input Parameters: * report Buffer containing an IN or FEATURE report from an attached * device. * item Pointer to the report item of interest in a struct hid_rptinfo_s @@ -330,7 +330,7 @@ void hid_putitem(FAR uint8_t *report, FAR struct hid_rptitem_s *item); * Description: * Retrieves the size of a given HID report in bytes from it's Report ID. * - * InputParameters: + * Input Parameters: * rptinfo Pointer to a struct hid_rptinfo_s instance containing the parser * output. * id Report ID of the report whose size is to be retrieved. diff --git a/include/nuttx/usb/usbhost.h b/include/nuttx/usb/usbhost.h index 7f95b1d5b3770d00bb0517ddf342b00320bc1db6..9dc98450da95bb09746cac3cf3a64ba4e6653488 100644 --- a/include/nuttx/usb/usbhost.h +++ b/include/nuttx/usb/usbhost.h @@ -91,7 +91,7 @@ * id - In the case where the device supports multiple base classes, subclasses, or * protocols, this specifies which to configure for. * - * Returned Values: + * Returned Value: * On success, this function will return a non-NULL instance of struct * usbhost_class_s that can be used by the USB host driver to communicate with the * USB host class. NULL is returned on failure; this function will fail only if @@ -121,7 +121,7 @@ * configdesc - A pointer to a uint8_t buffer container the configuration descriptor. * desclen - The length in bytes of the configuration 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 * @@ -152,7 +152,7 @@ * Input Parameters: * devclass - The USB host class entry previously obtained from a call to create(). * - * 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 * @@ -175,7 +175,7 @@ * 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 @@ -209,7 +209,7 @@ * 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 * @@ -238,7 +238,7 @@ * mps (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 * @@ -262,7 +262,7 @@ * devinfo - A pointer to memory provided by the caller in which to return the * device information. * - * 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 * @@ -286,7 +286,7 @@ * 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 * @@ -308,7 +308,7 @@ * 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 * @@ -341,7 +341,7 @@ * 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 * @@ -366,7 +366,7 @@ * 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 * @@ -395,7 +395,7 @@ * 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 * @@ -420,7 +420,7 @@ * 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 * @@ -456,7 +456,7 @@ * 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 * @@ -489,7 +489,7 @@ * (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: @@ -534,7 +534,7 @@ * 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. * @@ -561,7 +561,7 @@ * 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. * @@ -584,7 +584,7 @@ * 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. * @@ -611,7 +611,7 @@ * hport - The port from which the device is being disconnected. Might be a port * on a hub. * - * Returned Values: + * Returned Value: * None * * Assumptions: @@ -949,7 +949,7 @@ extern "C" * devclass - An write-able instance of struct usbhost_registry_s that will be * maintained in a registry. * - * Returned Values: + * Returned Value: * On success, this function will return zero (OK). Otherwise, a negated errno * value is returned. * @@ -969,7 +969,7 @@ int usbhost_registerclass(struct usbhost_registry_s *devclass); * Input Parameters: * id - Identifies the USB device class that has connect to the USB host. * - * Returned Values: + * Returned Value: * On success this function will return a non-NULL instance of struct * usbhost_registry_s. NULL will be returned on failure. This function can only * fail if (1) id is NULL, or (2) no USB host class is registered that matches the @@ -991,7 +991,7 @@ const struct usbhost_registry_s *usbhost_findclass(const struct usbhost_id_s *id * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1012,7 +1012,7 @@ int usbhost_hub_initialize(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1054,7 +1054,7 @@ int usbhost_cdcacm_initialize(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1075,7 +1075,7 @@ int usbhost_kbdinit(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1096,7 +1096,7 @@ int usbhost_mouse_init(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1116,7 +1116,7 @@ int usbhost_xboxcontroller_init(void); * Input Parameters: * None * - * Returned Values: + * Returned Value: * On success this function will return zero (OK); A negated errno value * will be returned on failure. * @@ -1147,7 +1147,7 @@ int usbhost_wlaninit(void); * and bound to the hub, the allocated class instance is returned into * this caller-provided memory location. * - * 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 * diff --git a/include/nuttx/usb/usbmonitor.h b/include/nuttx/usb/usbmonitor.h index d5be243e0546592ab653206ec753c48dbbce74af..fe360c0cc23662b3c05c577b0455e7506b5d1912 100644 --- a/include/nuttx/usb/usbmonitor.h +++ b/include/nuttx/usb/usbmonitor.h @@ -72,7 +72,7 @@ extern "C" * Input Parameters: * None * - * Returned values: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return on * any failure. * diff --git a/include/nuttx/userspace.h b/include/nuttx/userspace.h index 6e1afc2aa1514e1a47255ff59adebe0360610c9d..b7bb1cf65c4c9353fadf6ba951e2db9368f44be9 100644 --- a/include/nuttx/userspace.h +++ b/include/nuttx/userspace.h @@ -157,11 +157,11 @@ extern "C" * This function is the user-space, task startup function. It is called * from up_task_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the task entry point * argc and argv - Standard arguments for the task entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ @@ -177,11 +177,11 @@ void task_startup(main_t entrypt, int argc, FAR char *argv[]) noreturn_function; * This function is the user-space, pthread startup function. It is called * from up_pthread_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the pthread entry point * arg - Standard argument for the pthread entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ diff --git a/include/nuttx/video/fb.h b/include/nuttx/video/fb.h index 4d6c7f1d49a1228c64cd53d6ba01a4dd232dbf4c..83857ebc83de9aaf53256738b17711b360e3976d 100644 --- a/include/nuttx/video/fb.h +++ b/include/nuttx/video/fb.h @@ -410,7 +410,7 @@ extern "C" * 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. * @@ -429,7 +429,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. diff --git a/include/nuttx/wdog.h b/include/nuttx/wdog.h index 720d2b961c85c08a1c63bddf4e4b073a99a5f82c..a57d50e6ae45e72f996564341bebb8077d30f7a1 100644 --- a/include/nuttx/wdog.h +++ b/include/nuttx/wdog.h @@ -176,7 +176,7 @@ extern "C" * Parameters: * None * - * Return Value: + * Returned Value: * Pointer to watchdog (i.e., the watchdog ID), or NULL if insufficient * watchdogs are available. * @@ -196,7 +196,7 @@ WDOG_ID wd_create(void); * wdog - The watchdog ID to delete. This is actually a pointer to a * watchdog structure. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * @@ -231,7 +231,7 @@ int wd_delete(WDOG_ID wdog); * wdentry - function to call on timeout * parm1..4 - parameters to pass to wdentry * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * @@ -253,7 +253,7 @@ int wd_start(WDOG_ID wdog, int32_t delay, wdentry_t wdentry, int argc, ...); * Parameters: * wdog - ID of the watchdog to cancel. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned to * indicate the nature of any failure. * @@ -271,7 +271,7 @@ int wd_cancel(WDOG_ID wdog); * Parameters: * wdog - watchdog ID * - * Return Value: + * Returned Value: * The time in system ticks remaining until the watchdog time expires. * Zero means either that wdog is not valid or that the wdog has already * expired. diff --git a/include/nuttx/wireless/cc3000/evnt_handler.h b/include/nuttx/wireless/cc3000/evnt_handler.h index fe5f4ecdad024d1a9580fb12dfa464941e9bbab4..a720a04de9915658543d68b22722265d9e7e6e76 100644 --- a/include/nuttx/wireless/cc3000/evnt_handler.h +++ b/include/nuttx/wireless/cc3000/evnt_handler.h @@ -131,7 +131,7 @@ extern unsigned long socket_active_status; * from from information (in case of data received) * fromlen from information length (in case of data received) * - * Returned Values: + * Returned Value: * None * ****************************************************************************/ @@ -147,7 +147,7 @@ uint8_t *hci_event_handler(void *pRetParams, uint8_t *from, uint8_t *fromlen); * Input Parameters: * event_hdr event header * - * Returned Values: + * Returned Value: * 1 if event supported and handled; 0 if event is not supported * ****************************************************************************/ @@ -164,7 +164,7 @@ long hci_unsol_event_handler(char *event_hdr); * Input Parameters: * None * - * Returned Values: + * Returned Value: * ESUCCESS if successful, EFAIL if an error occurred * ****************************************************************************/ diff --git a/include/nuttx/wireless/cc3000/wlan.h b/include/nuttx/wireless/cc3000/wlan.h index b0a07c67d83813a5b5244f7dada0ebec330de5ac..70f2601ab34951aaa3cb53231c579fb8f088611f 100644 --- a/include/nuttx/wireless/cc3000/wlan.h +++ b/include/nuttx/wireless/cc3000/wlan.h @@ -499,7 +499,7 @@ long wlan_smart_config_set_prefix(char* cNewPrefix); * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ @@ -516,7 +516,7 @@ signed long aes_read_key(FAR uint8_t *key); * Input Parameters: * key AES128 key of size 16 bytes * - * Returned Value + * Returned Value: * On success 0, error otherwise. * ****************************************************************************/ diff --git a/include/nuttx/wireless/ieee802154/ieee802154_mac.h b/include/nuttx/wireless/ieee802154/ieee802154_mac.h index 10647638485c002b28141166955db258df7b7038..398134b696acb73f4a619d0839fc9a796642d651 100644 --- a/include/nuttx/wireless/ieee802154/ieee802154_mac.h +++ b/include/nuttx/wireless/ieee802154/ieee802154_mac.h @@ -1783,7 +1783,7 @@ MACHANDLE mac802154_create(FAR struct ieee802154_radio_s *radiodev); * minor - The device minor number. The IEEE802.15.4 MAC character device * will be registered as /dev/ieeeN where N is the minor number * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * @@ -1801,7 +1801,7 @@ int mac802154dev_register(MACHANDLE mac, int minor); * Input Parameters: * mac - Pointer to the mac layer struct to be registered. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * @@ -1819,10 +1819,10 @@ int mac802154netdev_register(MACHANDLE mac); * be called early in the initialization sequence before any radios * begin operation. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -1845,10 +1845,10 @@ void ieee802154_primitivepool_initialize(void); * list. If that the list is empty, then the primitive structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated primitive structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -1865,10 +1865,10 @@ FAR struct ieee802154_primitive_s *ieee802154_primitive_allocate(void); * the free pool if it was a pre-allocated primitive structure. If the primitive * was allocated dynamically it will be deallocated. * - * Inputs: + * Input Parameters: * prim - primitive structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/wireless/nrf24l01.h b/include/nuttx/wireless/nrf24l01.h index 123eb935036d404a381bd150406e2b6470d5229d..7cff670dc1025fdbe8cb5610dfdca2009d83e9af 100644 --- a/include/nuttx/wireless/nrf24l01.h +++ b/include/nuttx/wireless/nrf24l01.h @@ -196,7 +196,7 @@ struct nrf24l01_config_s /************************************************************************************ * Register the nRF24L01+ device. * - * Input Parmeters: + * Input Parameters: * spi - SPI Device structure * cfg Board specific configuration info * @@ -214,7 +214,7 @@ int nrf24l01_register(FAR struct spi_dev_s *spi, FAR struct nrf24l01_config_s *c /************************************************************************************ * Initialize the nRF24L01+ chip to a default initial state. * - * Input Parmeters: + * Input Parameters: * dev Pointer to a registered nRF24L01 device structure * ************************************************************************************/ @@ -224,7 +224,7 @@ int nrf24l01_init(FAR struct nrf24l01_dev_s *dev); /************************************************************************************ * Set the default TX address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * addr TX address (LSByte first) * @@ -238,7 +238,7 @@ int nrf24l01_settxaddr(FAR struct nrf24l01_dev_s *dev, FAR const uint8_t *addr); /************************************************************************************ * Get the default TX address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * addr TX address (LSByte first) * @@ -252,7 +252,7 @@ int nrf24l01_gettxaddr(FAR struct nrf24l01_dev_s *dev, FAR uint8_t *addr); /************************************************************************************ * Configure auto-retransmit * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * retrdelay Auto-retransmit delay * retrcount Auto-retransmit count (0 - 15) @@ -268,7 +268,7 @@ int nrf24l01_setretransmit(FAR struct nrf24l01_dev_s *dev, /************************************************************************************ * Configure a RX pipe. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * pipeno Pipe number to configure * pipecfg Pointer to configuration data @@ -284,7 +284,7 @@ int nrf24l01_setpipeconfig(FAR struct nrf24l01_dev_s *dev, unsigned int pipeno, /************************************************************************************ * Get pipe configuration. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * pipeno Pipe number to configure * pipecfg Pointer to configuration data used to store the config @@ -300,7 +300,7 @@ int nrf24l01_getpipeconfig(FAR struct nrf24l01_dev_s *dev, unsigned int pipeno, /************************************************************************************ * Enable a RX pipe. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * pipeno Pipe number * enable true to enable the pipe, false to disable it @@ -316,7 +316,7 @@ int nrf24l01_enablepipe(FAR struct nrf24l01_dev_s *dev, unsigned int pipeno, /************************************************************************************ * Configure RF. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * datarate Datarate * outpower Output power @@ -334,7 +334,7 @@ int nrf24l01_setuprf(FAR struct nrf24l01_dev_s *dev, nrf24l01_datarate_t datarat * * Note that hardware supports only -18, -12, -6 and 0 dBm values. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * outpower Output power (in dBm). * @@ -350,7 +350,7 @@ int nrf24l01_settxpower(FAR struct nrf24l01_dev_s *dev, int outpower); * * Note that hardware supports only -18, -12, -6 and 0 dBm values. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: @@ -363,7 +363,7 @@ int nrf24l01_gettxpower(FAR struct nrf24l01_dev_s *dev); /************************************************************************************ * Set transmission data rate * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: @@ -377,7 +377,7 @@ int nrf24l01_setdatarate(FAR struct nrf24l01_dev_s *dev, /************************************************************************************ * Set radio frequency. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * freq New frequency value (in Mhz: 2400 to 2525) * @@ -391,7 +391,7 @@ int nrf24l01_setradiofreq(FAR struct nrf24l01_dev_s *dev, uint32_t freq); /************************************************************************************ * Get current radio frequency. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: @@ -404,7 +404,7 @@ uint32_t nrf24l01_getradiofreq(FAR struct nrf24l01_dev_s *dev); /************************************************************************************ * Configure address length. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * width Address width to use (3-5) * @@ -418,7 +418,7 @@ int nrf24l01_setaddrwidth(FAR struct nrf24l01_dev_s *dev, uint32_t width); /************************************************************************************ * Change the current lifecycle state of the nRF24L01+ chip. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * state New state to put the nRF24L01 module into * @@ -429,7 +429,7 @@ int nrf24l01_changestate(FAR struct nrf24l01_dev_s *dev, nrf24l01_state_t state) /************************************************************************************ * Send data to the default address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * data Pointer on the data buffer * datalen Length of the buffer (in bytes) @@ -444,7 +444,7 @@ int nrf24l01_send(FAR struct nrf24l01_dev_s *dev, FAR const uint8_t *data, /************************************************************************************ * Send data to the specified address. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * data Pointer on the data buffer * datalen Length of the buffer (in bytes) @@ -461,7 +461,7 @@ int nrf24l01_sendto(FAR struct nrf24l01_dev_s *dev, FAR const uint8_t *data, * Get the retransmits count of the last transmission. * This value is meaningful only if auto-acknowledge is enabled. * - * Input Parmeters: + * Input Parameters: * dev Pointer to an nRF24L01 device structure * * Returned Value: diff --git a/include/nuttx/wireless/pktradio.h b/include/nuttx/wireless/pktradio.h index d4f405b4142c685cad0ff1bb602ce7faaf3de98c..829de17909d6950a174e5a05dca12a1ed56e5bdb 100644 --- a/include/nuttx/wireless/pktradio.h +++ b/include/nuttx/wireless/pktradio.h @@ -181,10 +181,10 @@ struct pktradio_metadata_s * called. Therefore, it may be called during packet radio driver * initialization, even if there are multiple packet radio drivers. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -202,10 +202,10 @@ void pktradio_metadata_initialize(void); * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated metadata structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -223,10 +223,10 @@ FAR struct pktradio_metadata_s *pktradio_metadata_allocate(void); * structure. If the metadata structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * metadata - metadata structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/nuttx/wqueue.h b/include/nuttx/wqueue.h index b5ee23e022ae2888814a824e09ffdf9701d890db..8fe684a9a5cfd45d7fc36b5057ffb89184e4b5c6 100644 --- a/include/nuttx/wqueue.h +++ b/include/nuttx/wqueue.h @@ -318,7 +318,7 @@ extern "C" * Description: * Start the user mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -345,7 +345,7 @@ int work_usrstart(void); * previous work as been performed and removed from the queue, then any * pending work will be canceled and lost. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked @@ -371,7 +371,7 @@ int work_queue(int qid, FAR struct work_s *work, worker_t worker, * After work has been cancelled, it may be re-queue by calling work_queue() * again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The previously queue work structure to cancel * @@ -393,7 +393,7 @@ int work_cancel(int qid, FAR struct work_s *work); * is used internally by the work logic but could also be used by the * user to force an immediate re-assessment of pending work. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * * Returned Value: @@ -409,7 +409,7 @@ int work_signal(int qid); * Description: * Check if the work structure is available. * - * Input parameters: + * Input Parameters: * work - The work queue structure to check. * None * @@ -431,7 +431,7 @@ int work_signal(int qid); * Parameters: * reqprio - Requested minimum worker thread priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -453,7 +453,7 @@ void lpwork_boostpriority(uint8_t reqprio); * reqprio - Previously requested minimum worker thread priority to be * "unboosted" * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/include/sys/ioctl.h b/include/sys/ioctl.h index cc697c040a3be115e88c5945fee1b9b1aaa091cf..d8da7a121b237d3fc4ebe6c317cb877110a9ef3a 100644 --- a/include/sys/ioctl.h +++ b/include/sys/ioctl.h @@ -110,7 +110,7 @@ extern "C" * arg The argument of the ioctl cmd, OR * ... A third argument of type unsigned long is still expected. * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * -1 on failure with errno set properly: * diff --git a/include/sys/sendfile.h b/include/sys/sendfile.h index 22cb8271ef6521c34b150f3b6d10d9eb5a54ba9f..c414532671e7ebd6ef443f636ff13efda3aac3c1 100644 --- a/include/sys/sendfile.h +++ b/include/sys/sendfile.h @@ -87,7 +87,7 @@ extern "C" * different semantics and prototypes. sendfile() should not be used * in portable programs. * - * Input Parmeters: + * Input Parameters: * infd - A file (or socket) descriptor opened for reading * outfd - A descriptor opened for writing. * offset - If 'offset' is not NULL, then it points to a variable diff --git a/include/sys/time.h b/include/sys/time.h index ece75bc10fc14c6150b1ae99d7b343fd3735086f..36ba9822be012128f3f32019993ad942f9a9c7c3 100644 --- a/include/sys/time.h +++ b/include/sys/time.h @@ -160,7 +160,7 @@ extern "C" * tv - The location to return the current time * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * @@ -183,7 +183,7 @@ int gettimeofday(FAR struct timeval *tv, FAR struct timezone *tz); * tv - The net to time to be set * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * diff --git a/libc/dirent/lib_readdirr.c b/libc/dirent/lib_readdirr.c index ffbe91056aff71531bc7aa6f886ef18a764110ce..d383651c636a136667ad7b6e4cd53c2f6253f3dd 100644 --- a/libc/dirent/lib_readdirr.c +++ b/libc/dirent/lib_readdirr.c @@ -62,7 +62,7 @@ * directory stream pointed to by dir. It returns NULL on * reaching the end-of-file or if an error occurred. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * entry -- The storage pointed to by entry must be large @@ -73,7 +73,7 @@ * argument entry. Upon reaching the end of the directory * stream, this pointer shall have the value NULL. * - * Return: + * Returned Value: * If successful, the readdir_r() function return s zero; * otherwise, an error number is returned to indicate the * error. diff --git a/libc/dirent/lib_telldir.c b/libc/dirent/lib_telldir.c index f77a4a1c21c4c0aceb6f741039c41947da12f94e..af12ff902b1f5289d6d6c13f98072eea4e36a759 100644 --- a/libc/dirent/lib_telldir.c +++ b/libc/dirent/lib_telldir.c @@ -61,11 +61,11 @@ * The telldir() function returns the current location * associated with the directory stream dirp. * - * Inputs: + * Input Parameters: * dirp -- An instance of type DIR created by a previous * call to opendir(); * - * Return: + * Returned Value: * On success, the telldir() function returns the current * location in the directory stream. On error, -1 is * returned, and errno is set appropriately. diff --git a/libc/hex2bin/lib_fhex2mem.c b/libc/hex2bin/lib_fhex2mem.c index 1967dd1adeb6faf90245ebb87853ca6497f9d203..b6bc91aa9f8bfc1191bc1eb6450322d6ced667fa 100644 --- a/libc/hex2bin/lib_fhex2mem.c +++ b/libc/hex2bin/lib_fhex2mem.c @@ -69,7 +69,7 @@ * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * diff --git a/libc/hex2bin/lib_hex2bin.c b/libc/hex2bin/lib_hex2bin.c index 2dc5d32d97b7175e62ba511911e296f357354b66..3815eb062702c8ec767a104dd5f3654ff6f1207f 100644 --- a/libc/hex2bin/lib_hex2bin.c +++ b/libc/hex2bin/lib_hex2bin.c @@ -403,7 +403,7 @@ static inline void writedata(FAR struct lib_sostream_s *outstream, * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * diff --git a/libc/hex2bin/lib_hex2mem.c b/libc/hex2bin/lib_hex2mem.c index 12c284cf5403019affd8a71af7b577293389434e..24b25b011db96bf114ed8a19ed73d1b301318465 100644 --- a/libc/hex2bin/lib_hex2mem.c +++ b/libc/hex2bin/lib_hex2mem.c @@ -69,7 +69,7 @@ * swap - Controls byte ordering. See enum hex2bin_swap_e for * description of the values. * - * Returned Value + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * failure. * diff --git a/libc/inttypes/lib_strtoimax.c b/libc/inttypes/lib_strtoimax.c index 0acaca315514aeb29431a59f5b27e4353f3fce31..d4eff8232fe6b69fc6de5f63ad47d03156212f9a 100644 --- a/libc/inttypes/lib_strtoimax.c +++ b/libc/inttypes/lib_strtoimax.c @@ -64,7 +64,7 @@ * nptr to a intmax_t integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/inttypes/lib_strtoumax.c b/libc/inttypes/lib_strtoumax.c index 9440908c93c31358aacee9b9626919fa186396b7..90cf6005ff46e7a7821f6600771798b4e8677139 100644 --- a/libc/inttypes/lib_strtoumax.c +++ b/libc/inttypes/lib_strtoumax.c @@ -57,7 +57,7 @@ * nptr to a long unsigned integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/libgen/lib_basename.c b/libc/libgen/lib_basename.c index 18b2168fad3e1426d25085ea253d71beb82e4103..c83793820987112dd5067810212b5b5bcd61810a 100644 --- a/libc/libgen/lib_basename.c +++ b/libc/libgen/lib_basename.c @@ -73,7 +73,7 @@ static char g_retchar[2]; * Parameter: * path The null-terminated string referring to the path to be decomposed * - * Return: + * Returned Value: * On success the filename component of the path is returned. * ****************************************************************************/ diff --git a/libc/libgen/lib_dirname.c b/libc/libgen/lib_dirname.c index 0acd03c71fdcc78f07b8f6f73a081a2e039ee102..ce260e2a4f326b416ad083dc03e0a892d4d1a8bc 100644 --- a/libc/libgen/lib_dirname.c +++ b/libc/libgen/lib_dirname.c @@ -73,7 +73,7 @@ static char g_retchar[2]; * Parameter: * path The null-terminated string referring to the path to be decomposed * - * Return: + * Returned Value: * On success the directory component of the path is returned. * ****************************************************************************/ diff --git a/libc/misc/lib_ioctl.c b/libc/misc/lib_ioctl.c index 0e7ca015d33755ab16b2a2e5db30e2f9dd860e22..f9acafba8a34ec8fee317e44af24b8fd471843d4 100644 --- a/libc/misc/lib_ioctl.c +++ b/libc/misc/lib_ioctl.c @@ -65,7 +65,7 @@ * req The ioctl command * ... A third argument of type unsigned long is expected * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * -1 on failure with errno set properly: * diff --git a/libc/misc/lib_mkfifo.c b/libc/misc/lib_mkfifo.c index deb919aad1c82498380c169165ac5984a4537021..4bcd412096bfa9e0316030a5f6fe2de19ff99c77 100644 --- a/libc/misc/lib_mkfifo.c +++ b/libc/misc/lib_mkfifo.c @@ -68,12 +68,12 @@ * If all threads that write to the FIFO have closed, subsequent calls to * read() on the FIFO will return 0 (end-of-file). * - * Inputs: + * Input Parameters: * pathname - The full path to the FIFO instance to attach to or to create * (if not already created). * mode - Ignored for now * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/libc/misc/lib_sendfile.c b/libc/misc/lib_sendfile.c index be6fa94c01d05a52e62ccfb9c77d39675293c05b..e3eaf548380f07e3b0cb2257642387c402d1a523 100644 --- a/libc/misc/lib_sendfile.c +++ b/libc/misc/lib_sendfile.c @@ -72,7 +72,7 @@ * different semantics and prototypes. sendfile() should not be used * in portable programs. * - * Input Parmeters: + * Input Parameters: * infd - A file (or socket) descriptor opened for reading * outfd - A descriptor opened for writing. * offset - If 'offset' is not NULL, then it points to a variable diff --git a/libc/net/lib_shutdown.c b/libc/net/lib_shutdown.c index a2c733dec232bfef467bfabe83b069a035eee604..b6cdaecdeaabcabfdd8c032a05c3dcd766d50f86 100644 --- a/libc/net/lib_shutdown.c +++ b/libc/net/lib_shutdown.c @@ -41,10 +41,6 @@ #ifdef CONFIG_NET -/**************************************************************************** - * Pre-processor Definitions - ****************************************************************************/ - /**************************************************************************** * Public Functions ****************************************************************************/ @@ -60,7 +56,7 @@ * The shutdown() function disables subsequent send and/or receive * operations on a socket, depending on the value of the how argument. * - * Input Paramteers: + * Input Parameters: * sockfd - Specifies the file descriptor of the socket. * how - Specifies the type of shutdown. The values are as follows: * diff --git a/libc/pthread/pthread_attr_destroy.c b/libc/pthread/pthread_attr_destroy.c index 16dd2cc50ee667eb92ca0364da488fe88ce24554..d91530841bb309f8ad54b823d7a379a07e39cd69 100644 --- a/libc/pthread/pthread_attr_destroy.c +++ b/libc/pthread/pthread_attr_destroy.c @@ -57,7 +57,7 @@ * Parameters: * attr * - * Return Value: + * Returned Value: * 0 meaning success * * Assumptions: diff --git a/libc/pthread/pthread_attr_getaffinity.c b/libc/pthread/pthread_attr_getaffinity.c index 1371ceff379b8de67be1763036b62598ebf372e1..e74dafc553689cb82f3adb844322e30151ab7b21 100644 --- a/libc/pthread/pthread_attr_getaffinity.c +++ b/libc/pthread/pthread_attr_getaffinity.c @@ -56,7 +56,7 @@ * attr * cpuset * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getinheritsched.c b/libc/pthread/pthread_attr_getinheritsched.c index d8e6515fa8cacce09dc257d34986f5c3b4d77a30..546e52a652f0d67cdfdbeb890840c38fb4d0124c 100644 --- a/libc/pthread/pthread_attr_getinheritsched.c +++ b/libc/pthread/pthread_attr_getinheritsched.c @@ -60,7 +60,7 @@ * attr * inheritsched * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getschedparam.c b/libc/pthread/pthread_attr_getschedparam.c index 3de2a3b7a28bfaa94fb8a8c6d882833b4658f1f8..408fa938945ee38f4b4daaa5d80749c43cf3c9de 100644 --- a/libc/pthread/pthread_attr_getschedparam.c +++ b/libc/pthread/pthread_attr_getschedparam.c @@ -58,7 +58,7 @@ * attr * param * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getschedpolicy.c b/libc/pthread/pthread_attr_getschedpolicy.c index ca819b8ffa48a9aa727bf52d020c14e394220a65..f3c06455b4f8a0c8c918d80531e1ba7dfd6b3834 100644 --- a/libc/pthread/pthread_attr_getschedpolicy.c +++ b/libc/pthread/pthread_attr_getschedpolicy.c @@ -57,7 +57,7 @@ * attr * policy * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_getstacksize.c b/libc/pthread/pthread_attr_getstacksize.c index 858cf88c9d18234b1a74bc1ed9586923be29cd83..ba64db65789138e57158bbe6ad508ba215ef3609 100644 --- a/libc/pthread/pthread_attr_getstacksize.c +++ b/libc/pthread/pthread_attr_getstacksize.c @@ -56,7 +56,7 @@ * attr * stacksize * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_init.c b/libc/pthread/pthread_attr_init.c index 256be4b2356af7b4ebd7c24a69ad82c2110f9961..60af413b87da79513cc378c840838692e5f6f201 100644 --- a/libc/pthread/pthread_attr_init.c +++ b/libc/pthread/pthread_attr_init.c @@ -76,7 +76,7 @@ const pthread_attr_t g_default_pthread_attr = PTHREAD_ATTR_INITIALIZER; * Parameters: * attr * - * Return Value: + * Returned Value: * 0 on success, otherwise an error number * * Assumptions: diff --git a/libc/pthread/pthread_attr_setaffinity.c b/libc/pthread/pthread_attr_setaffinity.c index 83f8e337cf568a28166e55169e59616984113c2e..ce2029f6093763b9a0d41139a5135b2eec4c5883 100644 --- a/libc/pthread/pthread_attr_setaffinity.c +++ b/libc/pthread/pthread_attr_setaffinity.c @@ -57,7 +57,7 @@ * attr * stacksize * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setinheritsched.c b/libc/pthread/pthread_attr_setinheritsched.c index 36b1d1dba1adecb1af706d647ce6aa1d11195d9e..c202c9dbab3bf554c63089d36c7f9ef47f8b0eee 100644 --- a/libc/pthread/pthread_attr_setinheritsched.c +++ b/libc/pthread/pthread_attr_setinheritsched.c @@ -61,7 +61,7 @@ * attr * policy * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setschedparam.c b/libc/pthread/pthread_attr_setschedparam.c index 812ebee8592c558c271902e19e0f40694b5d55ae..c6972ced3f48d218797a3049aeece9df353f34d2 100644 --- a/libc/pthread/pthread_attr_setschedparam.c +++ b/libc/pthread/pthread_attr_setschedparam.c @@ -58,7 +58,7 @@ * attr * param * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setschedpolicy.c b/libc/pthread/pthread_attr_setschedpolicy.c index 9d7ce10fff30555f41bd89b62bdbd68978a6a671..724c442e06364b6763ba4fd44fa49b84fa081334 100644 --- a/libc/pthread/pthread_attr_setschedpolicy.c +++ b/libc/pthread/pthread_attr_setschedpolicy.c @@ -59,7 +59,7 @@ * attr * policy * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_attr_setstacksize.c b/libc/pthread/pthread_attr_setstacksize.c index f69fc7df9c40cecd417f489671ebfbbf6787009c..6a0b8d4aeb129a1434c6ae8111b72ab3b4b466d5 100644 --- a/libc/pthread/pthread_attr_setstacksize.c +++ b/libc/pthread/pthread_attr_setstacksize.c @@ -57,7 +57,7 @@ * attr * stacksize * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_destroy.c b/libc/pthread/pthread_barrierattr_destroy.c index 663f449981047c106b7c53e61d3d2a6e7480c66a..ca7dcd9e64683073051eaf614b82475837954ac8 100644 --- a/libc/pthread/pthread_barrierattr_destroy.c +++ b/libc/pthread/pthread_barrierattr_destroy.c @@ -59,7 +59,7 @@ * Parameters: * attr - barrier attributes to be destroyed. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if attr is invalid. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_getpshared.c b/libc/pthread/pthread_barrierattr_getpshared.c index 3964a801ca80079606087fdebcad69d9235c2869..2f4fd22533ef1ab7e8e1b3bc004481402d6d1bbc 100644 --- a/libc/pthread/pthread_barrierattr_getpshared.c +++ b/libc/pthread/pthread_barrierattr_getpshared.c @@ -58,7 +58,7 @@ * attr - barrier attributes to be queried. * pshared - the location to stored the current value of the pshared attribute. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if either attr or pshared is invalid. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_init.c b/libc/pthread/pthread_barrierattr_init.c index e8270f6b985409f0fa6260c30e5408310d6fadb2..f2a5527da732a92a1650cf79bdff723726b4bb96 100644 --- a/libc/pthread/pthread_barrierattr_init.c +++ b/libc/pthread/pthread_barrierattr_init.c @@ -58,7 +58,7 @@ * Parameters: * attr - barrier attributes to be initialized. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if attr is invalid. * * Assumptions: diff --git a/libc/pthread/pthread_barrierattr_setpshared.c b/libc/pthread/pthread_barrierattr_setpshared.c index 76109ac08cf94df0983f7f60e0b5329ec5ed4d4b..b26ef1746edf5a7cd26a9142e169bc8e3aef9108 100644 --- a/libc/pthread/pthread_barrierattr_setpshared.c +++ b/libc/pthread/pthread_barrierattr_setpshared.c @@ -87,7 +87,7 @@ * attr - barrier attributes to be modified. * pshared - the new value of the pshared attribute. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if either attr is invalid or pshared is not one * of PTHREAD_PROCESS_SHARED or PTHREAD_PROCESS_PRIVATE. * diff --git a/libc/pthread/pthread_barrierdestroy.c b/libc/pthread/pthread_barrierdestroy.c index 3f74e06c4927db6f7f839297a323e14bf1170157..19a007b02af55fd347b6c67cff4c4e52e6b9a884 100644 --- a/libc/pthread/pthread_barrierdestroy.c +++ b/libc/pthread/pthread_barrierdestroy.c @@ -63,7 +63,7 @@ * Parameters: * barrier - barrier to be destroyed. * - * Return Value: + * Returned Value: * 0 (OK) on success or on of the following error numbers: * * EBUSY The implementation has detected an attempt to destroy a barrier diff --git a/libc/pthread/pthread_barrierinit.c b/libc/pthread/pthread_barrierinit.c index 6f8d427dfe29f77a7fd5274687cd46264c32f1dc..c9c60cefaa582795019f9a3cfd339b76d290eed4 100644 --- a/libc/pthread/pthread_barrierinit.c +++ b/libc/pthread/pthread_barrierinit.c @@ -69,7 +69,7 @@ * pthread_barrier_wait() before any of them successfully return from * the call. The value specified by count must be greater than zero. * - * Return Value: + * Returned Value: * 0 (OK) on success or on of the following error numbers: * * EAGAIN The system lacks the necessary resources to initialize another diff --git a/libc/pthread/pthread_barrierwait.c b/libc/pthread/pthread_barrierwait.c index 8ba29d1d94dece211ef2537048dc8c3b39d945bc..ed51b62c01b5d14ca4dd0ae32e7256c22f46f151 100644 --- a/libc/pthread/pthread_barrierwait.c +++ b/libc/pthread/pthread_barrierwait.c @@ -86,7 +86,7 @@ * Parameters: * barrier - the barrier to wait on * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if the barrier is not valid. * * Assumptions: diff --git a/libc/pthread/pthread_condattr_destroy.c b/libc/pthread/pthread_condattr_destroy.c index 12bee245dccd840efd210752d061a5e139743dfc..2f97ffbd6fab60a5f5e5f4cb97dce9b1bd105ce0 100644 --- a/libc/pthread/pthread_condattr_destroy.c +++ b/libc/pthread/pthread_condattr_destroy.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_condattr_init.c b/libc/pthread/pthread_condattr_init.c index 8865868b81f32ff49517c6fc5c19b803dc381e4c..9f23736233212b6aba7c8804bd7b6fd11a35ffd3 100644 --- a/libc/pthread/pthread_condattr_init.c +++ b/libc/pthread/pthread_condattr_init.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_conddestroy.c b/libc/pthread/pthread_conddestroy.c index a691b60d7d6579e130924e09d8b3bbe261b5e8f0..44e6e4cab5105a033d5a926778d16295b7383eb8 100644 --- a/libc/pthread/pthread_conddestroy.c +++ b/libc/pthread/pthread_conddestroy.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_condinit.c b/libc/pthread/pthread_condinit.c index 81a31ea57fa0447c0add7605c91784d216a2277d..d19601f196f430233a4a946eb3804438bf6f4a7c 100644 --- a/libc/pthread/pthread_condinit.c +++ b/libc/pthread/pthread_condinit.c @@ -59,7 +59,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_destroy.c b/libc/pthread/pthread_mutexattr_destroy.c index 01c8a6589a607c7c9a260d407833e2d04efabed9..f8fe9e057e903819eb09ca61848ad88de3fd48da 100644 --- a/libc/pthread/pthread_mutexattr_destroy.c +++ b/libc/pthread/pthread_mutexattr_destroy.c @@ -56,7 +56,7 @@ * Parameters: * attr * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_getprotocol.c b/libc/pthread/pthread_mutexattr_getprotocol.c index 7cc6065d367b85181e52c86fbbfffdfe2bd64b92..b83e289f42fd31b4c450175817fea1f0a2f874e1 100644 --- a/libc/pthread/pthread_mutexattr_getprotocol.c +++ b/libc/pthread/pthread_mutexattr_getprotocol.c @@ -58,7 +58,7 @@ * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * ****************************************************************************/ diff --git a/libc/pthread/pthread_mutexattr_getpshared.c b/libc/pthread/pthread_mutexattr_getpshared.c index 6d219fb08565d4e992787bb8c9111ad0f201041b..ea398bed6c5af2d07c1e733d79096953da4c4dff 100644 --- a/libc/pthread/pthread_mutexattr_getpshared.c +++ b/libc/pthread/pthread_mutexattr_getpshared.c @@ -57,7 +57,7 @@ * attr * pshared * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_getrobust.c b/libc/pthread/pthread_mutexattr_getrobust.c index 4db30f6b75ff22d9d9dec19aa8dbfde84b99c69d..4bf88ff7ea61091286e1dbb5b17a3ab752ee6827 100644 --- a/libc/pthread/pthread_mutexattr_getrobust.c +++ b/libc/pthread/pthread_mutexattr_getrobust.c @@ -55,7 +55,7 @@ * attr - The mutex attributes to query * robust - Location to return the robustness indication * - * Return Value: + * Returned Value: * 0, if the robustness was successfully return in 'robust', or * EINVAL, if any NULL pointers provided. * diff --git a/libc/pthread/pthread_mutexattr_gettype.c b/libc/pthread/pthread_mutexattr_gettype.c index c45008f8d4e9ba93d0817c85cd81e49cd300bf55..46e7076233b0beb7e759462ea494a923f913600f 100644 --- a/libc/pthread/pthread_mutexattr_gettype.c +++ b/libc/pthread/pthread_mutexattr_gettype.c @@ -55,7 +55,7 @@ * attr - The mutex attributes to query * type - Location to return the mutex type * - * Return Value: + * Returned Value: * 0, if the mutex type was successfully return in 'type', or * EINVAL, if any NULL pointers provided. * diff --git a/libc/pthread/pthread_mutexattr_init.c b/libc/pthread/pthread_mutexattr_init.c index 6f241881527996ea0e69df028fc6333ff02dece3..c0441c7ed2974dcacd8d5e33a3befe46f9608225 100644 --- a/libc/pthread/pthread_mutexattr_init.c +++ b/libc/pthread/pthread_mutexattr_init.c @@ -56,7 +56,7 @@ * Parameters: * attr * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_setprotocol.c b/libc/pthread/pthread_mutexattr_setprotocol.c index e2a8a45ac501f0cc7f00eadbba7be4d3a53db247..117c626248dae7885cf13d2f594e32978018f27c 100644 --- a/libc/pthread/pthread_mutexattr_setprotocol.c +++ b/libc/pthread/pthread_mutexattr_setprotocol.c @@ -58,7 +58,7 @@ * attr - A pointer to the mutex attributes to be modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * ****************************************************************************/ diff --git a/libc/pthread/pthread_mutexattr_setpshared.c b/libc/pthread/pthread_mutexattr_setpshared.c index 054c4db07e4531aafe6d4354bb43b1df48de9484..575e38036e0780085f3297e122b0c02f8bbbf0a5 100644 --- a/libc/pthread/pthread_mutexattr_setpshared.c +++ b/libc/pthread/pthread_mutexattr_setpshared.c @@ -57,7 +57,7 @@ * attr * pshared * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/libc/pthread/pthread_mutexattr_setrobust.c b/libc/pthread/pthread_mutexattr_setrobust.c index aeb2714e93d45db3cb0ec678985e8c52ae33bfd1..6a231bd2edfadb60ae388b88d31a046b91e06c4e 100644 --- a/libc/pthread/pthread_mutexattr_setrobust.c +++ b/libc/pthread/pthread_mutexattr_setrobust.c @@ -55,7 +55,7 @@ * attr - The mutex attributes in which to set the mutex type. * robust - The mutex type value to set. * - * Return Value: + * Returned Value: * 0, if the mutex robustness was successfully set in 'attr', or * EINVAL, if 'attr' is NULL or 'robust' unrecognized. * diff --git a/libc/pthread/pthread_mutexattr_settype.c b/libc/pthread/pthread_mutexattr_settype.c index 02e1832cd6c8762e36fa2eec8f04af4e9720f893..7c501b62217eb2f4320ab059002775694bce4ec8 100644 --- a/libc/pthread/pthread_mutexattr_settype.c +++ b/libc/pthread/pthread_mutexattr_settype.c @@ -55,7 +55,7 @@ * attr - The mutex attributes in which to set the mutex type. * type - The mutex type value to set. * - * Return Value: + * Returned Value: * 0, if the mutex type was successfully set in 'attr', or * EINVAL, if 'attr' is NULL or 'type' unrecognized. * diff --git a/libc/pthread/pthread_once.c b/libc/pthread/pthread_once.c index d73dde966fc1d9da17149a5f2c2f54cc98c76e5d..2f067decbb909dcbb1d32c735b190463a72538b0 100644 --- a/libc/pthread/pthread_once.c +++ b/libc/pthread/pthread_once.c @@ -67,7 +67,7 @@ * PTHREAD_ONCE_INIT is defined in pthread.h * init_routine - The initialization routine that will be called once. * - * Return Value: + * Returned Value: * 0 (OK) on success or EINVAL if either once_control or init_routine are * invalid * diff --git a/libc/pthread/pthread_rwlock_rdlock.c b/libc/pthread/pthread_rwlock_rdlock.c index 4eadfedccb5d4530b4d0f36d98f70375bf12833e..1b23abcc92557b0ad92902d88595a062855f9706 100644 --- a/libc/pthread/pthread_rwlock_rdlock.c +++ b/libc/pthread/pthread_rwlock_rdlock.c @@ -93,7 +93,7 @@ static int tryrdlock(FAR pthread_rwlock_t *rw_lock) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_rwlock_wrlock.c b/libc/pthread/pthread_rwlock_wrlock.c index c9f4f3a7c56ad1b2f28aab579b46a587a40df1a1..73b1ce276204f499c6fce051435c94019b35fda3 100644 --- a/libc/pthread/pthread_rwlock_wrlock.c +++ b/libc/pthread/pthread_rwlock_wrlock.c @@ -73,7 +73,7 @@ static void wrlock_cleanup(FAR void *arg) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/pthread/pthread_startup.c b/libc/pthread/pthread_startup.c index 3d2b76ce8f95318d8070cc390c1112226bec5a5f..a1f8e64f5ebfd25aaf5a279ce192eb36d3e82985 100644 --- a/libc/pthread/pthread_startup.c +++ b/libc/pthread/pthread_startup.c @@ -82,11 +82,11 @@ * This function is the user-space, pthread startup function. It is called * from up_pthread_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the pthread entry point * arg - Standard argument for the pthread entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ diff --git a/libc/pthread/pthread_yield.c b/libc/pthread/pthread_yield.c index 2af7ea2b9334904206042724cb9f82d4dd49837f..78ee5a7bb7a8e5b76ebd9567f7cbf6bc306b1be4 100644 --- a/libc/pthread/pthread_yield.c +++ b/libc/pthread/pthread_yield.c @@ -54,7 +54,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/libc/sched/sched_cpucount.c b/libc/sched/sched_cpucount.c index 6bdac1111763ac7fb1bcd12b6cb1d151ddd1c85f..5f7f151ec035f75c812384a3ae2364df8df757e6 100644 --- a/libc/sched/sched_cpucount.c +++ b/libc/sched/sched_cpucount.c @@ -54,10 +54,10 @@ * Return the number of bits set in the 'set'. This could be improved by * using CPU-specific bit counting instructions. * - * Inputs: + * Input Parameters: * set - The set of CPUs to be counted. * - * Return Value: + * Returned Value: * The number of CPUs in 'set' * ****************************************************************************/ diff --git a/libc/sched/sched_getprioritymax.c b/libc/sched/sched_getprioritymax.c index 03660cbb8d49dde907fa34b17de444922dd672f6..4ca6bf6119451e7c8e351c676caf84c9f6b6dead 100644 --- a/libc/sched/sched_getprioritymax.c +++ b/libc/sched/sched_getprioritymax.c @@ -54,10 +54,10 @@ * This function returns the value of the highest possible * task priority for a specified scheduling policy. * - * Inputs: + * Input Parameters: * policy - Scheduling policy requested. * - * Return Value: + * Returned Value: * The maximum priority value or -1 (ERROR) * (errno is not set) * diff --git a/libc/sched/sched_getprioritymin.c b/libc/sched/sched_getprioritymin.c index 660677f8ca458dd29cc536dcde1d8e8703d7c42a..4a39350107065a3e01d3e53511c192069a692949 100644 --- a/libc/sched/sched_getprioritymin.c +++ b/libc/sched/sched_getprioritymin.c @@ -54,10 +54,10 @@ * This function returns the value of the lowest possible * task priority for a specified scheduling policy. * - * Inputs: + * Input Parameters: * policy - Scheduling policy requested. * - * Return Value: + * Returned Value: * The minimum priority value or -1 (ERROR) * (errno is not set) * diff --git a/libc/sched/task_startup.c b/libc/sched/task_startup.c index c0895a16b81d49fca62089c7cfd33d30b498139d..2d14b47fa1f8c961476effadf5631f2403ead20c 100644 --- a/libc/sched/task_startup.c +++ b/libc/sched/task_startup.c @@ -57,11 +57,11 @@ * This function is the user-space, task startup function. It is called * from up_task_start() in user-mode. * - * Inputs: + * Input Parameters: * entrypt - The user-space address of the task entry point * argc and argv - Standard arguments for the task entry point * - * Return: + * Returned Value: * None. This function does not return. * ****************************************************************************/ diff --git a/libc/semaphore/sem_getprotocol.c b/libc/semaphore/sem_getprotocol.c index 308f1ea5208ef60d171e28dc6fbecd769e79030d..436113b015d1ad400a0354610d2734ff7c9749e1 100644 --- a/libc/semaphore/sem_getprotocol.c +++ b/libc/semaphore/sem_getprotocol.c @@ -59,7 +59,7 @@ * protocol - The user provided location in which to store the protocol * value. * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/libc/semaphore/sem_getvalue.c b/libc/semaphore/sem_getvalue.c index 120dae1372b21e59fa892ab4b72df2e72d9fc8f8..d6da1ba4bf464a7cfe84288f8ea81cef46e3b47c 100644 --- a/libc/semaphore/sem_getvalue.c +++ b/libc/semaphore/sem_getvalue.c @@ -68,7 +68,7 @@ * sem - Semaphore descriptor * sval - Buffer by which the value is returned * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/libc/semaphore/sem_init.c b/libc/semaphore/sem_init.c index 99b77317f6aaca663c4446d14206a501ba4aa965..b26b0b5937076e42cafaa2e57086feb4ef6a806f 100644 --- a/libc/semaphore/sem_init.c +++ b/libc/semaphore/sem_init.c @@ -68,7 +68,7 @@ * pshared - Process sharing (not used) * value - Semaphore initialization value * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -124,7 +124,7 @@ int nxsem_init(FAR sem_t *sem, int pshared, unsigned int value) * pshared - Process sharing (not used) * value - Semaphore initialization value * - * Return Value: + * Returned Value: * This returns zero (OK) if successful. Otherwise, -1 (ERROR) is * returned and the errno value is set appropriately. * diff --git a/libc/semaphore/sem_setprotocol.c b/libc/semaphore/sem_setprotocol.c index ac82cf719a7db399fc317f15bed6480a387ead5e..b64f4665462aa88dd1220a81e6334f5922ddf79e 100644 --- a/libc/semaphore/sem_setprotocol.c +++ b/libc/semaphore/sem_setprotocol.c @@ -80,7 +80,7 @@ * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. @@ -138,7 +138,7 @@ int nxsem_setprotocol(FAR sem_t *sem, int protocol) * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/libc/signal/sig_addset.c b/libc/signal/sig_addset.c index 392be1ca691d681f97bf436ce2d2a987945f63d9..6205ef98c66d98d7fe203b706567e13d13d6b91a 100644 --- a/libc/signal/sig_addset.c +++ b/libc/signal/sig_addset.c @@ -55,7 +55,7 @@ * set - Signal set to add signal to * signo - Signal to add * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal number is invalid. * * Assumptions: diff --git a/libc/signal/sig_delset.c b/libc/signal/sig_delset.c index 9c6c608a2d16f2025cdaad5804e4e0822fcc3369..c38685fd723524087ed2f7ba9d4c8919134de263 100644 --- a/libc/signal/sig_delset.c +++ b/libc/signal/sig_delset.c @@ -55,7 +55,7 @@ * set - Signal set to delete the signal from * signo - Signal to delete * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal number is invalid. * * Assumptions: diff --git a/libc/signal/sig_emptyset.c b/libc/signal/sig_emptyset.c index 01b398ad08832d71f8c5526ee73fe167da5ec8ee..7614e6ec6e54059d6b18853c31e59ca6bebfca80 100644 --- a/libc/signal/sig_emptyset.c +++ b/libc/signal/sig_emptyset.c @@ -53,7 +53,7 @@ * Parameters: * set - Signal set to initialize * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal set cannot be initialized. * * Assumptions: diff --git a/libc/signal/sig_fillset.c b/libc/signal/sig_fillset.c index 2586646e37e849cad3c9a781b6b8bf2deda6fe5f..a9344abb1041bbe15cdba830b9d3c0daaf41cd5a 100644 --- a/libc/signal/sig_fillset.c +++ b/libc/signal/sig_fillset.c @@ -53,7 +53,7 @@ * Parameters: * set - Signal set to initalize * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal set cannot be initialized. * * Assumptions: diff --git a/libc/signal/sig_ismember.c b/libc/signal/sig_ismember.c index 2fbac5f6c856c5e91bd337ccdceebf7bcb329b50..5624174e0e7c4b9ffaf8f88f2dad7c229da4741f 100644 --- a/libc/signal/sig_ismember.c +++ b/libc/signal/sig_ismember.c @@ -54,7 +54,7 @@ * set - Signal set to test * signo - Signal to test for * - * Return Value: + * Returned Value: * 1 (true), if the specified signal is a member of the set, * 0 (OK or FALSE), if it is not, or * -1 (ERROR) if the signal number is invalid. diff --git a/libc/stdio/lib_ferror.c b/libc/stdio/lib_ferror.c index 4d324c8081106a21ca2d937528668e02452ca8ba..3bec087b6d4115aa5e1b802ba035ebbca1f229f7 100644 --- a/libc/stdio/lib_ferror.c +++ b/libc/stdio/lib_ferror.c @@ -57,7 +57,7 @@ * This function will test if the last operation resulted in an eror. This * is used to disambiguate EOF and error conditions. * - * Return Value: + * Returned Value: * A non-zero value is returned to indicate the error condition. * ****************************************************************************/ diff --git a/libc/stdio/lib_fflush.c b/libc/stdio/lib_fflush.c index dd3e17831691f39195e0a0367910f2ba641c13aa..032ee023f4983ff77e300f844cb9637e8e4c3f30 100644 --- a/libc/stdio/lib_fflush.c +++ b/libc/stdio/lib_fflush.c @@ -62,7 +62,7 @@ * * If the stream argument is NULL, fflush() flushes all open output streams. * - * Return: + * Returned Value: * OK on success EOF on failure (with errno set appropriately) * ****************************************************************************/ diff --git a/libc/stdio/lib_freopen.c b/libc/stdio/lib_freopen.c index 0fffc1bd9618d4d7e53703ea285d12e782f4ff13..950be9ce059162738493dc1543a41debcf6316d1 100644 --- a/libc/stdio/lib_freopen.c +++ b/libc/stdio/lib_freopen.c @@ -70,7 +70,7 @@ * The error indicator and eof indicator are automatically cleared (as if * clearerr was called). * - * Input Paramters: + * Input Parameters: * path - If non-NULL, refers to the name of the file to be opened. * mode - String describing the new file access mode * stream - Pointer to the type FILE to be reopened. diff --git a/libc/stdio/lib_libfflush.c b/libc/stdio/lib_libfflush.c index 29a44cfe22e5089f16705b0628eb0228bf88c274..22482eb879005eebecb99854c93bacd8ca188d4d 100644 --- a/libc/stdio/lib_libfflush.c +++ b/libc/stdio/lib_libfflush.c @@ -65,7 +65,7 @@ * stream - the stream to flush * bforce - flush must be complete. * - * Return: + * Returned Value: * A negated errno value on failure, otherwise the number of bytes remaining * in the buffer. * diff --git a/libc/stdio/lib_libnoflush.c b/libc/stdio/lib_libnoflush.c index f862cd68748c99532d9cf35b07b69cf73caeb55c..b7daabb2d7c4bfbd30fbeee2bbef50d2709a3dd6 100644 --- a/libc/stdio/lib_libnoflush.c +++ b/libc/stdio/lib_libnoflush.c @@ -60,7 +60,7 @@ * lib_noflush() provides a common, dummy flush method for output streams * that are not flushable. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/libc/stdio/lib_libsnoflush.c b/libc/stdio/lib_libsnoflush.c index 652b977cf69a0ab5a4a8e5ce9ee5e3c2dc86f210..8d95fad48cc7277e93c752729bf53a7681d81aec 100644 --- a/libc/stdio/lib_libsnoflush.c +++ b/libc/stdio/lib_libsnoflush.c @@ -59,7 +59,7 @@ * lib_snoflush() provides a common, dummy flush method for seekable output * streams that are not flushable. * - * Return: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/libc/stdio/lib_lowoutstream.c b/libc/stdio/lib_lowoutstream.c index 8447051d39da32f6d7245ec9e9c01ac50b7a71e2..1896660d358b507be497f6c4388945804516b794 100644 --- a/libc/stdio/lib_lowoutstream.c +++ b/libc/stdio/lib_lowoutstream.c @@ -76,7 +76,7 @@ static void lowoutstream_putc(FAR struct lib_outstream_s *this, int ch) * Description: * Initializes a stream for use with low-level, architecture-specific I/O. * - * Input parameters: + * Input Parameters: * stream - User allocated, uninitialized instance of struct * lib_lowoutstream_s to be initialized. * diff --git a/libc/stdio/lib_meminstream.c b/libc/stdio/lib_meminstream.c index 0fdcd8f92f1438425967f6146e1d68302bfdebd3..ef888d9e7dda8941a59c9174c90449d51044eeca 100644 --- a/libc/stdio/lib_meminstream.c +++ b/libc/stdio/lib_meminstream.c @@ -81,7 +81,7 @@ static int meminstream_getc(FAR struct lib_instream_s *this) * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_meminstream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_memoutstream.c b/libc/stdio/lib_memoutstream.c index 28137d07ed72ce7965f5005273a7c4221648c170..80b8a36609ff83cbb11e5adb4f43b4577f84d885 100644 --- a/libc/stdio/lib_memoutstream.c +++ b/libc/stdio/lib_memoutstream.c @@ -78,7 +78,7 @@ static void memoutstream_putc(FAR struct lib_outstream_s *this, int ch) * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_memoutstream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_memsistream.c b/libc/stdio/lib_memsistream.c index af241b4c2ed8f23a5fce6811d2e54fd907055754..1bfda9ea2fa533665637b2f8badafe4b2169f7bf 100644 --- a/libc/stdio/lib_memsistream.c +++ b/libc/stdio/lib_memsistream.c @@ -125,7 +125,7 @@ static off_t memsistream_seek(FAR struct lib_sistream_s *this, off_t offset, * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_memsistream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_memsostream.c b/libc/stdio/lib_memsostream.c index 93c19facad180ace15a98e7ba2add4527952da0f..93536a34069f2a1d40cca386ad3a0beba0a5595b 100644 --- a/libc/stdio/lib_memsostream.c +++ b/libc/stdio/lib_memsostream.c @@ -122,7 +122,7 @@ static off_t memsostream_seek(FAR struct lib_sostream_s *this, off_t offset, * Description: * Initializes a stream for use with a fixed-size memory buffer. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_memsostream_s to be initialized. * bufstart - Address of the beginning of the fixed-size memory buffer diff --git a/libc/stdio/lib_nullinstream.c b/libc/stdio/lib_nullinstream.c index 9ca50d6379b4174e9550516113c80cf454dbbf24..67d930b8d86caab5259f9452dde25d699ba7cc35 100644 --- a/libc/stdio/lib_nullinstream.c +++ b/libc/stdio/lib_nullinstream.c @@ -62,7 +62,7 @@ static int nullinstream_getc(FAR struct lib_instream_s *this) * Initializes a NULL stream. The initialized stream will will return only * EOF. * - * Input parameters: + * Input Parameters: * nullinstream - User allocated, uninitialized instance of struct * lib_instream_s to be initialized. * diff --git a/libc/stdio/lib_nulloutstream.c b/libc/stdio/lib_nulloutstream.c index 47f2acd58a401c3b1826835c7afd4e197ad05745..1f92028e3c9fa0400d099bcb817ecc581b2e4d9d 100644 --- a/libc/stdio/lib_nulloutstream.c +++ b/libc/stdio/lib_nulloutstream.c @@ -64,7 +64,7 @@ static void nulloutstream_putc(FAR struct lib_outstream_s *this, int ch) * Initializes a NULL streams. The initialized stream will write all data * to the bit-bucket. * - * Input parameters: + * Input Parameters: * nulloutstream - User allocated, uninitialized instance of struct * lib_outstream_s to be initialized. * diff --git a/libc/stdio/lib_rawinstream.c b/libc/stdio/lib_rawinstream.c index e37f3630fd5c6a1af0d0b0522100add2b58d5ca6..a0e4919c27c2cf24297ac220e9894a0de63df813 100644 --- a/libc/stdio/lib_rawinstream.c +++ b/libc/stdio/lib_rawinstream.c @@ -104,7 +104,7 @@ static off_t rawsistream_seek(FAR struct lib_sistream_s *this, off_t offset, * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_rawsistream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_rawoutstream.c b/libc/stdio/lib_rawoutstream.c index 69155fc15c6d0e055b685baac46d9d0d0431636d..20e19e44a5a11b766cf90a97b855cc58f05e7325 100644 --- a/libc/stdio/lib_rawoutstream.c +++ b/libc/stdio/lib_rawoutstream.c @@ -111,7 +111,7 @@ static off_t rawsostream_seek(FAR struct lib_sostream_s *this, off_t offset, * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_rawsostream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_rawsistream.c b/libc/stdio/lib_rawsistream.c index d332728c07f0f45849fc53065ee07ad39357380f..3d8d4fd1fe2529510c397483f62bb2bdaf16d50b 100644 --- a/libc/stdio/lib_rawsistream.c +++ b/libc/stdio/lib_rawsistream.c @@ -91,7 +91,7 @@ static int rawinstream_getc(FAR struct lib_instream_s *this) * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_rawinstream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_rawsostream.c b/libc/stdio/lib_rawsostream.c index 1579e1db6de25b7e36156e51c699413f5495950c..4f05a0bf742efbd39d3ec342d6fbe26968afd5a1 100644 --- a/libc/stdio/lib_rawsostream.c +++ b/libc/stdio/lib_rawsostream.c @@ -98,7 +98,7 @@ static void rawoutstream_putc(FAR struct lib_outstream_s *this, int ch) * Description: * Initializes a stream for use with a file descriptor. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_rawoutstream_s to be initialized. * fd - User provided file/socket descriptor (must have been opened diff --git a/libc/stdio/lib_remove.c b/libc/stdio/lib_remove.c index 3c2c8e6d3f0b34703145590a4055c3a9975dbe51..4e3e4765d5a1e7fb6e8a7971ed97ed317c6e884f 100644 --- a/libc/stdio/lib_remove.c +++ b/libc/stdio/lib_remove.c @@ -53,7 +53,7 @@ * The remove() function causes the object denoted by path to be removed. * The function is equivalent to unlink() or rmdir(). * - * Input Parmeters: + * Input Parameters: * path - A pointer to a file or directory to be removed. * * Returned Value: diff --git a/libc/stdio/lib_stdinstream.c b/libc/stdio/lib_stdinstream.c index f1b5f3da998e76502c8b5c8dfa9c8b12f3522f2b..da577595300829d9672bd978494fb7de8708f408 100644 --- a/libc/stdio/lib_stdinstream.c +++ b/libc/stdio/lib_stdinstream.c @@ -77,7 +77,7 @@ static int stdinstream_getc(FAR struct lib_instream_s *this) * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_stdinstream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_stdoutstream.c b/libc/stdio/lib_stdoutstream.c index 4c77c745fcc81883e7ef47b585818436604f558e..10fd58b4fbefd0068084ab1a9a29234f7569ab1a 100644 --- a/libc/stdio/lib_stdoutstream.c +++ b/libc/stdio/lib_stdoutstream.c @@ -102,7 +102,7 @@ static int stdoutstream_flush(FAR struct lib_outstream_s *this) * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_stdoutstream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_stdsistream.c b/libc/stdio/lib_stdsistream.c index b569bb412222b8772ff827a5cce8990a23929e41..5fd2544729d701ca4bae921b91b6707b0e33fae1 100644 --- a/libc/stdio/lib_stdsistream.c +++ b/libc/stdio/lib_stdsistream.c @@ -90,7 +90,7 @@ static off_t stdsistream_seek(FAR struct lib_sistream_s *this, off_t offset, * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * instream - User allocated, uninitialized instance of struct * lib_stdsistream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_stdsostream.c b/libc/stdio/lib_stdsostream.c index 8654b635620b7d133ac58b33b5bb48621d3a8e50..c7891f0e8c280956ee89cc52b1091e5968da40e2 100644 --- a/libc/stdio/lib_stdsostream.c +++ b/libc/stdio/lib_stdsostream.c @@ -115,7 +115,7 @@ static off_t stdsostream_seek(FAR struct lib_sostream_s *this, off_t offset, * Description: * Initializes a stream for use with a FILE instance. * - * Input parameters: + * Input Parameters: * outstream - User allocated, uninitialized instance of struct * lib_stdsostream_s to be initialized. * stream - User provided stream instance (must have been opened for diff --git a/libc/stdio/lib_zeroinstream.c b/libc/stdio/lib_zeroinstream.c index 506d00587173ee2cc2f670442747ddaf2f530df4..a9d543f4df4301b9adfc6abfb449a2a66aafb3e9 100644 --- a/libc/stdio/lib_zeroinstream.c +++ b/libc/stdio/lib_zeroinstream.c @@ -62,7 +62,7 @@ static int zeroinstream_getc(FAR struct lib_instream_s *this) * Initializes a NULL stream. The initialized stream will return an * infinitely long stream of zeroes. * - * Input parameters: + * Input Parameters: * zeroinstream - User allocated, uninitialized instance of struct * lib_instream_s to be initialized. * diff --git a/libc/stdlib/lib_abort.c b/libc/stdlib/lib_abort.c index f037e8d8cc48068da2dd21bc9ccdd243eb5eab01..87751c5a45e5ea59f25f5d68f448d1953562c97d 100644 --- a/libc/stdlib/lib_abort.c +++ b/libc/stdlib/lib_abort.c @@ -87,7 +87,7 @@ * It does this by restoring the default disposition for SIGABRT and * then raising the signal for a second time. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libc/stdlib/lib_checkbase.c b/libc/stdlib/lib_checkbase.c index a94140e81ec02dbc762694f63eae9dd94e6abb7a..9d11a1d5364edffe108fc6e0674658d10f97ca41 100644 --- a/libc/stdlib/lib_checkbase.c +++ b/libc/stdlib/lib_checkbase.c @@ -59,7 +59,7 @@ * Assumptions: * *ptr points to the first, non-whitespace character in the string. * - * Returns: + * Returned Value: * - if base is valid, the actual base to use, and pptr is updated to point * at the first digit. * - if base is invalid (<2 or >36), return -1. diff --git a/libc/stdlib/lib_ptsname.c b/libc/stdlib/lib_ptsname.c index 54cdabd69ef7313a9d6aed949f0fbe6b01784dd7..af08e494de8e121170987b2ad8285e9eca69b8e1 100644 --- a/libc/stdlib/lib_ptsname.c +++ b/libc/stdlib/lib_ptsname.c @@ -54,7 +54,7 @@ * The ptsname() function returns the name of the slave pseudoterminal * device corresponding to the master referred to by fd. * - * Returned Values: + * Returned Value: * On success, ptsname() returns a pointer to a string in static storage * which will be overwritten by subsequent calls. This pointer must not * be freed. On failure, NULL is returned. diff --git a/libc/stdlib/lib_ptsnamer.c b/libc/stdlib/lib_ptsnamer.c index e5df9c0ec7eb1b35808de0f5273107529d4914da..17a1ad4b3c108bb1f63bdae475423c939a0bc14e 100644 --- a/libc/stdlib/lib_ptsnamer.c +++ b/libc/stdlib/lib_ptsnamer.c @@ -59,7 +59,7 @@ * terminated string in the buffer pointed to by buf. The buflen * argument specifies the number of bytes available in buf. * - * Returned Values: + * Returned Value: * On success, ptsname_r() returns 0. On failure, a nonzero value is * returned and errno is set to indicate the error. * diff --git a/libc/stdlib/lib_strtol.c b/libc/stdlib/lib_strtol.c index 2c6c6a24dec02c1a46ce3aadbccf2960efffd86a..411f7d6d416609b4ce75bbc00c94d1136ed91089 100644 --- a/libc/stdlib/lib_strtol.c +++ b/libc/stdlib/lib_strtol.c @@ -61,7 +61,7 @@ * nptr to a long integer value according to the given base, which must be * between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_strtoll.c b/libc/stdlib/lib_strtoll.c index a5f8b2cdc3bee01b1182bb711b70a55c20ea42d5..865af86a21f6020c677101bd895341264050b6e1 100644 --- a/libc/stdlib/lib_strtoll.c +++ b/libc/stdlib/lib_strtoll.c @@ -63,7 +63,7 @@ * nptr to a long long integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_strtoul.c b/libc/stdlib/lib_strtoul.c index 8828aa830c7aef33f91b77397fd87b4886635b00..82ea183d73e8e89bc226364da765e25017c509f8 100644 --- a/libc/stdlib/lib_strtoul.c +++ b/libc/stdlib/lib_strtoul.c @@ -56,7 +56,7 @@ * nptr to a long unsigned integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_strtoull.c b/libc/stdlib/lib_strtoull.c index fe13b63249b84d340393d833e6114e55ba4817a2..1896aec570cb05e5a227184fdf4872ab653f831d 100644 --- a/libc/stdlib/lib_strtoull.c +++ b/libc/stdlib/lib_strtoull.c @@ -59,7 +59,7 @@ * nptr to a long unsigned integer value according to the given base, which * must be between 2 and 36 inclusive, or be the special value 0. * - * Returns: + * Returned Value: * - The converted value, if the base and number are valid * - 0 if an error occurs, and set errno to: * * EINVAL if base < 2 or base > 36 diff --git a/libc/stdlib/lib_unlockpt.c b/libc/stdlib/lib_unlockpt.c index 8ea6e4c7ef52832805858a63659805aee408744c..0626d8657161671e6c6cd0c85ad5b764f2214f03 100644 --- a/libc/stdlib/lib_unlockpt.c +++ b/libc/stdlib/lib_unlockpt.c @@ -57,7 +57,7 @@ * unlockpt() must be called before opening the slave side of a * pseudoterminal. * - * Returned Values: + * Returned Value: * When successful, unlockpt() returns 0. Otherwise, it returns -1 and * sets errno appropriately. * diff --git a/libc/string/lib_stpcpy.c b/libc/string/lib_stpcpy.c index dd2917f7bc5f30d785b2a7b4154ddc2248060c55..edfdd4ca003d2a5b89b43a6e72c1a9f25a41adf0 100644 --- a/libc/string/lib_stpcpy.c +++ b/libc/string/lib_stpcpy.c @@ -52,7 +52,7 @@ * Copies the string pointed to by 'src' (including the terminating NUL * character) into the array pointed to by 'dest'. * - * Returned value: + * Returned Value: * The stpcpy() function returns a pointer to the terminating NUL * character copied into the 'dest' buffer * diff --git a/libc/string/lib_strcpy.c b/libc/string/lib_strcpy.c index a329dc2925f82a0fa985e30a603ede8001699486..9c1b197a616e724bab15f972c6cc4c71a925c278 100644 --- a/libc/string/lib_strcpy.c +++ b/libc/string/lib_strcpy.c @@ -52,7 +52,7 @@ * Copies the string pointed to by 'src' (including the terminating NUL * character) into the array pointed to by 'des'. * - * Returned value: + * Returned Value: * The strcpy() function returns the 'dest' pointer * ****************************************************************************/ diff --git a/libc/string/lib_strtok.c b/libc/string/lib_strtok.c index 937326555899719a41817a49a7c0a6bcd76a8b63..8821a7d7ea5ed4c7e460091b6f99cf9c002a39f5 100644 --- a/libc/string/lib_strtok.c +++ b/libc/string/lib_strtok.c @@ -75,7 +75,7 @@ static char *g_saveptr = NULL; * end of the string are ignored. The tokens returned by * strtok() are always non-empty strings. * - * Return + * Returned Value: * strtok() returns a pointer to the next token, or NULL * if there are no more tokens. * diff --git a/libc/string/lib_strtokr.c b/libc/string/lib_strtokr.c index 22579f91ee47b86d2e211c7aa1f510c042e6425d..c179521961563be862ec7b31f61cab160f4b32f4 100644 --- a/libc/string/lib_strtokr.c +++ b/libc/string/lib_strtokr.c @@ -84,7 +84,7 @@ * end of the string are ignored. The tokens returned by * strtok() are always non-empty strings. * - * Return + * Returned Value: * strtok_r() returns a pointer to the next token, or NULL * if there are no more tokens. * diff --git a/libc/time/lib_asctime.c b/libc/time/lib_asctime.c index af633ebd7371fe644873b76b00ec5e622fba6557..3ddf1074f8d811f48d7b76d2899668372be25cb6 100644 --- a/libc/time/lib_asctime.c +++ b/libc/time/lib_asctime.c @@ -58,7 +58,7 @@ * Parameters: * tp - Pointer to the time to be converted. * - * Return Value: + * Returned Value: * One success a pointer to the string is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_asctimer.c b/libc/time/lib_asctimer.c index 11b25974fa9641a667fb17f62b5b06417ed2dc36..bebbd21a1228288d13592033b4e0c10d1dc25d2f 100644 --- a/libc/time/lib_asctimer.c +++ b/libc/time/lib_asctimer.c @@ -78,7 +78,7 @@ static const char * const g_mon_name[12] = * tp - Pointer to the time to be converted. * buf - A user provided buffer to receive the 26 character time string. * - * Return Value: + * Returned Value: * One success, the pointer to the 'buf' is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_ctime.c b/libc/time/lib_ctime.c index 4072663fb8c0f6270a7a49b5dbfde63458730a39..1151382816abe160b35487db94b3c6355ddd84ac 100644 --- a/libc/time/lib_ctime.c +++ b/libc/time/lib_ctime.c @@ -58,7 +58,7 @@ * Parameters: * timep - The current time represented as seconds since the epoch. * - * Return Value: + * Returned Value: * One success a pointer to the string is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_ctimer.c b/libc/time/lib_ctimer.c index ccc9c8f9284757877ad826557d02b2ff0e745e89..1286976c6d923e16db8cc52a60e17eed0f89d11f 100644 --- a/libc/time/lib_ctimer.c +++ b/libc/time/lib_ctimer.c @@ -63,7 +63,7 @@ * timep - The current time represented as seconds since the epoch. * buf - A user provided buffer to receive the 26 character time string. * - * Return Value: + * Returned Value: * One success, the pointer to the 'buf' is returned; on failure, NULL is * returned. * diff --git a/libc/time/lib_dayofweek.c b/libc/time/lib_dayofweek.c index 981e027025d960b257a25a977a1787d463aa8f25..9549dc3e4424890cbd65063d04e04d6eb4905a6f 100644 --- a/libc/time/lib_dayofweek.c +++ b/libc/time/lib_dayofweek.c @@ -90,7 +90,7 @@ * month - The month of the year 1 - 12 * year - the year including the 1900 * - * Returned value: + * Returned Value: * Zero based day of the week 0-6, 0 = Sunday, 1 = Monday... 6 = Saturday * ****************************************************************************/ diff --git a/libc/time/lib_gettimeofday.c b/libc/time/lib_gettimeofday.c index 6a1f01d16edcf0543e39492e79209012df11e9c7..89a8caefd8834a85808f1002b676669e75b1cf6d 100644 --- a/libc/time/lib_gettimeofday.c +++ b/libc/time/lib_gettimeofday.c @@ -64,7 +64,7 @@ * tv - The location to return the current time * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * diff --git a/libc/time/lib_settimeofday.c b/libc/time/lib_settimeofday.c index a36f32911bdf97266c4bafa699841556e58d79b5..1fc96d5ec756a5858cca5008f163a2d5c1ed0ee2 100644 --- a/libc/time/lib_settimeofday.c +++ b/libc/time/lib_settimeofday.c @@ -63,7 +63,7 @@ * tv - The net to time to be set * tz - Ignored * - * Returned value: + * Returned Value: * Zero (OK) on success; -1 is returned on failure with the errno variable * set appropriately. * diff --git a/libc/time/lib_time.c b/libc/time/lib_time.c index 504f7795f98d612cdcc0d77762b90c208c628ce5..683d8a71b9ba299dec19710835b1ce5c8a5dbc35 100644 --- a/libc/time/lib_time.c +++ b/libc/time/lib_time.c @@ -63,7 +63,7 @@ * parameter is not used, but a time_t object is still returned by the * function. * - * Return Value: + * Returned Value: * The current calendar time as a time_t object. If the argument is not * a null pointer, the return value is the same as the one stored in the * location pointed by the argument. diff --git a/libc/unistd/lib_chdir.c b/libc/unistd/lib_chdir.c index 16786a0f317817a74eb957ef89866a30fc7f0396..b87a3ebb82b96d03ecf0de1055d1999158dee69f 100644 --- a/libc/unistd/lib_chdir.c +++ b/libc/unistd/lib_chdir.c @@ -90,7 +90,7 @@ static inline void _trimdir(char *path) * is, the starting point for path searches for pathnames not beginning * with '/'. * - * Input Parmeters: + * Input Parameters: * path - A pointer to a directory to use as the new current working * directory * diff --git a/libc/unistd/lib_getcwd.c b/libc/unistd/lib_getcwd.c index 55587a599e2356cadfdf7c1dac0799f76b422305..9a04de995c94287a3b0ec629d56683a34a3300aa 100644 --- a/libc/unistd/lib_getcwd.c +++ b/libc/unistd/lib_getcwd.c @@ -71,7 +71,7 @@ * symbolic links. The 'size' argument is the size in bytes of the * character array pointed to by the 'buf' argument. * - * Input Parmeters: + * Input Parameters: * buf - a pointer to the location in which the current working directory * pathaname is returned. * size - The size in bytes avaiable at 'buf' diff --git a/libc/unistd/lib_getopt.c b/libc/unistd/lib_getopt.c index 47ac0855095dbd4101c4beac802a29ab2c380f7a..8826588ecab6628181ab856585b48e1735d1bf82 100644 --- a/libc/unistd/lib_getopt.c +++ b/libc/unistd/lib_getopt.c @@ -101,13 +101,14 @@ static bool g_binitialized = false; * errors are returned ('?' or ':') until getopt() finally returns -1. * (You can also set optind to -1 to force a reset). * - * Return: If an option was successfully found, then getopt() returns the - * option character. If all command-line options have been parsed, then - * getopt() returns -1. If getopt() encounters an option character that - * was not in optstring, then '?' is returned. If getopt() encounters an - * option with a missing argument, then the return value depends on the - * first character in optstring: if it is ':', then ':' is returned; - * otherwise '?' is returned. + * Return Value: + * If an option was successfully found, then getopt() returns the option + * haracter. If all command-line options have been parsed, then getopt() + * returns -1. If getopt() encounters an option character that was not + * in optstring, then '?' is returned. If getopt() encounters an option + * with a missing argument, then the return value depends on the first + * character in optstring: if it is ':', then ':' is returned; otherwise + * '?' is returned. * ****************************************************************************/ diff --git a/libc/unistd/lib_pipe.c b/libc/unistd/lib_pipe.c index 469dd5a1d508a1ba4d74aa498913dd20ba1db150..dc251b33c834e492a2c371f81bcbef89871609a1 100644 --- a/libc/unistd/lib_pipe.c +++ b/libc/unistd/lib_pipe.c @@ -57,11 +57,11 @@ * and places them in the array pointed to by 'fd'. fd[0] is for reading, * fd[1] is for writing. * - * Inputs: + * Input Parameters: * fd[2] - The user provided array in which to catch the pipe file * descriptors * - * Return: + * Returned Value: * 0 is returned on success; otherwise, -1 is returned with errno set * appropriately. * diff --git a/libc/userfs/lib_userfs.c b/libc/userfs/lib_userfs.c index 8f04c21f1d914d41ecc42bc232152b83dc7fe024..f08b936375ad2460a3da9f2a0c33ec0ae6620f38 100644 --- a/libc/userfs/lib_userfs.c +++ b/libc/userfs/lib_userfs.c @@ -901,7 +901,7 @@ static inline int userfs_destroy_dispatch(FAR struct userfs_info_s *info, * NOTE: This is a user function that is implemented as part of the * NuttX C library and is intended to be called by appliation logic. * - * Input parameters: + * Input Parameters: * mountpt - Mountpoint path * userops - The caller operations that implement the file system * interface. diff --git a/libc/wqueue/work_cancel.c b/libc/wqueue/work_cancel.c index 31ccbf68d330fbd5f014224483a32d30dd053ba5..c03530705661a34eee9c10cb8fcc763075c11d1b 100644 --- a/libc/wqueue/work_cancel.c +++ b/libc/wqueue/work_cancel.c @@ -62,7 +62,7 @@ * After work has been cancelled, it may be re-queue by calling work_queue() * again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The previously queue work structure to cancel * @@ -124,7 +124,7 @@ static int work_qcancel(FAR struct usr_wqueue_s *wqueue, FAR struct work_s *work * user mode work queue. After work has been cancelled, it may be re-queue * by calling work_queue() again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (must be USRWORK) * work - The previously queue work structure to cancel * diff --git a/libc/wqueue/work_lock.c b/libc/wqueue/work_lock.c index eec61847ac7f40bcb50d6cf6faf0bbf4652e40d6..8b8a5682c0bcf9ccb787d022e006e357e180640c 100644 --- a/libc/wqueue/work_lock.c +++ b/libc/wqueue/work_lock.c @@ -58,7 +58,7 @@ * Description: * Lock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -98,7 +98,7 @@ int work_lock(void) * Description: * Unlock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libc/wqueue/work_queue.c b/libc/wqueue/work_queue.c index 5b9a0ac3e478372d69817a1fb41e6324486e2eb8..40cbdf5635a450c9f0550b1d29978022d9586bf1 100644 --- a/libc/wqueue/work_queue.c +++ b/libc/wqueue/work_queue.c @@ -70,7 +70,7 @@ * from the queue, or (2) work_cancel() has been called to cancel the work * and remove it from the work queue. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked @@ -141,7 +141,7 @@ static int work_qqueue(FAR struct usr_wqueue_s *wqueue, * previous work as been performed and removed from the queue, then any * pending work will be canceled and lost. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked diff --git a/libc/wqueue/work_signal.c b/libc/wqueue/work_signal.c index 53fc8f829d51e1fd746f31bf04977f819ff3a39f..1854210cc5f84dff616d6cbdbc3f18b088ff2ab7 100644 --- a/libc/wqueue/work_signal.c +++ b/libc/wqueue/work_signal.c @@ -79,7 +79,7 @@ * is used internally by the work logic but could also be used by the * user to force an immediate re-assessment of pending work. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * * Returned Value: diff --git a/libc/wqueue/work_usrthread.c b/libc/wqueue/work_usrthread.c index 5e919d8e0a58c390ebff12488e37bf7c1eb6882f..bb62a8d645f4cb4d8c11ca687af0c4dddf58e986 100644 --- a/libc/wqueue/work_usrthread.c +++ b/libc/wqueue/work_usrthread.c @@ -106,7 +106,7 @@ pthread_mutex_t g_usrmutex; * part of the internal implementation of each work queue; it should not * be called from application level logic. * - * Input parameters: + * Input Parameters: * wqueue - Describes the work queue to be processed * * Returned Value: @@ -285,7 +285,7 @@ void work_process(FAR struct usr_wqueue_s *wqueue) * miscellaneous operations. The user work thread must be started by * application start-up logic by calling work_usrstart(). * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: @@ -327,7 +327,7 @@ static pthread_addr_t work_usrthread(pthread_addr_t arg) * Description: * Start the user mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libc/wqueue/wqueue.h b/libc/wqueue/wqueue.h index 6075ea00e80479e7580d4845fb4bdb4b8191aad5..f16574e663a0256d522bc316b36f55c8e2944f3c 100644 --- a/libc/wqueue/wqueue.h +++ b/libc/wqueue/wqueue.h @@ -92,7 +92,7 @@ extern pthread_mutex_t g_usrmutex; * Description: * Lock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -111,7 +111,7 @@ int work_lock(void); * Description: * Unlock the user-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/libnx/nx/nx_drawcircle.c b/libnx/nx/nx_drawcircle.c index c06413b4586fdcd0ada920735c59bac055f661b9..05027479716b7e5245524f1f50ea27bc6b889fe5 100644 --- a/libnx/nx/nx_drawcircle.c +++ b/libnx/nx/nx_drawcircle.c @@ -102,7 +102,7 @@ * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nx/nx_drawline.c b/libnx/nx/nx_drawline.c index 6ca0ade436ee71ca49c1ebc6a1b0be2e28af1f4a..ecd0df074f75c1365be1248e4f201e349d083b14 100644 --- a/libnx/nx/nx_drawline.c +++ b/libnx/nx/nx_drawline.c @@ -86,7 +86,7 @@ * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nx/nx_fillcircle.c b/libnx/nx/nx_fillcircle.c index 7bfa1551f52391f4f951fa8d0d65e84dbfa41f32..adec60a4066cbc2443a935478640659b34964da7 100644 --- a/libnx/nx/nx_fillcircle.c +++ b/libnx/nx/nx_fillcircle.c @@ -84,7 +84,7 @@ * radius - The radius of the circle in pixels. * color - The color to use to fill the circle. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxfonts/nxfonts_cache.c b/libnx/nxfonts/nxfonts_cache.c index fbf99eca87c8695a0df82950ae5f6a6f46dcd627..6276b91dc755e01793324d78e063eed383824d59 100644 --- a/libnx/nxfonts/nxfonts_cache.c +++ b/libnx/nxfonts/nxfonts_cache.c @@ -639,7 +639,7 @@ nxf_findcache(enum nx_fontid_e fontid, nxgl_mxpixel_t fgcolor, * bpp - Bits per pixel * maxglyphs - Maximum number of glyphs permitted in the cache * - * Returned value: + * Returned Value: * On success a non-NULL handle is returned that then may sequently be * used with nxf_getglyph() to extract fonts from the font cache. NULL * returned on any failure with the errno value set to indicate the nature @@ -798,7 +798,7 @@ errout_with_lock: * Input Parameters: * fhandle - A font cache handle previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -876,7 +876,7 @@ void nxf_cache_disconnect(FCACHE fhandle) * Input Parameters: * fhandle - A font cache handle previously returned by nxf_cache_connect(); * - * Returned value: + * Returned Value: * Zero (OK) is returned if the metrics were * * Returned Value: diff --git a/libnx/nxglib/nxglib_circlepts.c b/libnx/nxglib/nxglib_circlepts.c index 21d2340a71a1751a036e8958b0452e375d9bc4ef..a7132ce5f50cb61402c3a19afb98e302613833a9 100644 --- a/libnx/nxglib/nxglib_circlepts.c +++ b/libnx/nxglib/nxglib_circlepts.c @@ -89,13 +89,13 @@ * circumference of the circle. These points may then be used by * nx_drawcircle() or related APIs to draw a circle outline. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 16 points where the * circle points will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxglib/nxglib_circletraps.c b/libnx/nxglib/nxglib_circletraps.c index f7038703ba61e360621bf453463ecd6b8202faba..158c044e4ea9b2c5785e9c6614f9f7640e66d8df 100644 --- a/libnx/nxglib/nxglib_circletraps.c +++ b/libnx/nxglib/nxglib_circletraps.c @@ -68,13 +68,13 @@ * Given a description of a a circle, return 8 trapezoids that can be * used to fill the circle by nx_fillcircle() and other interfaces. * - * Input parameters: + * Input Parameters: * center - A pointer to the point that is the center of the circle * radius - The radius of the circle in pixels. * circle - A pointer the first entry in an array of 8 trapezoids where * the circle description will be returned. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxglib/nxglib_splitline.c b/libnx/nxglib/nxglib_splitline.c index 31b5d914bdd38c9c00f73c635052735022ba591a..10bffa257b4ca191cfa490ab33db0c32c7cdfb55 100644 --- a/libnx/nxglib/nxglib_splitline.c +++ b/libnx/nxglib/nxglib_splitline.c @@ -104,12 +104,12 @@ static b16_t nxgl_interpolate(b16_t x, b16_t dy, b16_t dxdy) * this case, 3 trapezoids will be returned, but traps[1] will be * degenerate. * - * Input parameters: + * Input Parameters: * vector - A pointer to the vector described the line to be drawn. * traps - A pointer to a array of trapezoids (size 3). * rect - A pointer to a rectangle. * - * Returned value: + * Returned Value: * 0: Line successfully broken up into three trapezoids. Values in * traps[0], traps[1], and traps[2] are valid. * 1: Line successfully represented by one trapezoid. Value in traps[1] diff --git a/libnx/nxmu/nx_bitmap.c b/libnx/nxmu/nx_bitmap.c index 2c455d424be287eac0cbd129937f5dce39dd7c87..e1fcb8451b720a2998a400505c76b08df57407f7 100644 --- a/libnx/nxmu/nx_bitmap.c +++ b/libnx/nxmu/nx_bitmap.c @@ -69,7 +69,7 @@ * may lie outside of the display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_block.c b/libnx/nxmu/nx_block.c index 4569a195adc030c4a3698a27fd4af4292f2577cf..2bf8efa64ccac1ee26dbec370a3e5d8b9eb46033 100644 --- a/libnx/nxmu/nx_block.c +++ b/libnx/nxmu/nx_block.c @@ -74,7 +74,7 @@ * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_closewindow.c b/libnx/nxmu/nx_closewindow.c index 6e5661f6b449d2c6a59d9bad0c7c452b44dc35d3..b0aac838b79211d67b99f23d96ea68d6026e17ba 100644 --- a/libnx/nxmu/nx_closewindow.c +++ b/libnx/nxmu/nx_closewindow.c @@ -60,7 +60,7 @@ * Input Parameters: * wnd - The window to be destroyed * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_connect.c b/libnx/nxmu/nx_connect.c index e69580bce81374762c7e4faa67162e94b0b0e7fb..d600666e8a57eb61b3dd93a835622ccbbb20c33a 100644 --- a/libnx/nxmu/nx_connect.c +++ b/libnx/nxmu/nx_connect.c @@ -93,7 +93,7 @@ static uint32_t g_nxcid = 1; * Input Parameters: * svrmqname - The name for the server incoming message queue * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * diff --git a/libnx/nxmu/nx_constructwindow.c b/libnx/nxmu/nx_constructwindow.c index cc8b1656b147d1e95266c70dbab8288fca740091..3cfd88c12eba0b562a4ba6bc81d06416bd2020f8 100644 --- a/libnx/nxmu/nx_constructwindow.c +++ b/libnx/nxmu/nx_constructwindow.c @@ -75,7 +75,7 @@ * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. In the * case of ERROR, NX will have deallocated the pre-allocated window. * diff --git a/libnx/nxmu/nx_disconnect.c b/libnx/nxmu/nx_disconnect.c index 6b1877efc3f110bb83ee0bbed59b2560d2fff392..2b6a9638e9339b932ae47766af3863d792af43a5 100644 --- a/libnx/nxmu/nx_disconnect.c +++ b/libnx/nxmu/nx_disconnect.c @@ -61,7 +61,7 @@ * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK on success; ERROR on failure with the errno set appropriately. * NOTE that handle will no long be valid upon return. * diff --git a/libnx/nxmu/nx_eventhandler.c b/libnx/nxmu/nx_eventhandler.c index a82b10839a6361f4ced1d4c0b8d909b7a586e223..bc6a746850d98c03eaf2d1955eb7bbc28a34f66e 100644 --- a/libnx/nxmu/nx_eventhandler.c +++ b/libnx/nxmu/nx_eventhandler.c @@ -108,7 +108,7 @@ static inline void nx_disconnected(FAR struct nxfe_conn_s *conn) * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then * one or more server message was processed. * ERROR: An error occurred and errno has been set appropriately. Of diff --git a/libnx/nxmu/nx_eventnotify.c b/libnx/nxmu/nx_eventnotify.c index 70653f62e2e2d1d9c90067c6f1d2280c60d195ba..a136774349a1eb039413b1de10b31be9939170f4 100644 --- a/libnx/nxmu/nx_eventnotify.c +++ b/libnx/nxmu/nx_eventnotify.c @@ -69,7 +69,7 @@ * Input Parameters: * handle - the handle returned by nx_connect * - * Return: + * Returned Value: * OK: No errors occurred. If CONFIG_NX_BLOCKING is defined, then * one or more server message was processed. * ERROR: An error occurred and errno has been set appropriately diff --git a/libnx/nxmu/nx_fill.c b/libnx/nxmu/nx_fill.c index bb59f6b28119c73530b3935aebadefc20a657732..d8a6231caffaabc6524787b3facceee9ee43d262 100644 --- a/libnx/nxmu/nx_fill.c +++ b/libnx/nxmu/nx_fill.c @@ -63,7 +63,7 @@ * rect - The location to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_filltrapezoid.c b/libnx/nxmu/nx_filltrapezoid.c index 6dbdf27ab3b22c4d56d9f17bd771210ad8fd7a4b..a9c850842931a7cc8b5bcdd3f3462b0d9d1d2fc2 100644 --- a/libnx/nxmu/nx_filltrapezoid.c +++ b/libnx/nxmu/nx_filltrapezoid.c @@ -64,7 +64,7 @@ * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_getposition.c b/libnx/nxmu/nx_getposition.c index d18d1d3a593f8a4a0c3128b1071a6e2206f8534a..757c1621c53ca10a60fea8a1a9bfa0a58adf7f8a 100644 --- a/libnx/nxmu/nx_getposition.c +++ b/libnx/nxmu/nx_getposition.c @@ -61,7 +61,7 @@ * Input Parameters: * hwnd - The window handle * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_getrectangle.c b/libnx/nxmu/nx_getrectangle.c index 958a1e05e847530ecfab41f7c6044217a5e68a29..fb1843b52dda17ff2e48a81bf25086e36cd47501 100644 --- a/libnx/nxmu/nx_getrectangle.c +++ b/libnx/nxmu/nx_getrectangle.c @@ -68,7 +68,7 @@ * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_lower.c b/libnx/nxmu/nx_lower.c index 06952d17f7931212fac87936433d9ecf9348827f..8d0ceca40d46bdd0ed168550792740bf04aa6470 100644 --- a/libnx/nxmu/nx_lower.c +++ b/libnx/nxmu/nx_lower.c @@ -56,10 +56,10 @@ * Description: * Lower the specified window to the bottom of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be lowered * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_move.c b/libnx/nxmu/nx_move.c index 144e9e588b589bc07b0990ad19df330ed2526c7b..71a4ca7f44c062e85e7e4a1fcdab1be399907e8b 100644 --- a/libnx/nxmu/nx_move.c +++ b/libnx/nxmu/nx_move.c @@ -61,7 +61,7 @@ * rect - Describes the rectangular region to move * offset - The offset to move the region * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_openwindow.c b/libnx/nxmu/nx_openwindow.c index 3280ee4225d1ff04f2de5c47dbe3b1c9c17ddab7..d5152192b74541c0606f4295f0fff124bafd80d7 100644 --- a/libnx/nxmu/nx_openwindow.c +++ b/libnx/nxmu/nx_openwindow.c @@ -63,7 +63,7 @@ * cb - Callbacks used to process window events * arg - User provided value that will be returned with NX callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NX accesses * Failure: NULL is returned and errno is set appropriately * diff --git a/libnx/nxmu/nx_raise.c b/libnx/nxmu/nx_raise.c index a149acdb280f4738870590f521dc4ca104c9b0a5..92f82d456df1c41dfea9424d4fb5d24d121ed74f 100644 --- a/libnx/nxmu/nx_raise.c +++ b/libnx/nxmu/nx_raise.c @@ -56,10 +56,10 @@ * Description: * Bring the specified window to the top of the display. * - * Input parameters: + * Input Parameters: * hwnd - the window to be raised * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_releasebkgd.c b/libnx/nxmu/nx_releasebkgd.c index 9fe9a44c719591ce06e54198115795cd801ec28d..22620193cef895ef692cf97e4ec3e5d179e20c67 100644 --- a/libnx/nxmu/nx_releasebkgd.c +++ b/libnx/nxmu/nx_releasebkgd.c @@ -60,7 +60,7 @@ * Input Parameters: * hwnd - The handle returned (indirectly) by nx_requestbkgd * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_requestbkgd.c b/libnx/nxmu/nx_requestbkgd.c index 77a4ae8ed5445325401102fcfe87b4a4ec0e0bfa..d3eff5c55309bca6308705f38b62ae4e80cd1eaa 100644 --- a/libnx/nxmu/nx_requestbkgd.c +++ b/libnx/nxmu/nx_requestbkgd.c @@ -84,7 +84,7 @@ * cb - Callbacks to use for processing background window events * arg - User provided argument (see nx_openwindow, nx_constructwindow) * - * Return: + * Returned Value: * OK: Success; ERROR of failure with errno set appropriately. * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setbgcolor.c b/libnx/nxmu/nx_setbgcolor.c index 74c683acf34c0a9ab02c9b1a0280f8897438054d..43d74187a84b64562e28d083e02bf4ef9e5be6e5 100644 --- a/libnx/nxmu/nx_setbgcolor.c +++ b/libnx/nxmu/nx_setbgcolor.c @@ -59,7 +59,7 @@ * handle - The connection handle * color - The color to use in the background * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setpixel.c b/libnx/nxmu/nx_setpixel.c index 376f85b04c4bee6fef21770773c8765ccf665ce0..bef376807319fc244cb86c85339aa40762922869 100644 --- a/libnx/nxmu/nx_setpixel.c +++ b/libnx/nxmu/nx_setpixel.c @@ -64,7 +64,7 @@ * pos - The pixel location to be set * col - The color to use in the set * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setposition.c b/libnx/nxmu/nx_setposition.c index a537d1b79a706e09665a624a48b03cb7e81d335f..e8d6887271e3ba3b82ab9304739c182a00ab13bb 100644 --- a/libnx/nxmu/nx_setposition.c +++ b/libnx/nxmu/nx_setposition.c @@ -60,7 +60,7 @@ * hwnd - The window handle * pos - The new position of the window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nx_setsize.c b/libnx/nxmu/nx_setsize.c index dd2ee119ff1dd9dc4bc8009b6b78a0d8710c856a..7a73710d9e29e8ec3b308b115d4540bd3daedabe 100644 --- a/libnx/nxmu/nx_setsize.c +++ b/libnx/nxmu/nx_setsize.c @@ -60,7 +60,7 @@ * hwnd - The window handle * size - The new size of the window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nxmu_sendserver.c b/libnx/nxmu/nxmu_sendserver.c index 2072ad28942fe980338089b3d278d3d500885127..833d03f9d9f88a2f2530f9ce59ad4e77e4449daf 100644 --- a/libnx/nxmu/nxmu_sendserver.c +++ b/libnx/nxmu/nxmu_sendserver.c @@ -61,7 +61,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxmu/nxmu_sendwindow.c b/libnx/nxmu/nxmu_sendwindow.c index 350fecd41dcb74af3bbe6c06c8f36c58f3508aea..aa5920424929dd100a04d5cedacb37caeced4a10 100644 --- a/libnx/nxmu/nxmu_sendwindow.c +++ b/libnx/nxmu/nxmu_sendwindow.c @@ -62,7 +62,7 @@ * msg - A pointer to the message to send * msglen - The length of the message in bytes. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk.h b/libnx/nxtk/nxtk.h index 44d507ee015e2c6bcafb1db887f4971a7488035b..97f5b486ec4233d3d4aaaccfbb3f947dd22d89a1 100644 --- a/libnx/nxtk/nxtk.h +++ b/libnx/nxtk/nxtk.h @@ -125,13 +125,13 @@ void nxtk_setsubwindows(FAR struct nxtk_framedwindow_s *fwnd); * then move the rectangle to that it is relative to the containing * window. * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The locaton to put the result * src - The src rectangle in relative sub-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -152,13 +152,13 @@ void nxtk_subwindowclip(FAR struct nxtk_framedwindow_s *fwnd, * relative to the sub-window (i.e., (0,0) is the top left corner of the * sub-window). * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The location to put the result * src - The src rectangle in relative container-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -185,7 +185,7 @@ void nxtk_containerclip(FAR struct nxtk_framedwindow_s *fwnd, * srcoffset - The offset to move the region * bounds - The subwindow bounds in absolute screen coordinates. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ @@ -203,13 +203,13 @@ void nxtk_subwindowmove(FAR struct nxtk_framedwindow_s *fwnd, * Description: * Redraw the window frame. * - * Input parameters: + * Input Parameters: * fwnd - the framed window whose frame needs to be re-drawn. This must * have been previously created by nxtk_openwindow(). * bounds - Only draw the ports of the frame within this bounding box. * (window relative coordinates). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_bitmaptoolbar.c b/libnx/nxtk/nxtk_bitmaptoolbar.c index 6f31d9300992ae7366323a75a3074684448c5ace..6ba5d383c99ffc92f411f15605e02d648fdfdfea 100644 --- a/libnx/nxtk/nxtk_bitmaptoolbar.c +++ b/libnx/nxtk/nxtk_bitmaptoolbar.c @@ -89,7 +89,7 @@ * origin may lie outside of the sub-window display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_bitmapwindow.c b/libnx/nxtk/nxtk_bitmapwindow.c index 0371715ba7c400fdf6c2f9ab506559d1e9995b86..8ba53f948510b97e5e630a456ef3d737edac1f9b 100644 --- a/libnx/nxtk/nxtk_bitmapwindow.c +++ b/libnx/nxtk/nxtk_bitmapwindow.c @@ -89,7 +89,7 @@ * origin may lie outside of the sub-window display. * stride - The width of the full source image in pixels. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_block.c b/libnx/nxtk/nxtk_block.c index d68dbe8fc237cf49704d63e0210a50c5bf635085..625e862d179d463f56db6b8d790f5abd65185ac5 100644 --- a/libnx/nxtk/nxtk_block.c +++ b/libnx/nxtk/nxtk_block.c @@ -71,7 +71,7 @@ * arg - An argument that will accompany the block messages (This is arg2 * in the blocked callback). * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_closetoolbar.c b/libnx/nxtk/nxtk_closetoolbar.c index 7be217d18de8a2e192c46e253eb03226adab4f10..ed4cbb190a210864e8395fe1d7c066c2eb868e82 100644 --- a/libnx/nxtk/nxtk_closetoolbar.c +++ b/libnx/nxtk/nxtk_closetoolbar.c @@ -81,7 +81,7 @@ * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_closewindow.c b/libnx/nxtk/nxtk_closewindow.c index 54857521305de246af323063ee5aa35f2e43be9e..cf2e6ad90b7891f2d5f7d78bd94b7cde7f615863 100644 --- a/libnx/nxtk/nxtk_closewindow.c +++ b/libnx/nxtk/nxtk_closewindow.c @@ -82,7 +82,7 @@ * Input Parameters: * hfwnd - The handle returned by nxtk_openwindow * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_containerclip.c b/libnx/nxtk/nxtk_containerclip.c index 67ed6cb17b18ae198e6f1b2ab7d41a1e1ec0967c..42951f470ba2e2dfab9b41528e3d6643cc17a494 100644 --- a/libnx/nxtk/nxtk_containerclip.c +++ b/libnx/nxtk/nxtk_containerclip.c @@ -83,13 +83,13 @@ * relative to the sub-window (i.e., (0,0) is the top left corner of the * sub-window). * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The locaton to put the result * src - The src rectangle in relative container-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawcircletoolbar.c b/libnx/nxtk/nxtk_drawcircletoolbar.c index 37998b70f84e69ddd5bf4e68d12b0380ef103b2f..69ea9a67ca1335493f30080a779411b614fbde59 100644 --- a/libnx/nxtk/nxtk_drawcircletoolbar.c +++ b/libnx/nxtk/nxtk_drawcircletoolbar.c @@ -102,7 +102,7 @@ * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawcirclewindow.c b/libnx/nxtk/nxtk_drawcirclewindow.c index 3f6cdd28827112aea102564ba30e11e62c9fdde4..1ba7717085912cce6ee9c62aefb064359d33902e 100644 --- a/libnx/nxtk/nxtk_drawcirclewindow.c +++ b/libnx/nxtk/nxtk_drawcirclewindow.c @@ -102,7 +102,7 @@ * width - The width of the line * color - The color to use to fill the line * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawframe.c b/libnx/nxtk/nxtk_drawframe.c index adafccc574468d0282dd2d4a0ea7b7dfbc5a041b..2e1ea68b17f421438b6f6fc0607da410eb4cce22 100644 --- a/libnx/nxtk/nxtk_drawframe.c +++ b/libnx/nxtk/nxtk_drawframe.c @@ -98,13 +98,13 @@ static void nxtk_drawframeside(FAR struct nxtk_framedwindow_s *fwnd, * Description: * Redraw the window frame. * - * Input parameters: + * Input Parameters: * fwnd - the framed window whose frame needs to be re-drawn. This must * have been previously created by nxtk_openwindow(). * bounds - Only draw the ports of the frame within this bounding box. * (window relative coordinates). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawlinetoolbar.c b/libnx/nxtk/nxtk_drawlinetoolbar.c index 84d25ad83caf307c6b7049f9a40b0a973c393569..51820a47f8fdc844e92cf240b2ce05b31fcea2d6 100644 --- a/libnx/nxtk/nxtk_drawlinetoolbar.c +++ b/libnx/nxtk/nxtk_drawlinetoolbar.c @@ -88,7 +88,7 @@ * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_drawlinewindow.c b/libnx/nxtk/nxtk_drawlinewindow.c index 231842b8828a83cfe48ca8c457da0d4b4629ff60..970ce40e60f529aeec3cf12765af737b96042b3d 100644 --- a/libnx/nxtk/nxtk_drawlinewindow.c +++ b/libnx/nxtk/nxtk_drawlinewindow.c @@ -87,7 +87,7 @@ * caps - Draw a circular cap on the ends of the line to support better * line joins * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_fillcircletoolbar.c b/libnx/nxtk/nxtk_fillcircletoolbar.c index af502c766070404a9cb7bf1c42f7ce979c8ae856..0772d8c75e9e813389c20c742aaee82aa04d1fe1 100644 --- a/libnx/nxtk/nxtk_fillcircletoolbar.c +++ b/libnx/nxtk/nxtk_fillcircletoolbar.c @@ -84,7 +84,7 @@ * radius - The radius of the circle in pixels. * color - The color to use to fill the circle. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_fillcirclewindow.c b/libnx/nxtk/nxtk_fillcirclewindow.c index b155e85ff92b50235f93e7fd7b71b2905f652b6d..20273be3a55cc083554556e19c6ea90d50c61a21 100644 --- a/libnx/nxtk/nxtk_fillcirclewindow.c +++ b/libnx/nxtk/nxtk_fillcirclewindow.c @@ -84,7 +84,7 @@ * radius - The radius of the circle in pixels. * color - The color to use to fill the circle. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_filltoolbar.c b/libnx/nxtk/nxtk_filltoolbar.c index 25eb6a8e8e833a733ba7a10139db1034bb268de8..146fc59ad22ca64ce65cdea293c70ef242bd626a 100644 --- a/libnx/nxtk/nxtk_filltoolbar.c +++ b/libnx/nxtk/nxtk_filltoolbar.c @@ -83,7 +83,7 @@ * rect - The location within the toolbar window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_filltraptoolbar.c b/libnx/nxtk/nxtk_filltraptoolbar.c index 3ca0b38ad2361eb159c445f83d6079adeaa98530..afbc11be3e6abad497d2ab63a950e206cefafdb6 100644 --- a/libnx/nxtk/nxtk_filltraptoolbar.c +++ b/libnx/nxtk/nxtk_filltraptoolbar.c @@ -83,7 +83,7 @@ * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_filltrapwindow.c b/libnx/nxtk/nxtk_filltrapwindow.c index 88c3077223f2ea20ba85374f2c1c196e96e00b09..886ab81b8ba3bcbf1d0cbc4b5eee1c3c4e85a7d1 100644 --- a/libnx/nxtk/nxtk_filltrapwindow.c +++ b/libnx/nxtk/nxtk_filltrapwindow.c @@ -83,7 +83,7 @@ * trap - The trapezoidal region to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_fillwindow.c b/libnx/nxtk/nxtk_fillwindow.c index 9ff1caca57eb4bba494eccd8ae5ef22c606a1ed4..103fdc2795d94f5d0efbc8684e5f27060f8b22b8 100644 --- a/libnx/nxtk/nxtk_fillwindow.c +++ b/libnx/nxtk/nxtk_fillwindow.c @@ -83,7 +83,7 @@ * rect - The location within the client window to be filled * color - The color to use in the fill * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_getposition.c b/libnx/nxtk/nxtk_getposition.c index 1f0bdceeef7d08b3bb2fce23d19aa9e865ab545c..dafbe0113939ee8c0581cb68dd479cb5de4d5926 100644 --- a/libnx/nxtk/nxtk_getposition.c +++ b/libnx/nxtk/nxtk_getposition.c @@ -83,7 +83,7 @@ * Input Parameters: * hfwnd - The window handle returned by nxtk_openwindow. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_gettoolbar.c b/libnx/nxtk/nxtk_gettoolbar.c index bc05cbce94261939029d686f700c33033161a10f..ab404d12319a790a5f94ade423faffa6dedd9d8b 100644 --- a/libnx/nxtk/nxtk_gettoolbar.c +++ b/libnx/nxtk/nxtk_gettoolbar.c @@ -88,7 +88,7 @@ * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_getwindow.c b/libnx/nxtk/nxtk_getwindow.c index 4106267fb0cb311ba93d3a0119b3eeb9ecb5ab91..6f7e15e13125bd07d947b66b6ed676f5a71b6117 100644 --- a/libnx/nxtk/nxtk_getwindow.c +++ b/libnx/nxtk/nxtk_getwindow.c @@ -88,7 +88,7 @@ * dest - The location to copy the memory region * deststride - The width, in bytes, of the dest memory * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_lower.c b/libnx/nxtk/nxtk_lower.c index 08a588897d9833fa62ad5583772b93bc02e60a23..fee5fd075d9c71556da6bdff0a0cb1861239412d 100644 --- a/libnx/nxtk/nxtk_lower.c +++ b/libnx/nxtk/nxtk_lower.c @@ -79,11 +79,11 @@ * Lower the window containing the specified client sub-window to the * bottom of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be lowered. This must have been previously * created by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_movetoolbar.c b/libnx/nxtk/nxtk_movetoolbar.c index 913142a0d4ae37dc5d1f4c9859db01f5143a3e88..08a1e3beb332e3649083849d60ad9e761a5013f2 100644 --- a/libnx/nxtk/nxtk_movetoolbar.c +++ b/libnx/nxtk/nxtk_movetoolbar.c @@ -87,7 +87,7 @@ * sub-window to move * offset - The offset to move the region * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_movewindow.c b/libnx/nxtk/nxtk_movewindow.c index 302cff98d1d0bc23328c16f5c1f008b1bf8efd7b..e0064ba795f069e6a4507f3390c4ad5256862390 100644 --- a/libnx/nxtk/nxtk_movewindow.c +++ b/libnx/nxtk/nxtk_movewindow.c @@ -86,7 +86,7 @@ * sub-window to move * offset - The offset to move the region * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_opentoolbar.c b/libnx/nxtk/nxtk_opentoolbar.c index f5d58979eaaaede926b9217b769208fccc7687fa..2bf68b69c1f6d4faba95838a30f8b421b0582647 100644 --- a/libnx/nxtk/nxtk_opentoolbar.c +++ b/libnx/nxtk/nxtk_opentoolbar.c @@ -85,7 +85,7 @@ * arg - User provided value that will be returned with toolbar * callbacks. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_openwindow.c b/libnx/nxtk/nxtk_openwindow.c index ebefaec892060f1eb069f92fc2a4cc9a77f3f42a..f333ea79c7f75bbc197b3c48ff23e8494b4d14fc 100644 --- a/libnx/nxtk/nxtk_openwindow.c +++ b/libnx/nxtk/nxtk_openwindow.c @@ -107,7 +107,7 @@ nxgl_mxpixel_t g_bordercolor3[CONFIG_NX_NPLANES] = * cb - Callbacks used to process window events * arg - User provided value that will be returned with NXTK callbacks. * - * Return: + * Returned Value: * Success: A non-NULL handle used with subsequent NXTK window accesses * Failure: NULL is returned and errno is set appropriately * diff --git a/libnx/nxtk/nxtk_raise.c b/libnx/nxtk/nxtk_raise.c index d0273fe704845cb1e9951040a9f43abde41b3455..2fa954a6ea61afb9b5ece31409f5f1c42a6c3742 100644 --- a/libnx/nxtk/nxtk_raise.c +++ b/libnx/nxtk/nxtk_raise.c @@ -79,11 +79,11 @@ * Bring the window containing the specified client sub-window to the top * of the display. * - * Input parameters: + * Input Parameters: * hfwnd - the window to be raised. This must have been previously * created by nxtk_openwindow(). * - * Returned value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_setposition.c b/libnx/nxtk/nxtk_setposition.c index ed856252720a4484fc19f35e34a266b988c6c23b..642db0fb54094706f63448342a161de879618b5c 100644 --- a/libnx/nxtk/nxtk_setposition.c +++ b/libnx/nxtk/nxtk_setposition.c @@ -84,7 +84,7 @@ * hfwnd - The window handle returned by nxtk_openwindow * pos - The new position of the client sub-window * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_setsize.c b/libnx/nxtk/nxtk_setsize.c index 7e9079696647c847f2551fc6a00ef0cdc0a476ae..d9ccfe46c8ed1bc1331f4adb87e745e67da88577 100644 --- a/libnx/nxtk/nxtk_setsize.c +++ b/libnx/nxtk/nxtk_setsize.c @@ -84,7 +84,7 @@ * hfwnd - The window handle returned by nxtk_openwindow * size - The new size of the client sub-window. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_subwindowclip.c b/libnx/nxtk/nxtk_subwindowclip.c index b1b4024ee7e813ccb3155da86a9e9727bcf33c0d..3aa0a5dc2895e9a19ed2ae267a8151ce224f85b1 100644 --- a/libnx/nxtk/nxtk_subwindowclip.c +++ b/libnx/nxtk/nxtk_subwindowclip.c @@ -83,13 +83,13 @@ * containing window (i.e., (0,0) is the top left corner of the containing * window). * - * Input parameters: + * Input Parameters: * fwnd - The framed window to be used * dest - The locaton to put the result * src - The src rectangle in relative sub-window coordinates * bounds - The subwindow bounds in absolute screen coordinates. * - * Returned value: + * Returned Value: * None * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_subwindowmove.c b/libnx/nxtk/nxtk_subwindowmove.c index 6b80609d3da5bef106e858f4b95c5c6ddbb642fc..2c14d010ce679509c76385d4ac16cded0e26e5e7 100644 --- a/libnx/nxtk/nxtk_subwindowmove.c +++ b/libnx/nxtk/nxtk_subwindowmove.c @@ -89,7 +89,7 @@ * srcoffset - The offset to move the region * bounds - The subwindow bounds in absolute screen coordinates. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/libnx/nxtk/nxtk_toolbarbounds.c b/libnx/nxtk/nxtk_toolbarbounds.c index eacaf9057311c1c280e763302334e15d32b3f86b..0657d6027602d1f518aa35e64b8b6ad763064db2 100644 --- a/libnx/nxtk/nxtk_toolbarbounds.c +++ b/libnx/nxtk/nxtk_toolbarbounds.c @@ -87,7 +87,7 @@ * hfwnd - The handle returned by nxtk_openwindow * bounds - User provided location in which to return the bounding box. * - * Return: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_addregion.c b/mm/kmm_heap/kmm_addregion.c index 41884fa7c35f98b1d13309031c2775c550438c8c..96bf448eec99bb817411ba60aca41cf145945520 100644 --- a/mm/kmm_heap/kmm_addregion.c +++ b/mm/kmm_heap/kmm_addregion.c @@ -57,7 +57,7 @@ * heap_start - Address of the beginning of the memory region * heap_size - The size (in bytes) if the memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_free.c b/mm/kmm_heap/kmm_free.c index c9016788188a24bc775222abd836726bb7c90b34..466b268b7eafd04cbc401688ad31c3eb8a66772f 100644 --- a/mm/kmm_heap/kmm_free.c +++ b/mm/kmm_heap/kmm_free.c @@ -60,7 +60,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_heapmember.c b/mm/kmm_heap/kmm_heapmember.c index 53fa7027b7d00dbe16eb84064664f0d81741e819..dc1c916ef7ef75f754272be6119b78b2998d8373 100644 --- a/mm/kmm_heap/kmm_heapmember.c +++ b/mm/kmm_heap/kmm_heapmember.c @@ -58,7 +58,7 @@ * Parameters: * mem - The address to check * - * Return Value: + * Returned Value: * true if the address is a member of the kernel heap. false if not * not. If the address is not a member of the kernel heap, then it * must be a member of the user-space heap (unchecked) diff --git a/mm/kmm_heap/kmm_initialize.c b/mm/kmm_heap/kmm_initialize.c index 03baba81203434cd5da82417ae3135bb2659af34..4bf8d990274ce70043354715519106b6c0f696b7 100644 --- a/mm/kmm_heap/kmm_initialize.c +++ b/mm/kmm_heap/kmm_initialize.c @@ -66,7 +66,7 @@ struct mm_heap_s g_kmmheap; * heap_start - Address of the beginning of the (initial) memory region * heap_size - The size (in bytes) if the (initial) memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_kernel.c b/mm/kmm_heap/kmm_kernel.c index e2fc9232b818b0e30438568bac6a2d722c9376c5..0faf6944abe09e5dd9b9f8a49a91c357e4aebdb3 100644 --- a/mm/kmm_heap/kmm_kernel.c +++ b/mm/kmm_heap/kmm_kernel.c @@ -59,7 +59,7 @@ * Parameters: * mem - The address to check * - * Return Value: + * Returned Value: * true if the address is a member of the kernel heap. false if not * not. If the address is not a member of the kernel heap, then it * must be a member of the user-space heap (unchecked) diff --git a/mm/kmm_heap/kmm_malloc.c b/mm/kmm_heap/kmm_malloc.c index 06bed81c50110f49ab096aacc03fd93ac5c63bcc..9f0e6e7949fff6070fadbbd509df1be25242dd95 100644 --- a/mm/kmm_heap/kmm_malloc.c +++ b/mm/kmm_heap/kmm_malloc.c @@ -56,7 +56,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_memalign.c b/mm/kmm_heap/kmm_memalign.c index 2ca1465bf02a3e2c8415db3718b917dee976aaa4..9c0ba608ecae1d604f52e4d6b56f4f980ad7e26d 100644 --- a/mm/kmm_heap/kmm_memalign.c +++ b/mm/kmm_heap/kmm_memalign.c @@ -59,7 +59,7 @@ * alignment - Log2 byte alignment * size - Size (in bytes) of the new memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the re-allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_realloc.c b/mm/kmm_heap/kmm_realloc.c index 477e2b70b1864930e2e0ad145bc1569f98a793ac..f06d6fa161770ef45458e57c27564f0be67c9c22 100644 --- a/mm/kmm_heap/kmm_realloc.c +++ b/mm/kmm_heap/kmm_realloc.c @@ -57,7 +57,7 @@ * oldmem - The old memory allocated * newsize - Size (in bytes) of the new memory region to be re-allocated. * - * Return Value: + * Returned Value: * The address of the re-allocated memory (NULL on failure to re-allocate) * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_sem.c b/mm/kmm_heap/kmm_sem.c index 2ba019f6732468d6d9ba9b7bdac8d7a349f06e85..dc05bf78ed7390bd97cf647da354039ed410b39b 100644 --- a/mm/kmm_heap/kmm_sem.c +++ b/mm/kmm_heap/kmm_sem.c @@ -56,7 +56,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ @@ -75,7 +75,7 @@ int kmm_trysemaphore(void) * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ diff --git a/mm/kmm_heap/kmm_zalloc.c b/mm/kmm_heap/kmm_zalloc.c index 19bea29f15983320443ceaa0a5d68ba7a16a176c..525ee8cb8d9e2f0326f36df5c11b14236c214d97 100644 --- a/mm/kmm_heap/kmm_zalloc.c +++ b/mm/kmm_heap/kmm_zalloc.c @@ -56,7 +56,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/mm_heap/mm_initialize.c b/mm/mm_heap/mm_initialize.c index 7696676fde3ba26556df17df80443b27f0788b07..becafc88a64fc86f6ed9682aa1635f343221dafe 100644 --- a/mm/mm_heap/mm_initialize.c +++ b/mm/mm_heap/mm_initialize.c @@ -60,7 +60,7 @@ * heapstart - Start of the heap region * heapsize - Size of the heap region * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -145,7 +145,7 @@ void mm_addregion(FAR struct mm_heap_s *heap, FAR void *heapstart, * heapstart - Start of the initial heap region * heapsize - Size of the initial heap region * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/mm/shm/shmget.c b/mm/shm/shmget.c index 682b4707edeadabc27ef9fd245dacc181f05cd53..c7701cbfc822b24b23feebbbd32a615c2e659096 100644 --- a/mm/shm/shmget.c +++ b/mm/shm/shmget.c @@ -63,10 +63,10 @@ * Description: * Find the shared memory region with matching key * - * Input parameters: + * Input Parameters: * key - The value that uniquely identifies a shared memory region. * - * Returned value: + * Returned Value: * On success, an index in the range of 0 to CONFIG_ARCH_SHM_MAXREGIONS-1 * is returned to identify the matching region; -ENOENT is returned on * failure. @@ -94,10 +94,10 @@ static int shm_find(key_t key) * Description: * Allocate an unused shared memory region. That is one with a key of -1 * - * Input parameters: + * Input Parameters: * None * - * Returned value: + * Returned Value: * On success, an index in the range of 0 to CONFIG_ARCH_SHM_MAXREGIONS-1 * is returned to identify the matching region; -ENOSPC is returned on * failure. @@ -154,12 +154,12 @@ static int shm_reserve(key_t key, int shmflg) * Extend the size of a memory regions by allocating physical pages as * necessary * - * Input parameters: + * Input Parameters: * shmid - The index of the region of interest in the shared memory region * table. * size - The new size of the region. * - * Returned value: + * Returned Value: * Zero is returned on success; -ENOMEM is returned on failure. * (Should a different error be returned if the region is just too big?) * @@ -224,7 +224,7 @@ static int shm_extend(int shmid, size_t size) * Description: * Create the shared memory region. * - * Input parameters: + * Input Parameters: * key - The key that is used to access the unique shared memory * identifier. * size - The shared memory region that is created will be at least @@ -232,7 +232,7 @@ static int shm_extend(int shmid, size_t size) * shmflgs - See IPC_* definitions in sys/ipc.h. Only the values * IPC_PRIVATE or IPC_CREAT are supported. * - * Returned value: + * Returned Value: * Zero is returned on success; A negated errno value is returned on * failure. * diff --git a/mm/umm_heap/umm_addregion.c b/mm/umm_heap/umm_addregion.c index 00e5372ee8bce1b7b8db613f9048261885ce8f91..9197cf3f334e2374e7be84abe84799536b40f6f8 100644 --- a/mm/umm_heap/umm_addregion.c +++ b/mm/umm_heap/umm_addregion.c @@ -59,7 +59,7 @@ * heap_start - Address of the beginning of the memory region * heap_size - The size (in bytes) if the memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/umm_heap/umm_initialize.c b/mm/umm_heap/umm_initialize.c index 04e045e0730499ca60d2bf990697765dc1ff94f9..55fc430fc19a25da0a52f253debc650fcf612ee5 100644 --- a/mm/umm_heap/umm_initialize.c +++ b/mm/umm_heap/umm_initialize.c @@ -89,7 +89,7 @@ * heap_start - Address of the beginning of the (initial) memory region * heap_size - The size (in bytes) if the (initial) memory region. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/mm/umm_heap/umm_malloc.c b/mm/umm_heap/umm_malloc.c index 7832af4e2938f962905554da18a744bccef4d4bc..ddbb03a2c6bdd9d7028d61649ae43b3393fd9283 100644 --- a/mm/umm_heap/umm_malloc.c +++ b/mm/umm_heap/umm_malloc.c @@ -59,7 +59,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/mm/umm_heap/umm_realloc.c b/mm/umm_heap/umm_realloc.c index a517aa200a9dfacb17f4b3c77a67d8d586a66caf..394a4e2cd2c644334d37bd80c03e2e03989ea51e 100644 --- a/mm/umm_heap/umm_realloc.c +++ b/mm/umm_heap/umm_realloc.c @@ -59,7 +59,7 @@ * oldmem - The old memory allocated * newsize - Size (in bytes) of the new memory region to be re-allocated. * - * Return Value: + * Returned Value: * The address of the re-allocated memory (NULL on failure to re-allocate) * ****************************************************************************/ diff --git a/mm/umm_heap/umm_sem.c b/mm/umm_heap/umm_sem.c index a9012e542c2bfbc6d2f106eff20685fd35356a48..37b0fb42cdd7b819d0dd5b72327ee3737dbad6d0 100644 --- a/mm/umm_heap/umm_sem.c +++ b/mm/umm_heap/umm_sem.c @@ -58,7 +58,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ @@ -79,7 +79,7 @@ int umm_trysemaphore(void) * Parameters: * None * - * Return Value: + * Returned Value: * OK on success; a negated errno on failure * ****************************************************************************/ diff --git a/mm/umm_heap/umm_zalloc.c b/mm/umm_heap/umm_zalloc.c index 7103e3233b66b3811bf25c51329663f98732546a..6ce7fe14fbc74da6e071b614066dbfaa503ae2cf 100644 --- a/mm/umm_heap/umm_zalloc.c +++ b/mm/umm_heap/umm_zalloc.c @@ -59,7 +59,7 @@ * Parameters: * size - Size (in bytes) of the memory region to be allocated. * - * Return Value: + * Returned Value: * The address of the allocated memory (NULL on failure to allocate) * ****************************************************************************/ diff --git a/net/arp/arp.h b/net/arp/arp.h index 0fbea68c510a38b58bf765c1110fe29e7e8cf4ec..643c5a609341feef21df23a59aefb1911c2d54fe 100644 --- a/net/arp/arp.h +++ b/net/arp/arp.h @@ -374,7 +374,7 @@ void arp_notify(in_addr_t ipaddr); * Description: * Find the ARP entry corresponding to this IP address. * - * Input parameters: + * Input Parameters: * ipaddr - Refers to an IP address in network order * * Assumptions @@ -391,7 +391,7 @@ FAR struct arp_entry *arp_find(in_addr_t ipaddr); * Description: * Remove an IP association from the ARP table * - * Input parameters: + * Input Parameters: * ipaddr - Refers to an IP address in network order * * Assumptions @@ -416,7 +416,7 @@ FAR struct arp_entry *arp_find(in_addr_t ipaddr); * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * ipaddr - The IP address as an inaddr_t * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * @@ -438,7 +438,7 @@ int arp_update(in_addr_t ipaddr, FAR uint8_t *ethaddr); * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * pipaddr - Refers to an IP address uint16_t[2] in network order * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * diff --git a/net/arp/arp_table.c b/net/arp/arp_table.c index 928ed5901939adf879e55ce8f8f8bd0c742894a6..d8818ddf39653684e20d6c99a82507f9aa3759ff 100644 --- a/net/arp/arp_table.c +++ b/net/arp/arp_table.c @@ -129,7 +129,7 @@ void arp_timer(void) * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * ipaddr - The IP address as an inaddr_t * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * @@ -227,7 +227,7 @@ int arp_update(in_addr_t ipaddr, FAR uint8_t *ethaddr) * Add the IP/HW address mapping to the ARP table -OR- change the IP * address of an existing association. * - * Input parameters: + * Input Parameters: * pipaddr - Refers to an IP address uint16_t[2] in network order * ethaddr - Refers to a HW address uint8_t[IFHWADDRLEN] * @@ -255,7 +255,7 @@ void arp_hdr_update(FAR uint16_t *pipaddr, FAR uint8_t *ethaddr) * Description: * Find the ARP entry corresponding to this IP address. * - * Input parameters: + * Input Parameters: * ipaddr - Refers to an IP address in network order * * Assumptions diff --git a/net/devif/devif.h b/net/devif/devif.h index 438e275f46e6ad255a6ebfde58148e4ed791b601..2eeb97f7f0449a8f019bebed17bb58a54311a9ff 100644 --- a/net/devif/devif.h +++ b/net/devif/devif.h @@ -309,7 +309,7 @@ EXTERN systime_t g_polltime; * Parameters: * None * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -400,7 +400,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * Description: * Execute a list of callbacks. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -409,7 +409,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * flags - The bit set of events to be notified. * list - The list to traverse in performing the notifications * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: @@ -426,7 +426,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, FAR void *pvconn, * Description: * Execute a list of callbacks using the device event chain. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -434,7 +434,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, FAR void *pvconn, * connection or UDP port. * flags - The bit set of events to be notified. * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: diff --git a/net/devif/devif_callback.c b/net/devif/devif_callback.c index 92718b9798f78c9434775833c1f302856217349d..e2261b750fe408b7fefc78e426ed8ee7f0914805 100644 --- a/net/devif/devif_callback.c +++ b/net/devif/devif_callback.c @@ -170,7 +170,7 @@ static void devif_callback_free(FAR struct net_driver_s *dev, * Return true if the current set of events should trigger a callback to * occur. * - * Input paramters: + * Input Parameters: * events - The set of events that has occurred. * triggers - The set of events that will trigger a callback. * @@ -402,7 +402,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * Description: * Execute a list of callbacks using the packet event chain. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -411,7 +411,7 @@ void devif_dev_callback_free(FAR struct net_driver_s *dev, * flags - The bit set of events to be notified. * list - The list to traverse in performing the notifications * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: @@ -465,7 +465,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, void *pvconn, * Description: * Execute a list of callbacks using the device event chain. * - * Input parameters: + * Input Parameters: * dev - The network device state structure associated with the network * device that initiated the callback event. * pvconn - Holds a reference to the TCP connection structure or the UDP @@ -473,7 +473,7 @@ uint16_t devif_conn_event(FAR struct net_driver_s *dev, void *pvconn, * connection or UDP port. * flags - The bit set of events to be notified. * - * Returned value: + * Returned Value: * The updated flags as modified by the callback functions. * * Assumptions: diff --git a/net/devif/devif_initialize.c b/net/devif/devif_initialize.c index 244d7a1b6c5a01b3cca96be51677613e324889cf..ecbe15479e7d98229e99ee3fe73b11ce9b38ade6 100644 --- a/net/devif/devif_initialize.c +++ b/net/devif/devif_initialize.c @@ -85,7 +85,7 @@ uint8_t g_reassembly_timer; * Parameters: * None * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/net/icmp/icmp.h b/net/icmp/icmp.h index 77aa832f8f4c4135723371d38811918f91229e72..d17f5d1fbd67d295ab6648df03e162649b7b6e7f 100644 --- a/net/icmp/icmp.h +++ b/net/icmp/icmp.h @@ -129,7 +129,7 @@ struct pollfd; /* Forward reference */ * dev - The device driver structure containing the received ICMP * packet * - * Return: + * Returned Value: * None * * Assumptions: @@ -235,7 +235,7 @@ FAR struct icmp_conn_s *icmp_findconn(FAR struct net_driver_s *dev, uint8_t id); * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmp/icmp_input.c b/net/icmp/icmp_input.c index 38937dad6427c5a5230cf4fd488ea2eaebf9500f..973b0326c159709c63ef7313d1ef2bf044284666 100644 --- a/net/icmp/icmp_input.c +++ b/net/icmp/icmp_input.c @@ -89,7 +89,7 @@ * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * @@ -214,7 +214,7 @@ drop: * dev - The device driver structure containing the received ICMP * packet * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmp/icmp_poll.c b/net/icmp/icmp_poll.c index f86e3a6e1461c031e4c9e02c0b0a4bbcc955989f..190bc067444774836d30424192772115086586f5 100644 --- a/net/icmp/icmp_poll.c +++ b/net/icmp/icmp_poll.c @@ -62,7 +62,7 @@ * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmp/icmp_sendto.c b/net/icmp/icmp_sendto.c index 9ee74e000e1e137a78ae4f6b3533ac646b4214d5..7c20668273f3f57636f1f17884d618d7369c8f73 100644 --- a/net/icmp/icmp_sendto.c +++ b/net/icmp/icmp_sendto.c @@ -150,7 +150,7 @@ static inline int sendto_timeout(FAR struct icmp_sendto_s *pstate) * dev - The device driver structure to use in the send operation * pstate - Reference to an instance of the ICMP sendto state structure * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6.h b/net/icmpv6/icmpv6.h index 582712c5e532c3e7eab307eef036264fc8b79a7d..f5bee4251e47e402e3b1d92b16774e09042680f6 100644 --- a/net/icmpv6/icmpv6.h +++ b/net/icmpv6/icmpv6.h @@ -158,7 +158,7 @@ struct pollfd; /* Forward reference */ * dev - The device driver structure containing the received ICMPv6 * packet * - * Return: + * Returned Value: * None * * Assumptions: @@ -214,7 +214,7 @@ int icmpv6_neighbor(const net_ipv6addr_t ipaddr); * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -236,7 +236,7 @@ void icmpv6_poll(FAR struct net_driver_s *dev); * dev - Reference to an Ethernet device driver structure * ipaddr - IP address of Neighbor to be solicited * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -261,7 +261,7 @@ void icmpv6_solicit(FAR struct net_driver_s *dev, * Parameters: * dev - Reference to an Ethernet device driver structure * - * Return: + * Returned Value: * None * ****************************************************************************/ @@ -280,7 +280,7 @@ void icmpv6_rsolicit(FAR struct net_driver_s *dev); * dev - The device driver structure containing the outgoing ICMPv6 packet * buffer * - * Return: + * Returned Value: * None. * * Assumptions: @@ -301,7 +301,7 @@ void icmpv6_advertise(FAR struct net_driver_s *dev, * dev - The device driver structure containing the outgoing ICMPv6 packet * buffer * - * Return: + * Returned Value: * None * * Assumptions: @@ -406,7 +406,7 @@ void icmpv6_notify(net_ipv6addr_t ipaddr); * Parameters: * dev - The device driver structure to assign the address to * - * Return: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * any failure. * diff --git a/net/icmpv6/icmpv6_advertise.c b/net/icmpv6/icmpv6_advertise.c index 37c8c8ebb967120ff53015852934fafe6ec3c22a..e0a7d8a770a9bf22ac65c933890419e5f8824adf 100644 --- a/net/icmpv6/icmpv6_advertise.c +++ b/net/icmpv6/icmpv6_advertise.c @@ -85,7 +85,7 @@ * dev - The device driver structure containing the outgoing ICMPv6 packet * buffer * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_autoconfig.c b/net/icmpv6/icmpv6_autoconfig.c index bb481224e2de64172f8f18a123754e19dee6e810..3f1ea9d2a65c63a36feadf9f1116fbaf24677809 100644 --- a/net/icmpv6/icmpv6_autoconfig.c +++ b/net/icmpv6/icmpv6_autoconfig.c @@ -331,7 +331,7 @@ static int icmpv6_wait_radvertise(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure to assign the address to * - * Return: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * any failure. * diff --git a/net/icmpv6/icmpv6_input.c b/net/icmpv6/icmpv6_input.c index 66030ad90106270b491a782d28170a6a5fda3698..42c2e8c55dce23ce543734a886caa282fda0013c 100644 --- a/net/icmpv6/icmpv6_input.c +++ b/net/icmpv6/icmpv6_input.c @@ -99,7 +99,7 @@ * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * @@ -221,7 +221,7 @@ drop: * dev - The device driver structure containing the received ICMPv6 * packet * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_poll.c b/net/icmpv6/icmpv6_poll.c index 145dd62e69995cf825e129accdbec307f377237d..d6853ff4a645b5a8b5fcfea221cab97df5c41171 100644 --- a/net/icmpv6/icmpv6_poll.c +++ b/net/icmpv6/icmpv6_poll.c @@ -63,7 +63,7 @@ * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_rsolicit.c b/net/icmpv6/icmpv6_rsolicit.c index 1ff49d712c6f895a0f60674052857ac14b8a5cd1..ba24bbeef1964b6d488fa4e548918b8cb8c6560d 100644 --- a/net/icmpv6/icmpv6_rsolicit.c +++ b/net/icmpv6/icmpv6_rsolicit.c @@ -84,7 +84,7 @@ * Parameters: * dev - Reference to an Ethernet device driver structure * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/net/icmpv6/icmpv6_sendto.c b/net/icmpv6/icmpv6_sendto.c index cbff44a3ea70f4d83b1b22c670af8651a729513a..8db6d370e7fd2643cd425add06d4dfcdc5fcb192 100644 --- a/net/icmpv6/icmpv6_sendto.c +++ b/net/icmpv6/icmpv6_sendto.c @@ -150,7 +150,7 @@ static inline int sendto_timeout(FAR struct icmpv6_sendto_s *pstate) * dev - The device driver structure to use in the send operation * pstate - Reference to an instance of the ICMPv6 sendto state structure * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/icmpv6/icmpv6_solicit.c b/net/icmpv6/icmpv6_solicit.c index 7fa1a55d19f20a646cfe8fc7d1f9b726cd1cbe66..30fe57b26634e05f3cda0b5178709f30be9b6dda 100644 --- a/net/icmpv6/icmpv6_solicit.c +++ b/net/icmpv6/icmpv6_solicit.c @@ -94,7 +94,7 @@ static const uint16_t g_icmpv_mcastaddr[6] = * dev - Reference to an Ethernet device driver structure * ipaddr - IP address of Neighbor to be solicited * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/net/ieee802154/ieee802154.h b/net/ieee802154/ieee802154.h index bf60db0530e89fa30708455d821174ace75fc315..3dc16735070d855ec09f2e196b6efa546263a856 100644 --- a/net/ieee802154/ieee802154.h +++ b/net/ieee802154/ieee802154.h @@ -268,7 +268,7 @@ FAR struct ieee802154_conn_s * * If there are multilple frames in the list, this metadata * must apply to all of the frames in the list. * - * Return: + * Returned Value: * OK The IEEE 802.15.4 has been processed and can be deleted * ERROR Hold the IEEE 802.15.4 and try again later. There is a listening * socket but no recv in place to catch the IEEE 802.15.4 yet. @@ -364,7 +364,7 @@ FAR struct radio_driver_s * * dev - The device driver structure to use in the send operation * conn - The IEEE 802.15.4 "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: @@ -413,10 +413,10 @@ ssize_t psock_ieee802154_sendto(FAR struct socket *psock, * be called early in the initialization sequence before any socket * activity. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -437,10 +437,10 @@ void ieee802154_container_initialize(void); * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated container structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -461,10 +461,10 @@ FAR struct ieee802154_container_s *ieee802154_container_allocate(void); * structure. If the container structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * container - container structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/ieee802154/ieee802154_container.c b/net/ieee802154/ieee802154_container.c index af70fe645d12853bd355b4985a63855815b1d0da..88f01755dec44b86a8817996ff2b6cf41bc202fe 100644 --- a/net/ieee802154/ieee802154_container.c +++ b/net/ieee802154/ieee802154_container.c @@ -82,10 +82,10 @@ static struct ieee802154_container_s * be called early in the initialization sequence before any socket * activity. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -127,10 +127,10 @@ void ieee802154_container_initialize(void) * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated container structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -185,10 +185,10 @@ FAR struct ieee802154_container_s *ieee802154_container_allocate(void) * structure. If the container structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * container - container structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/ieee802154/ieee802154_input.c b/net/ieee802154/ieee802154_input.c index 1d50451cc3055ce5e1ad26e24221c3a6710b6eff..57f32eaf700558bae6148f2ec8b26e181eb699d0 100644 --- a/net/ieee802154/ieee802154_input.c +++ b/net/ieee802154/ieee802154_input.c @@ -64,7 +64,7 @@ * Parameters: * conn - The socket connection structure. * - * Return: + * Returned Value: * The number of frames in the queue. * ****************************************************************************/ @@ -96,7 +96,7 @@ static int ieee802154_count_frames(FAR struct ieee802154_conn_s *conn) * framel - A single frame to add to the RX queue. * meta - Meta data characterizing the received frane. * - * Return: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * any failure. * @@ -227,7 +227,7 @@ static int ieee802154_queue_frame(FAR struct ieee802154_conn_s *conn, * If there are multilple frames in the list, this metadata * must apply to all of the frames in the list. * - * Return: + * Returned Value: * OK The IEEE 802.15.4 has been processed and can be deleted * ERROR Hold the IEEE 802.15.4 and try again later. There is a listening * socket but no recv in place to catch the IEEE 802.15.4 yet. diff --git a/net/ieee802154/ieee802154_poll.c b/net/ieee802154/ieee802154_poll.c index 0d313e0e4b62c62eb3b8209e7e543f5ff37c99f0..fb33ea1bbb62bb1c38b0874a0d6c4c0a362e695b 100644 --- a/net/ieee802154/ieee802154_poll.c +++ b/net/ieee802154/ieee802154_poll.c @@ -64,7 +64,7 @@ * dev - The device driver structure to use in the send operation * conn - The packet "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/ieee802154/ieee802154_recvfrom.c b/net/ieee802154/ieee802154_recvfrom.c index 2e47f18fb72f4c115b8629e8a86a40711dcc3e0b..7ee3c7d04134caf19c43335bbfb59199f8a248de 100644 --- a/net/ieee802154/ieee802154_recvfrom.c +++ b/net/ieee802154/ieee802154_recvfrom.c @@ -91,7 +91,7 @@ struct ieee802154_recvfrom_s * Parameters: * conn - The socket connection structure. * - * Return: + * Returned Value: * The number of frames in the queue. * ****************************************************************************/ @@ -121,7 +121,7 @@ static int ieee802154_count_frames(FAR struct ieee802154_conn_s *conn) * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * The network is lockec @@ -209,7 +209,7 @@ static ssize_t ieee802154_recvfrom_rxqueue(FAR struct radio_driver_s *radio, * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * The network is locked. diff --git a/net/ieee802154/ieee802154_sendto.c b/net/ieee802154/ieee802154_sendto.c index 2c2c79e5b1b5746ce97c0029a2479903c374c764..47657ac1f95d473573fc0c33ea022d303b9d02e9 100644 --- a/net/ieee802154/ieee802154_sendto.c +++ b/net/ieee802154/ieee802154_sendto.c @@ -96,7 +96,7 @@ struct ieee802154_sendto_s * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * addr - The address to check * addrlen - The length of the address in bytes * @@ -125,7 +125,7 @@ static bool ieee802154_anyaddrnull(FAR const uint8_t *addr, uint8_t addrlen) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The short address to check * * Returned Value: @@ -145,7 +145,7 @@ static inline bool ieee802154_saddrnull(FAR const uint8_t *saddr) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The extended address to check * * Returned Value: diff --git a/net/igmp/igmp.h b/net/igmp/igmp.h index 4850bd511ed6f0a600d18bdf16f6018a8af052fc..eef6cad00b4a5fd4eaa723428c914595d9899c22 100644 --- a/net/igmp/igmp.h +++ b/net/igmp/igmp.h @@ -247,7 +247,7 @@ void igmp_poll(FAR struct net_driver_s *dev); * message to be sent. * destipaddr - The IP address of the recipient of the message * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/igmp/igmp_send.c b/net/igmp/igmp_send.c index 3a28cccc8c6c05bfbb4f178692de2438fdc5023a..e6941d7f2b645dce45d2238627900ea04271647b 100644 --- a/net/igmp/igmp_send.c +++ b/net/igmp/igmp_send.c @@ -106,7 +106,7 @@ static uint16_t igmp_chksum(FAR uint8_t *buffer, int buflen) * message to be sent. * destipaddr - The IP address of the recipient of the message * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/ipforward/ipv6_forward.c b/net/ipforward/ipv6_forward.c index b2fea28f4ac6303834e8ae956d7841b3ee43e632..4250692d893388ad82a8c28ac0932184ea5c8fac 100644 --- a/net/ipforward/ipv6_forward.c +++ b/net/ipforward/ipv6_forward.c @@ -187,7 +187,7 @@ static int ipv6_decr_ttl(FAR struct ipv6_hdr_s *ipv6) * but this is a point where support for other conversions may be * provided. * - * Returned value: + * Returned Value: * PACKET_FORWARDED - Packet was forwarded * PACKET_NOT_FORWARDED - Packet was not forwarded * < 0 - And error occurred (and packet not fowarded). diff --git a/net/local/local.h b/net/local/local.h index b4ccfd9a8a038a2d373eda987e6197d71acfda55..f49d399bf513a2b46f65530c649f353dadb6e1c5 100644 --- a/net/local/local.h +++ b/net/local/local.h @@ -375,7 +375,7 @@ int local_accept(FAR struct socket *psock, FAR struct sockaddr *addr, * len Length of data to send * flags Send flags (ignored for now) * - * Return: + * Returned Value: * On success, returns the number of characters sent. On error, * -1 is returned, and errno is set appropriately (see send() for the * list of errno numbers). @@ -429,7 +429,7 @@ ssize_t psock_local_sendto(FAR struct socket *psock, FAR const void *buf, * buf Data to send * len Length of data to send * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. * @@ -482,7 +482,7 @@ ssize_t local_recvfrom(FAR struct socket *psock, FAR void *buf, * len - Length of data to receive [in] * Length of data actually received [out] * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. If -ECONNRESET is received, then the sending side has closed * the FIFO. In this case, the returned data may still be valid (if the @@ -504,7 +504,7 @@ int local_fifo_read(FAR struct file *filep, FAR uint8_t *buf, size_t *len); * addrlen - The size of the memory allocat by the caller to receive the * address. * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -521,7 +521,7 @@ int local_getaddr(FAR struct local_conn_s *conn, FAR struct sockaddr *addr, * Parameters: * filep - File structure of write-only FIFO. * - * Return: + * Returned Value: * The non-zero size of the following packet is returned on success; a * negated errno value is returned on any failure. * diff --git a/net/local/local_connect.c b/net/local/local_connect.c index 9a875b314b7e8425bdb6ff57bffe70a82186e039..28215e67f6c8855f7f537969830607d270477bbe 100644 --- a/net/local/local_connect.c +++ b/net/local/local_connect.c @@ -117,7 +117,7 @@ static inline void _local_semtake(sem_t *sem) * Find a local connection structure that is the appropriate "server" * connection to be used with the provided "client" connection. * - * Returned Values: + * Returned Value: * Zero (OK) returned on success; A negated errno value is returned on a * failure. Possible failures include: * @@ -250,7 +250,7 @@ errout_with_fifos: * Find a local connection structure that is the appropriate "server" * connection to be used with the provided "client" connection. * - * Returned Values: + * Returned Value: * Zero (OK) returned on success; A negated errno value is returned on a * failure. Possible failures include: * diff --git a/net/local/local_recvutils.c b/net/local/local_recvutils.c index 91e185754f410bae2971b96aa87a3eea515951af..798107e534f82cf536b6a03d5eebc269a19083d1 100644 --- a/net/local/local_recvutils.c +++ b/net/local/local_recvutils.c @@ -69,7 +69,7 @@ * len - Length of data to receive [in] * Length of data actually received [out] * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. If -ECONNRESET is received, then the sending side has closed * the FIFO. In this case, the returned data may still be valid (if the @@ -133,7 +133,7 @@ errout: * Parameters: * filep - File structure of write-only FIFO. * - * Return: + * Returned Value: * The non-zero size of the following packet is returned on success; a * negated errno value is returned on any failure. * @@ -201,7 +201,7 @@ int local_sync(FAR struct file *filep) * addrlen - The size of the memory allocated by the caller to receive the * address. * - * Return: + * Returned Value: * Zero (OK) on success; a negated errno value on failure. * ****************************************************************************/ diff --git a/net/local/local_send.c b/net/local/local_send.c index a305dac44116798e2d7ec316350d0187f42f32d5..6f170ba0a22e532c367e7fcc7a60fc7710cb340c 100644 --- a/net/local/local_send.c +++ b/net/local/local_send.c @@ -66,7 +66,7 @@ * len Length of data to send * flags Send flags (ignored for now) * - * Return: + * Returned Value: * On success, returns the number of characters sent. On error, * -1 is returned, and errno is set appropriately (see send() for the * list of errno numbers). diff --git a/net/local/local_sendpacket.c b/net/local/local_sendpacket.c index fad305fd0b47b8d5a3bc00fcf9f7ed2d854cd307..8a4fcae61cd2bf5835efa9913f26b210ad90a853 100644 --- a/net/local/local_sendpacket.c +++ b/net/local/local_sendpacket.c @@ -83,7 +83,7 @@ static const uint8_t g_preamble[LOCAL_PREAMBLE_SIZE] = * buf Data to send * len Length of data to send * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. * @@ -133,7 +133,7 @@ static int local_fifo_write(FAR struct file *filep, FAR const uint8_t *buf, * buf Data to send * len Length of data to send * - * Return: + * Returned Value: * Zero is returned on success; a negated errno value is returned on any * failure. * diff --git a/net/netdev/netdev_ioctl.c b/net/netdev/netdev_ioctl.c index e4b1e13a46314a7e6ad2aa54c54164011a6d036a..9fdb2f1e8c6aedcf13929abb34075143fe99a55f 100644 --- a/net/netdev/netdev_ioctl.c +++ b/net/netdev/netdev_ioctl.c @@ -382,7 +382,7 @@ static void ioctl_set_ipv6addr(FAR net_ipv6addr_t outaddr, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -444,7 +444,7 @@ static int netdev_iee802154_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -507,7 +507,7 @@ static int netdev_pktradio_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -548,7 +548,7 @@ static int netdev_wifr_ioctl(FAR struct socket *psock, int cmd, * Parameters: * req - The argument of the ioctl cmd * - * Return: + * Returned Value: * A pointer to the driver structure on success; NULL on failure. * ****************************************************************************/ @@ -578,7 +578,7 @@ static FAR struct net_driver_s *netdev_ifr_dev(FAR struct ifreq *req) * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1030,7 +1030,7 @@ static int netdev_ifr_ioctl(FAR struct socket *psock, int cmd, * Parameters: * req - The argument of the ioctl cmd * - * Return: + * Returned Value: * A pointer to the driver structure on success; NULL on failure. * ****************************************************************************/ @@ -1063,7 +1063,7 @@ static FAR struct net_driver_s *netdev_imsfdev(FAR struct ip_msfilter *imsf) * cmd The ioctl command * imsf The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1122,7 +1122,7 @@ static int netdev_imsf_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * req The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1245,7 +1245,7 @@ static int netdev_arp_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * rtentry The argument of the ioctl cmd * - * Return: + * Returned Value: * >=0 on success (positive non-zero values are cmd-specific) * Negated errno returned on failure. * @@ -1359,7 +1359,7 @@ static int netdev_rt_ioctl(FAR struct socket *psock, int cmd, * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * @@ -1469,7 +1469,7 @@ int psock_ioctl(FAR struct socket *psock, int cmd, unsigned long arg) * cmd The ioctl command * arg The argument of the ioctl cmd * - * Return: + * Returned Value: * A non-negative value is returned on success; a negated errno value is * returned on any failure to indicate the nature of the failure: * diff --git a/net/pkt/pkt.h b/net/pkt/pkt.h index 2351e911922545b24538312c9096b640c8601f5d..f4bcfca1e6170494122cd628f857e932dc8723f9 100644 --- a/net/pkt/pkt.h +++ b/net/pkt/pkt.h @@ -193,7 +193,7 @@ uint16_t pkt_callback(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure containing the received packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR There is a matching connection, but could not dispatch the packet * yet. Useful when a packet arrives before a recv call is in @@ -267,7 +267,7 @@ FAR struct net_driver_s *pkt_find_device(FAR struct pkt_conn_s *conn); * dev - The device driver structure to use in the send operation * conn - The packet "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/pkt/pkt_input.c b/net/pkt/pkt_input.c index e4ba86c2d140d11f32df5af05dac12adea67d456..4676426f12e9a57e140b353b6279a53eecc704e1 100644 --- a/net/pkt/pkt_input.c +++ b/net/pkt/pkt_input.c @@ -73,7 +73,7 @@ * Parameters: * dev - The device driver structure containing the received packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR There is a matching connection, but could not dispatch the packet * yet. Useful when a packet arrives before a recv call is in diff --git a/net/pkt/pkt_poll.c b/net/pkt/pkt_poll.c index 272de209f3660405f6f0ae44a7102e0debd22d79..7fdb76d036c69622e02d1dfe0359783aa470b82f 100644 --- a/net/pkt/pkt_poll.c +++ b/net/pkt/pkt_poll.c @@ -68,7 +68,7 @@ * dev - The device driver structure to use in the send operation * conn - The packet "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/pkt/pkt_recvfrom.c b/net/pkt/pkt_recvfrom.c index ae801d07bb559cd9c175a730dcd20bb5fa0245cd..137fd5f647763e2517b8bc432e8158c185acc7d7 100644 --- a/net/pkt/pkt_recvfrom.c +++ b/net/pkt/pkt_recvfrom.c @@ -159,7 +159,7 @@ static void pkt_recvfrom_newdata(FAR struct net_driver_s *dev, * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * @@ -177,7 +177,7 @@ static inline void pkt_recvfrom_sender(FAR struct net_driver_s *dev, * * Parameters: * - * Returned Values: + * Returned Value: * * Assumptions: * diff --git a/net/sixlowpan/sixlowpan.h b/net/sixlowpan/sixlowpan.h index 4d0ba44685ad7f7332aefe56b728adfd39378e9a..7760e47e58f715e291059808a4a2cecbb6586c89 100644 --- a/net/sixlowpan/sixlowpan.h +++ b/net/sixlowpan/sixlowpan.h @@ -86,7 +86,7 @@ void sixlowpan_initialize(void); * psock_6lowpan_tcp_send() call may be used only when the TCP socket is in a * connected state (so that the intended recipient is known). * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * len - Length of data to send @@ -126,7 +126,7 @@ ssize_t psock_6lowpan_tcp_send(FAR struct socket *psock, FAR const void *buf, * driver. Under those conditions, this function will be called to create * the IEEE80215.4 frames. * - * Input Parmeters + * Input Parameters: * dev - The network device containing the packet to be sent. * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets @@ -159,7 +159,7 @@ void sixlowpan_tcp_send(FAR struct net_driver_s *dev, * * Both cases are handled here. * - * Input Parmeters + * Input Parameters: * dev - The network device containing the packet to be sent. * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets @@ -189,7 +189,7 @@ void sixlowpan_icmpv6_send(FAR struct net_driver_s *dev, * psock_6lowpan_udp_send() call may be used with connectionlesss UDP * sockets. * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * len - Length of data to send @@ -219,7 +219,7 @@ ssize_t psock_6lowpan_udp_send(FAR struct socket *psock, FAR const void *buf, * may be returned when they are not NULL and 0), and the error ENOTCONN is * returned when the socket was not actually connected. * - * Input Parmeters + * Input Parameters: * psock A pointer to a NuttX-specific, internal socket structure * buf Data to send * len Length of data to send @@ -251,7 +251,7 @@ ssize_t psock_6lowpan_udp_sendto(FAR struct socket *psock, * Handles forwarding a UDP packet via 6LoWPAN. This is currently only * used by the IPv6 forwarding logic. * - * Input Parmeters + * Input Parameters: * dev - An instance of nework device state structure * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_framelist.c b/net/sixlowpan/sixlowpan_framelist.c index 545bea004a44eac2afe50e7902c21e0ae256f621..d69e007a1f5ce3be2c3863c04458b5a65c03cc98 100644 --- a/net/sixlowpan/sixlowpan_framelist.c +++ b/net/sixlowpan/sixlowpan_framelist.c @@ -199,7 +199,7 @@ static uint16_t sixlowpan_protosize(FAR const struct ipv6_hdr_s *ipv6hdr, * destmac - The IEEE802.15.4 MAC address of the destination * meta - Location to return the final metadata. * - * Returned value + * Returned Value: * OK is returned on success; Othewise a negated errno value is returned. * ****************************************************************************/ @@ -298,7 +298,7 @@ static int sixlowpan_ieee802154_metadata(FAR struct radio_driver_s *radio, * destmac - The radio-specific MAC address of the destination * meta - Location to return the final metadata. * - * Returned value + * Returned Value: * OK is returned on success; Othewise a negated errno value is returned. * ****************************************************************************/ diff --git a/net/sixlowpan/sixlowpan_framer.c b/net/sixlowpan/sixlowpan_framer.c index 666c6a3adf19209c679659033898bcfff0882b6a..023d59f83fc108e6fcb67b41de4dab15b674fa12 100644 --- a/net/sixlowpan/sixlowpan_framer.c +++ b/net/sixlowpan/sixlowpan_framer.c @@ -64,7 +64,7 @@ * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * addr - The address to check * addrlen - The length of the address in bytes * @@ -93,7 +93,7 @@ static bool sixlowpan_anyaddrnull(FAR const uint8_t *addr, uint8_t addrlen) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The short address to check * * Returned Value: @@ -113,7 +113,7 @@ static inline bool sixlowpan_saddrnull(FAR const uint8_t *saddr) * If the destination address is all zero in the MAC header buf, then it is * broadcast on the 802.15.4 network. * - * Input parameters: + * Input Parameters: * eaddr - The extended address to check * * Returned Value: @@ -247,7 +247,7 @@ int sixlowpan_meta_data(FAR struct radio_driver_s *radio, * determine what the size of the IEEE802.15.4 header will be. No frame * buffer is required to make this determination. * - * Input parameters: + * Input Parameters: * radio - A reference IEEE802.15.4 MAC network device structure. * meta - Meta data that describes the MAC header * @@ -272,7 +272,7 @@ int sixlowpan_frame_hdrlen(FAR struct radio_driver_s *radio, * new incoming frame and the network responds with an outgoing packet. It * submits any new outgoing frame to the MAC. * - * Input parameters: + * Input Parameters: * radio - A reference to a radio network device instance. * meta - Meta data that describes the MAC header * frame - The IOB containing the frame to be submitted. diff --git a/net/sixlowpan/sixlowpan_hc06.c b/net/sixlowpan/sixlowpan_hc06.c index c9e05410e1cd502d42d770b4f3b55de78ba9a135..204cf69cbcdc312da874a11ef66ed66c0f4a07da 100644 --- a/net/sixlowpan/sixlowpan_hc06.c +++ b/net/sixlowpan/sixlowpan_hc06.c @@ -1078,7 +1078,7 @@ int sixlowpan_compresshdr_hc06(FAR struct radio_driver_s *radio, * decompression, g_frame_hdrlen and g_uncompressed_hdrlen are set to the * appropriate values * - * Input Parmeters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Obfuscated MAC metadata including node addressing * information. diff --git a/net/sixlowpan/sixlowpan_hc1.c b/net/sixlowpan/sixlowpan_hc1.c index 977c268caba0442293e80165aaafeb22bebf5232..ffbc479edfbd5d3517ade57c5b97a02186002d37 100644 --- a/net/sixlowpan/sixlowpan_hc1.c +++ b/net/sixlowpan/sixlowpan_hc1.c @@ -108,7 +108,7 @@ * | src p.| dst p.| UDP checksum | L4 data... * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * - * Input Parmeters: + * Input Parameters: * radio - A reference to a radio network device instance * ipv6 - The IPv6 header followd by TCP, UDP, or ICMPv6 header to be * compressed diff --git a/net/sixlowpan/sixlowpan_icmpv6send.c b/net/sixlowpan/sixlowpan_icmpv6send.c index e62c617ed1ea27ba3c1fe133217ddc2b95ab3943..a4ef1dc79a0591c11f9c0db06dcca3211f127ed9 100644 --- a/net/sixlowpan/sixlowpan_icmpv6send.c +++ b/net/sixlowpan/sixlowpan_icmpv6send.c @@ -63,7 +63,7 @@ * Handles forwarding a ICMPv6 packet via 6LoWPAN. This is currently only * used by the IPv6 forwarding logic. * - * Input Parmeters + * Input Parameters: * dev - An instance of nework device state structure * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_input.c b/net/sixlowpan/sixlowpan_input.c index e64becd9c1b355e3bc7408a5993ece845799f50c..50a757a60489cd774de362a7b5cb932597ac51f7 100644 --- a/net/sixlowpan/sixlowpan_input.c +++ b/net/sixlowpan/sixlowpan_input.c @@ -597,7 +597,7 @@ errout_with_reass: * Description: * Inject the packet in d_buf into the network for normal packet processing. * - * Input Parmeters + * Input Parameters: * radio - The IEEE802.15.4 MAC network driver interface. * * Returned Value: diff --git a/net/sixlowpan/sixlowpan_internal.h b/net/sixlowpan/sixlowpan_internal.h index 7e527dae0df054269703e336a12a5941998a2609..e07e40154900f3d65a83b2a570131c338eadb609 100644 --- a/net/sixlowpan/sixlowpan_internal.h +++ b/net/sixlowpan/sixlowpan_internal.h @@ -319,7 +319,7 @@ int sixlowpan_meta_data(FAR struct radio_driver_s *radio, * determine what the size of the IEEE802.15.4 header will be. No frame * buffer is required to make this determination. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * meta - obfuscated meta data that describes the MAC header * @@ -341,7 +341,7 @@ int sixlowpan_frame_hdrlen(FAR struct radio_driver_s *radio, * new incoming frame and the network responds with an outgoing packet. It * submits any new outgoing frame to the MAC. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * meta - Obfuscated metadata that describes the MAC header * frame - The IOB containing the frame to be submitted. @@ -471,7 +471,7 @@ int sixlowpan_compresshdr_hc06(FAR struct radio_driver_s *radio, * decompression, g_frame_hdrlen and g_uncompressed_hdrlen are set to the * appropriate values * - * Input Parmeters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Obfuscated MAC metadata including node addressing * information. @@ -506,7 +506,7 @@ void sixlowpan_uncompresshdr_hc06(FAR struct radio_driver_s *radio, * 6lowpan packet in the packetbuf buffer from a full IPv6 packet in the * uip_buf buffer. * - * Input Parmeters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * ipv6 - The IPv6 header to be compressed * destmac - L2 destination address, needed to compress the IP @@ -629,7 +629,7 @@ bool sixlowpan_ismacbased(const net_ipv6addr_t ipaddr, * Description: * Get the maximum frame length supported by radio network drvier. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * * Returned Value: @@ -646,7 +646,7 @@ int sixlowpan_radio_framelen(FAR struct radio_driver_s *radio); * Description: * Get the source PAN ID from the IEEE802.15.4 radio. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * panid - The location in which to return the PAN ID. 0xfff may be * returned if the device is not associated. @@ -668,7 +668,7 @@ int sixlowpan_src_panid(FAR struct radio_driver_s *radio, * Extract the source MAC address from the radio-specific RX metadata, and * return the source address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * srcaddr - The location in which to return the source MAC address. @@ -689,7 +689,7 @@ int sixlowpan_extract_srcaddr(FAR struct radio_driver_s *radio, * Extract the destination MAC address from the radio-specific RX metadata, * and return the destination address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * destaddr - The location in which to return the destination MAC address. @@ -713,10 +713,10 @@ int sixlowpan_extract_destaddr(FAR struct radio_driver_s *radio, * * Called only once during network initialization. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -734,11 +734,11 @@ void sixlowpan_reass_initialize(void); * list. If that the list is empty, then the reassembly buffer structure * will be allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag for subsequent lookup. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the allocated reass structure. All fields used by the * reasembly logic have been zeroed. On a failure to allocate, NULL is * returned. @@ -759,11 +759,11 @@ FAR struct sixlowpan_reassbuf_s * * Find a previously allocated, active reassembly buffer with the specified * reassembly tag. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag to match. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the matching reass structure. * * Assumptions: @@ -784,10 +784,10 @@ FAR struct sixlowpan_reassbuf_s * * structure. If the reass structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * reass - reass structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/sixlowpan/sixlowpan_reassbuf.c b/net/sixlowpan/sixlowpan_reassbuf.c index c3ae7eeb8044152b84f3abf30a6bf1037a1f0a71..13b57fa0b9ec06a0c0886a3148f807d0abb706f4 100644 --- a/net/sixlowpan/sixlowpan_reassbuf.c +++ b/net/sixlowpan/sixlowpan_reassbuf.c @@ -121,10 +121,10 @@ static bool sixlowpan_compare_fragsrc(FAR struct sixlowpan_reassbuf_s *reass, * Description: * Free all expired or inactive reassembly buffers. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -177,10 +177,10 @@ static void sixlowpan_reass_expire(void) * Description: * Remove a reassembly buffer from the active reassembly buffer list. * - * Inputs: + * Input Parameters: * reass - The reassembly buffer to be removed. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -234,10 +234,10 @@ static void sixlowpan_remove_active(FAR struct sixlowpan_reassbuf_s *reass) * * Called only once during network initialization. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -276,11 +276,11 @@ void sixlowpan_reass_initialize(void) * list. If that the list is empty, then the reassembly buffer structure * will be allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag for subsequent lookup. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the allocated reass structure. All fields used by the * reasembly logic have been zeroed. On a failure to allocate, NULL is * returned. @@ -355,11 +355,11 @@ FAR struct sixlowpan_reassbuf_s * * Find a previously allocated, active reassembly buffer with the specified * reassembly tag. * - * Inputs: + * Input Parameters: * reasstag - The reassembly tag to match. * fragsrc - The source address of the fragment. * - * Return Value: + * Returned Value: * A reference to the matching reass structure. * * Assumptions: @@ -411,10 +411,10 @@ FAR struct sixlowpan_reassbuf_s * * structure. If the reass structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * reass - reass structure to free * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/net/sixlowpan/sixlowpan_send.c b/net/sixlowpan/sixlowpan_send.c index b8fceb8958d66f52c47925586ad6e83e81223572..3deb9d5b1cd9e3b05b1d3073f0e8776352c1aff0 100644 --- a/net/sixlowpan/sixlowpan_send.c +++ b/net/sixlowpan/sixlowpan_send.c @@ -141,7 +141,7 @@ static inline bool send_timeout(FAR struct sixlowpan_send_s *sinfo) * This function is called from the interrupt level to perform the actual * send operation when polled by the lower, device interfacing layer. * - * Input Parmeters + * Input Parameters: * dev - The structure of the network driver that caused the interrupt * conn - The connection structure associated with the socket * flags - Set of events describing why the callback was invoked diff --git a/net/sixlowpan/sixlowpan_tcpsend.c b/net/sixlowpan/sixlowpan_tcpsend.c index df7eab7971c16b08170db0ed016dc1b466eccf04..bc2085c498eeac1731549602913bd81a69b9d8cd 100644 --- a/net/sixlowpan/sixlowpan_tcpsend.c +++ b/net/sixlowpan/sixlowpan_tcpsend.c @@ -178,7 +178,7 @@ static uint16_t sixlowpan_tcp_chksum(FAR const struct ipv6tcp_hdr_s *ipv6tcp, * Description: * sixlowpan_tcp_header() will construct the IPv6 and TCP headers * - * Input Parmeters + * Input Parameters: * conn - An instance of the TCP connection structure. * dev - The network device that will route the packet * buf - Data to send @@ -328,7 +328,7 @@ static inline bool send_timeout(FAR struct sixlowpan_send_s *sinfo) * This function is called from the interrupt level to perform the actual * TCP send operation when polled by the lower, device interfacing layer. * - * Input Parmeters + * Input Parameters: * dev - The structure of the network driver that caused the interrupt * pvconn - The connection structure associated with the socket * pvpriv - The interrupt handler's private data argument @@ -745,7 +745,7 @@ static int sixlowpan_send_packet(FAR struct socket *psock, * psock_6lowpan_tcp_send() call may be used only when the TCP socket is in a * connected state (so that the intended recipient is known). * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * bulen - Length of data to send @@ -898,7 +898,7 @@ ssize_t psock_6lowpan_tcp_send(FAR struct socket *psock, FAR const void *buf, * driver. Under those conditions, this function will be called to create * the IEEE80215.4 frames. * - * Input Parmeters + * Input Parameters: * dev - The network device containing the packet to be sent. * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_udpsend.c b/net/sixlowpan/sixlowpan_udpsend.c index e2f115eb09064843baf85fdbf38d02d5b41f65b4..6f99f31b7c696ad24a1b338eb2e9a4ccd584c8ff 100644 --- a/net/sixlowpan/sixlowpan_udpsend.c +++ b/net/sixlowpan/sixlowpan_udpsend.c @@ -136,7 +136,7 @@ static uint16_t sixlowpan_udp_chksum(FAR const struct ipv6udp_hdr_s *ipv6udp, * may be returned when they are not NULL and 0), and the error ENOTCONN is * returned when the socket was not actually connected. * - * Input Parmeters + * Input Parameters: * psock A pointer to a NuttX-specific, internal socket structure * buf Data to send * buflen Length of data to send @@ -337,7 +337,7 @@ ssize_t psock_6lowpan_udp_sendto(FAR struct socket *psock, * psock_6lowpan_udp_send() call may be used with connectionlesss UDP * sockets. * - * Input Parmeters + * Input Parameters: * psock - An instance of the internal socket structure. * buf - Data to send * buflen - Length of data to send @@ -413,7 +413,7 @@ ssize_t psock_6lowpan_udp_send(FAR struct socket *psock, FAR const void *buf, * Handles forwarding a UDP packet via 6LoWPAN. This is currently only * used by the IPv6 forwarding logic. * - * Input Parmeters + * Input Parameters: * dev - An instance of nework device state structure * fwddev - The network device used to send the data. This will be the * same device except for the IP forwarding case where packets diff --git a/net/sixlowpan/sixlowpan_utils.c b/net/sixlowpan/sixlowpan_utils.c index 696503b5a9398d168ff30c68fefe6de9011df66b..644ad1484e136ae1e0badc406047204435983e80 100644 --- a/net/sixlowpan/sixlowpan_utils.c +++ b/net/sixlowpan/sixlowpan_utils.c @@ -573,7 +573,7 @@ bool sixlowpan_ismacbased(const net_ipv6addr_t ipaddr, * Description: * Get the maximum frame length supported by radio network drvier. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * * Returned Value: @@ -607,7 +607,7 @@ int sixlowpan_radio_framelen(FAR struct radio_driver_s *radio) * Description: * Get the source PAN ID from the IEEE802.15.4 MAC layer. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * panid - The location in which to return the PAN ID. 0xfff may be * returned if the device is not associated. @@ -647,7 +647,7 @@ int sixlowpan_src_panid(FAR struct radio_driver_s *radio, * Extract the source MAC address from the radio-specific RX metadata, and * return the source address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * srcaddr - The location in which to return the source MAC address. @@ -714,7 +714,7 @@ int sixlowpan_extract_srcaddr(FAR struct radio_driver_s *radio, * Extract the destination MAC address from the radio-specific RX metadata, * and return the destination address in a radio-agnostic form. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * metadata - Opaque reference to the radio-specific RX metadata. * destaddr - The location in which to return the destination MAC address. diff --git a/net/tcp/tcp.h b/net/tcp/tcp.h index bfd402c00a1f892f842fcfe88e5c7ec919747b4a..13ab0d803d8a2c70def5cc65c52fde573919f917 100644 --- a/net/tcp/tcp.h +++ b/net/tcp/tcp.h @@ -480,7 +480,7 @@ FAR struct tcp_conn_s *tcp_alloc_accept(FAR struct net_driver_s *dev, * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: @@ -727,7 +727,7 @@ void tcp_nextsequence(void); * dev - The device driver structure to use in the send operation * conn - The TCP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: @@ -748,7 +748,7 @@ void tcp_poll(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn); * conn - The TCP "connection" to poll for TX data * hsec - The polling interval in halves of a second * - * Return: + * Returned Value: * None * * Assumptions: @@ -859,7 +859,7 @@ int tcp_accept_connection(FAR struct net_driver_s *dev, * flags - flags to apply to the TCP header * len - length of the message * - * Return: + * Returned Value: * None * * Assumptions: @@ -904,7 +904,7 @@ ssize_t tcp_sendfile(FAR struct socket *psock, FAR struct file *infile, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -925,7 +925,7 @@ void tcp_reset(FAR struct net_driver_s *dev); * conn - The TCP connection structure holding connection information * ack - The ACK response to send * - * Return: + * Returned Value: * None * * Assumptions: @@ -949,7 +949,7 @@ void tcp_ack(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: @@ -971,7 +971,7 @@ void tcp_appsend(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: @@ -991,7 +991,7 @@ void tcp_rexmit(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: @@ -1012,7 +1012,7 @@ void tcp_ipv4_input(FAR struct net_driver_s *dev); * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: @@ -1053,7 +1053,7 @@ uint16_t tcp_callback(FAR struct net_driver_s *dev, * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * @@ -1320,7 +1320,7 @@ void tcp_wrbuffer_initialize(void); * the free list. This function is called from TCP logic when a buffer * of TCP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: diff --git a/net/tcp/tcp_appsend.c b/net/tcp/tcp_appsend.c index 7ee1f06779a980dc054717767ffbbfea430c4d7d..b87c679b6e6e94a4564c75939f24ec465abc71b5 100644 --- a/net/tcp/tcp_appsend.c +++ b/net/tcp/tcp_appsend.c @@ -72,7 +72,7 @@ * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: @@ -197,7 +197,7 @@ void tcp_appsend(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * conn - The TCP connection structure holding connection information * result - App result event sent * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_callback.c b/net/tcp/tcp_callback.c index dcc16927b9d20f9bc80ad9c782b0edb542d1528c..a43af2fb90165e8713f98f38e2d9b2a8d3795a53 100644 --- a/net/tcp/tcp_callback.c +++ b/net/tcp/tcp_callback.c @@ -218,7 +218,7 @@ uint16_t tcp_callback(FAR struct net_driver_s *dev, * buffers * buflen - The number of bytes to copy to the read-ahead buffer. * - * Returned value: + * Returned Value: * The number of bytes actually buffered is returned. This will be either * zero or equal to buflen; partial packets are not buffered. * diff --git a/net/tcp/tcp_conn.c b/net/tcp/tcp_conn.c index 43282501ea2f8a63ffd4036ccaddd161d31ff4f2..0c125d47178e66db3bdc2c94be1abbcc5df176a2 100644 --- a/net/tcp/tcp_conn.c +++ b/net/tcp/tcp_conn.c @@ -243,7 +243,7 @@ static FAR struct tcp_conn_s * * portno -- the selected port number in host order. Zero means no port * selected. * - * Return: + * Returned Value: * Selected or verified port number in host order on success, a negated * errno on failure: * @@ -445,7 +445,7 @@ static inline FAR struct tcp_conn_s * * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: @@ -510,7 +510,7 @@ static inline int tcp_ipv4_bind(FAR struct tcp_conn_s *conn, * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: @@ -1039,7 +1039,7 @@ FAR struct tcp_conn_s *tcp_alloc_accept(FAR struct net_driver_s *dev, * This function implements the lower level parts of the standard TCP * bind() operation. * - * Return: + * Returned Value: * 0 on success or -EADDRINUSE on failure * * Assumptions: diff --git a/net/tcp/tcp_devpoll.c b/net/tcp/tcp_devpoll.c index ee00d7f7d13807a28707c9e095ad3c9ce196f3d9..8097f442f4014956509279da448d533a0b54c5e6 100644 --- a/net/tcp/tcp_devpoll.c +++ b/net/tcp/tcp_devpoll.c @@ -70,7 +70,7 @@ * dev - The device driver structure to use in the send operation * conn - The TCP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_input.c b/net/tcp/tcp_input.c index b78a819fc03142277849c8495ed52dd38f9367ad..015374aa2c715a2b98ea06d9eb35c8c6ef84bc36 100644 --- a/net/tcp/tcp_input.c +++ b/net/tcp/tcp_input.c @@ -76,7 +76,7 @@ * domain - IP domain (PF_INET or PF_INET6) * iplen - Lngth of the IP header (IPv4_HDRLEN or IPv6_HDRLEN). * - * Return: + * Returned Value: * None * * Assumptions: @@ -947,7 +947,7 @@ drop: * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: @@ -977,7 +977,7 @@ void tcp_ipv4_input(FAR struct net_driver_s *dev) * Parameters: * dev - The device driver structure containing the received TCP packet. * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_send.c b/net/tcp/tcp_send.c index b4e833aa9b023dc4e432079d3d6375d44fd902bb..def99b137fb0954c5c506956d2ae78d64e129062 100644 --- a/net/tcp/tcp_send.c +++ b/net/tcp/tcp_send.c @@ -86,7 +86,7 @@ * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * The length of the IP header (IPv4_HDRLEN or IPv6_HDRLEN) * ****************************************************************************/ @@ -122,7 +122,7 @@ static inline FAR struct tcp_hdr_s *tcp_header(FAR struct net_driver_s *dev) * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -190,7 +190,7 @@ static inline void tcp_ipv4_sendcomplete(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -253,7 +253,7 @@ static inline void tcp_ipv6_sendcomplete(FAR struct net_driver_s *dev, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -301,7 +301,7 @@ static void tcp_sendcomplete(FAR struct net_driver_s *dev, * dev - The device driver structure to use in the send operation * conn - The TCP connection structure holding connection information * - * Return: + * Returned Value: * None * * Assumptions: @@ -403,7 +403,7 @@ static void tcp_sendcommon(FAR struct net_driver_s *dev, * len - length of the message (includes the length of the IP and TCP * headers) * - * Return: + * Returned Value: * None * * Assumptions: @@ -431,7 +431,7 @@ void tcp_send(FAR struct net_driver_s *dev, FAR struct tcp_conn_s *conn, * Parameters: * dev - The device driver structure to use in the send operation * - * Return: + * Returned Value: * None * * Assumptions: @@ -548,7 +548,7 @@ void tcp_reset(FAR struct net_driver_s *dev) * conn - The TCP connection structure holding connection information * ack - The ACK response to send * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_timer.c b/net/tcp/tcp_timer.c index b5f5ffb5abb6c1b24d42c2a252146fc504fed733..a5812140f3d62750bb3d03851bcb401a1efc91b2 100644 --- a/net/tcp/tcp_timer.c +++ b/net/tcp/tcp_timer.c @@ -72,7 +72,7 @@ * conn - The TCP "connection" to poll for TX data * hsed - The polling interval in halves of a second * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/tcp/tcp_wrbuffer.c b/net/tcp/tcp_wrbuffer.c index 6553d34f20a132c29865f6cde782eac2193f3c0b..643d99070865dbfd673a5bc9b880f126d78d481c 100644 --- a/net/tcp/tcp_wrbuffer.c +++ b/net/tcp/tcp_wrbuffer.c @@ -125,7 +125,7 @@ void tcp_wrbuffer_initialize(void) * the free list. This function is called from TCP logic when a buffer * of TCP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: diff --git a/net/udp/udp.h b/net/udp/udp.h index 24be51dc21e1b74a67b7de2f89c234141d2ffefe..315c0bfed0aedf4d2d816405eb20ec60b18d8b39 100644 --- a/net/udp/udp.h +++ b/net/udp/udp.h @@ -301,7 +301,7 @@ void udp_ipv6_select(FAR struct net_driver_s *dev); * dev - The device driver structure to use in the send operation * conn - The UDP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: @@ -321,7 +321,7 @@ void udp_poll(FAR struct net_driver_s *dev, FAR struct udp_conn_s *conn); * dev - The device driver structure to use in the send operation * conn - The UDP "connection" structure holding port information * - * Return: + * Returned Value: * None * * Assumptions: @@ -354,7 +354,7 @@ void udp_wrbuffer_initialize(void); * the free list. This function is called from UDP logic when a buffer * of UDP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: @@ -426,7 +426,7 @@ void udp_wrbuffer_dump(FAR const char *msg, FAR struct udp_wrbuffer_s *wrb, * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. @@ -449,7 +449,7 @@ int udp_ipv4_input(FAR struct net_driver_s *dev); * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. diff --git a/net/udp/udp_conn.c b/net/udp/udp_conn.c index 61e67028f64c55c153bcd98ab0decc8720775bb1..d301b3654320379e4805d466709721b872d3be7a 100644 --- a/net/udp/udp_conn.c +++ b/net/udp/udp_conn.c @@ -203,7 +203,7 @@ static FAR struct udp_conn_s *udp_find_conn(uint8_t domain, * Input Parameters: * None * - * Return: + * Returned Value: * Next available port number * ****************************************************************************/ diff --git a/net/udp/udp_devpoll.c b/net/udp/udp_devpoll.c index 9b6de1a0a0bd56b3ca568677a224321ba3b50015..e23dd6830166534a35c1eeeb7144d8234bf88b5b 100644 --- a/net/udp/udp_devpoll.c +++ b/net/udp/udp_devpoll.c @@ -68,7 +68,7 @@ * dev - The device driver structure to use in the send operation * conn - The UDP "connection" to poll for TX data * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/udp/udp_input.c b/net/udp/udp_input.c index 081dc26b06232ff146228da7014f43bf11cff08c..dffd3be129be0df79745b92cd0afc28407f93198 100644 --- a/net/udp/udp_input.c +++ b/net/udp/udp_input.c @@ -71,7 +71,7 @@ * udp - A pointer to the UDP header in the packet * iplen - Length of the IP and UDP headers * - * Return: + * Returned Value: * OK - The packet has been processed and can be deleted * ERROR - Hold the packet and try again later. There is a listening * socket but no receive in place to catch the packet yet. The @@ -241,7 +241,7 @@ static int udp_input(FAR struct net_driver_s *dev, unsigned int iplen) * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. @@ -273,7 +273,7 @@ int udp_ipv4_input(FAR struct net_driver_s *dev) * Parameters: * dev - The device driver structure containing the received UDP packet * - * Return: + * Returned Value: * OK The packet has been processed and can be deleted * ERROR Hold the packet and try again later. There is a listening socket * but no receive in place to catch the packet yet. diff --git a/net/udp/udp_send.c b/net/udp/udp_send.c index 7779d038759ef89b2345d62be63ccef3febb008b..46a9b3e86d41d1aecf94f9035878d5f5c90d9e50 100644 --- a/net/udp/udp_send.c +++ b/net/udp/udp_send.c @@ -89,7 +89,7 @@ * dev - The device driver structure to use in the send operation * conn - The UDP "connection" structure holding port information * - * Return: + * Returned Value: * None * * Assumptions: diff --git a/net/udp/udp_wrbuffer.c b/net/udp/udp_wrbuffer.c index ae8fafd7ffb1b9c876951ff6f64b57c73a729a0d..5e0eca867795d5b804aee1d30e6066f2a5b64c4b 100644 --- a/net/udp/udp_wrbuffer.c +++ b/net/udp/udp_wrbuffer.c @@ -124,7 +124,7 @@ void udp_wrbuffer_initialize(void) * the free list. This function is called from UDP logic when a buffer * of UDP data is about to sent * - * Input parameters: + * Input Parameters: * None * * Assumptions: diff --git a/net/utils/net_ipv6_mask2pref.c b/net/utils/net_ipv6_mask2pref.c index cc4fd245c85106d3d95a0d93b0930ebccf3a388f..95b1b2000a04a81e7a1767fec084e3299a2aa092 100644 --- a/net/utils/net_ipv6_mask2pref.c +++ b/net/utils/net_ipv6_mask2pref.c @@ -152,7 +152,7 @@ static inline uint8_t net_msbits16(uint16_t hword) * Parameters: * mask Points to an IPv6 netmask in the form of uint16_t[8] * - * Return: + * Returned Value: * The prefix length, range 0-128 on success; This function will not * fail. * diff --git a/net/utils/net_lock.c b/net/utils/net_lock.c index fff004bd3fe7895a109d33d08e90625c7299a62d..3cfad414d694bda8ff3de3ba3e6a8d155c4a3d85 100644 --- a/net/utils/net_lock.c +++ b/net/utils/net_lock.c @@ -124,7 +124,7 @@ void net_lockinitialize(void) * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -163,7 +163,7 @@ void net_lock(void) * Input Parameters: * None * - * Returned value: + * Returned Value: * None * ****************************************************************************/ @@ -201,7 +201,7 @@ void net_unlock(void) * sem - A reference to the semaphore to be taken. * abstime - The absolute time to wait until a timeout is declared. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * @@ -265,7 +265,7 @@ int net_timedwait(sem_t *sem, FAR const struct timespec *abstime) * Input Parameters: * sem - A reference to the semaphore to be taken. * - * Returned value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is returned on * any failure. * diff --git a/net/utils/utils.h b/net/utils/utils.h index fc72447084e70d99a3e05323ce1219ae15614da5..81dac87c1547d51104eb2425b79a5bcd90c80d28 100644 --- a/net/utils/utils.h +++ b/net/utils/utils.h @@ -161,7 +161,7 @@ unsigned int net_timeval2dsec(FAR struct timeval *tv, * Parameters: * mask Points to an IPv6 netmask in the form of uint16_t[8] * - * Return: + * Returned Value: * The prefix length, range 0-128 on success; This function will not * fail. * diff --git a/sched/clock/clock_abstime2ticks.c b/sched/clock/clock_abstime2ticks.c index 25a4af540e0933094af7459ff1648287a9408f6d..4cfbea8b5b68b8988ee6870614b51be6191af16d 100644 --- a/sched/clock/clock_abstime2ticks.c +++ b/sched/clock/clock_abstime2ticks.c @@ -89,7 +89,7 @@ static long compare_timespec(FAR const struct timespec *a, * reltime - Convert this absolue time to system clock ticks. * ticks - Return the converted number of ticks here. * - * Return Value: + * Returned Value: * OK on success; A non-zero error number on failure; * * Assumptions: diff --git a/sched/clock/clock_dow.c b/sched/clock/clock_dow.c index c922e856bc2b4242f88e6aa121252065920c4722..41b7f8fafa36ac641f08f4525956f5062f4377c0 100644 --- a/sched/clock/clock_dow.c +++ b/sched/clock/clock_dow.c @@ -70,7 +70,7 @@ static const uint8_t g_lookup[12] = {2, 5, 7, 10, 12, 15, 17, 20, 23, 25, 28, 30 * month - 0 through 11 * day - 1 through 31 * - * Return Value: + * Returned Value: * The day of the week as days since Sunday: 0 = Sunday, 1 = Monday, etc. * * Assumptions: diff --git a/sched/clock/clock_initialize.c b/sched/clock/clock_initialize.c index 6edf41d90de6f4e30414979350f02c3920623424..6cdf1b3a81a9a6a8226325ccfb4a51d26c5bcb2a 100644 --- a/sched/clock/clock_initialize.c +++ b/sched/clock/clock_initialize.c @@ -275,7 +275,7 @@ void clock_initialize(void) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -314,7 +314,7 @@ void clock_synchronize(void) * Parameters: * rtc_diff: amount of time system-time is adjusted forward with RTC * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/clock/clock_systimer.c b/sched/clock/clock_systimer.c index e1d4440ab11296b7ca9a7198783a065f14825359..6334c5232bca7bd2e8c00b5c0017eeb3f4e5725b 100644 --- a/sched/clock/clock_systimer.c +++ b/sched/clock/clock_systimer.c @@ -72,7 +72,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * The current value of the system timer counter * * Assumptions: diff --git a/sched/clock/clock_systimespec.c b/sched/clock/clock_systimespec.c index 5d6009d0510fc1ab71da2d18f8a34db525ab7c19..bdab9b115b420b651aa648153d7786deae151116 100644 --- a/sched/clock/clock_systimespec.c +++ b/sched/clock/clock_systimespec.c @@ -62,7 +62,7 @@ * Parameters: * ts - Location to return the time * - * Return Value: + * Returned Value: * Current version always returns OK * * Assumptions: diff --git a/sched/clock/clock_ticks2time.c b/sched/clock/clock_ticks2time.c index 899ecd9818f6d7057c8eee218993384d96c59be2..0ea5295f57518f580036898639ccb896e62f2437 100644 --- a/sched/clock/clock_ticks2time.c +++ b/sched/clock/clock_ticks2time.c @@ -56,7 +56,7 @@ * ticks - The number of system time ticks to convert. * reltime - Return the converted system time here. * - * Return Value: + * Returned Value: * Always returns OK * * Assumptions: diff --git a/sched/clock/clock_time2ticks.c b/sched/clock/clock_time2ticks.c index 5f0bc28c40637a7ea95585cf6a5e8575efa7d82b..5f0cb36becfc1a5f3a90b14452bd0d654c581785 100644 --- a/sched/clock/clock_time2ticks.c +++ b/sched/clock/clock_time2ticks.c @@ -60,7 +60,7 @@ * reltime - Convert this relative time to system clock ticks. * ticks - Return the converted number of ticks here. * - * Return Value: + * Returned Value: * Always returns OK * * Assumptions: diff --git a/sched/clock/clock_timespec_add.c b/sched/clock/clock_timespec_add.c index 0e0fb931dbb8912473268393e0722d8e7a0780f5..08bf634d768da2a8b5657df1ee46437809759e39 100644 --- a/sched/clock/clock_timespec_add.c +++ b/sched/clock/clock_timespec_add.c @@ -54,11 +54,11 @@ * Description: * Add timespec ts1 to to2 and return the result in ts3 * - * Inputs: + * Input Parameters: * ts1 and ts2: The two timespecs to be added * t23: The location to return the result (may be ts1 or ts2) * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/clock/clock_timespec_subtract.c b/sched/clock/clock_timespec_subtract.c index 754c84d1cb57df1c4a0dbe75e11ca4dbca79a637..873dd75d7cc881db03d449531118171d1947317e 100644 --- a/sched/clock/clock_timespec_subtract.c +++ b/sched/clock/clock_timespec_subtract.c @@ -55,11 +55,11 @@ * Subtract timespec ts2 from to1 and return the result in ts3. * Zero is returned if the time difference is negative. * - * Inputs: + * Input Parameters: * ts1 and ts2: The two timespecs to be subtracted (ts1 - ts2) * t23: The location to return the result (may be ts1 or ts2) * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/environ/env_clearenv.c b/sched/environ/env_clearenv.c index ededbadbed13173995950b30cae79df3a5b0cc66..97aee7e230c619beda88fa264cbbc962ed13f9b6 100644 --- a/sched/environ/env_clearenv.c +++ b/sched/environ/env_clearenv.c @@ -60,7 +60,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/environ/env_dup.c b/sched/environ/env_dup.c index 08b0e1b6179e3758306d643e2672e3697a3b8043..5544c1faf687a12bbb4bb158f90820f735286c53 100644 --- a/sched/environ/env_dup.c +++ b/sched/environ/env_dup.c @@ -67,7 +67,7 @@ * group The child task group to receive the newly allocated copy of the * parent task groups environment structure. * - * Return Value: + * Returned Value: * zero on success * * Assumptions: diff --git a/sched/environ/env_findvar.c b/sched/environ/env_findvar.c index f6b44da5c497c26a63fcc2c9aabeb73b743f3d78..953aefebf3938fe96887f3b3e53b9f1f88945323 100644 --- a/sched/environ/env_findvar.c +++ b/sched/environ/env_findvar.c @@ -86,7 +86,7 @@ static bool env_cmpname(const char *pszname, const char *peqname) * group The task group containging environment array to be searched. * pname The variable name to find * - * Return Value: + * Returned Value: * A pointer to the name=value string in the environment * * Assumptions: diff --git a/sched/environ/env_getenv.c b/sched/environ/env_getenv.c index 6e92f90d3f14bc5d5cb42a26b400e7889caa715f..be20805204aa15b64fb75219c3b3023ebf84922f 100644 --- a/sched/environ/env_getenv.c +++ b/sched/environ/env_getenv.c @@ -63,7 +63,7 @@ * Parameters: * name - The name of the variable to find. * - * Return Value: + * Returned Value: * The value of the valiable (read-only) or NULL on failure * * Assumptions: diff --git a/sched/environ/env_getenvironptr.c b/sched/environ/env_getenvironptr.c index 11c4f5368e11328884ca5cf62d334bad70625520..43f7a2cfcf68302fd0a803e149dd990828306055 100644 --- a/sched/environ/env_getenvironptr.c +++ b/sched/environ/env_getenvironptr.c @@ -60,7 +60,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the per-thread environ variable. * * Assumptions: diff --git a/sched/environ/env_putenv.c b/sched/environ/env_putenv.c index ec683b298c000868fce894da2f76ee61cb5fe108..f54dea241f1e25e53bd78ec740ea95272df03b4d 100644 --- a/sched/environ/env_putenv.c +++ b/sched/environ/env_putenv.c @@ -65,7 +65,7 @@ * Parameters: * name=value string describing the environment setting to add/modify * - * Return Value: + * Returned Value: * Zero on sucess * * Assumptions: diff --git a/sched/environ/env_release.c b/sched/environ/env_release.c index d1ace0505b0ebb0ce338eb75e82840fc3d0f5129..fd9bdfd31208f7eda6b38d831342a8ccee04d2da 100644 --- a/sched/environ/env_release.c +++ b/sched/environ/env_release.c @@ -65,7 +65,7 @@ * group Identifies the task group containing the environment structure * to be released. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/environ/env_removevar.c b/sched/environ/env_removevar.c index b18ebbf899c7633f321c3ec59232b3b7f96f3ddb..197357ea08684fe6ab25c4ba512ecdf8326dfe18 100644 --- a/sched/environ/env_removevar.c +++ b/sched/environ/env_removevar.c @@ -60,7 +60,7 @@ * group The task group with the environment containing the name=value pair * pvar A pointer to the name=value pair in the restroom * - * Return Value: + * Returned Value: * Zero on success * * Assumptions: diff --git a/sched/environ/env_setenv.c b/sched/environ/env_setenv.c index 38faae839a8fb87e7706b9c507912833587c7cb0..96cd06ac4ce94137a1ccbe47c855bb4944f7ef6f 100644 --- a/sched/environ/env_setenv.c +++ b/sched/environ/env_setenv.c @@ -71,7 +71,7 @@ * value - The new value of the variable * overwrite - Replace any existing value if non-zero. * - * Return Value: + * Returned Value: * Zero on success * * Assumptions: diff --git a/sched/environ/env_unsetenv.c b/sched/environ/env_unsetenv.c index 2956cfe783c5f2be3c00b0e388f9cace351fdcab..fa85358abfdf5fff14cfadac5f4107d88f82e541 100644 --- a/sched/environ/env_unsetenv.c +++ b/sched/environ/env_unsetenv.c @@ -63,7 +63,7 @@ * Parameters: * name - The name of the variable to delete * - * Return Value: + * Returned Value: * Zero on success * * Assumptions: diff --git a/sched/errno/errno_get.c b/sched/errno/errno_get.c index 8982ac61e735f659f0e453f32c13e83bc1e8d4e5..3664a3e054cb0fc17f66eb3bdc44660d9deb9a78 100644 --- a/sched/errno/errno_get.c +++ b/sched/errno/errno_get.c @@ -65,7 +65,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * The current value of the thread specific errno. * * Assumptions: diff --git a/sched/errno/errno_getptr.c b/sched/errno/errno_getptr.c index 4e47895a0b4eda981427a7bfb3c2e917b01f5cc9..4d220db23d99d7471c4e243de561f5521a94d911 100644 --- a/sched/errno/errno_getptr.c +++ b/sched/errno/errno_getptr.c @@ -75,7 +75,7 @@ static int g_irqerrno; * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the per-thread errno variable. * * Assumptions: diff --git a/sched/errno/errno_set.c b/sched/errno/errno_set.c index 540bc8b7829f2249862198779c71b8e83c608ca3..a7a00af67ac8d4ce75b44f32a1f83cc11a5f4faf 100644 --- a/sched/errno/errno_set.c +++ b/sched/errno/errno_set.c @@ -64,7 +64,7 @@ * Parameters: * errcode - The thread specific errno will be set to this error code value. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/group/group_addrenv.c b/sched/group/group_addrenv.c index 52330c04cc7ae36c0d28b503e50a46531f281c1b..bc301c9b43443c63492de8f4c547dca2e0bf0f3d 100644 --- a/sched/group/group_addrenv.c +++ b/sched/group/group_addrenv.c @@ -82,7 +82,7 @@ gid_t g_gid_current; * be the TCB at the head of the ready-to-run list, but that is not * enough. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success. A negated errno value is returned on * any failure. * diff --git a/sched/group/group_childstatus.c b/sched/group/group_childstatus.c index e4e994677d1faacfdc37597c3476595e0f6645f5..915c1c9a96dda69daff8a4ca7536e63806fd4547 100644 --- a/sched/group/group_childstatus.c +++ b/sched/group/group_childstatus.c @@ -100,7 +100,7 @@ static struct child_pool_s g_child_pool; * Parameters: * group - The task group containing the child status. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -140,7 +140,7 @@ static void group_dumpchildren(FAR struct task_group_s *group, * Parameters: * None. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -176,7 +176,7 @@ void task_initialize(void) * Parameters: * None. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure. NULL is * returned if there are no remaining, pre-allocated child status structures. * @@ -211,7 +211,7 @@ FAR struct child_status_s *group_allocchild(void) * Parameters: * status - The child status structure to be freed. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -241,7 +241,7 @@ void group_freechild(FAR struct child_status_s *child) * group - The task group for the child status. * child - The structure to be added * - * Return Value: + * Returned Value: * N * * Assumptions: @@ -273,7 +273,7 @@ void group_addchild(FAR struct task_group_s *group, * group - The ID of the parent task group to containing the child status. * pid - The ID of the child to find. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure. NULL is * returned if there is child status structure for that pid in the TCB. * @@ -312,7 +312,7 @@ FAR struct child_status_s *group_findchild(FAR struct task_group_s *group, * Parameters: * tcb - The TCB of the parent task to containing the child status. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure for the * exited child. NULL is returned if not child has exited. * @@ -351,7 +351,7 @@ FAR struct child_status_s *group_exitchild(FAR struct task_group_s *group) * group - The task group containing the child status. * pid - The ID of the child to find. * - * Return Value: + * Returned Value: * On success, a non-NULL pointer to a child status structure. NULL is * returned if there is child status structure for that pid in the TCB. * @@ -412,7 +412,7 @@ FAR struct child_status_s *group_removechild(FAR struct task_group_s *group, * Parameters: * group - The task group containing the child status. * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/group/group_create.c b/sched/group/group_create.c index 0cb29b4e2e2b0a7203b11116d7516ebe28f0ee6b..29ca989ca6f46643c08b55480038b7a47c9b5394 100644 --- a/sched/group/group_create.c +++ b/sched/group/group_create.c @@ -92,7 +92,7 @@ FAR struct task_group_s *g_grouphead; * Parameters: * tcb - The tcb in need of the task group. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -165,7 +165,7 @@ static void group_assigngid(FAR struct task_group_s *group) * tcb - The tcb in need of the task group. * ttype - Type of the thread that is the parent of the group * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: @@ -274,7 +274,7 @@ int group_allocate(FAR struct task_tcb_s *tcb, uint8_t ttype) * Parameters: * tcb - The tcb in need of the task group. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: diff --git a/sched/group/group_find.c b/sched/group/group_find.c index 3db582fa25157337aa1fc76cb9063275d491f390..ade869dd013d6d1e659b51c27d96c633d6149044 100644 --- a/sched/group/group_find.c +++ b/sched/group/group_find.c @@ -68,7 +68,7 @@ * Parameters: * gid - The group ID to find. * - * Return Value: + * Returned Value: * On success, a pointer to the group task structure is returned. This * function can fail only if there is no group that corresponds to the * group ID. @@ -114,7 +114,7 @@ FAR struct task_group_s *group_findbygid(gid_t gid) * Parameters: * pid - The task ID of the main task thread. * - * Return Value: + * Returned Value: * On success, a pointer to the group task structure is returned. This * function can fail only if there is no group that corresponds to the * task ID. diff --git a/sched/group/group_foreachchild.c b/sched/group/group_foreachchild.c index 10fed5f90a5bb0d7209b34fc6e955ce59df4e6fc..5908d6a121be31f31bfe04ca9a7ead7ebc6d62de 100644 --- a/sched/group/group_foreachchild.c +++ b/sched/group/group_foreachchild.c @@ -60,7 +60,7 @@ * handler - The function to be called * arg - An additional argument to provide to the handler * - * Return Value: + * Returned Value: * Success (OK) is always returned unless the handler returns a non-zero * value (a negated errno on errors). In that case, the traversal * terminates and that non-zero value is returned. diff --git a/sched/group/group_join.c b/sched/group/group_join.c index 7fb2a817fa9f451ac018b893b557198f476638dd..1bb2fdfdeb1354ca6b432ebc652c3d7e9acf03f1 100644 --- a/sched/group/group_join.c +++ b/sched/group/group_join.c @@ -74,7 +74,7 @@ * group - The task group to add the new member * pid - The new member * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: @@ -152,7 +152,7 @@ static inline int group_addmember(FAR struct task_group_s *group, pid_t pid) * Parameters: * tcb - The TCB of the new "child" task that need to join the group. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: @@ -189,7 +189,7 @@ int group_bind(FAR struct pthread_tcb_s *tcb) * Parameters: * tcb - The TCB of the new "child" task that need to join the group. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: diff --git a/sched/group/group_killchildren.c b/sched/group/group_killchildren.c index 3b719a495c762ca3c35884aa821226feff5c70fc..aa4ae077b7d06ff883a7dc9fb3e148c9dc63e574 100644 --- a/sched/group/group_killchildren.c +++ b/sched/group/group_killchildren.c @@ -59,7 +59,7 @@ * pid - The ID of the group member that may be signalled. * arg - The PID of the thread to be retained. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -95,7 +95,7 @@ static int group_killchildren_handler(pid_t pid, FAR void *arg) * Parameters: * tcb - TCB of the task to be retained. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/group/group_leave.c b/sched/group/group_leave.c index 79a1bde1a103dca5fc8c6dfa0a394a65c5cae659..e20bb3bdd7c5b89128eff2197e4f6c8178ce23fc 100644 --- a/sched/group/group_leave.c +++ b/sched/group/group_leave.c @@ -70,7 +70,7 @@ * Parameters: * group - The group to be removed. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -129,7 +129,7 @@ static void group_remove(FAR struct task_group_s *group) * Parameters: * group - The group to be removed. * - * Return Value: + * Returned Value: * None. * * Assumptions: @@ -289,7 +289,7 @@ static inline void group_release(FAR struct task_group_s *group) * group - The group from which to remove the member. * pid - The member to be removed. * - * Return Value: + * Returned Value: * On success, returns the number of members remaining in the group (>=0). * Can fail only if the member is not found in the group. On failure, * returns -ENOENT @@ -346,7 +346,7 @@ static inline void group_removemember(FAR struct task_group_s *group, pid_t pid) * Parameters: * tcb - The TCB of the task that is exiting. * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/group/group_setupidlefiles.c b/sched/group/group_setupidlefiles.c index 0d4eb19ca29410a0e8ced572f04bf5cd502062d4..076017360d4feae83cf9952c9295243c6ec28e25 100644 --- a/sched/group/group_setupidlefiles.c +++ b/sched/group/group_setupidlefiles.c @@ -66,7 +66,7 @@ * Parameters: * tcb - tcb of the idle task. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/group/group_setuptaskfiles.c b/sched/group/group_setuptaskfiles.c index e1068712507d2ff90c89d531b8850ca901fae16c..1a1ec07963b09b36df7aeaa4c8926d5e78c5175f 100644 --- a/sched/group/group_setuptaskfiles.c +++ b/sched/group/group_setuptaskfiles.c @@ -79,7 +79,7 @@ * Input Parameters: * tcb - tcb of the new task. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -137,7 +137,7 @@ static inline void sched_dupfiles(FAR struct task_tcb_s *tcb) * Input Parameters: * tcb - tcb of the new task. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -198,7 +198,7 @@ static inline void sched_dupsockets(FAR struct task_tcb_s *tcb) * Parameters: * tcb - tcb of the new task. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned on * failure. * diff --git a/sched/group/group_signal.c b/sched/group/group_signal.c index f066fc7f5d71b58bc487ecf60ce50299d4ee0156..e0de4bcf648c83aca638d18a84c540b37e5d025d 100644 --- a/sched/group/group_signal.c +++ b/sched/group/group_signal.c @@ -80,7 +80,7 @@ struct group_signal_s * pid - The ID of the group member that may be signalled. * arg - A pointer to a struct group_signal_s instance. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * ****************************************************************************/ @@ -195,7 +195,7 @@ static int group_signal_handler(pid_t pid, FAR void *arg) * Parameters: * group - The task group that needs to be signalled. * - * Return Value: + * Returned Value: * 0 (OK) on success; a negated errno value on failure. * * Assumptions: diff --git a/sched/init/init.h b/sched/init/init.h index 4724c83392f37335e1184574f7c9dd11b4ea558b..b602786bc4fc55da4f34d51dbe4f767e8ad45a4b 100644 --- a/sched/init/init.h +++ b/sched/init/init.h @@ -57,7 +57,7 @@ * Input Parameters: * None * - * Returned value: + * Returned Value: * Does not return. * ****************************************************************************/ diff --git a/sched/init/os_start.c b/sched/init/os_start.c index 9033189e639c7418a7d62dcd0f35e7fc61dae407..0fcbd4ba48ce81d1e79e7771a57ea336ec68c23d 100644 --- a/sched/init/os_start.c +++ b/sched/init/os_start.c @@ -361,7 +361,7 @@ static FAR char *g_idleargv[1][2]; * Input Parameters: * None * - * Returned value: + * Returned Value: * Does not return. * ****************************************************************************/ diff --git a/sched/irq/irq.h b/sched/irq/irq.h index ac38158f3cc2136a5966f7836ba0c0a2839fc755..a51455f17506f8cfb56b8793832a3ecd2befb5cf 100644 --- a/sched/irq/irq.h +++ b/sched/irq/irq.h @@ -180,10 +180,10 @@ int irq_unexpected_isr(int irq, FAR void *context, FAR void *arg); * the IRQ lock is also set UNLESS the CPU starting the task is the * holder of the IRQ lock. * - * Inputs: + * Input Parameters: * rtcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true - IRQs are locked by a different CPU. * false - IRQs are unlocked OR if they are locked BUT this CPU * is the holder of the lock. diff --git a/sched/irq/irq_csection.c b/sched/irq/irq_csection.c index 63e0be9f66795c5e09618563870cc5eda4dade68..ca75810ca0696c3f5276a2d3c6a6e0fbbe3f6f5d 100644 --- a/sched/irq/irq_csection.c +++ b/sched/irq/irq_csection.c @@ -587,10 +587,10 @@ void leave_critical_section(irqstate_t flags) * the IRQ lock is also set UNLESS the CPU starting the task is the * holder of the IRQ lock. * - * Inputs: + * Input Parameters: * rtcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true - IRQs are locked by a different CPU. * false - IRQs are unlocked OR if they are locked BUT this CPU * is the holder of the lock. diff --git a/sched/mqueue/mq_desclose.c b/sched/mqueue/mq_desclose.c index b4c72c0e961f837205cfa57c5d276ef844f14f2c..c4a5d68f52e55d6190c6bf0bd875bcbf59797c54 100644 --- a/sched/mqueue/mq_desclose.c +++ b/sched/mqueue/mq_desclose.c @@ -60,7 +60,7 @@ * Description: * Deallocate a message queue descriptor but returning it to the free list * - * Inputs: + * Input Parameters: * mqdes - message queue descriptor to free * ****************************************************************************/ @@ -82,7 +82,7 @@ * mqdes - Message queue descriptor. * group - Group that has the open descriptor. * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/mqueue/mq_descreate.c b/sched/mqueue/mq_descreate.c index d3b574f6234f8a2266447cd3802de5c6529bb2a0..47dad5bd3bc32dc09f7028a72b6a0801d46d86f7 100644 --- a/sched/mqueue/mq_descreate.c +++ b/sched/mqueue/mq_descreate.c @@ -67,10 +67,10 @@ * Description: * Allocate a message queue descriptor. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * Reference to the allocated mq descriptor. * ****************************************************************************/ @@ -109,12 +109,12 @@ static mqd_t nxmq_alloc_des(void) * Description: * Create a message queue descriptor for the specified TCB * - * Inputs: + * Input Parameters: * mtcb - task that needs the descriptor. * msgq - Named message queue containing the message * oflags - access rights for the descriptor * - * Return Value: + * Returned Value: * On success, the message queue descriptor is returned. NULL is returned * on a failure to allocate. * diff --git a/sched/mqueue/mq_getattr.c b/sched/mqueue/mq_getattr.c index b1475b6846212fea50f4374c50a1e96e678bdbe6..2bcf0902a700c642c46f69e3fa7b622541b65ce7 100644 --- a/sched/mqueue/mq_getattr.c +++ b/sched/mqueue/mq_getattr.c @@ -57,7 +57,7 @@ * mqdes - Message queue descriptor * mq_stat - Buffer in which to return attributes * - * Return Value: + * Returned Value: * 0 (OK) if attributes provided, -1 (ERROR) otherwise. * * Assumptions: diff --git a/sched/mqueue/mq_initialize.c b/sched/mqueue/mq_initialize.c index 3e46ac2554274cbed235d34024d2ab46f139e120..46e820c9fce820cdeacfe9312222ca44fdfb121f 100644 --- a/sched/mqueue/mq_initialize.c +++ b/sched/mqueue/mq_initialize.c @@ -111,7 +111,7 @@ static sq_queue_t g_desalloc; * Description: * Allocate a block of messages and place them on the free list. * - * Inputs Parameters: + * Input Parameters: * queue * ****************************************************************************/ @@ -156,10 +156,10 @@ mq_msgblockalloc(FAR sq_queue_t *queue, uint16_t nmsgs, * be called early in the initialization sequence before any of the * other message interfaces execute. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -198,10 +198,10 @@ void nxmq_initialize(void) * Allocate a block of message descriptors and place them on the free * list. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_msgfree.c b/sched/mqueue/mq_msgfree.c index 9492a93d38736d2aa5f8eeb2c6656de522013484..4ea3735f73381c2a7e9e2cc005332b6cdbca8307 100644 --- a/sched/mqueue/mq_msgfree.c +++ b/sched/mqueue/mq_msgfree.c @@ -59,10 +59,10 @@ * messages if it was a pre-allocated message. If the message was * allocated dynamically it will be deallocated. * - * Inputs: + * Input Parameters: * mqmsg - message to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_msgqalloc.c b/sched/mqueue/mq_msgqalloc.c index 473896c3f28568ef676141265253a1f9c47879fc..becf7bd39439b597cf29156d40f35ba353d4bb9e 100644 --- a/sched/mqueue/mq_msgqalloc.c +++ b/sched/mqueue/mq_msgqalloc.c @@ -66,7 +66,7 @@ * queue is created to determine the maximum number of * messages that may be placed in the message queue. * - * Return Value: + * Returned Value: * The allocated and initialized message queue structure or NULL in the * event of a failure. * diff --git a/sched/mqueue/mq_msgqfree.c b/sched/mqueue/mq_msgqfree.c index b52494813e196eb83946b0b7fce57ae48a2f4196..54f858ced8778b83fc88c9591403bd4d0b9125fb 100644 --- a/sched/mqueue/mq_msgqfree.c +++ b/sched/mqueue/mq_msgqfree.c @@ -57,10 +57,10 @@ * closed so that no thread will attempt access it while it is being * deleted. * - * Inputs: + * Input Parameters: * msgq - Named essage queue to be freed * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_notify.c b/sched/mqueue/mq_notify.c index 8dd0e89080d3e1c12fc6762f43edb3667a7f4f41..3cf3d42278ae161746962be2e9941d9d96809f59 100644 --- a/sched/mqueue/mq_notify.c +++ b/sched/mqueue/mq_notify.c @@ -78,7 +78,7 @@ * sigev_signo - The signo to use for the notification * sigev_value - Value associated with the signal * - * Return Value: + * Returned Value: * On success mq_notify() returns 0; on error, -1 is returned, with * errno set to indicate the error. * diff --git a/sched/mqueue/mq_recover.c b/sched/mqueue/mq_recover.c index 087dc4d34178fb3794e0691195e60eef2c8d3197..b150c0a28b557380b0f1f2bbdff0fb6a8e42df64 100644 --- a/sched/mqueue/mq_recover.c +++ b/sched/mqueue/mq_recover.c @@ -58,10 +58,10 @@ * via pthread_cancel. I checks if the task was waiting for a message * queue event and adjusts counts appropriately. * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/mqueue/mq_release.c b/sched/mqueue/mq_release.c index c916c7b41dc591d5306659efd388e9331762955d..2e253b915b30e87d843ae3ab84a7deaa6204e3fc 100644 --- a/sched/mqueue/mq_release.c +++ b/sched/mqueue/mq_release.c @@ -55,10 +55,10 @@ * This function closes all of the message queues opened by members of * the task group. * - * Inputs: + * Input Parameters: * group - The task group that is terminating. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/mqueue/mq_setattr.c b/sched/mqueue/mq_setattr.c index de238e4601be0b945be1d799ed5beba5d58153a1..eb70f779de4f7f14942e9e7b2e7fee57857b77c6 100644 --- a/sched/mqueue/mq_setattr.c +++ b/sched/mqueue/mq_setattr.c @@ -65,7 +65,7 @@ * mq_stat - New attributes * oldstate - Old attributes * - * Return Value: + * Returned Value: * 0 (OK) if attributes are set successfully, otherwise * -1 (ERROR). * diff --git a/sched/mqueue/mq_sndinternal.c b/sched/mqueue/mq_sndinternal.c index 933d684a13ca2d1ff86dd3fe97eeb76e0e2e1e14..7ad32132cb216d115818a907520ccbb2d34d669c 100644 --- a/sched/mqueue/mq_sndinternal.c +++ b/sched/mqueue/mq_sndinternal.c @@ -131,7 +131,7 @@ int nxmq_verify_send(mqd_t mqdes, FAR const char *msg, size_t msglen, * the g_msgfreeirq list. If this is unsuccessful, the calling interrupt * handler will be notified. * - * Inputs: + * Input Parameters: * None * * Returned Value: diff --git a/sched/mqueue/mq_waitirq.c b/sched/mqueue/mq_waitirq.c index ee24c4d9f74fce1325952092fab566473e14659b..d542adc8af954da8bf38683409332b8057835f13 100644 --- a/sched/mqueue/mq_waitirq.c +++ b/sched/mqueue/mq_waitirq.c @@ -65,7 +65,7 @@ * wtcb - A pointer to the TCB of the task that is waiting on a message * queue, but has received a signal instead. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/paging/paging.h b/sched/paging/paging.h index cccda6e4ed94efefe8c3283fba98f1121bd0f02d..c7e253b421e0de589c7f73af100508173da2af58 100644 --- a/sched/paging/paging.h +++ b/sched/paging/paging.h @@ -107,7 +107,7 @@ extern FAR struct tcb_s *g_pftcb; * This is the entry point of the worker thread that performs the actual * page file. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: diff --git a/sched/paging/pg_worker.c b/sched/paging/pg_worker.c index a2ded4c1aef0ba8a107053e6f0a7a608e7586e5c..e6fe07b62a8318cc77abd5041ae8dbee408cf326 100644 --- a/sched/paging/pg_worker.c +++ b/sched/paging/pg_worker.c @@ -141,7 +141,7 @@ static systime_t g_starttime; * task that is waiting for a fill. * - Signal the page fill worker thread. * - * Input parameters: + * Input Parameters: * tcb - The TCB of the task that just received the fill. * result - The result of the page fill operation. * @@ -223,7 +223,7 @@ static void pg_callback(FAR struct tcb_s *tcb, int result) * The result (NULL or a TCB pointer) will be returned in the global * variable, g_pftcb. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -334,7 +334,7 @@ static inline bool pg_dequeue(void) * prioritized list, or (2) when a page fill completes and there are more * pages to be filled in g_waitingforfill list. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -441,7 +441,7 @@ static inline bool pg_startfill(void) * - Set g_pftcb to NULL. * - Restore the default priority of the page fill worker thread. * - * Input parameters: + * Input Parameters: * None. * * Returned Value: @@ -475,7 +475,7 @@ static inline void pg_alldone(void) * This function is just a dumb wrapper around up_unblocktask(). This * function simply makes the task that just received the fill ready-to-run. * - * Input parameters: + * Input Parameters: * None. * * Returned Value: @@ -515,7 +515,7 @@ static inline void pg_fillcomplete(void) * after completing a page fill. * - A configurable timeout with no activity. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: diff --git a/sched/pthread/pthread_cleanup.c b/sched/pthread/pthread_cleanup.c index a4f6e45b21904f54490a443ea9dc62a0420891d4..cbfc2558be0f127b196264479e7fbe5387468299 100644 --- a/sched/pthread/pthread_cleanup.c +++ b/sched/pthread/pthread_cleanup.c @@ -64,7 +64,7 @@ * Input Parameters: * tcb - The TCB of the pthread that is exiting or being canceled. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_completejoin.c b/sched/pthread/pthread_completejoin.c index 0b934c1033e9cf30996bcf56db79f99f7f921c3a..6dc23185c5d05951b3554f690c5e2609baedd723 100644 --- a/sched/pthread/pthread_completejoin.c +++ b/sched/pthread/pthread_completejoin.c @@ -115,7 +115,7 @@ static bool pthread_notifywaiters(FAR struct join_s *pjoin) * Parameters: * pid * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/pthread/pthread_condbroadcast.c b/sched/pthread/pthread_condbroadcast.c index 0fddd76927316f88e0becba422d1ce01a4a61563..5a19538882cdf71d36279e5d1a34c28d8e0eff15 100644 --- a/sched/pthread/pthread_condbroadcast.c +++ b/sched/pthread/pthread_condbroadcast.c @@ -59,7 +59,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_condsignal.c b/sched/pthread/pthread_condsignal.c index 5826a425de13caef01be0b591fd02665475dfc02..21eab53ec213cf5783fd924421bbcfb7bdf0c8c0 100644 --- a/sched/pthread/pthread_condsignal.c +++ b/sched/pthread/pthread_condsignal.c @@ -58,7 +58,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_condtimedwait.c b/sched/pthread/pthread_condtimedwait.c index 66410faebdefa01f094f4634d36de7f37df9996a..0093d3def31735f3c7c937ee793a4deac8424fbd 100644 --- a/sched/pthread/pthread_condtimedwait.c +++ b/sched/pthread/pthread_condtimedwait.c @@ -75,7 +75,7 @@ * pid - the task ID of the task to wakeup * signo - The signal to use to wake up the task * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -156,7 +156,7 @@ static void pthread_condtimedout(int argc, uint32_t pid, uint32_t signo) * mutex - the mutex that protects the condition variable * abstime - wait until this absolute time * - * Return Value: + * Returned Value: * OK (0) on success; A non-zero errno value is returned on failure. * * Assumptions: diff --git a/sched/pthread/pthread_condwait.c b/sched/pthread/pthread_condwait.c index b3716da0a6dd12ce774b3095a05cfe926fa095d6..734dc55bad374289b57f1367963c6b905644957e 100644 --- a/sched/pthread/pthread_condwait.c +++ b/sched/pthread/pthread_condwait.c @@ -62,7 +62,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_create.c b/sched/pthread/pthread_create.c index 4900574e1695aa8ade97753ccd0a399742c7c165..7f6f2ed2b271e87194c555790ce846b344e7de36 100644 --- a/sched/pthread/pthread_create.c +++ b/sched/pthread/pthread_create.c @@ -103,7 +103,7 @@ static const char g_pthreadname[] = ""; * tcb - Address of the new task's TCB * arg - The argument to provide to the pthread on startup. * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -133,7 +133,7 @@ static inline void pthread_argsetup(FAR struct pthread_tcb_s *tcb, pthread_addr_ * Parameters: * pjoin * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -232,7 +232,7 @@ static void pthread_start(void) * start_routine * arg * - * Returned value: + * Returned Value: * OK (0) on success; a (non-negated) errno value on failure. The errno * variable is not set. * diff --git a/sched/pthread/pthread_detach.c b/sched/pthread/pthread_detach.c index 47e0a3b42dca4feaaaa493cbcb545c40db5257bb..184f1642727e72eda3e117f74e92ee54d79f2584 100644 --- a/sched/pthread/pthread_detach.c +++ b/sched/pthread/pthread_detach.c @@ -68,7 +68,7 @@ * Parameters: * thread * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code. * * Assumptions: diff --git a/sched/pthread/pthread_findjoininfo.c b/sched/pthread/pthread_findjoininfo.c index 23fcc6a46d761e26e44bff7e7735aedc468cfd48..9ddc34cdd8f021418b3714906f9de45cab7339ef 100644 --- a/sched/pthread/pthread_findjoininfo.c +++ b/sched/pthread/pthread_findjoininfo.c @@ -58,7 +58,7 @@ * group - The that the pid is (or was) a member of of * pid - The ID of the pthread * - * Return Value: + * Returned Value: * None or pointer to the found entry. * * Assumptions: diff --git a/sched/pthread/pthread_getaffinity.c b/sched/pthread/pthread_getaffinity.c index 868fe7003d1d75e24598aed5420e9de19c52ffc3..d3eb4d9f8964b254c3db3a8aa72f965322dd004a 100644 --- a/sched/pthread/pthread_getaffinity.c +++ b/sched/pthread/pthread_getaffinity.c @@ -71,7 +71,7 @@ * cpusetsize - Size of cpuset. MUST be sizeofcpu_set_t(). * cpuset - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an errno value is returned indicating the * nature of the failure. * diff --git a/sched/pthread/pthread_getschedparam.c b/sched/pthread/pthread_getschedparam.c index 0167f172a196aa9619510a8536a59f5cf945881e..fa3e030a4567286e42a7cf1457367c6054b0bf5b 100644 --- a/sched/pthread/pthread_getschedparam.c +++ b/sched/pthread/pthread_getschedparam.c @@ -80,7 +80,7 @@ * policy - The location to store the thread's scheduling policy. * param - The location to store the thread's priority. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, the error code ESRCH if the value specified * by thread does not refer to an existing thread. * diff --git a/sched/pthread/pthread_getspecific.c b/sched/pthread/pthread_getspecific.c index 51927549c115680b80c71907aa3c1ae2e4a55910..889f712dd35a8d1783c5540183ecad6ff82133e5 100644 --- a/sched/pthread/pthread_getspecific.c +++ b/sched/pthread/pthread_getspecific.c @@ -65,7 +65,7 @@ * Parameters: * key = The data key to get or set * - * Return Value: + * Returned Value: * The function pthread_getspecific() returns the thread-specific data * associated with the given key. If no thread specific data is * associated with the key, then the value NULL is returned. diff --git a/sched/pthread/pthread_initialize.c b/sched/pthread/pthread_initialize.c index be0cb85ae4711f1560e9d8a1039a310cf12e2d30..5da4bcdaa026bc91fd73380959395ea98bd67dec 100644 --- a/sched/pthread/pthread_initialize.c +++ b/sched/pthread/pthread_initialize.c @@ -64,7 +64,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -91,7 +91,7 @@ void pthread_initialize(void) * intr - false: ignore EINTR errors when locking; true tread EINTR as * other errors by returning the errno value * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ diff --git a/sched/pthread/pthread_join.c b/sched/pthread/pthread_join.c index 4f22777b9a97121b64c78420bcf4f82a208b755c..24bec6bb0d124970e0947441a5e4126f18aa3c0b 100644 --- a/sched/pthread/pthread_join.c +++ b/sched/pthread/pthread_join.c @@ -70,7 +70,7 @@ * thread * pexit_value * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, one of the following error codes: * * EINVAL The value specified by thread does not refer to joinable diff --git a/sched/pthread/pthread_keycreate.c b/sched/pthread/pthread_keycreate.c index 60be2fb5e32de1a1f5687f8d84255e5ba692a59b..9daade6a312f916ef24e1074d28615f21e6c398b 100644 --- a/sched/pthread/pthread_keycreate.c +++ b/sched/pthread/pthread_keycreate.c @@ -71,7 +71,7 @@ * with each key that is invoked when a thread exits. However, this * argument is ignored in the current implementation. * - * Return Value: + * Returned Value: * If successful, the pthread_key_create() function will store the newly * created key value at *key and return zero (OK). Otherwise, an error * number will bereturned to indicate the error: diff --git a/sched/pthread/pthread_keydelete.c b/sched/pthread/pthread_keydelete.c index 57cd46309a411c9c1cf4e41b11bf061d749cf9b6..ab72fad9db95be43c708188448dc21f7bf1fe48f 100644 --- a/sched/pthread/pthread_keydelete.c +++ b/sched/pthread/pthread_keydelete.c @@ -60,7 +60,7 @@ * Parameters: * key = the key to delete * - * Return Value: + * Returned Value: * Always returns ENOSYS. * * Assumptions: diff --git a/sched/pthread/pthread_kill.c b/sched/pthread/pthread_kill.c index 1c2663e47e1286452a45c57c286a6be9e69b522f..e3f04a0b7aed80b7456869487f861d850708c32b 100644 --- a/sched/pthread/pthread_kill.c +++ b/sched/pthread/pthread_kill.c @@ -70,7 +70,7 @@ * signo - The signal number to send. If 'signo' is zero, no signal is * sent, but all error checking is performed. * - * Return Value: + * Returned Value: * On success the signal was send and zero is returned. On error one * of the following error numbers is returned. * diff --git a/sched/pthread/pthread_mutex.c b/sched/pthread/pthread_mutex.c index 6e1edd49d83c434e8456cb8dac41e7cbeddc9be2..02092a011795aeff842cf50598ca1889255c5f33 100644 --- a/sched/pthread/pthread_mutex.c +++ b/sched/pthread/pthread_mutex.c @@ -64,7 +64,7 @@ * Parameters: * mutex - The mutex to be locked * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -107,7 +107,7 @@ static void pthread_mutex_add(FAR struct pthread_mutex_s *mutex) * Parameters: * mutex - The mutex to be locked * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -172,7 +172,7 @@ static void pthread_mutex_remove(FAR struct pthread_mutex_s *mutex) * intr - false: ignore EINTR errors when locking; true treat EINTR as * other errors by returning the errno value * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ @@ -242,7 +242,7 @@ int pthread_mutex_take(FAR struct pthread_mutex_s *mutex, bool intr) * intr - false: ignore EINTR errors when locking; true treat EINTR as * other errors by returning the errno value * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ @@ -299,7 +299,7 @@ int pthread_mutex_trytake(FAR struct pthread_mutex_s *mutex) * Parameters: * mutex - The mutex to be unlocked * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. * ****************************************************************************/ diff --git a/sched/pthread/pthread_mutexdestroy.c b/sched/pthread/pthread_mutexdestroy.c index 17f58fbda531cb250f97a14ac8038d200b622c98..7c5055504cf9dcfdfa900be763ebe1d6b878ac12 100644 --- a/sched/pthread/pthread_mutexdestroy.c +++ b/sched/pthread/pthread_mutexdestroy.c @@ -63,7 +63,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_mutexinit.c b/sched/pthread/pthread_mutexinit.c index 9885869bbeefee525a741150517f6bcbe510ee92..a648544bfad91e8f00dfcc3869ce04d4ab823d2a 100644 --- a/sched/pthread/pthread_mutexinit.c +++ b/sched/pthread/pthread_mutexinit.c @@ -61,7 +61,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_mutexlock.c b/sched/pthread/pthread_mutexlock.c index 223b2193c59a898b06a7fc6e12619058207bd7da..88611c7be36b9fbf938fc1eaaec05f8ecec56b43 100644 --- a/sched/pthread/pthread_mutexlock.c +++ b/sched/pthread/pthread_mutexlock.c @@ -91,7 +91,7 @@ * Parameters: * mutex - A reference to the mutex to be locked. * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. Note that the errno EINTR * is never returned by pthread_mutex_lock(). * diff --git a/sched/pthread/pthread_mutextrylock.c b/sched/pthread/pthread_mutextrylock.c index b88916ae5048c89fca3c5e8dd1c564e768c776ab..fb74a76d5c44e121cd025167379e23fb501e52fd 100644 --- a/sched/pthread/pthread_mutextrylock.c +++ b/sched/pthread/pthread_mutextrylock.c @@ -69,7 +69,7 @@ * Parameters: * mutex - A reference to the mutex to be locked. * - * Return Value: + * Returned Value: * 0 on success or an errno value on failure. Note that the errno EINTR * is never returned by pthread_mutex_trylock(). * diff --git a/sched/pthread/pthread_mutexunlock.c b/sched/pthread/pthread_mutexunlock.c index a29fc490da11b37411f6f203dbd11ca1331616bb..75492515ac92d3ed61fec6084a5bacac23dafc31 100644 --- a/sched/pthread/pthread_mutexunlock.c +++ b/sched/pthread/pthread_mutexunlock.c @@ -61,7 +61,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * Returns true if the mutex is locked * ****************************************************************************/ @@ -105,7 +105,7 @@ static inline bool pthread_mutex_islocked(FAR struct pthread_mutex_s *mutex) * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_release.c b/sched/pthread/pthread_release.c index ff7164f1ebe8aeac7cb373eef15cc793e1e23f5c..fd79544c9c4d073d8fb25a98f207d9889508b31e 100644 --- a/sched/pthread/pthread_release.c +++ b/sched/pthread/pthread_release.c @@ -61,7 +61,7 @@ * group = The task group containing the pthread resources to be * released. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/pthread/pthread_setaffinity.c b/sched/pthread/pthread_setaffinity.c index 87f91e9be96ab28be743926285310f3f225f99ef..5f3ba7283c783f26de42334ed26af3547179cc6a 100644 --- a/sched/pthread/pthread_setaffinity.c +++ b/sched/pthread/pthread_setaffinity.c @@ -73,7 +73,7 @@ * cpusetsize - Size of cpuset. MUST be sizeofcpu_set_t(). * cpuset - Provides the new affinity set for the thread. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an errno value is returned indicating the * nature of the failure. * diff --git a/sched/pthread/pthread_setschedparam.c b/sched/pthread/pthread_setschedparam.c index 2ba1e851167725f58be5b7ea39e48ab48a7d482f..bfbbf2dbcd10adba382816defcc51d0fca3efe68 100644 --- a/sched/pthread/pthread_setschedparam.c +++ b/sched/pthread/pthread_setschedparam.c @@ -82,7 +82,7 @@ * SCHED_RR. SCHED_OTHER and SCHED_SPORADIC are not supported. * param - Provides the new priority of the thread. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, an error code identifying the cause of the * failure: * diff --git a/sched/pthread/pthread_setschedprio.c b/sched/pthread/pthread_setschedprio.c index e698d3bf29bcb8c6c15ee9664a4a82b763bcb9d5..aed67e45593feb0cb2de5326d64102c5284ed3b6 100644 --- a/sched/pthread/pthread_setschedprio.c +++ b/sched/pthread/pthread_setschedprio.c @@ -61,12 +61,12 @@ * If the thread_setschedprio() function fails, the scheduling priority * of the target thread will not be changed. * - * Inputs: + * Input Parameters: * thread - the thread ID of the task to reprioritize. * prio - The new thread priority. The range of valid priority numbers is * from SCHED_PRIORITY_MIN through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * OK if successful, otherwise an error number. This function can * fail for the following reasons: * diff --git a/sched/pthread/pthread_setspecific.c b/sched/pthread/pthread_setspecific.c index 3a0db5b7ef441fa64a11e5620418d0c8785a9e2e..371353b424adaa6b1f6cffa0a1bc058f7e8b38ed 100644 --- a/sched/pthread/pthread_setspecific.c +++ b/sched/pthread/pthread_setspecific.c @@ -72,7 +72,7 @@ * key = The data key to get or set * value = The value to bind to the key. * - * Return Value: + * Returned Value: * If successful, pthread_setspecific() will return zero (OK). * Otherwise, an error number will be returned: * diff --git a/sched/pthread/pthread_sigmask.c b/sched/pthread/pthread_sigmask.c index fb87f28c3f264a8d42815d7369a5b15bf4b425e2..43eb6c27eda74e39f184df8f7e5a9876dac9e783 100644 --- a/sched/pthread/pthread_sigmask.c +++ b/sched/pthread/pthread_sigmask.c @@ -71,7 +71,7 @@ * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * On success, this function will return 0 (OK). It will return EINVAL if * how is invalid. * diff --git a/sched/sched/sched_addblocked.c b/sched/sched/sched_addblocked.c index 151faedb6922de1cd4c6f046df090f87e6dc98eb..487330714de122111a5d9253a1df46fbe1a67c86 100644 --- a/sched/sched/sched_addblocked.c +++ b/sched/sched/sched_addblocked.c @@ -55,11 +55,11 @@ * This function adds a TCB to one of the blocked state task lists as * inferred from task_state. * - * Inputs: + * Input Parameters: * btcb - Points to the TCB that is blocked * task_state - identifies the state of the blocked task * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_addprioritized.c b/sched/sched/sched_addprioritized.c index b94b60255dbe658d7887c2460c0a46586521146e..15e20319be9ac1cab73cc9ea71a3ed63785a395f 100644 --- a/sched/sched/sched_addprioritized.c +++ b/sched/sched/sched_addprioritized.c @@ -56,11 +56,11 @@ * Description: * This function adds a TCB to a prioritized TCB list. * - * Inputs: + * Input Parameters: * tcb - Points to the TCB to add to the prioritized list * list - Points to the prioritized list to add tcb to * - * Return Value: + * Returned Value: * true if the head of the list has changed. * * Assumptions: diff --git a/sched/sched/sched_addreadytorun.c b/sched/sched/sched_addreadytorun.c index 880f4b85bb039e45448f196152dce72c1a77b40c..2f5a7704c9bab46b2e8f15e017e0a804d19fd714 100644 --- a/sched/sched/sched_addreadytorun.c +++ b/sched/sched/sched_addreadytorun.c @@ -60,10 +60,10 @@ * instead. The pending tasks will be made ready-to-run when preemption is * unlocked. * - * Inputs: + * Input Parameters: * btcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * @@ -144,10 +144,10 @@ bool sched_addreadytorun(FAR struct tcb_s *btcb) * g_pendingtasks list instead. The pending tasks will be made * ready-to-run when preemption isunlocked. * - * Inputs: + * Input Parameters: * btcb - Points to the blocked TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * diff --git a/sched/sched/sched_cpuload.c b/sched/sched/sched_cpuload.c index ef35c39848c48594cd7e77bdb9a0cd57be024788..1ee7275bd349252b8163e229f574ebcfc85ea30c 100644 --- a/sched/sched/sched_cpuload.c +++ b/sched/sched/sched_cpuload.c @@ -110,10 +110,10 @@ volatile uint32_t g_cpuload_total; * Description: * Collect data that can be used for CPU load measurements. * - * Inputs: + * Input Parameters: * cpu - The CPU that we are performing the load operations on. * - * Return Value: + * Returned Value: * None * * Assumptions/Limitations: @@ -156,10 +156,10 @@ static inline void sched_cpu_process_cpuload(int cpu) * Description: * Collect data that can be used for CPU load measurements. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions/Limitations: @@ -228,7 +228,7 @@ void weak_function sched_process_cpuload(void) * pid - The task ID of the thread of interest. pid == 0 is the IDLE thread. * cpuload - The location to return the CPU load * - * Return Value: + * Returned Value: * OK (0) on success; a negated errno value on failure. The only reason * that this function can fail is if 'pid' no longer refers to a valid * thread. diff --git a/sched/sched/sched_cpuselect.c b/sched/sched/sched_cpuselect.c index c995cb8764433cc4a290229bb6a077eb78898a84..b96436cdd49f42043a9ea6fd612a93548db80f47 100644 --- a/sched/sched/sched_cpuselect.c +++ b/sched/sched/sched_cpuselect.c @@ -65,10 +65,10 @@ * Return the index to the CPU with the lowest priority running task, * possbily its IDLE task. * - * Inputs: + * Input Parameters: * affinity - The set of CPUs on which the thread is permitted to run. * - * Return Value: + * Returned Value: * Index of the CPU with the lowest priority running task * * Assumptions: diff --git a/sched/sched/sched_foreach.c b/sched/sched/sched_foreach.c index 1ee962d7728b89ce7552eed1e8f84443a166279f..3bd7898a849de40faebddb2f326f597260c4289c 100644 --- a/sched/sched/sched_foreach.c +++ b/sched/sched/sched_foreach.c @@ -59,7 +59,7 @@ * handler - The function to be called with the TCB of * each task * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_garbage.c b/sched/sched/sched_garbage.c index 7c853232d05dea5caff99a8955301395f796aa4f..a5fce0c8d0538ab0378729ae0b12b7bd8cc5eeb4 100644 --- a/sched/sched/sched_garbage.c +++ b/sched/sched/sched_garbage.c @@ -53,7 +53,7 @@ * Description: * Clean-up deferred de-allocations of user memory * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -110,7 +110,7 @@ static inline void sched_kucleanup(void) * Description: * Return TRUE if there is user heap garbage to be collected. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -133,7 +133,7 @@ static inline bool sched_have_kugarbage(void) * Description: * Clean-up deferred de-allocations of kernel memory * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -184,7 +184,7 @@ static inline void sched_kcleanup(void) * Description: * Return TRUE if there is kernal heap garbage to be collected. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -220,7 +220,7 @@ static inline bool sched_have_kgarbage(void) * collection to be called from the IDLE thread because it runs at a very * low priority and could cause false memory out conditions. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -254,7 +254,7 @@ void sched_garbage_collection(void) * state. The looping nature of the IDLE loops should catch any missed * garbage from the test on the next time arround. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/sched/sched/sched_getfiles.c b/sched/sched/sched_getfiles.c index 7e634053d925fe1588c393397570c38312f70671..d36fe7f0c0fb38453192bf926eff175c25391b2c 100644 --- a/sched/sched/sched_getfiles.c +++ b/sched/sched/sched_getfiles.c @@ -58,7 +58,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the errno. * * Assumptions: diff --git a/sched/sched/sched_getparam.c b/sched/sched/sched_getparam.c index 9c164e374d48dd472834590c5fa8bbcf2d774564..c1668d00c5d8e16c662d7cc305ff7bbf2652eb47 100644 --- a/sched/sched/sched_getparam.c +++ b/sched/sched/sched_getparam.c @@ -64,14 +64,14 @@ * use by application logic. Applications should use the standard * sched_getparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority * of the calling task is returned. * param - A structure whose member sched_priority is the integer * priority. The task's priority is copied to the sched_priority * element of this structure. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -165,14 +165,14 @@ int nxsched_getparam (pid_t pid, FAR struct sched_param *param) * pid. This function is a simply wrapper around nxsched_getparam() that * sets the errno value in the event of an error. * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority * of the calling task is returned. * param - A structure whose member sched_priority is the integer * priority. The task's priority is copied to the sched_priority * element of this structure. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise -1 (ERROR) with the errno value set * to indicate the nature of the problem. * diff --git a/sched/sched/sched_getscheduler.c b/sched/sched/sched_getscheduler.c index 1ca4cf64eda33e3e762cf71e95e267c774d32617..13150854ba7b94653e3e8a9782a416feffc5103a 100644 --- a/sched/sched/sched_getscheduler.c +++ b/sched/sched/sched_getscheduler.c @@ -68,11 +68,11 @@ * use by application logic. Applications should use the standard * sched_getscheduler(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to query. If pid is zero, the * calling task is queried. * - * Return Value: + * Returned Value: * On success, sched_getscheduler() returns the policy for the task * (either SCHED_FIFO or SCHED_RR). On error, a negated errno value * returned: @@ -121,11 +121,11 @@ int nxsched_getscheduler(pid_t pid) * sched_getscheduler() is a simply wrapper around nxsched_getscheduler() * that sets the errno value in the event of an error. * - * Inputs: + * Input Parameters: * pid - the task ID of the task to query. If pid is zero, the * calling task is queried. * - * Return Value: + * Returned Value: * On success, sched_getscheduler() returns the policy for the task * (either SCHED_FIFO or SCHED_RR). On error, ERROR (-1) is * returned, and errno is set appropriately: diff --git a/sched/sched/sched_getsockets.c b/sched/sched/sched_getsockets.c index 2601f90783a9b1343fe5c6e1950b7c8e4fa28993..a2dfdedd18cd1834af6d266d96f0ccb02c88346a 100644 --- a/sched/sched/sched_getsockets.c +++ b/sched/sched/sched_getsockets.c @@ -57,7 +57,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the errno. * * Assumptions: diff --git a/sched/sched/sched_getstreams.c b/sched/sched/sched_getstreams.c index 91f3c9f6f35a8c147466879e480243b92b935408..0a99a1e453f6d08a93551931d8cb14ebcea73b60 100644 --- a/sched/sched/sched_getstreams.c +++ b/sched/sched/sched_getstreams.c @@ -54,7 +54,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * A pointer to the errno. * * Assumptions: diff --git a/sched/sched/sched_lock.c b/sched/sched/sched_lock.c index 708b7780b13e27250e3f83c20268303688a5c4dd..a7a55ac264b324d2adc2f458a23f3d6bfc798e6a 100644 --- a/sched/sched/sched_lock.c +++ b/sched/sched/sched_lock.c @@ -132,10 +132,10 @@ volatile cpu_set_t g_cpu_lockset SP_SECTION; * either calls sched_unlock() (the appropriate number of times) or * until it blocks itself. * - * Inputs + * Input Parameters: * None * - * Return Value: + * Returned Value: * OK on success; ERROR on failure * ****************************************************************************/ diff --git a/sched/sched/sched_lockcount.c b/sched/sched/sched_lockcount.c index c3a8ef19030f8fa30c83a5003e12a82f037ffebb..9aeef35894a3b205de0ae078168c7214783eec3f 100644 --- a/sched/sched/sched_lockcount.c +++ b/sched/sched/sched_lockcount.c @@ -57,10 +57,10 @@ * execution. sched_unlock() will have to called that many times from * this thread in order to re-enable pre-emption. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * lockcount * ****************************************************************************/ diff --git a/sched/sched/sched_mergepending.c b/sched/sched/sched_mergepending.c index 6e258c7554a02761fca9eed6af57e2c9dd64ef1a..826a0e78330588cdc4af1643c3d3b5410982cbd0 100644 --- a/sched/sched/sched_mergepending.c +++ b/sched/sched/sched_mergepending.c @@ -68,10 +68,10 @@ * This function merges the prioritized g_pendingtasks list into the * prioritized ready-to-run task list. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * true if the head of the ready-to-run task list has changed indicating * a context switch is needed. * @@ -173,10 +173,10 @@ bool sched_mergepending(void) * This function merges the prioritized g_pendingtasks list into the * prioritized ready-to-run task list. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * true if the head of the ready-to-run task list has changed indicating * a context switch is needed. * diff --git a/sched/sched/sched_mergeprioritized.c b/sched/sched/sched_mergeprioritized.c index 7ff70b14df82cfa95fa2f12c34537a181706051c..7fb7d072840c042fef76148e4cc03b884a13b2ad 100644 --- a/sched/sched/sched_mergeprioritized.c +++ b/sched/sched/sched_mergeprioritized.c @@ -58,14 +58,14 @@ * into the prioritized task list, 'list2'. On return 'list2' will contain * the prioritized content of both lists; 'list1' will be empty. * - * Inputs: + * Input Parameters: * list1 - Points to the prioritized list to merge into list 1. This list * will be empty upon return. * list2 - That list that will contained the prioritized content of * both lists upon return. * task_state - The task state/list index associated with list2. * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_releasetcb.c b/sched/sched/sched_releasetcb.c index b7046aa790ae94516ff498ea92f474a853b32daa..26ab60b7f783a30d723496cd44793a1ece3838d1 100644 --- a/sched/sched/sched_releasetcb.c +++ b/sched/sched/sched_releasetcb.c @@ -102,7 +102,7 @@ static void sched_releasepid(pid_t pid) * however, there are certain error recovery contexts where the TCB my * not be fully initialized when sched_releasetcb is called. * - * Return Value: + * Returned Value: * OK on success; ERROR on failure * * Assumptions: diff --git a/sched/sched/sched_removeblocked.c b/sched/sched/sched_removeblocked.c index 36c92e96f0893301032ab2825fe6e6892d563b02..9ed15a98bbc5f81a33794af643e688ff3fc12891 100644 --- a/sched/sched/sched_removeblocked.c +++ b/sched/sched/sched_removeblocked.c @@ -55,10 +55,10 @@ * This function removes a TCB from one of the blocked state task * lists as inferred from the task_state inside the TCB. * - * Inputs: + * Input Parameters: * btcb - Points to the TCB that is blocked * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/sched/sched_removereadytorun.c b/sched/sched/sched_removereadytorun.c index f5e93b881c80413f91a3f2d1086d3f1e4e469b21..78919d498986f3487b0969ff02662e33721203a7 100644 --- a/sched/sched/sched_removereadytorun.c +++ b/sched/sched/sched_removereadytorun.c @@ -57,10 +57,10 @@ * Description: * This function removes a TCB from the ready to run list. * - * Inputs: + * Input Parameters: * rtcb - Points to the TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * @@ -116,10 +116,10 @@ bool sched_removereadytorun(FAR struct tcb_s *rtcb) * Description: * This function removes a TCB from the ready to run list. * - * Inputs: + * Input Parameters: * rtcb - Points to the TCB that is ready-to-run * - * Return Value: + * Returned Value: * true if the currently active task (the head of the ready-to-run list) * has changed. * diff --git a/sched/sched/sched_reprioritize.c b/sched/sched/sched_reprioritize.c index 66112c3da01374d41518c459d5d5db813fd0a11e..3c65eec35f1c7e3f4bab3ed27684ce984a56dd8f 100644 --- a/sched/sched/sched_reprioritize.c +++ b/sched/sched/sched_reprioritize.c @@ -63,11 +63,11 @@ * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * On success, sched_reporioritize() returns 0 (OK). On error, a negated * errno value is returned. * diff --git a/sched/sched/sched_roundrobin.c b/sched/sched/sched_roundrobin.c index 9aa5a6b8edf30b74b0374e5801337f43b44fe76c..798b4265cf8edbce971335fe0f786be88b49cd94 100644 --- a/sched/sched/sched_roundrobin.c +++ b/sched/sched/sched_roundrobin.c @@ -73,12 +73,12 @@ * Description: * Check if the currently executing task has exceeded its time slice. * - * Inputs: + * Input Parameters: * tcb - The TCB of the currently executing task * ticks - The number of ticks that have elapsed on the interval timer. * noswitches - True: Can't do context switches now. * - * Return Value: + * Returned Value: * The number if ticks remaining until the next time slice expires. * Zero is returned if there is no time slicing (i.e., the task at the * head of the ready-to-run list does not support round robin diff --git a/sched/sched/sched_rrgetinterval.c b/sched/sched/sched_rrgetinterval.c index 3faefb44d2d9f193e3d1580e2092c407239af08d..fc96d8bd3b7e4279ca92293cab2afa8d4f869b03 100644 --- a/sched/sched/sched_rrgetinterval.c +++ b/sched/sched/sched_rrgetinterval.c @@ -62,12 +62,12 @@ * is written into 'interval. The identified process should be running * under the SCHED_RRscheduling policy.' * - * Inputs: + * Input Parameters: * pid - the task ID of the task. If pid is zero, the priority of the * calling task is returned. * interval - a structure used to return the time slice * - * Return Value: + * Returned Value: * On success, sched_rr_get_interval() returns OK (0). On error, * ERROR (-1) is returned, and errno is set to: * diff --git a/sched/sched/sched_setaffinity.c b/sched/sched/sched_setaffinity.c index 06ab16f86558813b3414cf8d129d56b0730244d3..d9ba77966969abbbe59ea079ac7b90db5ccd8802 100644 --- a/sched/sched/sched_setaffinity.c +++ b/sched/sched/sched_setaffinity.c @@ -72,12 +72,12 @@ * is not intended for use by application logic. Applications should * use the standard sched_setparam(). * - * Inputs: + * Input Parameters: * pid - The ID of thread whose affinity set will be modified. * cpusetsize - Size of mask. MUST be sizeofcpu_set_t(). * mask - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * Zero (OK) if successful. Otherwise, a negated errno value is returned: * * ESRCH The task whose ID is pid could not be found. @@ -180,12 +180,12 @@ errout_with_lock: * This function is a simply wrapper around nxsched_setaffinity() that sets * the errno value in the event of an error. * - * Inputs: + * Input Parameters: * pid - The ID of thread whose affinity set will be modified. * cpusetsize - Size of mask. MUST be sizeofcpu_set_t(). * mask - The location to return the thread's new affinity set. * - * Return Value: + * Returned Value: * 0 if successful. Otherwise, ERROR (-1) is returned, and errno is * set appropriately: * diff --git a/sched/sched/sched_setparam.c b/sched/sched/sched_setparam.c index 33307f157550f7ae6788077855712751863a9b79..9a36299d7b73f35215b66781fc5a4dec2b551b62 100644 --- a/sched/sched/sched_setparam.c +++ b/sched/sched/sched_setparam.c @@ -72,14 +72,14 @@ * use by application logic. Applications should use the standard * sched_setparam(). * - * Inputs: + * Input Parameters: * pid - the task ID of the task to reprioritize. If pid is zero, the * priority of the calling task is changed. * param - A structure whose member sched_priority is the integer priority. * The range of valid priority numbers is from SCHED_PRIORITY_MIN * through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * 0 (OK) if successful, otherwise a negated errno value is returned to * indicate the nature of the failure.. * @@ -239,14 +239,14 @@ errout_with_lock: * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * pid - the task ID of the task to reprioritize. If pid is zero, the * priority of the calling task is changed. * param - A structure whose member sched_priority is the integer priority. * The range of valid priority numbers is from SCHED_PRIORITY_MIN * through SCHED_PRIORITY_MAX. * - * Return Value: + * Returned Value: * On success, sched_setparam() returns 0 (OK). On error, -1 (ERROR) is * returned, and errno is set appropriately. * diff --git a/sched/sched/sched_setpriority.c b/sched/sched/sched_setpriority.c index 1e8cbd41bfee54a8e677b9872a435a99352a8c6f..ead70de4fd1f7fb27c2443f0539201d200ea7c21 100644 --- a/sched/sched/sched_setpriority.c +++ b/sched/sched/sched_setpriority.c @@ -59,10 +59,10 @@ * Description: * Get the next highest priority ready-to-run task. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * - * Return Value: + * Returned Value: * TCB of the next highest priority ready-to-run task. * ****************************************************************************/ @@ -124,11 +124,11 @@ static FAR struct tcb_s *sched_nexttcb(FAR struct tcb_s *tcb) * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -178,11 +178,11 @@ static inline void sched_running_setpriority(FAR struct tcb_s *tcb, * the position of the task in the ready-to-run list and if the priority * is increased, may cause the task to become running. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -267,11 +267,11 @@ static void sched_readytorun_setpriority(FAR struct tcb_s *tcb, * Change the priority of a blocked tasks. The only issue here is that * the task may like in a prioritized or an non-prioritized queue. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -324,11 +324,11 @@ static inline void sched_blocked_setpriority(FAR struct tcb_s *tcb, * to sched_yield() -- The task will be moved to after all other tasks * with the same priority. * - * Inputs: + * Input Parameters: * tcb - the TCB of task to reprioritize. * sched_priority - The new task priority * - * Return Value: + * Returned Value: * On success, nxsched_setpriority() returns 0 (OK). On error, a negated * errno value is returned. * diff --git a/sched/sched/sched_timerexpiration.c b/sched/sched/sched_timerexpiration.c index d00150654ff2399eb99b1f51dd08683decc1db38..b1c137535a32e9de09cd1d70ed6980d451828e1a 100644 --- a/sched/sched/sched_timerexpiration.c +++ b/sched/sched/sched_timerexpiration.c @@ -162,12 +162,12 @@ static struct timespec g_stop_time; * Check for operations specific to scheduling policy of the currently * active task on a single CPU. * - * Inputs: + * Input Parameters: * cpu - The CPU that we are performing the scheduler operations on. * ticks - The number of ticks that have elapsed on the interval timer. * noswitches - True: Can't do context switches now. * - * Return Value: + * Returned Value: * The number if ticks remaining until the next time slice expires. * Zero is returned if there is no time slicing (i.e., the task at the * head of the ready-to-run list does not support round robin @@ -264,11 +264,11 @@ static uint32_t sched_cpu_scheduler(int cpu, uint32_t ticks, bool noswitches) * Check for operations specific to scheduling policy of the currently * active task on a single CPU. * - * Inputs: + * Input Parameters: * ticks - The number of ticks that have elapsed on the interval timer. * noswitches - True: Can't do context switches now. * - * Return Value: + * Returned Value: * The number if ticks remaining until the next time slice expires. * Zero is returned if there is no time slicing (i.e., the task at the * head of the ready-to-run list does not support round robin diff --git a/sched/sched/sched_waitpid.c b/sched/sched/sched_waitpid.c index 1763ee966f71257994dbdf4b84f99332a389dd16..faca0216aa031ab1ef5d3387c89d7bd7145c16a2 100644 --- a/sched/sched/sched_waitpid.c +++ b/sched/sched/sched_waitpid.c @@ -147,7 +147,7 @@ * stat_loc - The location to return the exit status * options - ignored * - * Return Value: + * Returned Value: * If waitpid() returns because the status of a child process is available, * it will return a value equal to the process ID of the child process for * which status is reported. diff --git a/sched/sched/sched_yield.c b/sched/sched/sched_yield.c index e9e62920f9325b57fe26395f1c0d859d95d20ffe..320de61c10ba7ed4f81a2141f2ca2410c7907247 100644 --- a/sched/sched/sched_yield.c +++ b/sched/sched/sched_yield.c @@ -54,10 +54,10 @@ * This function forces the calling task to give up the CPU (only to other * tasks at the same priority). * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) (errno is not set) * * Assumptions: diff --git a/sched/semaphore/sem_destroy.c b/sched/semaphore/sem_destroy.c index 5cc05f222c3d4de2f4d980ff378d16ecef4ee0e9..7c0522d29fc3d3bb1a05a8118d909df717d76d7f 100644 --- a/sched/semaphore/sem_destroy.c +++ b/sched/semaphore/sem_destroy.c @@ -65,7 +65,7 @@ * Parameters: * sem - Semaphore to be destroyed. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -119,7 +119,7 @@ int nxsem_destroy (FAR sem_t *sem) * Parameters: * sem - Semaphore to be destroyed. * - * Return Value: + * Returned Value: * This function is a application interface. It returns zero (OK) if * successful. Otherwise, -1 (ERROR) is returned and the errno value is * set appropriately. diff --git a/sched/semaphore/sem_holder.c b/sched/semaphore/sem_holder.c index 3080c3080fd6e853d05cae638a162c0752a7bd0e..9095f98e7f2ded89adf4a51ddb32004caeaec4ee 100644 --- a/sched/semaphore/sem_holder.c +++ b/sched/semaphore/sem_holder.c @@ -717,7 +717,7 @@ static int nxsem_restoreholderprioB(FAR struct semholder_s *pholder, * - If it is >0 then there should be no threads waiting for counts and * stcb should be null. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -778,7 +778,7 @@ static inline void nxsem_restorebaseprio_irq(FAR struct tcb_s *stcb, * - If it is >0 then there should be no threads waiting for counts and * stcb should be null. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -848,7 +848,7 @@ static inline void nxsem_restorebaseprio_task(FAR struct tcb_s *stcb, * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -882,7 +882,7 @@ void nxsem_initholders(void) * Parameters: * sem - A reference to the semaphore being destroyed * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -933,7 +933,7 @@ void nxsem_destroyholder(FAR sem_t *sem) * htcb - TCB of the thread that just obtained the semaphore * sem - A reference to the incremented semaphore * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) if unsuccessful * * Assumptions: @@ -976,7 +976,7 @@ void nxsem_addholder_tcb(FAR struct tcb_s *htcb, FAR sem_t *sem) * Parameters: * sem - A reference to the incremented semaphore * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) if unsuccessful * * Assumptions: @@ -998,7 +998,7 @@ void nxsem_addholder(FAR sem_t *sem) * Parameters: * None * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) if unsuccessful * * Assumptions: @@ -1027,7 +1027,7 @@ void nxsem_boostpriority(FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore being posted * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1077,7 +1077,7 @@ void nxsem_releaseholder(FAR sem_t *sem) * - If it is >0 then there should be no threads waiting for counts and * stcb should be null. * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1122,7 +1122,7 @@ void nxsem_restorebaseprio(FAR struct tcb_s *stcb, FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore no longer being waited for * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1151,7 +1151,7 @@ void nxsem_canceled(FAR struct tcb_s *stcb, FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -1177,7 +1177,7 @@ void sem_enumholders(FAR sem_t *sem) * Parameters: * sem - A reference to the semaphore * - * Return Value: + * Returned Value: * The number of available holder containers * * Assumptions: diff --git a/sched/semaphore/sem_initialize.c b/sched/semaphore/sem_initialize.c index 769313781c78d3f4cfdacd7a4b564ee66d83425f..3b629de0a4bf0c1f49ac34f83e69d9e00ee4cb7b 100644 --- a/sched/semaphore/sem_initialize.c +++ b/sched/semaphore/sem_initialize.c @@ -59,7 +59,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/semaphore/sem_post.c b/sched/semaphore/sem_post.c index f20cb68c774fce1194e1b542818ad276896a4e75..67822aca194e529ec98ffcc936cb9362720f3329 100644 --- a/sched/semaphore/sem_post.c +++ b/sched/semaphore/sem_post.c @@ -74,7 +74,7 @@ * Parameters: * sem - Semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -211,7 +211,7 @@ int nxsem_post(FAR sem_t *sem) * Parameters: * sem - Semaphore descriptor * - * Return Value: + * Returned Value: * This function is a standard, POSIX application interface. It will * return zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/sched/semaphore/sem_recover.c b/sched/semaphore/sem_recover.c index 6305f0d35e8a5420146e6cb93fe9c3af19dd768a..343ba330a956c7ecfe3eb4957be90a40e67b682a 100644 --- a/sched/semaphore/sem_recover.c +++ b/sched/semaphore/sem_recover.c @@ -64,10 +64,10 @@ * only the task, there is not mechanism to traverse all of the semaphores * with counts held by the task. * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/semaphore/sem_reset.c b/sched/semaphore/sem_reset.c index 28a0965a4cb86211c8f00c0b866737fc154d0c23..81f8fce83a40628033eecf1ea7b6c28e9cb7a26e 100644 --- a/sched/semaphore/sem_reset.c +++ b/sched/semaphore/sem_reset.c @@ -64,7 +64,7 @@ * sem - Semaphore descriptor to be reset * count - The requested semaphore count * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/sched/semaphore/sem_setprotocol.c b/sched/semaphore/sem_setprotocol.c index f4b202b22bc5212ffe675bc6ccd19d43f1eea569..be98b88c1728b9a4b72d4945bdaaf503433a2745 100644 --- a/sched/semaphore/sem_setprotocol.c +++ b/sched/semaphore/sem_setprotocol.c @@ -82,7 +82,7 @@ * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -153,7 +153,7 @@ int nxsem_setprotocol(FAR sem_t *sem, int protocol) * modified * protocol - The new protocol to use * - * Return Value: + * Returned Value: * This function is exposed as a non-standard application interface. It * returns zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. diff --git a/sched/semaphore/sem_tickwait.c b/sched/semaphore/sem_tickwait.c index 350a7a1cec3ea3ee739f5fd2858524e87540bc04..fd549e4aa372bd6d155f59ee03ff438f0e761773 100644 --- a/sched/semaphore/sem_tickwait.c +++ b/sched/semaphore/sem_tickwait.c @@ -76,7 +76,7 @@ * posted. If ticks is zero, then this function is equivalent * to nxsem_trywait(). * - * Return Value: + * Returned Value: * This is an internal OS interface, not available to applications, and * hence follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. diff --git a/sched/semaphore/sem_timedwait.c b/sched/semaphore/sem_timedwait.c index 98e5c84b2b726c133eb8bde51f732067649f9609..a5ae5116f4be16fa557bcdd586f1f131462123fc 100644 --- a/sched/semaphore/sem_timedwait.c +++ b/sched/semaphore/sem_timedwait.c @@ -86,7 +86,7 @@ * sem - Semaphore object * abstime - The absolute time to wait until a timeout is declared. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -235,7 +235,7 @@ errout_with_irqdisabled: * sem - Semaphore object * abstime - The absolute time to wait until a timeout is declared. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success. On failure, -1 (ERROR) is returned * and the errno is set appropriately: * diff --git a/sched/semaphore/sem_timeout.c b/sched/semaphore/sem_timeout.c index 377793930b9be603cb453fa75df2cda552704703..d4ba2a0d88ebfe9d87be44beddc08ce72316e4b3 100644 --- a/sched/semaphore/sem_timeout.c +++ b/sched/semaphore/sem_timeout.c @@ -63,7 +63,7 @@ * argc - The number of arguments (should be 1) * pid - The task ID of the task to wakeup * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/semaphore/sem_trywait.c b/sched/semaphore/sem_trywait.c index e990427c456df611b6aa9b0b2e07528015ad6fd3..d7480e05406c4e61267666a280fb338dcad503f8 100644 --- a/sched/semaphore/sem_trywait.c +++ b/sched/semaphore/sem_trywait.c @@ -65,7 +65,7 @@ * Parameters: * sem - the semaphore descriptor * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -136,7 +136,7 @@ int nxsem_trywait(FAR sem_t *sem) * Parameters: * sem - the semaphore descriptor * - * Return Value: + * Returned Value: * Zero (OK) on success or -1 (ERROR) if unsuccessful. If this function * returns -1(ERROR), then the cause of the failure will be reported in * errno variable as: diff --git a/sched/semaphore/sem_wait.c b/sched/semaphore/sem_wait.c index 5b2b8ceb5d8afb17b80aad9ee45da8eb838ea3a6..9bb1d3105c368e7a792ef190be7d589f5b7d6d41 100644 --- a/sched/semaphore/sem_wait.c +++ b/sched/semaphore/sem_wait.c @@ -72,7 +72,7 @@ * Parameters: * sem - Semaphore descriptor. * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -221,7 +221,7 @@ int nxsem_wait(FAR sem_t *sem) * Parameters: * sem - Semaphore descriptor. * - * Return Value: + * Returned Value: * This function is a standard, POSIX application interface. It returns * zero (OK) if successful. Otherwise, -1 (ERROR) is returned and * the errno value is set appropriately. Possible errno values include: diff --git a/sched/semaphore/sem_waitirq.c b/sched/semaphore/sem_waitirq.c index 4ca202f07e2cb16b4ffe213a8dc4df39bae6f43f..11254e8fcb6c76b769f95e4f9a9285d7615f8731 100644 --- a/sched/semaphore/sem_waitirq.c +++ b/sched/semaphore/sem_waitirq.c @@ -70,7 +70,7 @@ * errcode - EINTR if the semaphore wait was awakened by a signal; * ETIMEDOUT if awakened by a timeout * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/signal/sig_action.c b/sched/signal/sig_action.c index 1b2f3be67e0321aa39ed08ed63c89bd1d2c123c0..d40ec627ed87f7d6921fcd2bc19cb06dda135e81 100644 --- a/sched/signal/sig_action.c +++ b/sched/signal/sig_action.c @@ -139,7 +139,7 @@ static FAR sigactq_t *nxsig_alloc_action(void) * act - Location of new handler * oact - Location to store only handler * - * Return Value: + * Returned Value: * 0 (OK), or -1 (ERROR) if the signal number is invalid. * (errno is not set) * diff --git a/sched/signal/sig_pending.c b/sched/signal/sig_pending.c index 7dc44fc4569904f5e3baad7e162333f44ef0b2c4..4dc27e0d988fd08a2c1d7d4623bee981ff28ca30 100644 --- a/sched/signal/sig_pending.c +++ b/sched/signal/sig_pending.c @@ -62,7 +62,7 @@ * Parameters: * set - The location to return the pending signal set. * - * Return Value: + * Returned Value: * 0 (OK) or -1 (ERROR) * * Assumptions: diff --git a/sched/signal/sig_procmask.c b/sched/signal/sig_procmask.c index 19bf70316e608d3bd61aee03dcbe4d9a70552d09..27f1d771025752002c6d361a4310c6ad6443f7e9 100644 --- a/sched/signal/sig_procmask.c +++ b/sched/signal/sig_procmask.c @@ -92,7 +92,7 @@ * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -197,7 +197,7 @@ int nxsig_procmask(int how, FAR const sigset_t *set, FAR sigset_t *oset) * set - Location of the new signal mask * oset - Location to store the old signal mask * - * Return Value: + * Returned Value: * This function will return 0 (OK) on success or -1 (ERROR) if how is * invalid. In the latter case, the errno variable will be set to EINVAL. * diff --git a/sched/signal/sig_queue.c b/sched/signal/sig_queue.c index 455b7ea72d50f76cda9cd82cef88a60fccd5cab3..00e08f26c0e32952be33588873f7bc43f29c9503 100644 --- a/sched/signal/sig_queue.c +++ b/sched/signal/sig_queue.c @@ -76,7 +76,7 @@ * signo - Signal number * value - Value to pass to task with signal * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -157,7 +157,7 @@ int nxsig_queue(int pid, int signo, void *sival_ptr) * signo - Signal number * value - Value to pass to task with signal * - * Return Value: + * Returned Value: * On success (at least one signal was sent), zero (OK) is returned. On * any failure, -1 (ERROR) is returned and errno varaible is set * appropriately: diff --git a/sched/signal/sig_suspend.c b/sched/signal/sig_suspend.c index 4bfc114b34973bcb19892a65ffefb30ef50cc1f0..8a8c068cdfc590128f35f0159b46a7d02394ca1c 100644 --- a/sched/signal/sig_suspend.c +++ b/sched/signal/sig_suspend.c @@ -75,7 +75,7 @@ * Parameters: * set - signal mask to use while suspended. * - * Return Value: + * Returned Value: * -1 (ERROR) always * * Assumptions: diff --git a/sched/signal/sig_timedwait.c b/sched/signal/sig_timedwait.c index 01b735ffec6935704a455df170a4c97051bbc103..edc8a2c990a388b2275cdd187f753a51c5fd0c5c 100644 --- a/sched/signal/sig_timedwait.c +++ b/sched/signal/sig_timedwait.c @@ -226,7 +226,7 @@ void nxsig_wait_irq(FAR struct tcb_s *wtcb, int errcode) * info - The returned value (may be NULL). * timeout - The amount of time to wait (may be NULL) * - * Return Value: + * Returned Value: * This is an internal OS interface and should not be used by applications. * It follows the NuttX internal error return policy: Zero (OK) is * returned on success. A negated errno value is returned on failure. @@ -483,7 +483,7 @@ int nxsig_timedwait(FAR const sigset_t *set, FAR struct siginfo *info, * info - The returned value (may be NULL). * timeout - The amount of time to wait (may be NULL) * - * Return Value: + * Returned Value: * Signal number that cause the wait to be terminated, otherwise -1 (ERROR) * is returned with errno set to either: * diff --git a/sched/signal/sig_waitinfo.c b/sched/signal/sig_waitinfo.c index 92d11acf2860e324aa3f5d59b729e81589f26604..0bac27e33ff569bcef9577eb2724537789523dea 100644 --- a/sched/signal/sig_waitinfo.c +++ b/sched/signal/sig_waitinfo.c @@ -59,7 +59,7 @@ * set - The pending signal set * info - The returned value * - * Return Value: + * Returned Value: * Signal number that cause the wait to be terminated, otherwise -1 (ERROR) * is returned and the errno variable is set appropriately. * diff --git a/sched/task/task_activate.c b/sched/task/task_activate.c index 47791c7a259504439d6ef9554a674c2ccef133b8..18dad9c71f1442b024ff06576bf43042a7e8aa30 100644 --- a/sched/task/task_activate.c +++ b/sched/task/task_activate.c @@ -60,7 +60,7 @@ * Input Parameters: * tcb - The TCB for the task for the task (same as the task_init argument). * - * Return Value: + * Returned Value: * Always returns OK * ****************************************************************************/ diff --git a/sched/task/task_atexit.c b/sched/task/task_atexit.c index ba26f3ab8cc8d7927d368828159a8197c687f2e6..91c6c9c6394a8e2ba1503391d39445546117cf1f 100644 --- a/sched/task/task_atexit.c +++ b/sched/task/task_atexit.c @@ -82,7 +82,7 @@ * Input Parameters: * func - A pointer to the function to be called when the task exits. * - * Return Value: + * Returned Value: * Zero on success. Non-zero on failure. * ****************************************************************************/ diff --git a/sched/task/task_cancelpt.c b/sched/task/task_cancelpt.c index bcd03621a90a9c762d27a15926ac0ef9838b76d7..9220264278b4f82b61f476de374d43d4233edde0 100644 --- a/sched/task/task_cancelpt.c +++ b/sched/task/task_cancelpt.c @@ -103,7 +103,7 @@ * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * @@ -194,7 +194,7 @@ bool enter_cancellation_point(void) * Input Parameters: * None * - * Returned Value + * Returned Value: * None * ****************************************************************************/ @@ -274,7 +274,7 @@ void leave_cancellation_point(void) * Input Parameters: * None * - * Returned Value + * Returned Value: * true is returned if a cancellation is pending but cannot be performed * now due to the nesting level. * diff --git a/sched/task/task_create.c b/sched/task/task_create.c index c1cdedba29fe6e85193ee8190afdd1bf0221b7bc..f09d04578c057abc271b7e00fac60afc471c4e11 100644 --- a/sched/task/task_create.c +++ b/sched/task/task_create.c @@ -78,7 +78,7 @@ * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. @@ -224,7 +224,7 @@ errout_with_tcb: * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. @@ -265,7 +265,7 @@ int nxtask_create(FAR const char *name, int priority, * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the non-zero process ID of the new task or ERROR if memory is * insufficient or the task cannot be created. The errno will be set in * the failure case to indicate the nature of the error. @@ -306,7 +306,7 @@ int task_create(FAR const char *name, int priority, * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * Returns the positive, non-zero process ID of the new task or a negated * errno value to indicate the nature of any failure. If memory is * insufficient or the task cannot be created -ENOMEM will be returned. diff --git a/sched/task/task_exit.c b/sched/task/task_exit.c index f42ef1421eeac2f8291f4cdddcb66a1be76234e0..a7e8522f4fb4bbc47fad3fd0e6da459febfe26ba 100644 --- a/sched/task/task_exit.c +++ b/sched/task/task_exit.c @@ -69,10 +69,10 @@ * and task_restart(). In the last two cases, the task will be terminated * as though exit() were called. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * OK on success; or ERROR on failure * * Assumeptions: diff --git a/sched/task/task_getgroup.c b/sched/task/task_getgroup.c index 34f52c2c9cc283e8e3c7435f20812d42cfcfc4d6..871d4b1f4ce0db1d8c258c77c59e3d9f2fadf7c5 100644 --- a/sched/task/task_getgroup.c +++ b/sched/task/task_getgroup.c @@ -60,7 +60,7 @@ * Parameters: * pid - The task ID to use in the lookup. * - * Return Value: + * Returned Value: * On success, a pointer to the group task structure is returned. This * function can fail only if there is no group that corresponds to the * groupd ID. diff --git a/sched/task/task_init.c b/sched/task/task_init.c index f9b7002d331aac0cd1726713b547f4667af19df1..2d15f84736eeed4be93587698ef4d47e98456e62 100644 --- a/sched/task/task_init.c +++ b/sched/task/task_init.c @@ -80,7 +80,7 @@ * should be terminated with a NULL argv[] value. If no * parameters are required, argv may be NULL. * - * Return Value: + * Returned Value: * OK on success; ERROR on failure with errno set appropriately. (See * task_schedsetup() for possible failure conditions). On failure, the * caller is responsible for freeing the stack memory and for calling diff --git a/sched/task/task_onexit.c b/sched/task/task_onexit.c index 6d3d47fce6b4df8fe667d36e3c22c3df1da7405c..135ed2b65750e8def4b5cdd8717c2bafdfa3d2b5 100644 --- a/sched/task/task_onexit.c +++ b/sched/task/task_onexit.c @@ -84,7 +84,7 @@ * arg - An argument that will be provided to the on_exit() function when * the task exits. * - * Return Value: + * Returned Value: * Zero on success. Non-zero on failure. * ****************************************************************************/ diff --git a/sched/task/task_recover.c b/sched/task/task_recover.c index 7c6bee2114847f4094b8a11383a75213bd6c8224..c4fea9b9b09c3a9f1876abbe3ca10a9a2a7433e4 100644 --- a/sched/task/task_recover.c +++ b/sched/task/task_recover.c @@ -63,10 +63,10 @@ * via pthread_cancel. I checks checks for semaphores, message queue, and * watchdog timer resources stranded in bad conditions. * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/task/task_reparent.c b/sched/task/task_reparent.c index 075a391940e3fde92b2ff560bcd99df860513e34..88f2bb8b459710017a2ae0ca44cfed535650ee26 100644 --- a/sched/task/task_reparent.c +++ b/sched/task/task_reparent.c @@ -64,7 +64,7 @@ * of the current parent task) * chpid - PID of the child to be reparented. * - * Return Value: + * Returned Value: * 0 (OK) on success; A negated errno value on failure. * ****************************************************************************/ diff --git a/sched/task/task_restart.c b/sched/task/task_restart.c index c7ad08e3843e77514dc4d6e320f339956f467e18..a8ff6570681a18ad14a3a492240273f9c047cdc0 100644 --- a/sched/task/task_restart.c +++ b/sched/task/task_restart.c @@ -63,11 +63,11 @@ * reinitialized with same ID, priority, original entry point, stack size, * and parameters it had when it was first started. * - * Inputs: + * Input Parameters: * pid - The task ID of the task to delete. An ID of zero signifies the * calling task. * - * Return Value: + * Returned Value: * OK on sucess; ERROR on failure. * * This function can fail if: diff --git a/sched/task/task_setup.c b/sched/task/task_setup.c index fc2ff3f6c8c56a5953cc1b4dc907bd9a5123f515..8389e2bc544223c72964d51ebf680d1c89184bc8 100644 --- a/sched/task/task_setup.c +++ b/sched/task/task_setup.c @@ -82,10 +82,10 @@ static const char g_noname[] = ""; * Description: * This function assigns the next unique task ID to a task. * - * Inputs: + * Input Parameters: * tcb - TCB of task * - * Return: + * Returned Value: * OK on success; ERROR on failure (errno is not set) * ****************************************************************************/ @@ -344,7 +344,7 @@ static inline void task_dupdspace(FAR struct tcb_s *tcb) * entry - Thread user entry point * ttype - Type of the new thread: task, pthread, or kernel thread * - * Return Value: + * Returned Value: * OK on success; ERROR on failure. * * This function can only failure is it is unable to assign a new, unique @@ -449,7 +449,7 @@ static int thread_schedsetup(FAR struct tcb_s *tcb, int priority, * tcb - Address of the new task's TCB * name - Name of the new task * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -491,7 +491,7 @@ static void task_namesetup(FAR struct task_tcb_s *tcb, FAR const char *name) * terminated with a NULL argv[] value. If no parameters are * required, argv may be NULL. * - * Return Value: + * Returned Value: * Zero (OK) on success; a negated errno on failure. * ****************************************************************************/ @@ -631,7 +631,7 @@ static inline int task_stackargsetup(FAR struct task_tcb_s *tcb, * main - Application start point of the new task * ttype - Type of the new thread: task or kernel thread * - * Return Value: + * Returned Value: * OK on success; ERROR on failure. * * This function can only failure is it is unable to assign a new, unique @@ -664,7 +664,7 @@ int task_schedsetup(FAR struct task_tcb_s *tcb, int priority, start_t start, * entry - Entry point of the new pthread * ttype - Type of the new thread: task, pthread, or kernel thread * - * Return Value: + * Returned Value: * OK on success; ERROR on failure. * * This function can only failure is it is unable to assign a new, unique @@ -709,7 +709,7 @@ int pthread_schedsetup(FAR struct pthread_tcb_s *tcb, int priority, * terminated with a NULL argv[] value. If no parameters are * required, argv may be NULL. * - * Return Value: + * Returned Value: * OK * ****************************************************************************/ diff --git a/sched/task/task_start.c b/sched/task/task_start.c index b1f1e3cd1a8c7e83b46cd82d039bc7b69e9ea848..a0c88329e52282fe32844c85cd44760fd0c70a11 100644 --- a/sched/task/task_start.c +++ b/sched/task/task_start.c @@ -70,10 +70,10 @@ * execution of a task. It receives initial control when the task is * started and calls main entry point of the newly started task. * - * Inputs: + * Input Parameters: * None * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/task/task_starthook.c b/sched/task/task_starthook.c index 6bf8de96955d1b3e2cb97baff8b1863817066535..908629a646e4d43e308c2ba8ba1b78970968cbeb 100644 --- a/sched/task/task_starthook.c +++ b/sched/task/task_starthook.c @@ -58,12 +58,12 @@ * The start hook is useful, for example, for setting up automatic * configuration of C++ constructors. * - * Inputs: + * Input Parameters: * tcb - The new, unstarted task task that needs the start hook * starthook - The pointer to the start hook function * arg - The argument to pass to the start hook function. * - * Return: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/task/task_terminate.c b/sched/task/task_terminate.c index 2edb7492779e72a3accfbd02f0cf67b18a05a925..8215d70f9c6454e6df21d0ff73a2902248595ce6 100644 --- a/sched/task/task_terminate.c +++ b/sched/task/task_terminate.c @@ -84,13 +84,13 @@ * exit() and pthread_exit(). In those cases task_exithook() has already * been called with nonblocking == false; * - * Inputs: + * Input Parameters: * pid - The task ID of the task to delete. A pid of zero * signifies the calling task. * nonblocking - True: The task is an unhealthy, partially torn down * state and is not permitted to block. * - * Return Value: + * Returned Value: * OK on success; or ERROR on failure * * This function can fail if the provided pid does not correspond to a diff --git a/sched/task/task_vfork.c b/sched/task/task_vfork.c index 7b4f53a12378022af79531670ba495a878875f5a..124a7fd077991b55742c0ea628ba7f7fc884b577 100644 --- a/sched/task/task_vfork.c +++ b/sched/task/task_vfork.c @@ -82,7 +82,7 @@ * tcb - Address of the new task's TCB * name - Name of the new task * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -110,7 +110,7 @@ static inline void vfork_namesetup(FAR struct tcb_s *parent, * parent - Address of the parent task's TCB * child - Address of the child task's TCB * - * Return Value: + * Returned Value: * Zero (OK) on success; a negated errno on failure. * ****************************************************************************/ @@ -177,7 +177,7 @@ static inline int vfork_stackargsetup(FAR struct tcb_s *parent, * parent - Address of the parent task's TCB * child - Address of the child task's TCB * - * Return Value: + * Returned Value: * Zero (OK) on success; a negated errno on failure. * ****************************************************************************/ diff --git a/sched/timer/timer_create.c b/sched/timer/timer_create.c index e6c775093d2dac195cc485626e23c7248793a0ce..f842690a9274f4f53768b320a956356848f155d1 100644 --- a/sched/timer/timer_create.c +++ b/sched/timer/timer_create.c @@ -146,7 +146,7 @@ static FAR struct posix_timer_s *timer_allocate(void) * asynchronous notification. evp may be NULL (see above). * timerid - The pre-thread timer created by the call to timer_create(). * - * Return Value: + * Returned Value: * If the call succeeds, timer_create() will return 0 (OK) and update the * location referenced by timerid to a timer_t, which can be passed to the * other per-thread timer calls. If an error occurs, the function will diff --git a/sched/timer/timer_delete.c b/sched/timer/timer_delete.c index 6d6e5bebc12fefcf0932c522a7efc5e29242eff5..63a189427db3e7d982fb5c8fd0ffa5748ef3bd57 100644 --- a/sched/timer/timer_delete.c +++ b/sched/timer/timer_delete.c @@ -64,7 +64,7 @@ * timerid - The per-thread timer, previously created by the call to * timer_create(), to be deleted. * - * Return Value: + * Returned Value: * If the call succeeds, timer_create() will return 0 (OK). Otherwise, * the function will return a value of -1 (ERROR) and set errno to * indicate the error. diff --git a/sched/timer/timer_getoverrun.c b/sched/timer/timer_getoverrun.c index da07dcedcacc5936ebed171a04559cce88a8b443..c5aaee879980c85a465874f1f33caabd46a4c613 100644 --- a/sched/timer/timer_getoverrun.c +++ b/sched/timer/timer_getoverrun.c @@ -76,7 +76,7 @@ * timerid - The pre-thread timer, previously created by the call to * timer_create(), whose overrun count will be returned.. * - * Return Value: + * Returned Value: * If the timer_getoverrun() function succeeds, it will return the timer * expiration overrun count as explained above. timer_getoverrun() will * fail if: diff --git a/sched/timer/timer_gettime.c b/sched/timer/timer_gettime.c index 25e016876552f7303729f4c0aa219209a1e15826..138b7a5f7d8aae5739c6e96350b1730afb1c904d 100644 --- a/sched/timer/timer_gettime.c +++ b/sched/timer/timer_gettime.c @@ -68,7 +68,7 @@ * timerid - The pre-thread timer, previously created by the call to * timer_create(), whose remaining time count will be returned.. * - * Return Value: + * Returned Value: * If the timer_gettime() succeeds, a value of 0 (OK) will be returned. * If an error occurs, the value -1 (ERROR) will be returned, and errno * set to indicate the error. diff --git a/sched/timer/timer_initialize.c b/sched/timer/timer_initialize.c index 25a64b1a51afef22525b569370b96694350f320b..1ab262c26e972c9573f05bbd9684bedf03531ddd 100644 --- a/sched/timer/timer_initialize.c +++ b/sched/timer/timer_initialize.c @@ -91,7 +91,7 @@ volatile sq_queue_t g_alloctimers; * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -132,7 +132,7 @@ void weak_function timer_initialize(void) * Parameters: * pid - the task ID of the thread that exited * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/timer/timer_release.c b/sched/timer/timer_release.c index 2608092a16f9a2da6bd8f0bdca6eed5cdd9f99fc..eef4fcae6af522397d03a6f1f2b72e46924d2cdd 100644 --- a/sched/timer/timer_release.c +++ b/sched/timer/timer_release.c @@ -106,7 +106,7 @@ static inline void timer_free(struct posix_timer_s *timer) * timer - The per-thread timer, previously created by the call to * timer_create(), to be deleted. * - * Return Value: + * Returned Value: * If the call succeeds, timer_release() will return 0 (OK) or 1 (meaning * that the timer is still valid). Otherwise, the function will return a * negated errno value: diff --git a/sched/timer/timer_settime.c b/sched/timer/timer_settime.c index 3724ed5ebddda015d38cef4951d2d674322dc3e4..3311de1c7f58b0cc6b42fe739d196e321dbf635a 100644 --- a/sched/timer/timer_settime.c +++ b/sched/timer/timer_settime.c @@ -77,7 +77,7 @@ static void timer_timeout(int argc, wdparm_t itimer); * Parameters: * timer - A reference to the POSIX timer that just timed out * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -132,7 +132,7 @@ static inline void timer_signotify(FAR struct posix_timer_s *timer) * Parameters: * timer - A reference to the POSIX timer that just timed out * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -165,7 +165,7 @@ static inline void timer_restart(FAR struct posix_timer_s *timer, * itimer - A reference to the POSIX timer that just timed out * signo - The signal to use to wake up the task * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -284,7 +284,7 @@ static void timer_timeout(int argc, wdparm_t itimer) * ovalue - A location in which to return the time remaining from the * previous timer setting. (ignored) * - * Return Value: + * Returned Value: * If the timer_settime() succeeds, a value of 0 (OK) will be returned. * If an error occurs, the value -1 (ERROR) will be returned, and errno set * to indicate the error. diff --git a/sched/wdog/wd_cancel.c b/sched/wdog/wd_cancel.c index 040385d31d50c39abc556cc974fbe73ebdfbc379..6eaab00c3be2383e131c8460ff933efaa4a935af 100644 --- a/sched/wdog/wd_cancel.c +++ b/sched/wdog/wd_cancel.c @@ -64,7 +64,7 @@ * Parameters: * wdog - ID of the watchdog to cancel. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; A negated errno value is returned to * indicate the nature of any failure. * diff --git a/sched/wdog/wd_create.c b/sched/wdog/wd_create.c index 8bd64961536c7a953d7f5689c140c3533f2c7275..bc8509bad70a9a108610c0abbea6a7a5dad81f55 100644 --- a/sched/wdog/wd_create.c +++ b/sched/wdog/wd_create.c @@ -63,7 +63,7 @@ * Parameters: * None * - * Return Value: + * Returned Value: * Pointer to watchdog (i.e., the watchdog ID), or NULL if insufficient * watchdogs are available. * diff --git a/sched/wdog/wd_delete.c b/sched/wdog/wd_delete.c index 785d4ec87c3cf2585336efbaf75388097d4d6271..46fe6cef5aaf6bc4cc4cefd72c64bdf5c474965e 100644 --- a/sched/wdog/wd_delete.c +++ b/sched/wdog/wd_delete.c @@ -67,7 +67,7 @@ * wdog - The watchdog ID to delete. This is actually a pointer to a * watchdog structure. * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * diff --git a/sched/wdog/wd_gettime.c b/sched/wdog/wd_gettime.c index 0e48dec2f3888b969b34284c4e2b8c8e213290dd..1a5c31f9ccc0951269d69b8eb762624cdc9d00fd 100644 --- a/sched/wdog/wd_gettime.c +++ b/sched/wdog/wd_gettime.c @@ -58,7 +58,7 @@ * Parameters: * wdog - watchdog ID * - * Return Value: + * Returned Value: * The time in system ticks remaining until the watchdog time expires. * Zero means either that wdog is not valid or that the wdog has already * expired. diff --git a/sched/wdog/wd_initialize.c b/sched/wdog/wd_initialize.c index 54b98e4838431a9c24ebc511b9a3453a50763ce5..17e1e001a590925d9d268d34fe663412b7ce2c6f 100644 --- a/sched/wdog/wd_initialize.c +++ b/sched/wdog/wd_initialize.c @@ -90,7 +90,7 @@ static struct wdog_s g_wdpool[CONFIG_PREALLOC_WDOGS]; * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: diff --git a/sched/wdog/wd_recover.c b/sched/wdog/wd_recover.c index 2a4847471b3e61c023ba520d329723bcd70aa0be..4b2e28368bcac8cc2d2be82eda3834329e32885f 100644 --- a/sched/wdog/wd_recover.c +++ b/sched/wdog/wd_recover.c @@ -58,10 +58,10 @@ * task_delete() or via pthread_cancel(). It checks if the deleted task * is waiting for a timed event and if so cancels the timeout * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/wdog/wd_start.c b/sched/wdog/wd_start.c index f861cbfab791eefd7b986f3617d555d285ecfaff..ec7fa96ec9d3804cea70c0264a26b217a0356f23 100644 --- a/sched/wdog/wd_start.c +++ b/sched/wdog/wd_start.c @@ -101,7 +101,7 @@ typedef void (*wdentry4_t)(int argc, wdparm_t arg1, wdparm_t arg2, * Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -209,7 +209,7 @@ static inline void wd_expiration(void) * wdentry - function to call on timeout * parm1..4 - parameters to pass to wdentry * - * Return Value: + * Returned Value: * Zero (OK) is returned on success; a negated errno value is return to * indicate the nature of any failure. * @@ -406,7 +406,7 @@ int wd_start(WDOG_ID wdog, int32_t delay, wdentry_t wdentry, int argc, ...) * this function is called on each timer interrupt and a value of one * is implicit. * - * Return Value: + * Returned Value: * If CONFIG_SCHED_TICKLESS is defined then the number of ticks for the * next delay is provided (zero if no delay). Otherwise, this function * has no returned value. diff --git a/sched/wdog/wdog.h b/sched/wdog/wdog.h index 4b51b2355f8cb7cbc5dc4383676445e601464e49..aed26579395a7ed61b3af17ab5cd77ae02ada0d0 100644 --- a/sched/wdog/wdog.h +++ b/sched/wdog/wdog.h @@ -93,7 +93,7 @@ extern uint16_t g_wdnfree; * Parameters: * None * - * Return Value: + * Returned Value: * None * * Assumptions: @@ -120,7 +120,7 @@ void weak_function wd_initialize(void); * this function is called on each timer interrupt and a value of one * is implicit. * - * Return Value: + * Returned Value: * If CONFIG_SCHED_TICKLESS is defined then the number of ticks for the * next delay is provided (zero if no delay). Otherwise, this function * has no returned value. @@ -144,10 +144,10 @@ void wd_timer(void); * task_delete() or via pthread_cancel(). It checks if the deleted task * is waiting for a timed event and if so cancels the timeout * - * Inputs: + * Input Parameters: * tcb - The TCB of the terminated task or thread * - * Return Value: + * Returned Value: * None. * * Assumptions: diff --git a/sched/wqueue/kwork_cancel.c b/sched/wqueue/kwork_cancel.c index 659d9688b7010e662b32c24a5614ceda8f6d1727..526a3d906aade2cdb5f59a039268d0aa9a6264ee 100644 --- a/sched/wqueue/kwork_cancel.c +++ b/sched/wqueue/kwork_cancel.c @@ -63,7 +63,7 @@ * After work has been cancelled, it may be re-queue by calling work_queue() * again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * work - The previously queue work structure to cancel * @@ -124,7 +124,7 @@ static int work_qcancel(FAR struct kwork_wqueue_s *wqueue, * user mode work queue. After work has been cancelled, it may be re-queue * by calling work_queue() again. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (must be HPWORK or LPWORK) * work - The previously queue work structure to cancel * diff --git a/sched/wqueue/kwork_hpthread.c b/sched/wqueue/kwork_hpthread.c index 7389220452e3a18a5221b42fb550dace9190bf96..a923ad1122944931ea75b484cc7ef52ed3e87b3f 100644 --- a/sched/wqueue/kwork_hpthread.c +++ b/sched/wqueue/kwork_hpthread.c @@ -82,7 +82,7 @@ struct hp_wqueue_s g_hpwork; * bring up. This entry point is referenced by OS internally and should * not be accessed by application logic. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: @@ -132,7 +132,7 @@ static int work_hpthread(int argc, char *argv[]) * Description: * Start the high-priority, kernel-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/sched/wqueue/kwork_inherit.c b/sched/wqueue/kwork_inherit.c index c648c4b4ede5d4d7ef7ca74d7b70b67ef5caabad..6647a415c7e2c50e25057feaaa01d82b6c605a34 100644 --- a/sched/wqueue/kwork_inherit.c +++ b/sched/wqueue/kwork_inherit.c @@ -65,7 +65,7 @@ * Parameters: * reqprio - Requested minimum worker thread priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -178,7 +178,7 @@ static void lpwork_boostworker(pid_t wpid, uint8_t reqprio) * reqprio - Previously requested minimum worker thread priority to be * "unboosted" * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -324,7 +324,7 @@ static void lpwork_restoreworker(pid_t wpid, uint8_t reqprio) * Parameters: * reqprio - Requested minimum worker thread priority * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -370,7 +370,7 @@ void lpwork_boostpriority(uint8_t reqprio) * reqprio - Previously requested minimum worker thread priority to be * "unboosted" * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/sched/wqueue/kwork_lpthread.c b/sched/wqueue/kwork_lpthread.c index dcb0726efe7aedb173e9f5c650369875c5e447d8..5d6911fef3f235593828ade12a46e122760cdae1 100644 --- a/sched/wqueue/kwork_lpthread.c +++ b/sched/wqueue/kwork_lpthread.c @@ -84,7 +84,7 @@ struct lp_wqueue_s g_lpwork; * bring up. This entry point is referenced by OS internally and should * not be accessed by application logic. * - * Input parameters: + * Input Parameters: * argc, argv (not used) * * Returned Value: @@ -168,7 +168,7 @@ static int work_lpthread(int argc, char *argv[]) * Description: * Start the low-priority, kernel-mode worker thread(s) * - * Input parameters: + * Input Parameters: * None * * Returned Value: diff --git a/sched/wqueue/kwork_process.c b/sched/wqueue/kwork_process.c index 80c7befca291423b937e27e60efaa42156fb9b11..2266949f5f730708a3d033079870ae1a235904ba 100644 --- a/sched/wqueue/kwork_process.c +++ b/sched/wqueue/kwork_process.c @@ -85,7 +85,7 @@ * part of the internal implementation of each work queue; it should not * be called from application level logic. * - * Input parameters: + * Input Parameters: * wqueue - Describes the work queue to be processed * * Returned Value: diff --git a/sched/wqueue/kwork_queue.c b/sched/wqueue/kwork_queue.c index 8b5a8e6f5a30341ee008daca89689f2ce783fcbd..483a7e55af3c6c00e83bf0f43ed9567c06265c9b 100644 --- a/sched/wqueue/kwork_queue.c +++ b/sched/wqueue/kwork_queue.c @@ -71,7 +71,7 @@ * from the queue, or (2) work_cancel() has been called to cancel the work * and remove it from the work queue. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked @@ -144,7 +144,7 @@ static void work_qqueue(FAR struct kwork_wqueue_s *wqueue, * previous work as been performed and removed from the queue, then any * pending work will be canceled and lost. * - * Input parameters: + * Input Parameters: * qid - The work queue ID (index) * work - The work structure to queue * worker - The worker callback to be invoked. The callback will invoked diff --git a/sched/wqueue/kwork_signal.c b/sched/wqueue/kwork_signal.c index 2efec2ea45961f9b15019ea4b9fbd6698cdf9a82..73ca066a6118beb95d680069b8e8fd43266f5f99 100644 --- a/sched/wqueue/kwork_signal.c +++ b/sched/wqueue/kwork_signal.c @@ -61,7 +61,7 @@ * is used internally by the work logic but could also be used by the * user to force an immediate re-assessment of pending work. * - * Input parameters: + * Input Parameters: * qid - The work queue ID * * Returned Value: diff --git a/sched/wqueue/wqueue.h b/sched/wqueue/wqueue.h index 701af9b300d43bbce6e6f606fcbceb3b5fc18bcd..7e7942ef02a3292a4d46f65633241549bc56476c 100644 --- a/sched/wqueue/wqueue.h +++ b/sched/wqueue/wqueue.h @@ -134,7 +134,7 @@ extern struct lp_wqueue_s g_lpwork; * Description: * Start the high-priority, kernel-mode work queue. * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -153,7 +153,7 @@ int work_hpstart(void); * Description: * Start the low-priority, kernel-mode worker thread(s) * - * Input parameters: + * Input Parameters: * None * * Returned Value: @@ -175,7 +175,7 @@ int work_lpstart(void); * part of the internal implementation of each work queue; it should not * be called from application level logic. * - * Input parameters: + * Input Parameters: * wqueue - Describes the work queue to be processed * period - The polling period in clock ticks * wndx - The worker thread index diff --git a/wireless/ieee802154/ieee802154_primitive.c b/wireless/ieee802154/ieee802154_primitive.c index 35db231fcd467e10497eabebc796630765b525e1..4b3e14d5943f3974bf43623a7f4b5b9910b45690 100644 --- a/wireless/ieee802154/ieee802154_primitive.c +++ b/wireless/ieee802154/ieee802154_primitive.c @@ -135,10 +135,10 @@ static bool g_poolinit = false; * be called early in the initialization sequence before any radios * begin operation. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -224,10 +224,10 @@ void ieee802154_primitivepool_initialize(void) * list. If that the list is empty, then the primitive structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated primitive structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -341,10 +341,10 @@ FAR struct ieee802154_primitive_s *ieee802154_primitive_allocate(void) * structure. If the primitive structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * prim - primitive structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/ diff --git a/wireless/ieee802154/mac802154_device.c b/wireless/ieee802154/mac802154_device.c index 3ab60e4a08f1e85feaa5c8d57c2ed1db61af31aa..13dcc31a0f01a12c49d9375ab72994a700905662 100644 --- a/wireless/ieee802154/mac802154_device.c +++ b/wireless/ieee802154/mac802154_device.c @@ -846,7 +846,7 @@ static int mac802154dev_rxframe(FAR struct mac802154_chardevice_s *dev, * minor - The device minor number. The IEEE802.15.4 MAC character device * will be registered as /dev/ieeeN where N is the minor number * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/wireless/ieee802154/mac802154_loopback.c b/wireless/ieee802154/mac802154_loopback.c index 1eabcd1a786dfbeff99d35fcfc94ea3620c92d07..04dbd9139ec0c2f657c57bee7c9ae308d38f425c 100644 --- a/wireless/ieee802154/mac802154_loopback.c +++ b/wireless/ieee802154/mac802154_loopback.c @@ -888,7 +888,7 @@ static int lo_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -911,7 +911,7 @@ static int lo_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -983,7 +983,7 @@ static int lo_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/wireless/ieee802154/mac802154_netdev.c b/wireless/ieee802154/mac802154_netdev.c index aa4abe8ab2ae46f44dab4dbbb1350ef3b67fc2ca..0a11caf0172d50f3508e1e115ce01f6d8d5435f9 100644 --- a/wireless/ieee802154/mac802154_netdev.c +++ b/wireless/ieee802154/mac802154_netdev.c @@ -664,7 +664,7 @@ static void macnet_txpoll_expiry(int argc, wdparm_t arg, ...) * Description: * Get the extended address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * eaddr - The location in which to return the extended address. * @@ -701,7 +701,7 @@ static int macnet_coord_eaddr(FAR struct radio_driver_s *radio, * Description: * Get the short address of the PAN coordinator. * - * Input parameters: + * Input Parameters: * radio - Reference to a radio network driver state instance. * saddr - The location in which to return the short address. * @@ -1169,7 +1169,7 @@ static int macnet_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1198,7 +1198,7 @@ static int macnet_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -1280,7 +1280,7 @@ static int macnet_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * @@ -1357,7 +1357,7 @@ static int macnet_properties(FAR struct radio_driver_s *netdev, * Input Parameters: * mac - Pointer to the mac layer struct to be registered. * - * Returned Values: + * Returned Value: * Zero (OK) is returned on success. Otherwise a negated errno value is * returned to indicate the nature of the failure. * diff --git a/wireless/pktradio/pktradio_loopback.c b/wireless/pktradio/pktradio_loopback.c index c9e144eb4d7a72955ac7148758dc092928ded6a7..71c963126d43bf0715c4a81229d73b6a80436ed1 100644 --- a/wireless/pktradio/pktradio_loopback.c +++ b/wireless/pktradio/pktradio_loopback.c @@ -848,7 +848,7 @@ static int lo_ioctl(FAR struct net_driver_s *dev, int cmd, * Description: * Calculate the MAC header length given the frame meta-data. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -871,7 +871,7 @@ static int lo_get_mhrlen(FAR struct radio_driver_s *netdev, * Description: * Requests the transfer of a list of frames to the MAC. * - * Input parameters: + * Input Parameters: * netdev - The networkd device that will mediate the MAC interface * meta - Obfuscated metadata structure needed to create the radio * MAC header @@ -943,7 +943,7 @@ static int lo_req_data(FAR struct radio_driver_s *netdev, * run time. This information is provided to the 6LoWPAN network via the * following structure. * - * Input parameters: + * Input Parameters: * netdev - The network device to be queried * properties - Location where radio properities will be returned. * diff --git a/wireless/pktradio/pktradio_metadata.c b/wireless/pktradio/pktradio_metadata.c index 585b6bac23fcc28a188488a73b0b393c81597e9e..4dce2ec7562ae69b03f0fffe1915b48a4d0a664a 100644 --- a/wireless/pktradio/pktradio_metadata.c +++ b/wireless/pktradio/pktradio_metadata.c @@ -86,10 +86,10 @@ static struct pktradio_metadata_s g_metadata_pool[CONFIG_PKTRADIO_NRXMETA]; * be called early in the initialization sequence before any radios * begin operation. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * None * ****************************************************************************/ @@ -136,10 +136,10 @@ void pktradio_metadata_initialize(void) * list. If that the list is empty, then the meta-data structure will be * allocated from the dynamic memory pool. * - * Inputs: + * Input Parameters: * None * - * Return Value: + * Returned Value: * A reference to the allocated metadata structure. All user fields in this * structure have been zeroed. On a failure to allocate, NULL is * returned. @@ -216,10 +216,10 @@ FAR struct pktradio_metadata_s *pktradio_metadata_allocate(void) * structure. If the metadata structure was allocated dynamically it will * be deallocated. * - * Inputs: + * Input Parameters: * metadata - metadata structure to free * - * Return Value: + * Returned Value: * None * ****************************************************************************/