NvM

目标

本文档旨在指导使用 NvM 模块的用户能够清晰地了解 NvM 的功能，以及如何去配置和使用 NvM 模块。

NvM 模块的作用是提供在汽车环境下 NV 数据的存储和维护的各种需求服务。 NvM 模块支持管理 Flash 设备的 NV 数据。 NvM 模块提供各种同步/异步服务来管理和维护非易失性数据

缩写词和术语

表 缩写解释

缩写词/术语	描述
NvM	Non-Volatile Manager
MemIf	Memory Abstraction Interface
Fee	Flash EEPROM Emulation
Ea	EEPROM Abstraction
Fls	Flash Driver
Eep	EEPROM Abstraction
Nv	Non-Volatile

参考文档

[1] 参考手册_NvM.pdf

[2] 参考手册_MemIf.pdf

[3] 参考手册_Fee.pdf

[4] 参考手册_Ea.pdf

协议栈集成

项目交付的内容为：协议栈源码和ORIENTAIS Studio配置工具。协议栈细分为协议栈的各模块及其对应的配置工具模块。

NvM各配置模块的功能介绍，参见表 NvM各配置模块介绍。

使用协议栈源码和配置工具，进行协议栈的集成的步骤，参见表 协议栈集成的步骤。

表 NvM各配置模块介绍

模块名	功能
Fee	Fee驱动配置。(由MCAL工具导入，详见章节(配置Flash/Fee)；若使用项目提供的Fee模块，详见(配置Fee_62模块))
Flash	Flash驱动配置。(由MCAL工具导入，详见章节（配置Flash/Fee模块）)
Eep	EEPROM驱动配置。(如未使用EEPROM做存储，则无需配置)
Ea	Ea属性及Block配置。(如未使用EEPROM做存储，则无需配置)
NvM	非易失存储管理

表 协议栈集成的步骤

步骤	操作	说明
1	ORIENTAIS Stuido配置工具工程搭建和协议栈模块加载	若配置工具已经搭建，则仅需进行协议栈模块的加载操作。
2	模块配置及配置文件生成	NA
3	代码集成	现有工程、协议栈源代码和配置生成文件的集成。
4	验证测试	NA

Note

协议栈集成之前，用户须确保已经有基础工程，且本协议栈相关的其他协议栈能正常工作。

新建ORIENTAIS Stuido配置工程及模块加载

1. 安装ORIENTAIS Studio软件后，双击软件图标打开软件。

   

   图 初始界面

2. 菜单栏File🡪New🡪Project，新建工程。

   

   图 新建界面

3. 在弹出的新建窗口中选择Autosar下的 [BSW Project]，选择Next。

   

   图 初始选择界面

4. 在弹出的窗口中输入工程名，选择Finish。

   

   图 命名界面

5. 选择[Bsw_Builder]，右键单击，选择New ECU Configuration。

   

   图 新建ECU界面

6. 在弹出的窗口中输入ECU名，然后选择Next。

   

   图 选择内核界面

7. 在弹出的窗口中勾选需添加的模块，点击Finish。

   1. 如果使用内部FLASH进行NvM的存储，则需要外部导入Fls和Fee模块，导入方法参见章节(配置代码生成 )。

   2. 除外部导入外，普华产品协议栈也提供Fee模块的支持，可在工具内添加Fee_62模块，配置参见章节(Fee_62模块)。

   3. 如果需要使用EEPROM硬件进行NvM的存储，则还需要添加Ea和Eep模块，配置参见章节(Eep_62模块 & Ea模块) 。

      

      图 NvM和MemIf模块选择界面

      

      图 Crc模块选择界面

8. 新建工程如下所示，步骤7中添加的模块已经被加入到工程中。

   

   图 内部显示界面

模块配置及生产代码

模块配置

模块的具体配置，取决于具体的项目需求。该协议栈各模块配置项的详细介绍，参见章节(Flash/Fee模块配置) 。

表 协议栈各模块配置参考文档

模块	参考文档及其章节	说明
FLASH	MCAL对应的FLASH配置手册
Fee	MCAL对应的Fee配置手册
NvM	NvM用户手册_参考手册.pdf 章节（配置Flash/Fee模块）

