usr.sbin/sicontrol/sicontrol.8

   1 .\" $FreeBSD: src/usr.sbin/sicontrol/sicontrol.8,v 1.11.2.6 2003/03/12 22:08:15 trhodes Exp $
   2 .\" $DragonFly: src/usr.sbin/sicontrol/sicontrol.8,v 1.2 2003/06/17 04:30:03 dillon Exp $
   3 .\"
   4 .Dd September 26, 1995
   5 .Dt SICONTROL 8
   6 .Os
   7 .Sh NAME
   8 .Nm sicontrol
   9 .Nd Specialix SI/XIO driver configuration and debugging
  10 .Sh SYNOPSIS
  11 .Nm
  12 device
  13 .Ar command Op Ar param ...
  14 .Sh DESCRIPTION
  15 The
  16 .Nm
  17 utility is used to configure and monitor the SI/XIO device driver.
  18 .Pp
  19 The
  20 .Nm
  21 utility operates on the specified
  22 .Ar device
  23 to indicate which port is to be used.
  24 .Pp
  25 The special
  26 .Ar device
  27 string `-' is used to indicate the global driver settings instead.
  28 .Pp
  29 A
  30 .Pa /dev/
  31 is included if necessary.
  32 .Pp
  33 The following commands are used for the global settings and should be
  34 specified with the '-' device name:
  35 .Bl -tag -width 4n
  36 .It Cm int_throttle Op Cm value
  37 Configure the `aggregate interrupt throttle value'.
  38 The maximum number of host adapter interrupts per second is determined by:
  39 .Pp
  40 .Ar "controller CPU clock / (8 * int_throttle)"
  41 .Pp
  42 The default value at boot time is 25000.  The host adapter cpu clock is
  43 25MHz.  This gives a maximum interrupt rate of about 125 interrupts per
  44 second.
  45 .Pp
  46 Lowering this value will increase the rate in which the host adapter can
  47 interrupt the operating system for attention.
  48 .\"
  49 .It Cm rxint_throttle Op Cm value
  50 Configure the receiver interrupt throttle value.
  51 The default value of 4 at boot time allows an interrupt rate of
  52 approximately 25.
  53 .Pp
  54 Lowering this value will increase the rate in which the host adapter can
  55 interrupt the operating system to empty the receiver fifos.
  56 .\"
  57 .It Cm nport
  58 Return the number of ports under the control of the device driver.
  59 .El
  60 .Pp
  61 The following commands are used for the individual ports and should be
  62 specified with a device name from
  63 .Pa /dev :
  64 .Bl -tag -width 4n
  65 .It Cm mstate
  66 Show the current incoming modem control signals.
  67 .It Cm ccbstat
  68 Show the current "ccb" structure for the specified port.
  69 This is not of
  70 much use outside of debugging the driver and determining why a port is
  71 wedged.
  72 .It Cm ttystat
  73 Show the current "tty" structure that the kernel has for the specified port.
  74 This is not much use outside of debugging the driver.
  75 .El
  76 .Sh FILES
  77 .Bl -tag -width /dev/si_control -compact
  78 .It Pa /dev/si_control
  79 global driver control file for use by
  80 .Nm
  81 .It Pa /dev/ttyA*
  82 terminal control ports
  83 .It Pa /dev/ttyiA*
  84 initial termios state devices, for use by
  85 .Xr stty 1
  86 .It Pa /dev/ttylA*
  87 locked termios state devices, for use by
  88 .Xr stty 1
  89 .El
  90 .Sh DIAGNOSTICS
  91 Generally self explanatory.....
  92 .Sh SEE ALSO
  93 .Xr stty 1 ,
  94 .Xr si 4 ,
  95 .Xr termios 4 ,
  96 .Xr tty 4 ,
  97 .Xr comcontrol 8
  98 .Sh HISTORY
  99 The
 100 .Nm
 101 utility is loosely based on a utility called
 102 .Nm siconfig
 103 which was written by
 104 .An Andy Rutter Aq andy@acronym.co.uk
 105 .Pp
 106 Specialix International do not support this device driver in any way.
 107 .Sh AUTHORS
 108 .An Peter Wemm Aq peter@FreeBSD.org
 109 .Sh BUGS
 110 Bound to be many... :-)