This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - HwTq1Meas_IntegrationManual
Integration Manual
For
HwTq1Meas
VERSION: 3.0
DATE: 21-Dec-2015
Prepared By:
Software Group,
Nexteer Automotive,
Saginaw, MI, USA
Location: The official version of this document is stored in the Nexteer Configuration Management System.
Revision History
| Sl. No. | Description | Author | Version | Date | 
| 1 | Initial version | Rijvi Ahmed | 1.0 | 11-Aug-2015 | 
| 2 | Updated for CM660A_HwTq1Meas_Design_1.4.0 | Selva | 2.0 | 14-Oct-2015 | 
| 3 | Updated for CM660A_HwTq1Meas_Design_1.6.0 | Selva | 3.0 | 21-Dec-2015 | 
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 | 
| FDD | Functional 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 – CM660A HwTq1Meas | See Synergy subproject version | 
| 2 | Software Naming Conventions | Process 04.02.00 | 
| 3 | Software Coding Standards | Process 04.02.00 | 
Dependencies
SWCs
| Module | Required 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
| Modules | Notes | |
| None | 
Configuration Files to be provided by Integration Project
CDD_HwTq1Meas_Cfg.h
Note: Temporarily this file can be copied from the contract folder. Later revision will have the Davinci configuration parameter to generate the file.
Da Vinci Parameter Configuration Changes
| Parameter | Notes | SWC | 
| None | 
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
Required Global Data Outputs
Refer DataDict.m file
Specific Include Path present
Yes
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger | 
| HwTq1MeasInit1 | None | RTE (Init) | 
| Runnable | Scheduling Requirements | Trigger | 
| HwTq1MeasPer1 | None | RTE (2 ms) | 
| HwTq1MeasPer2 | None | RTE (100 ms) | 
| HwTq1MeasHwTq1AutTrim_Oper | None | On event | 
| HwTq1MeasHwTq1ClrTrim_Oper | None | On event | 
| HwTq1MeasHwTq1ReadTrim_Oper | None | On event | 
| HwTq1MeasHwTq1TrimPrfmdSts_Oper | None | On event | 
| HwTq1MeasHwTq1WrTrim_Oper | None | On event | 
| HwTq1MeasTrigStrt_Oper | None | On event | 
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
*See DataDict.m
Compiler Settings
Preprocessor MACRO
None
Optimization Settings
None
Appendix
Port Configuration SENT1SPCO output:
Port (that’s needs to be configured as SENT1SPCO) should be initialized as input DIO with level high.
The client call IoHwAb_SetFctPrphlHwTq1_Oper will reset the pin to output Alterante mode for SENT1SPCO.
2 - HwTq1Meas_MDD
Module Design Document
For
HandWheel Torque 1 Measurement
Dec 21 2015
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
Software Group,
Nexteer Automotive,
Saginaw, MI, USAChange History
| Description | Author | Version | Date | 
| Initial Version | Rijvi Ahmed | 1.0 | 11-Aug-2015 | 
| Inplement Rack Limiter EOT | Rijvi Ahmed | 2.0 | 18-Sep-2015 | 
| Updated for CM660A_HwTq1Meas_Design_1.4.0 | Selva | 3.0 | 14-Oct-2015 | 
| Updated for CM660A_HwTq1Meas_Design_1.6.0 | Selva | 4.0 | 21-Dec-15 | 
Table of Contents
2 HwTq1Meas & High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of HwTq1Meas 7
4.1 Program (fixed) Constants 8
5 Software Component Implementation 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.1.3.2 Store Module Inputs to Local copies 10
5.1.3.3 (Processing of function)……… 10
5.1.3.4 Store Local copy of outputs into Module Outputs 10
5.2.1 HwTq1MeasHwTq1AutTrim_oper 10
5.2.1.2 (Processing of function)……… 10
5.2.2 HwTq1MeasHwTq1ClrTrim_Oper 10
5.2.2.2 (Processing of function)……… 10
5.2.3 HwTq1MeasHwTq1ReadTrim_Oper 10
5.2.3.2 (Processing of function)……… 10
5.2.4 HwTq1MeasHwTq1TrimPrfmdSts_Oper 10
5.2.4.2 (Processing of function)……… 11
5.2.5 HwTq1MeasHwTq1WrTrim_Oper 11
5.2.5.2 (Processing of function)……… 11
5.2.6 HwTq1MeasTrigStrt_Oper 11
5.2.6.2 (Processing of function)……… 11
5.4 Module Internal (Local) Functions 11
5.5 GLOBAL Function/Macro Definitions 12
6 Known Limitations with Design 13
Appendix A Abbreviations and Acronyms 15
Introduction
Purpose
Module design document for Hand Wheel Torque 1 Measurement Function.
HwTq1Meas & High-Level Description
This module configures and processes the RSENT1 peripheral, which is connected to the handwheel torque 1 sensor. The module configures the peripheral, triggers transfers, and processes the received data.
This module also reads and provides the rack limiter EOT information which is stored in torque sensor 1 scratchpad.
Design details of software module
Graphical representation of HwTq1Meas

