This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - SysFricLrng_IntegrationManual
Integration Manual
For
SysFricLrng
VERSION: 2.0
DATE: 05-Dec-2016
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
TATA ELXSI,
CHENNAI, INDIA
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 | Basavaraja Ganeshappa | 1.0 | 30-Mar-2016 | 
| 2 | Updated to design version 2.2.0 | TATA | 2.0 | 05-Dec-16 | 
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 | 
| FDD | Functional Design Document | 
| 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 Guideline | Process 4.02.01 | 
| 2 | EA4 Software Naming Conventions | Process 4.02.01 | 
| 3 | Software Design and Coding Standards | Process 4.02.01 | 
| 4 | FDD: SF007A_SysFricLrng_Design | See Synergy sub project version | 
Dependencies
SWCs
| Module | Required Feature | 
| None | 
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 SF007A_SysFricLrng_DataDict.m
Required Global Data Outputs
Refer SF007A_SysFricLrng_DataDict.m
Specific Include Path present
None
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger | 
| StOutpCtrlInit1 | None | RTE – Init | 
| Runnable | Scheduling Requirements | Trigger | 
| StOutpCtrlPer1 | None | RTE – 10ms | 
.
| Server Runnable | Scheduling Requirements | Trigger | 
| ClrFricLrngOperMod | None | On server invocation call | 
| GetFricLrngData | None | On server invocation call | 
| GetFricOffsOutpDi | None | On server invocation call | 
| InitFricLrngTbl | None | On server invocation call | 
| SetFricLrngData | None | On server invocation call | 
| SetFricOffsOutpDi | None | On server invocation call | 
| GetFricData | None | On server invocation call | 
| SetFricData | None | On server invocation call | 
Memory Map REQUIREMENTS
Mapping
| Memory Section | Contents | Notes | 
Usage
| Feature | RAM | ROM | 
| None | 
Table 1: ARM Cortex R4 Memory Usage
NvM Blocks
- Refer Data Dict 
Compiler Settings
Preprocessor MACRO
FLTINJENA is used for coditionaly injecting fault
Optimization Settings
None
Appendix
None
2 - SysFricLrng_MDD
Module Design Document
For
SysFricLrng
Dec 05, 2016
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
TATA ELXSI,
CHENNAI, INDIA 
Change History
| Description | Author | Version | Date | 
| Initial Version | Basavaraja Ganeshappa | 1.0 | 24th Mar 2016 | 
| Re base lined by pulling 1.3.1 | Basavaraja Ganeshappa | 2.0 | 25th Jul 2016 | 
| Implementation of SF007A v2.0.0 & v2.1.0 | Krishna Anne | 3.0 | 3rd Oct 2016 | 
| Updated to design version 2.2.0 | TATA | 4.0 | 05-Dec-16 | 
Table of Contents
1 Introduction 6
1.1 Purpose 6
2 SysFricLrng High-Level Description 7
3 Design details of software module 8
3.1 Graphical representation of SysFricLrng 8
3.2 Data Flow Diagram 9
3.2.1 Component level DFD 9
3.2.2 Function level DFD 9
4 Constant Data Dictionary 10
4.1 Program (fixed) Constants 10
4.1.1 Embedded Constants 10
5 Software Component Implementation 11
5.1 Sub-Module Functions 11
5.1.1 Init: SysFricLrngInit1 11
5.1.1.1 Design Rationale 11
5.1.1.2 Module Outputs 11
5.1.2 Per: SysFricLrngPer1 11
5.1.2.1 Design Rationale 11
5.1.2.2 Store Module Inputs to Local copies 11
5.1.2.3 (Processing of function)……… 11
5.1.2.4 Store Local copy of outputs into Module Outputs 11
5.2 Server Runnables 11
5.2.1 Server Runnable Name 11
5.2.1.1 Design Rationale 11
5.2.1.2 (Processing of function)……… 11
5.3 Server Runnables 12
5.3.1 Server Runnable Name 12
5.3.1.1 Design Rationale 12
5.3.1.2 (Processing of function)……… 12
5.3.2 Server Runnable Name 12
5.3.2.1 Design Rationale 12
5.3.2.2 (Processing of function)……… 12
5.3.3 Server Runnable Name 12
5.3.3.1 Design Rationale 12
5.3.3.2 (Processing of function)……… 12
5.3.4 Server Runnable Name 12
5.3.4.1 Design Rationale 12
5.3.4.2 (Processing of function)……… 12
5.3.5 Server Runnable Name 13
5.3.5.1 Design Rationale 13
5.3.5.2 (Processing of function)……… 13
5.3.6 Server Runnable Name 13
5.3.6.2 (Processing of function)……… 13
5.3.7 Server Runnable Name 13
5.3.7.2 (Processing of function)……… 13
5.4 Interrupt Functions 13
5.4.1 Interrupt Function Name 13
5.4.1.1 Design Rationale 13
5.4.1.2 (Processing of the ISR function)….. 13
5.5 Module Internal (Local) Functions 14
5.5.1 Local Function #1 14
5.5.1.1 Design Rationale 14
5.5.1.2 Processing 14
5.5.2 Local Function #2 14
5.5.2.1 Design Rationale 14
5.5.2.2 Processing 14
5.5.3 Local Function #3 15
5.5.3.1 Design Rationale 15
5.5.3.2 Processing 15
5.5.4 Local Function #4 15
5.5.4.1 Design Rationale 15
5.5.4.2 Processing 15
5.5.5 Local Function #5 16
5.5.5.1 Design Rationale 16
5.5.5.2 Processing 16
5.5.6 Local Function #6 16
5.5.6.1 Design Rationale 16
5.5.6.2 Processing 16
5.5.7 Local Function #7 16
5.5.7.1 Design Rationale 17
5.5.7.2 Processing 17
5.5.8 Local Function #8 17
5.5.8.1 Design Rationale 17
5.5.8.2 Processing 17
5.5.8.3 17
5.5.9 Local Function #9 17
5.5.9.1 Design Rationale 18
5.5.9.2 Processing 18
5.5.10 Local Function #10 18
5.5.10.1 Design Rationale 18
5.5.10.2 Processing 18
5.5.11 Local Function #11 18
5.5.11.1 Design Rationale 18
5.5.11.2 Processing 19
5.5.12 Local Function #12 19
5.5.12.1 Design Rationale 19
5.5.12.2 Processing 19
5.6 GLOBAL Function/Macro Definitions 19
6 Known Limitations with Design 20
7 UNIT TEST CONSIDERATION 21
Appendix A Abbreviations and Acronyms 22
Appendix B Glossary 23
Appendix C References 24
Introduction
Purpose
MDD for System Friction Learning
SysFricLrng High-Level Description
Refer FDD
Design details of software module
Refer FDD
Graphical representation of SysFricLrng

