Sr. No.	Title	Version
1	FDD – ES102A_PolarityCfg_Design	See Synergy sub project version
2	Software Naming Conventions	Process 3.06.00
3	Software Design and Coding Standards	Process 3.06.00

Dependencies

SWCs

Module	Required Feature
None

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

None

Da Vinci Parameter Configuration Changes

Parameter	Notes	SWC
None

DaVinci Interrupt Configuration Changes

ISR Name	VIM #	Priority Dependency	Notes
None

Manual Configuration Changes

Constant	Notes	SWC
None

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Refer DataDict.m file in the FDD

Required Global Data Outputs

Refer DataDict.m file file in the FDD

Specific Include Path present

Runnable Scheduling

This section specifies the required runnable scheduling.

Init	Scheduling Requirements	Trigger
PolarityCfgInit1	None	Init

Runnable	Scheduling Requirements	Trigger
PolarityCfgRead_Oper PolarityCfgWr_Oper		On event On event

PolarityCfgRead_Oper

PolarityCfgWr_Oper

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
<Memmap usuage info>

Table 1: ARM Cortex R4 Memory Usage

Non RTE NvM Blocks

Block Name
None

RTE NvM Blocks

Block Name
PolarityCfgSaved

Compiler Settings

Preprocessor MACRO

None.

Optimization Settings

None

Appendix

None

2 - PolarityCfg_MDD

Module Design Document

For

‘PolarityCfg’

VERSION: 3.0

DATE: 07-Jul-2017

Prepared By:

Shawn Penning,

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
1	Initial Version	Sankardu Varadapureddi	1.0	26-May-2015
3	Corrections to Name and Graphic, Update MDD Layout	Shawn Penning	3.0	07-Jul-2017

Table of Contents

1 Polarity Configuration High-Level Description 6

2 Design details of software module 7

2.1 Graphical representation of Polarity Configuration 7

2.2 Data Flow Diagram 7

2.2.1 Module level DFD 7

2.2.2 Sub-Module level DFD 7

2.3 COMPONENT FLOW DIAGRAM 8

3 Variable Data Dictionary 9

3.1 User defined typedef definition/declaration 9

3.2 Variable definition for enumerated types 9

4 Constant Data Dictionary 10

4.1 Program(fixed) Constants 10

4.1.1 Embedded Constants 10

4.1.1.1 Local 10

4.1.1.2 Global 10

4.1.2 Module specific Lookup Tables Constants 10

5 Software Module Implementation 11

5.1 Sub-Module Functions 11

5.1.1 Initialization Functions 11

5.1.1.1 INIT: PolarityCfgInit 11

5.1.1.1.1 Design Rationale 11

5.1.1.1.2 Module Outputs 11

5.1.1.1.3 Module Internal 11

5.1.2 PERIODIC FUNCTIONS 11

5.1.3 Interrupt Functions 11

5.1.4 Server runnables 12

5.1.4.1 PolarityCfgRead 12

5.1.4.1.1 Design Rationale 12

5.1.4.1.2 Store Module Inputs to Local copies 12

5.1.4.1.3 (Processing of function)……… 12

5.1.4.1.4 Store Local copy of outputs into Module Outputs 12

5.1.4.2 PolarityCfgWr 12

5.1.4.2.1 Design Rationale 12

5.1.4.2.2 Store Module Inputs to Local copies 12

5.1.4.2.3 (Processing of function)……… 12

5.1.4.2.4 Store Local copy of outputs into Module Outputs 12

5.1.5 Local Function/Macro Definitions 12

5.1.5.1 Local Function #1 12

5.1.5.2 Description 12

5.1.6 GLObAL Function/Macro Definitions 13

5.1.7 Transition FUNCTIONS 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

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

Polarity Configuration High-Level Description

This function will identify polarity control settings for certain points in the design.

Design details of software module

Graphical representation of Polarity Configuration

Data Flow Diagram

Refer FDD

Module level DFD

Refer FDD

Sub-Module level DFD

Refer FDD

COMPONENT FLOW DIAGRAM

Refer FDD

