ESP32-C3 Rust 学习笔记

说明

本页重点记录 esp-idf-sys 在 ESP32-C3 上的 native 构建流程与中间产物分析.
适合在排查 esp-idf, bindgen, sdkconfig 与 build.rs 之间关系时做深入参考.
esp-idf-sys native方式编译分析

1. native编译

    1> 自动下载 esp-idf cmake ninja riscv-esp工具链

    2> 使用 cmake 编译 esp-idf， 配置文件是： sdkconfig 和 sdkconfig_defaults

        把 esp-idf-sys 中的 resources/cmake_project 作为一个基本的项目,
        (参考下： https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32/api-guides/build-system.html#cmake-esp-idf)
        复制到你的项目编译输出路径下:
            target/riscv32imc-esp-espidf/debug/build/esp-idf-sys-eac6c6bb186a6e4d/out
                .
                ├── build
                ├── CMakeLists.txt
                └── main.c

            sdkconfig 和 sdkconfig_defaults 是 从环境变量 ESP_IDF_SDKCONFIG 和 ESP_IDF_SDKCONFIG_DEFAULTS 中取到的
            这个项目就是一个 ESP-IDF hello world 的cmake项目
            编译从 ESP_IDF_SDKCONFIG 和 ESP_IDF_SDKCONFIG_DEFAULTS 中定义的组件， 并生成一个 libespidf.elf 可执行文件，这个文件可能只是为了生成依赖的库，没有其它作用
            生成的 库 会以 println!("cargo: ... ") 的形式输出？

        主要过程是：
          cmake::Config::new(&out_dir)
            .generator("Ninja")
            .out_dir(&out_dir)
            .no_build_target(true)
            .define("CMAKE_TOOLCHAIN_FILE", &cmake_toolchain_file)
            .always_configure(true)
            .pic(false)
            .asmflag(asm_flags)
            .cflag(c_flags)
            .cxxflag(cxx_flags)
            .env("IDF_PATH", &idf.esp_idf.worktree())
            .env("PATH", &idf.exported_path)
            .env("SDKCONFIG", sdkconfig)
            .env("SDKCONFIG_DEFAULTS", sdkconfig_defaults)
            .env("IDF_TARGET", &chip.to_string())
            .build();

        为了编译自定义组件， 应该需要考虑配置 sdkconfig_defaults 文件

    3>. 解析 cmake 的输出结果, 如: link_args sdkconfig_json, 把解析的结果返回 -- EspIdfBuildOutput

2. 生成rs代码

    一个bindgen需要的头文件 header_file:
        src/include/esp-idf/bindings.h

    执行下面 build code, 返回值是 bindings_file:
        bindgen::run(
            build_output
                .bindgen
                .builder()?
                .ctypes_prefix("c_types")
                .header(header_file.try_to_str()?)
                .blacklist_function("strtold")
                .blacklist_function("_strtold_r")
                .clang_args(build_output.components.clang_args())
                .clang_args(vec![
                    "-target",
                    if mcu == "esp32c3" {
                        // Necessary to pass explicitly, because of https://github.com/rust-lang/rust-bindgen/issues/1555
                        "riscv32"
                    } else {
                        // We don't really have a similar issue with Xtensa, but we pass it explicitly as well just in case
                        "xtensa"
                    },
                ]),
        )?;

    bindings_file 这里是: target/riscv32imc-esp-espidf/debug/build/esp-idf-sys-e842de6eba130a3d/out/bindings.rs
    这是 头文件中声明的 rust绑定. 同时, 这中间使用的各种 args 也会以 println!("cargo: ... "): 的形式输出

3. 在 esp-idf-sys 中刚好有 src/lib.rs:
    
    include!(env!("EMBUILD_GENERATED_BINDINGS_FILE"));

4. esp-idf-sys 的 src代码

    src/start.rs 定义了我们项目的入口, 及rust运行的基础, 我们的项目中 main 函数会在 src/start.rs 中被引用

上面几个过程就有了 esp32 的 c bind 的 crate 了.

上面的整个过程 就是: 
    编译esp-idf源码, 根据配置生成 各种.a
    生成 rust绑定
    编译 rust code
Keyboard shortcuts

学习笔记

ESP32-C3 Rust 学习笔记

说明

esp-idf-sys native方式编译 分析

esp-idf-sys native方式编译分析
