Commit 90615f9f authored by Ioana Ciornei's avatar Ioana Ciornei Committed by Greg Kroah-Hartman

staging: fsl-dpaa2/eth: convert documentation to .rst format

Convert the DPAA2 Ethernet driver documentation to .rst format
and rename the file accordingly.
Also add a SPDX tag to the new rst file.
Signed-off-by: default avatarIoana Ciornei <ioana.ciornei@nxp.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 02211edc
Freescale DPAA2 Ethernet driver .. SPDX-License-Identifier: GPL-2.0
=============================== .. include:: <isonum.txt>
This file provides documentation for the Freescale DPAA2 Ethernet driver.
===============================
DPAA2 Ethernet driver
===============================
Contents :Copyright: |copy| 2017-2018 NXP
========
Supported Platforms
Architecture Overview
Creating a Network Interface
Features & Offloads
This file provides documentation for the Freescale DPAA2 Ethernet driver.
Supported Platforms Supported Platforms
=================== ===================
...@@ -23,10 +20,11 @@ Architecture Overview ...@@ -23,10 +20,11 @@ Architecture Overview
Unlike regular NICs, in the DPAA2 architecture there is no single hardware block Unlike regular NICs, in the DPAA2 architecture there is no single hardware block
representing network interfaces; instead, several separate hardware resources representing network interfaces; instead, several separate hardware resources
concur to provide the networking functionality: concur to provide the networking functionality:
- network interfaces
- queues, channels - network interfaces
- buffer pools - queues, channels
- MAC/PHY - buffer pools
- MAC/PHY
All hardware resources are allocated and configured through the Management All hardware resources are allocated and configured through the Management
Complex (MC) portals. MC abstracts most of these resources as DPAA2 objects Complex (MC) portals. MC abstracts most of these resources as DPAA2 objects
...@@ -35,14 +33,13 @@ hardware resources, like queues, do not have a corresponding MC object and ...@@ -35,14 +33,13 @@ hardware resources, like queues, do not have a corresponding MC object and
are treated as internal resources of other objects. are treated as internal resources of other objects.
For a more detailed description of the DPAA2 architecture and its object For a more detailed description of the DPAA2 architecture and its object
abstractions see: abstractions see *Documentation/networking/dpaa2/overview.rst*.
Documentation/networking/dpaa2/overview.rst
Each Linux net device is built on top of a Datapath Network Interface (DPNI) Each Linux net device is built on top of a Datapath Network Interface (DPNI)
object and uses Buffer Pools (DPBPs), I/O Portals (DPIOs) and Concentrators object and uses Buffer Pools (DPBPs), I/O Portals (DPIOs) and Concentrators
(DPCONs). (DPCONs).
Configuration interface: Configuration interface::
----------------------- -----------------------
| DPAA2 Ethernet Driver | | DPAA2 Ethernet Driver |
...@@ -56,7 +53,7 @@ Configuration interface: ...@@ -56,7 +53,7 @@ Configuration interface:
| DPBP API | | DPNI API | | DPCON API | | DPBP API | | DPNI API | | DPCON API |
---------- ---------- ----------- ---------- ---------- -----------
. . . software . . . software
=========== . ========== . ============ . =================== ======= . ========== . ============ . ===================
. . . hardware . . . hardware
------------------------------------------ ------------------------------------------
| MC hardware portals | | MC hardware portals |
...@@ -72,11 +69,11 @@ DPBPs represent hardware buffer pools. Packet I/O is performed in the context ...@@ -72,11 +69,11 @@ DPBPs represent hardware buffer pools. Packet I/O is performed in the context
of DPCON objects, using DPIO portals for managing and communicating with the of DPCON objects, using DPIO portals for managing and communicating with the
hardware resources. hardware resources.
Datapath (I/O) interface: Datapath (I/O) interface::
----------------------------------------------- -----------------------------------------------
| DPAA2 Ethernet Driver | | DPAA2 Ethernet Driver |
----------------------------------------------- -----------------------------------------------
| ^ ^ | | | ^ ^ | |
| | | | | | | | | |
enqueue| dequeue| data | dequeue| seed | enqueue| dequeue| data | dequeue| seed |
...@@ -132,6 +129,8 @@ DPNIs are decoupled from PHYs; a DPNI can be connected to a PHY through a DPMAC ...@@ -132,6 +129,8 @@ DPNIs are decoupled from PHYs; a DPNI can be connected to a PHY through a DPMAC
object or to another DPNI through an internal link, but the connection is object or to another DPNI through an internal link, but the connection is
managed by MC and completely transparent to the Ethernet driver. managed by MC and completely transparent to the Ethernet driver.
::
--------- --------- --------- --------- --------- ---------
| eth if1 | | eth if2 | | eth ifn | | eth if1 | | eth if2 | | eth ifn |
--------- --------- --------- --------- --------- ---------
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment