uart_dev_ns8250.c 23.1 KB
Newer Older
1
/*-
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 * Copyright (c) 2003 Marcel Moolenaar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

27
28
#include "opt_platform.h"

29
30
31
32
33
34
35
#include <sys/cdefs.h>
__FBSDID("$FreeBSD$");

#include <sys/param.h>
#include <sys/systm.h>
#include <sys/bus.h>
#include <sys/conf.h>
36
37
#include <sys/kernel.h>
#include <sys/sysctl.h>
38
39
#include <machine/bus.h>

40
41
42
43
44
45
#ifdef FDT
#include <dev/fdt/fdt_common.h>
#include <dev/ofw/ofw_bus.h>
#include <dev/ofw/ofw_bus_subr.h>
#endif

46
47
48
#include <dev/uart/uart.h>
#include <dev/uart/uart_cpu.h>
#include <dev/uart/uart_bus.h>
49
#include <dev/uart/uart_dev_ns8250.h>
50
51

#include <dev/ic/ns16550.h>
52
53
54
55
56

#include "uart_if.h"

#define	DEFAULT_RCLK	1843200

57
58
59
60
61
static int broken_txfifo = 0;
SYSCTL_INT(_hw, OID_AUTO, broken_txfifo, CTLFLAG_RW | CTLFLAG_TUN,
	&broken_txfifo, 0, "UART FIFO has QEMU emulation bug");
TUNABLE_INT("hw.broken_txfifo", &broken_txfifo);

62
63
64
65
66
67
68
/*
 * Clear pending interrupts. THRE is cleared by reading IIR. Data
 * that may have been received gets lost here.
 */
static void
ns8250_clrint(struct uart_bas *bas)
{
69
	uint8_t iir, lsr;
70
71
72
73

	iir = uart_getreg(bas, REG_IIR);
	while ((iir & IIR_NOPEND) == 0) {
		iir &= IIR_IMASK;
74
75
76
77
78
		if (iir == IIR_RLS) {
			lsr = uart_getreg(bas, REG_LSR);
			if (lsr & (LSR_BI|LSR_FE|LSR_PE))
				(void)uart_getreg(bas, REG_DATA);
		} else if (iir == IIR_RXRDY || iir == IIR_RXTOUT)
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
			(void)uart_getreg(bas, REG_DATA);
		else if (iir == IIR_MLSC)
			(void)uart_getreg(bas, REG_MSR);
		uart_barrier(bas);
		iir = uart_getreg(bas, REG_IIR);
	}
}

static int
ns8250_delay(struct uart_bas *bas)
{
	int divisor;
	u_char lcr;

	lcr = uart_getreg(bas, REG_LCR);
	uart_setreg(bas, REG_LCR, lcr | LCR_DLAB);
	uart_barrier(bas);
96
	divisor = uart_getreg(bas, REG_DLL) | (uart_getreg(bas, REG_DLH) << 8);
97
98
99
100
101
	uart_barrier(bas);
	uart_setreg(bas, REG_LCR, lcr);
	uart_barrier(bas);

	/* 1/10th the time to transmit 1 character (estimate). */
102
103
104
	if (divisor <= 134)
		return (16000000 * divisor / bas->rclk);
	return (16000 * divisor / (bas->rclk / 1000));
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
}

static int
ns8250_divisor(int rclk, int baudrate)
{
	int actual_baud, divisor;
	int error;

	if (baudrate == 0)
		return (0);

	divisor = (rclk / (baudrate << 3) + 1) >> 1;
	if (divisor == 0 || divisor >= 65536)
		return (0);
	actual_baud = rclk / (divisor << 4);

	/* 10 times error in percent: */
	error = ((actual_baud - baudrate) * 2000 / baudrate + 1) >> 1;

	/* 3.0% maximum error tolerance: */
	if (error < -30 || error > 30)
		return (0);

	return (divisor);
}

static int
ns8250_drain(struct uart_bas *bas, int what)
{
	int delay, limit;

	delay = ns8250_delay(bas);

	if (what & UART_DRAIN_TRANSMITTER) {
		/*
		 * Pick an arbitrary high limit to avoid getting stuck in
		 * an infinite loop when the hardware is broken. Make the
		 * limit high enough to handle large FIFOs.
		 */
		limit = 10*1024;
		while ((uart_getreg(bas, REG_LSR) & LSR_TEMT) == 0 && --limit)
			DELAY(delay);
		if (limit == 0) {
			/* printf("ns8250: transmitter appears stuck... "); */
			return (EIO);
		}
	}

	if (what & UART_DRAIN_RECEIVER) {
		/*
		 * Pick an arbitrary high limit to avoid getting stuck in
		 * an infinite loop when the hardware is broken. Make the
		 * limit high enough to handle large FIFOs and integrated
		 * UARTs. The HP rx2600 for example has 3 UARTs on the
		 * management board that tend to get a lot of data send
		 * to it when the UART is first activated.
		 */
		limit=10*4096;
		while ((uart_getreg(bas, REG_LSR) & LSR_RXRDY) && --limit) {
			(void)uart_getreg(bas, REG_DATA);
			uart_barrier(bas);
			DELAY(delay << 2);
		}
		if (limit == 0) {
			/* printf("ns8250: receiver appears broken... "); */
			return (EIO);
		}
	}

	return (0);
}

