1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2020 Intel Corporation
4 Intel(R) ACC100 and ACC101 5G/4G FEC Poll Mode Drivers
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.
10 The BBDEV ACC101, also known as Mount Cirrus, is a derivative device from Mount Bryce
11 with functional and capacity improvements but still with the same exposed BBDEV capabilities.
16 ACC100 and ACC101 5G/4G FEC PMDs support the following features:
18 - LDPC Encode in the DL (5GNR)
19 - LDPC Decode in the UL (5GNR)
20 - Turbo Encode in the DL (4G)
21 - Turbo Decode in the UL (4G)
22 - 16 VFs per PF (physical device)
23 - Maximum of 128 queues per VF
24 - PCIe Gen-3 x16 Interface
28 ACC100 and ACC101 5G/4G FEC PMDs support the following BBDEV capabilities:
30 * For the LDPC encode operation:
31 - ``RTE_BBDEV_LDPC_CRC_24B_ATTACH`` : set to attach CRC24B to CB(s)
32 - ``RTE_BBDEV_LDPC_RATE_MATCH`` : if set then do not do Rate Match bypass
33 - ``RTE_BBDEV_LDPC_INTERLEAVER_BYPASS`` : if set then bypass interleaver
35 * For the LDPC decode operation:
36 - ``RTE_BBDEV_LDPC_CRC_TYPE_24B_CHECK`` : check CRC24B from CB(s)
37 - ``RTE_BBDEV_LDPC_ITERATION_STOP_ENABLE`` : disable early termination
38 - ``RTE_BBDEV_LDPC_CRC_TYPE_24B_DROP`` : drops CRC24B bits appended while decoding
39 - ``RTE_BBDEV_LDPC_HQ_COMBINE_IN_ENABLE`` : provides an input for HARQ combining
40 - ``RTE_BBDEV_LDPC_HQ_COMBINE_OUT_ENABLE`` : provides an input for HARQ combining
41 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_IN_ENABLE`` : HARQ memory input is internal
42 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_OUT_ENABLE`` : HARQ memory output is internal
43 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_LOOPBACK`` : loopback data to/from HARQ memory
44 - ``RTE_BBDEV_LDPC_INTERNAL_HARQ_MEMORY_FILLERS`` : HARQ memory includes the fillers bits
45 - ``RTE_BBDEV_LDPC_DEC_SCATTER_GATHER`` : supports scatter-gather for input/output data
46 - ``RTE_BBDEV_LDPC_HARQ_6BIT_COMPRESSION`` : supports compression of the HARQ input/output
47 - ``RTE_BBDEV_LDPC_LLR_COMPRESSION`` : supports LLR input compression
49 * For the turbo encode operation:
50 - ``RTE_BBDEV_TURBO_CRC_24B_ATTACH`` : set to attach CRC24B to CB(s)
51 - ``RTE_BBDEV_TURBO_RATE_MATCH`` : if set then do not do Rate Match bypass
52 - ``RTE_BBDEV_TURBO_ENC_INTERRUPTS`` : set for encoder dequeue interrupts
53 - ``RTE_BBDEV_TURBO_RV_INDEX_BYPASS`` : set to bypass RV index
54 - ``RTE_BBDEV_TURBO_ENC_SCATTER_GATHER`` : supports scatter-gather for input/output data
56 * For the turbo decode operation:
57 - ``RTE_BBDEV_TURBO_CRC_TYPE_24B`` : check CRC24B from CB(s)
58 - ``RTE_BBDEV_TURBO_SUBBLOCK_DEINTERLEAVE`` : perform subblock de-interleave
59 - ``RTE_BBDEV_TURBO_DEC_INTERRUPTS`` : set for decoder dequeue interrupts
60 - ``RTE_BBDEV_TURBO_NEG_LLR_1_BIT_IN`` : set if negative LLR encoder i/p is supported
61 - ``RTE_BBDEV_TURBO_POS_LLR_1_BIT_IN`` : set if positive LLR encoder i/p is supported
62 - ``RTE_BBDEV_TURBO_DEC_TB_CRC_24B_KEEP`` : keep CRC24B bits appended while decoding
63 - ``RTE_BBDEV_TURBO_DEC_CRC_24B_DROP`` : option to drop the code block CRC after decoding
64 - ``RTE_BBDEV_TURBO_EARLY_TERMINATION`` : set early termination feature
65 - ``RTE_BBDEV_TURBO_DEC_SCATTER_GATHER`` : supports scatter-gather for input/output data
66 - ``RTE_BBDEV_TURBO_HALF_ITERATION_EVEN`` : set half iteration granularity
71 Section 3 of the DPDK manual provides instructions on installing and compiling DPDK.
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 these
86 commands for ACC100 and ACC101 respectively:
88 .. code-block:: console
90 sudo lspci -vd8086:0d5c
91 sudo lspci -vd8086:57c4
93 The physical and virtual functions are compatible with Linux UIO drivers:
94 ``vfio`` and ``igb_uio``. However, in order to work the 5G/4G
95 FEC device first needs to be bound to one of these linux drivers through DPDK.
101 Install the DPDK igb_uio driver, bind it with the PF PCI device ID and use
102 ``lspci`` to confirm the PF device is under use by ``igb_uio`` DPDK UIO driver.
104 The igb_uio driver may be bound to the PF PCI device using one of two methods for ACC100
105 (for ACC101 the device id ``57c4`` should be used in lieu of ``0d5c``):
108 1. PCI functions (physical or virtual, depending on the use case) can be bound to
109 the UIO driver by repeating this command for every function.
111 .. code-block:: console
113 cd <dpdk-top-level-directory>
114 insmod ./build/kmod/igb_uio.ko
115 echo "8086 0d5c" > /sys/bus/pci/drivers/igb_uio/new_id
119 2. Another way to bind PF with DPDK UIO driver is by using the ``dpdk-devbind.py`` tool
121 .. code-block:: console
123 cd <dpdk-top-level-directory>
124 ./usertools/dpdk-devbind.py -b igb_uio 0000:06:00.0
126 where the PCI device ID (example: 0000:06:00.0) is obtained using lspci -vd8086:0d5c
129 In a similar way the 5G/4G FEC PF may be bound with vfio-pci as any PCIe device.
132 Enable Virtual Functions
133 ~~~~~~~~~~~~~~~~~~~~~~~~
135 Now, it should be visible in the printouts that PCI PF is under igb_uio control
136 "``Kernel driver in use: igb_uio``"
138 To show the number of available VFs on the device, read ``sriov_totalvfs`` file..
140 .. code-block:: console
142 cat /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/sriov_totalvfs
144 where 0000\:<b>\:<d>.<f> is the PCI device ID
147 To enable VFs via igb_uio, echo the number of virtual functions intended to
148 enable to ``max_vfs`` file..
150 .. code-block:: console
152 echo <num-of-vfs> > /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/max_vfs
155 Afterwards, all VFs must be bound to appropriate UIO drivers as required, same
156 way it was done with the physical function previously.
158 Enabling SR-IOV via vfio driver is pretty much the same, except that the file
161 .. code-block:: console
163 echo <num-of-vfs> > /sys/bus/pci/devices/0000\:<b>\:<d>.<f>/sriov_numvfs
166 Configure the VFs through PF
167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
169 The PCI virtual functions must be configured before working or getting assigned
170 to VMs/Containers. The configuration involves allocating the number of hardware
171 queues, priorities, load balance, bandwidth and other settings necessary for the
172 device to perform FEC functions.
174 This configuration needs to be executed at least once after reboot or PCI FLR and can
175 be achieved by using the functions ``rte_acc10x_configure()``,
176 which sets up the parameters defined in the compatible ``acc100_conf`` structure.
181 BBDEV provides a test application, ``test-bbdev.py`` and range of test data for testing
182 the functionality of the device 5G/4G FEC encode and decode, depending on the device's
183 capabilities. The test application is located under app->test-bbdev folder and has the
186 .. code-block:: console
188 "-p", "--testapp-path": specifies path to the bbdev test app.
189 "-e", "--eal-params" : EAL arguments which are passed to the test app.
190 "-t", "--timeout" : Timeout in seconds (default=300).
191 "-c", "--test-cases" : Defines test cases to run. Run all if not specified.
192 "-v", "--test-vector" : Test vector path (default=dpdk_path+/app/test-bbdev/test_vectors/bbdev_null.data).
193 "-n", "--num-ops" : Number of operations to process on device (default=32).
194 "-b", "--burst-size" : Operations enqueue/dequeue burst size (default=32).
195 "-s", "--snr" : SNR in dB used when generating LLRs for bler tests.
196 "-s", "--iter_max" : Number of iterations for LDPC decoder.
197 "-l", "--num-lcores" : Number of lcores to run (default=16).
198 "-i", "--init-device" : Initialise PF device with default values.
201 To execute the test application tool using simple decode or encode data,
202 type one of the following:
204 .. code-block:: console
206 ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_dec_default.data
207 ./test-bbdev.py -c validation -n 64 -b 1 -v ./ldpc_enc_default.data
210 The test application ``test-bbdev.py``, supports the ability to configure the PF device with
211 a default set of values, if the "-i" or "- -init-device" option is included. The default values
212 are defined in test_bbdev_perf.c.
218 In addition to the simple LDPC decoder and LDPC encoder tests, bbdev also provides
219 a range of additional tests under the test_vectors folder, which may be useful. The results
220 of these tests will depend on the device 5G/4G FEC capabilities which may cause some
221 testcases to be skipped, but no failure should be reported.
224 Alternate Baseband Device configuration tool
225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
227 On top of the embedded configuration feature supported in test-bbdev using "- -init-device"
228 option mentioned above, there is also a tool available to perform that device configuration
229 using a companion application.
230 The ``pf_bb_config`` application notably enables then to run bbdev-test from the VF
231 and not only limited to the PF as captured above.
233 See for more details: https://github.com/intel/pf-bb-config
235 Specifically for the BBDEV ACC100 PMD, the command below can be used:
237 .. code-block:: console
239 ./pf_bb_config ACC100 -c acc100/acc100_config_vf_5g.cfg
240 ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data
242 Specifically for the BBDEV ACC101 PMD, the command below can be used:
244 .. code-block:: console
246 ./pf_bb_config ACC101 -c acc101/acc101_config_2vf_4g5g.cfg
247 ./test-bbdev.py -e="-c 0xff0 -a${VF_PCI_ADDR}" -c validation -n 64 -b 32 -l 1 -v ./ldpc_dec_default.data