`include指令【FPGA】

 案例：

在Verilog中，`include指令可以将一个文件的内容插入到当前文件中。
这个指令通常用于将一些常用的代码片段或者模块定义放在单独的文件中，
然后在需要使用的地方通过`include指令将其插入到当前文件中。
这样可以提高代码的复用性和可维护性。
 
下面是一个`include的使用案例：
 
假设我们有一个名为"adder.v"的文件，其中定义了一个4位加法器模块"adder4"。
我们可以将这个模块定义放在一个单独的文件"adder4.v"中，
然后在"adder.v"中通过`include指令将其插入到当前文件中。具体操作如下：
 
1. 在"adder4.v"中定义4位加法器模块"adder4"：
 
```
module adder4(a, b, cin, sum, cout);
    input [3:0] a, b;
    input cin;
    output [3:0] sum;
    output cout;
 
    assign {cout, sum} = a + b + cin;
endmodule
```
 
2. 在"adder.v"中通过`include指令将"adder4.v"中的内容插入到当前文件中，并使用"adder4"模块：
 
```
`include "adder4.v"
 
module top;
    wire [3:0] a, b;
    wire cin, cout;
    wire [3:0] sum;
 
    adder4 u_adder4(.a(a), .b(b), .cin(cin), .sum(sum), .cout(cout));
endmodule
```
 
这样，我们就可以在"adder.v"中使用"adder4"模块，而不需要在当前文件中重新定义一遍。

源文件： 

假设我们有一个名为"adder.v"的文件

module adder4(a, b, cin, sum, cout);
    input [3:0] a, b;
    input cin;
    output [3:0] sum;
    output cout;
 
    assign {cout, sum} = a + b + cin;
endmodule

调用文件： 

`include "adder4.v"
 
module top;
    wire [3:0] a, b;
    wire cin, cout;
    wire [3:0] sum;
 
    adder4 u_adder4(.a(a), .b(b), .cin(cin), .sum(sum), .cout(cout));
endmodule

io案例：

在Verilog中，
使用`include可以将IO引脚定义写在另一个文件内，以便于代码的管理和维护。
下面是一个简单的Demo：
 
引用：
`include "io_def.v"
 
module my_module(clk, in1, in2, out1, out2);
  input clk;
  input in1, in2;
  output out1, out2;
  
  wire [7:0] data_in;
  wire [7:0] data_out;
  
  // 实例化一个模块
  my_submodule submodule_inst(clk, data_in, data_out);
  
  // 将输入输出端口与data_in、data_out相连
  assign data_in = {in1, in2};
  assign {out1, out2} = data_out;
  
endmodule
 
在上面的代码中，我们使用了`include "io_def.v"将IO引脚定义写在了另一个文件io_def.v中。
在my_module模块中，我们实例化了一个名为submodule_inst的模块，
并将其输入输出端口与data_in、data_out相连。
这样，我们就可以在另一个文件中定义IO引脚，然后在需要使用的模块中使用`include将其引入，
从而实现代码的模块化和复用。
 

io_def.v文件内容：
 
 
`define DATA_WIDTH 8
`define CLK_PERIOD 10
 
module io_def(
    input clk,
    input [`DATA_WIDTH-1:0] in1,
    input [`DATA_WIDTH-1:0] in2,
    output [`DATA_WIDTH-1:0] out1,
    output [`DATA_WIDTH-1:0] out2
);
endmodule

my_module.v文件内容：
 
 
`include "io_def.v"
 
module my_module(
    input clk,
    input in1,
    input in2,
    output out1,
    output out2
);
 
wire [`DATA_WIDTH-1:0] data_in;
wire [`DATA_WIDTH-1:0] data_out;
 
// 实例化一个模块
my_submodule submodule_inst(clk, data_in, data_out);
 
// 将输入输出端口与data_in、data_out相连
assign data_in = {in1, in2};
assign {out1, out2} = data_out;
 
endmodule

在上面的代码中，我们使用了include "io_def.v"将IO引脚定义写在了另一个文件io_def.v中。在my_module模块中，我们实例化了一个名为submodule_inst的模块，并将其输入输出端口与data_in、data_out相连。这样，我们就可以在另一个文件中定义IO引脚，然后在需要使用的模块中使用include将其引入，从而实现代码的模块化和复用。

define方法

在Verilog中，使用`include可以将IO引脚定义写在另一个文件内，
这样可以方便地修改与硬件哪个引脚绑定。下面是一个简单的Demo：
 
// io_defines.v
`ifndef _IO_DEFINES_V
`define _IO_DEFINES_V
 
`define CLK 1
`define RST 2
`define DATA_IN 3
`define DATA_OUT 4
 
`endif // _IO_DEFINES_V
 
// top_module.v
`include "io_defines.v"
 
module top_module (
    input wire [`CLK] clk,
    input wire [`RST] rst,
    input wire [`DATA_IN] data_in,
    output wire [`DATA_OUT] data_out
);
 
// ...
 
endmodule
 
在上面的例子中，我们将IO引脚定义写在了io_defines.v文件中，
并使用`include将其包含到了top_module.v文件中。
这样，在top_module中就可以使用`CLK、`RST、`DATA_IN
和`DATA_OUT这些宏来代替具体的引脚号码了。
如果需要修改某个引脚的绑定，只需要修改io_defines.v文件即可。
 

案例3：

在Verilog中，如果要在io_defines.v文件中定义LED，并在top_module.v文件中使用LED，
可以按照以下步骤进行操作：
1. 在io_defines.v文件中定义LED，可以使用以下代码：
   ```
   module io_defines(
     input wire LED
   );
   endmodule
   ```
2. 在top_module.v文件中使用LED，可以使用以下代码：
   ```
   module top_module(
     input wire clk,
     input wire reset,
     input wire [7:0] data_in,
     output wire [7:0] data_out,
     input wire LED
   );
   io_defines io_defines_inst(
     .LED(LED)
   );
   //其他模块实例化和逻辑代码
   endmodule
   ```
3. 在综合工具中，需要将LED绑定到对应的硬件引脚上，具体方法可以参考综合工具的使用手册。
 
下面是一个简单的Demo，演示了如何在io_defines.v和top_module.v中使用LED：
```
// io_defines.v
module io_defines(
  input wire LED
);
endmodule
 
// top_module.v
module top_module(
  input wire clk,
  input wire reset,
  input wire [7:0] data_in,
  output wire [7:0] data_out,
  input wire LED
);
io_defines io_defines_inst(        //【注】这里进行连线
  .LED(LED)
);
assign data_out = data_in;
endmodule
```