This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Component Design

1: EraseBlock
2: GetDataIndex
3: GetErrorStatus
4: InvalidateBlock
5: ReadBlock
6: RestoreBlockDefaults
7: SetBlockProtection
8: SetDataIndex
9: SetRamBlockStatus
10: WriteBlock
11: ES006A_NvM_Design_PeerReviewChkList
12: ES006A_NvM_FDD

Component Design

Module Detailled Design

Component Documentation

1 - EraseBlock

Erase Block

Nexteer NvM Library

By Function

Erase Block

Description

Request to erase the specified NvM block. This function queues the erase request and returns the acceptance result synchronously. The NvM can notify the application by callback when the service is finished. This function performs the same action as NvM_InvalidateNvBlock for FEE hardware.

Request Type
Asynchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
CallFunction	Input	Non-functional port to allow designers to show when the function should be called in their model. Only available if Cast Function Return to Void = True
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

2 - GetDataIndex

Get Data Index

Nexteer NvM Library

By Function

Get Data Index

Description

The request passes the current DataIndex of the specified dataset block.

Request Type
Synchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
DataIndexPtr	Output	Address where the current DataIndex shall be written.
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for DataIndexPtr	Data store name for use in model testing for the output argument in the function call.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	No
Redundant	No
Data Set	Yes

3 - GetErrorStatus

Get Error Status

Nexteer NvM Library

By Function

Get Error Status

Description

This request reads the block dependent status/error information and writes it to the given address (ReqResPtr). The status/error information was set by a former or current asynchronous request. This API can also be requested with the block id 0 (multi block). The multi block status/error information are only set by NvM_ReadAll() and NvM_WriteAll() requests.

Request Type
Synchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
ReqResPtr	Output	Pointer to where the result shall be written.
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for ReqResPtr	Data store name for use in model testing for the result of the argument in the function call.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

4 - InvalidateBlock

Invalidate Block

Nexteer NvM Library

By Function

Invalidate Block

Description

Request to invalidate the specified NvM block. This function queues the request and returns the acceptance result synchronously. The NvM can notify the application by callback when the service is finished. This function performs the same action as NvM_EraseBlock for FEE hardware.

Request Type
Asynchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
CallFunction	Input	Non-functional port to allow designers to show when the function should be called in their model. Only available if Cast Function Return to Void = True
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

5 - ReadBlock

Read Block

Nexteer NvM Library

By Function

Read Block

Description

Request to copy the data of the NvM block to its corresponding RAM block. This function queues the read request and returns the acceptance result synchronously.

Request Type
Asynchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
CallFunction	Input	Non-functional port to allow designers to show when the function should be called in their model. Only available if Cast Function Return to Void = True
NvM_DstPtr	Output	Pointer where the data of a non-permanent RAM block shall be written to. Only available if Set Output to NULL_PTR = False
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for NvM_DstPtr	Data store name for use in model testing for the output argument in the function call.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False
Set Output to NULL_PTR	`True`: NvM_DstPtr is ignored and NvM will used the configured PIM (permanent address) `False`: NvM_DstPtr shall point to the variable where NvM data shall be written to in RAM.

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

6 - RestoreBlockDefaults

Restore Block Defaults

Nexteer NvM Library

By Function

Restore Block Defaults

Description

Request to copy the ROM block default data to its corresponding RAM block. The selected block needs either ROM defaults or an initialization callback. This function queues the restore request and returns the acceptance results synchronously.

Request Type
Asynchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
NvM_DstPtr	Output	Pointer where the data of a non-permanent RAM block shall be written to. Only available if Set Output to NULL_PTR = False
CallFunction	Input	Non-functional port to allow designers to show when the function should be called in their model. Only available if Cast Function Return to Void = True
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for NvM_DstPtr	Data store name for use in model testing for the output argument in the function call.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False
Set Output to NULL_PTR	`True`: NvM_DstPtr is ignored and NvM will used the configured PIM (permanent address) `False`: NvM_DstPtr shall point to the variable where NvM data shall be written to in RAM.

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

7 - SetBlockProtection

Set Block Protection

Nexteer NvM Library

By Function

Set Block Protection

Description

The request sets the write protection for the NvM block. Any further write, erase, and invalidate requests to the block is rejected synchronously if the NvM block-write protection is set. The data area of the RAM block remains writeable in any case.

Request Type
Synchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
ProtectionEnabled	Input	`True`: Protection Enabled. `False`: Protection Disabled.
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for Protection Enabled	Data store name for use in model testing for the input argument in the function call.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

8 - SetDataIndex

Set Data Index

Nexteer NvM Library

By Function

Set Data Index

Description

The request sets the specified index to associate a dataset NvM block (with or without ROM blocks) with its corresponding RAM block. The DataIndex needs to have a valid value before read, write, erase or invalidate requests are initiated. If the dataset block has a set of ROM defaults, the function is used to select the appropriate ROM set (prior to NvM_ReadBlock()).

Request Type
Synchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
DataIndex	Input	Index position of a block of NvM block type Dataset.
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for DataIndex	Data store name for use in model testing for the input argument in the function call.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	No
Redundant	No
Data Set	Yes

9 - SetRamBlockStatus

Set Ram Block Status

Nexteer NvM Library

By Function

Set Ram Block Status

Description

This request sets a block’s status to valid/changed and also to unchanged. Setting BlockChanged to True will mark it for writing during NvM_WriteAll, which is called during shutdown. The data saved is the current value in the PIM defined for the NvM block. If the value of BlockChanged is set to false before shutdown, then the block will not be updated.

