1 - FordMsg077BusHiSpd_IntegrationManual

Integration Manual

For

FordMsg077BusHiSpd

VERSION: 1.0

DATE: 04-MAY-2018

Prepared By:

TATA ELXSI,

INDIA

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

Revision History

Sl. No.DescriptionAuthorVersionDate
1Initial versionShishir Holenarasipura1.004-May-2018

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
FDDFunctional Design Document

References

This section lists the title & version of all the documents that are referred for development of this document

Sr. No.TitleVersion
1EA4 Software Naming Conventions1.02
2Software Design and Coding Standards2.01
3MM124A_FordMsg077BusHiSpd_DesignSee Synergy Sub Project Version

Dependencies

SWCs

ModuleRequired Feature
NoneN/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

ComIPduCallout_BrakeSnData_3_FD1, ComTimeoutNotification_VehLatComp_A_Actl

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 FDD

Required Global Data Outputs

Refer FDD

Specific Include Path present

None

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
FordMsg077BusHiSpdInit1NoneRTE(Init)
RunnableScheduling RequirementsTrigger
FordMsg077BusHiSpdPer1NoneRTE(10ms)

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
FordMsg077BusHiSpd_START_SEC_CODECode

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

Usage

FeatureRAMROM
N/A

Table 1: ARM Cortex R4 Memory Usage

NvM Blocks

None

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

2 - FordMsg077BusHiSpd_MDD

Module Design Document

For

FordMsg077BusHiSpd

02-May-2018

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

TATA ELXSI,

INDIA

Change History

Sl. No.DescriptionAuthorVersionDate
1Initial versionShishir Holenarasipura1.002-May-2018


Table of Contents

Table of Contents 3

1 Introduction 6

1.1 Purpose 6

1.2 Scope 6

2 FordMsg077BusHiSpd & High-Level Description 7

3 Design details of software module 8

3.1 Graphical representation of FordMsg077BusHiSpd 8

3.2 Data Flow Diagram 9

3.2.1 Component level DFD 9

3.2.2 Function level DFD 9

4 Constant Data Dictionary 10

4.1 Program (fixed) Constants 10

4.1.1 Embedded Constants 10

5 Software Component Implementation 11

5.1 Sub-Module Functions 11

5.1.1 Init: FordMsg077BusHiSpdInit1 11

5.1.2 Per: FordMsg077BusHiSpdPer1 11

5.2 Server Runnables 11

5.2.1 ComIPduCallout_BrakeSnData_3_FD1 11

5.2.1.1 Design Rationale 11

5.2.1.2 Processing of function 11

5.2.2 ComTimeoutNotification_VehLatComp_A_Actl 11

5.2.2.1 Design Rationale 11

5.2.2.2 Processing of function 11

5.3 Interrupt Functions 12

5.4 Module Internal (Local) Functions 12

5.4.1 Local Function #1 12

5.4.1.1 Design Rationale 12

5.4.1.2 Processing 12

5.4.2 Local Function #2 12

5.4.2.1 Design Rationale 13

5.4.2.2 Processing 13

5.4.3 Local Function #3 13

5.4.3.1 Design Rationale 13

5.4.3.2 Processing 13

5.4.4 Local Function #4 14

5.4.5 Design Rationale 14

5.4.5.1 Processing 14

5.4.6 Local Function #5 15

5.4.6.1 Design Rationale 15

5.4.6.2 Processing 15

5.4.7 Local Function #6 15

5.4.7.1 Design Rationale 15

5.4.7.2 Processing 15

5.4.8 Local Function #7 15

5.4.8.1 Design Rationale 16

5.4.8.2 Processing 16

5.4.9 Local Function #8 16

5.4.9.1 Design Rationale 16

5.4.9.2 Processing 16

5.4.10 Local Function #9 16

5.4.10.1 Design Rationale 16

5.4.10.2 Processing 16

5.4.11 Local Function #10 17

5.4.11.1 Design Rationale 17

5.4.11.2 Processing 17

5.4.12 Local Function #11 17

5.4.12.1 Design Rationale 17

