usr/src/man/man7d/rge.7d

   1 '\" te
   2 .\" Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH RGE 7D "Dec 21, 2007"
   7 .SH NAME
   8 rge \- Realtek Gigabit/Fast Ethernet Network Adapter driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 /dev/rge
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBrge\fR Gigabit/Fast Ethernet driver is a multi-threaded,  loadable,
  19 clonable,  GLD-based  STREAMS  driver supporting  the Data Link Provider
  20 Interface, \fBdlpi\fR(7P), on  the Realtek Gigabit/Fast Ethernet Network
  21 Adapter.
  22 .sp
  23 .LP
  24 The \fBrge\fR driver functions includes controller initialization, frame
  25 transmit and receive, promiscuous and multicast support, and error recovery and
  26 reporting.
  27 .SH APPLICATION PROGRAMMING INTERFACE
  28 .sp
  29 .LP
  30 The cloning,  character-special device \fB/dev/rge\fR is  used to access all
  31 Realtek Gigabit/Fast Ethernet devices installed within the system.
  32 .sp
  33 .LP
  34 The \fBrge\fR driver is managed by the \fBdladm\fR(1M) command line utility,
  35 which allows VLANs to be defined on top of \fBrge\fR  instances and for
  36 \fBrge\fR instances to be aggregated. See \fBdladm\fR(1M) for more details.
  37 .sp
  38 .LP
  39 The values returned by the driver in the DL_INFO_ACK primitive in response to
  40 the DL_INFO_REQ are as follows:
  41 .RS +4
  42 .TP
  43 .ie t \(bu
  44 .el o
  45 Maximum SDU (with jumbo frame) is \fB7000\fR.
  46 .RE
  47 .RS +4
  48 .TP
  49 .ie t \(bu
  50 .el o
  51 Minimum SDU is \fB0\fR.
  52 .RE
  53 .RS +4
  54 .TP
  55 .ie t \(bu
  56 .el o
  57 \fBDSLAP\fR address length is \fB8\fR bytes.
  58 .RE
  59 .RS +4
  60 .TP
  61 .ie t \(bu
  62 .el o
  63 \fBMAC\fR type is \fBDL_ETHER.\fR
  64 .RE
  65 .RS +4
  66 .TP
  67 .ie t \(bu
  68 .el o
  69 \fBSAP\fR length value is  -2, meaning the physical address component is
  70 followed immediately by a 2-byte sap component within the DLSAP address.
  71 .RE
  72 .RS +4
  73 .TP
  74 .ie t \(bu
  75 .el o
  76 Broadcast address value is Ethernet/IEEE  broadcast address
  77 (FF:FF:FF:FF:FF:FF).
  78 .RE
  79 .sp
  80 .LP
  81 Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a
  82 particular Service Access Point (SAP) with the stream.
  83 .SH CONFIGURATION
  84 .sp
  85 .LP
  86 By default, the \fBrge\fR driver performs auto-negotiation to select the link
  87 speed and mode. Link speed and mode can be any one of the following:
  88 .RS +4
  89 .TP
  90 .ie t \(bu
  91 .el o
  92 1000 Mbps, full-duplex
  93 .RE
  94 .RS +4
  95 .TP
  96 .ie t \(bu
  97 .el o
  98 100 Mbps, full-duplex
  99 .RE
 100 .RS +4
 101 .TP
 102 .ie t \(bu
 103 .el o
 104 100 Mbps, half-duplex
 105 .RE
 106 .RS +4
 107 .TP
 108 .ie t \(bu
 109 .el o
 110 10 Mbps, full-duplex
 111 .RE
 112 .RS +4
 113 .TP
 114 .ie t \(bu
 115 .el o
 116 10 Mbps, half-duplex
 117 .RE
 118 .sp
 119 .LP
 120 Alternatively, you can set the capabilities advertised by the \fBrge\fR device
 121 using \fBndd\fR(1M). The driver supports a number of parameters whose names
 122 begin with \fBadv_\fR. Each of these parameters contains a boolean value that
 123 determines if the device advertises that mode of operation. The
 124 \fIadv_pause_cap\fR indicates if half/full duplex pause is advertised to link
 125 partner. You can set \fIadv_asym_pause_cap\fR to advertise to the link partner
 126 that asymmetric pause is desired.
 127 .sp
 128 .LP
 129 For example, to prevent the device 'rge2' from advertising gigabit
 130 capabilities, enter (as super-user):
 131 .sp
 132 .in +2
 133 .nf
 134 # ndd -set /dev/rge2 adv_1000fdx_cap 0
 135 .fi
 136 .in -2
 137
 138 .sp
 139 .LP
 140 All capabilities default to enabled. Note that changing any capability
 141 parameter causes the link to go down while the link partners renegotiate the
 142 link speed/duplex using the newly changed capabilities.
 143 .sp
 144 .LP
 145 You can find the current parameter settings by using \fBndd\fR \fB-get\fR. In
 146 addition, the driver exports the current state, speed, duplex setting, and
 147 working mode of the link via \fBndd\fR parameters (these are read only and may
 148 not be changed). For example, to check link state of device \fBrge0\fR:
 149 .sp
 150 .in +2
 151 .nf
 152 # ndd -get /dev/rge0 link_status
 153 1
 154 # ndd -get /dev/rge0 link_speed
 155 100
 156 # ndd -get /dev/rge0 link_duplex
 157 2
 158 .fi
 159 .in -2
 160
 161 .sp
 162 .LP
 163 The output above indicates that the link is up and running at 100Mbps
 164 full-duplex. In addition, the driver exports its working mode by
 165 \fIloop_mode\fR. If it is set to 0, the loopback mode is disabled.
 166 .SH FILES
 167 .sp
 168 .ne 2
 169 .na
 170 \fB\fB/dev/rge*\fR\fR
 171 .ad
 172 .RS 27n
 173 Character special device.
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fB/kernel/drv/rge\fR\fR
 180 .ad
 181 .RS 27n
 182 32-bit x86 \fBrge\fR driver binary.
 183 .RE
 184
 185 .sp
 186 .ne 2
 187 .na
 188 \fB\fB/kernel/drv/amd64/rge\fR\fR
 189 .ad
 190 .RS 27n
 191 64-bit x86 \fBrge\fR driver binary.
 192 .RE
 193
 194 .sp
 195 .ne 2
 196 .na
 197 \fB\fB/kernel/drv/sparcv9/rge\fR\fR
 198 .ad
 199 .RS 27n
 200 SPARC \fBrge\fR driver binary.
 201 .RE
 202
 203 .SH ATTRIBUTES
 204 .sp
 205 .LP
 206 See \fBattributes\fR(5) for a description of the following attributes:
 207 .sp
 208
 209 .sp
 210 .TS
 211 box;
 212 c | c
 213 l | l .
 214 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 215 _
 216 Architecture    SPARC, x86
 217 .TE
 218
 219 .SH SEE ALSO
 220 .sp
 221 .LP
 222 \fBdladm\fR(1M), \fBattributes\fR(5), \fBstreamio\fR(7I), \fBdlpi\fR(7P)
 223 .sp
 224 .LP
 225 \fIWriting Device Drivers\fR
 226 .sp
 227 .LP
 228 \fISTREAMS Programming Guide\fR
 229 .sp
 230 .LP
 231 \fINetwork Interfaces Programmer's Guide\fR