Request Type
Asynchronous If CRC calculation is updating during operation.
Synchronous If CRC calculation is updated only at shutdown.

Port Description

The following table describes the ports for this block.

Port	Type	Description
BlockChanged	Input	Boolean value to queue the NvM update during shutdown.
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for BlockChanged	Data store name for use in model testing for the input argument in the function call.
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

10 - WriteBlock

Write Block

Nexteer NvM Library

By Function

Write Block

Description

Request for copying data from the RAM block to its corresponding NvM block. This function queues the write request and returns the acceptance result synchronously. If the block has a CRC, the RAM block CRC will be recalculated before the data and the CRC are written to the NvM memory, even if the service NvM_SetRamBlockStatus() was called before and the configuration was set that within this service, the CRCcalculation should be done. If writing the data to NvM memory fails, the NvM will retry writing. The number of write retries is a configuration option by software.

Request Type
Asynchronous

Port Description

The following table describes the ports for this block.

Port	Type	Description
CallFunction	Input	Non-functional port to allow designers to show when the function should be called in their model. Only available if Cast Function Return to Void = True
NvM_SrcPtr	Input	Pointer where the data of a non-permanent RAM block shall be read from. Only available if Set Input to NULL_PTR = False
Return	Output	Standard return `E_OK` or `E_NOT_OK` for the function call. Only available if Cast Function Return to Void = False

Mask Description

The following table describes the parameters for this mask.

Parameter	Description
NvM Block Name	The block name defined in the m-file with the NVM class.
Cast Function Return to Void	`True`: Function will be cast as a 'void' function and the return value is ignored. `False`: Value is returned and used by the calling function.
Data Store for NvM_SrcPtr	Data store name for use in model testing for the input argument in the function call. Only available if Set Input to NULL_PTR = False
Data Store for Return	Data store name for use in model testing for the result of the function call. Only available if Cast Function Return to Void = False
Set Output to NULL_PTR	`True`: NvM_SrcPtr is ignored and NvM will used the configured PIM (permanent address) `False`: NvM_SrcPtr shall point to the variable where NvM data shall be written to in RAM.

NvM Block Compatibility

The following table describes which NvM block type is compatible with this function.

NvM Block Type	Compatible
Native	Yes
Redundant	Yes
Data Set	Yes

11 - ES006A_NvM_Design_PeerReviewChkList

Nexteer_Template_V1.0

Overview

Peer Review Instructions
Technical Review Checklist
Template Change Log

Sheet 1: Peer Review Instructions

Instructions for Functional Design Package Peer Review

PRE-MEETING
	Function Owner	Confirm that requirements are reviewed and approved PRIOR to the FDP peer review
	Function Owner	Start with latest version of the template for any "first reviews" - Continue to use existing temmplate for re-reviews
	Function Owner	Provide the functional design package (changed documents) to the invited attendees 1-2 working days in advance of review
	Function Owner	Notify the assigned peer reviewer and make sure they are prepared to do their function in the meeting
	Function Owner	Identify necessary attendance and invite to meeting
	Function Owner	Complete the "Author" column information for sections 1 through 5 prior to the review
	Function Owner	Complete the attendance invitation list in section 7
	Function Owner	For Re-reviews only: Complete the column "remarks by author" to identify actions taken to address items found in earlier reviews.

DURING MEETING
	Function Owner	Present document changes to the review team
	Peer Reviewer	Capture attendance of the review
	Peer Reviewer	Capture actions and issues in section 6. Identify issue summary, Document type, Reference (Requirement ID, section number, etc), Defect Type and indicate status as "OPEN"

POST MEETING
	Function Owner	Follow up on all "open" items. Update "Summary of Resolution" to indicate what was done or decided.
	Function Owner	Schedule follow up review OR review open items with peer reviewer and obtain agreement to close
	Peer Reviewer	Close change request in system and confirm all associated tasks are complete. Upload peer review checklist (this document) with any FDP updates

Sheet 2: Technical Review Checklist

Technical Review Checklist - Template Version 02.02.00

Product Name

Electric Power Steering

Electrical Arch.

Review Scope

Defect Type

Numbers

Yes

Closed

Function ID

ES006A_NvM

Change Control #: EA4#7778
Description: Cleanup of the design

Requirement

Rejected

FDD

Long Name

Non-Volatile Memory Management

Interface

Open

Model

Version that you started from. NOT the version you hope to release. If this will be v1.0.0, enter NA. Starting Baseline

01.00.00

Effort

Design

FMEA

Author

Kevin Smith

Review Effort(Hrs.)

2.00

Standards

*.m File

Corr+Verf effort(Hrs.)

Documentation

Cal Process

Total Effort (Hrs.)

2.00

Others

Total

Checklist No.

Description of Check

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status

Section 1: Data Dictionary

Is Filename of Data Dictionary in correct format?

Yes

Closed

Is the FDD.Version property correctly updated?

Yes

Closed

Is the Data Dictionary Verification report error free?

Naming conventions by Vector code does not match Nexteer's conventions

Closed

Does FDD Long Name, Short Name, and Description match requirements?

Naming conventions by Vector code does not match Nexteer's conventions

Closed

Are all runnables defined?

Yes

Closed

Do runnables have the correct time step?

Yes

Closed

Do server runnables correctly define arguments?

Yes

Closed

Are all clients defined?

Yes

Closed

Do client definitions match the corresponding server runnable?

Yes

Closed

Does name and metadata of every signal match its corresponding interface signal?

