This is the multi-page printable view of this section. Click here to print.
ShtdnMech
1 - Data Dictionary
Overview
Change LogVariable Dictionary
Calibration Dictionary
Global Constants
Template
Help
Sheet 1: Change Log
| Shutdown Mechanisms - Rev 1 | <- Global Program / Module Name | ||||||
| Revision | Author | Date | Change Description | Data Dictionary Type: | Component | ||
| 1.0 | OT | 30-Jul-12 | Initial Version | ||||
Sheet 2: Variable Dictionary
Sheet 3: Calibration Dictionary
Sheet 4: Global Constants
| Shutdown Mechanisms - Rev 1 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Variable Information (Global Variables Only) | Achieved in Software Design | Used in Module List | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Layer 2 | Layer 3 | Layer 4 | Layer 5 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Constant Name | Description | Uints | Type | Engineering Value | ADC | ADC Diagnostics | Data Memory Verification | DC Link Power Control | DSP Computational Integrity | DSP SPI driver | Event Manager Driver | External Memory Driver | Flash Programming Exec | GPIO | Illegal OpCode Handler | Interrupt Handler | Motor Current Driver | Motor Driver Diagnostics | Motor Position Driver | Phase Feedback Capture | Powerdown Control | Primary Shutdown Control | Program Flow | Program Memory Diagnostic | PWM Duty Cycle | Redundant Memory Check | Redundant Rapid Shutdown | Scheduler | Stack Monitor | State Dependent Task List | System Boot & Startup | System Control | Temperature Sensor Diagnostic | Unused Interrupt Handler | Utilization Monitor | Watchdog Dirver | Smith | Battery Voltage | Battery Voltage Diagnostics | Diagnostic CTC Manager | Diagnostic Manager | Diagnostics Application Services | EOL TorqueTest | Flash Boot Loader | Flight Recorder | Handwheel Position | Handwheel Torque | Motor Control Output Conversion | Motor Position Diagnostics | Motor Position Initialization | Motor Velocity | Motor Velocity Tachometer | Serial Communications I/O | Serial Communications Services | States and Modes | Tuning Select | Vehicle Power Mode | Vehicle Speed | Controller Polarity | Current Estimation | Handwheel Velocity | Inverse Motor Model | Motor Temperature Estimation | Motor Torque Limit | Output Reasonableness Dianostic | Parameter Estimation | Quadrant and rate Detection | Active Pull Compensation | Assist | Damping | Duty Cycle | Kinematic Integrity Diagnostic | Long Term Vehicle Speed Diagnostic | Max Assist Limit | Return | State Output Control | Torque Output |
Sheet 5: Template
| 2.2a | Data File: | |||||
| Header: | extern <TYPE><TAB><NAME>; | |||||
| Source: | #pragma DATA_SECTION(<ROOTNAME>, "<SEGMENT>"); <TYPE> <NAME>; | |||||
| EOL Constants: | ||||||
| Header: | extern <TYPE><TAB><NAME>; | |||||
| Source: | #pragma DATA_SECTION(<ROOTNAME>, "<SEGMENT>"); <TYPE> <NAME>; | |||||
| Global (Embedded) Constants: | ||||||
| Header: | #define <NAME><COL40><VALUE> | |||||
| A2L Name | ||||||
| Measurement: | rte_<SWC>_<NAME> | |||||
| Calibration Constants: | ||||||
| Tuning ID: | ||||||
| Tuning: | N | Index Range: | ||||
| Header: | extern CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME>; | |||||
| Source: | #pragma DATA_SECTION(<ROOTNAME>, ".<SEGMENT>"); CONST(<AUTOSAR_TYPE>, CAL_CONST) <NAME> = <VALUE>; | |||||
| eCal: | <NAME> | |||||
| Tuning: | Y | Index Range: | ||||
| Header: | <NONCRITICAL> #define <ROOTNAME><TAB>k_N_CalNC_Cnt_Str.<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> #define <ROOTNAME><TAB>k_S_CalSC_Cnt_Str.<ROOTNAME> <SAFETYCRITICAL> | |||||
| Source: | ||||||
| eCal: | <NONCRITICAL> k_N_CalNC_Cnt_Str.<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> k_S_CalSC_Cnt_Str.<ROOTNAME> <SAFETYCRITICAL> | |||||
| Tuning: | P | Index Range: | ||||
| Header: | <NONCRITICAL> #define <ROOTNAME><TAB>k_N_CalNC_Cnt_Str.Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> #define <ROOTNAME><TAB>k_S_CalSC_Cnt_Str.SC_Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <SAFETYCRITICAL> | |||||
| Source: | ||||||
| eCal: | <NONCRITICAL> k_N_CalNC_Cnt_Str.Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <NONCRITICAL> <SAFETYCRITICAL> k_S_CalSC_Cnt_Str.SC_Personality[L3_S_CalPersSelect_Cnt_G_u16].<ROOTNAME> <SAFETYCRITICAL> | |||||
Sheet 6: Help
| Short cut | Macro | Sescription |
| Ctrl-q | ClearDataDictFilter | Will clear all autofilters on the Global Data Dictionary |
| DFD_Create | Creates a Series of Data Flow Worksheet Pages from the information in the data dictionary. If Data Flow Worksheet pages already exist, they will be deleted first. | |
| DFD_Delete | Will clear all Data Flow Diagram pages from the Data Dictionary. This will make the file smaller for archiving. | |
| DFD_Print | Formate and prepares to print the Data Flow Worksheet pages. |
2 - Shutdown_Mechanisms_MDD
Module –
High-Level Description
This module handles diagnostic data during an F1 fault. The actual signal control is performed in other modules which “own” the signal.
Figures
Component Diagram
Variable Data Dictionary
For details on module input / output variable, refer to the Data Dictionary for the application. Input / output variable names are listed here for reference.
| Module Inputs | Module Outputs | |
|---|---|---|
| None | None | |
Module Internal Variables
This section identifies the name, range and resolutions for module specific data created by this module. If there are no range restrictions on the variable, the term “FULL” is placed into the table for legal range.
| Variable Name | Resolution | Legal Range (min) | Legal Range (max) | Software Segment |
|---|---|---|---|---|
| ESMErrOutStat_Cnt_D_u08 | 1 | 0 | 1 | SHTDNMECH_START_SEC_VAR_CLEARED_8 |
| SysFault2Stat_Cnt_D_u08 | 8 | 0 | 8 | SHTDNMECH_START_SEC_VAR_CLEARED_8 |
| GateDrvResetStat_Cnt_D_u32 | 524288 | 0 | 524288 | SHTDNMECH_START_SEC_VAR_CLEARED_32 |
| NHETPwmStat_Cnt_D_u32 | 22282308 | 0 | 22282308 | SHTDNMECH_START_SEC_VAR_CLEARED_32 |
User defined typedef definition/declaration
This section documents any user types uniquely used for the module.
| Typedef Name | Element Name | User Defined Type | Legal Range (min) | Legal Range (max) |
|---|---|---|---|---|
| None |
Constant Data Dictionary
Calibration Constants
This section lists the calibrations used by the module. For details on calibration constants, refer to the Data Dictionary for the application.
| Constant Name |
|---|
| None |
Program(fixed) Constants
Embedded Constants
All embedded constants whose values are provided in Eng units will be evaluated to the equivalent counts by using the FPM_InitFixedPoint_m() macro within the #define statement.
Local
| Constant Name | Resolution | Units | Value |
|---|---|---|---|
| D_ESMERROUTSTAT_CNT_U08 | 1 | Counts | 0x01 |
| D_SYSFAULT2STAT_CNT_U08 | 1 | Counts | 0x08 |
| D_GATEDRVRESETSTAT_CNT_U32 | 1 | Counts | 0x00080000 |
| D_NHETPWMSTAT_CNT_U32 | 1 | Counts | 0x01540044 |
Global
This section lists the global constants used by the module. For details on global constants, refer to the Data Dictionary for the application.
| Constant Name |
|---|
| D_ZERO_CNT_U8 |
| D_ZERO_CNT_U32 |
Module specific Lookup Tables Constants
| Constant Name | Resolution | Value | Software Segment |
|---|---|---|---|
| None |
Functions/Macros used by the Sub-Modules
Library Functions / Macros
The library and functions / Macros that are called by the various sub modules are identified below,
None
Data Hiding Functions
None
Global Functions/Macros Defined by this Module
None
Local Functions/Macros Used by this MDD only
None
Software Module Implementation
Runtime Environment (RTE) Initial Values
This section lists the initial values of data written by this module but controlled by the RTE. After RTE initialization, the data in this table will contain these values.
| Data | Value |
|---|---|
| None |
Initialization Functions
None
Periodic Functions
Per: _Per1
Design Rationale
None
Program Flow Start
Rte_Call_ShtdnMech_Per1_CP0_CheckpointReached()
Store Module Inputs to Local copies
Rte_Call_FetDrvReset_OP_GET(&FetDrvReset_Cnt_T_lgc)
Rte_Call_SysFault2_OP_GET(&SysFault2_Cnt_T_lgc)
Rte_Call_SysFault3_OP_GET(&SysFault3_Cnt_T_lgc)
Status Signals for Testing
Store Local copy of outputs into Module Outputs
None
Program Flow End
Rte_Call_ShtdnMech_Per1_CP1_CheckpointReached()
Fault Recovery Functions
None
Shutdown Functions
None
Interrupt Functions
None
Serial Communication Functions
None
Transition Functions
None
Execution Requirements
Execution Rates for sub-modules called by the Scheduler
This table serves as reference for the Scheduler design
| Function Name | Calling Frequency | System State(s) in which the function is called |
|---|---|---|
| ShtdnMech_Per1 | 10 ms | ALL |
Execution Requirements for Serial Communication Functions
| Function Name | Sub-Module called by (Serial Comm Function Name) |
|---|---|
| None |
Memory Map Definition Requirements
Sub Modules (Functions)
This table identifies the software segments for functions identified in this module.
| Name of Sub Module | Software Segment |
|---|---|
| ShtdnMech_Per1 | RTE_START_SEC_SA_SHTDNMECH_APPL_CODE |
Local Functions
This table identifies the software segments for local functions identified in this module.
| Name of Sub Module | Software Segment |
|---|---|
| None |
Known Issues / Limitations With Design
None
Revision Control Log
| Item # | Rev # | Change Description | Date | Author Initials |
|---|---|---|---|---|
| 1 | 1.0 | Initial Version | 25-Jul-12 | OT |
| 2 | 2.0 | Updates to remove NHETPINDIS, removed control of SysFault3 pin (this is handled in hardware). Only control NHET Direction on entering operate state (instead of exiting disable state) as other pins are controlled by other modules and NHET pins should remain inputs in warm init. | 03-Aug-12 | LWW |
| 3 | 3.0 | Update for anomaly 3640 correction | 22-Aug-12 | LWW |
| 4 | 4.0 | Added checkpoints and memmap software segment is updated for static variables | 27-Sep-12 | Selva |
| 5 | 5.0 | Implemented FDD 18B v003 (removed signal control from module) | 17-Oct-12 | OT |
3 - ShtdnMech_UnitTestReports
Overview
Unit Test InformationModule Definitions
Variable Range
ShtdnMech_Per1
ShtdnMech_Per1() B
Sheet 1: Unit Test Information
| 1.0a | |||||
| Nexteer EPS Unit Test Tool | |||||
| Rev:2.7b | |||||
| Name of Tester: | Rajsi Tyagi | Include Files: | |||
| Code File(s) Under Test: | Sa_ShtdnMech.c | ||||
| Code File(s) Version: | 6 | ||||
| Module Design Document: | Shutdown_Mechanisms_MDD.docx | ||||
| Module Design Document Version: | 5 | ||||
| Unit Test Plan Version: | 2 | ||||
| Optimization Level: | Level 2 | ||||
| Compiler (CodeGen) Version: | TMS470_4.9.2 | ||||
| Model Type: | Excel Macro | ||||
| Model Version: | |||||
| Special Test Requirements: | |||||
| Test Date: | 11/22/2012 | ||||
| Comments: | Note: Full range is taken for the register testing as suggested by developer. | ||||
| Index of Tests: | |||||
| Test Set up | Test Worksheets | Test Status | Run TS | ||
| ShtdnMech_Per1 | ShtdnMech_Per1() B | -- | -- | 11 | |
Sheet 2: Module Definitions
| |||||||||||
| Nexteer EPS Unit Test Tool | |||||||||||
| Rev:2.7b | |||||||||||
| Module Definitions | |||||||||||
| Module Test Functions | Module Set/Read Variables | Module Function Stubs | |||||||||
| Return Type | Name | Parameter Prototype | Scope | Type | Name | Default Value | Return Type | Name | Parameter Prototype | ||
| void | ShtdnMech_Per1 | (void) | M | uint8 | ESMErrOutStat_Cnt_D_u08 | 0 | Boolean | FetDrvReset_OP_GET | (void) | ||
| M | uint8 | SysFault2Stat_Cnt_D_u08 | 0 | Boolean | SysFault2_OP_GET | (void) | |||||
| M | uint32 | GateDrvResetStat_Cnt_D_u32 | 0 | Boolean | SysFault3_OP_GET | (void) | |||||
| M | uint32 | NHETPwmStat_Cnt_D_u32 | 0 | void | CP0_CheckpointReached | (void) | |||||
| G | T_NHET.UINT32 | NHET0.NHETDIR | void | CP1_CheckpointReached | (void) | ||||||
Sheet 3: Variable Range
| |||||||||||
| Nexteer EPS Unit Test Tool | |||||||||||
| Rev:2.7b | |||||||||||
| Variable Range Definitions | |||||||||||
| Variable Name | Max Value | Min Value | |||||||||
| ESMErrOutStat_Cnt_D_u08 | |||||||||||
| SysFault2Stat_Cnt_D_u08 | |||||||||||
| GateDrvResetStat_Cnt_D_u32 | |||||||||||
| NHETPwmStat_Cnt_D_u32 | |||||||||||
| NHET0.NHETPINDIS | |||||||||||
| NHET0.NHETDIR | |||||||||||
Sheet 4: ShtdnMech_Per1
| |||||
| Nexteer EPS Unit Test Tool | |||||
| Rev:2.7b | |||||
| Test Setup | |||||
| Number Of Calibrations | 0 | ||||
| Number Of Calibration Sets | 0 | ||||
| Calibration Sheet | |||||
| Function(s) Under Test | Variables | Function Stubs | |||
| Function Name | TestType | Test Vectors | Set | Read | Function Name |
| ShtdnMech_Per1 | B | 11 | NHET0.NHETDIR | FetDrvReset_OP_GET | |
| SysFault2_OP_GET | |||||
| SysFault3_OP_GET | |||||
| CP0_CheckpointReached | |||||
| CP1_CheckpointReached | |||||
Sheet 5: ShtdnMech_Per1() B
| ShtdnMech_Per1 | TS | -- | ||||||||||||||||
| B | I/P | Func Stub Return Val | Func Stub Return Val | Func Stub Return Val | Func Stub Counter | Func Stub Counter | Func Stub Counter | Func Stub Counter | Func Stub Counter | Expected Stub Cnt | Expected Stub Cnt | Expected Stub Cnt | Expected Stub Cnt | Expected Stub Cnt | Test Status | Perf. Metrics | Comments | |
| Vector Number | Vector Description | NHET0.NHETDIR | FetDrvReset_OP_GET | SysFault2_OP_GET | SysFault3_OP_GET | FetDrvReset_OP_GET | SysFault2_OP_GET | SysFault3_OP_GET | CP0_CheckpointReached | CP1_CheckpointReached | FetDrvReset_OP_GET | SysFault2_OP_GET | SysFault3_OP_GET | CP0_CheckpointReached | CP1_CheckpointReached | P/F | CPU Cycles | |
| 1 | NHET0.NHETDIR min | 0 | 1 | 0 | 0 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 2 | NHET0.NHETDIR max | 4294967295 | 1 | 0 | 0 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 3 | NHET0.NHETDIR pos | 634636 | 0 | 1 | 1 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 4 | FetDrvReset_OP_GET min | 8696 | 0 | 0 | 1 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 5 | FetDrvReset_OP_GET max | 89202 | 1 | 1 | 0 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 6 | SysFault2_OP_GET min | 6778 | 0 | 0 | 1 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 7 | SysFault2_OP_GET max | 42344 | 1 | 1 | 0 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 8 | SysFault3_OP_GET min | 7768 | 0 | 1 | 0 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 9 | SysFault3_OP_GET max | 423454 | 1 | 0 | 1 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 10 | All min | 0 | 0 | 0 | 0 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||
| 11 | All max | 4294967295 | 1 | 1 | 1 | -- | -- | -- | -- | -- | 1 | 1 | 1 | 1 | 1 | -- | ||