配置代码生成

1. 对Fee和Fls模块配置完成后导入MCAL工具中的Fee和Fls的配置。

   

   图 导入MCAL配置

   

   图 导入MCAL配置

2. 在ORIENTAIS Stuido主界面左方，选择对应的协议栈，单击右键弹出Validate All和Generate All菜单。

   

   图 校验界面

3. 选择Validate All对本协议栈各配置选项进行校验，没有错误提示信息即校验通过。若有错误信息，请按照错误提示修改。

4. 选择Generate All，生成配置文件。右下角的Console窗口输出生成的配置文件信息。

   

   图 校验完成界面

5. 将ORIENTAIS Studio切换到Resource模式，即可查看生成的配置文件。

   

   图 配置显示界面

功能集成

代码集成

协议栈代码包括两部分：项目提供的协议栈源码和ORIENTAIS Studio配置生成代码。

用户须将协议栈源码和章节（配置代码生成）生成的源代码添加到集成开发工具的对应文件夹。协议栈集成的文件结构，见章节（源代码集成）。

Note

协议栈集成之前，用户须确保已经有基础工程，且本协议栈相关的其他协议栈能正常工作。

集成注意事项

对于集成过程中，协议栈特殊要求和用户经常出现的问题，归类总结形成 表 协议栈集成约束清单。用户需逐一排查表中的约束项，以避免集成问题出现。

表 协议栈协议栈集成约束清单

编号	类别	约束限制
1	堆栈	用户需确保为任务堆栈和中断堆栈分配足够的堆栈空间。
2	头文件	添加协议栈代码之后，用户需更新集成开发工具中的头文件路径。 调用协议栈API的源文件，需要包含协议栈的头文件。
3	初始化	以NvM为例，NvM的初始化顺序为：Fls _Init， Fee_Init，NvM_Init。
4	周期函数	Fls_MainFunction();Fee_MainFunction();NvM_MainFunction();需要被周期性任务函数调用。

集成示例

本章节通过NvM的集成过程。用户可以据此熟悉NvM配置工具的配置过程，以及如何应用配置工具生成的配置文件。

Note

本示例不代表用户的实际配置情况，用户需要根据自己的实际需求，决定各个参数的配置。

集成目标

NvM配置需求：

表 配置目标

NV模块名称	CRC校验	类别	Length	num	Ram blockaddress
NvMBlock_ConfigFEE1	Crc16	Native	300	1	0x70008400
NvMBlock_ConfigFEE2	Crc16	Native	200	1	0x70008800

模块的配置

新建配置工程及模块加载操作，请参考本文档（模块配置及生产代码） 章节。

配置Flash/Fee模块

本章介绍如何使用MCAL工具配置Flash模块

1. 打开MCAL工具，新建flash模块后，无需更改，直接按照默认即可。

   

   

   图 MCAL界面

2. 完成MCAL配置后，生成Flash/Fee模块的配置文件，替换工程中原有的Flash/Fee模块的配置文件。

   导入配置工具后工程如下图所示：

   

   图 工具配置界面

配置Fee_62模块

Note

如项目中使用普华提供的Fee协议栈，则遵循以下配置

1. 加载Fee_62模块。

   

   图 Fee_62加载界面

2. FeeGeneral提供Fee模块的基本属性配置，如下图所示：

   

   图 FeeGeneral配置

3. Fee还需配置FeeBank对应Fls的具体sector地址，可以直接配置起始地址和Bank Size（符合Fls模块实际情况）。

   

   图 FeeBank手动配置

   该处也可以根据Fls模块对应关联sector。

   

   图 FeeBank关联配置

4. Fee模块需要配置NvM使用的NvBlock，各个Block的基本配置如下表。BlockID根据NvMDatasetSelectionBits配置。

表 Fee Block配置

Index	Name	Fee BlockID	Fee Block Size
0	FeeBlockConfiguration_0	0x100	4
1	FeeBlockConfiguration_1	0x101	4
2	FeeBlockConfiguration_2	0x200	302
3	FeeBlockConfiguration_3	0x300	202

因为NvM Block采用16字节CRC校验的方式，所以，对应的NV block size会在NvM Block Size的基础上增加2，用于存放Crc信息。

