1 - MotRplCoggCmd_IntegrationManual

Integration Manual

For

MotRplCoggCmd

VERSION: 1

DATE: 09-Feb-2016

Prepared By:

Selva Sengottaiyan

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 versionS. Sengottaiyan1.009-Feb-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 Dependencies 7

4.1 SWCs 7

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

5 Configuration REQUIREMeNTS 8

5.1 Build Time Config 8

5.2 Configuration Files to be provided by Integration Project 8

5.3 Da Vinci Parameter Configuration Changes 8

5.4 DaVinci Interrupt Configuration Changes 8

5.5 Manual Configuration Changes 8

6 Integration DATAFLOW REQUIREMENTS 9

6.1 Required Global Data Inputs 9

6.2 Required Global Data Outputs 9

6.3 Specific Include Path present 9

7 Runnable Scheduling 10

8 Memory Map REQUIREMENTS 11

8.1 Mapping 11

8.2 Usage 11

8.3 RTE NvM Blocks 11

9 Compiler Settings 12

9.1 Preprocessor MACRO 12

9.2 Optimization Settings 12

10 Appendix 13

Abbrevations And Acronyms

AbbreviationDescription
DFDDesign functional diagram
MDDModule 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.TitleVersion
1FDD – SF107_MotRplCoggCmd_ImplSee Synergy subproject version
2Software Naming ConventionsProcess 04.02.01
3Software Coding StandardsProcess 04.02.01

Dependencies

SWCs

ModuleRequired 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

None

Dependencies

SWCs

ModuleRequired 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

None

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

Required Global Data Outputs

Refer .m file

Specific Include Path present

Yes

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
MotRplCoggCmdInit1NoneRte
RunnableScheduling RequirementsTrigger
MotRplCoggCmdPer1Schedule before current regulatorMotorControl *2
SetMotCoggCmdPrm_OperNoneOn server invocation call
GetMotCoggCmdPrm_OperNoneOn server invocation call

.

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes

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

Usage

FeatureRAMROM
None

Table 1: ARM Cortex R4 Memory Usage

RTE NvM Blocks

Block Name
MotCoggCmdY

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

2 - MotRplCoggCmd_MDD

Module Design Document

For

MotRplCoggCmd

Feb 9, 2016

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Selva Sengottaiyan

Nexteer Automotive,

Saginaw, MI, USA
Change History

VersionDescriptionAuthorDate
1Initial VersionSelva Sengottaiyan09-Feb-2016


Table of Contents

1 Introduction 5

2 MotRplCoggCmd & High-Level Description 6

3 Design details of software module 7

3.1 Graphical representation of MotRplCoggCmd 7

3.2 Data Flow Diagram 7

3.2.1 Component level DFD 7

3.2.2 Function level DFD 7

4 Constant Data Dictionary 8

4.1 Program (fixed) Constants 8

4.1.1 Embedded Constants 8

5 Software Component Implementation 9

5.1 Sub-Module Functions 9

5.1.1 Init: MotRplCoggCmdInit1 9

5.1.1.1 Design Rationale 9

5.1.1.2 Module Outputs 9

5.1.2 Per: MotRplCoggCmdPer1 9

5.1.2.1 Design Rationale 9

5.1.2.2 Store Module Inputs to Local copies 9

5.1.2.3 (Processing of function)……… 9

5.1.2.4 Store Local copy of outputs into Module Outputs 9

5.2 Server Runables 9

5.2.1 GetMotCoggCmdPrm_Oper 9

5.2.1.1 Design Rationale 9

5.2.1.2 Store Module Inputs to Local copies 10

5.2.1.3 (Processing of function)……… 10

5.2.1.4 Store Local copy of outputs into Module Outputs 10

5.2.1 SetMotCoggCmdPrm_Oper 10

5.2.1.1 Design Rationale 10

5.2.1.2 Store Module Inputs to Local copies 10

5.2.1.3 (Processing of function)……… 10

5.2.1.4 Store Local copy of outputs into Module Outputs 10

5.3 Module Internal (Local) Functions 10

5.3.1 Local Function #1 10

5.3.1.1 Design Rationale 10

5.3.1.2 Processing 10

6 Known Limitations with Design 11

7 UNIT TEST CONSIDERATION 12

Appendix A Abbreviations and Acronyms 13

Appendix B Glossary 14

Appendix C References 15

Introduction

Refer the Design Subproject.

MotRplCoggCmd & High-Level Description

Refer the Design Subproject.

Design details of software module

Graphical representation of MotRplCoggCmd

Refer the Design Subproject.

Data Flow Diagram

Component level DFD

Function level DFD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant NameResolutionUnitsValue
Refer the Design Subproject.Refer the Design Subproject.Refer the Design Subproject.Refer the Design Subproject.

Software Component Implementation

<The detailed design of the function is provided in the FDD. The detail design shall only be added to the MDD when it is not provided in the FDD or the FDD is not adequate and clarification is needed.>

Sub-Module Functions

The sub-module functions are grouped based on similar functionality that needs to be executed in a given “State” of the system (refer States and Modes). For a given module, the MDD will identify the type and number of sub-modules required. The sub-module types are described below.

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

Init: MotRplCoggCmdInit1

Design Rationale

Refer the Design Subproject

Module Outputs

Refer the Design Subproject