/*
 * We can only flush UARTs with FIFOs. UARTs without FIFOs should be
 * drained. WARNING: this function clobbers the FIFO setting!
 */
static void
ns8250_flush(struct uart_bas *bas, int what)
{
	uint8_t fcr;

	fcr = FCR_ENABLE;
	if (what & UART_FLUSH_TRANSMITTER)
		fcr |= FCR_XMT_RST;
	if (what & UART_FLUSH_RECEIVER)
		fcr |= FCR_RCV_RST;
	uart_setreg(bas, REG_FCR, fcr);
	uart_barrier(bas);
}

static int
ns8250_param(struct uart_bas *bas, int baudrate, int databits, int stopbits,
    int parity)
{
	int divisor;
	uint8_t lcr;

	lcr = 0;
	if (databits >= 8)
		lcr |= LCR_8BITS;
	else if (databits == 7)
		lcr |= LCR_7BITS;
	else if (databits == 6)
		lcr |= LCR_6BITS;
	else
		lcr |= LCR_5BITS;
	if (stopbits > 1)
		lcr |= LCR_STOPB;
	lcr |= parity << 3;

	/* Set baudrate. */
	if (baudrate > 0) {
		divisor = ns8250_divisor(bas->rclk, baudrate);
		if (divisor == 0)
			return (EINVAL);
220
221
		uart_setreg(bas, REG_LCR, lcr | LCR_DLAB);
		uart_barrier(bas);
222
223
		uart_setreg(bas, REG_DLL, divisor & 0xff);
		uart_setreg(bas, REG_DLH, (divisor >> 8) & 0xff);
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
		uart_barrier(bas);
	}

	/* Set LCR and clear DLAB. */
	uart_setreg(bas, REG_LCR, lcr);
	uart_barrier(bas);
	return (0);
}

/*
 * Low-level UART interface.
 */
static int ns8250_probe(struct uart_bas *bas);
static void ns8250_init(struct uart_bas *bas, int, int, int, int);
static void ns8250_term(struct uart_bas *bas);
static void ns8250_putc(struct uart_bas *bas, int);
240
static int ns8250_rxready(struct uart_bas *bas);
241
static int ns8250_getc(struct uart_bas *bas, struct mtx *);
242

243
struct uart_ops uart_ns8250_ops = {
244
245
246
247
	.probe = ns8250_probe,
	.init = ns8250_init,
	.term = ns8250_term,
	.putc = ns8250_putc,
248
	.rxready = ns8250_rxready,
249
250
251
252
253
254
	.getc = ns8250_getc,
};

static int
ns8250_probe(struct uart_bas *bas)
{
255
	u_char val;
256
257
258
259
260

	/* Check known 0 bits that don't depend on DLAB. */
	val = uart_getreg(bas, REG_IIR);
	if (val & 0x30)
		return (ENXIO);
261
262
263
264
265
266
	/*
	 * Bit 6 of the MCR (= 0x40) appears to be 1 for the Sun1699
	 * chip, but otherwise doesn't seem to have a function. In
	 * other words, uart(4) works regardless. Ignore that bit so
	 * the probe succeeds.
	 */
267
	val = uart_getreg(bas, REG_MCR);
268
	if (val & 0xa0)
269
270
271
272
273
274
275
276
277
		return (ENXIO);

	return (0);
}

static void
ns8250_init(struct uart_bas *bas, int baudrate, int databits, int stopbits,
    int parity)
{
278
	u_char	ier;
279
280
281
282
283
284

	if (bas->rclk == 0)
		bas->rclk = DEFAULT_RCLK;
	ns8250_param(bas, baudrate, databits, stopbits, parity);

	/* Disable all interrupt sources. */
285
286
287
288
289
290
	/*
	 * We use 0xe0 instead of 0xf0 as the mask because the XScale PXA
	 * UARTs split the receive time-out interrupt bit out separately as
	 * 0x10.  This gets handled by ier_mask and ier_rxbits below.
	 */
	ier = uart_getreg(bas, REG_IER) & 0xe0;
291
	uart_setreg(bas, REG_IER, ier);
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
	uart_barrier(bas);

	/* Disable the FIFO (if present). */
	uart_setreg(bas, REG_FCR, 0);
	uart_barrier(bas);

	/* Set RTS & DTR. */
	uart_setreg(bas, REG_MCR, MCR_IE | MCR_RTS | MCR_DTR);
	uart_barrier(bas);

	ns8250_clrint(bas);
}

