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,
carl.yin@quectel.com, naveen.kumar@quectel.com,
loic.poulain@linaro.org, Bhaumik Bhatt <bbhatt@codeaurora.org>
Subject: [PATCH v8 9/9] bus: mhi: Improve documentation on channel transfer setup APIs
Date: Thu, 1 Apr 2021 14:16:18 -0700 [thread overview]
Message-ID: <1617311778-1254-10-git-send-email-bbhatt@codeaurora.org> (raw)
In-Reply-To: <1617311778-1254-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>
Reviewed-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.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 b16afd3..43a66e1 100644
--- a/include/linux/mhi.h
+++ b/include/linux/mhi.h
@@ -714,13 +714,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-04-01 21:16 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-04-01 21:16 Bhaumik Bhatt
2021-04-01 21:16 ` [PATCH v8 1/9] bus: mhi: core: Allow sending the STOP channel command Bhaumik Bhatt
2021-05-04 17:40 ` Jeffrey Hugo
2021-04-01 21:16 ` [PATCH v8 2/9] bus: mhi: core: Clear context for stopped channels from remove() Bhaumik Bhatt
2021-05-04 17:41 ` Jeffrey Hugo
2021-04-01 21:16 ` [PATCH v8 3/9] bus: mhi: core: Improvements to the channel handling state machine Bhaumik Bhatt
2021-04-07 6:26 ` Manivannan Sadhasivam
2021-05-04 17:43 ` Jeffrey Hugo
2021-04-01 21:16 ` [PATCH v8 4/9] bus: mhi: core: Update debug messages to use client device Bhaumik Bhatt
2021-04-07 6:27 ` Manivannan Sadhasivam
2021-05-04 17:45 ` Jeffrey Hugo
2021-04-01 21:16 ` [PATCH v8 5/9] bus: mhi: core: Hold device wake for channel update commands Bhaumik Bhatt
2021-04-07 6:31 ` Manivannan Sadhasivam
2021-05-04 17:46 ` Jeffrey Hugo
2021-04-01 21:16 ` [PATCH v8 6/9] bus: mhi: core: Clear configuration from channel context during reset Bhaumik Bhatt
2021-05-04 17:48 ` Jeffrey Hugo
2021-04-01 21:16 ` [PATCH v8 7/9] bus: mhi: core: Check channel execution environment before issuing reset Bhaumik Bhatt
2021-05-04 17:49 ` Jeffrey Hugo
2021-04-01 21:16 ` [PATCH v8 8/9] bus: mhi: core: Remove __ prefix for MHI channel unprepare function Bhaumik Bhatt
2021-05-04 17:50 ` Jeffrey Hugo
2021-04-01 21:16 ` Bhaumik Bhatt [this message]
2021-05-04 17:51 ` [PATCH v8 9/9] bus: mhi: Improve documentation on channel transfer setup APIs Jeffrey Hugo
2021-04-07 6:56 ` your mail 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=1617311778-1254-10-git-send-email-bbhatt@codeaurora.org \
--to=bbhatt@codeaurora.org \
--cc=carl.yin@quectel.com \
--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 \
--cc=naveen.kumar@quectel.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;
as well as URLs for NNTP newsgroup(s).