diff --git a/.readthedocs.yml b/.readthedocs.yml index 594f1ac15f..ef05120b6d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -15,7 +15,7 @@ python: install: - requirements: docs/requirements.txt -# We need to list all the submodules included in documenation build by Doxygen +# We need to list all the submodules included in documentation build by Doxygen submodules: include: - components/mqtt/esp-mqtt diff --git a/components/app_trace/Kconfig b/components/app_trace/Kconfig index be61cfd49e..6939174a3f 100644 --- a/components/app_trace/Kconfig +++ b/components/app_trace/Kconfig @@ -207,7 +207,7 @@ menu "Application Level Tracing" depends on APPTRACE_ENABLE default n help - Enables supporrt for SEGGER SystemView tracing functionality. + Enables support for SEGGER SystemView tracing functionality. choice APPTRACE_SV_DEST prompt "SystemView destination" diff --git a/components/bt/controller/esp32/Kconfig.in b/components/bt/controller/esp32/Kconfig.in index f09945dc87..d3c04a115f 100644 --- a/components/bt/controller/esp32/Kconfig.in +++ b/components/bt/controller/esp32/Kconfig.in @@ -454,7 +454,7 @@ config BTDM_CTRL_SCAN_BACKOFF_UPPERLIMITMAX default n help Disable active scan backoff. The bluetooth spec requires that scanners should run a backoff procedure to - minimize collision of scan request PDUs from nultiple scanners. If scan backoff is disabled, in active + minimize collision of scan request PDUs from multiple scanners. If scan backoff is disabled, in active scanning, scan request PDU will be sent every time when HW receives scannable ADV PDU. config BTDM_CTRL_CHECK_CONNECT_IND_ACCESS_ADDRESS diff --git a/components/bt/controller/esp32c3/Kconfig.in b/components/bt/controller/esp32c3/Kconfig.in index ea50bb4cb5..f407e81a35 100644 --- a/components/bt/controller/esp32c3/Kconfig.in +++ b/components/bt/controller/esp32c3/Kconfig.in @@ -471,7 +471,7 @@ config BT_CTRL_SCAN_BACKOFF_UPPERLIMITMAX default n help Disable active scan backoff. The bluetooth spec requires that scanners should run a backoff procedure to - minimize collision of scan request PDUs from nultiple scanners. If scan backoff is disabled, in active + minimize collision of scan request PDUs from multiple scanners. If scan backoff is disabled, in active scanning, scan request PDU will be sent every time when HW receives scannable ADV PDU. config BT_BLE_ADV_DATA_LENGTH_ZERO_AUX diff --git a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h index e35749a105..c4d49b202f 100644 --- a/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h +++ b/components/bt/host/bluedroid/api/include/api/esp_gap_ble_api.h @@ -1047,7 +1047,7 @@ typedef struct { } esp_ble_gap_periodic_adv_report_t; /** -* @brief perodic adv sync establish parameters +* @brief periodic adv sync establish parameters */ typedef struct { uint8_t status; /*!< periodic advertising sync status */ diff --git a/components/bt/host/bluedroid/bta/av/bta_av_aact.c b/components/bt/host/bluedroid/bta/av/bta_av_aact.c index 3f06922be5..e75fe818c3 100644 --- a/components/bt/host/bluedroid/bta/av/bta_av_aact.c +++ b/components/bt/host/bluedroid/bta/av/bta_av_aact.c @@ -1147,7 +1147,7 @@ void bta_av_config_ind (tBTA_AV_SCB *p_scb, tBTA_AV_DATA *p_data) p_info->media_type = p_scb->media_type; p_info->seid = p_data->str_msg.msg.config_ind.int_seid; - /* Sep type of Peer will be oppsite role to our local sep */ + /* Sep type of Peer will be opposite role to our local sep */ if (local_sep == AVDT_TSEP_SRC) { p_info->tsep = AVDT_TSEP_SNK; } else if (local_sep == AVDT_TSEP_SNK) { diff --git a/components/bt/host/bluedroid/bta/hf_ag/bta_ag_cmd.c b/components/bt/host/bluedroid/bta/hf_ag/bta_ag_cmd.c index 6bccfe1b7e..2cf985c703 100644 --- a/components/bt/host/bluedroid/bta/hf_ag/bta_ag_cmd.c +++ b/components/bt/host/bluedroid/bta/hf_ag/bta_ag_cmd.c @@ -358,7 +358,7 @@ void bta_hf_ag_bqb_brsf_ctrl(BOOLEAN enable) #endif /* BT_HF_AG_BQB_INCLUDED */ /******************************************* -* Funcitons Result +* Function Results ********************************************/ /******************************************************************************* ** diff --git a/components/bt/host/bluedroid/external/sbc/decoder/include/oi_codec_sbc.h b/components/bt/host/bluedroid/external/sbc/decoder/include/oi_codec_sbc.h index 495fbf6b91..ae87317c6d 100644 --- a/components/bt/host/bluedroid/external/sbc/decoder/include/oi_codec_sbc.h +++ b/components/bt/host/bluedroid/external/sbc/decoder/include/oi_codec_sbc.h @@ -372,7 +372,7 @@ OI_STATUS OI_CODEC_SBC_DecodeFrame(OI_CODEC_SBC_DECODER_CONTEXT *context, * * @param frameData Pointer to the SBC data. * - * @param frameBytes Number of bytes avaiable in the frameData buffer + * @param frameBytes Number of bytes available in the frameData buffer * */ OI_UINT8 OI_CODEC_SBC_FrameCount(OI_BYTE *frameData, diff --git a/components/bt/host/bluedroid/external/sbc/encoder/srce/sbc_encoder.c b/components/bt/host/bluedroid/external/sbc/encoder/srce/sbc_encoder.c index c0ab99b830..fa1d40c9f9 100644 --- a/components/bt/host/bluedroid/external/sbc/encoder/srce/sbc_encoder.c +++ b/components/bt/host/bluedroid/external/sbc/encoder/srce/sbc_encoder.c @@ -18,7 +18,7 @@ /****************************************************************************** * - * contains code for encoder flow and initalization of encoder + * contains code for encoder flow and initialization of encoder * ******************************************************************************/ @@ -62,7 +62,7 @@ void SBC_Encoder(SBC_ENC_PARAMS *pstrEncParams) pstrEncParams->ps16NextPcmBuffer = pstrEncParams->as16PcmBuffer; #endif do { - /* SBC ananlysis filter*/ + /* SBC analysis filter*/ if (s32NumOfSubBands == 4) { SbcAnalysisFilter4(pstrEncParams); } else { @@ -73,7 +73,7 @@ void SBC_Encoder(SBC_ENC_PARAMS *pstrEncParams) ps16ScfL = pstrEncParams->as16ScaleFactor; s32Ch = pstrEncParams->s16NumOfChannels * s32NumOfSubBands; - pstrEncParams->ps16NextPcmBuffer += s32Ch * s32NumOfBlocks; /* in case of multible sbc frame to encode update the pcm pointer */ + pstrEncParams->ps16NextPcmBuffer += s32Ch * s32NumOfBlocks; /* in case of multiple sbc frame to encode update the pcm pointer */ for (s32Sb = 0; s32Sb < s32Ch; s32Sb++) { SbBuffer = pstrEncParams->s32SbBuffer + s32Sb; @@ -101,7 +101,7 @@ void SBC_Encoder(SBC_ENC_PARAMS *pstrEncParams) /* In case of JS processing,check whether to use JS */ #if (SBC_JOINT_STE_INCLUDED == TRUE) if (pstrEncParams->s16ChannelMode == SBC_JOINT_STEREO) { - /* Calculate sum and differance scale factors for making JS decision */ + /* Calculate sum and difference scale factors for making JS decision */ ps16ScfL = pstrEncParams->as16ScaleFactor ; /* calculate the scale factor of Joint stereo max sum and diff */ for (s32Sb = 0; s32Sb < s32NumOfSubBands - 1; s32Sb++) { @@ -191,7 +191,7 @@ void SBC_Encoder(SBC_ENC_PARAMS *pstrEncParams) } /**************************************************************************** -* InitSbcAnalysisFilt - Initalizes the input data to 0 +* InitSbcAnalysisFilt - Initializes the input data to 0 * * RETURNS : N/A */ @@ -306,7 +306,7 @@ void SBC_Encoder_Init(SBC_ENC_PARAMS *pstrEncParams) /* allocation method: loudness */ pstrEncParams->s16AllocationMethod = SBC_LOUDNESS; - /* set the header paramers, unused for mSBC */ + /* set the header parameters, unused for mSBC */ pstrEncParams->FrameHeader = 0; } diff --git a/components/driver/touch_sensor/esp32s2/include/driver/touch_sensor_legacy.h b/components/driver/touch_sensor/esp32s2/include/driver/touch_sensor_legacy.h index 96ce713067..01047c2771 100644 --- a/components/driver/touch_sensor/esp32s2/include/driver/touch_sensor_legacy.h +++ b/components/driver/touch_sensor/esp32s2/include/driver/touch_sensor_legacy.h @@ -333,7 +333,7 @@ esp_err_t touch_pad_filter_read_smooth(touch_pad_t touch_num, uint32_t *smooth); /** * @brief Force reset benchmark to raw data of touch sensor. * @param touch_num touch pad index - * - TOUCH_PAD_MAX Reset basaline of all channels + * - TOUCH_PAD_MAX Reset baseline of all channels * @return * - ESP_OK Success */ diff --git a/components/driver/touch_sensor/esp32s3/include/driver/touch_sensor_legacy.h b/components/driver/touch_sensor/esp32s3/include/driver/touch_sensor_legacy.h index 96ce713067..01047c2771 100644 --- a/components/driver/touch_sensor/esp32s3/include/driver/touch_sensor_legacy.h +++ b/components/driver/touch_sensor/esp32s3/include/driver/touch_sensor_legacy.h @@ -333,7 +333,7 @@ esp_err_t touch_pad_filter_read_smooth(touch_pad_t touch_num, uint32_t *smooth); /** * @brief Force reset benchmark to raw data of touch sensor. * @param touch_num touch pad index - * - TOUCH_PAD_MAX Reset basaline of all channels + * - TOUCH_PAD_MAX Reset baseline of all channels * @return * - ESP_OK Success */ diff --git a/components/driver/touch_sensor/include/driver/touch_sensor_common.h b/components/driver/touch_sensor/include/driver/touch_sensor_common.h index 848b4c2149..4d46457b6b 100644 --- a/components/driver/touch_sensor/include/driver/touch_sensor_common.h +++ b/components/driver/touch_sensor/include/driver/touch_sensor_common.h @@ -43,7 +43,7 @@ esp_err_t touch_pad_deinit(void); esp_err_t touch_pad_io_init(touch_pad_t touch_num); /** - * @brief Set touch sensor high voltage threshold of chanrge. + * @brief Set touch sensor high voltage threshold of charge. * The touch sensor measures the channel capacitance value by charging and discharging the channel. * So the high threshold should be less than the supply voltage. * @param refh the value of DREFH diff --git a/components/esp-tls/Kconfig b/components/esp-tls/Kconfig index 3ede8810ba..49bfe2c444 100644 --- a/components/esp-tls/Kconfig +++ b/components/esp-tls/Kconfig @@ -84,7 +84,7 @@ menu "ESP-TLS" config ESP_TLS_INSECURE bool "Allow potentially insecure options" help - You can enable some potentially insecure options. These options should only be used for testing pusposes. + You can enable some potentially insecure options. These options should only be used for testing purposes. Only enable these options if you are very sure. config ESP_TLS_SKIP_SERVER_CERT_VERIFY diff --git a/components/esp_adc/Kconfig b/components/esp_adc/Kconfig index d6af0751f0..89f65f30c3 100644 --- a/components/esp_adc/Kconfig +++ b/components/esp_adc/Kconfig @@ -58,7 +58,7 @@ menu "ADC and ADC Calibration" config ADC_CONTINUOUS_FORCE_USE_ADC2_ON_C3_S3 depends on IDF_TARGET_ESP32C3 || IDF_TARGET_ESP32S3 - bool "Force use ADC2 continumous mode on ESP32S3 or ESP32C3" + bool "Force use ADC2 continuous mode on ESP32S3 or ESP32C3" default n help On ESP32C3 and ESP32S3, ADC2 Digital Controller is not stable. Therefore, diff --git a/components/esp_eth/include/esp_eth_driver.h b/components/esp_eth/include/esp_eth_driver.h index 0c5f183cac..92e0eb02b0 100644 --- a/components/esp_eth/include/esp_eth_driver.h +++ b/components/esp_eth/include/esp_eth_driver.h @@ -245,7 +245,7 @@ esp_err_t esp_eth_start(esp_eth_handle_t hdl); /** * @brief Stop Ethernet driver * -* @note This function does the oppsite operation of `esp_eth_start`. +* @note This function does the opposite operation of `esp_eth_start`. * * @param[in] hdl handle of Ethernet driver * @return diff --git a/components/esp_eth/test_apps/main/esp_eth_test_apps.c b/components/esp_eth/test_apps/main/esp_eth_test_apps.c index 392abe1058..e4e138bebf 100644 --- a/components/esp_eth/test_apps/main/esp_eth_test_apps.c +++ b/components/esp_eth/test_apps/main/esp_eth_test_apps.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Unlicense OR CC0-1.0 */ @@ -503,7 +503,7 @@ TEST_CASE("ethernet dhcp test", "[ethernet]") // combine driver with netif esp_eth_netif_glue_handle_t glue = esp_eth_new_netif_glue(eth_handle); TEST_ESP_OK(esp_netif_attach(eth_netif, glue)); - // register user defined event handers + // register user defined event handlers TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); TEST_ESP_OK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, eth_event_group)); // start Ethernet driver @@ -551,7 +551,7 @@ TEST_CASE("ethernet start/stop stress test with IP stack", "[ethernet]") // combine driver with netif esp_eth_netif_glue_handle_t glue = esp_eth_new_netif_glue(eth_handle); TEST_ESP_OK(esp_netif_attach(eth_netif, glue)); - // register user defined event handers + // register user defined event handlers TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); TEST_ESP_OK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, eth_event_group)); @@ -677,7 +677,7 @@ TEST_CASE("ethernet download test", "[ethernet]") // combine driver with netif esp_eth_netif_glue_handle_t glue = esp_eth_new_netif_glue(eth_handle); TEST_ESP_OK(esp_netif_attach(eth_netif, glue)); - // register user defined event handers + // register user defined event handlers TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); TEST_ESP_OK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, eth_event_group)); // start Ethernet driver diff --git a/components/esp_eth/test_apps/main/esp_eth_test_esp_emac.c b/components/esp_eth/test_apps/main/esp_eth_test_esp_emac.c index 36e3b660e6..00cd32e34d 100644 --- a/components/esp_eth/test_apps/main/esp_eth_test_esp_emac.c +++ b/components/esp_eth/test_apps/main/esp_eth_test_esp_emac.c @@ -377,7 +377,7 @@ TEST_CASE("internal emac interrupt priority", "[esp_emac]") // combine driver with netif esp_eth_netif_glue_handle_t glue = esp_eth_new_netif_glue(eth_handle); TEST_ESP_OK(esp_netif_attach(eth_netif, glue)); - // register user defined event handers + // register user defined event handlers TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); TEST_ESP_OK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, eth_event_group)); diff --git a/components/esp_https_server/include/esp_https_server.h b/components/esp_https_server/include/esp_https_server.h index 611118fc83..6f4e59f1b2 100644 --- a/components/esp_https_server/include/esp_https_server.h +++ b/components/esp_https_server/include/esp_https_server.h @@ -128,7 +128,7 @@ struct httpd_ssl_config { * The callback is only applicable when CONFIG_ESP_HTTPS_SERVER_CERT_SELECT_HOOK is enabled in menuconfig */ esp_https_server_cert_select_cb cert_select_cb; - /** Application protocols the server supports in order of prefernece. + /** Application protocols the server supports in order of preference. * Used for negotiating during the TLS handshake, first one the client supports is selected. * The data structure must live as long as the https server itself */ const char** alpn_protos; diff --git a/components/esp_hw_support/Kconfig b/components/esp_hw_support/Kconfig index 59a4a6d6a9..49f22dbbb1 100644 --- a/components/esp_hw_support/Kconfig +++ b/components/esp_hw_support/Kconfig @@ -167,7 +167,7 @@ menu "Hardware Settings" (!!! Please adjust this value according to the Data Sheet of SPI Flash used in your project.) In Flash Data Sheet, the parameters that define the Flash ready timing after power-up (minimum - time from Vcc(min) to CS activeare) usually named tVSL in ELECTRICAL CHARACTERISTICS chapter, + time from Vcc(min) to CS active) are usually named tVSL in ELECTRICAL CHARACTERISTICS chapter, and the configuration value here should be: ESP_SLEEP_WAIT_FLASH_READY_EXTRA_DELAY = tVSL - 900 diff --git a/components/esp_hw_support/include/esp_private/spi_share_hw_ctrl.h b/components/esp_hw_support/include/esp_private/spi_share_hw_ctrl.h index 873bb74d24..6969731fff 100644 --- a/components/esp_hw_support/include/esp_private/spi_share_hw_ctrl.h +++ b/components/esp_hw_support/include/esp_private/spi_share_hw_ctrl.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -49,7 +49,7 @@ typedef void (*bg_ctrl_func_t)(void*); * Call this if your driver wants to manage a SPI peripheral. * * @param host Peripheral to claim - * @param source The caller indentification string. + * @param source The caller identification string. * * @return True if peripheral is claimed successfully; false if peripheral already is claimed. */ @@ -237,7 +237,7 @@ esp_err_t spi_bus_init_lock(spi_bus_lock_handle_t *out_lock, const spi_bus_lock_ * Free the resources used by an SPI bus lock. * * @note All attached devices should have been unregistered before calling this - * funciton. + * function. * * @param lock Handle to the lock to free. */ @@ -447,7 +447,7 @@ bool spi_bus_lock_bg_exit(spi_bus_lock_handle_t lock, bool wip, BaseType_t* do_y * there is no acquiring device. * * @param lock The SPI bus lock. - * @param out_dev_lock The recommended device for hte next operation. It's the new + * @param out_dev_lock The recommended device for the next operation. It's the new * acquiring device when found, otherwise a device that has active BG request. * * @return true if the ISR need to quit (new acquiring device has no active BG @@ -487,7 +487,7 @@ bool spi_bus_lock_bg_clear_req(spi_bus_lock_dev_handle_t dev_lock); * Check if there is any active BG requests. * * @param lock The SPI bus lock. - * @return true if any device has active BG requst, otherwise false. + * @return true if any device has active BG request, otherwise false. */ bool spi_bus_lock_bg_req_exist(spi_bus_lock_handle_t lock); diff --git a/components/esp_netif/test_apps/test_app_vfs_l2tap/main/test_vfs_l2tap.c b/components/esp_netif/test_apps/test_app_vfs_l2tap/main/test_vfs_l2tap.c index ff766f309b..b2107a87e1 100644 --- a/components/esp_netif/test_apps/test_app_vfs_l2tap/main/test_vfs_l2tap.c +++ b/components/esp_netif/test_apps/test_app_vfs_l2tap/main/test_vfs_l2tap.c @@ -203,7 +203,7 @@ static void ethernet_init(test_vfs_eth_network_t *network_hndls) // combine driver with netif network_hndls->glue = esp_eth_new_netif_glue(network_hndls->eth_handle); TEST_ESP_OK(esp_netif_attach(network_hndls->eth_netif, network_hndls->glue)); - // register user defined event handers + // register user defined event handlers TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, eth_event_group)); TEST_ESP_OK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, eth_event_group)); diff --git a/components/esp_system/Kconfig b/components/esp_system/Kconfig index 72a808e901..c3849f839f 100644 --- a/components/esp_system/Kconfig +++ b/components/esp_system/Kconfig @@ -580,7 +580,7 @@ menu "ESP System Settings" default y select FREERTOS_DEBUG_OCDAWARE help - The FreeRTOS panic and unhandled exception handers can detect a JTAG OCD debugger and + The FreeRTOS panic and unhandled exception handlers can detect a JTAG OCD debugger and instead of panicking, have the debugger stop on the offending instruction. choice ESP_SYSTEM_CHECK_INT_LEVEL diff --git a/components/esp_wifi/include/esp_wifi.h b/components/esp_wifi/include/esp_wifi.h index f6e9f09f75..082c8bf6d2 100644 --- a/components/esp_wifi/include/esp_wifi.h +++ b/components/esp_wifi/include/esp_wifi.h @@ -613,7 +613,7 @@ esp_err_t esp_wifi_scan_get_ap_records(uint16_t *number, wifi_ap_record_t *ap_re * * @attention Different from esp_wifi_scan_get_ap_records(), this API only gets one AP record * from the scanned AP list each time. This API will free the memory of one AP record, - * if the user doesn't get all records in the scannned AP list, then needs to call esp_wifi_clear_ap_list() + * if the user doesn't get all records in the scanned AP list, then needs to call esp_wifi_clear_ap_list() * to free the remaining memory. * * @param[out] ap_record pointer to one AP record diff --git a/components/esp_wifi/lib b/components/esp_wifi/lib index 045077064a..0a5e3a5d43 160000 --- a/components/esp_wifi/lib +++ b/components/esp_wifi/lib @@ -1 +1 @@ -Subproject commit 045077064a43cf51019c427a7dd461fae3fe07d5 +Subproject commit 0a5e3a5d43de82e779d92913d17cb0302249fab3 diff --git a/components/hal/esp32/include/hal/touch_sensor_ll.h b/components/hal/esp32/include/hal/touch_sensor_ll.h index 65b96ae142..357399fe1a 100644 --- a/components/hal/esp32/include/hal/touch_sensor_ll.h +++ b/components/hal/esp32/include/hal/touch_sensor_ll.h @@ -508,11 +508,11 @@ static inline void touch_ll_get_sleep_time(uint16_t *sleep_time) } /** - * Set touch sensor high voltage threshold of chanrge. + * Set touch sensor high voltage threshold of charge. * The touch sensor measures the channel capacitance value by charging and discharging the channel. * So the high threshold should be less than the supply voltage. * - * @param refh The high voltage threshold of chanrge. + * @param refh The high voltage threshold of charge. */ static inline void touch_ll_set_voltage_high(touch_high_volt_t refh) { @@ -520,11 +520,11 @@ static inline void touch_ll_set_voltage_high(touch_high_volt_t refh) } /** - * Get touch sensor high voltage threshold of chanrge. + * Get touch sensor high voltage threshold of charge. * The touch sensor measures the channel capacitance value by charging and discharging the channel. * So the high threshold should be less than the supply voltage. * - * @param refh The high voltage threshold of chanrge. + * @param refh The high voltage threshold of charge. */ static inline void touch_ll_get_voltage_high(touch_high_volt_t *refh) { @@ -554,11 +554,11 @@ static inline void touch_ll_get_voltage_low(touch_low_volt_t *refl) } /** - * Set touch sensor high voltage attenuation of chanrge. The actual charge threshold is high voltage threshold minus attenuation value. + * Set touch sensor high voltage attenuation of charge. The actual charge threshold is high voltage threshold minus attenuation value. * The touch sensor measures the channel capacitance value by charging and discharging the channel. * So the high threshold should be less than the supply voltage. * - * @param refh The high voltage threshold of chanrge. + * @param refh The high voltage threshold of charge. */ static inline void touch_ll_set_voltage_attenuation(touch_volt_atten_t atten) { @@ -566,11 +566,11 @@ static inline void touch_ll_set_voltage_attenuation(touch_volt_atten_t atten) } /** - * Get touch sensor high voltage attenuation of chanrge. The actual charge threshold is high voltage threshold minus attenuation value. + * Get touch sensor high voltage attenuation of charge. The actual charge threshold is high voltage threshold minus attenuation value. * The touch sensor measures the channel capacitance value by charging and discharging the channel. * So the high threshold should be less than the supply voltage. * - * @param refh The high voltage threshold of chanrge. + * @param refh The high voltage threshold of charge. */ static inline void touch_ll_get_voltage_attenuation(touch_volt_atten_t *atten) { diff --git a/components/hal/esp32s2/include/hal/touch_sensor_hal.h b/components/hal/esp32s2/include/hal/touch_sensor_hal.h index 6d2770d4ee..d74b83b937 100644 --- a/components/hal/esp32s2/include/hal/touch_sensor_hal.h +++ b/components/hal/esp32s2/include/hal/touch_sensor_hal.h @@ -186,7 +186,7 @@ void touch_hal_filter_get_config(touch_filter_config_t *filter_info); * Force reset benchmark to raw data of touch sensor. * * @param touch_num touch pad index - * - TOUCH_PAD_MAX Reset basaline of all channels. + * - TOUCH_PAD_MAX Reset baseline of all channels. */ #define touch_hal_reset_benchmark(touch_num) touch_ll_reset_benchmark(touch_num) diff --git a/components/hal/esp32s2/include/hal/touch_sensor_ll.h b/components/hal/esp32s2/include/hal/touch_sensor_ll.h index b35b68908d..13b253d4e4 100644 --- a/components/hal/esp32s2/include/hal/touch_sensor_ll.h +++ b/components/hal/esp32s2/include/hal/touch_sensor_ll.h @@ -1404,7 +1404,7 @@ static inline void IRAM_ATTR touch_ll_read_benchmark(touch_pad_t touch_num, uint * * @note If call this API, make sure enable clock gate(`touch_ll_clkgate`) first. * @param touch_num touch pad index - * - TOUCH_PAD_MAX Reset basaline of all channels. + * - TOUCH_PAD_MAX Reset baseline of all channels. */ static inline void touch_ll_reset_benchmark(touch_pad_t touch_num) { diff --git a/components/hal/esp32s3/include/hal/touch_sensor_hal.h b/components/hal/esp32s3/include/hal/touch_sensor_hal.h index dc8f6fefdc..94219cfb57 100644 --- a/components/hal/esp32s3/include/hal/touch_sensor_hal.h +++ b/components/hal/esp32s3/include/hal/touch_sensor_hal.h @@ -186,7 +186,7 @@ void touch_hal_filter_get_config(touch_filter_config_t *filter_info); * Force reset benchmark to raw data of touch sensor. * * @param touch_num touch pad index - * - TOUCH_PAD_MAX Reset basaline of all channels. + * - TOUCH_PAD_MAX Reset baseline of all channels. */ #define touch_hal_reset_benchmark(touch_num) touch_ll_reset_benchmark(touch_num) diff --git a/components/hal/esp32s3/include/hal/touch_sensor_ll.h b/components/hal/esp32s3/include/hal/touch_sensor_ll.h index 5a17306bbb..28b91632c4 100644 --- a/components/hal/esp32s3/include/hal/touch_sensor_ll.h +++ b/components/hal/esp32s3/include/hal/touch_sensor_ll.h @@ -1441,7 +1441,7 @@ static inline void IRAM_ATTR touch_ll_read_benchmark(touch_pad_t touch_num, uint * * @note If call this API, make sure enable clock gate(`touch_ll_clkgate`) first. * @param touch_num touch pad index - * - TOUCH_PAD_MAX Reset basaline of all channels. + * - TOUCH_PAD_MAX Reset baseline of all channels. */ static inline void touch_ll_reset_benchmark(touch_pad_t touch_num) { diff --git a/components/hal/include/hal/mcpwm_types.h b/components/hal/include/hal/mcpwm_types.h index 2e826a5a05..8562f400bb 100644 --- a/components/hal/include/hal/mcpwm_types.h +++ b/components/hal/include/hal/mcpwm_types.h @@ -73,7 +73,7 @@ typedef enum { typedef enum { MCPWM_TIMER_STOP_EMPTY, /*!< MCPWM timer stops when next count reaches zero */ MCPWM_TIMER_STOP_FULL, /*!< MCPWM timer stops when next count reaches peak */ - MCPWM_TIMER_START_NO_STOP, /*!< MCPWM timer starts couting, and don't stop until received stop command */ + MCPWM_TIMER_START_NO_STOP, /*!< MCPWM timer starts counting, and don't stop until received stop command */ MCPWM_TIMER_START_STOP_EMPTY, /*!< MCPWM timer starts counting and stops when next count reaches zero */ MCPWM_TIMER_START_STOP_FULL, /*!< MCPWM timer starts counting and stops when next count reaches peak */ } mcpwm_timer_start_stop_cmd_t; diff --git a/components/hal/include/hal/sdio_slave_hal.h b/components/hal/include/hal/sdio_slave_hal.h index a517f6b6d8..bfdbe9e9be 100644 --- a/components/hal/include/hal/sdio_slave_hal.h +++ b/components/hal/include/hal/sdio_slave_hal.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2015-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2015-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -153,7 +153,7 @@ extern "C" { #endif #if SOC_SDIO_SLAVE_SUPPORTED -/// Space used for each sending descriptor. Should initialize the sendbuf accoring to this size. +/// Space used for each sending descriptor. Should initialize the sendbuf according to this size. #define SDIO_SLAVE_SEND_DESC_SIZE sizeof(sdio_slave_hal_send_desc_t) @@ -239,7 +239,7 @@ typedef struct { /** * Initialize the HAL, should provide buffers to the context and configure the - * members before this funciton is called. + * members before this function is called. * * @param hal Context of the HAL layer. */ @@ -350,7 +350,7 @@ esp_err_t sdio_slave_hal_send_get_next_finished_arg(sdio_slave_context_t *hal, v * * @note Only call when the DMA is stopped! * @param hal Context of the HAL layer. - * @param out_arg Argument indiciating the buffer to send + * @param out_arg Argument indicating the buffer to send * @param out_return_cnt Space in the queue released after this descriptor is flushed. * @return * - ESP_ERR_INVALID_STATE: This function call be called only when the DMA is stopped. @@ -476,7 +476,7 @@ void sdio_slave_hal_recv_flush_one_buffer(sdio_slave_context_t *hal); /** * Enable some of the interrupts for the host. * - * @note May have concurrency issue wit the host or other tasks, suggest only use it during + * @note May have concurrency issue with the host or other tasks, suggest only use it during * initialization. * @param hal Context of the HAL layer. * @param mask Bitwise mask for the interrupts to enable. diff --git a/components/hal/include/hal/touch_sensor_hal.h b/components/hal/include/hal/touch_sensor_hal.h index 23f9ba863a..2bafab2730 100644 --- a/components/hal/include/hal/touch_sensor_hal.h +++ b/components/hal/include/hal/touch_sensor_hal.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2019-2024 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2019-2025 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -54,22 +54,22 @@ typedef struct { #define touch_hal_get_sleep_time(sleep_time) touch_ll_get_sleep_time(sleep_time) /** - * Set touch sensor high / low voltage threshold of chanrge. + * Set touch sensor high / low voltage threshold of charge. * The touch sensor measures the channel capacitance value by charging and discharging the channel. * So charge threshold should be less than the supply voltage. * The actual charge threshold is high voltage threshold minus attenuation value. * - * @param refh The high voltage threshold of chanrge. + * @param refh The high voltage threshold of charge. */ void touch_hal_set_voltage(const touch_hal_volt_t *volt); /** - * Get touch sensor high / low voltage threshold of chanrge. + * Get touch sensor high / low voltage threshold of charge. * The touch sensor measures the channel capacitance value by charging and discharging the channel. * So charge threshold should be less than the supply voltage. * The actual charge threshold is high voltage threshold minus attenuation value. * - * @param refh The voltage threshold of chanrge / discharge. + * @param refh The voltage threshold of charge / discharge. */ void touch_hal_get_voltage(touch_hal_volt_t *volt); diff --git a/components/mbedtls/Kconfig b/components/mbedtls/Kconfig index d499956a2c..cc46f584f7 100644 --- a/components/mbedtls/Kconfig +++ b/components/mbedtls/Kconfig @@ -655,7 +655,7 @@ menu "mbedTLS" expiry of TLS session tickets or session cache entries. Disabling this option will save some firmware size, particularly if - the rest of the firmware doesn't call any standard timekeeeping + the rest of the firmware doesn't call any standard timekeeping functions. config MBEDTLS_PLATFORM_TIME_ALT diff --git a/components/mqtt/test_apps/common/test_mqtt_connection.c b/components/mqtt/test_apps/common/test_mqtt_connection.c index 0e82003918..a6cb70210c 100644 --- a/components/mqtt/test_apps/common/test_mqtt_connection.c +++ b/components/mqtt/test_apps/common/test_mqtt_connection.c @@ -112,7 +112,7 @@ void connect_test_fixture_setup(void) // combine driver with netif s_eth_glue = esp_eth_new_netif_glue(s_eth_handle); TEST_ESP_OK(esp_netif_attach(s_eth_netif, s_eth_glue)); - // register user defined event handers + // register user defined event handlers TEST_ESP_OK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, s_eth_event_group)); TEST_ESP_OK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, s_eth_event_group)); // start Ethernet driver diff --git a/components/openthread/include/esp_openthread_netif_glue.h b/components/openthread/include/esp_openthread_netif_glue.h index 3d70c8a7f7..b71d29d24a 100644 --- a/components/openthread/include/esp_openthread_netif_glue.h +++ b/components/openthread/include/esp_openthread_netif_glue.h @@ -62,7 +62,7 @@ void esp_openthread_netif_glue_deinit(void); * @brief This function acquires the OpenThread netif. * * @return - * The OpenThread netif or NULL if not initialzied. + * The OpenThread netif or NULL if not initialized. * */ esp_netif_t *esp_openthread_get_netif(void); diff --git a/components/perfmon/include/xtensa_perfmon_apis.h b/components/perfmon/include/xtensa_perfmon_apis.h index 735544cb88..e026ab555c 100644 --- a/components/perfmon/include/xtensa_perfmon_apis.h +++ b/components/perfmon/include/xtensa_perfmon_apis.h @@ -21,7 +21,7 @@ extern "C" * Structure to configure performance counter to measure dedicated function */ typedef struct xtensa_perfmon_config { - int repeat_count; /*!< how much times function will be called before the calback will be repeated */ + int repeat_count; /*!< how much times function will be called before the callback will be repeated */ float max_deviation; /*!< Difference between min and max counter number 0..1, 0 - no difference, 1 - not used */ void *call_params; /*!< This pointer will be passed to the call_function as a parameter */ void (*call_function)(void *params); /*!< pointer to the function that have to be called */ @@ -56,7 +56,7 @@ esp_err_t xtensa_perfmon_exec(const xtensa_perfmon_config_t *config); * perfmon_config_t::callback_params. If callback_params is set to NULL, will print to stdout * * @param[in] params: used parameters passed from configuration (callback_params). - * This parameter expected as FILE* hanle, where data will be stored. + * This parameter is expected to be a FILE* handle, where data will be stored. * If this parameter NULL, then data will be stored to the stdout. * @param[in] select: select value for current counter * @param[in] mask: mask value for current counter diff --git a/components/protocomm/include/crypto/srp6a/esp_srp.h b/components/protocomm/include/crypto/srp6a/esp_srp.h index b02d78a5b5..a430d08a7d 100644 --- a/components/protocomm/include/crypto/srp6a/esp_srp.h +++ b/components/protocomm/include/crypto/srp6a/esp_srp.h @@ -132,7 +132,7 @@ void esp_srp_free(esp_srp_handle_t *hd); * @param username Username not expected NULL terminated * @param username_len Username length * @param pass Password not expected to be NULL terminated - * @param pass_len Pasword length + * @param pass_len Password length * @param salt_len Salt length * @param bytes_B Public Key returned * @param len_B Length of the public key @@ -162,7 +162,7 @@ esp_err_t esp_srp_srv_pubkey(esp_srp_handle_t *hd, const char *username, int use * @note if API has returned ESP_OK, salt and verifier generated need to be freed by caller * @note Usually, username and password are not saved on the device. Rather salt and verifier are * generated outside the device and are embedded. - * this covenience API can be used to generate salt and verifier on the fly for development use case. + * this convenience API can be used to generate salt and verifier on the fly for development use case. * OR for devices which intentionally want to generate different password each time and can send it * to the client securely. e.g., a device has a display and it shows the pin */ diff --git a/components/spi_flash/spi_flash_chip_mxic_opi.c b/components/spi_flash/spi_flash_chip_mxic_opi.c index d19488fa53..417b67799c 100644 --- a/components/spi_flash/spi_flash_chip_mxic_opi.c +++ b/components/spi_flash/spi_flash_chip_mxic_opi.c @@ -88,7 +88,7 @@ esp_err_t spi_flash_chip_mxic_opi_set_write_protect(esp_flash_t *chip, bool writ static void spi_flash_chip_mxic_opi_get_data_length_zoom(esp_flash_io_mode_t io_mode, uint32_t *length_zoom) { /* Under STR mode, one byte occupies one single clock. While under DTR mode, one byte occupies half clock. - For exmaple, if an operation needs 3 clock dummy, host send 3 dummy bytes under STR mode, while 6 dummy bytes under DTR mode. + For example, if an operation needs 3 clock dummy, host send 3 dummy bytes under STR mode, while 6 dummy bytes under DTR mode. Therefore, we need to adjust data zoom to fit the clock here. */ assert((io_mode == SPI_FLASH_OPI_STR) || (io_mode == SPI_FLASH_OPI_DTR)); *length_zoom = (io_mode == SPI_FLASH_OPI_STR) ? 1 : 2; @@ -358,7 +358,7 @@ esp_err_t spi_flash_chip_xmic_opi_set_io_mode(esp_flash_t *chip) } // This function should only be called after opi mode initialization. So, only configure for OPI-STR/OPI-DTR mode -// not support other mode in this file, return `ESP_ERR_FLASH_NOT_INITIALISED` directely. +// not support other mode in this file, return `ESP_ERR_FLASH_NOT_INITIALISED` directly. esp_err_t spi_flash_chip_xmic_opi_config_host_io_mode(esp_flash_t *chip, uint32_t flags) { uint32_t dummy_cyclelen_base; diff --git a/components/ulp/ulp_riscv/include/ulp_riscv.h b/components/ulp/ulp_riscv/include/ulp_riscv.h index 39836a58b6..b77934d964 100644 --- a/components/ulp/ulp_riscv/include/ulp_riscv.h +++ b/components/ulp/ulp_riscv/include/ulp_riscv.h @@ -133,7 +133,7 @@ void ulp_riscv_halt(void); * * @note This will reset the ULP core from the main CPU. It is intended to be used when the * ULP is in a bad state and cannot run as intended due to a corrupt firmware or any other reason. - * The main core can reset the ULP core with this API and then re-initilialize the ULP. + * The main core can reset the ULP core with this API and then re-initialize the ULP. */ void ulp_riscv_reset(void); diff --git a/components/ulp/ulp_riscv/ulp_core/include/ulp_riscv_touch_ulp_core.h b/components/ulp/ulp_riscv/ulp_core/include/ulp_riscv_touch_ulp_core.h index 043c7d5072..f589e7000d 100644 --- a/components/ulp/ulp_riscv/ulp_core/include/ulp_riscv_touch_ulp_core.h +++ b/components/ulp/ulp_riscv/ulp_core/include/ulp_riscv_touch_ulp_core.h @@ -48,7 +48,7 @@ esp_err_t ulp_riscv_touch_pad_filter_read_smooth(touch_pad_t touch_num, uint32_t * @brief Force reset benchmark to raw data of touch sensor. * @note Refer `touch_pad_reset_benchmark()` for more details * - * @param touch_num Touch pad index (TOUCH_PAD_MAX resets basaline of all channels) + * @param touch_num Touch pad index (TOUCH_PAD_MAX resets baseline of all channels) * @return esp_err_t ESP_OK when successful */ esp_err_t ulp_riscv_touch_pad_reset_benchmark(touch_pad_t touch_num); diff --git a/components/vfs/include/esp_vfs.h b/components/vfs/include/esp_vfs.h index 8e71115a43..c0f20979ad 100644 --- a/components/vfs/include/esp_vfs.h +++ b/components/vfs/include/esp_vfs.h @@ -352,7 +352,7 @@ esp_err_t esp_vfs_register_fd(esp_vfs_id_t vfs_id, int *fd); * * @param vfs_id VFS identificator returned by esp_vfs_register_with_id. * @param local_fd The fd in the local vfs. Passing -1 will set the local fd as the (*fd) value. - * @param permanent Whether the fd should be treated as permannet (not removed after close()) + * @param permanent Whether the fd should be treated as permanent (not removed after close()) * @param fd The registered file descriptor will be written to this address. * * @return ESP_OK if the registration is successful, diff --git a/components/wpa_supplicant/esp_supplicant/include/esp_dpp.h b/components/wpa_supplicant/esp_supplicant/include/esp_dpp.h index 77c694f743..5330c5dbe8 100644 --- a/components/wpa_supplicant/esp_supplicant/include/esp_dpp.h +++ b/components/wpa_supplicant/esp_supplicant/include/esp_dpp.h @@ -64,7 +64,7 @@ typedef void (*esp_supp_dpp_event_cb_t)(esp_supp_dpp_event_t evt, void *data); esp_err_t esp_supp_dpp_init(esp_supp_dpp_event_cb_t evt_cb); /** - * @brief De-initalize DPP Supplicant + * @brief De-initialize DPP Supplicant * * Frees memory from DPP Supplicant Data Structures. * diff --git a/components/wpa_supplicant/esp_supplicant/include/esp_wnm.h b/components/wpa_supplicant/esp_supplicant/include/esp_wnm.h index 8a73e3a43d..8efa02e5c6 100644 --- a/components/wpa_supplicant/esp_supplicant/include/esp_wnm.h +++ b/components/wpa_supplicant/esp_supplicant/include/esp_wnm.h @@ -45,7 +45,7 @@ int esp_wnm_send_bss_transition_mgmt_query(enum btm_query_reason query_reason, int cand_list); /** - * @brief Check bss trasition capability of connected AP + * @brief Check bss transition capability of connected AP * * @return * - true: AP supports BTM diff --git a/docs/en/api-guides/coexist.rst b/docs/en/api-guides/coexist.rst index bd1fcd37ce..aa31036255 100644 --- a/docs/en/api-guides/coexist.rst +++ b/docs/en/api-guides/coexist.rst @@ -204,14 +204,14 @@ Coexistence Policy .. only:: SOC_IEEE802154_SUPPORTED - The IEEE 802.15.4 module requests RF resources based on pre-assigned priorities. Normal receive operations are assigned the lowest priority, meaning Wi-Fi and BLE will take over the RF whenever needed, while 802.15.4 can only receive during the remaining time. Other 802.15.4 operations, such as transmitting or receiving ACKs and transmitting or receiving at given time, are assigned higher priorities. However, their access to RF ultimately depends on the priorities of Wi-Fi and BLE operations at that moment. + The IEEE 802.15.4 module requests RF resources based on pre-assigned priorities. Normal receive operations are assigned the lowest priority, meaning Wi-Fi and BLE will take over the RF whenever needed, while 802.15.4 can only receive during the remaining time. Other 802.15.4 operations, such as transmitting or receiving ACKs and transmitting or receiving at given time, are assigned higher priorities. However, their access to RF ultimately depends on the priorities of Wi-Fi and BLE operations at that moment. .. only:: SOC_WIFI_SUPPORTED and SOC_BT_SUPPORTED - Dynamic Priority - """""""""""""""""""""""""""" + Dynamic Priority + """""""""""""""""""""""""""" - The coexistence module assigns varying priorities to different statuses of each module, and these priorities are dynamic. For example, in every N BLE Advertising events, there is always one event with high priority. If a high-priority BLE Advertising event occurs within the Wi-Fi time slice, the right to use the RF may be preempted by BLE. + The coexistence module assigns varying priorities to different statuses of each module, and these priorities are dynamic. For example, in every N BLE Advertising events, there is always one event with high priority. If a high-priority BLE Advertising event occurs within the Wi-Fi time slice, the right to use the RF may be preempted by BLE. .. only:: SOC_WIFI_SUPPORTED @@ -249,7 +249,7 @@ Coexistence API Error Codes All coexistence APIs have custom return values, i.e., error codes. These error codes can be categorized as: - - No error. For example, the return value ESP_OK siginifies the API returned successfully. + - No error. For example, the return value ESP_OK signifies the API returned successfully. - Recoverable errors. For example, the return value ESP_ERR_INVALID_ARG signifies API parameter errors. diff --git a/docs/en/api-guides/esp-wifi-mesh.rst b/docs/en/api-guides/esp-wifi-mesh.rst index 998224a9ed..1e7f274dfe 100644 --- a/docs/en/api-guides/esp-wifi-mesh.rst +++ b/docs/en/api-guides/esp-wifi-mesh.rst @@ -277,7 +277,7 @@ The following diagram demonstrates how an ESP-WIFI-MESH network is built when th **2.** Over multiple iterations of transmission and scanning, the beacon frame with the strongest router RSSI is propagated throughout the network. Node C has the strongest router RSSI (-10 dB) hence its beacon frame is propagated throughout the network. All nodes participating in the election vote for node C thus giving node C a vote percentage of 100%. Therefore node C becomes a root node and connects with the router. -**3.** Once Node C has connected with the router, nodes A/B/D/E connectwith node C as it is the preferred parent node (i.e., the shallowest node). Nodes A/B/D/E form the second layer of the network. +**3.** Once Node C has connected with the router, nodes A/B/D/E connect with node C as it is the preferred parent node (i.e., the shallowest node). Nodes A/B/D/E form the second layer of the network. **4.** Node F and G connect with nodes D and E respectively and the network building process is complete. diff --git a/docs/en/api-guides/performance/speed.rst b/docs/en/api-guides/performance/speed.rst index 17b9b658af..fe3f8a5887 100644 --- a/docs/en/api-guides/performance/speed.rst +++ b/docs/en/api-guides/performance/speed.rst @@ -175,7 +175,7 @@ The example project :example:`system/startup_time` is pre-configured to optimize Task Priorities --------------- -As ESP-IDF FreeRTOS is a real-time operating system, it is necessary to ensure that high-throughput or low-slatency tasks are granted a high priority in order to run immediately. Priority is set when calling :cpp:func:`xTaskCreate` or :cpp:func:`xTaskCreatePinnedToCore` and can be changed at runtime by calling :cpp:func:`vTaskPrioritySet`. +As ESP-IDF FreeRTOS is a real-time operating system, it is necessary to ensure that high-throughput or low-latency tasks are granted a high priority in order to run immediately. Priority is set when calling :cpp:func:`xTaskCreate` or :cpp:func:`xTaskCreatePinnedToCore` and can be changed at runtime by calling :cpp:func:`vTaskPrioritySet`. It is also necessary to ensure that tasks yield CPU (by calling :cpp:func:`vTaskDelay`, ``sleep()``, or by blocking on semaphores, queues, task notifications, etc) in order to not starve lower-priority tasks and cause problems for the overall system. The :ref:`task-watchdog-timer` provides a mechanism to automatically detect if task starvation happens. However, note that a TWDT timeout does not always indicate a problem, because sometimes the correct operation of the firmware requires some long-running computation. In these cases, tweaking the TWDT timeout or even disabling the TWDT may be necessary. diff --git a/docs/en/api-guides/wifi.rst b/docs/en/api-guides/wifi.rst index 2a01552cb8..ca2f76a8f7 100644 --- a/docs/en/api-guides/wifi.rst +++ b/docs/en/api-guides/wifi.rst @@ -2417,7 +2417,7 @@ Wi-Fi HT20/40 In station/AP coexist mode, the station/AP can configure HT20/40 separately. If both station and AP are negotiated to HT40, the HT40 channel should be the channel of station because the station always has higher priority than AP in {IDF_TARGET_NAME}. For example, the configured bandwidth of AP is HT40, the configured primary channel is 6, and the configured secondary channel is 10. The station is connected to an router whose primary channel is 6 and secondary channel is 2, then the actual channel of AP is changed to primary 6 and secondary 2 automatically. - Theoretically, the HT40 can gain better throughput because the maximum raw physicial (PHY) data rate for HT40 is 150 Mbps while it is 72 Mbps for HT20. However, if the device is used in some special environment, e.g., there are too many other Wi-Fi devices around the {IDF_TARGET_NAME} device, the performance of HT40 may be degraded. So if the applications need to support same or similar scenarios, it is recommended that the bandwidth is always configured to HT20. + Theoretically, the HT40 can gain better throughput because the maximum raw physical (PHY) data rate for HT40 is 150 Mbps while it is 72 Mbps for HT20. However, if the device is used in some special environment, e.g., there are too many other Wi-Fi devices around the {IDF_TARGET_NAME} device, the performance of HT40 may be degraded. So if the applications need to support same or similar scenarios, it is recommended that the bandwidth is always configured to HT20. .. only:: esp32c2 diff --git a/docs/en/api-reference/network/esp_dpp.rst b/docs/en/api-reference/network/esp_dpp.rst index e7b8526577..7a19fe8007 100644 --- a/docs/en/api-reference/network/esp_dpp.rst +++ b/docs/en/api-reference/network/esp_dpp.rst @@ -3,7 +3,7 @@ Wi-Fi Easy Connect\ :sup:`TM` (DPP) :link_to_translation:`zh_CN:[中文]` -Wi-Fi Easy Connect\ :sup:`TM`, also known as Device Provisioning Protocol (DPP) or Easy Connect, is a provisioning protocol certified by Wi-Fi Alliance. It is a secure and standardized provisioning protocol for configuration of Wi-Fi Devices. With Easy Connect, adding a new device to a network is as simple as scanning a QR Code. This reduces complexity and enhances user experience while onboarding devices without UI like Smart Home and IoT products. Unlike old protocols like Wi-Fi Protected Setup (WPS), Wi-Fi Easy Connect in corporates strong encryption through public key cryptography to ensure networks remain secure as new devices are added. +Wi-Fi Easy Connect\ :sup:`TM`, also known as Device Provisioning Protocol (DPP) or Easy Connect, is a provisioning protocol certified by Wi-Fi Alliance. It is a secure and standardized provisioning protocol for configuration of Wi-Fi Devices. With Easy Connect, adding a new device to a network is as simple as scanning a QR Code. This reduces complexity and enhances user experience while onboarding devices without UI like Smart Home and IoT products. Unlike old protocols like Wi-Fi Protected Setup (WPS), Wi-Fi Easy Connect incorporates strong encryption through public key cryptography to ensure networks remain secure as new devices are added. Easy Connect brings many benefits in the user experience: diff --git a/docs/en/api-reference/peripherals/sdmmc_host.rst b/docs/en/api-reference/peripherals/sdmmc_host.rst index c37f180052..b4d5caa4b7 100644 --- a/docs/en/api-reference/peripherals/sdmmc_host.rst +++ b/docs/en/api-reference/peripherals/sdmmc_host.rst @@ -202,7 +202,7 @@ See also - :doc:`../storage/sdmmc`: introduces the higher-level driver which implements the protocol layer. - :doc:`sdspi_host`: introduces a similar driver that uses the SPI controller and is limited to SD protocol's SPI mode. -- :doc:`sd_pullup_requirements`: introduces pull-up support and compatibilities of modules and development kits. +- :doc:`sd_pullup_requirements`: introduces pull-up support and compatibility of modules and development kits. API Reference diff --git a/docs/en/libraries-and-frameworks/libs-frameworks.rst b/docs/en/libraries-and-frameworks/libs-frameworks.rst index bb0b56be46..9d1c6a0e65 100644 --- a/docs/en/libraries-and-frameworks/libs-frameworks.rst +++ b/docs/en/libraries-and-frameworks/libs-frameworks.rst @@ -92,7 +92,7 @@ ESP-Protocols components: * `mdns `_ (mDNS) is a multicast UDP service that is used to provide local network service and host discovery. See the `mdns documentation `_. -* `esp_websocket_client `_ is a managed component for ESP-IDF that contains implementation of WebSocket protocol client for ESP32. See the `esp_websocket_client documentation `_. For detailes of WebSocket protocol client, see `WebSocket_protocol_client `_. +* `esp_websocket_client `_ is a managed component for ESP-IDF that contains implementation of WebSocket protocol client for ESP32. See the `esp_websocket_client documentation `_. For details of WebSocket protocol client, see `WebSocket_protocol_client `_. * `asio `_ is a cross-platform C++ library, see https://think-async.com/Asio/. It provides a consistent asynchronous model using a modern C++ approach. See the `asio documentation `_. diff --git a/docs/en/migration-guides/release-5.x/5.0/peripherals.rst b/docs/en/migration-guides/release-5.x/5.0/peripherals.rst index e21960c675..c979ba9e26 100644 --- a/docs/en/migration-guides/release-5.x/5.0/peripherals.rst +++ b/docs/en/migration-guides/release-5.x/5.0/peripherals.rst @@ -520,7 +520,7 @@ LCD 2. Call :func:`i2s_channel_init_std_mode`, :func:`i2s_channel_init_pdm_rx_mode`, :func:`i2s_channel_init_pdm_tx_mode` or :func:`i2s_channel_init_tdm_mode` to initialize the channel to the specified mode. Corresponding slot, clock and GPIO configurations are needed in this step. 3. (Optional) Call :cpp:func:`i2s_channel_register_event_callback` to register the ISR event callback functions. I2S events now can be received by the callback function synchronously, instead of from the event queue asynchronously. 4. Call :cpp:func:`i2s_channel_enable` to start the hardware of I2S channel. In the new driver, I2S does not start automatically after installed, and users are supposed to know clearly whether the channel has started or not. - 5. Read or write data by :cpp:func:`i2s_channel_read` or :cpp:func:`i2s_channel_write`. Certainly, only the RX channel handle is suppoesd to be inputted in :cpp:func:`i2s_channel_read` and the TX channel handle in :cpp:func:`i2s_channel_write`. + 5. Read or write data by :cpp:func:`i2s_channel_read` or :cpp:func:`i2s_channel_write`. Certainly, only the RX channel handle is supposed to be inputted in :cpp:func:`i2s_channel_read` and the TX channel handle in :cpp:func:`i2s_channel_write`. 6. (Optional) The slot, clock and GPIO configurations can be changed by corresponding 'reconfig' functions, but :cpp:func:`i2s_channel_disable` must be called before updating the configurations. 7. Call :cpp:func:`i2s_channel_disable` to stop the hardware of I2S channel. 8. Call :cpp:func:`i2s_del_channel` to delete and release the resources of the channel if it is not needed any more, but the channel must be disabled before deleting it. diff --git a/examples/common_components/protocol_examples_common/eth_connect.c b/examples/common_components/protocol_examples_common/eth_connect.c index 0cd105621d..ad48069021 100644 --- a/examples/common_components/protocol_examples_common/eth_connect.c +++ b/examples/common_components/protocol_examples_common/eth_connect.c @@ -169,7 +169,7 @@ static esp_netif_t *eth_start(void) s_eth_glue = esp_eth_new_netif_glue(s_eth_handle); esp_netif_attach(netif, s_eth_glue); - // Register user defined event handers + // Register user defined event handlers ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, ð_on_got_ip, NULL)); #ifdef CONFIG_EXAMPLE_CONNECT_IPV6 ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_CONNECTED, &on_eth_event, netif)); diff --git a/examples/ethernet/basic/main/ethernet_example_main.c b/examples/ethernet/basic/main/ethernet_example_main.c index 19f60cfed4..f18154ca33 100644 --- a/examples/ethernet/basic/main/ethernet_example_main.c +++ b/examples/ethernet/basic/main/ethernet_example_main.c @@ -112,7 +112,7 @@ void app_main(void) } } - // Register user defined event handers + // Register user defined event handlers ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, NULL)); ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, NULL)); diff --git a/examples/ethernet/iperf/main/Kconfig.projbuild b/examples/ethernet/iperf/main/Kconfig.projbuild index 83d85cef65..8681b631e8 100644 --- a/examples/ethernet/iperf/main/Kconfig.projbuild +++ b/examples/ethernet/iperf/main/Kconfig.projbuild @@ -5,6 +5,6 @@ menu "Example Configuration" default y help Linenoise line editing library provides functions to save and load - command history. If this option is enabled, initalizes a FAT filesystem + command history. If this option is enabled, initializes a FAT filesystem and uses it to store command history. endmenu diff --git a/examples/network/bridge/main/bridge_example_main.c b/examples/network/bridge/main/bridge_example_main.c index e0fa9c09e0..719c0af3bb 100644 --- a/examples/network/bridge/main/bridge_example_main.c +++ b/examples/network/bridge/main/bridge_example_main.c @@ -190,7 +190,7 @@ void app_main(void) // Attach esp netif bridge glue instance with added ports to bridge netif ESP_ERROR_CHECK(esp_netif_attach(br_netif, netif_br_glue)); - // Register user defined event handers + // Register user defined event handlers ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, NULL)); ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, NULL)); diff --git a/examples/network/simple_sniffer/main/Kconfig.projbuild b/examples/network/simple_sniffer/main/Kconfig.projbuild index 2677b15366..cd7df7501c 100644 --- a/examples/network/simple_sniffer/main/Kconfig.projbuild +++ b/examples/network/simple_sniffer/main/Kconfig.projbuild @@ -7,7 +7,7 @@ menu "Example Configuration" default y help Linenoise line editing library provides functions to save and load command history. - If this option is enabled, initalizes a FAT filesystem and uses it to store command history. + If this option is enabled, initializes a FAT filesystem and uses it to store command history. choice SNIFFER_PCAP_DESTINATION prompt "Select destination to store pcap file" @@ -35,7 +35,7 @@ menu "Example Configuration" prompt "Select SD card work mode" default SNIFFER_SD_SDMMC_MODE help - Select whitch peripheral SD card should use. + Select which peripheral SD card should use. config SNIFFER_SD_SDMMC_MODE bool "SDMMC" depends on IDF_TARGET_ESP32 || IDF_TARGET_ESP32S3 diff --git a/examples/network/simple_sniffer/main/simple_sniffer_example_main.c b/examples/network/simple_sniffer/main/simple_sniffer_example_main.c index 4674c78236..a7505a8bdc 100644 --- a/examples/network/simple_sniffer/main/simple_sniffer_example_main.c +++ b/examples/network/simple_sniffer/main/simple_sniffer_example_main.c @@ -130,7 +130,7 @@ static void initialize_eth(void) ESP_ERROR_CHECK(example_eth_init(ð_handles, ð_port_cnt)); if (eth_port_cnt > 0) { - // Register user defined event handers + // Register user defined event handlers ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, NULL)); for (uint32_t i = 0; i < eth_port_cnt; i++) { diff --git a/examples/network/vlan_support/main/vlan_support_main.c b/examples/network/vlan_support/main/vlan_support_main.c index a7fd985999..30c5c891b3 100644 --- a/examples/network/vlan_support/main/vlan_support_main.c +++ b/examples/network/vlan_support/main/vlan_support_main.c @@ -145,7 +145,7 @@ void app_main(void) // Create default event loop that running in background ESP_ERROR_CHECK(esp_event_loop_create_default()); - // Register user defined event handers + // Register user defined event handlers ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ESP_EVENT_ANY_ID, ð_event_handler, NULL)); ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &got_ip_event_handler, NULL)); diff --git a/examples/peripherals/i2c/i2c_tools/main/Kconfig.projbuild b/examples/peripherals/i2c/i2c_tools/main/Kconfig.projbuild index 14f3381330..265a48e5e8 100644 --- a/examples/peripherals/i2c/i2c_tools/main/Kconfig.projbuild +++ b/examples/peripherals/i2c/i2c_tools/main/Kconfig.projbuild @@ -5,7 +5,7 @@ menu "Example Configuration" default y help Linenoise line editing library provides functions to save and load - command history. If this option is enabled, initalizes a FAT filesystem + command history. If this option is enabled, initializes a FAT filesystem and uses it to store command history. config EXAMPLE_I2C_MASTER_SCL diff --git a/examples/system/console/basic/main/Kconfig.projbuild b/examples/system/console/basic/main/Kconfig.projbuild index f9d9e82030..169b5d04b4 100644 --- a/examples/system/console/basic/main/Kconfig.projbuild +++ b/examples/system/console/basic/main/Kconfig.projbuild @@ -5,7 +5,7 @@ menu "Example Configuration" default y help Linenoise line editing library provides functions to save and load - command history. If this option is enabled, initalizes a FAT filesystem + command history. If this option is enabled, initializes a FAT filesystem and uses it to store command history. config CONSOLE_MAX_COMMAND_LINE_LENGTH diff --git a/tools/test_apps/storage/sdmmc_console/README.md b/tools/test_apps/storage/sdmmc_console/README.md index a110a35361..46c1752cd5 100644 --- a/tools/test_apps/storage/sdmmc_console/README.md +++ b/tools/test_apps/storage/sdmmc_console/README.md @@ -92,7 +92,7 @@ As most other IDF console applications, the app supports line editing, commands ### Running test cases -When running the tests, keep in mind that once an SD card has been initialized in SPI mode, it cannot be re-initalized in SD mode without first powering it off. This means that on boards without an SD card power control circuit, it is not possible to run all the tests in one go with `test *` command. Run SDMMC tests first, then SDSPI tests: `test [sdmmc]` and then `test [sdspi]`. If you need to run SDMMC test again, power cycle the card first. +When running the tests, keep in mind that once an SD card has been initialized in SPI mode, it cannot be re-initialized in SD mode without first powering it off. This means that on boards without an SD card power control circuit, it is not possible to run all the tests in one go with `test *` command. Run SDMMC tests first, then SDSPI tests: `test [sdmmc]` and then `test [sdspi]`. If you need to run SDMMC test again, power cycle the card first. On chips without an SDMMC host controller only SDSPI tests are compiled. In this case, `test *` can be used to run all tests.