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

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [orpsocv2/] [rtl/] [verilog/] [uart16550/] [uart_receiver.v] - Blame information for rev 643

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

Line No. Rev Author Line
1 6 julius
//////////////////////////////////////////////////////////////////////
2
////                                                              ////
3
////  uart_receiver.v                                             ////
4
////                                                              ////
5
////                                                              ////
6
////  This file is part of the "UART 16550 compatible" project    ////
7
////  http://www.opencores.org/cores/uart16550/                   ////
8
////                                                              ////
9
////  Documentation related to this project:                      ////
10
////  - http://www.opencores.org/cores/uart16550/                 ////
11
////                                                              ////
12
////  Projects compatibility:                                     ////
13
////  - WISHBONE                                                  ////
14
////  RS232 Protocol                                              ////
15
////  16550D uart (mostly supported)                              ////
16
////                                                              ////
17
////  Overview (main Features):                                   ////
18
////  UART core receiver logic                                    ////
19
////                                                              ////
20
////  Known problems (limits):                                    ////
21
////  None known                                                  ////
22
////                                                              ////
23
////  To Do:                                                      ////
24
////  Thourough testing.                                          ////
25
////                                                              ////
26
////  Author(s):                                                  ////
27
////      - gorban@opencores.org                                  ////
28
////      - Jacob Gorban                                          ////
29
////      - Igor Mohor (igorm@opencores.org)                      ////
30
////                                                              ////
31
////  Created:        2001/05/12                                  ////
32
////  Last Updated:   2001/05/17                                  ////
33
////                  (See log for the revision history)          ////
34
////                                                              ////
35
////                                                              ////
36
//////////////////////////////////////////////////////////////////////
37
////                                                              ////
38
//// Copyright (C) 2000, 2001 Authors                             ////
39
////                                                              ////
40
//// This source file may be used and distributed without         ////
41
//// restriction provided that this copyright statement is not    ////
42
//// removed from the file and that any derivative work contains  ////
43
//// the original copyright notice and the associated disclaimer. ////
44
////                                                              ////
45
//// This source file is free software; you can redistribute it   ////
46
//// and/or modify it under the terms of the GNU Lesser General   ////
47
//// Public License as published by the Free Software Foundation; ////
48
//// either version 2.1 of the License, or (at your option) any   ////
49
//// later version.                                               ////
50
////                                                              ////
51
//// This source is distributed in the hope that it will be       ////
52
//// useful, but WITHOUT ANY WARRANTY; without even the implied   ////
53
//// warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR      ////
54
//// PURPOSE.  See the GNU Lesser General Public License for more ////
55
//// details.                                                     ////
56
////                                                              ////
57
//// You should have received a copy of the GNU Lesser General    ////
58
//// Public License along with this source; if not, download it   ////
59
//// from http://www.opencores.org/lgpl.shtml                     ////
60
////                                                              ////
61
//////////////////////////////////////////////////////////////////////
62
//
63
// CVS Revision History
64
//
65 360 julius
// $Log: not supported by cvs2svn $
66 6 julius
// Revision 1.29  2002/07/29 21:16:18  gorban
67
// The uart_defines.v file is included again in sources.
68
//
69
// Revision 1.28  2002/07/22 23:02:23  gorban
70
// Bug Fixes:
71
//  * Possible loss of sync and bad reception of stop bit on slow baud rates fixed.
72
//   Problem reported by Kenny.Tung.
73
//  * Bad (or lack of ) loopback handling fixed. Reported by Cherry Withers.
74
//
75
// Improvements:
76
//  * Made FIFO's as general inferrable memory where possible.
77
//  So on FPGA they should be inferred as RAM (Distributed RAM on Xilinx).
78
//  This saves about 1/3 of the Slice count and reduces P&R and synthesis times.
79
//
80
//  * Added optional baudrate output (baud_o).
81
//  This is identical to BAUDOUT* signal on 16550 chip.
82
//  It outputs 16xbit_clock_rate - the divided clock.
83
//  It's disabled by default. Define UART_HAS_BAUDRATE_OUTPUT to use.
84
//
85
// Revision 1.27  2001/12/30 20:39:13  mohor
86
// More than one character was stored in case of break. End of the break
87
// was not detected correctly.
88
//
89
// Revision 1.26  2001/12/20 13:28:27  mohor
90
// Missing declaration of rf_push_q fixed.
91
//
92
// Revision 1.25  2001/12/20 13:25:46  mohor
93
// rx push changed to be only one cycle wide.
94
//
95
// Revision 1.24  2001/12/19 08:03:34  mohor
96
// Warnings cleared.
97
//
98
// Revision 1.23  2001/12/19 07:33:54  mohor
99
// Synplicity was having troubles with the comment.
100
//
101
// Revision 1.22  2001/12/17 14:46:48  mohor
102
// overrun signal was moved to separate block because many sequential lsr
103
// reads were preventing data from being written to rx fifo.
104
// underrun signal was not used and was removed from the project.
105
//
106
// Revision 1.21  2001/12/13 10:31:16  mohor
107
// timeout irq must be set regardless of the rda irq (rda irq does not reset the
108
// timeout counter).
109
//
110
// Revision 1.20  2001/12/10 19:52:05  gorban
111
// Igor fixed break condition bugs
112
//
113
// Revision 1.19  2001/12/06 14:51:04  gorban
114
// Bug in LSR[0] is fixed.
115
// All WISHBONE signals are now sampled, so another wait-state is introduced on all transfers.
116
//
117
// Revision 1.18  2001/12/03 21:44:29  gorban
118
// Updated specification documentation.
119
// Added full 32-bit data bus interface, now as default.
120
// Address is 5-bit wide in 32-bit data bus mode.
121
// Added wb_sel_i input to the core. It's used in the 32-bit mode.
122
// Added debug interface with two 32-bit read-only registers in 32-bit mode.
123
// Bits 5 and 6 of LSR are now only cleared on TX FIFO write.
124
// My small test bench is modified to work with 32-bit mode.
125
//
126
// Revision 1.17  2001/11/28 19:36:39  gorban
127
// Fixed: timeout and break didn't pay attention to current data format when counting time
128
//
129
// Revision 1.16  2001/11/27 22:17:09  gorban
130
// Fixed bug that prevented synthesis in uart_receiver.v
131
//
132
// Revision 1.15  2001/11/26 21:38:54  gorban
133
// Lots of fixes:
134
// Break condition wasn't handled correctly at all.
135
// LSR bits could lose their values.
136
// LSR value after reset was wrong.
137
// Timing of THRE interrupt signal corrected.
138
// LSR bit 0 timing corrected.
139
//
140
// Revision 1.14  2001/11/10 12:43:21  gorban
141
// Logic Synthesis bugs fixed. Some other minor changes
142
//
143
// Revision 1.13  2001/11/08 14:54:23  mohor
144
// Comments in Slovene language deleted, few small fixes for better work of
145
// old tools. IRQs need to be fix.
146
//
147
// Revision 1.12  2001/11/07 17:51:52  gorban
148
// Heavily rewritten interrupt and LSR subsystems.
149
// Many bugs hopefully squashed.
150
//
151
// Revision 1.11  2001/10/31 15:19:22  gorban
152
// Fixes to break and timeout conditions
153
//
154
// Revision 1.10  2001/10/20 09:58:40  gorban
155
// Small synopsis fixes
156
//
157
// Revision 1.9  2001/08/24 21:01:12  mohor
158
// Things connected to parity changed.
159
// Clock devider changed.
160
//
161
// Revision 1.8  2001/08/23 16:05:05  mohor
162
// Stop bit bug fixed.
163
// Parity bug fixed.
164
// WISHBONE read cycle bug fixed,
165
// OE indicator (Overrun Error) bug fixed.
166
// PE indicator (Parity Error) bug fixed.
167
// Register read bug fixed.
168
//
169
// Revision 1.6  2001/06/23 11:21:48  gorban
170
// DL made 16-bit long. Fixed transmission/reception bugs.
171
//
172
// Revision 1.5  2001/06/02 14:28:14  gorban
173
// Fixed receiver and transmitter. Major bug fixed.
174
//
175
// Revision 1.4  2001/05/31 20:08:01  gorban
176
// FIFO changes and other corrections.
177
//
178
// Revision 1.3  2001/05/27 17:37:49  gorban
179
// Fixed many bugs. Updated spec. Changed FIFO files structure. See CHANGES.txt file.
180
//
181
// Revision 1.2  2001/05/21 19:12:02  gorban
182
// Corrected some Linter messages.
183
//
184
// Revision 1.1  2001/05/17 18:34:18  gorban
185
// First 'stable' release. Should be sythesizable now. Also added new header.
186
//
187
// Revision 1.0  2001-05-17 21:27:11+02  jacob
188
// Initial revision
189
//
190
//
191
 
