Inport

Create input port for subsystem or external input

• 

Libraries:
Simulink / Commonly Used Blocks
Simulink / Ports & Subsystems
Simulink / Sources
HDL Coder / Commonly Used Blocks
HDL Coder / Ports & Subsystems
HDL Coder / Sources

Description

Inport blocks link signals from outside a system into the system.

The software assigns Inport block port numbers according to these rules:

• Inport blocks within a top-level system or subsystem are numbered sequentially, starting with 1.

• If you add an Inport block, the label is the next available number.

• If you delete an Inport block, other port numbers are renumbered to ensure that the Inport blocks are in sequence and that no numbers are omitted.

• If you copy an Inport block into a system, its port number is not renumbered unless its current number conflicts with an input port already in the system. If the port number for the copied Inport block is not in sequence, renumber the block. Otherwise, you get an error message when you simulate the model or update the block diagram.

Inport Blocks in Top-Level Systems

You can use an Inport block in a top-level system to:

• Supply external inputs from a workspace using the Input parameter. If you do not provide external input data, the output from the Inport block is the ground value. For more information, see Load Data to Root-Level Input Ports.

  • To load data for several signals using root-level input ports, consider using the Root Inport Mapper tool. See Map Data Using Root Inport Mapper Tool.

  • Use the createInputDataset function to create a Simulink.SimulationData.Dataset object that contains an element for each root-level Inport block in the model you specify.

• Provide a means for perturbation of the model by the linmod and trim analysis functions. For more information, see Linearizing Models.

Inport Blocks in Subsystems

Inport blocks in a subsystem represent inputs to the subsystem. A signal arriving at an input port on a Subsystem block flows out of the associated Inport block in that subsystem. The Inport block associated with an input port on a Subsystem block is the block whose Port number parameter matches the relative position of the input port on the Subsystem block. For example, the Inport block whose Port number parameter is 1 gets its signal from the block connected to the topmost port on the Subsystem block.

If you renumber the Port number of an Inport block, the block becomes connected to a different input port. The block continues to receive its signal from the same block outside the subsystem.

Inport blocks inside a subsystem support signal label propagation, but root-level Inport blocks do not. For more information, see Signal Label Propagation.

You can directly edit port labels on a Subsystem block. For more information, see Edit Port Labels on Subsystem Blocks.

Tip

For models that include buses composed of many bus elements, consider using In Bus Element and Out Bus Element blocks. These blocks:

• Reduce signal line complexity and clutter in a block diagram.

• Make it easier to change the interface incrementally.

• Allow access to a bus element closer to the point of usage, avoiding the use of a Bus Selector and Goto block configuration.

The In Bus Element block is of block type Inport and the Out Bus Element block is of block type Outport.

Create Duplicate Inport Blocks

You can create any number of duplicates of an Inport block. The duplicates are graphical representations of the original intended to simplify block diagrams by eliminating unnecessary lines. The duplicate has the same port number, properties, and output as the original.

To create a duplicate of an Inport block:

1. In the block diagram, select the unconnected Inport block that you want to duplicate.

2. Press and hold the Ctrl key and drag the block.

3. Release the pointer, and then select Duplicate from the context menu.

You can select an Inport block that has duplicates to highlight the duplicate blocks. To show a related block in an open diagram or new tab, pause your cursor on the ellipsis that appears after selection. Then, select Related Blocks from the action menu. When multiple blocks correspond to the selected block, a list of related blocks opens. You can filter the list of related blocks by entering a search term in the text box. After you select a related block from the list, window focus goes to the open diagram or new tab that shows the related block.

Connect Buses to Root-Level Inport Blocks

If you want a root-level Inport block of a model to produce a bus, set the Data type parameter to the name of a bus object that defines the bus that the Inport block produces. For more information, see Specify Bus Properties with Bus Objects.

Examples

Simulink Subsystem Semantics

This set of examples shows different types of Simulink® Subsystems and what semantics are used when simulating these subsystems. Each example provides a description of the model and the subtleties governing how the model is executed.

• Open Live Script

Ports

Output

Port_1 — Input signal

scalar | vector

Input signal that flows into the system through the input port.

You can use an Inport block in a subsystem to supply fixed-point data in a structure or in any other format.

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

Parameters

Main

Port number — Position of port on parent block

1 (default) | real integer

Specify the order in which the port that corresponds to the block appears on the parent Subsystem or Model block.

• If you add a block that creates another port, the port number is the next available number.

• Deleting all blocks associated with a port deletes the port. Other ports are renumbered so that they are sequential and do not skip any numbers.

• Specifying a port number that exceeds the number of ports creates a port for that number and for any skipped sequential numbers.

