OpenCores
URL https://opencores.org/ocsvn/xulalx25soc/xulalx25soc/trunk

Subversion Repositories xulalx25soc

[/] [xulalx25soc/] [trunk/] [rtl/] [rxuart.v] - Blame information for rev 77

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 7 dgisselq
////////////////////////////////////////////////////////////////////////////////
2 2 dgisselq
//
3
// Filename:    rxuart.v
4
//
5 7 dgisselq
// Project:     XuLA2 board
6 2 dgisselq
//
7
// Purpose:     Receive and decode inputs from a single UART line.
8
//
9
//      To interface with this module, connect it to your system clock,
10
//      pass it the 32 bit setup register (defined below) and the UART
11
//      input.  When data becomes available, the o_wr line will be asserted
12
//      for one clock cycle.  On parity or frame errors, the o_parity_err
13
//      or o_frame_err lines will be asserted.  Likewise, on a break 
14
//      condition, o_break will be asserted.  These lines are self clearing.
15
//
16
//      There is a synchronous reset line, logic high.
17
//
18
//      Now for the setup register.  The register is 32 bits, so that this
19
//      UART may be set up over a 32-bit bus.
20
//
21
//      i_setup[29:28]  Indicates the number of data bits per word.  This will
22
//      either be 2'b00 for an 8-bit word, 2'b01 for a 7-bit word, 2'b10
23
//      for a six bit word, or 2'b11 for a five bit word.
24
//
25
//      i_setup[27]     Indicates whether or not to use one or two stop bits.
26
//              Set this to one to expect two stop bits, zero for one.
27
//
28
//      i_setup[26]     Indicates whether or not a parity bit exists.  Set this
29
//              to 1'b1 to include parity.
30
//
31
//      i_setup[25]     Indicates whether or not the parity bit is fixed.  Set
32
//              to 1'b1 to include a fixed bit of parity, 1'b0 to allow the
33
//              parity to be set based upon data.  (Both assume the parity
34
//              enable value is set.)
35
//
36
//      i_setup[24]     This bit is ignored if parity is not used.  Otherwise,
37
//              in the case of a fixed parity bit, this bit indicates whether
38
//              mark (1'b1) or space (1'b0) parity is used.  Likewise if the
39
//              parity is not fixed, a 1'b1 selects even parity, and 1'b0
40
//              selects odd.
41
//
42
//      i_setup[23:0]   Indicates the speed of the UART in terms of clocks.
43
//              So, for example, if you have a 200 MHz clock and wish to
44
//              run your UART at 9600 baud, you would take 200 MHz and divide
45
//              by 9600 to set this value to 24'd20834.  Likewise if you wished
46
//              to run this serial port at 115200 baud from a 200 MHz clock,
47
//              you would set the value to 24'd1736
48
//
49
//      Thus, to set the UART for the common setting of an 8-bit word, 
50
//      one stop bit, no parity, and 115200 baud over a 200 MHz clock, you
51
//      would want to set the setup value to:
52
//
53
//      32'h0006c8              // For 115,200 baud, 8 bit, no parity
54
//      32'h005161              // For 9600 baud, 8 bit, no parity
55
//      
56 7 dgisselq
//
57
//
58
// Creator:     Dan Gisselquist, Ph.D.
59 2 dgisselq
//              Gisselquist Technology, LLC
60
//
61 7 dgisselq
////////////////////////////////////////////////////////////////////////////////
62 2 dgisselq
//
63 7 dgisselq
// Copyright (C) 2015, Gisselquist Technology, LLC
64 2 dgisselq
//
65 7 dgisselq
// This program is free software (firmware): you can redistribute it and/or
66
// modify it under the terms of  the GNU General Public License as published
67
// by the Free Software Foundation, either version 3 of the License, or (at
68
// your option) any later version.
69 2 dgisselq
//
70 7 dgisselq
// This program is distributed in the hope that it will be useful, but WITHOUT
71
// ANY WARRANTY; without even the implied warranty of MERCHANTIBILITY or
72
// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
73
// for more details.
74 2 dgisselq
//
75 7 dgisselq
// License:     GPL, v3, as defined and found on www.gnu.org,
76
//              http://www.gnu.org/licenses/gpl.html
77 2 dgisselq
//
78 7 dgisselq
//
79
////////////////////////////////////////////////////////////////////////////////
80
//
81
//
82 2 dgisselq
 
83
// States: (@ baud counter == 0)
84
//      0        First bit arrives
85
//      ..7     Bits arrive
86
//      8       Stop bit (x1)
87
//      9       Stop bit (x2)
88
///     c       break condition
89
//      d       Waiting for the channel to go high
90
//      e       Waiting for the reset to complete
91
//      f       Idle state
92
`define RXU_BIT_ZERO            4'h0
93
`define RXU_BIT_ONE             4'h1
94
`define RXU_BIT_TWO             4'h2
95
`define RXU_BIT_THREE           4'h3
96
`define RXU_BIT_FOUR            4'h4
97
`define RXU_BIT_FIVE            4'h5
98
`define RXU_BIT_SIX             4'h6
99
`define RXU_BIT_SEVEN           4'h7
100
`define RXU_PARITY              4'h8
101
`define RXU_STOP                4'h9
102
`define RXU_SECOND_STOP         4'ha
103
// Unused 4'hb
104
// Unused 4'hc
105
`define RXU_BREAK               4'hd
106
`define RXU_RESET_IDLE          4'he
107
`define RXU_IDLE                4'hf
108
 
