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