พื้นฐานและการใช้งาน define ใน Verilog: คู่มือสำหรับการออกแบบดิจิทัลและ FPGA

By 佐川 直弘 | Naohiro Sagawa (運営者)

※記事内に広告を含みます。Amazonアソシエイトとして適格販売により収入を得ています。

1. พื้นฐานของ define ใน Verilog

define คืออะไร? (บทบาทและข้อดี)

define เป็นหนึ่งใน Preprocessor Directive ของ Verilog ซึ่งมีหน้าที่แทนที่สตริงด้วยค่าหรือเนื้อหาอื่นในระหว่างการคอมไพล์

ข้อดีหลักของ define

• เพิ่มความอ่านง่ายของโค้ด: เขียนชื่อค่าคงที่ที่ยาวได้อย่างย่อ
• เพิ่มความง่ายต่อการบำรุงรักษา: การแก้ไขทำได้ง่าย (เปลี่ยนเพียงจุดเดียวก็มีผลทุกที่)
• รองรับการคอมไพล์แบบมีเงื่อนไข: สามารถใช้ร่วมกับ ifdef / ifndef เพื่อให้โค้ดทำงานเฉพาะบางเงื่อนไข

ขอบเขตการใช้งานของ define (Global หรือ Local)

define ใน Verilog จะทำงานในGlobal Scope
หมายความว่า เมื่อกำหนดแล้ว สามารถใช้งานได้ทุกโมดูลหรือบล็อกในไฟล์เดียวกัน
แต่สามารถยกเลิกการกำหนดได้ด้วย undef

การใช้งาน define แบบ Global

`define WIDTH 8

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

การยกเลิกการกำหนดด้วย undef

`define TEMP 100
`undef TEMP

ความสัมพันธ์ระหว่าง include และ define (ข้อควรระวังเมื่อแยกไฟล์)

กำหนด define ไว้ในไฟล์ภายนอก

constants.vh (Header file)

`define DATA_WIDTH 16

main.v (Main file)

`include "constants.vh"

module main;
  reg [`DATA_WIDTH-1:0] value;
endmodule

โครงสร้างพื้นฐานและโค้ดตัวอย่าง

โครงสร้างพื้นฐาน

`define ชื่อมาโคร ค่าที่จะแทนที่

ตัวอย่างการใช้ค่าคงที่

module example;
  real pi_value = `PI;
endmodule

สรุป

• define เป็น Preprocessor Directive ที่ใช้แทนที่สตริงระหว่างการคอมไพล์
• ถูกใช้แบบ Global และใช้งานได้ข้ามโมดูล
• สามารถจัดการค่าคงที่ในไฟล์แยกโดยใช้ร่วมกับ include
• สามารถยกเลิกการกำหนดได้ด้วย undef

2. พื้นฐานและการประยุกต์ใช้ define: วิธีการใช้งานและการเพิ่มประสิทธิภาพโค้ด

วิธีการใช้งานพื้นฐานของ define

โครงสร้างพื้นฐาน

`define ชื่อมาโคร ค่าที่จะแทนที่

การกำหนดค่าคงที่

`define DATA_WIDTH 16

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

การใช้งานมาโคร

`define ADD(A, B) (A + B)

module example;
  initial begin
    $display("Sum: %d", `ADD(10, 5));
  end
endmodule

การใช้งาน Conditional Compilation (ifdef / ifndef)

โครงสร้างพื้นฐานของ ifdef

`ifdef ชื่อมาโคร
  // โค้ดเมื่อมาโครถูกกำหนด
`else
  // โค้ดเมื่อมาโครยังไม่ถูกกำหนด
`endif

การเปิดใช้งานโค้ดสำหรับ Debug

`define DEBUG

module example;
  initial begin
    `ifdef DEBUG
      $display("Debug mode is ON");
    `else
      $display("Debug mode is OFF");
    `endif
  end
endmodule

ifndef (กรณีที่ยังไม่ได้กำหนดมาโคร)

`ifndef SIMULATION
  // โค้ดที่จะทำงานเมื่อไม่ใช่สภาพแวดล้อม Simulation
`endif

การเขียนมาโครเพื่อเพิ่มการนำกลับมาใช้ซ้ำ

มาโครแบบมีอาร์กิวเมนต์

`define MULTIPLY(A, B) (A * B)

module example;
  initial begin
    $display("Result: %d", `MULTIPLY(5, 6));
  end
endmodule

การจัดการค่าคงที่ร่วมกันด้วย include

Header file (constants.vh)

`define CLOCK_FREQ 50_000_000

Main file (main.v)

`include "constants.vh"

module example;
  initial begin
    $display("Clock Frequency: %d", `CLOCK_FREQ);
  end
endmodule

การเพิ่มประสิทธิภาพโค้ดที่ใช้ซ้ำด้วย define

การทำ Bit Operation ให้สั้นลง

`define SET_BIT(REG, BIT) (REG | (1 << BIT))

module example;
  reg [7:0] my_register;

  initial begin
    my_register = `SET_BIT(my_register, 3);
    $display("Register value: %b", my_register);
  end
endmodule

สรุป

• สามารถใช้ define เพื่อกำหนดค่าคงที่หรือมาโคร
• รองรับการจัดการโค้ดที่ต่างกันในแต่ละสภาพแวดล้อมด้วย Conditional Compilation (ifdef / ifndef)
• การใช้มาโครแบบมีอาร์กิวเมนต์ช่วยเพิ่มการนำกลับมาใช้ซ้ำ
• การใช้ include ช่วยให้ค่าคงที่ถูกจัดการรวมศูนย์และใช้ร่วมกันได้หลายไฟล์

3. ความแตกต่างระหว่าง define และ parameter

คุณลักษณะของ define (การประมวลผลในระดับ Preprocessor)

define เป็น Preprocessor Directive ของ Verilog ซึ่งจะถูกขยายเป็นมาโครก่อนการคอมไพล์

คุณลักษณะหลักของ define

• ถูกแทนค่าที่ระดับ Preprocessor (ก่อนที่คอมไพเลอร์จะตีความ)
• มีขอบเขตแบบ Global (ใช้ได้ทุกโมดูลในไฟล์)
• ไม่มีชนิดข้อมูล (ถูกมองเป็นสตริงทั้งหมด)
• ไม่รองรับการ Parameterization (ขาดความยืดหยุ่น)

ตัวอย่างการใช้ define

`define WIDTH 16

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

คุณลักษณะของ parameter (สามารถกำหนดค่าได้ตอนคอมไพล์)

parameter คือ ค่าคงที่ที่กำหนดภายในโมดูล ซึ่งช่วยเพิ่มความยืดหยุ่นในการออกแบบ

คุณลักษณะหลักของ parameter

• มีขอบเขตแบบ Local (กำหนดเฉพาะแต่ละโมดูล)
• มีชนิดข้อมูล (สามารถระบุความกว้างบิตได้)
• รองรับการ Parameterization (เปลี่ยนค่าได้ตอนอินสแตนซ์)
• ดีต่อการ Debug (ตรวจสอบได้ในขั้นตอนคอมไพล์)

ตัวอย่างการใช้ parameter

module example #(parameter WIDTH = 16);
  reg [WIDTH-1:0] data;
endmodule

การเขียนทับค่า Parameter

module top;
  example #(.WIDTH(32)) instance1();
  example #(.WIDTH(8)) instance2();
endmodule

การเปรียบเทียบระหว่าง define และ parameter

ควรใช้แบบไหน? (เปรียบเทียบตามกรณี)

ควรใช้ define เมื่อ

• ต้องการกำหนดค่าแบบ Global
• ต้องการใช้ Conditional Compilation
• ใช้กับค่าคงที่ที่เรียบง่าย

ควรใช้ parameter เมื่อ

• ต้องการกำหนดค่าที่แตกต่างกันในแต่ละโมดูล
• ต้องการใช้กับบิตวิดท์หรือค่าตัวเลข
• ต้องการความง่ายในการ Debug

สรุป

• define ถูกประมวลผลโดย Preprocessor และถูกแทนค่าก่อนคอมไพล์
• parameter ใช้ภายในโมดูล และสามารถเปลี่ยนค่าได้ตอนอินสแตนซ์
• ใช้ define เมื่อจำเป็นต้องใช้แบบ Global และใช้ parameter เมื่อจำเป็นต้องควบคุมแบบ Local
• หากคำนึงถึงความง่ายในการ Debug ควรใช้ parameter เป็นหลัก

4. การใช้งาน define ขั้นสูง

การสร้างมาโครแบบมีอาร์กิวเมนต์

โครงสร้างพื้นฐานของมาโครแบบมีอาร์กิวเมนต์

`define MACRO_NAME(ARG1, ARG2) โค้ดที่ถูกแทนค่า

ตัวอย่างมาโครสำหรับการบวก

`define ADD(A, B) (A + B)

module example;
  initial begin
    $display("Sum: %d", `ADD(10, 5));
  end
endmodule

มาโครสำหรับ Bit Operation

`define SET_BIT(REG, BIT) (REG | (1 << BIT))

module example;
  reg [7:0] data;

  initial begin
    data = `SET_BIT(data, 3);
    $display("Data: %b", data);
  end
endmodule

การกำหนดมาโครหลายบรรทัด

โครงสร้างพื้นฐานของมาโครหลายบรรทัด

`define MACRO_NAME(ARG) 
  โค้ด1; 
  โค้ด2;

ตัวอย่างการใช้มาโครหลายบรรทัด

`define PRINT_VALUES(A, B) 
  $display("Value A: %d", A); 
  $display("Value B: %d", B);

module example;
  initial begin
    `PRINT_VALUES(10, 20);
  end
endmodule

เทคนิคสำหรับ Debug และการปรับปรุงโค้ด

มาโครสำหรับ Debug

`define DEBUG_PRINT(MSG) 
  $display("DEBUG: %s", MSG);

module example;
  initial begin
    `DEBUG_PRINT("This is a debug message");
  end
endmodule

การสลับโหมด Debug

`define DEBUG

module example;
  initial begin
    `ifdef DEBUG
      $display("Debug mode enabled");
    `endif
  end
endmodule

ตัวอย่างการออกแบบโดยใช้ define

การสลับความถี่ Clock

`define CLOCK_50MHZ
// `define CLOCK_100MHZ

module clock_generator;
  `ifdef CLOCK_50MHZ
    localparam CLOCK_FREQ = 50_000_000;
  `elsif CLOCK_100MHZ
    localparam CLOCK_FREQ = 100_000_000;
  `endif

  initial begin
    $display("Clock Frequency: %d Hz", CLOCK_FREQ);
  end
endmodule

สรุป

• การใช้มาโครแบบมีอาร์กิวเมนต์ช่วยลดความซ้ำซ้อนในโค้ด
• การใช้มาโครหลายบรรทัดทำให้โค้ดอ่านง่ายขึ้น
• การสร้างมาโครสำหรับ Debug ช่วยให้สลับระหว่างโหมดทดสอบและโหมดจริงได้ง่าย
• ควรใช้ define เพื่อเพิ่มความยืดหยุ่นของการออกแบบด้วยการแบ่งเงื่อนไข

5. ข้อควรระวังเมื่อใช้งาน define

วิธีป้องกันการชนกันของชื่อ (Name Collision)

ตัวอย่างปัญหา

`define WIDTH 16

module moduleA;
  reg [`WIDTH-1:0] dataA;
endmodule

module moduleB;
  `define WIDTH 32
  reg [`WIDTH-1:0] dataB;
endmodule

วิธีแก้ไข: ใช้ชื่อที่ไม่ซ้ำกัน

`define MODULE_A_WIDTH 16
`define MODULE_B_WIDTH 32

แนวทางปฏิบัติที่ดีเพื่อรักษาความอ่านง่ายของโค้ด

1. ใส่คอมเมนต์

`define DATA_WIDTH 16  // กำหนดความกว้างของ Data Bus

2. หลีกเลี่ยงการซ้อนเงื่อนไขมากเกินไป

ตัวอย่างที่ไม่ดี (ซ้อนลึกเกินไป)

`ifdef FEATURE_A
  `ifdef FEATURE_B
    `ifdef DEBUG_MODE
      // โค้ดที่อยู่ในนี้
    `endif
  `endif
`endif

ตัวอย่างที่ดี

`ifdef FEATURE_A
  `define ENABLE_FEATURE_A
`endif

`ifdef FEATURE_B
  `define ENABLE_FEATURE_B
`endif

module example;
  `ifdef ENABLE_FEATURE_A
    initial $display("Feature A is enabled");
  `endif
endmodule

3. รักษาการย่อหน้า (Indent) ให้เหมาะสม

ความเสี่ยงจากการใช้ define มากเกินไป และวิธีแก้ไข

ความเสี่ยงที่ 1: Debug ยากขึ้น

วิธีแก้:

`define VALUE 10

module example;
  initial begin
    $display("VALUE: %d", `VALUE);
  end
endmodule

ความเสี่ยงที่ 2: บางกรณีควรใช้ parameter แทน

ตัวอย่างที่ใช้ define (ไม่แนะนำ)

`define WIDTH 16

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

ตัวอย่างที่ใช้ parameter (แนะนำ)

module example #(parameter WIDTH = 16);
  reg [WIDTH-1:0] data;
endmodule

ความเสี่ยงที่ 3: ทำให้ผู้อื่นเข้าใจโค้ดยาก

แนวทางแก้ไข:

• ใช้ define เท่าที่จำเป็น และคำนึงถึงความอ่านง่าย
• ใช้ parameter หรือ localparam แทนเมื่อเหมาะสม
• กำหนดกฎการตั้งชื่อที่ชัดเจน

สรุป

• เนื่องจาก define เป็น Global Scope จึงต้องระวังการตั้งชื่อไม่ให้ชนกัน
• ใช้คอมเมนต์และการย่อหน้า (Indent) อย่างเหมาะสมเพื่อเพิ่มความอ่านง่าย
• หลีกเลี่ยงการใช้ define มากเกินไป และพิจารณาใช้ parameter แทน
• คำนึงถึงความยากในการ Debug และใช้ $display หรือวิธีอื่นช่วยตรวจสอบ

6. FAQ (คำถามที่พบบ่อย)

ควรใช้ define หรือ parameter ดี?

คำแนะนำ

• ควรใช้ parameter เป็นหลัก หากเป็นไปได้
• หากต้องการ Conditional Compilation (ifdef เป็นต้น) ควรใช้ define

จะ Debug เมื่อใช้ define ได้อย่างไร?

แนวทางสำหรับการ Debug

• ใช้ $display เพื่อตรวจสอบผลการแทนค่าของ define

`define VALUE 100

module example;
  initial begin
    $display("VALUE: %d", `VALUE);
  end
endmodule

• ใช้ undef เพื่อปิดการทำงานของ define ชั่วคราว

`define DEBUG
`undef DEBUG

ความแตกต่างระหว่าง ifdef และ ifndef

ตัวอย่างการใช้งาน

`define FEATURE_A

`ifdef FEATURE_A
  $display("FEATURE_A is enabled");
`else
  $display("FEATURE_A is disabled");
`endif

`ifndef FEATURE_B
  $display("FEATURE_B is not defined");
`endif

จะใช้ define กับหลายบรรทัดได้อย่างไร?

การกำหนดมาโครหลายบรรทัด

`define PRINT_VALUES(A, B) 
  $display("Value A: %d", A); 
  $display("Value B: %d", B);

module example;
  initial begin
    `PRINT_VALUES(10, 20);
  end
endmodule

define ใน SystemVerilog แตกต่างจาก Verilog หรือไม่?

ตัวอย่างการใช้ Preprocessor Function ใน SystemVerilog

`define DEBUG_PRINT(MSG) 
  $display("DEBUG [%s:%0d]: %s", `__FILE__, `__LINE__, MSG);

module example;
  initial begin
    `DEBUG_PRINT("Simulation started");
  end
endmodule

สรุป

• ควรเลือกใช้ define หรือ parameter ตามวัตถุประสงค์
• สำหรับการ Debug ควรใช้ $display เพื่อตรวจสอบผลลัพธ์
• ifdef ใช้เมื่อ “ถูกกำหนดแล้ว” ส่วน ifndef ใช้เมื่อ “ยังไม่ถูกกำหนด”
• สำหรับมาโครหลายบรรทัด ให้ใช้ backslash (\) ต่อบรรทัด
• SystemVerilog มีความสามารถของ Preprocessor ที่ทรงพลังมากกว่า