Yumud

基于C++20的超轻量级高性能嵌入式开发框架充分释放个位级成本MCU的巨大潜能

随着科技与技术的不断进步，价格个位数的MCU和前沿的C++20冲击着现有的设施。在硬件上，价格超1元便已经是32位MCU的天下，很难找到一个死守8位的MCU的理由。在软件上，用C进行开发已经落伍了，它几乎没有任何安全或是抽象可言，而绝大多数开发者开发的都是面向特定业务直接对接SDK的不可复用的代码。现在是面向对象与函数式编程的时代，C89却被部分开发者奉为圭臬。硬件已经日新月异，可嵌入式的主流话语权却还在C89上，这不禁让人啼笑皆非———传统的面向过程与全局变量乱飞的思维显然已经不适用于编写出安全高效可复用性强的代码。但我们却不得不承认嵌入式环境确实难寻成熟可靠的嵌入式C++框架（请忘了Arduino,它是蒙了一层C++皮的C/Java）。基于这样的想法，我从大二(2023年末)开始打造一个完备的嵌入式框架，并借助它获得了不少国家级别的奖项，现在我将它开源于此。在今天，借助C++20的强大特性，我们可以轻松编写安全，高效复用性强的代码。让嵌入式开发从繁琐枯燥的外设配置变成了调度抽象语义的游戏，才能够使我们编写出更快更清爽更加与现代设计接轨的代码,不是吗。

很多人说C++不适合用在嵌入式上，更别说STL了。能得出这样的结论也受限于PC上编写代码的惯性，诸如iostream，异常等非零成本开销的设施会在一开始就占用数十上百KB的内存空间，因而他们一旦在嵌入式开发中尝试应用C++并不慎用到了这些设施就很容易得出这样错误的结论。我们需要做的，仅仅只是择取其中零成本抽象的C++子集。在长期与C++的接触中，我也总结了更适合嵌入式开发的C++子集，这是在编写本库的过程中得到大量实践验证的：

尽可能提高优化选项，将默认的O0提升到至少O2的标准，同时开启lto优化：默认的O0优化选项会占用大量内存空间，且为了保持函数的调用关系与代码一致，导致很多调用和计算无法内联或乱序执行，同时 lto优化能在最后在全局合并减少重复的代码，使用两者能极大减少二进制文件体积。也正因此，依赖使用Og进行程序追踪从来不是本库鼓励的开发方式，因为它让压缩数倍二进制空间的优化难以正常开展，正确的开发流应当是严谨推导自己的代码，或是利用本库提供的错误调试工具快速定位问题。
禁用异常与rtti：异常和rtti等特性是C++中被诟病已久的非零成本抽象特性，更不要说它上来就占用数十k二进制文件而不适合嵌入式开发的原罪。在本库中，异常被禁用，本库对异常安全不做任何处理。更合理的做法可以参考借鉴rust的Result，Option等工具，通过在结果中附加执行情况来为调用方提供错误信息。本框架中实现了rust的Result类，以帮助开发者进行更轻量现代化的错误处理。
手动重写newlib：很多嵌入式开发者在开发之初就早早地重写write函数，开启u_printf_float链接选项，殊不知这也是一项开销相当大的举动，newlib中提供的c风格设施一方面没有对MCU提供足够的轻量化设计，同时也很难被编译器内联与编译期求值。本框架自主实现的一系列字符串转换函数以及与之对应的流输出类，能够在可读性更好的同时大幅度减少printf等设施的占用。
多使用模板和内联：很多C开发者总是抱着课本上模板会增大二进制文件体积的教条去批判C++,而事实上模板很难造成可观的体积膨胀，恰恰相反，编译器在得到模板提供的类型信息后能够减少很多无用的推迟到运行期判决的代码，使得代码能够更好的内联压缩。例如SDK中通常提供传递配置结构体去配置外设的方式，或是获取中断标志位的函数，实际上这些函数内部做了大量不必要的判断与重复读取寄存器，反而加大了二进制文件体积和运行期的负担，通过将部分函数用模板改写，部分代码设置能内联到直接对寄存器进行位修改的地步，既快又轻量。在未来的计划中，为了减少SDK调用，同时减少适配不同产商芯片的移植成本，将逐渐通过结构体位域，编译时求值与模板元函数来实现对外设的配置与映射。
避免浮点改用定点：浮点对于编写桌面应用或是使用带有FPU单元的开发者来说触手可得，但大量的芯片却只提供了整数相关的硬件计算单元，而支持高性能的的芯片并不是作者的兴趣所在，在极限低成本的平台发挥超强的效能才是成就所在。故本库提供了内置的定点数支持，参考了德州仪器开源的iqmath库并对它做了改进，使得定点数被改写为一个重载了四则运算的模板类，我们能像用浮点数一样没有语法噪声地使用定点数并获得超高速的超越函数计算，其性能表现甚至在具有浮点单元的芯片上同样优于浮点计算。
STL可用：STL当然可用，但STL可用不代表我们可以盲目使用，请尽可能避免动态分配的容器。首先，零成本开销的库文件是完全可以使用的，诸如 <type_traits> <ranges> <algorithm> 等库，他们在提供抽象的同时几乎不会引入额外的占用。其次<functional> <quene> <vector> <unordered_map>等库同样可用，但在使用容器前思考背后的动态分配是否有必要，尽量使用<array> <span> <string_view>等在栈上进行内存分配或是只引用不持有的容器。最后<iostream> <exception>等库应当极力避免使用，他们会引入大量我们不需要的函数，占用大量体积。

