diff options
| author | Keith Short <keithshort@chromium.org> | 2019-09-05 15:22:42 -0600 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2019-09-10 15:07:07 +0000 |
| commit | 3726540f6250b4f217bbc725a30d89308c72fb44 (patch) | |
| tree | ac2ec8424f1e46555b921b392489b6da38d0a980 | |
| parent | 633e195022d29460bdcccd0b1b5562ce6dbc2e89 (diff) | |
| download | chrome-ec-3726540f6250b4f217bbc725a30d89308c72fb44.tar.gz | |
docs: Updates to USB-PD
Minor updates to the USB-PD description.
BUG=none
BRANCH=none
TEST=make buildall
Change-Id: Id428f0815027ca25d798b56f00e41b2985609417
Signed-off-by: Keith Short <keithshort@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1788245
Reviewed-by: Daisuke Nojiri <dnojiri@chromium.org>
Reviewed-by: Jett Rink <jettrink@chromium.org>
| -rw-r--r-- | docs/usb-c.md | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/docs/usb-c.md b/docs/usb-c.md index 1723ac7921..79b3145bdf 100644 --- a/docs/usb-c.md +++ b/docs/usb-c.md @@ -80,12 +80,13 @@ Modes in the EC codebase. Right now platform/ec has two different implementations of USB-C PD stack. 1. The older implementation is mainly contained within - [`usb_pd_protocol.c`](../common/usb_pd_protocol.c) -2. The newer implementation is broken up into multiple different files and - state machines + [`usb_pd_protocol.c`](../common/usb_pd_protocol.c) and + [`usb_pd_policy.c`](../common/usb_pd_policy.c) +2. The newer implementation is found under [`common/usbc`](../common/usbc) and + is broken up into multiple different files and state machines * Policy engine state machine files, `usb_pe_*_sm.c`. - * Protocol engine state machine file, `usb_prl_sm.c`. - * State machine manager file, `usb_sm.c`. + * Protocol engine state machine file, `usb_prl_*_sm.c`. + * State machine framework file, `usb_sm.c`. * Type-C physical layer state machine files, `usb_tc_*_sm.c`. * USB-C PD Task file, `usbc_task.c`. @@ -94,6 +95,9 @@ Chromebooks. For example, the older stack supports the Zinger, which is the USB-C charging device that shipped with Samus, the Google Chromebook Pixel 2. The Zinger implements the charger only side of the USB PD protocol. +To use the newer USB-C PD stack implementation, see `CONFIG_USB_SM_FRAMEWORK` +description in [config.h][config header link]. + The newer implementation only supports Chromebooks at the moment. There are multiple policy engine definitions to choose from depending on the different USB-C features the Chromebook should support. As of now, you must choose one and @@ -189,9 +193,6 @@ PPC IC. Many USB-C policies and features are gated by various `CONFIG_*` options that should be defined in `board.h` (or baseboard equivalent). -To use the newer USB-C PD stack implementation, see `CONFIG_USB_SM_FRAMEWORK` -description in [config.h][config header link]. - Most USB-C options will start with `CONFIG_USB_PD_` or `CONFIG_USBC_`. For their full descriptions see [config.h][config header link] |