Sr. No.	Title	Version
<1>	<MDD Guidelines>	Process 4.00.00
<2>	<Software Naming Conventions>	Process 4.00.00
<3>	<Coding standards>	Process 4.00.00
<4>	FDD – SF102A_MotCtrlPrmEstimn_Design	See Synergy Subproject version
	<Add if more available>

Dependencies

SWCs

Module	Required Feature
None	N/A

Note : Referencing the external components should be avoided in most cases. Only in unavoidable circumstance external components should be referred. Developer should track the references.

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

None

Configuration REQUIREMeNTS

Build Time Config

Constants	Notes
None

Configuration Files to be provided by Integration Project

Da Vinci Parameter Configuration Changes

Parameter	Notes	SWC
N/A

DaVinci Interrupt Configuration Changes

ISR Name	VIM #	Priority Dependency	Notes
N/A

Manual Configuration Changes

Constant	Notes	SWC
N/A

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Refer DataDict.m file

Required Global Data Outputs

Refer DataDict.m file

Specific Include Path present

Runnable Scheduling

This section specifies the required runnable scheduling.

Init	Scheduling Requirements	Trigger
MotCtrlPrmEstimnInit1	None	RTE(Init)

Runnable	Scheduling Requirements	Trigger
MotCtrlPrmEstimnPer1	None	RTE(2ms)
MotCtrlPrmEstimnPer2	None	RTE(100ms)
GetMotPrmNomEol_Oper	None	On event
SetMotPrmNomEol_Oper	None	On event

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

Non RTE NvM Blocks

Block Name

None

Note : Size of the NVM block if configured in developer

RTE NvM Blocks

Block Name

MotPrmNom

Note : Size of the NVM block if configured in developer

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

2 - MotCtrlPrmEstimn_MDD

Module Design Document

For

MotCtrlPrmEstimn

VERSION: 3.0

DATE: 29-Nov-2016

Prepared By:

Software Group

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

Revision History

Sl. No.	Description	Author	Version	Date
1	Initial Version	Rijvi	1.0	20-JUN-2015
2	Updated per design rev. 1.5.0	Rijvi	2.0	07-APRIL-2016
3	Updated per design rev. 2.1.0	ML	3.0	29-NOV-2016

Table of Contents

1 Abbrevations And Acronyms 5

2 References 6

3 MotCtrlPrmEstimn & High-Level Description 7

4 Design details of software module 8

4.1 Graphical representation of MotCtrlPrmEstimn 8

4.2 Data Flow Diagram 8

4.2.1 Module level DFD 8

4.2.2 Sub-Module level DFD 8

4.3 COMPONENT FLOW DIAGRAM 8

5 Variable Data Dictionary 9

5.1 User defined typedef definition/declaration 9

5.2 Variable definition for enumerated types 9

6 Constant Data Dictionary 10

6.1 Program(fixed) Constants 10

6.1.1 Embedded Constants 10

6.1.1.1 Local 10

6.1.1.2 Global 10

6.1.2 Module specific Lookup Tables Constants 10

7 Software Module Implementation 11

7.1 Sub-Module Functions 11

7.2 Initialization Functions 11

7.2.1 Per: MotCtrlPrmEstimnInit1 11

7.2.1.1 Design Rationale 11

7.2.1.2 Store Module Inputs to Local copies 11

7.2.1.3 (Processing of function)……… 11

7.2.1.4 Store Local copy of outputs into Module Outputs 11

7.3 PERIODIC FUNCTIONS 11

7.3.1 Per: MotCtrlPrmEstimnPer1 11

7.3.1.1 Design Rationale 11

7.3.1.2 Store Module Inputs to Local copies 11

7.3.1.3 (Processing of function)……… 11

7.3.1.4 Store Local copy of outputs into Module Outputs 11

7.3.2 Per: MotCtrlPrmEstimnPer2 11

7.3.2.1 Design Rationale 11

7.3.2.2 Store Module Inputs to Local copies 11

7.3.2.3 (Processing of function)……… 11

7.3.2.4 Store Local copy of outputs into Module Outputs 12

7.4 Non PERIODIC FUNCTIONS 12

7.5 Interrupt Functions 12

7.6 Server runnables 12

7.6.1 GetMotPrmNomEol 12

7.6.1.1 Design Rationale 12

7.6.1.2 Store Module Inputs to Local copies 12

7.6.1.3 (Processing of function)……… 12

7.6.1.4 Store Local copy of outputs into Module Outputs 12

7.6.2 SetMotPrmNomEol 12

7.6.2.1 Design Rationale 12

7.6.2.2 Store Module Inputs to Local copies 12

7.6.2.3 (Processing of function)……… 12

7.6.2.4 Store Local copy of outputs into Module Outputs 12

7.7 Serial Communication Functions 13

7.8 Local Function/Macro Definitions 13

