share/man/man4/cm.4

   1 .\"
   2 .\" Copyright (c) 2004 Tom Rhodes
   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 July 16, 2005
  29 .Dt CM 4
  30 .Os
  31 .Sh NAME
  32 .Nm cm
  33 .Nd "SMC Arcnet Ethernet device driver"
  34 .Sh SYNOPSIS
  35 To compile this driver into the kernel,
  36 place the following lines in your kernel
  37 configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device isa"
  40 .Cd "device cm"
  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_cm_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides support for the
  53 .Tn Arcnet
  54 .Tn ISA
  55 network adapters.
  56 .Pp
  57 This driver also has quirks preset in the
  58 .Xr device.hints 5
  59 file for card detection.
  60 .Sh HARDWARE
  61 The
  62 .Nm
  63 driver supports the following
  64 card models:
  65 .Pp
  66 .Bl -bullet -compact
  67 .It
  68 SMC90c26
  69 .It
  70 SMC90c56
  71 .It
  72 SMC90c66 in '56 compatibility mode.
  73 .El
  74 .Sh IMPLEMENTATION NOTES
  75 When the
  76 .Va NOARP
  77 flag is set on the
  78 .Nm
  79 interface,
  80 it does not employ the address resolution protocol described in
  81 .Xr arp 4
  82 to dynamically map between Internet and Ethernet addresses on
  83 the local network.
  84 Instead it uses the least significant 8 bits of the
  85 .Tn IP
  86 address as the hardware address
  87 like described in
  88 .Tn RFC
  89 1051
  90 and
  91 .Tn RFC
  92 1201.
  93 .Pp
  94 With the
  95 .Dv IFF_LINK0
  96 flag cleared
  97 .Tn IP/ARP/RARP
  98 encoding is done according to
  99 .Tn RFC
 100 1201
 101 that is, with Packet Header Definition Standard header and packet type
 102 212 / 213.
 103 The
 104 .Tn MTU
 105 is normally 1500.
 106 The
 107 .Dv IFF_LINK0
 108 flag is cleared by default.
 109 .Pp
 110 With the
 111 .Dv IFF_LINK0
 112 flag set,
 113 .Tn IP
 114 and
 115 .Tn ARP
 116 encoding is done according to the deprecated
 117 .Tn RFC
 118 1051 encoding, that is with simple header, packet type 240 / 241,
 119 and the
 120 .Tn MTU
 121 is 507.
 122 .Pp
 123 When switching between the two modes, use
 124 .Dl ifconfig interfacename down up
 125 to switch the
 126 .Tn MTU .
 127 .Sh DIAGNOSTICS
 128 The following driver specific error messages
 129 may be reported:
 130 .Bl -diag
 131 .It "reset: card reset, link addr = 0x%02x (cm%d)"
 132 The card is being reset and a new link address assigned.
 133 .It "srint: restarted rx on buf cm%d"
 134 The rx buffer has been emptied and will be reset.
 135 .El
 136 .Sh SEE ALSO
 137 .Xr netintro 4 ,
 138 .Xr watchdog 4 ,
 139 .Xr device.hints 5 ,
 140 .Xr ifconfig 8 ,
 141 .Xr watchdog 8
 142 .Sh HISTORY
 143 The
 144 .Nm
 145 device was ported from
 146 .Nx
 147 by
 148 .An Max Khon Aq fjoe@FreeBSD.org
 149 and first appeared in
 150 .Fx 4.6 .
 151 This manual page first appeared in
 152 .Fx 5.3 .
 153 .Sh AUTHORS
 154 This manual page was written by
 155 .An Tom Rhodes Aq trhodes@FreeBSD.org .
 156 The
 157 .Sx IMPLEMENTATION NOTES
 158 section was submitted by
 159 .An Max Khon Aq fjoe@FreeBSD.org
 160 and originated from
 161 .Nx .
 162 .Sh BUGS
 163 The
 164 .Nm
 165 driver code could do with a bit of improvement,
 166 it would be nice if some one could come along and take care of this.
 167 .Pp
 168 The
 169 .Sx IMPLEMENTATION NOTES
 170 section is specific to all Arcnet
 171 devices (see
 172 .Pa sys/net/if_arcsubr.c )
 173 and should be moved to a more generic location.