share/man/man4/sge.4

   1 .\" Copyright (c) 2010 Pyun YongHyeon
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 16, 2011
  28 .Dt SGE 4
  29 .Os
  30 .Sh NAME
  31 .Nm sge
  32 .Nd Silicon Integrated Systems SiS190/191 Fast/Gigabit Ethernet driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device miibus"
  39 .Cd "device sge"
  40 .Ed
  41 .Pp
  42 Alternatively, to load the driver as a
  43 module at boot time, place the following line in
  44 .Xr loader.conf 5 :
  45 .Bd -literal -offset indent
  46 if_sge_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 device driver provides support for SiS190 Fast Ethernet
  52 controllers and SiS191 Fast/Gigabit Ethernet controllers.
  53 .Pp
  54 All LOMs supported by the
  55 .Nm
  56 driver have TCP/UDP/IP checksum offload for transmit and receive,
  57 TCP segmentation offload (TSO), hardware VLAN tag stripping/insertion
  58 features.
  59 Due to lack of documentation Wake On Lan (WOL), Jumbo frame and an
  60 interrupt moderation mechanism are not supported yet.
  61 .Pp
  62 The
  63 .Nm
  64 driver supports the following media types:
  65 .Bl -tag -width ".Cm 10baseT/UTP"
  66 .It Cm autoselect
  67 Enable autoselection of the media type and options.
  68 The user can manually override
  69 the autoselected mode by adding media options to
  70 .Xr rc.conf 5 .
  71 .It Cm 10baseT/UTP
  72 Set 10Mbps operation.
  73 .It Cm 100baseTX
  74 Set 100Mbps (Fast Ethernet) operation.
  75 .It Cm 1000baseTX
  76 Set 1000baseTX operation over twisted pair.
  77 .El
  78 .Pp
  79 The
  80 .Nm
  81 driver supports the following media options:
  82 .Bl -tag -width ".Cm full-duplex"
  83 .It Cm full-duplex
  84 Force full duplex operation.
  85 .It Cm half-duplex
  86 Force half duplex operation.
  87 .El
  88 .Pp
  89 For more information on configuring this device, see
  90 .Xr ifconfig 8 .
  91 .Sh HARDWARE
  92 The
  93 .Nm
  94 device driver provides support for the following Ethernet controllers:
  95 .Pp
  96 .Bl -bullet -compact
  97 .It
  98 SiS190 Fast Ethernet controller
  99 .It
 100 SiS191 Fast/Gigabit Ethernet controller
 101 .El
 102 .Sh SEE ALSO
 103 .Xr altq 4 ,
 104 .Xr arp 4 ,
 105 .Xr miibus 4 ,
 106 .Xr netintro 4 ,
 107 .Xr ng_ether 4 ,
 108 .Xr rgephy 4 ,
 109 .Xr vlan 4 ,
 110 .Xr ifconfig 8
 111 .Sh HISTORY
 112 The
 113 .Nm
 114 driver was written by
 115 .An Alexander Pohoyda
 116 .Aq alexander.pohoyda@gmx.net .
 117 And enhanced by
 118 .An Nikolay Denev
 119 .Aq ndenev@gmail.com .
 120 It first appeared in
 121 .Fx 8.1 .