1 - PwrSply_IntegrationManual

Integration Manual

For

PwrSply

VERSION: 2.0

DATE: 04-April-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.DescriptionAuthorVersionDate
1Initial versionRijvi Ahmed1.015-Sep-2015
2Updated per design rev. 1.4.0Rijvi Ahmed2.004_April-2016

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
FDDFunctional Design Document

References

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

Sr. No.TitleVersion
1FDD – ES008A PwrSplySee Synergy subproject version
2Software Naming ConventionsProcess 04.02.01
3Software Coding StandardsProcess 04.02.01

Dependencies

SWCs

ModuleRequired Feature
Spi_Renesas_Ar4.0.3_01.05.00_0Refer CM600A_CSIG0CfgAndUse_Design
CM600A_CSIG0CfgAndUse_DesignChannel and Sequence definitions and API requirements.

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

None

Configuration REQUIREMeNTS

Build Time Config

ModulesNotes
None

Configuration Files to be provided by Integration Project

<Configuration file that will generated from this components that will require Da Vinci Config generation or manual generation. Describe each parameter >

Da Vinci Parameter Configuration Changes

ParameterNotesSWC
See CM600A_CSIG0CfgAndUse_Design requirements.

DaVinci Interrupt Configuration Changes

ISR NameVIM #Priority DependencyNotes
None

Manual Configuration Changes

ConstantNotesSWC
None

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Refer DataDict.m file

Required Global Data Outputs

Refer DataDict.m file

Specific Include Path present

No

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
PwrSplyInit1NoneRTE/Init
RunnableScheduling RequirementsTrigger
PwrSplyPer1NoneRTE ( 4ms )

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
None

* 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 - PwrSply_MDD

Module Design Document

For

PwrSply

April 04, 2016

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Software Group,

Nexteer Automotive,

Saginaw, MI, USAChange History

DescriptionAuthorVersionDate
Initial VersionRijvi Ahmed1.015-Sep-2015
Updated per design rev. 1.4.0Rijvi Ahmed2.004-April-2016

Table of Contents

1 Introduction 4

2 PwrSply & High-Level Description 5

3 Design details of software module 6

3.1 Graphical representation of PwrSply 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: PwrSplyInit1 8

5.1.1.1 Design Rationale 8

5.1.1.2 (Processing of function)……… 8

5.1.2 Per: PwrSplyPer1 8

5.1.2.1 Design Rationale 8

5.1.2.2 Store Module Inputs to Local copies 8

5.1.2.3 (Processing of function)……… 8

5.1.2.4 Store Local copy of outputs into Module Outputs 8

5.2 Server Runnable 8

5.3 Interrupt Functions 8

5.4 Module Internal (Local) Functions 9

5.5 GLOBAL Function/Macro Definitions 9

6 Known Limitations with Design 10

7 UNIT TEST CONSIDERATION 11

Appendix A Abbreviations and Acronyms 12

Appendix B Glossary 13

Appendix C References 15

Introduction

None

PwrSply & High-Level Description

None

Design details of software module

<The Data Flow Diagrams should be created in the absence of this representation with the FDD.>

Graphical representation of PwrSply

Data Flow Diagram

Component level DFD

Function level DFD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant NameResolutionUnitsValue
Refer to the DataDictionary of the design

Software Component Implementation

<The detailed design of the function is provided in the FDD. The detail design shall only be added to the MDD when it is not provided in the FDD or the FDD is not adequate and clarification is needed.>

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.

<(Note: For multiple init or per functions, insert new headers at the “Header 3” level – subset of “Sub-Module Functions section above” and follow the same sub-section design shown below . If none required, place the text “None”))>

Init: PwrSplyInit1

Design Rationale

None

(Processing of function)………

Refer to FDD.

Per: PwrSplyPer1

Design Rationale

None

Store Module Inputs to Local copies

Refer to FDD.

(Processing of function)………

Refer to FDD.

Store Local copy of outputs into Module Outputs

Refer to FDD.

Server Runnable

None

Interrupt Functions

None

Module Internal (Local) Functions

None

GLOBAL Function/Macro Definitions

None

Known Limitations with Design

None

UNIT TEST CONSIDERATION

None

Abbreviations and Acronyms

Abbreviation or AcronymDescription

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 Mapping (Link:AUTOSAR_SWS_MemoryMapping.pdf)v1.3.0 R4.0 Rev 2
2MDD GuidelineEA4 01.00.00
3Software Naming Conventions.doc1.0
4Software Design and Coding Standards.doc2.0
5FDD – ES008A PwrSplySee Synergy subproject version
6CM600A_CSIG0CfgAndUse_DesignSee the latest version in Synergy

3 - PwrSply_PeerReviewChecklist


Overview

Summary Sheet
Synergy Project


Sheet 1: Summary Sheet
























Rev 1.28-Jun-15

Peer Review Summary Sheet


























Synergy Project Name:


kzshz2: Intended Use: Identify which component is being reviewed. This should be the Module Short Name from Synergy Rationale: Required for traceability. It will help to ensure this form is not attaced to the the wrong change request. ES008A_PwrSply_Impl
Revision / Baseline:


kzshz2: Intended Use: Identify which Synergy revision of this component is being reviewed Rationale: Required for traceability. It will help to ensure this form is not attaced to the the wrong change request. 1.3.0

























Change Owner:


kzshz2: Intended Use: Identify the developer who made the change(s) Rationale: A change request may have more than one resolver, this will help identify who made what change. Change owner identification may be required by indusrty standards. Krishna Anne
Work CR ID:


EA4#7567





























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:















































































































































































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:































N/AMDD


N/ASource Code


N/APolySpace









































N/AIntegration Manual


N/ADavinci Files








































































Comments:

Only design update, no impl changes



























































































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 FDD Owner and Integrator 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.





















Sheet 2: Synergy Project

Peer Review Meeting Log (Component Synergy Project Review)



















































Quality Check Items:




































Rationale is required for all answers of No










New baseline version name from Summary Sheet follows








Yes
Comments:



naming convention





































Project contains necessary subprojects








Yes
Comments:










































Project contains the correct version of subprojects








Yes
Comments:










































Design subproject is correct version








Yes
Comments:











































General Notes / Comments:



























































LN: Intended Use: Identify who were the reviewers and if the reviewed changes have been approved. Rationale: Since this Form will be attached to the Change Request it will confirm the approval and provides feedback in case of audits. KMC: Group Review Level removed in Rev 4.0 since the design review is not checked in until approved, so it would always be DR4. Review Board:


























Change Owner:

Krishna Anne


Review Date :

09/13/16
































Lead Peer Reviewer:


Nick Saxton


Approved by Reviewer(s):



Yes































Other Reviewer(s):









































































4 - requirements

FDDIDSourceFunctionLine(s)StatusComment
.SwFileName.SwFuncName.SwLines.SwStatus.SwComment
ES008A133PwrSply.cPwrSplyPer1787I
ES008A132PwrSply.cPwrSplyPer1787I
ES008A131PwrSply.cPwrSplyPer1787I
ES008A130PwrSply.cPwrSplyPer1787I
ES008A137PwrSply.cPwrSplyPer1801I
ES008A136PwrSply.cPwrSplyPer1801I
ES008A135PwrSply.cPwrSplyPer1787I
ES008A134PwrSply.cPwrSplyPer1787I
ES008A139PwrSply.cPwrSplyPer1801I
ES008A138PwrSply.cPwrSplyPer1801I
ES008A100PwrSply.cPwrSplyPer1907-926I
ES008A24PwrSply.cPwrSplyPer1874-895I
ES008A27PwrSply.cPwrSplyPer1874-895I
ES008A22PwrSply.cPwrSplyPer1874-895I
ES008A28PwrSply.cPwrSplyPer1874-895I
ES008A94PwrSply.cPwrSplyPer1851-864I
ES008A104PwrSply.cPwrSplyPer1907-926I
ES008A101PwrSply.cPwrSplyPer1907-926I
ES008A9PwrSply.cPwrSplyPer1734I
ES008A140PwrSply.cPwrSplyPer1801I
ES008A141PwrSply.cPwrSplyPer1801I
ES008A99PwrSply.cPwrSplyPer1906-925I
ES008A98PwrSply.cPwrSplyPer1906-925I
ES008A108PwrSply.cPwrSplyPer1779-811I
ES008A74PwrSply.cPwrSplyPer1875-896I
ES008A124PwrSply.cPwrSplyPer1792I
ES008A125PwrSply.cPwrSplyPer1806I
ES008A71PwrSply.cPwrSplyPer1875-896I
ES008A70PwrSply.cPwrSplyPer1819-935I
ES008A128PwrSply.cPwrSplyPer1787I
ES008A129PwrSply.cPwrSplyPer1787I
ES008A93PwrSply.cPwrSplyPer1906-925I
ES008A92PwrSply.cPwrSplyPer1906-925I
ES008A95PwrSply.cPwrSplyPer1851-864I
ES008A107PwrSply.cPwrSplyPer1762-776I
ES008A97PwrSply.cPwrSplyPer1851-864I
ES008A96PwrSply.cPwrSplyPer1851-864I
ES008A91PwrSply.cPwrSplyPer1906-925I
ES008A15PwrSply.cPwrSplyPer1734-938I
ES008A18PwrSply.cPwrSplyPer1751I
ES008A30PwrSply.cPwrSplyPer1874-895I
ES008A35PwrSply.cPwrSplyPer1734-938I
ES008A73PwrSply.cPwrSplyPer1875-896I
ES008A103PwrSply.cPwrSplyPer1907-926I
ES008A102PwrSply.cPwrSplyPer1907-926I
ES008A90PwrSply.cPwrSplyPer1906-925I
ES008A72PwrSply.cPwrSplyPer1875-896I