thunderbolt: Add clarifying comments about USB4 terms router and adapter
authorMika Westerberg <mika.westerberg@linux.intel.com>
Mon, 1 Feb 2021 12:03:00 +0000 (15:03 +0300)
committerMika Westerberg <mika.westerberg@linux.intel.com>
Thu, 4 Feb 2021 07:38:38 +0000 (10:38 +0300)
USB4 spec talks about routers and adapters whereas Thunderbolt 1-3
talked about CIO (Converged I/O) switches and ports. These are the same
thing but might cause confusion so add clarifying comments to struct
tb_switch and struct tb_port about the USB4 terms.

Signed-off-by: Mika Westerberg <mika.westerberg@linux.intel.com>
drivers/thunderbolt/tb.h

index 31468de..37679b5 100644 (file)
@@ -138,6 +138,8 @@ struct tb_switch_tmu {
  *
  * When the switch is being added or removed to the domain (other
  * switches) you need to have domain lock held.
+ *
+ * In USB4 terminology this structure represents a router.
  */
 struct tb_switch {
        struct device dev;
@@ -196,6 +198,9 @@ struct tb_switch {
  * @in_hopids: Currently allocated input HopIDs
  * @out_hopids: Currently allocated output HopIDs
  * @list: Used to link ports to DP resources list
+ *
+ * In USB4 terminology this structure represents an adapter (protocol or
+ * lane adapter).
  */
 struct tb_port {
        struct tb_regs_port_header config;