intel1g: Draft of Intel 1G (I350, etc) driver

src/apps/intel/README.md

@@ -112,6 +112,51 @@ Each physical Intel 82599 port supports the use of up to:
 * 64 VLANs (see the `vlan` configuration option)
 * 4 *mirror pools* (see the `mirror` configuration option)
 
+## Intel1G (apps.intel.intel1g.intel1g)
+
+The `intel1g` app drives one port of an Intel Gigabit Ethernet
+controller.
+
+Hardware support:
+- Intel I350 (in progress)
+
+Features:
+- Optionally attach to a pre-initialized NIC.
+- Optionally use specific TX and RX queue numbers (or none).
+- Configuration and statistics registers are mirrored to shared memory objects (NYI).
+- Receive and transmit links are optional and can have any name.
+
+![Intel1G](.images/Intel1G.png)
+
+### Configuration
+
+— Key **pciaddr**
+
+*Required*. The PCI address of the NIC as a string.
+
+— Key **attach**
+
+*Optional*. True means attach to a transmit and/or receive queue of an already-initialized NIC.
+
+— Key **txq**
+
+*Optional*. Transmit queue number to use. `false` means no transmit function. Default: 0.
+
+— Key **rxq**
+
+*Optional*. Receive queue number to use. `false` means no receive function. Default: 0.
+
+— Key **ndesc**
+
+*Optional*. Number of DMA descriptors to use i.e. size of the DMA
+transmit and receive queues. Default is not specified but assumed to
+be broadly applicable.
+
+— Key **rxburst**
+
+*Optional*. Maximum number of packets to receive on one
+breath. Default is not specified but assumed to be broadly applicable.
+
 ## LoadGen (apps.intel.loadgen)
 
 `LoadGen` is a *load generator* app based on the Intel 82599 Ethernet

src/apps/intel/README.md.src

@@ -117,6 +117,56 @@ Each physical Intel 82599 port supports the use of up to:
 * 64 VLANs (see the `vlan` configuration option)
 * 4 *mirror pools* (see the `mirror` configuration option)
 
+## Intel1G (apps.intel.intel1g.intel1g)
+
+The `intel1g` app drives one port of an Intel Gigabit Ethernet
+controller.
+
+Hardware support:
+- Intel I350 (in progress)
+
+Features:
+- Optionally attach to a pre-initialized NIC.
+- Optionally use specific TX and RX queue numbers (or none).
+- Configuration and statistics registers are mirrored to shared memory objects (NYI).
+- Receive and transmit links are optional and can have any name.
+
+    DIAGRAM: Intel1G
+              +----------+
+              |          |
+         -=-->* Intel1G  *--=->
+              |          |
+              +----------+
+
+### Configuration
+
+— Key **pciaddr**
+
+*Required*. The PCI address of the NIC as a string.
+
+— Key **attach**
+
+*Optional*. True means attach to a transmit and/or receive queue of an already-initialized NIC.
+
+— Key **txq**
+
+*Optional*. Transmit queue number to use. `false` means no transmit function. Default: 0.
+
+— Key **rxq**
+
+*Optional*. Receive queue number to use. `false` means no receive function. Default: 0.
+
+— Key **ndesc**
+
+*Optional*. Number of DMA descriptors to use i.e. size of the DMA
+transmit and receive queues. Default is not specified but assumed to
+be broadly applicable.
+
+— Key **rxburst**
+
+*Optional*. Maximum number of packets to receive on one
+breath. Default is not specified but assumed to be broadly applicable.
+
 ## LoadGen (apps.intel.loadgen)
 
 `LoadGen` is a *load generator* app based on the Intel 82599 Ethernet