1 - HwTqCorrln_DesignReview


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. ES229A_HwTqCorrln_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. ES229A_HwTqCorrln_Impl_3.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#8003





























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:































N/AMDD


YesSource Code


YesPolySpace









































N/AIntegration Manual


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

10/13/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:


HwTqCorrln.c

Source File Revision:


8
Header File Name:





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.

























MDD Name:

HwTqCorrln_MDD

Revision:
4

























FDD/SCIR/DSR/FDR/CM Name:




ES229A_HwTqCorrln_Design

Revision:
3.2.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








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





































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








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







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







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







Yes
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







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 :

09/15/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:


HwTqCorrlnSource File Revision:


8

Source File Name:















Source File Revision:





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 Unreleased

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:























21.1 has been ignored in the interest ot match the design from the previous instances of implementation


































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 :

10/13/16
































Lead Peer Reviewer:


Nick Saxton


Approved by Reviewer(s):



Yes































Other Reviewer(s):









































































2 - HwTqCorrln_IntegrationManual

Integration Manual

For

HwTqCorrln

VERSION: 2.0

DATE: 07-Oct-2015

Prepared By:

Nick Saxton,

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 versionSB1.004-Aug-2015
2Added fault injection in build time configNS2.007-Oct-2015

Table of Contents

1 Abbrevations And Acronyms 5

2 References 6

3 Dependencies 7

3.1 SWCs 7

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

4 Configuration REQUIREMeNTS 8

4.1 Build Time Config 8

4.2 Configuration Files to be provided by Integration Project 8

4.3 Da Vinci Parameter Configuration Changes 8

4.4 DaVinci Interrupt Configuration Changes 8

4.5 Manual Configuration Changes 8

5 Integration DATAFLOW REQUIREMENTS 9

5.1 Required Global Data Inputs 9

5.2 Required Global Data Outputs 9

5.3 Specific Include Path present 9

6 Runnable Scheduling 10

7 Memory Map REQUIREMENTS 11

7.1 Mapping 11

7.2 Usage 11

7.3 NvM Blocks 11

8 Compiler Settings 12

8.1 Preprocessor MACRO 12

8.2 Optimization Settings 12

9 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
<1><MDD Guidelines>Process 04.02.00
<2><Software Naming Conventions>Process 04.02.00
<3><Coding standards>Process 04.02.00
<4>FDD – ES229A_HwCorrln_DesignSee Synergy Subproject version

Dependencies

SWCs

ModuleRequired Feature
None

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

None

Configuration REQUIREMeNTS

Build Time Config

ModulesNotes
FLTINJENASet to STD_ON for Fault Injection

Configuration Files to be provided by Integration Project

Include NxtrFil.h in Rte_UserTypes.h header file

Da Vinci Parameter Configuration Changes

ParameterNotesSWC
N/A

DaVinci Interrupt Configuration Changes

ISR NameVIM #Priority DependencyNotes
N/A

Manual Configuration Changes

ConstantNotesSWC
N/A

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Refer DataDict.m file

Required Global Data Outputs

Refer DataDict.m file

Specific Include Path present

No

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
HwTqCorrlnInit1RTE_Init
RunnableScheduling RequirementsTrigger
HwTqCorrlnPer1NoneRTE(2ms)
HwTqCorrlnPer2NoneRTE(4ms)
HwTqCorrlnPer3NoneRTE(100ms)

.

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
None

* 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

NvM Blocks

Refer .m file

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

3 - HwTqCorrln_MDD

Module Design Document

For

HwTqCorrln

April 14, 2016

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Nick Saxton,

Nexteer Automotive,

Saginaw, MI, USA
Change History

DescriptionAuthorVersionDate
Initial VersionSB1.004-Aug-2015
Updated to FDD v2.1.0NS2.007-Oct-2015
Anomaly EA4#1980 fixedNS3.020-Oct-2015
Updated to FDD v3.0.0SV4.014-Apr-2016


Table of Contents

1 HwTqCorrln & High-Level Description 4

2 Design details of software module 5

2.1 Graphical representation of HwTqCorrln 5

2.2 Data Flow Diagram 6

2.2.1 Component level DFD 6

2.2.2 Function level DFD 6

3 Constant Data Dictionary 7

3.1 Program (fixed) Constants 7

3.1.1 Embedded Constants 7

4 Software Component Implementation 8

4.1 Sub-Module Functions 8

4.1.1 Init: HwTqCorrlnInit1 8