Note

FeeVirtualPageSize根据实际情况调整，应为FlsPageSize的整数倍。

Fee模块配置如下图所示：

图 Fee Block配置

配置Eep_62模块

Note

如项目中没有使用EEPROM，则不需要配置Eep模块与Ea模块

1. 加载Eep_62模块。

   

   图 Eep_62加载界面

2. Eep模块的General配置页面，根据实际需求配置。

   

   图 Eep General配置

3. EepInitConfiguration配置如下图所示：

   

   图 Eep InitConfiguration配置

   1. EepDefaultMode：此参数是初始化后的默认EEPROM设备模式。

   2. EepJobCallCycle：EEPROM驱动程序主要功能的调用循环时间。

   3. EepJobEndNotification：此参数是对操作结束的回调函数的引用。

   4. EepJobErrorNotification：此参数是对错误结果的回调函数的引用。

4. EepDeviceConfiguration配置如下图所示：

   

   图 EepDeviceConfiguration配置

   1. EepBaseAddress：此参数是EEPROM设备的基地址。

   2. EepFastReadBlockSize：快速模式下一个周期内读取的字节数。如果硬件不支持突发模式，则此参数应设置为与EepNormalReadBlockSize相同的值。

   3. EepFastWriteBlockSize：快速模式下一个周期内写入的字节数。如果硬件不支持突发模式，则此参数应设置为与EepNormalWriteBlockSize相同的值。

   4. EepNormalReadBlockSize：在正常模式下，在一个周期内读取的字节数。

   5. EepNormalWriteBlockSize：在正常模式下，在一个周期内写入的字节数。

   6. EepSize：此参数是EEPROM设备使用的大小（以字节为单位）。

   本示例中，Eep模块，地址默认从0开始，EepBaseAddress为0，默认设置为slow模式，因为EEPROM硬件不支持快速模式，所以快速模式即单次处理的数据量更多，单词处理的数据的时间更长，而单次任务处理的总时间相对较短，本次示例中EepFastReadBlockSize和EepNormalReadBlockSize保持一致，EepFastWriteBlockSize和EepNormalWriteBlockSize保持一致，均配置为128即可。EepSize按照实际的EEPROM大小，配置为65536，其他配置项可不做额外配置。

5. EepDeviceHwApis配置如下图所示：

   

   图 EepDeviceHwApiss配置

   填入驱动对应的api即可。

配置Ea模块

Note

如项目中没有使用EEPROM，则不需要配置Eep模块与Ea模块

1. 加载Ea模块。

   

   图 Ea加载界面

2. Ea模块作为Eeprom的抽象层，EaGernal提供Ea模块的基本属性配置，如下图所示：

   

   图 Ea General配置

3. Ea模块需要配置NvM使用的NvBlock，各个Block的基本配置如下表。

表 Ea Block配置

Index	Name	Ea BlockID	EaBlock Size
0	EaBlockConfiguration_ID_00	0x100	4
1	EaBlockConfiguration_ID_01	0x101	4
2	EaBlockConfiguration _0	0x200	302
3	EaBlockConfiguration _1	0x300	202

因为NvM Block采用16字节CRC校验的方式，所以，对应的NV block size会在NvM Block Size的基础上增加2，用于存放Crc信息。

Note

Ea地址配置需要考虑字节对齐，写入过程中不能跨页（page）写入。

Ea模块配置如下图所示：

图 Ea Block配置

配置CRC模块

按照如图所示把所有的CRC计算方式全部计算出来，也全部使能，这样子做的好处可以在其他模块进行自由选择，此配置界面只有一个。

图 CRC工具配置界面

配置MemIf模块

勾选对应使用的Fee或Ea设备即可。MemIfGeneralNumOfDevices的数值应为下层抽象存储模块的总和，即为当前Fee和Ea模块的总和。

图 MemIf工具配置界面

配置NvM模块

