This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - DmaCfgAndUse_Design_Review
Overview
Summary SheetSynergy Project
Source Code
MDD
Integration Manual
PolySpace
Sheet 1: Summary Sheet

Sheet 2: Synergy Project
Sheet 3: Source Code
Rev 1.2 | 8-Jun-15 | |||||||||||||||||||||||
Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
Source File Name: | CDD_DmaCfgAndUse.c | Source File Revision: | 2 | |||||||||||||||||||||
Header File Name: | CDD_DmaCfgAndUse.h | Header File Revision: | ||||||||||||||||||||||
Module Design Document Name: | MDD Revision: | |||||||||||||||||||||||
FDD/SCIR/DSR/FDR/CMS Revision: | ||||||||||||||||||||||||
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 | N/A | Comments: | No Outputs | |||||||||||||||||||||
all outputs are initialized prior to being written | ||||||||||||||||||||||||
Requirements Tracability tags in code match the requirements tracability in the FDD | N/A | Comments: | No Taggs needed for EA4 | |||||||||||||||||||||
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 | Yes | 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 | No | Comments: | For Registers | |||||||||||||||||||||
"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 | Yes | 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 | Yes | Comments: | ||||||||||||||||||||||
null pointer if needed: [N70] | ||||||||||||||||||||||||
Component outputs are limited to the legal range | N/A | Comments: | No outputs to limit | |||||||||||||||||||||
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: | ||||||||||||||||||||||
for any FDD corrections needed | ||||||||||||||||||||||||
General Notes / Comments: | ||||||||||||||||||||||||
Change Owner: | Avinash James | Review Date : | 12/13/16 | |||||||||||||||||||||
Lead Peer Reviewer: | Selva Sengottaiyan | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
Other Reviewer(s): | ||||||||||||||||||||||||
Sheet 4: MDD
Sheet 5: Integration Manual
Sheet 6: PolySpace
2 - DmaCfgAndUse_Integration_Manual
Integration Manual
For
DmaCfgAndUse
VERSION: 2.0
DATE: 10-Dec-2016
Prepared By:
Avinash James
Location: The official version of this document is stored in the Nexteer Configuration Management System.
Revision History
Description | Author | Version | Date |
Initial version | Avinash James | 1.0 | 08-Nov-2016 |
Corrected the micro diag error injection defines | Avinash James | 2.0 | 10-Dec-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> | <MDD Guidelines> | Software Engineering Process 04.00.00 |
<2> | <Software Naming Conventions> | Software Engineering Process 04.00.00 and working EA4 naming conventions |
<3> | <Coding standards> | Software Engineering Process 04.00.00 |
<4> | <FDD > | See Synergy subproject version |
<Add if more available> |
Dependencies
SWCs
Module | Required Feature |
MotCtrlMgr | Generated struct type declarations for the Motor Control loop / RTE interface data; macros for access of Motor Control loop data |
GuardCfgAndDiagc | PEG and PBG settings to allow DMA transfers; CM200C_DmaCfgAndUse_Impl_1.0.0 or newer requires CM107A_GuardCfgAndDiagc_Impl_1.0.0 or newer. |
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
void DmaRegInin (void) - needs to be a trusted function
void InjDmaErr(void) - Inject DAM errors needed for error injection build
void InjMotCtrlTo2MilliSecTrfErr (void) - Inject NTC 2B Errors needed for error injection build
Configuration REQUIREMeNTS
Build Time Config
Modules | Notes | |
MCUDIAGCERRINJ | STD_OFF for other builds STD_ON for uDiag test builds |
Configuration Files to be provided by Integration Project
None
Da Vinci Parameter Configuration Changes
Parameter | Notes | SWC |
<Configurator Changes for parameters> |
DaVinci Interrupt Configuration Changes
ISR Name | VIM # | Priority Dependency | Notes |
<Configurator Changes for Interrupts> |
Manual Configuration Changes
Constant | Notes | SWC |
<Additional configuration changes> |
Integration DATAFLOW REQUIREMENTS
Required Global Data Inputs
See DataDict.m file
Required Global Data Outputs
See DataDict.m file
Specific Include Path present
Yes
Runnable Scheduling
This section specifies the required runnable scheduling.
Init | Scheduling Requirements | Trigger |
DmaCfgAndUseInit1 | None | RTE Init |
Runnable | Scheduling Requirements | Trigger |
DmaCfgAndUsePer1 | Per FDD:” - Execution order of "DmaCfgAndUsePer1" shall schedule start of forward path (as soon as possible start of 2ms)” | RTE 2 ms |
DmaWaitForMotCtrlTo2MilliSecTrf_Oper | N/A | On invocation of DmaWaitForMotCtrlTo2MilliSecTrf.Oper |
DmaEna2MilliSecToMotCtrlTrf_Oper | N/A | On invocation of DmaEna2MilliSecToMotCtrlTrf.Oper |
InjDmaErr | N/A | On invocation of InjDmaErr only when MCUDIAGCERRINJ is STD_ON |
InjMcuDiagcErr | N/A | On invocation of InjMcuDiagcErr only when MCUDIAGCERRINJ is STD_ON |
Memory Map REQUIREMENTS
Mapping
Memory Section | Contents | Notes |
CDD_DmaCfgAndUse_START_SEC_CODE | ||
* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.
Usage
Feature | RAM | ROM |
<Memmap usuage info> |
Table 1: ARM Cortex R4 Memory Usage
NvM Blocks
None
Compiler Settings
Preprocessor MACRO
<Define all the preprocessor Macros needed and conditions when needed>.
Optimization Settings
<Define Optimization levels that are needed and conditions when needed>.
Appendix
<This section is for appendix>
3 - DmaCfgAndUse_MDD
Module Design Document
For
DmaCfgAndUse
VERSION: 2.0
DATE: 10-Dec-2016
Prepared By:
Avinash James
Location: The official version of this document is stored in the Nexteer Configuration Management System.
Revision History
Description | Author | Version | Date |
Initial Version | Avinash James | 1.0 | 08-Nov-2016 |
Corrected server runnable name | Avinash James | 2.0 | 10-Dec-2016 |
Table of Contents
3 DmaCfgAndUse High-Level Description 7
4 Design details of software module 8
4.1 Graphical representation of DmaCfgAndUse 8
5.1 User defined typedef definition/declaration 9
5.2 Variable definition for enumerated types 9
6.1 Program(fixed) Constants 10
6.1.2 Module specific Lookup Tables Constants 10
7 Software Module Implementation 11
7.2 Initialization Functions 11
7.2.1 Init: DmaCfgAndUseInit1 11
7.3.1 Per: DmaCfgAndUsePer1 11
7.3.1.2 Store Module Inputs to Local copies 11
7.3.1.3 (Processing of function)……… 11
7.3.1.4 Store Local copy of outputs into Module Outputs 11
7.4.1 NONPer: DmaEna2MilliSecToMotCtrlTrf_Oper 12
7.4.1.2 Store Module Inputs to Local copies 12
7.4.1.3 (Processing of function)……… 12
7.4.1.4 Store Local copy of outputs into Module Outputs 12
7.4.2 NONPer: DmaWaitForMotCtrlTo2MilliSecTrf_Oper 12
7.4.2.2 Store Module Inputs to Local copies 12
7.4.2.3 (Processing of function)……… 12
7.4.2.4 Store Local copy of outputs into Module Outputs 12
7.4.3 NONPer: InjDmaErr_Oper 12
7.4.3.2 Store Module Inputs to Local copies 12
7.4.3.3 (Processing of function)……… 12
7.4.3.4 Store Local copy of outputs into Module Outputs 12
7.4.4 NONPer: InjMotCtrlTo2MilliSecTrfErr_Oper 12
7.4.4.2 Store Module Inputs to Local copies 13
7.4.4.3 (Processing of function)……… 13
7.4.4.4 Store Local copy of outputs into Module Outputs 13
7.6 Serial Communication Functions 14
7.7 Local Function/Macro Definitions 14
7.8 GLObAL Function/Macro Definitions 14
9 Known Limitations With Design 16
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> | <MDD Guidelines> | Software Engineering Process 04.00.00 |
<2> | <Software Naming Conventions> | Software Engineering Process 04.00.00 and working EA4 naming conventions |
<3> | <Coding standards> | Software Engineering Process 04.00.00 |
<4> | <FDD > | See Synergy subproject version |
<Add if more available> |
DmaCfgAndUse High-Level Description
DMA Configuration and Usage (DmaCfgAndUse) sets up the initial DMA configuration and defines the periodic and server runnable functionality needed for DMA transfers of ADC and Motor Control loop/RTE interface data.
Design details of software module
See FDD.
Graphical representation of DmaCfgAndUse
Data Flow Diagram
See FDD.
Module level DFD
See FDD.
Sub-Module level DFD
See FDD.
COMPONENT FLOW DIAGRAM
NA
Variable Data Dictionary
User defined typedef definition/declaration
<This section documents any user types uniquely used for the module.>
Typedef Name | Element Name | User Defined Type | Legal Range (min) | Legal Range (max) |
MotCtrlFromTwoMilliSecRec1 | Generated in MotCtrlMgr component | N/A | N/A | N/A |
TwoMilliSecToMotCtrlRec1 | Generated in MotCtrlMgr component | N/A | N/A | N/A |
MotCtrlToTwoMilliSecRec1 | Generated in MotCtrlMgr component | N/A | N/A | N/A |
TwoMilliSecFromMotCtrlRec1 | Generated in MotCtrlMgr component | N/A | N/A | N/A |
Variable definition for enumerated types
Enum Name | Element Name | Value |
<(Name given for the user defined typdef of type struct/union) (Variable name qualified in refer[2])> | <(Variable name qualified Refer[2])> | <Define the value > |
Constant Data Dictionary
Program(fixed) Constants
Embedded Constants
< All program specific constants will be defined in detail >
Local
Constant Name | Resolution | Units | Value |
CPU1PEID_CNT_U32 | 1 | Counts | 1 |
PRPHLTOLCLRAMSPID_CNT_U32 | 1 | Counts | 3 |
LCLRAMTOPRPHLSPID_CNT_U32 | 1 | Counts | 2 |
LCLRAMTOLCLRAMSPID_CNT_U32 | 1 | Counts | 0 |
USRMODENA_CNT_U32 | 1 | Counts | 1 |
USRMODDI_CNT_U32 | 1 | Counts | 0 |
MAXWAIT_MICROSEC_U32 | 1 | MicroSec | 400 |
INIZERO_CNT_U32 | 1 | Counts | 0 |
ERRID2BBIT0CASE1_CNT_U32 | 1 | Counts | 0x002B0101U |
ERRID36BIT0CASE1_CNT_U32 | 1 | Counts | 0x00360101U |
ERRID36BIT1CASE1_CNT_U32 | 1 | Counts | 0x00360201U |
Also see FDD DataDict.m file |
Global
<This section lists the global constants used by the module. For details on global constants, refer to the Data Dictionary for the application>
Constant Name |
See FDD DataDict.m file |
Module specific Lookup Tables Constants
<(This is for lookup tables (arrays) with fixed values, same name as other tables)>
Constant Name | Resolution | Value | Software Segment |
<Refer Constant name qualified in [2]> | <Refer MDD guidelines [1]> | <Refer MDD guidelines [1]> | <Refer MDD guidelines [1]> |
Software Module Implementation
Sub-Module Functions
<(Note: For multiple functions, insert new headers at the “Header 2” level – subset of “ Sub Module Function section above” and follow the same sub-section design shown below . If none required, place the text “None”))>
Initialization Functions
<(Note: For multiple init functions, insert new headers at the “Header 2” level – subset of “ Initialization Function section above” and follow the same sub-section design shown below . If none required, place the text “None”))>
Init: DmaCfgAndUseInit1
Design Rationale
The DMACnnCM channel master registers can be written only in supervisor mode. After the Channel master register for a given channel has been written, the selected Processor Element can write to that channel’s registers in user mode. However, for simplicity, all DMA register initialization is being done in one trusted function. Therefore, only the Per Instance Memory initialization is done directly in the DmaCfgAndUseInit1 function; all DMA register initialization is done in the DmaRegInin function called by DmaCfgAndUseInit1.
Module Outputs
See FDD.
PERIODIC FUNCTIONS
(Note: For multiple periodic functions, insert new headers at the “Header 2” level – subset of “7.3 Periodic Functions” and follow the same sub-section design shown below). If none required, place the text “None”)>
Per: DmaCfgAndUsePer1
Design Rationale
None
Store Module Inputs to Local copies
None
(Processing of function)………
See FDD.
Store Local copy of outputs into Module Outputs
None
Server RUNNABLE FUNCTIONS
DmaEna2MilliSecToMotCtrlTrf_Oper
Design Rationale
None
Store Module Inputs to Local copies
None
(Processing of function)………
See FDD
Store Local copy of outputs into Module Outputs
None
DmaWaitForMotCtrlTo2MilliSecTrf_Oper
Design Rationale
None
Store Module Inputs to Local copies
None
(Processing of function)………
See FDD
Store Local copy of outputs into Module Outputs
None
InjDmaErr
Design Rationale
None
Store Module Inputs to Local copies
None
(Processing of function)………
See FDD
Store Local copy of outputs into Module Outputs
None
InjMcuDiagcErr
Design Rationale
None
Store Module Inputs to Local copies
None
(Processing of function)………
See FDD
Store Local copy of outputs into Module Outputs
None
Interrupt Functions
None
Serial Communication Functions
None
Local Function/Macro Definitions
None
GLObAL Function/Macro Definitions
<If these are numerous and defined in a separate source file then reference the source file only.>
GLObAL Function #1
Function Name | DmaRegInin | Type | Min | Max |
Arguments Passed | None | |||
Return Value | N/A |
Description
Trusted function that performs all register initialization from the CM200C_DmaCfgAndUse_PeripheralCfg.xlsx spreadsheet in the FDD. The DMACnnCM channel master registers can be written only in supervisor mode. After the Channel master register for a given channel has been written, the selected Processor Element can write to that channel’s registers in user mode. However, for simplicity, all DMA register initialization is being done in one trusted function. For timing optimization, register level initialization is used (rather than bit field modifications of the register fields).
TRANSIENT FUNCTIONS
None
Unit Test Considerations
None
Known Limitations With Design
There is a deviation from the coding standards for use of display variables which are used only for storing values needed for test purpose. However we have used display variable to compare with a measured parameter and assign value to the diplay variable based on the comparison. This deviation is okay as creating an additional per instance memory for this purpose is redundant and hence have deviated from the coding standards
Appendix
<This section is for appendix>