This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Component Implementation

1: ES400A_TunSelnMngt_Integration_Manual
2: ES400A_TunSelnMngt_MDD
3: TunSelnMngt_Peer_Review_Checklist

Component Implementation

Component Documentation

1 - ES400A_TunSelnMngt_Integration_Manual

Integration Manual

For

ES400A TunSelnMngt

VERSION: 4.0

DATE: 29-Aug-2016

Prepared By:

Kevin Smith

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	Approved By
1	Initial version	K. Smith	1.0	09-Oct-15	-
2	Updated for version 1 of the design	K. Smith	2.0	04-Apr-16
3	Removed CalUsgProtn exclusive area	N. Saxton	3.0	06-May-16
4	Anomaly correction for EA4#6672	K. Smith	4.0	29-Aug-16

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

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	ES400A_TunSelnMngt_Design	See Synergy subproject version

Dependencies

SWCs

Module	Required Feature
None

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

Modules	Notes
None

Configuration Files to be provided by Integration Project

TunSelnMngt_Cfg_private.h – Genereated by Configurator
TunSelnMngt_Cfg_private.c – Genereated by Configurator

Da Vinci Parameter Configuration Changes

All the parameters are generated by the data dictionary tool based on the configuration for the project

Parameter	Notes		SWC

DaVinci Interrupt Configuration Changes

ISR Name	VIM #	Priority Dependency	Notes
None

Manual Configuration Changes

Constant	Notes	SWC
None

Exclusive Areas

Constant	Notes	SWC
TunSelnMngtIntDataProtnExclsvArea	Exclusive area needs to protect periodic access of PIMs from asynchronous updates by server runnables SetCalPageReq and CopyCalPage. Integrator verify if client calls to server runnables are interrupt or task based and set up exclusive area to properly protect access.

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Required Global Data Outputs

Specific Include Path present

Yes. TunSelnMngt.h must also be included in Rte_UserTypes.h for non-RTE generated type definitions.

Runnable Scheduling

This section specifies the required runnable scheduling.

Init	Scheduling Requirements	Trigger
TunSelnMngtInit1	This init function should be performed before any calibration access is done by another component and after DiagcMgr has initialized. However, if the calibration access is only to common calibrations, then there would be no impact.	RTE

Runnable	Scheduling Requirements	Trigger
TunSelnMngtPer1	None	RTE 10ms

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

*See DataDict.m

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

The following settings are recommend for online calibration support and DAQ access. This only applies to projects that XCP settings are generated by GENy.

Configurable Options	Setting	Rationale
Enable Calibration	True	Required to be true to enable write commands such as DOWNLOAD.
XCP Control	True	Required to enable or disable XCP access
Open Command Interface	True	Required for XCP service E8 and E9 support
Prescaler	True	Required to support scaling the DAQ timing (example, 2ms DAQ can be scaled in mulitples of 2ms to create DAQs running at 4ms, 8ms, 10ms, etc).
User Defined Commands	True	Required for additional functions built into XCP commands
Page Switching	True	Required for online calibration functions to properly operate.
General Page Info	True
Copy Page	True

2 - ES400A_TunSelnMngt_MDD

Module Design Document

For

TunSelnMngt

May 14, 2018

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Kevin Smith,

Nexteer Automotive,

Saginaw, MI, USA
Change History

Description	Author	Version	Date	Approved By
Initial Version	K. Smith	1	07-Apr-16
Updated program flow diagrams	N. Saxton	2	06-May-16
Updates to flow charts for anomaly EA4#6672 corrections	K. Smith	3	29-Aug-16
Updated to match version 2.0.0 of the design	K. Smith	4	29-Nov-17
Updated to match version 3.0.0 of the design and anomaly EA4#21421	K. Smith	5	14-May-18

Table of Contents

1 Introduction 5

1.1 Purpose 5

1.2 Scope 5

2 TunSelnMngt & High-Level Description 6

3 Design details of software module 7

3.1 Graphical representation of TunSelnMngt 7

3.2 Data Flow Diagram 7

3.2.1 Component level DFD 7

3.2.2 Function level DFD 7

4 Constant Data Dictionary 8

4.1 Program (fixed) Constants 8

4.1.1 Embedded Constants 8

4.2 Variable Data Dictionary 8

4.2.1 User Defined Typedef Definition/Declaration 8

4.2.1.1 Static Structures 8

4.2.1.2 Dynamic Structures and Enums 9

4.2.2 User Defined Enumerated Types 10

