mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Lijun Pan <Lijun.Pan@freescale.com>
To: <gregkh@linuxfoundation.org>, <arnd@arndb.de>,
	<devel@driverdev.osuosl.org>, <linux-kernel@vger.kernel.org>
Cc: <stuart.yoder@freescale.com>, <itai.katz@freescale.com>,
	<german.rivera@freescale.com>, <leoli@freescale.com>,
	<scottwood@freescale.com>, <agraf@suse.de>,
	<bhamciu1@freescale.com>, <R89243@freescale.com>,
	<bhupesh.sharma@freescale.com>, <nir.erez@freescale.com>,
	<richard.schmitt@freescale.com>, <dan.carpenter@oracle.com>,
	Lijun Pan <Lijun.Pan@freescale.com>
Subject: [PATCH v2 7/8] staging: fsl-mc: update TODO and README for restool driver
Date: Fri, 30 Oct 2015 14:32:09 -0500	[thread overview]
Message-ID: <1446233530-8918-8-git-send-email-Lijun.Pan@freescale.com> (raw)
In-Reply-To: <1446233530-8918-1-git-send-email-Lijun.Pan@freescale.com>

Add more introduction of restool driver and state why
restool driver is needed in helping moving fsl-mc bus
out of staging tree.

Signed-off-by: Lijun Pan <Lijun.Pan@freescale.com>
---
 drivers/staging/fsl-mc/README.txt | 11 ++++++++++-
 drivers/staging/fsl-mc/TODO       | 18 ++++++++++++++++--
 2 files changed, 26 insertions(+), 3 deletions(-)

diff --git a/drivers/staging/fsl-mc/README.txt b/drivers/staging/fsl-mc/README.txt
index 8214102..e9ec507 100644
--- a/drivers/staging/fsl-mc/README.txt
+++ b/drivers/staging/fsl-mc/README.txt
@@ -130,7 +130,16 @@ the objects involved in creating a network interfaces.
     via a config file passed to the MC when firmware starts
     it.  There is also a Linux user space tool called "restool"
     that can be used to create/destroy containers and objects
-    dynamically.
+    dynamically. The kernel side restool driver communicates with
+    user space restool via ioctl. Restool relies on allocator driver
+    to allocate dpmcp resources, enumerates fsl-mc bus to find root dprc
+    objects of interest. When the user space restool program sends a request
+    to restool driver to create a dp* objects in MC firmware, an interrupt
+    will be triggered by MC firmware and the dprc driver's interrupt handler
+    shall process the interrupt (synchronizing the objects in MC firmware and
+    objects in Linux kernel). Though small, restool driver helps verify all
+    the functionality of fsl-mc bus, dprc driver, allocator driver,
+    and MC flib API.
 
 -DPAA2 Objects for an Ethernet Network Interface
 
diff --git a/drivers/staging/fsl-mc/TODO b/drivers/staging/fsl-mc/TODO
index 5065821..4892eb6 100644
--- a/drivers/staging/fsl-mc/TODO
+++ b/drivers/staging/fsl-mc/TODO
@@ -5,10 +5,24 @@
   fsl-mc bus out of staging.
 
 * Decide if multiple root fsl-mc buses will be supported per Linux instance,
-  and if so add support for this.
+  and if so add support for this. No matter fsl-mc bus support multiple root
+  dprc or not, restool driver is designed to support multiple root if fsl-mc
+  bus is ready some day later. If there is only one root dprc, restool driver
+  works fine.
+
+* Add at least one driver utilizing fsl-mc bus. Restool driver is a very
+  small and simple driver, which interacts with fsl-mc bus, dprc driver,
+  allocator driver. Restool relies on allocator driver to allocate
+  dpmcp resources, enumerates fsl-mc bus to find root dprc objects of interest.
+  When the user space restool program sends a request to restool driver to
+  create a dp* objects in MC firmware, an interrupt will be triggered by
+  MC firmware and the dprc driver's interrupt handler shall process the
+  interrupt. Though small, restool driver helps verify all the functionality
+  of fsl-mc bus, dprc driver, allocator driver, and MC flib API. Restool
+  driver helps in moving fsl-mc bus out of staging branch.
 
 * 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
+  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:
 
-- 
2.3.3


  parent reply	other threads:[~2015-10-30 19:48 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-10-30 19:32 [PATCH v2 0/8] Management Complex " Lijun Pan
2015-10-30 19:32 ` [PATCH v2 1/8] staging: fsl-mc: static inline function to differentiate root dprc Lijun Pan
2015-10-30 19:32 ` [PATCH v2 2/8] staging: fsl-mc: add sysfs rescan attribute in TODO Lijun Pan
2015-10-30 19:32 ` [PATCH v3 3/8] staging: fsl-mc: dprc device's sysfs rescan documentation Lijun Pan
2015-10-30 19:32 ` [PATCH v2 4/8] staging: fsl-mc: root dprc rescan attribute to sync kernel with MC Lijun Pan
2015-10-30 19:32 ` [PATCH v2 5/8] staging: fsl-mc: fsl-mc bus's sysfs rescan documentation Lijun Pan
2015-10-30 19:32 ` [PATCH v2 6/8] staging: fsl-mc: bus rescan attribute to sync kernel with MC Lijun Pan
2015-10-30 19:32 ` Lijun Pan [this message]
2015-10-30 19:32 ` [PATCH v2 8/8] staging: fsl-mc: Management Complex restool driver Lijun Pan

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1446233530-8918-8-git-send-email-Lijun.Pan@freescale.com \
    --to=lijun.pan@freescale.com \
    --cc=R89243@freescale.com \
    --cc=agraf@suse.de \
    --cc=arnd@arndb.de \
    --cc=bhamciu1@freescale.com \
    --cc=bhupesh.sharma@freescale.com \
    --cc=dan.carpenter@oracle.com \
    --cc=devel@driverdev.osuosl.org \
    --cc=german.rivera@freescale.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=itai.katz@freescale.com \
    --cc=leoli@freescale.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=nir.erez@freescale.com \
    --cc=richard.schmitt@freescale.com \
    --cc=scottwood@freescale.com \
    --cc=stuart.yoder@freescale.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®