ImcSigArbn_MDD

Module Design Document

For

ImcSigArbn

May 11, 2017

Prepared By:

Krishna Anne,

Nexteer Automotive,

Saginaw, MI, USA
Change History

DescriptionAuthorVersionDate
Initial VersionShruthi Raghavan1.002/02/2017
Fix for Issues in using Return value of ImcDataKrishna Anne2.005/11/2017


Table of Contents1 Introduction 4

1.1 Purpose 4

2 ImcSigArbn & High-Level Description 5

3 Design details of software module 6

3.1 Graphical representation of ImcSigArbn 6

3.2 Data Flow Diagram 6

3.2.1 Component level DFD 6

3.2.2 Function level DFD 6

4 Constant Data Dictionary 7

4.1 Program (fixed) Constants 7

4.1.1 Embedded Constants 7

5 Software Component Implementation 8

5.1 Sub-Module Functions 8

5.1.1 Init: ImcSigArbnInit1 8

5.1.1.1 Design Rationale 8

5.1.2 Per: ImcSigArbnPer1 8

5.1.2.1 Design Rationale 8

5.1.3 Per: ImcSigArbnPer2 8

5.1.3.1 Design Rationale 8

5.2 Server Runnables 8

5.3 Interrupt Functions 8

5.4 Module Internal (Local) Functions 8

5.4.1 Local Function #1 8

5.4.1.1 Design Rationale 9

5.5 GLOBAL Function/Macro Definitions 9

6 Known Limitations with Design 10

7 UNIT TEST CONSIDERATION 11

Appendix A Abbreviations and Acronyms 12

Appendix B Glossary 13

Appendix C References 14

Introduction

Purpose

Module design document for ImcSigArbn SF063A to refer for design rationale, unit test considerations and implementation details.

ImcSigArbn & High-Level Description

This function shall define the requirements for sharing signals. It shall serve as a single function of contact to obtain information from the other controller in a dual ECU structure. It shall define requirements for arbitration of signals and integrator states to ensure performance.

Design details of software module

Graphical representation of ImcSigArbn

Data Flow Diagram

Component level DFD

Refer FDD Simulink model.

Function level DFD

Refer FDD Simulink Model

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant NameResolutionUnitsValue
Refer to DataDict.m file

Software Component Implementation

Sub-Module Functions

Init: ImcSigArbnInit1

Design Rationale

Refer FDD Simulink model

Per: ImcSigArbnPer1

Design Rationale

Refer FDD Simulink model
The implementation of ElapsedTime block was optimized in the code to avoid a couple of Boolean operations and additional temporary variables. The functionality was verified in peer review with design owner as well.

Per: ImcSigArbnPer2

Design Rationale

Refer FDD Simulink model
The implementation of ElapsedTime block was optimized in the code to avoid a couple of Boolean operations and additional temporary variables. The functionality was verified in peer review with design owner as well.

Server Runnables

None

Interrupt Functions

None

Module Internal (Local) Functions

Local Function #1

Function NameCalcImcSigOffsTypeMinMax
Arguments PassedImcSigArbnEna_Cnt_T_loglBoolean01
InpSig_Uls_T_f32Float32-32767.532767.5
ImcSig_Uls_T_f32Float32-32767.532767.5
*SigLpFil_Uls_T_strFilLpRec1[struct ('FilSt’, -32767.5,
'FilGain', 0. 062831853000000)]
[struct('FilSt', 32767.5,
'FilGain', 0. 998132557254885)]
*OutSigPrev_Uls_T_f32Float32-32767.532767.5
ImcSigArbnSigOffsLim_Uls_T_f32Float32032767.5
Sts_Cnt_T_enumImcArbnRxSts1IMCARBNRXSTS_NODATAIMCARBNRXSTS_INVLD
Rtn_Cnt_T_enumStd_ReturnTypeE_NOT_OKE_OK
Return ValueOutSigPrev_Uls_T_f32Float32-32767.532767.5

