clk: qcom: rpmh: Add note about sleep/wake state for BCMs

The sleep/wake state doesn't need to be set here because of specific
RPMh behavior that carries over the active state when sleep/wake state
hasn't been modified. Add a note to the code so we aren't tempted to set
the sleep/wake states.

Cc: Alex Elder <elder@linaro.org>
Cc: Taniya Das <quic_tdas@quicinc.com>
Signed-off-by: Stephen Boyd <swboyd@chromium.org>
Reviewed-by: Alex Elder <elder@linaro.org>
Reviewed-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Signed-off-by: Bjorn Andersson <bjorn.andersson@linaro.org>
Link: https://lore.kernel.org/r/20220517190949.2922197-1-swboyd@chromium.org

diff --git a/drivers/clk/qcom/clk-rpmh.c b/drivers/clk/qcom/clk-rpmh.c
index aed9079823449db725012519ee29732d6fc5f5fd..c07cab6905cbf699b405596e757428e6dfc57cfe 100644 (file)
--- a/drivers/clk/qcom/clk-rpmh.c
+++ b/drivers/clk/qcom/clk-rpmh.c
@@ -274,6 +274,11 @@ static int clk_rpmh_bcm_send_cmd(struct clk_rpmh *c, bool enable)
                cmd.addr = c->res_addr;
                cmd.data = BCM_TCS_CMD(1, enable, 0, cmd_state);
 
+               /*
+                * Send only an active only state request. RPMh continues to
+                * use the active state when we're in sleep/wake state as long
+                * as the sleep/wake state has never been set.
+                */
                ret = clk_rpmh_send(c, RPMH_ACTIVE_ONLY_STATE, &cmd, enable);
                if (ret) {
                        dev_err(c->dev, "set active state of %s failed: (%d)\n",