109
module rxuart(i_clk, i_reset, i_setup, i_uart, o_wr, o_data, o_break,
110 9 dgisselq
                        o_parity_err, o_frame_err);
111 2 dgisselq
        //  parameter // CLOCKS_PER_BAUD = 25'd004340,
112
                        //  BREAK_CONDITION = CLOCKS_PER_BAUD * 12,
113
                        //  CLOCKS_PER_HALF_BAUD = CLOCKS_PER_BAUD/2;
114
        // 8 data bits, no parity, (at least 1) stop bit
115
        input                   i_clk, i_reset;
116
        input           [29:0]   i_setup;
117
        input                   i_uart;
118
        output  reg             o_wr;
119
        output  reg     [7:0]    o_data;
120
        output  reg             o_break;
121
        output  reg             o_parity_err, o_frame_err;
122
 
123
 
124
        wire    [27:0]   clocks_per_baud, break_condition, half_baud;
125
        wire    [1:0]    data_bits;
126
        wire            use_parity, parity_even, dblstop, fixd_parity;
127
        reg     [29:0]   r_setup;
128
        assign  clocks_per_baud = { 4'h0, r_setup[23:0] };
129
        assign  data_bits   = r_setup[29:28];
130
        assign  dblstop     = r_setup[27];
131
        assign  use_parity  = r_setup[26];
132
        assign  fixd_parity = r_setup[25];
133
        assign  parity_even = r_setup[24];
134
        assign  break_condition = { r_setup[23:0], 4'h0 };
135
        assign  half_baud = { 5'h00, r_setup[23:1] };
136
 
137
        reg     q_uart, qq_uart, ck_uart;
138
        initial q_uart  = 1'b0;
139
        initial qq_uart = 1'b0;
140
        initial ck_uart = 1'b0;
141
        always @(posedge i_clk)
142
        begin
143
                q_uart <= i_uart;
144
                qq_uart <= q_uart;
145
                ck_uart <= qq_uart;
146
        end
147 9 dgisselq
        // assign       o_ck_uart = ck_uart;
148 2 dgisselq
 
149
        reg     [27:0]   chg_counter;
150
        initial chg_counter = 28'h00;
151
        always @(posedge i_clk)
152
                if (i_reset)
153
                        chg_counter <= 28'h00;
154
                else if (qq_uart != ck_uart)
155
                        chg_counter <= 28'h00;
156
                else if (chg_counter < break_condition)
157
                        chg_counter <= chg_counter + 1;
158
 
159
        always @(posedge i_clk)
160
                o_break <=((chg_counter >= break_condition)&&(~ck_uart))? 1'b1:1'b0;
161
 
162
        reg     [3:0]    state;
163
        reg     [27:0]   baud_counter;
164
        reg     [7:0]    data_reg;
165
        reg             calc_parity;
166
        initial o_wr = 1'b0;
167
        initial state = `RXU_RESET_IDLE;
168
        initial o_parity_err = 1'b0;
169
        initial o_frame_err  = 1'b0;
170
        // initial      baud_counter = clocks_per_baud;
171
        always @(posedge i_clk)
172
        begin
173
                if (i_reset)
174
                begin
175
                        o_wr <= 1'b0;
176
                        o_data <= 8'h00;
177
                        state <= `RXU_RESET_IDLE;
178
                        baud_counter <= clocks_per_baud; // Set, not reset
179
                        data_reg <= 8'h00;
180
                        calc_parity <= 1'b0;
181
                        o_parity_err <= 1'b0;
182
                        o_frame_err <= 1'b0;
183
                end else if (state == `RXU_RESET_IDLE)
184
                begin
185
                        r_setup <= i_setup;
186
                        data_reg <= 8'h00; o_data <= 8'h00; o_wr <= 1'b0;
187
                        baud_counter <= clocks_per_baud-28'h01;// Set, not reset
188
                        if ((ck_uart)&&(chg_counter >= break_condition))
189
                                // Goto idle state from a reset
190
                                state <= `RXU_IDLE;
191
                        else // Otherwise, stay in this condition 'til reset
192
                                state <= `RXU_RESET_IDLE;
193
                        calc_parity <= 1'b0;
194
                        o_parity_err <= 1'b0;
195
                        o_frame_err <= 1'b0;
196
                end else if ((~ck_uart)&&(chg_counter >= break_condition))
197
                begin // We are in a break condition
198
                        state <= `RXU_BREAK;
199
                        o_wr <= 1'b0;
200
                        o_data <= 8'h00;
201
                        baud_counter <= clocks_per_baud-28'h01;// Set, not reset
202
                        data_reg <= 8'h00;
203
                        calc_parity <= 1'b0;
204
                        o_parity_err <= 1'b0;
205
                        o_frame_err <= 1'b0;
206
                        r_setup <= i_setup;
207
                end else if (state == `RXU_BREAK)
208
                begin // Goto idle state following return ck_uart going high
209
                        data_reg <= 8'h00; o_data <= 8'h00; o_wr <= 1'b0;
210
                        baud_counter <= clocks_per_baud - 28'h01;
211
                        if (ck_uart)
212
                                state <= `RXU_IDLE;
213
                        else
214
                                state <= `RXU_BREAK;
215
                        calc_parity <= 1'b0;
216
                        o_parity_err <= 1'b0;
217
                        o_frame_err <= 1'b0;
218
                        r_setup <= i_setup;
219
                end else if (state == `RXU_IDLE)
220
                begin // Idle state, independent of baud counter
221 58 dgisselq
                        r_setup <= i_setup;
222 2 dgisselq
                        data_reg <= 8'h00; o_data <= 8'h00; o_wr <= 1'b0;
223
                        baud_counter <= clocks_per_baud - 28'h01;
224
                        if ((ck_uart == 1'b0)&&(chg_counter > half_baud))
225
                        begin
226
                                // We are in the center of a valid start bit
227
                                case (data_bits)
228
                                2'b00: state <= `RXU_BIT_ZERO;
229
                                2'b01: state <= `RXU_BIT_ONE;
230
                                2'b10: state <= `RXU_BIT_TWO;
231
                                2'b11: state <= `RXU_BIT_THREE;
232
                                endcase
233
                        end else // Otherwise, just stay here in idle
234
                                state <= `RXU_IDLE;
235
                        calc_parity <= 1'b0;
236
                        o_parity_err <= 1'b0;
237
                        o_frame_err <= 1'b0;
238
                end else if (baud_counter == 0)
239
                begin
240
                        baud_counter <= clocks_per_baud-28'h1;
241
                        if (state < `RXU_BIT_SEVEN)
242
                        begin
243
                                // Data arrives least significant bit first.
244
                                // By the time this is clocked in, it's what
245
                                // you'll have.
246
                                data_reg <= { ck_uart, data_reg[7:1] };
247
                                calc_parity <= calc_parity ^ ck_uart;
248
                                o_data <= 8'h00;
249
                                o_wr <= 1'b0;
250
                                state <= state + 1;
251
                                o_parity_err <= 1'b0;
252
                                o_frame_err <= 1'b0;
253
                        end else if (state == `RXU_BIT_SEVEN)
254
                        begin
255
                                data_reg <= { ck_uart, data_reg[7:1] };
256
                                calc_parity <= calc_parity ^ ck_uart;
257
                                o_data <= 8'h00;
258
                                o_wr <= 1'b0;
259
                                state <= (use_parity) ? `RXU_PARITY:`RXU_STOP;
260
                                o_parity_err <= 1'b0;
261
                                o_frame_err <= 1'b0;
262
                        end else if (state == `RXU_PARITY)
263
                        begin
264
                                if (fixd_parity)
265
                                        o_parity_err <= (ck_uart ^ parity_even);
266
                                else
267
                                        o_parity_err <= ((parity_even && (calc_parity != ck_uart))
268
                                                ||((~parity_even)&&(calc_parity==ck_uart)));
269
                                state <= `RXU_STOP;
270
                                o_frame_err <= 1'b0;
271
                        end else if (state == `RXU_STOP)
272
                        begin // Stop (or parity) bit(s)
273
                                case (data_bits)
274
                                2'b00: o_data <= data_reg;
275
                                2'b01: o_data <= { 1'b0, data_reg[7:1] };
276
                                2'b10: o_data <= { 2'b0, data_reg[7:2] };
277
                                2'b11: o_data <= { 3'b0, data_reg[7:3] };
278
                                endcase
279
                                o_wr <= 1'b1; // Pulse the write
280
                                o_frame_err <= (~ck_uart);
281
                                if (~ck_uart)
282
                                        state <= `RXU_RESET_IDLE;
283
                                else if (dblstop)
284
                                        state <= `RXU_SECOND_STOP;
285
                                else
286
                                        state <= `RXU_IDLE;
287
                                // o_parity_err <= 1'b0;
288
                        end else // state must equal RX_SECOND_STOP
289
                        begin
290
                                if (~ck_uart)
291
                                begin
292
                                        o_frame_err <= 1'b1;
293
                                        state <= `RXU_RESET_IDLE;
294
                                end else begin
295
                                        state <= `RXU_IDLE;
296
                                        o_frame_err  <= 1'b0;
297
                                end
298
                                o_parity_err <= 1'b0;
299
                        end
300
                end else begin
301
                        o_wr <= 1'b0;   // data_reg = data_reg
302 18 dgisselq
                        baud_counter <= baud_counter - 28'd1;
303 2 dgisselq
                        o_parity_err <= 1'b0;
304
                        o_frame_err  <= 1'b0;
305
                end
306
        end
307
 
308
endmodule
309
 
310
 

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.