Assi_MDD
Module Design Document
For
Assist
VERSION: 2.0
DATE: 09-AUG-2016
Prepared By:
Nick Saxton
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 | SB | 1.0 | 02-JUN-2015 |
| 2 | Quality update | NS | 2.0 | 09-AUG-2016 |
Table of Contents
3 Assi & High-Level Description 7
4 Design details of software module 8
4.1 Graphical representation of Assi 8
5.1 User defined typedef definition/declaration 9
5.2 Variable definition for enumerated types 9
6.1 Program(fixed) Constants 10
6.1.2 Module specific Lookup Tables Constants 10
7 Software Module Implementation 11
7.2 Initialization Functions 11
7.3.1.2 Store Module Inputs to Local copies 11
7.3.1.3 (Processing of function)……… 11
7.3.1.4 Store Local copy of outputs into Module Outputs 11
7.6 Serial Communication Functions 12
7.7 Local Function/Macro Definitions 12
7.8 GLObAL Function/Macro Definitions 12
9 Known Limitations With Design 14
Abbrevations And Acronyms
| Abbreviation | Description |
| DFD | Design functional diagram |
| MDD | Module design Document |
| <ADD more to the table if applicable> | |
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 4.00.00 |
| <2> | <Software Naming Conventions> | Process 4.00.00 |
| <3> | <Coding standards> | Process 4.00.00 |
| <4> | FDD - SF001A_Assi_Design | See Synergy Subproject version |
| <Add if more available> |
Assi & High-Level Description
Refer FDD
Design details of software module
Graphical representation of Assi
Data Flow Diagram
Module level DFD
Sub-Module level DFD
COMPONENT FLOW DIAGRAM
Variable Data Dictionary
User defined typedef definition/declaration
| Typedef Name | Element Name | User Defined Type | Legal Range (min) | Legal Range (max) |
| N/A | ||||
Variable definition for enumerated types
| Enum Name | Element Name | Value |
| N/A | <(Variable name qualified Refer[2])> | <Define the value > |
Constant Data Dictionary
Program(fixed) Constants
Embedded Constants
< All program specific constants will be defined in detail >
Local
| Constant Name | Resolution | Units | Value |
| Refer constants from .m file |
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 |
| Refer constants from .m file |
Module specific Lookup Tables Constants
<(This is for lookup tables (arrays) with fixed values, same name as other tables)>
| Constant Name | Resolution | Value | Software Segment |
| Refer .m file |
Software Module Implementation
Sub-Module Functions
NONE
Initialization Functions
None
PERIODIC FUNCTIONS
(Note: For multiple periodic functions, insert new headers at the “Header 2” level – subset of “7.3 Periodic Functions” and follow the same sub-section design shown below). If none required, place the text “None”)>
Per: Assiper1
Design Rationale
Fault Injection client call is conditional compiled based on “FLTINJENA” build constant.
Store Module Inputs to Local copies
Refer to FDD
(Processing of function)………
Refer to FDD
Store Local copy of outputs into Module Outputs
Refer to FDD
Non PERIODIC FUNCTIONS
None
Interrupt Functions
None
Serial Communication Functions
None
Local Function/Macro Definitions
None
GLObAL Function/Macro Definitions
None
TRANSIENT FUNCTIONS
Unit Test Considerations
None