xref: /freebsd/share/man/man4/cas.4 (revision 641a6cfb86023499caafe26a4d821a0b885cf00b)
1.\"
2.\" Copyright (c) 2009 Marius Strobl <marius@FreeBSD.org>
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $FreeBSD$
27.\"
28.Dd March 24, 2012
29.Dt CAS 4
30.Os
31.Sh NAME
32.Nm cas
33.Nd Sun Cassini/Cassini+ and National Semiconductor DP83065 Saturn Gigabit Ethernet driver
34.Sh SYNOPSIS
35To compile this driver into the kernel,
36place the following lines in your
37kernel configuration file:
38.Bd -ragged -offset indent
39.Cd "device miibus"
40.Cd "device cas"
41.Ed
42.Pp
43Alternatively, to load the driver as a
44module at boot time, place the following line in
45.Xr loader.conf 5 :
46.Bd -literal -offset indent
47if_cas="YES"
48.Ed
49.Sh DESCRIPTION
50The
51.Nm
52driver provides support for the Sun Cassini/Cassini+ and National
53Semiconductor DP83065 Saturn Gigabit Ethernet controllers found
54on-board in Sun UltraSPARC machines and as add-on cards.
55.Pp
56All controllers supported by the
57.Nm
58driver have TCP/UDP checksum offload capability for both receive and
59transmit, support for the reception and transmission of extended frames
60for
61.Xr vlan 4
62and an interrupt coalescing/moderation mechanism as well as a 512-bit
63multicast hash filter.
64.Pp
65The
66.Nm
67driver also supports Jumbo Frames (up to 9022 bytes), which can be
68configured via the interface MTU setting.
69Selecting an MTU larger than 1500 bytes with the
70.Xr ifconfig 8
71utility configures the adapter to receive and transmit Jumbo Frames.
72.Sh HARDWARE
73The chips supported by the
74.Nm
75driver are:
76.Pp
77.Bl -bullet -compact
78.It
79National Semiconductor DP83065 Saturn Gigabit Ethernet
80.It
81Sun Cassini Gigabit Ethernet
82.It
83Sun Cassini+ Gigabit Ethernet
84.El
85.Pp
86The
87following add-on cards are known to work with the
88.Nm
89driver at this time:
90.Pp
91.Bl -bullet -compact
92.It
93Sun GigaSwift Ethernet 1.0 MMF (Cassini Kuheen)
94(part no.\& 501-5524)
95.It
96Sun GigaSwift Ethernet 1.0 UTP (Cassini)
97(part no.\& 501-5902)
98.It
99Sun GigaSwift Ethernet UTP (GCS)
100(part no.\& 501-6719)
101.It
102Sun Quad GigaSwift Ethernet UTP (QGE)
103(part no.\& 501-6522)
104.It
105Sun Quad GigaSwift Ethernet PCI-X (QGE-X)
106(part no.\& 501-6738)
107.El
108.Sh NOTES
109On sparc64 the
110.Nm
111driver respects the
112.Va local-mac-address?
113system configuration variable which can be set in the Open Firmware boot
114monitor using the
115.Ic setenv
116command or by
117.Xr eeprom 8 .
118If set to
119.Dq Li false
120(the default), the
121.Nm
122driver will use the system's default MAC address for all of its devices.
123If set to
124.Dq Li true ,
125the unique MAC address of each interface is used if present rather than
126the system's default MAC address.
127.Pp
128Supported interfaces having their own MAC address include on-board
129versions on boards equipped with more than one Ethernet interface and
130all add-on cards.
131.Sh SEE ALSO
132.Xr altq 4 ,
133.Xr miibus 4 ,
134.Xr netintro 4 ,
135.Xr vlan 4 ,
136.Xr eeprom 8 ,
137.Xr ifconfig 8
138.Sh HISTORY
139The
140.Nm
141device driver appeared in
142.Fx 8.0
143and
144.Fx 7.3 .
145It is named after the
146.Nm
147driver which first appeared in
148.Ox 4.1
149and supports the same set of controllers but is otherwise unrelated.
150.Sh AUTHORS
151.An -nosplit
152The
153.Nm
154driver was written by
155.An Marius Strobl
156.Aq marius@FreeBSD.org
157based on the
158.Xr gem 4
159driver.
160