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

Return to the regular view of this page.

Component Implementation

Component Implementation

Component Documentation

1 - SnsrOffLrng_MDD

Module Design Document

For

Sensor Offset Learning

Dec 7, 2016

Prepared By:

Shruthi Raghavan,

Nexteer Automotive,

Saginaw, MI, USA
Change History

VersionDescriptionAuthorDate
1Initial VersionSelva Sengottaiyan07-Feb-2016
2Updated as per FDD v 1.2.0Krishna Anne07-Mar-2016
3Updated graphical representationNick Saxton17-Aug-2016
4Updated design limitations for FDD v1.5.0Shruthi Raghavan7-Dec-2016


Table of Contents1 Introduction 6

2 SnsrOffsLrng & High-Level Description 7

3 Design details of software module 8

3.1 Graphical representation of SnsrOffsLrng 9

4 Constant Data Dictionary 11

4.1 Program (fixed) Constants 11

4.1.1 Embedded Constants 11

5 Software Component Implementation 12

5.1 Sub-Module Functions 12

5.1.1 Init: SnsrOffsLrngInit1 12

5.1.1.1 Design Rationale 12

5.1.1.2 Module Outputs 12

5.1.2 Per: SnsrOffsLrngPer1 12

5.1.2.1 Design Rationale 12

5.1.2.2 Store Module Inputs to Local copies 12

5.1.2.3 (Processing of function)……… 12

5.1.2.4 Store Local copy of outputs into Module Outputs 12

5.1.1 Per: SnsrOffsLrngPer2 12

5.1.1.1 Design Rationale 12

5.1.1.2 Store Module Inputs to Local copies 12

5.1.1.3 (Processing of function)……… 12

5.1.1.4 Store Local copy of outputs into Module Outputs 12

5.2 Server Runables 13

5.2.1 SnsrOffsLrng_RstHwTq 13

5.2.1.1 Design Rationale 13

5.2.1.2 Store Module Inputs to Local copies 13

5.2.1.3 (Processing of function)……… 13

5.2.1.4 Store Local copy of outputs into Module Outputs 13

5.2.2 SnsrOffsLrng_RstYawAndAg 13

5.2.2.1 Design Rationale 13

5.2.2.2 Store Module Inputs to Local copies 13

5.2.2.3 (Processing of function)……… 13

5.2.2.4 Store Local copy of outputs into Module Outputs 13

5.2.3 SnsrOffsLrng_SetHwAgOffs 13

5.2.3.1 Design Rationale 13

5.2.3.2 Store Module Inputs to Local copies 13

5.2.3.3 (Processing of function)……… 13

5.2.3.4 Store Local copy of outputs into Module Outputs 13

5.2.4 SnsrOffsLrng_GetHwAgOffs 14

5.2.4.1 Design Rationale 14

5.2.4.2 Store Module Inputs to Local copies 14

5.2.4.3 (Processing of function)……… 14

5.2.4.4 Store Local copy of outputs into Module Outputs 14

5.2.5 SnsrOffsLrng_SetHwTqOffs 14

5.2.5.1 Design Rationale 14

5.2.5.2 Store Module Inputs to Local copies 14

5.2.5.3 (Processing of function)……… 14

5.2.5.4 Store Local copy of outputs into Module Outputs 14

5.2.6 SnsrOffsLrng_GetHwTqOffs 14

5.2.6.1 Design Rationale 14

5.2.6.2 Store Module Inputs to Local copies 14

5.2.6.3 (Processing of function)……… 14

5.2.6.4 Store Local copy of outputs into Module Outputs 14

5.2.7 SnsrOffsLrng_SetYawRateOffs 15

5.2.7.1 Design Rationale 15

5.2.7.2 Store Module Inputs to Local copies 15

5.2.7.3 (Processing of function)……… 15

5.2.7.4 Store Local copy of outputs into Module Outputs 15

5.2.8 SnsrOffsLrng_GetYawRateOffs 15

5.2.8.1 Design Rationale 15

5.2.8.2 Store Module Inputs to Local copies 15

5.2.8.3 (Processing of function)……… 15

5.2.8.4 Store Local copy of outputs into Module Outputs 15

5.3 Module Internal (Local) Functions 15

5.3.1 Module Internal (Local) Functions 15

6 Known Limitations with Design 19

7 UNIT TEST CONSIDERATION 20

Appendix A Abbreviations and Acronyms 21