192
// synopsys translate_off
193
`include "timescale.v"
194
// synopsys translate_on
195
 
196
`include "uart_defines.v"
197
 
198
module uart_receiver (clk, wb_rst_i, lcr, rf_pop, srx_pad_i, enable,
199 360 julius
                      counter_t, rf_count, rf_data_out, rf_error_bit, rf_overrun, rx_reset, lsr_mask, rstate, rf_push_pulse);
200 6 julius
 
201 360 julius
   input                                clk;
202
   input                                wb_rst_i;
203
   input [7:0]                           lcr;
204
   input                                rf_pop;
205
   input                                srx_pad_i;
206
   input                                enable;
207
   input                                rx_reset;
208
   input                                lsr_mask;
209 6 julius
 
210 360 julius
   output [9:0]                  counter_t;
211
   output [`UART_FIFO_COUNTER_W-1:0]     rf_count;
212
   output [`UART_FIFO_REC_WIDTH-1:0]     rf_data_out;
213
   output                               rf_overrun;
214
   output                               rf_error_bit;
215
   output [3:0]                  rstate;
216
   output                               rf_push_pulse;
217 6 julius
 
218 360 julius
   reg [3:0]                             rstate;
219
   reg [3:0]                             rcounter16;
220
   reg [2:0]                             rbit_counter;
