This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - RamMem_IntegrationManual
Integration Manual
For
RamMem
VERSION: 1.0
DATE: 01-Nov-2017
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
| # | Description | Author | Version | Date |
| 1 | Initial version | Shruthi Raghavan | 1.0 | 01-Nov-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 | Integration Manual Template | 1.3 |
| 2 | EA4 Software Naming Conventions | 01.01.00 |
| 3 | Software Design and Coding Standards | 2.1 |
| 4 | Functional Design Document : CM103B_RamMem_Design | See Synergy SubProject Version |
Dependencies
SWCs
| Module | Required Feature |
| Os.h | SuspendAllInterrupts(), ResumeAllInterrupts() |
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
RamMemLclRamSngBitEcc
RamMemGlbRamSngBitEcc
Configuration REQUIREMeNTS
Build Time Config
| Modules | Notes | |
| None |
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
Refer FDD m file.
Required Global Data Outputs
Refer FDD m file.
Specific Include Path present
Yes
Runnable Scheduling
This section specifies the required runnable scheduling.
| Init | Scheduling Requirements | Trigger |
| RamMemInit1 | Should be after DiagcMgr Initialization. | RTE(Init) |
| Runnable | Scheduling Requirements | Trigger |
| RamMemPer1 | None | RTE(2 ms) |
Memory Map REQUIREMENTS
Mapping
| Memory Section | Contents | Notes |
| CDD_RamMem_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
None
Optimization Settings
None
Appendix
None
2 - RamMem_MDD
Module Design Document
For
RamMem
Oct 23, 2017
Prepared By:
Shruthi Raghavan,
Nexteer Automotive,
Saginaw, MI, USA
Change History
| Description | Author | Version | Date |
| Initial Version | Shruthi Raghavan | 1.0 | 23-Oct-2017 |
Table of Contents
2 RamMem & High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of RamMem 7
4.1 Program (fixed) Constants 8
5 Software Component Implementation 10
5.3.1 RamMemLclRamSngBitEcc 10
5.3.2 RamMemGlbRamSngBitEcc 10
5.4 Module Internal (Local) Functions 10
5.5 GLOBAL Function/Macro Definitions 11
6 Known Limitations with Design 12
Appendix A Abbreviations and Acronyms 14
Introduction
Purpose
Module Design Document for Implementation details of RamMem component from CM103B FDD.
RamMem & High-Level Description
Diagnostics related to RAM memory - Local, periperal and I-Cache.
Design details of software module
Graphical representation of RamMem