static void
ns8250_term(struct uart_bas *bas)
{

	/* Clear RTS & DTR. */
	uart_setreg(bas, REG_MCR, MCR_IE);
	uart_barrier(bas);
}

static void
ns8250_putc(struct uart_bas *bas, int c)
{
317
	int limit;
318

319
	limit = 250000;
320
	while ((uart_getreg(bas, REG_LSR) & LSR_THRE) == 0 && --limit)
321
		DELAY(4);
322
	uart_setreg(bas, REG_DATA, c);
323
	uart_barrier(bas);
324
	limit = 250000;
325
	while ((uart_getreg(bas, REG_LSR) & LSR_TEMT) == 0 && --limit)
326
		DELAY(4);
327
328
329
}

static int
330
ns8250_rxready(struct uart_bas *bas)
331
332
{

333
	return ((uart_getreg(bas, REG_LSR) & LSR_RXRDY) != 0 ? 1 : 0);
334
335
336
}

static int
337
ns8250_getc(struct uart_bas *bas, struct mtx *hwmtx)
338
{
339
	int c;
340
341

	uart_lock(hwmtx);
342

343
344
	while ((uart_getreg(bas, REG_LSR) & LSR_RXRDY) == 0) {
		uart_unlock(hwmtx);
345
		DELAY(4);
346
347
348
349
350
351
352
353
		uart_lock(hwmtx);
	}

	c = uart_getreg(bas, REG_DATA);

	uart_unlock(hwmtx);

	return (c);
354
355
356
357
358
359
360
361
362
363
364
365
366
367
}

static kobj_method_t ns8250_methods[] = {
	KOBJMETHOD(uart_attach,		ns8250_bus_attach),
	KOBJMETHOD(uart_detach,		ns8250_bus_detach),
	KOBJMETHOD(uart_flush,		ns8250_bus_flush),
	KOBJMETHOD(uart_getsig,		ns8250_bus_getsig),
	KOBJMETHOD(uart_ioctl,		ns8250_bus_ioctl),
	KOBJMETHOD(uart_ipend,		ns8250_bus_ipend),
	KOBJMETHOD(uart_param,		ns8250_bus_param),
	KOBJMETHOD(uart_probe,		ns8250_bus_probe),
	KOBJMETHOD(uart_receive,	ns8250_bus_receive),
	KOBJMETHOD(uart_setsig,		ns8250_bus_setsig),
	KOBJMETHOD(uart_transmit,	ns8250_bus_transmit),
368
369
	KOBJMETHOD(uart_grab,		ns8250_bus_grab),
	KOBJMETHOD(uart_ungrab,		ns8250_bus_ungrab),
370
371
372
373
	{ 0, 0 }
};

struct uart_class uart_ns8250_class = {
374
	"ns8250",
375
376
	ns8250_methods,
	sizeof(struct ns8250_softc),
377
	.uc_ops = &uart_ns8250_ops,
378
379
380
381
382
383
384
385
386
387
388
	.uc_range = 8,
	.uc_rclk = DEFAULT_RCLK
};

#define	SIGCHG(c, i, s, d)				\
	if (c) {					\
		i |= (i & s) ? s : s | d;		\
	} else {					\
		i = (i & s) ? (i & ~s) | d : i;		\
	}

