Merge branch 'feature/esp_board_manager' into 'main'

feat(esp_board_manager): Add esp_board_manager component

See merge request adf/multimedia/esp-gmf!122

Author: jason-mao

.github/workflows/upload_component.yml

@@ -24,6 +24,7 @@ jobs:
             esp_audio_simple_player:./packages/esp_audio_simple_player
             esp_capture: ./packages/esp_capture
             gmf_app_utils: ./packages/gmf_app_utils
+            esp_board_manager: ./packages/esp_board_manager
             gmf_examples: ./gmf_examples
           namespace: "espressif"
           api_token: ${{ secrets.IDF_COMPONENT_API_TOKEN }}

.gitignore

@@ -28,6 +28,7 @@ GPATH
 **/managed_components
 **/dependencies.lock
 **/dist
+**/gen_bmgr_codes/
 
 # Doc build artifacts
 gmf_core/docs/*/_build/

.gitlab/ci/.build_test_rules.yml

@@ -8,5 +8,12 @@
   disable:
     - if: TARGET_DIR_TYPE == "example"
 
+.disable_test_apps_esp32: &disable_test_apps_esp32
+  disable:
+    - if: TARGET_DIR_TYPE == "test_apps" AND IDF_TARGET == "esp32"
+
 gmf_core/test_apps:
   <<: *disable_example
+
+packages/esp_board_manager:
+  <<: *disable_test_apps_esp32

README.md

@@ -44,6 +44,7 @@ Advanced components are encapsulation modules in ESP-GMF that target specific ap
 | [gmf_loader](./packages/gmf_loader) | Set up the given GMF pool using the <br> configuration selected via `Kconfig` | - `gmf_core`<br>- `gmf_io`<br>- `gmf_audio`<br>- `gmf_misc`<br>- `gmf_video`<br>- `gmf_ai_audio`<br>- `esp_codec_dev`<br>- `esp_audio_codec`<br>- `esp_video_codec` |
 | [gmf_app_utils](./packages/gmf_app_utils) | Common peripheral configuration, unit <br>testing tools Memory leak detection tools | - `gmf_core`<br>- `protocol_examples_common`<br>- `codec_board`|
 | [esp_capture](./packages/esp_capture) | High-level multimedia capture module | - `gmf_core`<br>- `gmf-audio`<br>- `gmf-video`<br>- `esp_muxer`<br>- `esp_codec_dev`<br>- `esp-sr`<br>- `esp_video`<br>- `esp32-camera`|
+| [esp_board_manager](./packages/esp_board_manager) | Intelligent, automated board configuration and management utilities with YAML-based setup | Dependencies vary based on selected board |
 
 
 # ESP-GMF Usage Guide

README_CN.md

@@ -44,6 +44,7 @@ ESP-GMF 各个模块以组件的形式存在，组件又按功能分为**原子
 |  [gmf_loader](./packages/gmf_loader) | 使用 `Kconfig` 选择的配置<br>设置给定的 GMF Pool | - `gmf_core`<br>- `gmf_io`<br>- `gmf_audio`<br>- `gmf_misc`<br>- `gmf_video`<br>- `gmf_ai_audio`<br>- `esp_codec_dev`<br>- `esp_audio_codec`<br>- `esp_video_codec` |
 |  [gmf_app_utils](./packages/gmf_app_utils) | 常用外设配置，单元测试工具<br>内存泄漏检测工具 | - `gmf_core`<br>- `protocol_examples_common`<br>- `codec_board` |
 |  [esp_capture](./packages/esp_capture) | 易用的音视频采集器 | - `gmf_core`<br>- `gmf-audio`<br>- `gmf-video`<br>- `esp_muxer`<br>- `esp_codec_dev`<br>- `esp-sr`<br>- `esp_video`<br>- `esp32-camera`|
+|  [esp_board_manager](./packages/esp_board_manager) | 智能、自动化的板子配置和管理工具，支持基于 YAML 的设置 | 根据选择的板子变化依赖 |
 
 # ESP-GMF 使用说明
 
@@ -53,4 +54,4 @@ GMF-Core API 的简单示例代码请参考 [test_apps](./gmf_core/test_apps/mai
 
 - **ESP-GMF 和 ESP-ADF 有什么区别？**
 
-  ESP-ADF 是一个包含很多模块的功能性仓库，比如 `audio_pipeline`、`services`、`peripherals` 和 `audio boards` 等，它常应用与比较复杂的项目中。ESP-GMF 是将 `audio_pipeline` 独立出来并进行功能扩展，使其支持音频、视频、图像等流式数据的应用场景。ESP-GMF 按功能分为不同的组件，灵活性优于 ESP-ADF 的 `audio_pipeline`，例如用于简单流式数据的处理，从 SD 卡/flash 播放一个音频，以及多个组件结合使用提供较复杂的功能模块（如音频播放器 `esp_audio_simple_player `）。ESP-ADF 的后期版本会使用 ESP-GMF 替代 `audio_pipeline` 模块。
+  ESP-ADF 是一个包含很多模块的功能性仓库，比如 `audio_pipeline`、`services`、`peripherals` 和 `audio boards` 等，它常应用于比较复杂的项目中。ESP-GMF 是将 `audio_pipeline` 独立出来并进行功能扩展，使其支持音频、视频、图像等流式数据的应用场景。ESP-GMF 按功能分为不同的组件，灵活性优于 ESP-ADF 的 `audio_pipeline`，例如用于简单流式数据的处理，从 SD 卡/flash 播放一个音频，以及多个组件结合使用提供较复杂的功能模块（如音频播放器 `esp_audio_simple_player `）。ESP-ADF 的后期版本会使用 ESP-GMF 替代 `audio_pipeline` 模块。

packages/esp_board_manager/CHANGELOG.md

@@ -0,0 +1,47 @@
+# Changelog
+
+## v0.3.0 (Initial Release)
+
+### Core Features
+- **ESP Board Manager**: Initial release of comprehensive board configuration management system
+- **YAML-based Configuration**: Support for `board_peripherals.yaml` and `board_devices.yaml` configuration files
+- **Automatic Code Generation**: Modular code generation system with 8-step streamlined process
+- **Multi-path Board Scanning**: Support for Default, Customer, and Components board paths
+- **Automatic Dependency Management**: Smart component dependency detection and `idf_component.yml` updates
+- **SDK Configuration Automation**: Automatic ESP-IDF feature enabling based on board requirements
+
+### Supported Boards
+- **Echoear Core Board V1.0**: Full audio, LCD, touch, and SD card support
+- **ESP-BOX-3**: ESP32-S3 development board with I2C, I2S, SPI, LEDC, and GPIO support
+- **Dual Eyes Board V1.0**: Dual LCD display with touch support
+- **ESP32-S3 Korvo2 V3**: Full audio and SD card support
+- **ESP32-S3 Korvo2L**: Full audio and SD card support
+- **ESP32 Lyrat Mini V1.1**: YAML configurations support
+- **ESP32-C5 Spot**: YAML configurations support
+
+### Peripheral Support
+- **I2C**: Full support with type safety
+- **I2S**: Complete audio interface support
+- **SPI**: Full peripheral and device support
+- **LEDC**: PWM and LED control support
+- **GPIO**: GPIO support
+
+### Device Support
+- **Audio Codecs**: ES8311, ES7210, and other audio codec devices
+- **SD Cards**: FATFS filesystem support
+- **LCD Displays**: SPI LCD with LVGL integration
+- **Touch Input**: I2C touch controller support
+- **SPIFFS Filesystem**: Embedded filesystem support
+- **LEDC Control**: LED brightness and PWM control
+- **GPIO Control**: GPIO output control
+
+### APP Interfaces
+- **Board Manager API**: `esp_board_manager_init()`, `esp_board_manager_deinit()`, `esp_board_manager_print()`
+- **Peripheral API**: `esp_board_manager_get_periph_config()`, `esp_board_manager_get_periph_handle()`
+- **Device API**: `esp_board_manager_get_device_config()`, `esp_board_manager_get_device_handle()`
+- **Error Handling**: Comprehensive error codes and macros (`ESP_BOARD_RETURN_ON_ERROR`)
+
+### Documentation & Testing
+- **Comprehensive Documentation**: README, API documentation, and configuration guides
+- **Test Applications**: Complete test suite for all peripherals and devices
+- **Configuration Rules**: Detailed YAML configuration rules and best practices

packages/esp_board_manager/CMakeLists.txt

@@ -0,0 +1,35 @@
+# Include peripheral and device sources functions
+include(${CMAKE_CURRENT_LIST_DIR}/peripherals/CMakeLists.txt)
+include(${CMAKE_CURRENT_LIST_DIR}/devices/CMakeLists.txt)
+
+# Get peripheral sources
+get_peripheral_sources(PERIPH_SRCS PERIPH_INCLUDES)
+
+# Get device sources
+get_device_sources(DEVICE_SRCS DEVICE_INCLUDES)
+
+set(BOARD_SETUP_SRCS
+)
+
+idf_component_register(
+    SRCS
+        "src/esp_board_manager.c"
+        "src/esp_board_periph.c"
+        "src/esp_board_device.c"
+        "src/esp_board_manager_err.c"
+        ${PERIPH_SRCS}  # Add peripheral sources
+        ${DEVICE_SRCS}  # Add device sources
+        ${BOARD_SETUP_SRCS}  # Add board-specific sources
+    INCLUDE_DIRS
+        "."
+        "include"
+        ${PERIPH_INCLUDES}  # Add peripheral includes
+        ${DEVICE_INCLUDES}  # Add device includes
+    REQUIRES
+        driver
+        esp_common
+        fatfs
+        esp_lcd
+        spiffs
+    LDFRAGMENTS
+)

packages/esp_board_manager/Kconfig.projbuild

@@ -0,0 +1,15 @@
+menu "ESP Board Manager Configuration"
+
+    menu "Board Manager Setting"
+        config ESP_BOARD_MANAGER_AUTO_CONFIG_DEVICE_AND_PERIPHERAL
+            bool "Enable automatic configure device and peripheral in sdkconfig"
+            default y
+            help
+                When enabled, the board manager will automatically configure corresponding
+                device and peripheral types in user's sdkconfig based on detected
+                device and peripheral information from YAML configuration files.
+    endmenu
+
+    orsource "./gen_codes/Kconfig.in"
+
+endmenu

packages/esp_board_manager/LICENSE

@@ -0,0 +1,22 @@
+Espressif Modified MIT License
+
+ Copyright (c) 2025 Espressif Systems (Shanghai) CO., LTD
+
+ Permission is hereby granted for use EXCLUSIVELY with Espressif Systems products.
+ This includes the right to use, copy, modify, merge, publish, distribute, and sublicense
+ the Software, subject to the following conditions:
+
+ 1. This Software MUST BE USED IN CONJUNCTION WITH ESPRESSIF SYSTEMS PRODUCTS.
+ 2. The above copyright notice and this permission notice shall be included in all copies
+    or substantial portions of the Software.
+ 3. Redistribution of the Software in source or binary form FOR USE WITH NON-ESPRESSIF PRODUCTS
+    is strictly prohibited.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ DEALINGS IN THE SOFTWARE.
+
+ SPDX-License-Identifier: LicenseRef-Espressif-Modified-MIT