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