bus: mhi: Improve documentation on channel transfer setup APIs
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> Link: https://lore.kernel.org/r/1617311778-1254-10-git-send-email-bbhatt@codeaurora.org Signed-off-by: Manivannan Sadhasivam <manivannan.sadhasivam@linaro.org>
This commit is contained in:
Родитель
8aaa288f70
Коммит
6731fefd95
|
@ -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);
|
||||
|
|
Загрузка…
Ссылка в новой задаче