This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - AssiSumLim_Integration Manual
Integration Manual
For
‘AssiSumLim’
VERSION: 1.0
DATE: 04-June-2015
Prepared By:
Sankardu Varadapureddi,
Nexteer Automotive,
Saginaw, MI, USA
Revision History
| Sl. No. | Description | Author | Version | Date | 
| 1 | Initial version | Sankardu Varadapureddi | 1.0 | 22-May-2015 | 
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 – SF004B_AssiSumLim_Design | See Synergy sub project version | 
| 2 | Software Naming Conventions | Process 3.06.00 | 
| 3 | Software Design and Coding Standards | Process 3.06.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 | 
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 | 
|---|---|---|
| AssiSumLimInit1 | None | Init | 
| Runnable | Scheduling Requirements | Trigger | 
|---|---|---|
| AssiSumLimPer1 SetManTqCmd_Oper | None None | 2ms on event | 
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 | 
|---|---|---|
| <Memmap usuage info> | 
Table 1: ARM Cortex R4 Memory Usage
Non RTE NvM Blocks
| Block Name | 
|---|
| None | 
RTE NvM Blocks
| Block Name | 
|---|
| None | 
Compiler Settings
Preprocessor MACRO
None.
Optimization Settings
None
Appendix
None
2 - AssiSumLim_MDD
Module Design Document
For
‘AssiSumLim’
VERSION: 3.0
DATE: 15-May-2017
Prepared By:
Shawn Penning,
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 | Sankardu Varadapureddi | 1.0 | 03-Jun-2015 | 
| 2 | Updated Graph , added Limitations, Updated Server Runnable Information | Matthew Leser | 2.0 | 15-May-2017 | 
| 3 | Removed application data types; PIM range correction noted | Shawn Penning | 3.0 | 14-Jun-2017 | 
Table of Contents
3 AssiSumLim High-Level Description 7
4 Design details of software module 8
4.1 Graphical representation of AssiSumLim 8
5.1 User defined typedef definition/declaration 10
5.2 Variable definition for enumerated types 10
6.1 Program(fixed) Constants 11
6.1.2 Module specific Lookup Tables Constants 11
7 Software Module Implementation 12
7.1.1 Initialization Functions 12
7.1.1.1 INIT: AssiSumLimInit1 12
7.1.2.1 Per: AssiSumLimPer1 12
7.1.2.1.2 Store Module Inputs to Local copies 12
7.1.2.1.3 (Processing of function)……… 12
7.1.2.1.4 Store Local copy of outputs into Module Outputs 12
7.1.4.1.2 Store Module Inputs to Local copies 13
7.1.4.1.3 (Processing of function)……… 13
7.1.4.1.4 Store Local copy of outputs into Module Outputs 13
7.1.5 Local Function/Macro Definitions 13
7.1.6 GLObAL Function/Macro Definitions 13
7.1.7 Tranisition FUNCTIONS 13
8 Known Limitations With Design 14
Abbrevations And Acronyms
| Abbreviation | Description | 
|---|---|
| DFD | Design functional diagram | 
| MDD | Module design Document | 
| FDD | Functional 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 | Process 3.06.00 | 
| 2 | Software Naming Conventions | 2.0 | 
| 3 | Software Design and Coding standards | 2.1 | 
| 4 | FDD - SF004B_AssiSumLim_Design | See Synergy sub project version | 
AssiSumLim High-Level Description
Design details of software module
Graphical representation of AssiSumLim

Data Flow Diagram
Refer FDD
Module level DFD
Refer FDD
Sub-Module level DFD
Refer FDD
COMPONENT FLOW DIAGRAM
Refer FDD
Variable Data Dictionary
User defined typedef definition/declaration
<This section documents any user types uniquely used for the module.>
| Typedef Name | Element Name | User Defined Type | Legal Range (min) | Legal Range (max) | 
|---|---|---|---|---|
| None | ||||
Variable definition for enumerated types
| Enum Name | Element Name | Value | 
|---|---|---|
| None | 
Constant Data Dictionary
Program(fixed) Constants
Embedded Constants
Local
| Constant Name | Resolution | Units | Value | 
|---|---|---|---|
Note: Refer .m file for constants definitions.
Global
| Constant Name | 
|---|
| None | 
Module specific Lookup Tables Constants
| Constant Name | Resolution | Value | Software Segment | 
|---|---|---|---|
| None | 
Software Module Implementation
Sub-Module Functions
Initialization Functions
AssiSumLimInit1
INIT: AssiSumLimInit1
Design Rationale
Design follows implemenetation in FDD.
Module Outputs
Refer ‘AssiSumLimInit1’ block in FDD
Module Internal
None
PERIODIC FUNCTIONS
Per: AssiSumLimPer1
Design Rationale
Design follows implementation in FDD.
Store Module Inputs to Local copies
Refer to FDD
(Processing of function)………
Refer to FDD (Block ‘AssiSumLmtPer1’)
Store Local copy of outputs into Module Outputs
Refer to FDD
Interrupt Functions
None
Server runnables
SetManTqCmd
| Function Name | SetManTqCmd_Oper | Type | Min | Max | |
| Arguments Passed | VehSpd_Kph_T_f32 | float32 | 0.0F | 511.0F | |
| ManTqCmd | float32 | -8.8 | 8.8 | ||
| ManTqCmdEna | boolean | FALSE | TRUE | ||
| Return Value | ManTqCmdRtn_Uls_T_enum | Std_ReturnType | 0 | 1 | |
Design Rationale
Argument names should have _arg added to end of names for ManTqCmd and ManTqCmdEna.
Store Module Inputs to Local copies
None
(Processing of function)………
Refer ‘SetManTqCmd’ block in FDD
Store Local copy of outputs into Module Outputs
None
Local Function/Macro Definitions
None
GLObAL Function/Macro Definitions
None
Tranisition FUNCTIONS
None
Known Limitations With Design
.
Tustin Filter does not have a library block in design or code (could be added to component after CR EA4#6619 is completed).
SetNtcSts.CallLocation should include AssiSumLimInit1 in DataDict.m (see CR EA4#12283).
Range for MotVelFilLp is incorrect and could cause overflow. Should be max of 1350, not 62500. This will be addressed in future design with CR EA4#12743.
UNIT TEST CONSIDERATION
None
Appendix
None
3 - AssiSumLim_PeerReview
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: | AssiSumLim.c | Source File Revision: | 5 | |||||||||||||||||||||
| Header File Name: | N/A | Header File Revision: | ||||||||||||||||||||||
| MDD Name: | AssiSumLim_MDD.docx | Revision: | 3 | |||||||||||||||||||||
| FDD/SCIR/DSR/FDR/CM Name: | SF004B_AssiSumLim_Design | Revision: | 2.2.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 | ||||||||||||||||||||||||
| 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: | ||||||||||||||||||||||
| Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
| Component.h is included | N/A | Comments: | ||||||||||||||||||||||
| All other includes are actually needed. (System includes | N/A | Comments: | ||||||||||||||||||||||
| only allowed in Nexteer library components) | ||||||||||||||||||||||||
| Software Design and Coding Standards followed: | Version: 2.1 | |||||||||||||||||||||||
| Code comments are clear, correct, and adequate | N/A | 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 | N/A | 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 | N/A | 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 | N/A | Comments: | ||||||||||||||||||||||
| null pointer if needed: [N70] | ||||||||||||||||||||||||
| Component outputs are limited to the legal range | N/A | 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 : | 11/16/17 | |||||||||||||||||||||
| Lead Peer Reviewer: | Steven Horwath | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||