Yes

Closed

Do output signal ranges match requirements (check DOOR min/max attributes too)?

Yes

Closed

Are calibration tables named correctly (e.g. AssiX and AssiY)?

Closed

Are all data types represented by released Data_Management classes?

Submitted to Price L. for addition

Closed

Do all calibrations have correct values for all metadata?

Yes

Closed

Is NVM defined in the appropriate number of blocks?

Closed

Are constants defined with proper scope (local vs global)?

Yes

Closed

Are all dependent constants and calibrations included in one file?

Yes

Closed

Does FDD.DesignASIL match requirements?

Yes

Closed

Section 2: Model

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status

Is filename of model in correct format?

Closed

Is Top level of model annotated with Requirements Baseline?

Closed

Is the Top level of the model annotated with Tool Dependencies?

Closed

Is Top level of model annotated with Change Log or History?

Closed

Is the 2nd level of model free from subsystems that are not Function-Call Subsystems?

Closed

Is the 2nd level of model free from arithmetic and logic operations?

Closed

Are the Runnable trigger signals named as "call_<Runnable>"?

Closed

Does 2nd level of model have a properly updated annotation with name, description, and intended baseline number?

Closed

Are all data flow layers free of Function-Call Subsystems and Memory Store blocks?

Closed

Does the Model have the confidentiality and copyright information inside all its Subsystems?

Closed

Are all the Memory Store blocks for PIM and Display Variables located on the 2nd level of model?

Closed

Is each diagnostic (NTC) capable of being set to "PASS"?

Closed

Does non-zero intialization of PIM occur in the function's Init runnable?

Closed

Does design properly include Set Ram Block Status when NVM RAM values change?

Closed

Does model include appropriate logic for dealing with missing or corrupted NVM data?

Closed

Does model execute without errors/warnings after loading NxtrMBDConfig configuration set?

Closed

Section 3: Requirements Linking

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status

Are all requirements links of the format <FDDNumber>_<ObjectID>?

Closed

Does requirements HTML report reference only the DOORS module of this component for all links in the design?

Closed

Are linked blocks linked to the correct requirements(s)? (watch for problems due to copy/pasted blocks)

Closed

Is the list of unlinked blocks acceptable?

Closed

Section 4: Model Advisor

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status

Was Model Advisor run with the correct configuration settings?

Closed

Is the Model Advisor rerport free from "Fails".

Closed

Are Model Advisor report "Warnings" acceptable?

Closed

Section 5: Delivery Package

Author: This column is for Self review. Author shall fill Yes/No/NA against each point in checklist. Author

Author: This column is for reviewer. Reviewer shall fill Yes/No/NA against each point in checklist. Reviewer

Author: Detailed Description of the finding shall be provided by the reviewer. Description of finding by reviewer

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status

Does Design folder contain only the model, data dictionary, and (optionally) a simulation setup script?

Closed

Does Doc folder contain a zipped HTML webview model?

Closed

Was webview model created without requirements highlighted?

Closed

Does Reports folder contain only the data dictionary verification report, Model Advisor report, and zipped requirements traceability report?

Closed

Section 6: Other Issus/Actions Identified

Document

Reference

Summary of resolution

Author: Defect type to be selected. Defect Type

Author: What action is taken to fix the comment & other remarks need to be filled by author. Remarks By Author

Author: Data in this column shall be filled by reviewer after checking whether the rework is completed. Status

4.1

4.2

4.3

4.4

4.5

4.6

4.7

4.8

4.9

4.10

4.11

4.12

4.13

4.14

4.15

4.16

4.17

4.18

4.19

4.20

4.21

4.22

4.23

4.24

4.25

Section 7: APPROVALS

Role

First Review

Date

Attendance

Approval?

Function Owner*

Kevin Smith

10/7/2016

Yes

Peer Reviewer*

Jared Julien

Yes

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Second Review (if required)

Date

Attendance

Approval?

Function Owner*

Peer Reviewer*

<Name>

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Third Review (if required)

Date

Attendance

Approval?

Function Owner*

Peer Reviewer*

<Name>

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Fourth Review (if required)

Date

Attendance

Approval?

Function Owner*

Peer Reviewer*

<Name>

Safety

Software

ESG / Systems

EPDT / CSE

Hardware

Test

Role

Add more if necessary

Date

Attendance

Approval?

P.S.:

Yes indicates adherence

No indicates non-adherence, reviewer shall provide suitable comments at the end of this document for each point.

NA indicates not applicable

Sheet 3: Template Change Log

Rev	Change	Author
01.00.05	Added lesson learned #3.5	MDK
01.00.06	Added lesson learned #3.6, 3.7 - Structure and writing of NVM in mfiles and models.	MDK
02.00.00	Combined ESG and Systems into one, compatible with Data_Management 2.13.0 of CreateDD and VerifyDD.	K. Derry
02.01.00	Added: Does FDD.DesignASIL match requirements? Added: Was webview model created without requirements highlighted? Removed: Redundant row in Data Dictionary section. Formatting: Column C now consistently center-justified.	K. Derry
02.02.00	Added: Are all data types represented by released Data_Management classes? Removed: Are all runnables defined? Rationale: Automated tools checking. Removed: Does the Component shortname match data dictionary FDD metadata? Removed: "Data store name must resolve to Simulink signal object" Edited: Model Advisor report should now be left unzipped.	K. Derry

12 - ES006A_NvM_FDD

Non Volatile RAM Manager And

Non Volatile RAM Manager Proxy

FDD #ES-006A

Contents

