Manual Pages for UNIX Operating System command usage for man hxge

Devices                                                  hxge(7D)



NAME
     hxge - Sun Blade 10 Gigabit Ethernet network driver

SYNOPSIS
     /dev/hxge*


DESCRIPTION
     The hxge Gigabit Ethernet driver is a multi-threaded,  load-
     able, clonable, GLD-based STREAMS driver supporting the Data
     Link Provider Interface, dlpi(7P), on the Sun  Blade  Shared
     10Gb Ethernet Interface.


     The Shared PCI-Express 10 Gb networking  interface  provides
     network  I/O  consolidation  for  up  to  six  Constellation
     blades, with each blade seeing its own portion of  the  net-
     work interface.


     The hxge driver functions include chip initialization, frame
     transmit  and  receive,  flow  classification, multicast and
     promiscuous support and error recovery and reporting in  the
     blade domain.

APPLICATION PROGRAMMING INTERFACE
     The cloning character-special device, /dev/hxge, is used  to
     access  Sun  Blade  Shared  10Gb  Ethernet Interface devices
     installed within the system.


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


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


     The values returned by the driver in the DL_INFO_ACK  primi-
     tive in response to a DL_INFO_REQ are:

         o    Maximum  SDU  is  1500  (ETHERMTU  -   defined   in
              ).



SunOS 5.11          Last change: 10 Feb 2007                    1






Devices                                                  hxge(7D)



         o    Minimum SDU is 0.

         o    DLSAP address length is 8.

         o    MAC type is DL_ETHER.

         o    SAP  length  value  is  -2,  meaning  the  physical
              address  component  is followed immediately by a 2-
              byte SAP component within the DLSAP address.

         o    Broadcast address value is the Ethernet/IEEE broad-
              cast address (FF:FF:FF:FF:FF:FF).

              Due to the nature of the  link  address  definition
              for  IPoIB, the DL_SET_PHYS_ADDR_REQ DLPI primitive
              is not supported.

              In the transmit case for streams that have been put
              in raw mode via the DLIOCRAW ioctl, the dlpi appli-
              cation must prepend the 20 byte  IPoIB  destination
              address  to the data it wants to transmit over-the-
              wire. In the receive case, applications receive the
              IP/ARP  datagram along with the IETF defined 4 byte
              header.


     Once in the DL_ATTACHED state, you must send  a  DL_BIND_REQ
     to  associate  a  particular Service Access Point (SAP) with
     the stream.

CONFIGURATION
     The link speed and mode are fixed at 10 Gbps full-duplex.


     The default MTU is 1500. To enable jumbo frame support,  you
     configure  the hxge driver by defining the accept-jumbo pro-
     perty to 1 in the hxge.conf  file.  Note  that  the  largest
     jumbo size is 9178 bytes.


     The driver may be configured to discard certain  classes  of
     traffic.  By  default,  no  class of traffic is allowed. You
     configure the hxge driver by defining the class option  pro-
     perty to 0x20000 in hxge.conf to discard the specified class
     of traffic. For example, the  following  line  in  hxge.conf
     discards all IP Version 4 TCP traffic:

       class-opt-ipv4-tcp = 0x20000;







SunOS 5.11          Last change: 10 Feb 2007                    2






Devices                                                  hxge(7D)



     You can also use the ndd(1M) command to configure  the  hxge
     driver at runtime to discard any classes of traffic.


     The hxgedriver supports the  self-healing  functionality  of
     Solaris    OS.    By    default    it   is   configured   to
     DDI_FM_EREPORT_CAPABLE | DDI_FM_ERRCB_CAPABLE. You configure
     the  hxge  driver  by  defining  the  fm-capable property in
     hxge.conf to other capabilities or  to  0x0  to  disable  it
     entirely.


     The  hxge  driver  may  be  configured  using  the  standard
     ifconfig(1M) command.


     The hxge driver also reports various hardware  and  software
     statistics  data.  You  can  view these statistics using the
     kstat(1M) command.

FILES
     /dev/hxge*                  Special character device.


     /kernel/drv/hxge            32-bit device driver (x86).


     /kernel/drv/sparcv9/hxge    64-bit device driver (SPARC).


     /kernel/drv/amd64/hxge      64-bit device driver (x86).


     /kernel/drv/hxge.conf       Configuration file.


ATTRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     ____________________________________________________________
    |       ATTRIBUTE TYPE        |       ATTRIBUTE VALUE       |
    |_____________________________|_____________________________|
    | Architecture                | SPARC, x86                  |
    |_____________________________|_____________________________|


SEE ALSO
     dladm(1M), ifconfig(1M),  kstat(1M),  ndd(1M),  netstat(1M),
     driver.conf(4), attributes(5), streamio(7I), dlpi(7P)



SunOS 5.11          Last change: 10 Feb 2007                    3






Devices                                                  hxge(7D)



     Writing Device Drivers


     STREAMS Programming Guide


     Network Interfaces Programmer's Guide
















































SunOS 5.11          Last change: 10 Feb 2007                    4