From: Bhaumik Bhatt <bbhatt@codeaurora.org>
To: manivannan.sadhasivam@linaro.org
Cc: linux-arm-msm@vger.kernel.org, hemantk@codeaurora.org,
jhugo@codeaurora.org, linux-kernel@vger.kernel.org,
loic.poulain@linaro.org, Bhaumik Bhatt <bbhatt@codeaurora.org>
Subject: [PATCH v6 7/8] bus: mhi: Improve documentation on channel transfer setup APIs
Date: Thu, 4 Feb 2021 12:28:05 -0800 [thread overview]
Message-ID: <1612470486-10440-8-git-send-email-bbhatt@codeaurora.org> (raw)
In-Reply-To: <1612470486-10440-1-git-send-email-bbhatt@codeaurora.org>
The mhi_prepare_for_transfer() and mhi_unprepare_from_transfer()
APIs could use better explanation. Add details on what MHI does
when these APIs are used.
Signed-off-by: Bhaumik Bhatt <bbhatt@codeaurora.org>
Reviewed-by: Hemant Kumar <hemantk@codeaurora.org>
---
include/linux/mhi.h | 18 ++++++++++++++++--
1 file changed, 16 insertions(+), 2 deletions(-)
diff --git a/include/linux/mhi.h b/include/linux/mhi.h
index d26acc8..56c4c52 100644
--- a/include/linux/mhi.h
+++ b/include/linux/mhi.h
@@ -712,13 +712,27 @@ int mhi_device_get_sync(struct mhi_device *mhi_dev);
void mhi_device_put(struct mhi_device *mhi_dev);
/**
- * mhi_prepare_for_transfer - Setup channel for data transfer
+ * mhi_prepare_for_transfer - Setup UL and DL channels for data transfer.
+ * Allocate and initialize the channel context and
+ * also issue the START channel command to both
+ * channels. Channels can be started only if both
+ * host and device execution environments match and
+ * channels are in a DISABLED state.
* @mhi_dev: Device associated with the channels
*/
int mhi_prepare_for_transfer(struct mhi_device *mhi_dev);
/**
- * mhi_unprepare_from_transfer - Unprepare the channels
+ * mhi_unprepare_from_transfer - Reset UL and DL channels for data transfer.
+ * Issue the RESET channel command and let the
+ * device clean-up the context so no incoming
+ * transfers are seen on the host. Free memory
+ * associated with the context on host. If device
+ * is unresponsive, only perform a host side
+ * clean-up. Channels can be reset only if both
+ * host and device execution environments match
+ * and channels are in an ENABLED, STOPPED or
+ * SUSPENDED state.
* @mhi_dev: Device associated with the channels
*/
void mhi_unprepare_from_transfer(struct mhi_device *mhi_dev);
--
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
next prev parent reply other threads:[~2021-02-04 20:37 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-02-04 20:27 [PATCH v6 0/8] Updates to MHI channel handling Bhaumik Bhatt
2021-02-04 20:27 ` [PATCH v6 1/8] bus: mhi: core: Allow sending the STOP channel command Bhaumik Bhatt
2021-02-04 20:28 ` [PATCH v6 2/8] bus: mhi: core: Clear context for stopped channels from remove() Bhaumik Bhatt
2021-02-04 20:28 ` [PATCH v6 3/8] bus: mhi: core: Improvements to the channel handling state machine Bhaumik Bhatt
2021-02-24 10:03 ` Manivannan Sadhasivam
2021-02-25 1:39 ` Bhaumik Bhatt
2021-02-04 20:28 ` [PATCH v6 4/8] bus: mhi: core: Clear configuration from channel context during reset Bhaumik Bhatt
2021-02-04 20:28 ` [PATCH v6 5/8] bus: mhi: core: Check channel execution environment before issuing reset Bhaumik Bhatt
2021-02-24 10:07 ` Manivannan Sadhasivam
2021-02-04 20:28 ` [PATCH v6 6/8] bus: mhi: core: Remove __ prefix for MHI channel unprepare function Bhaumik Bhatt
2021-02-04 20:28 ` Bhaumik Bhatt [this message]
2021-02-24 10:08 ` [PATCH v6 7/8] bus: mhi: Improve documentation on channel transfer setup APIs Manivannan Sadhasivam
2021-02-04 20:28 ` [PATCH v6 8/8] bus: mhi: core: Do not clear channel context more than once Bhaumik Bhatt
2021-02-05 22:46 ` Hemant Kumar
2021-02-24 10:10 ` Manivannan Sadhasivam
2021-02-24 18:55 ` Bhaumik Bhatt
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=1612470486-10440-8-git-send-email-bbhatt@codeaurora.org \
--to=bbhatt@codeaurora.org \
--cc=hemantk@codeaurora.org \
--cc=jhugo@codeaurora.org \
--cc=linux-arm-msm@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=loic.poulain@linaro.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).