share/man/man4/cas.4

   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
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device miibus"
  40 .Cd "device cas"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 if_cas_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for the Sun Cassini/Cassini+ and National
  53 Semiconductor DP83065 Saturn Gigabit Ethernet controllers found
  54 on-board in Sun UltraSPARC machines and as add-on cards.
  55 .Pp
  56 All controllers supported by the
  57 .Nm
  58 driver have TCP/UDP checksum offload capability for both receive and
  59 transmit, support for the reception and transmission of extended frames
  60 for
  61 .Xr vlan 4
  62 and an interrupt coalescing/moderation mechanism as well as a 512-bit
  63 multicast hash filter.
  64 .Pp
  65 The
  66 .Nm
  67 driver also supports Jumbo Frames (up to 9022 bytes), which can be
  68 configured via the interface MTU setting.
  69 Selecting an MTU larger than 1500 bytes with the
  70 .Xr ifconfig 8
  71 utility configures the adapter to receive and transmit Jumbo Frames.
  72 .Sh HARDWARE
  73 .Pp
  74 The chips supported by the
  75 .Nm
  76 driver are:
  77 .Pp
  78 .Bl -bullet -compact
  79 .It
  80 National Semiconductor DP83065 Saturn Gigabit Ethernet
  81 .It
  82 Sun Cassini Gigabit Ethernet
  83 .It
  84 Sun Cassini+ Gigabit Ethernet
  85 .El
  86 .Pp
  87 The
  88 following add-on cards are known to work with the
  89 .Nm
  90 driver at this time:
  91 .Pp
  92 .Bl -bullet -compact
  93 .It
  94 Sun GigaSwift Ethernet 1.0 MMF (Cassini Kuheen)
  95 (part no.\& 501-5524)
  96 .It
  97 Sun GigaSwift Ethernet 1.0 UTP (Cassini)
  98 (part no.\& 501-5902)
  99 .It
 100 Sun GigaSwift Ethernet UTP (GCS)
 101 (part no.\& 501-6719)
 102 .It
 103 Sun Quad GigaSwift Ethernet UTP (QGE)
 104 (part no.\& 501-6522)
 105 .It
 106 Sun Quad GigaSwift Ethernet PCI-X (QGE-X)
 107 (part no.\& 501-6738)
 108 .El
 109 .Sh NOTES
 110 On sparc64 the
 111 .Nm
 112 driver respects the
 113 .Va local-mac-address?
 114 system configuration variable which can be set in the Open Firmware boot
 115 monitor using the
 116 .Ic setenv
 117 command or by
 118 .Xr eeprom 8 .
 119 If set to
 120 .Dq Li false
 121 (the default), the
 122 .Nm
 123 driver will use the system's default MAC address for all of its devices.
 124 If set to
 125 .Dq Li true ,
 126 the unique MAC address of each interface is used if present rather than
 127 the system's default MAC address.
 128 .Pp
 129 Supported interfaces having their own MAC address include on-board
 130 versions on boards equipped with more than one Ethernet interface and
 131 all add-on cards.
 132 .Sh SEE ALSO
 133 .Xr altq 4 ,
 134 .Xr miibus 4 ,
 135 .Xr netintro 4 ,
 136 .Xr vlan 4 ,
 137 .Xr eeprom 8 ,
 138 .Xr ifconfig 8
 139 .Sh HISTORY
 140 The
 141 .Nm
 142 device driver appeared in
 143 .Fx 8.0
 144 and
 145 .Fx 7.3 .
 146 It is named after the
 147 .Nm
 148 driver which first appeared in
 149 .Ox 4.1
 150 and supports the same set of controllers but is otherwise unrelated.
 151 .Sh AUTHORS
 152 .An -nosplit
 153 The
 154 .Nm
 155 driver was written by
 156 .An Marius Strobl
 157 .Aq marius@FreeBSD.org
 158 based on the
 159 .Xr gem 4
 160 driver.