Skip to contentSkip to conversation

staging: fsl-mc: move bus driver out of staging, add dpio

PATCH Superseded Stuart Yoder 3 participants 27 messages Oct 21, 2016 – Nov 30, 2016 4 messages not in the archive

Subsystems (6)

v1 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

cover staging: fsl-mc: move bus driver out of staging, add dpio

This patch series: A) addresses the final item in the staging TODO list for the fsl-mc bus driver-- adding a functional driver on top of the bus driver, and B) requests that the fsl-mc bus driver be moved out of staging.

The proposed destination for the bus driver is drivers/bus. Proposed location for global header files for fsl-mc and dpaa2 is include/linux/fsl.

The functional driver added is for the DPIO object which provides queuing services for other DPAA2 drivers. An overview of the DPIO object and driver components are in patch 2. Patches 3-7 are internal components of the DPIO driver-- bit twiddling of hardware registers, DPAA2 data structures, and the queuing APIs exposed to other drivers.

Patch 8 adds the fsl-mc driver for the DPIO object. It provides the probe/remove functions, demonstrating a working example of how fsl-mc drivers initialize, interact with the management complex hardware, map their mappable MMIO regions, initialize interrupts, register an ISR, etc. All other DPAA2 drivers will follow a similar initialization pattern.

The dpio driver is added under drivers/bus/fsl-mc/dpio. This driver provides queueing related services and there is no other obvious place it would go. Like the bus driver, it is part of the DPAA2 infrastucture and putting it under the fsl-mc bus driver seems like a logical place.

This series depends on the patch series:
[PATCH 00/14] staging: fsl-mc: cleanup and uprev to MC v10.x
https://www.spinics.net/lists/kernel/msg2362567.html

Ioana Radulescu (1):
bus: fsl-mc: dpio: add APIs for DPIO objects

Roy Pledge (6):
bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs
bus: fsl-mc: dpio: add global dpaa2 definitions
bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2
bus: fsl-mc: dpio: add the DPAA2 DPIO service interface
bus: fsl-mc: dpio: add the DPAA2 DPIO object driver
bus: fsl-mc: dpio: add maintainer for DPIO