1. High Level Description 4

2. Derived Requirements 4

3. Sub-Function Data Flow 4

4. Design Rationale 5

5. Components 6

5.1. NvM: Non Volatile Memory (AUTOSAR BSW) 6

5.1.1. BSW Configuration 6

5.1.1.1. NvMCommon 6

5.1.2. Periodic Functions 7

5.1.2.1. NvM_MainFunction 7

5.1.2.1.1. Function Definition 7

5.1.3. Service Sub-Functions 8

5.1.3.1. API Configuration Class 1 9

5.1.3.1.1. Sub-Function: NvM_Init 9

5.1.3.1.2. Sub-Function: NvM_ReadAll 10

5.1.3.1.3. Sub-Function: NvM_WriteAll 11

5.1.3.1.4. Sub-Function: NvM_GetErrorStatus 12

5.1.3.1.5. Sub-Function: NvM_SetRamBlockStatus 13

5.1.3.1.6. Sub-Function: NvM_CancelWriteAll 14

5.1.3.2. API Configuration Class 2 15

5.1.3.2.1. Sub-Function: NvM_SetDataIndex 15

5.1.3.2.2. Sub-Function: NvM_GetDataIndex 16

5.1.3.2.3. Sub-Function: NvM_ReadBlock 17

5.1.3.2.4. Sub-Function: NvM_WriteBlock 18

5.1.3.2.5. Sub-Function: NvM_RestoreBlockDefaults 19

5.1.3.2.6. Sub-Function: NvM_CancelJobs 20

5.1.3.3. API Configuration Class 3 21

5.1.3.3.1. Sub-Function: NvM_SetBlockProtection 21

5.1.3.3.2. Sub-Function: NvM_EraseNvBlock 22

5.1.3.3.3. Sub-Function: NvM_InvalidateNvBlock 23

5.1.4. Type Definitions 24

5.1.4.1. Std_ReturnType 24

5.1.4.2. NvM_RequestResultType 24

5.1.4.3. NvM_BlockIdType 25

5.2. NvM_Proxy: Non Volatile Memory Proxy (Nexteer CDD) 26

5.2.1. Design Rationale 26

5.2.2. Sub-Functions 26

5.2.2.1. Sub-Function: NvMProxy_Init 26

5.2.2.1.1. Hardware Related Design 26

5.2.2.1.2. Software Related Design 26

6. Timing / Execution Constraints 27

6.1. Rationale / Comments 27

6.2. Rates and State Execution: NvM 27

6.3. Rates and State Execution: NvMProxy 28

7. Serial Communications Interfaces 28

8. Additional Information 29

8.1. NvM block definition Considerations 29

8.1.1. Scenario 1 29

8.1.2. Scenario 2 29

8.2. Software Component Design Considerations 30

8.2.1. API Port Selection 30

9. Revision Record & Change Approval 31

High Level Description

This design document describes the functionality, API, and the configuration of the AUTOSAR basic software (BSW) module NVRAM Manager (NvM) and the NvM Proxy (NvMProxy).

The NvM provides services to ensure the data storage and maintenance of NV (non-volatile) data. The NvM module is able to administrate the NV data for an EEPROM and/or a Flash EEPROM Emulation (FEE) device.

The NvMProxy provides an interface for software components outside of the application of the NvM to communicate with the NvM component.

Derived Requirements

None

Sub-Function Data Flow

None

Design Rationale

The NvM and NvMProxy components are integrated below the application layer in the basic software layer of the AUTOSAR model.

NvMProxy was designed so that all software components can send their NvM requests to the proxy interface, which will communicate the request to the NvM and report the results back to the calling component. This simplifies the design of software components by only requiring one interface for defining NvM needs and providing the needed functionality to switch the OS context in the event the calling application is different than the application NvM is integrated.

Components

The following sections describe the NvM and NvM proxy components.

NvM: Non Volatile Memory (AUTOSAR BSW)

BSW Configuration

NvMCommon

Configuration Parameter	Value	Rationale
API Configuration Class	MVM_API_CONFIG_CLASS_3	Class 3 shall be used to provide all API options to software components. This is to prevent rework of existing components if use cases change and require API functions that may not have been available during component development under a different API class.
Compiled Configuration Id	1	Version of the NV memory layout, always shall start at 1 and be revised if the memory layout changes
Crc Number of Bytes	64	Dummy value, not used.
Dataset Selection Bits	1	Shall be set to 1 if the only block types are “native” and “redundant.” If a dataset is required, then the number needs to be set satisfy the following equation: 2^(Selection Bits) >= max(dataset) For example, if the largest dataset for all configured blocks was 30, the selection bits are required to be set to 5. 2^5 = 32 >= 30
Development Error Detection	FALSE	Only should be true for early development. Shall not be used in production level software
Drivers Mode Switch	True	Disables processing of background sector switching from startup and shutdown events.
Dynamic Configuration Handling	True	Allows for adapting new FEE layouts over existing layouts. See section 5.1.3.2.2 for details on the impact of this setting.
Job Prioritization	False	No requirement for prioritization of any blocks
Maximum Number of Write Retries	3	Default setting
Multi Block Callback	NvMProxy_MultiBlkCallBack
Multi block Job Status Information	False
Polling Mode	True	Enabled to provide the application the ability to poll the status of the asynchronous request.
Repeat Mirror Operations	0	Default setting
SetRamBlockStatus API	True	Applications shall use SetRamBlockStatus API to indicate their RAM shadows have updated.
Size Of Immediate Status Information	N/A	Not used
Size Of Standard Job Queue	8	Default setting
Version Information API	False	N/A