成本从来都是我最看重的一点，在资源丰富的硬件平台上做低效率的crud从来不是一个成熟的开发者应该引以为傲的资本，本框架将始终保持对人民币2元以下的单片机的支持并将其作为核心的优化动力。在本框架上，完全可以在超低成本的芯片上编写大量业务代码而不超过芯片的极限，实现低性能MCU的四两拨千斤，快速实现降本增效。例如，通过本框架可以在短时间内部署大量低成本节点进行组网并实现传感，控制，计算等组件的模块化。真正使得嵌入式变成一门优雅的技术。

下面是一些案例的效果：

作用	描述	开销	性能
步进电机FOC驱动器	基于CH32V203(对标F103)芯片实现了完整的Can节点及FOC控制	36KB / 64KB	电流环/速度环/位置环均能以40khz+运行
机器人视觉主控板	基于CH32V307(对标F407)芯片实现了完整的Can主机以及视觉/AI/行为树的运行	93KB / 192KB	能以60fps运行视觉算法，自动完成对目标的搜索
九轴传感节点	基于CH32V203(对标F103)芯片实现了完整的Can节点及串口命令行	28KB / 32KB	6微秒单次解算

本框架的突出特点：

实现了完全的跨平台的抽象
提供了debug，日志相关的轻量强力工具，与stl保持良好兼容
使用了模板化的定点数类，编写无语法噪声的定点代码不再是问题
提供了大量外设的抽象层，同时尽可能保证他们是易用且中断安全的(添加相关仲裁机制)
提供了大量嵌入式常用设备的支持，开箱即用的一众SPI和I2C设备
提供了大量的机器人学，图像处理相关的中间层
在支持传统的虚函数,CRTP多态的同时也支持类似Rust的Trait特征表述以实现鸭子类型
（计划）使用模板元进行硬件平台的快速配置
（计划）提供异步去中心分布通信框架

固然承认，时至今日Arduino和HAL这两个框架在如今得嵌入式开发中占有相当大的话语权，但与这两者相比，本库依然有不可替代得巨大优势，在此与其对比以更好地呈现本框架的优势。

本库与主流开发框架的比较：

vs arduino：

提供了对外设每一分细节的精细控制，满足初级开发和高级开发的需求
提供了统一的设备管理层，不需要再用宏定义进一步区分各个平台
提供了对于外设统一的抽象层，外设不再依赖特定的硬件实现
提供了对常用总线的原生支持，总线类能够动态传递，而不是定死的全局单例
C++化程度更高，减少Java或C风格C++的刻板写法，大大增加代码甜度
大量使用泛型，以实现代码的复用与泛化
大量使用stl(参考odrive)

