BSW EA UML 模型建模指南（Modeling Guidelines of Basic Software EA UML Model）

1 介绍（Introduction）

本建模指南描述了在 UML 模型中规范 AUTOSAR 基础软件所使用的建模技术和规则。

BSW 模型中的信息由 AUTOSAR 元模型工具（Meta Model Tool，MMT）处理，并为 AUTOSAR 定义的多份软件规范（SWS）提供主要输入。为了使 BSW 模型可被 MMT 访问，模型必须遵守本文档中描述的规则。

1.1 制品（Artifacts）

AUTOSAR BSW UML 模型的主要目的是保持 99+ 份 SWS 文档与文件结构、提供/需要接口、时序图、状态机等保持同步。因此，所有相关信息都按照第 2 章"建模指南"中规定的建模规则保存在 BSW 模型中。

BSW UML 模型向 SWS 文档贡献以下制品：

1.1.1 头文件（Header Files）

每份 SWS 文档的第 5.1 章包含 BSW 模块的文件结构，特别是其头文件包含结构。由于大多数模块的头文件关系具有相似的结构（实际上有些部分完全相同），头文件结构使用类图建模，使用带构造型（Stereotype）的类表示源文件和头文件；详见 2.4.1 节。

1.1.2 导入类型定义（Imported Type Definitions）

SWS 第 8.1 章包含导入类型的表格列表。该表根据 2.3.5 节解释的模块依赖关系自动生成。

1.1.3 类型定义（Type Definitions）

SWS 第 8.2 章包含给定 BSW 模块内定义的所有类型的详细描述。类型定义的建模详见 2.3.8 节。

1.1.4 函数定义（Function Definitions）

SWS 第 8.3 章包含 BSW 模块提供的每个函数的详细描述，以特定布局的表格形式呈现。表格的各个字段根据 2.3.3 节中定义的 API 函数定义填充。

1.1.5 回调通知（Callback Notifications）

与函数定义非常相似，SWS 第 8.4 章包含 BSW 模块提供的回调定义。这些回调将由其他 BSW 模块调用，其中较低层模块通常是调用者。每个回调通知的表格将根据 2.3.7 节为模块的指定回调生成。

1.1.6 调度函数（Scheduled Functions）

调度函数在 SWS 第 8.5 章中描述。BSW UML 模型中调度函数的定义见 2.3.3.1 节。

1.1.7 必需接口（Mandatory Interfaces）

SWS 第 8.6.1 章包含模块期望的"必需接口"列表。该列表根据 2.3.5.2 节描述的必需依赖从 BSW UML 模型生成。

1.1.8 可选接口（Optional Interfaces）

SWS 第 8.6.2 章包含"可选接口"列表，基于 2.3.5.3 节中的可选依赖生成。

1.1.9 可配置接口（Configurable Interfaces）

SWS 第 8.6.3 章包含"可配置接口"列表。

1.1.10 时序图（Sequence Diagrams）

每个 BSW 模块的关键交互通过时序图建模，详见 2.4.2 节。

1.1.11 各种图（Various Diagrams）

包括组件图、类型图、状态机图等，详见 2.4 节。

1.1.12 服务建模（Modeling of services）

BSW 模块对 SW-C 提供的服务建模详见 2.3.9 节。

2 建模指南（Modeling Guide）

2.1 术语（Terminology）

本节定义本文档中使用的术语：

2.2 模型结构（Model Structure）

BSW UML 模型采用层次化包结构：

• AUTOSAR Root
  • AUTOSAR_Platform
  • AUTOSAR_ClassicPlatform
  • ...
• 每个模块位于单独的包中，包含该模块的所有 UML 元素。

2.3 BSW 模块建模（Modeling of BSW Modules）

2.3.1 模块（Modules）

2.3.1.1 包（Packages）

每个 BSW 模块使用包（Package）组织其元素。包名应当与模块缩写一致。

2.3.1.2 组件（Components）

每个 BSW 模块在 UML 中表示为组件（Component），带有构造型 <<BSWModule>>。

2.3.1.3 组件图（Component Diagrams）

使用组件图展示模块的内部结构，包括：

• 模块组件；
• 内部子组件；
• 提供的接口（Provided Interfaces）；
• 需要的接口（Required Interfaces）；
• 端口（Ports）。

2.3.1.4 类型图（Type Diagrams）

使用类图展示模块的数据类型定义。

2.3.2 函数接口（Function interfaces）

