1 - EotProtnFwl_Integration Manual

Integration Manual

For

SF027A_EotProtnFwl

VERSION: 1.0

DATE: 01-Feb-2016

Prepared By:

Sarika Natu,

KPIT Technologies,

India

Location: The official version of this document is stored in the Nexteer Configuration Management System.

Revision History

DescriptionAuthorVersionDate
Initial versionSarika Natu1.001-Feb-2016

Table of Contents

1 Abbrevations And Acronyms 4

2 References 5

3 Dependencies 6

3.1 SWCs 6

3.2 Global Functions(Non RTE) to be provided to Integration Project 6

4 Configuration REQUIREMeNTS 7

4.1 Build Time Config 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

6 Runnable Scheduling 9

7 Memory Map REQUIREMENTS 10

7.1 Mapping 10

7.2 Usage 10

7.3 NvM Blocks 10

8 Compiler Settings 11

8.1 Preprocessor MACRO 11

8.2 Optimization Settings 11

9 Appendix 12

Abbrevations And Acronyms

AbbreviationDescription
DFDDesign functional diagram
MDDModule 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.TitleVersion
1MDD GuidelineEA4 01.00.00
2Software Naming Conventions.doc2.0
3Software Design and Coding Standards.doc2.1
4AUTOSAR Specification of Memory Mapping (Link:AUTOSAR_SWS_MemoryMapping.pdf)v1.3.0 R4.0 Rev 2
5SF027_EotProtnFwl_DesignRefer Synergy subproject version

Dependencies

SWCs

ModuleRequired Feature
None

Global Functions(Non RTE) to be provided to Integration Project

None

Configuration REQUIREMeNTS

Build Time Config

ModulesNotes
None

Configuration Files to be provided by Integration Project

None

Da Vinci Parameter Configuration Changes

ParameterNotesSWC
None

DaVinci Interrupt Configuration Changes

ISR NameVIM #Priority DependencyNotes
None

Manual Configuration Changes

ConstantNotesSWC
None

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.

InitScheduling RequirementsTrigger
EotProtnFwlInit1NoneRTE (Init)
RunnableScheduling RequirementsTrigger
EotProtnFwlPer1NoneRTE(2ms)

.

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
EotProtnFwl_START_SEC_CODE
EotProtnFwl_STOP_SEC_CODE

* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.

Usage

FeatureRAMROM
<Memmap usuage info>

Table 1: ARM Cortex R4 Memory Usage

NvM Blocks

None

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

2 - EotProtnFwl_MDD

Module Design Document

For

EotProtnFwl

Feb 01, 2016

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Sarika Natu,

KPIT Technologies,

India


Change History

DescriptionAuthorVersionDate
Initial VersionSarika Natu(KPIT Technologies)1.001-Feb-2016


Table of Contents

1 EotProtnFwl & High-Level Description 5

2 Design details of software module 6

2.1 Graphical representation of EotProtnFwl 6

2.2 Data Flow Diagram 6

2.2.1 Component level DFD 6

2.2.2 Function level DFD 6

3 Constant Data Dictionary 7

3.1 Program (fixed) Constants 7

3.1.1 Embedded Constants 7

4 Software Component Implementation 8

4.1 Sub-Module Functions 8

4.1.1 Init: EotProtnFwl_Init1 8

4.1.1.1 Design Rationale 8

4.1.1.2 Module Outputs 8

4.1.2 Per: EotProtnFwl_Per1 8

4.1.2.1 Design Rationale 8

4.1.2.2 Store Module Inputs to Local copies 8

4.1.2.3 (Processing of function)……… 8

4.1.2.4 Store Local copy of outputs into Module Outputs 8

4.2 Server Runables 8

4.3 Interrupt Functions 8

4.4 Module Internal (Local) Functions 8

4.4.1 Local Function #1 8

4.4.1.1 Design Rationale 9

4.4.1.2 Processing 9

4.4.2 Local Function #2 9

4.4.2.1 Design Rationale 9

4.4.2.2 Processing 9

4.5 GLOBAL Function/Macro Definitions 9

5 Known Limitations with Design 10

6 UNIT TEST CONSIDERATION 11

Appendix A Abbreviations and Acronyms 12

Appendix B Glossary 13

Appendix C References 14

EotProtnFwl & High-Level Description

EOT Protection Firewall function is safety function which imposes a firewall limit to the Assist_EOTDamping and EOTActvCmd motor commands generated by SF-018A.

Design details of software module

Graphical representation of EotProtnFwl

C:\Users\fzd2x9\Desktop\SF027A_EotProtnFwl_Impl.png

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

Refer FDD

Software Component Implementation

Sub-Module Functions

Init: EotProtnFwl_Init1

Design Rationale

Refer FDD

Module Outputs

Refer FDD

Per: EotProtnFwl_Per1

Design Rationale

EotProtnFwl_Per1 function is divided into various functions to reduce the cyclomatic complexity.

Store Module Inputs to Local copies

Refer FDD

(Processing of function)………

Refer FDD

Store Local copy of outputs into Module Outputs

Refer FDD

Server Runnables

None

Interrupt Functions

None

Module Internal (Local) Functions

Local Function #1