Programmatic Use

To set the block parameter value programmatically, use the set_param function.

Parameter:	Port
Values:	"1" (default) | real integer in quotes
Data Types:	char | string

Example: set_param("mymodel/Subsystem1/PortBlock",Port="5")

Icon display — Icon display

Port number (default) | Signal name | Port number and signal name

Specify the information displayed on the block icon.

Programmatic Use

Block Parameter: IconDisplay

Type: character vector

Values: 'Signal name' | 'Port number' | 'Port number and signal name'

Default: 'Port number'

Latch input by delaying outside signal — Option to latch signal by delay

off (default) | on

Select to specify that the block output is the value of the input signal at the previous time step.

Selecting this option enables the software to resolve data dependencies among triggered subsystems that are part of a loop.

The Inport block indicates that this option is selected by displaying <Lo>.

Dependencies

This parameter is enabled only when the block represents an input port in a triggered subsystem.

Programmatic Use

Block Parameter: LatchByDelayingOutsideSignal

Type: character vector

Values: 'on' | 'off'

Default: 'off'

Latch input for feedback signals of function-call subsystem outputs — Latch signal from changing

off (default) | on

Select to specify that the block latches the input value and prevents it from changing during the execution of the function-call subsystem. For a single function call that is branched to invoke multiple function-call subsystems, this option breaks a loop formed when a signal feeds back from one function-call subsystem into another. Selecting this option prevents any change to the values of a feedback signal from a function-call subsystem that is invoked during the execution of the subsystem that contains this block.

The Inport block indicates that this option is selected by displaying <Li>.

Dependencies

This option is enabled only when the block represents an input port in a function-call subsystem.

Programmatic Use

Block Parameter: LatchInputForFeedbackSignals

Type: character vector

Values: 'on' | 'off'

Default: 'off'

Connect Inputs — Option to open Root Inport Mapper tool

button

To import, visualize, and map signal and bus data to root-level Inport blocks, click this button. The Root Inport Mapper tool opens.

Dependencies

This button appears only when the block is at the root level for the model.

Signal Attributes

Output function call — Option to produce function-call event

off (default) | on

Specify that the input signal produces a function-call event signal.

Select this option if a current model must accept a function-call event signal when referenced in the top model.

Dependencies

• To enable this option, the block must be in an asynchronous function call.

• The software ignores the value of this parameter when Data type specifies a Simulink.ValueType object.

Programmatic Use

Block Parameter: OutputFunctionCall

Type: character vector

Values: 'off' | 'on'

Default: 'off'

Minimum — Minimum output value

[] (default) | scalar

Lower value of the output range that the software checks.

This number must be a finite real double scalar value.

The software uses this value to perform:

• Simulation range checking (see Specify Signal Ranges).

• Automatic scaling of fixed-point data types.

• Optimization of the code that you generate from the model. This optimization can remove algorithmic code and affect the results of some simulation modes such as SIL or external mode. For more information, see Optimize using the specified minimum and maximum values (Embedded Coder).

Dependencies

The software ignores the value of this parameter when Data type specifies a Simulink.ValueType or Simulink.Bus object. The software uses the minimum values specified by the Simulink.ValueType object or the Simulink.BusElement objects in the Simulink.Bus object instead.

Programmatic Use

Block Parameter: OutMin

Type: character vector

Values: '[ ]'| scalar

Default: '[ ]'

Maximum — Maximum output value

[] (default) | scalar

Upper value of the output range that the software checks.

This number must be a finite real double scalar value.

The software uses this value to perform:

• Simulation range checking (see Specify Signal Ranges).

• Automatic scaling of fixed-point data types.

• Optimization of the code that you generate from the model. This optimization can remove algorithmic code and affect the results of some simulation modes such as SIL or external mode. For more information, see Optimize using the specified minimum and maximum values (Embedded Coder).

Dependencies

The software ignores the value of this parameter when Data type specifies a Simulink.ValueType or Simulink.Bus object. The software uses the maximum values specified by the Simulink.ValueType object or the Simulink.BusElement objects in the Simulink.Bus object instead.

Programmatic Use

Block Parameter: OutMax

Type: character vector

Values: '[ ]'| scalar

Default: '[ ]'

Data type — Output data type

Inherit: auto (default) | double | single | half | int8 | uint8 | int16 | uint16 | ...

Specify the output data type of the external input. The type can be inherited, specified directly, or expressed as a data type object, such as Simulink.NumericType.

The Data Type Assistant helps you set data attributes. To use the Data Type Assistant, click . For more information, see Specify Data Types Using Data Type Assistant.

You can specify any of these options:

• Inherited data type