5 Software Component Implementation 11

5.1 Sub-Module Functions 11

5.1.1 Init: TunSelnMngtInit1 11

5.1.2 Per: TunSelnMngtPer1 13

5.2 Server Runnables 15

5.2.1 CopyCalPageReq 15

5.2.2 GetCalPageReq 16

5.2.3 GetSegInfoReq 17

5.2.4 OnlineTunRamAdrMpg 18

5.2.5 SetCalPageReq 19

5.3 Interrupt Functions 20

5.4 Module Internal (Local) Functions 20

5.4.1 SwtCalIdx 20

5.4.2 IdxChgMngt 21

5.4.3 MemCopy32Bit 23

5.4.4 MemCopy8Bit 24

5.4.5 SegModAdrInfo 25

5.4.6 SegModStdInfo 26

5.4.7 SegModAdrMpg 27

5.5 GLOBAL Function/Macro Definitions 28

6 Known Limitations with Design 29

7 UNIT TEST CONSIDERATION 30

Appendix A Abbreviations and Acronyms 31

Appendix B Glossary 32

Appendix C References 33

Introduction

Purpose

This MDD aids in documenting the implementation of ES400A Tuning Selection Management.

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.

TunSelnMngt & High-Level Description

Tuning Selection Management (TunSelnMngt) provides the ability to change run-time calibrations during operation. The component also provides a RAM buffer for online calibration changes over XCP for tuning processes.

Design details of software module

Graphical representation of TunSelnMngt

Data Flow Diagram

None

Component level DFD

None

Function level DFD

None

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Values between the brackets [] are the ranges that the configurable constants could be defined as for a given integration. These values are generated by Configurator before the software build.

Constant Name	Resolution	Units	Value
MAXININIDXCNT_CNT_U08	Uint8	Cnt	[0-255]
MAXININOPTSETAIDXCNT_CNT_U08	Uint8	Cnt	[0-255]
MAXRTIDXCNT_CNT_U08	Uint8	Cnt	[0-255]
MAXONLINECALCFGCNT_CNT_U08	Uint8	Cnt	[0-255]
ONLINECALGROUPS_CNT_U08	Uint8	Cnt	[0-255]
ONLINECALRAMTBL_CNT_U16	Uint16	Cnt	[0-65535]
PRMPTRTBLSIZEINWORD_CNT_U16	Uint16	Cnt	[0-65535]

Variable Data Dictionary

The following type definitions are found in the private header of this component.

User Defined Typedef Definition/Declaration

Static Structures

The following table contains structures are static in their definition. However, internal elements may change based on the configuration of the project but the high level content is the same. These elements are described at the bottom of the table.

Typedef Name	Element Name	User Defined Type	Legal Range (min)	Legal Range (max)
TunSelnRamTblRec1	PrmRefTblPtr	Rte_ParameterRefTabType	N/A	N/A
	PrmTblCrc_u32	Uint32	0	4294967295
TunSelnIdxTblRec1	SrcIdx_u16	Uint16	0	65535
	DestIdx_u16	Uint16	0	65535
	SigIdx_u08	Uint8	0	255
TunSelnOnlineCalIdxTblRec1	RamStructPtr_u08	UInt8*	0	255
	StructSize_u16	Uint16	0	65535
	TblIdx_u16	Uint16	0	65535
	GroupIdx_u08	Uint8	0	255

Rte_ParameterRefTabType is a structure of void pointers that point to the various calibration component structures. This type is generated by the RTE based on the configuration of the integration.

Dynamic Structures and Enums

The following table contains structures are dynamic in their definition. The contents contained will vary from project to project. The intent of this table is to document their purpose.

Entry Type	Typedef Name	Example Element(s)	Variable Type	Value	Comment
Enum	OnlineCalGroup1	GroupA	N/A	0	This enum contains a number representation for each calibration group that is generated for online calibration from A=0 to Z=26. Groups are defined by a letter suffix.
		GroupB	N/A	1
Struct	<GroupName>Typ GroupATyp	<Cal Region><Cal Cmp Name><Online Group> CalRegn01CmnGroupA	RTE Generated	N/A	This structure is generated based on the online groups configured. Each group will generate a structure and contain all calibration software components within that group.
Union	OnlineCalTblRec1	Byte[<RAM Size>]	Unit8	N/A	This structure combines all the online calibration groups into data type for assignment to the RAM buffer. The ‘byte’ element is used to access the entire buffer on a byte-by-byte basis and ensure that the RAM is properly sized.
		<GroupName>	<GroupName>Typ	N/A