Periodic Functions

NvM_MainFunction

This function has to be called cyclically. It is the entry point for the NvM component. In this function processing of all asynchronous jobs are handled (read/write/erase/invalidate/CRC calculation).

Function Definition

Prototype
void NvM_MainFunction ( void )
Parameter
N/A
Return Code
N/A

Service Sub-Functions

The value of the API configuration class determines which API server ports are available to the system. The image below shows the breakdown of the functionality for each API Configuration Class.

In the following sub sections, the APIs are defined for application software components (SWCs) and BSW components. The application function definition shall be used for components that sit above the RTE layer in the AUTOSAR model. The RTE generator will absorb some of the dynamic arguments, such as BlockId, and create a macro with the proper definition for the software component. Complex device drivers and other BSWs that sit below the RTE layer shall use the CDD function definition.

API Configuration Class 1

The following sections contain a description of the functions provided by the AUTOSAR NvM basic software component with API Configuration Class 1 configured.

Sub-Function: NvM_Init

None

Function Particularities
Request Type	Synchronous
Re-entrant	Yes
Expected Caller Context	Shall only be called from ECU state manager or equivalent function.

Before the NvM component can be used, it has to be initialized. Depending on the program the NvM is integrated, the BSWs from lower levels shall be initialized prior to the NvM. The table below is an example of this strategy for Fee and Ea use cases for initialize modules from the low level components up to the NvM.

	Fee	Ea
Low level driver	Fls	SPI/EEP
Device Abstraction	FEE	EA
Non-Volatile Manager	NvM

The NvM AUTOSAR component compliant with ASIL-D standards, NvM_Init shall be called as a trusted function. This will allow the NvM_Init function access to all the permanent RAM shadows defined in software, regardless of their ASIL rating. This reduces the RAM and throughput during start up to move data from application to another.

Application Function Definition

None

CDD Function Definition

Prototype
void NvM_Init ( void )
Parameter
N/A
Return Code
N/A

Sub-Function: NvM_ReadAll

None

Function Particularities
Request Type	Asynchronous
Re-entrant	No
Expected Caller Context	Shall only be called from ECU state manager or equivalent function.

This function shall only be called after NvM_Init has been executed. The request loads all the RAM blocks that have the option NVM_SELECT_BLOCK_FOR_READALL selected.

Note: Non-permanent blocks and data set blocks are skipped during execution of this function and must be loaded manually by calling NvM_ReadBlock().

During the execution of NvM_ReadAll(), the value in the configuration ID (block 1) is compared with the compiled ID version in the NvM settings. With the Dynamic Configuration Handling option set to True, any NvM blocks with the option Resistant to Changed Software enabled will be processed and loaded into RAM as if the configuration IDs matched. If the option Resistant to Changed Software is not enabled, the blocks will be treated is if they were invalid or blank.

Application Function Definition

None

CDD Function Definition

Prototype
void NvM_ReadAll ( void )
Parameter
N/A
Return Code
N/A

Sub-Function: NvM_WriteAll

None

Function Particularities
Request Type	Asynchronous
Re-entrant	No
Expected Caller Context	Shall only be called from ECU state manager or equivalent function.

Request to write all blocks with RAM data that has been changed and have the option NVM_SELECT_BLOCK_FOR_WRITEALL selected.

Note: Non-permanent blocks and data set blocks are skipped during execution of this function and must be written manually by calling NvM_WriteBlock().

Application Function Definition

None

CDD Function Definition

Prototype
void NvM_WriteAll ( void )
Parameter
N/A
Return Code
N/A

Sub-Function: NvM_GetErrorStatus

None

Function Particularities
Request Type	Synchronous
Re-entrant	Yes
Expected Caller Context	Application

The request reads the block dependent status/error information and writes it to the given address. The status/error information was set by a former or current asynchronous request. This API can also be requested with the block id 0 (multi block). The multi block status/error information are only set by NvM_ReadAll() and NvM_WriteAll() requests.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_GetErrorStatus (uint8* RequestResultPtr )
Parameter
RequestResultPtr – Pointer were the result shall be written. See section 5.1.4.2 for details on return values.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_GetErrorStatus ( NvMBlockIdType BlockId, uint8* RequestResultPtr )
Parameter
BlockId – The block identifier
RequestResultPtr – Pointer were the result shall be written. See section 5.1.4.2 for details on return values.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_SetRamBlockStatus

None

Request Type

Synchronous (If NVM_CALC_RAM_BLOCK_CRC is False)

Asynchronous (If NVM_CALC_RAM_BLOCK_CRC is True)

Re-entrant

Yes

Expected Caller Context

Application

The request sets a block’s status to valid/changed and also to unchanged. Setting a block to valid/changed will mark it for writing during NvM_WriteAll(). If a block has the CRC option NVM_CALC_RAM_BLOCK_CRC set to True, the CRC calculation of the RAM is initialed as a background task.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_SetRamBlockStatus (Boolean BlockChanged )
Parameter
BlockChanged – TRUE: Validates the RAM block and marks it as changed. FALSE: Mark the block as unchanged
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_SetRamBlockStatus ( NvMBlockIdType BlockId, Boolean BlockChanged )
Parameter
BlockId – The block identifier
BlockChanged – TRUE: Validates the RAM block and marks it as changed. FALSE: Mark the block as unchanged
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_CancelWriteAll

None