5.4.12.2 Processing 17

5.4.13 Local Function #12 17

5.4.13.1 Design Rationale 18

5.4.13.2 Processing 18

5.4.14 Local Function #13 18

5.4.14.1 Design Rationale 18

5.4.14.2 Processing 18

5.4.15 Local Function #14 18

5.4.15.1 Design Rationale 18

5.4.15.2 Processing 19

5.4.16 Local Function #15 19

5.4.16.1 Design Rationale 19

5.4.16.2 Processing 19

5.4.17 Local Function #16 19

5.4.17.1 Design Rationale 19

5.4.17.2 Processing 19

5.4.18 Local Function #17 19

5.4.18.1 Design Rationale 20

5.4.18.2 Processing 20

5.4.19 Local Function #18 20

5.4.19.1 Design Rationale 20

5.4.19.2 Processing 20

5.5 GLOBAL Function/Macro Definitions 20

6 Known Limitations with Design 21

7 UNIT TEST CONSIDERATION 22

Appendix A Abbreviations and Acronyms 23

Appendix B Glossary 24

Appendix C References 25

Introduction

Purpose

Module Design Document for MM124A_FordMsg077BusHiSpd_Impl.

Scope

The following definitions are used throughout this document:

  • Shall: indicates a mandatory requirement without exception in compliance.

  • Should: indicates a mandatory requirement; exceptions allowed only with documented justification.

  • May: indicates an optional action.

FordMsg077BusHiSpd & High-Level Description

Refer the FDD.

Design details of software module

Graphical representation of FordMsg077BusHiSpd

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 NameResolutionUnitsValue
Refer .m file for constants

Software Component Implementation

Sub-Module Functions

The sub-module functions are grouped based on similar functionality that needs to be executed in a given “State” of the system (refer States and Modes). For a given module, the MDD will identify the type and number of sub-modules required. The sub-module types are described below.

Init: FordMsg077BusHiSpdInit1

Design Rationale

Refer FDD

Module Outputs

Refer FDD

Per: FordMsg077BusHiSpdPer1

Design Rationale

Refer FDD

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

ComIPduCallout_BrakeSnData_3_FD1

5.2.1.1 Design Rationale

None

5.2.1.2 Processing of function

None

ComTimeoutNotification_VehLatComp_A_Actl

5.2.2.1 Design Rationale

None

5.2.2.2 Processing of function

None

Interrupt Functions

None

Module Internal (Local) Functions

Local Function #1

Function NameDiagEnaTypeMinMax
Arguments PassedFordTqSteerCmpEnad_Cnt_T_loglboolean0U1U
FordBrkOscnRednEnad_Cnt_T_loglboolean0U1U
FordLaneKeepAssiEnad_Cnt_T_loglboolean0U1U
FordTrfcJamAssiEnad_Cnt_T_loglboolean0U1U
FordLaneCentrAssiEnad_Cnt_T_loglboolean0U1U
FordPullDriftCmpEnad_Cnt_T_loglboolean0U1U
FordTrlrBackUpAssiEnad_Cnt_T_loglboolean0U1U
FordEvasSteerAssiEnad_Cnt_T_loglboolean0U1U
FordCanDtcInhb_Cnt_T_loglboolean0U1U
FordClrDiagcFlgProxy_Cnt_T_loglboolean0U1U
*MissMsgDiagEna_Cnt_T_loglboolean0U1U
* FordVehLatACmpdInvldDiagEna_Cnt_T_loglboolean0U1U
*FordVehLgtACmpdInvldDiagEna_Cnt_T_loglboolean0U1U
*FordVehSpdOverGndInvldDiagEna_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/DiagEna

Local Function #2

Function NameCalSelnTypeMinMax
Arguments PassedFordEpsLifeCycMod_Cnt_T_u08uint80U1U
*BusHiSpdMissThd_MilliSec_T_u16uint160U6000U
*BusHiSpdLatACmpdInvldThd_MilliSec_T_u16uint160U6000U
*BusHiSpdLgtACmpdInvldThd_MilliSec_T_u16uint160U6000U
*BusHiSpdYawRateCmpdInvldThd_MilliSec_T_u16uint160U6000U
*BusHiSpdOverGndInvldThd_MilliSec_T_u16uint160U6000U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/CalSeln