• Built-in Simulink^® data type — For example, specify single or uint8. See Data Types Supported by Simulink.

• Fixed-point data type — Use the fixdt function. For example, specify fixdt(1,16,0).

• Enumerated data type — Use the name of the type preceded by Enum:. For example, specify Enum: myEnumType.

• Bus data type — Use the name of the Simulink.Bus object preceded by Bus:. For example, specify Bus: myBusObject.

• Simulink image data type — If you have Computer Vision Toolbox™, use the constructor for the Simulink.ImageType (Computer Vision Toolbox) object and specify the properties to describe the image. By default, the data type uses the Simulink.ImageType(480,640,3) expression that represents the rows, columns, and channels of the image respectively.

• Value type — Use the name of the Simulink.ValueType object preceded by ValueType:. For example, specify ValueType: windVelocity.

• Custom data type — Use a MATLAB^® expression that specifies the type. For example, you can specify a Simulink.NumericType object whose DataTypeMode property is set to a value other than 'Fixed-point: unspecified scaling'.

When you specify a Simulink.ValueType or Simulink.Bus object as the data type, some parameters of the Inport block are ignored. For example, the Min, Max, and Unit parameters of the Inport block are ignored. The software uses the corresponding properties of the Simulink.ValueType object or the Simulink.BusElement objects in the Simulink.Bus object instead. For example, suppose a block sets Unit to ft/s. When the Data type of the block specifies a ValueType object that has m/s as its unit, the block uses m/s instead of ft/s.

Programmatic Use

Block Parameter: OutDataTypeStr

Type: character vector

Values: 'Inherit: auto' | 'double' | 'single' | 'half' | 'int8' | 'uint8' | 'int16' | 'uint16' | 'int32' | 'uint32' | 'int64' | 'uint64' | 'boolean' | 'fixdt(1,16)' | 'fixdt(1,16,0)' | 'fixdt(1,16,2^0,0)' | 'string' | 'Enum: <class name>' | 'Bus: <object name>' | 'ValueType: <object name>' | '<data type expression>' | Simulink.ImageType(480,640,3)

Default: 'Inherit: auto'

Lock output data type setting against changes by the fixed-point tools — Option to prevent fixed-point tools from overriding data types

off (default) | on

Select this parameter to prevent the fixed-point tools from overriding the output data type you specify on the block. For more information, see Use Lock Output Data Type Setting (Fixed-Point Designer).

Dependencies

The software ignores the value of this parameter when Data type specifies a Simulink.ValueType object.

Programmatic Use

Block Parameter: LockScale

Values: 'off' | 'on'

Default: 'off'

Output as nonvirtual bus — Option to specify virtuality of bus output

off (default) | on

Specify whether the output for a top-level Inport block used to load bus data is virtual or nonvirtual.

• Select this parameter to specify a nonvirtual bus output.

• Clear this parameter to specify a virtual bus output.

Tips

• All signals in a nonvirtual bus must have the same sample time, even if the associated bus object specifies inherited sample time for some elements. Any operation that would result in a nonvirtual bus containing signals with different sample rates generates an error. You cannot load multirate data for a nonvirtual bus. See Modify Sample Times for Nonvirtual Buses for details on how to pass signals with different sample rates into a referenced model as a nonvirtual bus.

  To load multirate data for a bus, clear the Output as nonvirtual bus parameter, and set the Sample time parameter to inherited (-1).

• For the top model in a model reference hierarchy, code generation creates a C structure to represent the nonvirtual bus output.

• For referenced models, select this option to create a C structure in generated code. Otherwise, code generation creates an argument for each leaf element of the bus.

Dependencies

To enable this parameter:

• The block must be at the top level of a model.

• The Data type block parameter must resolve to a Simulink.Bus object. For example, set Data type to a Simulink.Bus object or a Simulink.ValueType object that specifies a Simulink.Bus object as its data type.

Programmatic Use

Block Parameter: BusOutputAsStruct

Type: character vector

Values: 'off' | 'on'

Default: 'off'

Unit (e.g., m, m/s^2, N*m) — Physical unit of the input signal to the block

inherit (default) | <Enter unit>

Specify the physical unit of the input signal to the block. To specify a unit, begin typing in the text box. As you type, the parameter displays potential matching units. For a list of supported units, use the showunitslist function.

To constrain the unit system, click the link to the right of the parameter:

• If a Unit System Configuration block exists in the component, its dialog box opens. Use that dialog box to specify allowed and disallowed unit systems for the component.

• If a Unit System Configuration block does not exist in the component, the model Configuration Parameters dialog box displays. Use that dialog box to specify allowed and disallowed unit systems for the model.