Design Rationale

All the ImcSigArbn_* functions in the Per2 inside ‘Calc Offs Corrn 10ms Periodic’ block of FDD do the same function with different cals, pims and input signals. So they were all clubbed into single function.

Local Function #1

Function NameCalcImcSigOffsTypeMinMax
Arguments PassedSetArbnNtcfloat3204294967296
Return ValueNANANANA

Design Rationale

To handle cyclomatic complexity.

GLOBAL Function/Macro Definitions

None

Known Limitations with Design

  1. Filter ranges given in design are full range of float for state variable and [0,max_float32] for gain – this has to be fixed in next version. For now, the ranges are given in the unit test considerations after calculating from the code. These values can be used instead.

  2. The value of calculated float32 offset signals are limited to [-cal, cal] and then later checked for absolute value being greater than or equal to the same cal. This was verified by component owner as not the design intent & one of these places, the cal used has to change.

  3. The input signal PosnTrakgIntgtrSt1 has a range of [-2864,2864] according to the DataDict.m file. If its IMC counterpart ImcPosnTrakgIntgtrSt1 read in Per2 has the same range [-2864,2864], the algorithm inside the ImcSigArbn_PosnTrakgIntglSt1 will only give output PosnTrakgIntgtrSt1Offs values

[Refer: SF063A_ImcSigArbn/ImcSigArbn/ImcSigArbnPer2/Calculate Offs Corrn 10 ms Periodic /ImcSigArbn_PosnTrakgIntglSt1/Do arbitration]
in the range [-2864,2864]. However, the limit used on this value is a calibration ImcSigArbnPosnTrakg1ArbnOffsLim whose range is [0,32767.5], max is much larger than the actual maximum that can be taken by this variable. Also, the output limits on the PosnTrakgIntgtrSt1Offs output is [-32767.5,32767.5], which needs to change.

  1. The units on the embedded constants INTGTROFFSSATNLOWLIM_ULS_F32 and INTGTROFFSSATNUPPRLIM_ULS_F32 need to change if a different set of constants are decided to be used for PosnTrakgIntgtrSt1Offs limits

UNIT TEST CONSIDERATION

In case the m file gives float min/max values as the ranges for the following PIMs, use the values from this table instead as the range.

PIM VariablesRanges
Structure NameStructure ElementMinMax
HwAgLpFilFilSt-14401440
FilGain0. 0628318530000000. 998132557254885
HwAgTarLpFilFilSt-14401440
FilGain0. 0628318530000000. 998132557254885
HwTqLpFilFilSt-1010
FilGain0. 0628318530000000. 998132557254885
MotVelLpFilFilSt-13501350
FilGain0. 0628318530000000. 998132557254885
PosnServoIntgtrLpFilFilSt-32767.532767.5
FilGain0. 0628318530000000. 998132557254885
PullCmpLongTermCmpLpFilFilSt-1010
FilGain0. 0628318530000000. 998132557254885
PullCmpShoTermCmpLpFilFilSt-1010
FilGain0. 0628318530000000. 998132557254885
TrakgIntgtrSt1LpFilFilSt-28642864
FilGain0. 0628318530000000. 998132557254885
TrakgIntgtrSt2LpFilFilSt-2000020000
FilGain0. 0628318530000000. 998132557254885
VehSpdLpFilFilSt0511
FilGain0. 0628318530000000. 998132557254885

Tolerance of state variables can be assumed to be six significant digits and for the gains it is 1e-07.

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 GuidelineSee Software Engineering Process 04.02.01
3Software Naming Conventions.docSee Software Engineering Process 04.02.01
4Software Design and Coding Standards.docSee Software Engineering Process 04.02.01
5SF063A_ImcSigArbn_DesignSee Synergy Sub-Project Version
Last modified October 12, 2025: Initial commit (ddf2e20)