Sr. No.	Title	Version
1	FDD – ES228A/HwTqArbn	See synergy sub project version
2	Software Naming Conventions	Process 03.06.00
3	Software Coding Standards	Process 03.06.00

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

< Global function (except the ones that are defined in RTE modules) that is defined in this component but used by other function>

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

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
None

Runnable	Scheduling Requirements	Trigger
HwTqArbnPer1	None	RTE 2ms Task

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

None

Note : Size of the NVM block if configured in developer

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

2 - HwTqArbn_MDD

Module Design Document

For

Handwheel Torque Arbitration

VERSION: 1.0

DATE: 11-MAY-2015

Prepared By:

Software Group,

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	Rijvi Ahmed	1.0	11-May-2015

Table of Contents

1 Abbrevations And Acronyms 5

2 References 6

3 MDD HWTQARBN & High-Level Description 7

4 Design details of software module 8

4.1 Graphical representation of HWTQARBN 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.3 PERIODIC FUNCTIONS 11

7.3.1 Per: HwTqArbnPer1 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.4 Interrupt Functions 11

7.5 Serial Communication Functions 12

7.6 Local Function/Macro Definitions 12

7.6.1 Local Function #1 12

7.6.1.1 Description 12

7.7 GLObAL Function/Macro Definitions 12

7.7.1 GLObAL Function #1 12

7.7.1.1 Description 12

7.8 TRANSIENT FUNCTIONS 12

8 Known Limitations With Design 13

9 UNIT TEST CONSIDERATION 14

1 Appendix 15

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 03.06.00
2	Software Naming Conventions	Process 03.06.00
3	Software Coding Standards	Process 03.06.00
4	FDD – ES228A/HwTqArbn	See synergy sub project version

MDD HWTQARBN & High-Level Description

None

Design details of software module

Graphical representation of HWTQARBN

Data Flow Diagram

Module level DFD

N/A

Sub-Module level DFD

N/A

COMPONENT FLOW DIAGRAM

N/A

Variable Data Dictionary

User defined typedef definition/declaration

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

Typedef Name

Element Name

User Defined Type

Legal Range

(min)

Legal Range

(max)

N/A

Variable definition for enumerated types

Enum Name	Element Name	Value

Constant Data Dictionary

Program(fixed) Constants

Embedded Constants

< All program specific constants will be defined in detail >

Local

Constant Name	Resolution	Units	Value
CORRLNSTSMASKSIGA_CNT_U08	1	Cnt	0x01u
CORRLNSTSMASKSIGB_CNT_U08	1	Cnt	0x02u
CORRLNSTSMASKSIGC_CNT_U08	1	Cnt	0x04u
CORRLNSTSMASKSIGD_CNT_U08	1	Cnt	0x08u
MAXSTALLCNTR_CNT_U08	1	Cnt	255u

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

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

Software Module Implementation

Sub-Module Functions

None

Initialization Functions

<(Note: For multiple init functions, insert new headers at the “Header 2” level – subset of “ Initialization Function section above” and follow the same sub-section design shown below . If none required, place the text “None”))>

None

PERIODIC FUNCTIONS

(Note: For multiple periodic functions, insert new headers at the “Header 2” level – subset of “7.3 Periodic Functions” and follow the same sub-section design shown below). If none required, place the text “None”)>

Per: HwTqArbnPer1

Design Rationale

None

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

Interrupt Functions

None

Serial Communication Functions

None

Local Function/Macro Definitions

Local Function #1

Function Name	SigAvlChkRev	Type	Min	Max
Arguments Passed	SigRollgCntr_Cnt_T_u08	Uint8	0	255
	SigQlfr_Cnt_T_enum	SigQlfr1	0	2
	kMaxStallCnt_Cnt_T_u08	Uint8	0	255
	*LstRollgCntr_Cnt_T_u08	Uint8	0	255
	*StallCntr_Cnt_T_u08	Uint8	0	255
Return Value	SigAvl_Cnt_T_lgc	boolean	0	1

Description

Refer to FDD

GLObAL Function/Macro Definitions

GLObAL Function #1

Function Name	None	Type	Min	Max
Arguments Passed	None	<Refer MDD guidelines[1]>	<Refer MDD guidelines[1]>	<Refer MDD guidelines[1]>

Return Value	None

Description

