This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - Swp_DesignReview
Overview
Summary SheetSynergy Project
Davinci Files
Source Code
MDD
PolySpace
Integration Manual
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: | Swp.c | Source File Revision: | 2 | |||||||||||||||||||||
Header File Name: | Swp.h | Header File Revision: | ||||||||||||||||||||||
MDD Name: | Swp_MDD | Revision: | 2 | |||||||||||||||||||||
FDD/SCIR/DSR/FDR/CM Name: | DF002A_Swp_Design | Revision: | 1.6.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 | Req Tags are not available in the design. | |||||||||||||||||||||||
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 | init version | |||||||||||||||||||||||
Code accurately implements FDD (Document or Model) | Yes | Comments: | ||||||||||||||||||||||
Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
Component.h is included | Yes | Comments: | ||||||||||||||||||||||
All other includes are actually needed. (System includes | Yes | Comments: | ||||||||||||||||||||||
only allowed in Nexteer library components) | ||||||||||||||||||||||||
Software Design and Coding Standards followed: | Version: | |||||||||||||||||||||||
Code comments are clear, correct, and adequate | Yes | Comments: | ||||||||||||||||||||||
and have been updated for the change: [N40] and | Deviations exist for DFs | |||||||||||||||||||||||
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 | Yes | Comments: | ||||||||||||||||||||||
is per standard | ||||||||||||||||||||||||
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] | ||||||||||||||||||||||||
All divides protect against divide by zero | Yes | Comments: | ||||||||||||||||||||||
if needed: [N65] | ||||||||||||||||||||||||
All integer division and modulus operations | Yes | Comments: | ||||||||||||||||||||||
handle negative numbers correctly: [N76] | ||||||||||||||||||||||||
All typecasting and fixed point arithmetic, | Yes | 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 | Yes | 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: | Krishna Anne | Review Date : | 02/08/16 | |||||||||||||||||||||
Lead Peer Reviewer: | Kathleen Creager | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
Other Reviewer(s): | ||||||||||||||||||||||||
Sheet 5: MDD
Sheet 6: PolySpace
Sheet 7: Integration Manual
2 - Swp_IntegrationManual
Integration Manual
For
Swp
VERSION: 2.0
DATE: 01-Feb-2016
Prepared By:
Krishna Kanth Anne,
Software Engineering,
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 | Krishna Kanth Anne | 1.0 | 20-Oct-15 |
2 | Fix for anomaly EA4#2461 | Krishna Kanth Anne | 2.0 | 01-Feb-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 |
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 | Process 04.02.00 |
2 | Software Naming Conventions | Process 04.02.00 |
3 | Coding standards | Process 04.02.00 |
4 | FDD : DF002A_Swp_Design | See Synergy Subproject 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 | |
Swp | Set to STD_ON for Sweep software build, set to STD_OFF for normal build. Constant resides in “Swp.h” file. |
Configuration Files to be provided by Integration Project
None
Da Vinci Parameter Configuration Changes
Parameter | Notes | SWC |
NA |
DaVinci Interrupt Configuration Changes
ISR Name | VIM # | Priority Dependency | Notes |
NA |
Manual Configuration Changes
Constant | Notes | SWC |
NA |
Integration DATAFLOW REQUIREMENTS
Required Global Data Inputs
Please refer DataDict.m file
Required Global Data Outputs
Please refer DataDict.m file
Specific Include Path present
Swp.h file shall have to be included.
Runnable Scheduling
This section specifies the required runnable scheduling.
Init | Scheduling Requirements | Trigger |
SwpInit1 | RTE_Init |
Runnable | Scheduling Requirements | Trigger |
SwpPer1 | None | RTE(2ms) |
Runnable | Scheduling Requirements | Trigger |
SwpPer2 | None | RTE(2ms) |
Memory Map REQUIREMENTS
Mapping
Memory Section | Contents | Notes |
Swp_START_SEC_CODE | Swp code and variables | This code section statement will contain variables that need mapping to GlobalShared memory during Sweep builds (these variables are present when SWPENA == STD_ON) |
* 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
3 - Swp_MDD
Module Design Document
For
Swp
Jan 20, 2016
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
Krishna Kanth Anne,
Nexteer Automotive,
Saginaw, MI, USA
Change History
Description | Author | Version | Date |
Initial Version | Krishna Kanth Anne | 1.0.0 | 20-Oct-2015 |
Fix for anomaly EA4#2461 | Krishna Kanth Anne | 1.1.0 | 20-Jan-2016 |
Table of Contents
2 PullCmpActv & High-Level Description 5
3 Design details of software module 6
3.1 Graphical representation of PullCmpActv 6
4.1 Program (fixed) Constants 7
5 Software Component Implementation 8
5.2 Module Internal (Local) Functions 8
6 Known Limitations with Design 9
Appendix A Abbreviations and Acronyms 11
Introduction
Purpose
MDD for Sweep function
Scope
NA
Swp & High-Level Description
Please refer FDD.
Design details of software module
Please refer FDD.
Graphical representation of Swp
Data Flow Diagram
Please refer FDD.
Component level DFD
Please refer FDD.
Function level DFD
Please refer FDD.
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
Local Constants
Constant Name | Resolution | Units | Value |
---|---|---|---|
Please refer DF002A_Swp_DataDict.m | NA | NA | NA |
SWPSTRT_CNT_U16 | NA | NA | 0 |
SWPTRAN_CNT_U16 | NA | NA | 1 |
SWPDWELL_CNT_U16 | NA | NA | 2 |
SWPSTOP_CNT_U16 | NA | NA | 3 |
SWPRAMP_CNT_U16 | NA | NA | 4 |
SWPDONE_CNT_U16 | NA | NA | 5 |
Software Component Implementation
Please refer FDD.
Sub-Module Functions
Init: SwpInit1
Please refer FDD.
Design Rationale
Dummy Initialization function to correlate with the FDD (.m file)
Per: SwpPer1
Please refer FDD.
Design Rationale
For DFs, it was decided to use the module level variables in place of PIMs defined in the FDD (PIM section of .m file), This is a deviation from regular EA4 process. This is to give control over MemMap to avoid MPU violations while writing these variables using xcp.
All of the given PIMs from .m file are either defined as of Function level variables (if used in only one function) or Module level variables (if used in more than one function) in DFs.
Each of the Function level and Module level variables shall be volatile only when they are intended to be user modifiable as per the data dictionary .m file.
Deviations exist in the naming conventions for all of Function level and Module level variables from regular EA4 naming conventions.
Per: SwpPer2
Please refer FDD.
Design Rationale
For DFs, it was decided to use the module level variables in place of PIMs defined in the FDD (PIM section of .m file), This is a deviation from regular EA4 process. This is to give control over MemMap to avoid MPU violations while writing these variables using xcp.
All of the given PIMs from .m file are either defined as of Function level variables (if used in only one function) or Module level variables (if used in more than one function) in DFs.
Each of the Function level and Module level variables shall be volatile only when they are intended to be user modifiable as per the data dictionary .m file.
Deviations exist in the naming conventions for all of Function level and Module level variables from regular EA4 naming conventions.
Known Limitations with Design
None.
UNIT TEST CONSIDERATION
Please refer Init.txt file in the FDD design: DF002A_Swp_Design for initial values of Function level and Module level variables.
For DFs, it was decided to use the module level variables in place of PIMs defined in the FDD (PIM section of .m file), This is a deviation from regular EA4 process.
All of the given PIMs from .m file are either defined as of Function level variables (if used in only one function) or Module level variables (if used in more than one function) in DFs.
Each of the Function level and Module level variables shall be volatile only when they are intended to be user modifiable as per the data dictionary .m file.
Deviations exist in the naming conventions for all of Function level and Module level variables from regular EA4 naming conventions.
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.00 |
3 | Software Naming Conventions.doc | 1.0 |
4 | Software Design and Coding Standards.doc | 2.0 |
5 | FDD: SF002A_Swp_Design | See Synergy SubProject version |