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

Return to the regular view of this page.

Commont Manufacturing Services

1: CMSCommon Design Review
2: Data Dictionary

Commont Manufacturing Services

Component Documentation

1 - CMSCommon Design Review

Overview

Summary Sheet
Source Code

Sheet 1: Summary Sheet

Rev 2.0

26-Aug-13

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

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. CMSCOMMON_07A.5

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. Jared Julien

Change Request ID:

11578

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:

Updates to support DiagMgr updates to generic parameters

General Guidelines:
- The reviews should 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 should be done prior to reviewing the modifications for this Change Result)
- The Change Owner is 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: Source Code

Rev 2.0

26-Aug-13

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. EPS_DiagSrvcs_ISO.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. 65

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

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

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 3

Quality Check Items:

Yes

Rationale is required for all answers of No

Pre-review checklist
(change owners only)

Analysis performed for divide by zero

kzshz2: Intended Use: To confirm this defensive coding strategy has been taken into consideration Rationale: Necessary since currently there is no place this is documented

Comments:

No Change

Software Design and Coding Standard followed

Comments:

Software Naming Convention followed

Comments:

All buffered outputs are written in every path

Comments:

N/A

Group-review Checklist (review board)

Telelogic Synergy version matches header

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:

Change log contains detailed description of changes

Comments:

Code compared vs requirements (Document or Model)

kzshz2: Intended Use: Identify if previous version was compared and only the expected change(s) was present. Rationale: This is helpful in identifying unapproved (intended or mistaken) changes.

Comments:

N/A

Global Outputs (RTE/Non-RTE) Initialized

Comments:

N/A

Global Outputs are limited to the legal range defined

Comments:

N/A

in the FDD Data dictionary

No Compiler Errors verified

kzshz2: Intended Use: To confirm the appropriate variable name formats have been used. Rationale: This is needed to ensure there will be no errors discovered at the time of integration. A Sandox project may be required to confirm there are no errors until the QAC tool has been evaultated to determine if it can automate this check.

Comments:

Type Casting and Fix Point Macros use reviewed

Comments:

No change

Function prototype and passed parameters are

Comments:

consistent

General Notes / Comments:

kzshz2: Intended Use: Identify who where 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. Group Review Level: There are four Design Review States that a document may have as follows: DR1 – Un-reviewed document. The DR1 reviews usually require larger, cross functional review teams (i.e. Management, Hardware Engineering, etc.) It is usually advisable, but not required to include outside representation as well such as system engineers. It is up to the document owner to decide on the scope of the review, however, the peer group can decide that a re-review with additional team member is required. DR2 – The Document has previously passed through the peer review process, but requires design changes significant enough to require another group peer review. DR3 – The Document has passed group peer review but needs minor corrections that can be re-reviewed with the Lead Peer Reviewer. DR4 – The document has passed all peer reviews and is ready for release. Review Board:

Change Owner:

Jared Julien

Review Date :

03/07/14

Group Review Level:

DR4

Lead Peer Reviewer:

Owen Tosh

Approved by Reviewer(s):

Yes

Other Reviewer(s):

2 - Data Dictionary

Overview

Change Log
Variable Dictionary
Calibration Dictionary
Global Constants
Template
Help

Sheet 1: Change Log

CMSBMW- Rev 3				<- Global Program / Module Name
Revision	Author	Date	Change Description		Data Dictionary Type:	Component
1.0	VK	18-Mar-13	Initial Creation
2.0	NPH	31-May-13	FDD reference
3	LK	29-Jan-14	k_CMSGotoPosPol_Cnt_s08 added for Generate Position Trajectory Handwheel angle input polarity

Sheet 2: Variable Dictionary

CMSBMW- Rev 3

Variable Information

Range

Software Variable Name

Standard Reference Name

FDD Reference

Description

[I]nput [O]uput [M]oduleInternal [D]isplay [N]onVolatileMemory Usage

OEM

1X, 1Y, 1Z, 1I, 1BS 2X, 2Y, 2Z, 2I, 2BS etc Graph Settings

Initalization Value

Min

Max

Resolution

Unit Test Tolerance (+/-)

Units

Type

Memory Segment

Variables

Sheet 3: Calibration Dictionary

CMSBMW- Rev 3

Calibration Information

Achieved in Software Design

Range

Software Calibration Name

Standard Reference Name

FDD Reference

Description

Tuning Set

OEM

1X, 1Y, 1Z, 1I, 1BS 2X, 2Y, 2Z, 2I, 2BS etc Graph Settings

Default Value

Min

Max

Units

Type

Memory Segment

k_NxtrSrvcPosTrajThres_HwDeg_f32

Unknown

0.00E+00

1.44E+03

HwDeg

float32

k_NxtrSrvcPosTrajHoldTime_mS_u16

Unknown

5000

0.00E+00

6.50E+04