Function NameDetEOTDampingTypeMinMax
Arguments PassedEotDampgCmd_MotNwtMtr_T_f32float32-8.88.8
EotProtnDi_Cnt_T_Loglboolean01
HwAg_HwDeg_T_f32float32-1440.01440.0
MotVelCrf_MotRadPerSec_T_f32float32- 1118.01118.0
EotProtnFwlPinionAgConfSts_Cnt_T_Loglboolean01
VehSpd_Kph_T_u9p7uint160511
MfgEnaSt_Cnt_T_EnumEnum01
* EotDampgFwlReached_Cnt_T_Loglboolean01
Return by ValueEotDampgCmdLimd_MotNwtMtr_T_f32float32-8.88.8

Design Rationale

This function updates EotDampgFwlReached_Cnt_T_Logl

Processing

Refer Active/Inactive region for EOTDamping Command implementation in model

Local Function #2

Function NameDetEOTActiveTypeMinMax
Arguments PassedEotActvCmd_MotNwtMtr_T_f32float32-8.88.8
EotProtnDi_Cnt_T_Loglboolean01
HwAg_HwDeg_T_f32float32-1440.01440.0
EotProtnFwlPinionAgConfSts_Cnt_T_Loglboolean01
VehSpd_Kph_T_u9p7uint160511
MfgEnaSt_Cnt_T_EnumEnum01
* EotActvCmdFwlReached_Cnt_T_Loglboolean01
Return ValueEotActvCmdLimd_MotNwtMtr_T_f32float32-8.88.8

Design Rationale

This function updates EotActvCmdFwlReached_Cnt_T_Logl

Processing

Refer Active/Inactive region for EOT Active Command implementation in model

GLOBAL Function/Macro Definitions

None

Known Limitations with Design

None

UNIT TEST CONSIDERATION

None

Abbreviations and Acronyms

Abbreviation or AcronymDescription

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

TermDefinitionSource
MDDModule Design Document
DFDData Flow Diagram

References

Ref. #TitleVersion
1AUTOSAR Specification of Memory Mapping (Link:AUTOSAR_SWS_MemoryMapping.pdf)v1.3.0 R4.0 Rev 2
2MDD GuidelineEA4 01.00.00
3Software Naming Conventions.doc2.0
4Software Design and Coding Standards.doc2.1
5SF027_EotProtnFwl_DesginPlease refer synergy subproject version

3 - EotProtnFwl_PeerReviewChecklist


Overview

Summary Sheet
Synergy Project


Sheet 1: Summary Sheet
























Rev 1.28-Jun-15

Peer Review Summary Sheet


























Synergy Project Name:


kzshz2: Intended Use: Identify which component is being reviewed. This should be the Module Short Name from Synergy Rationale: Required for traceability. It will help to ensure this form is not attaced to the the wrong change request. SF027A_EotProtnFwl_Impl
Revision / Baseline:


kzshz2: Intended Use: Identify which Synergy revision of this component is being reviewed Rationale: Required for traceability. It will help to ensure this form is not attaced to the the wrong change request. SF027A_EotProtnFwl_Impl_1.1.1

























Change Owner:


kzshz2: Intended Use: Identify the developer who made the change(s) Rationale: A change request may have more than one resolver, this will help identify who made what change. Change owner identification may be required by indusrty standards. Nick Saxton
Work CR ID:


EA4#7501





























kzshz2: Intended Use: Intended to identify at a high level to the reviewers which areas of the component have been changed. Rationale: This will be good information to know when ensuring appropriate reviews have been completed. Modified File Types:















































































































































































kzshz2: Intended Use: Identify who where the reviewers, what they reviewed, and if the reviewed changes have been approved to release the code for testing. Comments here should be at a highlevel, the specific comments should be present on the specific review form sheet. Rationale: Since this Form will be attached to the Change Request it will confirm the approval and provides feedback in case of audits. ADD DR Level Move reviewer and approval to individual checklist form Review Checklist Summary:






















































Reviewed:
































MDD



Source Code



PolySpace










































Integration Manual



Davinci Files








































































Comments:

Change: Pulled in new design subproject to match code



























































































General Guidelines:
- The reviews shall be performed over the portions of the component that were modified as a result of the Change Request.
- New components should include FDD Owner and Integrator as apart of the Group Review Board (Source Code, Integration Manual, and Davinci Files)
- Enter any rework required into the comment field and select No. When the rework is complete, review again using this same review sheet and select Yes. Add date and additional comment stating that the rework is completed.
- To review a component with multiple source code files use the "Add Source" button to create a Source code tab for each source file.
- .h file should be reviewed with the source file as part of the source file.





















Sheet 2: Synergy Project

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:











































General Notes / Comments:



























































LN: Intended Use: Identify who were the reviewers and if the reviewed changes have been approved. Rationale: Since this Form will be attached to the Change Request it will confirm the approval and provides feedback in case of audits. KMC: Group Review Level removed in Rev 4.0 since the design review is not checked in until approved, so it would always be DR4. Review Board:


























Change Owner:

Nick Saxton
Review Date :

09/13/16


































Lead Peer Reviewer:


Krishna Anne
Approved by Reviewer(s):



Yes

































Other Reviewer(s):