1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2020 Intel Corporation
4 Intel(R) ACC100 5G/4G FEC Poll Mode Driver
5 ==========================================
7 The BBDEV ACC100 5G/4G FEC poll mode driver (PMD) supports an
8 implementation of a VRAN FEC wireless acceleration function.
9 This device is also known as Mount Bryce.
14 ACC100 5G/4G FEC PMD supports the following features:
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
26 ACC100 5G/4G FEC PMD supports the following BBDEV capabilities:
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
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
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
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
68 Section 3 of the DPDK manual provides instuctions on installing and compiling DPDK. The
69 default set of bbdev compile flags may be found in config/common_base, where for example
70 the flag to build the ACC100 5G/4G FEC device, ``CONFIG_RTE_LIBRTE_PMD_BBDEV_ACC100``,
73 DPDK requires hugepages to be configured as detailed in section 2 of the DPDK manual.
74 The bbdev test application has been tested with a configuration 40 x 1GB hugepages. The
75 hugepage configuration of a server may be examined using:
77 .. code-block:: console
79 grep Huge* /proc/meminfo
85 When the device first powers up, its PCI Physical Functions (PF) can be listed through this command:
87 .. code-block:: console
89 sudo lspci -vd8086:0d5c
91 The physical and virtual functions are compatible with Linux UIO drivers:
92 ``vfio`` and ``igb_uio``. However, in order to work the ACC100 5G/4G
93 FEC device first needs to be bound to one of these linux drivers through DPDK.
99 Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
100 ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
102 The igb_uio driver may be bound to the PF PCI device using one of three methods:
105 1. PCI functions (physical or virtual, depending on the use case) can be bound to
106 the UIO driver by repeating this command for every function.
108 .. code-block:: console
110 cd <dpdk-top-level-directory>
111 insmod ./build/kmod/igb_uio.ko
112 echo "8086 0d5c" > /sys/bus/pci/drivers/igb_uio/new_id
116 2. Another way to bind PF with DPDK UIO driver is by using the ``dpdk-devbind.py`` tool
118 .. code-block:: console
120 cd <dpdk-top-level-directory>
121 ./usertools/dpdk-devbind.py -b igb_uio 0000:06:00.0
123 where the PCI device ID (example: 0000:06:00.0) is obtained using lspci -vd8086:0d5c
126 3. A third way to bind is to use ``dpdk-setup.sh`` tool
128 .. code-block:: console
130 cd <dpdk-top-level-directory>
131 ./usertools/dpdk-setup.sh
133 select 'Bind Ethernet/Crypto/Baseband device to IGB UIO module'
135 select 'Display current Ethernet/Crypto/Baseband device settings' to confirm binding
137 In a similar way the ACC100 5G/4G FEC PF may be bound with vfio-pci as any PCIe device.
139 Enable Virtual Functions
140 ~~~~~~~~~~~~~~~~~~~~~~~~
142 Now, it should be visible in the printouts that PCI PF is under igb_uio control
143 "``Kernel driver in use: igb_uio``"
145 To show the number of available VFs on the device, read ``sriov_totalvfs`` file..
147 .. code-block:: console
149 cat /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/sriov_totalvfs
151 where 0000\:<b>\:<d>.<f> is the PCI device ID
154 To enable VFs via igb_uio, echo the number of virtual functions intended to
155 enable to ``max_vfs`` file..
157 .. code-block:: console
159 echo <num-of-vfs> > /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/max_vfs
162 Afterwards, all VFs must be bound to appropriate UIO drivers as required, same
163 way it was done with the physical function previously.
165 Enabling SR-IOV via vfio driver is pretty much the same, except that the file
168 .. code-block:: console
170 echo <num-of-vfs> > /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/sriov_numvfs
173 Configure the VFs through PF
174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
176 The PCI virtual functions must be configured before working or getting assigned
177 to VMs/Containers. The configuration involves allocating the number of hardware
178 queues, priorities, load balance, bandwidth and other settings necessary for the
179 device to perform FEC functions.
181 This configuration needs to be executed at least once after reboot or PCI FLR and can
182 be achieved by using the function ``acc100_configure()``, which sets up the
183 parameters defined in ``acc100_conf`` structure.
188 BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing
189 the functionality of ACC100 5G/4G FEC encode and decode, depending on the device's
190 capabilities. The test application is located under app->test-bbdev folder and has the
193 .. code-block:: console
195 "-p", "--testapp-path": specifies path to the bbdev test app.
196 "-e", "--eal-params" : EAL arguments which are passed to the test app.
197 "-t", "--timeout" : Timeout in seconds (default=300).
198 "-c", "--test-cases" : Defines test cases to run. Run all if not specified.
199 "-v", "--test-vector" : Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data).
200 "-n", "--num-ops" : Number of operations to process on device (default=32).
201 "-b", "--burst-size" : Operations enqueue/dequeue burst size (default=32).
202 "-s", "--snr" : SNR in dB used when generating LLRs for bler tests.
203 "-s", "--iter_max" : Number of iterations for LDPC decoder.
204 "-l", "--num-lcores" : Number of lcores to run (default=16).
205 "-i", "--init-device" : Initialise PF device with default values.
208 To execute the test application tool using simple decode or encode data,
209 type one of the following:
211 .. code-block:: console
213 ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_dec_default.data
214 ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_enc_default.data
217 The test application ``test-bbdev.py``, supports the ability to configure the PF device with
218 a default set of values, if the "-i" or "- -init-device" option is included. The default values
219 are defined in test_bbdev_perf.c.
225 In addition to the simple LDPC decoder and LDPC encoder tests, bbdev also provides
226 a range of additional tests under the test_vectors folder, which may be useful. The results
227 of these tests will depend on the ACC100 5G/4G FEC capabilities which may cause some
228 testcases to be skipped, but no failure should be reported.