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

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
Copyright (C) 2015 Freescale Semiconductor Inc. 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 This document provides an overview of the Freescale DPAA2 architecture
and how it is integrated into the Linux kernel. and how it is integrated into the Linux kernel.
...@@ -17,8 +17,8 @@ Contents summary ...@@ -17,8 +17,8 @@ Contents summary
-Ethernet -Ethernet
-MAC -MAC
DPAA2 Overview Introduction
-------------- ------------
DPAA2 is a hardware architecture designed for high-speeed network DPAA2 is a hardware architecture designed for high-speeed network
packet processing. DPAA2 consists of sophisticated mechanisms for packet processing. DPAA2 consists of sophisticated mechanisms for
...@@ -35,7 +35,7 @@ network ports to create functional objects/devices such as network ...@@ -35,7 +35,7 @@ network ports to create functional objects/devices such as network
interfaces, an L2 switch, or accelerator instances. interfaces, an L2 switch, or accelerator instances.
The MC provides memory-mapped I/O command interfaces (MC portals) 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 The diagram below shows an overview of the DPAA2 resource management
architecture: architecture:
...@@ -130,8 +130,7 @@ in creating a network interfaces. ...@@ -130,8 +130,7 @@ in creating a network interfaces.
level. level.
DPRCs can be defined statically and populated with objects DPRCs can be defined statically and populated with objects
via a config file passed to the MC when firmware starts via a config file passed to the MC when firmware starts it.
it.
-DPAA2 Objects for an Ethernet Network Interface -DPAA2 Objects for an Ethernet Network Interface
...@@ -217,8 +216,8 @@ in creating a network interfaces. ...@@ -217,8 +216,8 @@ in creating a network interfaces.
-IRQs: command completion -IRQs: command completion
-commands: IRQ config, enable, reset -commands: IRQ config, enable, reset
Object Connections Object Connections
------------------ ------------------
Some objects have explicit relationships that must Some objects have explicit relationships that must
be configured: be configured:
...@@ -242,8 +241,8 @@ in creating a network interfaces. ...@@ -242,8 +241,8 @@ in creating a network interfaces.
Ethernet driver configures the DPBPs associated with Ethernet driver configures the DPBPs associated with
the network interface. the network interface.
Interrupts Interrupts
---------- ----------
All interrupts generated by DPAA2 objects are message All interrupts generated by DPAA2 objects are message
interrupts. At the hardware level message interrupts interrupts. At the hardware level message interrupts
generated by devices will normally have 3 components-- generated by devices will normally have 3 components--
...@@ -255,8 +254,8 @@ in creating a network interfaces. ...@@ -255,8 +254,8 @@ in creating a network interfaces.
For ARM-based SoC this is the same as the stream ID. 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 This section provides an overview of the Linux kernel drivers for
DPAA2-- 1) the bus driver and associated "DPAA2 infrastructure" DPAA2-- 1) the bus driver and associated "DPAA2 infrastructure"
...@@ -291,7 +290,7 @@ of each driver follows. ...@@ -291,7 +290,7 @@ of each driver follows.
+----+--------------+ | +--+---+ +----+--------------+ | +--+---+
| MC-bus driver | | | PHY | | MC-bus driver | | | PHY |
| | | |driver| | | | |driver|
| /soc/fsl-mc | | +--+---+ | /bus/fsl-mc | | +--+---+
+-------------------+ | | +-------------------+ | |
| | | |
================================ HARDWARE =========|=================|====== ================================ HARDWARE =========|=================|======
...@@ -322,6 +321,8 @@ A brief description of each driver is provided below. ...@@ -322,6 +321,8 @@ A brief description of each driver is provided below.
a bind of the root DPRC to the DPRC driver a bind of the root DPRC to the DPRC driver
The binding for the MC-bus device-tree node can be consulted here: The binding for the MC-bus device-tree node can be consulted here:
Documentation/devicetree/bindings/misc/fsl,qoriq-mc.txt 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 DPRC driver
----------- -----------
...@@ -366,8 +367,8 @@ A brief description of each driver is provided below. ...@@ -366,8 +367,8 @@ A brief description of each driver is provided below.
active in the kernel-- Ethernet, crypto, compression, active in the kernel-- Ethernet, crypto, compression,
etc. etc.
Ethernet Ethernet driver
-------- ---------------
The Ethernet driver is bound to a DPNI and implements the kernel The Ethernet driver is bound to a DPNI and implements the kernel
interfaces needed to connect the DPAA2 network interface to interfaces needed to connect the DPAA2 network interface to
the network stack. the network stack.
......
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