N/A

TRANSIENT FUNCTIONS

None

Known Limitations With Design

None

UNIT TEST CONSIDERATION

None

Appendix

None

3 - HwTqArbn_PeerReviewChecklist

Overview

Summary Sheet
Davinci Files
Source Code
MDD
QAC
Integration Manual

Sheet 1: Summary Sheet

Rev 6.0

28-Oct-14

Peer Review Summary Sheet

Component 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. ES228A_HwTqArbn_Impl

Component Revision:

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. 1.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. Rijvi Ahmed

Change Request ID:

EA4#431

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:

MDD

Source Code

Data Dictionary

QAC

Integration Manual

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. (Note: If this peer review form was not
completed for pervious versions of this component, the Change Owner should review the entire component and complete the checklist in its entirety prior and check
the form into Syngery. This may be done prior to reviewing the modifications for this Change Result)
- The Change Owner shall responsible for completing the entire checklist (Pre and Group review items) prior holding the initial group review.
- New components should include FDD Owner and Intergator as apart of the Group Review Board (Source Code, Integration Manual, and Davinci Files)
- Select "Yes" and add "N/A" to the comments for checklist items that are not applicable for this change

Sheet 2: Davinci Files

Rev 6.0

28-Oct-14

Peer Review Meeting Log (Davinci Review)

Quality Check Items:

Yes

Rationale is required for all answers of No

Pre-review checklist for change owners

DCF: Latest StdDef imported

Comments:

DCF: Only StdDef Port types are used (if not

Comments:

add justification)

DCF: All unused definitions removed

Comments:

N/A for EA4 component

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

Comments:

N/A

change correctly

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

*Cfg.h.TT: Verfied Davinci Configurator generates

Comments:

N/A

the configuration header(s) file correctly

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

Group-review for review board

All changed files have been compared against previous

Comments:

N/A. Initial version

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.

DCF:Automated validation check is performed

Comments:

DCF: Inputs/Outputs match names from requirements

Comments:

See note

DCF: Inputs/Outputs configuration paremeters

Comments:

reviewed

kzshz2: Intended Use: All changed inputs have been reviewed to ensure configuration parameters (i.e. Buffered vs Direct read/writes) are correct. This includes signal grouping when signal consistency is required by the FDD

DCF: Sender/Reciever Ports type and default values

Comments:

See note

match their corresponding ports (internal/external)

kzshz2: Intended Use: Identify if all the Sender/Reciever ports are compatibale with there connecting ports. Rationale: This will help to avoid errors when this component is being integrated into a project.

DCF: Ports prototype and default values

Comments:

match their corresponding ports (internal/external)

kzshz2: Intended Use: Identify if all the Server/Client ports are compatibale with there connecting ports. Rationale: This will help to avoid errors when this component is being integrated into a project.

DCF: Server runnable variables are using direct

Comments:

N/A

read/writes

DCF: Runnable calling frequencies match requirements

Comments:

General Notes / Comments:

Some signals name, data type, init value and range need to be updated in the FDD. Email has been sent to FDD owner for the changes. Check with FDD when updated. Done

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:

Rijvi Ahmed

Review Date :

05/20/15

Lead Peer Reviewer:

Kathleen Creager

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Sheet 3: Source Code

Rev 6.0

28-Oct-14

Peer Review Meeting Log (Source Code Review)

Source File Name:

kzshz2: Intended Use: Identify which .asm, .c, or .h file is being reviewed Rationale: Required for traceability. It will help to ensure this sheet is not attached to the wrong design review form. HwTqArbn.c

Source 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. 1

Module Design Document Name:

kzshz2: Intended Use: Identify which version of the MDD this source file was written against. Rationale: Needed for traceability between source code and MDD HwTqArbn_MDD.doc

MDD Revision:

kzshz2: Intended Use: Identify which version of the MDD this source file was written against. Rationale: Needed for traceability between source code and MDD 1

Data Dictionary Revision:

kzshz2: Intended Use: Identify which version of the Data Dictionary was referenced for ranges during the source file review. Rationale: Needed for traceability between source code and DD N/A

FDD/SER/CMS

and Revision:

nz63rn: Intended Use: Identify which version of which FDD/CMS/SER this source file was written against. Rationale: Needed for traceability between source code and FDD/CMS/SER ES228A_HwTqArbn_Design_1.1.0