vs HAL：

做到了真正的硬件抽象，对不同厂家的芯片都提供的近乎相同的api，不再被厂家裹挟
应用层与库函数完全隔离，在应用层完全不需要和厂方SDK进行交互
没有丑陋的HAL前缀表示函数的命名空间
用多态取或lambda取代函数指针的使用，减少了心智负担
所有外设通过用户自定义宏或是模板元裁剪而不是工程文件管理提供了更高的自由度
将自动化生成代码与用户业务代码隔离，无需危险地与自动生成得代码互作
无需刻意学习框架编写受限的代码，提供了开箱即用的外设

下面是一些简单的演示(不一定与实际开发中的代码同步，开发中的文件都在src文件夹下测试开发直到成熟才会合并入框架具体例子请参考src/app或src/testbench下的文件)

无需复杂的结构体配置点亮一盏led

int main(){
    //...preinit()

    //通过引用获取GPIO
    //端口使用工厂模式返回GPIO，确保GPIO不会被随意构造
    auto led = portC[13];

    //将led设置为输出模式，并以高电平初始化
    led.outpp(HIGH);

    while(true){

        //通过重载GPIO的布尔运算符以写入与读取，使得GPIO能够直接被布尔量赋值
        led = !led;
        delay(200);
    }
}

又或是开启互补PWM快速验证SPWM输出

int main(){
    //...preinit()

    //将定时器①以36Khz初始化 使用字面量常量表达式来计算
    timer1.init(36_KHz);

    //使用工厂模式来获取定时器①的输出比较通道①
    auto pwm = timer1.oc(1);
    pwm.init();

    {
        //获取互补PWM通道并初始化
        auto pwmn = timer1.ocn(1);
        pwmn.init();

        //或者也可以直接
        // timer1.ocn(1).init();
    }

    //将刹车寄存器初始化 默认为200ns
    timer1.initBdtr();

    //进入主循环
    while(true){
        // time (时间) 是一个获取高精度秒数(微秒级)的函数 将在systick中被自动更改
        const auto t = time();
        // 重载了PWM被数值赋值的函数 使得对它的赋值能直接改变占空比
        pwm = 0.5 + 0.5 * sin(t);
    }

    //或者也可以直接这样做

    //以0:0的中断优先级将定时器①的更新中断使能
    //使用枚举类以确保安全 
    // timer1.enableIt(TimerIT::Update, {0,0});

    //使用lambda函数建立对应中断请求的回调函数
    // timer1.bindCb(TimerIT::Update, [&](){pwm = 0.5 + 0.5 * sin(t);});
}

再或者通过CAN指令精细控制云台的角度

int main(){
    //...preinit()

    //将CAN1以1Mbps的波特率初始化
    can1.init(1_MHz);

    //将串口一以921600的波特率初始化 默认TX和RX都使用DMA进行数据收发
    uart1.init(921600);

    //OutputStream是输出流类 可以实现数据的格式化输出
    //这里将串口的字符打印特征传递给logger 让logger编码的字符从uart1输出
    OutputStream logger = {&uart1};

    //建立舵机与步进电机变量
    SG90   servo   {timer1.ch(1)};
    DRV8825 stepper {timer1.ch(2);}

    //通过引用的方式建立is-a的关系 其中多继承确保只要是两个继承自角度可控类的对象均可以传入云台中
    Gimbal  gimbal  {servo, stepper};
    gimbal.init();

    real_t angle;
    while(true){
        if(can1.available()){
            //从CAN的接收FIFO中读取报文
            const auto & msg = can1.read();
            
            //使用模板以确保报文可以转换为任意类型的数据
            msg.load(angle);

            //直接就能将数据打印到串口
            //使用python风格的print输出而不需要formatter
            logger.println("angle is:", angle);
        }

        //内部有多种向量数据类型(多维向量与四元数等)，为机器人学奠定基础
        gimbal.moveTo(Vector2(1, 0).rotated(angle));
    }
}

⚠️声明

