InertiaCmpVel_MDD

Module Design Document

For

InertiaCmpVel

Jul 14, 2016

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Krishna Anne,

Nexteer Automotive,

Saginaw, MI, USA
Change History

SNoDescriptionAuthorVersionDate
1Initial VersionSB1.023-Jul-2015
2Updated to version 1.3.0 of designSB2.011-Mar-2016
3Updated to version 1.7.0 and 1.8.0 of designKK3.021-Jun-2016
4Updated to version 1.9.0 of designKK4.014-Jul-2016


Table of Contents

1 Introduction 4

1.1 Purpose 4

1.2 Scope 4

2 InertiaCmpVel & High-Level Description 5

3 Design details of software module 6

3.1 Graphical representation of InertiaCmpVel 6

3.2 Data Flow Diagram 7

3.2.1 Component level DFD 7

3.2.2 Function level DFD 7

4 Constant Data Dictionary 8

4.1 Program (fixed) Constants 8

4.1.1 Embedded Constants 8

5 Software Component Implementation 9

5.1.1 Sub-Module Functions 9

5.1.2 Interrupt Service Routines 9

5.1.3 Server Runnable Functions 9

5.1.4 Module Internal (Local) Functions 9

5.1.5 Transition Functions 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

Introduction

Purpose

Scope

InertiaCmpVel & High-Level Description

Refer FDD

Design details of software module

Graphical representation of InertiaCmpVel

Data Flow Diagram

Component level DFD

Refer FDD

Function level DFD

Refer FDD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

None

Global Constants

Refer .m file

User defined typedef definition/declaration

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

Typedef NameElement NameUser Defined Type

Legal Range

(min)

Legal Range

(max)

typedef struct FilCoeffRecb0_Uls_f32Float32FULLFULL
b1_Uls_f32Float32FULLFULL
b2_Uls_f32Float32FULLFULL
a0_Uls_f32Float32FULLFULL
a1_Uls_f32Float32FULLFULL
a2_Uls_f32Float32FULLFULL

Software Component Implementation

Sub-Module Functions

Initialization sub-module InertiaCmpVelInit1()

Design Rational:

Init function is not present in the model but in reference to the Init.txt text file Low pass filter and Notch filter are initialized.

For Low pass filter standard EA4 LPF implementation from NxtrFil.h is followed and for Notch filter initialization, EA3 implementation is followed.

Periodic sub-module InertiaCmpVelPer1()

Interrupt Service Routines

None

Server Runnable Functions

None

Module Internal (Local) Functions

Calculate Driver Velocity

Function NameDrvrVelCalcTypeMinMax
Arguments PassedHwTq_HwNwtMtr_T_f32float32-1010
MotVelCrf_MotRadPerSec_T_f32float32-13501350
VehSpd_Kph_T_f32float320511
Return ValueScadDrvrVel_MotRadPerSec_T_f32float32-13501350

Calculate ADD Coefficient

Function NameADDCoeffCalcTypeMinMax
Arguments PassedAssiCmdBas_MotNwtMtr_T_f32float32-8.88.8
WhlImbRejctnAmp_MotNwtMtr_T_f32float3208.8
VehSpd_Kph_T_f32float320511
Return ValueADDCoeffCalc_MotNwtMtrSpRad_T_f32float320.00.00007

Calculate Gain

Function NameDecelGainTypeMinMax
Arguments PassedVehLgtA_KphPerSec_T_f32float32-3535
MotVelCrf_MotRadPerSec_T_f32float32-13501350
Return ValueDecelGain_Uls_T_f32float3201

Calculate Filter Coefficients

Function NameFilCoeffCalcTypeMinMax
Arguments PassedADDCoeff_MotNwtMtrPerMotRadPerSec_T_f32float320.00.041306
WhlImbRejctnAmp_MotNwtMtr_T_f32float3208.8
VehSpd_Kph_T_f32float320511
Return Value*FilCoeff_T_Recb0_Uls_f32float32-2.741562052401790
b1_Uls_f32float320.00.330448
b2_Uls_f32float32-0.1600838624551132.41111405240179
a0_Uls_f32float320.55258853.9498924
a1_Uls_f32float32-7.9996842-4.8417266
a2_Uls_f32float324.050423410.6056849

Generate Command

Function NameGenFddIcCmdTypeMinMax
Arguments PassedScadDrvrVel_MotRadPerSec_T_f32float32-7226.6527226.652
*FilCoeff_T_Recb0_Uls_f32float32-2.741562052401790
b1_Uls_f32float320.00.330448
b2_Uls_f32float32-0.1662621330091642.41111405240179
a0_Uls_f32float320.55258853.9498924
a1_Uls_f32float32-7.9996842-4.8417266
a2_Uls_f32float324.050423410.6056849
Return ValueInertiaCmp_MotNwtMtr_T_f32Float-8.88.8

NotchCmp

Function NameNotchCmpTypeMinMax
Arguments PassedVehSpd_Kph_T_f32float320511
InertiaCmp_MotNwtMtr_T_f32float32-8.88.8
Return ValueNotchCmp _MotNwtMtr_T_f32float32-8.88.8

FilNotchFullUpdOutp_f32

Function NameFilNotchFullUpdOutp_f32TypeMinMax
Arguments PassedInpfloat32See unit test consideration
FilNotchStRecPtrFilNotchStRec1
FilNotchGainRecPtrFilNotchGainRec1
Return ValueNone
Description

Notch filter output calculation implemented based on ‘Inertia Comp Notch’ block functionality.

FilNotchInit

Function NameFilNotchInitTypeMinMax
Arguments PassedInpfloat32See unit test consideration
FilNotchStRecPtrFilNotchStRec1
FilNotchGainRecPtrFilNotchGainRec1
Return ValueFilOutfloat32
Description

Notch filter initialization function implemented based on EA3 design.

Transition Functions

None

Known Limitations with Design

None

UNIT TEST CONSIDERATION

  1. Since the notch filter implementation used in this module is dynamic in nature, absolute ranges are difficult to determine without pre-defined knowledge on the combination of coefficient values (A1, A2, B0, B1, B2). Because of this, the systems group ran simulations on 10 different combinations of coefficients (2 with defined default calibrations, 8 considered extreme cases of notch filters) and logged the ranges of the filter state variables and outputs during a frequency sweep. The ranges given throughout this module were taken as the worst case results of all of the given test cases.

To provide useful cases for unit testing, the boundary checks tested during unit testing should be altered to test the state variable minimum and maximum for each of the 10 test cases with the given coefficients set to the values given in that test case. In the case where the default values of the coefficients are used in a vector, the unit tester should not test the corresponding state variables with values over the range defined for that set of coefficients. See attached simulation results.

  1. GenFddIcCmd function is designed to work with argument values from the calling function as used with the other functions in the module, and outputs may be out of the expected range if tested with arbitrary combinations of input values. Unit testing of this function should use only passed argument value combinations coming from the calling function.

Abbreviations and Acronyms

Abbreviation or AcronymDescription

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

TermDefinitionSource
MDDModule Design Document
DFDData Flow Diagram

References

Ref. #TitleVersion
1AUTOSAR Specification of Memory Mapping (Link:AUTOSAR_SWS_MemoryMapping.pdf)v1.3.0 R4.0 Rev 2
2MDD GuidelineEA4 01.00.00
3Software Naming Conventions.doc2.0
4Software Design and Coding Standards.doc2.1
5FDD – SF014A_InetiaCmpVel_DesignSee Synergy Sub project version
Last modified October 12, 2025: Initial commit (1fadfc4)