Local Function #3

Function NameMissMsgTypeMinMax
Arguments PassedMissMsgDiagEna_Cnt_T_loglboolean0U1U
BusHiSpdMissTiThd_MilliSec_T_u16uint160U6000U
*FordVehLatACmpdRaw_Cnt_T_u16uint160U1023U
*FordVehLatACmpd_Cnt_T_f32float32-17.917.835
*FordVehLatACmpdVld_Cnt_T_loglboolean0U1U
*FordVehLgtACmpdRaw_Cnt_T_u16uint160U1023
*FordVehLgtACmpd_Cnt_T_f32float32-17.917.835
*FordVehLgtACmpdVld_Cnt_T_loglboolean0U1U
*FordVehYawRateCmpdRaw_Cnt_T_u16uint160U4095
*FordVehYawRateCmpd_Cnt_T_f32float32-7574.92659
*FordVehYawRateCmpdVld_Cnt_T_loglboolean0U1U
*FordVehSpdOverGndRaw_Cnt_T_u16uint160U65535
*FordVehSpdOverGnd_Kph_T_f32float320655.33
*FordVehSpdOverGndVld_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MissingMsgDetermination

Local Function #4

Function NameOutProcgTypeMinMax
Arguments PassedFord_VehLatComp_A_Actl_Cnt_T_enumFord_VehLatComp_A_Actl0U1023U
Ford_VehLongComp_A_Actl_Cnt_T_enumFord_VehLongComp_A_Actl0U1023U
Ford_VehYawComp_W_Actl_Cnt_T_enumFord_VehYawComp_W_Actl0U4095U
Ford_VehOverGnd_V_Est_Cnt_T_enumFord_VehOverGnd_V_Est0U65535U
*FordVehLatACmpdRaw_Cnt_T_u16uint160U1023U
*FordVehLatACmpd_Cnt_T_f32float32-17.917.835
*FordVehLatACmpdVld_Cnt_T_loglboolean0U1U
*FordVehLgtACmpdRaw_Cnt_T_u16uint160U1023U
*FordVehLgtACmpd_Cnt_T_f32float32-17.917.835
*FordVehLgtACmpdVld_Cnt_T_loglboolean0U1U
*FordVehYawRateCmpdRaw_Cnt_T_u16uint160U4095U
*FordVehYawRateCmpd_Cnt_T_f32float32-7574.92659
*FordVehYawRateCmpdVld_Cnt_T_loglboolean0U1U
*FordVehSpdOverGndRaw_Cnt_T_u16uint160U65535U
*FordVehSpdOverGnd_Kph_T_f32float320655.35
*FordVehSpdOverGndVld_Cnt_T_loglboolean0U1U
*FordVehLatACmpdVldInp_Cnt_T_loglboolean0U1U
*FordVehLgtACmpdInp_Cnt_T_loglboolean0U1U
*FordVehYawRateCmpdInp_Cnt_T_loglboolean0U1U
*FordVehSpdOverGndInp_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing

Local Function #5

Function NameVldElpdTiTypeMinMax
Arguments Passed*VehLatVldElpdTi_Cnt_T_loglboolean0U1U
*VehLatInvldElpdTi_Cnt_T_loglboolean0U1U
*VehLgtVldElpdTi_Cnt_T_loglboolean0U1U
*VehLgtInvldElpdTi_Cnt_T_loglboolean0U1U
*VehYawRateVldElpdTi_Cnt_T_loglboolean0U1U
*VehYawRateInvldElpdTi_Cnt_T_loglboolean0U1U
*VehSpdOverGndVldElpdTi_Cnt_T_loglboolean0U1U
*VehSpdOverGndInvldElpdTi_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/VldElpdTi

Local Function #6