Per: MotRplCoggCmdPer1

Design Rationale

Refer the Design Subproject

Store Module Inputs to Local copies

Refer the Design Subproject

(Processing of function)………

Refer the Design Subproject

Store Local copy of outputs into Module Outputs

Refer the Design Subproject

Server Runables

GetMotCoggCmdPrm_Oper

Design Rationale

Refer the Design Subproject

Store Module Inputs to Local copies

Refer the Design Subproject

(Processing of function)………

Refer the Design Subproject

Store Local copy of outputs into Module Outputs

Refer the Design Subproject

SetMotCoggCmdPrm_Oper

Design Rationale

Refer the Design Subproject

Store Module Inputs to Local copies

Refer the Design Subproject

(Processing of function)………

Refer the Design Subproject

Store Local copy of outputs into Module Outputs

Refer the Design Subproject

Module Internal (Local) Functions

Local Function #1

Function NameSinLookupTypeMinMax
Arguments PassedTheta_Rad_T_f32Float3202*PI
Return ValueResult_Uls_T_f32Float3201

Design Rationale

Processing

Refer the design

Known Limitations with Design

None

UNIT TEST CONSIDERATION

None

Abbreviations and Acronyms

Abbreviation or AcronymDescription

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

TermDefinitionSource
MDDModule Design Document
DFDData Flow Diagram

References

Ref. #TitleVersion
1AUTOSAR Specification of Memory Mapping (Link:AUTOSAR_SWS_MemoryMapping.pdf)v1.3.0 R4.0 Rev 2
2MDD GuidelineEA4 01.00.01
3Software Naming Conventions.doc1.0
4Software Design and Coding Standards.doc2.0

3 - MotRplCoggCmd_ReviewChecklists


Overview

Summary Sheet
Synergy Project
Source Code
PolySpace


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. SF107A_MotRplCoggCmd_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. SF107A_MotRplCoggCmd_Impl_1.2.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. Krishna Anne
Work CR ID:


EA4#5727





























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


YesSource Code


YesPolySpace









































Integration Manual


Davinci Files








































































Comments:

Reviewed only changes.



























































































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:

Krishna Anne


Review Date :

05/12/16
































Lead Peer Reviewer:


Nick Saxton


Approved by Reviewer(s):



Yes































Other Reviewer(s):










































































Sheet 3: Source Code






















Rev 1.28-Jun-15
Peer Review Meeting Log (Source Code Review)

























Source File Name:


CDD_MotRplCoggCmd_MotCtrl.c

Source File Revision:


3
Header File Name:


CDD_MotRplCoggCmd_MotCtrl_MemMap.h

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




CDD_MotRplCoggCmd.h






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
MDD Name:

MotRplCoggCmd_MDD

Revision:
1

























FDD/SCIR/DSR/FDR/CM Name:




SF107AMotRplCoggCmd_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







Yes
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








Yes
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








Yes
Comments:
























All other includes are actually needed. (System includes








Yes
Comments:









only allowed in Nexteer library components)





































Software Design and Coding Standards followed:











Version: 2.1

























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







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







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







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

















































































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:

Krishna Anne


Review Date :

05/12/16
































Lead Peer Reviewer:


Nick Saxton


Approved by Reviewer(s):



Yes































Other Reviewer(s):










































































Sheet 4: PolySpace






















Rev 1.28-Jun-15
Peer Review Meeting Log (QAC/PolySpace Review)


























Source File Name:


CDD_MotRplCoggCmd.c











Source File Revision:


1

Source File Name:


CDD_MotRplCoggCmd_MotCtrl











Source File Revision:


3

Source File Name:















Source File Revision:






























EA4 Static Analysis Compliance Guideline version:







01.01.00














Poly Space version:


Windows User: eg. 2013b 2013b





Polyspace sub project version:




Windows User: eg. TL108a_PolyspaceSuprt_1.0.0 TL108A_PolyspaceSuprt_1.0.0






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 TL100A_QACSuprt_1.2.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 AnalysisYes
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:



























































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:

Krishna Anne


Review Date :

05/12/16
































Lead Peer Reviewer:


Nick Saxton


Approved by Reviewer(s):



Yes































Other Reviewer(s):









































































4 - requirements

FDDIDSourceFunctionLine(s)StatusComment
.SwFileName.SwFuncName.SwLines.SwStatus.SwComment
SF107A28CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1158I
SF107A61CDD_MotRplCoggCmd.cMotRplCoggCmdInit1208-221I
SF107A27CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1107I
SF107A48CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1131,135I
SF107A46CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1104I
SF107A47CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1176I
SF107A44CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1113I
SF107A45CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1106I
SF107A42CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1112I
SF107A43CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1105I
SF107A40CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1110I
SF107A41CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1111I
SF107A39CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1108I
SF107A38CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1109I
SF107A59CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1156I
SF107A33CDD_MotRplCoggCmd.cGetMotCoggCmdPrm_Oper167I
SF107A32CDD_MotRplCoggCmd.cSetMotCoggCmdPrm_Oper271I
SF107A57CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1161-171I
SF107A56CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1148I
SF107A51CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1124-127I
SF107A50CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1131,135,143I
SF107A53CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1161-171I
SF107A55CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1161-171I
SF107A54CDD_MotRplCoggCmd_MotCtrl.cMotRplCoggCmdPer1161-171I