Variable Data Dictionary

User defined typedef definition/declaration

<This section documents any user types uniquely used for the module.>

None

Variable definition for enumerated types

Enum Name	Element Name	Value
None

Constant Data Dictionary

Program(fixed) Constants

Embedded Constants

Local

Constant Name	Resolution	Units	Value
HWAG0POL_CNT_U32	Bitfield Mask	NA	0x00000001U
HWAG1POL_CNT_U32	Bitfield Mask	NA	0x00000002U
HWAG2POL_CNT_U32	Bitfield Mask	NA	0x00000004U
HWAG3POL_CNT_U32	Bitfield Mask	NA	0x00000008U
HWAG4POL_CNT_U32	Bitfield Mask	NA	0x00000010U
HWAG5POL_CNT_U32	Bitfield Mask	NA	0x00000020U
HWAG6POL_CNT_U32	Bitfield Mask	NA	0x00000040U
HWAG7POL_CNT_U32	Bitfield Mask	NA	0x00000080U
HWTQ0POL_CNT_U32	Bitfield Mask	NA	0x00000100U
HWTQ1POL_CNT_U32	Bitfield Mask	NA	0x00000200U
HWTQ2POL_CNT_U32	Bitfield Mask	NA	0x00000400U
HWTQ3POL_CNT_U32	Bitfield Mask	NA	0x00000800U
HWTQ4POL_CNT_U32	Bitfield Mask	NA	0x00001000U
HWTQ5POL_CNT_U32	Bitfield Mask	NA	0x00002000U
HWTQ6POL_CNT_U32	Bitfield Mask	NA	0x00004000U
HWTQ7POL_CNT_U32	Bitfield Mask	NA	0x00008000U
MOTAGMECL0POL_CNT_U32	Bitfield Mask	NA	0x00010000U
MOTAGMECL1POL_CNT_U32	Bitfield Mask	NA	0x00020000U
MOTAGMECL2POL_CNT_U32	Bitfield Mask	NA	0x00040000U
MOTAGMECL3POL_CNT_U32	Bitfield Mask	NA	0x00080000U
MOTAGMECL4POL_CNT_U32	Bitfield Mask	NA	0x00100000U
MOTAGMECL5POL_CNT_U32	Bitfield Mask	NA	0x00200000U
MOTAGMECL6POL_CNT_U32	Bitfield Mask	NA	0x00400000U
MOTAGMECL7POL_CNT_U32	Bitfield Mask	NA	0x00800000U
MOTELECMECLPOL_CNT_U32	Bitfield Mask	NA	0x01000000U
ASSIMECHPOL_CNT_U32	Bitfield Mask	NA	0x02000000U

Global

Constant Name

Module specific Lookup Tables Constants

Constant Name	Resolution	Value	Software Segment
None

Software Module Implementation

Sub-Module Functions

Initialization Functions

PolarityCfgInit

INIT: PolarityCfgInit

Design Rationale

Design follows implemenetation in FDD.

Module Outputs

Refer ‘PolarityCfgInit’ block in FDD

Module Internal

None

PERIODIC FUNCTIONS

None

Interrupt Functions

None

Server runnables

PolarityCfgRead

Design Rationale

None

Store Module Inputs to Local copies

None

(Processing of function)………

Refer ‘PolarityCfgRead’ block in FDD

Store Local copy of outputs into Module Outputs

None

PolarityCfgWr

Design Rationale

None

Store Module Inputs to Local copies

None

(Processing of function)………

Refer ‘PolarityCfgWr’ block in FDD

Store Local copy of outputs into Module Outputs

None

Local Function/Macro Definitions

Local Function #1

Function Name	GetPolarity	Type	Min	Max
Arguments Passed	Polarity_Cnt_T_u32	uint32	0	0xFFFFFFFF
	PolarityMask_Cnt_T_u32	uint32	0x00000001	0x02000000
Return Value	Polarity_Cnt_T_s08	sint08	-1	1

Description

Design:

if ( (Polarity_Cnt_T_u32 & PolarityMask_Cnt_T_u32) == PolarityMask_Cnt_T_u32 )

