1 - EcmOutpAndDiagc_IntegrationManual

Integration Manual

For

EcmOutpAndDiagc

VERSION: 2.0

DATE: 06-Feb-2018

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

DescriptionAuthorVersionDate
Initial versionShruthi Raghavan1.014-Nov-2017
Implement fixes for anomaly EA4#19053Shruthi Raghavan2.006-Feb-2017

Table of Contents

1 Abbrevations And Acronyms 4

2 References 5

3 Dependencies 6

3.1 SWCs 6

3.2 Global Functions(Non RTE) to be provided to Integration Project 6

4 Configuration REQUIREMeNTS 7

4.1 Build Time Config 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

6 Runnable Scheduling 9

7 Memory Map REQUIREMENTS 10

7.1 Mapping 10

7.2 Usage 10

7.3 NvM Blocks 10

8 Compiler Settings 11

8.1 Preprocessor MACRO 11

8.2 Optimization Settings 11

9 Appendix 12

Abbrevations And Acronyms

AbbreviationDescription
DFDDesign functional diagram
MDDModule design Document

References

This section lists the title & version of all the documents that are referred for development of this document

Sr. No.TitleVersion
1Software Naming Conventions2.01
2Software Design and Coding standards2.01
3CM104B_EcmOutpAndDiagc_DesignSee Synergy subproject version

Dependencies

SWCs

ModuleRequired Feature
CDD_ExcpnHndlgP1mcDiagc type, SetMcuDiagcIdnData, GetMcuDiagcIdnData definitions.
Os.hSuspend and Resume interrupt calls.
Mcu.hNeeded for Mcu_EcmReleaseErrorOutPin() API called from CtrlErrOut_Oper

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

EcmOutpAndDiagcInit1

EcmOutpAndDiagcInit3

CtrlErrOut_Oper

Configuration REQUIREMeNTS

Build Time Config

ModulesNotes
None

Configuration Files to be provided by Integration Project

None

Da Vinci Parameter Configuration Changes

ParameterNotesSWC
None

DaVinci Interrupt Configuration Changes

ISR NameVIM #Priority DependencyNotes
-

Manual Configuration Changes

ConstantNotesSWC
None

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Refer FDD

Required Global Data Outputs

Refer FDD

Specific Include Path present

Yes

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
EcmOutpAndDiagcInit1Pre-OsNon-RTE (Init)
EcmOutpAndDiagcInit2NoneRTE(Init)
EcmOutpAndDiagcInit3Pre-OsNon-RTE (Init)
RunnableScheduling RequirementsTrigger
CtrlErrOut_Oper1NoneOn Invocation

1 : Using the Mcal Api (Mcu_EcmReleaseErrorOutPin) call creates a dependency on the Mcal. We assume that Mcal Api does not write to any static RAM – this assumption must be revalidated everytime that there is a change/update to the MCAL

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
CDD_EcmOutpAndDiagc_START_SEC_CODE

* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.

Usage

FeatureRAMROM
None

Table 1: ARM Cortex R4 Memory Usage

NvM Blocks

None

Compiler Settings

Preprocessor MACRO

None

Optimization Settings

None

Appendix

None

2 - EcmOutpAndDiagc_MDD

Module Design Document

For

EcmOutpAndDiagc

Feb 07, 2018

Prepared By:

Shruthi Raghavan,

Nexteer Automotive,

Saginaw, MI, USA
Change History

DescriptionAuthorVersionDate
Initial VersionShruthi Raghavan1.015-Nov-2017
Removed local constant that was removed from NonRte fileShruthi Raghavan2.007-Feb-2018


Table of Contents

1 Introduction 4

1.1 Purpose 4

2 EcmOutpAndDiagc & High-Level Description 5

3 Design details of software module 6

3.1 Graphical representation of EcmOutpAndDiagc 6

3.2 Data Flow Diagram 6

3.2.1 Component level DFD 6

3.2.2 Function level DFD 6

4 Constant Data Dictionary 7

4.1 Program (fixed) Constants 7

4.1.1 Embedded Constants 7

5 Software Component Implementation 8

5.1 Sub-Module Functions 8

5.1.1 Init: EcmOutpAndDiagcInit1 8

5.1.1.1 Design Rationale 8

5.1.2 Init: EcmOutpAndDiagcInit3 8

5.1.2.1 Design Rationale 8

5.1.3 Periodic 8

5.2 Server Runables 8

5.2.1 CtrlErrOut_Oper 8

5.2.1.1 Design Rationale 8

5.3 Interrupt Functions 8

5.4 Module Internal (Local) Functions 8

5.4.1 Local Function #1 8

5.5 GLOBAL Function/Macro Definitions 8

6 Known Limitations with Design 9

7 UNIT TEST CONSIDERATION 10

Appendix A Abbreviations and Acronyms 11

Appendix B Glossary 12

Appendix C References 13

Introduction

Purpose

Module Design Document for Implementation of EcmOutpAndDiagc design for P1Mc processor based projects.

EcmOutpAndDiagc & High-Level Description

Refer FDD.

Design details of software module

Graphical representation of EcmOutpAndDiagc

Data Flow Diagram

Component level DFD

Refer FDD

Function level DFD

Refer FDD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant NameResolutionUnitsValue
ECMERROUTZPINSTSREGMASK_CNT_U321Cnt0x80000000U
ECMERROUTZPINCOMPERRMASK_CNT_U321Cnt0x40000000U
ERROUTPCLRINVLDREGCMPWBITMASK_CNT_U321Cnt0x00010000U
ECMCOMPERRBITMASK_CNT_U321Cnt0x10000000U
FLASHAPPLCMDIFECMERRMASK_CNT_U321Cnt0x00080000U
NROFCOMPERRSRCSETATMPTS_CNT_U081Cnt3U
FEINTRPTREQFLGBITMASK_CNT_U321Cnt0x00001000U
FEINTRPTEVESRCECMBITMASK_CNT_U321Cnt0x00000002U
ECMERRSETTRIGREGSTSCLRMASK_CNT_U321Cnt0x40000000U