Function Particularities
Request Type	Asynchronous
Re-entrant	No
Expected Caller Context	Shall only be called from ECU state manager or equivalent function.

Request to cancel a running NvM_WriteAll() request.

Application Function Definition

None

CDD Function Definition

Prototype
void NvM_CancelWriteAll ( void )
Parameter
None
Return Code
None

API Configuration Class 2

The following sections contain a description of the functions provided by the AUTOSAR NvM basic software component with API Configuration Class 2 configured.

Sub-Function: NvM_SetDataIndex

None

Function Particularities
Request Type	Synchronous
Re-entrant	Yes
Expected Caller Context	Application

The request sets the specified index to associate a dataset NV block (with or without ROM blocks) with its corresponding RAM block. The DataIndex needs to have a valid value before read, write, erase or invalidate requests are initiated.

If the dataset block has a set of ROM defaults, the function is used to select the appropriate ROM set (prior to NvM_ReadBlock()).

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_SetDataIndex (uint8 DataIndex )
Parameter
DataIndex – Index position of a block in the NV block Dataset type
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_SetDataIndex ( NvMBlockIdType BlockId, uint8 DataIndex )
Parameter
BlockId – The block identifier
DataIndex – Index position of a block in the NV block Dataset type
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_GetDataIndex

None

Function Particularities
Request Type	Synchronous
Re-entrant	Yes
Expected Caller Context	Application

The request passes the current DataIndex of the specified dataset block.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_GetDataIndex (uint8* DataIndexPtr )
Parameter
DataIndexPtr – Address where the current DataIndex shall be written to
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_GetDataIndex ( NvMBlockIdType BlockId, uint8* DataIndexPtr )
Parameter
BlockId – The block identifier
DataIndexPtr – Address where the current DataIndex shall be written to
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_ReadBlock

None

Function Particularities
Request Type	Asynchronous
Re-entrant	Yes
Expected Caller Context	Application

Request to copy the data of the NV block to its corresponding RAM block. This function queues the read request and returns the acceptance result synchronously.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_ReadBlock (uint8* NvM_DstPtr )
Parameter
NvM_DstPtr – Pointer where the data of a non-permanent RAM block shall be written to. If the block is permanent NULL_PTR shall be passed.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_ReadBlock ( NvMBlockIdType BlockId, uint8* NvM_DstPtr)
Parameter
BlockId – The block identifier
NvM_DstPtr – Pointer where the data of a non-permanent RAM block shall be written to. If the block is permanent NULL_PTR shall be passed.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_WriteBlock

None

Function Particularities
Request Type	Asynchronous
Re-entrant	Yes
Expected Caller Context	Application

Request for copying data from the RAM block to its corresponding NV block. This function queues the write request and returns the acceptance result synchronously.

If the block has a CRC, the RAM block CRC will be recalculated before the data and the CRC are written to the NV memory, even if the service NvM_SetRamBlockStatus() was called before and the configuration was set that within this service, the CRC calculation should be done.

If writing the data to NV memory fails, the NVM will retry writing. The number of write retries is a configuration option.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_WriteBlock (const uint8* NvM_SrcPtr )
Parameter
NvM_SrcPtr – Pointer where the data of a non-permanent RAM block shall be read from. If the block is permanent, NULL_PTR shall be passed.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_WriteBlock ( NvMBlockIdType BlockId, const uint8* NvM_SrcPtr)
Parameter
BlockId – The block identifier
NvM_SrcPtr – Pointer where the data of a non-permanent RAM block shall be read from. If the block is permanent, NULL_PTR shall be passed.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_RestoreBlockDefaults

None

Function Particularities
Request Type	Asynchronous
Re-entrant	Yes
Expected Caller Context	Application

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_RestoreBlockDefaults (uint8* NvM_DstPtr )
Parameter
NvM_DstPtr – Pointer where the data of a non-permanent RAM block shall be written to. If the block is permanent, NULL_PTR shall be passed.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_RestoreBlockDefaults ( NvMBlockIdType BlockId, uint8* NvM_DstPtr)
Parameter
BlockId – The block identifier
NvM_DstPtr – Pointer where the data of a non-permanent RAM block shall be written to. If the block is permanent, NULL_PTR shall be passed.
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_CancelJobs

None

Function Particularities
Request Type	Asynchronous
Re-entrant	Yes
Expected Caller Context	Application

Request to cancel pending job for a NV block.

Application Function Definition

None

CDD Function Definition

Prototype
Std_ReturnType NvM_CancelJobs ( NvMBlockIdType BlockId )
Parameter
BlockId – The block identifier
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

API Configuration Class 3

The following sections contain a description of the functions provided by the AUTOSAR NvM basic software component with API Configuration Class 3 configured.

Sub-Function: NvM_SetBlockProtection

None

Function Particularities
Request Type	Synchronous
Re-entrant	Yes
Expected Caller Context	Application

The request sets the write protection for the NV block. Any further write, erase, and invalidate requests to the NVRAM block is rejected synchronously if the NV block-write protection is set. The data area of the RAM block remains writeable in any case.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_SetBlockProtection ( Boolean ProtectionEnabled )
Parameter
ProtectionEnabled – True: Enable protection. False: Disable protection
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_ SetBlockProtection ( NvMBlockIdType BlockId, Boolean ProtectionEnabled )
Parameter
BlockId – The block identifier
ProtectionEnabled – True: Enable protection. False: Disable protection
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_EraseNvBlock

None

Function Particularities
Request Type	Asynchronous
Re-entrant	Yes
Expected Caller Context	Application