Data Flow Diagram
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 |
|---|---|---|---|
| LCLRAMSNGBITCNTRMAX_CNT_U08 | uint8 | Cnt | 100U |
| GLBRAMSNGBITCNTRMAX_CNT_U08 | uint8 | Cnt | 100U |
| PRPHLRAMSNGBITECCRDACSERRDETD_CNT_U32 | uint32 | Cnt | 0x00000002U |
| PRPHLRAMSNGBITECCERRADDRSAVED_CNT_U32 | uint32 | Cnt | 0x00010000U |
| PRPHLRAMSNGBITECCERRDETDFLGCLRMSK_CNT_U32 | uint32 | Cnt | 0X00000200U |
| PRPHLRAMDBLBITECCRDACSERRDETD_CNT_U32 | uint32 | Cnt | 0x00000004U |
| PRPHLRAMDBLBITECCERRADDRSAVED_CNT_U32 | uint32 | Cnt | 0x00020000U |
| PRPHLRAMDBLBITECCERRDETDFLGCLRMSK_CNT_U32 | uint32 | Cnt | 0X00000400U |
| DTSRAMSNGBITECCRDACSERRDETD_CNT_U32 | uint32 | Cnt | 0X00008000U |
| DTSRAMSNGBITECCERRADRMSK_CNT_U32 | uint32 | Cnt | 0X00000FFFU |
| DTSRAMSNGBITECCERRDETDFLGCLRMSK_CNT_U32 | uint32 | Cnt | 0X00008000U |
| INSTRCACHEBNK0SNGBITECCERRDETD_CNT_U32 | uint32 | Cnt | 0x00000001U |
| INSTRCACHEBNK1SNGBITECCERRDETD_CNT_U32 | uint32 | Cnt | 0x00000100U |
| INSTRCACHEBNK0DBLBITECCERRDETD_CNT_U32 | uint32 | Cnt | 0x00000002U |
| INSTRCACHEBNK1DBLBITECCERRDETD_CNT_U32 | uint32 | Cnt | 0x00000200U |
| INSTRCACHESNGBITECCFLGCLRMSK_CNT_U32 | uint32 | Cnt | 0X00000003U |
| INSTRCACHEDBLBITECCFLGCLRMSK_CNT_U32 | uint32 | Cnt | 0X00000003U |
| INSTRCACHEECCFLTECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x00040000U |
| CSIHRAMECCDBLBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x00200000U |
| MCANRAMECCDBLBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x00400000U |
| FRRAMECCDBLBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x01000000U |
| GTMRAMECCDBLBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x02000000U |
| DTSRAMECCSNGBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x00000200U |
| CSIHRAMECCSNGBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x00200000U |
| MCANRAMECCSNGBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x00400000U |
| FRRAMECCSNGBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x01000000U |
| GTMRAMECCSNGBITECMCLRMSK_CNT_U32 | uint32 | Cnt | 0x02000000U |
| LCLRAMECCSNGBITSOFTFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x01U |
| GLBRAMECCSNGBITSOFTFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x02U |
| INSTRCACHEECCFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x04U |
| DTSRAMECCSNGBITFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x08U |
| MCANRAMECCSNGBITFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x10U |
| FRRAMECCSNGBITFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x20U |
| CSIHRAMECCSNGBITFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x40U |
| GTMRAMECCSNGBITFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x80U |
| CSIHRAMECCDBLBITFLTPRMBYTE_CNT_U08 | uint8 | Cnt | 0x02U |
| MTTCANRAMDBLBITECCERRPRMBYTE_CNT_U08 | uint8 | Cnt | 0x02U |
| MCAN0RAMDBLBITECCERRPRMBYTE_CNT_U08 | uint8 | Cnt | 0x08U |
| MCAN1RAMDBLBITECCERRPRMBYTE_CNT_U08 | uint8 | Cnt | 0x20U |
| FRMRAMDBLBITECCERRPRMBYTE_CNT_U08 | uint8 | Cnt | 0x02U |
| FRTBUFADBLBITECCERRPRMBYTE_CNT_U08 | uint8 | Cnt | 0x08U |
| FRTBUFBDBLBITECCERRPRMBYTE_CNT_U08 | uint8 | Cnt | 0x20U |
| LCLRAMWORDLINERDADROFFS_CNT_U32 | uint32 | Cnt | 0x00000010U |
| LCLRAMWORDLINEADRMSK_CNT_U32 | uint32 | Cnt | 0xFFFFFF8FU |
| GLBRAMWORDLINERDADROFFS_CNT_U32 | uint32 | Cnt | 0x00000008U |
| GLBRAMWORDLINEADRMSK_CNT_U32 | uint32 | Cnt | 0xFFFFFFC7U |
| LCLRAMECCSEDECMFLGCLRMASK_CNT_U32 | uint32 | Cnt | 0x00010000U |
| GLBRAMECCSEDECMFLGCLRMASK_CNT_U32 | uint32 | Cnt | 0x00020000U |
| LCLRAMBASADR_CNT_U32 | uint32 | Cnt | 0xFEBE0000U |
| LCLRAMSEDERRBASADRBNK0_CNT_U32 | uint32 | Cnt | 0xFEBC0000U |
| LCLRAMSEDERRBASADRBNK1_CNT_U32 | uint32 | Cnt | 0xFEBC0004U |
| LCLRAMSEDERRBASADRBNK2_CNT_U32 | uint32 | Cnt | 0xFEBC0008U |
| LCLRAMSEDERRBASADRBNK3_CNT_U32 | uint32 | Cnt | 0xFEBC000CU |
| GLBRAMBASADR_CNT_U32 | uint32 | Cnt | 0xFEED8000U |
| GLBRAMSEDERRBASADR_CNT_U32 | uint32 | Cnt | 0xFEE00000U |
| GLBRAMSEDERRADRSTRT_CNT_U32 | uint32 | Cnt | 0xFFC64040U |
| LCLRAMBNK0SEDERRADRSTRT_CNT_U32 | uint32 | Cnt | 0xFFC65460U |
| LCLRAMBNK1SEDERRADRSTRT_CNT_U32 | uint32 | Cnt | 0xFFC65464U |
| LCLRAMBNK2SEDERRADRSTRT_CNT_U32 | uint32 | Cnt | 0xFFC65468U |
| LCLRAMBNK3SEDERRADRSTRT_CNT_U32 | uint32 | Cnt | 0xFFC6546CU |
| SIZEOFRAMSNGBITECCERRADRREG_CNT_U08 | uint8 | Cnt | 4U |
| NROFGLBRAMSEDERRADRREG_CNT_U08 | uint8 | Cnt | 32U |
| NROFRAMADRINWORDLINE_CNT_U08 | uint8 | Cnt | 8U |
| NROFLCLRAMSEGPERBNK_CNT_U08 | uint8 | Cnt | 8U |
| NROFLCLRAMMEMBNK_CNT_U08 | uint8 | Cnt | 4U |
| LCLRAMBNKLOGLADROFFS_CNT_U32 | uint32 | Cnt | 4U |
| LCLRAMBNK0SNGBITERRMONREGMASK_CNT_U32 | uint32 | Cnt | 0x11111111U |
| LCLRAMBNK1SNGBITERRMONREGMASK_CNT_U32 | uint32 | Cnt | 0x22222222U |
| LCLRAMBNK2SNGBITERRMONREGMASK_CNT_U32 | uint32 | Cnt | 0x44444444U |
| LCLRAMBNK3SNGBITERRMONREGMASK_CNT_U32 | uint32 | Cnt | 0x88888888U |
| LCLRAMWORDLINERDADROFFS_CNT_U32 | uint32 | Cnt | 0x00000010U |
| LCLRAMWORDLINEADRMASK_CNT_U32 | uint32 | Cnt | 0xFFFFFF8FU |
| GLBRAMWORDLINERDADROFFS_CNT_U32 | uint32 | Cnt | 0x00000008U |
| GLBRAMWORDLINEADRMASK_CNT_U32 | uint32 | Cnt | 0xFFFFFFC7U |
Software Component Implementation
Sub-Module Functions
Init: RamMemInit1
Design Rationale
Refer FDD document.
Per: RamMemPer1
Design Rationale
Refer FDD document.
Server Runables
None
Interrupt Functions
RamMemLclRamSngBitEcc
Design Rationale
Refer to the FDD document.
RamMemGlbRamSngBitEcc
Design Rationale
Refer to the FDD document.
Module Internal (Local) Functions
Local Function #1
| Function Name | SpiEccErrChkAndHndlg | Type | Min | Max |
| Arguments Passed | None | - | - | - |
| Return Value | N/A | - | - | - |
Design Rationale
Handles RAM single and double bit ECC error checking for Spi peripheral [CSIH0-3].
Called from the periodic runnable RamMemPer1
Local Function #2
| Function Name | MCanEccErrChkAndHndlg | Type | Min | Max |
| Arguments Passed | None | - | - | - |
| Return Value | N/A | - | - | - |
Design Rationale
Handles RAM single and double bit ECC error checking for MCAN peripheral [MTTCAN,MCAN0 and MCAN1].
Called from the periodic runnable RamMemPer1
Local Function #3
| Function Name | FrEccErrChkAndHndlg | Type | Min | Max |
| Arguments Passed | None | - | - | - |
| Return Value | N/A | - | - | - |
Design Rationale
Handles RAM single and double bit ECC error checking for FlexRay peripheral [MRAM,TBF A,TBF B].
Called from the periodic runnable RamMemPer1
Local Function #4
| Function Name | GtmRamEccErrChkAndHndlg | Type | Min | Max |
| Arguments Passed | None | - | - | - |
| Return Value | N/A | - | - | - |
Design Rationale
Handles RAM single bit ECC error checking for GTM peripheral..
Called from the periodic runnable RamMemPer1
Local Function #4
| Function Name | RamFailrModClassnChk | Type | Min | Max |
| Arguments Passed | LclRamFailrAdr_Cnt_T_u32 | uint32 | 0 | 4294967295 |
| ErrClrMask_Cnt_T_u32 | uint32 | 0 | 4294967295 | |
| Return Value | N/A | - | - | - |
Design Rationale
None
GLOBAL Function/Macro Definitions
GLOBAL Function #1
| Function Name | None. | Type | Min | Max |
| Arguments Passed | - | - | - | - |
| Return Value | - | - | - | - |
Design Rationale
N/A
Known Limitations with Design
Design updates dRamMemFrRamTmpBufBDblBitEccErrAdr and dRamMemFrRamTmpBufADblBitEccErrAdr in the wrong places. They should be intercahnged. Corrected in code.
The NTC parameter bytes are also interchanged for the above.
UNIT TEST CONSIDERATION
Register file definitions are in the P1Xc/include folder of AR202A since this component is designed for P1X-c micro.
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 | v1.3.0 R4.0 Rev 2 |
| 2 | MDD Guideline | EA4 01.00.01 |
| 3 | Software Naming Conventions.doc | 01.01.00 |
| 4 | Software Design and Coding Standards.doc | 2.1 |
| 5 | Functional Design Document: CM103B_RamMem_Design | See Synergy SubProject Version |
3 - RamMem_PeerReviewChecklist
Overview
Summary SheetSynergy Project
Source Code
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_RamMemNonRte.c | Source File Revision: | 2 | |||||||||||||||||||||
| Header File Name: | CDD_RamMem.h | Header File Revision: | ||||||||||||||||||||||
| MDD Name: | RamMem_MDD.docx | Revision: | 1 | |||||||||||||||||||||
| FDD/SCIR/DSR/FDR/CM Name: | CM103B_RamMem_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 | 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 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. | 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 | Yes | Comments: | ||||||||||||||||||||||
| All other includes are actually needed. (System includes | N/A | Comments: | ||||||||||||||||||||||
| only allowed in Nexteer library components) | ||||||||||||||||||||||||
| Software Design and Coding Standards followed: | Version: 2.1 | |||||||||||||||||||||||
| Code comments are clear, correct, and adequate | N/A | 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 | Yes | Comments: | ||||||||||||||||||||||
| is per standard | updated to be in the right location | |||||||||||||||||||||||
| 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-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 | 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: | ||||||||||||||||||||||||
| Sandbox project manually updated for include path to point to P1Xc register headers in AR202A instead of those for P1m : Approved by Steven Horwath 11/15/2017 | ||||||||||||||||||||||||
| Update the version history : Done 11/22/2017 | ||||||||||||||||||||||||
| Change Owner: | Shruthi Raghavan | Review Date : | 11/22/17 | |||||||||||||||||||||
| Lead Peer Reviewer: | Brendon Binder | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | Xin Liu | |||||||||||||||||||||||