Quality Check Items:

Yes

Rationale is required for all answers of No

Pre-review checklist for change owners

Software Naming Convention V1.2 followed:

for variable names

Comments:

See note

for constant names

Comments:

see note

for function names

Comments:

for other names (component, memory

Comments:

mapping handles, typedefs, etc.)

All buffered outputs written in every path, i.e. no

Comments:

possibility of an uninitialized value being written

Group-review Checklist (review board)

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.

Comments:

and Version Control version in file comment block

Change log contains detailed description of changes

Comments:

and CR number

Code accurately implements FDD (Document or Model)

Comments:

See notes

No Compiler Errors or Warnings verified

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.

Comments:

FDD test points exist as display variables: declared

Comments:

static volatile, written once and never used, names

match the FDD

Software Design and Coding Standards V2.0 followed:

Code comments are clear, correct, and adequate

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

Comments:

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

Function comment blocks are per standards and

Comments:

contain correct information: [N43]

Code formatting (indentation, placement of

Comments:

braces, etc.) is per standards: [N5], [N55], [N56],

[N57], [N58], [N59]

Embedded constants used per standards; no

Comments:

"magic numbers": [N12]

One magic number is used for averaging which is acceptable.

All variables and constants defined at module

Comments:

level are included in appropriate MemMap

section: [N25] and Naming Conventions

All execution-order-dependent code can be

Comments:

recognized by the compiler: [N80]

No possibility of a non-terminating loop: [N63]

Comments:

No possibility of divide by zero: [N65]

Comments:

All integer division and modulus operations

Comments:

N/A

handle negative numbers correctly: [N76]

All typecasting and fixed point arithmetic,

Comments:

N/A

including all use of fixed point macros and

timer functions, is correct and has no possibility

of unintended overflow or underflow: [N66]

No possibility of converting a negative floating

Comments:

point value to an unsigned type: [N67]

All conversions between signed and unsigned

Comments:

N/A

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

No possibility of dereferencing a null

Comments:

pointer: [N70]

Global outputs (RTE and Non-RTE) Initialized:

Comments:

[N24]

Module outputs are limited to the legal range

Comments:

defined in the FDD Data dictionary: [N53]