Appendix B Glossary 22

Appendix C References 23

Introduction

Refer the Design Subproject.

SnsrOffsLrng & High-Level Description

Refer the Design Subproject.

Design details of software module

Graphical representation of SnsrOffsLrng

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant NameResolutionUnitsValue
HWTQOFFSHILIM_HWNWTMTR_F32Single precision floatHwNwtMtr4
HWTQOFFSLOLIM_HWNWTMTR_F32Single precision floatHwNwtMtr-4
VEHYAWRATEOFFSHILIM_VEHDEGPERSEC_F32Single precision floatVehDegPerSec20
VEHYAWRATEOFFSLOLIM_VEHDEGPERSEC_F32Single precision floatVehDegPerSec-20
HWAGOFFSHILIM_HWDEG_F32Single precision floatHwDeg-30
HWAGOFFSLOLIM_HWDEG_F32Single precision floatHwDeg-30
MTRXSIZE_CNT_U081Cnt3

Software Component Implementation

Sub-Module Functions

Init: SnsrOffsLrngInit1

Design Rationale

Refer the Design.

Module Outputs

Refer the Design.

Per: SnsrOffsLrngPer1

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

Per: SnsrOffsLrngPer2

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

Server Runables

SnsrOffsLrng_RstHwTq

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

SnsrOffsLrng_RstYawAndAg

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

SnsrOffsLrng_SetHwAgOffs

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

SnsrOffsLrng_GetHwAgOffs

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

SnsrOffsLrng_SetHwTqOffs

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

SnsrOffsLrng_GetHwTqOffs

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

SnsrOffsLrng_SetYawRateOffs

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

SnsrOffsLrng_GetYawRateOffs

Design Rationale

Refer the Design.

Store Module Inputs to Local copies

Refer the Design.

(Processing of function)………

Refer the Design.

Store Local copy of outputs into Module Outputs

Refer the Design.

Module Internal (Local) Functions

Module Internal (Local) Functions

Calculate LearnHwAg
Function NameLearnHwAgTypeMinMaxUTP Tol.
Arguments PassedHwAgLrngLrngCdnVld_Cnt_T_loglBooleanFALSETRUE
HwAgLrngEna_Cnt_T_loglBooleanFALSETRUE
SysTqFild_HwNm_T_f32float32-8.88.8
HandwheelPosition_HwDeg_T_f32float32-14401440
Return ValueNone

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Calculate SOaCHierarchyManager
Function NameSOaCHierarchyManagerTypeMinMaxUTP Tol.
Arguments Passed*EnableYOC_Cnt_T_loglBooleanFALSETRUE
*HwAgLrngEna_Cnt_T_loglBooleanFALSETRUE
*HwAgLrngRst_Cnt_T_loglBooleanFALSETRUE
Return Value

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Calculate Perform_TqInpDetn
Function NamePerform_TqInpDetnTypeMinMaxUTP Tol.
Arguments PassedNone
Return Value

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Calculate EnableLearning
Function NameEnableLearningTypeMinMaxUTP Tol.
Arguments Passed
Return ValueHwTqLrngEna_Cnt_T_loglBooleanFALSETRUE

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Calculate CalculateKVector
Function Name
CalculateKVector
TypeMinMaxUTP Tol.
Arguments PassedTqMdlXAry_HwRadpS_T_f32[3]float32-4242
KVect_Uls_T_f32[3]float32-4242
Return Value

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Calculate EnablePreProcessing
Function NameEnablePreProcessingTypeMinMaxUTP Tol.
Arguments PassedHwTqPreproc_dB_T_f32float32-10030
SampleCntrLim_Cnt_T_u16Uint16165535
TqInpPrsntVld_Cnt_T_loglBooleanFALSETRUE
TqInpPrsnt_Cnt_T_loglBooleanFALSETRUE
Return Value

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Calculate UpdateCovarianceMatrix
Function NameUpdateCovarianceMatrixTypeMinMaxUTP Tol.
Arguments PassedTqMdlXAry_HwRadpS_T_f32[3]float32-4242
KVect_Uls_T_f32[3]float32-4242
Return Value

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

TblSize_Cnt_T_u16 is size of the single dimension of TqMdlAryKVect_Uls_T_f32.

