Sr. No.	Title	Version
1	MDD Guidelines	Software Engineering Process 04.04.02
2	Software Naming Conventions	Software Engineering Process 04.04.02
3	Coding standards	Software Engineering Process 04.04.02
<4	FDD	See Synergy Sub projection version
	<Add if more available>

Dependencies

SWCs

Module	Required Feature
ElecGlbPrm	Global macro defined in the header file

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

GtmCfgAndUsePer1 – Called from the Motor control ISR

Configuration REQUIREMeNTS

Build Time Config

Modules	Notes
None

Configuration Files to be provided by Integration Project

None

Da Vinci Parameter Configuration Changes

Parameter	Notes	SWC

DaVinci Interrupt Configuration Changes

ISR Name	VIM #	Priority Dependency	Notes

Manual Configuration Changes

	Notes	SWC

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

See DataDict.m file

Required Global Data Outputs

See DataDict.m file

Specific Include Path present

Yes

Runnable Scheduling

This section specifies the required runnable scheduling.

Init	Scheduling Requirements	Trigger
GtmCfgAndUseInit1	None	RTE Init

Runnable	Scheduling Requirements	Trigger
GtmCfgAndUsePer1	None	Motor Control Rate
GtmCfgAndUsePer2	None	2 ms
GtmGetSent0Data_Oper	None	On Invocation
GtmGetSent1Data_Oper	None	On Invocation

Memory Map REQUIREMENTS

Mapping

Memory Section	Contents	Notes
GtmCfgAndUse_START_SEC_CODE
CDD_GtmCfgAndUse_MotCtrl_START_SEC_CODE

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

Usage

Feature	RAM	ROM

Table 1: ARM Cortex R4 Memory Usage

NvM Blocks

None

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

2 - GtmCfgAndUse_MDD

Module Design Document Guidelines

GtmCfgAndUse

Feb 28, 2018

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Software Group,

Nexteer Automotive,

Saginaw, MI, USA
Change History

Description	Author	Version	Date
Initial version	Avinash James	1.0	13-Sep-2017
Updated local function and added unit test consideration	Avinash James	2.0	28-Feb-2018

Table of Contents

1 Introduction 5

1.1 Purpose 5

1.2 Scope 5

2 Component Name & High Level Description 6

3 Design details of software component 7

3.1 Graphical Representation 7

3.2 Data Flow Diagrams 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

5 Software Component Implementation 9

5.1 Sub-Module Functions 9

5.1.1 Init: GtmCfgAndUseInit1 9

5.1.1.1 Design Rationale 9

5.1.1.2 Module Outputs 9

5.1.2 Per: GtmCfgAndUsePer1 9

5.1.2.1 Design Rationale 9

5.1.2.2 Store Module Inputs to Local copies 9

5.1.2.3 (Processing of function) 9

5.1.2.4 Store Local copy of outputs into Module Outputs 9

5.1.3 Per: GtmCfgAndUsePer2 9

5.1.3.1 Design Rationale 9

5.1.3.2 Store Module Inputs to Local copies 9

5.1.3.3 (Processing of function) 9

5.1.3.4 Store Local copy of outputs into Module Outputs 9

5.2 Server Runnable () Functions 10

5.2.1 GtmGetSent0Data_Oper 10

5.2.1.1 Design Rationale 10

5.2.1.2 Store Module Inputs to Local copies 10

5.2.1.3 (Processing of function) 10

5.2.1.4 Store Local copy of outputs into Module Outputs 10

5.2.2 GtmGetSent1Data_Oper 10

5.2.2.1 Design Rationale 10

5.2.2.2 Store Module Inputs to Local copies 10

5.2.2.3 (Processing of function) 10

5.2.2.4 Store Local copy of outputs into Module Outputs 10

5.3 Interrupt Service Routines 10

5.4 Module Internal (Local) Functions 10

5.4.1 Local Function #1 10

5.4.1.1 Description 11

5.4.2 Local Function #2 11

5.4.2.1 Description 11

5.4.3 Local Function #3 11

5.4.3.1 Description 11

5.4.4 Local Function #4 11

5.4.4.1 Description 11

5.4.5 Local Function #5 11

5.4.5.1 Description 12

5.4.6 Local Function #6 12

5.4.6.1 Description 12

5.4.7 Local Function #7 12

5.4.7.1 Description 12

5.4.7.2 Design Rationale 12

5.5 GLOBAL Function/Macro Definitions 13

6 Known Limitations with Design 14

7 UNIT TEST CONSIDERATION 15

Appendix A Abbreviations and Acronyms 16

Appendix B Glossary 17

Appendix C References 18

Introduction

Purpose

Component Name & High Level Description

Refer FDD

Design details of software component

