xref: /freebsd/share/man/man4/cas.4 (revision 25f58222bd2abe147011c59d3ceb8c394cf30913)
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 May 3, 2010
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
73.Pp
74The chips supported by the
75.Nm
76driver are:
77.Pp
78.Bl -bullet -compact
79.It
80National Semiconductor DP83065 Saturn Gigabit Ethernet
81.It
82Sun Cassini Gigabit Ethernet
83.It
84Sun Cassini+ Gigabit Ethernet
85.El
86.Pp
87The
88following add-on cards are known to work with the
89.Nm
90driver at this time:
91.Pp
92.Bl -bullet -compact
93.It
94Sun GigaSwift Ethernet 1.0 MMF (Cassini Kuheen)
95(part no.\& 501-5524)
96.It
97Sun GigaSwift Ethernet 1.0 UTP (Cassini)
98(part no.\& 501-5902)
99.It
100Sun GigaSwift Ethernet UTP (GCS)
101(part no.\& 501-6719)
102.It
103Sun Quad GigaSwift Ethernet UTP (QGE)
104(part no.\& 501-6522)
105.El
106.Sh NOTES
107On sparc64 the
108.Nm
109driver respects the
110.Va local-mac-address?
111system configuration variable which can be set in the Open Firmware boot
112monitor using the
113.Ic setenv
114command or by
115.Xr eeprom 8 .
116If set to
117.Dq Li false
118(the default), the
119.Nm
120driver will use the system's default MAC address for all of its devices.
121If set to
122.Dq Li true ,
123the unique MAC address of each interface is used if present rather than
124the system's default MAC address.
125.Pp
126Supported interfaces having their own MAC address include on-board
127versions on boards equipped with more than one Ethernet interface and
128all add-on cards.
129.Sh SEE ALSO
130.Xr altq 4 ,
131.Xr miibus 4 ,
132.Xr netintro 4 ,
133.Xr vlan 4 ,
134.Xr eeprom 8 ,
135.Xr ifconfig 8
136.Sh HISTORY
137The
138.Nm
139device driver appeared in
140.Fx 8.0
141and
142.Fx 7.3 .
143It is named after the
144.Nm
145driver which first appeared in
146.Ox 4.1
147and supports the same set of controllers but is otherwise unrelated.
148.Sh AUTHORS
149.An -nosplit
150The
151.Nm
152driver was written by
153.An Marius Strobl
154.Aq marius@FreeBSD.org
155based on the
156.Xr gem 4
157driver.
158