1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright(c) 2020 Intel Corporation 3 4Intel(R) ACC100 5G/4G FEC Poll Mode Driver 5========================================== 6 7The BBDEV ACC100 5G/4G FEC poll mode driver (PMD) supports an 8implementation of a VRAN FEC wireless acceleration function. 9This device is also known as Mount Bryce. 10 11Features 12-------- 13 14ACC100 5G/4G FEC PMD supports the following features: 15 16- LDPC Encode in the DL (5GNR) 17- LDPC Decode in the UL (5GNR) 18- Turbo Encode in the DL (4G) 19- Turbo Decode in the UL (4G) 20- 16 VFs per PF (physical device) 21- Maximum of 128 queues per VF 22- PCIe Gen-3 x16 Interface 23- MSI 24- SR-IOV 25 26ACC100 5G/4G FEC PMD supports the following BBDEV capabilities: 27 28* For the LDPC encode operation: 29 - ``RTE_BBDEV_LDPC_CRC_24B_ATTACH`` : set to attach CRC24B to CB(s) 30 - ``RTE_BBDEV_LDPC_RATE_MATCH`` : if set then do not do Rate Match bypass 31 - ``RTE_BBDEV_LDPC_INTERLEAVER_BYPASS`` : if set then bypass interleaver 32 33* For the LDPC decode operation: 34 - ``RTE_BBDEV_LDPC_CRC_TYPE_24B_CHECK`` : check CRC24B from CB(s) 35 - ``RTE_BBDEV_LDPC_ITERATION_STOP_ENABLE`` : disable early termination 36 - ``RTE_BBDEV_LDPC_CRC_TYPE_24B_DROP`` : drops CRC24B bits appended while decoding 37 - ``RTE_BBDEV_LDPC_HQ_COMBINE_IN_ENABLE`` : provides an input for HARQ combining 38 - ``RTE_BBDEV_LDPC_HQ_COMBINE_OUT_ENABLE`` : provides an input for HARQ combining 39 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_IN_ENABLE`` : HARQ memory input is internal 40 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_OUT_ENABLE`` : HARQ memory output is internal 41 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_LOOPBACK`` : loopback data to/from HARQ memory 42 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_FILLERS`` : HARQ memory includes the fillers bits 43 - ``RTE_BBDEV_LDPC_DEC_SCATTER_GATHER`` : supports scatter-gather for input/output data 44 - ``RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION`` : supports compression of the HARQ input/output 45 - ``RTE_BBDEV_LDPC_LLR_COMPRESSION`` : supports LLR input compression 46 47* For the turbo encode operation: 48 - ``RTE_BBDEV_TURBO_CRC_24B_ATTACH`` : set to attach CRC24B to CB(s) 49 - ``RTE_BBDEV_TURBO_RATE_MATCH`` : if set then do not do Rate Match bypass 50 - ``RTE_BBDEV_TURBO_ENC_INTERRUPTS`` : set for encoder dequeue interrupts 51 - ``RTE_BBDEV_TURBO_RV_INDEX_BYPASS`` : set to bypass RV index 52 - ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER`` : supports scatter-gather for input/output data 53 54* For the turbo decode operation: 55 - ``RTE_BBDEV_TURBO_CRC_TYPE_24B`` : check CRC24B from CB(s) 56 - ``RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE`` : perform subblock de-interleave 57 - ``RTE_BBDEV_TURBO_DEC_INTERRUPTS`` : set for decoder dequeue interrupts 58 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_IN`` : set if negative LLR encoder i/p is supported 59 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_IN`` : set if positive LLR encoder i/p is supported 60 - ``RTE_BBDEV_TURBO_DEC_TB_CRC_24B_KEEP`` : keep CRC24B bits appended while decoding 61 - ``RTE_BBDEV_TURBO_EARLY_TERMINATION`` : set early termination feature 62 - ``RTE_BBDEV_TURBO_DEC_SCATTER_GATHER`` : supports scatter-gather for input/output data 63 - ``RTE_BBDEV_TURBO_HALF_ITERATION_EVEN`` : set half iteration granularity 64 65Installation 66------------ 67 68Section 3 of the DPDK manual provides instructions on installing and compiling DPDK. 69 70DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual. 71The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The 72hugepage configuration of a server may be examined using: 73 74.. code-block:: console 75 76 grep Huge* /proc/meminfo 77 78 79Initialization 80-------------- 81 82When the device first powers up, its PCI Physical Functions (PF) can be listed through this command: 83 84.. code-block:: console 85 86 sudo lspci -vd8086:0d5c 87 88The physical and virtual functions are compatible with Linux UIO drivers: 89``vfio`` and ``igb_uio``. However, in order to work the ACC100 5G/4G 90FEC device first needs to be bound to one of these linux drivers through DPDK. 91 92 93Bind PF UIO driver(s) 94~~~~~~~~~~~~~~~~~~~~~ 95 96Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use 97``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver. 98 99The igb_uio driver may be bound to the PF PCI device using one of three methods: 100 101 1021. PCI functions (physical or virtual, depending on the use case) can be bound to 103the UIO driver by repeating this command for every function. 104 105.. code-block:: console 106 107 cd <dpdk-top-level-directory> 108 insmod ./build/kmod/igb_uio.ko 109 echo "8086 0d5c" > /sys/bus/pci/drivers/igb_uio/new_id 110 lspci -vd8086:0d5c 111 112 1132. Another way to bind PF with DPDK UIO driver is by using the ``dpdk-devbind.py`` tool 114 115.. code-block:: console 116 117 cd <dpdk-top-level-directory> 118 ./usertools/dpdk-devbind.py -b igb_uio 0000:06:00.0 119 120where the PCI device ID (example: 0000:06:00.0) is obtained using lspci -vd8086:0d5c 121 122 1233. A third way to bind is to use ``dpdk-setup.sh`` tool 124 125.. code-block:: console 126 127 cd <dpdk-top-level-directory> 128 ./usertools/dpdk-setup.sh 129 130 select 'Bind Ethernet/Crypto/Baseband device to IGB UIO module' 131 enter PCI device ID 132 select 'Display current Ethernet/Crypto/Baseband device settings' to confirm binding 133 134In a similar way the ACC100 5G/4G FEC PF may be bound with vfio-pci as any PCIe device. 135 136Enable Virtual Functions 137~~~~~~~~~~~~~~~~~~~~~~~~ 138 139Now, it should be visible in the printouts that PCI PF is under igb_uio control 140"``Kernel driver in use: igb_uio``" 141 142To show the number of available VFs on the device, read ``sriov_totalvfs`` file.. 143 144.. code-block:: console 145 146 cat /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/sriov_totalvfs 147 148 where 0000\:<b>\:<d>.<f> is the PCI device ID 149 150 151To enable VFs via igb_uio, echo the number of virtual functions intended to 152enable to ``max_vfs`` file.. 153 154.. code-block:: console 155 156 echo <num-of-vfs> > /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/max_vfs 157 158 159Afterwards, all VFs must be bound to appropriate UIO drivers as required, same 160way it was done with the physical function previously. 161 162Enabling SR-IOV via vfio driver is pretty much the same, except that the file 163name is different: 164 165.. code-block:: console 166 167 echo <num-of-vfs> > /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/sriov_numvfs 168 169 170Configure the VFs through PF 171~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 172 173The PCI virtual functions must be configured before working or getting assigned 174to VMs/Containers. The configuration involves allocating the number of hardware 175queues, priorities, load balance, bandwidth and other settings necessary for the 176device to perform FEC functions. 177 178This configuration needs to be executed at least once after reboot or PCI FLR and can 179be achieved by using the function ``acc100_configure()``, which sets up the 180parameters defined in ``acc100_conf`` structure. 181 182Test Application 183---------------- 184 185BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing 186the functionality of ACC100 5G/4G FEC encode and decode, depending on the device's 187capabilities. The test application is located under app->test-bbdev folder and has the 188following options: 189 190.. code-block:: console 191 192 "-p", "--testapp-path": specifies path to the bbdev test app. 193 "-e", "--eal-params" : EAL arguments which are passed to the test app. 194 "-t", "--timeout" : Timeout in seconds (default=300). 195 "-c", "--test-cases" : Defines test cases to run. Run all if not specified. 196 "-v", "--test-vector" : Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data). 197 "-n", "--num-ops" : Number of operations to process on device (default=32). 198 "-b", "--burst-size" : Operations enqueue/dequeue burst size (default=32). 199 "-s", "--snr" : SNR in dB used when generating LLRs for bler tests. 200 "-s", "--iter_max" : Number of iterations for LDPC decoder. 201 "-l", "--num-lcores" : Number of lcores to run (default=16). 202 "-i", "--init-device" : Initialise PF device with default values. 203 204 205To execute the test application tool using simple decode or encode data, 206type one of the following: 207 208.. code-block:: console 209 210 ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_dec_default.data 211 ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_enc_default.data 212 213 214The test application ``test-bbdev.py``, supports the ability to configure the PF device with 215a default set of values, if the "-i" or "- -init-device" option is included. The default values 216are defined in test_bbdev_perf.c. 217 218 219Test Vectors 220~~~~~~~~~~~~ 221 222In addition to the simple LDPC decoder and LDPC encoder tests, bbdev also provides 223a range of additional tests under the test_vectors folder, which may be useful. The results 224of these tests will depend on the ACC100 5G/4G FEC capabilities which may cause some 225testcases to be skipped, but no failure should be reported. 226