This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - HwAg1Meas_IntegrationManual
Integration Manual
For
HwAg1Meas
VERSION: 6.0
DATE: 14-Aug-2017
Prepared By:
Software Engineering,
Nexteer Automotive,
Saginaw, MI, USA
Revision History
| Description | Author | Version | Date | 
| Initial version | Selva Sengottaiyan | 1.0 | 21-July-2015 | 
| Updated to FDD v 1.2.0 | Selva Sengottaiyan | 2.0 | 11-Sep-2015 | 
| Updated to FDD v1.4.0 | Selva Sengottaiyan | 3.0 | 22-Dec-2015 | 
| Updated to FDD v1.8.0 | TATA | 4.0 | 21-Jun-2015 | 
| Updated for v2.1.0 | KK | 5.0 | 11-Apr-2017 | 
| Updated server runnable names to match DataDict.m | Brionna Spencer | 6.0 | 14-Aug-2017 | 
Table of Contents
3.2 Global Functions(Non RTE) to be provided to Integration Project 6
4 Configuration REQUIREMeNTS 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
Abbrevations And Acronyms
| Abbreviation | Description | 
| DFD | Design functional diagram | 
| MDD | Module design Document | 
References
This section lists the title & version of all the documents that are referred for development of this document
| Sr. No. | Title | Version | 
| 1 | FDD – CM670A_HwAg1Meas_Design | See Synergy sub project version | 
| 2 | Software Naming Conventions | 01.01.00 | 
| 3 | Software Design and Coding Standards | 2.1 | 
Dependencies
SWCs
| Module | Required Feature | 
| None | 
Global Functions(Non RTE) to be provided to Integration Project
None
Configuration REQUIREMeNTS
Build Time Config
| Modules | Notes | |
| None | 
Configuration Files to be provided by Integration Project
HwAg1Meas_Cfg.h
Da Vinci Parameter Configuration Changes
| Parameter | Notes | SWC | 
| Refer the .m file | CM10 provides program specific NTC configuration | 
DaVinci Interrupt Configuration Changes
| ISR Name | VIM # | Priority Dependency | Notes | 
| None | 
Manual Configuration Changes
| Constant | Notes | SWC | 
| 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
No
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger | 
| HwAg1MeasInit1 | None | RTE (Init) | 
| Runnable | Scheduling Requirements | Trigger | 
| HwAg1MeasPer1 | None | RTE (2 ms) | 
| HwAg1MeasPer2 | None | RTE (2 ms) | 
| HwAg1MeasPer3 | None | RTE (2 ms) | 
| HwAg1MeasPer4 | None | RTE (2ms) | 
| HwAg1MeasPer5 | None | RTE (100ms) | 
| HwAg1AutTrim_Oper | None | Server invocation | 
| HwAg1ClrTrim_Oper | None | Server invocation | 
| HwAg1ReadTrim_Oper | None | Server invocation | 
| HwAg1ReadTrim_Oper | None | Server invocation | 
| HwAg1TrimPrfmdSts_Oper | None | Server invocation | 
| HwAg1WrTrim_Oper | None | Server invocation | 
| HwAg1ClrLtch _Oper | None | Server invocation | 
Memory Map REQUIREMENTS
Mapping
| Memory Section | Contents | Notes | 
| None | ||
* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.
Usage
| Feature | RAM | ROM | 
| None | 
Table 1: ARM Cortex R4 Memory Usage
NvM Blocks
RTE NvM Blocks
| Block Name | 
| HwAg1Offs | 
| HwAg1IfFltLtch | 
Note : Size of the NVM block if configured in developer
Compiler Settings
Preprocessor MACRO
None.
Optimization Settings
None.
Appendix
SENT2SPCO port out should be configured to be high level on port configurations refer CM10 for SPCO port configuration (SENT2SPCO shall be port level high). Port configuration SENT2SPCO output:
Port (that’s needs to be configured as SENT2SPCO) should be initialized as input dio with level high. The client call Iohwab_Setfctprphlhwag1_oper will reset the pin to output alterante mode for SENT2SPCO.
Design Recommandation:
- Port Config RSENT2 IO pin shall setup default input.
- Schedule execution of tasks as per below order at the end of 2ms task
1. "HwAg1MeasPer2"
2. "HwAg1MeasPer3"
3. "HwAg1MeasPer4"
4. "HwAg1MeasPer1"
- Schedule "HwAg1MeasPer4" & "HwAg1MeasPer1" shall at least 110us apart.
2 - HwAg1Meas_MDD
Module Design Document
For
HwAg1Meas
14-Aug-2017
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
Software Engineering,
Nexteer Automotive,
Saginaw, MI, USA
Change History
| Description | Author | Version | Date | 
| Initial Version | Selva Sengottaiyan | 1.0 | 21-July-2015 | 
| Updated to v1.2.0 of the FDD | Selva Sengottaiyan | 2.0 | 11-Sep-2015 | 
| Updated to v1.4.0 of the FDD | Selva Sengottaiyan | 3.0 | 23-Dec-2015 | 
| Updated to v1.11.0 of the FDD | Ramachandran | 4.0 | 21-Jun-2016 | 
| Updated for v2.1.0 | KK | 5.0 | 11-Apr-2017 | 
| Updated server runnable names to match DataDict.m and updated graphic | Brionna Spencer | 6.0 | 14-Aug-2017 | 
Table of Contents
1 Introduction 5
1.1 Purpose 5
1.2 Scope 5
2 HwAg1Meas High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of HwAg1Meas 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: HwAg1MeasInit1 9
5.1.1.1 Design Rationale 9
5.1.2 Per: HwAg1MeasPer1 9
5.1.2.1 Design Rationale 9
5.1.3 Per: HwAg1MeasPer2 9
5.1.3.1 Design Rationale 9
5.1.4 Per: HwAg1MeasPer3 9
5.1.4.1 Design Rationale 9
5.1.5 Per: HwAg1MeasPer4 9
5.1.5.1 Design Rationale 9
5.1.6 Per: HwAg1MeasPer5 9
5.1.6.1 Design Rationale 9
5.2 Server Runnables 10
5.2.1 HwAg1AutTrim 10
5.2.1.1 Design Rationale 10
5.2.2 HwAg1ClrLtch 10
5.2.2.1 Design Rationale 10
5.2.3 HwAg1ClrTrim 10
5.2.3.1 Design Rationale 10
5.2.4 HwAg1ReadTrim 10
5.2.4.1 Design Rationale 10
5.2.5 HwAg1TrimPrfmdSts 10
5.2.5.1 Design Rationale 10
5.2.6 HwAg1WrTrim 10
5.2.6.1 Design Rationale 10
5.3 Interrupt Functions 10
5.4 Module Internal (Local) Functions 11
5.4.1 Local Function #1 11
5.4.1.1 Design Rationale 11
5.4.2 Local Function #2 11
5.4.2.1 Design Rationale 11
5.4.3 Local Function #3 11
5.4.3.1 Design Rationale 11
6 Known Limitations with Design 12
7 UNIT TEST CONSIDERATION 13
Appendix A Abbreviations and Acronyms 14
Appendix B Glossary 15
Appendix C References 16
Introduction
Purpose
Refer to FDD.
Scope
HwAg1Meas High-Level Description
Refer to FDD
Design details of software module
Graphical representation of HwAg1Meas

