1 - FordSysSt_IntegrationManual

Integration Manual

For

FordSysSt

VERSION: 1.0

DATE: 06-Dec-2017

Prepared By:

Shawn Penning,

Nexteer Automotive,

Saginaw, MI, USA

Revision History

Sl. No.DescriptionAuthorVersionDate
1Initial versionShawn Penning1.006-Dec-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
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
1MDD GuidelinesSoftware Process Release 01.02.00
1EA4 Software Naming ConventionsSoftware Process Release 01.02.00
3Design and Coding StandardsSoftware Process Release 02.01.00
4FDD: CF052A_FordSysSt_DesignSee Synergy subproject version

Dependencies

SWCs

ModuleRequired 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

None

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
None

Manual Configuration Changes

ConstantNotesSWC
None

Exclusive Area ‘FordSysStExclusiveArea’ must be configured to block OS interrupts.

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

Refer DataDict.m file in the FDD

Required Global Data Outputs

Refer DataDict.m file in the FDD

Specific Include Path present

No

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
FordSysStInit1NoneRTE/Init
RunnableScheduling RequirementsTrigger
FordSysStPer1NoneRTE/10 ms

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
FordSysSt_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 - FordSysSt_MDD

Module Design Document

For

FordSysSt

04-Dec-2017

Prepared For:

Software Engineering

Nexteer Automotive,

Saginaw, MI, USA

Prepared By:

Shawn Penning,

Nexteer Automotive,

Saginaw, MI, USA
Change History

DescriptionAuthorVersionDate
Initial VersionShawn Penning104-Dec-2017


Table of Contents

1 Introduction 6

1.1 Purpose 6

1.2 Scope 6

2 FordSysSt & High-Level Description 7

3 Design details of software module 8

3.1 Graphical representation of FordSysSt 8

3.2 Data Flow Diagram 8

3.2.1 Component level DFD 8

3.2.2 Function level DFD 8

4 Constant Data Dictionary 9

4.1 Program (fixed) Constants 9

4.1.1 Embedded Constants 9

5 Software Component Implementation 10

5.1 Sub-Module Functions 10

5.1.1 Init: FordSysStInit1 10

5.1.1.1 Design Rationale 10

5.1.1.2 Module Outputs 10

5.1.2 Per: FordSysStPer1 10

5.1.2.1 Design Rationale 10

5.1.2.2 Store Module Inputs to Local copies 10

5.1.2.3 (Processing of function) 10

5.1.2.4 Store Local copy of outputs into Module Outputs 10

5.2 Server Runnables 10

5.3 Interrupt Functions 10

5.4 Module Internal (Local) Functions 10

5.4.1 Local Function #1 10

5.4.1.1 Design Rationale 10

5.4.1.2 Processing 11

5.4.2 Local Function #2 11

5.4.2.1 Design Rationale 11

5.4.2.2 Processing 11

5.4.3 Local Function #3 11

5.4.3.1 Design Rationale 11

5.4.3.2 Processing 11

5.4.4 Local Function #4 11

5.4.4.1 Design Rationale 11

5.4.4.2 Processing 11

5.4.5 Local Function #5 11

5.4.5.1 Design Rationale 12

5.4.5.2 Processing 12

5.4.6 Local Function #6 12

5.4.6.1 Design Rationale 12

5.4.6.2 Processing 12

5.4.7 Local Function #7 12

5.4.7.1 Design Rationale 13

5.4.7.2 Processing 13

5.4.8 Local Function #8 13

5.4.9 Design Rationale 13

5.4.9.1 Processing 13

5.4.10 Local Function #9 13

5.4.11 Design Rationale 13

5.4.11.1 Processing 13

5.4.12 Local Function #10 13

5.4.12.1 Design Rationale 13

5.4.12.2 Processing 14

5.4.13 Local Function #11 14

5.4.14 Design Rationale 14

5.4.14.1 Processing 14

5.4.15 Local Function #12 14

5.4.16 Design Rationale 14

5.4.16.1 Processing 14

5.4.17 Local Function #13 14

5.4.18 Design Rationale 14

5.4.18.1 Processing 14

5.5 GLOBAL Function/Macro Definitions 14

6 Known Limitations with Design 16

7 UNIT TEST CONSIDERATION 17

Appendix A Abbreviations and Acronyms 18

Appendix B Glossary 19

Appendix C References 20

Introduction

Purpose

Scope

FordSysSt & High-Level Description

Ford System State will handle internal states and failure modes, and output the current state to the bus.

Design details of software module

Graphical representation of FordSysSt

Data Flow Diagram

Refer FDD

Component level DFD

Refer FDD

Function level DFD

Refer FDD

Constant Data Dictionary

Program (fixed) Constants

Embedded Constants

Local Constants

Constant NameResolutionUnitsValue
Refer .m file

Software Component Implementation

Sub-Module Functions

Init: Init1

Design Rationale

None

Module Outputs

None

Per: Per1

Design Rationale

None

Store Module Inputs to Local copies

Refer FDD

(Processing of function)

Refer FDD

Store Local copy of outputs into Module Outputs

Refer FDD

Server Runnables

None

Interrupt Functions

None

Module Internal (Local) Functions

Local Function #1

