diff options
| author | Denis Brockus <dbrockus@chromium.org> | 2019-11-08 07:38:01 -0700 |
|---|---|---|
| committer | Commit Bot <commit-bot@chromium.org> | 2019-11-08 21:21:14 +0000 |
| commit | 81a46885ddd6a592fc80321164781d42bba86132 (patch) | |
| tree | 29528161231b0b08f148865e111e8fbe8d387e58 /common/usbc/usb_prl_sm.c | |
| parent | 1ef8bbc6c57f9aa7c07c4a11e30772e592442282 (diff) | |
| download | chrome-ec-81a46885ddd6a592fc80321164781d42bba86132.tar.gz | |
pd: Clarify flag comments
BRANCH=none
BUG=b:141563840
TEST=make -j buildall
Change-Id: Iaff605f5d93ccce26aec4d9e33be78017c7b9231
Signed-off-by: Denis Brockus <dbrockus@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1906194
Reviewed-by: Jett Rink <jettrink@chromium.org>
Diffstat (limited to 'common/usbc/usb_prl_sm.c')
| -rw-r--r-- | common/usbc/usb_prl_sm.c | 32 |
1 files changed, 21 insertions, 11 deletions
diff --git a/common/usbc/usb_prl_sm.c b/common/usbc/usb_prl_sm.c index 74f2864533..00460d86cb 100644 --- a/common/usbc/usb_prl_sm.c +++ b/common/usbc/usb_prl_sm.c @@ -58,18 +58,28 @@ * These flags are used in multiple state machines and could have * different meanings in each state machine. */ -#define PRL_FLAGS_TX_COMPLETE BIT(0) /* Transmit complete */ -#define PRL_FLAGS_START_AMS BIT(1) /* Start AMS */ -#define PRL_FLAGS_END_AMS BIT(2) /* End AMS */ -#define PRL_FLAGS_TX_ERROR BIT(3) /* TX error occurred */ -#define PRL_FLAGS_PE_HARD_RESET BIT(4) /* PE triggered Hard Reset */ -#define PRL_FLAGS_HARD_RESET_COMPLETE BIT(5) /* Hard reset complete */ -#define PRL_FLAGS_PORT_PARTNER_HARD_RESET BIT(6) /* Partner sent hard reset */ -/* Triggers a message transmission */ +/* Flag to note message transmission completed */ +#define PRL_FLAGS_TX_COMPLETE BIT(0) +/* Flag to note an AMS is being started by PE */ +#define PRL_FLAGS_START_AMS BIT(1) +/* Flag to note an AMS is being stopped by PE */ +#define PRL_FLAGS_END_AMS BIT(2) +/* Flag to note transmission error occurred */ +#define PRL_FLAGS_TX_ERROR BIT(3) +/* Flag to note PE triggered a hard reset */ +#define PRL_FLAGS_PE_HARD_RESET BIT(4) +/* Flag to note hard reset has completed */ +#define PRL_FLAGS_HARD_RESET_COMPLETE BIT(5) +/* Flag to note port partner sent a hard reset */ +#define PRL_FLAGS_PORT_PARTNER_HARD_RESET BIT(6) +/* Flag to note a message transmission has been requested */ #define PRL_FLAGS_MSG_XMIT BIT(7) -#define PRL_FLAGS_MSG_RECEIVED BIT(8) /* Message was received */ -#define PRL_FLAGS_ABORT BIT(9) /* Abort sending message */ -#define PRL_FLAGS_CHUNKING BIT(10)/* Use message chunking */ +/* Flag to note a message was received */ +#define PRL_FLAGS_MSG_RECEIVED BIT(8) +/* Flag to note aborting current TX message, not currently set */ +#define PRL_FLAGS_ABORT BIT(9) +/* Flag to note current TX message uses chunking */ +#define PRL_FLAGS_CHUNKING BIT(10) /* PD counter definitions */ #define PD_MESSAGE_ID_COUNT 7 |