set ‘Polarity_Cnt_T_s08’ to ‘1’

else

set ‘Polarity_Cnt_T_s08’ to ‘-1’

Note: ‘PolarityMask_Cnt_T_u32’ is a bit field mask and takes values mentioned in table at sec 6.1.1.1

GLObAL Function/Macro Definitions

None

Transition FUNCTIONS

None

Known Limitations With Design

None

UNIT TEST CONSIDERATION

None

Appendix A Abbreviations and Acronyms

Abbreviation	Description
DFD	Design functional diagram
MDD	Module design Document
FDD	Functional Design Document

Appendix B 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

Appendix C References

Ref. #	Title	Version
1	AUTOSAR Specification of Memory Mapping	v1.3.0 R4.0 Rev 2
2	MDD Guideline	EA4 01.00.01
3	Software Naming Conventions.doc	EA4 01.00.00
4	Software Design and Coding Standards.doc	2.1
5	FDD : ES102A_PolarityCfg_Design	See Synergy sub project version

3 - PolarityCfg_Peer Review Checklists

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. ES102A_PolarityCfg_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. ES102A_PolarityCfg_Impl_1.1.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. Shawn Penning

Work CR ID:

EA4#11049

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:

Shawn Penning

Review Date :

07/07/17

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Krishna Anne

Bri Spencer

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

Yes

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

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

N/A

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

N/A

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

Yes

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

Yes

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:

Shawn Penning

Review Date :

07/07/17

Component Type :

Application

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Krishna Anne

Bri Spencer

Sheet 4: Source Code

Rev 1.2

8-Jun-15

Peer Review Meeting Log (Source Code Review)

Source File Name:

PolarityCfg.c

Source File Revision:

Header File Name:

N/A

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

MDD Name:

PolarityCfg_MDD.docx

Revision:

FDD/SCIR/DSR/FDR/CM Name:

ES102A_PolarityCfg_Design

Revision:

1.3.0

Quality Check Items:

Rationale is required for all answers of No

Working EA4 Software Naming Convention followed:

for variable names

N/A

Comments:

for constant names

N/A

Comments:

for function names

Yes

Comments:

for other names (component, memory

N/A

Comments:

mapping handles, typedefs, etc.)

All paths assign a value to outputs, ensuring

N/A

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

Tags removed

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)

N/A

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

N/A

Comments:

only allowed in Nexteer library components)

Software Design and Coding Standards followed:

Version: 2.1

Code comments are clear, correct, and adequate

N/A

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

N/A

Comments:

contain correct information: [N43]

Code formatting (indentation, placement of

N/A

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 execution-order-dependent code can be

N/A

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

N/A

Comments:

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

All code is mapped with FDD (all FDD

N/A

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:

Shawn Penning

Review Date :

07/07/17

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Krishna Anne

Bri Spencer

Sheet 5: MDD

Rev 1.2

8-Jun-15

Peer Review Meeting Log (MDD Review)

MDD Name:

PolarityCfg_MDD.docx

MDD Revision:

Source File Name:

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

Yes

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:

Shawn Penning

Review Date :

07/07/17

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Krishna Anne

Bri Spencer

Sheet 6: PolySpace

Rev 1.2

8-Jun-15

Peer Review Meeting Log (QAC/PolySpace Review)

Source File Name:

PolarityCfg.c

Source File Revision:

Source File Name:

Source File Revision:

Source File Name:

Source File Revision:

EA4 Static Analysis Compliance Guideline version:

01.02.00

Poly Space version:

Windows User: eg. 2013b 2013B

Polyspace sub project version:

Windows User: eg. TL108a_PolyspaceSuprt_1.0.0

QAC version:

Windows User: eg 8.1.1-R

QAC sub project version:

Windows User: eg. 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

N/A

Comments:

for all functions in the component per Design

and Coding Standards rule [N47]

General Notes / Comments:

Change Owner:

Shawn Penning

Review Date :

07/07/17

Lead Peer Reviewer:

Brendon Binder

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Krishna Anne

Bri Spencer