summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDenis Brockus <dbrockus@chromium.org>2019-08-16 08:04:11 -0600
committerCommit Bot <commit-bot@chromium.org>2019-08-23 18:04:37 +0000
commit5b3ef3d1d46f84aa20b36d4d4e92e5bbb46bc2b0 (patch)
tree8efbc90cbfdc9f7d1d99c0cc974ddd189e7c73ca
parent7f9543f3bb9019deec8c70d4c8d1d84cb7538c27 (diff)
downloadchrome-ec-5b3ef3d1d46f84aa20b36d4d4e92e5bbb46bc2b0.tar.gz
USBC PD: update usb-c doc
change new state machine file references to be up to date with the current code. BUG=none BRANCH=none TEST=none Change-Id: I4182b71bea107c4b9b852b93dcf59be5f4616f4d Signed-off-by: Denis Brockus <dbrockus@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1757086 Reviewed-by: Jett Rink <jettrink@chromium.org> Commit-Queue: Jett Rink <jettrink@chromium.org>
-rw-r--r--docs/usb-c.md9
1 files changed, 6 insertions, 3 deletions
diff --git a/docs/usb-c.md b/docs/usb-c.md
index 6952488469..1723ac7921 100644
--- a/docs/usb-c.md
+++ b/docs/usb-c.md
@@ -83,8 +83,11 @@ Right now platform/ec has two different implementations of USB-C PD stack.
[`usb_pd_protocol.c`](../common/usb_pd_protocol.c)
2. The newer implementation is broken up into multiple different files and
state machines
- * Policy engine state machine files, such as `usb_pe_*_sm.c`.
- * Type-C physical layer state machine: `usb_tc_sm.c`
+ * 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`.
+ * Type-C physical layer state machine files, `usb_tc_*_sm.c`.
+ * USB-C PD Task file, `usbc_task.c`.
The older implementation supports firmware for device types other than
Chromebooks. For example, the older stack supports the Zinger, which is the
@@ -106,7 +109,7 @@ In both older and newer implementations, the following details apply:
* The `PD_C#` task runs the state machine (old or new) for the port and
communicates with the TCPC, MUX, and PPC. This task needs a large task
stack.
- * The `PD_INT_C#` tasks runs at a higher priority than the state machine
+ * The `PD_INT_C#` tasks run at a higher priority than the state machine
task, and its sole job is to receive interrupts from the TCPC as quickly
as possible then send appropriate messages to other tasks (including
`PD_C#`). This task shouldn't need much stack space, but the i2c