389
int
390
391
392
393
ns8250_bus_attach(struct uart_softc *sc)
{
	struct ns8250_softc *ns8250 = (struct ns8250_softc*)sc;
	struct uart_bas *bas;
394
	unsigned int ivar;
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
#ifdef FDT
	phandle_t node;
	pcell_t cell;
#endif

	ns8250->busy_detect = 0;

#ifdef FDT
	/* 
	 * Check whether uart requires to read USR reg when IIR_BUSY and 
	 * has broken txfifo. 
	 */
	node = ofw_bus_get_node(sc->sc_dev);
	if ((OF_getprop(node, "busy-detect", &cell, sizeof(cell))) > 0)
		ns8250->busy_detect = 1;
	if ((OF_getprop(node, "broken-txfifo", &cell, sizeof(cell))) > 0)
		broken_txfifo = 1;
#endif
413
414
415
416

	bas = &sc->sc_bas;

	ns8250->mcr = uart_getreg(bas, REG_MCR);
417
418
419
420
421
422
423
424
425
426
427
428
429
	ns8250->fcr = FCR_ENABLE;
	if (!resource_int_value("uart", device_get_unit(sc->sc_dev), "flags",
	    &ivar)) {
		if (UART_FLAGS_FCR_RX_LOW(ivar)) 
			ns8250->fcr |= FCR_RX_LOW;
		else if (UART_FLAGS_FCR_RX_MEDL(ivar)) 
			ns8250->fcr |= FCR_RX_MEDL;
		else if (UART_FLAGS_FCR_RX_HIGH(ivar)) 
			ns8250->fcr |= FCR_RX_HIGH;
		else
			ns8250->fcr |= FCR_RX_MEDH;
	} else 
		ns8250->fcr |= FCR_RX_MEDH;
430
431
432
433
434
435
436
437
438
439
440
441
442
	
	/* Get IER mask */
	ivar = 0xf0;
	resource_int_value("uart", device_get_unit(sc->sc_dev), "ier_mask",
	    &ivar);
	ns8250->ier_mask = (uint8_t)(ivar & 0xff);
	
	/* Get IER RX interrupt bits */
	ivar = IER_EMSC | IER_ERLS | IER_ERXRDY;
	resource_int_value("uart", device_get_unit(sc->sc_dev), "ier_rxbits",
	    &ivar);
	ns8250->ier_rxbits = (uint8_t)(ivar & 0xff);
	
443
444
445
446
447
	uart_setreg(bas, REG_FCR, ns8250->fcr);
	uart_barrier(bas);
	ns8250_bus_flush(sc, UART_FLUSH_RECEIVER|UART_FLUSH_TRANSMITTER);

	if (ns8250->mcr & MCR_DTR)
448
		sc->sc_hwsig |= SER_DTR;
449
	if (ns8250->mcr & MCR_RTS)
450
		sc->sc_hwsig |= SER_RTS;
451
452
453
	ns8250_bus_getsig(sc);

	ns8250_clrint(bas);
454
455
	ns8250->ier = uart_getreg(bas, REG_IER) & ns8250->ier_mask;
	ns8250->ier |= ns8250->ier_rxbits;
456
457
	uart_setreg(bas, REG_IER, ns8250->ier);
	uart_barrier(bas);
458
459
460
461
462
463
464
465
466
467
468
469

	/*
	 * Timing of the H/W access was changed with r253161 of uart_core.c
	 * It has been observed that an ITE IT8513E would signal a break
	 * condition with pretty much every character it received, unless
	 * it had enough time to settle between ns8250_bus_attach() and
	 * ns8250_bus_ipend() -- which it accidentally had before r253161.
	 * It's not understood why the UART chip behaves this way and it
	 * could very well be that the DELAY make the H/W work in the same
	 * accidental manner as before. More analysis is warranted, but
	 * at least now we fixed a known regression.
	 */
470
	DELAY(200);
471
472
473
	return (0);
}

474
int
475
476
ns8250_bus_detach(struct uart_softc *sc)
{
477
	struct ns8250_softc *ns8250;
478
	struct uart_bas *bas;
479
	u_char ier;
480

481
	ns8250 = (struct ns8250_softc *)sc;
482
	bas = &sc->sc_bas;
483
	ier = uart_getreg(bas, REG_IER) & ns8250->ier_mask;
484
	uart_setreg(bas, REG_IER, ier);
485
486
487
488
489
	uart_barrier(bas);
	ns8250_clrint(bas);
	return (0);
}

490
int
491
492
493
494
ns8250_bus_flush(struct uart_softc *sc, int what)
{
	struct ns8250_softc *ns8250 = (struct ns8250_softc*)sc;
	struct uart_bas *bas;
495
	int error;
496
497

	bas = &sc->sc_bas;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
498
	uart_lock(sc->sc_hwmtx);
499
	if (sc->sc_rxfifosz > 1) {
500
501
502
		ns8250_flush(bas, what);
		uart_setreg(bas, REG_FCR, ns8250->fcr);
		uart_barrier(bas);
503
504
505
		error = 0;
	} else
		error = ns8250_drain(bas, what);
Marcel Moolenaar's avatar
Marcel Moolenaar committed
506
	uart_unlock(sc->sc_hwmtx);
507
	return (error);
508
509
}

