HDL Port and Identifier Properties
Customize ports, identifiers, and comments
With the HDL port and identifier properties, you can customize ports, identifiers, and comments in the generated code.
Specify these properties as
name-value arguments to the generatehdl
function.
Name
is the property name and Value
is the
corresponding value. You can specify several name-value arguments in any order as
'Name1',Value1,...,'NameN',ValueN
.
For example:
fir = dsp.FIRFilter('Structure','Direct form antisymmetric'); generatehdl(fir,'InputDataType',numerictype(1,16,15),'ClockInputPort','clk_input');
Clocks, Inputs, and Outputs
ClockEnableInputPort
— Name of clock enable input port
'clk_enable'
(default) | character vector | string scalar
Name of clock enable input port, specified as 'clk_enable'
, a
character vector, or a string scalar.
If you specify a value that is a reserved word in the target language, the coder adds the
postfix _rsvd
to this value. You can update the postfix value by using
the ReservedWordPostfix
property. For more details, see Resolving HDL Reserved Word Conflicts.
ClockEnableOutputPort
— Name of clock enable output port
'ce_out'
(default) | character vector | string scalar
Name of clock enable output port, specified as 'ce_out'
, a
character vector, or a string scalar. This property applies only to Multirate Filters
that use a single input clock (default behavior of ClockInputs
). For an
example, see Clock Ports for Multirate Filters. For more details, see Code Generation Options for Multirate Filters.
If you specify a value that is a reserved word in the target language, the coder adds the
postfix _rsvd
to this value. You can update the postfix value by using
the ReservedWordPostfix
property. For more details, see Resolving HDL Reserved Word Conflicts.
ClockInputPort
— Name of clock input port
'clk'
(default) | character vector | string scalar
Name of clock input port, specified as 'clk'
, a character vector,
or a string scalar.
If you specify a value that is a reserved word in the target language, the coder adds the
postfix _rsvd
to this value. You can update the postfix value by using
the ReservedWordPostfix
property. For more details, see Resolving HDL Reserved Word Conflicts.
InputPort
— Name of filter input port
'filter_in'
(default) | character vector | string scalar
Name of filter input port, specified as 'filter_in'
, a character
vector, or a string scalar.
If you specify a value that is a reserved word in the target language, the coder adds the
postfix _rsvd
to this value. You can update the postfix value by using
the ReservedWordPostfix
property. For more details, see Resolving HDL Reserved Word Conflicts.
InputType
— Data type of filter input port
'std_logic_vector'
(default) | 'signed/unsigned'
| 'wire'
Data type of filter input port, specified as one of the following:
'std_logic_vector'
or'signed/unsigned'
(when the target language is VHDL)'wire'
(when the target language is Verilog)
OutputPort
— Name of filter output port
'filter_out'
(default) | character vector | string scalar
Name of filter output port, specified as 'filter_out'
, a
character vector, or a string scalar.
If you specify a value that is a reserved word in the target language, the coder adds the
postfix _rsvd
to this value. You can update the postfix value by using
the ReservedWordPostfix
property. For more details, see Resolving HDL Reserved Word Conflicts.
OutputType
— Data type of filter output port
'Same as input data type'
(default) | 'std_logic_vector'
| 'signed/unsigned'
| 'wire'
Data type of filter output port in generated HDL code, specified as one of the following:
'Same as input data type'
,'std_logic_vector'
, or'signed/unsigned'
(when the target language is VHDL)'wire'
(when the target language is Verilog)
Resets
ResetInputPort
— Name of filter reset port
'reset'
(default) | character vector | string scalar
Name of filter reset port, specified as 'reset'
, a character
vector, or a string scalar. Use the ResetAssertedLevel
property to control the behaviour of this port.
If you specify a value that is a reserved word in the target language, the coder adds the
postfix _rsvd
to this value. You can update the postfix value by using
the ReservedWordPostfix
property. For more details, see Resolving HDL Reserved Word Conflicts.
RemoveResetFrom
— Suppress generation of resets from shift registers
'none'
(default) | 'ShiftRegister'
Suppress the generation of resets from the shift registers, specified as
'none'
or 'ShiftRegister'
. To omit reset signals
from shift registers, set this property to 'ShiftRegister'
. Disabling
reset signals from shift registers can result in a more efficient FPGA
implementation.
For more details, see Suppressing Generation of Reset Logic.
ResetAssertedLevel
— Asserted (active) level of reset input signal
'active-high'
(default) | 'active-low'
Asserted (active) level of reset input signal, specified as one of the following:
'active-high'
— To reset registers in the filter design, the reset input signal must be driven high (1).For example, this code checks whether
reset
is active high before populating thedelay_pipeline
register.Delay_Pipeline_Process : PROCESS (clk, reset) BEGIN IF reset = '1' THEN delay_pipeline(0 TO 50) <= (OTHERS => (OTHERS => '0'));
'active-low'
— To reset registers in the filter design, the reset input signal must be driven low (0).For example, this code checks whether
reset
is active low before populating thedelay_pipeline
register.Delay_Pipeline_Process : PROCESS (clk, reset) BEGIN IF reset = '0' THEN delay_pipeline(0 TO 50) <= (OTHERS => (OTHERS => '0'));
ResetType
— Reset style for registers
'async'
(default) | 'sync'
Reset style for registers, specified as one of the following:
'async'
— The coder uses asynchronous resets. The HDL process block does not check for an active clock before performing a reset. For example:delay_pipeline_process : PROCESS (clk, reset) BEGIN IF Reset_Port = '1' THEN delay_pipeline (0 To 50) <= (OTHERS =>(OTHERS => '0')); ELSIF Clock_Port'event AND Clock_Port = '1' THEN IF ClockEnable_Port = '1' THEN delay_pipeline(0) <= signed(Fin_Port); delay_pipeline(1 TO 50) <= delay_pipeline(0 TO 49); END IF; END IF; END PROCESS delay_pipeline_process;
'sync'
— The coder uses a synchronous reset style. In this case, the HDL process block checks for the rising edge of the clock before performing a reset. For example:delay_pipeline_process : PROCESS (clk, reset) BEGIN IF rising_edge(Clock_Port) THEN IF Reset_Port = '0' THEN delay_pipeline(0 To 50) <= (OTHERS =>(OTHERS => '0')); ELSIF ClockEnable_Port = '1' THEN delay_pipeline(0) <= signed(Fin_Port); delay_pipeline(1 TO 50) <= delay_pipeline(0 TO 49); END IF; END IF; END PROCESS delay_pipeline_process;
Identifiers and Comments
BlockGenerateLabel
— Postfix to the block section labels
'_gen'
(default) | character vector | string scalar
Postfix to the block section labels, specified as '_gen'
, a
character vector, or a string scalar. This property applies only when the target
language is VHDL. The coder appends this postfix to the block section labels of VHDL
GENERATE
statements.
InstanceGenerateLabel
— Postfix to the instance section labels
'_gen'
(default) | character vector | string scalar
Postfix to the instance section labels, specified as '_gen'
, a
character vector, or a string scalar. This property applies only when the target
language is VHDL. The coder appends this postfix to the instance section labels of VHDL
GENERATE
statements.
OutputGenerateLabel
— Postfix to output assignment block labels
'outputgen'
(default) | character vector | string scalar
Postfix to output assignment block labels, specified as
'outputgen'
, a character vector, or a string scalar. This property
applies only when the target language is VHDL. The coder appends this postfix to the
output assignment block labels of VHDL GENERATE
statements.
ClockProcessPostfix
— Postfix to HDL clock process names
'_process'
(default) | character vector | string scalar
Postfix to HDL clock process names, specified as '_process'
, a
character vector, or a string scalar. The coder uses HDL process blocks to modify the
content of the registers in the filter. The block label is derived from the register
name and this postfix. For example, in the following block declaration, the coder
derives the process label from the register name delay_pipeline
and
the default postfix
'_process'
.
delay_pipeline_process : PROCESS (clk, reset) BEGIN
CoeffPrefix
— Prefix for filter coefficient names
'coeff'
(default) | character vector | string scalar
Prefix for filter coefficient names, specified as 'coeff'
, a
character vector, or a string scalar. The coder derives the coefficient names by
appending filter-specific characteristics to this prefix.
Filter Type | Coefficient Name |
---|---|
FIR | The coder appends the coefficient number to CoeffPrefix ,
starting with 1. For example, the default for the first coefficient is
coeff1 . |
IIR |
The coder appends the following characters to
For example, the default for the first numerator coefficient of
the third section is |
For example:
firfilt = design(fdesign.lowpass,'equiripple', ... 'FilterStructure','dfsymfir','SystemObject',true); generatehdl(firfilt,'InputDataType',numerictype(1,16,15), ... 'CoefficientSource','Internal','CoeffPrefix','mycoeff');
The coder replaces the default coefficient name prefix with the custom value:
ARCHITECTURE rtl OF firfilt IS -- Local Functions -- Type Definitions TYPE delay_pipeline_type IS ARRAY (NATURAL range <>) OF signed(15 DOWNTO 0); -- sfix16_En15 -- Constants CONSTANT mycoeff1 : signed(15 DOWNTO 0) := to_signed(-159, 16); -- sfix16_En16 CONSTANT mycoeff2 : signed(15 DOWNTO 0) := to_signed(-137, 16); -- sfix16_En16 CONSTANT mycoeff3 : signed(15 DOWNTO 0) := to_signed(444, 16); -- sfix16_En16 CONSTANT mycoeff4 : signed(15 DOWNTO 0) := to_signed(1097, 16); -- sfix16_En16 ...
Dependencies
This property applies only when you set CoefficientSource
to 'Internal'
.
ComplexImagPostfix
— Postfix to imaginary part of complex signal names
'_im'
(default) | character vector | string scalar
Postfix to imaginary part of complex signal names, specified as
'_im'
, a character vector, or a string scalar. See Using Complex Data and Coefficients.
ComplexRealPostfix
— Postfix to real part of complex signal names
'_re'
(default) | character vector | string scalar
Postfix to real part of complex signal names, specified as '_re'
,
a character vector, or a string scalar. See Using Complex Data and Coefficients.
EntityConflictPostfix
— Postfix to duplicate entity or module names
'_block'
(default) | character vector | string scalar
Postfix to duplicate entity or module names, specified as
'_block'
, a character vector, or a string scalar. The coder appends
this postfix to resolve duplicate VHDL entity or Verilog module names. For example, if
the coder detects two entities with the name MyFilt
, the coder names
the first entity MyFilt
and the second instance
MyFilt_block
.
InstancePrefix
— Prefix for component instance name
'u_'
(default) | character vector | string scalar
Prefix for component instance name, specified as 'u_'
, a
character vector, or string scalar.
PackagePostfix
— Postfix to VHDL package file name
'_pkg'
(default) | character vector | string scalar
Postfix to VHDL package file name, specified as '_pkg'
, a
character vector, or a string scalar. The coder derives the package name by appending
this postfix to the filter name. This option applies only if a package file is required
for the design.
ReservedWordPostfix
— Postfix to reserved words
'_rsvd'
(default) | character vector | string scalar
Postfix to reserved words, specified as '_rsvd'
, a character
vector, or a string scalar. This property applies to name, postfix, or label values
specified as a character vector or a string scalar in Name,Value
pair arguments to generatehdl
. If a specified value is a reserved
word in the target language, the coder appends this postfix to the value. For example,
if you call generatehdl
with the argument pair
'Name','mod'
, the coder forms the name mod_rsvd
in the generated filter code. See Reserved Word Tables.
SplitEntityArch
— Split VHDL entity and architecture code
'off'
(default) | 'on'
Split VHDL entity and architecture code, specified as 'off'
or
'on'
. When this property is set to 'on'
, the
coder generates the VHDL entity and architecture code of the filter in two separate
files. The coder derives the file names from the filter name by appending the postfixes
_entity
and _arch
to the base file name. To
specify custom postfix values, set the SplitEntityFilePostfix
and SplitArchFilePostfix
properties.
SplitArchFilePostfix
— Postfix to VHDL architecture file name
'_arch'
(default) | character vector | string scalar
Postfix to VHDL architecture file name, specified as '_arch'
, a
character vector, or a string scalar.
Dependencies
This property applies only when you set SplitEntityArch
to
'on'
.
SplitEntityFilePostfix
— Postfix to VHDL entity file name
'_entity'
(default) | character vector | string scalar
Postfix to VHDL entity file name, specified as '_entity'
, a
character vector, or a string scalar.
Dependencies
This property applies only when you set SplitEntityArch
to
'on'
.
UserComment
— Add user comments to generated HDL code
character vector | string scalar
Add user comments to generated HDL code, specified as a character vector or string vector. The user comments appear in the header comment block at the top of the generated files, preceded by leading comment characters specific to the target language. When you include new lines or line feeds in the user comments, the coder emits single-line comments for each new line. For example:
firfilt = dsp.FIRFilter; generatehdl(firfilt,'InputDataType',numerictype(1,16,15), ... 'UserComment','This is a comment line.\nThis is a second line.')
firfilt
is as
follows:-- ------------------------------------------------------------- -- -- Module: firfilt -- Generated by MATLAB(R) 9.1 and the Filter Design HDL Coder 3.1. -- Generated on: 2016-11-08 15:28:25 -- This is a comment line. -- This is a second line. -- -- ------------------------------------------------------------- -- ------------------------------------------------------------- -- HDL Code Generation Options: -- -- TargetLanguage: VHDL -- Name: firfilt -- InputDataType: numerictype(1,16,15) -- UserComment: User data, length 47 -- GenerateHDLTestBench: off -- ------------------------------------------------------------- -- HDL Implementation : Fully parallel -- Folding Factor : 1 -- ------------------------------------------------------------- -- Filter Settings: -- -- Discrete-Time FIR Filter (real) -- ------------------------------- -- Filter Structure : Direct-Form FIR -- Filter Length : 2 -- Stable : Yes -- Linear Phase : Yes (Type 2) -- Arithmetic : fixed -- Numerator : s16,15 -> [-1 1) -- -------------------------------------------------------------
VectorPrefix
— Prefix for VHDL vector signal names
'vector_of_'
(default) | character vector | string scalar
Prefix for VHDL vector signal names, specified as 'vector_of_'
, a
character vector, or a string scalar.
Tips
If you use the function fdhdltool
to generate HDL code, you can set the
corresponding properties in the Generate HDL dialog box.
Property | Location in Dialog Box |
---|---|
Input data type Output data type Clock enable output port Input port Output port | Global Settings tab > Ports tab |
Additional port and identifier properties |
Top section of Global Settings tab, and Global Settings tab > General tab |
Check out the main Global Settings tab, and the Ports and General tabs of the Global Settings tab.
Version History
Introduced before R2006a
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other bat365 country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)