This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - LoaMgr_IntegrationManual
Integration Manual
For
LoaMgr
VERSION: 1.0
DATE: 06-Oct-2017
Prepared By:
Matthew Leser,
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 | Matthew Leser | 1.0 | 06-Oct-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 | FDD : SF049B_LoaMgr_Design | See Synergy sub project version | 
| 2 | Software Naming Conventions | Process 4.02.00 | 
| 3 | Software Design and Coding Standards | Process 4.02.00 | 
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 | 
Exclusive Area ‘LoaMgrExclusiveArea’ must be configured to block OS interrupts.
Integration DATAFLOW REQUIREMENTS
Required Global Data Inputs
Refer DataDict.m file in the FDD
Required Global Data Outputs
Refer DataDict.m file file in the FDD
Specific Include Path present
No
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger | 
| LoaMgrInit1 | None | RTE (Init) | 
| Runnable | Scheduling Requirements | Trigger | 
| LoaMgrPer1 | None | RTE (4 ms) | 
.
Memory Map REQUIREMENTS
Mapping
| Memory Section | Contents | Notes | 
| None | ||
* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.
Usage
| Feature | RAM | ROM | 
| None | 
Table 1: ARM Cortex R4 Memory Usage
NvM Blocks
None
Compiler Settings
Preprocessor MACRO
None.
Optimization Settings
None.
Appendix
None
2 - LoaMgr_MDD
Module Design Document
For
LoaMgr
October 6, 2017
Prepared By:
Matthew Leser
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Change History
| Description | Author | Version | Date | 
| Initial Version | Matthew Leser | 1 | 06-Oct-2017 | 
Table of Contents1 Introduction 5
2 LoaMgr High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of LoaMgr 7
4.1 Program (fixed) Constants 9
5 Software Component Implementation 10
5.1.2.2 Store Module Inputs to Local copies 10
5.1.2.3 (Processing of function)……… 10
5.1.2.4 Store Local copy of outputs into Module Outputs 10
5.4 Module Internal (Local) Functions 10
5.5 GLOBAL Function/Macro Definitions 13
6 Known Limitations with Design 14
Appendix A Abbreviations and Acronyms 16
Introduction
Purpose
MDD for Loss of Assist Manager
LoaMgr High-Level Description
Refer to FDD
Design details of software module
Graphical representation of LoaMgr

