From 07437880b10600c29d03ffbeed67503963ed7288 Mon Sep 17 00:00:00 2001 From: Tomas Rezucha Date: Mon, 29 Jan 2024 11:00:00 +0100 Subject: [PATCH 1/2] fix: Various typos Closes https://github.com/espressif/esp-bsp/issues/283 --- .../ws_7inch/include/bsp/ws_7inch.h | 9 ++----- bsp/esp-box-3/include/bsp/esp-box-3.h | 14 +++++------ bsp/esp-box-lite/include/bsp/esp-box-lite.h | 25 +++++++++---------- bsp/esp-box/include/bsp/esp-box.h | 8 +++--- .../include/bsp/esp32_azure_iot_kit.h | 4 +-- .../include/bsp/esp32_c3_lcdkit.h | 4 +-- bsp/esp32_lyrat/include/bsp/esp32_lyrat.h | 8 +++--- bsp/esp32_s3_eye/include/bsp/esp32_s3_eye.h | 10 ++++---- .../include/bsp/esp32_s3_korvo_2.h | 8 +++--- .../include/bsp/esp32_s3_lcd_ev_board.h | 22 ++++++---------- .../include/bsp/esp32_s3_usb_otg.h | 4 +-- .../include/bsp/esp_bsp_generic.h | 4 +-- .../include/bsp/esp_wrover_kit.h | 4 +-- components/es8311/include/es8311.h | 3 ++- .../esp_lvgl_port/include/esp_lvgl_port.h | 14 +++++------ .../esp_lcd_touch/include/esp_lcd_touch.h | 8 +++--- 16 files changed, 69 insertions(+), 80 deletions(-) diff --git a/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/include/bsp/ws_7inch.h b/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/include/bsp/ws_7inch.h index d02f6801..4bf2fb5e 100644 --- a/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/include/bsp/ws_7inch.h +++ b/SquareLine/boards/custom_waveshare_7inch/components/ws_7inch/include/bsp/ws_7inch.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: CC0-1.0 */ @@ -55,11 +55,6 @@ extern "C" { * * There are multiple devices connected to I2C peripheral:) * - LCD Touch controller - * - * After initialization of I2C, use BSP_I2C_NUM macro when creating I2C devices drivers ie.: - * \code{.c} - * es8311_handle_t es8311_dev = es8311_create(BSP_I2C_NUM, ES8311_ADDRRES_0); - * \endcode **************************************************************************************************/ #define BSP_I2C_NUM 1 #define BSP_I2C_CLK_SPEED_HZ 400000 @@ -99,7 +94,7 @@ esp_err_t bsp_i2c_deinit(void); * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); diff --git a/bsp/esp-box-3/include/bsp/esp-box-3.h b/bsp/esp-box-3/include/bsp/esp-box-3.h index 26847f88..ea1abe76 100644 --- a/bsp/esp-box-3/include/bsp/esp-box-3.h +++ b/bsp/esp-box-3/include/bsp/esp-box-3.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -184,21 +184,21 @@ esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config); * @brief Get codec I2S interface (initialized in bsp_audio_init) * * @return - * - Pointer to codec I2S interface handle or NULL when error occured + * - Pointer to codec I2S interface handle or NULL when error occurred */ const audio_codec_data_if_t *bsp_audio_get_codec_itf(void); /** * @brief Initialize speaker codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_speaker_init(void); /** * @brief Initialize microphone codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_microphone_init(void); @@ -215,7 +215,7 @@ esp_codec_dev_handle_t bsp_audio_codec_microphone_init(void); * * After initialization of I2C, use BSP_I2C_NUM macro when creating I2C devices drivers ie.: * \code{.c} - * es8311_handle_t es8311_dev = es8311_create(BSP_I2C_NUM, ES8311_ADDRRES_0); + * icm42670_handle_t imu = icm42670_create(BSP_I2C_NUM, ICM42670_I2C_ADDRESS); * \endcode **************************************************************************************************/ #define BSP_I2C_NUM CONFIG_BSP_I2C_NUM @@ -344,7 +344,7 @@ esp_err_t bsp_sdcard_unmount(void); * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -356,7 +356,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); diff --git a/bsp/esp-box-lite/include/bsp/esp-box-lite.h b/bsp/esp-box-lite/include/bsp/esp-box-lite.h index ea96815c..3538f208 100644 --- a/bsp/esp-box-lite/include/bsp/esp-box-lite.h +++ b/bsp/esp-box-lite/include/bsp/esp-box-lite.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -171,21 +171,21 @@ esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config); * @brief Get codec I2S interface (initialized in bsp_audio_init) * * @return - * - Pointer to codec I2S interface handle or NULL when error occured + * - Pointer to codec I2S interface handle or NULL when error occurred */ const audio_codec_data_if_t *bsp_audio_get_codec_itf(void); /** * @brief Initialize speaker codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_speaker_init(void); /** * @brief Initialize microphone codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_microphone_init(void); @@ -194,15 +194,14 @@ esp_codec_dev_handle_t bsp_audio_codec_microphone_init(void); * I2C interface * * There are multiple devices connected to I2C peripheral: - * - Codec ES8311 (configuration only) - * - ADC ES7210 (configuration only) - * - Encryption chip ATECC608A (NOT populated on most boards) + * - Codec ES8156 (configuration only) + * - ADC ES7243E (configuration only) * - LCD Touch controller - * - Inertial Measurement Unit ICM-42607-P + * - Inertial Measurement Unit ICM-42607-P (NOT populated on most boards) * * After initialization of I2C, use BSP_I2C_NUM macro when creating I2C devices drivers ie.: * \code{.c} - * es8311_handle_t es8311_dev = es8311_create(BSP_I2C_NUM, ES8311_ADDRRES_0); + * icm42670_handle_t imu = icm42670_create(BSP_I2C_NUM, ICM42670_I2C_ADDRESS); * \endcode **************************************************************************************************/ #define BSP_I2C_NUM CONFIG_BSP_I2C_NUM @@ -290,7 +289,7 @@ esp_err_t bsp_spiffs_unmount(void); * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -302,7 +301,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); @@ -333,7 +332,7 @@ void bsp_display_unlock(void); /** * @brief Set display's brightness * - * Brightness is controlled with PWM signal to a pin controling backlight. + * Brightness is controlled with PWM signal to a pin controlling backlight. * * @param[in] brightness_percent Brightness in [%] * @return @@ -421,7 +420,7 @@ adc_oneshot_unit_handle_t bsp_adc_get_handle(void); * @return * - ESP_OK All buttons initialized * - ESP_ERR_INVALID_ARG btn_array is too small or NULL - * - ESP_FAIL Underlaying iot_button_create failed + * - ESP_FAIL Underlying iot_button_create failed */ esp_err_t bsp_iot_button_create(button_handle_t btn_array[], int *btn_cnt, int btn_array_size); diff --git a/bsp/esp-box/include/bsp/esp-box.h b/bsp/esp-box/include/bsp/esp-box.h index bf17d001..94b04c69 100644 --- a/bsp/esp-box/include/bsp/esp-box.h +++ b/bsp/esp-box/include/bsp/esp-box.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -172,7 +172,7 @@ esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config); * @brief Get codec I2S interface (initialized in bsp_audio_init) * * @return - * - Pointer to codec I2S interface handle or NULL when error occured + * - Pointer to codec I2S interface handle or NULL when error occurred */ const audio_codec_data_if_t *bsp_audio_get_codec_itf(void); @@ -286,7 +286,7 @@ esp_err_t bsp_spiffs_unmount(void); * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -298,7 +298,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); diff --git a/bsp/esp32_azure_iot_kit/include/bsp/esp32_azure_iot_kit.h b/bsp/esp32_azure_iot_kit/include/bsp/esp32_azure_iot_kit.h index 5c762d19..078019f1 100644 --- a/bsp/esp32_azure_iot_kit/include/bsp/esp32_azure_iot_kit.h +++ b/bsp/esp32_azure_iot_kit/include/bsp/esp32_azure_iot_kit.h @@ -199,7 +199,7 @@ esp_err_t bsp_sdcard_unmount(void); * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -211,7 +211,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); diff --git a/bsp/esp32_c3_lcdkit/include/bsp/esp32_c3_lcdkit.h b/bsp/esp32_c3_lcdkit/include/bsp/esp32_c3_lcdkit.h index 81757d8b..391968d0 100644 --- a/bsp/esp32_c3_lcdkit/include/bsp/esp32_c3_lcdkit.h +++ b/bsp/esp32_c3_lcdkit/include/bsp/esp32_c3_lcdkit.h @@ -77,7 +77,7 @@ extern "C" { * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -215,7 +215,7 @@ esp_err_t bsp_audio_init(const i2s_pdm_tx_config_t *i2s_config, i2s_chan_handle_ /** * @brief Initialize speaker codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_speaker_init(void); /************************************************************************************************** diff --git a/bsp/esp32_lyrat/include/bsp/esp32_lyrat.h b/bsp/esp32_lyrat/include/bsp/esp32_lyrat.h index e33dd013..89bec691 100644 --- a/bsp/esp32_lyrat/include/bsp/esp32_lyrat.h +++ b/bsp/esp32_lyrat/include/bsp/esp32_lyrat.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -143,21 +143,21 @@ esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config); * @brief Get codec I2S interface (initialized in bsp_audio_init) * * @return - * - Pointer to codec I2S interface handle or NULL when error occured + * - Pointer to codec I2S interface handle or NULL when error occurred */ const audio_codec_data_if_t *bsp_audio_get_codec_itf(void); /** * @brief Initialize speaker codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_speaker_init(void); /** * @brief Initialize microphone codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_microphone_init(void); diff --git a/bsp/esp32_s3_eye/include/bsp/esp32_s3_eye.h b/bsp/esp32_s3_eye/include/bsp/esp32_s3_eye.h index 04504603..5bed5a0e 100644 --- a/bsp/esp32_s3_eye/include/bsp/esp32_s3_eye.h +++ b/bsp/esp32_s3_eye/include/bsp/esp32_s3_eye.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -300,7 +300,7 @@ esp_err_t bsp_sdcard_unmount(void); * * This function initializes SPI, display controller and starts LVGL handling task. * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -312,7 +312,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); @@ -455,14 +455,14 @@ esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config); * @brief Get codec I2S interface (initialized in bsp_audio_init) * * @return - * - Pointer to codec I2S interface handle or NULL when error occured + * - Pointer to codec I2S interface handle or NULL when error occurred */ const audio_codec_data_if_t *bsp_audio_get_codec_itf(void); /** * @brief Initialize microphone codec device * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_microphone_init(void); diff --git a/bsp/esp32_s3_korvo_2/include/bsp/esp32_s3_korvo_2.h b/bsp/esp32_s3_korvo_2/include/bsp/esp32_s3_korvo_2.h index 4d6336e5..8e41e7a4 100644 --- a/bsp/esp32_s3_korvo_2/include/bsp/esp32_s3_korvo_2.h +++ b/bsp/esp32_s3_korvo_2/include/bsp/esp32_s3_korvo_2.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -203,7 +203,7 @@ esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config); * @brief Get codec I2S interface (initialized in bsp_audio_init) * * @return - * - Pointer to codec I2S interface handle or NULL when error occured + * - Pointer to codec I2S interface handle or NULL when error occurred */ const audio_codec_data_if_t *bsp_audio_get_codec_itf(void); @@ -436,7 +436,7 @@ esp_err_t bsp_sdcard_unmount(void); * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -448,7 +448,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); diff --git a/bsp/esp32_s3_lcd_ev_board/include/bsp/esp32_s3_lcd_ev_board.h b/bsp/esp32_s3_lcd_ev_board/include/bsp/esp32_s3_lcd_ev_board.h index 7bd5b8ba..897c44f3 100644 --- a/bsp/esp32_s3_lcd_ev_board/include/bsp/esp32_s3_lcd_ev_board.h +++ b/bsp/esp32_s3_lcd_ev_board/include/bsp/esp32_s3_lcd_ev_board.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -108,12 +108,6 @@ typedef struct { * - ADC ES7210 (configuration only) * - LCD Touch controller * - IO expander chip TCA9554 - * - * After initialization of I2C, use `BSP_I2C_NUM` macro when creating I2C devices drivers ie.: - * \code{.c} - * es8311_handle_t es8311_dev = es8311_create(BSP_I2C_NUM, ES8311_ADDRRES_0); - * \endcode - * **************************************************************************************************/ #define BSP_I2C_NUM (CONFIG_BSP_I2C_NUM) @@ -190,7 +184,7 @@ esp_err_t bsp_spiffs_unmount(void); * @note This function will be called in `bsp_display_start()` when using LCD sub-board 2 with the resolution of 480x480. * @note This function will be called in `bsp_audio_init()`. * - * @return Pointer to device handle or NULL when error occured + * @return Pointer to device handle or NULL when error occurred */ esp_io_expander_handle_t bsp_io_expander_init(void); @@ -237,7 +231,7 @@ esp_err_t bsp_audio_init(const i2s_std_config_t *i2s_config); * * @note This function will call `bsp_audio_init()` if it has not been called already. * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_speaker_init(void); @@ -246,7 +240,7 @@ esp_codec_dev_handle_t bsp_audio_codec_speaker_init(void); * * @note This function will call `bsp_audio_init()` if it has not been called already. * - * @return Pointer to codec device handle or NULL when error occured + * @return Pointer to codec device handle or NULL when error occurred */ esp_codec_dev_handle_t bsp_audio_codec_microphone_init(void); @@ -328,7 +322,7 @@ esp_err_t bsp_audio_poweramp_enable(bool enable); * @note This function initializes display controller and starts LVGL handling task. * @note Users can get LCD panel handle from `user_data` in returned display. * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -340,7 +334,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); @@ -416,7 +410,7 @@ void bsp_display_rotate(lv_disp_t *disp, lv_disp_rot_t rotation); * * @note This function should be called after calling `bsp_display_new()` or `bsp_display_start()` * - * @return Horizontal resolution. Return 0 if error occured. + * @return Horizontal resolution. Return 0 if error occurred. */ uint16_t bsp_display_get_h_res(void); @@ -425,7 +419,7 @@ uint16_t bsp_display_get_h_res(void); * * @note This function should be called after calling `bsp_display_new()` or `bsp_display_start()` * - * @return Vertical resolution. Return 0 if error occured. + * @return Vertical resolution. Return 0 if error occurred. */ uint16_t bsp_display_get_v_res(void); diff --git a/bsp/esp32_s3_usb_otg/include/bsp/esp32_s3_usb_otg.h b/bsp/esp32_s3_usb_otg/include/bsp/esp32_s3_usb_otg.h index e343cdfe..e0fde52b 100644 --- a/bsp/esp32_s3_usb_otg/include/bsp/esp32_s3_usb_otg.h +++ b/bsp/esp32_s3_usb_otg/include/bsp/esp32_s3_usb_otg.h @@ -206,7 +206,7 @@ esp_err_t bsp_spiffs_unmount(void); * * This function initializes SPI, display controller and starts LVGL handling task. * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -218,7 +218,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); diff --git a/bsp/esp_bsp_generic/include/bsp/esp_bsp_generic.h b/bsp/esp_bsp_generic/include/bsp/esp_bsp_generic.h index d2930368..08ceb7bd 100644 --- a/bsp/esp_bsp_generic/include/bsp/esp_bsp_generic.h +++ b/bsp/esp_bsp_generic/include/bsp/esp_bsp_generic.h @@ -278,7 +278,7 @@ esp_err_t bsp_sdcard_unmount(void); * This function initializes SPI, display controller and starts LVGL handling task. * LCD backlight must be enabled separately by calling bsp_display_brightness_set() * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -290,7 +290,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); diff --git a/bsp/esp_wrover_kit/include/bsp/esp_wrover_kit.h b/bsp/esp_wrover_kit/include/bsp/esp_wrover_kit.h index f48f5f52..e449efc7 100644 --- a/bsp/esp_wrover_kit/include/bsp/esp_wrover_kit.h +++ b/bsp/esp_wrover_kit/include/bsp/esp_wrover_kit.h @@ -247,7 +247,7 @@ esp_err_t bsp_iot_button_create(button_handle_t btn_array[], int *btn_cnt, int b * * This function initializes SPI, display controller and starts LVGL handling task. * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start(void); @@ -259,7 +259,7 @@ lv_disp_t *bsp_display_start(void); * * @param cfg display configuration * - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *bsp_display_start_with_config(const bsp_display_cfg_t *cfg); diff --git a/components/es8311/include/es8311.h b/components/es8311/include/es8311.h index 68118bd1..f6668437 100644 --- a/components/es8311/include/es8311.h +++ b/components/es8311/include/es8311.h @@ -17,7 +17,8 @@ #include "driver/i2c.h" /* ES8311 address: CE pin low - 0x18, CE pin high - 0x19 */ -#define ES8311_ADDRRES_0 0x18u +#define ES8311_ADDRRES_0 0x18u // Leaving this here for backward compatibility +#define ES8311_ADDRESS_0 0x18u #define ES8311_ADDRESS_1 0x19u #ifdef __cplusplus diff --git a/components/esp_lvgl_port/include/esp_lvgl_port.h b/components/esp_lvgl_port/include/esp_lvgl_port.h index bf22b102..f19b2d72 100644 --- a/components/esp_lvgl_port/include/esp_lvgl_port.h +++ b/components/esp_lvgl_port/include/esp_lvgl_port.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -175,7 +175,7 @@ esp_err_t lvgl_port_deinit(void); * @note Allocated memory in this function is not free in deinit. You must call lvgl_port_remove_disp for free all memory! * * @param disp_cfg Display configuration structure - * @return Pointer to LVGL display or NULL when error occured + * @return Pointer to LVGL display or NULL when error occurred */ lv_disp_t *lvgl_port_add_disp(const lvgl_port_display_cfg_t *disp_cfg); @@ -196,7 +196,7 @@ esp_err_t lvgl_port_remove_disp(lv_disp_t *disp); * @note Allocated memory in this function is not free in deinit. You must call lvgl_port_remove_touch for free all memory! * * @param touch_cfg Touch configuration structure - * @return Pointer to LVGL touch input device or NULL when error occured + * @return Pointer to LVGL touch input device or NULL when error occurred */ lv_indev_t *lvgl_port_add_touch(const lvgl_port_touch_cfg_t *touch_cfg); @@ -218,7 +218,7 @@ esp_err_t lvgl_port_remove_touch(lv_indev_t *touch); * @note Allocated memory in this function is not free in deinit. You must call lvgl_port_remove_encoder for free all memory! * * @param encoder_cfg Encoder configuration structure - * @return Pointer to LVGL encoder input device or NULL when error occured + * @return Pointer to LVGL encoder input device or NULL when error occurred */ lv_indev_t *lvgl_port_add_encoder(const lvgl_port_encoder_cfg_t *encoder_cfg); @@ -240,7 +240,7 @@ esp_err_t lvgl_port_remove_encoder(lv_indev_t *encoder); * @note Allocated memory in this function is not free in deinit. You must call lvgl_port_remove_navigation_buttons for free all memory! * * @param buttons_cfg Buttons configuration structure - * @return Pointer to LVGL buttons input device or NULL when error occured + * @return Pointer to LVGL buttons input device or NULL when error occurred */ lv_indev_t *lvgl_port_add_navigation_buttons(const lvgl_port_nav_btns_cfg_t *buttons_cfg); @@ -262,7 +262,7 @@ esp_err_t lvgl_port_remove_navigation_buttons(lv_indev_t *buttons); * @note The USB host must be initialized before. Use `usb_host_install` for host initialization. * * @param mouse_cfg mouse configuration structure - * @return Pointer to LVGL buttons input device or NULL when error occured + * @return Pointer to LVGL buttons input device or NULL when error occurred */ lv_indev_t *lvgl_port_add_usb_hid_mouse_input(const lvgl_port_hid_mouse_cfg_t *mouse_cfg); @@ -272,7 +272,7 @@ lv_indev_t *lvgl_port_add_usb_hid_mouse_input(const lvgl_port_hid_mouse_cfg_t *m * @note The USB host must be initialized before. Use `usb_host_install` for host initialization. * * @param keyboard_cfg keyboard configuration structure - * @return Pointer to LVGL buttons input device or NULL when error occured + * @return Pointer to LVGL buttons input device or NULL when error occurred */ lv_indev_t *lvgl_port_add_usb_hid_keyboard_input(const lvgl_port_hid_keyboard_cfg_t *keyboard_cfg); diff --git a/components/lcd_touch/esp_lcd_touch/include/esp_lcd_touch.h b/components/lcd_touch/esp_lcd_touch/include/esp_lcd_touch.h index edeac90e..db39f1f0 100644 --- a/components/lcd_touch/esp_lcd_touch/include/esp_lcd_touch.h +++ b/components/lcd_touch/esp_lcd_touch/include/esp_lcd_touch.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -60,7 +60,7 @@ typedef struct { /*!< User callback called after get coordinates from touch controller for apply user adjusting */ void (*process_coordinates)(esp_lcd_touch_handle_t tp, uint16_t *x, uint16_t *y, uint16_t *strength, uint8_t *point_num, uint8_t max_point_num); - /*!< User callback called after the touch interrupt occured */ + /*!< User callback called after the touch interrupt occurred */ esp_lcd_touch_interrupt_callback_t interrupt_callback; /*!< User data passed to callback */ void *user_data; @@ -378,7 +378,7 @@ esp_err_t esp_lcd_touch_get_mirror_y(esp_lcd_touch_handle_t tp, bool *mirror); esp_err_t esp_lcd_touch_del(esp_lcd_touch_handle_t tp); /** - * @brief Register user callback called after the touch interrupt occured + * @brief Register user callback called after the touch interrupt occurred * * @param tp: Touch handler * @param callback: Interrupt callback @@ -389,7 +389,7 @@ esp_err_t esp_lcd_touch_del(esp_lcd_touch_handle_t tp); esp_err_t esp_lcd_touch_register_interrupt_callback(esp_lcd_touch_handle_t tp, esp_lcd_touch_interrupt_callback_t callback); /** - * @brief Register user callback called after the touch interrupt occured with user data + * @brief Register user callback called after the touch interrupt occurred with user data * * @param tp: Touch handler * @param callback: Interrupt callback From b637e64b8f07a502036759ed26862af920a3e835 Mon Sep 17 00:00:00 2001 From: Tomas Rezucha Date: Mon, 29 Jan 2024 11:04:32 +0100 Subject: [PATCH 2/2] feat: Deprecate ES7210 and ES8311 drivers Drivers for these codecs are now in esp_codec_dev component --- components/es7210/README.md | 2 ++ components/es8311/README.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/components/es7210/README.md b/components/es7210/README.md index 1cafe1bc..4c7795d5 100644 --- a/components/es7210/README.md +++ b/components/es7210/README.md @@ -2,6 +2,8 @@ [![Component Registry](https://components.espressif.com/components/espressif/es7210/badge.svg)](https://components.espressif.com/components/espressif/es7210) +:warning: **This driver is deprecated. Please use codec drivers from [esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)** + ES7210 high performance four channels audio ADC features: * High performance multi-bit delta-sigma audio ADC * 102 dB signal to noise ratio diff --git a/components/es8311/README.md b/components/es8311/README.md index 5b806ecf..75b900ee 100644 --- a/components/es8311/README.md +++ b/components/es8311/README.md @@ -2,6 +2,8 @@ [![Component Registry](https://components.espressif.com/components/espressif/es8311/badge.svg)](https://components.espressif.com/components/espressif/es8311) +:warning: **This driver is deprecated. Please use codec drivers from [esp_codec_dev](https://components.espressif.com/components/espressif/esp_codec_dev)** + ES8311 low power mono audio codec features: * High performance and low power multi-bit delta-sigma audio ADC and DAC * I2S/PCM master or slave serial data port