Data Flow Diagram
Component level DFD
N/A
Function level DFD
N/A
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
Local Constants
| Constant Name | Resolution | Units | Value | 
| STSFLTMASK_CNT_U32 | 1 | Cnt | 0x000000FEUL | 
| TQDATAMASK_CNT_U32 | 1 | Cnt | 0x00000FFFUL | 
| SENTSYNCTRIG_CNT_U32 | 1 | Cnt | 16UL | 
| REGCFGWAITTI_CNT_U32 | 1 | Cnt | 2UL | 
| RACKLIMREOTSIGHILIM_HWDEG_F32 | Single point precision | HwDeg | (800.0F) | 
| RACKLIMREOTSIGLOLIM_HWDEG_F32 | Single point precision | HwDeg | (-800.0F) | 
| RACKLIMRCCWEOTSCA_ULS_F32 | Single point precision | Uls | (-0.1953F) | 
| RACKLIMRCWEOTSCA_ULS_F32 | Single point precision | Uls | (0.1953F) | 
| EOTCSMASK_CNT_U32 | 1 | Cnt | 0x00000700UL | 
| EOTIDTWO_CNT_U08 | 1 | Cnt | 2U | 
| EOTIDTHREE_CNT_U08 | 1 | Cnt | 3U | 
| EOTIDFOUR_CNT_U08 | 1 | Cnt | 4U | 
| EOTDATAMASK_CNT_U32 | 1 | Cnt | 0x00000FF0UL | 
| EOTIDMASK_CNT_U32 | 1 | Cnt | 0x0000000FUL | 
| FRSMASK_CNT_U32 | 1 | Cnt | 0x00000001UL | 
| CSMASK_CNT_U32 | 1 | Cnt | 0x000000FEUL | 
| FCCNMASK_CNT_U32 | 1 | Cnt | 0x30000000UL | 
| SLOWMSGDATAMASK_CNT_U32 | 1 | Cnt | 0x80000000UL | 
Software Component Implementation
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.
Init: HwTq1MeasInit1
Design Rationale
Magic numbers are used due to the large number of numeric values (for peripheral register configuration), it is more readable and easier to maintain without using embedded constants for these values. The values are shown in code comments, and line up exactly with the definitions given in the design module (a special spreadsheet was included in the design for this purpose).
See CM660A_HwTq1Meas_RSENTPeripheralCfg.xlsx in design module.
Module Outputs
Refer to FDD
Per: HwTq1MeasPer1
Design Rationale
None
Store Module Inputs to Local copies
Refer to FDD
(Processing of function)………
Refer to FDD
Store Local copy of outputs into Module Outputs
Refer to FDD
Per: HwTq1MeasPer2
Design Rationale
None
Store Module Inputs to Local copies
Refer to FDD
(Processing of function)………
Refer to FDD
Store Local copy of outputs into Module Outputs
Refer to FDD
Server Runables
HwTq1MeasHwTq1AutTrim_oper
Design Rationale
None
(Processing of function)………
See block “HwTq1MeasHwTq1AutTrim” in the Simulink model of the design.
HwTq1MeasHwTq1ClrTrim_Oper
Design Rationale
None
(Processing of function)………
See block “HwTq1MeasHwTq1ClrTrim” in the Simulink model of the design.
HwTq1MeasHwTq1ReadTrim_Oper
Design Rationale
None
(Processing of function)………
See block “HwTq1MeasHwTq1ReadTrim” in the Simulink model of the design.
HwTq1MeasHwTq1TrimPrfmdSts_Oper
Design Rationale
None
(Processing of function)………
See block “HwTq1MeasHwTq1TrimPrfmdSts” in the Simulink model of the design.
HwTq1MeasHwTq1WrTrim_Oper
Design Rationale
None
(Processing of function)………
See block “HwTq1MeasHwTq1WrTrim” in the Simulink model of the design.
HwTq1MeasTrigStrt_Oper
Design Rationale
None
(Processing of function)………
See block “HwTq1MeasTrigStrt” in the Simulink model of the design.
Interrupt Functions
None
Module Internal (Local) Functions
Local Function #1
| Function Name | RackLimrEotSigRead | Type | Min | Max | 
| Arguments Passed | None | N/A | N/A | N/A | 
| Return Value | N/A | N/A | N/A | N/A | 
Design Rationale
See RackLimrEot/RackLimrEotSigRead block in the Simulink model of the design.
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
GLOBAL Function/Macro Definitions
None
Known Limitations with Design
None
UNIT TEST CONSIDERATION
Overflow for the variables Rte_Pim_HwTq1MeasPrevRollgCntr, Rte_Pim_HwTq1MsgMissRxCnt, Rte_Pim_HwTq1ComStsErrCntr, Rte_Pim_HwTq1IntSnsrErrCntr are intentional as these are used as rolling counters.
Abbreviations and Acronyms
| Abbreviation or Acronym | Description | 
|---|---|
| DFD | Design functional diagram | 
| MDD | Module design Document | 
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 
| Term | Definition | Source | 
|---|---|---|
| MDD | Module Design Document | |
| DFD | Data Flow Diagram | 
References
| Ref. # | Title | Version | 
|---|---|---|
| 1 | AUTOSAR Specification of Memory Mapping (Link:AUTOSAR_SWS_MemoryMapping.pdf) | v1.3.0 R4.0 Rev 2 | 
| 2 | MDD Guideline | EA4 01.00.00 | 
| 3 | Software Naming Conventions.doc | 1.0 | 
| 4 | Software Design and Coding Standards.doc | 2.0 | 
| 5 | FDD – CM660A HwTq1Meas | See Synergy subproject version | 
3 - HwTq1Meas_PeerReviewChecklist
Overview
Summary SheetSynergy Project
Sheet 1: Summary Sheet

