This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - ImcSigArbn_IntegrationManual
Integration Manual
For
ImcSigArbn
VERSION: 1.0
DATE: 02-FEB-2017
Prepared By:
Shruthi Raghavan,
Nexteer Automotive,
Saginaw, MI, USA
Location: The official version of this document is stored in the Nexteer Configuration Management System.
Revision History
| Sl.No. | Description | Author | Version | Date | 
| 1 | Initial version | Shruthi R | 1.0 | 02-FEB-2017 | 
Table of Contents
3.2 Global Functions(Non RTE) to be provided to Integration Project 6
4 Configuration REQUIREMeNTS 7
4.2 Configuration Files to be provided by Integration Project 7
4.3 Da Vinci Parameter Configuration Changes 7
4.4 DaVinci Interrupt Configuration Changes 7
4.5 Manual Configuration Changes 7
5 Integration DATAFLOW REQUIREMENTS 8
5.1 Required Global Data Inputs 8
5.2 Required Global Data Outputs 8
5.3 Specific Include Path present 8
Abbrevations And Acronyms
| Abbreviation | Description | 
| DFD | Design functional diagram | 
| MDD | Module design Document | 
References
This section lists the title & version of all the documents that are referred for development of this document
| Sr. No. | Title | Version | 
| 1 | MDD Guidelines | See Software Engineering Process 04.02.01 | 
| 2 | EA4 Software Naming Conventions | See Software Engineering Process 04.02.01 | 
| 3 | Software Design and Coding standards | See Software Engineering Process 04.02.01 | 
| 4 | SF063_ImcSigArbn_Design | See Synergy Subroject Version | 
Dependencies
SWCs
| Module | Required Feature | 
| None | N/A | 
Global Functions(Non RTE) to be provided to Integration Project
None
Configuration REQUIREMeNTS
Build Time Config
| Modules | Notes | |
| None | 
Configuration Files to be provided by Integration Project
None
Da Vinci Parameter Configuration Changes
| Parameter | Notes | SWC | 
| None | 
DaVinci Interrupt Configuration Changes
| ISR Name | VIM # | Priority Dependency | Notes | 
| None | 
Manual Configuration Changes
| Constant | Notes | SWC | 
| None | 
Integration DATAFLOW REQUIREMENTS
Required Global Data Inputs
Refer DataDict.m file
Required Global Data Outputs
Refer DataDict.m file
Specific Include Path present
Yes
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger | 
| ImcSigArbnInit1 | None | RTE_Init | 
| Runnable | Scheduling Requirements | Trigger | 
| ImcSigArbnPer1 | None | RTE (2 ms) | 
| ImcSigArbnPer2 | None | RTE (10 ms) | 
Memory Map REQUIREMENTS
Mapping
| Memory Section | Contents | Notes | 
| N/A | 
* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.
Usage
| Feature | RAM | ROM | 
| N/A | 
Table 1: ARM Cortex R4 Memory Usage
NvM Blocks
None
Compiler Settings
Preprocessor MACRO
None
Optimization Settings
None
Appendix
None
2 - ImcSigArbn_MDD
Module Design Document
For
ImcSigArbn
May 11, 2017
Prepared By:
Krishna Anne,
Nexteer Automotive,
Saginaw, MI, USA
Change History
| Description | Author | Version | Date | 
| Initial Version | Shruthi Raghavan | 1.0 | 02/02/2017 | 
| Fix for Issues in using Return value of ImcData | Krishna Anne | 2.0 | 05/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 Name | Resolution | Units | Value | 
|---|---|---|---|
| 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 Name | CalcImcSigOffs | Type | Min | Max | 
| Arguments Passed | ImcSigArbnEna_Cnt_T_logl | Boolean | 0 | 1 | 
| InpSig_Uls_T_f32 | Float32 | -32767.5 | 32767.5 | |
| ImcSig_Uls_T_f32 | Float32 | -32767.5 | 32767.5 | |
| *SigLpFil_Uls_T_str | FilLpRec1 | [struct ('FilSt’, -32767.5, 'FilGain', 0. 062831853000000)] | [struct('FilSt', 32767.5, 'FilGain', 0. 998132557254885)] | |
| *OutSigPrev_Uls_T_f32 | Float32 | -32767.5 | 32767.5 | |
| ImcSigArbnSigOffsLim_Uls_T_f32 | Float32 | 0 | 32767.5 | |
| Sts_Cnt_T_enum | ImcArbnRxSts1 | IMCARBNRXSTS_NODATA | IMCARBNRXSTS_INVLD | |
| Rtn_Cnt_T_enum | Std_ReturnType | E_NOT_OK | E_OK | |
| Return Value | OutSigPrev_Uls_T_f32 | Float32 | -32767.5 | 32767.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 Name | CalcImcSigOffs | Type | Min | Max | 
| Arguments Passed | SetArbnNtc | float32 | 0 | 4294967296 | 
| Return Value | NA | NA | NA | NA | 
Design Rationale
To handle cyclomatic complexity.
GLOBAL Function/Macro Definitions
None
Known Limitations with Design
- 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. 
- 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. 
- 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.
- 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 Variables | Ranges | ||
|---|---|---|---|
| Structure Name | Structure Element | Min | Max | 
| HwAgLpFil | FilSt | -1440 | 1440 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| HwAgTarLpFil | FilSt | -1440 | 1440 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| HwTqLpFil | FilSt | -10 | 10 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| MotVelLpFil | FilSt | -1350 | 1350 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| PosnServoIntgtrLpFil | FilSt | -32767.5 | 32767.5 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| PullCmpLongTermCmpLpFil | FilSt | -10 | 10 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| PullCmpShoTermCmpLpFil | FilSt | -10 | 10 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| TrakgIntgtrSt1LpFil | FilSt | -2864 | 2864 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| TrakgIntgtrSt2LpFil | FilSt | -20000 | 20000 | 
| FilGain | 0. 062831853000000 | 0. 998132557254885 | |
| VehSpdLpFil | FilSt | 0 | 511 | 
| FilGain | 0. 062831853000000 | 0. 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 Acronym | Description | 
|---|---|
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 
| Term | Definition | Source | 
|---|---|---|
| MDD | Module Design Document | |
| DFD | Data Flow Diagram | 
References
| Ref. # | Title | Version | 
|---|---|---|
| 1 | AUTOSAR Specification of Memory Mapping (Link:AUTOSAR_SWS_MemoryMapping.pdf) | v1.3.0 R4.0 Rev 2 | 
| 2 | MDD Guideline | See Software Engineering Process 04.02.01 | 
| 3 | Software Naming Conventions.doc | See Software Engineering Process 04.02.01 | 
| 4 | Software Design and Coding Standards.doc | See Software Engineering Process 04.02.01 | 
| 5 | SF063A_ImcSigArbn_Design | See Synergy Sub-Project Version | 
3 - ImcSigArbn_PeerReviewChecklist
Overview
Summary SheetSynergy Project
Source Code
PolySpace
Sheet 1: Summary Sheet

Sheet 2: Synergy Project
Sheet 3: Source Code
| Rev 1.2 | 8-Jun-15 | |||||||||||||||||||||||
| Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
| Source File Name: | ImcSigArbn.c | Source File Revision: | 3 | |||||||||||||||||||||
| Header File Name: | - | Header File Revision: | ||||||||||||||||||||||
| MDD Name: | ImcSigArbn_MDD.docx | Revision: | 1 | |||||||||||||||||||||
| FDD/SCIR/DSR/FDR/CM Name: | SF063A_ImcSigArbn_Design | Revision: | 1.3.0 | |||||||||||||||||||||
| Quality Check Items: | ||||||||||||||||||||||||
| Rationale is required for all answers of No | ||||||||||||||||||||||||
| Working EA4 Software Naming Convention followed: | ||||||||||||||||||||||||
| for variable names | N/A | Comments: | ||||||||||||||||||||||
| for constant names | N/A | Comments: | ||||||||||||||||||||||
| for function names | N/A | Comments: | ||||||||||||||||||||||
| for other names (component, memory | N/A | Comments: | ||||||||||||||||||||||
| mapping handles, typedefs, etc.) | ||||||||||||||||||||||||
| All paths assign a value to outputs, ensuring | N/A | Comments: | ||||||||||||||||||||||
| all outputs are initialized prior to being written | ||||||||||||||||||||||||
| Requirements Tracability tags in code match the requirements tracability in the FDD | N/A | Comments: | ||||||||||||||||||||||
| requirements tracability in the FDD | Not done in EA4 | |||||||||||||||||||||||
| All variables are declared at the function level. | N/A | Comments: | ||||||||||||||||||||||
| Synergy version matches change history | Yes | Comments: | ||||||||||||||||||||||
| and Version Control version in file comment block | ||||||||||||||||||||||||
| Change log contains detailed description of changes | Yes | Comments: | ||||||||||||||||||||||
| and Work CR number | ||||||||||||||||||||||||
| Code accurately implements FDD (Document or Model) | Yes | Comments: | ||||||||||||||||||||||
| Design Rationale for ElapsedTime block is noted in MDD | ||||||||||||||||||||||||
| Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
| Component.h is included | N/A | Comments: | ||||||||||||||||||||||
| No header file for this component | ||||||||||||||||||||||||
| All other includes are actually needed. (System includes | Yes | Comments: | ||||||||||||||||||||||
| only allowed in Nexteer library components) | ||||||||||||||||||||||||
| Software Design and Coding Standards followed: | Version: 2.1 | |||||||||||||||||||||||
| Code comments are clear, correct, and adequate | Yes | Comments: | ||||||||||||||||||||||
| and have been updated for the change: [N40] and | ||||||||||||||||||||||||
| all other rules in the same section as rule [N40], | ||||||||||||||||||||||||
| plus [N75], [N12], [N23], [N33], [N37], [N38], | ||||||||||||||||||||||||
| [N48], [N54], [N77], [N79], [N72] | ||||||||||||||||||||||||
| Source file (.c and .h) comment blocks are per | Yes | Comments: | ||||||||||||||||||||||
| standards and contain correct information: [N41], [N42] | ||||||||||||||||||||||||
| Function comment blocks are per standards and | Yes | Comments: | ||||||||||||||||||||||
| contain correct information: [N43] | ||||||||||||||||||||||||
| Code formatting (indentation, placement of | Yes | Comments: | ||||||||||||||||||||||
| braces, etc.) is per standards: [N5], [N55], [N56], | ||||||||||||||||||||||||
| [N57], [N58], [N59] | ||||||||||||||||||||||||
| Embedded constants used per standards; no | Yes | Comments: | ||||||||||||||||||||||
| "magic numbers": [N12] | ||||||||||||||||||||||||
| Memory mapping for non-RTE code | N/A | Comments: | ||||||||||||||||||||||
| is per standard | No non-RTE code | |||||||||||||||||||||||
| All execution-order-dependent code can be | Yes | Comments: | ||||||||||||||||||||||
| recognized by the compiler: [N80] | ||||||||||||||||||||||||
| All loops have termination conditions that ensure | N/A | Comments: | ||||||||||||||||||||||
| finite loop iterations: [N63] | No loops in code | |||||||||||||||||||||||
| All divides protect against divide by zero | Yes | Comments: | ||||||||||||||||||||||
| if needed: [N65] | Only division by non-zero embedded constant | |||||||||||||||||||||||
| All integer division and modulus operations | Yes | Comments: | ||||||||||||||||||||||
| handle negative numbers correctly: [N76] | All library functions are used to do these operations | |||||||||||||||||||||||
| All typecasting and fixed point arithmetic, | Yes | Comments: | ||||||||||||||||||||||
| including all use of fixed point macros and | All library functions are used to do these operations | |||||||||||||||||||||||
| timer functions, is correct and has no possibility | ||||||||||||||||||||||||
| of unintended overflow or underflow: [N66] | ||||||||||||||||||||||||
| All float-to-unsiged conversions ensure the. | N/A | Comments: | ||||||||||||||||||||||
| float value is non-negative: [N67] | ||||||||||||||||||||||||
| All conversions between signed and unsigned | Yes | Comments: | ||||||||||||||||||||||
| types handle msb==1 as intended: [N78] | All library functions are used to do these operations | |||||||||||||||||||||||
| All pointer dereferencing protects against | N/A | Comments: | ||||||||||||||||||||||
| null pointer if needed: [N70] | ||||||||||||||||||||||||
| Component outputs are limited to the legal range | Yes | Comments: | ||||||||||||||||||||||
| defined in the FDD DataDict.m file : [N53] | ||||||||||||||||||||||||
| All code is mapped with FDD (all FDD | Yes | Comments: | ||||||||||||||||||||||
| subfunctions and/or model blocks identified | ||||||||||||||||||||||||
| with code comments; all code corresponds to | ||||||||||||||||||||||||
| some FDD subfunction and/or model block): [N40] | ||||||||||||||||||||||||
| Review did not identify violations of other | Yes | Comments: | ||||||||||||||||||||||
| coding standard rules | ||||||||||||||||||||||||
| Anomaly or Design Work CR created | Yes | Comments: List Anomaly or CR numbers | ||||||||||||||||||||||
| for any FDD corrections needed | EA4#9841 Continuous Improvement CR written | |||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||
| Change Owner: | Avinash James | Review Date : | 08/17/17 | |||||||||||||||||||||
| Lead Peer Reviewer: | Krishna Anne | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||