Function NameChkLvngWarmInitTypeMinMax
Arguments PassedFordSysSt_Cnt_T_enumSysSt10U3U
FordLoaSt_Cnt_T_enumLoaSt10U5U
SysStWrmIninCmpl_Cnt_T_loglBooleanFALSETRUE
FordVltgOperSt_Cnt_T_enumFordVltgOperSt10U6U
FordEpsSysSt_Cnt_T_enumFordEpsSysSt10U8U
OperScaFctr_Cnt_T_f32float320.11
OperRampRate_Cnt_T_f32float320.11000
Return Valuenone

Design Rationale

None

Processing

Check the conditions for leaving ChkLvngWarmInit.

Local Function #2

Function NameChkLvngLimpHomeTypeMinMax
Arguments PassedFordLoaSt_Cnt_T_enumLoaSt10U3U
FordEpsSysSt_Cnt_T_enumFordEpsSysSt10U8U
Return Valuenone

Design Rationale

None

Processing

Local Function #3

Function NameChkLvngLimpAsideTypeMinMax
Arguments PassedFordLoaSt_Cnt_T_enumLoaSt10U3U
FordEpsSysSt_Cnt_T_enumFordEpsSysSt10U8U
Return Valuenone

Design Rationale

None

Processing

Check the condtions for leaving LimpAside for another substate of EPSSystemFailure.

Local Function #4

Function NameChkLvngRampOutTypeMinMax
Arguments PassedFordLoaSt_Cnt_T_enumLoaSt10U3U
FordEpsSysSt_Cnt_T_enumFordEpsSysSt10U8U
Return Valuenone

Design Rationale

None

Processing

Check the condtions for leaving RampOut for another substate of EPSSystemFailure.

Local Function #5

Function NameChkLvngEpsNormOperLimAssiTypeMinMax
Arguments PassedLoaSt_Cnt_T_enumLoaSt10U3U
FordVltgOperSt_Cnt_T_enumFordVltgOperSt10U6U
SysSt_Cnt_T_enumSysSt10U3U
FordVehSpdVld_Cnt_T_loglbooleanFALSETRUE
FordVehSpd_Cnt_T_f32float320.0F511.0F
FordVehPwrpkTqSts_Cnt_T_enumFord_PwPckTq_D_Stat0U3U
NtcQlfr_Cnt_T_enumSigQlfr10U2U
FordEpsSysSt_Cnt_T_enumFordEpsSysSt10U8U
OperScaFctr_Cnt_T_f32float320.0F1.0F
OperRampRate_Cnt_T_f32float320.0F1000.0F
Return Valuenone

Design Rationale

None

Processing

Check the conditions for leaving EpsNormOper-->LimAssi.

Local Function #6

Function NameChkLvngEpsNormOperFullAssiTypeMinMax
Arguments PassedFordLoaSt_Cnt_T_enumLoaSt10U3U
FordVltgOperSt_Cnt_T_enumFordVltgOperSt10U6U
FordSysSt_Cnt_T_enumSysSt10U3U
FordVehSpdVld_Cnt_T_loglbooleanFALSETRUE
FordVehSpd_Cnt_T_f32float320.0F511.0F
FordVehPwrpkTqSts_Cnt_T_enumFord_PwPckTq_D_Stat0U3U
NtcQlfr_Cnt_T_enumSigQlfr10U2U
Return Valuenone

Design Rationale

None

Processing

Check the conditions for leaving EpsNormOper-->FullAssist.

Local Function #7

Function NamePowerDownTypeMinMax
Arguments PassedNone
Return Value

Design Rationale

None

Processing

Set FordEpsSystemSt to PowerDown

Local Function #8

Function NameWarmInitTypeMinMax
Arguments PassedNone
Return Value

Design Rationale

None

Processing

Set WarmInit conditions.

Local Function #9

Function NameEpsSystemFailureTypeMinMax
Arguments PassedNone
Return Value

Design Rationale

None

Processing

Set EpsSystemFailure variables common to the entire block.

Local Function #10

Function NameEpsSystemFailureExitCheckTypeMinMax
Arguments PassedFordSysSt_Cnt_T_enumSysSt10U3U
FordVehSpd_Cnt_T_f32float320.0F511.0F
FordVehSpdVld_Cnt_T_loglbooleanFALSETRUE
FordVehPwrpkTqSts_Cnt_T_enumFord_PwPckTq_D_Stat0U3U
NtcQlfr_Cnt_T_enumSigQlfr10U2U
Return ValuebooleanFALSETRUE

Design Rationale

None

Processing

Called whenever FordEpsSysSt is already in an EpsSystemFailure state.

Local Function #11

Function NameLimAssistTypeMinMax
Arguments PassedNone
Return Value

Design Rationale

None

Processing

Set LimAssist conditions.

Local Function #12

Function NameFullAssistTypeMinMax
Arguments PassedNone
Return Value

Design Rationale

None

Processing

Set FullAssist conditions.

Local Function #13

Function NameShutDownTypeMinMax
Arguments PassedNone
Return Value

Design Rationale

None

Processing

Set ShutDown conditions.

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 Mappingv1.3.0 R4.0 Rev 2
2MDD GuidelineEA4 01.00.00
3EA4 Software Naming Conventions01.01.00
4Software Design and Coding Standards2.1
5FDD – CF052A FordSysStSee Synergy subproject version

3 - FordSysSt_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
CF052A_FordSyst_Impl
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
CF052A_FordSyst_Impl_1.1.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#15162





























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:

The PSR code is being baselined. This is an approved deviation by Lonnie Newton. An anomaly will be put in the






system to get the design updated.














































































































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.