1.. SPDX-License-Identifier: BSD-3-Clause 2 Copyright 2016,2020 NXP 3 4 5DPAA2 Poll Mode Driver 6====================== 7 8The DPAA2 NIC PMD (**librte_net_dpaa2**) provides poll mode driver 9support for the inbuilt NIC found in the **NXP DPAA2** SoC family. 10 11More information can be found at `NXP Official Website 12<http://www.nxp.com/products/microcontrollers-and-processors/arm-processors/qoriq-arm-processors:QORIQ-ARM>`_. 13 14NXP DPAA2 (Data Path Acceleration Architecture Gen2) 15---------------------------------------------------- 16 17This section provides an overview of the NXP DPAA2 architecture 18and how it is integrated into the DPDK. 19 20Contents summary 21 22- DPAA2 overview 23- Overview of DPAA2 objects 24- DPAA2 driver architecture overview 25 26.. _dpaa2_overview: 27 28DPAA2 Overview 29~~~~~~~~~~~~~~ 30 31Reference: `FSL MC BUS in Linux Kernel <https://www.kernel.org/doc/readme/drivers-staging-fsl-mc-README.txt>`_. 32 33DPAA2 is a hardware architecture designed for high-speed network 34packet processing. DPAA2 consists of sophisticated mechanisms for 35processing Ethernet packets, queue management, buffer management, 36autonomous L2 switching, virtual Ethernet bridging, and accelerator 37(e.g. crypto) sharing. 38 39A DPAA2 hardware component called the Management Complex (or MC) manages the 40DPAA2 hardware resources. The MC provides an object-based abstraction for 41software drivers to use the DPAA2 hardware. 42 43The MC uses DPAA2 hardware resources such as queues, buffer pools, and 44network ports to create functional objects/devices such as network 45interfaces, an L2 switch, or accelerator instances. 46 47The MC provides memory-mapped I/O command interfaces (MC portals) 48which DPAA2 software drivers use to operate on DPAA2 objects: 49 50The diagram below shows an overview of the DPAA2 resource management 51architecture: 52 53.. code-block:: console 54 55 +--------------------------------------+ 56 | OS | 57 | DPAA2 drivers | 58 | | | 59 +-----------------------------|--------+ 60 | 61 | (create,discover,connect 62 | config,use,destroy) 63 | 64 DPAA2 | 65 +------------------------| mc portal |-+ 66 | | | 67 | +- - - - - - - - - - - - -V- - -+ | 68 | | | | 69 | | Management Complex (MC) | | 70 | | | | 71 | +- - - - - - - - - - - - - - - -+ | 72 | | 73 | Hardware Hardware | 74 | Resources Objects | 75 | --------- ------- | 76 | -queues -DPRC | 77 | -buffer pools -DPMCP | 78 | -Eth MACs/ports -DPIO | 79 | -network interface -DPNI | 80 | profiles -DPMAC | 81 | -queue portals -DPBP | 82 | -MC portals ... | 83 | ... | 84 | | 85 +--------------------------------------+ 86 87The MC mediates operations such as create, discover, 88connect, configuration, and destroy. Fast-path operations 89on data, such as packet transmit/receive, are not mediated by 90the MC and are done directly using memory mapped regions in 91DPIO objects. 92 93Overview of DPAA2 Objects 94~~~~~~~~~~~~~~~~~~~~~~~~~ 95 96The section provides a brief overview of some key DPAA2 objects. 97A simple scenario is described illustrating the objects involved 98in creating a network interfaces. 99 100DPRC (Datapath Resource Container) 101 102 A DPRC is a container object that holds all the other 103 types of DPAA2 objects. In the example diagram below there 104 are 8 objects of 5 types (DPMCP, DPIO, DPBP, DPNI, and DPMAC) 105 in the container. 106 107.. code-block:: console 108 109 +---------------------------------------------------------+ 110 | DPRC | 111 | | 112 | +-------+ +-------+ +-------+ +-------+ +-------+ | 113 | | DPMCP | | DPIO | | DPBP | | DPNI | | DPMAC | | 114 | +-------+ +-------+ +-------+ +---+---+ +---+---+ | 115 | | DPMCP | | DPIO | | 116 | +-------+ +-------+ | 117 | | DPMCP | | 118 | +-------+ | 119 | | 120 +---------------------------------------------------------+ 121 122From the point of view of an OS, a DPRC behaves similar to a plug and 123play bus, like PCI. DPRC commands can be used to enumerate the contents 124of the DPRC, discover the hardware objects present (including mappable 125regions and interrupts). 126 127.. code-block:: console 128 129 DPRC.1 (bus) 130 | 131 +--+--------+-------+-------+-------+ 132 | | | | | 133 DPMCP.1 DPIO.1 DPBP.1 DPNI.1 DPMAC.1 134 DPMCP.2 DPIO.2 135 DPMCP.3 136 137Hardware objects can be created and destroyed dynamically, providing 138the ability to hot plug/unplug objects in and out of the DPRC. 139 140A DPRC has a mappable MMIO region (an MC portal) that can be used 141to send MC commands. It has an interrupt for status events (like 142hotplug). 143 144All objects in a container share the same hardware "isolation context". 145This means that with respect to an IOMMU the isolation granularity 146is at the DPRC (container) level, not at the individual object 147level. 148 149DPRCs can be defined statically and populated with objects 150via a config file passed to the MC when firmware starts 151it. There is also a Linux user space tool called "restool" 152that can be used to create/destroy containers and objects 153dynamically. 154 155DPAA2 Objects for an Ethernet Network Interface 156~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 157 158A typical Ethernet NIC is monolithic-- the NIC device contains TX/RX 159queuing mechanisms, configuration mechanisms, buffer management, 160physical ports, and interrupts. DPAA2 uses a more granular approach 161utilizing multiple hardware objects. Each object provides specialized 162functions. Groups of these objects are used by software to provide 163Ethernet network interface functionality. This approach provides 164efficient use of finite hardware resources, flexibility, and 165performance advantages. 166 167The diagram below shows the objects needed for a simple 168network interface configuration on a system with 2 CPUs. 169 170.. code-block:: console 171 172 +---+---+ +---+---+ 173 CPU0 CPU1 174 +---+---+ +---+---+ 175 | | 176 +---+---+ +---+---+ 177 DPIO DPIO 178 +---+---+ +---+---+ 179 \ / 180 \ / 181 \ / 182 +---+---+ 183 DPNI --- DPBP,DPMCP 184 +---+---+ 185 | 186 | 187 +---+---+ 188 DPMAC 189 +---+---+ 190 | 191 port/PHY 192 193Below the objects are described. For each object a brief description 194is provided along with a summary of the kinds of operations the object 195supports and a summary of key resources of the object (MMIO regions 196and IRQs). 197 198DPMAC (Datapath Ethernet MAC): represents an Ethernet MAC, a 199hardware device that connects to an Ethernet PHY and allows 200physical transmission and reception of Ethernet frames. 201 202- MMIO regions: none 203- IRQs: DPNI link change 204- commands: set link up/down, link config, get stats, IRQ config, enable, reset 205 206DPNI (Datapath Network Interface): contains TX/RX queues, 207network interface configuration, and RX buffer pool configuration 208mechanisms. The TX/RX queues are in memory and are identified by 209queue number. 210 211- MMIO regions: none 212- IRQs: link state 213- commands: port config, offload config, queue config, parse/classify config, IRQ config, enable, reset 214 215DPIO (Datapath I/O): provides interfaces to enqueue and dequeue 216packets and do hardware buffer pool management operations. The DPAA2 217architecture separates the mechanism to access queues (the DPIO object) 218from the queues themselves. The DPIO provides an MMIO interface to 219enqueue/dequeue packets. To enqueue something a descriptor is written 220to the DPIO MMIO region, which includes the target queue number. 221There will typically be one DPIO assigned to each CPU. This allows all 222CPUs to simultaneously perform enqueue/dequeued operations. DPIOs are 223expected to be shared by different DPAA2 drivers. 224 225- MMIO regions: queue operations, buffer management 226- IRQs: data availability, congestion notification, buffer pool depletion 227- commands: IRQ config, enable, reset 228 229DPBP (Datapath Buffer Pool): represents a hardware buffer 230pool. 231 232- MMIO regions: none 233- IRQs: none 234- commands: enable, reset 235 236DPMCP (Datapath MC Portal): provides an MC command portal. 237Used by drivers to send commands to the MC to manage 238objects. 239 240- MMIO regions: MC command portal 241- IRQs: command completion 242- commands: IRQ config, enable, reset 243 244Object Connections 245~~~~~~~~~~~~~~~~~~ 246 247Some objects have explicit relationships that must 248be configured: 249 250- DPNI <--> DPMAC 251- DPNI <--> DPNI 252- DPNI <--> L2-switch-port 253 254A DPNI must be connected to something such as a DPMAC, 255another DPNI, or L2 switch port. The DPNI connection 256is made via a DPRC command. 257 258.. code-block:: console 259 260 +-------+ +-------+ 261 | DPNI | | DPMAC | 262 +---+---+ +---+---+ 263 | | 264 +==========+ 265 266- DPNI <--> DPBP 267 268A network interface requires a 'buffer pool' (DPBP object) which provides 269a list of pointers to memory where received Ethernet data is to be copied. 270The Ethernet driver configures the DPBPs associated with the network 271interface. 272 273Interrupts 274~~~~~~~~~~ 275 276All interrupts generated by DPAA2 objects are message 277interrupts. At the hardware level message interrupts 278generated by devices will normally have 3 components-- 2791) a non-spoofable 'device-id' expressed on the hardware 280bus, 2) an address, 3) a data value. 281 282In the case of DPAA2 devices/objects, all objects in the 283same container/DPRC share the same 'device-id'. 284For ARM-based SoC this is the same as the stream ID. 285 286 287DPAA2 DPDK - Poll Mode Driver Overview 288-------------------------------------- 289 290This section provides an overview of the drivers for 291DPAA2-- 1) the bus driver and associated "DPAA2 infrastructure" 292drivers and 2) functional object drivers (such as Ethernet). 293 294As described previously, a DPRC is a container that holds the other 295types of DPAA2 objects. It is functionally similar to a plug-and-play 296bus controller. 297 298Each object in the DPRC is a Linux "device" and is bound to a driver. 299The diagram below shows the dpaa2 drivers involved in a networking 300scenario and the objects bound to each driver. A brief description 301of each driver follows. 302 303.. code-block:: console 304 305 306 +------------+ 307 | DPDK DPAA2 | 308 | PMD | 309 +------------+ +------------+ 310 | Ethernet |.......| Mempool | 311 . . . . . . . . . | (DPNI) | | (DPBP) | 312 . +---+---+----+ +-----+------+ 313 . ^ | . 314 . | |<enqueue, . 315 . | | dequeue> . 316 . | | . 317 . +---+---V----+ . 318 . . . . . . . . . . .| DPIO driver| . 319 . . | (DPIO) | . 320 . . +-----+------+ . 321 . . | QBMAN | . 322 . . | Driver | . 323 +----+------+-------+ +-----+----- | . 324 | dpaa2 bus | | . 325 | VFIO fslmc-bus |....................|..................... 326 | | | 327 | /bus/fslmc | | 328 +-------------------+ | 329 | 330 ========================== HARDWARE =====|======================= 331 DPIO 332 | 333 DPNI---DPBP 334 | 335 DPMAC 336 | 337 PHY 338 =========================================|======================== 339 340 341A brief description of each driver is provided below. 342 343DPAA2 bus driver 344~~~~~~~~~~~~~~~~ 345 346The DPAA2 bus driver is a rte_bus driver which scans the fsl-mc bus. 347Key functions include: 348 349- Reading the container and setting up vfio group 350- Scanning and parsing the various MC objects and adding them to 351 their respective device list. 352 353Additionally, it also provides the object driver for generic MC objects. 354 355DPIO driver 356~~~~~~~~~~~ 357 358The DPIO driver is bound to DPIO objects and provides services that allow 359other drivers such as the Ethernet driver to enqueue and dequeue data for 360their respective objects. 361Key services include: 362 363- Data availability notifications 364- Hardware queuing operations (enqueue and dequeue of data) 365- Hardware buffer pool management 366 367To transmit a packet the Ethernet driver puts data on a queue and 368invokes a DPIO API. For receive, the Ethernet driver registers 369a data availability notification callback. To dequeue a packet 370a DPIO API is used. 371 372There is typically one DPIO object per physical CPU for optimum 373performance, allowing different CPUs to simultaneously enqueue 374and dequeue data. 375 376The DPIO driver operates on behalf of all DPAA2 drivers 377active -- Ethernet, crypto, compression, etc. 378 379DPBP based Mempool driver 380~~~~~~~~~~~~~~~~~~~~~~~~~ 381 382The DPBP driver is bound to a DPBP objects and provides services to 383create a hardware offloaded packet buffer mempool. 384 385DPAA2 NIC Driver 386~~~~~~~~~~~~~~~~ 387The Ethernet driver is bound to a DPNI and implements the kernel 388interfaces needed to connect the DPAA2 network interface to 389the network stack. 390 391Each DPNI corresponds to a DPDK network interface. 392 393Features 394^^^^^^^^ 395 396Features of the DPAA2 PMD are: 397 398- Multiple queues for TX and RX 399- Receive Side Scaling (RSS) 400- MAC/VLAN filtering 401- Packet type information 402- Checksum offload 403- Promiscuous mode 404- Multicast mode 405- Port hardware statistics 406- Jumbo frames 407- Link flow control 408- Scattered and gather for TX and RX 409 410Supported DPAA2 SoCs 411-------------------- 412- LX2160A 413- LS2084A/LS2044A 414- LS2088A/LS2048A 415- LS1088A/LS1048A 416 417Prerequisites 418------------- 419 420See :doc:`../platform/dpaa2` for setup information 421 422Currently supported by DPDK: 423 424- NXP LSDK **19.08+**. 425- MC Firmware version **10.18.0** and higher. 426- Supported architectures: **arm64 LE**. 427 428- Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment. 429 430.. note:: 431 432 Some part of fslmc bus code (mc flib - object library) routines are 433 dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace. 434 435 436Driver compilation and testing 437------------------------------ 438 439Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` 440for details. 441 442#. Running testpmd: 443 444 Follow instructions available in the document 445 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` 446 to run testpmd. 447 448 Example output: 449 450 .. code-block:: console 451 452 ./dpdk-testpmd -c 0xff -n 1 -- -i --portmask=0x3 --nb-cores=1 --no-flush-rx 453 454 ..... 455 EAL: Registered [pci] bus. 456 EAL: Registered [fslmc] bus. 457 EAL: Detected 8 lcore(s) 458 EAL: Probing VFIO support... 459 EAL: VFIO support initialized 460 ..... 461 PMD: DPAA2: Processing Container = dprc.2 462 EAL: fslmc: DPRC contains = 51 devices 463 EAL: fslmc: Bus scan completed 464 ..... 465 Configuring Port 0 (socket 0) 466 Port 0: 00:00:00:00:00:01 467 Configuring Port 1 (socket 0) 468 Port 1: 00:00:00:00:00:02 469 ..... 470 Checking link statuses... 471 Port 0 Link Up - speed 10000 Mbps - full-duplex 472 Port 1 Link Up - speed 10000 Mbps - full-duplex 473 Done 474 testpmd> 475 476 477* Use dev arg option ``drv_loopback=1`` to loopback packets at 478 driver level. Any packet received will be reflected back by the 479 driver on same port. e.g. ``fslmc:dpni.1,drv_loopback=1`` 480 481* Use dev arg option ``drv_no_prefetch=1`` to disable prefetching 482 of the packet pull command which is issued in the previous cycle. 483 e.g. ``fslmc:dpni.1,drv_no_prefetch=1`` 484 485Enabling logs 486------------- 487 488For enabling logging for DPAA2 PMD, following log-level prefix can be used: 489 490 .. code-block:: console 491 492 <dpdk app> <EAL args> --log-level=bus.fslmc:<level> -- ... 493 494Using ``bus.fslmc`` as log matching criteria, all FSLMC bus logs can be enabled 495which are lower than logging ``level``. 496 497 Or 498 499 .. code-block:: console 500 501 <dpdk app> <EAL args> --log-level=pmd.net.dpaa2:<level> -- ... 502 503Using ``pmd.net.dpaa2`` as log matching criteria, all PMD logs can be enabled 504which are lower than logging ``level``. 505 506Allowing & Blocking 507------------------- 508 509For blocking a DPAA2 device, following commands can be used. 510 511 .. code-block:: console 512 513 <dpdk app> <EAL args> -b "fslmc:dpni.x" -- ... 514 515Where x is the device object id as configured in resource container. 516 517Running secondary debug app without blocklist 518--------------------------------------------- 519 520dpaa2 hardware imposes limits on some H/W access devices like Management 521Control Port and H/W portal. This causes issue in their shared usages in 522case of multi-process applications. It can overcome by using 523allowlist/blocklist in primary and secondary applications. 524 525In order to ease usage of standard debugging apps like dpdk-procinfo, dpaa2 526driver reserves extra Management Control Port and H/W portal which can be 527used by debug application to debug any existing application without 528blocking these devices in primary process. 529 530Limitations 531----------- 532 533Platform Requirement 534~~~~~~~~~~~~~~~~~~~~ 535DPAA2 drivers for DPDK can only work on NXP SoCs as listed in the 536``Supported DPAA2 SoCs``. 537 538Maximum packet length 539~~~~~~~~~~~~~~~~~~~~~ 540 541The DPAA2 SoC family support a maximum of a 10240 jumbo frame. The value 542is fixed and cannot be changed. So, even when the ``rxmode.max_rx_pkt_len`` 543member of ``struct rte_eth_conf`` is set to a value lower than 10240, frames 544up to 10240 bytes can still reach the host interface. 545 546Other Limitations 547~~~~~~~~~~~~~~~~~ 548 549- RSS hash key cannot be modified. 550- RSS RETA cannot be configured. 551