Rewrite the sicontrol man page to something remotely useful.

I couldn't use the original, as it had unusable copyrights.

1 files changed, 96 insertions, 23 deletions

diff --git a/usr.sbin/sicontrol/sicontrol.8 b/usr.sbin/sicontrol/sicontrol.8
index 05c79e89f0cd..ce25794a004b 100644
--- a/usr.sbin/sicontrol/sicontrol.8
+++ b/usr.sbin/sicontrol/sicontrol.8
@@ -1,40 +1,113 @@
 .\" $Id$
-.\"
-.Dd August 14, 1995
+.\" The following requests are required for all man pages.
+.Dd September 26,1995
 .Dt SICONTROL 8
+.Os FreeBSD
 .Sh NAME
 .Nm sicontrol
-.Nd Specialix SI/XIO driver controller
+.Nd Specialix SI/XIO driver configuration and debugging
 .Sh SYNOPSIS
 .Nm sicontrol
-device_name
-.Ar argument Op Cm Ar parameter ...
+device
+.Ar command Op Cm Ar param ...
 .Sh DESCRIPTION
-.Nm Sicontrol
-is used to manage the SI/XIO driver .
-.sp
-Ask Peter Wemm <peter@haywire.dialix.com> for details.
+.Nm sicontrol
+is used to configure and monitor the SI/XIO device driver.
+.Pp
+.Nm sicontrol
+operates on the specified
+.Ar device
+to indicate which port is to be used.
+.Pp
+The special
+.Ar device
+string `-' is used to indicate the global driver settings instead.
+.Pp
+A '/dev/' is included if necessary.
+.Pp
+The following commands are used for the global settings and should be
+specified with the '-' device name.
+.Bl -tag -width 4n
+.It Cm int_throttle Op Cm value
+Configure the `aggregate interrupt throttle value'.
+The maximum number of host adapter interrupts per second is determined by:
+.Pp
+.Ar "controller CPU clock / (8 * int_throttle)"
+.Pp
+The default value at boot time is 25000.  The host adapter cpu clock is
+25Mhz.  This gives a maximum interrupt rate of about 125 interrupts per
+second.
+.Pp
+Lowering this value will increase the rate in which the host adapter can
+interrupt the operating system for attention.
+.\"
+.It Cm rxint_throttle Op Cm value
+Configure the receiver interrupt throttle value.
+The default value of 4 at boot time allows an interrupt rate of
+approximately 25.
+.Pp
+Lowering this value will increase the rate in which the host adapter can
+interrupt the operating system to empty the receviver fifos.
+.\"
+.It Cm nport
+Returns the number of ports under the control of the device driver.
+.El
+.Pp
+The following commands are used for the individual ports and should be
+specified with a device name from /dev.
+.Bl -tag -width 4n
+.It Cm mstate
+Shows the current incoming modem control signals.
+.It Cm ccbstat
+Shows the current "ccb" structure for the specified port. This is not of
+much use outside of debugging the driver and determining why a port is
+wedged.
+.It Cm ttystat
+Shows the current "tty" structure that the kernel has for the specified port.
+This is not much use outside of debugging the driver.
+.El
+.\" The following requests should be uncommented and used where appropriate.
+.\" This next request is for sections 2 and 3 function return values only.
+.\" .Sh RETURN VALUES
+.\" This next request is for sections 1, 6, 7 & 8 only
+.\" .Sh ENVIRONMENT
 .Sh FILES
 .Bl -tag -width /dev/si_control -compact
 .It Pa /dev/si_control
-driver control interface - used by
-.Xr sicontrol 8
+global driver control file for use by
+.Xr sicontrol 8 .
 .It Pa /dev/ttyA*
-ports
-.It Pa /dev/cuaA*
-callout ports
+terminal control ports
 .It Pa /dev/ttyiA*
-initial termios flags device
+initial termios state devices, for use by
+.Xr stty 1
 .It Pa /dev/ttylA*
-locked termios flags device
+locked termios state devices, for use by
+.Xr stty 1
+.El
+.\" .Sh EXAMPLES
+.\" This next request is for sections 1, 6, 7 & 8 only
+.\"     (command return values (to shell) and fprintf/stderr type diagnostics)
+.Sh DIAGNOSTICS
+Generally self explanatory.....
+.\" The next request is for sections 2 and 3 error and signal handling only.
+.\" .Sh ERRORS
 .Sh SEE ALSO
-.Xr tty 4 ,
-.Xr termios 4 ,
-.Xr comcontrol 8 ,
 .Xr stty 1 ,
+.Xr termios 4 ,
+.Xr tty 4 ,
 .Xr si 4 ,
-(to be written)
-.Sh DIAGNOSTICS
-Many and various.
+.Xr comcontrol 8 .
+.\" .Sh STANDARDS
+.Sh HISTORY
+.Nm sicontrol
+is loosely based on a utility called
+.Nm siconfig
+which was written by
+.Nm "Andy Rutter <andy@acronym.co.uk>"
+.Pp
+Specialix International do not support this device driver in any way.
+.Sh AUTHORS
+Peter Wemm <peter@freebsd.org>
 .Sh BUGS
-I'd say this manpage is one.. :-)
+Bound to be many... :-)