share/man/man7d/myri10ge.7d

   1 '\" te
   2 .\" Copyright (c) 2007-2009 Myricom, Inc. All Rights Reserved. Use is subject to license terms.
   3 .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   4 .\" 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
   5 .\" or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add
   6 .\" 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]
   7 .TH MYRI10GE 7D "Sep 10, 2009"
   8 .SH NAME
   9 myri10ge \- Myricom Myri10GE 10Gb PCI Express NIC Driver
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 /dev/myri10ge*
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 The \fBmyri10ge\fR Gigabit Ethernet driver is a multi-threaded, loadable,
  20 clonable, GLD-based STREAMS driver that supports the Data Link Provider
  21 Interface, \fBdlpi\fR(7P), on Myricom Myri10GE 10-Gigabit Ethernet controllers.
  22 .sp
  23 .LP
  24 The \fBmyri10ge\fR driver functions include controller initialization, frame
  25 transmit and receive, promiscuous and multicast support, multiple transmit and
  26 receive queues, support for TCP Large Send Offload, support for TCP Large
  27 Receive Offload, and error recovery and reporting.
  28 .SS "Application Programming Interface"
  29 .sp
  30 .LP
  31 The cloning character-special device, \fB/dev/myri10ge\fR, is used to access
  32 all Myricom Myri10GE 10 -Gigabit Ethernet dev ices installed within the system.
  33 .sp
  34 .LP
  35 The \fBmyri10ge\fR driver is managed by the \fBdladm\fR(8) command line
  36 utility. dladm allows VLANs to be defined on top of \fBmyri10ge\fR instances
  37 and for \fBmyri10ge\fR instances to be aggregated. See \fBdladm\fR(8) for more
  38 details.
  39 .sp
  40 .LP
  41 You must send an explicit \fBDL_ATTACH_REQ\fR message to associate the opened
  42 stream with a particular device (\fBPPA\fR). The \fBPPA\fR ID is interpreted as
  43 an unsigned integer data type and indicates the corresponding device instance
  44 (unit) number. The driver returns an error (\fBDL_ERROR_ACK\fR) if the
  45 \fBPPA\fR field value does not correspond to a valid device instance number for
  46 the system. The device is initialized on first attach and de-initialized
  47 (stopped) at last detach.
  48 .sp
  49 .LP
  50 The values returned by the driver in the \fBDL_INFO_ACK\fR primitive in
  51 response to your \fBDL_INFO_REQ\fR are:
  52 .RS +4
  53 .TP
  54 .ie t \(bu
  55 .el o
  56 Maximum \fBSDU\fR is \fB9000\fR.
  57 .RE
  58 .RS +4
  59 .TP
  60 .ie t \(bu
  61 .el o
  62 Minimum \fBSDU\fR is \fB0\fR.
  63 .RE
  64 .RS +4
  65 .TP
  66 .ie t \(bu
  67 .el o
  68 \fBDLSAP\fR address length is \fB8\fR.
  69 .RE
  70 .RS +4
  71 .TP
  72 .ie t \(bu
  73 .el o
  74 \fBMAC\fR type is \fBDL_ETHER\fR.
  75 .RE
  76 .RS +4
  77 .TP
  78 .ie t \(bu
  79 .el o
  80 \fBSAP\fR (Service Access Point) length value is \fB-2\fR, meaning the physical
  81 address component is followed immediately by a 2-byte \fBSAP\fR component
  82 within the \fBDLSAP\fR address.
  83 .RE
  84 .RS +4
  85 .TP
  86 .ie t \(bu
  87 .el o
  88 Broadcast address value is the Ethernet/IEEE broad- cast address
  89 (\fBFF:FF:FF:FF:FF:FF\fR).
  90 .RE
  91 .RS +4
  92 .TP
  93 .ie t \(bu
  94 .el o
  95 Once in the \fBDL_ATTACHED\fR state, you must send a \fBDL_BIND_REQ\fR to
  96 associate a particular SAP with the stream.
  97 .RE
  98 .SS "Configuration"
  99 .sp
 100 .LP
 101 Link speed and mode can only be 10000 Mbps full-duplex. See the \fIIEEE 802.3
 102 Standard\fR for more information.
 103 .SH FILES
 104 .sp
 105 .ne 2
 106 .na
 107 \fB\fB/dev/myri10ge*\fR\fR
 108 .ad
 109 .sp .6
 110 .RS 4n
 111 Special character device.
 112 .RE
 113
 114 .sp
 115 .ne 2
 116 .na
 117 \fB\fB/kernel/drv/myri10ge\fR\fR
 118 .ad
 119 .sp .6
 120 .RS 4n
 121 32-bit device driver (x86)
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fB/kernel/drv/amd64/myri10ge\fR\fR
 128 .ad
 129 .sp .6
 130 .RS 4n
 131 64-bit device driver (x86)
 132 .RE
 133
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fB/kernel/drv/sparcv9/myri10ge\fR\fR
 138 .ad
 139 .sp .6
 140 .RS 4n
 141 64-bit device driver (SPARC)
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fB/kernel/drv/myri10ge.conf\fR\fR
 148 .ad
 149 .sp .6
 150 .RS 4n
 151 Configuration file
 152 .RE
 153
 154 .SH ATTRIBUTES
 155 .sp
 156 .LP
 157 See \fBattributes\fR(5) for a description of the following attributes:
 158 .sp
 159
 160 .sp
 161 .TS
 162 box;
 163 c | c
 164 l | l .
 165 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 166 _
 167 Architecture    SPARC, x86
 168 _
 169 Interface Stability     Committed
 170 .TE
 171
 172 .SH SEE ALSO
 173 .sp
 174 .LP
 175 \fBdladm\fR(8), \fBnetstat\fR(8), \fBdriver.conf\fR(4), \fBattributes\fR(5),
 176 \fBdlpi\fR(7P), \fBstreamio\fR(7I)
 177 .sp
 178 .LP
 179 \fIWriting Device Drivers\fR
 180 .sp
 181 .LP
 182 \fINetwork Interface Guide\fR
 183 .sp
 184 .LP
 185 \fISTREAMS Programming Guide\fR
 186 .sp
 187 .LP
 188 \fIIEEE 802.3 Standard\fR