Report statement for debug output in VHDL - Step-by-Step Execution

Concept Flow - Report statement for debug output

Start Simulation

↓

Execute VHDL Process

↓

Encounter Report Statement

↓

Display Message on Console

↓

Continue Simulation or Stop if Severity is FAILURE

The report statement outputs a message during simulation for debugging, optionally stopping simulation on severe errors.

Execution Sample

VHDL

process
begin
  report "Starting process" severity note;
  wait for 10 ns;
  report "Process completed" severity warning;
  wait;
end process;

This code prints debug messages at different severity levels during simulation.

Execution Table

Step	Action	Report Message	Severity	Simulation Effect
1	Start process execution			Simulation runs
2	Execute report statement	Starting process	note	Message printed, simulation continues
3	Wait for 10 ns			Simulation waits 10 ns
4	Execute report statement	Process completed	warning	Message printed, simulation continues
5	Wait indefinitely			Simulation waits forever
6	End of process			Process suspended, simulation continues

💡 Simulation continues unless severity is FAILURE or ERROR

Variable Tracker

Variable	Start	After Step 2	After Step 4	Final
Simulation Time (ns)	0	0	10	10
Last Report Message	""	"Starting process"	"Process completed"	"Process completed"
Last Severity	""	note	warning	warning

Key Moments - 2 Insights

Why does the simulation not stop after the report statement with severity warning?

Because only severity levels ERROR or FAILURE stop simulation; WARNING and NOTE just print messages and continue, as shown in steps 2 and 4.

What happens if severity is FAILURE in a report statement?

Simulation stops immediately after printing the message, unlike the WARNING or NOTE severities seen in the execution table.

Visual Quiz - 3 Questions

Look at the execution table, what is the simulation time after the first report statement?

A 0 ns

B 10 ns

C After wait

D Indefinite

💡 Hint

Check the 'Simulation Time (ns)' row in variable_tracker after Step 2.

At which step does the simulation wait for 10 ns?

A Step 2

B Step 4

C Step 3

D Step 5

💡 Hint

Look at the 'Action' column in execution_table for waiting periods.

If the severity in the second report was FAILURE, what would happen?

A Simulation continues normally

B Simulation prints message and stops

C Message is not printed

D Simulation pauses but does not stop

💡 Hint

Refer to key_moments about severity effects on simulation.

Concept Snapshot

VHDL report statement syntax:
report "message" severity level;
Severity levels: NOTE, WARNING, ERROR, FAILURE.
NOTE and WARNING print messages and continue simulation.
ERROR and FAILURE print messages and stop simulation.
Used for debug output during simulation.

Full Transcript

The VHDL report statement is used to print messages during simulation for debugging. It has a severity level that controls whether simulation continues or stops. Severity levels NOTE and WARNING print messages but allow simulation to continue, while ERROR and FAILURE stop simulation after printing. In the example, two report statements print messages at NOTE and WARNING levels, so simulation continues. The execution table shows each step, including message printing and waiting. Variables like simulation time and last message update accordingly. Understanding severity effects helps control simulation flow during debugging.

Practice

1. What is the main purpose of the report statement in VHDL?

easy

A. To assign values to variables

B. To print messages during simulation for debugging

C. To declare a new signal in the design

D. To create a new process block

Solution

1. Step 1: Understand the role of report

   The report statement is used to output messages during simulation, which helps in debugging the design.

2. Step 2: Differentiate from other statements

   Other options like declaring signals, assigning variables, or creating processes do not involve printing messages.

3. Final Answer:

   To print messages during simulation for debugging -> Option B

4. Quick Check:

   Report statement = debug messages [OK]

Hint: Report prints debug messages during simulation [OK]

Common Mistakes:

• Confusing report with signal declaration
• Thinking report assigns values
• Mixing report with process creation

2. Which of the following is the correct syntax for a simple report statement in VHDL?

easy

A. report "Simulation started" severity note;

B. report = "Simulation started";

C. print "Simulation started";

D. message("Simulation started");

Solution

1. Step 1: Recall correct report syntax

   The correct syntax uses the keyword report followed by a string in quotes and optionally a severity level, ending with a semicolon.

2. Step 2: Check each option

   report "Simulation started" severity note; matches the correct syntax. Options A, C, and D use incorrect keywords or assignment operators.

3. Final Answer:

   report "Simulation started" severity note; -> Option A

4. Quick Check:

   Correct report syntax = report "Simulation started" severity note; [OK]

Hint: Report uses keyword + string + optional severity + semicolon [OK]

Common Mistakes:

• Using assignment operator '=' with report
• Using print or message instead of report
• Omitting semicolon at the end

3. What will be the output during simulation for the following VHDL code snippet?

process
begin
  report "Value is high" severity warning;
  wait;
end process;

medium

A. An error message: Value is high

B. No output, process waits silently

C. A warning message: Value is high

D. Simulation stops immediately

Solution

1. Step 1: Analyze the report statement

   The report statement prints the message "Value is high" with severity level warning during simulation.

2. Step 2: Understand simulation behavior

   The process then waits indefinitely, but the report message is printed once before waiting.

3. Final Answer:

   A warning message: Value is high -> Option C

4. Quick Check:

   Report with severity warning prints warning message [OK]

Hint: Report prints message once before wait [OK]

Common Mistakes:

• Assuming no output because of wait
• Confusing severity warning with error
• Thinking simulation stops immediately

4. Identify the error in this VHDL report statement:

report "Check signal" severity warning

medium

A. Report keyword is misspelled

B. Severity level 'warning' is invalid

C. Quotes around message are missing

D. Missing semicolon at the end

Solution

1. Step 1: Check syntax completeness

   The report statement must end with a semicolon to be syntactically correct.

2. Step 2: Verify other parts

   The severity level 'warning' is valid, quotes are present, and 'report' is spelled correctly.

3. Final Answer:

   Missing semicolon at the end -> Option D

4. Quick Check:

   Report statement ends with semicolon [OK]

Hint: Always end report statements with semicolon [OK]

Common Mistakes:

• Forgetting semicolon
• Using invalid severity levels
• Omitting quotes around message

5. You want to report an error message only when a signal error_flag is true during simulation. Which VHDL code snippet correctly uses the report statement for this?

hard

A. if error_flag = '1' then report "Error detected" severity error; end if;

B. report "Error detected" severity error when error_flag = '1';

C. report "Error detected" severity error if error_flag = '1';

D. if error_flag then report "Error detected" severity note; end if;

Solution

1. Step 1: Understand conditional reporting

   In VHDL, to report conditionally, use an if statement checking the signal, then call report inside it.

2. Step 2: Evaluate each option

   if error_flag = '1' then report "Error detected" severity error; end if; correctly uses if with condition and report with severity error. Options B and C use invalid syntax. if error_flag then report "Error detected" severity note; end if; uses severity note instead of error.

3. Final Answer:

   if error_flag = '1' then report "Error detected" severity error; end if; -> Option A

4. Quick Check:

   Conditional report uses if + report [OK]

Hint: Use if statement to conditionally report [OK]

Common Mistakes:

• Using report with when or if inline (invalid)
• Wrong severity level for error
• Omitting condition check