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$
  26 .\"
  27 .Dd October 24, 2018
  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 DEPRECATION NOTICE
  48 The
  49 .Nm
  50 driver is not present in
  51 .Fx 13.0
  52 and later.
  53 See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
  54 information.
  55 .Sh DESCRIPTION
  56 The
  57 .Nm
  58 device driver provides support for Attansic/Atheros L2 PCIe FastEthernet
  59 controllers.
  60 .Pp
  61 The controller supports hardware Ethernet checksum processing, hardware
  62 VLAN tag stripping/insertion and an interrupt moderation mechanism.
  63 Attansic L2 also features a 64-bit multicast hash filter.
  64 .Pp
  65 The
  66 .Nm
  67 driver supports the following media types:
  68 .Bl -tag -width ".Cm 10baseT/UTP"
  69 .It Cm autoselect
  70 Enable autoselection of the media type and options.
  71 The user can manually override the autoselected mode by
  72 adding media options to
  73 .Xr rc.conf 5 .
  74 .It Cm 10baseT/UTP
  75 Select 10Mbps operation.
  76 .It Cm 100baseTX
  77 Set 100Mbps (FastEthernet) operation.
  78 .El
  79 .Pp
  80 The
  81 .Nm
  82 driver provides support for the following media options:
  83 .Bl -tag -width ".Cm full-duplex"
  84 .It Cm full-duplex
  85 Force full duplex operation.
  86 .It Cm half-duplex
  87 Force half duplex operation.
  88 .El
  89 .Pp
  90 For more information on configuring this device, see
  91 .Xr ifconfig 8 .
  92 .Sh HARDWARE
  93 The
  94 .Nm
  95 driver supports Attansic/Atheros L2 PCIe FastEthernet controllers, and
  96 is known to support the following hardware:
  97 .Pp
  98 .Bl -bullet -compact
  99 .It
 100 ASUS EeePC 701
 101 .It
 102 ASUS EeePC 900
 103 .El
 104 .Pp
 105 Other hardware may or may not work with this driver.
 106 .Sh LOADER TUNABLES
 107 Tunables can be set at the
 108 .Xr loader 8
 109 prompt before booting the kernel or stored in
 110 .Xr loader.conf 5 .
 111 .Bl -tag -width "xxxxxx"
 112 .It Va hw.ae.msi_disable
 113 This tunable disables MSI support on the Ethernet hardware.
 114 The default value is 0.
 115 .El
 116 .Sh SYSCTL VARIABLES
 117 The
 118 .Nm
 119 driver collects a number of useful MAC counter during the work.
 120 The statistics is available via the
 121 .Va dev.ae.%d.stats
 122 .Xr sysctl 8
 123 tree, where %d corresponds to the controller number.
 124 .Sh DIAGNOSTICS
 125 .Bl -diag
 126 .It "ae%d: watchdog timeout."
 127 The device has stopped responding to the network, or there is a problem with
 128 the network connection (cable).
 129 .It "ae%d: reset timeout."
 130 The card reset operation has been timed out.
 131 .It "ae%d: Generating random ethernet address."
 132 No valid Ethernet address was found in the controller NVRAM and registers.
 133 Random locally administered address with ASUS OUI identifier will be used
 134 instead.
 135 .El
 136 .Sh SEE ALSO
 137 .Xr altq 4 ,
 138 .Xr arp 4 ,
 139 .Xr miibus 4 ,
 140 .Xr netintro 4 ,
 141 .Xr ng_ether 4 ,
 142 .Xr vlan 4 ,
 143 .Xr ifconfig 8
 144 .Sh HISTORY
 145 The
 146 .Nm
 147 driver and this manual page was written by
 148 .An Stanislav Sedov Aq Mt stas@FreeBSD.org .
 149 It first appeared in
 150 .Fx 7.1 .
 151 .Sh BUGS
 152 The Attansic L2 FastEthernet controller supports DMA but does not use a
 153 descriptor based transfer mechanism via scatter-gather DMA.
 154 Thus the data should be copied to/from the controller memory on each
 155 transmit/receive.
 156 Furthermore, a lot of data alignment restrictions apply.
 157 This may introduce a high CPU load on systems with heavy network activity.
 158 Luckily enough this should not be a problem on modern hardware as L2 does
 159 not support speeds faster than 100Mbps.