summaryrefslogtreecommitdiff
path: root/include/usb_prl_sm.h
diff options
context:
space:
mode:
authorJett Rink <jettrink@chromium.org>2019-09-25 13:54:27 -0600
committerCommit Bot <commit-bot@chromium.org>2019-10-10 22:49:32 +0000
commit1092c786f7876745ec0d68dd52284d252e1abee5 (patch)
treef01f92fee6104f41c2aa3ba9752e2f023cf55c3b /include/usb_prl_sm.h
parent552f9e9ce218718629b8178ef12823958b2044fa (diff)
downloadchrome-ec-1092c786f7876745ec0d68dd52284d252e1abee5.tar.gz
usbc: update CRCReceiveTimer
Shorten the CRCReceiveTimer and document that either the pe send or error function will get called in response to a prl_ send message. BRANCH=none BUG=none TEST=build; Change-Id: Icc43886cadfdcd67c943b25aebfdfb55b2693ade Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/1825514 Tested-by: Denis Brockus <dbrockus@chromium.org> Commit-Queue: Denis Brockus <dbrockus@chromium.org> Reviewed-by: Denis Brockus <dbrockus@chromium.org> Reviewed-by: Edward Hill <ecgh@chromium.org>
Diffstat (limited to 'include/usb_prl_sm.h')
-rw-r--r--include/usb_prl_sm.h9
1 files changed, 6 insertions, 3 deletions
diff --git a/include/usb_prl_sm.h b/include/usb_prl_sm.h
index 32b3ba8d06..694d4fd923 100644
--- a/include/usb_prl_sm.h
+++ b/include/usb_prl_sm.h
@@ -58,7 +58,8 @@ void prl_set_rev(int port, enum pd_rev_type rev);
enum pd_rev_type prl_get_rev(int port);
/**
- * Sends a PD control message
+ * Sends a PD control message. Either pe_message_sent() or pe_report_error() is
+ * guaranteed to be called in response to this call.
*
* @param port USB-C port number
* @param type Transmit type
@@ -69,7 +70,8 @@ void prl_send_ctrl_msg(int port, enum tcpm_transmit_type type,
enum pd_ctrl_msg_type msg);
/**
- * Sends a PD data message
+ * Sends a PD data message. Either pe_message_sent() or pe_report_error() is
+ * guaranteed to be called in response to this call.
*
* @param port USB-C port number
* @param type Transmit type
@@ -80,7 +82,8 @@ void prl_send_data_msg(int port, enum tcpm_transmit_type type,
enum pd_data_msg_type msg);
/**
- * Sends a PD extended data message
+ * Sends a PD extended data message. Either pe_message_sent() or
+ * pe_report_error() is guaranteed to be called in response to this call.
*
* @param port USB-C port number
* @param type Transmit type