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