510
int
511
512
513
514
515
516
517
518
ns8250_bus_getsig(struct uart_softc *sc)
{
	uint32_t new, old, sig;
	uint8_t msr;

	do {
		old = sc->sc_hwsig;
		sig = old;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
519
		uart_lock(sc->sc_hwmtx);
520
		msr = uart_getreg(&sc->sc_bas, REG_MSR);
Marcel Moolenaar's avatar
Marcel Moolenaar committed
521
		uart_unlock(sc->sc_hwmtx);
522
523
524
525
		SIGCHG(msr & MSR_DSR, sig, SER_DSR, SER_DDSR);
		SIGCHG(msr & MSR_CTS, sig, SER_CTS, SER_DCTS);
		SIGCHG(msr & MSR_DCD, sig, SER_DCD, SER_DDCD);
		SIGCHG(msr & MSR_RI,  sig, SER_RI,  SER_DRI);
526
		new = sig & ~SER_MASK_DELTA;
527
528
529
530
	} while (!atomic_cmpset_32(&sc->sc_hwsig, old, new));
	return (sig);
}

531
int
532
533
534
ns8250_bus_ioctl(struct uart_softc *sc, int request, intptr_t data)
{
	struct uart_bas *bas;
535
	int baudrate, divisor, error;
536
	uint8_t efr, lcr;
537
538

	bas = &sc->sc_bas;
539
	error = 0;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
540
	uart_lock(sc->sc_hwmtx);
541
542
543
544
545
546
547
548
549
550
	switch (request) {
	case UART_IOCTL_BREAK:
		lcr = uart_getreg(bas, REG_LCR);
		if (data)
			lcr |= LCR_SBREAK;
		else
			lcr &= ~LCR_SBREAK;
		uart_setreg(bas, REG_LCR, lcr);
		uart_barrier(bas);
		break;
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
	case UART_IOCTL_IFLOW:
		lcr = uart_getreg(bas, REG_LCR);
		uart_barrier(bas);
		uart_setreg(bas, REG_LCR, 0xbf);
		uart_barrier(bas);
		efr = uart_getreg(bas, REG_EFR);
		if (data)
			efr |= EFR_RTS;
		else
			efr &= ~EFR_RTS;
		uart_setreg(bas, REG_EFR, efr);
		uart_barrier(bas);
		uart_setreg(bas, REG_LCR, lcr);
		uart_barrier(bas);
		break;
	case UART_IOCTL_OFLOW:
		lcr = uart_getreg(bas, REG_LCR);
		uart_barrier(bas);
		uart_setreg(bas, REG_LCR, 0xbf);
		uart_barrier(bas);
		efr = uart_getreg(bas, REG_EFR);
		if (data)
			efr |= EFR_CTS;
		else
			efr &= ~EFR_CTS;
		uart_setreg(bas, REG_EFR, efr);
		uart_barrier(bas);
		uart_setreg(bas, REG_LCR, lcr);
		uart_barrier(bas);
		break;
581
582
583
584
	case UART_IOCTL_BAUD:
		lcr = uart_getreg(bas, REG_LCR);
		uart_setreg(bas, REG_LCR, lcr | LCR_DLAB);
		uart_barrier(bas);
585
586
		divisor = uart_getreg(bas, REG_DLL) |
		    (uart_getreg(bas, REG_DLH) << 8);
587
588
589
		uart_barrier(bas);
		uart_setreg(bas, REG_LCR, lcr);
		uart_barrier(bas);
590
591
592
593
594
		baudrate = (divisor > 0) ? bas->rclk / divisor / 16 : 0;
		if (baudrate > 0)
			*(int*)data = baudrate;
		else
			error = ENXIO;
595
		break;
596
	default:
597
598
		error = EINVAL;
		break;
599
	}
Marcel Moolenaar's avatar
Marcel Moolenaar committed
600
	uart_unlock(sc->sc_hwmtx);
601
	return (error);
602
603
}

