This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - Assi_IntegrationManual
Integration Manual
For
Assist
VERSION: 1.0
DATE: <02-JUN-2015>
Prepared By:
Spandana Balani
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 | Spandana Balani | 1.0 | 02-Jun-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 |
<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 4.00.00 |
<2> | <Software Naming Conventions> | Process 4.00.00 |
<3> | <Coding standards> | Process 4.00.00 |
<4> | FDD – SF001A_Assi_Design | See Synergy Subproject version |
<Add if more available> |
Dependencies
SWCs
Module | Required Feature |
None | N/A |
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
None
Configuration REQUIREMeNTS
Build Time Config
Constants | Notes | |
FLTINJENA | Set to STD_ON for Fault injection |
Configuration Files to be provided by Integration Project
<Configuration file that will generated from this components that will require Da Vinci Config generation or manual generation. Describe each parameter >
Da Vinci Parameter Configuration Changes
Parameter | Notes | SWC |
N/A |
DaVinci Interrupt Configuration Changes
ISR Name | VIM # | Priority Dependency | Notes |
N/A |
Manual Configuration Changes
Constant | Notes | SWC |
N/A |
Integration DATAFLOW REQUIREMENTS
Required Global Data Inputs
Refer DataDict.m file
Required Global Data Outputs
Refer DataDict.m file
Specific Include Path present
No
Runnable Scheduling
This section specifies the required runnable scheduling.
Init | Scheduling Requirements | Trigger |
None |
Runnable | Scheduling Requirements | Trigger |
AssiPer1 | None | RTE(2ms) |
.
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 - Assi_MDD
Module Design Document
For
Assist
VERSION: 2.0
DATE: 09-AUG-2016
Prepared By:
Nick Saxton
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 | SB | 1.0 | 02-JUN-2015 |
2 | Quality update | NS | 2.0 | 09-AUG-2016 |
Table of Contents
3 Assi & High-Level Description 7
4 Design details of software module 8
4.1 Graphical representation of Assi 8
5.1 User defined typedef definition/declaration 9
5.2 Variable definition for enumerated types 9
6.1 Program(fixed) Constants 10
6.1.2 Module specific Lookup Tables Constants 10
7 Software Module Implementation 11
7.2 Initialization Functions 11
7.3.1.2 Store Module Inputs to Local copies 11
7.3.1.3 (Processing of function)……… 11
7.3.1.4 Store Local copy of outputs into Module Outputs 11
7.6 Serial Communication Functions 12
7.7 Local Function/Macro Definitions 12
7.8 GLObAL Function/Macro Definitions 12
9 Known Limitations With Design 14
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 4.00.00 |
<2> | <Software Naming Conventions> | Process 4.00.00 |
<3> | <Coding standards> | Process 4.00.00 |
<4> | FDD - SF001A_Assi_Design | See Synergy Subproject version |
<Add if more available> |
Assi & High-Level Description
Refer FDD
Design details of software module
Graphical representation of Assi
Data Flow Diagram
Module level DFD
Sub-Module level DFD
COMPONENT FLOW DIAGRAM
Variable Data Dictionary
User defined typedef definition/declaration
Typedef Name | Element Name | User Defined Type | Legal Range (min) | Legal Range (max) |
N/A | ||||
Variable definition for enumerated types
Enum Name | Element Name | Value |
N/A | <(Variable name qualified Refer[2])> | <Define the value > |
Constant Data Dictionary
Program(fixed) Constants
Embedded Constants
< All program specific constants will be defined in detail >
Local
Constant Name | Resolution | Units | Value |
Refer constants from .m file |
Global
<This section lists the global constants used by the module. For details on global constants, refer to the Data Dictionary for the application>
Constant Name |
Refer constants from .m file |
Module specific Lookup Tables Constants
<(This is for lookup tables (arrays) with fixed values, same name as other tables)>
Constant Name | Resolution | Value | Software Segment |
Refer .m file |
Software Module Implementation
Sub-Module Functions
NONE
Initialization Functions
None
PERIODIC FUNCTIONS
(Note: For multiple periodic functions, insert new headers at the “Header 2” level – subset of “7.3 Periodic Functions” and follow the same sub-section design shown below). If none required, place the text “None”)>
Per: Assiper1
Design Rationale
Fault Injection client call is conditional compiled based on “FLTINJENA” build constant.
Store Module Inputs to Local copies
Refer to FDD
(Processing of function)………
Refer to FDD
Store Local copy of outputs into Module Outputs
Refer to FDD
Non PERIODIC FUNCTIONS
None
Interrupt Functions
None
Serial Communication Functions
None
Local Function/Macro Definitions
None
GLObAL Function/Macro Definitions
None
TRANSIENT FUNCTIONS
Unit Test Considerations
None
Known Limitations With Design
Appendix
3 - Assi_PeerReview
Overview
Summary SheetSynergy Project
Davinci Files
Source Code
MDD
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: | Assi.c | Source File Revision: | 5 | |||||||||||||||||||||
Header File Name: | N/A | Header File Revision: | ||||||||||||||||||||||
MDD Name: | Assi_MDD.docx | Revision: | 2 | |||||||||||||||||||||
FDD/SCIR/DSR/FDR/CM Name: | SF001A_Assi_Design | Revision: | 1.5.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 | Yes | 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 | 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 | N/A | 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 | N/A | 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: | Nick Saxton | Review Date : | 08/11/16 | |||||||||||||||||||||
Lead Peer Reviewer: | Krishna Anne | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
Other Reviewer(s): | ||||||||||||||||||||||||
Sheet 5: MDD
Sheet 6: PolySpace
4 - requirements
FDD | ID | Source | Function | Line(s) | Status | Comment |
---|---|---|---|---|---|---|
.SwFileName | .SwFuncName | .SwLines | .SwStatus | .SwComment | ||
SF001A | 568 | Assi.c | AssiPer1 | 277 | I | |
SF001A | 569 | Assi.c | AssiPer1 | 278 | I | |
SF001A | 584 | Assi.c | AssiPer1 | 285 | I | |
SF001A | 585 | Assi.c | AssiPer1 | 287 | I | |
SF001A | 595 | Assi.c | AssiPer1 | 344-347 | I | |
SF001A | 593 | Assi.c | AssiPer1 | 342 | I | |
SF001A | 587 | Assi.c | AssiPer1 | 297-306 | I | |
SF001A | 573 | Assi.c | AssiPer1 | 276 | I | |
SF001A | 572 | Assi.c | AssiPer1 | 270 | I | |
SF001A | 571 | Assi.c | AssiPer1 | 271 | I | |
SF001A | 570 | Assi.c | AssiPer1 | 272 | I | |
SF001A | 590 | Assi.c | AssiPer1 | 338 | I | |
SF001A | 565 | Assi.c | AssiPer1 | 273 | I | |
SF001A | 566 | Assi.c | AssiPer1 | 274 | I | |
SF001A | 567 | Assi.c | AssiPer1 | 275 | I | |
SF001A | 575 | Assi.c | AssiPer1 | 355 | I | |
SF001A | 596 | Assi.c | AssiPer1 | 349 | I | |
SF001A | 588 | Assi.c | AssiPer1 | 308-317 | I | |
SF001A | 591 | Assi.c | AssiPer1 | 338 | I | |
SF001A | 589 | Assi.c | AssiPer1 | 319-329 | I | |
SF001A | 586 | Assi.c | AssiPer1 | 290 | I |