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

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

drivers/staging/fsl-dpaa2/ethernet/README→drivers/staging/fsl-dpaa2/ethernet/ethernet-driver.rst

+19 −20
Original line number Diff line number Diff line 
Freescale DPAA2 Ethernet driver

===============================



This file provides documentation for the Freescale DPAA2 Ethernet driver.

.. SPDX-License-Identifier: GPL-2.0

.. include:: <isonum.txt>



===============================

DPAA2 Ethernet driver

===============================



Contents

========

	Supported Platforms

	Architecture Overview

	Creating a Network Interface

	Features & Offloads

:Copyright: |copy| 2017-2018 NXP



This file provides documentation for the Freescale DPAA2 Ethernet driver.



Supported Platforms

===================
@@ -23,6 +20,7 @@ Architecture Overview 
Unlike regular NICs, in the DPAA2 architecture there is no single hardware block

representing network interfaces; instead, several separate hardware resources

concur to provide the networking functionality:



- network interfaces

- queues, channels

- buffer pools
@@ -35,14 +33,13 @@ hardware resources, like queues, do not have a corresponding MC object and 
are treated as internal resources of other objects.



For a more detailed description of the DPAA2 architecture and its object

abstractions see:

	Documentation/networking/dpaa2/overview.rst

abstractions see *Documentation/networking/dpaa2/overview.rst*.



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

(DPCONs).



Configuration interface:

Configuration interface::



                 -----------------------

                | DPAA2 Ethernet Driver |
@@ -56,7 +53,7 @@ Configuration interface: 
        | DPBP API |   | DPNI API |    | DPCON API |

         ----------     ----------      -----------

             .              .                .             software

===========  .  ==========  .  ============  .  ===================

    =======  .  ==========  .  ============  .  ===================

             .              .                .             hardware

         ------------------------------------------

        |            MC hardware portals           |
@@ -72,7 +69,7 @@ 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

hardware resources.



Datapath (I/O) interface:

Datapath (I/O) interface::



         -----------------------------------------------

        |           DPAA2 Ethernet Driver               |
@@ -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

managed by MC and completely transparent to the Ethernet driver.



::



     ---------     ---------     ---------

    | eth if1 |   | eth if2 |   | eth ifn |

     ---------     ---------     ---------

CRA Git | Maintained and supported by SUSTech CRA and CCSE