基於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結構體中,以及其他各種屬性說明。