221
   reg [7:0]                             rshift;                 // receiver shift register
222
   reg                                  rparity;                // received parity
223
   reg                                  rparity_error;
224
   reg                                  rframing_error;         // framing error flag
225
   reg                                  rbit_in;
226
   reg                                  rparity_xor;
227
   reg [7:0]                             counter_b;      // counts the 0 (low) signals
228
   reg                                  rf_push_q;
229 6 julius
 
230 360 julius
   // RX FIFO signals
231
   reg [`UART_FIFO_REC_WIDTH-1:0]        rf_data_in;
232
   wire [`UART_FIFO_REC_WIDTH-1:0]       rf_data_out;
233
   wire                                 rf_push_pulse;
234
   reg                                  rf_push;
235
   wire                                 rf_pop;
236
   wire                                 rf_overrun;
237
   wire [`UART_FIFO_COUNTER_W-1:0]       rf_count;
238
   wire                                 rf_error_bit; // an error (parity or framing) is inside the fifo
239
   wire                                 break_error = (counter_b == 0);
240 6 julius
 
241 360 julius
   // RX FIFO instance
242
   uart_rfifo #(`UART_FIFO_REC_WIDTH) fifo_rx(
243
                                              .clk(             clk             ),
244
                                              .wb_rst_i(        wb_rst_i        ),
245
                                              .data_in( rf_data_in      ),
246
                                              .data_out(        rf_data_out     ),
247
                                              .push(            rf_push_pulse           ),
248
                                              .pop(             rf_pop          ),
249
                                              .overrun( rf_overrun      ),
250
                                              .count(           rf_count        ),
251
                                              .error_bit(       rf_error_bit    ),
252
                                              .fifo_reset(      rx_reset        ),
253
                                              .reset_status(lsr_mask)
254
                                              );
255 6 julius
 