Stuart Yoder (2):
staging: fsl-mc: move bus driver out of staging
bus: fsl-mc: dpio: add DPIO driver overview document

 Documentation/dpaa2/dpio-driver.txt                |  135 +++
 .../README.txt => Documentation/dpaa2/overview.txt |    0
 MAINTAINERS                                        |    6 +
 drivers/bus/Kconfig                                |    3 +
 drivers/bus/Makefile                               |    3 +
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/Kconfig |   10 +
 .../{staging/fsl-mc/bus => bus/fsl-mc}/Makefile    |    4 +-
 .../{staging/fsl-mc/bus => bus/fsl-mc}/dpbp-cmd.h  |    0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpbp.c  |    6 +-
 .../{staging/fsl-mc/bus => bus/fsl-mc}/dpcon-cmd.h |    0
 drivers/bus/fsl-mc/dpio/Makefile                   |    9 +
 drivers/bus/fsl-mc/dpio/dpio-cmd.h                 |  198 ++++
 drivers/bus/fsl-mc/dpio/dpio-driver.c              |  289 ++++++
 drivers/bus/fsl-mc/dpio/dpio-service.c             |  614 ++++++++++++
 drivers/bus/fsl-mc/dpio/dpio.c                     |  229 +++++
 drivers/bus/fsl-mc/dpio/dpio.h                     |  108 +++
 drivers/bus/fsl-mc/dpio/qbman-portal.c             | 1009 ++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/qbman-portal.h             |  464 +++++++++
 .../{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp-cmd.h |    0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.c |    5 +-
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.h |    0
 .../{staging/fsl-mc/bus => bus/fsl-mc}/dpmng-cmd.h |    0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmng.c |    6 +-
 .../{staging/fsl-mc/bus => bus/fsl-mc}/dprc-cmd.h  |    0
 .../fsl-mc/bus => bus/fsl-mc}/dprc-driver.c        |    4 +-
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc.c  |    6 +-
 .../fsl-mc/bus => bus/fsl-mc}/fsl-mc-allocator.c   |    4 +-
 .../fsl-mc/bus => bus/fsl-mc}/fsl-mc-bus.c         |    6 +-
 .../fsl-mc/bus => bus/fsl-mc}/fsl-mc-msi.c         |    2 +-
 .../fsl-mc/bus => bus/fsl-mc}/fsl-mc-private.h     |    4 +-
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/mc-io.c |    4 +-
 .../{staging/fsl-mc/bus => bus/fsl-mc}/mc-sys.c    |    6 +-
 drivers/irqchip/Makefile                           |    1 +
 .../bus => irqchip}/irq-gic-v3-its-fsl-mc-msi.c    |    2 +-
 drivers/staging/Kconfig                            |    2 -
 drivers/staging/Makefile                           |    1 -
 drivers/staging/fsl-mc/Kconfig                     |    1 -
 drivers/staging/fsl-mc/Makefile                    |    2 -
 drivers/staging/fsl-mc/TODO                        |   18 -
 include/linux/fsl/dpaa2-fd.h                       |  415 ++++++++
 include/linux/fsl/dpaa2-global.h                   |  203 ++++
 include/linux/fsl/dpaa2-io.h                       |  138 +++
 .../fsl-mc/include => include/linux/fsl}/dpbp.h    |    0
 .../fsl-mc/include => include/linux/fsl}/dpmng.h   |    0
 .../fsl-mc/include => include/linux/fsl}/dprc.h    |    0
 .../fsl-mc/include => include/linux/fsl}/mc-bus.h  |    2 +-
 .../fsl-mc/include => include/linux/fsl}/mc-cmd.h  |    0
 .../fsl-mc/include => include/linux/fsl}/mc-sys.h  |    0
 .../fsl-mc/include => include/linux/fsl}/mc.h      |    2 +-
 49 files changed, 3867 insertions(+), 54 deletions(-)
 create mode 100644 Documentation/dpaa2/dpio-driver.txt
 rename drivers/staging/fsl-mc/README.txt => Documentation/dpaa2/overview.txt (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/Kconfig (56%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/Makefile (88%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpbp-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpbp.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpcon-cmd.h (100%)
 create mode 100644 drivers/bus/fsl-mc/dpio/Makefile
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-cmd.h
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-driver.c
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-service.c
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.c
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.h
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.c
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.h
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmng-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmng.c (96%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc-driver.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-allocator.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-bus.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-msi.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-private.h (96%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/mc-io.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/mc-sys.c (99%)
 rename drivers/{staging/fsl-mc/bus => irqchip}/irq-gic-v3-its-fsl-mc-msi.c (99%)
 delete mode 100644 drivers/staging/fsl-mc/Kconfig
 delete mode 100644 drivers/staging/fsl-mc/Makefile
 delete mode 100644 drivers/staging/fsl-mc/TODO
 create mode 100644 include/linux/fsl/dpaa2-fd.h
 create mode 100644 include/linux/fsl/dpaa2-global.h
 create mode 100644 include/linux/fsl/dpaa2-io.h
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/dpbp.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/dpmng.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/dprc.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc-bus.h (99%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc-cmd.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc-sys.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc.h (99%)
Signature · 1 line
1.9.0
#1 lore raw

PATCH 1/9 staging: fsl-mc: move bus driver out of staging

Move the source files out of staging into their final locations:
-include files in drivers/staging/fsl-mc/include go to include/linux/fsl -irq-gic-v3-its-fsl-mc-msi.c goes to drivers/irqchip
-source in drivers/staging/fsl-mc/bus goes to drivers/bus/fsl-mc -README.txt, providing and overview of DPAA goes to
Documentation/dpaa2/overview.txt

Delete other remaining staging files-- Makefile, Kconfig, TODO

cc Thomas Gleixner <[email protected]>
cc Jason Cooper <[email protected]>
cc Marc Zyngier <[email protected]>
---
 .../README.txt => Documentation/dpaa2/overview.txt     |  0
 drivers/bus/Kconfig                                    |  3 +++
 drivers/bus/Makefile                                   |  3 +++
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/Kconfig     |  0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/Makefile    |  1 -
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpbp-cmd.h  |  0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpbp.c      |  6 +++---
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpcon-cmd.h |  0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp-cmd.h |  0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.c     |  5 +++--
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.h     |  0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmng-cmd.h |  0
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmng.c     |  6 +++---
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc-cmd.h  |  0
 .../{staging/fsl-mc/bus => bus/fsl-mc}/dprc-driver.c   |  4 ++--
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc.c      |  6 +++---
 .../fsl-mc/bus => bus/fsl-mc}/fsl-mc-allocator.c       |  4 ++--
 .../{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-bus.c    |  6 +++---
 .../{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-msi.c    |  2 +-
 .../fsl-mc/bus => bus/fsl-mc}/fsl-mc-private.h         |  4 ++--
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/mc-io.c     |  4 ++--
 drivers/{staging/fsl-mc/bus => bus/fsl-mc}/mc-sys.c    |  6 +++---
 drivers/irqchip/Makefile                               |  1 +
 .../fsl-mc/bus => irqchip}/irq-gic-v3-its-fsl-mc-msi.c |  2 +-
 drivers/staging/Kconfig                                |  2 --
 drivers/staging/Makefile                               |  1 -
 drivers/staging/fsl-mc/Kconfig                         |  1 -
 drivers/staging/fsl-mc/Makefile                        |  2 --
 drivers/staging/fsl-mc/TODO                            | 18 ------------------
 .../fsl-mc/include => include/linux/fsl}/dpbp.h        |  0
 .../fsl-mc/include => include/linux/fsl}/dpmng.h       |  0
 .../fsl-mc/include => include/linux/fsl}/dprc.h        |  0
 .../fsl-mc/include => include/linux/fsl}/mc-bus.h      |  2 +-
 .../fsl-mc/include => include/linux/fsl}/mc-cmd.h      |  0
 .../fsl-mc/include => include/linux/fsl}/mc-sys.h      |  0
 .../staging/fsl-mc/include => include/linux/fsl}/mc.h  |  2 +-
 36 files changed, 37 insertions(+), 54 deletions(-)
 rename drivers/staging/fsl-mc/README.txt => Documentation/dpaa2/overview.txt (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/Kconfig (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/Makefile (91%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpbp-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpbp.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpcon-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmcp.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmng-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dpmng.c (96%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc-cmd.h (100%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc-driver.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/dprc.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-allocator.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-bus.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-msi.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/fsl-mc-private.h (96%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/mc-io.c (99%)
 rename drivers/{staging/fsl-mc/bus => bus/fsl-mc}/mc-sys.c (99%)
 rename drivers/{staging/fsl-mc/bus => irqchip}/irq-gic-v3-its-fsl-mc-msi.c (99%)
 delete mode 100644 drivers/staging/fsl-mc/Kconfig
 delete mode 100644 drivers/staging/fsl-mc/Makefile
 delete mode 100644 drivers/staging/fsl-mc/TODO
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/dpbp.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/dpmng.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/dprc.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc-bus.h (99%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc-cmd.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc-sys.h (100%)
 rename {drivers/staging/fsl-mc/include => include/linux/fsl}/mc.h (99%)
Documentation/dpaa2/overview.txt renamed from drivers/staging/fsl-mc/README.txt +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/README.txt
rename to Documentation/dpaa2/overview.txt
drivers/bus/Kconfig +3 -0
index 7010dca..7d0e096 100644
@@ -166,4 +166,7 @@ config VEXPRESS_CONFIG
 	help
 	  Platform configuration infrastructure for the ARM Ltd.
 	  Versatile Express.
+
+source "drivers/bus/fsl-mc/Kconfig"
+
 endmenu
drivers/bus/Makefile +3 -0
index c6cfa6b..4521ab1 100644
@@ -14,6 +14,9 @@ obj-$(CONFIG_MVEBU_MBUS) 	+= mvebu-mbus.o
 # Interconnect bus driver for OMAP SoCs.
 obj-$(CONFIG_OMAP_INTERCONNECT)	+= omap_l3_smx.o omap_l3_noc.o
 
+# DPAA2 fsl-mc bus
+obj-$(CONFIG_FSL_MC_BUS)	+= fsl-mc/
+
 obj-$(CONFIG_OMAP_OCP2SCP)	+= omap-ocp2scp.o
 obj-$(CONFIG_QCOM_EBI2)		+= qcom-ebi2.o
 obj-$(CONFIG_SUNXI_RSB)		+= sunxi-rsb.o
drivers/bus/fsl-mc/Kconfig renamed from drivers/staging/fsl-mc/bus/Kconfig +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/bus/Kconfig
rename to drivers/bus/fsl-mc/Kconfig
drivers/bus/fsl-mc/Makefile renamed from drivers/staging/fsl-mc/bus/Makefile +0 -1
similarity index 91%
rename from drivers/staging/fsl-mc/bus/Makefile
rename to drivers/bus/fsl-mc/Makefile
index 38716fd..d56afee 100644
@@ -15,6 +15,5 @@ mc-bus-driver-objs := fsl-mc-bus.o \
 		      dprc-driver.o \
 		      fsl-mc-allocator.o \
 		      fsl-mc-msi.o \
-		      irq-gic-v3-its-fsl-mc-msi.o \
 		      dpmcp.o \
 		      dpbp.o
drivers/bus/fsl-mc/dpbp-cmd.h renamed from drivers/staging/fsl-mc/bus/dpbp-cmd.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/bus/dpbp-cmd.h
rename to drivers/bus/fsl-mc/dpbp-cmd.h
drivers/bus/fsl-mc/dpbp.c renamed from drivers/staging/fsl-mc/bus/dpbp.c +3 -3
similarity index 99%
rename from drivers/staging/fsl-mc/bus/dpbp.c
rename to drivers/bus/fsl-mc/dpbp.c
index cf4782f..f70e509 100644
@@ -29,9 +29,9 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-#include "../include/mc-sys.h"
-#include "../include/mc-cmd.h"
-#include "../include/dpbp.h"
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
+#include <linux/fsl/dpbp.h>
 
 #include "dpbp-cmd.h"
 
drivers/bus/fsl-mc/dpcon-cmd.h renamed from drivers/staging/fsl-mc/bus/dpcon-cmd.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/bus/dpcon-cmd.h
rename to drivers/bus/fsl-mc/dpcon-cmd.h
drivers/bus/fsl-mc/dpmcp-cmd.h renamed from drivers/staging/fsl-mc/bus/dpmcp-cmd.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/bus/dpmcp-cmd.h
rename to drivers/bus/fsl-mc/dpmcp-cmd.h
drivers/bus/fsl-mc/dpmcp.c renamed from drivers/staging/fsl-mc/bus/dpmcp.c +3 -2
similarity index 99%
rename from drivers/staging/fsl-mc/bus/dpmcp.c
rename to drivers/bus/fsl-mc/dpmcp.c
index e4d1651..00db8e9 100644
@@ -29,8 +29,9 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-#include "../include/mc-sys.h"
-#include "../include/mc-cmd.h"
+
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
 
 #include "dpmcp.h"
 #include "dpmcp-cmd.h"
drivers/bus/fsl-mc/dpmcp.h renamed from drivers/staging/fsl-mc/bus/dpmcp.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/bus/dpmcp.h
rename to drivers/bus/fsl-mc/dpmcp.h
drivers/bus/fsl-mc/dpmng-cmd.h renamed from drivers/staging/fsl-mc/bus/dpmng-cmd.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/bus/dpmng-cmd.h
rename to drivers/bus/fsl-mc/dpmng-cmd.h
drivers/bus/fsl-mc/dpmng.c renamed from drivers/staging/fsl-mc/bus/dpmng.c +3 -3
similarity index 96%
rename from drivers/staging/fsl-mc/bus/dpmng.c
rename to drivers/bus/fsl-mc/dpmng.c
index ad5d5bb..312fa0ee 100644
@@ -29,9 +29,9 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-#include "../include/mc-sys.h"
-#include "../include/mc-cmd.h"
-#include "../include/dpmng.h"
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
+#include <linux/fsl/dpmng.h>
 
 #include "dpmng-cmd.h"
 
drivers/bus/fsl-mc/dprc-cmd.h renamed from drivers/staging/fsl-mc/bus/dprc-cmd.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/bus/dprc-cmd.h
rename to drivers/bus/fsl-mc/dprc-cmd.h
drivers/bus/fsl-mc/dprc-driver.c renamed from drivers/staging/fsl-mc/bus/dprc-driver.c +2 -2
similarity index 99%
rename from drivers/staging/fsl-mc/bus/dprc-driver.c
rename to drivers/bus/fsl-mc/dprc-driver.c
index 4e416d8..b20e060 100644
@@ -13,8 +13,8 @@
 #include <linux/slab.h>
 #include <linux/interrupt.h>
 #include <linux/msi.h>
-#include "../include/mc-bus.h"
-#include "../include/mc-sys.h"
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
 
 #include "dprc-cmd.h"
 #include "fsl-mc-private.h"
drivers/bus/fsl-mc/dprc.c renamed from drivers/staging/fsl-mc/bus/dprc.c +3 -3
similarity index 99%
rename from drivers/staging/fsl-mc/bus/dprc.c
rename to drivers/bus/fsl-mc/dprc.c
index 572edd4..e2ebfb7 100644
@@ -29,9 +29,9 @@
  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  * POSSIBILITY OF SUCH DAMAGE.
  */
-#include "../include/mc-sys.h"
-#include "../include/mc-cmd.h"
-#include "../include/dprc.h"
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
+#include <linux/fsl/dprc.h>
 
 #include "dprc-cmd.h"
 
drivers/bus/fsl-mc/fsl-mc-allocator.c renamed from drivers/staging/fsl-mc/bus/fsl-mc-allocator.c +2 -2
similarity index 99%
rename from drivers/staging/fsl-mc/bus/fsl-mc-allocator.c
rename to drivers/bus/fsl-mc/fsl-mc-allocator.c
index ce07096..679574b 100644
@@ -10,8 +10,8 @@
 
 #include <linux/module.h>
 #include <linux/msi.h>
-#include "../include/mc-bus.h"
-#include "../include/mc-sys.h"
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
 
 #include "dpbp-cmd.h"
 #include "dpcon-cmd.h"
drivers/bus/fsl-mc/fsl-mc-bus.c renamed from drivers/staging/fsl-mc/bus/fsl-mc-bus.c +3 -3
similarity index 99%
rename from drivers/staging/fsl-mc/bus/fsl-mc-bus.c
rename to drivers/bus/fsl-mc/fsl-mc-bus.c
index 4e92437..e051b21 100644
@@ -18,9 +18,9 @@
 #include <linux/bitops.h>
 #include <linux/msi.h>
 #include <linux/dma-mapping.h>
-#include "../include/mc-bus.h"
-#include "../include/dpmng.h"
-#include "../include/mc-sys.h"
+#include <linux/fsl/mc-bus.h>
+#include <linux/fsl/dpmng.h>
+#include <linux/fsl/mc-sys.h>
 
 #include "fsl-mc-private.h"
 #include "dprc-cmd.h"
drivers/bus/fsl-mc/fsl-mc-msi.c renamed from drivers/staging/fsl-mc/bus/fsl-mc-msi.c +1 -1
similarity index 99%
rename from drivers/staging/fsl-mc/bus/fsl-mc-msi.c
rename to drivers/bus/fsl-mc/fsl-mc-msi.c
index 7975c6e..f2d6a22 100644
@@ -16,7 +16,7 @@
 #include <linux/irq.h>
 #include <linux/irqdomain.h>
 #include <linux/msi.h>
-#include "../include/mc-bus.h"
+#include <linux/fsl/mc-bus.h>
 
 /*
  * Generate a unique ID identifying the interrupt (only used within the MSI
drivers/bus/fsl-mc/fsl-mc-private.h renamed from drivers/staging/fsl-mc/bus/fsl-mc-private.h +2 -2
similarity index 96%
rename from drivers/staging/fsl-mc/bus/fsl-mc-private.h
rename to drivers/bus/fsl-mc/fsl-mc-private.h
index 5c49c9d..599425f 100644
@@ -10,8 +10,8 @@
 #ifndef _FSL_MC_PRIVATE_H_
 #define _FSL_MC_PRIVATE_H_
 
-#include "../include/mc.h"
-#include "../include/mc-bus.h"
+#include <linux/fsl/mc.h>
+#include <linux/fsl/mc-bus.h>
 
 int __must_check fsl_mc_device_add(struct dprc_obj_desc *obj_desc,
 				   struct fsl_mc_io *mc_io,
drivers/bus/fsl-mc/mc-io.c renamed from drivers/staging/fsl-mc/bus/mc-io.c +2 -2
similarity index 99%
rename from drivers/staging/fsl-mc/bus/mc-io.c
rename to drivers/bus/fsl-mc/mc-io.c
index d66b87f..501fba3 100644
@@ -31,8 +31,8 @@
  */
 
 #include <linux/io.h>
-#include "../include/mc-bus.h"
-#include "../include/mc-sys.h"
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
 
 #include "fsl-mc-private.h"
 #include "dpmcp.h"
drivers/bus/fsl-mc/mc-sys.c renamed from drivers/staging/fsl-mc/bus/mc-sys.c +3 -3
similarity index 99%
rename from drivers/staging/fsl-mc/bus/mc-sys.c
rename to drivers/bus/fsl-mc/mc-sys.c
index 4d82802..ac86226 100644
@@ -37,9 +37,9 @@
 #include <linux/ioport.h>
 #include <linux/device.h>
 #include <linux/io.h>
-#include "../include/mc-sys.h"
-#include "../include/mc-cmd.h"
-#include "../include/mc.h"
+#include <linux/fsl/mc-sys.h>
+#include <linux/fsl/mc-cmd.h>
+#include <linux/fsl/mc.h>
 
 #include "dpmcp.h"
 
drivers/irqchip/Makefile +1 -0
index e4dbfc8..075709d 100644
@@ -74,3 +74,4 @@ obj-$(CONFIG_LS_SCFG_MSI)		+= irq-ls-scfg-msi.o
 obj-$(CONFIG_EZNPS_GIC)			+= irq-eznps.o
 obj-$(CONFIG_ARCH_ASPEED)		+= irq-aspeed-vic.o
 obj-$(CONFIG_STM32_EXTI) 		+= irq-stm32-exti.o
+obj-$(CONFIG_FSL_MC_BUS)		+= irq-gic-v3-its-fsl-mc-msi.o
drivers/irqchip/irq-gic-v3-its-fsl-mc-msi.c renamed from drivers/staging/fsl-mc/bus/irq-gic-v3-its-fsl-mc-msi.c +1 -1
similarity index 99%
rename from drivers/staging/fsl-mc/bus/irq-gic-v3-its-fsl-mc-msi.c
rename to drivers/irqchip/irq-gic-v3-its-fsl-mc-msi.c
index 6b1cd57..347a3ea 100644
@@ -16,7 +16,7 @@
 #include <linux/msi.h>
 #include <linux/of.h>
 #include <linux/of_irq.h>
-#include "../include/mc-bus.h"
+#include <linux/fsl/mc-bus.h>
 
 static struct irq_chip its_msi_irq_chip = {
 	.name = "ITS-fMSI",
drivers/staging/Kconfig +0 -2
index 58a7b35..8d7a13f 100644
@@ -92,8 +92,6 @@ source "drivers/staging/clocking-wizard/Kconfig"
 
 source "drivers/staging/fbtft/Kconfig"
 
-source "drivers/staging/fsl-mc/Kconfig"
-
 source "drivers/staging/wilc1000/Kconfig"
 
 source "drivers/staging/most/Kconfig"
drivers/staging/Makefile +0 -1
index 2fa9745..8a88b1d 100644
@@ -35,7 +35,6 @@ obj-$(CONFIG_CRYPTO_SKEIN)	+= skein/
 obj-$(CONFIG_UNISYSSPAR)	+= unisys/
 obj-$(CONFIG_COMMON_CLK_XLNX_CLKWZRD)	+= clocking-wizard/
 obj-$(CONFIG_FB_TFT)		+= fbtft/
-obj-$(CONFIG_FSL_MC_BUS)	+= fsl-mc/
 obj-$(CONFIG_WILC1000)		+= wilc1000/
 obj-$(CONFIG_MOST)		+= most/
 obj-$(CONFIG_ISDN_I4L)		+= i4l/
drivers/staging/fsl-mc/Kconfig deleted +0 -1
deleted file mode 100644
index 32df07b..0000000
@@ -1 +0,0 @@
-source "drivers/staging/fsl-mc/bus/Kconfig"
drivers/staging/fsl-mc/Makefile deleted +0 -2
deleted file mode 100644
index 9c6a001..0000000
@@ -1,2 +0,0 @@
-# Freescale Management Complex (MC) bus drivers
-obj-$(CONFIG_FSL_MC_BUS)	+= bus/
drivers/staging/fsl-mc/TODO deleted +0 -18
deleted file mode 100644
index 54a8bc6..0000000
@@ -1,18 +0,0 @@
-* Add at least one device driver for a DPAA2 object (child device of the
-  fsl-mc bus).  Most likely candidate for this is adding DPAA2 Ethernet
-  driver support, which depends on drivers for several objects: DPNI,
-  DPIO, DPMAC.  Other pre-requisites include:
-
-     * MC firmware uprev.  The MC firmware upon which the fsl-mc
-       bus driver and DPAA2 object drivers are based is continuing
-       to evolve, so minor updates are needed to keep in sync with binary
-       interface changes to the MC.
-
-* Cleanup
-
-Please send any patches to Greg Kroah-Hartman <[email protected]>,
[email protected], [email protected],
[email protected]
-
-[1] https://lkml.org/lkml/2015/7/9/93
-[2] https://lkml.org/lkml/2015/7/7/712
include/linux/fsl/dpbp.h renamed from drivers/staging/fsl-mc/include/dpbp.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/include/dpbp.h
rename to include/linux/fsl/dpbp.h
include/linux/fsl/dpmng.h renamed from drivers/staging/fsl-mc/include/dpmng.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/include/dpmng.h
rename to include/linux/fsl/dpmng.h
include/linux/fsl/dprc.h renamed from drivers/staging/fsl-mc/include/dprc.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/include/dprc.h
rename to include/linux/fsl/dprc.h
include/linux/fsl/mc-bus.h renamed from drivers/staging/fsl-mc/include/mc-bus.h +1 -1
similarity index 99%
rename from drivers/staging/fsl-mc/include/mc-bus.h
rename to include/linux/fsl/mc-bus.h
index e915574..7acf3f0 100644
@@ -11,7 +11,7 @@
 #ifndef _FSL_MC_MCBUS_H_
 #define _FSL_MC_MCBUS_H_
 
-#include "../include/mc.h"
+#include <linux/fsl/mc.h>
 #include <linux/mutex.h>
 
 struct irq_domain;
include/linux/fsl/mc-cmd.h renamed from drivers/staging/fsl-mc/include/mc-cmd.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/include/mc-cmd.h
rename to include/linux/fsl/mc-cmd.h
include/linux/fsl/mc-sys.h renamed from drivers/staging/fsl-mc/include/mc-sys.h +0 -0
similarity index 100%
rename from drivers/staging/fsl-mc/include/mc-sys.h
rename to include/linux/fsl/mc-sys.h
include/linux/fsl/mc.h renamed from drivers/staging/fsl-mc/include/mc.h +1 -1
similarity index 99%
rename from drivers/staging/fsl-mc/include/mc.h
rename to include/linux/fsl/mc.h
index a781a36..cdba52a 100644
@@ -14,7 +14,7 @@
 #include <linux/device.h>
 #include <linux/mod_devicetable.h>
 #include <linux/interrupt.h>
-#include "../include/dprc.h"
+#include <linux/fsl/dprc.h>
 
 #define FSL_MC_VENDOR_FREESCALE	0x1957
 
Signature · 1 line
1.9.0
#6 lore raw

PATCH 4/9 bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

In reply to Stuart Yoder

From: Roy Pledge <[email protected]>

Add global definitions for DPAA2 frame descriptors and scatter gather entries.

---
 include/linux/fsl/dpaa2-fd.h | 415 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 415 insertions(+)
 create mode 100644 include/linux/fsl/dpaa2-fd.h
include/linux/fsl/dpaa2-fd.h new file +415 -0
new file mode 100644
index 0000000..b3fa9ff
@@ -0,0 +1,415 @@
+/*
+ * Copyright 2014-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Freescale Semiconductor nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#ifndef __FSL_DPAA2_FD_H
+#define __FSL_DPAA2_FD_H
+
+#include <linux/kernel.h>
+
+/**
+ * DOC: DPAA2 FD - Frame Descriptor APIs for DPAA2
+ *
+ * Frame Descriptors (FDs) are used to describe frame data in the DPAA2.
+ * Frames can be enqueued and dequeued to Frame Queues (FQs) which are consumed
+ * by the various DPAA accelerators (WRIOP, SEC, PME, DCE)
+ *
+ * There are three types of frames: single, scatter gather, and frame lists.
+ *
+ * The set of APIs in this file must be used to create, manipulate and
+ * query Frame Descriptors.
+ */
+
+/**
+ * struct dpaa2_fd - Struct describing FDs
+ * @words:         for easier/faster copying the whole FD structure
+ * @addr:          address in the FD
+ * @len:           length in the FD
+ * @bpid:          buffer pool ID
+ * @format_offset: format and offset fields
+ * @frc:           frame context
+ * @ctrl:          control bits...including dd, sc, va, err, etc
+ * @flc:           flow context address
+ *
+ * This structure represents the basic Frame Descriptor used in the system.
+ */
+struct dpaa2_fd {
+	union {
+		u32 words[8];
+		struct dpaa2_fd_simple {
+			__le64 addr;
+			__le32 len;
+			__le16 bpid;
+			__le16 format_offset;
+			__le32 frc;
+			__le32 ctrl;
+			__le64 flc;
+		} simple;
+	};
+};
+
+#define FD_OFFSET_MASK 0x0FFF
+#define FD_FORMAT_MASK 0x3
+#define FD_FORMAT_SHIFT 12
+#define SG_SHORT_LEN_FLAG_MASK 0x1
+#define SG_SHORT_LEN_FLAG_SHIFT 14
+#define SG_SHORT_LEN_MASK 0x1FFFF
+#define SG_OFFSET_MASK 0x0FFF
+#define SG_FORMAT_MASK 0x3
+#define SG_FORMAT_SHIFT 12
+#define SG_BPID_MASK 0x3FFF
+#define SG_FINAL_FLAG_MASK 0x1
+#define SG_FINAL_FLAG_SHIFT 15
+
+enum dpaa2_fd_format {
+	dpaa2_fd_single = 0,
+	dpaa2_fd_list,
+	dpaa2_fd_sg
+};
+
+/**
+ * dpaa2_fd_get_addr() - get the addr field of frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the address in the frame descriptor.
+ */
+static inline dma_addr_t dpaa2_fd_get_addr(const struct dpaa2_fd *fd)
+{
+
+	return (dma_addr_t)fd->simple.addr;
+}
+
+/**
+ * dpaa2_fd_set_addr() - Set the addr field of frame descriptor
+ * @fd: the given frame descriptor
+ * @addr: the address needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_addr(struct dpaa2_fd *fd, dma_addr_t addr)
+{
+	fd->simple.addr = addr;
+}
+
+/**
+ * dpaa2_fd_get_frc() - Get the frame context in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the frame context field in the frame descriptor.
+ */
+static inline u32 dpaa2_fd_get_frc(const struct dpaa2_fd *fd)
+{
+	return fd->simple.frc;
+}
+
+/**
+ * dpaa2_fd_set_frc() - Set the frame context in the frame descriptor
+ * @fd: the given frame descriptor
+ * @frc: the frame context needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_frc(struct dpaa2_fd *fd, u32 frc)
+{
+	fd->simple.frc = frc;
+}
+
+/**
+ * dpaa2_fd_get_flc() - Get the flow context in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the flow context in the frame descriptor.
+ */
+static inline dma_addr_t dpaa2_fd_get_flc(const struct dpaa2_fd *fd)
+{
+	return (dma_addr_t)fd->simple.flc;
+}
+
+/**
+ * dpaa2_fd_set_flc() - Set the flow context field of frame descriptor
+ * @fd: the given frame descriptor
+ * @flc_addr: the flow context needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_flc(struct dpaa2_fd *fd,  dma_addr_t flc_addr)
+{
+	fd->simple.flc = flc_addr;
+}
+
+/**
+ * dpaa2_fd_get_len() - Get the length in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the length field in the frame descriptor.
+ */
+static inline u32 dpaa2_fd_get_len(const struct dpaa2_fd *fd)
+{
+	return fd->simple.len;
+}
+
+/**
+ * dpaa2_fd_set_len() - Set the length field of frame descriptor
+ * @fd: the given frame descriptor
+ * @len: the length needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_len(struct dpaa2_fd *fd, u32 len)
+{
+	fd->simple.len = len;
+}
+
+/**
+ * dpaa2_fd_get_offset() - Get the offset field in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the offset.
+ */
+static inline uint16_t dpaa2_fd_get_offset(const struct dpaa2_fd *fd)
+{
+	return fd->simple.format_offset & FD_OFFSET_MASK;
+}
+
+/**
+ * dpaa2_fd_set_offset() - Set the offset field of frame descriptor
+ * @fd: the given frame descriptor
+ * @offset: the offset needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_offset(struct dpaa2_fd *fd, uint16_t offset)
+{
+	fd->simple.format_offset &= ~(FD_OFFSET_MASK);
+	fd->simple.format_offset |= offset;
+}
+
+/**
+ * dpaa2_fd_get_format() - Get the format field in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the format.
+ */
+static inline enum dpaa2_fd_format dpaa2_fd_get_format(
+						const struct dpaa2_fd *fd)
+{
+	return (enum dpaa2_fd_format)((fd->simple.format_offset
+				      >> FD_FORMAT_SHIFT) & FD_FORMAT_MASK);
+}
+
+/**
+ * dpaa2_fd_set_format() - Set the format field of frame descriptor
+ * @fd: the given frame descriptor
+ * @format: the format needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_format(struct dpaa2_fd *fd,
+				       enum dpaa2_fd_format format)
+{
+	fd->simple.format_offset &= ~(FD_FORMAT_MASK << FD_FORMAT_SHIFT);
+	fd->simple.format_offset |= format << FD_FORMAT_SHIFT;
+}
+
+/**
+ * dpaa2_fd_get_bpid() - Get the bpid field in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the buffer pool id.
+ */
+static inline uint16_t dpaa2_fd_get_bpid(const struct dpaa2_fd *fd)
+{
+	return fd->simple.bpid;
+}
+
+/**
+ * dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor
+ * @fd: the given frame descriptor
+ * @bpid: buffer pool id to be set
+ */
+static inline void dpaa2_fd_set_bpid(struct dpaa2_fd *fd, uint16_t bpid)
+{
+	fd->simple.bpid = bpid;
+}
+
+/**
+ * struct dpaa2_sg_entry - the scatter-gathering structure
+ * @addr: address of the sg entry
+ * @len: length in this sg entry
+ * @bpid: buffer pool id
+ * @format_offset: offset in the MS 16 bits, BPID in the LS 16 bits
+ */
+struct dpaa2_sg_entry {
+	__le64 addr;
+	__le32 len;
+	__le16 bpid;
+	__le16 format_offset;
+};
+
+enum dpaa2_sg_format {
+	dpaa2_sg_single = 0,
+	dpaa2_sg_frame_data,
+	dpaa2_sg_sgt_ext
+};
+
+/* Accessors for SG entry fields */
+
+/**
+ * dpaa2_sg_get_addr() - Get the address from SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the address.
+ */
+static inline dma_addr_t dpaa2_sg_get_addr(const struct dpaa2_sg_entry *sg)
+{
+	return le64_to_cpu((dma_addr_t)sg->addr);
+}
+
+/**
+ * dpaa2_sg_set_addr() - Set the address in SG entry
+ * @sg: the given scatter-gathering object
+ * @addr: the address to be set
+ */
+static inline void dpaa2_sg_set_addr(struct dpaa2_sg_entry *sg, dma_addr_t addr)
+{
+	sg->addr = cpu_to_le64(addr);
+}
+
+static inline bool dpaa2_sg_short_len(const struct dpaa2_sg_entry *sg)
+{
+	return (le16_to_cpu(sg->format_offset) >> SG_SHORT_LEN_FLAG_SHIFT)
+		& SG_SHORT_LEN_FLAG_MASK;
+}
+
+/**
+ * dpaa2_sg_get_len() - Get the length in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the length.
+ */
+static inline u32 dpaa2_sg_get_len(const struct dpaa2_sg_entry *sg)
+{
+	if (dpaa2_sg_short_len(sg))
+		return le32_to_cpu(sg->len) & SG_SHORT_LEN_MASK;
+
+	return le32_to_cpu(sg->len);
+}
+
+/**
+ * dpaa2_sg_set_len() - Set the length in SG entry
+ * @sg: the given scatter-gathering object
+ * @len: the length to be set
+ */
+static inline void dpaa2_sg_set_len(struct dpaa2_sg_entry *sg, u32 len)
+{
+	sg->len = cpu_to_le32(len);
+}
+
+/**
+ * dpaa2_sg_get_offset() - Get the offset in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the offset.
+ */
+static inline u16 dpaa2_sg_get_offset(const struct dpaa2_sg_entry *sg)
+{
+	return le16_to_cpu(sg->format_offset) & SG_OFFSET_MASK;
+}
+
+/**
+ * dpaa2_sg_set_offset() - Set the offset in SG entry
+ * @sg: the given scatter-gathering object
+ * @offset: the offset to be set
+ */
+static inline void dpaa2_sg_set_offset(struct dpaa2_sg_entry *sg,
+				       u16 offset)
+{
+	sg->format_offset &= cpu_to_le16(~(SG_OFFSET_MASK));
+	sg->format_offset |= cpu_to_le16(offset);
+}
+
+/**
+ * dpaa2_sg_get_format() - Get the SG format in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the format.
+ */
+static inline enum dpaa2_sg_format
+	dpaa2_sg_get_format(const struct dpaa2_sg_entry *sg)
+{
+	return (enum dpaa2_sg_format)((le16_to_cpu(sg->format_offset)
+				       >> SG_FORMAT_SHIFT) & SG_FORMAT_MASK);
+}
+
+/**
+ * dpaa2_sg_set_format() - Set the SG format in SG entry
+ * @sg: the given scatter-gathering object
+ * @format: the format to be set
+ */
+static inline void dpaa2_sg_set_format(struct dpaa2_sg_entry *sg,
+				       enum dpaa2_sg_format format)
+{
+	sg->format_offset &= cpu_to_le16(~(SG_FORMAT_MASK << SG_FORMAT_SHIFT));
+	sg->format_offset |= cpu_to_le16(format << SG_FORMAT_SHIFT);
+}
+
+/**
+ * dpaa2_sg_get_bpid() - Get the buffer pool id in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the bpid.
+ */
+static inline u16 dpaa2_sg_get_bpid(const struct dpaa2_sg_entry *sg)
+{
+	return le16_to_cpu(sg->bpid) & SG_BPID_MASK;
+}
+
+/**
+ * dpaa2_sg_set_bpid() - Set the buffer pool id in SG entry
+ * @sg: the given scatter-gathering object
+ * @bpid: the bpid to be set
+ */
+static inline void dpaa2_sg_set_bpid(struct dpaa2_sg_entry *sg, u16 bpid)
+{
+	sg->bpid &= cpu_to_le16(~(SG_BPID_MASK));
+	sg->bpid |= cpu_to_le16(bpid);
+}
+
+/**
+ * dpaa2_sg_is_final() - Check final bit in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return bool.
+ */
+static inline bool dpaa2_sg_is_final(const struct dpaa2_sg_entry *sg)
+{
+	return !!(le16_to_cpu(sg->format_offset) >> SG_FINAL_FLAG_SHIFT);
+}
+
+/**
+ * dpaa2_sg_set_final() - Set the final bit in SG entry
+ * @sg: the given scatter-gathering object
+ * @final: the final boolean to be set
+ */
+static inline void dpaa2_sg_set_final(struct dpaa2_sg_entry *sg, bool final)
+{
+	sg->format_offset &= cpu_to_le16(~(SG_FINAL_FLAG_MASK
+					 << SG_FINAL_FLAG_SHIFT));
+	sg->format_offset |= cpu_to_le16(final << SG_FINAL_FLAG_SHIFT);
+}
+
+#endif /* __FSL_DPAA2_FD_H */
Signature · 1 line
1.9.0
#27 lore raw

PATCH 9/9 bus: fsl-mc: dpio: add maintainer for DPIO

In reply to Stuart Yoder

From: Roy Pledge <[email protected]>

add Roy Pledge as maintainer of DPIO

---
 MAINTAINERS | 6 ++++++
 1 file changed, 6 insertions(+)
MAINTAINERS +6 -0
index 797a08a..1aa991e 100644
@@ -5097,6 +5097,12 @@ L:	[email protected]
 S:	Maintained
 F:	drivers/staging/fsl-mc/
 
+DPAA2 DATAPATH I/O (DPIO) DRIVER
+M:	Roy Pledge <[email protected]>
+L:	[email protected]
+S:	Maintained
+F:	drivers/bus/fsl-mc/dpio
+
 FREEVXFS FILESYSTEM
 M:	Christoph Hellwig <[email protected]>
 W:	ftp://ftp.openlinux.org/pub/people/hch/vxfs
Signature · 1 line
1.9.0
#13 lore raw

PATCH 6/9 bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

In reply to Stuart Yoder

From: Roy Pledge <[email protected]>

Add QBman APIs for frame queue and buffer pool operations.

---
 drivers/bus/fsl-mc/dpio/Makefile       |    2 +-
 drivers/bus/fsl-mc/dpio/qbman-portal.c | 1009 ++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/qbman-portal.h |  464 +++++++++++++++
 3 files changed, 1474 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.c
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.h
drivers/bus/fsl-mc/dpio/Makefile +1 -1
index 128befc..6588498 100644
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +1009 -0

1,009 lines not on this page · raw message

drivers/bus/fsl-mc/dpio/qbman-portal.h new file +464 -0

464 lines not on this page · raw message

Signature · 1 line
1.9.0
#19 lore raw

PATCH 7/9 bus: fsl-mc: dpio: add the DPAA2 DPIO service interface

In reply to Stuart Yoder

From: Roy Pledge <[email protected]>

The DPIO service interface handles initialization of DPIO objects and exports APIs to be used by other DPAA2 object drivers to perform queuing and buffer management related operations. The service allows registration of callbacks when frames or notifications are received.

---
 drivers/bus/fsl-mc/dpio/Makefile       |   2 +-
 drivers/bus/fsl-mc/dpio/dpio-service.c | 614 +++++++++++++++++++++++++++++++++
 include/linux/fsl/dpaa2-io.h           | 138 ++++++++
 3 files changed, 753 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-service.c
 create mode 100644 include/linux/fsl/dpaa2-io.h
drivers/bus/fsl-mc/dpio/Makefile +1 -1
index 6588498..0778da7 100644
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o qbman-portal.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o
drivers/bus/fsl-mc/dpio/dpio-service.c new file +614 -0

614 lines not on this page · raw message

include/linux/fsl/dpaa2-io.h new file +138 -0

138 lines not on this page · raw message

Signature · 1 line
1.9.0
#3 lore raw

PATCH 3/9 bus: fsl-mc: dpio: add APIs for DPIO objects

In reply to Stuart Yoder

From: Ioana Radulescu <[email protected]>

Add the command build/parse APIs for operating on DPIO objects through the DPAA2 Management Complex.

---
 drivers/bus/fsl-mc/Kconfig         |  10 ++
 drivers/bus/fsl-mc/Makefile        |   3 +
 drivers/bus/fsl-mc/dpio/Makefile   |   9 ++
 drivers/bus/fsl-mc/dpio/dpio-cmd.h | 198 ++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/dpio.c     | 229 +++++++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/dpio.h     | 108 +++++++++++++++++
 6 files changed, 557 insertions(+)
 create mode 100644 drivers/bus/fsl-mc/dpio/Makefile
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-cmd.h
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.c
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.h
drivers/bus/fsl-mc/Kconfig +10 -0
index 5c009ab..a10aaf0 100644
@@ -15,3 +15,13 @@ config FSL_MC_BUS
 	  architecture.  The fsl-mc bus driver handles discovery of
 	  DPAA2 objects (which are represented as Linux devices) and
 	  binding objects to drivers.
+
+config FSL_MC_DPIO
+        tristate "QorIQ DPAA2 DPIO driver"
+        depends on FSL_MC_BUS
+        help
+	  Driver for the DPAA2 DPIO object.  A DPIO provides queue and
+	  buffer management facilities for software to interact with
+	  other DPAA2 objects. This driver does not expose the DPIO
+	  objects individually, but groups them under a service layer
+	  API.
drivers/bus/fsl-mc/Makefile +3 -0
index d56afee..d18df72 100644
@@ -17,3 +17,6 @@ mc-bus-driver-objs := fsl-mc-bus.o \
 		      fsl-mc-msi.o \
 		      dpmcp.o \
 		      dpbp.o
+
+# MC DPIO driver
+obj-$(CONFIG_FSL_MC_DPIO) += dpio/
drivers/bus/fsl-mc/dpio/Makefile new file +9 -0
new file mode 100644
index 0000000..128befc
@@ -0,0 +1,9 @@
+#
+# QorIQ DPAA2 DPIO driver
+#
+
+subdir-ccflags-y := -Werror
+
+obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
+
+fsl-mc-dpio-objs := dpio.o
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +198 -0

198 lines not on this page · raw message

drivers/bus/fsl-mc/dpio/dpio.c new file +229 -0

229 lines not on this page · raw message

drivers/bus/fsl-mc/dpio/dpio.h new file +108 -0

108 lines not on this page · raw message

Signature · 1 line
1.9.0
#2 lore raw

PATCH 2/9 bus: fsl-mc: dpio: add DPIO driver overview document

In reply to Stuart Yoder

add document describing the dpio driver and it's role, components and major interfaces

---
 Documentation/dpaa2/dpio-driver.txt | 135 ++++++++++++++++++++++++++++++++++++
 1 file changed, 135 insertions(+)
 create mode 100644 Documentation/dpaa2/dpio-driver.txt
Documentation/dpaa2/dpio-driver.txt new file +135 -0
new file mode 100644
index 0000000..5c192b3
@@ -0,0 +1,135 @@
+Copyright (C) 2016 Freescale Semiconductor Inc.
+
+Introduction
+------------
+
+A DPAA2 DPIO (Data Path I/O) is a hardware object that provides
+interfaces to enqueue and dequeue frames to/from network interfaces
+and other accelerators.  A DPIO also provides hardware buffer
+pool management for network interfaces.
+
+This document provides an overview the Linux DPIO driver, its
+subcomponents, and its APIs.
+
+See Documentation/dpaa2/overview.txt for a general overview of DPAA2
+and the general DPAA2 driver architecture in Linux.
+
+Driver Overview
+---------------
+
+The DPIO driver is bound to DPIO objects discovered on the fsl-mc bus and
+provides services that:
+  A) allow other drivers, such as the Ethernet driver, to enqueue and dequeue
+     frames for their respective objects
+  B) allow drivers to register callbacks for data availability notifications
+     when data becomes available on a queue or channel
+  C) allow drivers to manage hardware buffer pools
+
+The Linux DPIO driver consists of 3 primary components--
+   DPIO object driver-- fsl-mc driver that manages the DPIO object
+   DPIO service-- provides APIs to other Linux drivers for services
+   QBman portal interface-- sends portal commands, gets responses
+
+          fsl-mc          other
+           bus           drivers
+            |               |
+        +---+----+   +------+-----+
+        |DPIO obj|   |DPIO service|
+        | driver |---|  (DPIO)    |
+        +--------+   +------+-----+
+                            |
+                     +------+-----+
+                     |    QBman   |
+                     | portal i/f |
+                     +------------+
+                            |
+                         hardware
+
+The diagram below shows how the DPIO driver components fit with the other
+DPAA2 Linux driver components:
+                                                   +------------+
+                                                   | OS Network |
+                                                   |   Stack    |
+                 +------------+                    +------------+
+                 | Allocator  |. . . . . . .       |  Ethernet  |
+                 |(DPMCP,DPBP)|                    |   (DPNI)   |
+                 +-.----------+                    +---+---+----+
+                  .          .                         ^   |
+                 .            .           <data avail, |   |<enqueue,
+                .              .           tx confirm> |   | dequeue>
+    +-------------+             .                      |   |
+    | DPRC driver |              .    +--------+ +------------+
+    |   (DPRC)    |               . . |DPIO obj| |DPIO service|
+    +----------+--+                   | driver |-|  (DPIO)    |
+               |                      +--------+ +------+-----+
+               |<dev add/remove>                 +------|-----+
+               |                                 |   QBman    |
+          +----+--------------+                  | portal i/f |
+          |   MC-bus driver   |                  +------------+
+          |                   |                     |
+          | /soc/fsl-mc       |                     |
+          +-------------------+                     |
+                                                    |
+ =========================================|=========|========================
+                                        +-+--DPIO---|-----------+
+                                        |           |           |
+                                        |        QBman Portal   |
+                                        +-----------------------+
+
+ ============================================================================
+
+
+DPIO Object Driver (dpio-driver.c)
+----------------------------------
+
+   The dpio-driver component registers with the fsl-mc bus to handle objects of
+   type "dpio".  The implementation of probe() handles basic initialization
+   of the DPIO including mapping of the DPIO regions (the QBman SW portal)
+   and initializing interrupts and registering irq handlers.  The dpio-driver
+   registers the probed DPIO with dpio-service.
+
+DPIO service  (dpio-service.c, dpaa2-io.h)
+------------------------------------------
+
+   The dpio service component provides queuing, notification, and buffers
+   management services to DPAA2 drivers, such as the Ethernet driver.  A system
+   will typically allocate 1 DPIO object per CPU to allow queuing operations
+   to happen simultaneously across all CPUs.
+
+   Notification handling
+      dpaa2_io_service_register()
+      dpaa2_io_service_deregister()
+      dpaa2_io_service_rearm()
+
+   Queuing
+      dpaa2_io_service_pull_fq()
+      dpaa2_io_service_pull_channel()
+      dpaa2_io_service_enqueue_fq()
+      dpaa2_io_service_enqueue_qd()
+      dpaa2_io_store_create()
+      dpaa2_io_store_destroy()
+      dpaa2_io_store_next()
+
+   Buffer pool management
+      dpaa2_io_service_release()
+      dpaa2_io_service_acquire()
+
+QBman portal interface (qbman-portal.c)
+---------------------------------------
+
+   The qbman-portal component provides APIs to do the low level hardware
+   bit twiddling for operations such as:
+      -initializing Qman software portals
+      -building and sending portal commands
+      -portal interrupt configuration and processing
+
+   The qbman-portal APIs are not public to other drivers, and are
+   only used by dpio-service.
+
+Other (dpaa2-fd.h, dpaa2-global.h)
+----------------------------------
+
+   Frame descriptor and scatter-gather definitions and the APIs used to
+   manipulate them are defined in dpaa2-fd.h.
+
+   Dequeue result struct and parsing APIs are defined in dpaa2-global.h.
Signature · 1 line
1.9.0
#12 lore raw

PATCH 5/9 bus: fsl-mc: dpio: add global dpaa2 definitions

In reply to Stuart Yoder

From: Roy Pledge <[email protected]>

Create header for global dpaa2 definitions. Add definitions for dequeue results.

---
 include/linux/fsl/dpaa2-global.h | 203 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 203 insertions(+)
 create mode 100644 include/linux/fsl/dpaa2-global.h
include/linux/fsl/dpaa2-global.h new file +203 -0
new file mode 100644
index 0000000..3ee3f29
@@ -0,0 +1,203 @@
+/*
+ * Copyright 2014-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Freescale Semiconductor nor the
+ *       names of its contributors may be used to endorse or promote products
+ *       derived from this software without specific prior written permission.
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+#ifndef __FSL_DPAA2_GLOBAL_H
+#define __FSL_DPAA2_GLOBAL_H
+
+#include <linux/types.h>
+#include <linux/cpumask.h>
+#include <linux/fsl/dpaa2-fd.h>
+
+struct dpaa2_dq {
+	union {
+		struct common {
+			u8 verb;
+			u8 reserved[63];
+		} common;
+		struct dq {
+			u8 verb;
+			u8 stat;
+			__le16 seqnum;
+			__le16 oprid;
+			u8 reserved;
+			u8 tok;
+			__le32 fqid;
+			u32 reserved2;
+			__le32 fq_byte_cnt;
+			__le32 fq_frm_cnt;
+			__le64 fqd_ctx;
+			u8 fd[32];
+		} dq;
+		struct scn {
+			u8 verb;
+			u8 stat;
+			u8 state;
+			u8 reserved;
+			__le32 rid_tok;
+			__le64 ctx;
+		} scn;
+	};
+};
+
+
+/* Parsing frame dequeue results */
+/* FQ empty */
+#define DPAA2_DQ_STAT_FQEMPTY       0x80
+/* FQ held active */
+#define DPAA2_DQ_STAT_HELDACTIVE    0x40
+/* FQ force eligible */
+#define DPAA2_DQ_STAT_FORCEELIGIBLE 0x20
+/* valid frame */
+#define DPAA2_DQ_STAT_VALIDFRAME    0x10
+/* FQ ODP enable */
+#define DPAA2_DQ_STAT_ODPVALID      0x04
+/* volatile dequeue */
+#define DPAA2_DQ_STAT_VOLATILE      0x02
+/* volatile dequeue command is expired */
+#define DPAA2_DQ_STAT_EXPIRED       0x01
+
+#define DQ_FQID_MASK 0x00FFFFFF
+#define DQ_FRAME_COUNT_MASK 0x00FFFFFF
+
+/**
+ * dpaa2_dq_flags() - Get the stat field of dequeue response
+ * @dq: the dequeue result.
+ */
+static inline u32 dpaa2_dq_flags(const struct dpaa2_dq *dq)
+{
+	return dq->dq.stat;
+}
+
+/**
+ * dpaa2_dq_is_pull() - Check whether the dq response is from a pull
+ *                      command.
+ * @dq: the dequeue result
+ *
+ * Return 1 for volatile(pull) dequeue, 0 for static dequeue.
+ */
+static inline int dpaa2_dq_is_pull(const struct dpaa2_dq *dq)
+{
+	return (int)(dpaa2_dq_flags(dq) & DPAA2_DQ_STAT_VOLATILE);
+}
+
+/**
+ * dpaa2_dq_is_pull_complete() - Check whether the pull command is completed.
+ * @dq: the dequeue result
+ *
+ * Return boolean.
+ */
+static inline int dpaa2_dq_is_pull_complete(
+					const struct dpaa2_dq *dq)
+{
+	return (int)(dpaa2_dq_flags(dq) & DPAA2_DQ_STAT_EXPIRED);
+}
+
+/**
+ * dpaa2_dq_seqnum() - Get the seqnum field in dequeue response
+ * @dq: the dequeue result
+ *
+ * seqnum is valid only if VALIDFRAME flag is TRUE
+ *
+ * Return seqnum.
+ */
+static inline u16 dpaa2_dq_seqnum(const struct dpaa2_dq *dq)
+{
+	return le16_to_cpu(dq->dq.seqnum);
+}
+
+/**
+ * dpaa2_dq_odpid() - Get the odpid field in dequeue response
+ * @dq: the dequeue result
+ *
+ * odpid is valid only if ODPVAILD flag is TRUE.
+ *
+ * Return odpid.
+ */
+static inline u16 dpaa2_dq_odpid(const struct dpaa2_dq *dq)
+{
+	return le16_to_cpu(dq->dq.oprid);
+}
+
+/**
+ * dpaa2_dq_fqid() - Get the fqid in dequeue response
+ * @dq: the dequeue result
+ *
+ * Return fqid.
+ */
+static inline u32 dpaa2_dq_fqid(const struct dpaa2_dq *dq)
+{
+	return le32_to_cpu(dq->dq.fqid) & DQ_FQID_MASK;
+}
+
+/**
+ * dpaa2_dq_byte_count() - Get the byte count in dequeue response
+ * @dq: the dequeue result
+ *
+ * Return the byte count remaining in the FQ.
+ */
+static inline u32 dpaa2_dq_byte_count(const struct dpaa2_dq *dq)
+{
+	return le32_to_cpu(dq->dq.fq_byte_cnt);
+}
+
+/**
+ * dpaa2_dq_frame_count() - Get the frame count in dequeue response
+ * @dq: the dequeue result
+ *
+ * Return the frame count remaining in the FQ.
+ */
+static inline u32 dpaa2_dq_frame_count(const struct dpaa2_dq *dq)
+{
+	return le32_to_cpu(dq->dq.fq_frm_cnt) & DQ_FRAME_COUNT_MASK;
+}
+
+/**
+ * dpaa2_dq_fd_ctx() - Get the frame queue context in dequeue response
+ * @dq: the dequeue result
+ *
+ * Return the frame queue context.
+ */
+static inline u64 dpaa2_dq_fqd_ctx(const struct dpaa2_dq *dq)
+{
+	return le64_to_cpu(dq->dq.fqd_ctx);
+}
+
+/**
+ * dpaa2_dq_fd() - Get the frame descriptor in dequeue response
+ * @dq: the dequeue result
+ *
+ * Return the frame descriptor.
+ */
+static inline const struct dpaa2_fd *dpaa2_dq_fd(const struct dpaa2_dq *dq)
+{
+	return (const struct dpaa2_fd *)&dq->dq.fd[0];
+}
+
+#endif /* __FSL_DPAA2_GLOBAL_H */
Signature · 1 line
1.9.0
#23 lore raw

PATCH 8/9 bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

In reply to Stuart Yoder

From: Roy Pledge <[email protected]>

The DPIO driver registers with the fsl-mc bus to handle bus-related events for DPIO objects. Key responsibility is mapping I/O regions, setting up interrupt handlers, and calling the DPIO service initialization during probe.

---
 drivers/bus/fsl-mc/dpio/Makefile      |   2 +-
 drivers/bus/fsl-mc/dpio/dpio-driver.c | 289 ++++++++++++++++++++++++++++++++++
 2 files changed, 290 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-driver.c
drivers/bus/fsl-mc/dpio/Makefile +1 -1
index 0778da7..837d330 100644
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o dpio-driver.o
drivers/bus/fsl-mc/dpio/dpio-driver.c new file +289 -0

289 lines not on this page · raw message

Signature · 1 line
1.9.0
#28 lore raw
In reply to Stuart Yoder

Hi Stuart,

Quoted 4 lines · Stuart Yoder

This patch series: A) addresses the final item in the staging TODO list for the fsl-mc bus driver-- adding a functional driver on top of the bus driver, and B) requests that the fsl-mc bus driver be moved out of staging.

Awesome, it's great to see progress again! :)

Quoted 6 lines

The proposed destination for the bus driver is drivers/bus. Proposed location for global header files for fsl-mc and dpaa2 is include/linux/fsl.

The functional driver added is for the DPIO object which provides queuing services for other DPAA2 drivers. An overview of the

I thought the idea of the TODO item was to have a full-fledged user of the bus, like a full network driver. The TODO item reads:

Review

Quoted 4 lines
(quoted diff) +0 -4
-* Add at least one device driver for a DPAA2 object (child device of the
-  fsl-mc bus).  Most likely candidate for this is adding DPAA2 Ethernet
-  driver support, which depends on drivers for several objects: DPNI,
-  DPIO, DPMAC.  Other pre-requisites include:

which to me indicates that DPIO is only part of that goal. Of course I'm the last person blocking progress to move the driver out of staging. But are we at the right point yet?

To me the topmost important bit of having this outside of staging is actually missing in the TODO list (probably since it's obvious): Have stable, reliable, responsible maintainership for the code.

So far I've seen German do the initial push upstream, then there was silence for a while. Now some time passed and you push a few bits here and there again. All of the efforts are great and very appreciated, but I'm missing the "maintainer" figure. Some peer to German and you who oversees the whole thing, reviews your patches and devotes at least 2-3 days a week to only upstream fsl-mc work. Someone like York for U-Boot or Scott for general Linux work.

Without that, there's too much of a chance that the code will stay incomplete, bitrot, etc. And that'd be bad for everyone involved. I think the concept behind fsl-mc is great and exactly what people need, so we should make sure it succeeds.

Alex

#29 lore raw
Quoted 24 lines

-----Original Message-----
From: Alexander Graf [mailto:[email protected]]
Sent: Monday, October 24, 2016 9:34 AM
To: Stuart Yoder <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>
Subject: Re: [PATCH 0/9] staging: fsl-mc: move bus driver out of staging, add dpio

Hi Stuart,

Quoted 4 lines · Stuart Yoder

This patch series: A) addresses the final item in the staging TODO list for the fsl-mc bus driver-- adding a functional driver on top of the bus driver, and B) requests that the fsl-mc bus driver be moved out of staging.

Awesome, it's great to see progress again! :)

Quoted 4 lines

The proposed destination for the bus driver is drivers/bus. Proposed location for global header files for fsl-mc and dpaa2 is include/linux/fsl.

Quoted 10 lines
Quoted 2 lines

The functional driver added is for the DPIO object which provides queuing services for other DPAA2 drivers. An overview of the

I thought the idea of the TODO item was to have a full-fledged user of the bus, like a full network driver. The TODO item reads:

Quoted 4 lines
(quoted diff) +0 -4
-* Add at least one device driver for a DPAA2 object (child device of the
-  fsl-mc bus).  Most likely candidate for this is adding DPAA2 Ethernet
-  driver support, which depends on drivers for several objects: DPNI,
-  DPIO, DPMAC.  Other pre-requisites include:

DPIO is a "full fleged user" of the bus. But, yes, it does provide infrastructure services and so does not have a standalone I/O function.

Quoted 3 lines

which to me indicates that DPIO is only part of that goal. Of course I'm the last person blocking progress to move the driver out of staging. But are we at the right point yet?

I thought the goal was to demonstrate a driver on top of the fsl-mc bus driver because without that it would have been difficult to validate/review that the bus infrastructure was correct.

The DPIO driver demonstrates full use of the bus driver infrastructure-- getting probed, discovering and mapping mmio regions, initializing the device, initializing interrupts.

Quoted 12 lines

To me the topmost important bit of having this outside of staging is actually missing in the TODO list (probably since it's obvious): Have stable, reliable, responsible maintainership for the code.

So far I've seen German do the initial push upstream, then there was silence for a while. Now some time passed and you push a few bits here and there again. All of the efforts are great and very appreciated, but I'm missing the "maintainer" figure. Some peer to German and you who oversees the whole thing, reviews your patches and devotes at least 2-3 days a week to only upstream fsl-mc work. Someone like York for U-Boot or Scott for general Linux work.

Quoted 4 lines

Without that, there's too much of a chance that the code will stay incomplete, bitrot, etc. And that'd be bad for everyone involved. I think the concept behind fsl-mc is great and exactly what people need, so we should make sure it succeeds.

I agree we need that. We are actively working on getting an additional maintainer (or two), and until we can get the right person(s) I'm willing to fill that role. We're not going to let this code bitrot.

I actually think getting the bus driver out of staging will help spur broader involvment by NXP engineers in the fsl-mc bus support. There are enhancements like a resource management interface for user space, an interface to see the MC log buffer, SMMU-related hooks for the fsl-mc bus, and vfio for the fsl-mc bus. All that stuff is on hold until we get the bus driver out of staging. The directive we have is to add no new features until the bus driver is out.

For example, the ARM SMMU driver has an include of <linux/pci.h>, but I don't see the SMMU maintainers accepting the following in arm-smmu.c:
#include <../drivers/staging/fsl-mc/include/mc.h>

Given that the fsl-mc bus TODO list is done, there is not a whole lot for a new maintainer to do to the bus driver itself until we get the driver out of staging (aside from reviewing another DPAA2 object driver that would also go into staging).

Once the bus driver + dpio is out staging it also opens up the door for other DPAA2 drivers-- network, crypto, DMA, L2 switch, decompression/compression, and others to be upstreamed. I didn't think we wanted all of those to go into staging, but we were waiting until some 1 driver was accepted first, proving the bus infrastructure is sound. I was hoping DPI could be that proof of concept.

So, in short, I think getting the bus driver and DPIO out of staging will open some parallel development and will also provide more opportunities for some new maintainers to get involved, because there will be more to review and do.

However, if you want things to stay in staging for now, I will resubmit and put DPIO there.

Thanks,
Stuart

#30 lore raw
Quoted 90 lines · Stuart Yoder
Quoted 18 lines

-----Original Message-----
From: Alexander Graf [mailto:[email protected]]
Sent: Monday, October 24, 2016 9:34 AM
To: Stuart Yoder <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>
Subject: Re: [PATCH 0/9] staging: fsl-mc: move bus driver out of staging, add dpio

Hi Stuart,

Quoted 4 lines · Stuart Yoder

This patch series: A) addresses the final item in the staging TODO list for the fsl-mc bus driver-- adding a functional driver on top of the bus driver, and B) requests that the fsl-mc bus driver be moved out of staging.

Awesome, it's great to see progress again! :)

Quoted 13 lines
Quoted 6 lines

The proposed destination for the bus driver is drivers/bus. Proposed location for global header files for fsl-mc and dpaa2 is include/linux/fsl.

The functional driver added is for the DPIO object which provides queuing services for other DPAA2 drivers. An overview of the

I thought the idea of the TODO item was to have a full-fledged user of the bus, like a full network driver. The TODO item reads:

Quoted 4 lines
(quoted diff) +0 -4
-* Add at least one device driver for a DPAA2 object (child device of the
-  fsl-mc bus).  Most likely candidate for this is adding DPAA2 Ethernet
-  driver support, which depends on drivers for several objects: DPNI,
-  DPIO, DPMAC.  Other pre-requisites include:

DPIO is a "full fleged user" of the bus. But, yes, it does provide infrastructure services and so does not have a standalone I/O function.

Quoted 3 lines

which to me indicates that DPIO is only part of that goal. Of course I'm the last person blocking progress to move the driver out of staging. But are we at the right point yet?

I thought the goal was to demonstrate a driver on top of the fsl-mc bus driver because without that it would have been difficult to validate/review that the bus infrastructure was correct.

The DPIO driver demonstrates full use of the bus driver infrastructure-- getting probed, discovering and mapping mmio regions, initializing the device, initializing interrupts.

Quoted 12 lines

To me the topmost important bit of having this outside of staging is actually missing in the TODO list (probably since it's obvious): Have stable, reliable, responsible maintainership for the code.

So far I've seen German do the initial push upstream, then there was silence for a while. Now some time passed and you push a few bits here and there again. All of the efforts are great and very appreciated, but I'm missing the "maintainer" figure. Some peer to German and you who oversees the whole thing, reviews your patches and devotes at least 2-3 days a week to only upstream fsl-mc work. Someone like York for U-Boot or Scott for general Linux work.

Quoted 4 lines

Without that, there's too much of a chance that the code will stay incomplete, bitrot, etc. And that'd be bad for everyone involved. I think the concept behind fsl-mc is great and exactly what people need, so we should make sure it succeeds.

I agree we need that. We are actively working on getting an additional maintainer (or two), and until we can get the right person(s) I'm willing to fill that role. We're not going to let this code bitrot.

I actually think getting the bus driver out of staging will help spur broader involvment by NXP engineers in the fsl-mc bus support. There are enhancements like a resource management interface for user space, an interface to see the MC log buffer, SMMU-related hooks for the fsl-mc bus, and vfio for the fsl-mc bus. All that stuff is on hold until we get the bus driver out of staging. The directive we have is to add no new features until the bus driver is out.

For example, the ARM SMMU driver has an include of <linux/pci.h>, but I don't see the SMMU maintainers accepting the following in arm-smmu.c:

    #include <../drivers/staging/fsl-mc/include/mc.h>

Given that the fsl-mc bus TODO list is done, there is not a whole lot for a new maintainer to do to the bus driver itself until we get the driver out of staging (aside from reviewing another DPAA2 object driver that would also go into staging).

Once the bus driver + dpio is out staging it also opens up the door for other DPAA2 drivers-- network, crypto, DMA, L2 switch, decompression/compression, and others to be upstreamed. I didn't think we wanted all of those to go into staging, but we were waiting until some 1 driver was accepted first, proving the bus infrastructure is sound. I was hoping DPI could be that proof of concept.

Quoted 7 lines

So, in short, I think getting the bus driver and DPIO out of staging will open some parallel development and will also provide more opportunities for some new maintainers to get involved, because there will be more to review and do.

However, if you want things to stay in staging for now, I will resubmit and put DPIO there.

As long as Greg is ok with your approach, I'm fine moving it out of staging too of course. And consider me eager to see the other drivers pop up :).

Alex

#4 lore raw

RE: [PATCH 3/9] bus: fsl-mc: dpio: add APIs for DPIO objects

In reply to Stuart Yoder
Quoted 304 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 5:02 PM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Ruxandra Ioana Radulescu <[email protected]>; Roy Pledge <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 3/9] bus: fsl-mc: dpio: add APIs for DPIO objects

From: Ioana Radulescu <[email protected]>

Add the command build/parse APIs for operating on DPIO objects through the DPAA2 Management Complex.

---
 drivers/bus/fsl-mc/Kconfig         |  10 ++
 drivers/bus/fsl-mc/Makefile        |   3 +
 drivers/bus/fsl-mc/dpio/Makefile   |   9 ++
 drivers/bus/fsl-mc/dpio/dpio-cmd.h | 198
++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/dpio.c     | 229
+++++++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/dpio.h     | 108 +++++++++++++++++
 6 files changed, 557 insertions(+)
 create mode 100644 drivers/bus/fsl-mc/dpio/Makefile
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-cmd.h
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.c
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.h
drivers/bus/fsl-mc/Kconfig +10 -0
index 5c009ab..a10aaf0 100644
@@ -15,3 +15,13 @@ config FSL_MC_BUS
 	  architecture.  The fsl-mc bus driver handles discovery of
 	  DPAA2 objects (which are represented as Linux devices) and
 	  binding objects to drivers.
+
+config FSL_MC_DPIO
+        tristate "QorIQ DPAA2 DPIO driver"
+        depends on FSL_MC_BUS
+        help
+	  Driver for the DPAA2 DPIO object.  A DPIO provides queue and
+	  buffer management facilities for software to interact with
+	  other DPAA2 objects. This driver does not expose the DPIO
+	  objects individually, but groups them under a service layer
+	  API.
drivers/bus/fsl-mc/Makefile +3 -0
index d56afee..d18df72 100644
@@ -17,3 +17,6 @@ mc-bus-driver-objs := fsl-mc-bus.o \
 		      fsl-mc-msi.o \
 		      dpmcp.o \
 		      dpbp.o
+
+# MC DPIO driver
+obj-$(CONFIG_FSL_MC_DPIO) += dpio/
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
new file mode 100644
index 0000000..128befc

drivers/bus/fsl-mc/dpio/Makefile new file +9 -0
@@ -0,0 +1,9 @@
+#
+# QorIQ DPAA2 DPIO driver
+#
+
+subdir-ccflags-y := -Werror
+
+obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
+
+fsl-mc-dpio-objs := dpio.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/dpio-cmd.h +0 -0

mc/dpio/dpio-cmd.h
new file mode 100644
index 0000000..b25a4cc

drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +5 -0
@@ -0,0 +1,198 @@
+/*
+ * Copyright 2013-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are

met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of the above-listed copyright holders nor the
+ * names of any contributors may be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */

drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +13 -0
+#ifndef _FSL_DPIO_CMD_H
+#define _FSL_DPIO_CMD_H
+
+/* DPIO Version */
+#define DPIO_VER_MAJOR			4
+#define DPIO_VER_MINOR			2
+
+/* Command Versioning */
+
+#define DPIO_CMD_ID_OFFSET		4
+#define DPIO_CMD_BASE_VERSION		1
+
+#define DPIO_CMD(id)	((id << DPIO_CMD_ID_OFFSET) |

DPIO_CMD_BASE_VERSION)

drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +4 -0
+
+/* Command IDs */
+#define DPIO_CMDID_CLOSE				DPIO_CMD(0x800)
+#define DPIO_CMDID_OPEN
	DPIO_CMD(0x803)
+#define DPIO_CMDID_CREATE
	DPIO_CMD(0x903)
+#define DPIO_CMDID_DESTROY
	DPIO_CMD(0x983)
+#define DPIO_CMDID_GET_API_VERSION
	DPIO_CMD(0xa03)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+
+#define DPIO_CMDID_ENABLE
	DPIO_CMD(0x002)
+#define DPIO_CMDID_DISABLE
	DPIO_CMD(0x003)
+#define DPIO_CMDID_GET_ATTR
	DPIO_CMD(0x004)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+#define DPIO_CMDID_RESET				DPIO_CMD(0x005)
+#define DPIO_CMDID_IS_ENABLED
	DPIO_CMD(0x006)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+
+#define DPIO_CMDID_SET_IRQ
	DPIO_CMD(0x010)
+#define DPIO_CMDID_GET_IRQ
	DPIO_CMD(0x011)
+#define DPIO_CMDID_SET_IRQ_ENABLE
	DPIO_CMD(0x012)
+#define DPIO_CMDID_GET_IRQ_ENABLE
	DPIO_CMD(0x013)
