National Instruments NI MATRIX Calling UCBs

Chapter 3 Ada Language Reference

AutoCode Reference 3-12 ni.com

Calling UCBs

Every one of the following arguments will be passed for each call to the

UCB in the following order:

INFO, T, U, NU, X, XD, NX, Y, NY, R_P, I_P

Within the UCB, the elements of all the array variables (U, X, XD, Y, R_P,

I_P) must be accessed as in the following example:

U(U'first), U(U'first+1), ... U(U'first+NU-1)

X(X'first), X(X'first+1), ... X(X'first+NX-1)

Make sure to access the elements in the above manner as all the arrays are

passed as array slices. The sizes of R_P and I_P must be entered in the

UCB block form to ensure that proper storage is allocated in the caller.

Also, the initial conditions for states have to be specified in the form.

Table3-5 lists the type and purpose of UCB arguments used in the fixed

calling method.

Table 3-5. UCB Calling Arguments and Data Types

Argument Data Type Description

INFO:in out RT_STATUS_RECORD A structure representing operation requests and

status.

T:in RT_DURATION Elapsed time.

U:in RT_REAL_ARRAY An array (of size NU) of inputs to the UCB.

NU:in RT_INTEGER The number of inputs to the UCB.

X:in out RT_REAL_ARRAY An array (of size NX) of state variables of the UCB.

XD:in out RT_REAL_ARRAY An array (of size NX). Defines the next discrete

states of X for discrete subsystems, and the derivative

of X for the continuous subsystems.

NX:in RT_INTEGER The number of states (and next states).

Y:in out RT_REAL_ARRAY An array (of size NX). Defines the next discrete

states of X for discrete subsystems, and the derivative

of X for the continuous subsystems.

NY:in RT_REAL_ARRAY The number of outputs from the UCB.

R_P:in out RT_REAL_ARRAY An array of real parameters.

NRP:in out RT_INTEGER The number of real parameters.

Contents

Main Page Important Information Warranty Copyright Trademarks Patents Conventions Contents Chapter 1 Introduction Chapter 2 C Language Reference Chapter 3 Ada Language Reference Page Chapter 4 Generating Code for Real-Time Operating Systems Chapter 5 Generated Code Architecture Page Page Chapter 6 Vectorized Code Generation Chapter 7 Code Optimization Chapter 8 AutoCode Sim Cdelay Scheduler Chapter 9 Global Scope Signals and Parameterless Procedures Appendix A Technical Support and Professional Services Index Introduction Manual Organization General Information Configuration File Language-Specific Information Structure and Content of the Generated Code Using MATRIXx Help Additional Netscape Information Related Publications C Language Reference Stand-Alone Simulation Compiling on Various Supported Platforms Stand-Alone Library System-Specific Files Page Page Target-Specific Utilities enable( ), disable( ), and background( ) Functions error( ) and fatalerr( ) Functions fatalerr( ): Stand-Alone Utilities Detected Errors ERROR: Conditions Detected in the Generated Code Implementation_Initialize( ) Function Implementation_Terminate() Function External_Input ( ) Function External_Output ( ) Function UserCode Blocks Linking Handwritten UCBs with AutoCode Applications Page Implementing Handwritten UCBs Page Figure 2-2. Linking Handwritten UCBs with AutoCode Applications File Name: Linking Handwritten UCBs (for AutoCode) with SystemBuild Page Variable Interface UCB Interface Ordering Interface Examples Inputs and Outputs Function Prototype Linking a Variable Interface UCB with the Simulator Procedure SuperBlocks Generating Reusable Procedures Linking Procedures with the SystemBuild Simulator proc_ucb_hook. Refer to the Template Programming Language User Guide. Figure 2-4. Linking Generated Reusable Procedures Linking Procedures with Real-Time Applications or Simulator Invoking Generated Procedures Directly Page Invoking Procedures Using Generated UCB Wrapper Function Invoking Procedures Using Generated Subsystem Function C Fixed-Point Arithmetic Fixed-Point AutoCode/C Implementation Page Generated Code with Fixed-Point Variables Fixed-Point Data Types Page User Types Overflow Protection Stand-Alone Files Macro Interface Function Interface Page Fixed-Point Conversion and Arithmetic Macros Conversion Macros Figure 2-6. AutoCode/C Conversion Macros for Fixed-to-Fixed Conversions sbALIGNubp(n,rp) sr wr ALIGN so wo p q(n, rp) i ALIGN so wo p (n, rp) sr wr ALIGN i p (n, rp) Arithmetic Macros Page Implementation of the Addition and Subtraction Macros Method 1: Using Wordsize Extension Method 2: Not Using Wordsize Extension Selecting Wordsize Extension in the Preprocessor Macro 32-Bit Multiplication and Division Macros 32-Bit Multiplication 32-Bit Division 16-Bit by 8-Bit Division 32-Bit by 16-Bit Division Fixed-Point Relational Macros Some Relevant Issues Ada Language Reference Stand-Alone Simulation Supported Ada Compilers for the Stand-Alone Library Supplied Templates ada_rt.tpl Template ada_sim.tpl Template ada_fxpt_sys.tpl Template ada_fxpt_sub.tpl Template Stand-Alone Library System-Specific Files Page Data Types Target-Specific Utilities Enable( ), Disable( ), and Background( ) Procedures Error Procedure( ) Procedure Implementation_Initialize( ) Procedure Page Implementation_Terminate( ) Procedure External_Input ( ) Procedure External_Output( ) Procedure UserCode Blocks Linking Handwritten UCBs with AutoCode Applications Calling UCBs Page Procedure SuperBlocks Generating Reusable Procedures Linking Procedures with Real-Time Applications or Simulator Page Ada Fixed-Point Arithmetic How to Generate Real-Time Code Fixed-Point AutoCode/Ada Architecture Fixed-Point Data Types Generic Functions Instantiated Functions Package Dependencies Generated Code with Fixed-Point Variables User Types System-Level Parameters to Generate User Types Overflow Protection Stand-Alone Files Compilation Example Page Fixed-Point Type Declarations Generic Functions Page Page Bit-Wise Functions Instantiated Functions Package Operator Instantiations Conversion Function Instantiations Sample Package Example3-3 shows a generated RT_FIXED_OPERATORS package. Addition and Subtraction Functions Page Multiplication and Division Functions 32-Bit Multiplication 32-Bit Division Conversion Functions Language-Defined Conversion Truncation Conversion Explicit Rounding Conversion Using System-Level Parameters to Generate Instantiations Using Subsystem-Level Parameters to Generate Instantiations System Scope Operators and Conversions Known Ada Compiler Problems Comparing Results to SystemBuilds Simulator No-Op Conversion Function Page Generating Code for Real-Time Operating Systems Real-Time Operating System Configuration File Configuration Items Table Syntax Table Naming Convention Table Column Contents Table Orderings File Comments RTOS Configuration File Contents Scheduler Priority Table Subsystem Table Interrupt Procedure SuperBlock Table Background Procedure SuperBlock Table Startup Procedure SuperBlock Table Processor IP Name Table Version Table Using the Configuration File Page Generated Code Architecture Symbolic Name Creation Default Names Signal Naming Duplicate Names Selection of a Signal Name Subsystem and Procedure Boundaries Typecheck Feature and Data Types Global Storage Percent vars (%var) Global Variable Blocks Sequencing Variable Blocks Global Variable Block and %var Equivalence Optimization for Read-From Variable Blocks Global Scope Signal Capability Subsystems Discrete and Continuous SuperBlocks Versus Subsystems Top-Level SuperBlock Block Ordering Interface Layers Scheduler External Interface Layer System External Interface Layer Discrete Subsystem Interface Layer Single-Rate System Multi-Rate System Sample and Hold Static Data Within Subsystems iinfo R_P and I_P State Data Procedure Data Pre-init Phase Init, Output, and State Phases Copy Back and Duplicates Error Handling Standard Procedures Structure-Based Interface Unrolled Interface Phases and Error Handling Referenced Percent Variables Page Page Procedure Arguments U, Y, S, and I Page Page Extended Procedure Information Structure Caller Identification Compatibility Issues Macro Procedure Interface Asynchronous Procedures Interrupt Background Startup Changing %var Values During Startup Condition Block Default Mode No-Default Mode Sequential Mode BlockScript Block Inputs and Outputs Environment Variables Local Variables Init, Output, and State Phases Default Phase States Local Variables and Phases Discrete Semantics Page Continuous Semantics Looping Concepts Term ino log y Loops and Scalar Code Rolling Loops with Scalar Code Generation Vectorized Code Types of Loops Examples of Rolled and Unrolled Loops Parameters Using Parameters Instead of States in a Discrete Model parameter to update more frequently than intended. Optimizations Constant Propagation/Hard-Coding Dead Code Elimination Implicit Type Conversion Special Directives UserCode Block Phases of the UCB Indirect Terms Parameterized UCB Callout Software Constructs IfThenElse Block WHILE Block BREAK Block CONTINUE Block Local Variable Block Sequencer Block Difference Between Local and Global Variable Blocks Scope Lifetime Continuous Subsystem Explicit Phases Integrator Limitations Multiprocessor Code Generation Shared Memory Architecture Distributed Memory Architecture Shared Memory Callouts Callout Naming Convention Mapping Command Options Fixed-Point Support for Multiprocessor AutoCode Definitions and Conventions Shared Memory Fixed-Point Callouts in AutoCode/C From Local Memory From Shared Memory From Shared Memory (mixed data types) Reading Shared Memory Shared Variable Block Support Page Page Shared Memory Callout Option Read Shared Variable Block Callouts Write Shared Variable Block Callouts Global Variable Block Callouts Callout Pairs Non-Shared (Local) Global Variable Blocks Entering Non-Shared (Local) Critical Section Leaving Non-Shared (Local) Critical Section Entering with Extended Procedure Info Option Specified Leaving with Extended Procedure Info Option Specified Shared Global Variable Blocks Entering Shared Critical Section Leaving Shared Critical Section Entering with Extended Procedure Info Option Specified Leaving with Extended Procedure Info Option Specified Page Vectorized Code Generation How Code Is Generated Scalar Gain Block Example Example 6-1 shows the scalar code generated for a gain block. Vectorized Gain Block Example Array Subscripts Signal Connectivity Block Outputs Block Inputs Page Vectorization Modes Maximal Vectorization Mixed Vectorization Vector Labels and Names Example Page Page Page Page Page Vectorization Features Multiple Arrays within a Block Page Split-Merge Inefficiency Split Vector Page Merge Page External Outputs Copy-Back Page Eliminating Copy-Back Other Copy-Back Scenarios Vectorized Standard Procedure Interface Page Ada Array Aggregates and Slices Page Vectorization of the BlockScript Block Matrix Outputs Code Optimization Read from Variable Blocks Page Page Page Restart Capability Page Page Merging INIT Sections Page Page Reuse of Temporary Block Outputs Reuse Temporaries as Specified Maximal Reuse of Temporaries Page Constant Propagation Page Page Optimizing with Matrix Blocks Optimizing with Constant Blocks Optimizing with Callout Blocks Optimizing with Inverse Blocks Optimizing with Division Blocks Page Summary AutoCode Sim Cdelay Scheduler Task Posting Policies Page Page Scheduler Pipeline Page Managing DataStores in the Scheduler Page Sim Cdelay Scheduler State Transition Diagrams of Tasks under Sim Cdelay Figure 8-6. New STD for ATR Triggered Tasks Figure 8-7. New STD for ATR Triggered Tasks Implementing the Sim Cdelay AutoCode Scheduler Implementation Details DataStore Priority Problem Using the Sim Cdelay Scheduler Template Configuration for Enhanced Performance Shortcomings of the Sim Cdelay Scheduler Page Global Scope Signals and Parameterless Procedures Data Monitoring/Injection Specifying Monitored Signals Generating Code for Monitored Signals Page Parameterless Procedure Specifying Parameterless Procedure Interface Input Specification Output Specification Using a Parameterless Procedure Global-to-Global Input Connection Global Output Connection Condition Block Code Generation Reusing a Parameterless Procedure Generating Code for Parameterless Procedures Issues and Limitations Communication Between Subsystems Variable Blocks Versus Global Scope SystemBuild Simulator Connection to External Output Recommendations Naming Convention Model Documentation Explicit Sequencing Command Options A Technical Support and Professional Services Index A B C D E F Page G Page H I K L M N O P R S Page T U V W X Y