raw/cnxk_bphy: add BPHY CGX/RPM skeleton driver
[dpdk.git] / doc / guides / rawdevs / cnxk_bphy.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2021 Marvell.
3
4 Marvell CNXK BPHY Driver
5 ========================
6
7 CN10K/CN9K Fusion product families offer an internal BPHY unit which provides
8 set of hardware accelerators for performing baseband related operations.
9 Connectivity to the outside world happens through a block called RFOE which is
10 backed by ethernet I/O block called CGX or RPM (depending on the chip version).
11 RFOE stands for Radio Frequency Over Ethernet and provides support for
12 IEEE 1904.3 (RoE) standard.
13
14 Device Setup
15 ------------
16
17 The BPHY CGX/RPM devices will need to be bound to a user-space IO driver for
18 use. The script ``dpdk-devbind.py`` script included with DPDK can be used to
19 view the state of the devices and to bind them to a suitable DPDK-supported
20 kernel driver. When querying the status of the devices, they will appear under
21 the category of "Misc (rawdev) devices", i.e. the command
22 ``dpdk-devbind.py --status-dev misc`` can be used to see the state of those
23 devices alone.