C Caller

Integrate C code in Simulink

  • Library:
  • Simulink / User-Defined Functions

  • C Caller block

Description

The C Caller block integrates your external C code into Simulink®. This block imports and lists the functions in your external C code, and allows you to select your resolved C functions to integrate in your Simulink models. The C Caller block standalone supports code generation. For more complex models, code generation depends on the capabilities of your Simulink model.

To use the C Caller block, define your source code and any supporting files using Simulation Target under Configuration Parameters. Then, bring a C Caller block to the Simulink canvas, using Library Browser > Simulink > User Defined Functions. To change the defined source code file and its dependencies, go to Simulation Target tab in Configuration Parameters by clicking the from the block dialog. After changing your source code or any of its dependencies, refresh the list of functions by clicking the on the block dialog. To browse and modify the list of functions in your source code, use the icon to access your header files.

Ports

Input

expand all

Input argument to the C Caller block.

Number of input arguments and their names are inferred through the selected function in your external C code. To receive data to a C Caller block, connect an input signal to the input ports.

Input label has the same name as your input argument unless changed by editing the Label column under Port Specification from the Block Dialog. If you rename the label to an input port, the C Caller block changes the name of the port.

For input variables, you can change the input scope to parameters or constants using the Scope column.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | fixed point | enumerated | bus

Output

expand all

Output argument from the C Caller block.

Number of output arguments and their names are inferred through the selected function in your external C code. To send data from your C Caller block, connect a block to the output port of your C Caller block.

Output port label has the same name as your output argument unless you change it by editing the Label column under Port Specification from the Block Dialog. If you rename the label to an input port, the C Caller block changes the name of the port.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | Boolean | enumerated | bus

Parameters

expand all

Name of the function parsed for the C Caller block. For a list of available functions, see Available Functions.

Tunable: Yes

Programmatic Use

Block Parameter: FunctionName
Type: character vector

myFunctionName = get_param(gcb,'FunctionName')
myFunctionName =

    'mean_filter'

The Port specification table indicates the attributes of each input and output element for the selected block. These properties include Argument name, scope, input/output label, type and size of the input/output variables. Argument name, scope, type, and size are inferred from your source code. If the scope is an input, you can modify this variable to a parameter or a constant.

Name — Demonstrates the variable name inferred from your source code.

A bold argument name indicates that the port or parameter is a global argument.

Scope — Indicates the role of the variables from your source code. If the variable is an input argument in the C Caller block source code, you can change the scope type to a constant or a parameter. If the variable is an output argument in the source code, you cannot change the scope type.

Label — Labels the input or output variable for the Simulink model. You can change the labels using this table. If the scope is a parameter, enter the parameter name in this field. If the scope is a constant, enter the constant value.

Type — Indicates the data type coming from the ports.

Size — Indicates the size of the input and output data.

List of all available functions that can be mapped to a C Caller block.

The C Caller block in your model imports all functions in your external source code, and shows the function names next to the Function name on the block dialog. To select and use a function in your block, confirm that the function name appears in the Available Functions table. If you are missing one of the functions, reload the source code by clicking on the block dialog. To change the names of functions, modify your source code and click the Refresh button to reload.

Programmatic Use

Block Parameter: AvailableFunctions
Type: character vector

allAvailableFunctions = get_param(gcb, 'AvailableFunctions')
allAvailableFunctions =

  1×1 cell array

    {'add'}

Block Characteristics

Data Types

Boolean[a] | bus[a] | double[a] | enumerated[a] | fixed point[a] | integer[a] | single[a]

Direct Feedthrough

no

Multidimensional Signals

limited[a]

Variable-Size Signals

no

Zero-Crossing Detection

no

[a] Actual data type or capability support depends on block implementation.

Extended Capabilities

Fixed-Point Conversion
Design and simulate fixed-point systems using Fixed-Point Designer™.

Introduced in R2018b