usr.sbin/stallion/stlstty/stlstty.8

   1 .\" Copyright (c) 1996-1998 Greg Ungerer (gerg@stallion.oz.au).
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Greg Ungerer.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD: src/usr.sbin/stallion/stlstty/stlstty.8,v 1.1.2.3 2001/12/21 09:51:30 ru Exp $
  32 .\"
  33 .Dd January 14, 1998
  34 .Dt STLSTTY 8 i386
  35 .Os
  36 .Sh NAME
  37 .Nm stlstty
  38 .Nd "Stallion Technologies multiport serial port enhanced switches"
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl hV
  42 .Op Ar switches
  43 .Sh DESCRIPTION
  44 .Nm
  45 is used to view and set the advanced driver switches available on
  46 Stallion Technologies multiport serial ports.
  47 .Pp
  48 The advanced switches configurable through
  49 .Nm
  50 are only available on the intelligent boards of the Stallion
  51 Technologies multiport serial board range.
  52 This includes the EasyConnection 8/64 (ISA),
  53 ONboard and Brumby boards.
  54 The switches are not available on the EasyIO, EasyConnection 8/32
  55 and EasyConnection 8/64-PCI boards.
  56 .Pp
  57 If no switch settings are listed on the
  58 .Nm
  59 command line then it will display the current setting of all switches
  60 for the port that is
  61 standard input.
  62 If one or more switches is listed on the
  63 .Nm
  64 command line then those switches will be set accordingly.
  65 .Pp
  66 The options are:
  67 .Bl -tag -width indent
  68 .It Fl h
  69 Output usage information.
  70 .It Fl V
  71 Output version information.
  72 .El
  73 .Sh SWITCHES
  74 All switches are enabled by using the switch name as a parameter
  75 to
  76 .Nm .
  77 To disable a setting use a
  78 .Fl
  79 character in front of the switch name.
  80 .Pp
  81 All switches configurable by
  82 .Nm
  83 are persistent through opens and closes of the port.
  84 Once a switch is set it will remain set until changed using
  85 .Nm
  86 or by a reboot of the board or system.
  87 .Pp
  88 The following switches are configurable through
  89 .Nm :
  90 .Bl -tag -width indent
  91 .It Cm maprts Pq Fl maprts
  92 Maps the functionality normally associated with the DTR pin to
  93 action on the RTS pin instead.
  94 So in other words the RTS pin will now act as if it were the DTR pin.
  95 This is useful for boards that have ports that do not have full
  96 modem signaling on their connector (e.g. ONboard 16).
  97 .It Cm mapcts Pq Fl mapcts
  98 Maps the functionality normally associated with the DCD pin to
  99 be actioned on the CTS pin.
 100 So in other words the CTS pin will now act as if it were the DCD pin.
 101 This is useful for boards that have ports that do not have full
 102 modem signaling on their connector (e.g. ONboard 16).
 103 .It Cm rtslock Pq Fl rtslock
 104 Locks RTS based flow control on this port on.
 105 No matter what the port flow control is configured to be via
 106 the usual
 107 .Xr stty 1
 108 program, RTS based (hardware) flow control will be active on
 109 this port.
 110 .It Cm ctslock Pq Fl ctslock
 111 Locks CTS based flow control on this port on.
 112 No matter what the port flow control is configured to be via
 113 the usual
 114 .Xr stty 1
 115 program, CTS based (hardware) flow control will be active on
 116 this port.
 117 .It Cm loopback Pq Fl loopback
 118 Enables the internal loopback mode of the port UART.
 119 All data transmitted on this port will be received,
 120 and none will physically be transmitted by the port.
 121 .It Cm fakedcd Pq Fl fakedcd
 122 The DCD pin will always be reported as being asserted,
 123 regardless of the physical state of the hardware pin.
 124 .It Cm dtrfollow Pq Fl dtrfollow
 125 The DTR signal will only be asserted when data is being
 126 transmitted from the port.
 127 This is useful in conjunction with the EasyConnection
 128 Dual Interface module when fitted with RS-485 line drivers.
 129 .It Cm rximin Pq Fl rximin
 130 Disables (or enables) the slave processor's received character
 131 .Dq bunching
 132 algorithms.
 133 By default the slave processor will bunch up received data,
 134 so that it can be sent to the host in large chunks.
 135 This increases the time it takes for any individual character
 136 to be seen by an application.
 137 This may be undesirable for latency sensitive applications or
 138 protocols.
 139 To reduce received character latency the
 140 .Cm rximin
 141 switch should be turned on.
 142 .It Cm rxitime Pq Fl rxitime
 143 Disables (or enables) the slave processor's received character
 144 wait timer.
 145 This timer is used as part of the slave processor's data
 146 .Dq bunching
 147 algorithm.
 148 By turning this switch on the timer is reduced to a minimum,
 149 so that received data will immediately be sent to the host system.
 150 .It Cm rxthold Pq Fl rxthold
 151 Disables the UART received FIFO for this port.
 152 By default the UART received FIFO is programmed to a reasonably
 153 high level, to minimize CPU overhead.
 154 Some third party serial devices do not respond quickly to flow
 155 control signals (hardware or software) and this may cause the
 156 UART's received FIFO to over-run - thus losing data.
 157 Turning this switch on disables use of the received FIFO.
 158 .El
 159 .Sh SEE ALSO
 160 .Xr stl 4 ,
 161 .Xr stli 4 ,
 162 .Xr stlstats 8
 163 .Sh HISTORY
 164 This program was originally developed by
 165 .An Greg Ungerer Aq gerg@stallion.com .