[PATCH] bus: mhi: core: Update comments on mhi_prepare_for_power_up

[PATCH] bus: mhi: core: Update comments on mhi_prepare_for_power_up

[Jeffrey Hugo]

From: Pranjal Ramajor Asha Kanojiya <quic_pkanojiy@quicinc.com>

After "bus: mhi: core: Remove pre_init flag used for power purposes"
mhi_prepare_for_power_up() is no longer an optional API. All users
of MHI should call this API before power up sequence to initialize
MHI context. Update the comments on this API to make this clear.

Fixes: eee87072e2fb ("bus: mhi: core: Remove pre_init flag used for power purposes")
Signed-off-by: Pranjal Ramajor Asha Kanojiya <quic_pkanojiy@quicinc.com>
Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
---
 include/linux/mhi.h | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/include/linux/mhi.h b/include/linux/mhi.h
index 56e7934..483b852 100644
--- a/include/linux/mhi.h
+++ b/include/linux/mhi.h
@@ -617,10 +617,8 @@ int mhi_get_free_desc_count(struct mhi_device *mhi_dev,
 
 /**
  * mhi_prepare_for_power_up - Do pre-initialization before power up.
- *                            This is optional, call this before power up if
- *                            the controller does not want bus framework to
- *                            automatically free any allocated memory during
- *                            shutdown process.
+ *                            Call this before MHI power up sequence to
+ *                            initialize MHI context.
  * @mhi_cntrl: MHI controller
  */
 int mhi_prepare_for_power_up(struct mhi_controller *mhi_cntrl);
-- 
2.7.4

Re: [PATCH] bus: mhi: core: Update comments on mhi_prepare_for_power_up

[Bhaumik Bhatt]

On 2021-08-26 09:32 AM, Jeffrey Hugo wrote:
> From: Pranjal Ramajor Asha Kanojiya <quic_pkanojiy@quicinc.com>
> 
> After "bus: mhi: core: Remove pre_init flag used for power purposes"
> mhi_prepare_for_power_up() is no longer an optional API. All users
> of MHI should call this API before power up sequence to initialize
> MHI context. Update the comments on this API to make this clear.
> 
> Fixes: eee87072e2fb ("bus: mhi: core: Remove pre_init flag used for
> power purposes")
> Signed-off-by: Pranjal Ramajor Asha Kanojiya 
> <quic_pkanojiy@quicinc.com>
> Signed-off-by: Jeffrey Hugo <quic_jhugo@quicinc.com>
> ---
>  include/linux/mhi.h | 6 ++----
>  1 file changed, 2 insertions(+), 4 deletions(-)
> 
> diff --git a/include/linux/mhi.h b/include/linux/mhi.h
> index 56e7934..483b852 100644
> --- a/include/linux/mhi.h
> +++ b/include/linux/mhi.h
> @@ -617,10 +617,8 @@ int mhi_get_free_desc_count(struct mhi_device 
> *mhi_dev,
> 
>  /**
>   * mhi_prepare_for_power_up - Do pre-initialization before power up.
> - *                            This is optional, call this before power 
> up if
> - *                            the controller does not want bus 
> framework to
> - *                            automatically free any allocated memory 
> during
> - *                            shutdown process.
> + *                            Call this before MHI power up sequence 
> to
> + *                            initialize MHI context.
>   * @mhi_cntrl: MHI controller
>   */
>  int mhi_prepare_for_power_up(struct mhi_controller *mhi_cntrl);

Thanks for catching this!

Reviewed-by: Bhaumik Bhatt <bbhatt@codeaurora.org>

Adding Mani's Linaro email ID for pick-up.

Thanks,
Bhaumik
---
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora 
Forum,
a Linux Foundation Collaborative Project