usr.sbin/sicontrol/sicontrol.8

   1 .\" $FreeBSD$
   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.
  42 The host adapter cpu clock is
  43 25MHz.
  44 This gives a maximum interrupt rate of about 125 interrupts per
  45 second.
  46 .Pp
  47 Lowering this value will increase the rate in which the host adapter can
  48 interrupt the operating system for attention.
  49 .\"
  50 .It Cm rxint_throttle Op Cm value
  51 Configure the receiver interrupt throttle value.
  52 The default value of 4 at boot time allows an interrupt rate of
  53 approximately 25.
  54 .Pp
  55 Lowering this value will increase the rate in which the host adapter can
  56 interrupt the operating system to empty the receiver fifos.
  57 .\"
  58 .It Cm nport
  59 Return the number of ports under the control of the device driver.
  60 .El
  61 .Pp
  62 The following commands are used for the individual ports and should be
  63 specified with a device name from
  64 .Pa /dev :
  65 .Bl -tag -width 4n
  66 .It Cm mstate
  67 Show the current incoming modem control signals.
  68 .It Cm ccbstat
  69 Show the current "ccb" structure for the specified port.
  70 This is not of
  71 much use outside of debugging the driver and determining why a port is
  72 wedged.
  73 .El
  74 .Sh FILES
  75 .Bl -tag -width /dev/si_control -compact
  76 .It Pa /dev/si_control
  77 global driver control file for use by
  78 .Nm
  79 .It Pa /dev/ttyA*
  80 terminal control ports
  81 .It Pa /dev/ttyiA*
  82 initial termios state devices, for use by
  83 .Xr stty 1
  84 .It Pa /dev/ttylA*
  85 locked termios state devices, for use by
  86 .Xr stty 1
  87 .El
  88 .Sh DIAGNOSTICS
  89 Generally self explanatory.....
  90 .Sh SEE ALSO
  91 .Xr stty 1 ,
  92 .Xr si 4 ,
  93 .Xr termios 4 ,
  94 .Xr tty 4 ,
  95 .Xr comcontrol 8
  96 .Sh HISTORY
  97 The
  98 .Nm
  99 utility is loosely based on a utility called
 100 .Nm siconfig
 101 which was written by
 102 .An Andy Rutter Aq andy@acronym.co.uk
 103 .Pp
 104 Specialix International do not support this device driver in any way.
 105 .Sh AUTHORS
 106 .An Peter Wemm Aq peter@FreeBSD.org
 107 .Sh BUGS
 108 Bound to be many...
 109 :-)