Function NameVehLatVldElpdTiTypeMinMax
Arguments Passed*VehLatVldElpdTi_Cnt_T_loglboolean0U1U
*VehLatInvldElpdTi_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/VldElpdTi

Local Function #7

Function NameVehLgtVldElpdTiTypeMinMax
Arguments Passed*VehLgtVldElpdTi_Cnt_T_loglboolean0U1U
*VehLgtInvldElpdTi_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/VldElpdTi

Local Function #8

Function NameVehYawRateVldElpdTiTypeMinMax
Arguments Passed*VehYawRateVldElpdTi_Cnt_T_loglboolean0U1U
*VehYawRateInvldElpdTi_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/VldElpdTi

Local Function #9

Function NameVehSpdOverGndVldElpdTiTypeMinMax
Arguments Passed*VehSpdOverGndVldElpdTi_Cnt_T_loglboolean0U1U
*VehSpdOverGndInvldElpdTi_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/VldElpdTi

Local Function #10

Function NameVehLatAVldTypeMinMax
Arguments PassedFordVehLatACmpdVldInp_Cnt_T_loglboolean0U1U
VehLatVldElpdTi_Cnt_T_loglboolean0U1U
VehLatInvldElpdTi_Cnt_T_loglboolean0U1U
*FordVehLatACmpdVld_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/ChkElpdTi

Local Function #11

Function NameVehLgtAVldTypeMinMax
Arguments PassedFordVehLgtACmpdInp_Cnt_T_loglboolean0U1U
VehLgtVldElpdTi_Cnt_T_loglboolean0U1U
VehLgtInvldElpdTi_Cnt_T_loglboolean0U1U
*FordVehLgtACmpdVld_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/ChkElpdTi

Local Function #12

Function NameVehYawRateVldTypeMinMax
Arguments PassedFordVehYawRateCmpdInp_Cnt_T_loglboolean0U1U
VehYawRateVldElpdTi_Cnt_T_loglboolean0U1U
VehYawRateInvldElpdTi_Cnt_T_loglboolean0U1U
*FordVehYawRateCmpdVld_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/ChkElpdTi

Local Function #13

Function NameVehSpdOverGndVldTypeMinMax
Arguments PassedFordVehSpdOverGndInp_Cnt_T_loglboolean0U1U
VehSpdOverGndVldElpdTi_Cnt_T_loglboolean0U1U
VehSpdOverGndInvldElpdTi_Cnt_T_loglboolean0U1U
*FordVehSpdOverGndVld_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/OutputProcessing/ChkElpdTi

Local Function #14

Function NameMissMsgNtcPassTypeMinMax
Arguments PassedMissMsgDiagEna_Cnt_T_loglboolean0U1U
FordVehYawRateCmpdInp_Cnt_T_loglboolean0U1U
BusHiSpdYawRateCmpdInvldThd_Cnt_T_u16uint160U65535U
FordEvasSteerAssiEnad_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/MissMsgNtcPass

Local Function #15

Function NameFordVehLgtACmpdInvldNtcTypeMinMax
Arguments PassedFordVehLgtACmpdInvldDiagEna_Cnt_T_loglboolean0U1U
FordVehLgtACmpdInp_Cnt_T_loglboolean0U1U
BusHiSpdLgtACmpdInvldThd_Cnt_T_u16uint160U65535U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/FordVehLgtACmpdInvldNtc

Local Function #16

Function NameFordVehLatACmpdInvldDiagEnaPassTypeMinMax
Arguments PassedFordVehLatACmpdInvldDiagEna_Cnt_T_loglboolean0U1U
FordVehLatACmpdVldInp_Cnt_T_loglboolean0U1U
BusHiSpdLatACmpdInvldThd_Cnt_T_u16uint160U65535U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/FordVehLatACmpdInvldDiagEnaPass

Local Function #17

Function NameFordVehSpdOverGndInvldNtcTypeMinMax
Arguments PassedFordVehSpdOverGndInvldDiagEna_Cnt_T_loglboolean0U1U
BusHiSpdOverGndInvldThd_Cnt_T_u16uint160U65535U
FordVehSpdOverGndInp_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/MsgProcessing/FordVehSpdOverGndInvldNtc