Dependencies

The software ignores the value of this parameter when Data type specifies a Simulink.ValueType or Simulink.Bus object. The software uses the units specified by the Simulink.ValueType object or the Simulink.BusElement objects in the Simulink.Bus object instead.

Programmatic Use

Block Parameter: Unit

Type: character vector

Values: 'inherit' | '<Enter unit>'

Default: 'inherit'

To specify the physical unit of the input signal to the block without propagation, use UnitNoProp.

Port dimensions (-1 for inherited) — Port dimensions

-1 (default) | integer | [integer integer]

Specify the dimensions of the output signal.

-1	The port can load data for a signal with any dimensions. The port inherits dimensions from the connected signal.
N	The port can load data for a signal that is a vector of size N.
[R C]	The port can load data for a matrix signal having R rows and C columns.

Dependencies

The software ignores the value of this parameter when Data type specifies a Simulink.ValueType object. The software uses the dimensions specified by the Simulink.ValueType object instead.

Programmatic Use

Block Parameter: PortDimensions

Type: character vector

Values: '-1' | integer | [integer integer]

Default: '-1'

Variable-size signal — Option to allow or disallow variable-size signals

Inherit (default) | No | Yes

Specify the type of signals allowed for this port. To allow variable-size and fixed-size signals, select Inherit. To allow only variable-size signals, select Yes. To allow only fixed-size signals, select No.

When the signal at this port is a variable-size signal, the Port dimensions parameter specifies the maximum dimensions of the signal.

Dependencies

The software ignores the value of this parameter when Data type specifies a Simulink.ValueType object. The software uses the dimensions mode specified by the Simulink.ValueType object instead.

Programmatic Use

Parameter: VarSizeSig

Type: character vector

Value: 'Inherit' | 'No' | 'Yes'

Default: 'Inherit'

Signal type — Output signal type

auto (default) | real | complex

Specify the complexity of the signal output. To inherit the complexity from the signal that is connected to its input, select auto. Otherwise, choose a real or complex signal type.

Dependencies

The software ignores the value of this parameter when Data type specifies a Simulink.ValueType or Simulink.Bus object. The software uses the complexity specified by the Simulink.ValueType object or the Simulink.BusElement objects in the Simulink.Bus object instead.

Programmatic Use

Block Parameter: SignalType

Type: character vector

Values: 'auto' | 'real' | 'complex'

Default: 'auto'

Execution

Sample time (-1 for inherited) — Option to specify sample time

-1 (default) | scalar

Specify the discrete interval between sample time hits or specify another type of sample time, such as continuous (0) or inherited (-1). For more options, see Types of Sample Time.

By default, the block inherits its sample time based upon the context of the block within the model.

Programmatic Use

Block Parameter: SampleTime

Type: character vector

Values: scalar

Default: '-1'

Interpolate data — Option to linearly interpolate output data

on (default) | off

When loading data from the workspace into a root-level Inport block, specify whether the block linearly interpolates and extrapolates output values at time steps for which no corresponding data exists.

To load discrete data from the workspace:

1. Set the Sample time to a discrete rate, such as 2.

2. Clear Interpolate data.

For more information, see Control How Models Load Input Data.

The software uses the following interpolation and extrapolation:

• For time steps between the first specified data point and the last specified data point — zero-order hold.

• For time steps before the first specified data point and after the last specified data point — ground value.

• For variable-size signals for time steps before the first specified data point — a NaN value is logged for single or double data types and ground for other data types. For time steps after the last specified data point, the software uses ground values.

Programmatic Use

Block Parameter: Interpolate

Type: character vector

Values: 'on' | 'off'

Default: 'on'

Events — Option to trigger model partition based on flow of data into port

cell array of event trigger objects

In a rate-based system, you can configure an input port in the top model or on a model reference interface to trigger the execution of one or more model partitions in response to the flow of data into the port. The Events parameter stores the event triggers associated with the port. Each event trigger maps an input event to the name of the schedule event it triggers. The schedule for the model specifies the partition to execute in response to the schedule event and the priority of execution.

The table summarizes the event triggers you can configure. For each input port, you can configure one event trigger for each input event.

Input Event	Input Event Description	Event Trigger Object
Input write	Value for input port updates.	simulink.event.InputWrite
Input write timeout	Input port value does not update within a specified amount of time.	simulink.event.InputWriteTimeout
Input write lost	Input port value update overwrites unprocessed data.	simulink.event.InputWriteLost

To configure the schedule for your model, use the Schedule Editor.

Dependencies

This parameter is visible only when the block represents a root-level input port.

Programmatic Use

Block Parameter: EventTriggers

