summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJett Rink <jettrink@chromium.org>2018-05-01 10:47:35 -0600
committerJett Rink <jettrink@chromium.org>2018-05-02 14:01:16 +0000
commit8476a6695dec25898033f9808ed365a79201f9d3 (patch)
tree808ffccb33c715a47fb8cf5082de83e59e599e91
parent38889d08196b6e84062f9577c3c191de5082b68e (diff)
downloadchrome-ec-8476a6695dec25898033f9808ed365a79201f9d3.tar.gz
usb mux: add comment describing mux_state_t
It is a combination of flags and also represents typec_mux enum. BRANCH=none BUG=none TEST=none Change-Id: Ib44f41af6c99f62d76fe29230c82b64537ff0665 Signed-off-by: Jett Rink <jettrink@chromium.org> Reviewed-on: https://chromium-review.googlesource.com/1037423 Reviewed-by: Aseda Aboagye <aaboagye@chromium.org>
-rw-r--r--include/usb_mux.h7
1 files changed, 6 insertions, 1 deletions
diff --git a/include/usb_mux.h b/include/usb_mux.h
index 71ed1140ae..54107771ed 100644
--- a/include/usb_mux.h
+++ b/include/usb_mux.h
@@ -12,7 +12,12 @@
#include "usb_charge.h"
#include "usb_pd.h"
-/* USB-C mux state */
+/*
+ * USB-C mux state
+ *
+ * A bitwise combination of the USB_PD_MUX_* flags.
+ * The bottom 2 bits also correspond to the typec_mux enum type.
+ */
typedef uint8_t mux_state_t;
/* Packing and Unpacking defines used with CONFIG_USB_PD_TCPM_TCPCI_MUX_ONLY */