基于AUTOSAR_SWS_CANDriver.pdf,Specification of CAN Driver AUTOSAR CP Release 4.3.1
AUTOSAR所有软件规范文档(SWS)的目录结构都是一样的,如下:
特点及优点如下:
a. 结构化程度高,所有文档结构一致,易于查找;
b. 内容详实,包括所有API/数据结构的列表;
c. 采用多种说明方法,如表格、UML图,易于理解。
1 Introduction and functional overview
第一章做简单的功能介绍。
5 Dependencies to other modules
第五章介绍该模块与其他模块之间的依赖关系
这里主要看与头文件结构,从中我们可以看到模块设计的头文件、代码文件,以及各文件之间的引用关系。
7 Functional specification
第7章对该模块功能做详细、正式的说明:
8 API specification
第8章介绍该模块所涉及的数据类型、API的定义规范。
8.1 Imported types
引用到的数据类型:
8.2 Type definitions
本模块定义的数据类型:
8.3 Function definitions
本模块定义的API接口,例如:
8.4 Call-back notifications
回调函数定义。
8.5 Scheduled functions
供SchM模块调用的函数定义:
8.6 Expected Interfaces
依赖其他模块的API接口。
9 Sequence diagrams
本模块涉及流程的顺序图(UML图):
如Can Interface中的例子:
10 Configuration specification
本模块的配置数据及其数据结构的说明。
使用两种说明方法:
a. UML类图:说明配置相关数据结构的组成及引用关系;
b. 表格说明;
逐个描述数据结构及数据结构成员。
b.1 数据结构
即Can_ConfigType包含CanGeneral和CanConfigSet。
b.2 数据结构成员
Boolean成员CanDevErrorDetect在CanGeneral结构体中,以及其他各种属性说明。