Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
From:   Jeffrey Hugo <quic_jhugo@quicinc.com>
To:     <mani@kernel.org>, <hemantk@codeaurora.org>,
        <bbhatt@codeaurora.org>
CC:     <linux-arm-msm@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
        "Pranjal Ramajor Asha Kanojiya" <quic_pkanojiy@quicinc.com>,
        Jeffrey Hugo <quic_jhugo@quicinc.com>
Subject: [PATCH] bus: mhi: core: Update comments on mhi_prepare_for_power_up
Date:   Thu, 26 Aug 2021 10:32:55 -0600
Message-ID: <1629995575-32389-1-git-send-email-quic_jhugo@quicinc.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Type: text/plain
Precedence: bulk

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