share/man/man7d/xge.7d

   1 '\" te
   2 .\" Copyright (c) 2005, Sun Microsystems 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 XGE 7D "Oct 3, 2005"
   7 .SH NAME
   8 xge \- Neterion Xframe 10Gigabit Ethernet Network Adapter driver
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 /dev/xge
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The \fBxge\fR 10 Gigabit Ethernet  driver is a multi-threaded, loadable,
  19 clonable, GLD-based STREAMS driver supporting  the Data Link Provider
  20 Interface, \fBdlpi\fR(7P), on S2IO Xframe 10-Gigabit Ethernet Network Adapter.
  21 .sp
  22 .LP
  23 The \fBxge\fR driver functions includes controller initialization, frame
  24 transmit and receive, promiscuous and multicast support, TCP and UDP checksum
  25 offload (IPv4 and IPv6), 9622-byte jumbo frame, and error recovery and
  26 reporting.
  27 .sp
  28 .LP
  29 The \fBxge\fR driver and hardware support the 10GBase-SR/W, LR/W, and ER/W
  30 \fI802.3\fR physical layer.
  31 .SH APPLICATION PROGRAMMING INTERFACE
  32 .sp
  33 .LP
  34 The cloning,  character-special device \fB/dev/xge\fR is used to access all
  35 Xframe devices installed within the system.
  36 .sp
  37 .LP
  38 The \fBxge\fR driver is managed by the \fBdladm\fR(1M) command line utility,
  39 which allows VLANs to be defined on top of xge  instances and for \fBxge\fR
  40 instances to be aggregated. See \fBdladm\fR(1M) for more details.
  41 .sp
  42 .LP
  43 The values returned by the driver in the DL_INFO_ACK primitive in response to
  44 the DL_INFO_REQ are as follows:
  45 .RS +4
  46 .TP
  47 .ie t \(bu
  48 .el o
  49 Maximum SDU is \fB9600\fR.
  50 .RE
  51 .RS +4
  52 .TP
  53 .ie t \(bu
  54 .el o
  55 Minimum SDU is \fB0\fR.
  56 .RE
  57 .RS +4
  58 .TP
  59 .ie t \(bu
  60 .el o
  61 \fBDSLAP\fR address length is \fB8\fR bytes.
  62 .RE
  63 .RS +4
  64 .TP
  65 .ie t \(bu
  66 .el o
  67 \fBMAC\fR type is \fBDL_ETHER.\fR
  68 .RE
  69 .RS +4
  70 .TP
  71 .ie t \(bu
  72 .el o
  73 \fBSAP\fR length value is  -2 meaning the physical address component is
  74 followed immediately by a 2-byte sap component within the DLSAP address.
  75 .RE
  76 .RS +4
  77 .TP
  78 .ie t \(bu
  79 .el o
  80 Broadcast address value is Ethernet/IEEE  broadcast address
  81 (FF:FF:FF:FF:FF:FF).
  82 .RE
  83 .SH CONFIGURATION
  84 .sp
  85 .LP
  86 By default, the \fBxge\fR driver works without any configuration file.
  87 .sp
  88 .LP
  89 You can check the running-time status of a device  instance using
  90 \fBndd\fR(1M). Currently, the driver provides an interface to print all
  91 hardware statistics.
  92 .sp
  93 .LP
  94 For example, to print statistics of device xge0:
  95 .sp
  96 .in +2
  97 .nf
  98      #ndd /dev/xge0 stats
  99      tmac_data_octets 772
 100      tmac_frms 15
 101      tmac_drop_frms 0
 102      tmac_bcst_frms 6
 103      tmac_mcst_frms 6
 104
 105      ...
 106
 107      rmac_vld_frms 13
 108      rmac_fcs_err_frms 0
 109      rmac_drop_frms 0
 110      rmac_vld_bcst_frms 7
 111      rmac_vld_mcst_frms 11
 112      rmac_out_rng_len_err_frms 0
 113      rmac_in_rng_len_err_frms 0
 114      rmac_long_frms 0
 115
 116      ...
 117
 118      not_traffic_intr_cnt 242673
 119      traffic_intr_cnt 28
 120
 121      ...
 122 .fi
 123 .in -2
 124
 125 .SH FILES
 126 .sp
 127 .ne 2
 128 .na
 129 \fB\fB/dev/xge\fR \fR
 130 .ad
 131 .RS 13n
 132 \fBxge\fR special character device
 133 .RE
 134
 135 .SH ATTRIBUTES
 136 .sp
 137 .LP
 138 See \fBattributes\fR(5) for descriptions of the following attributes:
 139 .sp
 140
 141 .sp
 142 .TS
 143 box;
 144 l l
 145 l l .
 146 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 147 Architecture    x86
 148 .TE
 149
 150 .SH SEE ALSO
 151 .sp
 152 .LP
 153 \fBdladm\fR(1M), \fBndd\fR(1M), \fBattributes\fR(5), \fBstreamio\fR(7I),
 154 \fBdlpi\fR(7P)
 155 .sp
 156 .LP
 157 \fIWriting Device Drivers\fR
 158 .sp
 159 .LP
 160 \fISTREAMS Programming Guide\fR
 161 .sp
 162 .LP
 163 \fINetwork Interfaces Programmer's Guide\fR