linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Hemant Kumar <hemantk@codeaurora.org>
To: manivannan.sadhasivam@linaro.org
Cc: linux-arm-msm@vger.kernel.org, linux-kernel@vger.kernel.org,
	jhugo@codeaurora.org, bbhatt@codeaurora.org,
	Hemant Kumar <hemantk@codeaurora.org>
Subject: [PATCH v3 3/4] docs: Add documentation for user space client interface
Date: Thu, 11 Jun 2020 11:13:43 -0700	[thread overview]
Message-ID: <1591899224-3403-4-git-send-email-hemantk@codeaurora.org> (raw)
In-Reply-To: <1591899224-3403-1-git-send-email-hemantk@codeaurora.org>

MHI user space client driver is creating device file node
for user application to perform file operations. File
operations are handled by MHI core driver. Currently
Loopback MHI channel is supported by this driver.

Signed-off-by: Hemant Kumar <hemantk@codeaurora.org>
---
 Documentation/mhi/index.rst |  1 +
 Documentation/mhi/uci.rst   | 19 +++++++++++++++++++
 2 files changed, 20 insertions(+)
 create mode 100644 Documentation/mhi/uci.rst

diff --git a/Documentation/mhi/index.rst b/Documentation/mhi/index.rst
index 1d8dec3..c75a371 100644
--- a/Documentation/mhi/index.rst
+++ b/Documentation/mhi/index.rst
@@ -9,6 +9,7 @@ MHI
 
    mhi
    topology
+   uci
 
 .. only::  subproject and html
 
diff --git a/Documentation/mhi/uci.rst b/Documentation/mhi/uci.rst
new file mode 100644
index 0000000..a5c5c4f
--- /dev/null
+++ b/Documentation/mhi/uci.rst
@@ -0,0 +1,19 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+=================================
+User space Client Interface (UCI)
+=================================
+
+UCI driver enables user space clients to communicate to external MHI devices
+like modem and WLAN. It creates standard character device file nodes for user
+space clients to perform open, read, write, pool and close file operations.
+
+Device file node is created with format:-
+
+/dev/mhi_<controller_name>_<mhi_device_name>
+
+controller_name is the name of underlying bus used to transfer data.
+mhi_device_name is the name of the MHI channel being used by MHI client
+to send or receive data using MHI protocol. MHI channels are statically
+defined by MHI specification. Driver currently supports LOOPBACK channel
+index 0 (Host to device) and 1 (Device to Host).
-- 
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project


  parent reply	other threads:[~2020-06-11 18:14 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-11 18:13 [PATCH v3 0/4] user space client interface driver Hemant Kumar
2020-06-11 18:13 ` [PATCH v3 1/4] bus: mhi: core: Add helper API to return number of free TREs Hemant Kumar
2020-06-19  5:31   ` Manivannan Sadhasivam
2020-06-11 18:13 ` [PATCH v3 2/4] bus: mhi: core: Move MHI_MAX_MTU to external header file Hemant Kumar
2020-06-19  5:33   ` Manivannan Sadhasivam
2020-06-25  0:03     ` Hemant Kumar
2020-06-11 18:13 ` Hemant Kumar [this message]
2020-06-19  6:39   ` [PATCH v3 3/4] docs: Add documentation for user space client interface Manivannan Sadhasivam
2020-06-25  1:52     ` Hemant Kumar
2020-06-25  6:23       ` Manivannan Sadhasivam
2020-06-25  6:27         ` Manivannan Sadhasivam
2020-06-11 18:13 ` [PATCH v3 4/4] bus: mhi: clients: Add user space client interface driver Hemant Kumar
2020-06-19 10:40   ` Manivannan Sadhasivam
2020-07-21  3:40     ` Hemant Kumar
2020-07-22  8:45       ` Manivannan Sadhasivam
2020-07-24 23:47         ` Hemant Kumar
2020-07-25 16:49           ` Manivannan Sadhasivam

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=1591899224-3403-4-git-send-email-hemantk@codeaurora.org \
    --to=hemantk@codeaurora.org \
    --cc=bbhatt@codeaurora.org \
    --cc=jhugo@codeaurora.org \
    --cc=linux-arm-msm@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=manivannan.sadhasivam@linaro.org \
    /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;
as well as URLs for NNTP newsgroup(s).