Local Function #18

Function NameIsFeatActvTypeMinMax
Arguments PassedEnad_Cnt_T_loglboolean0U1U
Return ValueNA

Design Rationale

None

Processing

Please refer to the below path in the FDD model.

MM124A_FordMsg077BusHiSpd/FordMsg077BusHiSpd/FordMsg077BusHiSpdPer1/DiagEna

GLOBAL Function/Macro Definitions

None

Known Limitations with Design

None

UNIT TEST CONSIDERATION

None

Abbreviations and Acronyms

Abbreviation or AcronymDescription
FDDFunctional Design Document. (See references)

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.02
3Software Naming Conventions.docEA4 01.02
4Software Design and Coding Standards.docEA4 2.01
5FDD: MM073A_FordMsg3CABusHiSpd_DesignSee Synergy subproject version

3 - FordMsg077BusHiSpd_PeerReviewChecklist


Overview

Summary Sheet
Synergy Project
help
Version History


Sheet 1: Summary Sheet
























Rev 2.0121-Feb-18




Nexteer EA4 SWC Implementation Peer Review Summary Sheet

































Component Short Name:



FordMsg077BusHiSpd
Revision / Baseline:


MM124A_FordMsg077BusHiSpd_Impl_2.0.0
































Change Owner:


Shishir Holenarasipura
Work CR ID:


EA4#


































Modified File Types:






Check the file types that needed modification for the Work CR(s); macros for the check boxes will populate the appropriate checklist tabs for the review.
























































































































































































Review Checklist Summary:





































Reviewed:








At start of review, all items below should be marked "No". At the end of the review, all items should be marked "Yes" or "N/A" where N/A indicates the reviewers have reviewed the existing (unchanged) item and confirmed no updates were needed for the Work CR(s).




























































N/AMDD


N/ASource Code


N/APolySpace

















































N/AIntegration Manual


N/ADavinci Files




















































































All required reviewers participated





N/A





















































Comments:

Due to timing constraint, this version of implementation has not been reviewed










Approved by Steven Horwath


































































































Time spent ( to the nearest half hour)








review preparation



review meeting


review follow-up










Change owner:





























Component developer reviewers:






















0





Other reviewers:





























Total hours









0



0


0


0




































Content reviewed





























Lines of code:






Elements of .arxml content:







Pages of documentation:



































































































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 SWC Owner and/or SWC Design author and Integrator and/or SW Lead 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.

Each peer review shall start with a clean copy of the latest peer review checklist template. Save in the doc folder of the component implementation, with the file name in the format SWCShortName_Review.xlsx. If the existing review in Synergy has a different name, the name must be changed IN SYNERGY (rather than by syncing in a new file with the new name) so that the file history will be properly maintained.

Before the peer review, the change owner shall: (NOTE - time for completing these items is to be counted as the Change Owner Review Prep Time)
o Review the previous component peer review and copy any relevant comments to the new review sheet.
o Review all checklist items and make all corrections needed, so that the component is ready for peer review. The expectation is that peer review should find very few issues,
because the change owner has already used the checklist to ensure the component changes are complete and correct.
o Fill in all file name and version information as needed on peer review checklist tabs (file names may be copied from the previous peer review where appropriate)
o Fill in checklist answers (Yes/No/NA pulldowns) ONLY on those items which are NA for the current change. All other checklist items should be blank going into the review
meeting.

During the peer review meeting:
o For each page of the review, first review the items already marked as N/A for this change, to confirm that reviewers agree with this assessment; change the checklist box to
blank if it is found that the item does apply.
o Then review the items with the checklist box blank. After reviewing each of these items, the checklist box will be marked as "Yes", or the checklist box will be marked as
"No" with needed rework indicated or with rationale indicated.
o If any items are marked "No" with rationale indicated, this must be approved by a software supervisor or the software manager; there is a line in the "Review Board" section
of each tab to indicate who approved the "No" items on that tab.





Sheet 2: Synergy Project






















