This is the multi-page printable view of this section. Click here to print.
Component Implementation
1 - ES400A_TunSelnMngt_Integration_Manual
Integration Manual
For
ES400A TunSelnMngt
VERSION: 4.0
DATE: 29-Aug-2016
Prepared By:
Kevin Smith
Nexteer Automotive,
Saginaw, MI, USA
Location: The official version of this document is stored in the Nexteer Configuration Management System.
Revision History
Sl. No. | Description | Author | Version | Date | Approved By |
1 | Initial version | K. Smith | 1.0 | 09-Oct-15 | - |
2 | Updated for version 1 of the design | K. Smith | 2.0 | 04-Apr-16 | |
3 | Removed CalUsgProtn exclusive area | N. Saxton | 3.0 | 06-May-16 | |
4 | Anomaly correction for EA4#6672 | K. Smith | 4.0 | 29-Aug-16 |
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 | MDD Guidelines | Process 04.02.00 |
2 | Software Naming Conventions | Process 04.02.00 |
3 | Coding standards | Process 04.02.00 |
4 | ES400A_TunSelnMngt_Design | See Synergy subproject version |
Dependencies
SWCs
Module | Required 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
Modules | Notes | |
None |
Configuration Files to be provided by Integration Project
TunSelnMngt_Cfg_private.h – Genereated by Configurator
TunSelnMngt_Cfg_private.c – Genereated by Configurator
Da Vinci Parameter Configuration Changes
All the parameters are generated by the data dictionary tool based on the configuration for the project
Parameter | Notes | SWC | |
DaVinci Interrupt Configuration Changes
ISR Name | VIM # | Priority Dependency | Notes |
None |
Manual Configuration Changes
Constant | Notes | SWC |
None |
Exclusive Areas
Constant | Notes | SWC |
TunSelnMngtIntDataProtnExclsvArea | Exclusive area needs to protect periodic access of PIMs from asynchronous updates by server runnables SetCalPageReq and CopyCalPage. Integrator verify if client calls to server runnables are interrupt or task based and set up exclusive area to properly protect access. |
Integration DATAFLOW REQUIREMENTS
Required Global Data Inputs
Required Global Data Outputs
Specific Include Path present
Yes. TunSelnMngt.h must also be included in Rte_UserTypes.h for non-RTE generated type definitions.
Runnable Scheduling
This section specifies the required runnable scheduling.
Init | Scheduling Requirements | Trigger |
TunSelnMngtInit1 | This init function should be performed before any calibration access is done by another component and after DiagcMgr has initialized. However, if the calibration access is only to common calibrations, then there would be no impact. | RTE |
Runnable | Scheduling Requirements | Trigger |
TunSelnMngtPer1 | None | RTE 10ms |
.
Memory Map REQUIREMENTS
Mapping
Memory Section | Contents | Notes |
None |
* Each …START_SEC… constant is terminated by a …STOP_SEC… constant as specified in the AUTOSAR Memory Mapping requirements.
Usage
Feature | RAM | ROM |
None |
Table 1: ARM Cortex R4 Memory Usage
NvM Blocks
*See DataDict.m
Compiler Settings
Preprocessor MACRO
None
Optimization Settings
None
Appendix
Recommend GENy settings for CANembedded Projects
The following settings are recommend for online calibration support and DAQ access. This only applies to projects that XCP settings are generated by GENy.
Configurable Options | Setting | Rationale |
Enable Calibration | True | Required to be true to enable write commands such as DOWNLOAD. |
XCP Control | True | Required to enable or disable XCP access |
Open Command Interface | True | Required for XCP service E8 and E9 support |
Prescaler | True | Required to support scaling the DAQ timing (example, 2ms DAQ can be scaled in mulitples of 2ms to create DAQs running at 4ms, 8ms, 10ms, etc). |
User Defined Commands | True | Required for additional functions built into XCP commands |
Page Switching | True | Required for online calibration functions to properly operate. |
General Page Info | True | |
Copy Page | True |
2 - ES400A_TunSelnMngt_MDD
Module Design Document
For
TunSelnMngt
August 29, 2016
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
Kevin Smith,
Nexteer Automotive,
Saginaw, MI, USA
Change History
Description | Author | Version | Date | Approved By |
Initial Version | K. Smith | 1 | 07-Apr-16 | |
Updated program flow diagrams | N. Saxton | 2 | 06-May-16 | |
Updates to flow charts for anomaly EA4#6672 corrections | K. Smith | 3 | 29-Aug-16 |
Table of Contents
2 TunSelnMngt & High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of TunSelnMngt 7
4.1 Program (fixed) Constants 8
4.2 Variable Data Dictionary 8
4.2.1 User Defined Typedef Definition/Declaration 8
4.2.1.2 Dynamic Structures and Enums 9
4.2.2 User Defined Enumerated Types 10
5 Software Component Implementation 11
5.1.1 Init: TunSelnMngtInit1 11
5.4 Module Internal (Local) Functions 20
5.5 GLOBAL Function/Macro Definitions 28
6 Known Limitations with Design 29
Appendix A Abbreviations and Acronyms 31
Introduction
Purpose
This MDD aids in documenting the implementation of ES400A Tuning Selection Management.
Scope
The following definitions are used throughout this document:
Shall: indicates a mandatory requirement without exception in compliance.
Should: indicates a mandatory requirement; exceptions allowed only with documented justification.
May: indicates an optional action.
TunSelnMngt & High-Level Description
Tuning Selection Management (TunSelnMngt) provides the ability to change run-time calibrations during operation. The component also provides a RAM buffer for online calibration changes over XCP for tuning processes.
Design details of software module
Graphical representation of TunSelnMngt
Data Flow Diagram
None
Component level DFD
None
Function level DFD
None
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
Local Constants
Values between the brackets [] are the ranges that the configurable constants could be defined as for a given integration. These values are generated by Configurator before the software build.
Constant Name | Resolution | Units | Value |
---|---|---|---|
MAXINITIDXCNT_CNT_U08 | Uint8 | Cnt | [0-255] |
MAXRTIDXCNT_CNT_U08 | Uint8 | Cnt | [0-255] |
MAXONLINECALCFGCNT_CNT_U08 | Uint8 | Cnt | [0-255] |
ONLINECALGROUPS_CNT_U08 | Uint8 | Cnt | [0-255] |
ONLINECALRAMTBL_CNT_U16 | Uint16 | Cnt | [0-65535] |
PRMPTRTBLSIZEINWORD_CNT_U16 | Uint16 | Cnt | [0-65535] |
Variable Data Dictionary
The following type definitions are found in the private header of this component.
User Defined Typedef Definition/Declaration
Static Structures
The following table contains structures are static in their definition. However, internal elements may change based on the configuration of the project but the high level content is the same. These elements are described at the bottom of the table.
Typedef Name | Element Name | User Defined Type | Legal Range (min) | Legal Range (max) |
---|---|---|---|---|
TunSelnRamTblRec1 | PrmRefTblPtr | Rte_ParameterRefTabType | N/A | N/A |
PrmTblCrc_u32 | Uint32 | 0 | 4294967295 | |
TunSelnIdxTblRec1 | SrcIdx_u16 | Uint16 | 0 | 65535 |
DestIdx_u16 | Uint16 | 0 | 65535 | |
SigIdx_u08 | Uint8 | 0 | 255 | |
TunSelnOnlineCalIdxTblRec1 | RamStructPtr_u08 | UInt8* | 0 | 255 |
StructSize_u16 | Uint16 | 0 | 65535 | |
TblIdx_u16 | Uint16 | 0 | 65535 | |
GroupIdx_u08 | Uint8 | 0 | 255 |
Rte_ParameterRefTabType is a structure of void pointers that point to the various calibration component structures. This type is generated by the RTE based on the configuration of the integration.
Dynamic Structures and Enums
The following table contains structures are dynamic in their definition. The contents contained will vary from project to project. The intent of this table is to document their purpose.
Entry Type | Typedef Name | Example Element(s) | Variable Type | Value | Comment |
---|---|---|---|---|---|
Enum | OnlineCalGroup1 | GroupA | N/A | 0 | This enum contains a number representation for each calibration group that is generated for online calibration from A=0 to Z=26. Groups are defined by a letter suffix. |
GroupB | N/A | 1 | |||
Struct | <GroupName>Typ GroupATyp | <Cal Region><Cal Cmp Name><Online Group> CalRegn01CmnGroupA | RTE Generated | N/A | This structure is generated based on the online groups configured. Each group will generate a structure and contain all calibration software components within that group. |
Union | OnlineCalTblRec1 | Byte[<RAM Size>] | Unit8 | N/A | This structure combines all the online calibration groups into data type for assignment to the RAM buffer. The ‘byte’ element is used to access the entire buffer on a byte-by-byte basis and ensure that the RAM is properly sized. |
<GroupName> | <GroupName>Typ | N/A |
User Defined Enumerated Types
Enum Name | Element Name | Value |
---|---|---|
GetSegModeSegInfo1 | GETSEGMODSEGINFO_ADR | 0 |
GETSEGMODSEGINFO_LEN | 1 | |
GetSegModeMpgIdx1 | GETSEGMODMPGIDX_SRCADR | 0 |
GETSEGMODMPGIDX_DESTADR | 1 | |
GETSEGMODMPGIDX_LEN | 2 |
Software Component Implementation
Sub-Module Functions
Init: Init1
Design Rationale
The initialization function creates two copies of the RTE generated flash table in to RAM. A CRC is performed on each of the copies to ensure that they match. The function also adjusts the tables to load the appropriate initialization and run-time calibrations indexes that are required by the application.
Processing
Module Outputs
None
Per: Per1
Design Rationale
Processing
Module Outputs
None
Server Runnables
CopyCalPageReq
Design Rationale
This function is called by the XCP master and queues the copy of the calibrations contained in the selected group, or segment, into the RAM buffer. The actual copy is performed by TunSelnMngt’s main periodic function, but this runnable logs the current state of TunSelnMngt and marks the copy in progress.
(Processing of function)………
Module Outputs
None
GetCalPageReq
Design Rationale
This function is called by the XCP master and returns the page with the request XCP and ECU access for a given segment.
(Processing of function)………
Module Outputs
None
GetSegInfoReq
Design Rationale
This function is called by the XCP master and returns the requested information for the provided segment.
(Processing of function)………
Module Outputs
None
OnlineTunRamAdrMpg
Design Rationale
This function is called by the XCP master. During tuning, tools such as eTool and CANape will read calibration values from their flash addresses because that is how the A2L file is defined. However, when the calibrations are access from RAM, the user does not always know the exact address the calibration is located. This function calculates the RAM address for a given calibration to the XCP function for reading and writing.
(Processing of function)………
Module Outputs
None
SetCalPageReq
Design Rationale
This function is called by the XCP master. This function will set the status of the calibration page for a given segment.
(Processing of function)………
Module Outputs
None
Interrupt Functions
None
Module Internal (Local) Functions
SwtCalIdx
Function Name | SwtCalIdx | Type | Min | Max |
Arguments Passed | N/A | |||
Return Value | N/A |
Design Rationale
This function manages the RAM buffer access and switches the calibration index between the two copies in RAM.
Processing
IdxChgMngt
Function Name | IdxChgMngt | Type | Min | Max |
Arguments Passed | SeldIdx_Cnt_T_u08 | Uint8 | 0 | 255 |
GendCalTblSize_Cnt_T_u08 | Uint8 | 0 | 255 | |
GendCalTbl_T_rec | TunSelnIdxTblRec1* | 0 | 4294967295 | |
Return Value | IdxFound_Cnt_T_logl | Boolean | FALSE | TRUE |
Design Rationale
Processing
MemCopy32Bit
Function Name | MemCopy32Bit | Type | Min | Max |
Arguments Passed | Des_Arg | Void | 0 | 4294967295 |
Src_Arg | Void | 0 | 4294967295 | |
Len_Arg | Uint16 | 0 | 65535 | |
Return Value | N/A |
Design Rationale
The 32-bit mem copy function is used to move calibration pointers from flash to RAM. The void pointers are internally assigned to a uint32 pointer before the processing loop begins.
Processing
MemCopy8Bit
Function Name | MemCopy8Bit | Type | Min | Max |
Arguments Passed | Des_Arg | Void | 0 | 4294967295 |
Src_Arg | Void | 0 | 4294967295 | |
Len_Arg | Uint16 | 0 | 65535 | |
Return Value | N/A |
Design Rationale
The 8-bit mem copy function is used to move calibration segments into the RAM space. Since the length of the segments is not guaranteed to be a 32-bit even address, 8-bit was selected to ensure that only the bytes required to be moved are performed. The void pointers are internally assigned to a uint8 pointer before the processing loop begins.
Processing
SegModAdrInfo
Function Name | SegModAdrInfo | Type | Min | Max |
Arguments Passed | Seg_Arg | UInt8 | 0 | 255 |
SegInfo_Arg | GetSegModSegInfo1 | 0 | 1 | |
Resp_Arg | Uint8* | 0 | 255 | |
RespLen_Arg | Uint8* | 8 | 8 | |
Return Value | Rtn_Cnt_T_u08 | Uint8 | 0 | 255 |
Design Rationale
Processing
SegModStdInfo
Function Name | SegModStdInfo | Type | Min | Max |
Arguments Passed | Seg_Arg | Uint8 | 0 | 255 |
Resp_Arg | Uint8* | 0 | 255 | |
RespLen_Arg | UInt8* | 6 | 6 | |
Return Value | <Hard Coded> | UInt8 | 1 | 1 |
Design Rationale
Processing
SegModAdrMpg
Function Name | SegModAdrMpg | Type | Min | Max |
Arguments Passed | Seg_Arg | Uint8 | 0 | 255 |
MpgIdxInfo_Arg | GetSegModMpgIdx1 | 0 | 2 | |
MpgIdx_Arg | Uint8 | 0 | 255 | |
Resp_Arg | UInt8* | 0 | 4294967295 | |
RespLen_Arg | Uint8* | 8 | 8 | |
Return Value | Rtn_Cnt_T_u08 | Uint8 | 0 | 255 |
Design Rationale
Processing
TunSelnMngt_ChkXcpWrAcs
Function Name | TunSelnMngt_ChkXcpWrAcs | Type | Min | Max |
Arguments Passed | ReqAdr_Cnt_T_u32 | Uint32 | 0 | 4294967296 |
Return Value | Rtn_Cnt_T_logl | Boolean | FALSE | TRUE |
Design Rationale
This function is generated based on the configured access regions in Configurator. Below is just a high level overview of the function. The conditions in the if statements are logically OR’d together to form the tests.
Processing
GLOBAL Function/Macro Definitions
None
Known Limitations with Design
None
UNIT TEST CONSIDERATION
None
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 (Link:AUTOSAR_SWS_MemoryMapping.pdf) | v1.3.0 R4.0 Rev 2 |
2 | MDD Guideline | EA4 01.00.01 |
3 | Software Naming Conventions.doc | 1.0 |
4 | Software Design and Coding Standards.doc | 2.1 |
3 - TunSelnMngt_PeerReview
Overview
Summary SheetSynergy Project
Source Code
Integration Manual
MDD
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: | TunSelnMngt.c | Source File Revision: | 4 | |||||||||||||||||||||
Header File Name: | TunSelnMngt.h | Header File Revision: | ||||||||||||||||||||||
MDD Name: | TunSelnMngt_MDD.docx | Revision: | 3 | |||||||||||||||||||||
FDD/SCIR/DSR/FDR/CM Name: | ES400A_TunSelnMngt_Design | Revision: | 1.0.0 | |||||||||||||||||||||
Quality Check Items: | ||||||||||||||||||||||||
Rationale is required for all answers of No | ||||||||||||||||||||||||
Working EA4 Software Naming Convention followed: | ||||||||||||||||||||||||
for variable names | Yes | Comments: | ||||||||||||||||||||||
for constant names | Yes | Comments: | ||||||||||||||||||||||
for function names | Yes | Comments: | ||||||||||||||||||||||
for other names (component, memory | Yes | Comments: | ||||||||||||||||||||||
mapping handles, typedefs, etc.) | ||||||||||||||||||||||||
All paths assign a value to outputs, ensuring | Yes | Comments: | ||||||||||||||||||||||
all outputs are initialized prior to being written | ||||||||||||||||||||||||
Requirements Tracability tags in code match the requirements tracability in the FDD | Yes | Comments: | ||||||||||||||||||||||
requirements tracability in the FDD | ||||||||||||||||||||||||
All variables are declared at the function level. | Yes | 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) | Yes | Comments: | ||||||||||||||||||||||
Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
Component.h is included | Yes | Comments: | ||||||||||||||||||||||
All other includes are actually needed. (System includes | Yes | Comments: | ||||||||||||||||||||||
only allowed in Nexteer library components) | ||||||||||||||||||||||||
Software Design and Coding Standards followed: | Version: 2.1 | |||||||||||||||||||||||
Code comments are clear, correct, and adequate | Yes | 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 | Yes | 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 | Yes | Comments: | ||||||||||||||||||||||
"magic numbers": [N12] | ||||||||||||||||||||||||
Memory mapping for non-RTE code | Yes | Comments: | ||||||||||||||||||||||
is per standard | ||||||||||||||||||||||||
All execution-order-dependent code can be | Yes | Comments: | ||||||||||||||||||||||
recognized by the compiler: [N80] | ||||||||||||||||||||||||
All loops have termination conditions that ensure | Yes | Comments: | ||||||||||||||||||||||
finite loop iterations: [N63] | ||||||||||||||||||||||||
All divides protect against divide by zero | Yes | Comments: | ||||||||||||||||||||||
if needed: [N65] | ||||||||||||||||||||||||
All integer division and modulus operations | Yes | Comments: | ||||||||||||||||||||||
handle negative numbers correctly: [N76] | ||||||||||||||||||||||||
All typecasting and fixed point arithmetic, | Yes | 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. | Yes | Comments: | ||||||||||||||||||||||
float value is non-negative: [N67] | ||||||||||||||||||||||||
All conversions between signed and unsigned | Yes | Comments: | ||||||||||||||||||||||
types handle msb==1 as intended: [N78] | ||||||||||||||||||||||||
All pointer dereferencing protects against | Yes | Comments: | ||||||||||||||||||||||
null pointer if needed: [N70] | ||||||||||||||||||||||||
Component outputs are limited to the legal range | Yes | Comments: | ||||||||||||||||||||||
defined in the FDD DataDict.m file : [N53] | ||||||||||||||||||||||||
All code is mapped with FDD (all FDD | Yes | 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 | Yes | Comments: List Anomaly or CR numbers | ||||||||||||||||||||||
for any FDD corrections needed | ||||||||||||||||||||||||
General Notes / Comments: | ||||||||||||||||||||||||
Change Owner: | K. Smith | Review Date : | 08/30/16 | |||||||||||||||||||||
Lead Peer Reviewer: | Kathleen C. | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
Other Reviewer(s): | ||||||||||||||||||||||||