summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAaron Massey <aaronmassey@google.com>2022-06-15 13:09:46 -0600
committerChromeos LUCI <chromeos-scoped@luci-project-accounts.iam.gserviceaccount.com>2022-06-15 22:04:33 +0000
commit947e505d26f2dccab0e914e6b4705fd0e9938b77 (patch)
treec5cdd51d8a8d1886865bc80ff2ac8b63ab2f941e
parentdb857eb8d8b54dab26620b20b13f691e2be94842 (diff)
downloadchrome-ec-947e505d26f2dccab0e914e6b4705fd0e9938b77.tar.gz
emul: usb common partner describes delay units
The delay parameter in the tcpci_partner_send_control_msg function desoen't describe a unit of time in the function doc. Describe the unit of time so clients don't have to delve into the implementation to find out the unit of time. BRANCH=none BUG=None TEST=zmake test test-drivers Signed-off-by: Aaron Massey <aaronmassey@google.com> Change-Id: Iaf5214fdfcf2eafb2440c1fd317521baaaa4418c Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/3708433 Reviewed-by: Jeremy Bettis <jbettis@chromium.org>
-rw-r--r--zephyr/include/emul/tcpc/emul_tcpci_partner_common.h2
1 files changed, 1 insertions, 1 deletions
diff --git a/zephyr/include/emul/tcpc/emul_tcpci_partner_common.h b/zephyr/include/emul/tcpc/emul_tcpci_partner_common.h
index 0c74f4b4ce..4988c48576 100644
--- a/zephyr/include/emul/tcpc/emul_tcpci_partner_common.h
+++ b/zephyr/include/emul/tcpc/emul_tcpci_partner_common.h
@@ -347,7 +347,7 @@ int tcpci_partner_send_control_msg(struct tcpci_partner_data *data,
* @param type Type of message
* @param data_obj Pointer to array of data objects
* @param data_obj_num Number of data objects
- * @param delay Optional delay
+ * @param delay Optional delay in milliseconds
*
* @return TCPCI_EMUL_TX_SUCCESS on success
* @return TCPCI_EMUL_TX_FAILED when TCPCI is configured to not handle