Docs: Intel N3000 FPGA Support - FEC Interface Support

[Ghada Khalil]

This is a documentation request for the Intel N3000 FPGA Integration - Storyboard: StoryBoard: https://storyboard.openstack.org/#!/story/2006740

Developer Contact: <email address hidden>

Feature Description
-------------------
The Intel N3000 FPGA also supports forward error correction (FEC) capabilities which are exposed as a PCI device that may be used by a DPDK enabled container application to perform accelerated 5G LDPC encoding and decoding operations.

After the FPGA device is programmed, the FEC device with device id 0xd8f may be seen in the list of host devices:

system host-device-list <worker-node>

+------------------+--------------+----------+-----------+-----------+---------------------------+-------------------------+-------------------------------------+-----------+---------+
| name | address | class id | vendor id | device id | class name | vendor name | device name | numa_node | enabled |
+------------------+--------------+----------+-----------+-----------+---------------------------+-------------------------+-------------------------------------+-----------+---------+

| pci_0000_b7_00_0 | 0000:b7:00.0 | 120000 | 8086 | 0d8f | Processing accelerators | Intel Corporation | Device 0d8f | 1 | True |

...

To enable the FEC device for SR-IOV, it must be modified to set the number of virtual functions (VFs), as well as setting the appropriate userspace drivers for the physical function (PF) and VF. For example:

system host-lock <worker>
system host-device-modify <worker> <name> --driver <vf driver> --vf-driver <vf driver> -N <number of vfs> system host-unlock <worker>

The supported PF driver(s) are:
- igb_uio

The supported VF driver(s) are currently:
- igb_uio
- vfio

To pass the FEC device to a container, the following requests/limits must be entered into the pod specification:

intel.com/intel_fpga_fec: '<number of vfs>'

For example:

apiVersion: v1
kind: Pod
metadata:
  name: 5gnr
  annotations:
    k8s.v1.cni.cncf.io/networks: '[
            { "name": "sriov1" }
    ]'
spec:
  restartPolicy: Never
  containers:
  - name: 5gnr
    image: "5gnr-image"
    volumeMounts:
    - mountPath: /mnt/huge-1048576kB
      name: hugepage
    stdin: true
    tty: true
    resources:
      requests:
        memory: 4Gi
        intel.com/intel_fpga_fec: '1'
        intel.com/pci_sriov_net_datanetwork_a: '1'
      limits:
        hugepages-1Gi: 4Gi
        memory: 4Gi
        intel.com/intel_fpga_fec: '1'
        intel.com/pci_sriov_net_datanetwork_a: '1'
  volumes:
  - name: hugepage
    emptyDir:
      medium: HugePages

[Ghada Khalil (gkhalil)]

Doc updates for an stx.4.0 feature

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/739088

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/739088
Committed: https://git.openstack.org/cgit/starlingx/docs/commit/?id=31a46c273c44e61ac430b7755867bf989a0d5282
Submitter: Zuul
Branch: master

commit 31a46c273c44e61ac430b7755867bf989a0d5282
Author: MCamp859 <email address hidden>
Date: Thu Jul 2 12:10:15 2020 -0400

    Add Intel N3000 FPGA Guide

    Include sections for Device Flashing & FEC interface

    Closes-Bug: 1884776

    Closes-Bug: 1885053

    Change-Id: If34e9e11b6ac1670334eb130a1d42bd5820b7e7a
    Signed-off-by: MCamp859 <email address hidden>

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: r/stx.4.0
Review: https://review.opendev.org/741673

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/741673
Committed: https://git.openstack.org/cgit/starlingx/docs/commit/?id=e9cdf644f8d8255c6f0df569dec5470669f499b9
Submitter: Zuul
Branch: r/stx.4.0

commit e9cdf644f8d8255c6f0df569dec5470669f499b9
Author: MCamp859 <email address hidden>
Date: Thu Jul 2 12:10:15 2020 -0400

    Add Intel N3000 FPGA Guide

    Include sections for Device Flashing & FEC interface

    Closes-Bug: 1884776

    Closes-Bug: 1885053

    Change-Id: If34e9e11b6ac1670334eb130a1d42bd5820b7e7a
    Signed-off-by: MCamp859 <email address hidden>
    (cherry picked from commit 31a46c273c44e61ac430b7755867bf989a0d5282)