4.1.2 Per: HwTqCorrlnPer1 8

4.1.3 Per: HwTqCorrlnPer2 8

4.1.4 Per: HwTqCorrlnPer3 8

4.2 Server Runables 8

4.3 Interrupt Functions 8

4.4 Module Internal (Local) Functions 8

4.4.1 Local Function #1 8

4.4.1.1 Design Rationale 8

4.4.1.2 Processing 8

4.4.2 Local Function #2 9

4.4.2.1 Design Rationale 9

4.4.2.2 Processing 9

4.5 GLOBAL Function/Macro Definitions 9

5 Known Limitations with Design 10

6 UNIT TEST CONSIDERATION 11

Appendix A Abbreviations and Acronyms 12

Appendix B Glossary 13

Appendix C References 14

HwTqCorrln & High-Level Description

Refer FDD

Design details of software module

Refer FDD

Graphical representation of HwTqCorrln

Data Flow Diagram

Refer FDD

Component level DFD

Refer FDD

Function level DFD

Refer FDD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant NameResolutionUnitsValue
Refer .m file
HWTQCORRLNSTSSIGA_CNT_U081Cnt0x01
HWTQCORRLNSTSSIGB_CNT_U081Cnt0x02
HWTQCORRLNSTSSIGC_CNT_U081Cnt0x04
HWTQCORRLNSTSSIGD_CNT_U081Cnt0x08
MAXSTALL_CNT_U081Cnt255
HWTQIDPTSIGALL_CNT_U081Cnt4
HWTQIDPTSIGHALF_CNT_U081Cnt2
HWTQIDPTSIGNZERO_CNT_U081Cnt0
HWTQCHCORRLNTRAERRMAXLMT_ HWNWTMTR_F321HWNWTMTR10.0
HWTQCHCORRLNTRAERRMINLMT_ HWNWTMTR_F321HWNWTMTR-10.0

Software Component Implementation

Refer FDD

Sub-Module Functions

Init: HwTqCorrlnInit1

Refer FDD

Per: HwTqCorrlnPer1

Refer FDD

Per: HwTqCorrlnPer2

Refer FDD

Per: HwTqCorrlnPer3

Refer FDD

Server Runables

None

Interrupt Functions

None

Module Internal (Local) Functions

Local Function #1

Function NameCorrlnSigAvlChkTypeMinMax
Arguments PassedSigRollgCnt_Cnt_T_u08uint80255
SigQlfr_Cnt_T_enumSigQlfr1SIGQLFR_NORESSIGQLFR_FAILD
MaxStallCnt_Cnt_T_u08Uint80255
* LstRollgCnt_Cnt_T_u08uint80255
* StallCnt_Cnt_T_u08uint80255
Return ValueSigAvl_Cnt_T_lgcbooleanFALSETRUE

Design Rationale

None

Processing

Refer FDD CorrSigAvlChkRev1 State flow Chart

Local Function #2

Function NameImdtCorrlnChkTypeMinMax
Arguments PassedSig1Avl_Cnt_T_lgcBooelanFALSETRUE
Sig2Avl_Cnt_T_lgcBooleanFALSETRUE
HwTq1_HwNwtMtr_T_f32Float32-10.010.0
HwTq2_HwNwtMtr_T_f32Float32-10.010.0
ImdtCorrlnChkFailThd_HwNwtMtr_T_f32Float320.020.0
ImdtCorrlnChkPassThd_HwNwtMtr_T_f32Float320.020.0
NtcNr_T_enumEnum1511
*CorrlnSigAPass_Cnt_T_lgcBooleanFALSETRUE
*CorrlnSigBPass_Cnt_T_lgcBooleanFALSETRUE
*ImdtCorrlnChk_Cnt_T_lgcBooleanFALSETRUE
Return ValueChAImdtCorrlnChk_Cnt_T_lgcbooleanFALSETRUE

Design Rationale

None

Processing

Refer FDD ImdtCorrlnChk block

GLOBAL Function/Macro Definitions

None

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 GuidelineProcess 04.02.00
3Software Naming Conventions.docProcess 04.02.00
4Software Design and Coding Standards.docProcess 04.02.00
5FDD – ES229A_HwTqCorrln_DesignSee Synergy SubProject version

4 - requirements