+#define DPIO_CMDID_SET_IRQ_MASK
	DPIO_CMD(0x014)
+#define DPIO_CMDID_GET_IRQ_MASK
	DPIO_CMD(0x015)
+#define DPIO_CMDID_GET_IRQ_STATUS
	DPIO_CMD(0x016)
+#define DPIO_CMDID_CLEAR_IRQ_STATUS
	DPIO_CMD(0x017)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+
+#define DPIO_CMDID_SET_STASHING_DEST
	DPIO_CMD(0x120)
+#define DPIO_CMDID_GET_STASHING_DEST
	DPIO_CMD(0x121)
+#define DPIO_CMDID_ADD_STATIC_DEQUEUE_CHANNEL
	DPIO_CMD(0x122)
+#define DPIO_CMDID_REMOVE_STATIC_DEQUEUE_CHANNEL
	DPIO_CMD(0x123)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +115 -0
+
+struct dpio_cmd_open {
+	__le32 dpio_id;
+};
+
+#define DPIO_CHANNEL_MODE_MASK		0x3
+
+struct dpio_cmd_create {
+	__le16 pad0;
+	u8 channel_mode;
+	u8 pad1;
+	u8 num_priorities;
+
+};
+
+#define DPIO_ENABLE			1
+
+struct dpio_rsp_is_enabled {
+	u8 enabled;
+};
+
+struct dpio_cmd_set_irq {
+	/* cmd word 0 */
+	u8 irq_index;
+	u8 pad[3];
+	__le32 irq_val;
+	/* cmd word 1 */
+	__le64 irq_addr;
+	/* cmd word 2 */
+	__le32 irq_num;
+};
+
+struct dpio_cmd_get_irq {
+	__le32 pad;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq {
+	/* response word 0 */
+	__le32 irq_val;
+	__le32 pad;
+	/* response word 1 */
+	__le64 irq_addr;
+	/* response word 2 */
+	__le32 irq_num;
+	__le32 type;
+};
+
+struct dpio_cmd_set_irq_enable {
+	u8 enable;
+	u8 pad[3];
+	u8 irq_index;
+};
+
+struct dpio_cmd_get_irq_enable {
+	__le32 pad;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq_enable {
+	u8 enabled;
+};
+
+struct dpio_cmd_set_irq_mask {
+	__le32 mask;
+	u8 irq_index;
+};
+
+struct dpio_cmd_get_irq_mask {
+	__le32 pad;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq_mask {
+	__le32 mask;
+};
+
+struct dpio_cmd_get_irq_status {
+	__le32 status;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq_status {
+	__le32 status;
+};
+
+struct dpio_cmd_clear_irq_status {
+	__le32 status;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_attr {
+	/* cmd word 0 */
+	__le32 id;
+	__le16 qbman_portal_id;
+	u8 num_priorities;
+	u8 channel_mode;
+	/* cmd word 1 */
+	__le64 qbman_portal_ce_addr;
+	/* cmd word 2 */
+	__le64 qbman_portal_ci_addr;
+	/* cmd word 3 */
+	__le32 pad;
+	__le32 qbman_version;
+};
+
+struct dpio_cmd_set_stashing_dest {
+	u8 sdest;
+};
+
+struct dpio_rsp_get_stashing_dest {
+	u8 sdest;
+};
+
+struct dpio_cmd_add_static_dequeue_channel {

drivers/bus/fsl-mc/dpio/dpio-cmd.h line 196

Quoted 10 lines
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +10 -0
+	__le32 dpcon_id;
+};
+
+struct dpio_rsp_add_static_dequeue_channel {
+	u8 channel_index;
+};
+
+struct dpio_cmd_remove_static_dequeue_channel {
+	__le32 dpcon_id;
+};

Hi Stuart, looks like you removed unused API functions from dpio.h and dpio.c, but not the structures and CMDID defines associated with them, which are now dead code.

Thanks,
Ioana

#8 lore raw

RE: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

In reply to a message not in the archive
Quoted 283 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

From: Roy Pledge <[email protected]>

Add global definitions for DPAA2 frame descriptors and scatter gather entries.

---
 include/linux/fsl/dpaa2-fd.h | 415
+++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 415 insertions(+)
 create mode 100644 include/linux/fsl/dpaa2-fd.h
include/linux/fsl/dpaa2-fd.h new file +5 -0
new file mode 100644
index 0000000..b3fa9ff
@@ -0,0 +1,415 @@
+/*
+ * Copyright 2014-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are

met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of Freescale Semiconductor nor the
+ * names of its contributors may be used to endorse or promote
products
+ * derived from this software without specific prior written permission.
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */

include/linux/fsl/dpaa2-fd.h new file +10 -0
+#ifndef __FSL_DPAA2_FD_H
+#define __FSL_DPAA2_FD_H
+
+#include <linux/kernel.h>
+
+/**
+ * DOC: DPAA2 FD - Frame Descriptor APIs for DPAA2
+ *
+ * Frame Descriptors (FDs) are used to describe frame data in the DPAA2.
+ * Frames can be enqueued and dequeued to Frame Queues (FQs) which

are consumed
+ * by the various DPAA accelerators (WRIOP, SEC, PME, DCE)
+ *
+ * There are three types of frames: single, scatter gather, and frame lists.
+ *
+ * The set of APIs in this file must be used to create, manipulate and
+ * query Frame Descriptors.
+ */

include/linux/fsl/dpaa2-fd.h new file +66 -0
+
+/**
+ * struct dpaa2_fd - Struct describing FDs
+ * @words:         for easier/faster copying the whole FD structure
+ * @addr:          address in the FD
+ * @len:           length in the FD
+ * @bpid:          buffer pool ID
+ * @format_offset: format and offset fields
+ * @frc:           frame context
+ * @ctrl:          control bits...including dd, sc, va, err, etc
+ * @flc:           flow context address
+ *
+ * This structure represents the basic Frame Descriptor used in the system.
+ */
+struct dpaa2_fd {
+	union {
+		u32 words[8];
+		struct dpaa2_fd_simple {
+			__le64 addr;
+			__le32 len;
+			__le16 bpid;
+			__le16 format_offset;
+			__le32 frc;
+			__le32 ctrl;
+			__le64 flc;
+		} simple;
+	};
+};
+
+#define FD_OFFSET_MASK 0x0FFF
+#define FD_FORMAT_MASK 0x3
+#define FD_FORMAT_SHIFT 12
+#define SG_SHORT_LEN_FLAG_MASK 0x1
+#define SG_SHORT_LEN_FLAG_SHIFT 14
+#define SG_SHORT_LEN_MASK 0x1FFFF
+#define SG_OFFSET_MASK 0x0FFF
+#define SG_FORMAT_MASK 0x3
+#define SG_FORMAT_SHIFT 12
+#define SG_BPID_MASK 0x3FFF
+#define SG_FINAL_FLAG_MASK 0x1
+#define SG_FINAL_FLAG_SHIFT 15
+
+enum dpaa2_fd_format {
+	dpaa2_fd_single = 0,
+	dpaa2_fd_list,
+	dpaa2_fd_sg
+};
+
+/**
+ * dpaa2_fd_get_addr() - get the addr field of frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the address in the frame descriptor.
+ */
+static inline dma_addr_t dpaa2_fd_get_addr(const struct dpaa2_fd *fd)
+{
+
+	return (dma_addr_t)fd->simple.addr;
+}
+
+/**
+ * dpaa2_fd_set_addr() - Set the addr field of frame descriptor
+ * @fd: the given frame descriptor
+ * @addr: the address needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_addr(struct dpaa2_fd *fd, dma_addr_t

addr)

include/linux/fsl/dpaa2-fd.h new file +42 -0
+{
+	fd->simple.addr = addr;
+}
+
+/**
+ * dpaa2_fd_get_frc() - Get the frame context in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the frame context field in the frame descriptor.
+ */
+static inline u32 dpaa2_fd_get_frc(const struct dpaa2_fd *fd)
+{
+	return fd->simple.frc;
+}
+
+/**
+ * dpaa2_fd_set_frc() - Set the frame context in the frame descriptor
+ * @fd: the given frame descriptor
+ * @frc: the frame context needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_frc(struct dpaa2_fd *fd, u32 frc)
+{
+	fd->simple.frc = frc;
+}
+
+/**
+ * dpaa2_fd_get_flc() - Get the flow context in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the flow context in the frame descriptor.
+ */
+static inline dma_addr_t dpaa2_fd_get_flc(const struct dpaa2_fd *fd)
+{
+	return (dma_addr_t)fd->simple.flc;
+}
+
+/**
+ * dpaa2_fd_set_flc() - Set the flow context field of frame descriptor
+ * @fd: the given frame descriptor
+ * @flc_addr: the flow context needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_flc(struct dpaa2_fd *fd,  dma_addr_t

flc_addr)

include/linux/fsl/dpaa2-fd.h new file +58 -0
+{
+	fd->simple.flc = flc_addr;
+}
+
+/**
+ * dpaa2_fd_get_len() - Get the length in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the length field in the frame descriptor.
+ */
+static inline u32 dpaa2_fd_get_len(const struct dpaa2_fd *fd)
+{
+	return fd->simple.len;
+}
+
+/**
+ * dpaa2_fd_set_len() - Set the length field of frame descriptor
+ * @fd: the given frame descriptor
+ * @len: the length needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_len(struct dpaa2_fd *fd, u32 len)
+{
+	fd->simple.len = len;
+}
+
+/**
+ * dpaa2_fd_get_offset() - Get the offset field in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the offset.
+ */
+static inline uint16_t dpaa2_fd_get_offset(const struct dpaa2_fd *fd)
+{
+	return fd->simple.format_offset & FD_OFFSET_MASK;
+}
+
+/**
+ * dpaa2_fd_set_offset() - Set the offset field of frame descriptor
+ * @fd: the given frame descriptor
+ * @offset: the offset needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_offset(struct dpaa2_fd *fd, uint16_t offset)
+{
+	fd->simple.format_offset &= ~(FD_OFFSET_MASK);
+	fd->simple.format_offset |= offset;
+}
+
+/**
+ * dpaa2_fd_get_format() - Get the format field in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the format.
+ */
+static inline enum dpaa2_fd_format dpaa2_fd_get_format(
+						const struct dpaa2_fd *fd)
+{
+	return (enum dpaa2_fd_format)((fd->simple.format_offset
+				      >> FD_FORMAT_SHIFT) &

FD_FORMAT_MASK);

include/linux/fsl/dpaa2-fd.h new file +11 -0
+}
+
+/**
+ * dpaa2_fd_set_format() - Set the format field of frame descriptor
+ * @fd: the given frame descriptor
+ * @format: the format needs to be set in frame descriptor
+ */
+static inline void dpaa2_fd_set_format(struct dpaa2_fd *fd,
+				       enum dpaa2_fd_format format)
+{
+	fd->simple.format_offset &= ~(FD_FORMAT_MASK <<

FD_FORMAT_SHIFT);

include/linux/fsl/dpaa2-fd.h new file +13 -0
+	fd->simple.format_offset |= format << FD_FORMAT_SHIFT;
+}
+
+/**
+ * dpaa2_fd_get_bpid() - Get the bpid field in the frame descriptor
+ * @fd: the given frame descriptor
+ *
+ * Return the buffer pool id.
+ */
+static inline uint16_t dpaa2_fd_get_bpid(const struct dpaa2_fd *fd)
+{
+	return fd->simple.bpid;
+}

include/linux/fsl/dpaa2-fd.h line 247

Quoted 10 lines
include/linux/fsl/dpaa2-fd.h new file +10 -0
+
+/**
+ * dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor
+ * @fd: the given frame descriptor
+ * @bpid: buffer pool id to be set
+ */
+static inline void dpaa2_fd_set_bpid(struct dpaa2_fd *fd, uint16_t bpid)
+{
+	fd->simple.bpid = bpid;
+}

The setter/getter functions for fd.ctrl are missing.

include/linux/fsl/dpaa2-fd.h line 254

Quoted 7 lines
include/linux/fsl/dpaa2-fd.h new file +7 -0
+
+/**
+ * struct dpaa2_sg_entry - the scatter-gathering structure
+ * @addr: address of the sg entry
+ * @len: length in this sg entry
+ * @bpid: buffer pool id
+ * @format_offset: offset in the MS 16 bits, BPID in the LS 16 bits

Description of the format_offset field is incorrect, it shouldn't contain the reference to BPID.

Quoted 49 lines

+ */

include/linux/fsl/dpaa2-fd.h new file +22 -0
+struct dpaa2_sg_entry {
+	__le64 addr;
+	__le32 len;
+	__le16 bpid;
+	__le16 format_offset;
+};
+
+enum dpaa2_sg_format {
+	dpaa2_sg_single = 0,
+	dpaa2_sg_frame_data,
+	dpaa2_sg_sgt_ext
+};
+
+/* Accessors for SG entry fields */
+
+/**
+ * dpaa2_sg_get_addr() - Get the address from SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the address.
+ */
+static inline dma_addr_t dpaa2_sg_get_addr(const struct dpaa2_sg_entry

*sg)

include/linux/fsl/dpaa2-fd.h new file +10 -0
+{
+	return le64_to_cpu((dma_addr_t)sg->addr);
+}
+
+/**
+ * dpaa2_sg_set_addr() - Set the address in SG entry
+ * @sg: the given scatter-gathering object
+ * @addr: the address to be set
+ */
+static inline void dpaa2_sg_set_addr(struct dpaa2_sg_entry *sg,

dma_addr_t addr)

include/linux/fsl/dpaa2-fd.h new file +7 -0
+{
+	sg->addr = cpu_to_le64(addr);
+}
+
+static inline bool dpaa2_sg_short_len(const struct dpaa2_sg_entry *sg)
+{
+	return (le16_to_cpu(sg->format_offset) >>

SG_SHORT_LEN_FLAG_SHIFT)

include/linux/fsl/dpaa2-fd.h new file +6 -0
+		& SG_SHORT_LEN_FLAG_MASK;
+}
+
+/**
+ * dpaa2_sg_get_len() - Get the length in SG entry
+ * @sg: the given scatter-gathering object

include/linux/fsl/dpaa2-fd.h line 310

Quoted 10 lines
include/linux/fsl/dpaa2-fd.h new file +10 -0
+ *
+ * Return the length.
+ */
+static inline u32 dpaa2_sg_get_len(const struct dpaa2_sg_entry *sg)
+{
+	if (dpaa2_sg_short_len(sg))
+		return le32_to_cpu(sg->len) & SG_SHORT_LEN_MASK;
+
+	return le32_to_cpu(sg->len);
+}

We should do this in dpaa2_fd_get_len() as well. Hardware is capable of generating FDs with SL bit set for single frame format too, although in practice I've never actually seen it.

Thanks,
Ioana

#5 lore raw

RE: [PATCH 3/9] bus: fsl-mc: dpio: add APIs for DPIO objects

In reply to Ruxandra Ioana Radulescu
Quoted 321 lines

-----Original Message-----
From: Ruxandra Ioana Radulescu
Sent: Wednesday, November 02, 2016 9:50 AM
To: Stuart Yoder <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Stuart Yoder <[email protected]>
Subject: RE: [PATCH 3/9] bus: fsl-mc: dpio: add APIs for DPIO objects

Quoted 310 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 5:02 PM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Ruxandra Ioana Radulescu <[email protected]>; Roy Pledge <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 3/9] bus: fsl-mc: dpio: add APIs for DPIO objects

From: Ioana Radulescu <[email protected]>

Add the command build/parse APIs for operating on DPIO objects through the DPAA2 Management Complex.

---
 drivers/bus/fsl-mc/Kconfig         |  10 ++
 drivers/bus/fsl-mc/Makefile        |   3 +
 drivers/bus/fsl-mc/dpio/Makefile   |   9 ++
 drivers/bus/fsl-mc/dpio/dpio-cmd.h | 198
++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/dpio.c     | 229
+++++++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/dpio.h     | 108 +++++++++++++++++
 6 files changed, 557 insertions(+)
 create mode 100644 drivers/bus/fsl-mc/dpio/Makefile
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-cmd.h
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.c
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio.h
drivers/bus/fsl-mc/Kconfig +10 -0
index 5c009ab..a10aaf0 100644
@@ -15,3 +15,13 @@ config FSL_MC_BUS
 	  architecture.  The fsl-mc bus driver handles discovery of
 	  DPAA2 objects (which are represented as Linux devices) and
 	  binding objects to drivers.
+
+config FSL_MC_DPIO
+        tristate "QorIQ DPAA2 DPIO driver"
+        depends on FSL_MC_BUS
+        help
+	  Driver for the DPAA2 DPIO object.  A DPIO provides queue and
+	  buffer management facilities for software to interact with
+	  other DPAA2 objects. This driver does not expose the DPIO
+	  objects individually, but groups them under a service layer
+	  API.
drivers/bus/fsl-mc/Makefile +3 -0
index d56afee..d18df72 100644
@@ -17,3 +17,6 @@ mc-bus-driver-objs := fsl-mc-bus.o \
 		      fsl-mc-msi.o \
 		      dpmcp.o \
 		      dpbp.o
+
+# MC DPIO driver
+obj-$(CONFIG_FSL_MC_DPIO) += dpio/
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
new file mode 100644
index 0000000..128befc

drivers/bus/fsl-mc/dpio/Makefile new file +9 -0
@@ -0,0 +1,9 @@
+#
+# QorIQ DPAA2 DPIO driver
+#
+
+subdir-ccflags-y := -Werror
+
+obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
+
+fsl-mc-dpio-objs := dpio.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/dpio-cmd.h +0 -0

mc/dpio/dpio-cmd.h
new file mode 100644
index 0000000..b25a4cc

drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +5 -0
@@ -0,0 +1,198 @@
+/*
+ * Copyright 2013-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are

met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of the above-listed copyright holders nor the
+ * names of any contributors may be used to endorse or promote products
+ * derived from this software without specific prior written permission.
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */

drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +13 -0
+#ifndef _FSL_DPIO_CMD_H
+#define _FSL_DPIO_CMD_H
+
+/* DPIO Version */
+#define DPIO_VER_MAJOR			4
+#define DPIO_VER_MINOR			2
+
+/* Command Versioning */
+
+#define DPIO_CMD_ID_OFFSET		4
+#define DPIO_CMD_BASE_VERSION		1
+
+#define DPIO_CMD(id)	((id << DPIO_CMD_ID_OFFSET) |

DPIO_CMD_BASE_VERSION)

drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +4 -0
+
+/* Command IDs */
+#define DPIO_CMDID_CLOSE				DPIO_CMD(0x800)
+#define DPIO_CMDID_OPEN
	DPIO_CMD(0x803)
+#define DPIO_CMDID_CREATE
	DPIO_CMD(0x903)
+#define DPIO_CMDID_DESTROY
	DPIO_CMD(0x983)
+#define DPIO_CMDID_GET_API_VERSION
	DPIO_CMD(0xa03)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+
+#define DPIO_CMDID_ENABLE
	DPIO_CMD(0x002)
+#define DPIO_CMDID_DISABLE
	DPIO_CMD(0x003)
+#define DPIO_CMDID_GET_ATTR
	DPIO_CMD(0x004)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+#define DPIO_CMDID_RESET				DPIO_CMD(0x005)
+#define DPIO_CMDID_IS_ENABLED
	DPIO_CMD(0x006)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+
+#define DPIO_CMDID_SET_IRQ
	DPIO_CMD(0x010)
+#define DPIO_CMDID_GET_IRQ
	DPIO_CMD(0x011)
+#define DPIO_CMDID_SET_IRQ_ENABLE
	DPIO_CMD(0x012)
+#define DPIO_CMDID_GET_IRQ_ENABLE
	DPIO_CMD(0x013)
+#define DPIO_CMDID_SET_IRQ_MASK
	DPIO_CMD(0x014)
+#define DPIO_CMDID_GET_IRQ_MASK
	DPIO_CMD(0x015)
+#define DPIO_CMDID_GET_IRQ_STATUS
	DPIO_CMD(0x016)
+#define DPIO_CMDID_CLEAR_IRQ_STATUS
	DPIO_CMD(0x017)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +2 -0
+
+#define DPIO_CMDID_SET_STASHING_DEST
	DPIO_CMD(0x120)
+#define DPIO_CMDID_GET_STASHING_DEST
	DPIO_CMD(0x121)
+#define DPIO_CMDID_ADD_STATIC_DEQUEUE_CHANNEL
	DPIO_CMD(0x122)
+#define DPIO_CMDID_REMOVE_STATIC_DEQUEUE_CHANNEL
	DPIO_CMD(0x123)
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +121 -0
+
+struct dpio_cmd_open {
+	__le32 dpio_id;
+};
+
+#define DPIO_CHANNEL_MODE_MASK		0x3
+
+struct dpio_cmd_create {
+	__le16 pad0;
+	u8 channel_mode;
+	u8 pad1;
+	u8 num_priorities;
+
+};
+
+#define DPIO_ENABLE			1
+
+struct dpio_rsp_is_enabled {
+	u8 enabled;
+};
+
+struct dpio_cmd_set_irq {
+	/* cmd word 0 */
+	u8 irq_index;
+	u8 pad[3];
+	__le32 irq_val;
+	/* cmd word 1 */
+	__le64 irq_addr;
+	/* cmd word 2 */
+	__le32 irq_num;
+};
+
+struct dpio_cmd_get_irq {
+	__le32 pad;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq {
+	/* response word 0 */
+	__le32 irq_val;
+	__le32 pad;
+	/* response word 1 */
+	__le64 irq_addr;
+	/* response word 2 */
+	__le32 irq_num;
+	__le32 type;
+};
+
+struct dpio_cmd_set_irq_enable {
+	u8 enable;
+	u8 pad[3];
+	u8 irq_index;
+};
+
+struct dpio_cmd_get_irq_enable {
+	__le32 pad;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq_enable {
+	u8 enabled;
+};
+
+struct dpio_cmd_set_irq_mask {
+	__le32 mask;
+	u8 irq_index;
+};
+
+struct dpio_cmd_get_irq_mask {
+	__le32 pad;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq_mask {
+	__le32 mask;
+};
+
+struct dpio_cmd_get_irq_status {
+	__le32 status;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_irq_status {
+	__le32 status;
+};
+
+struct dpio_cmd_clear_irq_status {
+	__le32 status;
+	u8 irq_index;
+};
+
+struct dpio_rsp_get_attr {
+	/* cmd word 0 */
+	__le32 id;
+	__le16 qbman_portal_id;
+	u8 num_priorities;
+	u8 channel_mode;
+	/* cmd word 1 */
+	__le64 qbman_portal_ce_addr;
+	/* cmd word 2 */
+	__le64 qbman_portal_ci_addr;
+	/* cmd word 3 */
+	__le32 pad;
+	__le32 qbman_version;
+};
+
+struct dpio_cmd_set_stashing_dest {
+	u8 sdest;
+};
+
+struct dpio_rsp_get_stashing_dest {
+	u8 sdest;
+};
+
+struct dpio_cmd_add_static_dequeue_channel {
+	__le32 dpcon_id;
+};
+
+struct dpio_rsp_add_static_dequeue_channel {
+	u8 channel_index;
+};
Quoted 8 lines

drivers/bus/fsl-mc/dpio/dpio-cmd.h line 196

Quoted 4 lines
drivers/bus/fsl-mc/dpio/dpio-cmd.h new file +4 -0
+
+struct dpio_cmd_remove_static_dequeue_channel {
+	__le32 dpcon_id;
+};

Hi Stuart, looks like you removed unused API functions from dpio.h and dpio.c, but not the structures and CMDID defines associated with them, which are now dead code.

I didn't modify this particular file when I sent it out, but agree that we should clean that up. Will remove unused structs/defines in v2 of this series.

Thanks,
Stuart

#9 lore raw

RE: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

In reply to Ruxandra Ioana Radulescu
Quoted 11 lines

+/**

include/linux/fsl/dpaa2-fd.h line 247

Quoted 8 lines

+ * dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor
+ * @fd: the given frame descriptor
+ * @bpid: buffer pool id to be set
+ */

include/linux/fsl/dpaa2-fd.h new file +4 -0
+static inline void dpaa2_fd_set_bpid(struct dpaa2_fd *fd, uint16_t bpid)
+{
+	fd->simple.bpid = bpid;
+}

The setter/getter functions for fd.ctrl are missing.

Ok, will add those. Does the ethernet driver use that field?

Quoted 10 lines

include/linux/fsl/dpaa2-fd.h line 254

Quoted 7 lines
include/linux/fsl/dpaa2-fd.h new file +7 -0
+
+/**
+ * struct dpaa2_sg_entry - the scatter-gathering structure
+ * @addr: address of the sg entry
+ * @len: length in this sg entry
+ * @bpid: buffer pool id
+ * @format_offset: offset in the MS 16 bits, BPID in the LS 16 bits

Description of the format_offset field is incorrect, it shouldn't contain the reference to BPID.

Thanks, will fix.

Quoted 9 lines
Quoted 9 lines
include/linux/fsl/dpaa2-fd.h new file +9 -0
+/**
+ * dpaa2_sg_get_len() - Get the length in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the length.
+ */
+static inline u32 dpaa2_sg_get_len(const struct dpaa2_sg_entry *sg)
+{
+	if (dpaa2_sg_short_len(sg))
Quoted 8 lines

include/linux/fsl/dpaa2-fd.h line 310

Quoted 4 lines
include/linux/fsl/dpaa2-fd.h new file +4 -0
+		return le32_to_cpu(sg->len) & SG_SHORT_LEN_MASK;
+
+	return le32_to_cpu(sg->len);
+}

We should do this in dpaa2_fd_get_len() as well. Hardware is capable of generating FDs with SL bit set for single frame format too, although in practice I've never actually seen it.

Any suggestion on how to test this case?

Thanks,
Stuart

#21 lore raw

RE: [PATCH 7/9] bus: fsl-mc: dpio: add the DPAA2 DPIO service interface

In reply to a message not in the archive
Quoted 368 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 7/9] bus: fsl-mc: dpio: add the DPAA2 DPIO service interface

From: Roy Pledge <[email protected]>

The DPIO service interface handles initialization of DPIO objects and exports APIs to be used by other DPAA2 object drivers to perform queuing and buffer management related operations. The service allows registration of callbacks when frames or notifications are received.

---
 drivers/bus/fsl-mc/dpio/Makefile       |   2 +-
 drivers/bus/fsl-mc/dpio/dpio-service.c | 614
+++++++++++++++++++++++++++++++++
 include/linux/fsl/dpaa2-io.h           | 138 ++++++++
 3 files changed, 753 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-service.c
 create mode 100644 include/linux/fsl/dpaa2-io.h
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
index 6588498..0778da7 100644

drivers/bus/fsl-mc/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o qbman-portal.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/dpio-service.c +0 -0

mc/dpio/dpio-service.c
new file mode 100644
index 0000000..7a455a7

drivers/bus/fsl-mc/dpio/dpio-service.c new file +5 -0
@@ -0,0 +1,614 @@
+/*
+ * Copyright 2014-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are

met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the
distribution.
+ * * Neither the name of Freescale Semiconductor nor the
+ * names of its contributors may be used to endorse or promote
products
+ * derived from this software without specific prior written permission.
+ *
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */

drivers/bus/fsl-mc/dpio/dpio-service.c new file +78 -0
+#include <linux/types.h>
+#include <linux/fsl/mc.h>
+#include <linux/fsl/dpaa2-io.h>
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/interrupt.h>
+#include <linux/dma-mapping.h>
+#include <linux/slab.h>
+
+#include "dpio.h"
+#include "qbman-portal.h"
+
+struct dpaa2_io {
+	atomic_t refs;
+	struct dpaa2_io_desc dpio_desc;
+	struct qbman_swp_desc swp_desc;
+	struct qbman_swp *swp;
+	struct list_head node;
+	spinlock_t lock_mgmt_cmd;
+	spinlock_t lock_notifications;
+	struct list_head notifications;
+};
+
+struct dpaa2_io_store {
+	unsigned int max;
+	dma_addr_t paddr;
+	struct dpaa2_dq *vaddr;
+	void *alloced_addr;    /* unaligned value from kmalloc() */
+	unsigned int idx;      /* position of the next-to-be-returned entry */
+	struct qbman_swp *swp; /* portal used to issue VDQCR */
+	struct device *dev;    /* device used for DMA mapping */
+};
+
+/* keep a per cpu array of DPIOs for fast access */
+static struct dpaa2_io *dpio_by_cpu[NR_CPUS];
+static struct list_head dpio_list = LIST_HEAD_INIT(dpio_list);
+static DEFINE_SPINLOCK(dpio_list_lock);
+
+static inline struct dpaa2_io *service_select_by_cpu(struct dpaa2_io *d,
+						     int cpu)
+{
+	if (d)
+		return d;
+
+	if (unlikely(cpu >= NR_CPUS))
+		return NULL;
+
+	/*
+	 * If cpu == -1, choose the current cpu, with no guarantees about
+	 * potentially being migrated away.
+	 */
+	if (unlikely(cpu < 0))
+		cpu = smp_processor_id();
+
+	/* If a specific cpu was requested, pick it up immediately */
+	return dpio_by_cpu[cpu];
+}
+
+static inline struct dpaa2_io *service_select(struct dpaa2_io *d)
+{
+	if (d)
+		return d;
+
+	spin_lock(&dpio_list_lock);
+	d = list_entry(dpio_list.next, struct dpaa2_io, node);
+	list_del(&d->node);
+	list_add_tail(&d->node, &dpio_list);
+	spin_unlock(&dpio_list_lock);
+
+	return d;
+}
+
+/**
+ * dpaa2_io_create() - create a dpaa2_io object.
+ * @desc: the dpaa2_io descriptor
+ *
+ * Activates a "struct dpaa2_io" corresponding to the given config of an

actual
+ * DPIO object.
+ *
+ * Return a valid dpaa2_io object for success, or NULL for failure.
+ */

drivers/bus/fsl-mc/dpio/dpio-service.c new file +52 -0
+struct dpaa2_io *dpaa2_io_create(const struct dpaa2_io_desc *desc)
+{
+	struct dpaa2_io *obj = kmalloc(sizeof(*obj), GFP_KERNEL);
+
+	if (!obj)
+		return NULL;
+
+	/* check if CPU is out of range (-1 means any cpu) */
+	if (desc->cpu >= NR_CPUS)
+		return NULL;
+
+	atomic_set(&obj->refs, 1);
+	obj->dpio_desc = *desc;
+	obj->swp_desc.cena_bar = obj->dpio_desc.regs_cena;
+	obj->swp_desc.cinh_bar = obj->dpio_desc.regs_cinh;
+	obj->swp_desc.qman_version = obj->dpio_desc.qman_version;
+	obj->swp = qbman_swp_init(&obj->swp_desc);
+
+	if (!obj->swp) {
+		kfree(obj);
+		return NULL;
+	}
+
+	INIT_LIST_HEAD(&obj->node);
+	spin_lock_init(&obj->lock_mgmt_cmd);
+	spin_lock_init(&obj->lock_notifications);
+	INIT_LIST_HEAD(&obj->notifications);
+
+	/* For now only enable DQRR interrupts */
+	qbman_swp_interrupt_set_trigger(obj->swp,
+					QBMAN_SWP_INTERRUPT_DQRI);
+	qbman_swp_interrupt_clear_status(obj->swp, 0xffffffff);
+	if (obj->dpio_desc.receives_notifications)
+		qbman_swp_push_set(obj->swp, 0, 1);
+
+	spin_lock(&dpio_list_lock);
+	list_add_tail(&obj->node, &dpio_list);
+	if (desc->cpu >= 0 && !dpio_by_cpu[desc->cpu])
+		dpio_by_cpu[desc->cpu] = obj;
+	spin_unlock(&dpio_list_lock);
+
+	return obj;
+}
+EXPORT_SYMBOL(dpaa2_io_create);
+
+/**
+ * dpaa2_io_down() - release the dpaa2_io object.
+ * @d: the dpaa2_io object to be released.
+ *
+ * The "struct dpaa2_io" type can represent an individual DPIO object (as
+ * described by "struct dpaa2_io_desc") or an instance of a "DPIO service",
+ * which can be used to group/encapsulate multiple DPIO objects. In all

cases,
+ * each handle obtained should be released using this function.
+ */

drivers/bus/fsl-mc/dpio/dpio-service.c new file +41 -0
+void dpaa2_io_down(struct dpaa2_io *d)
+{
+	if (!atomic_dec_and_test(&d->refs))
+		return;
+	kfree(d);
+}
+EXPORT_SYMBOL(dpaa2_io_down);
+
+#define DPAA_POLL_MAX 32
+
+/**
+ * dpaa2_io_irq() - ISR for DPIO interrupts
+ *
+ * @obj: the given DPIO object.
+ *
+ * Return IRQ_HANDLED for success or IRQ_NONE if there
+ * were no pending interrupts.
+ */
+irqreturn_t dpaa2_io_irq(struct dpaa2_io *obj)
+{
+	const struct dpaa2_dq *dq;
+	int max = 0;
+	struct qbman_swp *swp;
+	u32 status;
+
+	swp = obj->swp;
+	status = qbman_swp_interrupt_read_status(swp);
+	if (!status)
+		return IRQ_NONE;
+
+	dq = qbman_swp_dqrr_next(swp);
+	while (dq) {
+		if (qbman_result_is_SCN(dq)) {
+			struct dpaa2_io_notification_ctx *ctx;
+			u64 q64;
+
+			q64 = qbman_result_SCN_ctx(dq);
+			ctx = (void *)q64;
+			ctx->cb(ctx);
+		} else {
+			pr_crit("fsl-mc-dpio: Unrecognised/ignored DQRR

entry\n");

drivers/bus/fsl-mc/dpio/dpio-service.c new file +82 -0
+		}
+		qbman_swp_dqrr_consume(swp, dq);
+		++max;
+		if (max > DPAA_POLL_MAX)
+			goto done;
+		dq = qbman_swp_dqrr_next(swp);
+	}
+done:
+	qbman_swp_interrupt_clear_status(swp, status);
+	qbman_swp_interrupt_set_inhibit(swp, 0);
+	return IRQ_HANDLED;
+}
+EXPORT_SYMBOL(dpaa2_io_irq);
+
+/**
+ * dpaa2_io_service_register() - Prepare for servicing of FQDAN or CDAN
+ *                               notifications on the given DPIO service.
+ * @d:   the given DPIO service.
+ * @ctx: the notification context.
+ *
+ * The caller should make the MC command to attach a DPAA2 object to
+ * a DPIO after this function completes successfully.  In that way:
+ *    (a) The DPIO service is "ready" to handle a notification arrival
+ *        (which might happen before the "attach" command to MC has
+ *        returned control of execution back to the caller)
+ *    (b) The DPIO service can provide back to the caller the 'dpio_id' and
+ *        'qman64' parameters that it should pass along in the MC command
+ *        in order for the object to be configured to produce the right
+ *        notification fields to the DPIO service.
+ *
+ * Return 0 for success, or -ENODEV for failure.
+ */
+int dpaa2_io_service_register(struct dpaa2_io *d,
+			      struct dpaa2_io_notification_ctx *ctx)
+{
+	unsigned long irqflags;
+
+	d = service_select_by_cpu(d, ctx->desired_cpu);
+	if (!d)
+		return -ENODEV;
+
+	ctx->dpio_id = d->dpio_desc.dpio_id;
+	ctx->qman64 = (u64)ctx;
+	ctx->dpio_private = d;
+	spin_lock_irqsave(&d->lock_notifications, irqflags);
+	list_add(&ctx->node, &d->notifications);
+	spin_unlock_irqrestore(&d->lock_notifications, irqflags);
+
+	/* Enable the generation of CDAN notifications */
+	if (ctx->is_cdan)
+		qbman_swp_CDAN_set_context_enable(d->swp,
+						  (u16)ctx->id,
+						  ctx->qman64);
+	return 0;
+}
+EXPORT_SYMBOL(dpaa2_io_service_register);
+
+/**
+ * dpaa2_io_service_deregister - The opposite of 'register'.
+ * @service: the given DPIO service.
+ * @ctx: the notification context.
+ *
+ * This function should be called only after sending the MC command to
+ * to detach the notification-producing device from the DPIO.
+ */
+void dpaa2_io_service_deregister(struct dpaa2_io *service,
+				struct dpaa2_io_notification_ctx *ctx)
+{
+	struct dpaa2_io *d = ctx->dpio_private;
+	unsigned long irqflags;
+
+	if (ctx->is_cdan)
+		qbman_swp_CDAN_disable(d->swp, (u16)ctx->id);
+
+	spin_lock_irqsave(&d->lock_notifications, irqflags);
+	list_del(&ctx->node);
+	spin_unlock_irqrestore(&d->lock_notifications, irqflags);
+}
+EXPORT_SYMBOL(dpaa2_io_service_deregister);
+
+/**
+ * dpaa2_io_service_rearm() - Rearm the notification for the given DPIO

service.
+ * @service: the given DPIO service.
+ * @ctx: the notification context.
+ *
+ * Once a FQDAN/CDAN has been produced, the corresponding FQ/channel is
+ * considered "disarmed". Ie. the user can issue pull dequeue operations on that
+ * traffic source for as long as it likes. Eventually it may wish to "rearm"
+ * that source to allow it to produce another FQDAN/CDAN, that's what this
+ * function achieves.
+ *
+ * Return 0 for success.
+ */

drivers/bus/fsl-mc/dpio/dpio-service.c line 308

Quoted 7 lines
drivers/bus/fsl-mc/dpio/dpio-service.c new file +7 -0
+int dpaa2_io_service_rearm(struct dpaa2_io *d,
+			   struct dpaa2_io_notification_ctx *ctx)
+{
+	unsigned long irqflags;
+	int err;
+
+	d = service_select(d);

Why not select the DPIO based on ctx->desired_cpu, like in the initial notification register?

Thanks,
Ioana

Quoted 13 lines
drivers/bus/fsl-mc/dpio/dpio-service.c new file +13 -0
+	if (!unlikely(d))
+		return -ENODEV;
+
+	spin_lock_irqsave(&d->lock_mgmt_cmd, irqflags);
+	if (ctx->is_cdan)
+		err = qbman_swp_CDAN_enable(d->swp, (u16)ctx->id);
+	else
+		err = qbman_swp_fq_schedule(d->swp, ctx->id);
+	spin_unlock_irqrestore(&d->lock_mgmt_cmd, irqflags);
+
+	return err;
+}
+EXPORT_SYMBOL(dpaa2_io_service_rearm);

[...]

#10 lore raw

RE: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

In reply to Stuart Yoder
Quoted 23 lines

-----Original Message-----
From: Stuart Yoder
Sent: Friday, November 04, 2016 4:32 PM
To: Ruxandra Ioana Radulescu <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>
Subject: RE: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

Quoted 11 lines

+/**

include/linux/fsl/dpaa2-fd.h line 247

Quoted 8 lines

+ * dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor
+ * @fd: the given frame descriptor
+ * @bpid: buffer pool id to be set
+ */

include/linux/fsl/dpaa2-fd.h new file +4 -0
+static inline void dpaa2_fd_set_bpid(struct dpaa2_fd *fd, uint16_t bpid)
+{
+	fd->simple.bpid = bpid;
+}

The setter/getter functions for fd.ctrl are missing.

Quoted 1 line

Ok, will add those. Does the ethernet driver use that field?

Yes.

Quoted 32 lines
Quoted 11 lines

include/linux/fsl/dpaa2-fd.h line 254

Quoted 8 lines
include/linux/fsl/dpaa2-fd.h new file +7 -0
+
+/**
+ * struct dpaa2_sg_entry - the scatter-gathering structure
+ * @addr: address of the sg entry
+ * @len: length in this sg entry
+ * @bpid: buffer pool id
+ * @format_offset: offset in the MS 16 bits, BPID in the LS 16 bits

Description of the format_offset field is incorrect, it shouldn't contain the reference to BPID.

Thanks, will fix.

Quoted 9 lines
Quoted 9 lines
include/linux/fsl/dpaa2-fd.h new file +9 -0
+/**
+ * dpaa2_sg_get_len() - Get the length in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the length.
+ */
+static inline u32 dpaa2_sg_get_len(const struct dpaa2_sg_entry *sg)
+{
+	if (dpaa2_sg_short_len(sg))
Quoted 8 lines

include/linux/fsl/dpaa2-fd.h line 310

Quoted 4 lines
include/linux/fsl/dpaa2-fd.h new file +4 -0
+		return le32_to_cpu(sg->len) & SG_SHORT_LEN_MASK;
+
+	return le32_to_cpu(sg->len);
+}

We should do this in dpaa2_fd_get_len() as well. Hardware is capable of generating FDs with SL bit set for single frame format too, although in practice I've never actually seen it.

Quoted 1 line

Any suggestion on how to test this case?

Actually, I stand corrected. Apparently WRIOP _always_ generates short len frames, it just happens that, for the current default settings, the rest of the bits in the 32bit word that contains the short length field are always zero.
For FDs generated on the core both formats are accepted, and we use long length format for the Ethernet driver TX frames.

Thanks,
Ioana

#25 lore raw

RE: [PATCH 8/9] bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

In reply to a message not in the archive
Quoted 219 lines

-----Original Message-----
From: Stuart Yoder
Sent: Thursday, November 03, 2016 4:38 PM
To: Ruxandra Ioana Radulescu <[email protected]>
Subject: FW: [PATCH 8/9] bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 8/9] bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

From: Roy Pledge <[email protected]>

The DPIO driver registers with the fsl-mc bus to handle bus-related events for DPIO objects. Key responsibility is mapping I/O regions, setting up interrupt handlers, and calling the DPIO service initialization during probe.

---
 drivers/bus/fsl-mc/dpio/Makefile      |   2 +-
 drivers/bus/fsl-mc/dpio/dpio-driver.c | 289
++++++++++++++++++++++++++++++++++
 2 files changed, 290 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-driver.c
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
index 0778da7..837d330 100644

drivers/bus/fsl-mc/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o dpio-driver.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/dpio-driver.c +0 -0

mc/dpio/dpio-driver.c
new file mode 100644
index 0000000..ad04a2c

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +5 -0
@@ -0,0 +1,289 @@
+/*
+ * Copyright 2014-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are

met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the
distribution.
+ * * Neither the name of Freescale Semiconductor nor the
+ * names of its contributors may be used to endorse or promote
products
+ * derived from this software without specific prior written permission.
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +44 -0
+
+#include <linux/types.h>
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/interrupt.h>
+#include <linux/msi.h>
+#include <linux/dma-mapping.h>
+#include <linux/delay.h>
+
+#include <linux/fsl/mc.h>
+#include <linux/fsl/dpaa2-io.h>
+
+#include "qbman-portal.h"
+#include "dpio.h"
+#include "dpio-cmd.h"
+
+MODULE_LICENSE("Dual BSD/GPL");
+MODULE_AUTHOR("Freescale Semiconductor, Inc");
+MODULE_DESCRIPTION("DPIO Driver");
+
+struct dpio_priv {
+	struct dpaa2_io *io;
+};
+
+static irqreturn_t dpio_irq_handler(int irq_num, void *arg)
+{
+	struct device *dev = (struct device *)arg;
+	struct dpio_priv *priv = dev_get_drvdata(dev);
+
+	return dpaa2_io_irq(priv->io);
+}
+
+static void unregister_dpio_irq_handlers(struct fsl_mc_device *dpio_dev)
+{
+	struct fsl_mc_device_irq *irq;
+
+	irq = dpio_dev->irqs[0];
+
+	/* clear the affinity hint */
+	irq_set_affinity_hint(irq->msi_desc->irq, NULL);
+}
+
+static int register_dpio_irq_handlers(struct fsl_mc_device *dpio_dev, int

cpu)

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +63 -0
+{
+	struct dpio_priv *priv;
+	int error;
+	struct fsl_mc_device_irq *irq;
+	cpumask_t mask;
+
+	priv = dev_get_drvdata(&dpio_dev->dev);
+
+	irq = dpio_dev->irqs[0];
+	error = devm_request_irq(&dpio_dev->dev,
+				 irq->msi_desc->irq,
+				 dpio_irq_handler,
+				 0,
+				 dev_name(&dpio_dev->dev),
+				 &dpio_dev->dev);
+	if (error < 0) {
+		dev_err(&dpio_dev->dev,
+			"devm_request_irq() failed: %d\n",
+			error);
+		return error;
+	}
+
+	/* set the affinity hint */
+	cpumask_clear(&mask);
+	cpumask_set_cpu(cpu, &mask);
+	if (irq_set_affinity_hint(irq->msi_desc->irq, &mask))
+		dev_err(&dpio_dev->dev,
+		       "irq_set_affinity failed irq %d cpu %d\n",
+		       irq->msi_desc->irq, cpu);
+
+	return 0;
+}
+
+static int dpaa2_dpio_probe(struct fsl_mc_device *dpio_dev)
+{
+	struct dpio_attr dpio_attrs;
+	struct dpaa2_io_desc desc;
+	struct dpio_priv *priv;
+	int err = -ENOMEM;
+	struct device *dev = &dpio_dev->dev;
+	static int next_cpu = -1;
+
+	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		goto err_priv_alloc;
+
+	dev_set_drvdata(dev, priv);
+
+	err = fsl_mc_portal_allocate(dpio_dev, 0, &dpio_dev->mc_io);
+	if (err) {
+		dev_dbg(dev, "MC portal allocation failed\n");
+		err = -EPROBE_DEFER;
+		goto err_mcportal;
+	}
+
+	err = dpio_open(dpio_dev->mc_io, 0, dpio_dev->obj_desc.id,
+			&dpio_dev->mc_handle);
+	if (err) {
+		dev_err(dev, "dpio_open() failed\n");
+		goto err_open;
+	}
+
+	err = dpio_get_attributes(dpio_dev->mc_io, 0, dpio_dev-
Quoted 1 line

mc_handle,

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +14 -0
+				  &dpio_attrs);
+	if (err) {
+		dev_err(dev, "dpio_get_attributes() failed %d\n", err);
+		goto err_get_attr;
+	}
+	desc.qman_version = dpio_attrs.qbman_version;
+
+	err = dpio_enable(dpio_dev->mc_io, 0, dpio_dev->mc_handle);
+	if (err) {
+		dev_err(dev, "dpio_enable() failed %d\n", err);
+		goto err_get_attr;
+	}
+
+	/* initialize DPIO descriptor */

drivers/bus/fsl-mc/dpio/dpio-driver.c line 161

Quoted 10 lines
drivers/bus/fsl-mc/dpio/dpio-driver.c new file +10 -0
+	desc.receives_notifications = dpio_attrs.num_priorities ? 1 : 0;
+	desc.has_8prio = dpio_attrs.num_priorities == 8 ? 1 : 0;
+	desc.dpio_id = dpio_dev->obj_desc.id;
+
+	/* get the cpu to use for the affinity hint */
+	if (next_cpu == -1)
+		next_cpu = cpumask_first(cpu_online_mask);
+	else
+		next_cpu = cpumask_next(next_cpu, cpu_online_mask);
+	desc.cpu = next_cpu;

What happens if there's more DPIOs than cores and cpumask_next returns nr_cpu_ids?

Thanks,
Ioana

#11 lore raw

RE: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

In reply to Ruxandra Ioana Radulescu
Quoted 69 lines

-----Original Message-----
From: Ruxandra Ioana Radulescu
Sent: Friday, November 04, 2016 10:04 AM
To: Stuart Yoder <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>
Subject: RE: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

Quoted 23 lines

-----Original Message-----
From: Stuart Yoder
Sent: Friday, November 04, 2016 4:32 PM
To: Ruxandra Ioana Radulescu <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>
Subject: RE: [PATCH 4/9] bus: fsl-mc: dpio: add frame descriptor and scatter/gather APIs

Quoted 11 lines

+/**

include/linux/fsl/dpaa2-fd.h line 247

Quoted 8 lines

+ * dpaa2_fd_set_bpid() - Set the bpid field of frame descriptor
+ * @fd: the given frame descriptor
+ * @bpid: buffer pool id to be set
+ */

include/linux/fsl/dpaa2-fd.h new file +4 -0
+static inline void dpaa2_fd_set_bpid(struct dpaa2_fd *fd, uint16_t bpid)
+{
+	fd->simple.bpid = bpid;
+}

The setter/getter functions for fd.ctrl are missing.

Quoted 1 line

Ok, will add those. Does the ethernet driver use that field?

Yes.

Quoted 32 lines
Quoted 11 lines

include/linux/fsl/dpaa2-fd.h line 254

Quoted 8 lines
include/linux/fsl/dpaa2-fd.h new file +7 -0
+
+/**
+ * struct dpaa2_sg_entry - the scatter-gathering structure
+ * @addr: address of the sg entry
+ * @len: length in this sg entry
+ * @bpid: buffer pool id
+ * @format_offset: offset in the MS 16 bits, BPID in the LS 16 bits

Description of the format_offset field is incorrect, it shouldn't contain the reference to BPID.

Thanks, will fix.

Quoted 17 lines

include/linux/fsl/dpaa2-fd.h line 310

Quoted 13 lines
include/linux/fsl/dpaa2-fd.h new file +13 -0
+/**
+ * dpaa2_sg_get_len() - Get the length in SG entry
+ * @sg: the given scatter-gathering object
+ *
+ * Return the length.
+ */
+static inline u32 dpaa2_sg_get_len(const struct dpaa2_sg_entry *sg)
+{
+	if (dpaa2_sg_short_len(sg))
+		return le32_to_cpu(sg->len) & SG_SHORT_LEN_MASK;
+
+	return le32_to_cpu(sg->len);
+}

We should do this in dpaa2_fd_get_len() as well. Hardware is capable of generating FDs with SL bit set for single frame format too, although in practice I've never actually seen it.

Quoted 6 lines
Quoted 1 line

Any suggestion on how to test this case?

Actually, I stand corrected. Apparently WRIOP _always_ generates short len frames, it just happens that, for the current default settings, the rest of the bits in the 32bit word that contains the short length field are always zero.

Ok, so we were getting lucky. I'll fix that in the next respin.

Thanks,
Stuart

#26 lore raw

RE: [PATCH 8/9] bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

In reply to Ruxandra Ioana Radulescu
Quoted 235 lines

-----Original Message-----
From: Ruxandra Ioana Radulescu
Sent: Friday, November 04, 2016 10:11 AM
To: Stuart Yoder <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: RE: [PATCH 8/9] bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

Quoted 224 lines

-----Original Message-----
From: Stuart Yoder
Sent: Thursday, November 03, 2016 4:38 PM
To: Ruxandra Ioana Radulescu <[email protected]>
Subject: FW: [PATCH 8/9] bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 8/9] bus: fsl-mc: dpio: add the DPAA2 DPIO object driver

From: Roy Pledge <[email protected]>

The DPIO driver registers with the fsl-mc bus to handle bus-related events for DPIO objects. Key responsibility is mapping I/O regions, setting up interrupt handlers, and calling the DPIO service initialization during probe.

---
 drivers/bus/fsl-mc/dpio/Makefile      |   2 +-
 drivers/bus/fsl-mc/dpio/dpio-driver.c | 289
++++++++++++++++++++++++++++++++++
 2 files changed, 290 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/dpio-driver.c
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
index 0778da7..837d330 100644

drivers/bus/fsl-mc/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o dpio-service.o dpio-driver.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/dpio-driver.c +0 -0

mc/dpio/dpio-driver.c
new file mode 100644
index 0000000..ad04a2c

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +5 -0
@@ -0,0 +1,289 @@
+/*
+ * Copyright 2014-2016 Freescale Semiconductor Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are

met:
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the
distribution.
+ * * Neither the name of Freescale Semiconductor nor the
+ * names of its contributors may be used to endorse or promote
products
+ * derived from this software without specific prior written permission.
+ *
+ * ALTERNATIVELY, this software may be distributed under the terms of the
+ * GNU General Public License ("GPL") as published by the Free Software
+ * Foundation, either version 2 of that License or (at your option) any
+ * later version.
+ *
+ * THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +44 -0
+
+#include <linux/types.h>
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/interrupt.h>
+#include <linux/msi.h>
+#include <linux/dma-mapping.h>
+#include <linux/delay.h>
+
+#include <linux/fsl/mc.h>
+#include <linux/fsl/dpaa2-io.h>
+
+#include "qbman-portal.h"
+#include "dpio.h"
+#include "dpio-cmd.h"
+
+MODULE_LICENSE("Dual BSD/GPL");
+MODULE_AUTHOR("Freescale Semiconductor, Inc");
+MODULE_DESCRIPTION("DPIO Driver");
+
+struct dpio_priv {
+	struct dpaa2_io *io;
+};
+
+static irqreturn_t dpio_irq_handler(int irq_num, void *arg)
+{
+	struct device *dev = (struct device *)arg;
+	struct dpio_priv *priv = dev_get_drvdata(dev);
+
+	return dpaa2_io_irq(priv->io);
+}
+
+static void unregister_dpio_irq_handlers(struct fsl_mc_device *dpio_dev)
+{
+	struct fsl_mc_device_irq *irq;
+
+	irq = dpio_dev->irqs[0];
+
+	/* clear the affinity hint */
+	irq_set_affinity_hint(irq->msi_desc->irq, NULL);
+}
+
+static int register_dpio_irq_handlers(struct fsl_mc_device *dpio_dev, int

cpu)

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +63 -0
+{
+	struct dpio_priv *priv;
+	int error;
+	struct fsl_mc_device_irq *irq;
+	cpumask_t mask;
+
+	priv = dev_get_drvdata(&dpio_dev->dev);
+
+	irq = dpio_dev->irqs[0];
+	error = devm_request_irq(&dpio_dev->dev,
+				 irq->msi_desc->irq,
+				 dpio_irq_handler,
+				 0,
+				 dev_name(&dpio_dev->dev),
+				 &dpio_dev->dev);
+	if (error < 0) {
+		dev_err(&dpio_dev->dev,
+			"devm_request_irq() failed: %d\n",
+			error);
+		return error;
+	}
+
+	/* set the affinity hint */
+	cpumask_clear(&mask);
+	cpumask_set_cpu(cpu, &mask);
+	if (irq_set_affinity_hint(irq->msi_desc->irq, &mask))
+		dev_err(&dpio_dev->dev,
+		       "irq_set_affinity failed irq %d cpu %d\n",
+		       irq->msi_desc->irq, cpu);
+
+	return 0;
+}
+
+static int dpaa2_dpio_probe(struct fsl_mc_device *dpio_dev)
+{
+	struct dpio_attr dpio_attrs;
+	struct dpaa2_io_desc desc;
+	struct dpio_priv *priv;
+	int err = -ENOMEM;
+	struct device *dev = &dpio_dev->dev;
+	static int next_cpu = -1;
+
+	priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
+	if (!priv)
+		goto err_priv_alloc;
+
+	dev_set_drvdata(dev, priv);
+
+	err = fsl_mc_portal_allocate(dpio_dev, 0, &dpio_dev->mc_io);
+	if (err) {
+		dev_dbg(dev, "MC portal allocation failed\n");
+		err = -EPROBE_DEFER;
+		goto err_mcportal;
+	}
+
+	err = dpio_open(dpio_dev->mc_io, 0, dpio_dev->obj_desc.id,
+			&dpio_dev->mc_handle);
+	if (err) {
+		dev_err(dev, "dpio_open() failed\n");
+		goto err_open;
+	}
+
+	err = dpio_get_attributes(dpio_dev->mc_io, 0, dpio_dev-
Quoted 1 line

mc_handle,

drivers/bus/fsl-mc/dpio/dpio-driver.c new file +19 -0
+				  &dpio_attrs);
+	if (err) {
+		dev_err(dev, "dpio_get_attributes() failed %d\n", err);
+		goto err_get_attr;
+	}
+	desc.qman_version = dpio_attrs.qbman_version;
+
+	err = dpio_enable(dpio_dev->mc_io, 0, dpio_dev->mc_handle);
+	if (err) {
+		dev_err(dev, "dpio_enable() failed %d\n", err);
+		goto err_get_attr;
+	}
+
+	/* initialize DPIO descriptor */
+	desc.receives_notifications = dpio_attrs.num_priorities ? 1 : 0;
+	desc.has_8prio = dpio_attrs.num_priorities == 8 ? 1 : 0;
+	desc.dpio_id = dpio_dev->obj_desc.id;
+
+	/* get the cpu to use for the affinity hint */
Quoted 8 lines

drivers/bus/fsl-mc/dpio/dpio-driver.c line 161

Quoted 5 lines
drivers/bus/fsl-mc/dpio/dpio-driver.c new file +5 -0
+	if (next_cpu == -1)
+		next_cpu = cpumask_first(cpu_online_mask);
+	else
+		next_cpu = cpumask_next(next_cpu, cpu_online_mask);
+	desc.cpu = next_cpu;

What happens if there's more DPIOs than cores and cpumask_next returns nr_cpu_ids?

We need to error out in that case. DPIO can't handle >= NR_CPUS.

Stuart

#16 lore raw

RE: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

In reply to Ruxandra Ioana Radulescu
Quoted 87 lines

-----Original Message-----
From: Ruxandra Ioana Radulescu
Sent: Thursday, November 10, 2016 9:04 AM
To: Stuart Yoder <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: RE: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

Quoted 45 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

From: Roy Pledge <[email protected]>

Add QBman APIs for frame queue and buffer pool operations.

---
 drivers/bus/fsl-mc/dpio/Makefile       |    2 +-
 drivers/bus/fsl-mc/dpio/qbman-portal.c | 1009
++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/qbman-portal.h |  464 +++++++++++++++
 3 files changed, 1474 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.c
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.h
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
index 128befc..6588498 100644

drivers/bus/fsl-mc/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/qbman-portal.c +0 -0

mc/dpio/qbman-portal.c
new file mode 100644
index 0000000..1eb3dd9

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +0 -0
@@ -0,0 +1,1009 @@

[...]

Quoted 27 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +10 -0
+/**
+ * qbman_swp_release() - Issue a buffer release command
+ * @s:           the software portal object
+ * @d:           the release descriptor
+ * @buffers:     a pointer pointing to the buffer address to be released
+ * @num_buffers: number of buffers to be released,  must be less than 8
+ *
+ * Return 0 for success, -EBUSY if the release command ring is not ready.
+ */
+int qbman_swp_release(struct qbman_swp *s, const struct

qbman_release_desc *d,

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +16 -0
+		      const u64 *buffers, unsigned int num_buffers)
+{
+	int i;
+	struct qbman_release_desc *p;
+	u32 rar;
+
+	if (!num_buffers || (num_buffers > 7))
+		return -EINVAL;
+
+	rar = qbman_read_register(s, QBMAN_CINH_SWP_RAR);
+	if (!RAR_SUCCESS(rar))
+		return -EBUSY;
+
+	/* Start the release command */
+	p = qbman_get_cmd(s, QBMAN_CENA_SWP_RCR(RAR_IDX(rar)));
+	/* Copy the caller's buffer pointers to the command */
Quoted 8 lines

drivers/bus/fsl-mc/dpio/qbman-portal.c line 832

Quoted 3 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +3 -0
+	for (i = 0; i < num_buffers; i++)
+		p->buf[i] = cpu_to_le64(buffers[i]);
+

Hi Stuart,
We also need to set BPID field in the buffer release command, something like:
+ p->bpid = d->bpid;
Without this all buffers will be released to buffer pool id 0, which is incorrect.

Will fix on next respin.

Quoted 48 lines
Quoted 48 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +2 -0
+	/*
+	 * Set the verb byte, have to substitute in the valid-bit and the

number

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +45 -0
+	 * of buffers.
+	 */
+	dma_wmb();
+	p->verb = d->verb | RAR_VB(rar) | num_buffers;
+
+	return 0;
+}
+
+struct qbman_acquire_desc {
+	u8 verb;
+	u8 reserved;
+	u16 bpid;
+	u8 num;
+	u8 reserved2[59];
+};
+
+struct qbman_acquire_rslt {
+	u8 verb;
+	u8 rslt;
+	u16 reserved;
+	u8 num;
+	u8 reserved2[3];
+	u64 buf[7];
+};
+
+/**
+ * qbman_swp_acquire() - Issue a buffer acquire command
+ * @s:           the software portal object
+ * @bpid:        the buffer pool index
+ * @buffers:     a pointer pointing to the acquired buffer addresses
+ * @num_buffers: number of buffers to be acquired, must be less than 8
+ *
+ * Return 0 for success, or negative error code if the acquire command
+ * fails.
+ */
+int qbman_swp_acquire(struct qbman_swp *s, u16 bpid, u64 *buffers,
+		      unsigned int num_buffers)
+{
+	struct qbman_acquire_desc *p;
+	struct qbman_acquire_rslt *r;
+	int i;
+
+	if (!num_buffers || (num_buffers > 7))
+		return -EINVAL;
+
Quoted 8 lines

drivers/bus/fsl-mc/dpio/qbman-portal.c

Quoted 2 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +2 -0
+	/* Start the management command */
+	p = qbman_swp_mc_start(s);

qbman_swp_mc_start() returns a pointer to where the QBMan management command must be written, but doesn't clear any previous values found there.
We should memset the area to zero before using it.
Same comment applies to other places where this function is used.

Ok, will fix.

Quoted 7 lines
Quoted 7 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +7 -0
+
+	if (!p)
+		return -EBUSY;
+
+	/* Encode the caller-provided attributes */
+	p->bpid = cpu_to_le16(bpid);
+	p->num = num_buffers;
Quoted 8 lines
Quoted 4 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +3 -0
+
+	/* Complete the management command */
+	r = qbman_swp_mc_complete(s, p, p->verb |

QBMAN_MC_ACQUIRE);

qbman_swp_mc_complete() may return NULL, if for instance the hardware is unresponsive. We need to check this before dereferencing r. Same for other instances of usage throughout the code.

Ok, will fix.

Thanks for the review.

Stuart

#15 lore raw

RE: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

In reply to a message not in the archive
Quoted 46 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

From: Roy Pledge <[email protected]>

Add QBman APIs for frame queue and buffer pool operations.

---
 drivers/bus/fsl-mc/dpio/Makefile       |    2 +-
 drivers/bus/fsl-mc/dpio/qbman-portal.c | 1009
++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/qbman-portal.h |  464 +++++++++++++++
 3 files changed, 1474 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.c
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.h
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
index 128befc..6588498 100644

drivers/bus/fsl-mc/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/qbman-portal.c +0 -0

mc/dpio/qbman-portal.c
new file mode 100644
index 0000000..1eb3dd9

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +0 -0
@@ -0,0 +1,1009 @@

[...]

Quoted 20 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +10 -0
+/**
+ * qbman_swp_release() - Issue a buffer release command
+ * @s:           the software portal object
+ * @d:           the release descriptor
+ * @buffers:     a pointer pointing to the buffer address to be released
+ * @num_buffers: number of buffers to be released,  must be less than 8
+ *
+ * Return 0 for success, -EBUSY if the release command ring is not ready.
+ */
+int qbman_swp_release(struct qbman_swp *s, const struct

qbman_release_desc *d,

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +9 -0
+		      const u64 *buffers, unsigned int num_buffers)
+{
+	int i;
+	struct qbman_release_desc *p;
+	u32 rar;
+
+	if (!num_buffers || (num_buffers > 7))
+		return -EINVAL;
+

drivers/bus/fsl-mc/dpio/qbman-portal.c line 832

Quoted 10 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +10 -0
+	rar = qbman_read_register(s, QBMAN_CINH_SWP_RAR);
+	if (!RAR_SUCCESS(rar))
+		return -EBUSY;
+
+	/* Start the release command */
+	p = qbman_get_cmd(s, QBMAN_CENA_SWP_RCR(RAR_IDX(rar)));
+	/* Copy the caller's buffer pointers to the command */
+	for (i = 0; i < num_buffers; i++)
+		p->buf[i] = cpu_to_le64(buffers[i]);
+

Hi Stuart,
We also need to set BPID field in the buffer release command, something like:
+ p->bpid = d->bpid;
Without this all buffers will be released to buffer pool id 0, which is incorrect.

Quoted 40 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +2 -0
+	/*
+	 * Set the verb byte, have to substitute in the valid-bit and the

number

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +37 -0
+	 * of buffers.
+	 */
+	dma_wmb();
+	p->verb = d->verb | RAR_VB(rar) | num_buffers;
+
+	return 0;
+}
+
+struct qbman_acquire_desc {
+	u8 verb;
+	u8 reserved;
+	u16 bpid;
+	u8 num;
+	u8 reserved2[59];
+};
+
+struct qbman_acquire_rslt {
+	u8 verb;
+	u8 rslt;
+	u16 reserved;
+	u8 num;
+	u8 reserved2[3];
+	u64 buf[7];
+};
+
+/**
+ * qbman_swp_acquire() - Issue a buffer acquire command
+ * @s:           the software portal object
+ * @bpid:        the buffer pool index
+ * @buffers:     a pointer pointing to the acquired buffer addresses
+ * @num_buffers: number of buffers to be acquired, must be less than 8
+ *
+ * Return 0 for success, or negative error code if the acquire command
+ * fails.
+ */
+int qbman_swp_acquire(struct qbman_swp *s, u16 bpid, u64 *buffers,
+		      unsigned int num_buffers)

drivers/bus/fsl-mc/dpio/qbman-portal.c line 881

Quoted 10 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +10 -0
+{
+	struct qbman_acquire_desc *p;
+	struct qbman_acquire_rslt *r;
+	int i;
+
+	if (!num_buffers || (num_buffers > 7))
+		return -EINVAL;
+
+	/* Start the management command */
+	p = qbman_swp_mc_start(s);

qbman_swp_mc_start() returns a pointer to where the QBMan management command must be written, but doesn't clear any previous values found there.
We should memset the area to zero before using it.
Same comment applies to other places where this function is used.

Quoted 11 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +10 -0
+
+	if (!p)
+		return -EBUSY;
+
+	/* Encode the caller-provided attributes */
+	p->bpid = cpu_to_le16(bpid);
+	p->num = num_buffers;
+
+	/* Complete the management command */
+	r = qbman_swp_mc_complete(s, p, p->verb |

QBMAN_MC_ACQUIRE);

qbman_swp_mc_complete() may return NULL, if for instance the hardware is unresponsive. We need to check this before dereferencing r. Same for other instances of usage throughout the code.

Thanks,
Ioana

#22 lore raw

RE: [PATCH 7/9] bus: fsl-mc: dpio: add the DPAA2 DPIO service interface

In reply to Ruxandra Ioana Radulescu
Quoted 18 lines
Quoted 18 lines

+/**
+ * dpaa2_io_service_rearm() - Rearm the notification for the given DPIO service.
+ * @service: the given DPIO service.
+ * @ctx: the notification context.
+ *
+ * Once a FQDAN/CDAN has been produced, the corresponding FQ/channel is
+ * considered "disarmed". Ie. the user can issue pull dequeue operations on that
+ * traffic source for as long as it likes. Eventually it may wish to "rearm"
+ * that source to allow it to produce another FQDAN/CDAN, that's what this
+ * function achieves.
+ *
+ * Return 0 for success.
+ */

drivers/bus/fsl-mc/dpio/dpio-service.c new file +2 -0
+int dpaa2_io_service_rearm(struct dpaa2_io *d,
+			   struct dpaa2_io_notification_ctx *ctx)
Quoted 8 lines

drivers/bus/fsl-mc/dpio/dpio-service.c line 308

Quoted 5 lines
drivers/bus/fsl-mc/dpio/dpio-service.c new file +5 -0
+{
+	unsigned long irqflags;
+	int err;
+
+	d = service_select(d);

Why not select the DPIO based on ctx->desired_cpu, like in the initial notification register?

Sounds like a reasonable idea, I am going to confirm with Roy.

Stuart

#17 lore raw

RE: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

In reply to a message not in the archive
Quoted 44 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

From: Roy Pledge <[email protected]>

Add QBman APIs for frame queue and buffer pool operations.

---
 drivers/bus/fsl-mc/dpio/Makefile       |    2 +-
 drivers/bus/fsl-mc/dpio/qbman-portal.c | 1009
++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/qbman-portal.h |  464 +++++++++++++++
 3 files changed, 1474 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.c
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.h
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
index 128befc..6588498 100644

drivers/bus/fsl-mc/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/qbman-portal.c +0 -0

mc/dpio/qbman-portal.c
new file mode 100644
index 0000000..1eb3dd9

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +0 -0

[...]

Quoted 30 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +30 -0
+/**
+ * qbman_swp_pull() - Issue the pull dequeue command
+ * @s: the software portal object
+ * @d: the software portal descriptor which has been configured with
+ *     the set of qbman_pull_desc_set_*() calls
+ *
+ * Return 0 for success, and -EBUSY if the software portal is not ready
+ * to do pull dequeue.
+ */
+int qbman_swp_pull(struct qbman_swp *s, struct qbman_pull_desc *d)
+{
+	struct qbman_pull_desc *p;
+
+	if (!atomic_dec_and_test(&s->vdq.available)) {
+		atomic_inc(&s->vdq.available);
+		return -EBUSY;
+	}
+	s->vdq.storage = (void *)d->rsp_addr_virt;
+	d->tok = 1;
+	p = qbman_get_cmd(s, QBMAN_CENA_SWP_VDQCR);
+	*p = *d;
+	dma_wmb();
+
+	/* Set the verb byte, have to substitute in the valid-bit */
+	p->verb |= s->vdq.valid_bit;
+	s->vdq.valid_bit ^= QB_VALID_BIT;
+
+	return 0;
+}
+

[...]

Quoted 24 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +3 -0
+
+/**
+ * qbman_result_has_new_result() - Check and get the dequeue response

from the
+ * dq storage memory set in pull dequeue command
+ * @s: the software portal object
+ * @dq: the dequeue result read from the memory
+ *
+ * Return 1 for getting a valid dequeue result, or 0 for not getting a valid
+ * dequeue result.
+ *
+ * Only used for user-provided storage of dequeue results, not DQRR. For
+ * efficiency purposes, the driver will perform any required endianness
+ * conversion to ensure that the user's dequeue result storage is in host- endian
+ * format. As such, once the user has called qbman_result_has_new_result() and
+ * been returned a valid dequeue result, they should not call it again on
+ * the same memory location (except of course if another dequeue command has
+ * been executed to produce a new result to that location).
+ */
+int qbman_result_has_new_result(struct qbman_swp *s, const struct dpaa2_dq *dq)

drivers/bus/fsl-mc/dpio/qbman-portal.c line 748

Quoted 3 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +3 -0
+{
+	if (!dq->dq.tok)
+		return 0;

While testing the Ethernet driver I discovered that sometimes the above check fails.

When we check a store entry for the first time, if the hardware didn't manage to fill it with a valid respose yet, we may find a non-null value in the token field (because the stores have uninitialized memory). So by only checking that token is !=0, we risk processing an uninitialized memory area as a valid dequeue entry.

We should always compare the token field against 1, the value that is given to the hardware on the dequeue command. It might also be a good idea to use a define here, to make it clear 1 is a magic value.

And I think we should also zero the stores when they are first allocated, since even with the proposed fix there's still a (much smaller) risk of finding our exact token value in an uninitialized memory area.

Thanks,
Ioana

#18 lore raw

RE: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

Quoted 126 lines

-----Original Message-----
From: Ruxandra Ioana Radulescu
Sent: Monday, November 28, 2016 12:10 PM
To: Stuart Yoder <[email protected]>; [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>
Subject: RE: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

Quoted 44 lines

-----Original Message-----
From: Stuart Yoder [mailto:[email protected]]
Sent: Friday, October 21, 2016 9:02 AM
To: [email protected]
Cc: German Rivera <[email protected]>; [email protected]; [email protected]; [email protected]; [email protected]; Leo Li <[email protected]>; Roy Pledge <[email protected]>; Roy Pledge <[email protected]>; Haiying Wang <[email protected]>; Stuart Yoder <[email protected]>
Subject: [PATCH 6/9] bus: fsl-mc: dpio: add QBMan portal APIs for DPAA2

From: Roy Pledge <[email protected]>

Add QBman APIs for frame queue and buffer pool operations.

---
 drivers/bus/fsl-mc/dpio/Makefile       |    2 +-
 drivers/bus/fsl-mc/dpio/qbman-portal.c | 1009
++++++++++++++++++++++++++++++++
 drivers/bus/fsl-mc/dpio/qbman-portal.h |  464 +++++++++++++++
 3 files changed, 1474 insertions(+), 1 deletion(-)
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.c
 create mode 100644 drivers/bus/fsl-mc/dpio/qbman-portal.h
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/Makefile +0 -0

mc/dpio/Makefile
index 128befc..6588498 100644

drivers/bus/fsl-mc/dpio/Makefile +1 -1
@@ -6,4 +6,4 @@ subdir-ccflags-y := -Werror
 
 obj-$(CONFIG_FSL_MC_DPIO) += fsl-mc-dpio.o
 
-fsl-mc-dpio-objs := dpio.o
+fsl-mc-dpio-objs := dpio.o qbman-portal.o
drivers/bus/fsl- renamed from drivers/bus/fsl-mc/dpio/qbman-portal.c +0 -0

mc/dpio/qbman-portal.c
new file mode 100644
index 0000000..1eb3dd9

drivers/bus/fsl-mc/dpio/qbman-portal.c new file +0 -0

[...]

Quoted 30 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +30 -0
+/**
+ * qbman_swp_pull() - Issue the pull dequeue command
+ * @s: the software portal object
+ * @d: the software portal descriptor which has been configured with
+ *     the set of qbman_pull_desc_set_*() calls
+ *
+ * Return 0 for success, and -EBUSY if the software portal is not ready
+ * to do pull dequeue.
+ */
+int qbman_swp_pull(struct qbman_swp *s, struct qbman_pull_desc *d)
+{
+	struct qbman_pull_desc *p;
+
+	if (!atomic_dec_and_test(&s->vdq.available)) {
+		atomic_inc(&s->vdq.available);
+		return -EBUSY;
+	}
+	s->vdq.storage = (void *)d->rsp_addr_virt;
+	d->tok = 1;
+	p = qbman_get_cmd(s, QBMAN_CENA_SWP_VDQCR);
+	*p = *d;
+	dma_wmb();
+
+	/* Set the verb byte, have to substitute in the valid-bit */
+	p->verb |= s->vdq.valid_bit;
+	s->vdq.valid_bit ^= QB_VALID_BIT;
+
+	return 0;
+}
+

[...]

Quoted 24 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +3 -0
+
+/**
+ * qbman_result_has_new_result() - Check and get the dequeue response

from the
+ * dq storage memory set in pull dequeue command
+ * @s: the software portal object
+ * @dq: the dequeue result read from the memory
+ *
+ * Return 1 for getting a valid dequeue result, or 0 for not getting a valid
+ * dequeue result.
+ *
+ * Only used for user-provided storage of dequeue results, not DQRR. For
+ * efficiency purposes, the driver will perform any required endianness
+ * conversion to ensure that the user's dequeue result storage is in host- endian
+ * format. As such, once the user has called qbman_result_has_new_result() and
+ * been returned a valid dequeue result, they should not call it again on
+ * the same memory location (except of course if another dequeue command has
+ * been executed to produce a new result to that location).
+ */
+int qbman_result_has_new_result(struct qbman_swp *s, const struct dpaa2_dq *dq)

drivers/bus/fsl-mc/dpio/qbman-portal.c line 748

Quoted 3 lines
drivers/bus/fsl-mc/dpio/qbman-portal.c new file +3 -0
+{
+	if (!dq->dq.tok)
+		return 0;

While testing the Ethernet driver I discovered that sometimes the above check fails.

When we check a store entry for the first time, if the hardware didn't manage to fill it with a valid respose yet, we may find a non-null value in the token field (because the stores have uninitialized memory). So by only checking that token is !=0, we risk processing an uninitialized memory area as a valid dequeue entry.

Quoted 7 lines

We should always compare the token field against 1, the value that is given to the hardware on the dequeue command. It might also be a good idea to use a define here, to make it clear 1 is a magic value.

And I think we should also zero the stores when they are first allocated, since even with the proposed fix there's still a (much smaller) risk of finding our exact token value in an uninitialized memory area.

Thanks. Will fix this on v3 respin.

Stuart