This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - AdcDiagc_IntegrationManual
Integration Manual
For
AdcDiagc
VERSION: 4.0
DATE: Aug 25, 2016
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 | 02-Feb-2016 | 
| 2 | Updated per design rev. 1.1.0 | Rijvi Ahmed | 2.0 | 23-Mar-2016 | 
| 3 | Updated per design rev. 1.6.0 | Avinash James | 3.0 | 18-Jul-2016 | 
| 4 | Updated per design rev. 1.7.0 | Avinash James | 4.0 | 25-Aug-2016 | 
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 | 
| <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. | Title | Version | 
| 1 | FDD – CM340A-AdcDiagc_Design | See Synergy sub project version | 
| 2 | Software Naming Conventions | Process 04.02.01 | 
| 3 | Software Design and Coding Standards | Process 04.02.01 | 
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
Configuration REQUIREMeNTS
Build Time Config
| Modules | Notes | |
| None | 
Configuration Files to be provided by Integration Project
No
Da Vinci Parameter Configuration Changes
| Parameter | Notes | SWC | 
| Refer the .m file in the design | 
DaVinci Interrupt Configuration Changes
| ISR Name | VIM # | Priority Dependency | Notes | 
| N/A | 
Manual Configuration Changes
| Constant | Notes | SWC | 
| 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
None Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger | 
| AdcDiagcInit1 | None | RTE/Init | 
| Runnable | Scheduling Requirements | Trigger | 
| AdcDiagcPer1 | None | RTE/2ms | 
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
None.
2 - AdcDiagc_MDD
Module Design Document
For
AdcDiagc
Aug 25, 2016
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
Software Group,
Nexteer Automotive,
Saginaw, MI, USA
Change History
| Description | Author | Version | Date | 
| Initial Version | Rijvi Ahmed | 1.0 | 02-Feb-2016 | 
| Updated per design rev. 1.1.0 | Rijvi Ahmed | 2.0 | 23-Mar-2016 | 
| Updated per design rev. 1.4.0 | Avinash James | 3.0 | 21-Jun-2016 | 
| Updated per design rev. 1.6.0 | Avinash James | 4.0 | 15-Jul-2016 | 
| Updated per design rev. 1.7.0 | Avinash James | 5.0 | 25-Aug-2016 | 
Table of Contents
2 AdcDiagc & High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of AdcDiagc 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.2.1.2 (Processing of function)……… 9
5.4 Module Internal (Local) Functions 10
5.5 GLOBAL Function/Macro Definitions 12
6 Known Limitations with Design 13
Appendix A Abbreviations and Acronyms 15
Introduction
Purpose
MDD for AdcDiagc
Scope
AdcDiagc & High-Level Description
Refer to FDD.
Design details of software module
Graphical representation of AdcDiagc