7.8.1 Local Function #1 CalcCurrMagSqRef 13

7.9 GLObAL Function/Macro Definitions 13

7.10 TRANSIENT FUNCTIONS 13

8 Unit Test Considerations 14

9 Known Limitations With Design 15

10 Appendix 16

Abbrevations And Acronyms

Abbreviation	Description
DFD	Design functional diagram
MDD	Module design Document
	<ADD more to the table if applicable>

References

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

Sr. No.	Title	Version
<1>	<MDD Guidelines>	Process 4.02.00
<2>	<Software Naming Conventions>	Process 4.02.00
<3>	<Coding standards>	2.1
<4>	FDD - SF102A_MotCtrlPrmEstimn_Design	See Synergy Subproject version
	<Add if more available>

MotCtrlPrmEstimn & High-Level Description

None

Design details of software module

Graphical representation of MotCtrlPrmEstimn

Data Flow Diagram

Module level DFD

Sub-Module level DFD

COMPONENT FLOW DIAGRAM

Variable Data Dictionary

User defined typedef definition/declaration

Typedef Name

Element Name

User Defined Type

Legal Range

(min)

Legal Range

(max)

None

Variable definition for enumerated types

Enum Name	Element Name	Value
N/A	<(Variable name qualified Refer[2])>	<Define the value >

Constant Data Dictionary

Program(fixed) Constants

Embedded Constants

< All program specific constants will be defined in detail >

Local

Constant Name	Resolution	Units	Value
Refer constants from .m file

Global

<This section lists the global constants used by the module. For details on global constants, refer to the Data Dictionary for the application>

Constant Name

None

Module specific Lookup Tables Constants

<(This is for lookup tables (arrays) with fixed values, same name as other tables)>

Constant Name	Resolution	Value	Software Segment
None

Software Module Implementation

Sub-Module Functions

NONE

Initialization Functions

Per: MotCtrlPrmEstimnInit1

Design Rationale

Refer to FDD

Store Module Inputs to Local copies

Refer to FDD

(Processing of function)………

Refer to FDD

Store Local copy of outputs into Module Outputs

Refer to FDD

PERIODIC FUNCTIONS

Per: MotCtrlPrmEstimnPer1

Design Rationale

None

Store Module Inputs to Local copies

None

(Processing of function)………

See SetMotPrmNomEol block in the FDD

Store Local copy of outputs into Module Outputs

None

Serial Communication Functions

None

Local Function/Macro Definitions

3 - MotCtrlPrmEstimn_PeerReviewChecklist

Overview

Summary Sheet
Synergy Project
Davinci Files
Source Code
MDD
PolySpace

Sheet 1: Summary Sheet

Rev 1.2

8-Jun-15

Peer Review Summary Sheet

Synergy Project Name:

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

Revision / Baseline:

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

Change Owner:

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

Work CR ID:

EA4#7258

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

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

Reviewed:

Yes

MDD

Yes

Source Code

Yes

PolySpace

N/A

Integration Manual

Yes

Davinci Files

Comments:

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

Sheet 2: Synergy Project

Peer Review Meeting Log (Component Synergy Project Review)

Quality Check Items:

Rationale is required for all answers of No

New baseline version name from Summary Sheet follows

Yes

Comments:

naming convention

Project contains necessary subprojects

Yes

Comments:

Project contains the correct version of subprojects

Yes

Comments:

Design subproject is correct version

Yes

Comments:

General Notes / Comments:

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

Change Owner:

Matthew Leser

Review Date :

12/16/16

Lead Peer Reviewer:

Krishna Anne

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Sheet 3: Davinci Files

Rev 1.2

8-Jun-15

Peer Review Meeting Log (Davinci Review)

Quality Check Items:

Rationale is required for all answers of No

Only StdDef Port types are used

Yes

Comments:

For components not using application data types, do all

N/A

Comments:

port interface names end in PortIf and a sequence number

Non-program-specific components saved

Yes

Comments:

in Autosar 4.0.3 format

*Cfg.arxml.TT: Verfied Davinci Configurator imported the

N/A

Comments:

change correctly

*Cfg.h.TT: Verfied Davinci Configurator generates

N/A

Comments:

the configuration header(s) file correctly

kzshz2: Either a generic sandbox or a baselined integration project can be used to verify

All changed files have been compared against previous

Yes

Comments:

versions (If available)

kzshz2: 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 Rationale: This is helpful in identifying unapproved (intended or mistaken) changes.

Automated validation check is performed

Yes

Comments:

Naming conventions followed. All names should

Yes

Comments:

match DataDict.m

Sender/Receiver port properties match DataDict.m

Yes

Comments:

file (use .m file helper tool)

Calibration port properties match DataDict.m

N/A

Comments:

file (use .m file helper tool)

Components using application data types:

Sender/Receiver port initialization values match

