2005-01-06 01:43:34 +00:00
|
|
|
/*-
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
* 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.
|
|
|
|
|
*
|
|
|
|
|
* $FreeBSD$
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
#ifndef _DEV_UART_BUS_H_
|
|
|
|
|
#define _DEV_UART_BUS_H_
|
|
|
|
|
|
2003-09-11 23:06:42 +00:00
|
|
|
#ifndef KLD_MODULE
|
|
|
|
|
#include "opt_uart.h"
|
|
|
|
|
#endif
|
|
|
|
|
|
2004-06-24 10:07:28 +00:00
|
|
|
#include <sys/serial.h>
|
2003-09-11 23:06:42 +00:00
|
|
|
#include <sys/timepps.h>
|
|
|
|
|
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
/* Drain and flush targets. */
|
|
|
|
|
#define UART_DRAIN_RECEIVER 0x0001
|
|
|
|
|
#define UART_DRAIN_TRANSMITTER 0x0002
|
|
|
|
|
#define UART_FLUSH_RECEIVER UART_DRAIN_RECEIVER
|
|
|
|
|
#define UART_FLUSH_TRANSMITTER UART_DRAIN_TRANSMITTER
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Interrupt sources (in priority order). See also uart_core.c
|
|
|
|
|
* Note that the low order 16 bits are used to pass modem signals
|
|
|
|
|
* from the hardware interrupt handler to the software interrupt
|
2004-06-24 10:07:28 +00:00
|
|
|
* handler.
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
*/
|
|
|
|
|
#define UART_IPEND_OVERRUN 0x010000
|
|
|
|
|
#define UART_IPEND_BREAK 0x020000
|
|
|
|
|
#define UART_IPEND_RXREADY 0x040000
|
|
|
|
|
#define UART_IPEND_SIGCHG 0x080000
|
|
|
|
|
#define UART_IPEND_TXIDLE 0x100000
|
|
|
|
|
|
|
|
|
|
#define UART_IPEND_MASK 0x1f0000
|
|
|
|
|
#define UART_IPEND_SIGMASK 0x00ffff
|
|
|
|
|
|
|
|
|
|
/* Received character status bits. */
|
|
|
|
|
#define UART_STAT_BREAK 0x0100
|
|
|
|
|
#define UART_STAT_FRAMERR 0x0200
|
|
|
|
|
#define UART_STAT_OVERRUN 0x0400
|
|
|
|
|
#define UART_STAT_PARERR 0x0800
|
|
|
|
|
|
2004-06-24 10:07:28 +00:00
|
|
|
#define UART_SIGMASK_DTE (SER_DTR | SER_RTS)
|
|
|
|
|
#define UART_SIGMASK_DCE (SER_DSR | SER_CTS | SER_DCD | SER_RI)
|
|
|
|
|
#define UART_SIGMASK_STATE (UART_SIGMASK_DTE | UART_SIGMASK_DCE)
|
|
|
|
|
#define UART_SIGMASK_DELTA (UART_SIGMASK_STATE << 8)
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
|
2003-09-11 23:06:42 +00:00
|
|
|
#ifdef UART_PPS_ON_CTS
|
2004-06-24 10:07:28 +00:00
|
|
|
#define UART_SIG_DPPS SER_DCTS
|
|
|
|
|
#define UART_SIG_PPS SER_CTS
|
2003-09-11 23:06:42 +00:00
|
|
|
#else
|
2004-06-24 10:07:28 +00:00
|
|
|
#define UART_SIG_DPPS SER_DDCD
|
|
|
|
|
#define UART_SIG_PPS SER_DCD
|
2003-09-11 23:06:42 +00:00
|
|
|
#endif
|
|
|
|
|
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
/* UART_IOCTL() requests */
|
|
|
|
|
#define UART_IOCTL_BREAK 1
|
|
|
|
|
#define UART_IOCTL_IFLOW 2
|
|
|
|
|
#define UART_IOCTL_OFLOW 3
|
2004-11-14 23:12:14 +00:00
|
|
|
#define UART_IOCTL_BAUD 4
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* UART class & instance (=softc)
|
|
|
|
|
*/
|
|
|
|
|
struct uart_class {
|
|
|
|
|
KOBJ_CLASS_FIELDS;
|
|
|
|
|
u_int uc_range; /* Bus space address range. */
|
|
|
|
|
u_int uc_rclk; /* Default rclk for this device. */
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
extern struct uart_class uart_ns8250_class;
|
|
|
|
|
extern struct uart_class uart_sab82532_class;
|
|
|
|
|
extern struct uart_class uart_z8530_class;
|
|
|
|
|
|
|
|
|
|
struct uart_softc {
|
|
|
|
|
KOBJ_FIELDS;
|
|
|
|
|
struct uart_class *sc_class;
|
|
|
|
|
struct uart_bas sc_bas;
|
|
|
|
|
device_t sc_dev;
|
|
|
|
|
|
2003-09-17 01:41:21 +00:00
|
|
|
struct mtx sc_hwmtx; /* Spinlock protecting hardware. */
|
|
|
|
|
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
struct resource *sc_rres; /* Register resource. */
|
|
|
|
|
int sc_rrid;
|
|
|
|
|
int sc_rtype; /* SYS_RES_{IOPORT|MEMORY}. */
|
|
|
|
|
struct resource *sc_ires; /* Interrupt resource. */
|
|
|
|
|
void *sc_icookie;
|
|
|
|
|
int sc_irid;
|
|
|
|
|
|
|
|
|
|
int sc_callout:1; /* This UART is opened for callout. */
|
|
|
|
|
int sc_fastintr:1; /* This UART uses fast interrupts. */
|
|
|
|
|
int sc_hasfifo:1; /* This UART has FIFOs. */
|
|
|
|
|
int sc_hwiflow:1; /* This UART has HW input flow ctl. */
|
|
|
|
|
int sc_hwoflow:1; /* This UART has HW output flow ctl. */
|
|
|
|
|
int sc_leaving:1; /* This UART is going away. */
|
|
|
|
|
int sc_opened:1; /* This UART is open for business. */
|
|
|
|
|
int sc_polled:1; /* This UART has no interrupts. */
|
|
|
|
|
int sc_txbusy:1; /* This UART is transmitting. */
|
|
|
|
|
|
|
|
|
|
struct uart_devinfo *sc_sysdev; /* System device (or NULL). */
|
|
|
|
|
|
|
|
|
|
int sc_altbrk; /* State for alt break sequence. */
|
|
|
|
|
uint32_t sc_hwsig; /* Signal state. Used by HW driver. */
|
|
|
|
|
|
|
|
|
|
/* Receiver data. */
|
|
|
|
|
uint16_t *sc_rxbuf;
|
|
|
|
|
int sc_rxbufsz;
|
|
|
|
|
int sc_rxput;
|
|
|
|
|
int sc_rxget;
|
|
|
|
|
int sc_rxfifosz; /* Size of RX FIFO. */
|
|
|
|
|
|
|
|
|
|
/* Transmitter data. */
|
|
|
|
|
uint8_t *sc_txbuf;
|
|
|
|
|
int sc_txdatasz;
|
|
|
|
|
int sc_txfifosz; /* Size of TX FIFO and buffer. */
|
|
|
|
|
|
2003-09-11 23:06:42 +00:00
|
|
|
/* Pulse capturing support (PPS). */
|
|
|
|
|
struct pps_state sc_pps;
|
|
|
|
|
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
/* Upper layer data. */
|
|
|
|
|
void *sc_softih;
|
|
|
|
|
uint32_t sc_ttypend;
|
|
|
|
|
union {
|
|
|
|
|
/* TTY specific data. */
|
|
|
|
|
struct {
|
|
|
|
|
struct tty *tp;
|
|
|
|
|
} u_tty;
|
|
|
|
|
/* Keyboard specific data. */
|
|
|
|
|
struct {
|
|
|
|
|
} u_kbd;
|
|
|
|
|
} sc_u;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
extern devclass_t uart_devclass;
|
|
|
|
|
extern char uart_driver_name[];
|
|
|
|
|
|
|
|
|
|
int uart_bus_attach(device_t dev);
|
|
|
|
|
int uart_bus_detach(device_t dev);
|
2003-09-26 05:14:56 +00:00
|
|
|
int uart_bus_probe(device_t dev, int regshft, int rclk, int rid, int chan);
|
The uart(4) driver is an universal driver for various UART hardware.
It improves on sio(4) in the following areas:
o Fully newbusified to allow for memory mapped I/O. This is a must
for ia64 and sparc64,
o Machine dependent code to take full advantage of machine and firm-
ware specific ways to define serial consoles and/or debug ports.
o Hardware abstraction layer to allow the driver to be used with
various UARTs, such as the well-known ns8250 family of UARTs, the
Siemens sab82532 or the Zilog Z8530. This is especially important
for pc98 and sparc64 where it's common to have different UARTs,
o The notion of system devices to unkludge low-level consoles and
remote gdb ports and provides the mechanics necessary to support
the keyboard on sparc64 (which is UART based).
o The notion of a kernel interface so that a UART can be tied to
something other than the well-known TTY interface. This is needed
on sparc64 to present the user with a device and ioctl handling
suitable for a keyboard, but also allows us to cleanly hide an
UART when used as a debug port.
Following is a list of features and bugs/flaws specific to the ns8250
family of UARTs as compared to their support in sio(4):
o The uart(4) driver determines the FIFO size and automaticly takes
advantages of larger FIFOs and/or additional features. Note that
since I don't have sufficient access to 16[679]5x UARTs, hardware
flow control has not been enabled. This is almost trivial to do,
provided one can test. The downside of this is that broken UARTs
are more likely to not work correctly with uart(4). The need for
tunables or knobs may be large enough to warrant their creation.
o The uart(4) driver does not share the same bumpy history as sio(4)
and will therefore not provide the necessary hooks, tweaks, quirks
or work-arounds to deal with once common hardware. To that extend,
uart(4) supports a subset of the UARTs that sio(4) supports. The
question before us is whether the subset is sufficient for current
hardware.
o There is no support for multiport UARTs in uart(4). The decision
behind this is that uart(4) deals with one EIA RS232-C interface.
Packaging of multiple interfaces in a single chip or on a single
expansion board is beyond the scope of uart(4) and is now mostly
left for puc(4) to deal with. Lack of hardware made it impossible
to actually implement such a dependency other than is present for
the dual channel SAB82532 and Z8350 SCCs.
The current list of missing features is:
o No configuration capabilities. A set of tunables and sysctls is
being worked out. There are likely not going to be any or much
compile-time knobs. Such configuration does not fit well with
current hardware.
o No support for the PPS API. This is partly dependent on the
ability to configure uart(4) and partly dependent on having
sufficient information to implement it properly.
As usual, the manpage is present but lacks the attention the
software has gotten.
2003-09-06 23:13:47 +00:00
|
|
|
|
|
|
|
|
int uart_tty_attach(struct uart_softc *);
|
|
|
|
|
int uart_tty_detach(struct uart_softc *);
|
|
|
|
|
void uart_tty_intr(void *arg);
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Receive buffer operations.
|
|
|
|
|
*/
|
|
|
|
|
static __inline int
|
|
|
|
|
uart_rx_empty(struct uart_softc *sc)
|
|
|
|
|
{
|
|
|
|
|
return ((sc->sc_rxget == sc->sc_rxput) ? 1 : 0);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static __inline int
|
|
|
|
|
uart_rx_full(struct uart_softc *sc)
|
|
|
|
|
{
|
|
|
|
|
return ((sc->sc_rxput + 1 < sc->sc_rxbufsz)
|
|
|
|
|
? (sc->sc_rxput + 1 == sc->sc_rxget) : (sc->sc_rxget == 0));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static __inline int
|
|
|
|
|
uart_rx_get(struct uart_softc *sc)
|
|
|
|
|
{
|
|
|
|
|
int ptr, xc;
|
|
|
|
|
|
|
|
|
|
ptr = sc->sc_rxget;
|
|
|
|
|
if (ptr == sc->sc_rxput)
|
|
|
|
|
return (-1);
|
|
|
|
|
xc = sc->sc_rxbuf[ptr++];
|
|
|
|
|
sc->sc_rxget = (ptr < sc->sc_rxbufsz) ? ptr : 0;
|
|
|
|
|
return (xc);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static __inline int
|
|
|
|
|
uart_rx_put(struct uart_softc *sc, int xc)
|
|
|
|
|
{
|
|
|
|
|
int ptr;
|
|
|
|
|
|
|
|
|
|
ptr = (sc->sc_rxput + 1 < sc->sc_rxbufsz) ? sc->sc_rxput + 1 : 0;
|
|
|
|
|
if (ptr == sc->sc_rxget)
|
|
|
|
|
return (ENOSPC);
|
|
|
|
|
sc->sc_rxbuf[sc->sc_rxput] = xc;
|
|
|
|
|
sc->sc_rxput = ptr;
|
|
|
|
|
return (0);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#endif /* _DEV_UART_BUS_H_ */
|