Values: 1-by-1 cell array | 2-by-1 cell array | 3-by-1 cell array

Default: []

Block Characteristics

Data Types	Boolean | bus | double | enumerated | fixed point | half | integer | single | string
Direct Feedthrough	no
Multidimensional Signals	yes
Variable-Size Signals	yes
Zero-Crossing Detection	no

Extended Capabilities

C/C++ Code Generation
Generate C and C++ code using Simulink® Coder™.

HDL Code Generation

Generate VHDL, Verilog and SystemVerilog code for FPGA and ASIC designs using HDL Coder™.

HDL Coder™ provides additional configuration options that affect HDL implementation and synthesized logic.

HDL Architecture

This block has one default HDL architecture.

HDL Block Properties

General
BalanceDelays	BalanceDelays Setting Description on (default) Detects introduction of delays on other paths in the DUT and inserts matching delays on the Inport block path. off Disable delay balancing on input ports in your DUT subsystem to prevent HDL Coder from inserting matching delays when they are unnecessary. For example, disable BalanceDelays on an Inport block in your DUT subsystem if it is on a path with a stable input, meaning the input signal to the input port is a stable input signal outside of the DUT. Note This property affects only DUT-level Inport blocks.
BidirectionalPort	BidirectionalPort Setting Description on Specify the port as bidirectional. The following requirements apply: The port must be in a Subsystem block with black box implementation. There must also be no logic between the bidirectional port and the corresponding top-level DUT subsystem port. For more information, see Specify Bidirectional Ports (HDL Coder). off (default) Do not specify the port as bidirectional.

Target Specification
IOInterface	Target platform interface type for DUT ports, specified as a character vector. The IOInterface block property is ignored for Inport and Outport blocks that are not DUT ports. To specify valid IOInterface settings, use the HDL Workflow Advisor: In the HDL Workflow Advisor, in the Set Target > Set Target Interface step, in the Target platform interface table, in the Target Platform Interfaces column, use the drop-down list to set the target platform interface type. Save the model. The IOInterface value is saved as an HDL block property of the port. For example, to view the IOInterface value, if the full path to your DUT port is hdlcoder_led_blinking/led_counter/LED, enter: hdlget_param('hdlcoder_led_blinking/led_counter/LED', 'IOInterface')
IOInterfaceMapping	Target platform interface port mapping for DUT ports, specified as a character vector. The IOInterfaceMapping block property is ignored for Inport and Outport blocks that are not DUT ports. To specify valid IOInterfaceMapping settings, use the HDL Workflow Advisor: In the HDL Workflow Advisor, in the Set Target > Set Target Interface step, in the Target platform interface table, in the Target Platform Interfaces column, use the drop-down list to set the target platform interface type. In the Bit Range / Address / FPGA Pin column, if you want to change the default value, enter a target platform interface mapping. Save the model. The IOInterfaceMapping value is saved as an HDL block property of the port. For example, to view the IOInterfaceMapping value, if the full path to your DUT port is hdlcoder_led_blinking/led_counter/LED, enter: hdlget_param('hdlcoder_led_blinking/led_counter/LED',... 'IOInterfaceMapping')
IOInterfaceOptions	Target platform interface port mapping options for DUT ports, specified as a character vector. The IOInterfaceOptions block property is ignored for Inport and Outport blocks that are not DUT ports. To specify valid IOInterfaceOptions settings, use the HDL Workflow Advisor: In the HDL Workflow Advisor, on the Set Target > Set Target Interface step, in the Target platform interface table, in the Target Platform Interfaces column, map the input or output ports to an AXI4 subordinate interface. In the Interface Options column, if you want to change the default initial value, click the Options button and enter a value for RegisterInitialValue. Save the model. The IOInterfaceOptions value is saved as an HDL block property of the port. For example, to view the IOInterfaceOptions value, if the full path to your DUT port is hdlcoder_led_blinking/led_counter/LED, enter: hdlget_param('hdlcoder_led_blinking/led_counter/LED',... 'IOInterfaceOptions')

Frame to Sample Conversion
ConvertToSamples	ConvertToSamples Setting Description on Convert the incoming matrix input signal to samples by using the frame to sample conversion optimization. To use this property, enable the model configuration parameter Enable frame to sample conversion. For more information, see Enable frame to sample conversion (HDL Coder). off (default) Do not convert the incoming matrix input signal to samples.

Simulink.ValueType Object Support

This block supports code generation for Simulink.ValueType object. For more information about value types, see Specify Common Set of Signal Properties as Value Type.

PLC Code Generation
Generate Structured Text code using Simulink® PLC Coder™.

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

Version History

Introduced before R2006a