1. NvMCommon提供NvM模块的基本属性配置，如下图所示：

   

   图 General工具配置界面

   1. NvMApiConfigClass：配置NvM的等级对应于3.

   2. NvMCompiledConfigId：初始化软件版本号43707

   3. NvMCrcNumOfBytes：每次NvM_MainFunction可计算128个字节的CRC。

   4. NvMDatasetSelectionBits：定义寻址的有效位。

   5. NvMMainFunctionPeriod：功能函数处理周期5ms。

   6. NvMSizeStandardJobQueue：任务队列长度为10。

2. NvMBlockDescriptor定义了NvM模块每个具体的存储块配置，如下图所示：

   

   图 NvMBlockDescriptor工具配置界面（1）

   

   图 NvMBlockDescriptor工具配置界面（2）

   

   图 NvMBlockDescriptor工具配置界面（3）

   1. NvMBlockCrcType：选择CRC16的计算方式。

   2. NvMBlockHeaderInclude：添加头文件包含

   3. NvMBlockManagementType：不设置备份块。

   4. NvMBlockUseCrc：使用CRC。

   5. NvMMaxNumOfReadRetries：读取失败之后最大3次尝试读取次数。

   6. NvMMaxNumOfWriteRetries：写入失败之后最大3次尝试写入次数。

   7. NvMNvBlockLength：块的大小，单位为字节

   8. NvMNvBlockNum：对应下层抽象块的数量

   9. NvMRamBlockDataAddress：存放在RAM区域的地址。

   10. NvMRomBlockDataAddress：存放默认备份值的区域地址

   11. NvMRomBlockNum：备份块的数量

   12. NvMSelectBlockForReadAll：能否全部读取。

   13. NvMSelectBlockForWriteAll：能否全部写入。

   14. NvMNameOfFeeBlock：Fee块的参考，对应于Fee的块号。

源代码集成

项目交付给用户的工程结构如下：

图 工程代码演示

• Config目录，这个目录用来存放配置工具生成的配置文件，NvM文件放在Ori_Config文件夹中。

• Source目录，存放模块相关的源代码。可以看到Source目录下各个文件夹下是各个模块的源代码。

NvM源代码集成步骤如下：

1. 将章节（模块的配置）中MCAL生成的NvM模块配置文件和ORIENTAIS Studio生成 的配置文件复制到Config文件夹中。

2. 将MCAL提供的NvM模块源码和项目提供的协议栈源代码文件复制到Sou rce/Memory文件夹中。

协议栈调度集成

NvM调度集成步骤如下（以底层使用Flash为例）：

1. 初始化存储栈，首先初始化Fls模块，然后初始化Fee模块。由于Fee初始 化需要遍历Fee_Block。所以需要先循环执行Fls_MainFunction和Fee_MainFunction使得Fee模块初始化完毕，然后初始化NvM模块。如下图所示：

   

   图 存储栈初始化

2. NvM_ReadAll(), NvM初始化后需要调用NvM_ReadAll()接口将存放在Flas h中的Nv_Block的数据读到Ram_Block中。由于NvM的任务是异步执行 的，所以调用NvM_ReadAll()接口后，任务需要在MainFunction中执行的， 所以还需要调用NvM_Mainfunction。常见的有两种调用方式：第一种在初 始化函数中调用了NvM_ReadAll()，紧接着后面采用while循环执行存储栈 的MainFunction直到NvM_ReadAll任务执行结束，这种方式的优点是初始 化完存放在NvM中的数据就可用了，但是由于是卡在初始化函数中执行的， 所以可能会导致系统初始化时间过长的问题，如下图所示。

   

   图 NvM_ReadAll

   第二种方式是在调用NvM_ReadAll后不while的执行MainFunction，而是等待OS的Task中周期调用MainFunction来处理ReadAll任务。这方式执行不会影响系统初始化时间，但是初始化完成后NvM中的数据还不可使用，比如像Dem之类需要NvM中的数据才能初始化的模块，需要等待NvM的ReadAll任务执行结束后在NvM的任务回调函数中执行。

3. 存储栈MainFunction放入到OS的Task中，根据项目实际的情况放入到合 适的周期中即可，如下图所示。

   

   图 MainFunction函数

4. NvM_WriteAll()，在系统准备休眠时需要调用NvM_WriteAll()接口使Ram_ Block中的数据存储到Nv_Block中。（一般使BSWM负责调用）