StHlthSigStc_MDD

Module Design Document

For

State of Health Signal Statistics

Sep 27, 2016

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Software Group,

Nexteer Automotive,

Saginaw, MI, USAChange History

Table of Contents

1 StHlthSignStc High-Level Description 5

2 Design details of software module 6

Graphical representation of StHlthSigStc 6

Data Flow Diagram 6

2.1.1 Component level DFD 6

2.1.2 Function level DFD 6

3 Variable Data Dictionary 7

3.1 User defined typedef definition/declaration 7

3.2 Variable definition for enumerated types 7

4 Constant Data Dictionary 8

Program (fixed) Constants 8

4.1.1 Embedded Constants 8

4.1.1.2 Global 8

4.1.2 Module specific Lookup Tables Constants 8

5 Software Module Implementation 9

5.1 Sub-Module Functions 9

5.1.1 Initialization Functions: StHlthSigStcInit1 9

5.1.2 PERIODIC FUNCTIONS 9

5.1.3 Interrupt Functions 9

5.1.4 Server Runnable Functions 9

5.1.4.1 ClrSigStcHlthData_Oper 9

5.1.4.2 GetSigStcHlthData_Oper 9

5.1.4.3 StHlthStcPwrDwn_Oper 9

5.1.4.4 UpdStHlthStcData_Oper 9

5.1.5 Module Internal (Local) Functions 9

5.1.5.1 Local Function #1 9

5.1.5.1.1 Description 9

5.1.5.2 Local Function #2 9

5.1.5.2.1 Description 10

5.1.5.3 Local Function #3 10

5.1.5.3.1 Description 10

5.1.5.4 Local Function #4 10

5.1.5.4.1 Description 10

5.1.6 Transition Functions 10

5.1.7 Global Function/Macro Definitions 10

5.1.7.1 Global Function #1 10

5.1.7.1.1 Description 10

5.1.7.2 Global Function #2 11

5.1.7.2.1 Description 11

5.1.7.3 Global Function #3 11

5.1.7.3.1 Description 11

6 Known Limitations with Design 12

7 UNIT TEST CONSIDERATION 13

Appendix A Abbreviations and Acronyms 14

Appendix B Glossary 15

Appendix C References 16

StHlthSignStc High-Level Description

This component shall collect State of Health data signals from other component(s) and shall compute following statistical values for each signal: Minimum, Maximum, Average and Life Cycle Sample counter. This component shall provide statistical data for ignition cycle and for life cycle for each signal upon request.

Design details of software module

See FDD.

Graphical representation of StHlthSigStc

Data Flow Diagram

See FDD.

Component level DFD

See FDD.

Function level DFD

See FDD.

Variable Data Dictionary

User defined typedef definition/declaration

<This section documents any user types uniquely used for the module.>

Ary1D_u8_StHlthSigStc1 – Typedef for Ram buffer where State of Health Statistical data is kept for the current Ignition cycle. Size of this array is configurable.

Ary1D_u32_ StHlthSigStc1 – Typedef for Ignition cycle sample counter. Size of this array is configurable.

Variable definition for enumerated types

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

* Also see see FDD ES106A_StHlthSigStc_DataDict.m file

Global

<This section lists the global constants used by the module. For details on global constants, refer to the Data Dictionary for the application>

Module specific Lookup Tables Constants

<(This is for lookup tables (arrays) with fixed values, same name as other tables)>

Software Module Implementation

Sub-Module Functions

None

Initialization Functions: StHlthSigStcInit1

See DataDict.m file and model. This function exists in “StHlthSigStc.c” file.

PERIODIC FUNCTIONS

None

Interrupt Functions

None

Server Runnable Functions

ClrSigStcHlthData_Oper

See DataDict.m file and model. This function exists in “StHlthSigStc.c” file.

GetSigStcHlthData_Oper

See DataDict.m file and model. This function exists in “StHlthSigStc.c” file.

StHlthStcPwrDwn_Oper

See DataDict.m file and model. This function exists in “StHlthSigStc.c” file.

UpdStHlthStcData_Oper

See DataDict.m file and model. This function exists in “StHlthSigStc.c” file.

Module Internal (Local) Functions

Local Function #1

Description

This function implements “StHlthStcPwrDwn” function in the FDD.

Local Function #2

Description

This function implements “GetSigStcHlthData” function in the FDD.

Local Function #3

Description

This function implements “Update Nvm” function in the FDD.

Local Function #4

Description

This function implements “Update Nvm” function in the FDD.

Transition Functions

None.

Global Function/Macro Definitions

Global Function #1

Description

Implements Nontrusted function wrapper for UpdDataSample. This will be called from UpdStHlthStcData_Oper upon client invocation.

Global Function #2

Description

Implements Nontrusted function wrapper for UpdNvmPim. This will be called from StHlthStcPwrDwn_Oper upon client invocation.

Global Function #3

Description

Implements Nontrusted function wrapper for UpdNvmPim. This will be called from ClrSigStcHlthData_Oper upon client invocation.

Known Limitations with Design

1. Following constants are not used in the implementation even though they defined in the .m file. It is only used for the purpose of model simulation.

1. SHIFTFAC16_ULS_U08

2. SHIFTFAC24_ULS_U08

3. SHIFTFAC8_ULS_U08

2. Implementation uses different name for following PIM variables that are defined in .m file:

   1. SigStcPrmInst

   2. CrcInst

UNIT TEST CONSIDERATION

Config files in the contract folder are for a test project with sample configurations for two monitored signals CtrlrTStHlth and OutpAssiStHlth.

Abbreviations and Acronyms

Glossary

Note: Terms and definitions from the source “Nexteer Automotive” take precedence over all other definitions of the same term. Terms and definitions from the source “Nexteer Automotive” are formulated from multiple sources, including the following:

• ISO 9000

• ISO/IEC 12207

• ISO/IEC 15504

• Automotive SPICE® Process Reference Model (PRM)

• Automotive SPICE® Process Assessment Model (PAM)

• ISO/IEC 15288

• ISO 26262

• IEEE Standards

• SWEBOK

• PMBOK

• Existing Nexteer Automotive documentation

References