summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Massey <aaronmassey@google.com>2021-10-04 13:34:33 -0600
committerCommit Bot <commit-bot@chromium.org>2021-10-11 17:15:22 +0000
commit23eb06c7c2f575e1e8650eecdb7577a7cc1c6d14 (patch)
tree02715679bb67219c5a57488555f959b8b1eb74fd
parentc4dc033b6fd4874ad4fb4e230ded27463a59ead2 (diff)
downloadchrome-ec-23eb06c7c2f575e1e8650eecdb7577a7cc1c6d14.tar.gz
zephyr: drivers: ln9310 make software_enable doc more explicit
Updates documentation in ln9310_software_enable() to explicitly state it contains an alternative startup sequence that is required by older chip versions in addition to normal startup. BRANCH=none BUG=b:184856083 TEST=zmake configure --test zephyr/test/drivers Signed-off-by: Aaron Massey <aaronmassey@chromium.org> Change-Id: I976d2f35b1e392bc584cbd7e13ab34421846f679 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3200519 Commit-Queue: Aaron Massey <aaronmassey@google.com> Tested-by: Aaron Massey <aaronmassey@google.com> Reviewed-by: Yuval Peress <peress@google.com> Reviewed-by: Wai-Hong Tam <waihong@google.com>
-rw-r--r--driver/ln9310.c9
1 files changed, 5 insertions, 4 deletions
diff --git a/driver/ln9310.c b/driver/ln9310.c
index 5a46efc3bb..4214b3b514 100644
--- a/driver/ln9310.c
+++ b/driver/ln9310.c
@@ -460,10 +460,11 @@ void ln9310_software_enable(int enable)
/*
* LN9310 startup requires (nEN=0 AND STANDBY_EN=0) where nEN is a pin
* and STANDBY_EN is a register bit. Previous EC firmware set
- * STANDBY_EN=1 in ln9310_init and toggled nEN to startup/shutdown. This
- * function implements an alternate software (i.e. controlled by EC
- * through I2C commands) startup sequence so one option is to set nEN=1
- * and just used ln9310_software_enable to startup/shutdown.
+ * STANDBY_EN=1 in ln9310_init and toggled nEN to startup/shutdown. In
+ * addition to normal startup, this function also implements an
+ * alternate software (i.e. controlled by EC through I2C commands)
+ * startup sequence required by older chip versions, so one option is to
+ * set nEN=1 and just used ln9310_software_enable to startup/shutdown.
* ln9310_software_enable can also be used in conjunction w/ the nEN pin
* (in case nEN pin is desired as visible signal ) as follows:
*