svn commit: r194247 - head/share/man/man4

Mon Jun 15 18:24:05 UTC 2009

Author: marius
Date: Mon Jun 15 18:24:04 2009
New Revision: 194247
URL: http://svn.freebsd.org/changeset/base/194247

Log:
  Add a man page for cas(4) and reference it as appropriate.
  
  Approved by:	re (kib)
  MFC after:	2 weeks

Added:
  head/share/man/man4/cas.4   (contents, props changed)
Modified:
  head/share/man/man4/Makefile
  head/share/man/man4/altq.4
  head/share/man/man4/miibus.4
  head/share/man/man4/vlan.4

Modified: head/share/man/man4/Makefile
==============================================================================

--- head/share/man/man4/Makefile	Mon Jun 15 18:22:41 2009	(r194246)
+++ head/share/man/man4/Makefile	Mon Jun 15 18:24:04 2009	(r194247)
@@ -55,6 +55,7 @@ MAN=	aac.4 \
 	bwi.4 \
 	cardbus.4 \
 	carp.4 \
+	cas.4 \
 	ccd.4 \
 	cd.4 \
 	cdce.4 \
@@ -472,6 +473,7 @@ MLINKS+=bfe.4 if_bfe.4
 MLINKS+=bge.4 if_bge.4
 MLINKS+=bktr.4 brooktree.4
 MLINKS+=bwi.4 if_bwi.4
+MLINKS+=cas.4 if_cas.4
 MLINKS+=crypto.4 cryptodev.4
 MLINKS+=cue.4 if_cue.4
 MLINKS+=dc.4 if_dc.4

Modified: head/share/man/man4/altq.4
==============================================================================
--- head/share/man/man4/altq.4	Mon Jun 15 18:22:41 2009	(r194246)
+++ head/share/man/man4/altq.4	Mon Jun 15 18:24:04 2009	(r194247)
@@ -25,7 +25,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd June 10, 2009
+.Dd June 14, 2009
 .Dt ALTQ 4
 .Os
 .Sh NAME
@@ -125,6 +125,7 @@ They have been applied to the following 
 .Xr bce 4 ,
 .Xr bfe 4 ,
 .Xr bge 4 ,
+.Xr cas 4 ,
 .Xr dc 4 ,
 .Xr de 4 ,
 .Xr ed 4 ,

Added: head/share/man/man4/cas.4
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man4/cas.4	Mon Jun 15 18:24:04 2009	(r194247)
@@ -0,0 +1,154 @@
+.\"
+.\" Copyright (c) 2009 Marius Strobl <marius at FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd June 15, 2009
+.Dt CAS 4
+.Os
+.Sh NAME
+.Nm cas
+.Nd Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn Gigabit Ethernet driver
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device miibus"
+.Cd "device cas"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+if_cas="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for the Sun Cassini/Cassini+ and National
+Semiconductor DP83065 Saturn Gigabit Ethernet controllers found
+on-board in Sun UltraSPARC machines and as add-on cards.
+.Pp
+All controllers supported by the
+.Nm
+driver have TCP/UDP checksum offload capability for both receive and
+transmit, support for the reception and transmission of extended frames
+for
+.Xr vlan 4
+and an interrupt coalescing/moderation mechanism as well as a 512-bit
+multicast hash filter.
+.Pp
+The
+.Nm
+driver also supports Jumbo Frames (up to 9022 bytes), which can be
+configured via the interface MTU setting.
+Selecting an MTU larger than 1500 bytes with the
+.Xr ifconfig 8
+utility configures the adapter to receive and transmit Jumbo Frames.
+.Sh HARDWARE
+.Pp
+The chips supported by the
+.Nm
+driver are:
+.Pp
+.Bl -bullet -compact
+.It
+National Semiconductor DP83065 Saturn Gigabit Ethernet
+.It
+Sun Cassini Gigabit Ethernet
+.It
+Sun Cassini+ Gigabit Ethernet
+.El
+.Pp
+The
+following add-on cards are known to work with the
+.Nm
+driver at this time:
+.Pp
+.Bl -bullet -compact
+.It
+Sun GigaSwift Ethernet 1.0 UTP (Cassini)
+(part no.\& 501-5902)
+.It
+Sun GigaSwift Ethernet UTP (GCS)
+(part no.\& 501-6719)
+.It
+Sun Quad GigaSwift Ethernet UTP (QGE)
+(part no.\& 501-6522)
+.El
+.Sh NOTES
+On sparc64 the
+.Nm
+driver respects the
+.Va local-mac-address?
+system configuration variable which can be set in the Open Firmware boot
+monitor using the
+.Ic setenv
+command or by
+.Xr eeprom 8 .
+If set to
+.Dq Li false
+(the default), the
+.Nm
+driver will use the system's default MAC address for all of its devices.
+If set to
+.Dq Li true ,
+the unique MAC address of each interface is used if present rather than
+the system's default MAC address.
+.Pp
+Supported interfaces having their own MAC address include on-board
+versions on boards equipped with more than one Ethernet interface and
+all add-on cards.
+.Sh SEE ALSO
+.Xr altq 4 ,
+.Xr miibus 4 ,
+.Xr netintro 4 ,
+.Xr vlan 4 ,
+.Xr eeprom 8 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+device driver appeared in
+.Fx 8.0
+and
+.Fx 7.3 .
+It is named after the
+.Nm
+driver which first appeared in
+.Ox 4.1
+and supports the same set of controllers but is otherwise unrelated.
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Marius Strobl
+.Aq marius at FreeBSD.org
+based on the
+.Xr gem 4
+driver.

Modified: head/share/man/man4/miibus.4
==============================================================================
--- head/share/man/man4/miibus.4	Mon Jun 15 18:22:41 2009	(r194246)
+++ head/share/man/man4/miibus.4	Mon Jun 15 18:24:04 2009	(r194247)
@@ -8,7 +8,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd June 10, 2009
+.Dd June 14, 2009
 .Dt MIIBUS 4
 .Os
 .Sh NAME
@@ -61,6 +61,8 @@ Broadcom NetXtreme II Gigabit Ethernet
 Broadcom BCM4401 Ethernet
 .It Xr bge 4
 Broadcom BCM570xx Gigabit Ethernet
+.It Xr cas 4
+Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn
 .It Xr dc 4
 DEC/Intel 21143 and various workalikes
 .It Xr ed 4
@@ -137,6 +139,7 @@ but as a result are not well behaved new
 .Xr bce 4 ,
 .Xr bfe 4 ,
 .Xr bge 4 ,
+.Xr cas 4 ,
 .Xr dc 4 ,
 .Xr ed 4 ,
 .Xr et 4 ,

Modified: head/share/man/man4/vlan.4
==============================================================================
--- head/share/man/man4/vlan.4	Mon Jun 15 18:22:41 2009	(r194246)
+++ head/share/man/man4/vlan.4	Mon Jun 15 18:24:04 2009	(r194247)
@@ -25,7 +25,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd June 10, 2009
+.Dd June 14, 2009
 .Dt VLAN 4
 .Os
 .Sh NAME
@@ -161,6 +161,7 @@ The following interfaces support long fr
 .Nm
 natively:
 .Xr bfe 4 ,
+.Xr cas 4 ,
 .Xr dc 4 ,
 .Xr fwe 4 ,
 .Xr fxp 4 ,
