share/man/man7d/pcn.7d

   1 '\" te
   2 .\" Copyright 2011 Jason King.  All rights reserved.
   3 .\" Copyright (c) 2001-2007 by Garrett D'Amore.
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions are met:
   6 .\" 1. Redistributions of source code must retain the above copyright notice,
   7 .\"    this list of conditions and the following disclaimer.
   8 .\" 2. Redistributions in binary form must reproduce the above copyright notice,
   9 .\"    this list of conditions and the following disclaimer in the documentation
  10 .\"    and/or other materials provided with the distribution.
  11 .\" 3. Neither the name of the author nor the names of any co-contributors may
  12 .\"    be used to endorse or promote products derived from this software
  13 .\"    without specific prior written permission.
  14 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS
  15 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  16 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
  18 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  19 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  20 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  21 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  22 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  23 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  24 .\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE
  25 .\" Portions Copyright (c) 2007 by Sun Microsystems, Inc.  All Rights Reserved.
  26
  27 .TH "PCN" "7D" "Sep 16, 2011"
  28 .
  29 .SH "NAME"
  30 \fBpcn\fR \- PCnet Ethernet device driver
  31 .SH "SYNOPSIS"
  32 .LP
  33 .nf
  34 \fB/dev/pcn\fR
  35 .fi
  36
  37 .SH "DESCRIPTION"
  38 .sp
  39 .LP
  40 The \fBpcn\fR driver is a multi\-threaded, loadable, clonable GLDv3\-based
  41 STREAMS driver supporting the Data Link Provider Interface \fBdlpi\fR(7P) for
  42 the AMD PCnet family of Ethernet controllers\.
  43 .SH "APPLICATION PROGRAMMING INTERFACE"
  44 The \fBpcn\fR driver can be used as either a "style 1" or a "style 2" Data Link
  45 Service Provider\. Physical points of attachment (PPAs) are interpreted as the
  46 instance number of the \fBpcn\fR controller as assigned by the
  47 operating environment\.
  48 .sp
  49 .LP
  50 The values returned by the driver in the \fBDL_INFO_ACK\fR response are:
  51 .RS +4
  52 .TP
  53 .ie t \(bu
  54 .el o
  55 Maximum SDU is 1500\.
  56 .RE
  57 .RS +4
  58 .TP
  59 .ie t \(bu
  60 .el o
  61 Minimum SDU is 0\.
  62 .RE
  63 .RS +4
  64 .TP
  65 .ie t \(bu
  66 .el o
  67 The dlsap address length is 8\.
  68 .RE
  69 .RS +4
  70 .TP
  71 .ie t \(bu
  72 .el o
  73 MAC type is \fBDL_ETHER\fR\.
  74 .RE
  75 .RS +4
  76 .TP
  77 .ie t \(bu
  78 .el o
  79 SAP length is \-2\. The 6\-byte physical address is immediately followed by a
  80 2\-byte SAP\.
  81 .RE
  82 .RS +4
  83 .TP
  84 .ie t \(bu
  85 .el o
  86 Service mode is \fBDL_CLDLS\fR\.
  87 .RE
  88 .RS +4
  89 .TP
  90 .ie t \(bu
  91 .el o
  92 The broadcast address is the 6\-byte Ethernet broadcast address
  93 (\fBff:ff:ff:ff:ff:ff\fR)\.
  94 .SH "CONFIGURATION"
  95 .sp
  96 .LP
  97 The \fBpcn\fR driver performs auto-negotiation to select the link speed and
  98 mode\.  Link sped may be 100Mbps full\-duplex, 100Mbps half\-duplex,
  99 10Mbps full\-duplex, or 10Mbps half\-duplex, depending on the hardware
 100 adapter type\.  See the \fIIEEE802.3\fR standard for more information\.
 101 .sp
 102 .LP
 103 The capabilities advertised by the \fBpcn\fR device can be set using
 104 \fBdladm\fR(1m)\.  The driver supports a number of parameters whose names
 105 being with \fBen_\fR (see below)\.  Each of these parameters contains a
 106 boolean value that determines if the devices advertises that mode of
 107 operations\.  The \fBadv_autoneg_cap\fR parameter controls whether
 108 auto-negotioation is performed\.  If \fBadv_autoneg_cap\fR is set to 0, the
 109 driver forces the mode of operation selected by the first non-zero
 110 parameter in priority order as shown below:
 111 .sp
 112 .in +2
 113 .nf
 114                             (highest priority/greatest throughput)
 115         en_100fdx_cap           100Mbps full duplex
 116         en_10fdx_cap            10Mbps full duplex
 117                          (lowest priority/least throughput)
 118 .fi
 119 .in -2
 120
 121 .sp
 122 .LP
 123 All capabilities default to enabled\.  Note that changing any capability
 124 parameter causes te link to go down while the link partners renegotiate
 125 the link speed/duplex using the newly changed capabilities\.
 126 .SH "ATTRIBUTES"
 127 .sp
 128 .LP
 129 See \fBattributes\fR(5) for a description of the following attributes:
 130 .sp
 131
 132 .sp
 133 .TS
 134 box;
 135 c | c
 136 l | l .
 137 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 138 _
 139 Architecture    x86
 140 _
 141 Interface Stability     Committed
 142 .TE
 143
 144 .SH "FILES"
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB/dev/pcn\fR\fR
 149 .ad
 150 .sp .6
 151 .RS 4n
 152 Special character device\.
 153 .RE
 154
 155 .sp
 156 .ne 2
 157 .na
 158 \fB\fB/kernel/drv/pcn\fR\fR
 159 .ad
 160 .sp 6
 161 .RS 4n
 162 32\-bit driver binary\.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB/kernel/drv/amd64/pcn\fR\fR
 169 .ad
 170 .sp .6
 171 .RS 4n
 172 64\-bit driver binary (x86)\.
 173 .RE
 174
 175 .SH "SEE ALSO"
 176 .sp
 177 .LP
 178 \fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7p)
 179 .sp
 180 .LP
 181 \fIIEEE 802.3\fR \(em Institute of Electrical and Electronics Engineers, 2002