Software Component Implementation

Sub-Module Functions

Init: EcmOutpAndDiagcInit1

Design Rationale

None

Init: EcmOutpAndDiagcInit3

Design Rationale

None

Periodic

None

Server Runables

CtrlErrOut_Oper

Design Rationale

The TrigReg1 enumeration type is given the type qualifier of EcmOutpAndDiagc so it is not generated in the RTE headers. The header in the include folder contains the typedef for this enum because it is not expected to be needed outside the context of this component (or server runnable call).

Interrupt Functions

None

Module Internal (Local) Functions

Local Function #1

Function Name-TypeMinMax
Arguments Passed----
Return Value----

GLOBAL Function/Macro Definitions

None

Known Limitations with Design

None.

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 AcronymDescription
EIException Interrupt

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

TermDefinitionSource
MDDModule Design Document
DFDData Flow Diagram

References

Ref. #TitleVersion
1AUTOSAR Specification of Memory Mappingv1.3.0 R4.0 Rev 2
2MDD GuidelineEA4 01.00.01
3Software Naming Conventions.doc1.02
4Software Design and Coding Standards.doc2.01
5FDD : CM104B_EcmOutpAndDiagc_DesignSee Synergy Subproject Ver.

3 - EcmOutpAndDiagc_PeerReviewChecklist
























Rev 2.0029-Nov-17

Nexteer SWC Implementation Peer Review Summary Sheet


























Component Short Name:


Windows User: Intended Use: Identify which component is being reviewed. This should match the component short name from the DataDict.m fileand the middle part of the Synergy project name, e.g. Assi for the SF001A_Assi_Impl Synergy project
EcmOutpAndDiagc
Revision / Baseline:

Windows User: Intended Use: Identify the implementation baseline name intended to be used for the changed component when changes are approved E.g. SF001A_Assi_Impl_1.2.0
CM104B_EcmOutpAndDiagc_Impl_1.3.0

























Change Owner:
Windows User: Intended Use: Identify the developer who made the change(s) being reviewed

Avinash James
Work CR ID:
Windows User: Intended Use: Identify the Implementation Work CR whose work is being reviewed (may be more than one)

EA4#21605





























kzshz2: Intended Use: Intended to identify at a high level to the reviewers which areas of the component have been changed. Rationale: This will be good information to know when ensuring appropriate reviews have been completed. Modified File Types:



Check the file types that needed modification for the Work CR(s); macros for the check boxes will populate the appropriate checklist tabs for the review.
























































































































































kzshz2: Intended Use: Identify who where the reviewers, what they reviewed, and if the reviewed changes have been approved to release the code for testing. Comments here should be at a highlevel, the specific comments should be present on the specific review form sheet. Rationale: Since this Form will be attached to the Change Request it will confirm the approval and provides feedback in case of audits. ADD DR Level Move reviewer and approval to individual checklist form Review Checklist Summary:






























Reviewed:




At start of review, all items below should be marked "No". At the end of the review, all items should be marked "Yes" or "N/A" where N/A indicates the reviewers have reviewed the existing (unchanged) item and confirmed no updates were needed for the Work CR(s).












































N/AMDD


N/ASource Code


N/APolySpace









































N/AIntegration Manual


N/ADavinci Files








































































Comments:

This is a PSR version of the changes proposed in CM104B. The changes in the design are not yet done.






Hence the baseline does not include the design sub project. Due to timing constraints not following the formal






review process.Tested the PSR. Approved deviaition by Lonnie Newton



















































































General Guidelines:
- The reviews shall be performed over the portions of the component that were modified as a result of the Change Request.
- New components should include SWC Owner and/or SWC Design author and Integrator and/or SW Lead as apart of the Group Review Board (Source Code, Integration Manual, and Davinci Files)
- Enter any rework required into the comment field and select No. When the rework is complete, review again using this same review sheet and select Yes. Add date and additional comment stating that the rework is completed.
- To review a component with multiple source code files use the "Add Source" button to create a Source code tab for each source file.
- .h file should be reviewed with the source file as part of the source file.

Each peer review shall start with a clean copy of the latest peer review checklist template. Before the peer review, the change owner shall:
o Review the previous component peer review and copy any relevant comments to the new review sheet.
o Review all checklist items and make all corrections needed, so that the component is ready for peer review. The expectation is that peer review should find very few issues,
because the change owner has already used the checklist to ensure the component changes are complete and correct.
o Fill in all file name and version information as needed on peer review checklist tabs (file names may be copied from the previous peer review where appropriate)
o Fill in checklist answers (Yes/No/NA pulldowns) ONLY on those items which are NA for the current change. All other checklist items should be blank going into the review
meeting.

During the peer review meeting:
o For each page of the review, first review the items already marked as N/A for this change, to confirm that reviewers agree with this assessment; change the checklist box to
blank if it is found that the item does apply.
o Then review the items with the checklist box blank. After reviewing each of these items, the checklist box will be marked as "Yes", or the checklist box will be marked as
"No" with needed rework indicated or with rationale indicated.
o If any items are marked "No" with rationale indicated, this must be approved by a software supervisor or the software manager; there is a line in the "Review Board" section
of each tab to indicate who approved the "No" items on that tab.