summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJett Rink <jettrink@chromium.org>2019-06-07 10:42:50 -0600
committerJett Rink <jettrink@chromium.org>2019-07-02 15:11:46 +0000
commit587eb9d49b7642df83916f515f2d7adbafd3d1d1 (patch)
tree20bb4cd9eb8f978e19015f85d116a43795fb0526 /include
parent1fc8bb63ec847d7e36633624e50658578b5e93f4 (diff)
downloadchrome-ec-587eb9d49b7642df83916f515f2d7adbafd3d1d1.tar.gz
doc: add documentation for usb-c on platform/ec
Add documentation for common configuration and touch points that need to be considered when implementing the USB-C stack on the platform/ec codebase. BRANCH=none BUG=chromium:974302 TEST=none Change-Id: I24aef187989c14688985d3cba48a6734ee519d23 Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1648609 Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
Diffstat (limited to 'include')
-rw-r--r--include/config.h10
1 files changed, 9 insertions, 1 deletions
diff --git a/include/config.h b/include/config.h
index 9c88792f12..502fdf2598 100644
--- a/include/config.h
+++ b/include/config.h
@@ -850,7 +850,15 @@
*/
#undef CONFIG_CHARGER_BQ25710_IDCHG_LIMIT_MA
-/* Define to use Power Delivery State Machine Framework */
+/*
+ * Define to use Power Delivery State Machine Framework. Along with
+ * CONFIG_USB_SM_FRAMEWORK, you must ensure the follow options are defined to
+ * use the new statemachine for USB-C:
+ *
+ * CONFIG_USB_TYPEC_SM (defined by default)
+ * CONFIG_USB_PRL_SM (defined by default)
+ * One of CONFIG_USB_PE_* policy engine options.
+ */
#undef CONFIG_USB_SM_FRAMEWORK
/*