604
int
605
606
607
ns8250_bus_ipend(struct uart_softc *sc)
{
	struct uart_bas *bas;
608
	struct ns8250_softc *ns8250;
609
610
611
	int ipend;
	uint8_t iir, lsr;

612
	ns8250 = (struct ns8250_softc *)sc;
613
	bas = &sc->sc_bas;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
614
	uart_lock(sc->sc_hwmtx);
615
	iir = uart_getreg(bas, REG_IIR);
616
617
618
619
620
621

	if (ns8250->busy_detect && (iir & IIR_BUSY) == IIR_BUSY) {
		(void)uart_getreg(bas, DW_REG_USR);
		uart_unlock(sc->sc_hwmtx);
		return (0);
	}
622
	if (iir & IIR_NOPEND) {
Marcel Moolenaar's avatar
Marcel Moolenaar committed
623
		uart_unlock(sc->sc_hwmtx);
624
		return (0);
625
	}
626
627
628
629
	ipend = 0;
	if (iir & IIR_RXRDY) {
		lsr = uart_getreg(bas, REG_LSR);
		if (lsr & LSR_OE)
Marcel Moolenaar's avatar
MFp4:    
Marcel Moolenaar committed
630
			ipend |= SER_INT_OVERRUN;
631
		if (lsr & LSR_BI)
Marcel Moolenaar's avatar
MFp4:    
Marcel Moolenaar committed
632
			ipend |= SER_INT_BREAK;
633
		if (lsr & LSR_RXRDY)
Marcel Moolenaar's avatar
MFp4:    
Marcel Moolenaar committed
634
			ipend |= SER_INT_RXREADY;
635
	} else {
636
		if (iir & IIR_TXRDY) {
Marcel Moolenaar's avatar
MFp4:    
Marcel Moolenaar committed
637
			ipend |= SER_INT_TXIDLE;
638
639
			uart_setreg(bas, REG_IER, ns8250->ier);
		} else
Marcel Moolenaar's avatar
MFp4:    
Marcel Moolenaar committed
640
			ipend |= SER_INT_SIGCHG;
641
	}
642
643
644
	if (ipend == 0)
		ns8250_clrint(bas);
	uart_unlock(sc->sc_hwmtx);
645
	return (ipend);
646
647
}

648
int
649
650
651
ns8250_bus_param(struct uart_softc *sc, int baudrate, int databits,
    int stopbits, int parity)
{
652
	struct ns8250_softc *ns8250;
653
	struct uart_bas *bas;
654
	int error, limit;
655

656
	ns8250 = (struct ns8250_softc*)sc;
657
	bas = &sc->sc_bas;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
658
	uart_lock(sc->sc_hwmtx);
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
	/*
	 * When using DW UART with BUSY detection it is necessary to wait
	 * until all serial transfers are finished before manipulating the
	 * line control. LCR will not be affected when UART is busy.
	 */
	if (ns8250->busy_detect != 0) {
		/*
		 * Pick an arbitrary high limit to avoid getting stuck in
		 * an infinite loop in case when the hardware is broken.
		 */
		limit = 10 * 1024;
		while (((uart_getreg(bas, DW_REG_USR) & USR_BUSY) != 0) &&
		    --limit)
			DELAY(4);

		if (limit <= 0) {
			/* UART appears to be stuck */
			uart_unlock(sc->sc_hwmtx);
			return (EIO);
		}
	}

681
	error = ns8250_param(bas, baudrate, databits, stopbits, parity);
Marcel Moolenaar's avatar
Marcel Moolenaar committed
682
	uart_unlock(sc->sc_hwmtx);
683
	return (error);
684
685
}

