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 Features
  15 --------
  16
  17 The BPHY CGX/RPM implements following features in the rawdev API:
  18
  19 - Access to BPHY CGX/RPM via a set of predefined messages
  20
  21 Device Setup
  22 ------------
  23
  24 The BPHY CGX/RPM devices will need to be bound to a user-space IO driver for
  25 use. The script ``dpdk-devbind.py`` script included with DPDK can be used to
  26 view the state of the devices and to bind them to a suitable DPDK-supported
  27 kernel driver. When querying the status of the devices, they will appear under
  28 the category of "Misc (rawdev) devices", i.e. the command
  29 ``dpdk-devbind.py --status-dev misc`` can be used to see the state of those
  30 devices alone.
  31
  32 Before performing actual data transfer one needs to first retrieve number of
  33 available queues with ``rte_rawdev_queue_count()`` and capacity of each
  34 using ``rte_rawdev_queue_conf_get()``.
  35
  36 To perform data transfer use standard ``rte_rawdev_enqueue_buffers()`` and
  37 ``rte_rawdev_dequeue_buffers()`` APIs. Not all messages produce sensible
  38 responses hence dequeueing is not always necessary.
  39
  40 BPHY CGX/RPM PMD
  41 ----------------
  42
  43 BPHY CGX/RPM PMD accepts ``struct cnxk_bphy_cgx_msg`` messages which differ by type and payload.
  44 Message types along with description are listed below. As for the usage examples please refer to
  45 ``cnxk_bphy_cgx_dev_selftest()``.
  46
  47 Get link information
  48 ~~~~~~~~~~~~~~~~~~~~
  49
  50 Message is used to get information about link state.
  51
  52 Message must have type set to ``CNXK_BPHY_CGX_MSG_TYPE_GET_LINKINFO``. In response one will
  53 get message containing payload i.e ``struct cnxk_bphy_cgx_msg_link_info`` filled with information
  54 about current link state.
  55
  56 Change internal loopback state
  57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  58
  59 Message is used to enable or disable internal loopback.
  60
  61 Message must have type set to ``CNXK_BPHY_CGX_MSG_TYPE_INTLBK_ENABLE`` or
  62 ``CNXK_BPHY_CGX_MSG_TYPE_INTLBK_DISABLE``. Former will activate internal loopback while the latter
  63 will do the opposite.
  64
  65 Change PTP RX state
  66 ~~~~~~~~~~~~~~~~~~~
  67
  68 Message is used to enable or disable PTP mode.
  69
  70 Message must have type set to ``CNXK_BPHY_CGX_MSG_TYPE_PTP_RX_ENABLE`` or
  71 ``CNXK_BPHY_CGX_MSG_TYPE_PTP_RX_DISABLE``. Former will enable PTP while the latter will do the
  72 opposite.
  73
  74 Set link mode
  75 ~~~~~~~~~~~~~
  76
  77 Message is used to change link mode.
  78
  79 Message must have type set to ``CNXK_BPHY_CGX_MSG_TYPE_SET_LINK_MODE``. Prior to sending actual
  80 message payload i.e ``struct cnxk_bphy_cgx_msg_link_mode`` needs to be filled with relevant
  81 information.
  82
  83 Change link state
  84 ~~~~~~~~~~~~~~~~~
  85
  86 Message is used to set link up or down.
  87
  88 Message must have type set to ``CNXK_BPHY_CGX_MSG_TYPE_SET_LINK_STATE``. Prior to sending actual
  89 message payload i.e ``struct cnxk_bphy_cgx_msg_set_link_state`` needs to be filled with relevant
  90 information.
  91
  92 Start or stop RX/TX
  93 ~~~~~~~~~~~~~~~~~~~
  94
  95 Message is used to start or stop accepting traffic.
  96
  97 Message must have type set to ``CNXK_BPHY_CGX_MSG_TYPE_START_RXTX`` or
  98 ``CNXK_BPHY_CGX_MSG_TYPE_STOP_RXTX``. Former will enable traffic while the latter will
  99 do the opposite.
 100
 101 BPHY PMD
 102 --------
 103
 104 BPHY PMD accepts ``struct cnxk_bphy_irq_msg`` messages which differ by type and payload.
 105 Message types along with description are listed below. For some usage examples please refer to
 106 ``bphy_rawdev_selftest()``.
 107
 108 Initialize or finalize interrupt handling
 109 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 110
 111 Message is used to setup low level interrupt handling.
 112
 113 Message must have type set to ``CNXK_BPHY_IRQ_MSG_TYPE_INIT`` or ``CNXK_BPHY_IRQ_MSG_TYPE_FINI``.
 114 The former will setup low level interrupt handling while the latter will tear everything down. There
 115 are also two convenience functions namely ``rte_pmd_bphy_intr_init()`` and
 116 ``rte_pmd_bphy_intr_fini()`` that take care of all details.
 117
 118 Self test
 119 ---------
 120
 121 On EAL initialization, BPHY CGX/RPM devices will be probed and populated into
 122 the raw devices. The rawdev ID of the device can be obtained using invocation
 123 of ``rte_rawdev_get_dev_id("NAME:x")`` from the test application, where:
 124
 125 - NAME is the desired subsystem: use "BPHY_CGX" for
 126   RFOE module,
 127 - x is the device's bus id specified in "bus:device.func" (BDF) format.
 128
 129 Use this identifier for further rawdev function calls.
 130
 131 The driver's selftest rawdev API can be used to verify the BPHY CGX/RPM
 132 functionality.