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