All code is mapped with FDD (all FDD

Comments:

subfunctions and/or model blocks identified

with code comments; all code corresponds to

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

Struct types used for NvM have

Comments:

N/A

elements declared in decreasing order by size

and are not nested or used in arrays: [N84], [N85]

No violations of other coding standard rules

Comments:

identified during review

General Notes / Comments:

1. A list of changes for FDD has been sent to the FDD author. Verify the scr code with FDD when updated. Done

2. Define constant for 'Max stall cntr' i.e. 255. Done

Change Owner:

Rijvi Ahmed

Review Date :

05/20/15

Lead Peer Reviewer:

Kathleen Creager

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Sheet 4: MDD

Rev 6.0

28-Oct-14

Peer Review Meeting Log (MDD Review)

Module Name:

kzshz2: Intended Use: Identify which file is has been reviewed Rationale: Required for traceability. It will help to ensure this sheet is not attached to the wrong design review form. HwTqArbn

Module

kzshz2: Intended Use: Identify how many source files are being reviewed and trace it to the appropriate MDD. Rationale: Required for traceability between source code and MDD

MDD Revision:

kzshz2: Intended Use: Identify which version of the MDD has been reviewed. Rationale: Required for traceability between the MDD and review. Auditors will likely require this. 1

Source File Revision:

kzshz2: Intended Use: Identify which version of the source file was this MDD written for. Rationale: Needed for traceability between source code and MDD 1

Data Dictionary Revision:

kzshz2: Intended Use: Identify which version of the Data Dictionary was referenced for ranges during the review. Rationale: Needed for traceability between source code and DD. Note: Maybe this should be moved to the Summary sheet since there is only one Data Dictionary Version for all changes N/A

Quality Check Items:

Yes

Rationale is required for all answers of No

Group-review Checklist (review board)

Synergy version matches header

Comments:

Change log contains detailed description of changes

Comments:

Changes Highlighted (for Unit Tester)

Comments:

N/A. initial version

High-level Diagrams have been reviewed (Section 2)

Comments:

All Design Exceptions and Limitations are listed

Comments:

Design rationale given for all module input and output

Comments:

N/A

data not communicated through RTE ports, per

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

All other Design rationale understood and captured

Comments:

appropriately

General Notes / Comments:

Change Owner:

Rijvi Ahmed

Review Date :

05/20/15

Lead Peer Reviewer:

Kathleen Creager

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Sheet 5: QAC

Rev 6.0

28-Oct-14

Peer Review Meeting Log (QAC Review)

Module Name:

kzshz2: Intended Use: Identify which .c file is being analyzed Rationale: Required for traceability. It will help to ensure this sheet is not attached to the wrong design review form. HwTqArbn

Source File Revision:

Module

Compliance Guidelines Version:

Working EA4 guideline

kzshz2: Intended Use: Identify specific changes in results (new violation present, previous violation corrected, etc.). Changes to the version of the tool or the way the results were gathered should be described here also. This should be filled out prior to the review by the change owner. Rationale: Gives reviewers an what needs to be focused on. Forces the change owner to compare with previous results to catch any differences that may otherwise go unoticed Brief Summary of Changes (In Results or Tool):

Quality Check Items:

Yes

Rationale is required for all answers of No

Pre-review
checklist for change owners

QAC version is correct and did not change (List version)

kzshz2: Intended Use: Identify which version of the QAC Subproject was used and if any of the personalities may have changed. Rationale: Will help ensure this is factored into evaluating the results

Comments:

TL100A_QACSuprt_1.1.0

Contract Folder's header files are appropriate

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.

Comments:

Group-review Checklist (review board)

100% Compliance to the MISRA Compliance Guidelines

Comments:

With approved deviations.

Cyclomatic complexity and Static path count ok per

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

Comments:

Design and Coding Standards rule [N47]

General Notes / Comments:

Polyspace was also run. Approved deviations are MISAR rules 19.1 and 8.10.

Deviation for MISRA rule 16.10 needs to be added in EA4 MISRA compliance document.

Polyspace code prover orange warnings for uninitialized variable, null pointer and overflow are okay because they are not the real issues. Polyspace doesn't understand RTE structure and range of variables.

Change Owner:

Rijvi Ahmed

Review Date :

05/20/15

Lead Peer Reviewer:

Kathleen Creager

Approved by Reviewer(s):

Yes

Other Reviewer(s):

Sheet 6: Integration Manual

Rev 6.0

28-Oct-14

Peer Review Meeting Log (Integration Manual Review)

Integration Manual Name:

kzshz2: Intended Use: Identify which file is being reviewed Rationale: Required for traceability. It will help to ensure this sheet is not attached to the wrong design review form. HwTqArbn_IntegrationManual.doc

Integration Manual Revision:

kzshz2: Intended Use: Identify which version of the integration manual has been reviewed. Rationale: Required for traceability between the MDD and review. Auditors will likely require this. 1

Quality Check Items:

Yes

Rationale is required for all answers of No

Group-review Checklist (review board)

Synergy version matches header

Comments:

Latest template used

Comments:

Change log contains detailed description of changes

Comments:

Changes Highlighted (for Integrator)

Comments:

N/A. initial version.

General Notes / Comments:

Change Owner:

Rijvi Ahmed

Review Date :

05/20/15

Lead Peer Reviewer:

Kathleen Creager

Approved by Reviewer(s):

Yes

Other Reviewer(s):

4 - requirements

FDD	ID	Source	Function	Line(s)	Status	Comment
		.SwFileName	.SwFuncName	.SwLines	.SwStatus	.SwComment
ES228A	16	HwTqArbn.c	HwTqArbnPer1	341,357	I
ES228A	128	HwTqArbn.c	HwTqArbnPer1	338-385	I
ES228A	82	HwTqArbn.c	HwTqArbnPer1	342,370	I
ES228A	98	HwTqArbn.c	HwTqArbnPer1	338-385	I
ES228A	83	HwTqArbn.c	HwTqArbnPer1	338-385	I
ES228A	91	HwTqArbn.c	HwTqArbnPer1,SigAvlChkRev	286,294,302,310,319-330,430-466	I
ES228A	129	HwTqArbn.c	HwTqArbnPer1	260-281,319-330	I
ES228A	85	HwTqArbn.c	HwTqArbnPer1	234-388	I