usr.sbin/sicontrol/sicontrol.8

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