Data Flow Diagram
Component level DFD
Refer to FDD
Function level DFD
Refer to FDD
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
Local Constants
| Constant Name | Resolution | Units | Value | 
|---|---|---|---|
| MAXWAITININ_MICROSEC_U32 | 1 | MicroSec | 2U | 
| DATAAVLMAXWAIT_MICROSEC_U32 | 1 | MicroSec | 300U | 
| COMSTSMAXWAIT_MICROSEC_U32 | 1 | MicroSec | 5U | 
| PRTCLFLTMASK_CNT_U32 | 1 | Cnt | 0xFEU | 
| SNSRIDMASK_CNT_U08 | 1 | Cnt | 0x00FU | 
| MSGSTSMASK_CNT_U08 | 1 | Cnt | 0x01U | 
| COMSTSMASK_CNT_U32 | 1 | Cnt | 0x30000000UL | 
| DATAMASK_CNT_U16 | 1 | Cnt | 0xFFF0U | 
* Refer to FDD for other constant definitions
Software Component Implementation
Sub-Module Functions
Init: HwAg1MeasInit1
Design Rationale
None
Per: HwAg1MeasPer1
Design Rationale
None
Per: HwAg1MeasPer2
Design Rationale
None
Per: HwAg1MeasPer3
Design Rationale
None
Per: HwAg1MeasPer4
Design Rationale
None
Per: HwAg1MeasPer5
Design Rationale
The implementation brings in the block “HwAg1Final” inside the True Condition of the “finalAbsAg” as the other error condition will just retain the previous value and rolling counter will not change. It saves extra instructions in the implementation to the match the FDD. Final Functionality is still the same.
Server Runnables
HwAg1AutTrim
Design Rationale
None
HwAg1ClrLtch
Design Rationale
None
HwAg1ClrTrim
Design Rationale
None
HwAg1ReadTrim
Design Rationale
None
HwAg1TrimPrfmdSts
Design Rationale
None
HwAg1WrTrim
Design Rationale
None
Interrupt Functions
None
Module Internal (Local) Functions
Local Function #1
| Function Name | CalcHwAgIdx | Type | Min | Max | 
| Arguments Passed | HwAgStep_HwDeg_T_f32 | float32 | -900 | 900 | 
| Return Value | Index_Cnt_T_u08 | uint16 | 0 | 22 | 
Design Rationale
The implementation deviates from the FDD block “Intpn” block. The implementation finds the minimum of absolute values of the difference between HwAg1Step with all the values from the Calibration table and find the index associated with minimum value of the difference in the calibration table.
Local Function #2
| Function Name | ReadRegister | Type | Min | Max | 
| Arguments Passed | RegisterDummyRead_Cnt_T_u32 | N/A | N/A | N/A | 
| Return Value | RegisterDummyRead_Cnt_T_u32 | N/A | N/A | N/A | 
Design Rationale
This function can be used both for read-and-use and for read-and-discard.
Local Function #3
| Function Name | UpdtLthOnValChng | Type | Min | Max | 
| Arguments Passed | SigQlfrIfNtc_T_enum | SigQlfr1 | SIGQLFR_NORES | SIGQLFR_FAILD | 
| Return Value | NA | N/A | N/A | N/A | 
Design Rationale
This function is split from Per4 to reduce path count and cyclomatic complexity.
Path in Model: CM670A_HwAg1Meas/HwAg1Meas/HwAg1MeasPer4/HwAgRead/Update Latch on value change
Known Limitations with Design
None
UNIT TEST CONSIDERATION
- Roll Over is intentional for - *Rte_Pim_HwAg1Snsr0ComStsErrCntr() 
- *Rte_Pim_HwAg1Snsr0IdErrCntr() 
- *Rte_Pim_HwAg1Snsr0IntSnsrErrCntr() 
- *Rte_Pim_HwAg1Snsr0NoMsgErrCntr() 
- *Rte_Pim_HwAg1Snsr1ComStsErrCntr() 
- *Rte_Pim_HwAg1Snsr1IdErrCntr() 
- *Rte_Pim_HwAg1Snsr1IntSnsrErrCntr() 
- *Rte_Pim_HwAg1Snsr1NoMsgErrCntr() 
- (*Rte_Pim_HwAg1PrevRollCnt). 
 