Data Flow Diagram
Refer FDD
Component level DFD
Refer FDD
Function level DFD
Refer FDD
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
Local Constants
| Constant Name | Resolution | Units | Value | 
|---|---|---|---|
| INDEX0_CNT_U08 | 1 | CNT | 0U | 
| INDEX1_CNT_U08 | 1 | CNT | 1U | 
| INDEX2_CNT_U08 | 1 | CNT | 2U | 
| INDEX3_CNT_U08 | 1 | CNT | 3U | 
| SYSSATNFRICESTIMDMIN_HWNWMTR_F32 | 1 | HwNwMtr | 0.0F | 
| SYSSATNFRICESTIMDMAX_HWNWMTR_F32 2 | 1 | HwNwMtr | 20.0F | 
| SYSFRICESTIMDMIN_HWNWMTR_F32 | 1 | HwNwMtr | 0.0F | 
| SYSFRICESTIMDMAX_HWNWMTR_F32 | 1 | HwNwMtr | 20.0F | 
| SYSFRICOFFSMIN_HWNWMTR_F32 | 1 | HwNwMtr | -5.0F | 
| SYSFRICOFFSMAX_HWNWMTR_F32 | 1 | HwNwMtr | 5.0F | 
For rest of the constants, please refer Data Dictionary
Software Component Implementation
The detailed design of the function is provided in the FDD.
Sub-Module Functions
Init: SysFricLrngInit1
Design Rationale
In MDD, filters are initialized inside the for loop using switch case but in code filters are initialized one by one without any conditions.
In model, filters are initialized twice as it is not possible to use a variable for the filter initialization in the model. This is redundancy is not present in the code as variables are used for initializing the filters.
Module Outputs
Refer FDD
Per: SysFricLrngPer1
Design Rationale
Refer FDD
Store Module Inputs to Local copies
Refer FDD
(Processing of function)………
Refer FDD
Store Local copy of outputs into Module Outputs
Refer FDD
Server Runnables
Server Runnable Name
ClrFricLrngOperMod
Design Rationale
Refer FDD
(Processing of function)………
On server invocation call
Server Runnables
Server Runnable Name
GetFricLrngData
Design Rationale
Refer FDD
(Processing of function)………
On server invocation call
Server Runnable Name
GetFricOffsOutpDi
Design Rationale
Refer FDD
(Processing of function)………
On server invocation call
Server Runnable Name
InitFricLrngTbl
Design Rationale
Refer FDD
(Processing of function)………
On server invocation call
Server Runnable Name
SetFricLrngDatal
Design Rationale
Refer FDD
(Processing of function)………
On server invocation call
Server Runnable Name
SetFricOffsOutpDi
Design Rationale
Refer FDD
(Processing of function)………
On server invocation call
Server Runnable Name
GetFricData
Design Rationale
Refer FDD
To avoid calculating array indexing for updating PIMs Rte_Pim_FricLrngData()->Hys and Rte_Pim_FricLrngData()->RngCntr, performed casting the array argument back to it's actual type (similar to what we do with cal arrays) so we can use normal indexing.
(Processing of function)………
On server invocation call
Server Runnable Name
SetFricData
Design Rationale
Refer FDD
To avoid calculating array indexing for updating from PIMs Rte_Pim_FricLrngData()->Hys and Rte_Pim_FricLrngData()->RngCntr, performed casting the array argument back to it's actual type (similar to what we do with cal arrays) so we can use normal indexing.
(Processing of function)………
On server invocation call
Interrupt Functions
None
Interrupt Function Name
None
Design Rationale
NA
(Processing of the ISR function)…..
NA
Module Internal (Local) Functions
Local Function #1
| Function Name | FricLearning | Type | Min | Max | 
| Arguments Passed | SelHwAg_HwDeg_T_f32 | Float32 | -1440.0 | 1440.0 | 
| SelColTq_HwNwtMtr_T_f32 | Float32 | -10 | 10 | |
| VehSpdIdx_Cnt_T_u16 | Uint16 | 0 | 3 | |
| HwVelDir_Cnt_T_u08 | Uint8 | 0 | 1 | |
| LrngEna_Cnt_T_Logl | Boolean | FALSE | TRUE | |
| Return Value | NA | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘FricLearning’ subsystem in FDD.
Following per instance data is updated.
| *Rte_Pim_RawAvrg() (Min:0, Max:20) | 
| Rte_Pim_SatnAvrgFric()[VehSpdIdx_Cnt_T_u16] (Min:0, Max:20) | 
Also writes the outputs SysFricEstimd and SysSatnFricEstimd
Local Function #2
| Function Name | RunningAndCalibrationModes | Type | Min | Max | 
| Arguments Passed | *FricOffs_HwNwtMtr_T_f32 | Float32 | -5.0 | +5.0 | 
| *LrngEna_Cnt_T_Logl | Boolean | FALSE | TRUE | |
| Return Value | None | NA | NA | NA | 
Design Rationale
Processing
Following PIMs are updated; refer to ‘RunningAndCalibrationModes’ subsystem in the FDD. FricOffs_HwNwtMtr_T_f32 is the output of this function
| Rte_Pim_FricLrngData()->FricOffs (Min:-5, Max:5) | 
| *Rte_Pim_RawAvrg() (Min:0, Max:20) | 
| Rte_Pim_SatnAvrgFric()[VehSpdIdx_Cnt_T_u16] (Min:0, Max:20) | 
Also updates the input argument, *FricOffs_HwNwtMtr_T_f32.
Local Function #3
| Function Name | RawAvrgCalc | Type | Min | Max | 
| Arguments Passed | VehSpdIdx_Cnt_T_u16 | Uint16 | 0 | 5 | 
| DeltaIdxOffsDec_Cnt_T_u16 | Uint16 | 0 | 12 | |
| DeltaIdxOffsInc_Cnt_T_u16 | Uint16 | 0 | 13 | |
| TotalCounter_Cnt_T_u32 | Uint32 | 0 | 65535 | |
| LrngEna_Cnt_T_Logl | Boolean | FALSE | TRUE | |
| Return Value | NA | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘Raw Average Calculation’ subsystem in FDD.
Following per instance data is updated.
| *Rte_Pim_RawAvrg() (Min:0, Max:20) | 
| Rte_Pim_SatnAvrgFric()[VehSpdIdx_Cnt_T_u16] (Min:0, Max:20) | 
Local Function #4
| Function Name | PhiCalc | Type | Min | Max | 
| Arguments Passed | SelHwAg_HwDeg_T_f32 | Float32 | -1440 | 1440 | 
| Gate_Cnt_T_u16 | Uint16 | 0 | 65535 | |
| DeltaIdxOffs_Cnt_T_u16 | Uint16 | 0 | 10 | |
| SelColTq_HwNwtMtr_T_f32 | Float32 | -10 | 10 | |
| Return Value | NA | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘Raw Average Calculation’ subsystem in FDD.
Following per instance data is updated.
| Rte_Pim_FricLrngData()->Hys[DeltaIdxOffs_Cnt_T_u16][Gate_Cnt_T_u16 + 1U] (Min:-127, Max:127) | 
| Rte_Pim_FricLrngData()->Hys[DeltaIdxOffs_Cnt_T_u16][Gate_Cnt_T_u16] (Min:-127, Max:127) | 
Local Function #5
| Function Name | RangeCounterManager | Type | Min | Max | 
| Arguments Passed | DeltaIdxOffs_Cnt_T_u16 | Uint16 | 0 | 10 | 
| DeltaIdxOffsDec_Cnt_T_u16 | Uint16 | 0 | 12 | |
| DeltaIdxOffsInc_Cnt_T_u16 | Uint16 | 0 | 13 | |
| Gate_Cnt_T_u16 | Uint16 | 0 | 65535 | |
| Return Value | NA | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘Range counter manager’ subsystem in FDD.
Following per instance data is updated.
| *Rte_Pim_ RngCntrThdExcdd() (Min:0, Max:1) | 
| Rte_Pim_FricLrngData->RngCntr (:,:) (Min:0, Max:65535) | 
Local Function #6
| Function Name | NTCSetReset | Type | Min | Max | 
| Arguments Passed | MaxRawAvrgFric_Cnt_T_f32 | Float32 | -127 | 254 | 
| Return Value | NA | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘NTC_Pass’ and ‘NTC_Fail’ subsystem in FDD
Sets or resets the NTCNR_0X0A2
Local Function #7
| Function Name | ClearingMode | Type | Min | Max | 
| Arguments Passed | none | NA | NA | NA | 
| Return Value | none | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘Clearing Mode’ subsystem in FDD.
Following per instance data is updated.
| *Rte_Pim_FricOffs()(Min:-5, Max:5) | 
Local Function #8
| Function Name | ResettingMode | Type | Min | Max | 
| Arguments Passed | *FricOffs_HwNwtMtr_T_f32 | NA | NA | NA | 
| Return Value | None | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘ResettingMode’ subsystem in FDD.
Following per instance data is updated. Also updates the input argument ‘*FricOffs_HwNwtMtr_T_f32’.
| Rte_Pim_FricLrngData()->RngCntr(;) | 
| Rte_Pim_AvrgFricLpFilX()->FilSt (X: 1 to 4) | 
| Rte_Pim_FricLrngData()->Hys(;) | 
| Rte_Pim_FricOffs()(Min:-5, Max:5) | 
| Rte_Pim_VehBasLineFric()[] (Min:-0, Max:127) Rte_Pim_RawAvrgFric()[] (Min:--127, Max:254) Rte_Pim_FilAvrgFric()[] (Min:--10 , Max: 10) Rte_Pim_SatnAvrgFric()[](Min:--127, Max:254) Rte_Pim_FricLrngData()->VehLrndFric[] (0-127) | 
Local Function #9
| Function Name | HwAngConstraint | Type | Min | Max | 
| Arguments Passed | FilHwAg_HwDeg_T_f32 | Float32 | -1440 | 1440 | 
| *HwAgOK_Cnt_T_Logl | boolean | 0 | 1 | |
| *SelHwAg_HwDeg_T_f32 | Float32 | -1440 | 1440 | |
| Return Value | NA | NA | NA | NA | 
Design Rationale
IDXSELN2_ULS_U08 is not used in the code because it is not required instead IDXSELN1_ULS_U08 serves the purpose.
Processing
Refer to ‘HwAngConstraint‘ subsystem in FDD. Updates the input arguments, *HwAgOK_Cnt_T_Logl and *SelHwAg_HwDeg_T_f32
Local Function #10
| Function Name | HwVelConstraint | Type | Min | Max | 
| Arguments Passed | HwVel_HwRadPerSec_T_f32 | Float32 | -42 | 42 | 
| HwVelOK_Cnt_T_Logl | Boolean | 0 | 1 | |
| HwVelDir_Cnt_T_u08 | Uint8 | 0 | 1 | |
| Return Value | NA | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘HwVelConstraint’ subsystem in FDD.
Local Function #11
| Function Name | VehSpdConstraint | Type | Min | Max | 
| Arguments Passed | VehSpd_Kph_T_f32 | Float32 | 0 | 511 | 
| *VehSpdOK_Cnt_T_Logl | Boolean | 0 | 1 | |
| *VehSpdIdx_Cnt_T_u16 | Uint16 | 0 | 5 | |
| Return Value | None | NA | NA | NA | 
Design Rationale
Code is optimized due to limitation with the model; hence code completely won’t match the model. There won’t be any impact on the functionality.
In the model as it is not possible to break the for loop until the loop iterator reaches the configured constant threshold value, index corresponding to the position in ‘SysFricLrngVehSpd’ which breaches the conditions mentioned in ‘VehSpdIdxCalcn’ subsystem is calculated by successively adding the index value after multiplying it with either the condition true or false based on whether the vehicle speed value breaches the threshold mentioned in the FDD. In code as it is possible to exit the for loop as soon as a value in ‘VehSpdIdxCalcn’ breaches thresholds as mentioned in FDD, no such successive addition of loop counter is required.
Processing
Refer to ‘VehSpdConstraint’ subsystem in FDD.
Local Function #12
| Function Name | ColTqconstraint | Type | Min | Max | 
| Arguments Passed | FilColTq_HwNwtMtr_T_f32 | Float32 | -10 | 10 | 
| *SelColTq_HwNwtMtr_T_f32 | Boolean | -10 | 10 | |
| Return Value | NA | NA | NA | NA | 
Design Rationale
Processing
Refer to ‘ColTqconstraint’ subsystem in FDD. Updates the *SelColTq_HwNwtMtr_T_f32.
GLOBAL Function/Macro Definitions
NA
Known Limitations with Design
Implementation of design baseline 2.2.0 does not match the FDD because in the FDD DataDict.m file, array dimensions in the NVM PIM definition for FricLrngData did not agree with the dimensions in the server runnable arguments. For the implementation, the dimensions in the NVM definition were used.
FDD DataDict.m file needs updates to definition in the DataDict.m file of SrvRunnables' GetFricData and SetFricData arguments to agree with the NVM definition. Implementation will need update to bring in the new design subproject and remove this MDD notes about the discrepancy.
UNIT TEST CONSIDERATION
In model, one based indexing is used but in code 0 based indexing is used.
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) | Process 4.02.01 | 
| 2 | MDD Guideline | Process 4.02.01 | 
| 3 | Software Naming Conventions.doc | 2.0 | 
| 4 | Software Design and Coding Standards.doc | 2.1 | 
| 5 | FDD- SF007A_SysFricLrng_Design | See Synergy sub project version | 
3 - SysFricLrng_PeerReviewChecklists
Overview
Summary SheetSynergy Project
Davinci Files
Sheet 1: Summary Sheet