Data Flow Diagram
None.
Component level DFD
Refer FDD.
Function level DFD
Refer FDD.
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
Local Constants
| Constant Name | Resolution | Units | Value | 
|---|---|---|---|
| MAXADCDIAGCST_CNT_U08 | 1 | CNT | 7U | 
| Refer to the FDD | |||
| MASKFLTCNTR_CNT_U08 | 1 | CNT | 127U | 
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:
Design Rationale
None
Module Outputs
None
Per:
Design Rationale
Refer FDD.
Store Module Inputs to Local copies
Refer FDD
(Processing of function)………
Refer FDD
Store Local copy of outputs into Module Outputs
Refer FDD.
Server Runables
Interrupt Functions
None
Module Internal (Local) Functions
Local Function #1
| Function Name | St2Proc | Type | Min | Max | 
| Arguments Passed | AdcSelfDiag0_Volt_T_f32 | float32 | 0.0 | 5.0 | 
| AdcSelfDiag2_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcSelfDiag4_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcDiagcSt_Uls_T_u08 | Uint8 | 0 | 3 | |
| *RollgCntr_Cnt_T_u08 | *uint8 | 0 | 255 | |
| Return Value | AdcNtcStInfo_Uls_T_u08 | Uint8 | 0 | 255 | 
Design Rationale
Processing
See “State 2” block in the Simulink model of the design.
Local Function #2
| Function Name | St4Proc | Type | Min | Max | 
| Arguments Passed | AdcSelfDiag0_Volt_T_f32 | float32 | 0.0 | 5.0 | 
| AdcSelfDiag2_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcSelfDiag4_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcDiagcSt_Uls_T_u08 | Uint8 | 0 | 3 | |
| *RollgCntr_Cnt_T_u08 | *uint8 | 0 | 255 | |
| Return Value | AdcNtcStInfo_Uls_T_u08 | Uint8 | 0 | 255 | 
Design Rationale
Processing
See “State 4” block in the Simulink model of the design.
Local Function #3
| Function Name | St6Proc | Type | Min | Max | 
| Arguments Passed | AdcSelfDiag0_Volt_T_f32 | float32 | 0.0 | 5.0 | 
| AdcSelfDiag2_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcSelfDiag4_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcDiagcSt_Uls_T_u08 | Uint8 | 0 | 3 | |
| *RollgCntr_Cnt_T_u08 | *uint8 | 0 | 255 | |
| Return Value | AdcNtcStInfo_Uls_T_u08 | Uint8 | 0 | 255 | 
Design Rationale
Processing
See “State 6” block in the Simulink model of the design.
Local Function #4
| Function Name | St0Proc | Type | Min | Max | 
| Arguments Passed | AdcSelfDiag0_Volt_T_f32 | float32 | 0.0 | 5.0 | 
| AdcSelfDiag2_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcSelfDiag4_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| *RollgCntr_Cnt_T_u08 | *uint8 | 00 | 3255 | |
| *uint8 | 0 | 255 | ||
| Return Value | AdcNtcStInfo_Uls_T_u08 | Uint8 | 0 | 255 | 
Design Rationale
Processing
See “State 0” block in the Simulink model of the design.
Local Function #5
| Function Name | Adc0StBasdProc | Type | Min | Max | 
| Arguments Passed | Adc0ParFlt_Cnt_T_u08 | uint8 | 0 | 255 | 
| Return Value | None | N/A | N/A | N/A | 
Design Rationale
Processing
See “Adc0 State Based Processing” block in the Simulink model of the design.
Local Function #6
| Function Name | Adc1StBasdProc | Type | Min | Max | 
| Arguments Passed | Adc1ParFlt_Cnt_T_u08 | uint8 | 0 | 255 | 
| Return Value | None | N/A | N/A | N/A | 
Design Rationale
Processing
See “Adc1 State Based Processing” block in the Simulink model of the design.
Local Function #7
| Function Name | AdcDiagcPtrProc | Type | Min | Max | 
| Arguments Passed | None | N/A | N/A | N/A | 
| Return Value | None | N/A | N/A | N/A | 
Design Rationale
Processing
See “Adc Daigc Pointer” block in the Simulink model of the design.
Local Function #8
| Function Name | ScanGroupAccrcyChk | Type | Min | Max | 
| Arguments Passed | AdcScanGroupInpRefVltg_Volt_T_f32 | float32 | 0.0 | 5.0 | 
| AdcScanGroupRefVltg_Volt_T_f32 | float32 | 0.0 | 5.0 | |
| AdcScanGroupInpRefPrm_Cnt_T_u08 | Uint8 | 0 | 255 | |
| Return Value | ScanGroupAccrcyChkRefPrm_Cnt_u08 | Uint8 | 0 | 255 | 
Design Rationale
Processing
See “Scan Group Accuracy Check” block in the Simulink model of the design.
Local Function #9
| Function Name | SetAdcParFlt | Type | Min | Max | 
| Arguments Passed | *Adc0ParFlt_Cnt_T_u08 | Uint8 | 0 | 255 | 
| *Adc1ParFlt_Cnt_T_u08 | Uint8 | 0 | 255 | |
| Return Value | 
Design Rationale
Processing
See “Adc Parity Fault” block in the Simulink model of the design.
GLOBAL Function/Macro Definitions
Note: The server runnable of this component are non-rte. So they are actually global functions which should belong to this section. But as they are already described under Server Runnable section so it’s omitted here.
Known Limitations with Design
None.
UNIT TEST CONSIDERATION
The overflow for the following PIMs are intentional as they are used as rolling counter.
Rte_Pim_Adc0FltCntSt0
Rte_Pim_Adc0FltCntSt2
Rte_Pim_Adc0FltCntSt4
Rte_Pim_Adc0FltCntSt6
Rte_Pim_Adc1FltCntSt0
Rte_Pim_Adc1FltCntSt2
Rte_Pim_Adc1FltCntSt4
Rte_Pim_Adc1FltCntSt6
Abbreviations and Acronyms
| Abbreviation or Acronym | Description | 
|---|---|
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 | Software Naming Conventions.doc | 1.0 | 
| 4 | Software Design and Coding Standards.doc | 2.1 | 
| 5 | FDD - CM340A_AdcDiagc_Design | See Synergy sub project version | 
3 - AdcDiagc_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 | ||
| CM340A | 216 | CDD_AdcDiagc.c | Adc0StBasdProc | 973-997 | I | |
| CM340A | 151 | CDD_AdcDiagc.c | Adc1StBasdProc | 1046-1051 | I | |
| CM340A | 153 | CDD_AdcDiagc.c | Adc1StBasdProc | 1046-1051 | I | |
| CM340A | 152 | CDD_AdcDiagc.c | Adc1StBasdProc | 1046-1051 | I | |
| CM340A | 154 | CDD_AdcDiagc.c | Adc1StBasdProc | 1046-1051 | I | |
| CM340A | 217 | CDD_AdcDiagc.c | Adc1StBasdProc | 1095-1119 | I | |
| CM340A | 194 | CDD_AdcDiagc.c | AdcDiagcPer1 | 858 | I | |
| CM340A | 134 | CDD_AdcDiagc.c | Adc1StBasdProc | 1095-1119 | I | |
| CM340A | 191 | CDD_AdcDiagc.c | Adc0StBasdProc | 920-924 | I | |
| CM340A | 190 | CDD_AdcDiagc.c | Adc0StBasdProc | 920-924 | I | |
| CM340A | 192 | CDD_AdcDiagc.c | Adc0StBasdProc | 920-924 | I | |
| CM340A | 115 | CDD_AdcDiagc.c | Adc0StBasdProc | 940-946 | I | |
| CM340A | 164 | CDD_AdcDiagc.c | Adc1StBasdProc | 1053-1058 | I | |
| CM340A | 117 | CDD_AdcDiagc.c | Adc0StBasdProc | 940-946 | I | |
| CM340A | 116 | CDD_AdcDiagc.c | Adc0StBasdProc | 940-946 | I | |
| CM340A | 163 | CDD_AdcDiagc.c | Adc1StBasdProc | 1053-1058 | I | |
| CM340A | 136 | CDD_AdcDiagc.c | Adc1StBasdProc | 1095-1119 | I | |
| CM340A | 112 | CDD_AdcDiagc.c | AdcDiagcPer1 | 858 | I | |
| CM340A | 80 | CDD_AdcDiagc.c | AdcDiagcPer1 | 858 | I | |
| CM340A | 173 | CDD_AdcDiagc.c | Adc0StBasdProc,Adc1StBasdProc | 920-924,926-931,933-938,940-946,1040-1044,1046-1051,1053-1058,1060-1066 | I | |
| CM340A | 118 | CDD_AdcDiagc.c | Adc0StBasdProc | 940-946 | I | |
| CM340A | 171 | CDD_AdcDiagc.c | Adc1StBasdProc | 1060-1066 | I | |
| CM340A | 170 | CDD_AdcDiagc.c | Adc1StBasdProc | 1060-1066 | I | |
| CM340A | 203 | CDD_AdcDiagc.c | Adc1StBasdProc | 1095-1119 | I | |
| CM340A | 22 | CDD_AdcDiagc.c | Adc0StBasdProc | 973-997 | I | |
| CM340A | 160 | CDD_AdcDiagc.c | Adc1StBasdProc | 1053-1058 | I | |
| CM340A | 211 | CDD_AdcDiagc.c | SetAdcParFlt | 1362-1382 | I | |
| CM340A | 28 | CDD_AdcDiagc.c | Adc0StBasdProc | 973-997 | I | |
| CM340A | 105 | CDD_AdcDiagc.c | AdcDiagcPtrProc | 1150 | I | |
| CM340A | 172 | CDD_AdcDiagc.c | Adc1StBasdProc | 1060-1066 | I | |
| CM340A | 162 | CDD_AdcDiagc.c | Adc1StBasdProc | 1053-1058 | I | |
| CM340A | 189 | CDD_AdcDiagc.c | Adc0StBasdProc,AdcDiagcPtrProc | 920-924,1135 | I | |
| CM340A | 146 | CDD_AdcDiagc.c | Adc1StBasdProc | 1040-1044 | I | |
| CM340A | 200 | CDD_AdcDiagc.c | Adc0StBasdProc,Adc1StBasdProc | 973-997,1040-1044 | I | |
| CM340A | 144 | CDD_AdcDiagc.c | Adc1StBasdProc | 1040-1044 | I | |
| CM340A | 145 | CDD_AdcDiagc.c | Adc1StBasdProc | 1040-1044 | I | |
| CM340A | 204 | CDD_AdcDiagc.c | AdcDiagcPer1,Adc0StBasdProc,Adc1StBasdProc | 816-863,952-971,1074-1093 | I | |
| CM340A | 206 | CDD_AdcDiagc.c | SetAdcParFlt | 1362-1382 | I | |
| CM340A | 99 | CDD_AdcDiagc.c | Adc0StBasdProc | 926-931 | I | |
| CM340A | 98 | CDD_AdcDiagc.c | Adc0StBasdProc | 926-931 | I | |
| CM340A | 108 | CDD_AdcDiagc.c | Adc0StBasdProc | 933-938 | I | |
| CM340A | 109 | CDD_AdcDiagc.c | Adc0StBasdProc | 933-938 | I | |
| CM340A | 132 | CDD_AdcDiagc.c | Adc1StBasdProc | 1095-1119 | I | |
| CM340A | 169 | CDD_AdcDiagc.c | Adc1StBasdProc | 1060-1066 | I | |
| CM340A | 70 | CDD_AdcDiagc.c | AdcDiagcPer1 | 816-863 | I | |
| CM340A | 102 | CDD_AdcDiagc.c | AdcDiagcPer1 | 858 | I | |
| CM340A | 106 | CDD_AdcDiagc.c | Adc0StBasdProc,AdcDiagcPtrProc | 933-938,1145 | I | |
| CM340A | 107 | CDD_AdcDiagc.c | Adc0StBasdProc | 933-938 | I | |
| CM340A | 97 | CDD_AdcDiagc.c | Adc0StBasdProc | 926-931 | I | |
| CM340A | 96 | CDD_AdcDiagc.c | Adc0StBasdProc,AdcDiagcPtrProc | 926-931,1140 | I | |
| CM340A | 16 | CDD_AdcDiagc.c | AdcDiagcPer1 | 816-863 | I | |
| CM340A | 31 | CDD_AdcDiagc.c | Adc0StBasdProc | 973-997 | I | |
| CM340A | 122 | CDD_AdcDiagc.c | Adc0StBasdProc | 973-997 | I | |
| CM340A | 130 | CDD_AdcDiagc.c | Adc1StBasdProc | 1095-1119 | I | |
| CM340A | 215 | CDD_AdcDiagc.c | SetAdcParFlt | 1362-1382 | I | 


