Skip to content

Commit

Permalink
soc: fsl: dpio: Convert DPIO documentation to .rst
Browse files Browse the repository at this point in the history
Convert the Datapath I/O documentation to .rst format
and move to the Documation/networking/dpaa2 directory

Signed-off-by: Roy Pledge <roy.pledge@nxp.com>
Reviewed-by: Horia Geantă <horia.geanta@nxp.com>
Reviewed-by: Ioana Radulescu <ruxandra.radulescu@nxp.com>
Signed-off-by: Li Yang <leoyang.li@nxp.com>
  • Loading branch information
Roy Pledge authored and Li Yang committed Jul 24, 2018
1 parent 2940882 commit d8e516b
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
Copyright 2016 NXP
.. include:: <isonum.txt>

DPAA2 DPIO (Data Path I/O) Overview
===================================

:Copyright: |copy| 2016-2018 NXP

This document provides an overview of the Freescale DPAA2 DPIO
drivers

Introduction
------------
============

A DPAA2 DPIO (Data Path I/O) is a hardware object that provides
interfaces to enqueue and dequeue frames to/from network interfaces
Expand All @@ -27,8 +35,11 @@ provides services that:

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
Expand All @@ -45,8 +56,9 @@ The Linux DPIO driver consists of 3 primary components--
|
hardware


The diagram below shows how the DPIO driver components fit with the other
DPAA2 Linux driver components:
DPAA2 Linux driver components::
+------------+
| OS Network |
| Stack |
Expand Down Expand Up @@ -98,20 +110,29 @@ DPIO service (dpio-service.c, dpaa2-io.h)

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)
Expand All @@ -120,7 +141,9 @@ 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
Expand Down
1 change: 1 addition & 0 deletions Documentation/networking/dpaa2/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ DPAA2 Documentation
:maxdepth: 1

overview
dpio-driver

0 comments on commit d8e516b

Please sign in to comment.