BSW 模块通过接口对外提供服务和消费其他模块的服务。接口可以是：

• 客户端-服务器（Client-Server）；
• 发送者-接收者（Sender-Receiver）；
• 模式切换（Mode Switch）。

2.3.3 API 函数（API Functions）

每个 API 函数在 UML 中建模为操作（Operation），归属于提供该操作的接口。操作的属性包括：

• 名称（与 C 函数名一致）；
• 返回类型；
• 参数列表（名称、类型、方向）；
• 同步/异步属性；
• 可重入性；
• 支持的并行调用；
• 对错误检测的支持。

2.3.3.1 调度函数（Scheduled Functions）

调度函数（主处理函数）使用特殊的客户端-服务器接口建模，由 SchM 调用。

2.3.4 API 函数参数（API Function Parameters）

参数建模规则：

• 参数应当具有方向（in/out/inout）；
• 参数类型应当使用 AUTOSAR 标准类型或模块特定类型；
• 复合参数使用复合类型建模。

2.3.5 模块依赖（Module Dependencies）

模块依赖通过端口连接和依赖关系建模。

2.3.5.1 虚拟接口（Virtual Interfaces）

虚拟接口是模块间共享的接口定义。

2.3.5.2 必需接口（Mandatory Interfaces）

必需接口建模为必需端口。

2.3.5.3 可选接口（Optional Interfaces）

可选接口建模为可选端口。

2.3.6 通用接口（Generic Interface）

通用接口允许在不知道具体类型时定义可重用的接口模式。

2.3.7 回调通知（Callback Notifications）

2.3.7.1 回调的定义和使用（非可配置回调）

非可配置回调是模块在编译时固定的回调函数。

2.3.7.2 可配置回调的定义和使用

可配置回调允许在运行时通过配置选择具体的回调函数。

2.3.7.3 回调通用接口

通用回调接口支持参数化。

2.3.8 数据类型定义（Data Type Definitions）

2.2.3.8.1 简单类型（Simple Types）

简单类型（整数、浮点、布尔等）通过原始数据类型（Primitive Data Type）建模。

2.3.8.2 枚举（Enumerations）

枚举通过枚举数据类型建模，包含字面量集合。

2.3.8.3 Std_ReturnType 扩展

Std_ReturnType 可通过扩展定义模块特定的错误代码。

2.3.8.4 结构体（Structures）

结构体通过应用数据类型（ApplicationDataType）建模，包含元素列表。

2.3.8.5 位域（Bitfields）

位域使用位域类型建模。

2.3.8.6 数据类型中的可变性建模

通过条件（Condition）和变体点（VariationPoint）机制处理数据类型中的条件编译。

2.3.9 服务建模（MoS）（Modeling of services (MoS)）

2.3.9.1 客户端/服务器接口建模（Modeling of Client Server Interfaces）

客户端/服务器接口建模为客户端-服务器接口，包含操作集合。

2.3.9.2 模式切换接口建模（Modeling of Mode Switch Interfaces）

模式切换接口建模为模式切换接口，包含模式声明组。

2.3.9.3 发送者/接收者接口建模（Modeling of Sender Receiver Interfaces）

发送者/接收者接口建模为数据接口，包含数据元素。

2.3.9.4 服务接口中的特殊类型建模

包括对应用程序数组类型、记录类型等的建模规则。

2.3.9.5 服务接口的可变性建模

使用条件机制处理接口中的条件元素。

2.3.9.6 PortAPIOptions 与 PortDefinedArgumentValues 的建模

用于配置端口的 API 选项和参数值。

2.4 图（Diagrams）

2.4.1 头文件建模（Header File Modeling）

头文件结构使用类图建模：

• 每个 C 源文件或头文件表示为类；
• 使用构造型标识文件类型（如 <<SOURCE>>、<<HEADER>>）；
• 使用依赖关系表示包含关系（#include）。

2.4.2 时序图（Sequence Diagrams）

关键 API 调用和事件交互使用UML 时序图建模。

2.4.3 状态机图（State Machine Diagrams）

复杂模块的状态转换使用UML 状态机图建模。

2.5 BSW 模型中生命周期概念的支持（Support for Life Cycle concept in BSW Model）

BSW 模型支持 AUTOSAR 的生命周期概念，包括：

• ECU 生命周期阶段；
• BSW 模块在每个阶段的行为；
• 跨生命周期的状态保留。