This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - LrnPinionCentr_IntegrationManual
Integration Manual
For
LrnPinionCentr
VERSION: 1.0
DATE: 18-Sep-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 | ML | 1.0 | 18-Sep-2017 | 
Table of Contents
3.2 Global Functions(Non RTE) to be provided to Integration Project 7
4 Configuration REQUIREMeNTS 8
4.2 Configuration Files to be provided by Integration Project 8
4.3 Da Vinci Parameter Configuration Changes 8
4.4 DaVinci Interrupt Configuration Changes 8
4.5 Manual Configuration Changes 8
5 Integration DATAFLOW REQUIREMENTS 9
5.1 Required Global Data Inputs 9
5.2 Required Global Data Outputs 9
5.3 Specific Include Path present 9
Abbrevations And Acronyms
| Abbreviation | Description | 
| DFD | Design functional diagram | 
| MDD | Module design Document | 
| <ADD more to the table if applicable> | |
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> | Process 04.02.00 | 
| <2> | <Software Naming Conventions> | Process 04.02.00 | 
| <3> | <Coding standards> | Process 04.02.00 | 
| <4> | FDD – SF024A_LrnPinionCentr_Design | See Synergy Subproject version | 
Dependencies
SWCs
| Module | Required Feature | 
| None | 
Note : Referencing the external components should be avoided in most cases. Only in unavoidable circumstance external components should be referred. Developer should track the references.
Global Functions(Non RTE) to be provided to Integration Project
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 .m file
Required Global Data Outputs
Refer .m file
Specific Include Path present
None
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger | 
| LrnPinionCentrInit1 | None | RTE Init | 
| LrnPinionCentrPer1 | None | 2 ms | 
| Runnable | Scheduling Requirements | Trigger | 
| SetInpPrm | None | On Event | 
Memory Map REQUIREMENTS
Mapping
| Memory Section | Contents | Notes | 
| None | ||
| LrnPinionCentr_START_SEC_CODE | 
* 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 - LrnPinionCentr_MDD
Module Design Document
For
LrnPinionCentr
12-Jan-2018
Prepared By:
Brendon Binder,
Nexteer Automotive,
Saginaw, MI, USA
Change History
| Description | Author | Version | Date | 
| Initial Version | ML | 1.0 | 18-Sep-2017 | 
| Updated DaVinci graphic for Cal name change | BRB | 2.0 | 12-Jan-2018 | 
Table of Contents
1 Introduction 5
1.1 Purpose 5
1.2 Scope 5
2 LrnPinionCentr & High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of LrnPinionCentr 7
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 Sub-Module Functions 9
5.1.1 Init: LrnPinionCentrInit1 9
5.1.1.1 Design Rationale 9
5.1.2 Per: LrnPinionCentrPer1 9
5.1.2.1 Design Rationale 9
5.2 Server Runnable 9
5.2.1 SetInpPrm 9
5.3 Interrupt Functions 9
5.4 Module Internal (Local) Functions 9
5.4.1 Local Function #1 9
5.4.1.1 Description 9
5.4.2 Local Function #2 9
5.4.2.1 Description 10
5.4.3 Local Function #3 10
5.4.3.1 Description 10
5.4.4 Local Function #4 10
5.4.4.1 Description 10
5.4.5 Local Function #5 10
5.4.5.1 Description 11
5.4.6 Local Function #6 11
5.4.6.1 Description 11
5.5 GLOBAL Function/Macro Definitions 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
LrnPinionCentr & High-Level Description
Refer FDD.
Design details of software module
Graphical representation of LrnPinionCentr

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 | 
|---|---|---|---|
| Refer DataDict.m file from FDD for other constants | - | - | - | 
Software Component Implementation
Sub-Module Functions
Init: LrnPinionCentrInit1
Refer FDD Simulink model
Design Rationale
Refer to Anomaly EA4#17174. Implementation deviates to fix this issue for build.
Per: LrnPinionCentrPer1
Refer FDD Simulink Model
Design Rationale
None
Server Runnable
SetInpPrm
Refer FDD Simulink Model
Interrupt Functions
None
Module Internal (Local) Functions
Local Function #1
| Function Name | RunMinMax | Type | Min | Max | 
| Arguments Passed | HwAg_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | 
| PinionCentrLrnEna_Cnt_T_logl | boolean | FALSE | TRUE | |
| *MaxHwPosn_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | |
| *MinHwPosn_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | |
| Return Value | None | 
Description
Implementation of ‘Running MinMax’ function.
Local Function #2
| Function Name | PosAgVelStCtrl1 | Type | Min | Max | 
| Arguments Passed | HwAg_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | 
| MotVelCrf_MotRadPerSec_T_f32 | float32 | -1350.0 | 1350.0 | |
| TarMotVel_MotRadPerSec_T_f32 | float32 | 0.0 | 1600.0 | |
| *PinionCentrLrnSt_Cnt_T_u08 | uint8 | 0 | 7 | |
| *TqCmd_MotNwtMtr_T_f32 | float32 | -8.8 | 8.8 | |
| *MotPosnCmd_MotRad_T_f32 | float32 | -1440.0 | 1440.0 | |
| Return Value | None | 
Description
Implementation of ‘POSANGVEL State Control 1’ function.
Local Function #3
| Function Name | PosMotTqStCtrl2 | Type | Min | Max | 
| Arguments Passed | *PinionCentrLrnSt_Cnt_T_u08 | uint8 | 0 | 7 | 
| *TqCmd_MotNwtMtr_T_f32 | float32 | -8.8 | 8.8 | |
| *MotPosnCmd_MotRad_T_f32 | float32 | -1440.0 | 1440.0 | |
| Return Value | None | 
Description
Implementation of ‘POSMTRTRQ State Control 2’ function.
Local Function #4
| Function Name | NegAgVelStCtrl3 | Type | Min | Max | 
| Arguments Passed | HwAg_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | 
| MotVelCrf_MotRadPerSec_T_f32 | float32 | -1350.0 | 1350.0 | |
| TarMotVel_MotRadPerSec_T_f32 | float32 | 0.0 | 1600.0 | |
| *PinionCentrLrnSt_Cnt_T_u08 | uint8 | 0 | 7 | |
| *TqCmd_MotNwtMtr_T_f32 | float32 | -8.8 | 8.8 | |
| *MotPosnCmd_MotRad_T_f32 | float32 | -1440.0 | 1440.0 | |
| Return Value | None | 
Description
Implementation of ‘NEGANGVEL State Control 3’ function.
Local Function #5
| Function Name | NegMotTqStCtrl4 | Type | Min | Max | 
| Arguments Passed | MaxHwPosn_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | 
| MinHwPosn_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | |
| *PinionCentrLrnSt_Cnt_T_u08 | uint8 | 0 | 7 | |
| *TqCmd_MotNwtMtr_T_f32 | float32 | -8.8 | 8.8 | |
| *MotPosnCmd_MotRad_T_f32 | float32 | -1440.0 | 1440.0 | |
| Return Value | None | 
Description
Implementation of ‘NEGMTRTRQ State Control 4’ function.
Local Function #6
| Function Name | MoveToStCtrl5 | Type | Min | Max | 
| Arguments Passed | HwAg_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | 
| TarHwAg_HwDeg_T_f32 | float32 | -1440.0 | 1440.0 | |
| MotVelCrf_MotRadPerSec_T_f32 | float32 | -1350.0 | 1350.0 | |
| TarMotVel_MotRadPerSec_T_f32 | float32 | 0.0 | 1600.0 | |
| *PinionCentrLrnSt_Cnt_T_u08 | uint8 | 0 | 7 | |
| *TqCmd_MotNwtMtr_T_f32 | float32 | -8.8 | 8.8 | |
| *MotPosnCmd_MotRad_T_f32 | float32 | -1440.0 | 1440.0 | |
| Return Value | None | 
Description
Implementation of ‘MOVETO State Control 5’ function.
GLOBAL Function/Macro Definitions
None
Known Limitations with Design
None
UNIT TEST CONSIDERATION
None
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.4.0 R4.0 Rev 3 | 
| 2 | MDD Guideline | EA4 01.00.01 | 
| 3 | Software Naming Conventions.doc | 1.0 | 
| 4 | Software Design and Coding Standards.doc | 2.01 | 
| 5 | FDD – SF024A_LrnPinionCentr_Design | See Synergy Subproject verison | 
3 - LrnPinionCentr_PeerReviewChecklist
Overview
Summary SheetDavinci Files
Source Code
PolySpace
MDD
Synergy Project
Sheet 1: Summary Sheet
Sheet 2: Davinci Files
Sheet 3: Source Code
Sheet 4: PolySpace
Sheet 5: MDD
| Rev 2.00 | 29-Nov-17 | |||||||||||||||||||||||
| Nexteer SWC Implementation Peer Review Meeting Log (MDD Review) | ||||||||||||||||||||||||
| MDD Name: | LrnPinionCentr_MDD.docx | MDD Revision: | 2 | |||||||||||||||||||||
| Source File Name: | LrnPinionCentr.c | Source File Revision: | 2 | |||||||||||||||||||||
| Source File Name: | Source File Revision: | |||||||||||||||||||||||
| Source File Name: | Source File Revision: | |||||||||||||||||||||||
| Quality Check Items: | ||||||||||||||||||||||||
| Rationale is required for all answers of No | ||||||||||||||||||||||||
| Synergy version matches document | Yes | Comments: | ||||||||||||||||||||||
| Change log contains detailed description of changes | Yes | Comments: | ||||||||||||||||||||||
| Changes Highlighted (for Unit Tester) | Yes | Comments: | ||||||||||||||||||||||
| Diagrams have been included per MDD Guideline | Yes | Comments: | ||||||||||||||||||||||
| and reviewed | ||||||||||||||||||||||||
| All Design Exceptions and Limitations are listed | N/A | Comments: | ||||||||||||||||||||||
| Design rationale given for all global | N/A | Comments: | ||||||||||||||||||||||
| data not communicated through RTE ports, per | ||||||||||||||||||||||||
| Design and Coding Standards rules [N9] and [N10]. | ||||||||||||||||||||||||
| All implementation details that differ from the SWC | N/A | Comments: | ||||||||||||||||||||||
| Design are noted and explained in Design Rationale | ||||||||||||||||||||||||
| All Unit Test Considerations have been described | Yes | Comments: | ||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||
| Review Board: | ||||||||||||||||||||||||
| Change Owner: | Brendon Binder | Review Date : | 01/12/18 | |||||||||||||||||||||
| Lead Peer Reviewer: | Shawn Penning | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | Bri Spencer | |||||||||||||||||||||||
| Rationale/justification for items marked "No" approved by: | ||||||||||||||||||||||||
Sheet 6: Synergy Project
| Rev 2.00 | 29-Nov-17 | |||||||||||||||||||||||
| Peer Review Meeting Log (Component Synergy Project Review) | ||||||||||||||||||||||||
| Quality Check Items: | ||||||||||||||||||||||||
| Rationale is required for all answers of No | ||||||||||||||||||||||||
| New baseline version name from Summary Sheet follows | Yes | Comments: | ||||||||||||||||||||||
| naming convention | ||||||||||||||||||||||||
| Project contains necessary subprojects | Yes | Comments: | ||||||||||||||||||||||
| Project contains the correct version of subprojects | Yes | Comments: | ||||||||||||||||||||||
| Design subproject is correct version | Yes | Comments: | ||||||||||||||||||||||
| .gpj file in tools folder matches .gpj generated by TL109 script | Yes | Comments: | ||||||||||||||||||||||
| File/folder structure is correct per documentation in | Yes | Comments: | ||||||||||||||||||||||
| TL109A_SwcSuprt | ||||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||
| Review Board: | ||||||||||||||||||||||||
| Change Owner: | Brendon Binder | Review Date : | 01/12/18 | |||||||||||||||||||||
| Lead Peer Reviewer: | Shawn Penning | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | Bri Spencer | |||||||||||||||||||||||
| Rationale/justification for items marked "No" approved by: | ||||||||||||||||||||||||