Yes

Comments:

DataDict.m file

Calibration port initialization values match

N/A

Comments:

DataDict.m file

Components not using application data types:

Sender/Receiver port initialization values match

N/A

Comments:

DataDict.m file and have been converted to counts

for fixed point types

Calibration port initialization values match

N/A

Comments:

DataDict.m file and have been converted to counts

for fixed point types

Mapping set and all unused items have been

N/A

Comments:

removed

All sender/receiver port read/writes using direct

Yes

Comments:

read/writes(List justification if not)

Runnable calling frequencies match FDD

Yes

Comments:

DataDict.m display variables: created as

N/A

Comments:

PerInstanceMemory. Matches the FDD

Component is correct component type

Yes

Comments:

General Notes / Comments:

Change Owner:

Matthew Leser

Review Date :

12/16/16

Component Type :

Application

Lead Peer Reviewer:

Krishna Anne

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Sheet 4: Source Code

Rev 1.2

8-Jun-15

Peer Review Meeting Log (Source Code Review)

Source File Name:

MotCtrlPrmEstimn.c

Source File Revision:

Header File Name:

Header File Revision:

kzshz2: Intended Use: Identify which version of the source file is being review. Rationale: Required for traceability between source code and review. Auditors will likely require this.

MDD Name:

MotCtrlPrmEstimn_MDD.doc

Revision:

FDD/SCIR/DSR/FDR/CM Name:

SF102A_MotCtrlPrmEstimn_Design

Revision:

2.1.0

Quality Check Items:

Rationale is required for all answers of No

Working EA4 Software Naming Convention followed:

for variable names

Yes

Comments:

for constant names

N/A

Comments:

for function names

N/A

Comments:

for other names (component, memory

N/A

Comments:

mapping handles, typedefs, etc.)

All paths assign a value to outputs, ensuring

Yes

Comments:

all outputs are initialized prior to being written

Requirements Tracability tags in code match the requirements tracability in the FDD

N/A

Comments:

requirements tracability in the FDD

All variables are declared at the function level.

N/A

Comments:

Synergy version matches change history

kzshz2: Intended Use: Indicate that the the versioning was confirmed by the peer reviewer(s). Rationale: There have been many occassions where versions were not updated in files and as a result Unit Test were referencing wrong versions. This often time leads to the need to re-run of batch tests.

Yes

Comments:

and Version Control version in file comment block

Change log contains detailed description of changes

Yes

Comments:

and Work CR number

Code accurately implements FDD (Document or Model)

Yes

Comments:

Verified no Compiler Errors or Warnings

KMC: Intended Use: To confirm no compiler errors or warnings exist for the code under review (warnings from contract header files may be ignored). Rationale: This is needed to ensure there will be no errors discovered at the time of integration. A Sandox project should be used; QAC can find compiler errors but not warnings.

Yes

Comments:

Component.h is included

N/A

Comments:

All other includes are actually needed. (System includes

Yes

Comments:

only allowed in Nexteer library components)

Software Design and Coding Standards followed:

Version:

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

Yes

Comments:

standards and contain correct information: [N41], [N42]

Function comment blocks are per standards and

Yes

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

Yes

Comments:

"magic numbers": [N12]

Memory mapping for non-RTE code

N/A

Comments:

is per standard

All execution-order-dependent code can be

Yes

Comments:

recognized by the compiler: [N80]

All loops have termination conditions that ensure

N/A

Comments:

finite loop iterations: [N63]

All divides protect against divide by zero

N/A

Comments:

if needed: [N65]

All integer division and modulus operations

N/A

Comments:

handle negative numbers correctly: [N76]

All typecasting and fixed point arithmetic,

N/A

Comments:

including all use of fixed point macros and

timer functions, is correct and has no possibility

of unintended overflow or underflow: [N66]

All float-to-unsiged conversions ensure the.

N/A

Comments:

float value is non-negative: [N67]

All conversions between signed and unsigned

N/A

Comments:

types handle msb==1 as intended: [N78]

All pointer dereferencing protects against

N/A

Comments:

null pointer if needed: [N70]

Component outputs are limited to the legal range

YES

Comments:

defined in the FDD DataDict.m file : [N53]

All code is mapped with FDD (all FDD

YES

Comments:

subfunctions and/or model blocks identified

with code comments; all code corresponds to

some FDD subfunction and/or model block): [N40]

Review did not identify violations of other

YES

Comments:

coding standard rules

Anomaly or Design Work CR created

N/A

Comments: List Anomaly or CR numbers

for any FDD corrections needed

General Notes / Comments:

Change Owner:

Matthew Leser

Review Date :

12/16/16

Lead Peer Reviewer:

Krishna Anne

Approved by Reviewer(s):

YES

Other Reviewer(s):

Sheet 5: MDD

Rev 1.2

