MATLAB Cosimulation

Cosimulate HDL code with MATLAB^®

To get started, see Verify HDL Module with MATLAB Testbench.

Apps

Generate a cosimulation block or System object from existing HDL files

Functions

Startup

`nclaunch`	Start and configure Cadence Xcelium simulator for use with HDL Verifier software
`vsim`	Start and configure ModelSim for use with HDL Verifier

HDL-Simulator Commands

`hdlsimmatlab`	Load instantiated HDL module for verification with Cadence Xcelium and MATLAB
`hdlsimmatlabsysobj`	Load instantiated HDL module for cosimulation with Cadence Xcelium and MATLAB System object
`matlabcp`	Associate MATLAB component function with instantiated HDL design
`matlabtb`	Schedule MATLAB testbench session for instantiated HDL module
`nomatlabtb`	End active MATLAB testbench and MATLAB component sessions
`matlabtbeval`	Call MATLAB function once and immediately on behalf of instantiated HDL module
`vsimmatlab`	Load instantiated HDL module for verification with ModelSim and MATLAB
`vsimmatlabsysobj`	Load instantiated HDL module for cosimulation with ModelSim and MATLAB System object

Server Control

`hdldaemon`	Control MATLAB server that supports interactions with HDL simulator
`notifyMatlabServer`	Send HDL simulator event ID and process ID to MATLAB server
`pingHdlSim`	Block cosimulation until HDL simulator is ready
`waitForHdlClient`	Wait until specified event ID is obtained or time-out occurs

Conversion

`dec2mvl`	Convert decimal to binary character vector
`mvl2dec`	Convert multivalued logic to decimal

Objects

`cosimulationConfiguration`	Configure HDL cosimulation workflow (Since R2022b)
`hdlverifier.HDLCosimulation`	Create a System object for HDL cosimulation with MATLAB
`hdlverifier.VivadoHDLCosimulation`	Create a System object for HDL cosimulation with the Vivado simulator and MATLAB (Since R2022a)

Topics

Startup and Connection

Set Up for HDL Cosimulation
To cosimulate your HDL code with a MATLAB or Simulink^® design, you must first:
Supported EDA Tools and Hardware
List of supported third-party EDA software and FPGA boards.
Set Up MATLAB-HDL Simulator Connection
Cosimulation requires a connection between MATLAB and your HDL simulation tool.
TCP/IP Socket Ports
Provides some direction for choosing TCP/IP socket ports.
Cross-Network Cosimulation
Provides instructions for performing cosimulation across a local network.
Run MATLAB-HDL Cosimulation
Run your testbench or component, including the cosimulation of your HDL module.

Cosimulation with System Object

Create a MATLAB System Object
You can verify HDL modules using the HDL Cosimulation System object™.
Verify Viterbi Decoder Using MATLAB System Object and HDL Simulator
This example shows you how to use MATLAB® System objects and an HDL simulator to cosimulate a Viterbi decoder implemented in VHDL.
Import HDL Code for MATLAB System Object
Generate a MATLAB System object to cosimulate your HDL code.

Cosimulation with Function

Import HDL Code for MATLAB Function
Generate a MATLAB function to cosimulate your HDL code.
Testbench and Component Function Writing

This section explains how you use the use_instance_obj argument for MATLAB functions matlabcp and matlabtb.
- Create a MATLAB Testbench
- Set Up Cosimulation Testbench
- Verify HDL Module with MATLAB Testbench
- Create a MATLAB Component Function
- Set Up Cosimulation Component
Verify HDL Module with MATLAB Component Function Using Cosimulation Wizard
This tutorial guides you through the basic steps for setting up an HDL Verifier™ cosimulation between MATLAB® and the HDL simulator, using the Cosimulation Wizard.

Automatic Verification

Automatic Verification of Generated HDL Code from MATLAB
Verify generated HDL code using a generated cosimulation script.
Verify Code with HDL Test Bench (HDL Coder)
Simulate the generated HDL design under test (DUT) with test vectors from the test bench using the specified simulation tool.

All Cosimulation

HDL Cosimulation
The HDL Verifier™ software consists of MATLAB functions, a MATLAB System object, and a library of Simulink blocks, all of which establish communication links between the HDL simulator and MATLAB or Simulink.
Prepare to Import HDL Code for Cosimulation
Prepare for cosimulation and choose whether to cosimulate your HDL code as a function, System object, or block.
Supported Data Types
If your HDL application needs to send HDL data to a MATLAB function or a Simulink block, you may first need to convert the data to a type supported by MATLAB and the HDL Verifier software.
Race Conditions in HDL Simulators
Describes ways to avoid race conditions in hardware cosimulations with MATLAB and Simulink software.
Use HDL Parameters in Cosimulation
Use Verilog parameters or VHDL generics in cosimulation.

Featured Examples

Cosimulation for Testing Filter Component Using MATLAB Testbench

Run either Siemens® ModelSim™ and Questa™ or Cadence® Xcelium™ with MATLAB® in batch mode to test an HDL component using a MATLAB testbench, by using the HDL Verifier™ function matlabtb. The function matlabtb facilitates this testing by feeding MATLAB-generated input data into the HDL component and feeding the output from the component back into MATLAB. When you generate complex waveforms in HDL, using matlabtb enables you to spend more time running tests than writing test waveforms. matlabtb also reads the results, so the testing process can leverage MATLAB to apply data transformations to the output before plotting. For more information on writing testbenches for cosimulation, see Create a MATLAB Testbench.

Open Script

Implement Filter Component of Oscillator in MATLAB

Implement a filter component for an HDL project in Siemens® ModelSim™ and Questa™ or Cadence® Xcelium™ by using the HDL Verifier™ function matlabcp. Instead of using HDL to model a complex component for use in an HDL project, you can use matlabcp to implement the component instead.

Open Script

Manchester Receiver

The Manchester Receiver example shows how to use the HDL Verifier™ to design, test, and verify a VHDL Manchester Receiver model with clock recovery capabilities.

Open Script

Implement Spectrum Display Component in MATLAB

Run MATLAB® with Siemens® ModelSim™ and Questa™ or Cadence® Xcelium™ to visualize the output of a larger HDL project, by using the HDL Verifier™ function matlabcp. Visualizing and analyzing the output of the HDL module using the host of scopes, plots, and viewers in MATLAB accelerate the development of the HDL module and its verification. In this example, you use the matlabcp function to bind the HDL module with its output. You visualize the HDL module output using the plot function in MATLAB.

Open Script

Include MATLAB Functions in HDL Testbench

Include MATLAB® functions as components of an HDL testbench. By utilizing MATLAB functions that represent the system-level behaviors, you can reduce the time required to verify RTL design. This example includes two MATLAB functions: one for generating stimuli and the other for creating a predictor model within a top-level HDL testbench. You run the testbench and observe the results within HDL simulator.

Open Script