How to Use `define` Macro in Verilog: Syntax and Examples

In Verilog, you use the `define directive to create a macro, which acts like a constant or reusable code snippet. You write `define NAME value at the top of your file, then use `NAME anywhere in your code to replace it with the defined value.

Syntax

The `define directive creates a macro with a name and a value or code snippet. It has this form:

`define MACRO_NAME replacement_text

Here:

• `define` is the keyword to create a macro.
• MACRO_NAME is the name you choose for the macro (no spaces, usually uppercase).
• replacement_text is the value or code that will replace the macro wherever used.

You use the macro by writing `MACRO_NAME in your code.

verilog

`define WIDTH 8

module example;
  reg [`WIDTH-1:0] data;
endmodule

Example

This example shows how to define a macro for a bus width and use it in a module. The macro `define WIDTH 8 sets the width to 8 bits. The module uses `WIDTH to declare a register of that size.

verilog

`define WIDTH 8

module example;
  reg [`WIDTH-1:0] data;

  initial begin
    data = 8'b10101010;
    $display("Data = %b", data);
  end
endmodule

Output

Data = 10101010

Common Pitfalls

Common mistakes when using `define macros include:

• Forgetting the backtick ` before the macro name when using it.
• Defining macros with spaces in the name, which is invalid.
• Not placing `define before the module or code that uses it.
• Macros do simple text replacement, so complex expressions may need parentheses to avoid errors.

verilog

`define WIDTH 8

module example_wrong;
  reg [WIDTH-1:0] data; // Wrong: missing backtick before WIDTH
endmodule

// Correct usage:
module example_right;
  reg [`WIDTH-1:0] data;
endmodule

Quick Reference

Directive	Description	Example
`define	Creates a macro	`define WIDTH 8
`MACRO_NAME	Uses the macro value	reg [`WIDTH-1:0] data;
`undef	Removes a macro definition	`undef WIDTH

Key Takeaways

Use `define` to create reusable constants or code snippets in Verilog.

Always prefix macro usage with a backtick (`) to expand it correctly.

Place `define directives before any code that uses the macro.

Macros perform simple text replacement, so use parentheses for complex expressions.

Use `undef to remove macros if needed to avoid conflicts.