This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - SnsrMeasStrt_IntegrationManual
Integration Manual
For
SnsrMeasStrt
VERSION: 1.0
DATE: 18-NOV-2016
Prepared By:
Shruthi Raghavan
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 | Shruthi Raghavan | 1.0 | 11/18/16 |
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 | EA3 Software Naming Conventions | 2.0 |
2 | Software Design and Coding standards | 2.1 |
3 | FDD CM410B | Refer Design Subproject in Synergy |
Dependencies
SWCs
Module | Required Feature |
CM650B HwTq0Meas | Server Runnable HwTq0MeasTrigStrt_Oper is called from this function |
CM660B HwTq1Meas | Server Runnable HwTq1MeasTrigStrt_Oper is called from this function |
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
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 FDD
Required Global Data Outputs
Refer FDD
Specific Include Path present
No
Runnable Scheduling
This section specifies the required runnable scheduling.
Init | Scheduling Requirements | Trigger |
SnsrMeasStrtInit1 | None | RTE (Init) |
Runnable | Scheduling Requirements | Trigger |
SnsrMeasStrtPer1 | None(Recommended to schedule before HwTq measurement 2ms periodic) | RTE (2 ms) |
SnsrMeasStrtIrq | Interupt triggered | Interrupt OSTM1 (interrupt channel 75) |
Refer this design for interrupt priority. ISR needs to be excuted in the same application region as HwTqMeas components.
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
None
Compiler Settings
Preprocessor MACRO
None
Optimization Settings
None
Appendix
None
2 - SnsrMeasStrt_MDD
Module Design Document
For
SnsrMeasStrt
Nov 18, 2016
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
Shruthi Raghavan,
Nexteer Automotive,
Saginaw, MI, USA
Change History
Description | Author | Version | Date |
Initial Version | Shruthi Raghavan | EA4 01.00.01 | 11/18/16 |
Table of Contents
1 Introduction 4
2 SnsrMeasStrt & High-Level Description 5
3 Design details of software module 6
3.1 Graphical representation of SnsrMeasStrt 6
4.1 Program (fixed) Constants 7
5 Software Component Implementation 8
5.1.1 Init: SnsrMeasStrt_Init1 8
5.1.2 Per: SnsrMeasStrt_Per1 8
5.1.2.2 Processing of function 8
5.3.1.2 Processing of the ISR function 9
5.4 Module Internal (Local) Functions 9
5.5 GLOBAL Function/Macro Definitions 9
6 Known Limitations with Design 10
Appendix A Abbreviations and Acronyms 12
Introduction
Purpose
Module Design Document for CM410B SnsrMeasStrt
SnsrMeasStrt & High-Level Description
Torque Leg is critical factor in Feel issue. In order to minimize lag, it is required to synchronize trigger and time to read torque data should be just in time, so there will be minimum lag.
Design details of software module
Graphical representation of SnsrMeasStrt
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
Refer to DataDict.m file for rest of the constants.
Constant Name | Resolution | Units | Value |
---|---|---|---|
Software Component Implementation
Sub-Module Functions
Init: SnsrMeasStrt_Init1
Design Rationale
OSTM1 Timer has choosen for timing synchronization, because it was close to tied with OSTM0, same clock for accuracy Purpose, but TAUJ or TAUD any real time timer mechanism would work. Initialize OS Timer registers. Refer to CM410B_SnsrMeasStrt_PeripheralCfg.xlsx in the design package to see the specific register configurations. Unmask the OSTM1 EI-level mask able interrupt according to the instructions in Model for which both Os.h and osekext.h are required.
Module Outputs
Refer FDD
Per: SnsrMeasStrt_Per1
Design Rationale
OSTM0 is a free running counter for 2ms. OSTM0CNT is used to trigger torque measure sensor reads with a calibrated trigger delay to start this read (by setting a count value to OSTM1CMP for triggering its interval timer mode interrupt) before the periodic is called again.
Processing of function
Refer to FDD
Server Runnables
None
Interrupt Functions
SnsrMeasStrtIrq
Design Rationale
PIMs belong to the RTE and so the corresponding header file is included in this file for the ISR to have TqMsgTrigCnt defined in scope. Client calls to Hw0TqMeas & Hw1TqMeas server runnables are possible from ISR because they are implemented as non-RTE also in the respective components.
Processing of the ISR function
ISR calls the HwTq0MeasTrigStrt_Oper, HwTq1MeasTrigStrt_Oper server runnables from CM650B and CM660B respectively. Each of these in turn triggers the TqSENT measurement from the corresponding Handwheel Torque Sensor.
Only client calls to server runnables are part of this ISR. Increments a PIM to capture how many timer triggers happen.
Module Internal (Local) Functions
None
GLOBAL Function/Macro Definitions
None
Known Limitations with Design
ISR needs to execute in the same application region of the Torque Measurement Components.
DataDict.m file has known issues:
Context of ISR is wrong
The register given as input is OSTM0CMP whereas the one need is OSTM0CNT.
An anomaly has been submitted to fix this.
UNIT TEST CONSIDERATION
Overflow for the variable Rte_Pim_TqMsgTrigCnt is intentional as this is used as a rolling counter.
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.01 |
3 | EA3 Software Naming Conventions.doc | 2.0 |
4 | Software Design and Coding Standards.doc | 2.1 |
5 | FDD CM410B | Refer to Design Subproject in Synergy |
3 - SnsrMeasStrt_PeerReviewChecklist
Overview
Summary SheetSynergy Project
Davinci Files
CDD_SnsrMeasStrt SourceCode
CDD_SnsrMeasStrt_Irq SourceCode
MDD
PolySpace
Integration Manual
Sheet 1: Summary Sheet