Request to erase the specified NV block. This function queues the erase request and returns the acceptance result synchronously. The NvM can notify the application by callback when the service is finished. This function performs the same action as NvM_InvalidateNvBlock for FEE.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_EraseNvBlock ( void )
Parameter
None
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_EraseNvBlock ( NvMBlockIdType BlockId )
Parameter
BlockId – The block identifier
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Sub-Function: NvM_InvalidateNvBlock

None

Function Particularities
Request Type	Asynchronous
Re-entrant	Yes
Expected Caller Context	Application

Request to invalidate the specified NV block. This function queues the erase request and returns the acceptance result synchronously. The NvM can notify the application by callback when the service is finished.

Application Function Definition

Prototype
Std_ReturnType Rte_Call_<SWCSvcPortName>_InvalidateNvBlock ( void )
Parameter
None
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

CDD Function Definition

Prototype
Std_ReturnType NvM_InvalidateNvBlock ( NvMBlockIdType BlockId )
Parameter
BlockId – The block identifier
Return Code
Std_ReturnType – See section 5.1.4.1 definition of this return type

Type Definitions

The following section outlines the data types used by the NvM component.

Std_ReturnType

uint8

Standard return type for functions

NVM_REQ_OK (0)

The last request has been accepted

NVM_REQ_NOT_OK (1)

The last request has not been accepted

NvM_RequestResultType

C-Type	Description	Value Range
uint8	An asynchronous API service can have the following results or status that can be polled by NvM_GetErrorStatus	NVM_REQ_OK (0) The last request has finished successfully.
		NVM_REQ_NOT_OK (1) The last request has finished unsuccessfully
		NVM_REQ_PENDING (2) The last request is currently being processed
		NVM_REQ_INTEGRITY_FAILED (3) A NV block with data corruption caused by a CRC mismatch or FEE or EA components reported an inconsistency
		NVM_REQ_BLOCK_SKIPPED (4) The block was skipped during a multi-block request (ReadAll or WriteAll requests)
		NVM_REQ_NV_INVALIDATED (5) The block is marked as invalid
		NVM_REQ_CANCELLED (6)

NvM_BlockIdType

uint16

It is the type of a block handle that is used by the application in order to access a NVM block. There are two reserved IDs:

Block ID 0 for multi block requests (Block ID 0 is only allowed for API NvM_GetErrorStatus())
Block ID 1 for the configuration Id block.

The block handles are created as defines in an ascending define list.

0..(2^(16 - Dataset Selection Bits) – 1)

Dataset Selection Bits is the maximum number of bits that are needed in order to store the maximum dataset value as is configured by the software integration team.

Following the example from section 5.1.1.1 where Dataset Selection Bits was equal to 5, the max number of block handles would be 2^(16-5)-1=2047

NvM_Proxy: Non Volatile Memory Proxy (Nexteer CDD)

Design Rationale

The NvM_Proxy provides and interface to the NvM for all software components. The interface shall consist of the API modules defined in the previous sections for the AUTOSAR NvM component with the prefix of NvMProxy instead of NvM.

If the calling component is in the same ASIL application as the NvM, the proxy shall just forward the request on directly. If the component is not in the same ASIL application as the NvM, the proxy shall call a nontrusted function to switch the OS context to the application of the NvM and then call the desired function.

The NvMProxy component shall also be responsible for settings NTC 0x06, 0x07, 0x08 and 0x0A when a block that is invalid by not being written or when the CRC check fails if one is applied to the block. This check shall be done during the initialization routine of the NvMProxy component.

NvMProxy shall also store all RAM status flags during shutdown to RAM, so they can be restored during a quick ignition cycle. The restoration shall take place if the NvM_WriteAll is completed, canceled or killed by the BswM.

Sub-Functions

Sub-Function: NvMProxy_Init

None

Function Particularities
Request Type	Synchronous
Re-entrant	Yes
Expected Caller Context	Shall only be called from ECU state manager or equivalent function.

Before the NvMProxy component can be used, it has to be initialized. This call also must be performed after the NvM_ReadAll() has finished executing to properly diagnose all NvM blocks for any data corruption.

Timing / Execution Constraints

Rationale / Comments

Rates and State Execution: NvM

In the following table, functions marked with 0ms run rate are function calls that can be called from the states indicated by “Execute.”

Sub-Function Name	Rate (ms)	Cold Init	Warm Init	Operate	Disable
NvM_Init	0	Execute	Do Not Execute	Do Not Execute	Do Not Execute
NvM_MainFunction	10	Execute*	Execute	Execute	Execute
NvM_ReadAll	0	Execute*	Do Not Execute	Do Not Execute	Do Not Execute
NvM_WriteAll	0	Do Not Execute	Do Not Execute	Do Not Execute	Execute
NvM_GetErrorStatus	0	Execute**	Execute	Execute	Execute
NvM_SetRamBlockStatus	0	Execute**	Execute	Execute	Execute
NvM_CancelWriteAll	0	Do Not Execute	Do Not Execute	Do Not Execute	Execute
NvM_SetDataIndex	0	Execute**	Execute	Execute	Execute
NvM_GetDataIndex	0	Execute**	Execute	Execute	Execute
NvM_ReadBlock	0	Execute**	Execute	Execute	Execute
NvM_WriteBlock	0	Execute**	Execute	Execute	Execute
NvM_RestoreBlockDefaults	0	Execute**	Execute	Execute	Execute
NvM_CancelJobs	0	Execute**	Execute	Execute	Execute
NvM_SetBlockProtection	0	Execute**	Execute	Execute	Execute
NvM_EraseNvBlock	0	Execute**	Execute	Execute	Execute
NvM_InvalidateNvBlock	0	Execute**	Execute	Execute	Execute
* Execution is allowed, but only after NvM_Init() has completed. ** Execution is allowed, but only after NvM_ReadAll() has completed.

