SystemVerilog 语法（1）package 的使用

目录

package 介绍

package 的基本语法

package 的引用

利用范围解析操作符 "::" 直接引用

利用 "import" 引用特定子项

利用通配符 "*" 引用包中的所有子项

---

package 介绍

SystemVerilog 中的 package 语法用于将相关的类型、常量、函数和任务组织在一起，以便在多个模块中共享和重用。

使用 package 的好处：

1. 模块化：使用 package 语法可以将代码分割成多个逻辑模块，使得代码更加模块化，易于维护和重用。
2. 作用域控制：package 语法可以控制变量和函数的作用域，避免了变量和函数名称冲突的问题。
3. 封装性：使用 package 语法可以将一些私有的变量和函数封装起来，只对外暴露必要的接口，增强了代码的封装性和安全性。
4. 可读性：使用 package 语法可以使代码更加清晰易读，提高了代码的可读性和可维护性。
5. 可重用性：使用 package 语法可以将一些通用的代码封装成库，方便在不同的项目中重用。

---

package 的基本语法

package 语法的基本结构如下：

package package_name;
  // 定义类型、常量、函数和任务
endpackage

其中，"package_name" 是包的名称，可以在其他模块中使用该名称来引用包中的内容。

在 package 中可以定义以下内容：

• 类型定义：使用 "typedef" 关键字定义新的数据类型。
• 常量定义：使用 "const" 关键字定义常量。
• 变量定义：使用 "var" 关键字定义变量。
• 函数定义：使用 "function" 关键字定义函数。
• 任务定义：使用 "task" 关键字定义任务。

例如，下面是一个简单的 package 定义：

package my_pkg;
  // 定义常量
  parameter int WIDTH = 8;
  // 定义数据类型
  typedef struct {
    logic [WIDTH-1:0] data;
    logic valid;
  } my_data_t;
  // 定义函数
  function automatic my_data_t create_my_data(logic [WIDTH-1:0] data);
    my_data_t my_data;
    my_data.data = data;
    my_data.valid = 1;
    return my_data;
  endfunction
endpackage

在上面的示例中，定义了一个名为 "my_pkg" 的 package。在 package 中，定义了一个常量 "WIDTH"，一个数据类型 "my_data_t"，以及一个函数 "create_my_data"。

注意：package 中定义的 function 必须包含 automatic 声明。

这是因为，如果没有声明为 automatic，function 的变量将会被视为全局变量，可能会导致不可预测的行为。使用 automatic 声明可以确保 function 中的变量只在 function 内部使用，避免了可能的命名冲突和其他问题。

---

package 的引用

package 定义可以在其他 SystemVerilog 文件中使用，只需在文件顶部包含 "my_pkg" 即可。例如：

`include "my_pkg.sv"
module my_module;
  ...
endmodule

调用了 my_pkg.sv 文件后，在模块内部引用也有多种方式，下面主要介绍三种方法：

• 利用范围解析操作符 "::" 直接引用
• 利用 "import" 引用特定子项
• 利用通配符 "*" 引用包中的所有子项

---

利用范围解析操作符 "::" 直接引用

`include "my_pkg.sv"
module my_module;
  // 直接引用常量
  parameter int WIDTH = my_pkg::WIDTH;

  // 直接引用数据类型
  my_pkg::my_data_t my_data;

  // 直接引用函数
  initial begin
    my_data = my_pkg::create_my_data(8'hFF);
  end
  
endmodule

---

利用 "import" 引用特定子项

`include "my_pkg.sv"
module my_module;
  //import 参数
  import my_pkg::WIDTH;
  //import 数据类型
  import my_pkg::my_data_t;
  //import 函数
  import my_pkg::create_my_data;
  
  // 引用常量
  parameter int WIDTH = my_pkg::WIDTH;

  // 引用数据类型
  my_data_t my_data;

  // 引用函数
  initial begin
    my_data = create_my_data(8'hFF);
  end
  
endmodule

---

利用通配符 "*" 引用包中的所有子项

`include "my_pkg.sv"
module my_module;
  //通配符"*"引用所有子项
  import my_pkg::*;
  
  // 引用常量
  parameter int WIDTH = my_pkg::WIDTH;

  // 引用数据类型
  my_data_t my_data;

  // 引用函数
  initial begin
    my_data = create_my_data(8'hFF);
  end
  
endmodule