686
int
687
688
ns8250_bus_probe(struct uart_softc *sc)
{
689
	struct ns8250_softc *ns8250;
690
691
	struct uart_bas *bas;
	int count, delay, error, limit;
692
	uint8_t lsr, mcr, ier;
693

694
	ns8250 = (struct ns8250_softc *)sc;
695
696
697
698
699
700
701
702
703
	bas = &sc->sc_bas;

	error = ns8250_probe(bas);
	if (error)
		return (error);

	mcr = MCR_IE;
	if (sc->sc_sysdev == NULL) {
		/* By using ns8250_init() we also set DTR and RTS. */
704
		ns8250_init(bas, 115200, 8, 1, UART_PARITY_NONE);
705
706
707
708
709
710
711
712
713
714
715
	} else
		mcr |= MCR_DTR | MCR_RTS;

	error = ns8250_drain(bas, UART_DRAIN_TRANSMITTER);
	if (error)
		return (error);

	/*
	 * Set loopback mode. This avoids having garbage on the wire and
	 * also allows us send and receive data. We set DTR and RTS to
	 * avoid the possibility that automatic flow-control prevents
716
	 * any data from being sent.
717
	 */
718
	uart_setreg(bas, REG_MCR, MCR_LOOPBACK | MCR_IE | MCR_DTR | MCR_RTS);
719
720
721
722
	uart_barrier(bas);

	/*
	 * Enable FIFOs. And check that the UART has them. If not, we're
723
724
	 * done. Since this is the first time we enable the FIFOs, we reset
	 * them.
725
726
727
	 */
	uart_setreg(bas, REG_FCR, FCR_ENABLE);
	uart_barrier(bas);
728
	if (!(uart_getreg(bas, REG_IIR) & IIR_FIFO_MASK)) {
729
730
731
732
733
734
		/*
		 * NS16450 or INS8250. We don't bother to differentiate
		 * between them. They're too old to be interesting.
		 */
		uart_setreg(bas, REG_MCR, mcr);
		uart_barrier(bas);
735
		sc->sc_rxfifosz = sc->sc_txfifosz = 1;
736
737
738
739
		device_set_desc(sc->sc_dev, "8250 or 16450 or compatible");
		return (0);
	}

740
	uart_setreg(bas, REG_FCR, FCR_ENABLE | FCR_XMT_RST | FCR_RCV_RST);
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
	uart_barrier(bas);

	count = 0;
	delay = ns8250_delay(bas);

	/* We have FIFOs. Drain the transmitter and receiver. */
	error = ns8250_drain(bas, UART_DRAIN_RECEIVER|UART_DRAIN_TRANSMITTER);
	if (error) {
		uart_setreg(bas, REG_MCR, mcr);
		uart_setreg(bas, REG_FCR, 0);
		uart_barrier(bas);
		goto describe;
	}

	/*
	 * We should have a sufficiently clean "pipe" to determine the
	 * size of the FIFOs. We send as much characters as is reasonable
758
	 * and wait for the overflow bit in the LSR register to be
759
760
	 * asserted, counting the characters as we send them. Based on
	 * that count we know the FIFO size.
761
	 */
762
	do {
763
764
765
766
767
		uart_setreg(bas, REG_DATA, 0);
		uart_barrier(bas);
		count++;

		limit = 30;
768
769
770
771
772
773
774
		lsr = 0;
		/*
		 * LSR bits are cleared upon read, so we must accumulate
		 * them to be able to test LSR_OE below.
		 */
		while (((lsr |= uart_getreg(bas, REG_LSR)) & LSR_TEMT) == 0 &&
		    --limit)
775
776
			DELAY(delay);
		if (limit == 0) {
777
			ier = uart_getreg(bas, REG_IER) & ns8250->ier_mask;
778
			uart_setreg(bas, REG_IER, ier);
779
780
781
782
783
784
			uart_setreg(bas, REG_MCR, mcr);
			uart_setreg(bas, REG_FCR, 0);
			uart_barrier(bas);
			count = 0;
			goto describe;
		}
785
	} while ((lsr & LSR_OE) == 0 && count < 130);
786
	count--;
787
788
789
790
791
792
793

	uart_setreg(bas, REG_MCR, mcr);

	/* Reset FIFOs. */
	ns8250_flush(bas, UART_FLUSH_RECEIVER|UART_FLUSH_TRANSMITTER);

 describe:
794
	if (count >= 14 && count <= 16) {
795
796
		sc->sc_rxfifosz = 16;
		device_set_desc(sc->sc_dev, "16550 or compatible");
797
	} else if (count >= 28 && count <= 32) {
798
799
		sc->sc_rxfifosz = 32;
		device_set_desc(sc->sc_dev, "16650 or compatible");
800
	} else if (count >= 56 && count <= 64) {
801
802
		sc->sc_rxfifosz = 64;
		device_set_desc(sc->sc_dev, "16750 or compatible");
803
	} else if (count >= 112 && count <= 128) {
804
805
806
		sc->sc_rxfifosz = 128;
		device_set_desc(sc->sc_dev, "16950 or compatible");
	} else {
807
		sc->sc_rxfifosz = 16;
808
809
810
811
812
813
814
815
816
817
818
		device_set_desc(sc->sc_dev,
		    "Non-standard ns8250 class UART with FIFOs");
	}

	/*
	 * Force the Tx FIFO size to 16 bytes for now. We don't program the
	 * Tx trigger. Also, we assume that all data has been sent when the
	 * interrupt happens.
	 */
	sc->sc_txfifosz = 16;

819
820
821
822
823
824
825
#if 0
	/*
	 * XXX there are some issues related to hardware flow control and
	 * it's likely that uart(4) is the cause. This basicly needs more
	 * investigation, but we avoid using for hardware flow control
	 * until then.
	 */
826
827
828
829
830
	/* 16650s or higher have automatic flow control. */
	if (sc->sc_rxfifosz > 16) {
		sc->sc_hwiflow = 1;
		sc->sc_hwoflow = 1;
	}
831
#endif
832

833
834
835
	return (0);
}

