34 lines
1.5 KiB
Plaintext
34 lines
1.5 KiB
Plaintext
一、文本编码格式
|
||
编码格式使用UTF-8
|
||
|
||
二、编码规范
|
||
1、SDK变量命名延续原SDK的下划线命名法，不使用驼峰命名法
|
||
2、宏定义统一大写
|
||
3、宏定义时宏值需要加括号，防止编译器预处理替换之后不被视为一个整体处理
|
||
3、hal层函数命名统一hal开头
|
||
4、driver层函数命名统一drv开头
|
||
5、if判断相等时变量放在右值，防止编写失误导致赋值
|
||
6、对外接口必须检测入口参数，防止用户输入空指针等导致系统崩溃。
|
||
7、驱动层单一语句需强制内联，增加运行效率
|
||
8、寄存器需要防编译器优化，防止实际运行CPU没有对寄存器所在内存进行操作，建议根据寄存器的读写权限使用宏__IO
|
||
|
||
三、框架规则
|
||
编写框架指导详见《WL818 SDK框架规则》
|
||
|
||
四、文件系统
|
||
WL818_SDK
|
||
├─compile
|
||
├─fw2flash
|
||
├─link
|
||
├─output
|
||
├─pgm
|
||
└─src
|
||
├─.vs
|
||
├─code //用户app
|
||
│ └─project_case
|
||
│ └─RM692H5_120HZ_DSC3_1
|
||
├─driver //该文件夹负责放驱动层不对外暴露的文件，如，drv_mipi_tx和hal_mipi_tx.h
|
||
│ ├─include //放仅内部可见的驱动头文件，比如drv_mipi_tx.h
|
||
│ ├─source //放仅内部可见的驱动源文件，比如drv_mipi_tx.c和hal_mipi_tx.c
|
||
│ └─ulog
|
||
└─include //对外头文件hal和common定义，如hal_mipi_tx.h |