Data Flow Diagram
Refer FDD
Component level DFD
Function level DFD
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
Local Constants
| Constant Name | Resolution | Units | Value | 
|---|---|---|---|
| Refer .m file | 
Software Component Implementation
Sub-Module Functions
Init: LoaMgrInit1
Design Rationale
Refer FDD
Module Outputs
Refer FDD
Per: LoaMgrPer1
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 Runables
None
Interrupt Functions
None
Module Internal (Local) Functions
Local Function #1
| Function Name | LtchInp | Type | Min | Max | 
| Arguments Passed | IdptSig_Cnt_T_u08 | uint8 | 0 | 4 | 
| MaxAllwdVal_Cnt_T_u08 | uint8 | 2 | 4 | |
| *PrevVal_Cnt_T_u08 | uint8 | 0 | 4 | |
| Return Value | HwTqResp_Cnt_T_u08 | uint8 | 0 | 4 | 
Design Rationale
None
Processing
Refer to ‘Latch_Inputs’ block in FDD at ‘SF049B_LoaMgr/LoaMgr/LoaMgrPer1/Latch_Inputs’
Local Function #2
| Function Name | CntMtgtnReq | Type | Min | Max | 
| Arguments Passed | HwTqLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | 
| MotAgLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| CurrMeasLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| IvtrLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| Return Value | MultiMtgtnResp_Cnt_T_u08 | uint8 | 0 | 3 | 
Design Rationale
None
Processing
Refer to ‘CntMtgtnReq’ block in FDD at ‘SF049B_LoaMgr/LoaMgr/LoaMgrPer1/Arbitrate_Responses/CntSwBasdMtgtn/CntMtgtnReq’
Local Function #3
| Function Name | ReqHwTqResp | Type | Min | Max | 
| Arguments Passed | HwTqIdptMin_Cnt_T_u08 | uint8 | 0 | 4 | 
| TqLoaAvl_Cnt_T_lgc | boolean | FALSE | TRUE | |
| Return Value | HwTqResp_Cnt_T_u08 | uint8 | 0 | 5 | 
Design Rationale
None
Processing
Refer to ‘HwTqResp’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1/Request_Responses’
Local Function #4
| Function Name | ReqMotAgResp | Type | Min | Max | 
| Arguments Passed | MotAgIdptMin_Cnt_T_u08 | uint8 | 0 | 3 | 
| MotAgSnsrlsAvl_Cnt_T_logl | boolean | FALSE | TRUE | |
| Return Value | MotAgResp_Cnt_T_u08 | uint8 | 0 | 5 | 
Design Rationale
None
Processing
Refer to ‘MotAgResp’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1/Request_Responses’
Local Function #5
| Function Name | ReqCurrMeasResp | Type | Min | Max | 
| Arguments Passed | CurrMeasIdptMin_Cnt_T_u08 | uint8 | 0 | 2 | 
| Return Value | CurrMeasResp_Cnt_T_u08 | uint8 | 0 | 5 | 
Design Rationale
None
Processing
Refer to ‘CurrMeasResp’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1/Request_Responses’
Local Function #6
| Function Name | ReqInvtrResp | Type | Min | Max | 
| Arguments Passed | IvtrIdptMin_Cnt_T_u08 | uint8 | 0 | 2 | 
| Return Value | InvtrResp_Cnt_T_u08 | uint8 | 0 | 5 | 
Design Rationale
None
Processing
Refer to ‘CurrMeasResp’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1/Request_Responses’
Local Function #7
| Function Name | CntSwBasdMtgtnChk | Type | Min | Max | 
| Arguments Passed | Resp_Cnt_T_u08 | uint8 | 0 | 5 | 
| PrevMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| Return Value | MtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | 
Design Rationale
None
Processing
This function corresponds to common logic (for all requests) in ‘CntSwBasdMtgtn’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1/Arbitrate_Responses’
Local Function #8
| Function Name | SelFinalResp | Type | Min | Max | 
| Arguments Passed | MultiMtgtnResp_Cnt_T_u08 | uint8 | 0 | 5 | 
| HwTqResp_Cnt_T_u08 | uint8 | 0 | 5 | |
| MotAgResp_Cnt_T_u08 | uint8 | 0 | 5 | |
| CurrMeasResp_Cnt_T_u08 | uint8 | 0 | 5 | |
| InvtrResp_Cnt_T_u08 | uint8 | 0 | 5 | |
| Return Value | LoaSt_Cnt_T_enum | LoaSt1 | 0 | 5 | 
Design Rationale
None
Processing
This function corresponds to ‘SelFinalResp’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1/Arbitrate_Responses’
Local Function #9
| Function Name | SetFaults | Type | Min | Max | 
| Arguments Passed | LoaSt_Cnt_T_enum | LoaSt1 | 0 | 5 | 
| HwTqIdptMin_Cnt_T_u08 | uint8 | 0 | 4 | |
| MotAgIdptMin_Cnt_T_u08 | uint8 | 0 | 3 | |
| CurrMeasIdptMin_Cnt_T_u08 | uint8 | 0 | 2 | |
| IvtrIdptMin_Cnt_T_u08 | uint8 | 0 | 2 | |
| Return Value | None | 
Design Rationale
None
Processing
This function corresponds to ‘Set_Faults’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1’
Local Function #10
| Function Name | SwMtgtnEn | Type | Min | Max | 
| Arguments Passed | HwTqLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | 
| MotAgLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| CurrMeasLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| IvtrLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| VehSpeedMod_Cnt_T_enum | enum | STEERMOD_BASEPS | STEERMOD_FULLYATNMS | |
| *LoaSca_Uls_T_f32 | float32 | 0 | 1 | |
| *LoaRateLim_UlsPerSec_T_f32 | float32 | 0.01 | 500 | |
| Return Value | None | 
Design Rationale
None
Processing
This function corresponds to ‘SwMtgtn’ block in FDD at ‘SF049A_LoaMgr/LoaMgr/LoaMgrPer1/Assign_Scale’.
Note that ‘*LoaSca_Uls_T_f32’ and ‘*LoaRateLim_UlsPerSec_T_f32’ are the outputs of this function.
Local Function #11
| Function Name | LoaMgrCoder | Type | Min | Max | 
| Arguments Passed | CurrMeasLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | 
| IvtrLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| FetLoaMtgtnEna_Cnt_T_lgc | boolean | FALSE | TRUE | |
| Return Value | MotAndThermProtnLoaMod_Cnt_T_u08 | uint8 | 0 | 7 | 
Design Rationale
None
Processing
This function corresponds to ‘coder block in FDD at ‘SF049B_LoaMgr/LoaMgr/LoaMgrPer1/coder’ .
GLOBAL Function/Macro Definitions
None
Known Limitations with Design
None
UNIT TEST CONSIDERATION
To satisfy IF case inside function ‘LtchInp’, out of range values will need to be given for values passed to function.
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 | EA4 01.00.01 | 
| 3 | Software Naming Conventions.doc | EA4 01.00.00 | 
| 4 | Software Design and Coding Standards.doc | 2.1 | 
| 5 | FDD : SF049B_LoaMgr_Design | See Synergy sub project version | 
3 - LoaMgr_Review
Overview
Summary SheetSynergy Project
Davinci Files
Source Code
MDD
Integration Manual
PolySpace
Sheet 1: Summary Sheet

