From db6a3cb05496accc2cf3b46dd76905881ee55e05 Mon Sep 17 00:00:00 2001 From: Pisit Sawangvonganan Date: Sun, 7 Jul 2024 01:24:49 +0700 Subject: [PATCH] include: fix typo in multiple directories Utilize a code spell-checking tool to scan for and correct spelling errors in all files within the `include/zephyr` directory. Signed-off-by: Pisit Sawangvonganan --- include/zephyr/devicetree.h | 4 ++-- include/zephyr/dsp/print_format.h | 2 +- include/zephyr/input/input_kbd_matrix.h | 4 ++-- include/zephyr/ipc/icmsg_me.h | 2 +- include/zephyr/ipc/pbuf.h | 2 +- include/zephyr/linker/irq-vector-table-section.ld | 2 +- include/zephyr/posix/pthread.h | 2 +- include/zephyr/rtio/rtio.h | 2 +- include/zephyr/sd/sd.h | 4 ++-- include/zephyr/sd/sd_spec.h | 2 +- include/zephyr/sys/cbprintf.h | 2 +- include/zephyr/sys/cbprintf_cxx.h | 2 +- include/zephyr/sys/cbprintf_internal.h | 2 +- include/zephyr/sys/libc-hooks.h | 2 +- include/zephyr/sys/linear_range.h | 2 +- include/zephyr/sys/poweroff.h | 2 +- include/zephyr/sys/time_units.h | 2 +- include/zephyr/sys/util.h | 2 +- include/zephyr/sys/winstream.h | 2 +- include/zephyr/toolchain.h | 2 +- include/zephyr/usb/class/usbd_hid.h | 6 +++--- include/zephyr/usb_c/usbc.h | 4 ++-- include/zephyr/xen/gnttab.h | 2 +- include/zephyr/xen/public/domctl.h | 2 +- include/zephyr/xen/public/grant_table.h | 4 ++-- 25 files changed, 32 insertions(+), 32 deletions(-) diff --git a/include/zephyr/devicetree.h b/include/zephyr/devicetree.h index d2e51e33af3..2cb08aa7b91 100644 --- a/include/zephyr/devicetree.h +++ b/include/zephyr/devicetree.h @@ -4316,7 +4316,7 @@ * @param name lowercase-and-underscores property name * @param default_value a fallback value to expand to * @return if @p prop exists, its value as a token, i.e. without any quotes and - * with special characters converted to underscores. Othewise + * with special characters converted to underscores. Otherwise * @p default_value */ #define DT_INST_STRING_TOKEN_OR(inst, name, default_value) \ @@ -4620,7 +4620,7 @@ /** * @brief Invokes @p fn for each element of property @p prop for - * a `DT_DRV_COMPAT` instance with multiple arguments and a sepatator. + * a `DT_DRV_COMPAT` instance with multiple arguments and a separator. * * Equivalent to * DT_FOREACH_PROP_ELEM_SEP_VARGS(DT_DRV_INST(inst), prop, fn, sep, diff --git a/include/zephyr/dsp/print_format.h b/include/zephyr/dsp/print_format.h index 695691424df..dd7d7128f7a 100644 --- a/include/zephyr/dsp/print_format.h +++ b/include/zephyr/dsp/print_format.h @@ -13,7 +13,7 @@ * @ingroup math_dsp * @defgroup math_printing Helper macros for printing Q values. * - * Extends the existing inttypes headers for print formatting. Useage: + * Extends the existing inttypes headers for print formatting. Usage: * @code{c} * printk("Value=%" PRIq "\n", PRIq_arg(value, 6, 2)); * @endcode diff --git a/include/zephyr/input/input_kbd_matrix.h b/include/zephyr/input/input_kbd_matrix.h index 6a458dcdf2a..bb164e6f536 100644 --- a/include/zephyr/input/input_kbd_matrix.h +++ b/include/zephyr/input/input_kbd_matrix.h @@ -44,7 +44,7 @@ typedef uint8_t kbd_row_t; * @brief Enables or disables a specific row, column combination in the actual * key mask. * - * This allows enabling or disabling spcific row, column combination in the + * This allows enabling or disabling specific row, column combination in the * actual key mask in runtime. It can be useful if some of the keys are not * present in some configuration, and the specific configuration is determined * in runtime. Requires @kconfig{CONFIG_INPUT_KBD_ACTUAL_KEY_MASK_DYNAMIC} to @@ -53,7 +53,7 @@ typedef uint8_t kbd_row_t; * @param dev Pointer to the keyboard matrix device. * @param row The matrix row to enable or disable. * @param col The matrix column to enable or disable. - * @param enabled Whether the specificied row, col has to be enabled or disabled. + * @param enabled Whether the specified row, col has to be enabled or disabled. * * @retval 0 If the change is successful. * @retval -errno Negative errno if row or col are out of range for the device. diff --git a/include/zephyr/ipc/icmsg_me.h b/include/zephyr/ipc/icmsg_me.h index 9736b0148c6..e5c0826d8f5 100644 --- a/include/zephyr/ipc/icmsg_me.h +++ b/include/zephyr/ipc/icmsg_me.h @@ -45,7 +45,7 @@ struct icmsg_me_data_t { /** @brief Initialize an icmsg_me instance * * This function is intended to be called during system initialization. - * It initializes the underlying icmsg instace as one of the initialization + * It initializes the underlying icmsg instance as one of the initialization * steps. * * @param[in] conf Structure containing configuration parameters for the diff --git a/include/zephyr/ipc/pbuf.h b/include/zephyr/ipc/pbuf.h index 7e61950c808..0be5bd5185c 100644 --- a/include/zephyr/ipc/pbuf.h +++ b/include/zephyr/ipc/pbuf.h @@ -60,7 +60,7 @@ struct pbuf_cfg { * @brief Data block of the packed buffer. * * The structure contains local copies of wr and rd indexes used by writer and - * reader respecitvely. + * reader respectively. */ struct pbuf_data { volatile uint32_t wr_idx; /* Index of the first holding first diff --git a/include/zephyr/linker/irq-vector-table-section.ld b/include/zephyr/linker/irq-vector-table-section.ld index 141eee4d28d..f0948804b99 100644 --- a/include/zephyr/linker/irq-vector-table-section.ld +++ b/include/zephyr/linker/irq-vector-table-section.ld @@ -8,6 +8,6 @@ KEEP(*(_IRQ_VECTOR_TABLE_SECTION_SYMS)) /* * Some ARM platforms require this symbol to be placed after the IRQ vector * table (like STM32F0). The symbol defined here is overriding the one in - * arch/arm/core/vector_table.ld when the IRQ vector table is enbled. + * arch/arm/core/vector_table.ld when the IRQ vector table is enabled. */ _vector_end = .; diff --git a/include/zephyr/posix/pthread.h b/include/zephyr/posix/pthread.h index f2723d68d76..eaa9ccb66b0 100644 --- a/include/zephyr/posix/pthread.h +++ b/include/zephyr/posix/pthread.h @@ -124,7 +124,7 @@ int pthread_condattr_init(pthread_condattr_t *att); int pthread_condattr_destroy(pthread_condattr_t *att); /** - * @brief POSIX threading comatibility API + * @brief POSIX threading compatibility API * * See IEEE 1003.1 * diff --git a/include/zephyr/rtio/rtio.h b/include/zephyr/rtio/rtio.h index a53e939b0ac..1bb3a844d8b 100644 --- a/include/zephyr/rtio/rtio.h +++ b/include/zephyr/rtio/rtio.h @@ -53,7 +53,7 @@ extern "C" { */ /** - * @brief RTIO Predefined Priorties + * @brief RTIO Predefined Priorities * @defgroup rtio_sqe_prio RTIO Priorities * @ingroup rtio * @{ diff --git a/include/zephyr/sd/sd.h b/include/zephyr/sd/sd.h index b23fa2c260c..f19448652ae 100644 --- a/include/zephyr/sd/sd.h +++ b/include/zephyr/sd/sd.h @@ -21,7 +21,7 @@ extern "C" { #endif /** - * @brief card status. Used interally by subsystem. + * @brief card status. Used internally by subsystem. */ enum card_status { CARD_UNINITIALIZED = 0, /*!< card has not been initialized */ @@ -30,7 +30,7 @@ enum card_status { }; /** - * @brief card type. Used interally by subsystem. + * @brief card type. Used internally by subsystem. */ enum card_type { CARD_SDMMC = 0, /*!< SD memory card */ diff --git a/include/zephyr/sd/sd_spec.h b/include/zephyr/sd/sd_spec.h index 7e08488805c..81664ca1d71 100644 --- a/include/zephyr/sd/sd_spec.h +++ b/include/zephyr/sd/sd_spec.h @@ -353,7 +353,7 @@ enum sd_switch_arg { /** * @brief SD switch group numbers * - * SD CMD6 has multiple function groups it can check/set. These indicies are + * SD CMD6 has multiple function groups it can check/set. These indices are * used to determine which group CMD6 will interact with. */ enum sd_group_num { diff --git a/include/zephyr/sys/cbprintf.h b/include/zephyr/sys/cbprintf.h index 2055eb6a047..6a160a624ec 100644 --- a/include/zephyr/sys/cbprintf.h +++ b/include/zephyr/sys/cbprintf.h @@ -523,7 +523,7 @@ int cbprintf_package_convert(void *in_packaged, uint16_t *strl, size_t strl_len); -/* @interal Context used for package copying. */ +/* @internal Context used for package copying. */ struct z_cbprintf_buf_desc { void *buf; size_t size; diff --git a/include/zephyr/sys/cbprintf_cxx.h b/include/zephyr/sys/cbprintf_cxx.h index 1930e18b7d4..75a2ba16ff4 100644 --- a/include/zephyr/sys/cbprintf_cxx.h +++ b/include/zephyr/sys/cbprintf_cxx.h @@ -337,7 +337,7 @@ static inline int z_cbprintf_cxx_is_longdouble(T arg) return 0; } -/* C++ version for caluculating argument alignment. */ +/* C++ version for calculating argument alignment. */ static inline size_t z_cbprintf_cxx_alignment(float arg) { ARG_UNUSED(arg); diff --git a/include/zephyr/sys/cbprintf_internal.h b/include/zephyr/sys/cbprintf_internal.h index 24e56feeb8c..b580eea8704 100644 --- a/include/zephyr/sys/cbprintf_internal.h +++ b/include/zephyr/sys/cbprintf_internal.h @@ -490,7 +490,7 @@ extern "C" { (Z_CBPRINTF_NONE_CHAR_PTR_COUNT(__VA_ARGS__) == \ Z_CBPRINTF_P_COUNT(GET_ARG_N(1, __VA_ARGS__))) -/* @brief Check if argument is a certain type of char pointer. What exectly is checked +/* @brief Check if argument is a certain type of char pointer. What exactly is checked * depends on @p flags. If flags is 0 then 1 is returned if @p x is a char pointer. * * @param idx Argument index. diff --git a/include/zephyr/sys/libc-hooks.h b/include/zephyr/sys/libc-hooks.h index 0e0871138d8..e737fc6872d 100644 --- a/include/zephyr/sys/libc-hooks.h +++ b/include/zephyr/sys/libc-hooks.h @@ -61,7 +61,7 @@ __syscall size_t zephyr_fwrite(const void *ZRESTRICT ptr, size_t size, * - If we have an MPU that requires power of two alignment, the heap bounds * must be specified in Kconfig via CONFIG_NEWLIB_LIBC_ALIGNED_HEAP_SIZE. * - Otherwise, the heap arena on most arches starts at a suitably - * aligned base addreess after the `_end` linker symbol, through to the end + * aligned base address after the `_end` linker symbol, through to the end * of system RAM. */ #if (!defined(CONFIG_MPU_REQUIRES_POWER_OF_TWO_ALIGNMENT) || \ diff --git a/include/zephyr/sys/linear_range.h b/include/zephyr/sys/linear_range.h index bfd591b3d48..85bc784ec20 100644 --- a/include/zephyr/sys/linear_range.h +++ b/include/zephyr/sys/linear_range.h @@ -248,7 +248,7 @@ static inline int linear_range_group_get_index(const struct linear_range *r, * @brief Obtain index given a window of values. * * If the window of values does not intersect with the range, -EINVAL will be - * returned. If intersection is partial (any of the window egdes does not + * returned. If intersection is partial (any of the window edges does not * intersect), the nearest index will be stored and -ERANGE returned. * * @param[in] r Linear range instance. diff --git a/include/zephyr/sys/poweroff.h b/include/zephyr/sys/poweroff.h index e9a3dc05215..b4ecabcf96d 100644 --- a/include/zephyr/sys/poweroff.h +++ b/include/zephyr/sys/poweroff.h @@ -37,7 +37,7 @@ FUNC_NORETURN void z_sys_poweroff(void); * @brief Perform a system power off. * * This function will perform an immediate power off of the system. It is the - * responsability of the caller to ensure that the system is in a safe state to + * responsibility of the caller to ensure that the system is in a safe state to * be powered off. Any required wake up sources must be enabled before calling * this function. * diff --git a/include/zephyr/sys/time_units.h b/include/zephyr/sys/time_units.h index f4deb93fb39..c02fd012887 100644 --- a/include/zephyr/sys/time_units.h +++ b/include/zephyr/sys/time_units.h @@ -195,7 +195,7 @@ static inline int z_impl_sys_clock_hw_cycles_per_sec_runtime_get(void) __round_up, __round_off)) / \ z_tmcvt_divisor(__from_hz, __to_hz)) -/* Integer multiplcation 64-bit conversion */ +/* Integer multiplication 64-bit conversion */ #define z_tmcvt_int_mul_64(__t, __from_hz, __to_hz) \ (uint64_t) (__t)*((__to_hz) / (__from_hz)) diff --git a/include/zephyr/sys/util.h b/include/zephyr/sys/util.h index 864564a5333..95cf9c6d298 100644 --- a/include/zephyr/sys/util.h +++ b/include/zephyr/sys/util.h @@ -722,7 +722,7 @@ char *utf8_lcpy(char *dst, const char *src, size_t n); * @brief Determine if a buffer exceeds highest address * * This macro determines if a buffer identified by a starting address @a addr - * and length @a buflen spans a region of memory that goes beond the highest + * and length @a buflen spans a region of memory that goes beyond the highest * possible address (thereby resulting in a pointer overflow). * * @param addr Buffer starting address diff --git a/include/zephyr/sys/winstream.h b/include/zephyr/sys/winstream.h index 7101b2e2eaf..57b753d9068 100644 --- a/include/zephyr/sys/winstream.h +++ b/include/zephyr/sys/winstream.h @@ -13,7 +13,7 @@ * with simple read/write semantics on top of a memory region shared * by the writer and reader. It requires no locking or * synchronization mechanisms beyond reliable ordering of memory - * operations, and so is a good fit for use with heterogenous shared + * operations, and so is a good fit for use with heterogeneous shared * memory environments (for example, where Zephyr needs to talk to * other CPUs in the system running their own software). * diff --git a/include/zephyr/toolchain.h b/include/zephyr/toolchain.h index 27e4a46956c..f8df4915736 100644 --- a/include/zephyr/toolchain.h +++ b/include/zephyr/toolchain.h @@ -56,7 +56,7 @@ * @def __noasan * @brief Disable address sanitizer * - * When used in the definiton of a symbol, prevents that symbol (be it + * When used in the definition of a symbol, prevents that symbol (be it * a function or data) from being instrumented by the address * sanitizer feature of the compiler. Most commonly, this is used to * prevent padding around data that will be treated specially by the diff --git a/include/zephyr/usb/class/usbd_hid.h b/include/zephyr/usb/class/usbd_hid.h index 9798b081093..7e9921072f2 100644 --- a/include/zephyr/usb/class/usbd_hid.h +++ b/include/zephyr/usb/class/usbd_hid.h @@ -128,12 +128,12 @@ struct hid_device_ops { const uint16_t len, const uint8_t *const buf); /** - * Notification to limit intput report frequency. + * Notification to limit input report frequency. * The device should mute an input report submission until a new * event occurs or until the time specified by the duration value has * elapsed. If a report ID is used in the report descriptor, the * device must store the duration and handle the specified report - * accordingly. Duration time resolution is in miliseconds. + * accordingly. Duration time resolution is in milliseconds. */ void (*set_idle)(const struct device *dev, const uint8_t id, const uint32_t duration); @@ -141,7 +141,7 @@ struct hid_device_ops { /** * If a report ID is used in the report descriptor, the device * must implement this callback and return the duration for the - * specified report ID. Duration time resolution is in miliseconds. + * specified report ID. Duration time resolution is in milliseconds. */ uint32_t (*get_idle)(const struct device *dev, const uint8_t id); diff --git a/include/zephyr/usb_c/usbc.h b/include/zephyr/usb_c/usbc.h index 5926793777b..9427645e881 100644 --- a/include/zephyr/usb_c/usbc.h +++ b/include/zephyr/usb_c/usbc.h @@ -91,7 +91,7 @@ enum usbc_policy_notify_t { MSG_ACCEPT_RECEIVED, /** Power Delivery Reject message was received */ MSG_REJECTED_RECEIVED, - /** Power Delivery discarded the message being transmited */ + /** Power Delivery discarded the message being transmitted */ MSG_DISCARDED, /** Power Delivery Not Supported message was received */ MSG_NOT_SUPPORTED_RECEIVED, @@ -291,7 +291,7 @@ typedef bool (*policy_cb_present_contract_is_valid_t)(const struct device *dev, * be sent to the Sink * * @param dev USB-C Connector Instance - * @return true if a different set of Cource Caps is available + * @return true if a different set of Source Caps is available */ typedef bool (*policy_cb_change_src_caps_t)(const struct device *dev); diff --git a/include/zephyr/xen/gnttab.h b/include/zephyr/xen/gnttab.h index da865fc4c70..be6a0d5c906 100644 --- a/include/zephyr/xen/gnttab.h +++ b/include/zephyr/xen/gnttab.h @@ -52,7 +52,7 @@ void *gnttab_get_page(void); /* * Releases provided page, that was used for mapping foreign grant frame, - * should be called after unmaping. + * should be called after unmapping. * * @param page_addr - pointer to start address of used page. */ diff --git a/include/zephyr/xen/public/domctl.h b/include/zephyr/xen/public/domctl.h index b33cf7966fa..9d856501a09 100644 --- a/include/zephyr/xen/public/domctl.h +++ b/include/zephyr/xen/public/domctl.h @@ -38,7 +38,7 @@ struct xen_domctl_createdomain { /* Use hardware-assisted paging if available? */ #define _XEN_DOMCTL_CDF_hap 1 #define XEN_DOMCTL_CDF_hap (1U << _XEN_DOMCTL_CDF_hap) -/* Should domain memory integrity be verifed by tboot during Sx? */ +/* Should domain memory integrity be verified by tboot during Sx? */ #define _XEN_DOMCTL_CDF_s3_integrity 2 #define XEN_DOMCTL_CDF_s3_integrity (1U << _XEN_DOMCTL_CDF_s3_integrity) /* Disable out-of-sync shadow page tables? */ diff --git a/include/zephyr/xen/public/grant_table.h b/include/zephyr/xen/public/grant_table.h index bbac2f45523..5516239131d 100644 --- a/include/zephyr/xen/public/grant_table.h +++ b/include/zephyr/xen/public/grant_table.h @@ -349,7 +349,7 @@ DEFINE_XEN_GUEST_HANDLE(gnttab_setup_table_t); /* * GNTMAP_contains_pte subflag: * 0 => This map request contains a host virtual address. - * 1 => This map request contains the machine addess of the PTE to update. + * 1 => This map request contains the machine address of the PTE to update. */ #define _GNTMAP_contains_pte (4) #define GNTMAP_contains_pte (1<<_GNTMAP_contains_pte) @@ -377,7 +377,7 @@ DEFINE_XEN_GUEST_HANDLE(gnttab_setup_table_t); #define GNTST_bad_page (-9) /* Specified page was invalid for op */ #define GNTST_bad_copy_arg (-10) /* copy arguments cross page boundary */ #define GNTST_address_too_big (-11) /* transfer page address too large */ -#define GNTST_eagain (-12) /* Operation not done; try agains */ +#define GNTST_eagain (-12) /* Operation not done; try again */ /* ` } */ #define GNTTABOP_error_msgs { \