- Thus, counter acts in circular 
Abbreviations and Acronyms
| Abbreviation or Acronym | Description | 
|---|---|
| MDD | Module Design Document | 
| DFD | Data Flow Diagram | 
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 
References
| Ref. # | Title | Version | 
|---|---|---|
| 1 | AUTOSAR Specification of Memory Mapping | v1.3.0 R4.0 Rev 2 | 
| 2 | MDD Guideline | EA4 01.00.01 | 
| 3 | EA4 Software Naming Conventions | 01.01.00 | 
| 4 | Software Design and Coding Standards | 2.1 | 
| 5 | FDD - CM670A_HwAg1Meas_Design | See Synergy sub project version | 
3 - HwAg1Meas_PeerReview
Overview
Summary SheetSynergy Project
Davinci Files
Source Code
Polyspace
MDD
Integration Manual
Sheet 1: Summary Sheet

Sheet 2: Synergy Project
Sheet 3: Davinci Files
Sheet 4: Source Code
| Rev 1.2 | 8-Jun-15 | |||||||||||||||||||||||
| Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
| Source File Name: | HwAg1Meas.c | Source File Revision: | 15 | |||||||||||||||||||||
| Header File Name: | N/A | Header File Revision: | ||||||||||||||||||||||
| MDD Name: | HwAg1Meas_MDD.docx | Revision: | 6 | |||||||||||||||||||||
| FDD/SCIR/DSR/FDR/CM Name: | CM670A_HwAg1Meas_Design | Revision: | 3.1.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 | 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 Traceability tags in code match the requirements traceability in the FDD | N/A | Comments: | ||||||||||||||||||||||
| requirements traceability in the FDD | Traceability tags were removed. | |||||||||||||||||||||||
| All variables are declared at the function level. | N/A | Comments: | ||||||||||||||||||||||
| Synergy version matches change history | 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) | N/A | Comments: | ||||||||||||||||||||||
| Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
| Component.h is included | N/A | Comments: | ||||||||||||||||||||||
| No Component.h to include. | ||||||||||||||||||||||||
| All other includes are actually needed. (System includes | Yes | Comments: | ||||||||||||||||||||||
| only allowed in Nexteer library components) | v800_ghs.h is a necessary system include for compiler | |||||||||||||||||||||||
| intrinsics (e.g. SYNCM and SYNCP instructions). | ||||||||||||||||||||||||
| 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 | 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 | 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-unsigned 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 | N/A | 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: | ||||||||||||||||||||||||
| Change Owner: | Brionna Spencer | Review Date : | 08/23/17 | |||||||||||||||||||||
| Lead Peer Reviewer: | Shawn Penning | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||


