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 March 12, 2008
  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 .Ed
  50 .Pp
  51 With
  52 .Ar flags
  53 encoded as:
  54 .Bl -tag -compact -width 0x000000
  55 .It 0x00010
  56 device is potential system console
  57 .It 0x00080
  58 use this port for remote kernel debugging
  59 .It 0x00100
  60 set RX FIFO trigger level to ``low'' (NS8250 only)
  61 .It 0x00200
  62 set RX FIFO trigger level to ``medium low'' (NS8250 only)
  63 .It 0x00400
  64 set RX FIFO trigger level to ``medium high'' (default, NS8250 only)
  65 .It 0x00800
  66 set RX FIFO trigger level to ``high'' (NS8250 only)
  67 .El
  68 .\"
  69 .Sh DESCRIPTION
  70 The
  71 .Nm
  72 device driver provides support for various classes of UARTs implementing the
  73 EIA RS-232C (CCITT V.24) serial communications interface.
  74 Each such interface is controlled by a separate and independent instance of
  75 the
  76 .Nm
  77 driver.
  78 The primary support for devices that contain multiple serial interfaces or
  79 that contain other functionality besides one or more serial interfaces is
  80 provided by the
  81 .Xr puc 4 ,
  82 or
  83 .Xr scc 4
  84 device drivers.
  85 However, the serial interfaces of those devices that are managed by the
  86 .Xr puc 4 ,
  87 or
  88 .Xr scc 4
  89 driver are each independently controlled by the
  90 .Nm
  91 driver.
  92 As such, the
  93 .Xr puc 4 ,
  94 or
  95 .Xr scc 4
  96 driver provides umbrella functionality for the
  97 .Nm
  98 driver and hides the complexities that are inherent when elementary components
  99 are packaged together.
 100 .Pp
 101 The
 102 .Nm
 103 driver has a modular design to allow it to be used on differing hardware and
 104 for various purposes.
 105 In the following sections the components are discussed in detail.
 106 Options are described in the section that covers the component to which each
 107 option applies.
 108 .\"
 109 .Ss CORE COMPONENT
 110 At the heart of the
 111 .Nm
 112 driver is the core component.
 113 It contains the bus attachments and the low-level interrupt handler.
 114 .\"
 115 .Ss HARDWARE DRIVERS
 116 The core component and the kernel interfaces talk to the hardware through the
 117 hardware interface.
 118 This interface serves as an abstraction of the hardware and allows varying
 119 UARTs to be used for serial communications.
 120 .\"
 121 .Ss SYSTEM DEVICES
 122 System devices are UARTs that have a special purpose by way of hardware
 123 design or software setup.
 124 For example, Sun UltraSparc machines use UARTs as their keyboard interface.
 125 Such an UART cannot be used for general purpose communications.
 126 Likewise, when the kernel is configured for a serial console, the
 127 corresponding UART will in turn be a system device so that the kernel can
 128 output boot messages early on in the boot process.
 129 .\"
 130 .Ss KERNEL INTERFACES
 131 The last but not least of the components is the kernel interface.
 132 This component ultimately determines how the UART is made visible to the
 133 kernel in particular and to users in general.
 134 The default kernel interface is the TTY interface.
 135 This allows the UART to be used for terminals, modems and serial line IP
 136 applications.
 137 System devices, with the notable exception of serial consoles, generally
 138 have specialized kernel interfaces.
 139 .\"
 140 .Sh HARDWARE
 141 The
 142 .Nm
 143 driver supports the following classes of UARTs:
 144 .Pp
 145 .Bl -bullet -compact
 146 .It
 147 NS8250: standard hardware based on the 8250, 16450, 16550, 16650, 16750 or
 148 the 16950 UARTs.
 149 .It
 150 SCC: serial communications controllers supported by the
 151 .Xr scc 4
 152 device driver.
 153 .El
 154 .\"
 155 .Sh FILES
 156 .Bl -tag -width ".Pa /dev/ttyu?.init" -compact
 157 .It Pa /dev/ttyu?
 158 for callin ports
 159 .It Pa /dev/ttyu?.init
 160 .It Pa /dev/ttyu?.lock
 161 corresponding callin initial-state and lock-state devices
 162 .Pp
 163 .It Pa /dev/cuau?
 164 for callout ports
 165 .It Pa /dev/cuau?.init
 166 .It Pa /dev/cuau?.lock
 167 corresponding callout initial-state and lock-state devices
 168 .El
 169 .Sh SEE ALSO
 170 .Xr puc 4 ,
 171 .Xr scc 4
 172 .\"
 173 .Sh HISTORY
 174 The
 175 .Nm
 176 device driver first appeared in
 177 .Fx 5.2 .
 178 .Sh AUTHORS
 179 The
 180 .Nm
 181 device driver and this manual page were written by
 182 .An Marcel Moolenaar Aq marcel@xcllnt.net .