uint16

k_NxtrSrvcHandsOnTime_mS_u16

Unknown

5000

0.00E+00

6.50E+04

uint16

k_F00FHandsOnThres_HwNm_f32

Unknown

0.5

0.00E+00

1.00E+01

HwNm

float32

k_CMSGotoPosPol_Cnt_s08

Unknown

-1

cnt

sint8

Sheet 4: Global Constants

CMSBMW- Rev 3

Variable Information (Global Variables Only)

Achieved in Software Design

Used in Module List

Layer 2

Layer 3

Layer 4

Layer 5

Constant Name

Description

Uints

Type

Engineering Value

ADC

ADC Diagnostics

Data Memory Verification

DC Link Power Control

DSP Computational Integrity

DSP SPI driver

Event Manager Driver

External Memory Driver

Flash Programming Exec

GPIO

Illegal OpCode Handler

Interrupt Handler

Motor Current Driver

Motor Driver Diagnostics

Motor Position Driver

Phase Feedback Capture

Powerdown Control

Primary Shutdown Control

Program Flow

Program Memory Diagnostic

PWM Duty Cycle

Redundant Memory Check

Redundant Rapid Shutdown

Scheduler

Stack Monitor

State Dependent Task List

System Boot & Startup

System Control

Temperature Sensor Diagnostic

Unused Interrupt Handler

Utilization Monitor

Watchdog Dirver

Smith

Battery Voltage

Battery Voltage Diagnostics

Diagnostic CTC Manager

Diagnostic Manager

Diagnostics Application Services

EOL TorqueTest

Flash Boot Loader

Flight Recorder

Handwheel Position

Handwheel Torque

Motor Control Output Conversion

Motor Position Diagnostics

Motor Position Initialization

Motor Velocity

Motor Velocity Tachometer

Serial Communications I/O

Serial Communications Services

States and Modes

Tuning Select

Vehicle Power Mode

Vehicle Speed

Controller Polarity

Current Estimation

Handwheel Velocity

Inverse Motor Model

Motor Temperature Estimation

Motor Torque Limit

Output Reasonableness Dianostic

Parameter Estimation

Quadrant and rate Detection

Active Pull Compensation

Assist

Damping

Duty Cycle

Kinematic Integrity Diagnostic

Long Term Vehicle Speed Diagnostic

Max Assist Limit

Return

State Output Control

Torque Output

D_OVRSMPLBUFFSIZE_CNT_U16

Sheet 5: Template

2.2a	Data File:

	Header:	extern <TYPE><TAB><NAME>;

	Source:	#pragma DATA_SECTION(<ROOTNAME>, "<SEGMENT>"); <TYPE> <NAME>;

	EOL Constants:

	Header:	extern <TYPE><TAB><NAME>;

	Source:	#pragma DATA_SECTION(<ROOTNAME>, "<SEGMENT>"); <TYPE> <NAME>;

	Global (Embedded) Constants:

	Header:	#define <NAME><COL40><VALUE>

	A2L Name

	Measurement:	rte_<SWC>_<NAME>

	Calibration Constants:

	Tuning ID:


	Tuning:	N	Index Range:

	Header:	extern CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME>;

	Source:	#pragma DATA_SECTION(<ROOTNAME>, ".<SEGMENT>"); CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME> = <VALUE>;

	eCal:	<NAME>



	Tuning:	Y	Index Range:

	Header:	<NONCRITICAL> #define <ROOTNAME><TAB>k_N_CalNC_Cnt_Str.<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> #define <ROOTNAME><TAB>k_S_CalSC_Cnt_Str.<ROOTNAME> <SAFETYCRITICAL>

	Source:

	eCal:	<NONCRITICAL> k_N_CalNC_Cnt_Str.<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> k_S_CalSC_Cnt_Str.<ROOTNAME> <SAFETYCRITICAL>



	Tuning:	P	Index Range:

	Header:	<NONCRITICAL> #define <ROOTNAME><TAB>k_N_CalNC_Cnt_Str.Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> #define <ROOTNAME><TAB>k_S_CalSC_Cnt_Str.SC_Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <SAFETYCRITICAL>

	Source:

	eCal:	<NONCRITICAL> k_N_CalNC_Cnt_Str.Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> k_S_CalSC_Cnt_Str.SC_Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <SAFETYCRITICAL>

Sheet 6: Help

Short cut	Macro	Sescription
Ctrl-q	ClearDataDictFilter	Will clear all autofilters on the Global Data Dictionary

	DFD_Create	Creates a Series of Data Flow Worksheet Pages from the information in the data dictionary. If Data Flow Worksheet pages already exist, they will be deleted first.
	DFD_Delete	Will clear all Data Flow Diagram pages from the Data Dictionary. This will make the file smaller for archiving.
	DFD_Print	Formate and prepares to print the Data Flow Worksheet pages.