////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
//
|
//
|
// Filename: txuartlite.v
|
// Filename: txuartlite.v
|
//
|
//
|
// Project: wbuart32, a full featured UART with simulator
|
// Project: wbuart32, a full featured UART with simulator
|
//
|
//
|
// Purpose: Transmit outputs over a single UART line. This particular UART
|
// Purpose: Transmit outputs over a single UART line. This particular UART
|
// implementation has been extremely simplified: it does not handle
|
// implementation has been extremely simplified: it does not handle
|
// generating break conditions, nor does it handle anything other than the
|
// generating break conditions, nor does it handle anything other than the
|
// 8N1 (8 data bits, no parity, 1 stop bit) UART sub-protocol.
|
// 8N1 (8 data bits, no parity, 1 stop bit) UART sub-protocol.
|
//
|
//
|
// To interface with this module, connect it to your system clock, and
|
// To interface with this module, connect it to your system clock, and
|
// pass it the byte of data you wish to transmit. Strobe the i_wr line
|
// pass it the byte of data you wish to transmit. Strobe the i_wr line
|
// high for one cycle, and your data will be off. Wait until the 'o_busy'
|
// high for one cycle, and your data will be off. Wait until the 'o_busy'
|
// line is low before strobing the i_wr line again--this implementation
|
// line is low before strobing the i_wr line again--this implementation
|
// has NO BUFFER, so strobing i_wr while the core is busy will just
|
// has NO BUFFER, so strobing i_wr while the core is busy will just
|
// get ignored. The output will be placed on the o_txuart output line.
|
// get ignored. The output will be placed on the o_txuart output line.
|
//
|
//
|
// (I often set both data and strobe on the same clock, and then just leave
|
// (I often set both data and strobe on the same clock, and then just leave
|
// them set until the busy line is low. Then I move on to the next piece
|
// them set until the busy line is low. Then I move on to the next piece
|
// of data.)
|
// of data.)
|
//
|
//
|
// Creator: Dan Gisselquist, Ph.D.
|
// Creator: Dan Gisselquist, Ph.D.
|
// Gisselquist Technology, LLC
|
// Gisselquist Technology, LLC
|
//
|
//
|
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
//
|
//
|
// Copyright (C) 2015-2017, Gisselquist Technology, LLC
|
// Copyright (C) 2015-2017, Gisselquist Technology, LLC
|
//
|
//
|
// This program is free software (firmware): you can redistribute it and/or
|
// This program is free software (firmware): you can redistribute it and/or
|
// modify it under the terms of the GNU General Public License as published
|
// modify it under the terms of the GNU General Public License as published
|
// by the Free Software Foundation, either version 3 of the License, or (at
|
// by the Free Software Foundation, either version 3 of the License, or (at
|
// your option) any later version.
|
// your option) any later version.
|
//
|
//
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
// This program is distributed in the hope that it will be useful, but WITHOUT
|
// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
|
// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
// for more details.
|
// for more details.
|
//
|
//
|
// You should have received a copy of the GNU General Public License along
|
// You should have received a copy of the GNU General Public License along
|
// with this program. (It's in the $(ROOT)/doc directory. Run make with no
|
// with this program. (It's in the $(ROOT)/doc directory. Run make with no
|
// target there if the PDF file isn't present.) If not, see
|
// target there if the PDF file isn't present.) If not, see
|
// <http://www.gnu.org/licenses/> for a copy.
|
// <http://www.gnu.org/licenses/> for a copy.
|
//
|
//
|
// License: GPL, v3, as defined and found on www.gnu.org,
|
// License: GPL, v3, as defined and found on www.gnu.org,
|
// http://www.gnu.org/licenses/gpl.html
|
// http://www.gnu.org/licenses/gpl.html
|
//
|
//
|
//
|
//
|
////////////////////////////////////////////////////////////////////////////////
|
////////////////////////////////////////////////////////////////////////////////
|
//
|
//
|
//
|
//
|
`default_nettype none
|
`default_nettype none
|
//
|
//
|
`define TXUL_BIT_ZERO 4'h0
|
`define TXUL_BIT_ZERO 4'h0
|
`define TXUL_BIT_ONE 4'h1
|
`define TXUL_BIT_ONE 4'h1
|
`define TXUL_BIT_TWO 4'h2
|
`define TXUL_BIT_TWO 4'h2
|
`define TXUL_BIT_THREE 4'h3
|
`define TXUL_BIT_THREE 4'h3
|
`define TXUL_BIT_FOUR 4'h4
|
`define TXUL_BIT_FOUR 4'h4
|
`define TXUL_BIT_FIVE 4'h5
|
`define TXUL_BIT_FIVE 4'h5
|
`define TXUL_BIT_SIX 4'h6
|
`define TXUL_BIT_SIX 4'h6
|
`define TXUL_BIT_SEVEN 4'h7
|
`define TXUL_BIT_SEVEN 4'h7
|
`define TXUL_STOP 4'h8
|
`define TXUL_STOP 4'h8
|
`define TXUL_IDLE 4'hf
|
`define TXUL_IDLE 4'hf
|
//
|
//
|
//
|
//
|
module txuartlite(i_clk, i_wr, i_data, o_uart_tx, o_busy);
|
module txuartlite(i_clk, i_wr, i_data, o_uart_tx, o_busy);
|
parameter [23:0] CLOCKS_PER_BAUD = 24'd868;
|
parameter [23:0] CLOCKS_PER_BAUD = 24'd8; // 24'd868;
|
input wire i_clk;
|
input wire i_clk;
|
input wire i_wr;
|
input wire i_wr;
|
input wire [7:0] i_data;
|
input wire [7:0] i_data;
|
// And the UART input line itself
|
// And the UART input line itself
|
output reg o_uart_tx;
|
output reg o_uart_tx;
|
// A line to tell others when we are ready to accept data. If
|
// A line to tell others when we are ready to accept data. If
|
// (i_wr)&&(!o_busy) is ever true, then the core has accepted a byte
|
// (i_wr)&&(!o_busy) is ever true, then the core has accepted a byte
|
// for transmission.
|
// for transmission.
|
output wire o_busy;
|
output wire o_busy;
|
|
|
reg [23:0] baud_counter;
|
reg [23:0] baud_counter;
|
reg [3:0] state;
|
reg [3:0] state;
|
reg [7:0] lcl_data;
|
reg [7:0] lcl_data;
|
reg r_busy, zero_baud_counter;
|
reg r_busy, zero_baud_counter;
|
|
|
initial r_busy = 1'b1;
|
initial r_busy = 1'b1;
|
initial state = `TXUL_IDLE;
|
initial state = `TXUL_IDLE;
|
initial lcl_data= 8'h0;
|
|
always @(posedge i_clk)
|
always @(posedge i_clk)
|
begin
|
begin
|
if (!zero_baud_counter)
|
if (!zero_baud_counter)
|
// r_busy needs to be set coming into here
|
// r_busy needs to be set coming into here
|
r_busy <= 1'b1;
|
r_busy <= 1'b1;
|
else if (state == `TXUL_IDLE) // STATE_IDLE
|
else if (state == `TXUL_IDLE) // STATE_IDLE
|
begin
|
begin
|
r_busy <= 1'b0;
|
r_busy <= 1'b0;
|
if ((i_wr)&&(!r_busy))
|
if ((i_wr)&&(!r_busy))
|
begin // Immediately start us off with a start bit
|
begin // Immediately start us off with a start bit
|
r_busy <= 1'b1;
|
r_busy <= 1'b1;
|
state <= `TXUL_BIT_ZERO;
|
state <= `TXUL_BIT_ZERO;
|
end
|
end
|
end else begin
|
end else begin
|
// One clock tick in each of these states ...
|
// One clock tick in each of these states ...
|
r_busy <= 1'b1;
|
r_busy <= 1'b1;
|
if (state <=`TXUL_STOP) // start bit, 8-d bits, stop-b
|
if (state <=`TXUL_STOP) // start bit, 8-d bits, stop-b
|
state <= state + 1;
|
state <= state + 1;
|
else
|
else
|
state <= `TXUL_IDLE;
|
state <= `TXUL_IDLE;
|
end
|
end
|
end
|
end
|
|
|
// o_busy
|
// o_busy
|
//
|
//
|
// This is a wire, designed to be true is we are ever busy above.
|
// This is a wire, designed to be true is we are ever busy above.
|
// originally, this was going to be true if we were ever not in the
|
// originally, this was going to be true if we were ever not in the
|
// idle state. The logic has since become more complex, hence we have
|
// idle state. The logic has since become more complex, hence we have
|
// a register dedicated to this and just copy out that registers value.
|
// a register dedicated to this and just copy out that registers value.
|
assign o_busy = (r_busy);
|
assign o_busy = (r_busy);
|
|
|
|
|
// lcl_data
|
// lcl_data
|
//
|
//
|
// This is our working copy of the i_data register which we use
|
// This is our working copy of the i_data register which we use
|
// when transmitting. It is only of interest during transmit, and is
|
// when transmitting. It is only of interest during transmit, and is
|
// allowed to be whatever at any other time. Hence, if r_busy isn't
|
// allowed to be whatever at any other time. Hence, if r_busy isn't
|
// true, we can always set it. On the one clock where r_busy isn't
|
// true, we can always set it. On the one clock where r_busy isn't
|
// true and i_wr is, we set it and r_busy is true thereafter.
|
// true and i_wr is, we set it and r_busy is true thereafter.
|
// Then, on any zero_baud_counter (i.e. change between baud intervals)
|
// Then, on any zero_baud_counter (i.e. change between baud intervals)
|
// we simple logically shift the register right to grab the next bit.
|
// we simple logically shift the register right to grab the next bit.
|
initial lcl_data = 8'hff;
|
initial lcl_data = 8'hff;
|
always @(posedge i_clk)
|
always @(posedge i_clk)
|
if ((i_wr)&&(!r_busy))
|
if ((i_wr)&&(!r_busy))
|
lcl_data <= i_data;
|
lcl_data <= i_data;
|
else if (zero_baud_counter)
|
else if (zero_baud_counter)
|
lcl_data <= { 1'b1, lcl_data[7:1] };
|
lcl_data <= { 1'b1, lcl_data[7:1] };
|
|
|
// o_uart_tx
|
// o_uart_tx
|
//
|
//
|
// This is the final result/output desired of this core. It's all
|
// This is the final result/output desired of this core. It's all
|
// centered about o_uart_tx. This is what finally needs to follow
|
// centered about o_uart_tx. This is what finally needs to follow
|
// the UART protocol.
|
// the UART protocol.
|
//
|
//
|
initial o_uart_tx = 1'b1;
|
initial o_uart_tx = 1'b1;
|
always @(posedge i_clk)
|
always @(posedge i_clk)
|
if ((i_wr)&&(!r_busy))
|
if ((i_wr)&&(!r_busy))
|
o_uart_tx <= 1'b0; // Set the start bit on writes
|
o_uart_tx <= 1'b0; // Set the start bit on writes
|
else if (zero_baud_counter) // Set the data bit.
|
else if (zero_baud_counter) // Set the data bit.
|
o_uart_tx <= lcl_data[0];
|
o_uart_tx <= lcl_data[0];
|
|
|
|
|
// All of the above logic is driven by the baud counter. Bits must last
|
// All of the above logic is driven by the baud counter. Bits must last
|
// CLOCKS_PER_BAUD in length, and this baud counter is what we use to
|
// CLOCKS_PER_BAUD in length, and this baud counter is what we use to
|
// make certain of that.
|
// make certain of that.
|
//
|
//
|
// The basic logic is this: at the beginning of a bit interval, start
|
// The basic logic is this: at the beginning of a bit interval, start
|
// the baud counter and set it to count CLOCKS_PER_BAUD. When it gets
|
// the baud counter and set it to count CLOCKS_PER_BAUD. When it gets
|
// to zero, restart it.
|
// to zero, restart it.
|
//
|
//
|
// However, comparing a 28'bit number to zero can be rather complex--
|
// However, comparing a 28'bit number to zero can be rather complex--
|
// especially if we wish to do anything else on that same clock. For
|
// especially if we wish to do anything else on that same clock. For
|
// that reason, we create "zero_baud_counter". zero_baud_counter is
|
// that reason, we create "zero_baud_counter". zero_baud_counter is
|
// nothing more than a flag that is true anytime baud_counter is zero.
|
// nothing more than a flag that is true anytime baud_counter is zero.
|
// It's true when the logic (above) needs to step to the next bit.
|
// It's true when the logic (above) needs to step to the next bit.
|
// Simple enough?
|
// Simple enough?
|
//
|
//
|
// I wish we could stop there, but there are some other (ugly)
|
// I wish we could stop there, but there are some other (ugly)
|
// conditions to deal with that offer exceptions to this basic logic.
|
// conditions to deal with that offer exceptions to this basic logic.
|
//
|
//
|
// 1. When the user has commanded a BREAK across the line, we need to
|
// 1. When the user has commanded a BREAK across the line, we need to
|
// wait several baud intervals following the break before we start
|
// wait several baud intervals following the break before we start
|
// transmitting, to give any receiver a chance to recognize that we are
|
// transmitting, to give any receiver a chance to recognize that we are
|
// out of the break condition, and to know that the next bit will be
|
// out of the break condition, and to know that the next bit will be
|
// a stop bit.
|
// a stop bit.
|
//
|
//
|
// 2. A reset is similar to a break condition--on both we wait several
|
// 2. A reset is similar to a break condition--on both we wait several
|
// baud intervals before allowing a start bit.
|
// baud intervals before allowing a start bit.
|
//
|
//
|
// 3. In the idle state, we stop our counter--so that upon a request
|
// 3. In the idle state, we stop our counter--so that upon a request
|
// to transmit when idle we can start transmitting immediately, rather
|
// to transmit when idle we can start transmitting immediately, rather
|
// than waiting for the end of the next (fictitious and arbitrary) baud
|
// than waiting for the end of the next (fictitious and arbitrary) baud
|
// interval.
|
// interval.
|
//
|
//
|
// When (i_wr)&&(!r_busy)&&(state == `TXUL_IDLE) then we're not only in
|
// When (i_wr)&&(!r_busy)&&(state == `TXUL_IDLE) then we're not only in
|
// the idle state, but we also just accepted a command to start writing
|
// the idle state, but we also just accepted a command to start writing
|
// the next word. At this point, the baud counter needs to be reset
|
// the next word. At this point, the baud counter needs to be reset
|
// to the number of CLOCKS_PER_BAUD, and zero_baud_counter set to zero.
|
// to the number of CLOCKS_PER_BAUD, and zero_baud_counter set to zero.
|
//
|
//
|
// The logic is a bit twisted here, in that it will only check for the
|
// The logic is a bit twisted here, in that it will only check for the
|
// above condition when zero_baud_counter is false--so as to make
|
// above condition when zero_baud_counter is false--so as to make
|
// certain the STOP bit is complete.
|
// certain the STOP bit is complete.
|
initial zero_baud_counter = 1'b0;
|
initial zero_baud_counter = 1'b0;
|
initial baud_counter = 24'h05;
|
initial baud_counter = 24'h05;
|
always @(posedge i_clk)
|
always @(posedge i_clk)
|
begin
|
begin
|
zero_baud_counter <= (baud_counter == 24'h01);
|
zero_baud_counter <= (baud_counter == 24'h01);
|
if (state == `TXUL_IDLE)
|
if (state == `TXUL_IDLE)
|
begin
|
begin
|
baud_counter <= 24'h0;
|
baud_counter <= 24'h0;
|
zero_baud_counter <= 1'b1;
|
zero_baud_counter <= 1'b1;
|
if ((i_wr)&&(!r_busy))
|
if ((i_wr)&&(!r_busy))
|
begin
|
begin
|
baud_counter <= CLOCKS_PER_BAUD - 24'h01;
|
baud_counter <= CLOCKS_PER_BAUD - 24'h01;
|
zero_baud_counter <= 1'b0;
|
zero_baud_counter <= 1'b0;
|
end
|
end
|
end else if (!zero_baud_counter)
|
end else if (!zero_baud_counter)
|
baud_counter <= baud_counter - 24'h01;
|
baud_counter <= baud_counter - 24'h01;
|
else
|
else
|
baud_counter <= CLOCKS_PER_BAUD - 24'h01;
|
baud_counter <= CLOCKS_PER_BAUD - 24'h01;
|
end
|
end
|
|
|
|
//
|
|
//
|
|
// FORMAL METHODS
|
|
//
|
|
//
|
|
//
|
|
`ifdef FORMAL
|
|
|
|
`ifdef TXUARTLITE
|
|
`define ASSUME assume
|
|
`else
|
|
`define ASSUME assert
|
|
`endif
|
|
|
|
// Setup
|
|
|
|
reg f_past_valid, f_last_clk;
|
|
|
|
always @($global_clock)
|
|
begin
|
|
restrict(i_clk == !f_last_clk);
|
|
f_last_clk <= i_clk;
|
|
if (!$rose(i_clk))
|
|
begin
|
|
`ASSUME($stable(i_wr));
|
|
`ASSUME($stable(i_data));
|
|
end
|
|
end
|
|
|
|
initial f_past_valid = 1'b0;
|
|
always @(posedge i_clk)
|
|
f_past_valid <= 1'b1;
|
|
|
|
always @(posedge i_clk)
|
|
if ((f_past_valid)&&($past(i_wr))&&($past(o_busy)))
|
|
begin
|
|
`ASSUME(i_wr == $past(i_wr));
|
|
`ASSUME(i_data == $past(i_data));
|
|
end
|
|
|
|
// Check the baud counter
|
|
always @(posedge i_clk)
|
|
if (zero_baud_counter)
|
|
assert(baud_counter == 0);
|
|
|
|
always @(posedge i_clk)
|
|
if ((f_past_valid)&&($past(baud_counter != 0))&&($past(state != `TXUL_IDLE)))
|
|
assert(baud_counter == $past(baud_counter - 1'b1));
|
|
|
|
always @(posedge i_clk)
|
|
if ((f_past_valid)&&(!$past(zero_baud_counter))&&($past(state != `TXUL_IDLE)))
|
|
assert($stable(o_uart_tx));
|
|
|
|
reg [23:0] f_baud_count;
|
|
initial f_baud_count = 1'b0;
|
|
always @(posedge i_clk)
|
|
if (zero_baud_counter)
|
|
f_baud_count <= 0;
|
|
else
|
|
f_baud_count <= f_baud_count + 1'b1;
|
|
|
|
always @(posedge i_clk)
|
|
assert(f_baud_count < CLOCKS_PER_BAUD);
|
|
|
|
always @(posedge i_clk)
|
|
if (baud_counter != 0)
|
|
assert(o_busy);
|
|
|
|
reg [9:0] f_txbits;
|
|
initial f_txbits = 0;
|
|
always @(posedge i_clk)
|
|
if (zero_baud_counter)
|
|
f_txbits <= { o_uart_tx, f_txbits[9:1] };
|
|
|
|
reg [3:0] f_bitcount;
|
|
initial f_bitcount = 0;
|
|
always @(posedge i_clk)
|
|
//if (baud_counter == CLOCKS_PER_BAUD - 24'h01)
|
|
//f_bitcount <= f_bitcount + 1'b1;
|
|
if ((!f_past_valid)||(!$past(f_past_valid)))
|
|
f_bitcount <= 0;
|
|
else if ((state == `TXUL_IDLE)&&(zero_baud_counter))
|
|
f_bitcount <= 0;
|
|
else if (zero_baud_counter)
|
|
f_bitcount <= f_bitcount + 1'b1;
|
|
|
|
always @(posedge i_clk)
|
|
assert(f_bitcount <= 4'ha);
|
|
|
|
reg [7:0] f_request_tx_data;
|
|
always @(posedge i_clk)
|
|
if ((i_wr)&&(!o_busy))
|
|
f_request_tx_data <= i_data;
|
|
|
|
wire [3:0] subcount;
|
|
assign subcount = 10-f_bitcount;
|
|
always @(posedge i_clk)
|
|
if (f_bitcount > 0)
|
|
assert(!f_txbits[subcount]);
|
|
/*
|
|
|
|
always @(posedge i_clk)
|
|
if ((f_bitcount > 2)&&(f_bitcount <= 10))
|
|
assert(f_txbits[f_bitcount-2:0]
|
|
== f_request_tx_data[7:(9-f_bitcount)]);
|
|
*/
|
|
|
|
always @(posedge i_clk)
|
|
if (f_bitcount == 4'ha)
|
|
begin
|
|
assert(f_txbits[8:1] == f_request_tx_data);
|
|
assert( f_txbits[9]);
|
|
end
|
|
|
|
always @(posedge i_clk)
|
|
assert((state <= `TXUL_STOP + 1'b1)||(state == `TXUL_IDLE));
|
|
//
|
|
//
|
|
|
|
`endif // FORMAL
|
endmodule
|
endmodule
|
|
|
|
|
