From 8b986d76970b784e30d37b2617e4c6864aa3e3f2 Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Tue, 18 Apr 2017 15:56:26 -0700 Subject: [PATCH] spell: fix comment typos: /include Change-Id: I20d315ef5f8a2da5cfe28b194126907adda9e13c Signed-off-by: David B. Kinder --- include/console.h | 4 ++-- include/device.h | 4 ++-- include/disk_access.h | 2 +- include/dma.h | 6 +++--- include/gpio.h | 10 +++++----- include/ipm.h | 2 +- include/irq.h | 2 +- include/kernel.h | 22 +++++++++++----------- include/legacy.h | 20 ++++++++++---------- include/linker-tool-gcc.h | 2 +- 10 files changed, 37 insertions(+), 37 deletions(-) diff --git a/include/console.h b/include/console.h index 54679ff0bc0..3b43864afaa 100644 --- a/include/console.h +++ b/include/console.h @@ -15,7 +15,7 @@ extern "C" { * * This function should be called once to initialize pull-style * access to console via console_getchar() function. This function - * supercedes, and incompatible with, callback (push-style) console + * supersedes, and incompatible with, callback (push-style) console * handling (via console_input_fn callback, etc.). * * @return N/A @@ -40,7 +40,7 @@ uint8_t console_getchar(void); * * This function should be called once to initialize pull-style * access to console via console_getline() function. This function - * supercedes, and incompatible with, callback (push-style) console + * supersedes, and incompatible with, callback (push-style) console * handling (via console_input_fn callback, etc.). * * @return N/A diff --git a/include/device.h b/include/device.h index 0ca45eb6ef1..6881c9eea92 100644 --- a/include/device.h +++ b/include/device.h @@ -172,7 +172,7 @@ static const int _INIT_LEVEL_APPLICATION = 1; * * @param name The same as dev_name provided to DEVICE_INIT() * - * @return The exanded name of the device object created by DEVICE_INIT() + * @return The expanded name of the device object created by DEVICE_INIT() */ #define DEVICE_NAME_GET(name) (_CONCAT(__device_, name)) @@ -201,7 +201,7 @@ static const int _INIT_LEVEL_APPLICATION = 1; * This is often useful when configuring interrupts statically in a * device's init or per-instance config function, as the init function * itself is required by DEVICE_INIT() and use of DEVICE_GET() - * inside it creates a circular dependeny. + * inside it creates a circular dependency. * * @param name Device name */ diff --git a/include/disk_access.h b/include/disk_access.h index 09a09cca7d3..92a3408c3bb 100644 --- a/include/disk_access.h +++ b/include/disk_access.h @@ -43,7 +43,7 @@ extern "C" { #define DISK_STATUS_WR_PROTECT 0x04 /* - * @brief perform any intialization + * @brief perform any initialization * * This call is made by the consumer before doing any IO calls so that the * disk or the backing device can do any initialization. diff --git a/include/dma.h b/include/dma.h index ac3565640ac..f6ededd7dce 100644 --- a/include/dma.h +++ b/include/dma.h @@ -132,7 +132,7 @@ struct dma_transfer_config { * start. HW specific. * flow_control_mode [ 12 ] - 0-source request served upon data * availability - * 1-source request postphoned until + * 1-source request postponed until * destination request happens * reserved [ 13 : 15 ] */ @@ -384,7 +384,7 @@ static inline int __deprecated dma_transfer_stop(struct device *dev, * * WARNING: This look-up works for most controllers, but *may* not work for * yours. Ensure your controller expects the most common register - * bit values before using this convienience function. If your + * bit values before using this convenience function. If your * controller does not support these values, you will have to write * your own look-up inside the controller driver. * @@ -413,7 +413,7 @@ static inline enum dma_burst_length dma_width_index(uint32_t size) * * WARNING: This look-up works for most controllers, but *may* not work for * yours. Ensure your controller expects the most common register - * bit values before using this convienience function. If your + * bit values before using this convenience function. If your * controller does not support these values, you will have to write * your own look-up inside the controller driver. * diff --git a/include/gpio.h b/include/gpio.h index c6fc65f1820..eb26849a20e 100644 --- a/include/gpio.h +++ b/include/gpio.h @@ -133,7 +133,7 @@ extern "C" { * when output is high. * * The DISCONNECT drive strength indicates that the pin is placed in a - * high impediance state and not driven, this option is used to + * high impedance state and not driven, this option is used to * configure hardware that supports a open collector drive mode. * * The interface supports two different drive strengths: @@ -141,7 +141,7 @@ extern "C" { * ALT - The highest drive strength supported by the HW * * On hardware that supports only one standard drive strength, both - * DFLT and ALT have the same behaviour. + * DFLT and ALT have the same behavior. * * On hardware that does not support a disconnect mode, DISCONNECT * will behave the same as DFLT. @@ -425,8 +425,8 @@ static inline int gpio_port_configure(struct device *port, int flags) * * Write the output state of a port. The state of each pin is * represented by one bit in the value. Pin 0 corresponds to the - * least signficiant bit, pin 31 corresponds to the most significant - * bit. For ports with less that 32 physical pins the most signficant + * least significant bit, pin 31 corresponds to the most significant + * bit. For ports with less that 32 physical pins the most significant * bits which do not correspond to a physical pin are ignored. * * @param port Pointer to the device structure for the driver instance. @@ -445,7 +445,7 @@ static inline int gpio_port_write(struct device *port, uint32_t value) * * Read the input state of a port. The state of each pin is * represented by one bit in the returned value. Pin 0 corresponds to - * the least signficiant bit, pin 31 corresponds to the most + * the least significant bit, pin 31 corresponds to the most * significant bit. Unused bits for ports with less that 32 physical * pins are returned as 0. * diff --git a/include/ipm.h b/include/ipm.h index b4572f23c1f..c388cccd0bc 100644 --- a/include/ipm.h +++ b/include/ipm.h @@ -79,7 +79,7 @@ typedef void (*ipm_register_callback_t)(struct device *port, ipm_callback_t cb, /** * @typedef ipm_set_enabled_t - * @brief Callback API upon emablement of interrupts + * @brief Callback API upon enablement of interrupts * * See @a ipm_set_enabled() for argument definitions. */ diff --git a/include/irq.h b/include/irq.h index 661babf065f..76b21ca63de 100644 --- a/include/irq.h +++ b/include/irq.h @@ -60,7 +60,7 @@ extern "C" { * not go through common interrupt handling code. They must be implemented in * such a way that it is safe to put them directly in the vector table. For * ISRs written in C, The ISR_DIRECT_DECLARE() macro will do this - * automatically. For ISRs wriiten in assembly it is entirely up to the + * automatically. For ISRs written in assembly it is entirely up to the * developer to ensure that the right steps are taken. * * This type of interrupt currently has a few limitations compared to normal diff --git a/include/kernel.h b/include/kernel.h index 21733731e19..7c2795397ef 100644 --- a/include/kernel.h +++ b/include/kernel.h @@ -307,7 +307,7 @@ extern k_tid_t k_current_get(void); * * @param thread ID of thread to cancel. * - * @retval 0 Thread spawning cancelled. + * @retval 0 Thread spawning canceled. * @retval -EINVAL Thread has already started executing. */ extern int k_thread_cancel(k_tid_t thread); @@ -494,7 +494,7 @@ extern void k_thread_resume(k_tid_t thread); * ensures that no thread runs for more than the specified time limit * before other threads of that priority are given a chance to execute. * Any thread whose priority is higher than @a prio is exempted, and may - * execute as long as desired without being pre-empted due to time slicing. + * execute as long as desired without being preempted due to time slicing. * * Time slicing only limits the maximum amount of time a thread may continuously * execute. Once the scheduler selects a thread for execution, there is no @@ -1754,7 +1754,7 @@ extern void k_delayed_work_init(struct k_delayed_work *work, * * This routine schedules work item @a work to be processed by workqueue * @a work_q after a delay of @a delay milliseconds. The routine initiates - * an asychronous countdown for the work item and then returns to the caller. + * an asynchronous countdown for the work item and then returns to the caller. * Only when the countdown completes is the work item actually submitted to * the workqueue and becomes pending. * @@ -1789,14 +1789,14 @@ extern int k_delayed_work_submit_to_queue(struct k_work_q *work_q, * @brief Cancel a delayed work item. * * This routine cancels the submission of delayed work item @a work. - * A delayed work item can only be cancelled while its countdown is still + * A delayed work item can only be canceled while its countdown is still * underway. * * @note Can be called by ISRs. * * @param work Address of delayed work item. * - * @retval 0 Work item countdown cancelled. + * @retval 0 Work item countdown canceled. * @retval -EINPROGRESS Work item is already pending. * @retval -EINVAL Work item is being processed or has completed its work. */ @@ -1833,7 +1833,7 @@ static inline void k_work_submit(struct k_work *work) * * This routine schedules work item @a work to be processed by the system * workqueue after a delay of @a delay milliseconds. The routine initiates - * an asychronous countdown for the work item and then returns to the caller. + * an asynchronous countdown for the work item and then returns to the caller. * Only when the countdown completes is the work item actually submitted to * the workqueue and becomes pending. * @@ -2127,7 +2127,7 @@ static inline unsigned int k_sem_count_get(struct k_sem *sem) * @brief Alert handler function type. * * An alert's alert handler function is invoked by the system workqueue - * when the alert is signalled. The alert handler function is optional, + * when the alert is signaled. The alert handler function is optional, * and is only invoked if the alert has been initialized with one. * * @param alert Address of the alert. @@ -2984,13 +2984,13 @@ struct k_mem_pool { /* * Use .altmacro to be able to recalculate values and pass them as string - * arguments when calling assembler macros resursively + * arguments when calling assembler macros recursively */ __asm__(".altmacro\n\t"); /* * Recursively calls a macro - * The followig global symbols need to be initialized: + * The following global symbols need to be initialized: * __memory_pool_max_block_size - maximal size of the memory block * __memory_pool_min_block_size - minimal size of the memory block * Notes: @@ -3015,7 +3015,7 @@ __asm__(".macro __do_recurse macro_name, name, n_max\n\t" * Macro allocates space in memory for the array of k_mem_pool_quad_block * structures and recursively calls itself for the next array, 4 times * larger. - * The followig global symbols need to be initialized: + * The following global symbols need to be initialized: * __memory_pool_max_block_size - maximal size of the memory block * __memory_pool_min_block_size - minimal size of the memory block * __memory_pool_quad_block_size - sizeof(struct k_mem_pool_quad_block) @@ -3034,7 +3034,7 @@ __asm__(".macro _build_quad_blocks n_max, name\n\t" * Build block sets and initialize them * Macro initializes the k_mem_pool_block_set structure and * recursively calls itself for the next one. - * The followig global symbols need to be initialized: + * The following global symbols need to be initialized: * __memory_pool_max_block_size - maximal size of the memory block * __memory_pool_min_block_size - minimal size of the memory block * __memory_pool_block_set_count, the number of the elements in the diff --git a/include/legacy.h b/include/legacy.h index 805b1584121..d1f01c3896d 100644 --- a/include/legacy.h +++ b/include/legacy.h @@ -735,7 +735,7 @@ extern void __deprecated task_start(ktask_t task); * @deprecated This API will be deprecated. * * This routine controls how task time slicing is performed by the task - * scheduler; it specifes the maximum time slice length (in ticks) and + * scheduler; it specifies the maximum time slice length (in ticks) and * the highest priority task level for which time slicing is performed. * * To enable time slicing, a non-zero time slice length must be specified. @@ -743,7 +743,7 @@ extern void __deprecated task_start(ktask_t task); * the specified number of ticks before giving other tasks of that priority * a chance to execute. (However, any task whose priority is higher than the * specified task priority level is exempted, and may execute as long as - * desired without being pre-empted due to time slicing.) + * desired without being preempted due to time slicing.) * * Time slicing limits only the maximum amount of time a task may continuously * execute. Once the scheduler selects a task for execution, there is no minimum @@ -1016,7 +1016,7 @@ static inline __deprecated void nano_sem_init(struct nano_sem *sem) * Legacy API: Will be deprecated in Zephyr 1.9 * @deprecated This API will be deprecated. * - * This routine performs a "give" operation on a nanokernel sempahore object. + * This routine performs a "give" operation on a nanokernel semaphore object. * * It is also a convenience wrapper for the execution of context-specific * APIs and helpful when the exact execution context is not known. However, @@ -1088,7 +1088,7 @@ static inline __deprecated void nano_sem_give(struct nano_sem *sem) * Legacy API: Will be deprecated in Zephyr 1.9 * @deprecated This API will be deprecated. * - * This routine performs a "give" operation on a nanokernel sempahore object. + * This routine performs a "give" operation on a nanokernel semaphore object. * * It is also a convenience wrapper for the execution of context-specific * APIs and is helpful when the exact execution context is not known. However, @@ -1384,7 +1384,7 @@ static inline __deprecated void task_sem_group_give(ksemg_t group) * Legacy API: Will be deprecated in Zephyr 1.9 * @deprecated This API will be deprecated. * - * This routine resets the count for each semaphore in the sempahore group + * This routine resets the count for each semaphore in the semaphore group * @a semagroup to zero. This method is faster than resetting the semaphores * individually. * @@ -2510,7 +2510,7 @@ static inline __deprecated void nano_fifo_put(struct nano_fifo *fifo, * * Unlike the fiber/ISR versions of this API which is not much different * conceptually than calling nano_fifo_put once for each element to queue, the - * behaviour is indeed different for tasks. There is no context switch being + * behavior is indeed different for tasks. There is no context switch being * done for each element queued, so the task can enqueue all elements without * being interrupted by a fiber being woken up. * @@ -2580,7 +2580,7 @@ void nano_fifo_put_list(struct nano_fifo *fifo, void *head, void *tail); * Legacy API: Will be deprecated in Zephyr 1.9 * @deprecated This API will be deprecated. * - * See nano_fifo_put_list for the description of the behaviour. + * See nano_fifo_put_list for the description of the behavior. * * It takes a pointer to a sys_slist_t object instead of the head and tail of a * custom singly-linked list. The sys_slist_t object is invalid afterwards and @@ -2800,7 +2800,7 @@ nano_lifo_put(struct nano_lifo *lifo, void *data) * @deprecated This API will be deprecated. * * Like nano_lifo_put(), but may only be called from a task. A fiber - * pending on the LIFO object will be made ready, and will preempty the + * pending on the LIFO object will be made ready, and will preempt the * running task immediately. * * @sa nano_lifo_put @@ -2821,7 +2821,7 @@ nano_lifo_put(struct nano_lifo *lifo, void *data) * @param lifo LIFO on which to receive. * @param timeout_in_ticks Affects the action taken should the LIFO be empty. * If TICKS_NONE, then return immediately. If TICKS_UNLIMITED, then wait as - * long as necesssary. Otherwise wait up to the specified number of ticks + * long as necessary. Otherwise wait up to the specified number of ticks * before timing out. * * @warning If it is to be called from the context of an ISR, then @a @@ -3149,7 +3149,7 @@ extern __deprecated void task_timer_free(ktimer_t timer); * If either @a duration or @a period is passed an invalid value * (@a duration <= 0, * @a period < 0), this kernel API acts like a * task_timer_stop(): if the allocated timer was still running (from a - * previous call), it will be cancelled; if not, nothing will happen. + * previous call), it will be canceled; if not, nothing will happen. * * @param timer Timer to start. * @param duration Initial delay in ticks. diff --git a/include/linker-tool-gcc.h b/include/linker-tool-gcc.h index c04fd965737..7071163234f 100644 --- a/include/linker-tool-gcc.h +++ b/include/linker-tool-gcc.h @@ -90,7 +90,7 @@ /* * As for SECTION_PROLOGUE(), except that this one must (!) be used - * for data sections which on XIP platforms will have differeing + * for data sections which on XIP platforms will have differing * virtual and load addresses (i.e. they'll be copied into RAM at * program startup). Such a section must (!) also use * GROUP_LINK_IN_LMA to specify the correct output load address.