Graphical Representation

Data Flow Diagrams

Refer FDD

Component level DFD

Function level DFD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant Name	Data Type	Value
CLRBIT0MASK_CNT_U32	Uint32	((uint32)0xFFFFFFFEU)
Refer .m file

Software Component Implementation

Sub-Module Functions

Init: GtmCfgAndUseInit1

Design Rationale

Refer FDD

Module Outputs

None

Per: GtmCfgAndUsePer1

Design Rationale

Refer FDD

Store Module Inputs to Local copies

None

(Processing of function)

Refer FDD

Store Local copy of outputs into Module Outputs

None

Per: GtmCfgAndUsePer2

Design Rationale

Refer FDD

Store Module Inputs to Local copies

None

(Processing of function)

Refer FDD

Store Local copy of outputs into Module Outputs

None

Server Runnable () Functions

GtmGetSent0Data_Oper

Design Rationale

Refer FDD .

The place where the server runnable gets called should make sure a NULL pointer is not passed as an argument to the server runnable

Store Module Inputs to Local copies

None

(Processing of function)

Refer FDD

Store Local copy of outputs into Module Outputs

None

GtmGetSent1Data_Oper

Design Rationale

Refer FDD

The place where the server runnable gets called should make sure a NULL pointer is not passed as an argument to the server runnable

Store Module Inputs to Local copies

None

(Processing of function)

Refer FDD

Store Local copy of outputs into Module Outputs

None

Interrupt Service Routines

None

Module Internal (Local) Functions

Local Function #1

Function Name	NoTranSysStIsEn	Type	Min	Max
Arguments Passed	MotCurrEolCalSt_Cnt_T_enum	MotCurrEolCalSt2	0	8
	IvtrFetFltPha_Cnt_T_enum	IvtrFetFltPha1	0	4
Return Value	N/A

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer2/No Transition SysState = Enable

Local Function #2

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

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer2/Transition from Enable

Local Function #3

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

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer2/Transition to Enable

Local Function #4

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

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer2/No Transition SysState != Enable

Local Function #5

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

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer2/Transition from Enable/Map FET Ctrl Signals to GPIO and Set Low (also same block name in other model layers)

Local Function #6

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

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer2/Transition from Enable/Map FET Ctrl Signals to GPIO and Set Low/Map Pins to GPIO (also same block name in other model layers)

Local Function #7

Function Name	CnvNanoSecToTmrCnt	Type	Min	Max
Arguments Passed	Ti_NanoSec_T_u32	uint32	0	100000
Return Value	Timer counts corresponding to the input time	uint32	0	8000

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer1/UpdatePWMRegisters/RawTime_NanoSec to RawTimerCount_Cnt Conversion Block

Design Rationale

Because this function is called by a motor control runnable, it is coded as an inline function to maximize the chance that the compiler will inline it, in order to improve runtime efficiency of the motor control loop.

Local Function #8

Function Name	ChkForFetFlt	Type	Min	Max
Arguments Passed	IvtrFetFltPha_Cnt_T_enum	IvtrFetFltPha1	0	4
Return Value	None

Description

See FDD model block: CM770A_GtmCfgAndUse/GtmCfgAndUse/GtmCfgAndUsePer2/Check For FET faults

Conversion Block

GLOBAL Function/Macro Definitions

None

Known Limitations with Design

None

UNIT TEST CONSIDERATION

Roll over of the PIM Rte_Pim_MissUpdCntr in the motor control function is intentional

In the motor control function MissUpdStrtCntr_Cnt_T_u32 and MissUpdEndCntr_Cnt_T_u32 reads the value from the same register GTM0ATOM00CN0. Hence during unit testing where these registers are simulated as variables and doesn’t change during execution, there will be a coverage issue for achieving the false case for the condition ((MissUpdStrtCntr_Cnt_T_u32 >= MissUpdEndCntr_Cnt_T_u32) as this will always be TRUE the way unit testing is done now.

Abbreviations and Acronyms

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

3 - GtmCfgAndUse_PeerReviewChecklist

Overview

Summary Sheet
help
Version History

Sheet 1: Summary Sheet

Rev 2.01

21-Feb-18

Nexteer EA4 SWC Implementation Peer Review Summary Sheet

Component Short Name:

GtmCfgAndUse

Revision / Baseline:

CM770A_GtmCfgAndUse_Impl_3.1.0

Change Owner:

Avinash James

Work CR ID:

EA4#21611

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/A

MDD

N/A

Source Code

N/A

PolySpace

N/A

Integration Manual

N/A

Davinci Files

All required reviewers participated

N/A

Comments:

The changes are made and the formal review is skipped due to timing constarints. Approved deviation by

Lonnie Newton

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: 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 3: 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