1 - MotVel_Integration Manual

Integration Manual

For

‘MotVel’

VERSION: 1.0

DATE: 12-April-2016

Prepared By:

Software Group

Nexteer Automotive,

Saginaw, MI, USA


Revision History

: ARM Cortex R4 Memory Usage

Sl. No.DescriptionAuthorVersionDate
1Initial versionRijvi Ahmed1.012-April-2016


Table of Contents

1 Abbrevations And Acronyms 4

2 References 5

3 Dependencies 6

3.1 SWCs 6

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

4 Configuration REQUIREMeNTS 7

4.1 Build Time Config 7

4.2 Configuration Files to be provided by Integration Project 7

4.3 Da Vinci Parameter Configuration Changes 7

4.4 DaVinci Interrupt Configuration Changes 7

4.5 Manual Configuration Changes 7

5 Integration DATAFLOW REQUIREMENTS 8

5.1 Required Global Data Inputs 8

5.2 Required Global Data Outputs 8

5.3 Specific Include Path present 8

6 Runnable Scheduling 9

7 Memory Map REQUIREMENTS 10

7.1 Mapping 10

7.2 Usage 10

7.3 Non RTE NvM Blocks 10

7.4 RTE NvM Blocks 10

8 Compiler Settings 11

8.1 Preprocessor MACRO 11

8.2 Optimization Settings 11

9 Appendix 12

Abbrevations And Acronyms

AbbreviationDescription
DFDDesign functional diagram
MDDModule design Document

References

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

Sr. No.TitleVersion
1FDD – SF40A_MotVel_DesignSee Synergy sub project version
2Software Naming ConventionsProcess 04.02.01
3Software Design and Coding StandardsProcess 04.02.01

Dependencies

SWCs

ModuleRequired Feature
None

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

MotVelPer1

Configuration REQUIREMeNTS

Build Time Config

ModulesNotes
None

Configuration Files to be provided by Integration Project

None

Da Vinci Parameter Configuration Changes

ParameterNotesSWC
None

DaVinci Interrupt Configuration Changes

ISR NameVIM #Priority DependencyNotes
None

Manual Configuration Changes

ConstantNotesSWC
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

Yes

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
MotVelInit1NoneRTE/Init
RunnableScheduling RequirementsTrigger
MotVelPer1NoneMotor Control ISR
MotVelPer2NoneRTE/2ms

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
MotCtrl_START_SEC_CODECode section for Motor Control scheduled functions

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

Usage

FeatureRAMROM
<Memmap usuage info>

Non RTE NvM Blocks

Block Name
None

RTE NvM Blocks

Block Name
none

Compiler Settings

Preprocessor MACRO

None.

Optimization Settings

None

Appendix

None

2 - MotVel_MDD

Module Design Document

For

‘MotVel’

VERSION: 1.0

DATE: 12-April-2016

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.DescriptionAuthorVersionDate
1Initial VersionRijvi Ahmed1.012-April-2016


Table of Contents

1 Abbrevations And Acronyms 4

2 References 5

3 High-Level Description 6

4 Design details of software module 7

4.1 Graphical representation 7

4.2 Data Flow Diagram 7

4.2.1 Module level DFD 7

4.2.2 Sub-Module level DFD 7

4.3 COMPONENT FLOW DIAGRAM 7

5 Variable Data Dictionary 8

5.1 User defined typedef definition/declaration 8

5.2 Variable definition for enumerated types 8

6 Constant Data Dictionary 9

6.1 Program(fixed) Constants 9

6.1.1 Embedded Constants 9

6.1.1.1 Local 9

6.1.2 Module specific Lookup Tables Constants 9

7 Software Module Implementation 10

7.1 Sub-Module Functions 10

7.1.1 Initialization Functions 10

7.1.2 PERIODIC FUNCTIONS 10

7.1.2.1 INIT: MotVelPER1 10

7.1.2.1.1 Design Rationale 10

7.1.2.1.2 Module Outputs 10

7.1.3 PERIODIC FUNCTIONS 10

7.1.3.1 INIT: MotVelPER2 10

7.1.3.1.1 Design Rationale 10

7.1.3.1.2 Module Outputs 10

7.1.4 Interrupt Functions 10

7.1.5 Server runnables 11

7.1.5.1.1 Store Local copy of outputs into Module Outputs 11

7.1.6 Local Function/Macro Definitions 11