Rev 2.0121-Feb-18

























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









N/A
Comments:



naming convention





































Project contains necessary subprojects








N/A
Comments:










































Project contains the correct version of subprojects








N/A
Comments:










































Design subproject is correct version








N/A
Comments:












































.gpj file in tools folder matches .gpj generated by TL109 script








N/A
Comments:













































File/folder structure is correct per documentation in









N/A
Comments:




TL109A_SwcSuprt







































General Notes / Comments:
























































Review Board:


























Change Owner:

Shishir Holenarasipura


Review Date :



































Lead Peer Reviewer:






Approved by Reviewer(s):



N/A































Other Reviewer(s):










































































Rationale/justification for items marked "No" approved by:












































Sheet 3: help

Summary sheet:






Intended Use: Identify which component is being reviewed. This should match the component short name from the DataDict.m fileand the middle part of the Synergy project name, e.g. Assi for the SF001A_Assi_Impl Synergy project







Intended Use: Identify the implementation baseline name intended to be used for the changed component when changes are approved E.g. SF001A_Assi_Impl_1.2.0





Intended Use: Identify the developer who made the change(s) being reviewed




Intended Use: Identify the Implementation Work CR whose work is being reviewed (may be more than one)




Intended Use: Intended to identify at a high level to the reviewers which areas of the component have been changed.





Source code:





This item includes looking at all layers of Simulink model for possible color coding not reflected at a higher level, and includes looking at any intermediate SWC Design versions between the version being implemented and the version that was included as a subproject in the previous implementation.
Intended Use: Synergy version number of the file being reviewed. (Version number that Synergy displays on the checked out or unmodified
file in the working project)





Intended Use: Synergy version number of the file being reviewed. (Version number that Synergy displays on the checked out or unmodified file in the working project)



Intended Use: Synergy version number of the file being reviewed. (Version number that Synergy displays on the checked out or unmodified file in the working project)







Intended Use: For SWC Designs, list the Synergy baseline number (just the number part of the Synergy baseline name) of the SWC Design baseline being implemented. E.g., for SF001A_Assi_Design_1.3.1, this field would say "1.3.1"









Intended Use: Indicate that the the versioning was confirmed by the peer reviewer(s).















Intended Use: To confirm no compiler errors or warnings exist for the code under review (warnings from contract header files may be ignored).













Intended Use: list version/revision of latest released Software Design and Coding Standards document.





Davinci Files





Intended Use: Identify if previous version was compared and only the expected change(s) was present. This is for text files only, not binary or GUIs








Polyspace





eg. 2013b





Integration manual





Intended Use: Identify which file is being reviewed





Intended Use: Identify which version of the integration manual has been reviewed.



Synergy





Refer to EA4 Common Naming Conventions document, section “Synergy Baseline Names for core components”





The following subprojects should be included for all component implementations:
• AR200A_ArSuprt_Impl
• AR201A_ArCplrSuprt_Impl
• TL101A_CptRteGen
• TL103A_CplrSuprt
• TL109A_SwcSuprt
• Corresponding _Design project used for the implementation

The following subprojects should be included as needed by each component:
• AR10xx_Nxtr*_Impl library components as needed by each component
• AR202x_MicroCtrlrSuprt_Impl as needed (for register header files for components making direct register access)[add notes about when to add a stub header file]
• Xx999x_xxxxGlbPrm_Impl as needed by each component
• TL105A_Artt for components with generated content

The following should NOT be included as subprojects:
• TL107x_DavinciSuprt (aka StdDef)
• TL100A_QACSuprt (QAC subproject was previously included but should be removed going forward)
• Any other component (not mentioned anywhere above) whose .h file is needed. For these components, a “stub” .h file should be created, containing only the multiple include protection and the definitions and function prototypes actually needed by the component with the #include, and placed in the “including” component’s local\include folder.

misc in Summary sheet





(integrator, designer, unit test coordinator, etc.)