Sheet 2: Synergy Project
Sheet 3: Davinci Files
Sheet 4: CDD_SnsrMeasStrt SourceCode
Rev 1.2 | 8-Jun-15 | |||||||||||||||||||||||
Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
Source File Name: | CDD_SnsrMeasStrt.c | Source File Revision: | 1 | |||||||||||||||||||||
Header File Name: | Header File Revision: | |||||||||||||||||||||||
MDD Name: | SnsrMeasStrt_MDD.docx | Revision: | 1 | |||||||||||||||||||||
FDD/SCIR/DSR/FDR/CM Name: | CM410B_SnsrMeasStrt_Design | Revision: | 1.1.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 | Yes | Comments: | ||||||||||||||||||||||
for function names | Yes | Comments: | ||||||||||||||||||||||
for other names (component, memory | Yes | Comments: | ||||||||||||||||||||||
mapping handles, typedefs, etc.) | ||||||||||||||||||||||||
All paths assign a value to outputs, ensuring | Yes | Comments: | ||||||||||||||||||||||
all outputs are initialized prior to being written | ||||||||||||||||||||||||
Requirements Tracability tags in code match the requirements tracability in the FDD | N/A | Comments: | ||||||||||||||||||||||
requirements tracability in the FDD | ||||||||||||||||||||||||
All variables are declared at the function level. | Yes | 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) | Yes | Comments: | ||||||||||||||||||||||
Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
Component.h is included | N/A | Comments: | ||||||||||||||||||||||
All other includes are actually needed. (System includes | Yes | Comments: | ||||||||||||||||||||||
only allowed in Nexteer library components) | ||||||||||||||||||||||||
Software Design and Coding Standards followed: | Version: 2.1 | |||||||||||||||||||||||
Code comments are clear, correct, and adequate | Yes | Comments: | ||||||||||||||||||||||
and have been updated for the change: [N40] and | ||||||||||||||||||||||||
all other rules in the same section as rule [N40], | ||||||||||||||||||||||||
plus [N75], [N12], [N23], [N33], [N37], [N38], | ||||||||||||||||||||||||
[N48], [N54], [N77], [N79], [N72] | ||||||||||||||||||||||||
Source file (.c and .h) comment blocks are per | Yes | Comments: | ||||||||||||||||||||||
standards and contain correct information: [N41], [N42] | ||||||||||||||||||||||||
Function comment blocks are per standards and | Yes | Comments: | ||||||||||||||||||||||
contain correct information: [N43] | ||||||||||||||||||||||||
Code formatting (indentation, placement of | Yes | Comments: | ||||||||||||||||||||||
braces, etc.) is per standards: [N5], [N55], [N56], | ||||||||||||||||||||||||
[N57], [N58], [N59] | ||||||||||||||||||||||||
Embedded constants used per standards; no | Yes | Comments: | ||||||||||||||||||||||
"magic numbers": [N12] | For Register Initialization, embedded constants are not used. | |||||||||||||||||||||||
Memory mapping for non-RTE code | Yes | Comments: | ||||||||||||||||||||||
is per standard | ||||||||||||||||||||||||
All execution-order-dependent code can be | Yes | Comments: | ||||||||||||||||||||||
recognized by the compiler: [N80] | ||||||||||||||||||||||||
All loops have termination conditions that ensure | N/A | Comments: | ||||||||||||||||||||||
finite loop iterations: [N63] | ||||||||||||||||||||||||
All divides protect against divide by zero | N/A | Comments: | ||||||||||||||||||||||
if needed: [N65] | ||||||||||||||||||||||||
All integer division and modulus operations | N/A | Comments: | ||||||||||||||||||||||
handle negative numbers correctly: [N76] | ||||||||||||||||||||||||
All typecasting and fixed point arithmetic, | N/A | Comments: | ||||||||||||||||||||||
including all use of fixed point macros and | ||||||||||||||||||||||||
timer functions, is correct and has no possibility | ||||||||||||||||||||||||
of unintended overflow or underflow: [N66] | ||||||||||||||||||||||||
All float-to-unsiged conversions ensure the. | N/A | Comments: | ||||||||||||||||||||||
float value is non-negative: [N67] | ||||||||||||||||||||||||
All conversions between signed and unsigned | N/A | Comments: | ||||||||||||||||||||||
types handle msb==1 as intended: [N78] | ||||||||||||||||||||||||
All pointer dereferencing protects against | N/A | Comments: | ||||||||||||||||||||||
null pointer if needed: [N70] | ||||||||||||||||||||||||
Component outputs are limited to the legal range | N/A | Comments: | ||||||||||||||||||||||
defined in the FDD DataDict.m file : [N53] | ||||||||||||||||||||||||
All code is mapped with FDD (all FDD | Yes | Comments: | ||||||||||||||||||||||
subfunctions and/or model blocks identified | ||||||||||||||||||||||||
with code comments; all code corresponds to | ||||||||||||||||||||||||
some FDD subfunction and/or model block): [N40] | ||||||||||||||||||||||||
Review did not identify violations of other | Yes | Comments: | ||||||||||||||||||||||
coding standard rules | ||||||||||||||||||||||||
Anomaly or Design Work CR created | Comments: List Anomaly or CR numbers | |||||||||||||||||||||||
for any FDD corrections needed | ||||||||||||||||||||||||
General Notes / Comments: | ||||||||||||||||||||||||
Compiler needs to include Os.h from the component contract folder and not from the AR200 contract folder so the order of include paths in the gpj must be changed accordingly | ||||||||||||||||||||||||
The anomaly created was completed using an component CR that was still open | ||||||||||||||||||||||||
Change Owner: | Shruthi Raghavan | Review Date : | 11/18/16 | |||||||||||||||||||||
Lead Peer Reviewer: | Avinash James | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
Other Reviewer(s): | Jayakrishnan T | Krishna Anne | ||||||||||||||||||||||
Sheet 5: CDD_SnsrMeasStrt_Irq SourceCode
Rev 1.2 | 8-Jun-15 | |||||||||||||||||||||||
Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
Source File Name: | CDD_SnsrMeasStrt_Irq.c | Source File Revision: | 1 | |||||||||||||||||||||
Header File Name: | Header File Revision: | |||||||||||||||||||||||
MDD Name: | SnsrMeasStrt_MDD.docx | Revision: | 1 | |||||||||||||||||||||
FDD/SCIR/DSR/FDR/CM Name: | CM410B_SnsrMeasStrt_Design | Revision: | 1.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 | Yes | Comments: | ||||||||||||||||||||||
for other names (component, memory | Yes | Comments: | ||||||||||||||||||||||
mapping handles, typedefs, etc.) | ||||||||||||||||||||||||
All paths assign a value to outputs, ensuring | Yes | Comments: | ||||||||||||||||||||||
all outputs are initialized prior to being written | ||||||||||||||||||||||||
Requirements Tracability tags in code match the requirements tracability in the FDD | N/A | Comments: | ||||||||||||||||||||||
requirements tracability in the FDD | ||||||||||||||||||||||||
All variables are declared at the function level. | Yes | 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) | Yes | Comments: | ||||||||||||||||||||||
Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
Component.h is included | N/A | Comments: | ||||||||||||||||||||||
All other includes are actually needed. (System includes | Yes | Comments: | ||||||||||||||||||||||
only allowed in Nexteer library components) | ||||||||||||||||||||||||
Software Design and Coding Standards followed: | Version: 2.1 | |||||||||||||||||||||||
Code comments are clear, correct, and adequate | Yes | Comments: | ||||||||||||||||||||||
and have been updated for the change: [N40] and | ||||||||||||||||||||||||
all other rules in the same section as rule [N40], | ||||||||||||||||||||||||
plus [N75], [N12], [N23], [N33], [N37], [N38], | ||||||||||||||||||||||||
[N48], [N54], [N77], [N79], [N72] | ||||||||||||||||||||||||
Source file (.c and .h) comment blocks are per | Yes | Comments: | ||||||||||||||||||||||
standards and contain correct information: [N41], [N42] | ||||||||||||||||||||||||
Function comment blocks are per standards and | Yes | Comments: | ||||||||||||||||||||||
contain correct information: [N43] | ||||||||||||||||||||||||
Code formatting (indentation, placement of | Yes | Comments: | ||||||||||||||||||||||
braces, etc.) is per standards: [N5], [N55], [N56], | ||||||||||||||||||||||||
[N57], [N58], [N59] | ||||||||||||||||||||||||
Embedded constants used per standards; no | Yes | Comments: | ||||||||||||||||||||||
"magic numbers": [N12] | ||||||||||||||||||||||||
Memory mapping for non-RTE code | Yes | Comments: | ||||||||||||||||||||||
is per standard | ISR is defined in memory region of Appl with Torque measure components so it can only call functions from that memory region | |||||||||||||||||||||||
All execution-order-dependent code can be | Yes | Comments: | ||||||||||||||||||||||
recognized by the compiler: [N80] | ||||||||||||||||||||||||
All loops have termination conditions that ensure | N/A | Comments: | ||||||||||||||||||||||
finite loop iterations: [N63] | ||||||||||||||||||||||||
All divides protect against divide by zero | N/A | Comments: | ||||||||||||||||||||||
if needed: [N65] | ||||||||||||||||||||||||
All integer division and modulus operations | N/A | Comments: | ||||||||||||||||||||||
handle negative numbers correctly: [N76] | ||||||||||||||||||||||||
All typecasting and fixed point arithmetic, | N/A | Comments: | ||||||||||||||||||||||
including all use of fixed point macros and | ||||||||||||||||||||||||
timer functions, is correct and has no possibility | ||||||||||||||||||||||||
of unintended overflow or underflow: [N66] | ||||||||||||||||||||||||
All float-to-unsiged conversions ensure the. | N/A | Comments: | ||||||||||||||||||||||
float value is non-negative: [N67] | ||||||||||||||||||||||||
All conversions between signed and unsigned | N/A | Comments: | ||||||||||||||||||||||
types handle msb==1 as intended: [N78] | ||||||||||||||||||||||||
All pointer dereferencing protects against | N/A | Comments: | ||||||||||||||||||||||
null pointer if needed: [N70] | ||||||||||||||||||||||||
Component outputs are limited to the legal range | N/A | Comments: | ||||||||||||||||||||||
defined in the FDD DataDict.m file : [N53] | ||||||||||||||||||||||||
All code is mapped with FDD (all FDD | Yes | Comments: | ||||||||||||||||||||||
subfunctions and/or model blocks identified | ||||||||||||||||||||||||
with code comments; all code corresponds to | ||||||||||||||||||||||||
some FDD subfunction and/or model block): [N40] | ||||||||||||||||||||||||
Review did not identify violations of other | Yes | Comments: | ||||||||||||||||||||||
coding standard rules | ||||||||||||||||||||||||
Anomaly or Design Work CR created | Comments: List Anomaly or CR numbers | |||||||||||||||||||||||
for any FDD corrections needed | EA4#8459 caused FDD changes : from v1.0.0 to v1.1.0 | |||||||||||||||||||||||
General Notes / Comments: | ||||||||||||||||||||||||
Change Owner: | Shruthi Raghavan | Review Date : | 11/18/16 | |||||||||||||||||||||
Lead Peer Reviewer: | Shruthi Raghavan | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
Other Reviewer(s): | Jayakrishnan T | Krishna Anne | ||||||||||||||||||||||