freebsd-skq/usr.sbin/sicontrol/sicontrol.8

.\" $FreeBSD$
.\"
.Dd September 26, 1995
.Dt SICONTROL 8
.Os FreeBSD
.Sh NAME
.Nm sicontrol
.Nd Specialix SI/XIO driver configuration and debugging
.Sh SYNOPSIS
.Nm
device
.Ar command Op Ar param ...
.Sh DESCRIPTION
.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 receiver fifos.
.\"
.It Cm nport
Return 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
.Pa /dev :
.Bl -tag -width 4n
.It Cm mstate
Show the current incoming modem control signals.
.It Cm ccbstat
Show 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
Show the current "tty" structure that the kernel has for the specified port.
This is not much use outside of debugging the driver.
.El
.Sh FILES
.Bl -tag -width /dev/si_control -compact
.It Pa /dev/si_control
global driver control file for use by
.Xr sicontrol 8 .
.It Pa /dev/ttyA*
terminal control ports
.It Pa /dev/ttyiA*
initial termios state devices, for use by
.Xr stty 1
.It Pa /dev/ttylA*
locked termios state devices, for use by
.Xr stty 1
.El
.Sh DIAGNOSTICS
Generally self explanatory.....
.Sh SEE ALSO
.Xr stty 1 ,
.Xr si 4 ,
.Xr termios 4 ,
.Xr tty 4 ,
.Xr comcontrol 8
.Sh HISTORY
.Nm Sicontrol
is loosely based on a utility called
.Nm siconfig
which was written by
.An Andy Rutter Aq andy@acronym.co.uk
.Pp
Specialix International do not support this device driver in any way.
.Sh AUTHORS
.An Peter Wemm Aq peter@FreeBSD.org
.Sh BUGS
Bound to be many... :-)
$Id$ -> $FreeBSD$ 1999-08-28 01:35:59 +00:00			`.\" $FreeBSD$`
Remove comments left since mdoc.template time or just useless comments 1999-10-30 15:38:20 +00:00			`.\"`
mdoc(7) police: use canonical form of .Dd macro. 2000-12-11 15:57:16 +00:00			`.Dd September 26, 1995`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.Dt SICONTROL 8`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.Os FreeBSD`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.Sh NAME`
			`.Nm sicontrol`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.Nd Specialix SI/XIO driver configuration and debugging`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 20:10:44 +00:00			`.Nm`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`device`
Eliminate mdocNG warnings caused by misplaced or extraneous macro calls. 2001-02-28 17:38:53 +00:00			`.Ar command Op Ar param ...`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.Sh DESCRIPTION`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`.Nm Sicontrol`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`is used to configure and monitor the SI/XIO device driver.`
			`.Pp`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`.Nm Sicontrol`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`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`
Fix a bunch of spelling errors in a bunch of man pages. 1996-01-30 13:52:50 +00:00			`interrupt the operating system to empty the receiver fifos.`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.\"`
			`.It Cm nport`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`Return the number of ports under the control of the device driver.`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.El`
			`.Pp`
			`The following commands are used for the individual ports and should be`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`specified with a device name from`
			`.Pa /dev :`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.Bl -tag -width 4n`
			`.It Cm mstate`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`Show the current incoming modem control signals.`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.It Cm ccbstat`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:09:25 +00:00			`Show the current "ccb" structure for the specified port.`
			`This is not of`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`much use outside of debugging the driver and determining why a port is`
			`wedged.`
			`.It Cm ttystat`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`Show the current "tty" structure that the kernel has for the specified port.`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`This is not much use outside of debugging the driver.`
			`.El`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.Sh FILES`
			`.Bl -tag -width /dev/si_control -compact`
			`.It Pa /dev/si_control`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`global driver control file for use by`
			`.Xr sicontrol 8 .`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.It Pa /dev/ttyA*`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`terminal control ports`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.It Pa /dev/ttyiA*`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`initial termios state devices, for use by`
			`.Xr stty 1`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.It Pa /dev/ttylA*`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`locked termios state devices, for use by`
			`.Xr stty 1`
			`.El`
			`.Sh DIAGNOSTICS`
			`Generally self explanatory.....`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.Sh SEE ALSO`
			`.Xr stty 1 ,`
Sort cross references. 1997-01-20 00:03:00 +00:00			`.Xr si 4 ,`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.Xr termios 4 ,`
			`.Xr tty 4 ,`
remove trailing periods from SEE ALSO. 2000-11-15 17:27:54 +00:00			`.Xr comcontrol 8`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.Sh HISTORY`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`.Nm Sicontrol`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`is loosely based on a utility called`
			`.Nm siconfig`
			`which was written by`
Use err(3). Add prototypes. 1997-10-15 06:43:54 +00:00			`.An Andy Rutter Aq andy@acronym.co.uk`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`.Pp`
			`Specialix International do not support this device driver in any way.`
			`.Sh AUTHORS`
.Sh AUTHOR -> .Sh AUTHORS. Use .An/.Aq. 1998-03-23 08:31:20 +00:00			`.An Peter Wemm Aq peter@FreeBSD.org`
Add skeleton manpage, so that make world works...... Correct the naming of the thing.. it's sicontrol, not siconfig as I'm used to.. 1995-08-14 01:56:17 +00:00			`.Sh BUGS`
Rewrite the sicontrol man page to something remotely useful. I couldn't use the original, as it had unusable copyrights. 1995-09-26 18:18:49 +00:00			`Bound to be many... :-)`