share/man/man7d/hxge.7d

   1 '\" te
   2 .\" Copyright (c) 2008, 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 HXGE 7D "Feb 10, 2007"
   7 .SH NAME
   8 hxge \- Sun Blade 10 Gigabit Ethernet network driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 /dev/hxge*
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBhxge\fR Gigabit Ethernet driver is a multi-threaded, loadable, clonable,
  19 GLD-based STREAMS driver supporting the Data Link Provider Interface,
  20 \fBdlpi\fR(7P), on the Sun Blade Shared 10Gb Ethernet Interface.
  21 .sp
  22 .LP
  23 The Shared PCI-Express 10 Gb networking interface provides network I/O
  24 consolidation for up to six Constellation blades, with each blade seeing its
  25 own portion of the network interface.
  26 .sp
  27 .LP
  28 The \fBhxge\fR driver functions include chip initialization, frame transmit and
  29 receive, flow classification, multicast and promiscuous support and error
  30 recovery and reporting in the blade domain.
  31 .SH APPLICATION PROGRAMMING INTERFACE
  32 .sp
  33 .LP
  34 The cloning character-special device, \fB/dev/hxge\fR, is used  to access Sun
  35 Blade Shared 10Gb Ethernet Interface devices installed within the system.
  36 .sp
  37 .LP
  38 The \fBhxge\fR driver is managed by the \fBdladm\fR(8) command line utility,
  39 which allows VLANs to be defined on top of \fBhxge\fR  instances and for
  40 \fBhxge\fR instances to be aggregated. See \fBdladm\fR(8) for more details.
  41 .sp
  42 .LP
  43 You must send an explicit DL_ATTACH_REQ message to associate the opened stream
  44 with a particular device (PPA). The PPA ID is interpreted as an unsigned
  45 integer data type and indicates the corresponding device instance (unit)
  46 number. The driver returns an error (DL_ERROR_ACK) if the PPA field value does
  47 not correspond to a valid device instance number for the system. The device is
  48 initialized  on  first  attach and de-initialized (stopped) at last detach
  49 .sp
  50 .LP
  51 The values returned by the driver in the DL_INFO_ACK primitive in response to a
  52 DL_INFO_REQ are:
  53 .RS +4
  54 .TP
  55 .ie t \(bu
  56 .el o
  57 Maximum SDU is 1500 (ETHERMTU - defined in <\fBsys/ethernet.h\fR>).
  58 .RE
  59 .RS +4
  60 .TP
  61 .ie t \(bu
  62 .el o
  63 Minimum SDU is 0.
  64 .RE
  65 .RS +4
  66 .TP
  67 .ie t \(bu
  68 .el o
  69 DLSAP address length is 8.
  70 .RE
  71 .RS +4
  72 .TP
  73 .ie t \(bu
  74 .el o
  75 MAC type is \fBDL_ETHER\fR.
  76 .RE
  77 .RS +4
  78 .TP
  79 .ie t \(bu
  80 .el o
  81 \fBSAP\fR length value is \fI-2\fR, meaning the physical address component is
  82 followed immediately by a 2-byte \fBSAP\fR component within the \fBDLSAP\fR
  83 address.
  84 .RE
  85 .RS +4
  86 .TP
  87 .ie t \(bu
  88 .el o
  89 Broadcast address value is the Ethernet/IEEE broadcast address
  90 (FF:FF:FF:FF:FF:FF).
  91 .sp
  92 Due to the nature of the link address definition for IPoIB, the
  93 DL_SET_PHYS_ADDR_REQ DLPI primitive is not supported.
  94 .sp
  95 In the transmit case for streams that have been put in raw mode via the
  96 DLIOCRAW ioctl, the \fBdlpi\fR application must prepend the 20 byte IPoIB
  97 destination address to the data it wants to transmit over-the-wire. In the
  98 receive case, applications receive the IP/ARP datagram along with the IETF
  99 defined 4 byte header.
 100 .RE
 101 .sp
 102 .LP
 103 Once in the DL_ATTACHED state, you must send a DL_BIND_REQ to associate a
 104 particular Service Access Point (SAP) with the stream.
 105 .SH CONFIGURATION
 106 .sp
 107 .LP
 108 The link speed and mode are fixed at 10 Gbps full-duplex.
 109 .sp
 110 .LP
 111 The default MTU is 1500. To enable jumbo frame support, you configure the
 112 \fBhxge\fR driver by defining the accept-jumbo property to 1 in the
 113 \fBhxge.conf\fR file. Note that the largest jumbo size is 9178 bytes.
 114 .sp
 115 .LP
 116 The driver may be configured to discard certain classes of traffic. By default,
 117 no class of traffic is allowed. You configure the \fBhxge\fR driver by defining
 118 the class option property to 0x20000 in \fBhxge.conf\fR to discard the
 119 specified class of traffic. For example, the following line in \fBhxge.conf\fR
 120 discards all IP Version 4 TCP traffic:
 121 .sp
 122 .in +2
 123 .nf
 124 class-opt-ipv4-tcp = 0x20000;
 125 .fi
 126 .in -2
 127
 128 .sp
 129 .LP
 130 You can also use the \fBndd\fR(8) command to configure the \fBhxge\fR driver
 131 at runtime to discard any classes of traffic.
 132 .sp
 133 .LP
 134 The \fBhxge\fRdriver supports the self-healing functionality of Solaris OS. By
 135 default it is configured to      DDI_FM_EREPORT_CAPABLE | DDI_FM_ERRCB_CAPABLE.
 136 You configure the \fBhxge\fR driver by defining the fm-capable property in
 137 \fBhxge.conf\fR to other capabilities or to 0x0 to disable it entirely.
 138 .sp
 139 .LP
 140 The \fBhxge\fR driver may be configured using the standard \fBifconfig\fR(8)
 141 command.
 142 .sp
 143 .LP
 144 The \fBhxge\fR driver also reports various hardware and software statistics
 145 data. You can view these statistics using the \fBkstat\fR(8) command.
 146 .SH FILES
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fB/dev/hxge*\fR\fR
 151 .ad
 152 .RS 28n
 153 Special character device.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fB/kernel/drv/hxge\fR\fR
 160 .ad
 161 .RS 28n
 162 32-bit device driver (x86).
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fB/kernel/drv/sparcv9/hxge\fR\fR
 169 .ad
 170 .RS 28n
 171 64-bit device driver (SPARC).
 172 .RE
 173
 174 .sp
 175 .ne 2
 176 .na
 177 \fB\fB/kernel/drv/amd64/hxge\fR\fR
 178 .ad
 179 .RS 28n
 180 64-bit device driver (x86).
 181 .RE
 182
 183 .sp
 184 .ne 2
 185 .na
 186 \fB\fB/kernel/drv/hxge.conf\fR\fR
 187 .ad
 188 .RS 28n
 189 Configuration file.
 190 .RE
 191
 192 .SH ATTRIBUTES
 193 .sp
 194 .LP
 195 See \fBattributes\fR(5) for descriptions of the following attributes:
 196 .sp
 197
 198 .sp
 199 .TS
 200 box;
 201 c | c
 202 l | l .
 203 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 204 _
 205 Architecture    SPARC, x86
 206 .TE
 207
 208 .SH SEE ALSO
 209 .sp
 210 .LP
 211 \fBdladm\fR(8), \fBifconfig\fR(8), \fBkstat\fR(8), \fBndd\fR(8),
 212 \fBnetstat\fR(8), \fBdriver.conf\fR(4), \fBattributes\fR(5),
 213 \fBstreamio\fR(7I), \fBdlpi\fR(7P)
 214 .sp
 215 .LP
 216 \fIWriting Device Drivers\fR
 217 .sp
 218 .LP
 219 \fISTREAMS Programming Guide\fR
 220 .sp
 221 .LP
 222 \fINetwork Interfaces Programmer's Guide\fR