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 August 25, 2003
  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 .\"
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 device driver provides support for various classes of UARTs implementing the
  46 EIA RS-232C (CCITT V.24) serial communications interface.
  47 Each such interface is controlled by a separate and independent instance of
  48 the
  49 .Nm
  50 driver.
  51 The primary support for devices that contain multiple serial interfaces or
  52 that contain other functionality besides one or more serial interfaces is
  53 provided by the
  54 .Xr puc 4
  55 device driver.
  56 However, the serial interfaces of those devices that are managed by the
  57 .Xr puc 4
  58 driver are controlled by the
  59 .Nm
  60 driver.
  61 As such, the
  62 .Xr puc 4
  63 driver provides umbrella functionality for the
  64 .Nm
  65 driver and hides the complexities that are inherent when elementary components
  66 are packaged together.
  67 .Pp
  68 The
  69 .Nm
  70 driver has a modular design to allow it to be used on differing hardware and
  71 for various purposes.
  72 In the following sections the components are discussed in detail.
  73 Options are described in the section that covers the component to which each
  74 option applies.
  75 .\"
  76 .Ss CORE COMPONENT
  77 At the heart of the
  78 .Nm
  79 driver is the core component.
  80 It contains the bus attachments and the low-level interrupt handler.
  81 .\"
  82 .Ss HARDWARE DRIVERS
  83 The core component and the kernel interfaces talk to the hardware through the
  84 hardware interface.
  85 This interface serves as an abstraction of the hardware and allows varying
  86 UARTs to be used for serial communications.
  87 .\"
  88 .Ss SYSTEM DEVICES
  89 System devices are UARTs that have a special purpose by way of hardware
  90 design or software setup.
  91 For example, Sun UltraSparc machines use UARTs as their keyboard interface.
  92 Such an UART cannot be used for general purpose communications.
  93 Likewise, when the kernel is configured for a serial console, the
  94 corresponding UART will in turn be a system device so that the kernel can
  95 output boot messages early on in the boot process.
  96 .\"
  97 .Ss KERNEL INTERFACES
  98 The last but not least of the components is the kernel interface.
  99 This component ultimately determines how the UART is made visible to the
 100 kernel in particular and to users in general.
 101 The default kernel interface is the TTY interface.
 102 This allows the UART to be used for terminals, modems and serial line IP
 103 applications.
 104 System devices, with the notable exception of serial consoles, generally
 105 have specialized kernel interfaces.
 106 .\"
 107 .Sh HARDWARE
 108 The
 109 .Nm
 110 driver supports the following classes of UARTs:
 111 .Pp
 112 .Bl -bullet -compact
 113 .It
 114 NS8250: standard hardware based on the 8250, 16450, 16550, 16650, 16750 or
 115 the 16950 UARTs
 116 .It
 117 SAB82532: Siemens SAB 82532 based serial communications controllers in
 118 asynchronous mode.
 119 .It
 120 Z8530: Zilog 8530 based serial communications controllers in asynchronous
 121 mode.
 122 .El
 123 .\"
 124 .Sh SEE ALSO
 125 .Xr puc 4
 126 .\"
 127 .Sh HISTORY
 128 The
 129 .Nm
 130 device driver first appeared in
 131 .Fx 5.2 .
 132 .Sh AUTHORS
 133 This manual page was written by
 134 .An Marcel Moolenaar Aq marcel@xcllnt.net .