StOutpCtrl_MDD

Module Design Document

For

StOutpCtrl

VERSION: 2.

DATE: 29-Mar-2016

Prepared By:

Akilan Rathakrishnan

Location: The official version of this document is stored in the Nexteer Configuration Management System.

Revision History

Table of Contents

1 Abbrevations And Acronyms 5

2 References 6

3 StOutpCtrl - High-Level Description 7

4 Design details of software module 8

4.1 Graphical representation of StOutpCtrl 8

4.2 Data Flow Diagram 8

4.2.1 Module level DFD 8

4.2.2 Sub-Module level DFD 8

4.3 COMPONENT FLOW DIAGRAM 8

5 Variable Data Dictionary 9

5.1 User defined typedef definition/declaration 9

5.2 Variable definition for enumerated types 9

6 Constant Data Dictionary 10

6.1 Program(fixed) Constants 10

6.1.1 Embedded Constants 10

6.1.1.1 Local 10

6.1.1.2 Global 10

6.1.2 Module specific Lookup Tables Constants 10

7 Software Module Implementation 11

7.1 Sub-Module Functions 11

7.1.1 Initialization Functions 11

7.1.1.1 INIT: StOutpCtrlInit1 11

7.1.1.2 Design Rationale 11

7.1.1.3 Store Module Inputs to Local copies 11

7.1.1.4 (Processing of function)……… 11

7.1.1.5 Store Local copy of outputs into Module Outputs 11

7.1.2 PERIODIC FUNCTIONS 11

7.1.2.1 Per: StOutpCtrlPer1 11

7.1.2.2 Design Rationale 11

7.1.2.3 Store Module Inputs to Local copies 11

7.1.2.4 (Processing of function)……… 11

7.1.2.5 Store Local copy of outputs into Module Outputs 11

7.2 Interrupt Functions 11

7.3 Serial Communication Functions 11

7.4 Local Function/Macro Definitions 12

7.4.1 Local Function #1: RateLimit 12

7.4.1.1 Description 12

7.4.1.2 Design Rationale 12

7.4.2 Local Function #1: RateSource 12

7.4.2.1 Description 12

7.4.2.2 Design Rationale 12

7.5 GLObAL Function/Macro Definitions 12

7.5.1 GLObAL Function #1 12

7.5.1.1 Description 12

7.6 TRANSIENT FUNCTIONS 13

8 Known Limitations With Design 14

9 UNIT TEST CONSIDERATION 15

10 Appendix 16

Abbrevations And Acronyms

References

This section lists the title & version of all the documents that are referred for development of this document

StOutpCtrl - High-Level Description

Refer FDD

Design details of software module

Graphical representation of StOutpCtrl

Data Flow Diagram

N/A

Module level DFD

N/A

Sub-Module level DFD

N/A

COMPONENT FLOW DIAGRAM

N/A

Variable Data Dictionary

User defined typedef definition/declaration

<This section documents any user types uniquely used for the module.>

Variable definition for enumerated types

Constant Data Dictionary

Program(fixed) Constants

Embedded Constants

< All program specific constants will be defined in detail >

Local

Global

<This section lists the global constants used by the module. For details on global constants, refer to the Data Dictionary for the application>

Module specific Lookup Tables Constants

<(This is for lookup tables (arrays) with fixed values, same name as other tables)>

Software Module Implementation

Sub-Module Functions

None

Initialization Functions

INIT: StOutpCtrlInit1

Design Rationale

None

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

PERIODIC FUNCTIONS

(Note: For multiple periodic functions, insert new headers at the “Header 2” level – subset of “7.1.2 Periodic Functions” and follow the same sub-section design shown below). If none required, place the text “None”)>

Per: StOutpCtrlPer1

Design Rationale

None

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

Interrupt Functions

None

Serial Communication Functions

None

Local Function/Macro Definitions

<If these are numerous and defined in a separate source file then reference the source file only.>

Local Function #1: RateLimit

Description

Implements "Rate Limit" model block in FDD -- selects ramp rate from input rate limits.

Design Rationale

FDD does not show a default case on the switch/case block in this function because none is required – all possible values of the switch variable (which is internal to this component) are covered by the cases shown. However a default clause is required by MISRA Rule 15.3. Therefore the default label was placed with the final case label in the code; this is functionally equivalent to the FDD and satisfies the MISRA rule.

Local Function #1: RateSource

Description

Implements "Rate Source" model block in FDD -- selects scale factor from input rate scales.

Design Rationale

FDD does not show a default case on the switch/case block in this function because none is required – all possible values of the switch variable (which is internal to this component) are covered by the cases shown. However a default clause is required by MISRA Rule 15.3. Therefore the default label was placed with the final case label in the code; this is functionally equivalent to the FDD and satisfies the MISRA rule.

GLObAL Function/Macro Definitions

GLObAL Function #1

Description

N/A

TRANSIENT FUNCTIONS

None

Known Limitations With Design

1. None

UNIT TEST CONSIDERATION

None

Appendix

None