Calculate UpdateHwTqOffs
Function NameUpdateHwTqOffsTypeMinMaxUTP Tol.
Arguments PassedHwTqEstimnVld_Cnt_T_loglbooleanFALSETRUE
HwTqDriftEstimnOnCentr_HwNm_T_f32float32-1010
Return ValueNone

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Calculate UpdateSampleCnt
Function NameUpdateSampleCntTypeMinMaxUTP Tol.
Arguments PassedHwAgMeasd_HwDeg_T_f32float32-14401440
Return ValueNone

Description

No flowchart added. For Unit test FDD should provide the information needed regarding function processing

Known Limitations with Design

The display variable dSnsrOffsLrngSysTqFild and PIM SysTqCdngFil structure have wrong ranges defined in the datadict.m file. The actual range according to developer is [-366, 366]. However, since the given range is larger and includes the correct range and because these variables are not affecting the downstream operations in a way that will fail the PIL, this is not changed in the interest of time (changing this would mean rerunning the robustness test and there wasn’t enough time for that before release).

The name of the NVM structure type SnsrLrndOffsRec2 is changed without any change to the name or datatype of the corresponding elements. The only difference between SnsrLrndOffsRec1 and SnsrLrndOffsRec2 is the ranges of the elements within the structure.

Since this is not the agreed process for EA4, the implementation deviates from FDD and uses the original structure in order to avoid a change to StdDef to only add a redundant datatype. For the next FDD revision we need to make a decision on whether to go back to SnsrLrndOffsRec1 in the FDD or change the StdDef and add SnsrLrndOffsRec2 type in it. Either way, once the new tool is officially rolled out for use, such deviations of type will be caught in the Polyspace as an error (necessitating manual fixes to work around such issues).

UNIT TEST CONSIDERATION

The display variable dSnsrOffsLrngSysTqFild and PIM SysTqCdngFil structure have wrong ranges defined in the datadict.m file. The actual range according to developer is [-366, 366]. However, since the given range is larger and includes the correct range and because these variables are not affecting the downstream operations in a way that will fail the PIL, this is not changed in the interest of time (changing this would mean rerunning the robustness test and there wasn’t enough time for that before release).

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.1
5SF051A_SnsrOffsLrng_DesignSee the synergy sub-project version included.

2 - SnsrOffLrng_ReviewChecklists

Overview

Summary Sheet
Synergy Project
Davinci Files
Source Code
MDD
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. SF051A_SnsrOffsLrng_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. Shruthi Raghavan
Work CR ID:


EA4#7859





























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:































YesMDD


YesSource Code


YesPolySpace









































N/AIntegration Manual


YesDavinci Files








































































Comments:

Only reviewed 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:

Shruthi Raghavan


Review Date :

12/08/16
































Lead Peer Reviewer:


Avinash James


Approved by Reviewer(s):



Yes































Other Reviewer(s):


Krishna Anne
Daniel Rabadan



































































Sheet 3: Davinci Files






















Rev 1.28-Jun-15
Peer Review Meeting Log (Davinci Review)


























Quality Check Items:




































Rationale is required for all answers of No










Only StdDef Port types are used








N/A
Comments:










































For components not using application data types, do all








N/A
Comments:



port interface names end in PortIf and a sequence number





























































Non-program-specific components saved








N/A
Comments:




in Autosar 4.0.3 format




































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








N/A
Comments:




change correctly




































*Cfg.h.TT: Verfied Davinci Configurator generates








N/A
Comments:










the configuration header(s) file correctly
kzshz2: Either a generic sandbox or a baselined integration project can be used to verify



























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
















All changed files have been compared against previous








Yes
Comments:




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.


































Automated validation check is performed








Yes
Comments:

























































Naming conventions followed. All names should








N/A
Comments:










match DataDict.m













































Sender/Receiver port properties match DataDict.m








N/A
Comments:










file (use .m file helper tool)













































Calibration port properties match DataDict.m








Yes
Comments:










file (use .m file helper tool)













































Components using application data types:























Sender/Receiver port initialization values match







N/A
Comments:










DataDict.m file














































Calibration port initialization values match







N/A
Comments:










DataDict.m file













































Components not using application data types:























Sender/Receiver port initialization values match







N/A
Comments:










DataDict.m file and have been converted to counts






















for fixed point types














































Calibration port initialization values match







Yes
Comments:










DataDict.m file and have been converted to counts






















for fixed point types














































Mapping set and all unused items have been







Yes
Comments:










removed













































All sender/receiver port read/writes using direct








N/A
Comments:










read/writes(List justification if not)













































Runnable calling frequencies match FDD








N/A
Comments:

































DataDict.m display variables: created as








N/A
Comments:









PerInstanceMemory. Matches the FDD





































Component is correct component type








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

Shruthi Raghavan
Review Date :

12/08/16
Component Type :


Application



























Lead Peer Reviewer:


Avinash James
Approved by Reviewer(s):



Yes

































Other Reviewer(s):


Krishna Anne





































































Sheet 4: Source Code






















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

























Source File Name:


SnsrOffsLrng.c

Source File Revision:


6
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:

SnsrOffsLrng_MDD.docx

Revision:
4

























FDD/SCIR/DSR/FDR/CM Name:




SF051A_SnsrOffsLrng_Design

Revision:
1.5.0


























Quality Check Items:



































Rationale is required for all answers of No









Working EA4 Software Naming Convention followed:















































for variable names







Yes
Comments:

















































for constant names







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











Removed Requirement Tags and requirements.csv
























All variables are declared at the function level.








Yes
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








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







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







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,







Yes
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:
















































FDD has pending changes needed that are noted in the MDD































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:

Shruthi Raghavan


Review Date :

12/08/16
































Lead Peer Reviewer:


Avinash James


Approved by Reviewer(s):



Yes































Other Reviewer(s):


Krishna Anne
Daniel Rabadan



































































Sheet 5: MDD






















Rev 1.28-Jun-15
Peer Review Meeting Log (MDD Review)


























MDD Name:

SnsrOffsLrng_MDD.docx













MDD Revision:

4


























Source File Name:


SnsrOffsLrng.c











Source File Revision:


6

Source File Name:















Source File Revision:





Source File Name:















Source File Revision:






























Quality Check Items:




































Rationale is required for all answers of No










Synergy version matches document








Yes
Comments:













































Change log contains detailed description of changes








Yes
Comments:













































Changes Highlighted (for Unit Tester)








Yes
Comments:













































Diagrams have been included per MDD Guideline








N/A
Comments:











and reviewed






































All Design Exceptions and Limitations are listed








N/A
Comments:



















































Design rationale given for all global








N/A
Comments:











data not communicated through RTE ports, per














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















































All implementation details that differ from the FDD are








Yes
Comments:











noted and explained in Design Rationale










See known limitations with design section


























All Unit Test Considerations have been described








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:

Shruthi Raghavan


Review Date :

12/08/16
































Lead Peer Reviewer:


Avinash James


Approved by Reviewer(s):



Yes































Other Reviewer(s):


Krishna Anne
Daniel Rabadan



































































Sheet 6: PolySpace






















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


























Source File Name:


SnsrOffsLrng.cSource File Revision:


6

Source File Name:















Source File Revision:





Source File Name:















Source File Revision:






























EA4 Static Analysis Compliance Guideline version:







DRAFT-01.02.00







Poly Space version:


Windows User: eg. 2013b 2013b
Polyspace sub project version:




Windows User: eg. TL108a_PolyspaceSuprt_1.0.0 N/A

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








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










Cyc complexity=11, St.Pth Cnt=103 (QAC)


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:

Shruthi Raghavan


Review Date :

12/08/16
































Lead Peer Reviewer:


Avinash James


Approved by Reviewer(s):



Yes































Other Reviewer(s):


Krishna Anne
Daniel Rabadan



































































3 - SnsrOffsLrng_IntegrationManual

Integration Manual

For

SnsrOffsLrng

VERSION: 1

DATE: 07-Mar-2016

Prepared By:

Krishna Anne

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.007-Feb-2016
2Updated as per FDD v 1.2.0Krishna Anne2.007-Mar-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 – SF51_SnsrOffsLrng_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

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

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

No

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
SnsrOffsLrngInit1NoneRte
RunnableScheduling RequirementsTrigger
SnsrOffsLrngPer1NoneRTE(2ms)
SnsrOffsLrngPer2NoneRTE(10ms)
RstHwTq
NoneOn server invocation call
RstYawAndAg
NoneOn server invocation call
SetHwAgOffs
NoneOn server invocation call
SetHwTqOffs
NoneOn server invocation call
SetYawRateOffs
NoneOn server invocation call
GetHwAgOffs
NoneOn server invocation call
GetHwTqOffs
NoneOn server invocation call
GetYawRateOffs
NoneOn 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
SnsrOffsLrnd

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None