目前受到完整支持的芯片只有CH32V2/CH32V3系列，其他平台的MCU计划在项目API稳定后加入支持，加入非SXX32风格的芯片乃至对于Linux的支持

使用C++20编写，请使用gcc12及以上的版本进行编译，否则可能出现编译错误使用Vscode下的eide搭建开发环境，计划将于项目成熟后逐步迁移到Cmake中

厂方sdk库已改动请使用用本仓库提供的sdk 位于sdk目录下下

🌱参与贡献

算是本人用来练习git的项目, 第一次使用git不太熟悉，欢迎大佬提出宝贵意见。本框架全由作者一人贡献，参考或引入了部分开源代码。由于目前项目架构尚不稳定不要轻易fork！！！！！

🔨开发环境

GCC

由于本项目使用GCC进行开发（对各平台实现最大化开源），且目前暂无计划打算增加对Clang系列编译器的支持（ARMCC/ARMCLANG不支持）且本项目使用到了完整的C++20的特性进行开发，故GCC的版本不低于12

CH32系列单片机开发：

同时由于CH32系列单片机使用的RiscV V4系列内部为了支持快速中断，为GCC添加了客制化的中断关键字，故应使用WCH定制的GCC12（需要安装MounRiver Studio以获取我们所需要的厂家客制化的riscv-none-elf-gcc）

VSCODE

为了提供插件EIDE的宿主以及获得更好的编码体验需要下载vscode并安装

EIDE

为了提供方便快捷开箱即用的环境体验本项目选择vscode的插件eide进行开发具体请移步 eide

OPENOCD

为了支持WCH-Link基于OPENOCD进行了定制化开发故需要安装WCH提供的OpenOCD(同样在MounRiver Studio的安装目录中可以找到)

编译选项

请使用Os/O3/Ofast进行编译，同时开启lto优化，以确保代码的尺寸和运行速度被尽可能优化, 否则可能导致FLASH占用过高无法使用。

Name		Name	Last commit message	Last commit date
Latest commit History 1,353 Commits
.vscode		.vscode
algo		algo
concept		concept
core		core
drivers		drivers
dsp		dsp
examples		examples
hal		hal
nvcv2		nvcv2
ral		ral
robots		robots
scripts/translator		scripts/translator
sdk		sdk
targets		targets
thirdparty		thirdparty
tools		tools
types		types
.gitignore		.gitignore
.gitmodules		.gitmodules
LICENSE		LICENSE
README.md		README.md
Yumud.code-workspace		Yumud.code-workspace

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Yumud

基于C++20的超轻量级高性能嵌入式开发框架充分释放个位级成本MCU的巨大潜能

⚠️声明

🌱参与贡献

🔨开发环境

GCC

CH32系列单片机开发：

VSCODE

EIDE

OPENOCD

编译选项

🍴目录

examples 官方例程

algo 算法

dsp 信号处理

types 各种类型

nvcv2 图像处理框架

drivers 设备驱动

ral 寄存器访问层(Register Access Layer)

concept 外设的抽象基类

sys 系统

src 主要源代码

hal 硬件抽象层(Hardware Abstraction Layer)

robots 机器人与电力学相关代码

About

Releases

Packages

Languages

License

Left-Hand/Yumud

Folders and files

Latest commit

History

Repository files navigation

Yumud

基于C++20的超轻量级高性能嵌入式开发框架 充分释放个位级成本MCU的巨大潜能

⚠️声明

🌱参与贡献

🔨开发环境

GCC

CH32系列单片机开发：

VSCODE

EIDE

OPENOCD

编译选项

🍴目录

examples 官方例程

algo 算法

dsp 信号处理

types 各种类型

nvcv2 图像处理框架

drivers 设备驱动

ral 寄存器访问层(Register Access Layer)

concept 外设的抽象基类

sys 系统

src 主要源代码

hal 硬件抽象层(Hardware Abstraction Layer)

robots 机器人与电力学相关代码

About

Topics

Resources

License

Stars

Watchers

Forks

Releases

Packages 0

Languages

基于C++20的超轻量级高性能嵌入式开发框架充分释放个位级成本MCU的巨大潜能

Packages