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;
Sender: bbhatt=codeaurora.org@mg.codeaurora.org
DMARC-Filter: OpenDMARC Filter v1.4.1 smtp.codeaurora.org 21DB3C4338F
From:   Bhaumik Bhatt <bbhatt@codeaurora.org>
To:     manivannan.sadhasivam@linaro.org
Cc:     linux-arm-msm@vger.kernel.org, hemantk@codeaurora.org,
        linux-kernel@vger.kernel.org, loic.poulain@linaro.org,
        quic_jhugo@quicinc.com, Bhaumik Bhatt <bbhatt@codeaurora.org>
Subject: [PATCH] bus: mhi: Update documentation for MHI error callbacks
Date:   Thu, 26 Aug 2021 14:48:24 -0700
Message-Id: <1630014504-32314-1-git-send-email-bbhatt@codeaurora.org>
Precedence: bulk

Design changes prompted redefinition of the FATAL and SYSTEM
ERROR callbacks such that FATAL ERROR should be treated as a
callback arriving from an atomic or interrupt context and taken
as an indication that the device has reset to one of the PBL
execution environments. Whereas, a SYSTEM ERROR (SYS_ERROR)
callback is sleep-capable and allowed to block such that the
controller can pursue its clean-up before core driver handles
further processing. Updated documentation for the same.

Signed-off-by: Bhaumik Bhatt <bbhatt@codeaurora.org>
---
 include/linux/mhi.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/mhi.h b/include/linux/mhi.h
index b8ca694..a8b2c25 100644
--- a/include/linux/mhi.h
+++ b/include/linux/mhi.h
@@ -31,8 +31,8 @@ struct mhi_buf_info;
  * @MHI_CB_LPM_EXIT: MHI host about to exit low power mode
  * @MHI_CB_EE_RDDM: MHI device entered RDDM exec env
  * @MHI_CB_EE_MISSION_MODE: MHI device entered Mission Mode exec env
- * @MHI_CB_SYS_ERROR: MHI device entered error state (may recover)
- * @MHI_CB_FATAL_ERROR: MHI device entered fatal error state
+ * @MHI_CB_SYS_ERROR: MHI device entered error state (uses non-atomic context)
+ * @MHI_CB_FATAL_ERROR: MHI device reset to a PBL exec env (uses atomic context)
  * @MHI_CB_BW_REQ: Received a bandwidth switch request from device
  */
 enum mhi_callback {
-- 
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project