Print this page
13071 igb(7D) needs to mention it's GLDv3, not STREAMS
Change-Id: Ib06c11b0fa59bfe7383aaac5a3f791cc740d99c4
   1 IGB(7D)                             Devices                            IGB(7D)
   2 
   3 
   4 
   5 NAME
   6        igb - Intel 82575 1Gb PCI Express NIC Driver
   7 
   8 SYNOPSIS
   9        /dev/igb*
  10 
  11 
  12 DESCRIPTION
  13        The igb 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 82575 Gigabit Ethernet controllers.
  16 

  17 
  18        The igb driver functions include controller  initialization, frame
  19        transmit and receive, promiscuous and multicast support, and error
  20        recovery and reporting.
  21 

  22 
  23        The igb driver and hardware support auto-negotiation, a protocol
  24        specified by the 1000  Base-T  standard.  Auto-negotiation allows each
  25        device to advertise its capabilities and discover those of its peer
  26        (link partner).  The highest common  denominator  supported  by  both
  27        link  partners  is automatically  selected,  yielding  the  greatest
  28        available throughput, while requiring no manual configuration. The igb
  29        driver also allows you to configure the advertised capabilities to less
  30        than the maximum (where the full speed  of  the interface is not
  31        required), or to force a specific mode of operation, irrespective of
  32        the  link  partner's  advertised capabilities.
  33 
  34 APPLICATION PROGRAMMING INTERFACE
  35        The cloning character-special device,  /dev/igb, is used to access all
  36        Intel 82575 Gigabit devices installed within the system.
  37 

  38 
  39        The igb driver is managed  by the dladm(1M) command  line utility,
  40        which allows  VLANs to be defined on top of igb instances and  for igb
  41        instances to be aggregated.  See dladm(1M) for more details.
  42 

  43 
  44        You must send an explicit DL_ATTACH_REQ message to associate the opened
  45        stream with a particular device (PPA). The PPA ID is interpreted as an
  46        unsigned integer data type and  indicates the corresponding device
  47        instance (unit) number. The driver returns an error (DL_ERROR_ACK) if
  48        the PPA field value does not correspond to a valid device instance
  49        number for the system. The device is initialized on first attach and
  50        de-initialized (stopped) at last detach.
  51 

  52 
  53        The values returned by the driver in the DL_INFO_ACK primitive in
  54        response to your DL_INFO_REQ are:
  55 
  56            o      Maximum SDU is 9000.
  57 
  58            o      Minimum SDU is 0.

  59 
  60            o      DLSAP address length is 8.
  61 
  62            o      MAC type is DL_ETHER.
  63 
  64            o      SAP (Service Access Point) length value is -2, meaning the
  65                   physical address component is followed immediately by a
  66                   2-byte SAP component within the DLSAP address.
  67 
  68            o      Broadcast address value is the Ethernet/IEEE broadcast
  69                   address (FF:FF:FF:FF:FF:FF).


  70 
  71                   Once in the DL_ATTACHED state, you must send a DL_BIND_REQ
  72                   to associate a particular SAP with the stream.

  73 
  74 CONFIGURATION
  75        By default, the  igb driver performs auto-negotiation to select the
  76        link speed and mode. Link speed and mode can be any one of the
  77        following, (as described in  the IEEE803.2 standard):



  78 
  79 
  80        1000 Mbps, full-duplex.
  81 
  82 
  83        100 Mbps, full-duplex.
  84 
  85 
  86        100 Mbps, half-duplex.
  87 
  88 
  89        10 Mbps, full-duplex.
  90 
  91 
  92        10 Mbps, half-duplex.
  93 
  94 
  95        The auto-negotiation protocol automatically selects speed (1000 Mbps,
  96        100 Mbps, or 10 Mbps) and operation mode (full-duplex or half-duplex)
  97        as the highest common denominator supported by both link partners.
  98 
  99 
 100        Alternatively, you can set the capabilities advertised by the igb
 101        device using ndd(1M). The driver supports a number of parameters whose
 102        names begin with adv_ (see below). Each of these parameters contains a
 103        boolean value that determines if the device advertises that mode of
 104        operation. For example,  the adv_1000fdx_cap parameter indicates if
 105        1000M full duplex is advertised to link partner. The  adv_autoneg cap
 106        parameter controls whether auto-negotiation is performed. If
 107        adv_autoneg_cap is set to 0, the driver forces the mode of operation
 108        selected by the first  non-zero parameter in priority order as shown
 109        below:
 110 
 111                                  (highest priority/greatest throughput)
 112                  adv_1000fdx_cap         1000Mbps full duplex
 113                  adv_100fdx_cap          100Mbps full duplex
 114                  adv_100hdx_cap          100Mbps half duplex
 115                  adv_10fdx_cap           10Mbps full duplex
 116                  adv_10hdx_cap           10Mbps half duplex
 117                                          (lowest priority/least throughput)
 118 
 119 
 120 
 121        All capabilities default to enabled. Note that changing any capability
 122        parameter causes the link to go down while the link partners
 123        renegotiate the link speed/duplex using the newly changed capabilities.
 124 
 125 FILES
 126        /dev/igb*
 127                                   Special character device.
 128 

 129 
 130        /kernel/drv/igb
 131                                   32-bit device driver (x86).
 132 

 133 
 134        /kernel/drv/amd64/igb
 135                                   64-bit device driver (x86).
 136 
 137 
 138        /kernel/drv/sparcv9/igb
 139                                   64-bit device driver (SPARC).
 140 
 141 
 142        /kernel/drv/igb.conf
 143                                   Configuration file.
 144 
 145 
 146 SEE ALSO
 147        dladm(1M), ndd(1M), netstat(1M), driver.conf(4), attributes(5),
 148        streamio(7I), dlpi(7P),
 149 
 150 
 151        Writing Device Drivers
 152 
 153 
 154        STREAMS Programming Guide
 155 
 156 
 157        Network Interfaces Programmer's Guide
 158 
 159 
 160 
 161                                  July 20, 2007                         IGB(7D)
   1 IGB(7D)                             Devices                            IGB(7D)
   2 


   3 NAME
   4      igb - Intel 1 GbE Server NIC Driver
   5 
   6 SYNOPSIS
   7      /dev/net/igb*
   8 

   9 DESCRIPTION
  10      The igb driver is a GLDv3 NIC driver for Intel 1 Gigabit Ethernet PCIe
  11      controllers which are built-in to motherboards and discrete PCIe devices.

  12 
  13      The driver supports the following device families:
  14 
  15      -   Intel 82575 Gigabit Ethernet Controller


  16 
  17      -   Intel 82576 Gigabit Ethernet Controller
  18 
  19      -   Intel 82580 Gigabit Ethernet Controller









  20 
  21      -   Intel Ethernet Controller I210


  22 
  23      -   Intel Ethernet Controller I211
  24 
  25      -   Intel Ethernet Controller I350


  26 
  27      Many other Intel 1 GbE devices are supported by the e1000g(7D) driver.
  28 
  29      The driver supports the following functionality depending on the
  30      controller generation:





  31 
  32      -   Jumbo frames up to 9000 bytes.
  33 
  34      -   Checksum offload for TCP and UDP on IPv4 and IPv6.  Checksum offload
  35          for IPv4 headers.
  36 
  37      -   TCP Segmentation Offload (TSO) over IPv4 and IPv6
  38 
  39      -   Support for multiple hardware rings, enabling receive-side steering
  40          (RSS) and multiple MAC address filters.
  41 
  42      -   Promiscuous access via snoop(1M) and dlpi(7P)
  43 
  44      -   LED control
  45 
  46      -   Link auto-negotiation, manual link controls, and IEEE 802.3x flow
  47          control

  48 
  49 APPLICATION PROGRAMMING INTERFACE
  50      For each supported device instance, which corresponds to a port, a
  51      character-special file is created.  This device can be used with the Data
  52      Link Provider Interface (DLPI) through either libdlpi(3LIB) or dlpi(7P).
  53 
  54      Each instance is assigned a unique ascending integer identifier starting
  55      from zero.  The first instance in the system would be enumerated with the
  56      id 0 and be named igb0 and be found in the file system at /dev/net/igb0.
  57 
  58 CONFIGURATION
  59      The igb driver supports operating at 1 Gbps full-duplex, 100 Mbps full
  60      and half-duplex, and 10 Mbps full and half-duplex.  By default, the
  61      device will use auto-negotiation and prefer the highest compatible speed.
  62      The advertised speeds and broader configuration can be observed and
  63      modified with dladm(1M).  While driver.conf(4) based configuration is
  64      possible, it is recommended that dladm(1M) is used wherever possible.
  65 














































  66 FILES
  67      /dev/net/igb*                     igb special character device.

  68 
  69      /kernel/drv/amd64/igb             x86 device driver.
  70 
  71      /kernel/drv/sparcv9/igb           SPARC device driver

  72 
  73      /kernel/drv/igb.conf              Configuration file.
  74 












  75 SEE ALSO
  76      dladm(1M), libdlpi(1M), driver.conf(4), e1000g(7D), dlpi(7P), mac(9E)

  77 
  78 illumos                       September 14, 2020                       illumos