Main Content

Multi-Dimensional Signals in Legacy Functions

Open Model

This example shows you how to use the Legacy Code Tool to integrate legacy C functions with Multi-Dimensional Signals.

The Legacy Code Tool allows you to:

  • Provide the legacy function specification,

  • Generate a C-MEX S-function that is used during simulation to call the legacy code, and

  • Compile and build the generated S-function for simulation.

Providing the Legacy Function Specification

Functions provided with the Legacy Code Tool take a specific data structure or array of structures as the argument. The data structure is initialized by calling the function legacy_code() using 'initialize' as the first input. After initializing the structure, you have to assign its properties to values corresponding to the legacy code being integrated. The prototype of the legacy functions being called in this example are:

void array3d_add(real_T *y1, real_T *u1, real_T *u2, int32_T nbRows, int32_T nbCols, int32_T nbPages);

where real_T is a typedef to double, and int32_T is a typedef to a 32-bit integer. The legacy source code is found in the files ndarray_ops.h and ndarray_ops.c.

% sldemo_sfun_ndarray_add
def = legacy_code('initialize');
def.SFunctionName = 'sldemo_sfun_ndarray_add';
def.OutputFcnSpec = ['void array3d_add(double y1[size(u1,1)][size(u1,2)][size(u1,3)], ',...
                    'double u1[][][], double u2[][][], ' ...
                   'int32 size(u1,1), int32 size(u1,2), int32 size(u1,3))'];
def.HeaderFiles   = {'ndarray_ops.h'};
def.SourceFiles   = {'ndarray_ops.c'};
def.IncPaths      = {'sldemo_lct_src'};
def.SrcPaths      = {'sldemo_lct_src'};

where y1 is a 3-D output signal of same dimensions as the 3-D input signal u1. Note that the last 3 arguments passed to the legacy function correspond to the number of element in each dimension of the 3-D input signal u1.

Generating and Compiling an S-Function for Use During Simulation

The function legacy_code() is called again with the first input set to 'generate_for_sim' in order to automatically generate and compile the C-MEX S-function according to the description provided by the input argument 'def'. This S-function is used to call the legacy functions in simulation. The source code for the S-function is found in the file sldemo_sfun_ndarray_add.c.

legacy_code('generate_for_sim', def);

### Start Compiling sldemo_sfun_ndarray_add
    mex('-I/tmp/Bdoc24b_2725827_2540691/tpa6a86547/simulink_features-ex68315702/sldemo_lct_src', '-I/tmp/Bdoc24b_2725827_2540691/tpa6a86547/simulink_features-ex68315702', '-c', '-outdir', '/tmp/Bdoc24b_2725827_2540691/tpaf999171_aaef_4221_a644_e39635234048', '/tmp/Bdoc24b_2725827_2540691/tpa6a86547/simulink_features-ex68315702/sldemo_lct_src/ndarray_ops.c')
Building with 'gcc'.
MEX completed successfully.
    mex('sldemo_sfun_ndarray_add.c', '-I/tmp/Bdoc24b_2725827_2540691/tpa6a86547/simulink_features-ex68315702/sldemo_lct_src', '-I/tmp/Bdoc24b_2725827_2540691/tpa6a86547/simulink_features-ex68315702', '/tmp/Bdoc24b_2725827_2540691/tpaf999171_aaef_4221_a644_e39635234048/ndarray_ops.o')
Building with 'gcc'.
MEX completed successfully.
### Finish Compiling sldemo_sfun_ndarray_add
### Exit

Generating an rtwmakecfg.m File for Code Generation

After the TLC block file is created, the function legacy_code() can be called again with the first input set to 'rtwmakecfg_generate' in order to generate an rtwmakecfg.m file to support code generation through Simulink® Coder™. Generate the rtwmakecfg.m file if the required source and header files for the S-functions are not in the same directory as the S-functions, and you want to add these dependencies in the makefile produced during code generation.

Note: Complete this step only if you are going to simulate the model in accelerated mode.

legacy_code('rtwmakecfg_generate', def);

Generating a Masked S-Function Block for Calling the Generated S-Function

After the C-MEX S-function source is compiled, the function legacy_code() can be called again with the first input set to 'slblock_generate' in order to generate a masked S-function block that is configured to call that S-function. The block is placed in a new model and can be copied to an existing model.

% legacy_code('slblock_generate', def);

Integrate the Legacy Code

The model sldemo_lct_ndarray shows integration with the legacy code. The subsystem ndarray_add serves as a harness for the call to the legacy C function.

open_system('sldemo_lct_ndarray')
open_system('sldemo_lct_ndarray/ndarray_add')
sim('sldemo_lct_ndarray');

See Also