This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Component Implementation

Component Implementation

Component Documentation

1 - CmnMfgSrvIf_IntegrationManual

Integration Manual

For

CmnMfgSrvIf

VERSION: 1.0

DATE: 5-Jan-2018

Prepared By:

Jared Julien,

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 versionJared Julien1.02-Feb-2018


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 04.02.01
2Software Naming ConventionsSoftware Process Release 04.02.01
3Design and Coding StandardsSoftware Process Release 04.02.01
4FDD: NM002C_CmnMfgSrvIf_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

Many global functions are generated by this component during integration, however, none of them are prodided by static code within this component. See appendix for additional information.

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

Integration DATAFLOW REQUIREMENTS

Required Global Data Inputs

None

Required Global Data Outputs

None

Specific Include Path present

No

Runnable Scheduling

This section specifies the required runnable scheduling.

InitScheduling RequirementsTrigger
NoneNoneN/A
RunnableScheduling RequirementsTrigger
NoneNoneN/A

Memory Map REQUIREMENTS

Mapping

Memory SectionContentsNotes
CmnMfgSrvIf_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

This component is primarily used to generate a configuration source file that provides all of it’s functionality. The purpose of this component is to bridge the gap between the AUTOSAR DCM and NM001A (common manufacturing services). To accomplish this, the component produces two1 outputs when generation is invoked through Configurator by an integrator, a .c source file and an .arxml config file, both located in the generate folder of the integration project.

The .arxml file is titled CmnMfgSrvIf_DemCfg.arxml. The file contains the necessary DCM settings for Nexteer services only. The integrator must manually merge these settings with their DCM settings being sure to include any additional or changed services with CmnMfgSrvIf in the name while retaining all of their exisiting customer service configurations. The integrator should be especially careful with the removal section as Configurator will suggest “removal” of any setting that is not defined in the generated ARXML file but is present in the project. This includes customer services as well as general DCM settings. As a general rule of thumb it is safe to remove anything with CmnMfgSrvIf in the name.

The .c file requires nothing from the integrator. During the initial integration it must be added to the corresponding generate.gpj file for the project but once that is complete and on every subsequent update no action needs to be taken.

This component takes only a single input in the form of an ODX file containing a list of all Nexteer manufacturing services that are enabled for the program. This file, titled EnadMfgSrv.odx-d, is expected to be located in the typical location in the generate folder of the integration project. Because this component uses this file and the file is generated during the integration of NM001A of NM010x this component should be regenerated AFTER making changes to NM001A or NM010x.

A DataDict.m file is generated in addition to the source and ARXML files. This file is not needed by the integration project or integrator. It is generated to be provided to the software architecture team for use with creating a system architecture specific to the project.


  1. Additionally, a DataDict.m file is also generated but for purposes of integration is not considered “functional”.↩︎

2 - CmnMfgSrvIf_PeerReviewChecklist


Overview

Summary Sheet
Synergy Project
Integration Manual


Sheet 1: Summary Sheet
























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
NM002C_CmnMfgSrvIf_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
NM002C_CmnMfgSrvIf_Impl_1.0.0

























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

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

EA4#19049





























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









































YesIntegration Manual


N/ADavinci Files








































































Comments:

























































































































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.

Sheet 2: Synergy Project






















Rev 2.0029-Nov-17

























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:












































.gpj file in tools folder matches .gpj generated by TL109 script








Yes
Comments:













































File/folder structure is correct per documentation in









Yes
Comments:




TL109A_SwcSuprt







































General Notes / Comments:
























































Review Board:


























Change Owner:

Jared Julien


Review Date :

02/23/18
































Lead Peer Reviewer:


Akilan Rathakrishnan


Approved by Reviewer(s):



Yes































Other Reviewer(s):










































































Rationale/justification for items marked "No" approved by:












































Sheet 3: Integration Manual






















Rev 2.0029-Nov-17
Nexteer SWC Implementation Peer Review Meeting Log (Integration Manual Review)


























Integration Manual Name:



kzshz2: Intended Use: Identify which file is being reviewed Rationale: Required for traceability. It will help to ensure this sheet is not attached to the wrong design review form. CmnMfgSrvIf_IntegrationManual.docx






Integration Manual Revision:



kzshz2: Intended Use: Identify which version of the integration manual has been reviewed. 1





























Quality Check Items:




































Rationale is required for all answers of No










Synergy version matches header








Yes
Comments:










































Latest template used








Yes
Comments:










































Change log contains detailed description of changes








Yes
Comments:

Initial version







































Changes Highlighted (for Integrator)








N/A
Comments:

Initial version








































General Notes / Comments:



























































Review Board:


























Change Owner:

Jared Julien


Review Date :

02/23/18
































Lead Peer Reviewer:


Akilan Rathakrishnan


Approved by Reviewer(s):



Yes
























































Integrator and or
SW lead:




Comments:

















































Other Reviewer(s):

































































Rationale/justification for items marked "No" approved by: