Why File I/O for test vectors ($readmemh, $writememh) in Verilog? - Purpose & Use Cases

The Big Idea

What if you could load thousands of test inputs instantly without typing a single number in your code?

The Scenario

Imagine you have to test a digital circuit with hundreds of input values. You write each value by hand inside your Verilog code. This means typing long lists of numbers directly in your testbench every time you want to run a test.

The Problem

Manually typing test data is slow and boring. It is easy to make mistakes like typos or missing values. Also, if you want to change the test data, you must edit the code and recompile everything. This wastes time and can cause errors that are hard to find.

The Solution

Using $readmemh and $writememh lets you load and save test data from external files. This means you keep your test vectors in simple text files. Your Verilog code can read these files automatically, making tests faster and less error-prone.

Before vs After

✗ Before

reg [7:0] test_data [0:255];
initial begin
  test_data[0] = 8'h1A;
  test_data[1] = 8'h2B;
  // ... many lines
end

✓ After

reg [7:0] test_data [0:255];
initial begin
  $readmemh("test_vectors.hex", test_data);
end

What It Enables

You can quickly change test inputs by editing simple files without touching your Verilog code, making testing flexible and efficient.

Real Life Example

When designing a processor, engineers use $readmemh to load thousands of instruction codes from a file to simulate how the processor runs real programs.

Key Takeaways

Manual test data entry is slow and error-prone.

$readmemh and $writememh automate loading and saving test vectors.

This makes testing faster, easier, and less buggy.

Practice

1. What is the primary purpose of the Verilog system task $readmemh?

easy

A. To load hexadecimal data from a file into a memory array

B. To write memory contents to a file in binary format

C. To initialize registers with random values

D. To display memory contents on the console

Solution

1. Step 1: Understand $readmemh usage

   $readmemh is used to read hexadecimal data from a file and load it into a memory array in Verilog.

2. Step 2: Compare with other options

   Other options describe writing data, random initialization, or display, which are not the purpose of $readmemh.

3. Final Answer:

   To load hexadecimal data from a file into a memory array -> Option A

4. Quick Check:

   $readmemh loads hex data [OK]

Hint: Remember: $readmemh reads hex data into memory [OK]

Common Mistakes:

• Confusing $readmemh with $writememh
• Thinking it writes data instead of reading
• Assuming it reads binary instead of hex

2. Which of the following is the correct syntax to write memory contents to a hex file in Verilog?

easy

A. $readmemh("data.hex", mem_array);

B. $writememh("output.hex", mem_array);

C. $writehex("output.hex", mem_array);

D. $dumpmemh("output.hex", mem_array);

Solution

1. Step 1: Identify the correct system task for writing

   $writememh is the Verilog system task used to write memory contents to a hex file.

2. Step 2: Check syntax correctness

   The syntax $writememh("output.hex", mem_array); correctly specifies the file name and memory array.

3. Final Answer:

   $writememh("output.hex", mem_array); -> Option B

4. Quick Check:

   Write memory to hex file = $writememh [OK]

Hint: Use $writememh to save memory to hex file [OK]

Common Mistakes:

• Using $readmemh instead of $writememh
• Misspelling the system task name
• Using non-existent tasks like $writehex

3. Given the following Verilog code snippet, what will be the content of mem[0] after $readmemh executes if the file data.hex contains:
0A
1F
2B

reg [7:0] mem [0:2];
initial begin
  $readmemh("data.hex", mem);
end

medium

A. 8'h00

B. 8'h1F

C. 8'h2B

D. 8'h0A

Solution

1. Step 1: Understand $readmemh file loading order

   $readmemh loads the first line of the file into mem[0], second line into mem[1], and so on.

2. Step 2: Match file content to memory

   The first line is 0A, so mem[0] will be 8'h0A.

3. Final Answer:

   8'h0A -> Option D

4. Quick Check:

   First file line -> mem[0] = 0A [OK]

Hint: First file line loads into mem[0] with $readmemh [OK]

Common Mistakes:

• Assuming mem[0] gets last file line
• Confusing hex values with decimal
• Forgetting zero-based indexing

4. Identify the error in the following Verilog code snippet that attempts to write memory contents to a hex file:

reg [7:0] mem [0:3];
initial begin
  $writememh(mem, "output.hex");
end

medium

A. Missing file extension in filename

B. Memory array size is invalid

C. Arguments to $writememh are in wrong order

D. Cannot use $writememh inside initial block

Solution

1. Step 1: Check $writememh argument order

   The correct syntax is $writememh("filename", memory_array);. The code reverses these arguments.

2. Step 2: Verify other aspects

   Memory size and file extension are valid, and $writememh can be used inside initial blocks.

3. Final Answer:

   Arguments to $writememh are in wrong order -> Option C

4. Quick Check:

   Filename first, memory second in $writememh [OK]

Hint: Filename is first argument in $writememh [OK]

Common Mistakes:

• Swapping filename and memory array arguments
• Thinking file extension is mandatory
• Believing $writememh can't be in initial block

5. You want to test a memory module by loading test vectors from a hex file and then save the modified memory contents back to another hex file. Which sequence of Verilog system tasks correctly achieves this?

hard

A. $readmemh("input.hex", mem); // test$writememh("output.hex", mem); // save

B. $writememh("input.hex", mem); // test$readmemh("output.hex", mem); // save

C. $readmemh(mem, "input.hex"); // test$writememh(mem, "output.hex"); // save

D. $readmemh("output.hex", mem); // test$writememh("input.hex", mem); // save

Solution

1. Step 1: Load test vectors correctly

   Use $readmemh("input.hex", mem); to load test vectors from the input file into memory.

2. Step 2: Save modified memory correctly

   Use $writememh("output.hex", mem); to write the memory contents to the output file.

3. Final Answer:

   $readmemh("input.hex", mem); // test
   $writememh("output.hex", mem); // save -> Option A

4. Quick Check:

   Read first, then write with correct syntax [OK]

Hint: Read test vectors first, write results second [OK]

Common Mistakes:

• Reversing read and write order
• Swapping filename and memory arguments
• Using wrong filenames for read/write