1 IXGBE(7D)                           Devices                          IXGBE(7D)
   2 
   3 
   4 
   5 NAME
   6        ixgbe - Intel 10Gb PCI Express NIC Driver
   7 
   8 SYNOPSIS
   9        /dev/ixgbe*
  10 
  11 
  12 DESCRIPTION
  13        The ixgbe 10 Gigabit Ethernet driver is a multi-threaded, loadable,
  14        clonable, GLD-based STREAMS driver supporting the Data Link Provider
  15        Interface, dlpi(7P), on Intel 10-Gigabit PCI Express Ethernet
  16        controllers.
  17 
  18 
  19        The ixgbe driver functions include controller initialization, frame
  20        transmit and receive, promiscuous and multicast support, and error
  21        recovery and reporting.
  22 
  23 
  24        The ixgbe driver supports the following Intel 10-Gigabit PCI Express
  25        Ethernet controllers:
  26 
  27            o      Intel Ethernet Controller 82598EB Family
  28 
  29            o      Intel Ethernet Controller 82599EB (X520) Family
  30 
  31            o      Intel Ethernet Controller X540 Family
  32 
  33            o      Intel Ethernet Controller X550 Family
  34 
  35        The ixgbe driver and hardware support auto-negotiation, a protocol
  36        specified by the IEEE 802.3ae specification.
  37 
  38 APPLICATION PROGRAMMING INTERFACE
  39        The cloning character-special device, /dev/ixgbe, is used to access all
  40        Intel 10-Gigabit PCI Express Ethernet devices installed within the
  41        system.
  42 
  43 
  44        The ixgbe driver is managed by the dladm(1M) command line utility,
  45        which allows VLANs to be defined on top of ixgbe instances and for
  46        ixgbe instances to be aggregated. See dladm(1M) for more details.
  47 
  48 
  49        You must send an explicit DL_ATTACH_REQ message to associate the opened
  50        stream with a particular device (PPA). The PPA ID is interpreted as an
  51        unsigned integer data type and indicates the corresponding device
  52        instance (unit) number. The driver returns an error (DL_ERROR_ACK) if
  53        the PPA field value does not correspond to a valid device instance
  54        number for the system. The device is initialized on first attach and
  55        de-initialized (stopped) at last detach.
  56 
  57 
  58        The values returned by the driver in the DL_INFO_ACK primitive in
  59        response to your DL_INFO_REQ are:
  60 
  61            o      Maximum SDU for Intel 82598EB is 16366.
  62 
  63            o      Maximum SDU for Intel 82599EB, X540 and X550 is 15500.
  64 
  65            o      Minimum SDU is 0.
  66 
  67            o      DLSAP address length is 8.
  68 
  69            o      MAC type is DL_ETHER.
  70 
  71            o      SAP (Service Access Point) length value is -2, meaning the
  72                   physical address component is followed immediately by a
  73                   2-byte SAP component within the DLSAP address.
  74 
  75            o      Broadcast address value is the Ethernet/IEEE broadcast
  76                   address (FF:FF:FF:FF:FF:FF).
  77 
  78                   Once in the DL_ATTACHED state, you must send a DL_BIND_REQ
  79                   to associate a particular SAP with the stream.
  80 
  81 CONFIGURATION
  82        By default, the ixgbe driver performs auto-negotiation to select the
  83        link speed and mode. Link speed and mode can only be 10000 Mbps full-
  84        duplex for fiber, and only 10000, 1000, or 100 Mbps full-duplex for
  85        copper. See the IEEE802.3 standard for more information.
  86 
  87 FILES
  88        /dev/ixgbe*
  89                                     Special character device.
  90 
  91 
  92        /kernel/drv/amd64/ixgbe
  93                                     Device driver (x86)
  94 
  95 
  96        /kernel/drv/sparcv9/ixgbe
  97                                     Device driver (SPARC)
  98 
  99 
 100        /kernel/drv/ixgbe.conf
 101                                     Driver configuration file
 102 
 103 
 104 ATTRIBUTES
 105        See attributes(5) for descriptions of the following attributes:
 106 
 107 
 108 
 109 
 110        +--------------------+-----------------+
 111        |  ATTRIBUTE TYPE    | ATTRIBUTE VALUE |
 112        +--------------------+-----------------+
 113        |Architecture        | SPARC, x86      |
 114        +--------------------+-----------------+
 115        |Interface Stability | Committed       |
 116        +--------------------+-----------------+
 117 
 118 SEE ALSO
 119        dladm(1M), netstat(1M), driver.conf(4), attributes(5), streamio(7I),
 120        dlpi(7P)
 121 
 122 
 123        Writing Device Drivers
 124 
 125 
 126        STREAMS Programming Guide
 127 
 128 
 129        Network Interfaces Programmer's Guide
 130 
 131 
 132        IEEE 802.3ae Specification, IEEE - 2002
 133 
 134 
 135 
 136                                January 10, 2020                      IXGBE(7D)