PDF《1. introduction》

1.

introduction 2. 前言 i. 项目概述 ii. 项目产生原因 iii. 代码分支说明 3. 编程风格 i. 程序规范 i. 代码规范N条ii. 编程规范N条iii. 接口规范N条iv. 注释模板 ii. 目录树架构 4. 快速配置使用 i. 支持快速配置的板跟型号 ii. 生成快速配置环境 iii. 工程编译 iv. 注意事项 5. 例子 6. 层次说明 i. 概述 ii. 板载提供层BSP i. 板载支持层BSL ii. 片内外设支持层OSL iii. 驱动层DEV iv. 驱动抽象层HAL v. 应用层APL 7. 模块说明 i. 概述 ii. BSP层i. BSL层ii. OSL层iii. DEV层i. IO驱动模块 iv. HAL层i. modbus模块 ii. 显示模块 v. APL层i. 菜单模块 8. 附录 i. DEV测试中的功能 ii. 配置脚本说明 iii. doxygen生成的代码文档 iv. 如何手动加入快速配置 v. 缩写查找表 vi. 名词解释 目录 lego项目帮助文档

2 标签: 单片机 原创 文档版本:0.3 update log update

1 (2014-09-04) update

2 (2014-12-16) update

3 (2015-04-12) 1. 完善写目录 2. 改进已写内容 项目名字:lego 项目版本号:0.1 lego项目帮助文档

3 introduction 前言 lego项目帮助文档

4 前言 它是一个泛平台,经过里面各层的通信来提供应用.同时针对不一样的板与芯片进行适配,并通过同一份代码进行管理,所以它要 做的任务只有一个,不用的开发板提供对应的方便的服务 当前代号 molecule 历史代号 molecule 项目编号规定:主版版本号.测试号 项目可执行程序版本编号规定:主版本号.测试号.编译时间 1.1.项目概述 lego项目帮助文档

5 项目概述 自己写过的代码不算多,但哪怕一两个就足够让我烦恼,很多时候无论是编写系统应用软件还是编写裸机程序,都有会遇到 很郁闷的情况,例如你在写windows程序的时候,可能需要一直到linux的时候,在之前没有考虑API问题时,便会变得无从入 手,因为两边的API不对应,这样就需要每个不一样的地方都要改,然而在代码编写的时候,往往不注意的细节(如分层, API规范等等)搞到不一样的地方到处都要改,后果很明显,这维护的时间想必很长.还有在编译裸机程序的时候,或许喜 欢效率而将很多函数乱插乱用,到后面发现,已经不想维护了,而且在裸机程序中,这种情况更难维护,因为控制硬件的函 数跟变量随时可能因一个小动作而变得无法预知结果.搞到在整个维护过程中很多不确定性.我一开始看到公司很多代码都 是分板来存储就觉得奇怪,现在也就知道了,这样可以适应不一样的cpu,不一样的板,而且会很容易适配.不过在我看来 这会造成一个不方便,多份的代码存储会导致代码管理的不方便,只要有人参与的管理就难免出现出错.所以它就出现了. 1.2.项目产生原因 lego项目帮助文档

6 项目产生原因 源代码管理是使用了git来进行管理. 这里是代码仓库 是在当其他分支稳定的情况下才会合并到这个分支上,这分支只有最新的稳定版源代码,所以编译出来的是可执行程序只能 是最新版的开发板.如果需要旧版本的可执行程序的话,可以在master中的README中拿到下载地址.当然也可以回滚以前 版本自己重新编译一次来得到可执行程序. dev分支为测试分支,所有的源代码先在这里实现,经过测验后稳定后才会合并到master分支 附属分支属于临时分支,同样需要推送到git服务器上,但这些分支只为了完成一个功能,当这个功能完成后,这个分支将合 并到dev分支中,合并后这个分支将会被删除. 下图是各分支的关系. 其中附录,列举了dev跟master的不同点,当这些不同点测试稳定后,会将他们合并. 只有测试完成功能后,才会写进 master分支.而附属分支是即将成为dev一部分的一些功能开发分支,当开发完这些分支中的功能后,将会合并到dev中一并 进行测试. 1.3.分支说明 master分支 dev分支 附属分支 lego项目帮助文档