Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 2abce12e authored by Ioana Radulescu's avatar Ioana Radulescu Committed by Greg Kroah-Hartman
Browse files

staging: fsl-mc: README cleanup 



Minor cosmetic changes to the DPAA2 overview documentation file.
Add a reference to the mc-bus driver sysfs documentation.

Signed-off-by: default avatarIoana Radulescu <ruxandra.radulescu@nxp.com>
Reviewed-by: default avatarLaurentiu Tudor <laurentiu.tudor@nxp.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 1df5d23d

drivers/staging/fsl-mc/README.txt

+17 −16
Original line number Diff line number Diff line 
Copyright (C) 2015 Freescale Semiconductor Inc.



DPAA2 (Data Path Acceleration Architecture Gen2)

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

DPAA2 (Data Path Acceleration Architecture Gen2) Overview

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



This document provides an overview of the Freescale DPAA2 architecture

and how it is integrated into the Linux kernel.
@@ -17,8 +17,8 @@ Contents summary 
        -Ethernet

        -MAC



DPAA2 Overview

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

Introduction

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



DPAA2 is a hardware architecture designed for high-speeed network

packet processing.  DPAA2 consists of sophisticated mechanisms for
@@ -35,7 +35,7 @@ network ports to create functional objects/devices such as network 
interfaces, an L2 switch, or accelerator instances.



The MC provides memory-mapped I/O command interfaces (MC portals)

which DPAA2 software drivers use to operate on DPAA2 objects:

which DPAA2 software drivers use to operate on DPAA2 objects.



The diagram below shows an overview of the DPAA2 resource management

architecture:
@@ -130,8 +130,7 @@ in creating a network interfaces. 
    level.



    DPRCs can be defined statically and populated with objects

    via a config file passed to the MC when firmware starts

    it.

    via a config file passed to the MC when firmware starts it.



-DPAA2 Objects for an Ethernet Network Interface
@@ -255,8 +254,8 @@ in creating a network interfaces. 
    For ARM-based SoC this is the same as the stream ID.





DPAA2 Linux Driver Overview

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

DPAA2 Linux Drivers Overview

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



This section provides an overview of the Linux kernel drivers for

DPAA2-- 1) the bus driver and associated "DPAA2 infrastructure"
@@ -291,7 +290,7 @@ of each driver follows. 
          +----+--------------+                     |              +--+---+

          |   MC-bus driver   |                     |              | PHY  |

          |                   |                     |              |driver|

          | /soc/fsl-mc       |                     |              +--+---+

          | /bus/fsl-mc       |                     |              +--+---+

          +-------------------+                     |                 |

                                                    |                 |

 ================================ HARDWARE =========|=================|======
@@ -322,6 +321,8 @@ A brief description of each driver is provided below. 
        a bind of the root DPRC to the DPRC driver

    The binding for the MC-bus device-tree node can be consulted here:

        Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt

    The sysfs bind/unbind interfaces for the MC-bus can be consulted here:

        Documentation/ABI/testing/sysfs-bus-fsl-mc*



    DPRC driver

    -----------
@@ -366,8 +367,8 @@ A brief description of each driver is provided below. 
    active in the kernel--  Ethernet, crypto, compression,

    etc.



    Ethernet

    --------

    Ethernet driver

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

    The Ethernet driver is bound to a DPNI and implements the kernel

    interfaces needed to connect the DPAA2 network interface to

    the network stack.