doc/guides/cryptodevs/bcmfs.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(C) 2020 Broadcom
   3
   4 Broadcom FlexSparc Crypto Poll Mode Driver
   5 ==========================================
   6
   7 The FlexSparc crypto poll mode driver (BCMFS PMD) provides support for offloading
   8 cryptographic operations to the Broadcom SoCs having FlexSparc4/FlexSparc5 unit.
   9 Detailed information about SoCs can be found at `Broadcom Official Website
  10 <https://www.broadcom.com/products/ethernet-connectivity/network-adapters/smartnic>`__.
  11
  12 Supported Broadcom SoCs
  13 -----------------------
  14
  15 * Stingray
  16 * Stingray2
  17
  18 Installation
  19 ------------
  20 Information about kernel, rootfs and toolchain can be found at
  21 `Broadcom Official Website <https://www.broadcom.com/products/ethernet-connectivity
  22 /network-adapters/smartnic/stingray-software>`__.
  23
  24     .. Note::
  25         To execute BCMFS PMD, it must be compiled with VFIO_PRESENT flag on the
  26         compiling platform and same gets enabled in rte_vfio.h.
  27
  28 The BCMFS crypto PMD may be compiled natively on a Stingray/Stingray2 platform or
  29 cross-compiled on an x86 platform. For example, below commands can be executed
  30 for cross compiling on x86 platform.
  31
  32 .. code-block:: console
  33
  34     cd <DPDK-source-directory>
  35     meson <dest-dir> --cross-file config/arm/arm64_stingray_linux_gcc
  36     cd <dest-dir>
  37     ninja
  38
  39 Initialization
  40 --------------
  41 The supported platform devices should be present in the
  42 */sys/bus/platform/devices/fs<version>/<dev_name>* path on the booted kernel.
  43 To get BCMFS PMD executing, device node must be owned by VFIO platform module only.
  44 For example, below commands can be run to get hold of a device node by VFIO.
  45
  46 .. code-block:: console
  47
  48     SETUP_SYSFS_DEV_NAME=67000000.crypto_mbox
  49     io_device_name="vfio-platform"
  50     echo $io_device_name > /sys/bus/platform/devices/${SETUP_SYSFS_DEV_NAME}/driver_override
  51     echo ${SETUP_SYSFS_DEV_NAME} > /sys/bus/platform/drivers_probe