Sheet 2: Synergy Project
Sheet 3: Davinci Files
Sheet 4: Source Code
| Rev 1.2 | 8-Jun-15 | |||||||||||||||||||||||
| Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
| Source File Name: | LoaMgr.c | Source File Revision: | 1 | |||||||||||||||||||||
| Header File Name: | N/A | Header File Revision: | ||||||||||||||||||||||
| MDD Name: | LoaMgr_MDD.docx | Revision: | 1 | |||||||||||||||||||||
| FDD/SCIR/DSR/FDR/CM Name: | SF049B_LoaMgr_Design | Revision: | 1.0.0 | |||||||||||||||||||||
| Quality Check Items: | ||||||||||||||||||||||||
| Rationale is required for all answers of No | ||||||||||||||||||||||||
| Working EA4 Software Naming Convention followed: | ||||||||||||||||||||||||
| for variable names | Yes | Comments: | ||||||||||||||||||||||
| for constant names | Yes | Comments: | ||||||||||||||||||||||
| for function names | Yes | Comments: | ||||||||||||||||||||||
| for other names (component, memory | Yes | Comments: | ||||||||||||||||||||||
| mapping handles, typedefs, etc.) | ||||||||||||||||||||||||
| All paths assign a value to outputs, ensuring | Yes | 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 | ||||||||||||||||||||||||
| All variables are declared at the function level. | Yes | 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: | ||||||||||||||||||||||
| Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
| Component.h is included | N/A | Comments: | ||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||
| All execution-order-dependent code can be | N/A | Comments: | ||||||||||||||||||||||
| recognized by the compiler: [N80] | ||||||||||||||||||||||||
| All loops have termination conditions that ensure | N/A | Comments: | ||||||||||||||||||||||
| finite loop iterations: [N63] | ||||||||||||||||||||||||
| All divides protect against divide by zero | N/A | Comments: | ||||||||||||||||||||||
| if needed: [N65] | ||||||||||||||||||||||||
| All integer division and modulus operations | N/A | Comments: | ||||||||||||||||||||||
| handle negative numbers correctly: [N76] | ||||||||||||||||||||||||
| All typecasting and fixed point arithmetic, | N/A | Comments: | ||||||||||||||||||||||
| including all use of fixed point macros and | ||||||||||||||||||||||||
| 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 | N/A | Comments: | ||||||||||||||||||||||
| types handle msb==1 as intended: [N78] | ||||||||||||||||||||||||
| All pointer dereferencing protects against | Yes | 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 | N/A | Comments: List Anomaly or CR numbers | ||||||||||||||||||||||
| for any FDD corrections needed | ||||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||
| Change Owner: | Matthew Leser | Review Date : | 10/25/17 | |||||||||||||||||||||
| Lead Peer Reviewer: | Avinash James | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | Pratik J | Brendon Binder | ||||||||||||||||||||||