User Defined Enumerated Types

Enum Name	Element Name	Value
GetSegModeSegInfo1	GETSEGMODSEGINFO_ADR	0
	GETSEGMODSEGINFO_LEN	1
GetSegModeMpgIdx1	GETSEGMODMPGIDX_SRCADR	0
	GETSEGMODMPGIDX_DESTADR	1
	GETSEGMODMPGIDX_LEN	2

Software Component Implementation

Sub-Module Functions

Init: Init1

Design Rationale

The initialization function creates two copies of the RTE generated flash table in to RAM. A CRC is performed on each of the copies to ensure that they match. The function also adjusts the tables to load the appropriate initialization and run-time calibrations indexes that are required by the application.

Processing

Module Outputs

None

Per: Per1

Design Rationale

Processing

Module Outputs

None

Server Runnables

Interrupt Functions

None

Module Internal (Local) Functions

SwtCalIdx

Function Name	SwtCalIdx	Type	Min	Max
Arguments Passed	N/A
Return Value	N/A

Design Rationale

This function manages the RAM buffer access and switches the calibration index between the two copies in RAM.

Processing

IdxChgMngt

Function Name	IdxChgMngt	Type	Min	Max
Arguments Passed	SeldIdx_Cnt_T_u08	Uint8	0	255
	GendCalTblSize_Cnt_T_u08	Uint8	0	255
	GendCalTbl_T_rec	TunSelnIdxTblRec1*	0	4294967295
Return Value	IdxFound_Cnt_T_logl	Boolean	FALSE	TRUE

Design Rationale

Processing

MemCopy32Bit

Function Name	MemCopy32Bit	Type	Min	Max
Arguments Passed	Des_Arg	Void	0	4294967295
	Src_Arg	Void	0	4294967295
	Len_Arg	Uint16	0	65535
Return Value	N/A

Design Rationale

The 32-bit mem copy function is used to move calibration pointers from flash to RAM. The void pointers are internally assigned to a uint32 pointer before the processing loop begins.

Processing

MemCopy8Bit

Function Name	MemCopy8Bit	Type	Min	Max
Arguments Passed	Des_Arg	Void	0	4294967295
	Src_Arg	Void	0	4294967295
	Len_Arg	Uint16	0	65535
Return Value	N/A

Design Rationale

The 8-bit mem copy function is used to move calibration segments into the RAM space. Since the length of the segments is not guaranteed to be a 32-bit even address, 8-bit was selected to ensure that only the bytes required to be moved are performed. The void pointers are internally assigned to a uint8 pointer before the processing loop begins.

Processing

SegModAdrInfo

Function Name	SegModAdrInfo	Type	Min	Max
Arguments Passed	Seg_Arg	UInt8	0	255
	SegInfo_Arg	GetSegModSegInfo1	0	1
	Resp_Arg	Uint8*	0	255
	RespLen_Arg	Uint8*	8	8
Return Value	Rtn_Cnt_T_u08	Uint8	0	255

Design Rationale

Processing

SegModStdInfo

Function Name	SegModStdInfo	Type	Min	Max
Arguments Passed	Seg_Arg	Uint8	0	255
	Resp_Arg	Uint8*	0	255
	RespLen_Arg	UInt8*	6	6
Return Value	<Hard Coded>	UInt8	1	1

Design Rationale

Processing

SegModAdrMpg

Function Name	SegModAdrMpg	Type	Min	Max
Arguments Passed	Seg_Arg	Uint8	0	255
	MpgIdxInfo_Arg	GetSegModMpgIdx1	0	2
	MpgIdx_Arg	Uint8	0	255
	Resp_Arg	UInt8*	0	4294967295
	RespLen_Arg	Uint8*	8	8
Return Value	Rtn_Cnt_T_u08	Uint8	0	255

Design Rationale

Processing

TunSelnMngt_ChkXcpWrAcs

Function Name	TunSelnMngt_ChkXcpWrAcs	Type	Min	Max
Arguments Passed	ReqAdr_Cnt_T_u32	Uint32	0	4294967296
Return Value	Rtn_Cnt_T_logl	Boolean	FALSE	TRUE

Design Rationale

This function is generated based on the configured access regions in Configurator. Below is just a high level overview of the function. The conditions in the if statements are logically OR’d together to form the tests.

Processing

GLOBAL Function/Macro Definitions