8-Jun-15

Peer Review Meeting Log (MDD Review)

MDD Name:

MotCtrlPrmEstimn_MDD.doc

MDD Revision:

Source File Name:

MotCtrlPrmEstimn.c

Source File Revision:

Source File Name:

Source File Revision:

Source File Name:

Source File Revision:

Quality Check Items:

Rationale is required for all answers of No

Synergy version matches document

YES

Comments:

Change log contains detailed description of changes

YES

Comments:

Changes Highlighted (for Unit Tester)

YES

Comments:

Diagrams have been included per MDD Guideline

N/A

Comments:

and reviewed

All Design Exceptions and Limitations are listed

N/A

Comments:

Design rationale given for all global

N/A

Comments:

data not communicated through RTE ports, per

Design and Coding Standards rules [N9] and [N10].

All implementation details that differ from the FDD are

N/A

Comments:

noted and explained in Design Rationale

All Unit Test Considerations have been described

N/A

Comments:

General Notes / Comments:

Change Owner:

Matthew Leser

Review Date :

12/16/16

Lead Peer Reviewer:

Krishna Anne

Approved by Reviewer(s):

YES

Other Reviewer(s):

Sheet 6: PolySpace

Rev 1.2

8-Jun-15

Peer Review Meeting Log (QAC/PolySpace Review)

Source File Name:

MotCtrlPrmEstimn.c

Source File Revision:

Source File Name:

Source File Revision:

Source File Name:

Source File Revision:

EA4 Static Analysis Compliance Guideline version:

Draft 1.2

Poly Space version:

Windows User: eg. 2013b 2013b

Polyspace sub project version:

Windows User: eg. TL108a_PolyspaceSuprt_1.0.0 N/A

QAC version:

Windows User: eg 8.1.1-R 8.1.1-R

QAC sub project version:

Windows User: eg. TL_100A_1.1.0 TL_100A_1.1.0

Quality Check Items:

Rationale is required for all answers of No

Contract Folder's header files are appropriate and

kzshz2: Intended Use: Identify that the contract folder contains only the information required for this component. All other variables, constants, function prototypes, etc. should be removed. Rationale: This will help avoid unit testers having to considers object not used. It will also avoid having other files required for QAC.

YES

Comments:

function prototypes match the latest component version

100% Compliance to the EA4 Static Analysis

YES

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

Cyclomatic complexity and Static path count OK

Creager, Kathleen: use Browse Function Metrics, STCYC and STPTH

YES

Comments:

for all functions in the component per Design

and Coding Standards rule [N47]

General Notes / Comments:

Change Owner:

Matthew Leser

Review Date :

12/16/16

Lead Peer Reviewer:

Krishna Anne

Approved by Reviewer(s):

YES

Other Reviewer(s):

4 - requirements

FDD	ID	Source	Function	Line(s)	Status	Comment
		.SwFileName	.SwFuncName	.SwLines	.SwStatus	.SwComment
SF102A	37	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	655	I
SF102A	50	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	420-428,435-475	I
SF102A	60	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	487-530,542-586	I
SF102A	89	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	490-533	I
SF102A	64	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	385	I
SF102A	83	MotCtrlPrmEstimn.c	GetMotPrmNomEol_Oper	253-260	I
SF102A	80	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	664-702	I
SF102A	81	MotCtrlPrmEstimn.c	SetMotPrmNomEol_Oper	778-797	I
SF102A	87	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	414	I
SF102A	27	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	416	I
SF102A	42	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	581	I
SF102A	40	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	472	I
SF102A	41	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	526	I
SF102A	79	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	663-701,711-730	I
SF102A	28	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	696	I
SF102A	77	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnInit1,MotCtrlPrmEstimnPer1,MotCtrlPrmEstimnPer2,SetMotPrmNomEol_Oper	310-336,438-478,488-531,543-587,661-699,709-728,781-800	I
SF102A	98	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	440-480	I
SF102A	72	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	415,416	I
SF102A	91	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	491-534	I
SF102A	90	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	544-588	I
SF102A	92	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	545-589	I
SF102A	97	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	439-479	I
SF102A	78	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	662-700,710-729	I
SF102A	39	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	654	I
SF102A	38	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	656	I
SF102A	59	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2,SetMotPrmNomEol_Oper	665-703,780-799	I
SF102A	58	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1,SetMotPrmNomEol_Oper	437-477,779-798	I
SF102A	55	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	489-532,540-584	I
SF102A	32	MotCtrlPrmEstimn.c	SetMotPrmNomEol_Oper	782-801	I
SF102A	56	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	422-430,541-585	I
SF102A	51	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	436-476	I
SF102A	36	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	415	I
SF102A	53	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer1	421-429,486-529	I
SF102A	63	MotCtrlPrmEstimn.c	MotCtrlPrmEstimnPer2	638	I