From 8476a6695dec25898033f9808ed365a79201f9d3 Mon Sep 17 00:00:00 2001 From: Jett Rink Date: Tue, 1 May 2018 10:47:35 -0600 Subject: 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 Reviewed-on: https://chromium-review.googlesource.com/1037423 Reviewed-by: Aseda Aboagye --- include/usb_mux.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) 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 */ -- cgit v1.2.1