256 360 julius
   wire                                 rcounter16_eq_7 = (rcounter16 == 4'd7);
257
   wire                                 rcounter16_eq_0 = (rcounter16 == 4'd0);
258
   wire                                 rcounter16_eq_1 = (rcounter16 == 4'd1);
259 6 julius
 
260 363 julius
   wire [3:0]                            rcounter16_minus_1 = rcounter16 - 3'd1;
261 6 julius
 
262 360 julius
   parameter  sr_idle                                   = 4'd0;
263
   parameter  sr_rec_start                      = 4'd1;
264
   parameter  sr_rec_bit                                = 4'd2;
265
   parameter  sr_rec_parity                     = 4'd3;
266
   parameter  sr_rec_stop                               = 4'd4;
267
   parameter  sr_check_parity           = 4'd5;
268
   parameter  sr_rec_prepare                    = 4'd6;
269
   parameter  sr_end_bit                                = 4'd7;
270
   parameter  sr_ca_lc_parity         = 4'd8;
271
   parameter  sr_wait1                                  = 4'd9;
272
   parameter  sr_push                                   = 4'd10;
273 6 julius
 
274
 
275 360 julius
   always @(posedge clk or posedge wb_rst_i)
276
     begin
277
        if (wb_rst_i)
278
          begin
279
             rstate                     <=  sr_idle;
280
             rbit_in                            <=  1'b0;
281
             rcounter16                         <=  0;
282
             rbit_counter               <=  0;
283
             rparity_xor                <=  1'b0;
284
             rframing_error     <=  1'b0;
285
             rparity_error              <=  1'b0;
286
             rparity                            <=  1'b0;
287
             rshift                             <=  0;
288
             rf_push                            <=  1'b0;
289
             rf_data_in                         <=  0;
290
          end
291
        else
292
          if (enable)
293
            begin
294
               case (rstate)
295
                 sr_idle : begin
296
                    rf_push                       <=  1'b0;
297
                    rf_data_in    <=  0;
298
                    rcounter16    <=  4'b1110;
299
                    if (srx_pad_i==1'b0 & ~break_error)   // detected a pulse (start bit?)
300
                      begin
301
                         rstate                   <=  sr_rec_start;
302
                      end
303
                 end
304
                 sr_rec_start : begin
305
                    rf_push                       <=  1'b0;
306
                    if (rcounter16_eq_7)    // check the pulse
307
                      if (srx_pad_i==1'b1)   // no start bit
308
                        rstate <=  sr_idle;
309
                      else            // start bit detected
310
                        rstate <=  sr_rec_prepare;
311
                    rcounter16 <=  rcounter16_minus_1;
312
                 end
313
                 sr_rec_prepare:begin
314
                    case (lcr[/*`UART_LC_BITS*/1:0])  // number of bits in a word
315
                      2'b00 : rbit_counter <=  3'b100;
316
                      2'b01 : rbit_counter <=  3'b101;
317
                      2'b10 : rbit_counter <=  3'b110;
318
                      2'b11 : rbit_counter <=  3'b111;
319
                    endcase
320
                    if (rcounter16_eq_0)
321
                      begin
322
                         rstate         <=  sr_rec_bit;
323
                         rcounter16     <=  4'b1110;
324
                         rshift         <=  0;
325
                      end
326
                    else
327
                      rstate <=  sr_rec_prepare;
328
                    rcounter16 <=  rcounter16_minus_1;
329
                 end
330
                 sr_rec_bit :   begin
331
                    if (rcounter16_eq_0)
332
                      rstate <=  sr_end_bit;
333
                    if (rcounter16_eq_7) // read the bit
334
                      case (lcr[/*`UART_LC_BITS*/1:0])  // number of bits in a word
335
                        2'b00 : rshift[4:0]  <=  {srx_pad_i, rshift[4:1]};
336
                        2'b01 : rshift[5:0]  <=  {srx_pad_i, rshift[5:1]};
337
                        2'b10 : rshift[6:0]  <=  {srx_pad_i, rshift[6:1]};
338
                        2'b11 : rshift[7:0]  <=  {srx_pad_i, rshift[7:1]};
339
                      endcase
340
                    rcounter16 <=  rcounter16_minus_1;
341
                 end
342
                 sr_end_bit :   begin
343
                    if (rbit_counter==3'b0) // no more bits in word
344
                      if (lcr[`UART_LC_PE]) // choose state based on parity
345
                        rstate <=  sr_rec_parity;
346
                      else
347 6 julius
                        begin
348 360 julius
                           rstate <=  sr_rec_stop;
349
                           rparity_error <=  1'b0;  // no parity - no error :)
350 6 julius
                        end
351 360 julius
                    else                // else we have more bits to read
352
                      begin
353
                         rstate <=  sr_rec_bit;
354 363 julius
                         rbit_counter <=  rbit_counter - 3'd1;
355 360 julius
                      end
356
                    rcounter16 <=  4'b1110;
357
                 end
358
                 sr_rec_parity: begin
359
                    if (rcounter16_eq_7)        // read the parity
360
                      begin
361
                         rparity <=  srx_pad_i;
362
                         rstate <=  sr_ca_lc_parity;
363
                      end
364
                    rcounter16 <=  rcounter16_minus_1;
365
                 end
366
                 sr_ca_lc_parity : begin    // rcounter equals 6
367
                    rcounter16  <=  rcounter16_minus_1;
368
                    rparity_xor <=  ^{rshift,rparity}; // calculate parity on all incoming data
369
                    rstate      <=  sr_check_parity;
370
                 end
371
                 sr_check_parity: begin   // rcounter equals 5
372
                    case ({lcr[`UART_LC_EP],lcr[`UART_LC_SP]})
373
                      2'b00: rparity_error <=   rparity_xor == 0;  // no error if parity 1
374
                      2'b01: rparity_error <=  ~rparity;      // parity should sticked to 1
375
                      2'b10: rparity_error <=   rparity_xor == 1;   // error if parity is odd
376
                      2'b11: rparity_error <=   rparity;          // parity should be sticked to 0
377
                    endcase
378
                    rcounter16 <=  rcounter16_minus_1;
379
                    rstate <=  sr_wait1;
380
                 end
381
                 sr_wait1 :     if (rcounter16_eq_0)
382
                   begin
383
                      rstate <=  sr_rec_stop;
384
                      rcounter16 <=  4'b1110;
385
                   end
386
                 else
387
                   rcounter16 <=  rcounter16_minus_1;
388
                 sr_rec_stop :  begin
389
                    if (rcounter16_eq_7)        // read the parity
390
                      begin
391
                         rframing_error <=  !srx_pad_i; // no framing error if input is 1 (stop bit)
392
                         rstate <=  sr_push;
393
                      end
394
                    rcounter16 <=  rcounter16_minus_1;
395
                 end
396
                 sr_push :      begin
397
                    ///////////////////////////////////////
398
                    //                          $display($time, ": received: %b", rf_data_in);
399
                    if(srx_pad_i | break_error)
400
                      begin
401
                         if(break_error)
402
                           rf_data_in   <=  {8'b0, 3'b100}; // break input (empty character) to receiver FIFO
403
                         else
404
                           rf_data_in  <=  {rshift, 1'b0, rparity_error, rframing_error};
405
                         rf_push                  <=  1'b1;
406
                         rstate        <=  sr_idle;
407
                      end
408
                    else if(~rframing_error)  // There's always a framing before break_error -> wait for break or srx_pad_i
409
                      begin
410
                         rf_data_in  <=  {rshift, 1'b0, rparity_error, rframing_error};
411
                         rf_push                  <=  1'b1;
412
                         rcounter16       <=  4'b1110;
413
                         rstate                   <=  sr_rec_start;
414
                      end
415
 
416
                 end
417
                 default : rstate <=  sr_idle;
418
               endcase
419
            end  // if (enable)
420
     end // always of receiver
421 6 julius
 
422 360 julius
   always @ (posedge clk or posedge wb_rst_i)
423
     begin
424
        if(wb_rst_i)
425
          rf_push_q <= 0;
426
        else
427
          rf_push_q <=  rf_push;
428
     end
429 6 julius
 
430 360 julius
   assign rf_push_pulse = rf_push & ~rf_push_q;
431 6 julius
 
432 360 julius
 
433
   //
434
   // Break condition detection.
435
   // Works in conjuction with the receiver state machine
436 6 julius
 
437 360 julius
   reg  [9:0]    toc_value; // value to be set to timeout counter
438 6 julius
 
439 360 julius
   always @(lcr)
440
     case (lcr[3:0])
441
       4'b0000: toc_value = 447; // 7 bits
442
       4'b0100: toc_value = 479; // 7.5 bits
443
       4'b0001, 4'b1000 : toc_value = 511; // 8 bits
444
       4'b1100: toc_value = 543; // 8.5 bits
445
       4'b0010, 4'b0101, 4'b1001: toc_value = 575; // 9 bits
446
       4'b0011, 4'b0110, 4'b1010, 4'b1101: toc_value = 639; // 10 bits
447
       4'b0111, 4'b1011, 4'b1110: toc_value = 703; // 11 bits
448
       4'b1111: toc_value = 767; // 12 bits
449
     endcase // case(lcr[3:0])
450 6 julius
 
451 360 julius
   wire [7:0]    brc_value; // value to be set to break counter
452
   assign               brc_value = toc_value[9:2]; // the same as timeout but 1 insead of 4 character times
453 6 julius
 
454 360 julius
   always @(posedge clk or posedge wb_rst_i)
455
     begin
456 6 julius
        if (wb_rst_i)
457 360 julius
          counter_b <=  8'd159;
458 6 julius
        else
459 360 julius
          if (srx_pad_i)
460
            counter_b <=  brc_value; // character time length - 1
461
          else
462
            if(enable & counter_b != 8'b0)            // only work on enable times  break not reached.
463
              counter_b <=  counter_b - 1;  // decrement break counter
464
     end // always of break condition detection
465 6 julius
 
466 360 julius
   ///
467
   /// Timeout condition detection
468
   reg  [9:0]    counter_t;      // counts the timeout condition clocks
469 6 julius
 
470 360 julius
   always @(posedge clk or posedge wb_rst_i)
471
     begin
472 6 julius
        if (wb_rst_i)
473 360 julius
          counter_t <=  10'd639; // 10 bits for the default 8N1
474 6 julius
        else
475 360 julius
          if(rf_push_pulse || rf_pop || rf_count == 0) // counter is reset when RX FIFO is empty, accessed or above trigger level
476
            counter_t <=  toc_value;
477
          else
478
            if (enable && counter_t != 10'b0)  // we don't want to underflow
479
              counter_t <=  counter_t - 1;
480
     end
481
 
482 6 julius
endmodule

powered by: WebSVN 2.1.0

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