For a new component, use number of lines in all source files reviewed, including files in the src and include folders and any generated cfg.h and cfg.c files.  For a changed component, try to add up how many lines, including comments and blank lines, were in the changed areas that were reviewed. Not just the actual changed lines, but the number of lines in the blocks of code you had to look at to review the change.
add up the number of ports, number of PIM variables, number if IRVs, number of runnables, number of NVM blocks in the component  (all of them for review of a new component, the new and modified ones for review of a change)
add the number of pages in the MDD and integration manual for a new component; for a modified component, count the number of pages that contained a change.












ReviewerRequired attendance for this type of changeReview spreadsheet tab(s)
Component group peerAllAll
Component owner and/or SWC Design author*Initial creation of any new component
*Simulink model changes (any change to the model other than just updating the change log)
Source
Integrator and/or SW lead of first program planning to use the component*Initial creation of any new component
*new or changed NVM blocks, NVM datatypes, or NVM usage (added or removed or changed NVM API calls in any runnable)
*Major rev (X changed in the X.Y.X design baseline number; means there was a component interface change)
*new or changed config params
*all MM component changes
Davinci files, Integration manual, source for NVM changes and for all MM component changes.
Unit test coordinatorFixes for coverage issuesSource
SQANoneNone








For each reviewer category listed on each tab, there should either be
• the name of the reviewer who attended
or
• a comment indicating
o why that reviewer was not required for this change
or
o who approved holding the review without that required reviewer (approval must
be from the software manager or a software supervisor)


Sheet 4: Version History















File Version History





VersionDescriptionAuthor(s)Revision DateApproved ByApproved DateStatus






Draft/ Released






































































Template Version History





VersionDescriptionAuthor(s)Revision DateApproved ByApproved DateStatus
1.0Initial VersionSW Engineering team24-May-15NANAReleased
1.01Changed name to be EA4 specificSW Engineering team25-Jun-15NANAReleased
1.02Modified Summary Sheet General Guidelines, Clarified wording on first item in Synergy project sheet.SW Engineering team30-Jul-15NANAReleased
1.02Made corrections and clarifications to Source Code check list.SW Engineering team30-Jul-15NANAReleased
1.02updated Davinci, MDD, and Polyspace/QAC tabsSW Engineering team30-Jul-15NANAReleased
1.03Aligned to portal version guidelinesUmesh Sambhari21-Nov-17NANAReleased
2.00Summary sheet template:
Changed title to indicate Implementation Peer Review
Corrected and/or clarified mouse hover comments, added instructions, renamed some fields.
Changed the default setting to "No" on the items reviewed
SW Engineering team29-Nov-17Lonnie Newton, Steven Horwath, Kevin Smith, Lucas Wendling, Vinod ShankarNAReleased
Source code template:
Removed hyperlink for naming conventions, corrected name of naming conventions document, added version field for naming conventions document.
Changed item about requirements tags to reflect that they should be removed
Added clarification that all combinations of conditionally compiled code must be checked
Item about accurately implementing SWC Design is modified and a new item added, both to clarify where to look when determining needed changes.
Added point for version of common naming conventions
Reworded multiple items for clarity
SW Engineering team29-Nov-17
Synergy project template:
added items for file/folder structure
added point on .gpj file in tools folder
SW Engineering team29-Nov-17
Davinci files template:
Clarified the StdDef item
Added new item for OBSOLETE
Clarified item on datadict.m comparison
Removed the references to .m file helper tool
Updated to reflect that all component should now use only implementation data types
Added points on PIMs and NVMs
SW Engineering team29-Nov-17
All template tabs:
Added/clarified/removed mouse hover comments.
Updated Review Board section
Removed the gridlines from all tabs
Updated titles to say "Nexteer SWC Implementation Peer Review"
Changed all occurences of "FDD" to "SWC Design"
SW Engineering team29-Nov-17
2.01Added a help tab and appropriate links
Added field on Summary sheet to report hours spent and content reviewed
Changed wording in an item in Polyspace tab and Source code tab
SW Engineering team21-Feb-18Lonnie Newton, Steven Horwath, Kevin Smith, Lucas Wendling, Vinod Shankar21-Feb-18Released