verilog-ethernet/rtl/ip_mux.py
2017-05-18 13:47:45 -07:00

505 lines
19 KiB
Python
Executable File

#!/usr/bin/env python
"""
Generates an IP mux with the specified number of ports
"""
from __future__ import print_function
import argparse
import math
from jinja2 import Template
def main():
parser = argparse.ArgumentParser(description=__doc__.strip())
parser.add_argument('-p', '--ports', type=int, default=4, help="number of ports")
parser.add_argument('-n', '--name', type=str, help="module name")
parser.add_argument('-o', '--output', type=str, help="output file name")
args = parser.parse_args()
try:
generate(**args.__dict__)
except IOError as ex:
print(ex)
exit(1)
def generate(ports=4, name=None, output=None):
if name is None:
name = "ip_mux_{0}".format(ports)
if output is None:
output = name + ".v"
print("Opening file '{0}'...".format(output))
output_file = open(output, 'w')
print("Generating {0} port IP mux {1}...".format(ports, name))
select_width = int(math.ceil(math.log(ports, 2)))
t = Template(u"""/*
Copyright (c) 2014-2017 Alex Forencich
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
// Language: Verilog 2001
`timescale 1ns / 1ps
/*
* IP {{n}} port multiplexer
*/
module {{name}}
(
input wire clk,
input wire rst,
/*
* IP frame inputs
*/
{%- for p in ports %}
input wire input_{{p}}_ip_hdr_valid,
output wire input_{{p}}_ip_hdr_ready,
input wire [47:0] input_{{p}}_eth_dest_mac,
input wire [47:0] input_{{p}}_eth_src_mac,
input wire [15:0] input_{{p}}_eth_type,
input wire [3:0] input_{{p}}_ip_version,
input wire [3:0] input_{{p}}_ip_ihl,
input wire [5:0] input_{{p}}_ip_dscp,
input wire [1:0] input_{{p}}_ip_ecn,
input wire [15:0] input_{{p}}_ip_length,
input wire [15:0] input_{{p}}_ip_identification,
input wire [2:0] input_{{p}}_ip_flags,
input wire [12:0] input_{{p}}_ip_fragment_offset,
input wire [7:0] input_{{p}}_ip_ttl,
input wire [7:0] input_{{p}}_ip_protocol,
input wire [15:0] input_{{p}}_ip_header_checksum,
input wire [31:0] input_{{p}}_ip_source_ip,
input wire [31:0] input_{{p}}_ip_dest_ip,
input wire [7:0] input_{{p}}_ip_payload_tdata,
input wire input_{{p}}_ip_payload_tvalid,
output wire input_{{p}}_ip_payload_tready,
input wire input_{{p}}_ip_payload_tlast,
input wire input_{{p}}_ip_payload_tuser,
{% endfor %}
/*
* IP frame output
*/
output wire output_ip_hdr_valid,
input wire output_ip_hdr_ready,
output wire [47:0] output_eth_dest_mac,
output wire [47:0] output_eth_src_mac,
output wire [15:0] output_eth_type,
output wire [3:0] output_ip_version,
output wire [3:0] output_ip_ihl,
output wire [5:0] output_ip_dscp,
output wire [1:0] output_ip_ecn,
output wire [15:0] output_ip_length,
output wire [15:0] output_ip_identification,
output wire [2:0] output_ip_flags,
output wire [12:0] output_ip_fragment_offset,
output wire [7:0] output_ip_ttl,
output wire [7:0] output_ip_protocol,
output wire [15:0] output_ip_header_checksum,
output wire [31:0] output_ip_source_ip,
output wire [31:0] output_ip_dest_ip,
output wire [7:0] output_ip_payload_tdata,
output wire output_ip_payload_tvalid,
input wire output_ip_payload_tready,
output wire output_ip_payload_tlast,
output wire output_ip_payload_tuser,
/*
* Control
*/
input wire enable,
input wire [{{w-1}}:0] select
);
reg [{{w-1}}:0] select_reg = {{w}}'d0, select_next;
reg frame_reg = 1'b0, frame_next;
{% for p in ports %}
reg input_{{p}}_ip_hdr_ready_reg = 1'b0, input_{{p}}_ip_hdr_ready_next;
{%- endfor %}
{% for p in ports %}
reg input_{{p}}_ip_payload_tready_reg = 1'b0, input_{{p}}_ip_payload_tready_next;
{%- endfor %}
reg output_ip_hdr_valid_reg = 1'b0, output_ip_hdr_valid_next;
reg [47:0] output_eth_dest_mac_reg = 48'd0, output_eth_dest_mac_next;
reg [47:0] output_eth_src_mac_reg = 48'd0, output_eth_src_mac_next;
reg [15:0] output_eth_type_reg = 16'd0, output_eth_type_next;
reg [3:0] output_ip_version_reg = 4'd0, output_ip_version_next;
reg [3:0] output_ip_ihl_reg = 4'd0, output_ip_ihl_next;
reg [5:0] output_ip_dscp_reg = 6'd0, output_ip_dscp_next;
reg [1:0] output_ip_ecn_reg = 2'd0, output_ip_ecn_next;
reg [15:0] output_ip_length_reg = 16'd0, output_ip_length_next;
reg [15:0] output_ip_identification_reg = 16'd0, output_ip_identification_next;
reg [2:0] output_ip_flags_reg = 3'd0, output_ip_flags_next;
reg [12:0] output_ip_fragment_offset_reg = 13'd0, output_ip_fragment_offset_next;
reg [7:0] output_ip_ttl_reg = 8'd0, output_ip_ttl_next;
reg [7:0] output_ip_protocol_reg = 8'd0, output_ip_protocol_next;
reg [15:0] output_ip_header_checksum_reg = 16'd0, output_ip_header_checksum_next;
reg [31:0] output_ip_source_ip_reg = 32'd0, output_ip_source_ip_next;
reg [31:0] output_ip_dest_ip_reg = 32'd0, output_ip_dest_ip_next;
// internal datapath
reg [7:0] output_ip_payload_tdata_int;
reg output_ip_payload_tvalid_int;
reg output_ip_payload_tready_int_reg = 1'b0;
reg output_ip_payload_tlast_int;
reg output_ip_payload_tuser_int;
wire output_ip_payload_tready_int_early;
{% for p in ports %}
assign input_{{p}}_ip_hdr_ready = input_{{p}}_ip_hdr_ready_reg;
{%- endfor %}
{% for p in ports %}
assign input_{{p}}_ip_payload_tready = input_{{p}}_ip_payload_tready_reg;
{%- endfor %}
assign output_ip_hdr_valid = output_ip_hdr_valid_reg;
assign output_eth_dest_mac = output_eth_dest_mac_reg;
assign output_eth_src_mac = output_eth_src_mac_reg;
assign output_eth_type = output_eth_type_reg;
assign output_ip_version = output_ip_version_reg;
assign output_ip_ihl = output_ip_ihl_reg;
assign output_ip_dscp = output_ip_dscp_reg;
assign output_ip_ecn = output_ip_ecn_reg;
assign output_ip_length = output_ip_length_reg;
assign output_ip_identification = output_ip_identification_reg;
assign output_ip_flags = output_ip_flags_reg;
assign output_ip_fragment_offset = output_ip_fragment_offset_reg;
assign output_ip_ttl = output_ip_ttl_reg;
assign output_ip_protocol = output_ip_protocol_reg;
assign output_ip_header_checksum = output_ip_header_checksum_reg;
assign output_ip_source_ip = output_ip_source_ip_reg;
assign output_ip_dest_ip = output_ip_dest_ip_reg;
// mux for start of packet detection
reg selected_input_ip_hdr_valid;
reg [47:0] selected_input_eth_dest_mac;
reg [47:0] selected_input_eth_src_mac;
reg [15:0] selected_input_eth_type;
reg [3:0] selected_input_ip_version;
reg [3:0] selected_input_ip_ihl;
reg [5:0] selected_input_ip_dscp;
reg [1:0] selected_input_ip_ecn;
reg [15:0] selected_input_ip_length;
reg [15:0] selected_input_ip_identification;
reg [2:0] selected_input_ip_flags;
reg [12:0] selected_input_ip_fragment_offset;
reg [7:0] selected_input_ip_ttl;
reg [7:0] selected_input_ip_protocol;
reg [15:0] selected_input_ip_header_checksum;
reg [31:0] selected_input_ip_source_ip;
reg [31:0] selected_input_ip_dest_ip;
always @* begin
case (select)
{%- for p in ports %}
{{w}}'d{{p}}: begin
selected_input_ip_hdr_valid = input_{{p}}_ip_hdr_valid;
selected_input_eth_dest_mac = input_{{p}}_eth_dest_mac;
selected_input_eth_src_mac = input_{{p}}_eth_src_mac;
selected_input_eth_type = input_{{p}}_eth_type;
selected_input_ip_version = input_{{p}}_ip_version;
selected_input_ip_ihl = input_{{p}}_ip_ihl;
selected_input_ip_dscp = input_{{p}}_ip_dscp;
selected_input_ip_ecn = input_{{p}}_ip_ecn;
selected_input_ip_length = input_{{p}}_ip_length;
selected_input_ip_identification = input_{{p}}_ip_identification;
selected_input_ip_flags = input_{{p}}_ip_flags;
selected_input_ip_fragment_offset = input_{{p}}_ip_fragment_offset;
selected_input_ip_ttl = input_{{p}}_ip_ttl;
selected_input_ip_protocol = input_{{p}}_ip_protocol;
selected_input_ip_header_checksum = input_{{p}}_ip_header_checksum;
selected_input_ip_source_ip = input_{{p}}_ip_source_ip;
selected_input_ip_dest_ip = input_{{p}}_ip_dest_ip;
end
{%- endfor %}
default: begin
selected_input_ip_hdr_valid = 1'b0;
selected_input_eth_dest_mac = 48'd0;
selected_input_eth_src_mac = 48'd0;
selected_input_eth_type = 16'd0;
selected_input_ip_version = 4'd0;
selected_input_ip_ihl = 4'd0;
selected_input_ip_dscp = 6'd0;
selected_input_ip_ecn = 2'd0;
selected_input_ip_length = 16'd0;
selected_input_ip_identification = 16'd0;
selected_input_ip_flags = 3'd0;
selected_input_ip_fragment_offset = 13'd0;
selected_input_ip_ttl = 8'd0;
selected_input_ip_protocol = 8'd0;
selected_input_ip_header_checksum = 16'd0;
selected_input_ip_source_ip = 32'd0;
selected_input_ip_dest_ip = 32'd0;
end
endcase
end
// mux for incoming packet
reg [7:0] current_input_tdata;
reg current_input_tvalid;
reg current_input_tready;
reg current_input_tlast;
reg current_input_tuser;
always @* begin
case (select_reg)
{%- for p in ports %}
{{w}}'d{{p}}: begin
current_input_tdata = input_{{p}}_ip_payload_tdata;
current_input_tvalid = input_{{p}}_ip_payload_tvalid;
current_input_tready = input_{{p}}_ip_payload_tready;
current_input_tlast = input_{{p}}_ip_payload_tlast;
current_input_tuser = input_{{p}}_ip_payload_tuser;
end
{%- endfor %}
default: begin
current_input_tdata = 8'd0;
current_input_tvalid = 1'b0;
current_input_tready = 1'b0;
current_input_tlast = 1'b0;
current_input_tuser = 1'b0;
end
endcase
end
always @* begin
select_next = select_reg;
frame_next = frame_reg;
{% for p in ports %}
input_{{p}}_ip_hdr_ready_next = input_{{p}}_ip_hdr_ready_reg & ~input_{{p}}_ip_hdr_valid;
{%- endfor %}
{% for p in ports %}
input_{{p}}_ip_payload_tready_next = 1'b0;
{%- endfor %}
output_ip_hdr_valid_next = output_ip_hdr_valid_reg & ~output_ip_hdr_ready;
output_eth_dest_mac_next = output_eth_dest_mac_reg;
output_eth_src_mac_next = output_eth_src_mac_reg;
output_eth_type_next = output_eth_type_reg;
output_ip_version_next = output_ip_version_reg;
output_ip_ihl_next = output_ip_ihl_reg;
output_ip_dscp_next = output_ip_dscp_reg;
output_ip_ecn_next = output_ip_ecn_reg;
output_ip_length_next = output_ip_length_reg;
output_ip_identification_next = output_ip_identification_reg;
output_ip_flags_next = output_ip_flags_reg;
output_ip_fragment_offset_next = output_ip_fragment_offset_reg;
output_ip_ttl_next = output_ip_ttl_reg;
output_ip_protocol_next = output_ip_protocol_reg;
output_ip_header_checksum_next = output_ip_header_checksum_reg;
output_ip_source_ip_next = output_ip_source_ip_reg;
output_ip_dest_ip_next = output_ip_dest_ip_reg;
if (current_input_tvalid & current_input_tready) begin
// end of frame detection
if (current_input_tlast) begin
frame_next = 1'b0;
end
end
if (~frame_reg & enable & ~output_ip_hdr_valid & selected_input_ip_hdr_valid) begin
// start of frame, grab select value
frame_next = 1'b1;
select_next = select;
case (select_next)
{%- for p in ports %}
{{w}}'d{{p}}: input_{{p}}_ip_hdr_ready_next = 1'b1;
{%- endfor %}
endcase
output_ip_hdr_valid_next = 1;
output_eth_dest_mac_next = selected_input_eth_dest_mac;
output_eth_src_mac_next = selected_input_eth_src_mac;
output_eth_type_next = selected_input_eth_type;
output_ip_version_next = selected_input_ip_version;
output_ip_ihl_next = selected_input_ip_ihl;
output_ip_dscp_next = selected_input_ip_dscp;
output_ip_ecn_next = selected_input_ip_ecn;
output_ip_length_next = selected_input_ip_length;
output_ip_identification_next = selected_input_ip_identification;
output_ip_flags_next = selected_input_ip_flags;
output_ip_fragment_offset_next = selected_input_ip_fragment_offset;
output_ip_ttl_next = selected_input_ip_ttl;
output_ip_protocol_next = selected_input_ip_protocol;
output_ip_header_checksum_next = selected_input_ip_header_checksum;
output_ip_source_ip_next = selected_input_ip_source_ip;
output_ip_dest_ip_next = selected_input_ip_dest_ip;
end
// generate ready signal on selected port
case (select_next)
{%- for p in ports %}
{{w}}'d{{p}}: input_{{p}}_ip_payload_tready_next = output_ip_payload_tready_int_early & frame_next;
{%- endfor %}
endcase
// pass through selected packet data
output_ip_payload_tdata_int = current_input_tdata;
output_ip_payload_tvalid_int = current_input_tvalid & current_input_tready & frame_reg;
output_ip_payload_tlast_int = current_input_tlast;
output_ip_payload_tuser_int = current_input_tuser;
end
always @(posedge clk) begin
if (rst) begin
select_reg <= {{w}}'d0;
frame_reg <= 1'b0;
{%- for p in ports %}
input_{{p}}_ip_hdr_ready_reg <= 1'b0;
{%- endfor %}
{%- for p in ports %}
input_{{p}}_ip_payload_tready_reg <= 1'b0;
{%- endfor %}
output_ip_hdr_valid_reg <= 1'b0;
end else begin
select_reg <= select_next;
frame_reg <= frame_next;
{%- for p in ports %}
input_{{p}}_ip_hdr_ready_reg <= input_{{p}}_ip_hdr_ready_next;
{%- endfor %}
{%- for p in ports %}
input_{{p}}_ip_payload_tready_reg <= input_{{p}}_ip_payload_tready_next;
{%- endfor %}
output_ip_hdr_valid_reg <= output_ip_hdr_valid_next;
end
output_eth_dest_mac_reg <= output_eth_dest_mac_next;
output_eth_src_mac_reg <= output_eth_src_mac_next;
output_eth_type_reg <= output_eth_type_next;
output_ip_version_reg <= output_ip_version_next;
output_ip_ihl_reg <= output_ip_ihl_next;
output_ip_dscp_reg <= output_ip_dscp_next;
output_ip_ecn_reg <= output_ip_ecn_next;
output_ip_length_reg <= output_ip_length_next;
output_ip_identification_reg <= output_ip_identification_next;
output_ip_flags_reg <= output_ip_flags_next;
output_ip_fragment_offset_reg <= output_ip_fragment_offset_next;
output_ip_ttl_reg <= output_ip_ttl_next;
output_ip_protocol_reg <= output_ip_protocol_next;
output_ip_header_checksum_reg <= output_ip_header_checksum_next;
output_ip_source_ip_reg <= output_ip_source_ip_next;
output_ip_dest_ip_reg <= output_ip_dest_ip_next;
end
// output datapath logic
reg [7:0] output_ip_payload_tdata_reg = 8'd0;
reg output_ip_payload_tvalid_reg = 1'b0, output_ip_payload_tvalid_next;
reg output_ip_payload_tlast_reg = 1'b0;
reg output_ip_payload_tuser_reg = 1'b0;
reg [7:0] temp_ip_payload_tdata_reg = 8'd0;
reg temp_ip_payload_tvalid_reg = 1'b0, temp_ip_payload_tvalid_next;
reg temp_ip_payload_tlast_reg = 1'b0;
reg temp_ip_payload_tuser_reg = 1'b0;
// datapath control
reg store_ip_payload_int_to_output;
reg store_ip_payload_int_to_temp;
reg store_ip_payload_temp_to_output;
assign output_ip_payload_tdata = output_ip_payload_tdata_reg;
assign output_ip_payload_tvalid = output_ip_payload_tvalid_reg;
assign output_ip_payload_tlast = output_ip_payload_tlast_reg;
assign output_ip_payload_tuser = output_ip_payload_tuser_reg;
// enable ready input next cycle if output is ready or the temp reg will not be filled on the next cycle (output reg empty or no input)
assign output_ip_payload_tready_int_early = output_ip_payload_tready | (~temp_ip_payload_tvalid_reg & (~output_ip_payload_tvalid_reg | ~output_ip_payload_tvalid_int));
always @* begin
// transfer sink ready state to source
output_ip_payload_tvalid_next = output_ip_payload_tvalid_reg;
temp_ip_payload_tvalid_next = temp_ip_payload_tvalid_reg;
store_ip_payload_int_to_output = 1'b0;
store_ip_payload_int_to_temp = 1'b0;
store_ip_payload_temp_to_output = 1'b0;
if (output_ip_payload_tready_int_reg) begin
// input is ready
if (output_ip_payload_tready | ~output_ip_payload_tvalid_reg) begin
// output is ready or currently not valid, transfer data to output
output_ip_payload_tvalid_next = output_ip_payload_tvalid_int;
store_ip_payload_int_to_output = 1'b1;
end else begin
// output is not ready, store input in temp
temp_ip_payload_tvalid_next = output_ip_payload_tvalid_int;
store_ip_payload_int_to_temp = 1'b1;
end
end else if (output_ip_payload_tready) begin
// input is not ready, but output is ready
output_ip_payload_tvalid_next = temp_ip_payload_tvalid_reg;
temp_ip_payload_tvalid_next = 1'b0;
store_ip_payload_temp_to_output = 1'b1;
end
end
always @(posedge clk) begin
if (rst) begin
output_ip_payload_tvalid_reg <= 1'b0;
output_ip_payload_tready_int_reg <= 1'b0;
temp_ip_payload_tvalid_reg <= 1'b0;
end else begin
output_ip_payload_tvalid_reg <= output_ip_payload_tvalid_next;
output_ip_payload_tready_int_reg <= output_ip_payload_tready_int_early;
temp_ip_payload_tvalid_reg <= temp_ip_payload_tvalid_next;
end
// datapath
if (store_ip_payload_int_to_output) begin
output_ip_payload_tdata_reg <= output_ip_payload_tdata_int;
output_ip_payload_tlast_reg <= output_ip_payload_tlast_int;
output_ip_payload_tuser_reg <= output_ip_payload_tuser_int;
end else if (store_ip_payload_temp_to_output) begin
output_ip_payload_tdata_reg <= temp_ip_payload_tdata_reg;
output_ip_payload_tlast_reg <= temp_ip_payload_tlast_reg;
output_ip_payload_tuser_reg <= temp_ip_payload_tuser_reg;
end
if (store_ip_payload_int_to_temp) begin
temp_ip_payload_tdata_reg <= output_ip_payload_tdata_int;
temp_ip_payload_tlast_reg <= output_ip_payload_tlast_int;
temp_ip_payload_tuser_reg <= output_ip_payload_tuser_int;
end
end
endmodule
""")
output_file.write(t.render(
n=ports,
w=select_width,
name=name,
ports=range(ports)
))
print("Done")
if __name__ == "__main__":
main()