share/man/man4/uart.4

   1 .\"
   2 .\" Copyright (c) 2003 Marcel Moolenaar
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd December 9, 2015
  29 .Dt UART 4
  30 .Os
  31 .Sh NAME
  32 .Nm uart
  33 .Nd driver for Universal Asynchronous Receiver/Transmitter (UART) devices
  34 .Sh SYNOPSIS
  35 .Cd "device uart"
  36 .Pp
  37 .Cd "device puc"
  38 .Cd "device uart"
  39 .Pp
  40 .Cd "device scc"
  41 .Cd "device uart"
  42 .Pp
  43 In
  44 .Pa /boot/device.hints :
  45 .Cd hint.uart.0.disabled="1"
  46 .Cd hint.uart.0.baud="38400"
  47 .Cd hint.uart.0.port="0x3f8"
  48 .Cd hint.uart.0.flags="0x10"
  49 .Pp
  50 With
  51 .Ar flags
  52 encoded as:
  53 .Bl -tag -compact -width 0x000000
  54 .It 0x00010
  55 device is potential system console
  56 .It 0x00080
  57 use this port for remote kernel debugging
  58 .It 0x00100
  59 set RX FIFO trigger level to ``low'' (NS8250 only)
  60 .It 0x00200
  61 set RX FIFO trigger level to ``medium low'' (NS8250 only)
  62 .It 0x00400
  63 set RX FIFO trigger level to ``medium high'' (default, NS8250 only)
  64 .It 0x00800
  65 set RX FIFO trigger level to ``high'' (NS8250 only)
  66 .El
  67 .\"
  68 .Sh DESCRIPTION
  69 The
  70 .Nm
  71 device driver provides support for various classes of UARTs implementing the
  72 EIA RS-232C (CCITT V.24) serial communications interface.
  73 Each such interface is controlled by a separate and independent instance of
  74 the
  75 .Nm
  76 driver.
  77 The primary support for devices that contain multiple serial interfaces or
  78 that contain other functionality besides one or more serial interfaces is
  79 provided by the
  80 .Xr puc 4 ,
  81 or
  82 .Xr scc 4
  83 device drivers.
  84 However, the serial interfaces of those devices that are managed by the
  85 .Xr puc 4 ,
  86 or
  87 .Xr scc 4
  88 driver are each independently controlled by the
  89 .Nm
  90 driver.
  91 As such, the
  92 .Xr puc 4 ,
  93 or
  94 .Xr scc 4
  95 driver provides umbrella functionality for the
  96 .Nm
  97 driver and hides the complexities that are inherent when elementary components
  98 are packaged together.
  99 .Pp
 100 The
 101 .Nm
 102 driver has a modular design to allow it to be used on differing hardware and
 103 for various purposes.
 104 In the following sections the components are discussed in detail.
 105 Options are described in the section that covers the component to which each
 106 option applies.
 107 .\"
 108 .Ss CORE COMPONENT
 109 At the heart of the
 110 .Nm
 111 driver is the core component.
 112 It contains the bus attachments and the low-level interrupt handler.
 113 .\"
 114 .Ss HARDWARE DRIVERS
 115 The core component and the kernel interfaces talk to the hardware through the
 116 hardware interface.
 117 This interface serves as an abstraction of the hardware and allows varying
 118 UARTs to be used for serial communications.
 119 .\"
 120 .Ss SYSTEM DEVICES
 121 System devices are UARTs that have a special purpose by way of hardware
 122 design or software setup.
 123 For example, Sun UltraSparc machines use UARTs as their keyboard interface.
 124 Such an UART cannot be used for general purpose communications.
 125 Likewise, when the kernel is configured for a serial console, the
 126 corresponding UART will in turn be a system device so that the kernel can
 127 output boot messages early on in the boot process.
 128 .\"
 129 .Ss KERNEL INTERFACES
 130 The last but not least of the components is the kernel interface.
 131 This component ultimately determines how the UART is made visible to the
 132 kernel in particular and to users in general.
 133 The default kernel interface is the TTY interface.
 134 This allows the UART to be used for terminals, modems and serial line IP
 135 applications.
 136 System devices, with the notable exception of serial consoles, generally
 137 have specialized kernel interfaces.
 138 .\"
 139 .Sh HARDWARE
 140 The
 141 .Nm
 142 driver supports the following classes of UARTs:
 143 .Pp
 144 .Bl -bullet -compact
 145 .It
 146 NS8250: standard hardware based on the 8250, 16450, 16550, 16650, 16750 or
 147 the 16950 UARTs.
 148 .It
 149 SCC: serial communications controllers supported by the
 150 .Xr scc 4
 151 device driver.
 152 .El
 153 .\"
 154 .Sh Pulse Per Second (PPS) Timing Interface
 155 The
 156 .Nm
 157 driver can capture PPS timing information as defined in RFC 2783.
 158 The API, accessed via
 159 .Xr ioctl 8 ,
 160 is available on the tty device.
 161 To use the PPS capture feature with
 162 .Xr ntpd 8 ,
 163 symlink the tty callout device
 164 .Va /dev/cuau?
 165 to
 166 .Va /dev/pps0.
 167 .Pp
 168 The
 169 .Va hw.uart.pps_mode
 170 tunable configures the PPS capture mode for all uart devices;
 171 it can be set in
 172 .Xr loader.conf 5 .
 173 The
 174 .Va dev.uart.0.pps_mode
 175 sysctl configures the PPS capture mode for a specific uart device;
 176 it can be set in
 177 .Xr loader.conf 5
 178 or
 179 .Xr sysctl.conf 5 .
 180 .Pp
 181 The following capture modes are available:
 182 .Bl -tag -compact -offset "mmmm" -width "mmmm"
 183 .It 0x00
 184 Capture disabled.
 185 .It 0x01
 186 Capture pulses on the CTS line.
 187 .It 0x02
 188 Capture pulses on the DCD line.
 189 .El
 190 .Pp
 191 The following values may be ORed with the capture mode to configure
 192 capture processing options:
 193 .Bl -tag -compact -offset "mmmm" -width "mmmm"
 194 .It 0x10
 195 Invert the pulse (RS-232 logic low = ASSERT, high = CLEAR).
 196 .It 0x20
 197 Attempt to capture narrow pulses.
 198 .El
 199 .Pp
 200 Add the narrow pulse option when the incoming PPS pulse width is small
 201 enough to prevent reliable capture in normal mode.
 202 In narrow mode the driver uses the hardware's ability to latch a line
 203 state change; not all hardware has this capability.
 204 The hardware latch provides a reliable indication that a pulse occurred,
 205 but prevents distinguishing between the CLEAR and ASSERT edges of the pulse.
 206 For each detected pulse, the driver synthesizes both an ASSERT and a CLEAR
 207 event, using the same timestamp for each.
 208 To prevent spurious events when the hardware is intermittently able to
 209 see both edges of a pulse, the driver will not generate a new pair of
 210 events within a half second of the prior pair.
 211 Both normal and narrow pulse modes work with
 212 .Xr ntpd 8 .
 213 .Pp
 214 Add the invert option when the connection to the uart device uses TTL
 215 level signals, or when the PPS source emits inverted pulses.
 216 RFC 2783 defines an ASSERT event as a higher-voltage line level, and a CLEAR
 217 event as a lower-voltage line level, in the context of the RS-232 protocol.
 218 The modem control signals on a TTL-level connection are typically
 219 inverted from the RS-232 levels.
 220 For example, carrier presence is indicated by a high signal on an RS-232
 221 DCD line, and by a low signal on a TTL DCD line.
 222 This is due to the use of inverting line driver buffers to convert between
 223 TTL and RS-232 line levels in most hardware designs.
 224 Generally speaking, a connection to a DB-9 style connector is an RS-232
 225 level signal at up to 12 volts.
 226 A connection to header pins or an edge-connector on an embedded board
 227 is typically a TTL signal at 3.3 or 5 volts.
 228 .Sh FILES
 229 .Bl -tag -width ".Pa /dev/ttyu?.init" -compact
 230 .It Pa /dev/ttyu?
 231 for callin ports
 232 .It Pa /dev/ttyu?.init
 233 .It Pa /dev/ttyu?.lock
 234 corresponding callin initial-state and lock-state devices
 235 .Pp
 236 .It Pa /dev/cuau?
 237 for callout ports
 238 .It Pa /dev/cuau?.init
 239 .It Pa /dev/cuau?.lock
 240 corresponding callout initial-state and lock-state devices
 241 .El
 242 .Sh SEE ALSO
 243 .Xr puc 4 ,
 244 .Xr scc 4
 245 .\"
 246 .Sh HISTORY
 247 The
 248 .Nm
 249 device driver first appeared in
 250 .Fx 5.2 .
 251 .Sh AUTHORS
 252 The
 253 .Nm
 254 device driver and this manual page were written by
 255 .An Marcel Moolenaar Aq marcel@xcllnt.net .