FDDIDSourceFunctionLine(s)StatusComment
.SwFileName.SwFuncName.SwLines.SwStatus.SwComment
ES229A150HwTqCorrln.cHwTqCorrlnPer1927I
ES229A153HwTqCorrln.cHwTqCorrlnPer1943-960I
ES229A155HwTqCorrln.cHwTqCorrlnPer31275I
ES229A154HwTqCorrln.cHwTqCorrlnPer1943-960I
ES229A134HwTqCorrln.cHwTqCorrlnPer31275I
ES229A159HwTqCorrln.cHwTqCorrlnPer21168I
ES229A158HwTqCorrln.cHwTqCorrlnInit1796I
ES229A70HwTqCorrln.cHwTqCorrlnPer1907I
ES229A133HwTqCorrln.cHwTqCorrlnPer31275I
ES229A114HwTqCorrln.cHwTqCorrlnPer1937I
ES229A117HwTqCorrln.cHwTqCorrlnPer21071I
ES229A116HwTqCorrln.cHwTqCorrlnPer21067I
ES229A65HwTqCorrln.cHwTqCorrlnPer1900I
ES229A66HwTqCorrln.cHwTqCorrlnPer1902I
ES229A67HwTqCorrln.cHwTqCorrlnPer1903I
ES229A68HwTqCorrln.cHwTqCorrlnPer1904I
ES229A69HwTqCorrln.cHwTqCorrlnPer1906I
ES229A118HwTqCorrln.cHwTqCorrlnInit1,HwTqCorrlnPer3801,1246,1248,1270I
ES229A165HwTqCorrln.cHwTqCorrlnPer21178I
ES229A123HwTqCorrln.cHwTqCorrlnPer31253I
ES229A27HwTqCorrln.cHwTqCorrlnPer21084I
ES229A48HwTqCorrln.cHwTqCorrlnPer1,HwTqCorrlnPer2,HwTqCorrlnPer3898,1061,1062,1063,1064,1242,1243I
ES229A49HwTqCorrln.cHwTqCorrlnPer1899I
ES229A95HwTqCorrln.cHwTqCorrlnPer21126I
ES229A167HwTqCorrln.cHwTqCorrlnPer21179I
ES229A166HwTqCorrln.cHwTqCorrlnPer21182I
ES229A124HwTqCorrln.cHwTqCorrlnPer31253I
ES229A147HwTqCorrln.cHwTqCorrlnPer1915I
ES229A144HwTqCorrln.cHwTqCorrlnPer21172I
ES229A143HwTqCorrln.cHwTqCorrlnPer31253I
ES229A109HwTqCorrln.cHwTqCorrlnPer31280,1285,1288I
ES229A148HwTqCorrln.cHwTqCorrlnPer1919I
ES229A149HwTqCorrln.cHwTqCorrlnPer1923I
ES229A77HwTqCorrln.cHwTqCorrlnPer21149-1167I
ES229A98HwTqCorrln.cHwTqCorrlnPer21126I
ES229A108HwTqCorrln.cHwTqCorrlnPer31258,1263,1265I
ES229A74HwTqCorrln.cHwTqCorrlnPer1912I
ES229A73HwTqCorrln.cHwTqCorrlnPer1911I
ES229A72HwTqCorrln.cHwTqCorrlnPer1910I
ES229A71HwTqCorrln.cHwTqCorrlnPer1908I
ES229A127HwTqCorrln.cHwTqCorrlnInit1791I
ES229A102HwTqCorrln.cHwTqCorrlnPer21149-1167I
ES229A90HwTqCorrln.cHwTqCorrlnPer21126I
ES229A100HwTqCorrln.cHwTqCorrlnPer21149-1167I
ES229A101HwTqCorrln.cHwTqCorrlnPer21149-1167I
ES229A160HwTqCorrln.cHwTqCorrlnPer1962I
ES229A105HwTqCorrln.cHwTqCorrlnPer1931I
ES229A22HwTqCorrln.cHwTqCorrlnPer21084I
ES229A132HwTqCorrln.cHwTqCorrlnInit1,HwTqCorrlnPer3803,1268I
ES229A135HwTqCorrln.cHwTqCorrlnPer21121I
ES229A30HwTqCorrln.cHwTqCorrlnPer21084I
ES229A51HwTqCorrln.cHwTqCorrlnPer1965I
ES229A131HwTqCorrln.cHwTqCorrlnPer21111I
ES229A130HwTqCorrln.cHwTqCorrlnPer21105I
ES229A168HwTqCorrln.cHwTqCorrlnPer21183I
ES229A125HwTqCorrln.cHwTqCorrlnPer21081I