Sheet 2: Synergy Project
4 - requirements
| FDD | ID | Source | Function | Line(s) | Status | Comment | 
|---|---|---|---|---|---|---|
| .SwFileName | .SwFuncName | .SwLines | .SwStatus | .SwComment | ||
| CM660A | 30 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1244 | I | |
| CM660A | 42 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1140-1145 | I | |
| CM660A | 29 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1171-1185 | I | |
| CM660A | 61 | CDD_HwTq1Meas.c | HwTq1MeasPer2 | 1281-1290 | I | |
| CM660A | 63 | CDD_HwTq1Meas.c | HwTq1MeasPer2 | 1281-1290 | I | |
| CM660A | 65 | CDD_HwTq1Meas.c | HwTq1MeasPer2 | 1281-1290 | I | |
| CM660A | 67 | CDD_HwTq1Meas.c | HwTq1MeasPer2 | 1281-1290 | I | |
| CM660A | 26 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1184 | I | |
| CM660A | 27 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1066-1247 | I | |
| CM660A | 48 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1129-1134 | I | |
| CM660A | 49 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1120-1124 | I | |
| CM660A | 46 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1141-1146 | I | |
| CM660A | 47 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1154-1159 | I | |
| CM660A | 44 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1141-1146 | I | |
| CM660A | 45 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1141-1146 | I | |
| CM660A | 28 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1129-1134 | I | |
| CM660A | 43 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1140-1145 | I | |
| CM660A | 40 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1140-1145 | I | |
| CM660A | 41 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1140-1145 | I | |
| CM660A | 76 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1225 | I | |
| CM660A | 75 | CDD_HwTq1Meas.c | RackLimrEotSigRead | 1425 | I | |
| CM660A | 71 | CDD_HwTq1Meas.c | RackLimrEotSigRead | 1411-1419 | I | |
| CM660A | 70 | CDD_HwTq1Meas.c | RackLimrEotSigRead | 1411-1419,1423,1424 | I | |
| CM660A | 39 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1066-1247 | I | |
| CM660A | 38 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1198,1203 | I | |
| CM660A | 55 | CDD_HwTq1Meas.c | HwTq1MeasHwTq1WrTrim_Oper | 909-916 | I | |
| CM660A | 54 | CDD_HwTq1Meas.c | HwTq1MeasHwTq1ClrTrim_Oper | 799-806 | I | |
| CM660A | 31 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1245 | I | |
| CM660A | 56 | CDD_HwTq1Meas.c | HwTq1MeasHwTq1AutTrim_Oper | 751-758 | I | |
| CM660A | 50 | CDD_HwTq1Meas.c | HwTq1MeasHwTq1AutTrim_Oper,HwTq1MeasHwTq1ClrTrim_Oper,HwTq1MeasHwTq1WrTrim_Oper,HwTq1MeasPer1 | 751-758,799-806,909-916,1175 | I | |
| CM660A | 53 | CDD_HwTq1Meas.c | HwTq1MeasHwTq1TrimPrfmdSts_Oper | 868 | I | |
| CM660A | 52 | CDD_HwTq1Meas.c | HwTq1MeasHwTq1ReadTrim_Oper | 837 | I | |
| CM660A | 33 | CDD_HwTq1Meas.c | HwTq1MeasTrigStrt_Oper | 1336-1353 | I | |
| CM660A | 32 | CDD_HwTq1Meas.c | HwTq1MeasPer1 | 1171-1185 | I | 


