share/man/man4/ae.4

   1 .\" Copyright (c) 2008 Stanislav Sedov <stas@FreeBSD.org>
   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: src/share/man/man4/ae.4,v 1.2.2.1.4.1 2009/04/15 03:14:26 kensmith Exp $
  26 .\"
  27 .Dd July 13, 2009
  28 .Dt AE 4
  29 .Os
  30 .Sh NAME
  31 .Nm ae
  32 .Nd "Attansic/Atheros L2 FastEthernet controller driver"
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel, place the following lines in your
  35 kernel configuration file:
  36 .Bd -ragged -offset indent
  37 .Cd "device miibus"
  38 .Cd "device ae"
  39 .Ed
  40 .Pp
  41 Alternatively, to load the driver as a
  42 module at boot time, place the following line in
  43 .Xr loader.conf 5 :
  44 .Bd -literal -offset indent
  45 if_ae_load="YES"
  46 .Ed
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 device driver provides support for Attansic/Atheros L2 PCIe FastEthernet
  51 controllers.
  52 .Pp
  53 The controller supports hardware Ethernet checksum processing, hardware
  54 VLAN tag stripping/insertion and an interrupt moderation mechanism.
  55 Attansic L2 also features a 64-bit multicast hash filter.
  56 .Pp
  57 The
  58 .Nm
  59 driver supports the following media types:
  60 .Bl -tag -width ".Cm 10baseT/UTP"
  61 .It Cm autoselect
  62 Enable autoselection of the media type and options.
  63 The user can manually override the autoselected mode by
  64 adding media options to
  65 .Xr rc.conf 5 .
  66 .It Cm 10baseT/UTP
  67 Select 10Mbps operation.
  68 .It Cm 100baseTX
  69 Set 100Mbps (FastEthernet) operation.
  70 .El
  71 .Pp
  72 The
  73 .Nm
  74 driver provides support for the following media options:
  75 .Bl -tag -width ".Cm full-duplex"
  76 .It Cm full-duplex
  77 Force full duplex operation.
  78 .It Cm half-duplex
  79 Force half duplex operation.
  80 .El
  81 .Pp
  82 For more information on configuring this device, see
  83 .Xr ifconfig 8 .
  84 .Sh HARDWARE
  85 The
  86 .Nm
  87 driver supports Attansic/Atheros L2 PCIe FastEthernet controllers, and
  88 is known to support the following hardware:
  89 .Pp
  90 .Bl -bullet -compact
  91 .It
  92 ASUS EeePC 701
  93 .It
  94 ASUS EeePC 900
  95 .El
  96 .Pp
  97 Other hardware may or may not work with this driver.
  98 .Sh SYSCTL VARIABLES
  99 The
 100 .Nm
 101 driver collects a number of useful MAC counter during the work.
 102 The statistics is available via the
 103 .Va hw.ae%d.stats
 104 .Xr sysctl 8
 105 tree, where %d corresponds to the controller number.
 106 .Sh DIAGNOSTICS
 107 .Bl -diag
 108 .It "ae%d: watchdog timeout."
 109 The device has stopped responding to the network, or there is a problem with
 110 the network connection (cable).
 111 .It "ae%d: reset timeout."
 112 The card reset operation has been timed out.
 113 .It "ae%d: Generating random ethernet address."
 114 No valid ethernet address was found neither in the controller registers not in
 115 NVRAM.
 116 Random locally administered address with ASUS OUI identifier will be used
 117 instead.
 118 .El
 119 .Sh SEE ALSO
 120 .Xr arp 4 ,
 121 .Xr ifmedia 4 ,
 122 .Xr miibus 4 ,
 123 .Xr netintro 4 ,
 124 .Xr ng_ether 4 ,
 125 .Xr vlan 4 ,
 126 .Xr ifconfig 8
 127 .Sh HISTORY
 128 The
 129 .Nm
 130 driver and this manual page was written by
 131 .An Stanislav Sedov Aq Mt stas@FreeBSD.org .
 132 It first appeared in
 133 .Fx 7.1 .
 134 .Sh BUGS
 135 The Attansic L2 FastEthernet contoller supports DMA but do not use a descriptor
 136 based transfer mechanism via scatter-gather DMA.
 137 Thus the data should be copied to/from the controller memory on each
 138 transmit/receive.
 139 Furthermore, a lot of data alignment restrictions apply.
 140 This may introduce a high CPU load on systems with heavy network activity.
 141 Luckily enough this should not be a problem on modern hardware as L2 does
 142 not support speeds faster than 100Mbps.