usr.sbin/sicontrol/sicontrol.8

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