None

Known Limitations with Design

Since the design relies heavily on the integration project to generate the RTE and calibrations, the component cannot simply have those settings available at this level. Attached are the settings used to generate the files in the local folder for testing with the compiler and also configurator settings.

File	Use
	Import into Configurator
	Place contents at the end of the Rte_Type.h file. Note: This file is based on the Configurator settings in this table.

UNIT TEST CONSIDERATION

None

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.01
3	Software Naming Conventions.doc	1.0
4	Software Design and Coding Standards.doc	2.1

3 - TunSelnMngt_Peer_Review_Checklist

Overview

Summary Sheet
Synergy Project
Source Code
PolySpace
help
Version History

Sheet 1: Summary Sheet

Rev 2.01

21-Feb-18

Nexteer EA4 SWC Implementation Peer Review Summary Sheet

Component Short Name:

Revision / Baseline:

ES400A_TunSelnMngt_Impl_3.1.0

Change Owner:

Brendon Binder

Work CR ID:

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).

MDD

Yes

Source Code

Yes

PolySpace

Integration Manual

Davinci Files

All required reviewers participated

Comments:

All the MISRA warnings and deviations approved by Kevin Smith

Time spent ( to the nearest half hour)

review preparation

review meeting

review follow-up

Change owner:

Component developer reviewers:

Other reviewers:

Total hours

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.01

21-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

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:

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

Yes

Comments:

File/folder structure is correct per documentation in

Yes

Comments:

TL109A_SwcSuprt

General Notes / Comments:

Review Board:

Change Owner:

Pratik Jadhav

Review Date :

07/13/18

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

Other Reviewer(s):

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

Sheet 3: Source Code

Rev 2.01

21-Feb-18

Nexteer SWC Implementation Peer Review Meeting Log (Source Code Review)

Source File Name:

TunSelnMngt.c

Source File Revision:

Header File Name:

Header File Revision:

MDD Name:

ES400A_TunSelnMngt_MDD.docx

Revision:

SWC Design Name:

ES400A_TunSelnMngt_Design

Revision:

3.1.0

Quality Check Items:

Rationale is required for all answers of No

EA4 Common Naming Convention followed:

Version: 1.01

EA4 Software Naming Convention followed:

Version: 1.02

for variable names

Yes

Comments:

for constant names

N/A

Comments:

for function names

N/A

Comments:

for other names (component, memory

Yes

Comments:

mapping handles, typedefs, etc.)

Verified no possibility of uninitialized variables being

Yes

Comments:

written to component outputs or IRVs

Any requirements traceability tags have been removed

N/A

Comments:

from at least the changed areas of code

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:

(including any anomaly number(s) being fixed) and

Work CR number

Code accurately implements SWC Design (Document

Yes

Comments:

or Model) in all areas where code was changed and/or

Simulink model was color-coded as changed and/or

mentioned in SWC Design change log.

Code comparison against previous version matches

Yes

Comments:

changes needed as described by the work CR(s), all

parent CRs and parent anomalies, and the SWC

Design change log.

Verified no Compiler Errors or Warnings

Yes

Comments:

(and verified for all possible combinations

of any conditionally compiled code)

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.01

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

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 access of motor control loop data uses macros

N/A

Comments:

generated by the motor control manager

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-unsigned 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 SWC Design DataDict.m file : [N53]

All code is mapped with SWC Design (all SWC

Yes

Comments:

Design subfunctions and/or model blocks identified

with code comments; all code corresponds to

some SWC Design subfunction and/or model block):

[N40]

Any other violations of design and coding

N/A

Comments:

standards noticed during the review are noted in the

comments section for rework.

Anomaly or Design Work CR created

N/A

Comments: List Anomaly or CR numbers

for any SWC Design corrections needed

General Notes / Comments:

Review Board:

Change Owner:

Pratik Jadhav

Review Date :

07/13/18

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

SWC owner and/or
SWC Design author:

Kevin Smith

Comments:

Integrator and or
SW lead:

Akilan R

Comments:

Unit test co-ordinator:

Comments:

Other Reviewer(s):

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

Sheet 4: PolySpace

Rev 2.01

21-Feb-18

Nexteer SWC Implementation Peer Review Meeting Log (PolySpace Review)

Source File Name:

TunSelnMngt.c

Source File Revision:

Source File Name:

TunSelnMngt_private.c

Source File Revision:

Source File Name:

Source File Revision:

EA4 Static Analysis Compliance Guideline version:

1.04

Poly Space version:

2013b

TL109A sub project version:

2.4.0

Quality Check Items:

Rationale is required for all answers of No

tools/local folders' header files are appropriate and

Yes

Comments:

function prototypes match the latest component version

100% Compliance to the EA4 Static Analysis

Comments:

Compliance Guideline

Are previously added justification and deviation

Yes

Comments:

comments still appropriate

Do all MISRA deviation comments use approved

Yes

Comments:

deviation tags

For any component source files (.c, .h, generated Cfg.c and Cfg.h)

Yes

Comments:

with conditional compilation, has Polyspace been run with all

combinations of build constants that can be used together in a build?

(Note which conditional compilation results have been archived)

Codemetrics count OK

Comments: Cyc. Complexity: 19. Path Count: 729

for all functions in the component per Design

and Coding Standards rule [N47]

General Notes / Comments:

Review Board:

Change Owner:

Pratik Jadhav

Review Date :

07/13/18

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

Other Reviewer(s):

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

Kevin Smith

Sheet 5: 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: 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.

Reviewer

Required attendance for this type of change

Review spreadsheet tab(s)

Component group peer

All

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 coordinator

Fixes for coverage issues

Source

SQA

None

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 6: Version History



File Version History
Version	Description	Author(s)	Revision Date	Approved By	Approved Date	Status
						Draft/ Released










Template Version History
Version	Description	Author(s)	Revision Date	Approved By	Approved Date	Status
1.0	Initial Version	SW Engineering team	24-May-15	NA	NA	Released
1.01	Changed name to be EA4 specific	SW Engineering team	25-Jun-15	NA	NA	Released
1.02	Modified Summary Sheet General Guidelines, Clarified wording on first item in Synergy project sheet.	SW Engineering team	30-Jul-15	NA	NA	Released
1.02	Made corrections and clarifications to Source Code check list.	SW Engineering team	30-Jul-15	NA	NA	Released
1.02	updated Davinci, MDD, and Polyspace/QAC tabs	SW Engineering team	30-Jul-15	NA	NA	Released
1.03	Aligned to portal version guidelines	Umesh Sambhari	21-Nov-17	NA	NA	Released
2.00	Summary 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 team	29-Nov-17	Lonnie Newton, Steven Horwath, Kevin Smith, Lucas Wendling, Vinod Shankar	NA	Released
	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 team	29-Nov-17
	Synergy project template: added items for file/folder structure added point on .gpj file in tools folder	SW Engineering team	29-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 team	29-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 team	29-Nov-17
2.01	Added 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 team	21-Feb-18	Lonnie Newton, Steven Horwath, Kevin Smith, Lucas Wendling, Vinod Shankar	21-Feb-18	Released

Component Implementation

Component Implementation

Component Documentation

1 - ES400A_TunSelnMngt_Integration_Manual

Abbrevations And Acronyms

References

Dependencies

SWCs

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

Configuration REQUIREMeNTS

Build Time Config

Configuration Files to be provided by Integration Project

Da Vinci Parameter Configuration Changes

DaVinci Interrupt Configuration Changes

Manual Configuration Changes

Exclusive Areas

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Required Global Data Outputs

Specific Include Path present

Runnable Scheduling

Memory Map REQUIREMENTS

Mapping

Usage

NvM Blocks

Compiler Settings

Preprocessor MACRO

Optimization Settings

Appendix

Recommend GENy settings for CANembedded Projects

2 - ES400A_TunSelnMngt_MDD

Introduction

Purpose

Scope

TunSelnMngt & High-Level Description

Design details of software module

Graphical representation of TunSelnMngt

Data Flow Diagram

Component level DFD

Function level DFD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Variable Data Dictionary

User Defined Typedef Definition/Declaration

Static Structures

Dynamic Structures and Enums

User Defined Enumerated Types

Software Component Implementation

Sub-Module Functions

Init: Init1

Design Rationale

Processing

Module Outputs

Per: Per1

Design Rationale

Processing

Module Outputs

Server Runnables

CopyCalPageReq

Design Rationale

(Processing of function)………

Module Outputs

GetCalPageReq

Design Rationale

(Processing of function)………

Module Outputs

GetSegInfoReq

Design Rationale

(Processing of function)………

Module Outputs

OnlineTunRamAdrMpg

Design Rationale

(Processing of function)………

Module Outputs

SetCalPageReq

Design Rationale

(Processing of function)………

Module Outputs