This is the multi-page printable view of this section. Click here to print.
Nexteer Manufacturing Components(Applicative Software)
- 1: Component Implementation
- 1.1: 1. Overview
- 1.2: 2. General Negative Responses
- 1.3: 3. Document Conventions
- 1.4: CmnMfgSrv_PeerReviewChecklist
- 2: Component Implementation
- 3: Component Implementation
- 3.1: MotVelCtrl_IntegrationManual
- 3.2: MotVelCtrl_MDD
- 3.3: MotVelCtrl_Review
- 4: Component Implementation
- 5: Component Implementation
- 6: Component Implementation
1.1 - 1. Overview
Standards
Nexteer Manufacturing Services adhere to the ISO-14229 standard for Automotive Diagnostic Services as well as ISO-15765 (Transport Layer) standard for sending data packets over a CAN-Bus.
Connection Details
Request ID (to ECU): 0x712
Response ID (from ECU): 0x710
Byte Ordering
All data is transfered in Motorola format (most significant byte first - also known as big-endian).
NvM Values
For EA4, an ignition cycle or ECU reset is required to commit any and all stored values from Volatile Memory (RAM) to Non-Volatile Memory (NvM). When an auto trim, clear trim, write trim, or similar service is used to modify any value stored in NvM a flag is set within the controller indicating that the value is to be written to NvM on the next shutdown. The power cycle can be provided by means of a cycling of physical ignition (EPS ENA) or by issuing an ECU reset (11 60) service. The reception of a positive response from the ECU reset service indicates completion of NvM writes at which time it is safe to remove battery.
1.2 - 2. General Negative Responses
This is a comprehensive list of all negative response codes as defined by the ISO-14229 specification. A value of “Yes” in the columns below indicates that the NRC is applicable to ALL services of the corresponding type regardless of whether or not it is expressly listed in the “Unique Negative Responses” section of a specific service.
| NRC | Description | 0x22 | 0x2E | 0x2F | 0x31 |
|---|---|---|---|---|---|
| 0x11 | General service not supported | Yes | Yes | Yes | Yes |
| 0x12 | Sub-function nut supported | No | No | Yes | Yes |
| 0x13 | Invalid length | Yes | Yes | Yes | Yes |
| 0x22 | Conditions not correct | No | No | No | No |
| 0x24 | Request sequence error | No | No | No | No |
| 0x31 | Request out of range | No | No | No | No |
| 0x33 | Security access denied | No | No | No | No |
| 0x35 | Invalid Key | No | No | No | No |
| 0x36 | Exceeded number of attempts | No | No | No | No |
| 0x37 | Time delay not expired | No | No | No | No |
| 0x78 | Request received, response pending | No | No | No | No |
| 0x7E | Sub-function not supported in current session | No | No | No | No |
| 0x7F | Service not supported in current session | Yes | Yes | Yes | Yes |
| 0x81 | Engine RPM too high | No | No | No | No |
| 0x82 | Engine RPM too low | No | No | No | No |
| 0x83 | Engine running | No | No | No | No |
| 0x84 | Engine not running | No | No | No | No |
| 0x85 | Engine run time too low | No | No | No | No |
| 0x86 | Temperature too high | No | No | No | No |
| 0x87 | Temperature too low | No | No | No | No |
| 0x88 | Vehicle speed too high | No | No | No | No |
| 0x89 | Vehicle speed too low | No | No | No | No |
| 0x8A | Throttle too high | No | No | No | No |
| 0x8B | Throttle too low | No | No | No | No |
| 0x8C | Transmission not in neutral | No | No | No | No |
| 0x8D | Transmission not in gear | No | No | No | No |
| 0x8F | Brake not applied | No | No | No | No |
| 0x90 | Transmission not in park | No | No | No | No |
| 0x92 | Voltage too high | No | No | No | No |
| 0x93 | Voltage too low | No | No | No | No |
1.3 - 3. Document Conventions
Terms
- NvM
- Non-Volatile Memory
Hexadecimal Values
Hexadecimal values in this document will always be prefixed with “0x”. Hexadecimal format values in transaction snippets will be represented by a pair of x’s, for example:
xx
ASCII Values
ASCII text strings in transaction snippets will be represented by a pair of a’s, for example:
aa
Bitfields (Binary Values)
Binary values in this document will always be prefixed with “0b”. Binary (or bitfield) values in transaction snippets will be represented by single ‘b’ characters, for example:
b
Binary values will always be in groups that are multiples of 8 bits. In cases where some bits are unused, the unused bits will be marked as “Reserved”, for example.
bbbb b b b b
| | | | |
| | | | '-- Bit 0
| | | '-- Bit 1
| | '-- Bit 2
| '-- Bit 3
'-- Reserved
Reserved bits should be passed as zeros on writes and reads.
Grouped Bytes
If bytes are grouped (for example, 4 bytes used to represent a single 32-bit value) the transaction snippet will show the bytes as being connected using the ‘o’ character, for example:
xx xx xx xx
| | | |
'--o--o--o-- Represents a 32-bit value
Grouped values are always in Motorola format (i.e. most-significant byte first).
Floating Point Numbers
Floating point values are represented in transaction snippets as four ‘f’ character pairs, for example:
ff ff ff ff
| | | |
'--o--o--o-- Single-precision floating point value
The four pairs represent the four bytes of data transmitted over CAN that make up the single precision float value. The four pairs will always be grouped using the conventions outlined in section 2.3 above.
Grouped values are always in Motorola format (i.e. most-significant byte first).
Units
Units in transaction snippets will be called out inside a pair of square braces, for example:
[MotNwtMtr]
If no units are specified, then the signal’s units are assumed to be Counts.
Ranges
Ranges for signals in transaction snippets will be called out inside a pair of parentheses, for example:
(minimum, maximum)
If no range is specified, then the range for the signal’s value is assumed to be bounded by the signals type.
| Type | Minimum | Maximum |
|---|---|---|
| uint8 | 0 | 255 |
| uint16 | 0 | 65535 |
| uint32 | 0 | 4294967295 |
| sint8 | -128 | 127 |
| sint16 | -32768 | 32767 |
| sint32 | -2147483648 | 2147483647 |
| float32 | error* | error* |
- *The float32 type does not have a specific minimum nor maximum value and thus each signal is required to provide a valid range specific to each.
Scale/Offset
Scale values for signals in transaction snippets will be called out inside a pair of curly braces, for example:
{*1/(2^16)}
The above scale would imply multiplying the raw value from the CAN bus by 1/65536 to achieve the scaled representation. An example including an offset would look like this:
{*1/(2^4) +11.0125}
In this second example, the raw value from the bus shall have a scale of 1/16 applied and then an offset of +11.0125 added. Offsets may be positive or negative as indicated by the preceding sign.
1.4 - CmnMfgSrv_PeerReviewChecklist
Overview
Summary SheetSynergy Project
Davinci Files
Source Code
PolySpace
Sheet 1: Summary Sheet
Sheet 2: Synergy Project
Sheet 3: Davinci Files
Sheet 4: Source Code
| Rev 1.2 | 8-Jun-15 | |||||||||||||||||||||||
| Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
| Source File Name: | CmnMfgSrv.c | Source File Revision: | 27 | |||||||||||||||||||||
| SrvFD62.c | 1 | |||||||||||||||||||||||
| SrvFD63.c | 1 | |||||||||||||||||||||||
| SrvFD73.c | 1 | |||||||||||||||||||||||
| SrvFDC1.c | 1 | |||||||||||||||||||||||
| SrvFDC2.c | 1 | |||||||||||||||||||||||
| SrvFDC9.c | 1 | |||||||||||||||||||||||
| SrvFDCA.c | 1 | |||||||||||||||||||||||
| SrvFDF4.c | 4 | |||||||||||||||||||||||
| SrvFDF5.c | 4 | |||||||||||||||||||||||
| SrvFDF6.c | 1 | |||||||||||||||||||||||
| SrvFDF7.c | 1 | |||||||||||||||||||||||
| Header File Name: | Header File Revision: | |||||||||||||||||||||||
| MDD Name: | N/A | Revision: | N/A | |||||||||||||||||||||
| FDD/SCIR/DSR/FDR/CM Name: | N/A | Revision: | N/A | |||||||||||||||||||||
| 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 | N/A | Comments: | Not applicable for EA4 | |||||||||||||||||||||
| 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) | N/A | Comments: | No design at this time | |||||||||||||||||||||
| Verified no Compiler Errors or Warnings | Yes | Comments: | CmnMfgSrv.c does not compile due to errors with definitions in contract headers but does compile without warnings in T1xx project | |||||||||||||||||||||
| 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: | Services intentionally deviate from standard | |||||||||||||||||||||
| contain correct information: [N43] | to provide additional information relevant to each service. | |||||||||||||||||||||||
| 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 | No | Comments: | To be added as part of EA4#12632 | |||||||||||||||||||||
| 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 | N/A | Comments: | No division | |||||||||||||||||||||
| if needed: [N65] | ||||||||||||||||||||||||
| All integer division and modulus operations | N/A | Comments: | No division | |||||||||||||||||||||
| 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. | N/A | 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 | N/A | Comments: | ||||||||||||||||||||||
| null pointer if needed: [N70] | ||||||||||||||||||||||||
| Component outputs are limited to the legal range | Yes | Comments: | M-file is not official, but outputs are limited | |||||||||||||||||||||
| defined in the FDD DataDict.m file : [N53] | ||||||||||||||||||||||||
| All code is mapped with FDD (all FDD | N/A | Comments: | No FDD at this time | |||||||||||||||||||||
| 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 | N/A | Comments: | ||||||||||||||||||||||
| for any FDD corrections needed | ||||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||
| Change Owner: | Jared Julien | Review Date : | 11/21/17 | |||||||||||||||||||||
| Lead Peer Reviewer: | Brendon Binder | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||
Sheet 5: PolySpace
2.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. | Description | Author | Version | Date |
| 1 | Initial version | Jared Julien | 1.0 | 2-Feb-2018 |
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 |
| FDD | Functional 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 | Software Process Release 04.02.01 |
| 2 | Software Naming Conventions | Software Process Release 04.02.01 |
| 3 | Design and Coding Standards | Software Process Release 04.02.01 |
| 4 | FDD: NM002C_CmnMfgSrvIf_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
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
| Modules | Notes | |
|---|---|---|
| None |
Configuration Files to be provided by Integration Project
None
Da Vinci Parameter Configuration Changes
| Parameter | Notes | SWC |
|---|---|---|
| None |
DaVinci Interrupt Configuration Changes
| ISR Name | VIM # | Priority Dependency | Notes |
|---|---|---|---|
| None |
Manual Configuration Changes
| Constant | Notes | SWC |
|---|---|---|
| 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.
| Init | Scheduling Requirements | Trigger |
|---|---|---|
| None | None | N/A |
| Runnable | Scheduling Requirements | Trigger |
|---|---|---|
| None | None | N/A |
Memory Map REQUIREMENTS
Mapping
| Memory Section | Contents | Notes |
|---|---|---|
| CmnMfgSrvIf_START_SEC_CODE | ||
* 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
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.
Additionally, a DataDict.m file is also generated but for purposes of integration is not considered “functional”.↩︎
2.2 - CmnMfgSrvIf_PeerReviewChecklist
Overview
Summary SheetSynergy Project
Integration Manual
Sheet 1: Summary Sheet
Sheet 2: Synergy Project
| Rev 2.00 | 29-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
3.1 - MotVelCtrl_IntegrationManual
Integration Manual
For
MotVelCtrl
VERSION: 1.0
DATE: 16-Feb-2016
Prepared By:
Sankardu Varadapureddi,
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 |
| 1 | Initial version | Sankardu Varadapureddi | 1.0 | 16-Feb-2016 |
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 | FDD : NM100A_ MotVelCtrl_Design | See Synergy sub project version |
| 2 | Software Naming Conventions | 2.0 |
| 3 | Software Design and Coding Standards | 2.1 |
| 4 | Integration Manual Template | 1.3 |
Dependencies
SWCs
| Module | Required Feature |
| None |
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
None
Da Vinci Parameter Configuration Changes
| Parameter | Notes | SWC |
| None |
DaVinci Interrupt Configuration Changes
| ISR Name | VIM # | Priority Dependency | Notes |
| None |
Manual Configuration Changes
| Constant | Notes | SWC |
| 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.
| Init | Scheduling Requirements | Trigger |
| MotVelCtrlInit1 | None | RTE (Init) |
| Runnable | Scheduling Requirements | Trigger |
| MotVelCtrlPer1 | None | RTE (2ms) |
| Server Runnable | Scheduling Requirements | Trigger |
| GetCtrlPrm_Oper | None | On event |
| SetCtrlPrm_Oper | None | On event |
| StopCtrl_Oper | None | On event |
| StrtCtrl_Oper | None | On event |
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
None
Compiler Settings
Preprocessor MACRO
None.
Optimization Settings
None.
Appendix
None
3.2 - MotVelCtrl_MDD
Module Design Document
For
MotVelCtrl
May 4, 2016
Prepared For:
Software Engineering
Nexteer Automotive,
Saginaw, MI, USA
Prepared By:
Nick Saxton,
Nexteer Automotive,
Saginaw, MI, USA
Change History
| Description | Author | Version | Date |
| Initial Version | Sankardu Varadapureddi | 1 | 17-Feb-2016 |
| Input name change | Nick Saxton | 2 | 04-May-2016 |
Table of Contents
2 MotVelCtrl High-Level Description 6
3 Design details of software module 7
3.1 Graphical representation of MotVelCtrl 7
4.1 Program (fixed) Constants 8
5 Software Component Implementation 9
5.1.2.2 Store Module Inputs to Local copies 9
5.1.2.3 (Processing of function)……… 9
5.1.2.4 Store Local copy of outputs into Module Outputs 9
5.2.1.2 (Processing of function)……… 9
5.2.2.2 (Processing of function)……… 9
5.2.3.2 (Processing of function)……… 10
5.2.4.2 (Processing of function)……… 10
5.4 Module Internal (Local) Functions 10
5.5 GLOBAL Function/Macro Definitions 11
6 Known Limitations with Design 12
Appendix A Abbreviations and Acronyms 14
Introduction
Purpose
Scope
MotVelCtrl High-Level Description
Refer to FDD
Design details of software module
Graphical representation of MotVelCtrl
Data Flow Diagram
Refer FDD
Component level DFD
Function level DFD
Constant Data Dictionary
Program (fixed) Constants
Embedded Constants
| Constant Name | Resolution | Units | Value |
|---|---|---|---|
| ONEOVERTWOMPLR_ULS_F32 | 1 | Cnt | 0.5 |
For other constants, refer .m file.
Local Constants
Software Component Implementation
Sub-Module Functions
Init: MotVelCtrlInit1
Design Rationale
Refer FDD
Module Outputs
Refer FDD
Per: MotVelCtrlPer1
Design Rationale
Refer FDD
Store Module Inputs to Local copies
Refer FDD
(Processing of function)………
Refer FDD
Store Local copy of outputs into Module Outputs
Refer FDD
Server Runables
GetCtrlPrm_Oper
Design Rationale
Refer FDD
(Processing of function)………
Refer FDD
SetCtrlPrm_Oper
Design Rationale
Refer FDD
(Processing of function)………
Refer FDD
StopCtrl_Oper
Design Rationale
Refer FDD
(Processing of function)………
Refer FDD
StrtCtrl_Oper
Design Rationale
Refer FDD
(Processing of function)………
Refer FDD
Interrupt Functions
None
Module Internal (Local) Functions
Local Function #1
| Function Name | FPIDControl | Type | Min | Max | |
| Arguments Passed | MotVelTarSlewed_MotRadPerSec_T_f32 | float32 | - 183500 | 183500 | |
| MotVelCrf_MotRadPerSec_T_f32 | float32 | -1350 | 1350 | ||
| Return Value | PIDCmdLimid_MotNwtMtr_T_f32 | float32 | -8.8 | 8.8 | |
Description
Blocks "F_PID Control_1" , "F_PID Control_2" and "F_PID Control_3" are of same functionality in the FDD. This sub function corresponds to those blocks implementation.
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 | 2.0 |
| 4 | Software Design and Coding Standards.doc | 2.1 |
| 5 | FDD : NM100A_ MotVelCtrl_Design | See Synergy sub project version |
3.3 - MotVelCtrl_Review
Overview
Summary SheetSynergy Project
Source Code
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: | MotVelCtrl.c | Source File Revision: | 3 | |||||||||||||||||||||
| Header File Name: | Header File Revision: | |||||||||||||||||||||||
| MDD Name: | MotVelCtrl_MDD.docx | Revision: | 2 | |||||||||||||||||||||
| FDD/SCIR/DSR/FDR/CM Name: | NM100A_MotVelCtrl_Design | Revision: | 1.4.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 | N/A | Comments: | ||||||||||||||||||||||
| for other names (component, memory | N/A | 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 | N/A | 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 | N/A | Comments: | ||||||||||||||||||||||
| All other includes are actually needed. (System includes | N/A | 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 | N/A | 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 | N/A | 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 | N/A | Comments: | ||||||||||||||||||||||
| finite loop iterations: [N63] | ||||||||||||||||||||||||
| All divides protect against divide by zero | N/A | Comments: | ||||||||||||||||||||||
| if needed: [N65] | ||||||||||||||||||||||||
| All integer division and modulus operations | N/A | Comments: | ||||||||||||||||||||||
| handle negative numbers correctly: [N76] | ||||||||||||||||||||||||
| All typecasting and fixed point arithmetic, | N/A | 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. | N/A | Comments: | ||||||||||||||||||||||
| float value is non-negative: [N67] | ||||||||||||||||||||||||
| All conversions between signed and unsigned | N/A | Comments: | ||||||||||||||||||||||
| types handle msb==1 as intended: [N78] | ||||||||||||||||||||||||
| All pointer dereferencing protects against | N/A | 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 | N/A | Comments: List Anomaly or CR numbers | ||||||||||||||||||||||
| for any FDD corrections needed | ||||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||
| Change Owner: | Nick Saxton | Review Date : | 07/11/16 | |||||||||||||||||||||
| Lead Peer Reviewer: | Krishna Anne | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||
Sheet 4: PolySpace
6.1 - ProgMfgSrv_PeerReviewChecklist
Overview
Summary SheetSynergy Project
Davinci Files
Source Code
PolySpace
help
Version History
Sheet 1: Summary Sheet
| Rev 2.01 | 21-Feb-18 | |||||||||||||||||||||||||||||
| Nexteer EA4 SWC Implementation Peer Review Summary Sheet | ||||||||||||||||||||||||||||||
| Component Short Name: | NM010B_ProgMfgSrv | Revision / Baseline: | NM010B_ProgMfgSrv_Impl_0.2.0 | |||||||||||||||||||||||||||
| Change Owner: | Jared Julien | Work CR ID: | EA4#24008 | |||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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). | ||||||||||||||||||||||||||||||
| No | MDD | Yes | Source Code | Yes | PolySpace | |||||||||||||||||||||||||
| No | Integration Manual | Yes | Davinci Files | |||||||||||||||||||||||||||
| All required reviewers participated | ||||||||||||||||||||||||||||||
| Comments: | ||||||||||||||||||||||||||||||
| Time spent ( to the nearest half hour) | review preparation | review meeting | review follow-up | |||||||||||||||||||||||||||
| Change owner: | 0.5 | 0.5 | 0 | |||||||||||||||||||||||||||
| Component developer reviewers: | 0 | 0.5 | 0 | 1.5 | ||||||||||||||||||||||||||
| Other reviewers: | 0 | 0 | 0 | |||||||||||||||||||||||||||
| Total hours | 0.5 | 1 | 0 | 1.5 | ||||||||||||||||||||||||||
| Content reviewed | ||||||||||||||||||||||||||||||
| Lines of code: | 200 | Elements of .arxml content: | 150 | Pages of documentation: | 0 | |||||||||||||||||||||||||
| 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. Save in the doc folder of the component implementation, with the file name in the format SWCShortName_Review.xlsx. If the existing review in Synergy has a different name, the name must be changed IN SYNERGY (rather than by syncing in a new file with the new name) so that the file history will be properly maintained. Before the peer review, the change owner shall: (NOTE - time for completing these items is to be counted as the Change Owner Review Prep Time) 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.01 | 21-Feb-18 | |||||||||||||||||||||||
| 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 | N/A | Comments: | No design - planned for future relase with | |||||||||||||||||||||
| architecture changes | ||||||||||||||||||||||||
| .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 : | 05/18/18 | |||||||||||||||||||||
| Lead Peer Reviewer: | Akilan Rathakrishnan | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||
| Rationale/justification for items marked "No" approved by: | ||||||||||||||||||||||||
Sheet 3: Davinci Files
| Rev 2.01 | 21-Feb-18 | ||||||||||||||||||||||||
| Nexteer SWC Implementation Peer Review Meeting Log (Davinci Review) | |||||||||||||||||||||||||
| Quality Check Items: | |||||||||||||||||||||||||
| Rationale is required for all answers of No | |||||||||||||||||||||||||
| Only StdDef Port interfaces and datatypes are used | Yes | Comments: | |||||||||||||||||||||||
| (compare against TL107B to ensure only implementation | |||||||||||||||||||||||||
| data types are used) | |||||||||||||||||||||||||
| OBSOLETE/OBSELETE doesn’t appear in any arxml file | Yes | Comments: | |||||||||||||||||||||||
| Do all port interface names end in PortIf and a sequence | Yes | Comments: | |||||||||||||||||||||||
| number | |||||||||||||||||||||||||
| Non-program-specific components saved | Yes | Comments: | |||||||||||||||||||||||
| in Autosar 4.0.3 format | |||||||||||||||||||||||||
| For components with generated configurable content: | N/A | Comments: | |||||||||||||||||||||||
| *Cfg.arxml.TT: Verfied Davinci Configurator imported the | |||||||||||||||||||||||||
| change correctly | |||||||||||||||||||||||||
| *Cfg.h.TT: Verfied Davinci Configurator generates | N/A | Comments: | |||||||||||||||||||||||
| the configuration header file(s) correctly | |||||||||||||||||||||||||
| All changed files have been compared against previous | Yes | Comments: | |||||||||||||||||||||||
| versions (If available) and changes match changes | |||||||||||||||||||||||||
| needed as described by the work CR(s), all parent CRs | |||||||||||||||||||||||||
| and parent anomalies, and the SWC Design change log. | |||||||||||||||||||||||||
| Davinci files accurately implement SWC Design (DataDict.m | N/A | Comments: | No design at this time | ||||||||||||||||||||||
| file) in all areas where arxml was changed and/or the | |||||||||||||||||||||||||
| DataDict.m file was changed as shown by | |||||||||||||||||||||||||
| comparing the DataDict.m from the current SWC Design | |||||||||||||||||||||||||
| with the DataDict.m used in the previous implementation. | |||||||||||||||||||||||||
| (This is NOT always the predecessor.) | |||||||||||||||||||||||||
Automated validation check is performed with no issues found | Yes | Comments: | |||||||||||||||||||||||
| Naming conventions followed. All names should | Yes | Comments: | Conventions followed, no DataDict | ||||||||||||||||||||||
| match DataDict.m | |||||||||||||||||||||||||
| Sender/Receiver port properties match DataDict.m file | N/A | Comments: | No sender/receiver ports | ||||||||||||||||||||||
| (name, data type, direction) | |||||||||||||||||||||||||
| Calibration port properties match DataDict.m file | N/A | Comments: | No calibrations | ||||||||||||||||||||||
| (name, data type) | |||||||||||||||||||||||||
| Sender/Receiver port initialization values match | N/A | Comments: | No sender/receiver ports | ||||||||||||||||||||||
| DataDict.m file and have been converted to counts | |||||||||||||||||||||||||
| for fixed point types | |||||||||||||||||||||||||
| Calibration port initialization values match | N/A | Comments: | No calibrations | ||||||||||||||||||||||
| DataDict.m file and have been converted to counts | |||||||||||||||||||||||||
| for fixed point types | |||||||||||||||||||||||||
| Mapping set and all unused items have been | Yes | Comments: | |||||||||||||||||||||||
| removed | |||||||||||||||||||||||||
| All sender/receiver port read/writes using "Write (explicit)" | N/A | Comments: | No sender/receiver ports | ||||||||||||||||||||||
| and "Read (explicit by argument)"(List justification if not) | |||||||||||||||||||||||||
| Runnable calling frequencies match DataDict.m file | N/A | Comments: | No periodic runnables | ||||||||||||||||||||||
| Runnable port access matches the DataDict.m file | N/A | Comments: | No datadict - runnables are called from | ||||||||||||||||||||||
| non-RTE servers so therefore mapped to init1 | |||||||||||||||||||||||||
| DataDict.m display variables: created as | N/A | Comments: | No DataDict - no display variables | ||||||||||||||||||||||
| PerInstanceMemory. Name and data type match DataDict.m file. | |||||||||||||||||||||||||
| Per Instance Memory names and data types | N/A | Comments: | No DataDict - no PIM | ||||||||||||||||||||||
| match DataDict.m file | |||||||||||||||||||||||||
| NVM blocks match DataDict.m file | N/A | Comments: | No DataDict - no NvM | ||||||||||||||||||||||
| (Named per naming convention. Default block | |||||||||||||||||||||||||
| used if specified in DataDict.m file. Data type | |||||||||||||||||||||||||
| matches DatatDict.m file) | |||||||||||||||||||||||||
| Component is correct component type | Yes | Comments: | |||||||||||||||||||||||
| General Notes / Comments: | |||||||||||||||||||||||||
| Review Board: | |||||||||||||||||||||||||
| Change Owner: | Jared Julien | Review Date : | 05/18/18 | Component Type : | Application | ||||||||||||||||||||
| 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: | |||||||||||||||||||||||||
Sheet 4: Source Code
| Rev 2.01 | 21-Feb-18 | |||||||||||||||||||||||
| Nexteer SWC Implementation Peer Review Meeting Log (Source Code Review) | ||||||||||||||||||||||||
| Source File Name: | SrvFED1.c | Source File Revision: | 1 | |||||||||||||||||||||
| Header File Name: | NxtrMfgSrvCfg.h | Header File Revision: | 1 | |||||||||||||||||||||
| MDD Name: | N/A | Revision: | N/A | |||||||||||||||||||||
| SWC Design Name: | N/A | Revision: | N/A | |||||||||||||||||||||
| Quality Check Items: | ||||||||||||||||||||||||
| Rationale is required for all answers of No | ||||||||||||||||||||||||
| EA4 Common Naming Convention followed: | Version:1.02 | |||||||||||||||||||||||
| EA4 Software Naming Convention followed: | Version: | |||||||||||||||||||||||
| 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.) | ||||||||||||||||||||||||
| Verified no possibility of uninitialized variables being | Yes | Comments: | ||||||||||||||||||||||
| written to component outputs or IRVs | ||||||||||||||||||||||||
| Any requirements traceability tags have been removed | Yes | Comments: | ||||||||||||||||||||||
| from at least the changed areas of code | ||||||||||||||||||||||||
| All variables are declared at the function level. | Yes | Comments: | ||||||||||||||||||||||
| Synergy version matches change history | Yes | Comments: | Version 1 | |||||||||||||||||||||
| and Version Control version in file comment block | ||||||||||||||||||||||||
| Change log contains detailed description of changes | Yes | Comments: | ||||||||||||||||||||||
| (including any anomaly number(s) being fixed) and | ||||||||||||||||||||||||
| Work CR number | ||||||||||||||||||||||||
| Code accurately implements SWC Design (Document | N/A | Comments: | No design/model | |||||||||||||||||||||
| or Model) in all areas where code was changed and/or | ||||||||||||||||||||||||
| Simulink model was color-coded as changed and/or | ||||||||||||||||||||||||
| mentioned in SWC Design change log. | ||||||||||||||||||||||||
| Code comparison against previous version matches | N/A | Comments: | Initial version | |||||||||||||||||||||
| changes needed as described by the work CR(s), all | ||||||||||||||||||||||||
| parent CRs and parent anomalies, and the SWC | ||||||||||||||||||||||||
| Design change log. | ||||||||||||||||||||||||
| Verified no Compiler Errors or Warnings | Yes | Comments: | ||||||||||||||||||||||
| (and verified for all possible combinations | ||||||||||||||||||||||||
| of any conditionally compiled code) | ||||||||||||||||||||||||
| Component.h is included | N/A | Comments: | No header | |||||||||||||||||||||
| All other includes are actually needed. (System includes | Yes | Comments: | ||||||||||||||||||||||
| only allowed in Nexteer library components) | ||||||||||||||||||||||||
| Software Design and Coding Standards followed: | Version: | |||||||||||||||||||||||
| 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 | No | Comments: | Using generated comment blocks that | |||||||||||||||||||||
| contain correct information: [N43] | match other CMS service server runnables | |||||||||||||||||||||||
| 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 | No | Comments: | Known issue - planned for correction in | |||||||||||||||||||||
| is per standard | tools in future update of TL113A | |||||||||||||||||||||||
| All access of motor control loop data uses macros | N/A | Comments: | No MotCtrl signals | |||||||||||||||||||||
| generated by the motor control manager | ||||||||||||||||||||||||
| All loops have termination conditions that ensure | N/A | Comments: | No loops | |||||||||||||||||||||
| finite loop iterations: [N63] | ||||||||||||||||||||||||
| All divides protect against divide by zero | N/A | Comments: | No division | |||||||||||||||||||||
| if needed: [N65] | ||||||||||||||||||||||||
| All integer division and modulus operations | N/A | Comments: | No division | |||||||||||||||||||||
| handle negative numbers correctly: [N76] | ||||||||||||||||||||||||
| All typecasting and fixed point arithmetic, | N/A | Comments: | No typecasting | |||||||||||||||||||||
| 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-unsigned conversions ensure the. | N/A | Comments: | No float to unsigned conversion | |||||||||||||||||||||
| float value is non-negative: [N67] | ||||||||||||||||||||||||
| All conversions between signed and unsigned | N/A | Comments: | No signed to unsigned conversion | |||||||||||||||||||||
| 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 | N/A | Comments: | No outputs | |||||||||||||||||||||
| defined in the SWC Design DataDict.m file : [N53] | ||||||||||||||||||||||||
| All code is mapped with SWC Design (all SWC | N/A | Comments: | No design | |||||||||||||||||||||
| Design subfunctions and/or model blocks identified | ||||||||||||||||||||||||
| with code comments; all code corresponds to | ||||||||||||||||||||||||
| some SWC Design subfunction and/or model block): | ||||||||||||||||||||||||
| [N40] | ||||||||||||||||||||||||
| Any other violations of design and coding | Yes | Comments: | ||||||||||||||||||||||
| standards noticed during the review are noted in the | ||||||||||||||||||||||||
| comments section for rework. | ||||||||||||||||||||||||
| Anomaly or Design Work CR created | N/A | Comments: List Anomaly or CR numbers | ||||||||||||||||||||||
| for any SWC Design corrections needed | ||||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||
| Review Board: | ||||||||||||||||||||||||
| Change Owner: | Jared Julien | Review Date : | 05/18/18 | |||||||||||||||||||||
| Lead Peer Reviewer: | Akilan Rathakrishnan | Approved by Reviewer(s): | Yes | |||||||||||||||||||||
| SWC owner and/or SWC Design author: | Comments: | |||||||||||||||||||||||
| Integrator and or SW lead: | Comments: | |||||||||||||||||||||||
| Unit test co-ordinator: | Comments: | |||||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||
| Rationale/justification for items marked "No" approved by: | ||||||||||||||||||||||||
Sheet 5: PolySpace
| Rev 2.01 | 21-Feb-18 | |||||||||||||||||||||||||
| Nexteer SWC Implementation Peer Review Meeting Log (PolySpace Review) | ||||||||||||||||||||||||||
| Source File Name: | ProgMfgSrv.c | Source File Revision: | 2 | |||||||||||||||||||||||
| Source File Name: | SrvFED0.c | Source File Revision: | 1 | |||||||||||||||||||||||
| Source File Name: | SrvFED1.c | Source File Revision: | 1 | |||||||||||||||||||||||
| EA4 Static Analysis Compliance Guideline version: | 1.04 | |||||||||||||||||||||||||
| Poly Space version: | 2013b | TL109A sub project version: | 2.3.0 | |||||||||||||||||||||||
| Quality Check Items: | ||||||||||||||||||||||||||
| Rationale is required for all answers of No | ||||||||||||||||||||||||||
| tools/local folders' header files are appropriate and | Yes | Comments: | ||||||||||||||||||||||||
| function prototypes match the latest component version | ||||||||||||||||||||||||||
| 100% Compliance to the EA4 Static Analysis | Yes | Comments: | ||||||||||||||||||||||||
| Compliance Guideline | ||||||||||||||||||||||||||
| Are previously added justification and deviation | Yes | Comments: | ||||||||||||||||||||||||
| comments still appropriate | ||||||||||||||||||||||||||
| Do all MISRA deviation comments use approved | Yes | Comments: | ||||||||||||||||||||||||
| deviation tags | ||||||||||||||||||||||||||
| For any component source files (.c, .h, generated Cfg.c and Cfg.h) | Yes | Comments: | No build constants | |||||||||||||||||||||||
| with conditional compilation, has Polyspace been run with all | ||||||||||||||||||||||||||
| combinations of build constants that can be used together in a build? | ||||||||||||||||||||||||||
| (Note which conditional compilation results have been archived) | ||||||||||||||||||||||||||
| Codemetrics count OK | Yes | Comments: | Static Path: 2 | |||||||||||||||||||||||
| for all functions in the component per Design | Cyclomatic Complexity: 2 | |||||||||||||||||||||||||
| and Coding Standards rule [N47] | ||||||||||||||||||||||||||
| General Notes / Comments: | ||||||||||||||||||||||||||
| Review Board: | ||||||||||||||||||||||||||
| Change Owner: | Jared Julien | Review Date : | 05/18/18 | |||||||||||||||||||||||
| Lead Peer Reviewer: | Akilan Rathakrishnan | Approved by Reviewer(s): | Yes | |||||||||||||||||||||||
| Other Reviewer(s): | ||||||||||||||||||||||||||
| Rationale/justification for items marked "No" approved by: | ||||||||||||||||||||||||||
Sheet 6: help
| Summary sheet: | |||||||||||||||
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 | |||||||||||||||
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 | |||||||||||||||
Intended Use: Identify the developer who made the change(s) being reviewed | |||||||||||||||
Intended Use: Identify the Implementation Work CR whose work is being reviewed (may be more than one) | |||||||||||||||
Intended Use: Intended to identify at a high level to the reviewers which areas of the component have been changed. | |||||||||||||||
| Source code: | |||||||||||||||
| This item includes looking at all layers of Simulink model for possible color coding not reflected at a higher level, and includes looking at any intermediate SWC Design versions between the version being implemented and the version that was included as a subproject in the previous implementation. | |||||||||||||||
| Intended Use: Synergy version number of the file being reviewed. (Version number that Synergy displays on the checked out or unmodified file in the working project) | |||||||||||||||
| Intended Use: Synergy version number of the file being reviewed. (Version number that Synergy displays on the checked out or unmodified file in the working project) | |||||||||||||||
| Intended Use: Synergy version number of the file being reviewed. (Version number that Synergy displays on the checked out or unmodified file in the working project) | |||||||||||||||
| Intended Use: For SWC Designs, list the Synergy baseline number (just the number part of the Synergy baseline name) of the SWC Design baseline being implemented. E.g., for SF001A_Assi_Design_1.3.1, this field would say "1.3.1" | |||||||||||||||
| Intended Use: Indicate that the the versioning was confirmed by the peer reviewer(s). | |||||||||||||||
| Intended Use: To confirm no compiler errors or warnings exist for the code under review (warnings from contract header files may be ignored). | |||||||||||||||
| Intended Use: list version/revision of latest released Software Design and Coding Standards document. | |||||||||||||||
| Davinci Files | |||||||||||||||
| Intended Use: Identify if previous version was compared and only the expected change(s) was present. This is for text files only, not binary or GUIs | |||||||||||||||
| Polyspace | |||||||||||||||
| eg. 2013b | |||||||||||||||
| Integration manual | |||||||||||||||
| Intended Use: Identify which file is being reviewed | |||||||||||||||
| Intended Use: Identify which version of the integration manual has been reviewed. | |||||||||||||||
| Synergy | |||||||||||||||
| Refer to EA4 Common Naming Conventions document, section “Synergy Baseline Names for core components” | |||||||||||||||
| The following subprojects should be included for all component implementations: • AR200A_ArSuprt_Impl • AR201A_ArCplrSuprt_Impl • TL101A_CptRteGen • TL103A_CplrSuprt • TL109A_SwcSuprt • Corresponding _Design project used for the implementation The following subprojects should be included as needed by each component: • AR10xx_Nxtr*_Impl library components as needed by each component • AR202x_MicroCtrlrSuprt_Impl as needed (for register header files for components making direct register access)[add notes about when to add a stub header file] • Xx999x_xxxxGlbPrm_Impl as needed by each component • TL105A_Artt for components with generated content The following should NOT be included as subprojects: • TL107x_DavinciSuprt (aka StdDef) • TL100A_QACSuprt (QAC subproject was previously included but should be removed going forward) • Any other component (not mentioned anywhere above) whose .h file is needed. For these components, a “stub” .h file should be created, containing only the multiple include protection and the definitions and function prototypes actually needed by the component with the #include, and placed in the “including” component’s local\include folder. | |||||||||||||||
| misc in Summary sheet | |||||||||||||||
| (integrator, designer, unit test coordinator, etc.) | |||||||||||||||
| For a new component, use number of lines in all source files reviewed, including files in the src and include folders and any generated cfg.h and cfg.c files. For a changed component, try to add up how many lines, including comments and blank lines, were in the changed areas that were reviewed. Not just the actual changed lines, but the number of lines in the blocks of code you had to look at to review the change. | |||||||||||||||
| add up the number of ports, number of PIM variables, number if IRVs, number of runnables, number of NVM blocks in the component (all of them for review of a new component, the new and modified ones for review of a change) | |||||||||||||||
| add the number of pages in the MDD and integration manual for a new component; for a modified component, count the number of pages that contained a change. | |||||||||||||||
| Reviewer | Required attendance for this type of change | Review spreadsheet tab(s) | |||||||||||||
| Component group peer | All | All | |||||||||||||
| Component owner and/or SWC Design author | *Initial creation of any new component *Simulink model changes (any change to the model other than just updating the change log) | Source | |||||||||||||
| Integrator and/or SW lead of first program planning to use the component | *Initial creation of any new component *new or changed NVM blocks, NVM datatypes, or NVM usage (added or removed or changed NVM API calls in any runnable) *Major rev (X changed in the X.Y.X design baseline number; means there was a component interface change) *new or changed config params *all MM component changes | Davinci files, Integration manual, source for NVM changes and for all MM component changes. | |||||||||||||
| Unit test coordinator | Fixes for coverage issues | Source | |||||||||||||
| SQA | None | None | |||||||||||||
For each reviewer category listed on each tab, there should either be • the name of the reviewer who attended or • a comment indicating o why that reviewer was not required for this change or o who approved holding the review without that required reviewer (approval must be from the software manager or a software supervisor) | |||||||||||||||
Sheet 7: Version History
| File Version History | ||||||
| Version | Description | Author(s) | Revision Date | Approved By | Approved Date | Status |
| Draft/ Released | ||||||
| Template Version History | ||||||
| Version | Description | Author(s) | Revision Date | Approved By | Approved Date | Status |
| 1.0 | Initial Version | SW Engineering team | 24-May-15 | NA | NA | Released |
| 1.01 | Changed name to be EA4 specific | SW Engineering team | 25-Jun-15 | NA | NA | Released |
| 1.02 | Modified Summary Sheet General Guidelines, Clarified wording on first item in Synergy project sheet. | SW Engineering team | 30-Jul-15 | NA | NA | Released |
| 1.02 | Made corrections and clarifications to Source Code check list. | SW Engineering team | 30-Jul-15 | NA | NA | Released |
| 1.02 | updated Davinci, MDD, and Polyspace/QAC tabs | SW Engineering team | 30-Jul-15 | NA | NA | Released |
| 1.03 | Aligned to portal version guidelines | Umesh Sambhari | 21-Nov-17 | NA | NA | Released |
| 2.00 | Summary sheet template: Changed title to indicate Implementation Peer Review Corrected and/or clarified mouse hover comments, added instructions, renamed some fields. Changed the default setting to "No" on the items reviewed | SW Engineering team | 29-Nov-17 | Lonnie Newton, Steven Horwath, Kevin Smith, Lucas Wendling, Vinod Shankar | NA | Released |
| Source code template: Removed hyperlink for naming conventions, corrected name of naming conventions document, added version field for naming conventions document. Changed item about requirements tags to reflect that they should be removed Added clarification that all combinations of conditionally compiled code must be checked Item about accurately implementing SWC Design is modified and a new item added, both to clarify where to look when determining needed changes. Added point for version of common naming conventions Reworded multiple items for clarity | SW Engineering team | 29-Nov-17 | ||||
| Synergy project template: added items for file/folder structure added point on .gpj file in tools folder | SW Engineering team | 29-Nov-17 | ||||
| Davinci files template: Clarified the StdDef item Added new item for OBSOLETE Clarified item on datadict.m comparison Removed the references to .m file helper tool Updated to reflect that all component should now use only implementation data types Added points on PIMs and NVMs | SW Engineering team | 29-Nov-17 | ||||
| All template tabs: Added/clarified/removed mouse hover comments. Updated Review Board section Removed the gridlines from all tabs Updated titles to say "Nexteer SWC Implementation Peer Review" Changed all occurences of "FDD" to "SWC Design" | SW Engineering team | 29-Nov-17 | ||||
| 2.01 | Added a help tab and appropriate links Added field on Summary sheet to report hours spent and content reviewed Changed wording in an item in Polyspace tab and Source code tab | SW Engineering team | 21-Feb-18 | Lonnie Newton, Steven Horwath, Kevin Smith, Lucas Wendling, Vinod Shankar | 21-Feb-18 | Released |