Coding Standards

R2026b

Learn about coding standard report, lint tool scripts, and coding standard rules

Industry coding standards recommend using certain HDL coding guidelines. HDL Coder™ generates code that follows industry-standard rules and generates a report that shows how well your generated HDL code conforms to industry coding standards.

HDL Coder checks for conformance of your Simulink^® model or MATLAB^® algorithm to the HDL coding standard rules. To fix errors or warnings related to these rules, update your model design. You can customize some of the coding standard rules.

Functions

hdlcoder.CodingStandard Create HDL coding standard customization object

Properties

HDL Coding Standard Customization Properties

Customize HDL coding standard

Model Settings

Coding standards

HDL coding standard	Select coding standard guidelines
Show passing rules in coding standard report	Include passing rules in coding standard report
Check for duplicate names	Check for duplicate names in design
Check for HDL keywords in design names	Check for HDL keywords in design names
Check module, instance, entity name length	Whether to check module, instance, and entity name length
Check signal, port, and parameter name length	Whether to check signal, port, and parameter name length
Check for clock enable signals	Whether to check for clock enable signals in generated code
Detect usage of reset signals	Whether to check for reset signals in generated code
Detect usage of asynchronous reset signals	Whether to check for asynchronous reset signals in generated code
Minimize use of variables	Whether to minimize use of variables
Check for initial statements that set RAM initial values	Whether to check for initial statements that set RAM initial values
Check for conditional statements in processes	Whether to check for length of conditional statements
Check for assignments to the same variable in multiple cascaded control regions	Whether to check if there are assignments to same variable in multiple cascaded control regions
Check if-else statement chain length	Whether to check if-else statement chain length
Check if-else statement nesting depth	Whether to check if-else statement nesting depth
Check multiplier width	Whether to check multiplier bit width
Check for non-integer constants	Whether to check for non-integer constants
Check line wrap length	Whether to check line lengths in the generated HDL code

Checks

Naming Guidelines

Check naming conventions

Check top-level subsystem/port names

Check module/entity names

Check signal and port names

Check package file names

Guidelines Specific to VHDL

Check file extension

Check architecture name

Check entity and architecture

Guidelines for Clocks and Resets

Check clock, reset, and enable signals

Check clock settings

Topics

HDL Coding Standard Report

HDL Coding Standards
Learn about HDL coding standards and rules.
HDL Coding Standard Report
What an HDL coding standard report is, the rule summary, and how you can fix warnings or errors related to rule violations.
Generate an HDL Coding Standard Report from MATLAB
Generate a coding standard report for a model.
Generate HDL Coding Standard Report from Simulink
Generate an HDL coding standard report from your Simulink model by using the Configuration Parameters dialog box or at the command line.
Generate HDL Lint Tool Script
Generate an HDL lint tool script from Simulink to check the generated code with third-party lint tools.

HDL Coding Standard Rules Reference

Basic Coding Practices
A list of rules related to basic coding practices, the rule description, and how you can fix warnings or errors resulting from rule violations.
RTL Description Rules and Checks
A list of rules related to RTL description techniques, the rule description, and how you can fix warnings or errors resulting from rule violations.
RTL Design Methodology Guidelines
A list of rules related to RTL design methodology, the rule description, and how you can fix warnings or errors resulting from rule violations.

Coding Standard Considerations

Cascaded Conditional Region Variable Assignments
Pass and fail examples of HDL code patterns for the check for the presence of assignments to the same variable in multiple cascaded conditional regions.