836
int
837
838
839
840
841
842
843
ns8250_bus_receive(struct uart_softc *sc)
{
	struct uart_bas *bas;
	int xc;
	uint8_t lsr;

	bas = &sc->sc_bas;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
844
	uart_lock(sc->sc_hwmtx);
845
846
847
848
	lsr = uart_getreg(bas, REG_LSR);
	while (lsr & LSR_RXRDY) {
		if (uart_rx_full(sc)) {
			sc->sc_rxbuf[sc->sc_rxput] = UART_STAT_OVERRUN;
849
			break;
850
		}
851
852
853
854
855
856
		xc = uart_getreg(bas, REG_DATA);
		if (lsr & LSR_FE)
			xc |= UART_STAT_FRAMERR;
		if (lsr & LSR_PE)
			xc |= UART_STAT_PARERR;
		uart_rx_put(sc, xc);
857
858
859
860
861
862
863
		lsr = uart_getreg(bas, REG_LSR);
	}
	/* Discard everything left in the Rx FIFO. */
	while (lsr & LSR_RXRDY) {
		(void)uart_getreg(bas, REG_DATA);
		uart_barrier(bas);
		lsr = uart_getreg(bas, REG_LSR);
864
	}
Marcel Moolenaar's avatar
Marcel Moolenaar committed
865
	uart_unlock(sc->sc_hwmtx);
866
867
868
 	return (0);
}

869
int
870
871
872
873
874
875
876
877
878
879
ns8250_bus_setsig(struct uart_softc *sc, int sig)
{
	struct ns8250_softc *ns8250 = (struct ns8250_softc*)sc;
	struct uart_bas *bas;
	uint32_t new, old;

	bas = &sc->sc_bas;
	do {
		old = sc->sc_hwsig;
		new = old;
880
881
882
		if (sig & SER_DDTR) {
			SIGCHG(sig & SER_DTR, new, SER_DTR,
			    SER_DDTR);
883
		}
884
885
886
		if (sig & SER_DRTS) {
			SIGCHG(sig & SER_RTS, new, SER_RTS,
			    SER_DRTS);
887
888
		}
	} while (!atomic_cmpset_32(&sc->sc_hwsig, old, new));
Marcel Moolenaar's avatar
Marcel Moolenaar committed
889
	uart_lock(sc->sc_hwmtx);
890
	ns8250->mcr &= ~(MCR_DTR|MCR_RTS);
891
	if (new & SER_DTR)
892
		ns8250->mcr |= MCR_DTR;
893
	if (new & SER_RTS)
894
895
896
		ns8250->mcr |= MCR_RTS;
	uart_setreg(bas, REG_MCR, ns8250->mcr);
	uart_barrier(bas);
Marcel Moolenaar's avatar
Marcel Moolenaar committed
897
	uart_unlock(sc->sc_hwmtx);
898
899
900
	return (0);
}

901
int
902
903
904
905
906
907
908
ns8250_bus_transmit(struct uart_softc *sc)
{
	struct ns8250_softc *ns8250 = (struct ns8250_softc*)sc;
	struct uart_bas *bas;
	int i;

	bas = &sc->sc_bas;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
909
	uart_lock(sc->sc_hwmtx);
910
911
912
913
914
915
916
917
	while ((uart_getreg(bas, REG_LSR) & LSR_THRE) == 0)
		;
	uart_setreg(bas, REG_IER, ns8250->ier | IER_ETXRDY);
	uart_barrier(bas);
	for (i = 0; i < sc->sc_txdatasz; i++) {
		uart_setreg(bas, REG_DATA, sc->sc_txbuf[i]);
		uart_barrier(bas);
	}
918
919
920
921
	if (broken_txfifo)
		ns8250_drain(bas, UART_DRAIN_TRANSMITTER);
	else
		sc->sc_txbusy = 1;
Marcel Moolenaar's avatar
Marcel Moolenaar committed
922
	uart_unlock(sc->sc_hwmtx);
923
924
	if (broken_txfifo)
		uart_sched_softih(sc, SER_INT_TXIDLE);
925
926
	return (0);
}
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957

void
ns8250_bus_grab(struct uart_softc *sc)
{
	struct uart_bas *bas = &sc->sc_bas;

	/*
	 * turn off all interrupts to enter polling mode. Leave the
	 * saved mask alone. We'll restore whatever it was in ungrab.
	 * All pending interupt signals are reset when IER is set to 0.
	 */
	uart_lock(sc->sc_hwmtx);
	uart_setreg(bas, REG_IER, 0);
	uart_barrier(bas);
	uart_unlock(sc->sc_hwmtx);
}

void
ns8250_bus_ungrab(struct uart_softc *sc)
{
	struct ns8250_softc *ns8250 = (struct ns8250_softc*)sc;
	struct uart_bas *bas = &sc->sc_bas;

	/*
	 * Restore previous interrupt mask
	 */
	uart_lock(sc->sc_hwmtx);
	uart_setreg(bas, REG_IER, ns8250->ier);
	uart_barrier(bas);
	uart_unlock(sc->sc_hwmtx);
}