drivers/thunderbolt/tunnel.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * Thunderbolt driver - Tunneling support
   4  *
   5  * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
   6  * Copyright (C) 2019, Intel Corporation
   7  */
   8
   9 #ifndef TB_TUNNEL_H_
  10 #define TB_TUNNEL_H_
  11
  12 #include "tb.h"
  13
  14 enum tb_tunnel_type {
  15         TB_TUNNEL_PCI,
  16         TB_TUNNEL_DP,
  17         TB_TUNNEL_DMA,
  18         TB_TUNNEL_USB3,
  19 };
  20
  21 /**
  22  * struct tb_tunnel - Tunnel between two ports
  23  * @tb: Pointer to the domain
  24  * @src_port: Source port of the tunnel
  25  * @dst_port: Destination port of the tunnel. For discovered incomplete
  26  *            tunnels may be %NULL or null adapter port instead.
  27  * @paths: All paths required by the tunnel
  28  * @npaths: Number of paths in @paths
  29  * @init: Optional tunnel specific initialization
  30  * @deinit: Optional tunnel specific de-initialization
  31  * @activate: Optional tunnel specific activation/deactivation
  32  * @consumed_bandwidth: Return how much bandwidth the tunnel consumes
  33  * @release_unused_bandwidth: Release all unused bandwidth
  34  * @reclaim_available_bandwidth: Reclaim back available bandwidth
  35  * @list: Tunnels are linked using this field
  36  * @type: Type of the tunnel
  37  * @max_up: Maximum upstream bandwidth (Mb/s) available for the tunnel.
  38  *          Only set if the bandwidth needs to be limited.
  39  * @max_down: Maximum downstream bandwidth (Mb/s) available for the tunnel.
  40  *            Only set if the bandwidth needs to be limited.
  41  * @allocated_up: Allocated upstream bandwidth (only for USB3)
  42  * @allocated_down: Allocated downstream bandwidth (only for USB3)
  43  */
  44 struct tb_tunnel {
  45         struct tb *tb;
  46         struct tb_port *src_port;
  47         struct tb_port *dst_port;
  48         struct tb_path **paths;
  49         size_t npaths;
  50         int (*init)(struct tb_tunnel *tunnel);
  51         void (*deinit)(struct tb_tunnel *tunnel);
  52         int (*activate)(struct tb_tunnel *tunnel, bool activate);
  53         int (*consumed_bandwidth)(struct tb_tunnel *tunnel, int *consumed_up,
  54                                   int *consumed_down);
  55         int (*release_unused_bandwidth)(struct tb_tunnel *tunnel);
  56         void (*reclaim_available_bandwidth)(struct tb_tunnel *tunnel,
  57                                             int *available_up,
  58                                             int *available_down);
  59         struct list_head list;
  60         enum tb_tunnel_type type;
  61         int max_up;
  62         int max_down;
  63         int allocated_up;
  64         int allocated_down;
  65 };
  66
  67 struct tb_tunnel *tb_tunnel_discover_pci(struct tb *tb, struct tb_port *down);
  68 struct tb_tunnel *tb_tunnel_alloc_pci(struct tb *tb, struct tb_port *up,
  69                                       struct tb_port *down);
  70 struct tb_tunnel *tb_tunnel_discover_dp(struct tb *tb, struct tb_port *in);
  71 struct tb_tunnel *tb_tunnel_alloc_dp(struct tb *tb, struct tb_port *in,
  72                                      struct tb_port *out, int max_up,
  73                                      int max_down);
  74 struct tb_tunnel *tb_tunnel_alloc_dma(struct tb *tb, struct tb_port *nhi,
  75                                       struct tb_port *dst, int transmit_path,
  76                                       int transmit_ring, int receive_path,
  77                                       int receive_ring);
  78 bool tb_tunnel_match_dma(const struct tb_tunnel *tunnel, int transmit_path,
  79                          int transmit_ring, int receive_path, int receive_ring);
  80 struct tb_tunnel *tb_tunnel_discover_usb3(struct tb *tb, struct tb_port *down);
  81 struct tb_tunnel *tb_tunnel_alloc_usb3(struct tb *tb, struct tb_port *up,
  82                                        struct tb_port *down, int max_up,
  83                                        int max_down);
  84
  85 void tb_tunnel_free(struct tb_tunnel *tunnel);
  86 int tb_tunnel_activate(struct tb_tunnel *tunnel);
  87 int tb_tunnel_restart(struct tb_tunnel *tunnel);
  88 void tb_tunnel_deactivate(struct tb_tunnel *tunnel);
  89 bool tb_tunnel_is_invalid(struct tb_tunnel *tunnel);
  90 bool tb_tunnel_port_on_path(const struct tb_tunnel *tunnel,
  91                             const struct tb_port *port);
  92 int tb_tunnel_consumed_bandwidth(struct tb_tunnel *tunnel, int *consumed_up,
  93                                  int *consumed_down);
  94 int tb_tunnel_release_unused_bandwidth(struct tb_tunnel *tunnel);
  95 void tb_tunnel_reclaim_available_bandwidth(struct tb_tunnel *tunnel,
  96                                            int *available_up,
  97                                            int *available_down);
  98
  99 static inline bool tb_tunnel_is_pci(const struct tb_tunnel *tunnel)
 100 {
 101         return tunnel->type == TB_TUNNEL_PCI;
 102 }
 103
 104 static inline bool tb_tunnel_is_dp(const struct tb_tunnel *tunnel)
 105 {
 106         return tunnel->type == TB_TUNNEL_DP;
 107 }
 108
 109 static inline bool tb_tunnel_is_dma(const struct tb_tunnel *tunnel)
 110 {
 111         return tunnel->type == TB_TUNNEL_DMA;
 112 }
 113
 114 static inline bool tb_tunnel_is_usb3(const struct tb_tunnel *tunnel)
 115 {
 116         return tunnel->type == TB_TUNNEL_USB3;
 117 }
 118
 119 #endif
 120