Rates and State Execution: NvMProxy

In the following table, functions marked with 0ms run rate are function calls that can be called from the states indicated by “Execute.”

Sub-Function Name	Rate (ms)	Cold Init	Warm Init	Operate	Disable
NvMProxy_Init	0	Execute**	Do Not Execute	Do Not Execute	Do Not Execute
NvMProxy_GetErrorStatus	0	Execute*	Execute	Execute	Execute
NvMProxy_SetRamBlockStatus	0	Execute*	Execute	Execute	Execute
NvMProxy_CancelWriteAll	0	Do Not Execute	Do Not Execute	Do Not Execute	Execute
NvMProxy_SetDataIndex	0	Execute*	Execute	Execute	Execute
NvMProxy_GetDataIndex	0	Execute*	Execute	Execute	Execute
NvMProxy_ReadBlock	0	Execute*	Execute	Execute	Execute
NvMProxy_WriteBlock	0	Execute*	Execute	Execute	Execute
NvMProxy_RestoreBlockDefaults	0	Execute*	Execute	Execute	Execute
NvMProxy_CancelJobs	0	Execute*	Execute	Execute	Execute
NvMProxy_SetBlockProtection	0	Execute*	Execute	Execute	Execute
NvMProxy_EraseNvBlock	0	Execute*	Execute	Execute	Execute
NvMProxy_InvalidateNvBlock	0	Execute*	Execute	Execute	Execute
* Execution is allowed, but only after NvMProxy_Init() has completed. ** Execution is allowed, but only after NvM_ReadAll() has completed.

Serial Communications Interfaces

None

Additional Information

NvM block definition Considerations

NvM block can be made from a single value to multiple values grouped as one element. It is up to the function designer to determine how their NvM blocks should be structured, but the following considerations should be considered when defining an NvM block.

Scenario 1

Consider a design with 3 PIMs defined for storage in NvM. If the PIMs were defined in the m-files as separate entries, the software component developer would create three separate NvM blocks for those pieces of data as shown below.

This would mean that each PIM, is independent of the other PIMs, however, it is a waste of FEE memory if the data does not truly need to be independent. Instead the three values should be grouped into a structure so the NvM block created looks like below.

This provides the designer with the same design (three separate variables) but the data is grouped together to make one CRC to cover all three values and only requires one instance of the FEE header saving FEE space.

Scenario 2

Consider a design with 3 PIMs, 2 of the PIMs are written during manufacturing and the other PIM is learned during function execution and saved at shutdown. In this case, it would make sense to group the PIMs by functionality.

This saves FEE space by grouping like content, but also protects the data that is written during manufacturing from being discarded in case the data that is written during shutdown encountered a power loss or other type of data corruption. Only the learned data would be considered invalid and the other block would be valid.

Software Component Design Considerations

API Port Selection

The NvM component will generate different API ports depending on the configuration required a given block. It shall be up to the developer of the software component to configure the service port with the correct API during development to ensure a proper match with the integration project.

Based on the settings in section 5.1.1, the API port will begin with “NvMService_AC3_SRBS”. This is because the API class is level 3 (AC3) and the set ram block status API is enable (SRBS).

The following table is for all API access except for NvM_ SetBlockProtection.

Configuration Matrix				Suffix	Port Name to Use in SWC
Block Type			ROM Default
Native	Redundant	Dataset	ROM Default
Y	N	N	N	N/A	NvMService_AC3_SRBS
Y	N	N	Y	_Defs	NvMService_AC3_SRBS_Defs
N	Y	N	N	N/A	NvMService_AC3_SRBS
N	Y	N	Y	_Defs	NvMService_AC3_SRBS_Defs
N	N	Y	N	_DS	NvMService_AC3_SRBS_DS
N	N	Y	Y	_DS_Defs	NvMService_AC3_SRBS_DS_Defs

The following table is only for API to NvM_ SetBlockProtection.

Configuration Matrix				Suffix	Port Name to Use in SWC
Block Type			ROM Default
Native	Redundant	Dataset	ROM Default
Y	N	N	N	N/A	NvMAdministration
Y	N	N	Y
N	Y	N	N
N	Y	N	Y
N	N	Y	N
N	N	Y	Y

Revision Record & Change Approval

Rev	Date	Change Control #	Drw	Change Description
01.00.00	01Sep15	EA4#471	KJS	Initial Release
02.00.00	01Oct16	EA4#7778	KJS	Updates for quick ignition cycle handling

Component Design

Component Design

Module Detailled Design

Component Documentation

1 - EraseBlock

Contents

Erase Block

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

2 - GetDataIndex

Contents

Get Data Index

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

3 - GetErrorStatus

Contents

Get Error Status

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

4 - InvalidateBlock

Contents

Invalidate Block

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

5 - ReadBlock

Contents

Read Block

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

6 - RestoreBlockDefaults

Contents

Restore Block Defaults

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

7 - SetBlockProtection

Contents

Set Block Protection

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

8 - SetDataIndex

Contents

Set Data Index

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

9 - SetRamBlockStatus

Contents

Set Ram Block Status

Description

Port Description

Mask Description

NvM Block Compatibility

See Also

10 - WriteBlock

Contents

Write Block

Description