Documentation/devicetree/bindings/net/hisilicon-hns-nic.txt

   1 Hisilicon Network Subsystem NIC controller
   2
   3 Required properties:
   4 - compatible: "hisilicon,hns-nic-v1" or "hisilicon,hns-nic-v2".
   5   "hisilicon,hns-nic-v1" is for hip05.
   6   "hisilicon,hns-nic-v2" is for Hi1610 and Hi1612.
   7 - ae-handle: accelerator engine handle for hns,
   8   specifies a reference to the associating hardware driver node.
   9   see Documentation/devicetree/bindings/net/hisilicon-hns-dsaf.txt
  10 - port-id: is the index of port provided by DSAF (the accelerator). DSAF can
  11   connect to 8 PHYs. Port 0 to 1 are both used for administration purpose. They
  12   are called debug ports.
  13
  14   The remaining 6 PHYs are taken according to the mode of DSAF.
  15
  16   In NIC mode of DSAF, all 6 PHYs are taken as ethernet ports to the CPU. The
  17   port-id can be 2 to 7. Here is the diagram:
  18             +-----+---------------+
  19             |            CPU      |
  20             +-+-+-+---+-+-+-+-+-+-+
  21               | |     | | | | | |
  22              debug       service
  23              port         port
  24              (0,1)       (2-7)
  25
  26   In Switch mode of DSAF, all 6 PHYs are taken as physical ports connect to a
  27   LAN Switch while the CPU side assume itself have one single NIC connect to
  28   this switch. In this case, the port-id will be 2 only.
  29             +-----+---------------+
  30             |            CPU      |
  31             +-+-+-+---+-+-+-+-+-+-+
  32               | |   service| port(2)
  33              debug   +------------+
  34              port    |   switch   |
  35              (0,1)   +-+-+-+-+-+-++
  36                        | | | | | |
  37                       external port
  38
  39   This attribute is remained for compatible purpose. It is not recommended to
  40   use it in new code.
  41
  42 - port-idx-in-ae: is the index of port provided by AE.
  43   In NIC mode of DSAF, all 6 PHYs of service DSAF are taken as ethernet ports
  44   to the CPU. The port-idx-in-ae can be 0 to 5. Here is the diagram:
  45             +-----+---------------+
  46             |            CPU      |
  47             +-+-+-+---+-+-+-+-+-+-+
  48               |    |   | | | | | |
  49            debug debug   service
  50            port  port     port
  51            (0)   (0)     (0-5)
  52
  53   In Switch mode of DSAF, all 6 PHYs of service DSAF are taken as physical
  54   ports connected to a LAN Switch while the CPU side assume itself have one
  55   single NIC connected to this switch. In this case, the port-idx-in-ae
  56   will be 0 only.
  57             +-----+-----+------+------+
  58             |                CPU      |
  59             +-+-+-+-+-+-+-+-+-+-+-+-+-+
  60               |    |     service| port(0)
  61             debug debug  +------------+
  62             port  port   |   switch   |
  63             (0)   (0)    +-+-+-+-+-+-++
  64                           | | | | | |
  65                          external port
  66
  67 - local-mac-address: mac addr of the ethernet interface
  68
  69 Example:
  70
  71         ethernet@0{
  72                 compatible = "hisilicon,hns-nic-v1";
  73                 ae-handle = <&dsaf0>;
  74                 port-idx-in-ae = <0>;
  75                 local-mac-address = [a2 14 e4 4b 56 76];
  76         };