Port declaration (input, output, inout) in Verilog - Mini Project: Build & Apply

Port declaration (input, output, inout) in Verilog

📖 Scenario: You are designing a simple digital module that interacts with other parts of a circuit. To do this, you need to declare ports that define how signals enter and leave your module.

🎯 Goal: Create a Verilog module named simple_module with three ports: an input called clk, an output called led, and an inout called data_bus. This will help you understand how to declare different types of ports in Verilog.

📋 What You'll Learn

Declare a module named simple_module

Declare an input port named clk

Declare an output port named led

Declare an inout port named data_bus

💡 Why This Matters

🌍 Real World

Declaring ports correctly is essential when designing hardware modules that connect and communicate with each other in digital circuits.

💼 Career

Hardware engineers and FPGA developers must know how to declare ports to build and test digital designs effectively.

1

Create the module skeleton

Write a Verilog module named simple_module with empty parentheses and an empty body.

Verilog

module simple_module();

// Your code here

endmodule

Hint

Start by writing module simple_module(); and end with endmodule.

2

Add port declarations

Inside the module parentheses, declare three ports exactly as follows: input clk, output led, and inout data_bus.

Verilog

module simple_module(input clk, output led, inout data_bus);

// Your code here

endmodule

Hint

List the ports inside the parentheses separated by commas, specifying their directions.

3

Declare port types inside the module

Inside the module body, declare the ports again with their directions: input clk;, output led;, and inout data_bus;.

Verilog

module simple_module(input clk, output led, inout data_bus);
    
    // Your code here

endmodule

Hint

Inside the module, write each port declaration ending with a semicolon.

4

Print the module ports as comments

Add comments inside the module that list the ports and their directions exactly as: // Port: clk (input), // Port: led (output), and // Port: data_bus (inout).

Verilog

module simple_module(input clk, output led, inout data_bus);
    input clk;
    output led;
    inout data_bus;
    
    // Your code here
endmodule

Hint

Use comments to clearly label each port and its direction.

Practice

1. Which keyword in Verilog is used to declare a port that receives signals from outside the module?

easy

A. input

B. output

C. inout

D. wire

Solution

1. Step 1: Understand port directions

   In Verilog, ports can be inputs, outputs, or bidirectional (inout).

2. Step 2: Identify the keyword for receiving signals

   The keyword input is used to declare ports that receive signals from outside the module.

3. Final Answer:

   input -> Option A

4. Quick Check:

   input = receives signals [OK]

Hint: Input ports receive signals from outside [OK]

Common Mistakes:

• Confusing output with input
• Using wire instead of input for ports
• Thinking inout means input only

2. Which of the following is the correct way to declare a 4-bit output port named data_out in Verilog?

easy

A. inout [4:0] data_out;

B. input [3:0] data_out;

C. output [3:0] data_out;

D. output data_out[3:0];

Solution

1. Step 1: Check port direction and width syntax

   Output ports use the keyword output. The width is declared as [3:0] for 4 bits.

2. Step 2: Validate the syntax correctness

   output [3:0] data_out; correctly declares a 4-bit output port as output [3:0] data_out;. output data_out[3:0]; has incorrect syntax placing the width after the name.

3. Final Answer:

   output [3:0] data_out; -> Option C

4. Quick Check:

   output [3:0] name; is correct syntax [OK]

Hint: Declare width before port name with brackets [OK]

Common Mistakes:

• Placing width after port name
• Using input instead of output
• Incorrect bit range like [4:0]

3. Consider this Verilog module header:

module example(input clk, output reg ready, inout wire data);
// module body
endmodule

Which statement about the ports is true?

medium

A. clk is an input port, ready is an output port, data is a bidirectional port

B. clk is an output port, ready is an input port, data is an output port

C. clk is a bidirectional port, ready is an input port, data is an output port

D. All ports are inputs by default

Solution

1. Step 1: Identify each port direction from declaration

   input clk means clk is input, output reg ready means ready is output, and inout wire data means data is bidirectional.

2. Step 2: Match each port with its direction

   clk is an input port, ready is an output port, data is a bidirectional port correctly matches clk as input, ready as output, and data as inout (bidirectional).

3. Final Answer:

   clk is input, ready is output, data is bidirectional -> Option A

4. Quick Check:

   input, output, inout match ports [OK]

Hint: Match keywords input/output/inout to port roles [OK]

Common Mistakes:

• Mixing input and output roles
• Assuming all ports default to input
• Ignoring reg or wire keywords

4. Identify the error in this Verilog port declaration:

module test_module(clk, data_out, inout_signal);
  input wire clk;
  output data_out;
  inout inout_signal
endmodule

medium

A. inout keyword is invalid in port list

B. input wire cannot be used for clk

C. output port must be declared as reg

D. Missing semicolon after inout_signal declaration

Solution

1. Step 1: Check syntax of port declarations

   In this non-ANSI style Verilog module, port names are listed in the header, and directions/types are declared inside the module body. Each declaration must end with a semicolon.

2. Step 2: Identify the specific error

   The declaration inout inout_signal lacks the required semicolon.

3. Final Answer:

   Missing semicolon after inout_signal declaration -> Option D

4. Quick Check:

   Declarations inside module end with semicolon [OK]

Hint: Port declarations inside module end with semicolon [OK]

Common Mistakes:

• Missing semicolons after port declarations
• Thinking output must be reg always
• Believing inout is invalid keyword

5. You want to design a Verilog module with a bidirectional data bus named bus that is 8 bits wide. Which is the correct port declaration and internal signal type to allow reading and writing on bus?

hard

A. input [7:0] bus; reg [7:0] bus_internal;

B. inout [7:0] bus; reg [7:0] bus_internal; assign bus = write_enable ? data_out : 8'bz;

C. output [7:0] bus; wire [7:0] bus_internal;

D. inout [7:0] bus; wire bus_internal; assign bus = write_enable ? data_out : 8'bz;

Solution

1. Step 1: Understand bidirectional port requirements

   Bidirectional ports use inout and require internal signals to store data for output, typically declared as reg for driven values.

2. Step 2: Analyze each option for correctness

   inout [7:0] bus; reg [7:0] bus_internal; assign bus = write_enable ? data_out : 8'bz; correctly declares inout [7:0] bus and uses reg [7:0] bus_internal for internal storage, with an assignment controlling bus output with high impedance when not writing.

3. Final Answer:

   inout [7:0] bus; reg [7:0] bus_internal; assign bus = write_enable ? data_out : 8'bz; -> Option B

4. Quick Check:

   inout with reg internal and tri-state assign [OK]

Hint: Use inout with reg and tri-state assign for bidirectional bus [OK]

Common Mistakes:

• Using wire instead of reg for internal signal
• Declaring bus as input or output only
• Not using tri-state (8'bz) for bus when not driving