7.1.7 GLObAL Function/Macro Definitions 11

7.1.8 Tranisition FUNCTIONS 11

8 Known Limitations With Design 12

9 UNIT TEST CONSIDERATION 13

10 Appendix 14

Abbrevations And Acronyms

AbbreviationDescription
DFDDesign functional diagram
MDDModule design Document
FDDFunctional Design Document

References

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

Sr. No.TitleVersion
1MDD GuidelinesProcess 04.02.01
2Software Naming ConventionsProcess 04.02.01
3Software Design and Coding standardsProcess 04.02.01
4FDD – SF40A_MotVel_DesignSee Synergy sub project version

High-Level Description

None

Design details of software module

Graphical representation

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

Typedef NameElement NameUser Defined Type

Legal Range

(min)

Legal Range

(max)

None

Variable definition for enumerated types

Enum NameElement NameValue
None

Constant Data Dictionary

Program(fixed) Constants

Embedded Constants

Local

Constant NameResolutionUnitsValue
Refer the m files

Global

Constant Name

Module specific Lookup Tables Constants

Constant NameResolutionValueSoftware Segment
None

Software Module Implementation

Sub-Module Functions

Initialization Functions

None

PERIODIC FUNCTIONS

INIT: MotVelPER1

Design Rationale

Refer the next version of the design.

Module Outputs

PERIODIC FUNCTIONS

INIT: MotVelPER2

Design Rationale

Refer the next version of the design.

Module Outputs

Interrupt Functions

None


Server runnables

None

Store Local copy of outputs into Module Outputs

None

Local Function/Macro Definitions

None

GLObAL Function/Macro Definitions

None

Tranisition FUNCTIONS

None

Known Limitations With Design

None.

UNIT TEST CONSIDERATION

None

Appendix

None

3 - MotVel_Peer Review Checklists


Overview

Summary Sheet
Synergy Project


Sheet 1: Summary Sheet
























Rev 1.28-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. SF40A_MotVel_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. 1.3.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. Selva Sengottaiyan
Work CR ID:


EA4#7611





























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



PolySpace










































Integration Manual



Davinci Files








































































Comments:

Not implementation change. Just Design subproject update in the implementation



























































































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:

Selva Sengottaiyan


Review Date :

09/23/16
































Lead Peer Reviewer:


Akilan


Approved by Reviewer(s):



Yes































Other Reviewer(s):









































































4 - requirements

FDDIDSourceFunctionLine(s)StatusComment
.SwFileName.SwFuncName.SwLines.SwStatus.SwComment
SF040A88CDD_MotVel.cMotVelPer2323-329I
SF040A111CDD_MotVel.cMotVelPer2241-313I
SF040A67CDD_MotVel.cMotVelPer2230I
SF040A68CDD_MotVel.cMotVelPer2227I
SF040A44CDD_MotVel.cMotVelPer2337I
SF040A45CDD_MotVel.cMotVelPer2339I
SF040A43CDD_MotVel.cMotVelPer2338I
SF040A40CDD_MotVel_MotCtrl.cMotVelPer162-78I
SF040A9CDD_MotVel_MotCtrl.cMotVelPer158-74I
SF040A77CDD_MotVel_MotCtrl.cMotVelPer165-81I
SF040A76CDD_MotVel_MotCtrl.cMotVelPer164-80I
SF040A75CDD_MotVel_MotCtrl.cMotVelPer163-79I
SF040A102CDD_MotVel.cMotVelPer2236-308I
SF040A90CDD_MotVel.cMotVelPer2324-330I
SF040A100CDD_MotVel_MotCtrl.cMotVelPer157-73I
SF040A101CDD_MotVel.cMotVelPer2202-341I
SF040A106CDD_MotVel.cMotVelPer2240-312I
SF040A104CDD_MotVel.cMotVelPer2238-310I
SF040A105CDD_MotVel.cMotVelPer2239-311I
SF040A11CDD_MotVel_MotCtrl.cMotVelPer160-76I
SF040A39CDD_MotVel_MotCtrl.cMotVelPer161-77I
SF040A38CDD_MotVel.cMotVelPer2228I
SF040A32CDD_MotVel_MotCtrl.cMotVelPer159-75I
SF040A37CDD_MotVel.cMotVelPer2229I
SF040A103CDD_MotVel.cMotVelPer2237-309I