blob: f416e4dcda766e2edb1ec5dcfad9838f6dce043d [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Andreas Noeverd6cc51c2014-06-03 22:04:00 +02002/*
Mika Westerberg15c67842018-10-01 12:31:22 +03003 * Thunderbolt driver - bus logic (NHI independent)
Andreas Noeverd6cc51c2014-06-03 22:04:00 +02004 *
5 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
Mika Westerberg15c67842018-10-01 12:31:22 +03006 * Copyright (C) 2018, Intel Corporation
Andreas Noeverd6cc51c2014-06-03 22:04:00 +02007 */
8
9#ifndef TB_H_
10#define TB_H_
11
Mika Westerberge6b245c2017-06-06 15:25:17 +030012#include <linux/nvmem-provider.h>
Andreas Noevera25c8b22014-06-03 22:04:02 +020013#include <linux/pci.h>
Mika Westerbergd1ff7022017-10-02 13:38:34 +030014#include <linux/thunderbolt.h>
Mika Westerbergbfe778a2017-06-06 15:25:01 +030015#include <linux/uuid.h>
Andreas Noevera25c8b22014-06-03 22:04:02 +020016
17#include "tb_regs.h"
Andreas Noeverd6cc51c2014-06-03 22:04:00 +020018#include "ctl.h"
Mika Westerberg3e136762017-06-06 15:25:14 +030019#include "dma_port.h"
Andreas Noeverd6cc51c2014-06-03 22:04:00 +020020
Mika Westerberg719a5fe2020-03-05 11:37:15 +020021#define NVM_MIN_SIZE SZ_32K
22#define NVM_MAX_SIZE SZ_512K
Mika Westerberg9b383032021-04-01 16:54:15 +030023#define NVM_DATA_DWORDS 16
Mika Westerberg719a5fe2020-03-05 11:37:15 +020024
25/* Intel specific NVM offsets */
26#define NVM_DEVID 0x05
27#define NVM_VERSION 0x08
28#define NVM_FLASH_SIZE 0x45
29
Andreas Noeverd6cc51c2014-06-03 22:04:00 +020030/**
Mika Westerberg719a5fe2020-03-05 11:37:15 +020031 * struct tb_nvm - Structure holding NVM information
32 * @dev: Owner of the NVM
Mika Westerberge6b245c2017-06-06 15:25:17 +030033 * @major: Major version number of the active NVM portion
34 * @minor: Minor version number of the active NVM portion
35 * @id: Identifier used with both NVM portions
36 * @active: Active portion NVMem device
37 * @non_active: Non-active portion NVMem device
38 * @buf: Buffer where the NVM image is stored before it is written to
39 * the actual NVM flash device
40 * @buf_data_size: Number of bytes actually consumed by the new NVM
41 * image
Mika Westerberg719a5fe2020-03-05 11:37:15 +020042 * @authenticating: The device is authenticating the new NVM
Mario Limonciello4b794f82020-06-23 11:14:28 -050043 * @flushed: The image has been flushed to the storage area
Mika Westerberg719a5fe2020-03-05 11:37:15 +020044 *
45 * The user of this structure needs to handle serialization of possible
46 * concurrent access.
Mika Westerberge6b245c2017-06-06 15:25:17 +030047 */
Mika Westerberg719a5fe2020-03-05 11:37:15 +020048struct tb_nvm {
49 struct device *dev;
Mika Westerberge6b245c2017-06-06 15:25:17 +030050 u8 major;
51 u8 minor;
52 int id;
53 struct nvmem_device *active;
54 struct nvmem_device *non_active;
55 void *buf;
56 size_t buf_data_size;
57 bool authenticating;
Mario Limonciello4b794f82020-06-23 11:14:28 -050058 bool flushed;
Mika Westerberge6b245c2017-06-06 15:25:17 +030059};
60
Rajmohan Maniff3a8302021-04-12 14:01:46 +030061enum tb_nvm_write_ops {
62 WRITE_AND_AUTHENTICATE = 1,
63 WRITE_ONLY = 2,
Mika Westerberg1cbf6802021-04-12 15:25:08 +030064 AUTHENTICATE_ONLY = 3,
Rajmohan Maniff3a8302021-04-12 14:01:46 +030065};
66
Mika Westerbergf67cf492017-06-06 15:25:16 +030067#define TB_SWITCH_KEY_SIZE 32
Mika Westerbergf0342e72018-12-30 12:14:46 +020068#define TB_SWITCH_MAX_DEPTH 6
Mika Westerbergb0407982019-12-17 15:33:40 +030069#define USB4_SWITCH_MAX_DEPTH 5
Mika Westerbergf67cf492017-06-06 15:25:16 +030070
71/**
Rajmohan Manicf29b9af2019-12-17 15:33:43 +030072 * enum tb_switch_tmu_rate - TMU refresh rate
73 * @TB_SWITCH_TMU_RATE_OFF: %0 (Disable Time Sync handshake)
74 * @TB_SWITCH_TMU_RATE_HIFI: %16 us time interval between successive
75 * transmission of the Delay Request TSNOS
76 * (Time Sync Notification Ordered Set) on a Link
77 * @TB_SWITCH_TMU_RATE_NORMAL: %1 ms time interval between successive
78 * transmission of the Delay Request TSNOS on
79 * a Link
80 */
81enum tb_switch_tmu_rate {
82 TB_SWITCH_TMU_RATE_OFF = 0,
83 TB_SWITCH_TMU_RATE_HIFI = 16,
84 TB_SWITCH_TMU_RATE_NORMAL = 1000,
85};
86
87/**
88 * struct tb_switch_tmu - Structure holding switch TMU configuration
89 * @cap: Offset to the TMU capability (%0 if not found)
90 * @has_ucap: Does the switch support uni-directional mode
91 * @rate: TMU refresh rate related to upstream switch. In case of root
Gil Finea28ec0e2021-12-17 03:16:38 +020092 * switch this holds the domain rate. Reflects the HW setting.
Rajmohan Manicf29b9af2019-12-17 15:33:43 +030093 * @unidirectional: Is the TMU in uni-directional or bi-directional mode
Gil Finea28ec0e2021-12-17 03:16:38 +020094 * related to upstream switch. Don't care for root switch.
95 * Reflects the HW setting.
96 * @unidirectional_request: Is the new TMU mode: uni-directional or bi-directional
97 * that is requested to be set. Related to upstream switch.
98 * Don't care for root switch.
99 * @rate_request: TMU new refresh rate related to upstream switch that is
100 * requested to be set. In case of root switch, this holds
101 * the new domain rate that is requested to be set.
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300102 */
103struct tb_switch_tmu {
104 int cap;
105 bool has_ucap;
106 enum tb_switch_tmu_rate rate;
107 bool unidirectional;
Gil Finea28ec0e2021-12-17 03:16:38 +0200108 bool unidirectional_request;
109 enum tb_switch_tmu_rate rate_request;
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300110};
111
Gil Fine8a90e4f2021-12-17 03:16:39 +0200112enum tb_clx {
113 TB_CLX_DISABLE,
114 TB_CL0S,
115 TB_CL1,
116 TB_CL2,
117};
118
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300119/**
Andreas Noevera25c8b22014-06-03 22:04:02 +0200120 * struct tb_switch - a thunderbolt switch
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300121 * @dev: Device for the switch
122 * @config: Switch configuration
123 * @ports: Ports in this switch
Mika Westerberg3e136762017-06-06 15:25:14 +0300124 * @dma_port: If the switch has port supporting DMA configuration based
125 * mailbox this will hold the pointer to that (%NULL
Mika Westerberge6b245c2017-06-06 15:25:17 +0300126 * otherwise). If set it also means the switch has
127 * upgradeable NVM.
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300128 * @tmu: The switch TMU configuration
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300129 * @tb: Pointer to the domain the switch belongs to
130 * @uid: Unique ID of the switch
131 * @uuid: UUID of the switch (or %NULL if not supported)
132 * @vendor: Vendor ID of the switch
133 * @device: Device ID of the switch
Mika Westerberg72ee3392017-06-06 15:25:05 +0300134 * @vendor_name: Name of the vendor (or %NULL if not known)
135 * @device_name: Name of the device (or %NULL if not known)
Mika Westerberg91c0c122019-03-21 19:03:00 +0200136 * @link_speed: Speed of the link in Gb/s
137 * @link_width: Width of the link (1 or 2)
Mika Westerbergbbcf40b2020-03-04 17:09:14 +0200138 * @link_usb4: Upstream link is USB4
Mika Westerberg2c3c4192017-06-06 15:25:13 +0300139 * @generation: Switch Thunderbolt generation
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300140 * @cap_plug_events: Offset to the plug events capability (%0 if not found)
Gil Fine23ccd212021-12-17 03:16:41 +0200141 * @cap_vsec_tmu: Offset to the TMU vendor specific capability (%0 if not found)
Mika Westerberga9be5582019-01-09 16:42:12 +0200142 * @cap_lc: Offset to the link controller capability (%0 if not found)
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300143 * @is_unplugged: The switch is going away
144 * @drom: DROM of the switch (%NULL if not found)
Mika Westerberge6b245c2017-06-06 15:25:17 +0300145 * @nvm: Pointer to the NVM if the switch has one (%NULL otherwise)
146 * @no_nvm_upgrade: Prevent NVM upgrade of this switch
147 * @safe_mode: The switch is in safe-mode
Yehezkel Bernat14862ee2018-01-22 12:50:09 +0200148 * @boot: Whether the switch was already authorized on boot or not
Mika Westerberg2d8ff0b2018-07-25 11:48:39 +0300149 * @rpm: The switch supports runtime PM
Mika Westerbergf67cf492017-06-06 15:25:16 +0300150 * @authorized: Whether the switch is authorized by user or policy
Mika Westerbergf67cf492017-06-06 15:25:16 +0300151 * @security_level: Switch supported security level
Gil Fine54e41812020-06-29 20:30:52 +0300152 * @debugfs_dir: Pointer to the debugfs structure
Mika Westerbergf67cf492017-06-06 15:25:16 +0300153 * @key: Contains the key used to challenge the device or %NULL if not
154 * supported. Size of the key is %TB_SWITCH_KEY_SIZE.
155 * @connection_id: Connection ID used with ICM messaging
156 * @connection_key: Connection key used with ICM messaging
157 * @link: Root switch link this switch is connected (ICM only)
158 * @depth: Depth in the chain this switch is connected (ICM only)
Mika Westerberg4f7c2e02019-05-28 18:56:20 +0300159 * @rpm_complete: Completion used to wait for runtime resume to
160 * complete (ICM only)
Mario Limonciello1cb36292020-06-23 11:14:29 -0500161 * @quirks: Quirks used for this Thunderbolt switch
Mika Westerberg56ad3ae2021-03-10 13:34:12 +0200162 * @credit_allocation: Are the below buffer allocation parameters valid
163 * @max_usb3_credits: Router preferred number of buffers for USB 3.x
164 * @min_dp_aux_credits: Router preferred minimum number of buffers for DP AUX
165 * @min_dp_main_credits: Router preferred minimum number of buffers for DP MAIN
166 * @max_pcie_credits: Router preferred number of buffers for PCIe
167 * @max_dma_credits: Router preferred number of buffers for DMA/P2P
Gil Fine8a90e4f2021-12-17 03:16:39 +0200168 * @clx: CLx state on the upstream link of the router
Mika Westerbergf67cf492017-06-06 15:25:16 +0300169 *
170 * When the switch is being added or removed to the domain (other
Mika Westerberg09f11b62019-03-19 16:48:41 +0200171 * switches) you need to have domain lock held.
Mika Westerbergc3963a52021-02-01 15:03:00 +0300172 *
173 * In USB4 terminology this structure represents a router.
Andreas Noevera25c8b22014-06-03 22:04:02 +0200174 */
175struct tb_switch {
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300176 struct device dev;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200177 struct tb_regs_switch_header config;
178 struct tb_port *ports;
Mika Westerberg3e136762017-06-06 15:25:14 +0300179 struct tb_dma_port *dma_port;
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300180 struct tb_switch_tmu tmu;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200181 struct tb *tb;
Andreas Noeverc90553b2014-06-03 22:04:11 +0200182 u64 uid;
Christoph Hellwig7c39ffe2017-07-18 15:30:05 +0200183 uuid_t *uuid;
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300184 u16 vendor;
185 u16 device;
Mika Westerberg72ee3392017-06-06 15:25:05 +0300186 const char *vendor_name;
187 const char *device_name;
Mika Westerberg91c0c122019-03-21 19:03:00 +0200188 unsigned int link_speed;
189 unsigned int link_width;
Mika Westerbergbbcf40b2020-03-04 17:09:14 +0200190 bool link_usb4;
Mika Westerberg2c3c4192017-06-06 15:25:13 +0300191 unsigned int generation;
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300192 int cap_plug_events;
Gil Fine23ccd212021-12-17 03:16:41 +0200193 int cap_vsec_tmu;
Mika Westerberga9be5582019-01-09 16:42:12 +0200194 int cap_lc;
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300195 bool is_unplugged;
Andreas Noevercd22e732014-06-12 23:11:46 +0200196 u8 *drom;
Mika Westerberg719a5fe2020-03-05 11:37:15 +0200197 struct tb_nvm *nvm;
Mika Westerberge6b245c2017-06-06 15:25:17 +0300198 bool no_nvm_upgrade;
199 bool safe_mode;
Yehezkel Bernat14862ee2018-01-22 12:50:09 +0200200 bool boot;
Mika Westerberg2d8ff0b2018-07-25 11:48:39 +0300201 bool rpm;
Mika Westerbergf67cf492017-06-06 15:25:16 +0300202 unsigned int authorized;
Mika Westerbergf67cf492017-06-06 15:25:16 +0300203 enum tb_security_level security_level;
Gil Fine54e41812020-06-29 20:30:52 +0300204 struct dentry *debugfs_dir;
Mika Westerbergf67cf492017-06-06 15:25:16 +0300205 u8 *key;
206 u8 connection_id;
207 u8 connection_key;
208 u8 link;
209 u8 depth;
Mika Westerberg4f7c2e02019-05-28 18:56:20 +0300210 struct completion rpm_complete;
Mario Limonciello1cb36292020-06-23 11:14:29 -0500211 unsigned long quirks;
Mika Westerberg56ad3ae2021-03-10 13:34:12 +0200212 bool credit_allocation;
213 unsigned int max_usb3_credits;
214 unsigned int min_dp_aux_credits;
215 unsigned int min_dp_main_credits;
216 unsigned int max_pcie_credits;
217 unsigned int max_dma_credits;
Gil Fine8a90e4f2021-12-17 03:16:39 +0200218 enum tb_clx clx;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200219};
220
221/**
222 * struct tb_port - a thunderbolt port, part of a tb_switch
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300223 * @config: Cached port configuration read from registers
224 * @sw: Switch the port belongs to
225 * @remote: Remote port (%NULL if not connected)
226 * @xdomain: Remote host (%NULL if not connected)
227 * @cap_phy: Offset, zero if not found
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300228 * @cap_tmu: Offset of the adapter specific TMU capability (%0 if not present)
Mika Westerberg56183c82017-02-19 10:39:34 +0200229 * @cap_adap: Offset of the adapter specific capability (%0 if not present)
Mika Westerbergb0407982019-12-17 15:33:40 +0300230 * @cap_usb4: Offset to the USB4 port capability (%0 if not present)
Mika Westerbergcae5f512021-04-01 17:34:20 +0300231 * @usb4: Pointer to the USB4 port structure (only if @cap_usb4 is != %0)
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300232 * @port: Port number on switch
Nikunj A. Dadhania8824d192020-07-21 17:05:23 +0530233 * @disabled: Disabled by eeprom or enabled but not implemented
Mika Westerberg91c0c122019-03-21 19:03:00 +0200234 * @bonded: true if the port is bonded (two lanes combined as one)
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300235 * @dual_link_port: If the switch is connected using two ports, points
236 * to the other port.
237 * @link_nr: Is this primary or secondary port on the dual_link.
Mika Westerberg0b2863a2017-02-19 16:57:27 +0200238 * @in_hopids: Currently allocated input HopIDs
239 * @out_hopids: Currently allocated output HopIDs
Mika Westerberg8afe9092019-03-26 15:52:30 +0300240 * @list: Used to link ports to DP resources list
Mika Westerberg56ad3ae2021-03-10 13:34:12 +0200241 * @total_credits: Total number of buffers available for this port
242 * @ctl_credits: Buffers reserved for control path
Mika Westerberg6ed541c2021-03-22 18:09:35 +0200243 * @dma_credits: Number of credits allocated for DMA tunneling for all
244 * DMA paths through this port.
Mika Westerbergc3963a52021-02-01 15:03:00 +0300245 *
246 * In USB4 terminology this structure represents an adapter (protocol or
247 * lane adapter).
Andreas Noevera25c8b22014-06-03 22:04:02 +0200248 */
249struct tb_port {
250 struct tb_regs_port_header config;
251 struct tb_switch *sw;
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300252 struct tb_port *remote;
253 struct tb_xdomain *xdomain;
254 int cap_phy;
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300255 int cap_tmu;
Mika Westerberg56183c82017-02-19 10:39:34 +0200256 int cap_adap;
Mika Westerbergb0407982019-12-17 15:33:40 +0300257 int cap_usb4;
Mika Westerbergcae5f512021-04-01 17:34:20 +0300258 struct usb4_port *usb4;
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300259 u8 port;
260 bool disabled;
Mika Westerberg91c0c122019-03-21 19:03:00 +0200261 bool bonded;
Andreas Noevercd22e732014-06-12 23:11:46 +0200262 struct tb_port *dual_link_port;
263 u8 link_nr:1;
Mika Westerberg0b2863a2017-02-19 16:57:27 +0200264 struct ida in_hopids;
265 struct ida out_hopids;
Mika Westerberg8afe9092019-03-26 15:52:30 +0300266 struct list_head list;
Mika Westerberg56ad3ae2021-03-10 13:34:12 +0200267 unsigned int total_credits;
268 unsigned int ctl_credits;
Mika Westerberg6ed541c2021-03-22 18:09:35 +0200269 unsigned int dma_credits;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200270};
271
272/**
Mika Westerbergcae5f512021-04-01 17:34:20 +0300273 * struct usb4_port - USB4 port device
274 * @dev: Device for the port
275 * @port: Pointer to the lane 0 adapter
Rajmohan Maniccc5cb82021-04-01 18:20:17 +0300276 * @can_offline: Does the port have necessary platform support to moved
277 * it into offline mode and back
Rajmohan Mani3fb10ea2021-04-01 18:42:38 +0300278 * @offline: The port is currently in offline mode
Mika Westerbergcae5f512021-04-01 17:34:20 +0300279 */
280struct usb4_port {
281 struct device dev;
282 struct tb_port *port;
Rajmohan Maniccc5cb82021-04-01 18:20:17 +0300283 bool can_offline;
Rajmohan Mani3fb10ea2021-04-01 18:42:38 +0300284 bool offline;
Mika Westerbergcae5f512021-04-01 17:34:20 +0300285};
286
287/**
Kranthi Kuntaladacb1282020-03-05 16:39:58 +0200288 * tb_retimer: Thunderbolt retimer
289 * @dev: Device for the retimer
290 * @tb: Pointer to the domain the retimer belongs to
291 * @index: Retimer index facing the router USB4 port
292 * @vendor: Vendor ID of the retimer
293 * @device: Device ID of the retimer
294 * @port: Pointer to the lane 0 adapter
295 * @nvm: Pointer to the NVM if the retimer has one (%NULL otherwise)
296 * @auth_status: Status of last NVM authentication
297 */
298struct tb_retimer {
299 struct device dev;
300 struct tb *tb;
301 u8 index;
302 u32 vendor;
303 u32 device;
304 struct tb_port *port;
305 struct tb_nvm *nvm;
306 u32 auth_status;
307};
308
309/**
Andreas Noever520b6702014-06-03 22:04:07 +0200310 * struct tb_path_hop - routing information for a tb_path
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200311 * @in_port: Ingress port of a switch
312 * @out_port: Egress port of a switch where the packet is routed out
313 * (must be on the same switch than @in_port)
314 * @in_hop_index: HopID where the path configuration entry is placed in
315 * the path config space of @in_port.
316 * @in_counter_index: Used counter index (not used in the driver
317 * currently, %-1 to disable)
318 * @next_hop_index: HopID of the packet when it is routed out from @out_port
Mika Westerberg0414bec2017-02-19 23:43:26 +0200319 * @initial_credits: Number of initial flow control credits allocated for
320 * the path
Mika Westerberg02c5e7c2020-12-10 16:07:59 +0200321 * @nfc_credits: Number of non-flow controlled buffers allocated for the
322 * @in_port.
Andreas Noever520b6702014-06-03 22:04:07 +0200323 *
324 * Hop configuration is always done on the IN port of a switch.
325 * in_port and out_port have to be on the same switch. Packets arriving on
326 * in_port with "hop" = in_hop_index will get routed to through out_port. The
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200327 * next hop to take (on out_port->remote) is determined by
328 * next_hop_index. When routing packet to another switch (out->remote is
329 * set) the @next_hop_index must match the @in_hop_index of that next
330 * hop to make routing possible.
Andreas Noever520b6702014-06-03 22:04:07 +0200331 *
332 * in_counter_index is the index of a counter (in TB_CFG_COUNTERS) on the in
333 * port.
334 */
335struct tb_path_hop {
336 struct tb_port *in_port;
337 struct tb_port *out_port;
338 int in_hop_index;
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200339 int in_counter_index;
Andreas Noever520b6702014-06-03 22:04:07 +0200340 int next_hop_index;
Mika Westerberg0414bec2017-02-19 23:43:26 +0200341 unsigned int initial_credits;
Mika Westerberg02c5e7c2020-12-10 16:07:59 +0200342 unsigned int nfc_credits;
Andreas Noever520b6702014-06-03 22:04:07 +0200343};
344
345/**
346 * enum tb_path_port - path options mask
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200347 * @TB_PATH_NONE: Do not activate on any hop on path
348 * @TB_PATH_SOURCE: Activate on the first hop (out of src)
349 * @TB_PATH_INTERNAL: Activate on the intermediate hops (not the first/last)
350 * @TB_PATH_DESTINATION: Activate on the last hop (into dst)
351 * @TB_PATH_ALL: Activate on all hops on the path
Andreas Noever520b6702014-06-03 22:04:07 +0200352 */
353enum tb_path_port {
354 TB_PATH_NONE = 0,
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200355 TB_PATH_SOURCE = 1,
356 TB_PATH_INTERNAL = 2,
357 TB_PATH_DESTINATION = 4,
Andreas Noever520b6702014-06-03 22:04:07 +0200358 TB_PATH_ALL = 7,
359};
360
361/**
362 * struct tb_path - a unidirectional path between two ports
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200363 * @tb: Pointer to the domain structure
364 * @name: Name of the path (used for debugging)
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200365 * @ingress_shared_buffer: Shared buffering used for ingress ports on the path
366 * @egress_shared_buffer: Shared buffering used for egress ports on the path
367 * @ingress_fc_enable: Flow control for ingress ports on the path
368 * @egress_fc_enable: Flow control for egress ports on the path
369 * @priority: Priority group if the path
370 * @weight: Weight of the path inside the priority group
371 * @drop_packages: Drop packages from queue tail or head
372 * @activated: Is the path active
Mika Westerberg44242d62018-09-28 16:35:32 +0300373 * @clear_fc: Clear all flow control from the path config space entries
374 * when deactivating this path
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200375 * @hops: Path hops
376 * @path_length: How many hops the path uses
Mika Westerberg43bddb22021-11-14 17:20:59 +0200377 * @alloc_hopid: Does this path consume port HopID
Andreas Noever520b6702014-06-03 22:04:07 +0200378 *
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200379 * A path consists of a number of hops (see &struct tb_path_hop). To
380 * establish a PCIe tunnel two paths have to be created between the two
381 * PCIe ports.
Andreas Noever520b6702014-06-03 22:04:07 +0200382 */
383struct tb_path {
384 struct tb *tb;
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200385 const char *name;
Andreas Noever520b6702014-06-03 22:04:07 +0200386 enum tb_path_port ingress_shared_buffer;
387 enum tb_path_port egress_shared_buffer;
388 enum tb_path_port ingress_fc_enable;
389 enum tb_path_port egress_fc_enable;
390
Nathan Chancellor37209782019-04-24 11:34:13 -0700391 unsigned int priority:3;
Andreas Noever520b6702014-06-03 22:04:07 +0200392 int weight:4;
393 bool drop_packages;
394 bool activated;
Mika Westerberg44242d62018-09-28 16:35:32 +0300395 bool clear_fc;
Andreas Noever520b6702014-06-03 22:04:07 +0200396 struct tb_path_hop *hops;
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +0200397 int path_length;
Mika Westerberg43bddb22021-11-14 17:20:59 +0200398 bool alloc_hopid;
Andreas Noever520b6702014-06-03 22:04:07 +0200399};
400
Mika Westerberg0b2863a2017-02-19 16:57:27 +0200401/* HopIDs 0-7 are reserved by the Thunderbolt protocol */
402#define TB_PATH_MIN_HOPID 8
Mika Westerbergc738a792020-05-08 11:47:00 +0300403/*
404 * Support paths from the farthest (depth 6) router to the host and back
405 * to the same level (not necessarily to the same router).
406 */
407#define TB_PATH_MAX_HOPS (7 * 2)
Mika Westerberg0b2863a2017-02-19 16:57:27 +0200408
Mika Westerbergb2911a52019-12-06 18:36:07 +0200409/* Possible wake types */
410#define TB_WAKE_ON_CONNECT BIT(0)
411#define TB_WAKE_ON_DISCONNECT BIT(1)
412#define TB_WAKE_ON_USB4 BIT(2)
413#define TB_WAKE_ON_USB3 BIT(3)
414#define TB_WAKE_ON_PCIE BIT(4)
Mika Westerberg6026b702021-01-14 16:44:17 +0200415#define TB_WAKE_ON_DP BIT(5)
Mika Westerbergb2911a52019-12-06 18:36:07 +0200416
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300417/**
418 * struct tb_cm_ops - Connection manager specific operations vector
Mika Westerbergf67cf492017-06-06 15:25:16 +0300419 * @driver_ready: Called right after control channel is started. Used by
420 * ICM to send driver ready message to the firmware.
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300421 * @start: Starts the domain
422 * @stop: Stops the domain
423 * @suspend_noirq: Connection manager specific suspend_noirq
424 * @resume_noirq: Connection manager specific resume_noirq
Mika Westerbergf67cf492017-06-06 15:25:16 +0300425 * @suspend: Connection manager specific suspend
Mika Westerberg884e4d52020-08-31 13:05:14 +0300426 * @freeze_noirq: Connection manager specific freeze_noirq
427 * @thaw_noirq: Connection manager specific thaw_noirq
Mika Westerbergf67cf492017-06-06 15:25:16 +0300428 * @complete: Connection manager specific complete
Mika Westerberg2d8ff0b2018-07-25 11:48:39 +0300429 * @runtime_suspend: Connection manager specific runtime_suspend
430 * @runtime_resume: Connection manager specific runtime_resume
Mika Westerberg4f7c2e02019-05-28 18:56:20 +0300431 * @runtime_suspend_switch: Runtime suspend a switch
432 * @runtime_resume_switch: Runtime resume a switch
Mika Westerberg81a54b52017-06-06 15:25:09 +0300433 * @handle_event: Handle thunderbolt event
Mika Westerberg9aaa3b82018-01-21 12:08:04 +0200434 * @get_boot_acl: Get boot ACL list
435 * @set_boot_acl: Set boot ACL list
Mika Westerberg3da88be2020-11-10 11:47:14 +0300436 * @disapprove_switch: Disapprove switch (disconnect PCIe tunnel)
Mika Westerbergf67cf492017-06-06 15:25:16 +0300437 * @approve_switch: Approve switch
438 * @add_switch_key: Add key to switch
439 * @challenge_switch_key: Challenge switch using key
Mika Westerberge6b245c2017-06-06 15:25:17 +0300440 * @disconnect_pcie_paths: Disconnects PCIe paths before NVM update
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300441 * @approve_xdomain_paths: Approve (establish) XDomain DMA paths
442 * @disconnect_xdomain_paths: Disconnect XDomain DMA paths
Mika Westerberg9490f712020-11-03 13:58:00 +0200443 * @usb4_switch_op: Optional proxy for USB4 router operations. If set
444 * this will be called whenever USB4 router operation is
445 * performed. If this returns %-EOPNOTSUPP then the
446 * native USB4 router operation is called.
447 * @usb4_switch_nvm_authenticate_status: Optional callback that the CM
448 * implementation can be used to
449 * return status of USB4 NVM_AUTH
450 * router operation.
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300451 */
452struct tb_cm_ops {
Mika Westerbergf67cf492017-06-06 15:25:16 +0300453 int (*driver_ready)(struct tb *tb);
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300454 int (*start)(struct tb *tb);
455 void (*stop)(struct tb *tb);
456 int (*suspend_noirq)(struct tb *tb);
457 int (*resume_noirq)(struct tb *tb);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300458 int (*suspend)(struct tb *tb);
Mika Westerberg884e4d52020-08-31 13:05:14 +0300459 int (*freeze_noirq)(struct tb *tb);
460 int (*thaw_noirq)(struct tb *tb);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300461 void (*complete)(struct tb *tb);
Mika Westerberg2d8ff0b2018-07-25 11:48:39 +0300462 int (*runtime_suspend)(struct tb *tb);
463 int (*runtime_resume)(struct tb *tb);
Mika Westerberg4f7c2e02019-05-28 18:56:20 +0300464 int (*runtime_suspend_switch)(struct tb_switch *sw);
465 int (*runtime_resume_switch)(struct tb_switch *sw);
Mika Westerberg81a54b52017-06-06 15:25:09 +0300466 void (*handle_event)(struct tb *tb, enum tb_cfg_pkg_type,
467 const void *buf, size_t size);
Mika Westerberg9aaa3b82018-01-21 12:08:04 +0200468 int (*get_boot_acl)(struct tb *tb, uuid_t *uuids, size_t nuuids);
469 int (*set_boot_acl)(struct tb *tb, const uuid_t *uuids, size_t nuuids);
Mika Westerberg3da88be2020-11-10 11:47:14 +0300470 int (*disapprove_switch)(struct tb *tb, struct tb_switch *sw);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300471 int (*approve_switch)(struct tb *tb, struct tb_switch *sw);
472 int (*add_switch_key)(struct tb *tb, struct tb_switch *sw);
473 int (*challenge_switch_key)(struct tb *tb, struct tb_switch *sw,
474 const u8 *challenge, u8 *response);
Mika Westerberge6b245c2017-06-06 15:25:17 +0300475 int (*disconnect_pcie_paths)(struct tb *tb);
Mika Westerberg180b0682021-01-08 16:25:39 +0200476 int (*approve_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
477 int transmit_path, int transmit_ring,
478 int receive_path, int receive_ring);
479 int (*disconnect_xdomain_paths)(struct tb *tb, struct tb_xdomain *xd,
480 int transmit_path, int transmit_ring,
481 int receive_path, int receive_ring);
Mika Westerberg9490f712020-11-03 13:58:00 +0200482 int (*usb4_switch_op)(struct tb_switch *sw, u16 opcode, u32 *metadata,
483 u8 *status, const void *tx_data, size_t tx_data_len,
484 void *rx_data, size_t rx_data_len);
485 int (*usb4_switch_nvm_authenticate_status)(struct tb_switch *sw,
486 u32 *status);
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300487};
Andreas Noever520b6702014-06-03 22:04:07 +0200488
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300489static inline void *tb_priv(struct tb *tb)
490{
491 return (void *)tb->privdata;
492}
493
Mika Westerberg2d8ff0b2018-07-25 11:48:39 +0300494#define TB_AUTOSUSPEND_DELAY 15000 /* ms */
495
Andreas Noevera25c8b22014-06-03 22:04:02 +0200496/* helper functions & macros */
497
498/**
499 * tb_upstream_port() - return the upstream port of a switch
500 *
501 * Every switch has an upstream port (for the root switch it is the NHI).
502 *
503 * During switch alloc/init tb_upstream_port()->remote may be NULL, even for
504 * non root switches (on the NHI port remote is always NULL).
505 *
506 * Return: Returns the upstream port of the switch.
507 */
508static inline struct tb_port *tb_upstream_port(struct tb_switch *sw)
509{
510 return &sw->ports[sw->config.upstream_port_number];
511}
512
Mika Westerbergdfe40ca2019-03-07 15:26:45 +0200513/**
514 * tb_is_upstream_port() - Is the port upstream facing
515 * @port: Port to check
516 *
517 * Returns true if @port is upstream facing port. In case of dual link
518 * ports both return true.
519 */
520static inline bool tb_is_upstream_port(const struct tb_port *port)
521{
522 const struct tb_port *upstream_port = tb_upstream_port(port->sw);
523 return port == upstream_port || port->dual_link_port == upstream_port;
524}
525
Mika Westerbergb323a982019-03-06 19:23:38 +0200526static inline u64 tb_route(const struct tb_switch *sw)
Andreas Noevera25c8b22014-06-03 22:04:02 +0200527{
528 return ((u64) sw->config.route_hi) << 32 | sw->config.route_lo;
529}
530
Mika Westerbergf67cf492017-06-06 15:25:16 +0300531static inline struct tb_port *tb_port_at(u64 route, struct tb_switch *sw)
532{
533 u8 port;
534
535 port = route >> (sw->config.depth * 8);
536 if (WARN_ON(port > sw->config.max_port_number))
537 return NULL;
538 return &sw->ports[port];
539}
540
Mika Westerbergdfe40ca2019-03-07 15:26:45 +0200541/**
542 * tb_port_has_remote() - Does the port have switch connected downstream
543 * @port: Port to check
544 *
545 * Returns true only when the port is primary port and has remote set.
546 */
547static inline bool tb_port_has_remote(const struct tb_port *port)
548{
549 if (tb_is_upstream_port(port))
550 return false;
551 if (!port->remote)
552 return false;
553 if (port->dual_link_port && port->link_nr)
554 return false;
555
556 return true;
557}
558
Mika Westerberg344e0642017-10-11 17:19:54 +0300559static inline bool tb_port_is_null(const struct tb_port *port)
560{
561 return port && port->port && port->config.type == TB_TYPE_PORT;
562}
563
Mika Westerberga3cfebd2020-07-25 10:32:46 +0300564static inline bool tb_port_is_nhi(const struct tb_port *port)
565{
566 return port && port->config.type == TB_TYPE_NHI;
567}
568
Mika Westerberg99cabbb2018-12-30 21:34:08 +0200569static inline bool tb_port_is_pcie_down(const struct tb_port *port)
570{
571 return port && port->config.type == TB_TYPE_PCIE_DOWN;
572}
573
Mika Westerberg0414bec2017-02-19 23:43:26 +0200574static inline bool tb_port_is_pcie_up(const struct tb_port *port)
575{
576 return port && port->config.type == TB_TYPE_PCIE_UP;
577}
578
Mika Westerberg4f807e42018-09-17 16:30:49 +0300579static inline bool tb_port_is_dpin(const struct tb_port *port)
580{
581 return port && port->config.type == TB_TYPE_DP_HDMI_IN;
582}
583
584static inline bool tb_port_is_dpout(const struct tb_port *port)
585{
586 return port && port->config.type == TB_TYPE_DP_HDMI_OUT;
587}
588
Rajmohan Manie6f81852019-12-17 15:33:44 +0300589static inline bool tb_port_is_usb3_down(const struct tb_port *port)
590{
591 return port && port->config.type == TB_TYPE_USB3_DOWN;
592}
593
594static inline bool tb_port_is_usb3_up(const struct tb_port *port)
595{
596 return port && port->config.type == TB_TYPE_USB3_UP;
597}
598
Andreas Noevera25c8b22014-06-03 22:04:02 +0200599static inline int tb_sw_read(struct tb_switch *sw, void *buffer,
600 enum tb_cfg_space space, u32 offset, u32 length)
601{
Mika Westerberg47083842019-03-19 17:07:37 +0200602 if (sw->is_unplugged)
603 return -ENODEV;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200604 return tb_cfg_read(sw->tb->ctl,
605 buffer,
606 tb_route(sw),
607 0,
608 space,
609 offset,
610 length);
611}
612
Mika Westerberg826c6a12019-07-01 18:41:51 +0300613static inline int tb_sw_write(struct tb_switch *sw, const void *buffer,
Andreas Noevera25c8b22014-06-03 22:04:02 +0200614 enum tb_cfg_space space, u32 offset, u32 length)
615{
Mika Westerberg47083842019-03-19 17:07:37 +0200616 if (sw->is_unplugged)
617 return -ENODEV;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200618 return tb_cfg_write(sw->tb->ctl,
619 buffer,
620 tb_route(sw),
621 0,
622 space,
623 offset,
624 length);
625}
626
627static inline int tb_port_read(struct tb_port *port, void *buffer,
628 enum tb_cfg_space space, u32 offset, u32 length)
629{
Mika Westerberg47083842019-03-19 17:07:37 +0200630 if (port->sw->is_unplugged)
631 return -ENODEV;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200632 return tb_cfg_read(port->sw->tb->ctl,
633 buffer,
634 tb_route(port->sw),
635 port->port,
636 space,
637 offset,
638 length);
639}
640
Mika Westerberg16a12582017-06-06 15:24:53 +0300641static inline int tb_port_write(struct tb_port *port, const void *buffer,
Andreas Noevera25c8b22014-06-03 22:04:02 +0200642 enum tb_cfg_space space, u32 offset, u32 length)
643{
Mika Westerberg47083842019-03-19 17:07:37 +0200644 if (port->sw->is_unplugged)
645 return -ENODEV;
Andreas Noevera25c8b22014-06-03 22:04:02 +0200646 return tb_cfg_write(port->sw->tb->ctl,
647 buffer,
648 tb_route(port->sw),
649 port->port,
650 space,
651 offset,
652 length);
653}
654
655#define tb_err(tb, fmt, arg...) dev_err(&(tb)->nhi->pdev->dev, fmt, ## arg)
656#define tb_WARN(tb, fmt, arg...) dev_WARN(&(tb)->nhi->pdev->dev, fmt, ## arg)
657#define tb_warn(tb, fmt, arg...) dev_warn(&(tb)->nhi->pdev->dev, fmt, ## arg)
658#define tb_info(tb, fmt, arg...) dev_info(&(tb)->nhi->pdev->dev, fmt, ## arg)
Mika Westerbergdaa51402018-10-01 12:31:19 +0300659#define tb_dbg(tb, fmt, arg...) dev_dbg(&(tb)->nhi->pdev->dev, fmt, ## arg)
Andreas Noevera25c8b22014-06-03 22:04:02 +0200660
661#define __TB_SW_PRINT(level, sw, fmt, arg...) \
662 do { \
Mika Westerbergb323a982019-03-06 19:23:38 +0200663 const struct tb_switch *__sw = (sw); \
Andreas Noevera25c8b22014-06-03 22:04:02 +0200664 level(__sw->tb, "%llx: " fmt, \
665 tb_route(__sw), ## arg); \
666 } while (0)
667#define tb_sw_WARN(sw, fmt, arg...) __TB_SW_PRINT(tb_WARN, sw, fmt, ##arg)
668#define tb_sw_warn(sw, fmt, arg...) __TB_SW_PRINT(tb_warn, sw, fmt, ##arg)
669#define tb_sw_info(sw, fmt, arg...) __TB_SW_PRINT(tb_info, sw, fmt, ##arg)
Mika Westerbergdaa51402018-10-01 12:31:19 +0300670#define tb_sw_dbg(sw, fmt, arg...) __TB_SW_PRINT(tb_dbg, sw, fmt, ##arg)
Andreas Noevera25c8b22014-06-03 22:04:02 +0200671
672#define __TB_PORT_PRINT(level, _port, fmt, arg...) \
673 do { \
Mika Westerbergb323a982019-03-06 19:23:38 +0200674 const struct tb_port *__port = (_port); \
Andreas Noevera25c8b22014-06-03 22:04:02 +0200675 level(__port->sw->tb, "%llx:%x: " fmt, \
676 tb_route(__port->sw), __port->port, ## arg); \
677 } while (0)
678#define tb_port_WARN(port, fmt, arg...) \
679 __TB_PORT_PRINT(tb_WARN, port, fmt, ##arg)
680#define tb_port_warn(port, fmt, arg...) \
681 __TB_PORT_PRINT(tb_warn, port, fmt, ##arg)
682#define tb_port_info(port, fmt, arg...) \
683 __TB_PORT_PRINT(tb_info, port, fmt, ##arg)
Mika Westerbergdaa51402018-10-01 12:31:19 +0300684#define tb_port_dbg(port, fmt, arg...) \
685 __TB_PORT_PRINT(tb_dbg, port, fmt, ##arg)
Andreas Noevera25c8b22014-06-03 22:04:02 +0200686
Mika Westerbergf67cf492017-06-06 15:25:16 +0300687struct tb *icm_probe(struct tb_nhi *nhi);
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300688struct tb *tb_probe(struct tb_nhi *nhi);
Andreas Noevera25c8b22014-06-03 22:04:02 +0200689
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300690extern struct device_type tb_domain_type;
Kranthi Kuntaladacb1282020-03-05 16:39:58 +0200691extern struct device_type tb_retimer_type;
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300692extern struct device_type tb_switch_type;
Mika Westerbergcae5f512021-04-01 17:34:20 +0300693extern struct device_type usb4_port_device_type;
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300694
695int tb_domain_init(void);
696void tb_domain_exit(void);
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300697int tb_xdomain_init(void);
698void tb_xdomain_exit(void);
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300699
Mika Westerberg7f0a34d2020-12-29 13:44:57 +0200700struct tb *tb_domain_alloc(struct tb_nhi *nhi, int timeout_msec, size_t privsize);
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300701int tb_domain_add(struct tb *tb);
702void tb_domain_remove(struct tb *tb);
703int tb_domain_suspend_noirq(struct tb *tb);
704int tb_domain_resume_noirq(struct tb *tb);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300705int tb_domain_suspend(struct tb *tb);
Mika Westerberg884e4d52020-08-31 13:05:14 +0300706int tb_domain_freeze_noirq(struct tb *tb);
707int tb_domain_thaw_noirq(struct tb *tb);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300708void tb_domain_complete(struct tb *tb);
Mika Westerberg2d8ff0b2018-07-25 11:48:39 +0300709int tb_domain_runtime_suspend(struct tb *tb);
710int tb_domain_runtime_resume(struct tb *tb);
Mika Westerberg3da88be2020-11-10 11:47:14 +0300711int tb_domain_disapprove_switch(struct tb *tb, struct tb_switch *sw);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300712int tb_domain_approve_switch(struct tb *tb, struct tb_switch *sw);
713int tb_domain_approve_switch_key(struct tb *tb, struct tb_switch *sw);
714int tb_domain_challenge_switch_key(struct tb *tb, struct tb_switch *sw);
Mika Westerberge6b245c2017-06-06 15:25:17 +0300715int tb_domain_disconnect_pcie_paths(struct tb *tb);
Mika Westerberg180b0682021-01-08 16:25:39 +0200716int tb_domain_approve_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
717 int transmit_path, int transmit_ring,
718 int receive_path, int receive_ring);
719int tb_domain_disconnect_xdomain_paths(struct tb *tb, struct tb_xdomain *xd,
720 int transmit_path, int transmit_ring,
721 int receive_path, int receive_ring);
Mika Westerbergd1ff7022017-10-02 13:38:34 +0300722int tb_domain_disconnect_all_paths(struct tb *tb);
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300723
Mika Westerberg559c1e12018-10-22 14:47:01 +0300724static inline struct tb *tb_domain_get(struct tb *tb)
725{
726 if (tb)
727 get_device(&tb->dev);
728 return tb;
729}
730
Mika Westerberg9d3cce02017-06-06 15:25:00 +0300731static inline void tb_domain_put(struct tb *tb)
732{
733 put_device(&tb->dev);
734}
Andreas Noeverd6cc51c2014-06-03 22:04:00 +0200735
Mika Westerberg719a5fe2020-03-05 11:37:15 +0200736struct tb_nvm *tb_nvm_alloc(struct device *dev);
737int tb_nvm_add_active(struct tb_nvm *nvm, size_t size, nvmem_reg_read_t reg_read);
738int tb_nvm_write_buf(struct tb_nvm *nvm, unsigned int offset, void *val,
739 size_t bytes);
740int tb_nvm_add_non_active(struct tb_nvm *nvm, size_t size,
741 nvmem_reg_write_t reg_write);
742void tb_nvm_free(struct tb_nvm *nvm);
743void tb_nvm_exit(void);
744
Mika Westerberg9b383032021-04-01 16:54:15 +0300745typedef int (*read_block_fn)(void *, unsigned int, void *, size_t);
746typedef int (*write_block_fn)(void *, unsigned int, const void *, size_t);
747
748int tb_nvm_read_data(unsigned int address, void *buf, size_t size,
749 unsigned int retries, read_block_fn read_block,
750 void *read_block_data);
751int tb_nvm_write_data(unsigned int address, const void *buf, size_t size,
752 unsigned int retries, write_block_fn write_next_block,
753 void *write_block_data);
754
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300755struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
756 u64 route);
Mika Westerberge6b245c2017-06-06 15:25:17 +0300757struct tb_switch *tb_switch_alloc_safe_mode(struct tb *tb,
758 struct device *parent, u64 route);
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300759int tb_switch_configure(struct tb_switch *sw);
760int tb_switch_add(struct tb_switch *sw);
761void tb_switch_remove(struct tb_switch *sw);
Mika Westerberg6ac6fae2020-06-05 14:25:02 +0300762void tb_switch_suspend(struct tb_switch *sw, bool runtime);
Andreas Noever23dd5bb2014-06-03 22:04:12 +0200763int tb_switch_resume(struct tb_switch *sw);
Mika Westerberg356b6c42019-09-19 15:25:30 +0300764int tb_switch_reset(struct tb_switch *sw);
Gil Fine16396642021-12-17 03:16:40 +0200765int tb_switch_wait_for_bit(struct tb_switch *sw, u32 offset, u32 bit,
766 u32 value, int timeout_msec);
Lukas Wunneraae20bb2016-03-20 13:57:20 +0100767void tb_sw_set_unplugged(struct tb_switch *sw);
Mika Westerberg386e5e22019-12-17 15:33:37 +0300768struct tb_port *tb_switch_find_port(struct tb_switch *sw,
769 enum tb_port_type type);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300770struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link,
771 u8 depth);
Christoph Hellwig7c39ffe2017-07-18 15:30:05 +0200772struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid);
Radion Mirchevsky8e9267b2017-10-04 15:24:14 +0300773struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route);
Mika Westerbergf67cf492017-06-06 15:25:16 +0300774
Mika Westerbergb433d012019-09-30 14:07:22 +0300775/**
776 * tb_switch_for_each_port() - Iterate over each switch port
777 * @sw: Switch whose ports to iterate
778 * @p: Port used as iterator
779 *
780 * Iterates over each switch port skipping the control port (port %0).
781 */
782#define tb_switch_for_each_port(sw, p) \
783 for ((p) = &(sw)->ports[1]; \
784 (p) <= &(sw)->ports[(sw)->config.max_port_number]; (p)++)
785
Mika Westerbergb6b0ea72017-10-04 15:19:20 +0300786static inline struct tb_switch *tb_switch_get(struct tb_switch *sw)
787{
788 if (sw)
789 get_device(&sw->dev);
790 return sw;
791}
792
Mika Westerbergbfe778a2017-06-06 15:25:01 +0300793static inline void tb_switch_put(struct tb_switch *sw)
794{
795 put_device(&sw->dev);
796}
797
798static inline bool tb_is_switch(const struct device *dev)
799{
800 return dev->type == &tb_switch_type;
801}
802
803static inline struct tb_switch *tb_to_switch(struct device *dev)
804{
805 if (tb_is_switch(dev))
806 return container_of(dev, struct tb_switch, dev);
807 return NULL;
808}
809
Mika Westerberg0414bec2017-02-19 23:43:26 +0200810static inline struct tb_switch *tb_switch_parent(struct tb_switch *sw)
811{
812 return tb_to_switch(sw->dev.parent);
813}
814
Mika Westerberg17a8f812019-10-08 16:42:47 +0300815static inline bool tb_switch_is_light_ridge(const struct tb_switch *sw)
Mika Westerberg8b0110d2019-01-08 18:55:09 +0200816{
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300817 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
818 sw->config.device_id == PCI_DEVICE_ID_INTEL_LIGHT_RIDGE;
Mika Westerberg8b0110d2019-01-08 18:55:09 +0200819}
820
Mika Westerberg17a8f812019-10-08 16:42:47 +0300821static inline bool tb_switch_is_eagle_ridge(const struct tb_switch *sw)
Mika Westerberg8b0110d2019-01-08 18:55:09 +0200822{
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300823 return sw->config.vendor_id == PCI_VENDOR_ID_INTEL &&
824 sw->config.device_id == PCI_DEVICE_ID_INTEL_EAGLE_RIDGE;
Mika Westerberg8b0110d2019-01-08 18:55:09 +0200825}
826
Mika Westerberg17a8f812019-10-08 16:42:47 +0300827static inline bool tb_switch_is_cactus_ridge(const struct tb_switch *sw)
Mika Westerberg99cabbb2018-12-30 21:34:08 +0200828{
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300829 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
830 switch (sw->config.device_id) {
831 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
832 case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
833 return true;
834 }
Mika Westerberg99cabbb2018-12-30 21:34:08 +0200835 }
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300836 return false;
Mika Westerberg99cabbb2018-12-30 21:34:08 +0200837}
838
Mika Westerberg17a8f812019-10-08 16:42:47 +0300839static inline bool tb_switch_is_falcon_ridge(const struct tb_switch *sw)
Mika Westerberg99cabbb2018-12-30 21:34:08 +0200840{
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300841 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
842 switch (sw->config.device_id) {
843 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
844 case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
845 return true;
846 }
Mika Westerberg99cabbb2018-12-30 21:34:08 +0200847 }
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300848 return false;
Mika Westerberg99cabbb2018-12-30 21:34:08 +0200849}
850
Mika Westerberg7bffd97e2019-03-22 15:16:53 +0200851static inline bool tb_switch_is_alpine_ridge(const struct tb_switch *sw)
852{
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300853 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
854 switch (sw->config.device_id) {
855 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
856 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
857 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
858 case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
859 return true;
860 }
Mika Westerberg7bffd97e2019-03-22 15:16:53 +0200861 }
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300862 return false;
Mika Westerberg7bffd97e2019-03-22 15:16:53 +0200863}
864
865static inline bool tb_switch_is_titan_ridge(const struct tb_switch *sw)
866{
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300867 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
868 switch (sw->config.device_id) {
869 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
870 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
871 case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
872 return true;
873 }
Mika Westerberg7bffd97e2019-03-22 15:16:53 +0200874 }
Mika Westerberg35ee69e2020-07-25 10:40:47 +0300875 return false;
Mika Westerberg7bffd97e2019-03-22 15:16:53 +0200876}
877
Gil Fine8a90e4f2021-12-17 03:16:39 +0200878static inline bool tb_switch_is_tiger_lake(const struct tb_switch *sw)
879{
880 if (sw->config.vendor_id == PCI_VENDOR_ID_INTEL) {
881 switch (sw->config.device_id) {
882 case PCI_DEVICE_ID_INTEL_TGL_NHI0:
883 case PCI_DEVICE_ID_INTEL_TGL_NHI1:
884 case PCI_DEVICE_ID_INTEL_TGL_H_NHI0:
885 case PCI_DEVICE_ID_INTEL_TGL_H_NHI1:
886 return true;
887 }
888 }
889 return false;
890}
891
Mika Westerbergf07a3602019-06-25 15:10:01 +0300892/**
Mika Westerbergb0407982019-12-17 15:33:40 +0300893 * tb_switch_is_usb4() - Is the switch USB4 compliant
894 * @sw: Switch to check
895 *
896 * Returns true if the @sw is USB4 compliant router, false otherwise.
897 */
898static inline bool tb_switch_is_usb4(const struct tb_switch *sw)
899{
900 return sw->config.thunderbolt_version == USB4_VERSION_1_0;
901}
902
903/**
Mika Westerbergf07a3602019-06-25 15:10:01 +0300904 * tb_switch_is_icm() - Is the switch handled by ICM firmware
905 * @sw: Switch to check
906 *
907 * In case there is a need to differentiate whether ICM firmware or SW CM
908 * is handling @sw this function can be called. It is valid to call this
909 * after tb_switch_alloc() and tb_switch_configure() has been called
910 * (latter only for SW CM case).
911 */
912static inline bool tb_switch_is_icm(const struct tb_switch *sw)
913{
914 return !sw->config.enabled;
915}
916
Mika Westerberg91c0c122019-03-21 19:03:00 +0200917int tb_switch_lane_bonding_enable(struct tb_switch *sw);
918void tb_switch_lane_bonding_disable(struct tb_switch *sw);
Mika Westerbergde462032020-04-02 14:50:52 +0300919int tb_switch_configure_link(struct tb_switch *sw);
920void tb_switch_unconfigure_link(struct tb_switch *sw);
Mika Westerberg91c0c122019-03-21 19:03:00 +0200921
Mika Westerberg8afe9092019-03-26 15:52:30 +0300922bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
923int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
924void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
925
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300926int tb_switch_tmu_init(struct tb_switch *sw);
927int tb_switch_tmu_post_time(struct tb_switch *sw);
928int tb_switch_tmu_disable(struct tb_switch *sw);
929int tb_switch_tmu_enable(struct tb_switch *sw);
Gil Finea28ec0e2021-12-17 03:16:38 +0200930void tb_switch_tmu_configure(struct tb_switch *sw,
931 enum tb_switch_tmu_rate rate,
932 bool unidirectional);
933/**
934 * tb_switch_tmu_hifi_is_enabled() - Checks if the specified TMU mode is enabled
935 * @sw: Router whose TMU mode to check
936 * @unidirectional: If uni-directional (bi-directional otherwise)
937 *
938 * Return true if hardware TMU configuration matches the one passed in
939 * as parameter. That is HiFi and either uni-directional or bi-directional.
940 */
941static inline bool tb_switch_tmu_hifi_is_enabled(const struct tb_switch *sw,
942 bool unidirectional)
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300943{
944 return sw->tmu.rate == TB_SWITCH_TMU_RATE_HIFI &&
Gil Finea28ec0e2021-12-17 03:16:38 +0200945 sw->tmu.unidirectional == unidirectional;
Rajmohan Manicf29b9af2019-12-17 15:33:43 +0300946}
947
Gil Fine8a90e4f2021-12-17 03:16:39 +0200948int tb_switch_enable_clx(struct tb_switch *sw, enum tb_clx clx);
949int tb_switch_disable_clx(struct tb_switch *sw, enum tb_clx clx);
950
951/**
952 * tb_switch_is_clx_enabled() - Checks if the CLx is enabled
953 * @sw: Router to check the CLx state for
954 *
955 * Checks if the CLx is enabled on the router upstream link.
956 * Not applicable for a host router.
957 */
958static inline bool tb_switch_is_clx_enabled(const struct tb_switch *sw)
959{
960 return sw->clx != TB_CLX_DISABLE;
961}
962
963/**
964 * tb_switch_is_cl0s_enabled() - Checks if the CL0s is enabled
965 * @sw: Router to check for the CL0s
966 *
967 * Checks if the CL0s is enabled on the router upstream link.
968 * Not applicable for a host router.
969 */
970static inline bool tb_switch_is_cl0s_enabled(const struct tb_switch *sw)
971{
972 return sw->clx == TB_CL0S;
973}
974
Andreas Noever9da672a2014-06-03 22:04:05 +0200975int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged);
Andreas Noever520b6702014-06-03 22:04:07 +0200976int tb_port_add_nfc_credits(struct tb_port *port, int credits);
977int tb_port_clear_counter(struct tb_port *port, int counter);
Mika Westerbergb0407982019-12-17 15:33:40 +0300978int tb_port_unlock(struct tb_port *port);
Mika Westerberg341d4512020-02-21 12:11:54 +0200979int tb_port_enable(struct tb_port *port);
980int tb_port_disable(struct tb_port *port);
Mika Westerberg0b2863a2017-02-19 16:57:27 +0200981int tb_port_alloc_in_hopid(struct tb_port *port, int hopid, int max_hopid);
982void tb_port_release_in_hopid(struct tb_port *port, int hopid);
983int tb_port_alloc_out_hopid(struct tb_port *port, int hopid, int max_hopid);
984void tb_port_release_out_hopid(struct tb_port *port, int hopid);
Mika Westerbergfb19fac2017-02-19 21:51:30 +0200985struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
986 struct tb_port *prev);
Andreas Noever9da672a2014-06-03 22:04:05 +0200987
Mika Westerberg56ad3ae2021-03-10 13:34:12 +0200988static inline bool tb_port_use_credit_allocation(const struct tb_port *port)
989{
990 return tb_port_is_null(port) && port->sw->credit_allocation;
991}
992
Mika Westerbergc64c3f32020-04-29 17:07:59 +0300993/**
994 * tb_for_each_port_on_path() - Iterate over each port on path
995 * @src: Source port
996 * @dst: Destination port
997 * @p: Port used as iterator
998 *
999 * Walks over each port on path from @src to @dst.
1000 */
1001#define tb_for_each_port_on_path(src, dst, p) \
1002 for ((p) = tb_next_port_on_path((src), (dst), NULL); (p); \
1003 (p) = tb_next_port_on_path((src), (dst), (p)))
1004
Mika Westerberg5b7b8c02020-05-08 12:41:34 +03001005int tb_port_get_link_speed(struct tb_port *port);
Isaac Hazan4210d502020-09-24 11:43:58 +03001006int tb_port_get_link_width(struct tb_port *port);
Isaac Hazan5cc0df92020-09-24 11:44:01 +03001007int tb_port_state(struct tb_port *port);
1008int tb_port_lane_bonding_enable(struct tb_port *port);
1009void tb_port_lane_bonding_disable(struct tb_port *port);
Mika Westerberge7051be2021-03-22 16:54:54 +02001010int tb_port_wait_for_link_width(struct tb_port *port, int width,
1011 int timeout_msec);
Mika Westerberg69fea372021-03-22 17:01:59 +02001012int tb_port_update_credits(struct tb_port *port);
Mika Westerberg5b7b8c02020-05-08 12:41:34 +03001013
Mika Westerbergda2da042017-06-06 15:24:58 +03001014int tb_switch_find_vse_cap(struct tb_switch *sw, enum tb_switch_vse_cap vsec);
Rajmohan Maniaa43a9d2019-12-17 15:33:42 +03001015int tb_switch_find_cap(struct tb_switch *sw, enum tb_switch_cap cap);
Mika Westerberg6de057e2020-06-29 20:21:07 +03001016int tb_switch_next_cap(struct tb_switch *sw, unsigned int offset);
Mika Westerbergda2da042017-06-06 15:24:58 +03001017int tb_port_find_cap(struct tb_port *port, enum tb_port_cap cap);
Mika Westerberg3c8b2282020-06-29 20:15:17 +03001018int tb_port_next_cap(struct tb_port *port, unsigned int offset);
Mika Westerberge78db6f2017-10-12 16:45:50 +03001019bool tb_port_is_enabled(struct tb_port *port);
Andreas Noevere2b87852014-06-03 22:04:03 +02001020
Rajmohan Manie6f81852019-12-17 15:33:44 +03001021bool tb_usb3_port_is_enabled(struct tb_port *port);
1022int tb_usb3_port_enable(struct tb_port *port, bool enable);
1023
Mika Westerberg0414bec2017-02-19 23:43:26 +02001024bool tb_pci_port_is_enabled(struct tb_port *port);
Mika Westerberg93f36ad2017-02-19 13:48:29 +02001025int tb_pci_port_enable(struct tb_port *port, bool enable);
1026
Mika Westerberg4f807e42018-09-17 16:30:49 +03001027int tb_dp_port_hpd_is_active(struct tb_port *port);
1028int tb_dp_port_hpd_clear(struct tb_port *port);
1029int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
1030 unsigned int aux_tx, unsigned int aux_rx);
1031bool tb_dp_port_is_enabled(struct tb_port *port);
1032int tb_dp_port_enable(struct tb_port *port, bool enable);
1033
Mika Westerberg0414bec2017-02-19 23:43:26 +02001034struct tb_path *tb_path_discover(struct tb_port *src, int src_hopid,
1035 struct tb_port *dst, int dst_hopid,
Mika Westerberg43bddb22021-11-14 17:20:59 +02001036 struct tb_port **last, const char *name,
1037 bool alloc_hopid);
Mika Westerberg8c7acaaf2017-02-19 22:11:41 +02001038struct tb_path *tb_path_alloc(struct tb *tb, struct tb_port *src, int src_hopid,
1039 struct tb_port *dst, int dst_hopid, int link_nr,
1040 const char *name);
Andreas Noever520b6702014-06-03 22:04:07 +02001041void tb_path_free(struct tb_path *path);
1042int tb_path_activate(struct tb_path *path);
1043void tb_path_deactivate(struct tb_path *path);
1044bool tb_path_is_invalid(struct tb_path *path);
Mika Westerberg0bd680c2020-03-24 14:44:13 +02001045bool tb_path_port_on_path(const struct tb_path *path,
1046 const struct tb_port *port);
Andreas Noever520b6702014-06-03 22:04:07 +02001047
Mika Westerberg6ed541c2021-03-22 18:09:35 +02001048/**
1049 * tb_path_for_each_hop() - Iterate over each hop on path
1050 * @path: Path whose hops to iterate
1051 * @hop: Hop used as iterator
1052 *
1053 * Iterates over each hop on path.
1054 */
1055#define tb_path_for_each_hop(path, hop) \
1056 for ((hop) = &(path)->hops[0]; \
1057 (hop) <= &(path)->hops[(path)->path_length - 1]; (hop)++)
1058
Andreas Noevercd22e732014-06-12 23:11:46 +02001059int tb_drom_read(struct tb_switch *sw);
1060int tb_drom_read_uid_only(struct tb_switch *sw, u64 *uid);
Andreas Noeverc90553b2014-06-03 22:04:11 +02001061
Mika Westerberga9be5582019-01-09 16:42:12 +02001062int tb_lc_read_uuid(struct tb_switch *sw, u32 *uuid);
Mika Westerberge28178b2020-04-02 12:42:44 +03001063int tb_lc_configure_port(struct tb_port *port);
1064void tb_lc_unconfigure_port(struct tb_port *port);
Mika Westerberg284652a2020-04-09 14:23:32 +03001065int tb_lc_configure_xdomain(struct tb_port *port);
1066void tb_lc_unconfigure_xdomain(struct tb_port *port);
Mika Westerbergfdb08872020-11-26 12:52:43 +03001067int tb_lc_start_lane_initialization(struct tb_port *port);
Mika Westerbergb2911a52019-12-06 18:36:07 +02001068int tb_lc_set_wake(struct tb_switch *sw, unsigned int flags);
Mika Westerberg5480dfc2019-01-09 17:25:43 +02001069int tb_lc_set_sleep(struct tb_switch *sw);
Mika Westerberg91c0c122019-03-21 19:03:00 +02001070bool tb_lc_lane_bonding_possible(struct tb_switch *sw);
Mika Westerberg8afe9092019-03-26 15:52:30 +03001071bool tb_lc_dp_sink_query(struct tb_switch *sw, struct tb_port *in);
1072int tb_lc_dp_sink_alloc(struct tb_switch *sw, struct tb_port *in);
1073int tb_lc_dp_sink_dealloc(struct tb_switch *sw, struct tb_port *in);
Mario Limonciello1cb36292020-06-23 11:14:29 -05001074int tb_lc_force_power(struct tb_switch *sw);
Andreas Noevera25c8b22014-06-03 22:04:02 +02001075
1076static inline int tb_route_length(u64 route)
1077{
1078 return (fls64(route) + TB_ROUTE_SHIFT - 1) / TB_ROUTE_SHIFT;
1079}
1080
Andreas Noever9da672a2014-06-03 22:04:05 +02001081/**
1082 * tb_downstream_route() - get route to downstream switch
1083 *
1084 * Port must not be the upstream port (otherwise a loop is created).
1085 *
1086 * Return: Returns a route to the switch behind @port.
1087 */
1088static inline u64 tb_downstream_route(struct tb_port *port)
1089{
1090 return tb_route(port->sw)
1091 | ((u64) port->port << (port->sw->config.depth * 8));
1092}
1093
Mika Westerberg5ca67682020-10-22 13:22:06 +03001094bool tb_is_xdomain_enabled(void);
Mika Westerbergd1ff7022017-10-02 13:38:34 +03001095bool tb_xdomain_handle_request(struct tb *tb, enum tb_cfg_pkg_type type,
1096 const void *buf, size_t size);
1097struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent,
1098 u64 route, const uuid_t *local_uuid,
1099 const uuid_t *remote_uuid);
1100void tb_xdomain_add(struct tb_xdomain *xd);
1101void tb_xdomain_remove(struct tb_xdomain *xd);
1102struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link,
1103 u8 depth);
1104
Rajmohan Mani3fb10ea2021-04-01 18:42:38 +03001105int tb_retimer_scan(struct tb_port *port, bool add);
Kranthi Kuntaladacb1282020-03-05 16:39:58 +02001106void tb_retimer_remove_all(struct tb_port *port);
1107
1108static inline bool tb_is_retimer(const struct device *dev)
1109{
1110 return dev->type == &tb_retimer_type;
1111}
1112
1113static inline struct tb_retimer *tb_to_retimer(struct device *dev)
1114{
1115 if (tb_is_retimer(dev))
1116 return container_of(dev, struct tb_retimer, dev);
1117 return NULL;
1118}
1119
Mika Westerbergb0407982019-12-17 15:33:40 +03001120int usb4_switch_setup(struct tb_switch *sw);
1121int usb4_switch_read_uid(struct tb_switch *sw, u64 *uid);
1122int usb4_switch_drom_read(struct tb_switch *sw, unsigned int address, void *buf,
1123 size_t size);
Mika Westerbergb0407982019-12-17 15:33:40 +03001124bool usb4_switch_lane_bonding_possible(struct tb_switch *sw);
Mika Westerbergb2911a52019-12-06 18:36:07 +02001125int usb4_switch_set_wake(struct tb_switch *sw, unsigned int flags);
Mika Westerbergb0407982019-12-17 15:33:40 +03001126int usb4_switch_set_sleep(struct tb_switch *sw);
1127int usb4_switch_nvm_sector_size(struct tb_switch *sw);
1128int usb4_switch_nvm_read(struct tb_switch *sw, unsigned int address, void *buf,
1129 size_t size);
Mika Westerberg1cbf6802021-04-12 15:25:08 +03001130int usb4_switch_nvm_set_offset(struct tb_switch *sw, unsigned int address);
Mika Westerbergb0407982019-12-17 15:33:40 +03001131int usb4_switch_nvm_write(struct tb_switch *sw, unsigned int address,
1132 const void *buf, size_t size);
1133int usb4_switch_nvm_authenticate(struct tb_switch *sw);
Mika Westerberg661b1942020-11-10 11:34:07 +03001134int usb4_switch_nvm_authenticate_status(struct tb_switch *sw, u32 *status);
Mika Westerberg56ad3ae2021-03-10 13:34:12 +02001135int usb4_switch_credits_init(struct tb_switch *sw);
Mika Westerbergb0407982019-12-17 15:33:40 +03001136bool usb4_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in);
1137int usb4_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1138int usb4_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in);
1139struct tb_port *usb4_switch_map_pcie_down(struct tb_switch *sw,
1140 const struct tb_port *port);
Rajmohan Manie6f81852019-12-17 15:33:44 +03001141struct tb_port *usb4_switch_map_usb3_down(struct tb_switch *sw,
1142 const struct tb_port *port);
Mika Westerbergcae5f512021-04-01 17:34:20 +03001143int usb4_switch_add_ports(struct tb_switch *sw);
1144void usb4_switch_remove_ports(struct tb_switch *sw);
Mika Westerbergb0407982019-12-17 15:33:40 +03001145
1146int usb4_port_unlock(struct tb_port *port);
Mika Westerberge28178b2020-04-02 12:42:44 +03001147int usb4_port_configure(struct tb_port *port);
1148void usb4_port_unconfigure(struct tb_port *port);
Mika Westerberg284652a2020-04-09 14:23:32 +03001149int usb4_port_configure_xdomain(struct tb_port *port);
1150void usb4_port_unconfigure_xdomain(struct tb_port *port);
Rajmohan Mani3406de72021-04-01 18:38:05 +03001151int usb4_port_router_offline(struct tb_port *port);
1152int usb4_port_router_online(struct tb_port *port);
Rajmohan Mani02d12852020-03-05 16:33:46 +02001153int usb4_port_enumerate_retimers(struct tb_port *port);
Gil Fine8a90e4f2021-12-17 03:16:39 +02001154bool usb4_port_clx_supported(struct tb_port *port);
Rajmohan Mani02d12852020-03-05 16:33:46 +02001155
Rajmohan Mani3406de72021-04-01 18:38:05 +03001156int usb4_port_retimer_set_inbound_sbtx(struct tb_port *port, u8 index);
Rajmohan Mani02d12852020-03-05 16:33:46 +02001157int usb4_port_retimer_read(struct tb_port *port, u8 index, u8 reg, void *buf,
1158 u8 size);
1159int usb4_port_retimer_write(struct tb_port *port, u8 index, u8 reg,
1160 const void *buf, u8 size);
1161int usb4_port_retimer_is_last(struct tb_port *port, u8 index);
1162int usb4_port_retimer_nvm_sector_size(struct tb_port *port, u8 index);
Rajmohan Manifaa1c612021-04-12 15:29:16 +03001163int usb4_port_retimer_nvm_set_offset(struct tb_port *port, u8 index,
1164 unsigned int address);
Rajmohan Mani02d12852020-03-05 16:33:46 +02001165int usb4_port_retimer_nvm_write(struct tb_port *port, u8 index,
1166 unsigned int address, const void *buf,
1167 size_t size);
1168int usb4_port_retimer_nvm_authenticate(struct tb_port *port, u8 index);
1169int usb4_port_retimer_nvm_authenticate_status(struct tb_port *port, u8 index,
1170 u32 *status);
1171int usb4_port_retimer_nvm_read(struct tb_port *port, u8 index,
1172 unsigned int address, void *buf, size_t size);
Mika Westerberg3b1d8d52020-02-21 23:14:41 +02001173
1174int usb4_usb3_port_max_link_rate(struct tb_port *port);
1175int usb4_usb3_port_actual_link_rate(struct tb_port *port);
1176int usb4_usb3_port_allocated_bandwidth(struct tb_port *port, int *upstream_bw,
1177 int *downstream_bw);
1178int usb4_usb3_port_allocate_bandwidth(struct tb_port *port, int *upstream_bw,
1179 int *downstream_bw);
1180int usb4_usb3_port_release_bandwidth(struct tb_port *port, int *upstream_bw,
1181 int *downstream_bw);
Mario Limonciello1cb36292020-06-23 11:14:29 -05001182
Mika Westerbergcae5f512021-04-01 17:34:20 +03001183static inline bool tb_is_usb4_port_device(const struct device *dev)
1184{
1185 return dev->type == &usb4_port_device_type;
1186}
1187
1188static inline struct usb4_port *tb_to_usb4_port_device(struct device *dev)
1189{
1190 if (tb_is_usb4_port_device(dev))
1191 return container_of(dev, struct usb4_port, dev);
1192 return NULL;
1193}
1194
1195struct usb4_port *usb4_port_device_add(struct tb_port *port);
1196void usb4_port_device_remove(struct usb4_port *usb4);
Rajmohan Mani3fb10ea2021-04-01 18:42:38 +03001197int usb4_port_device_resume(struct usb4_port *usb4);
Mika Westerbergcae5f512021-04-01 17:34:20 +03001198
Mika Westerberg810278d2020-08-26 08:58:29 +03001199/* Keep link controller awake during update */
Mario Limonciello1cb36292020-06-23 11:14:29 -05001200#define QUIRK_FORCE_POWER_LINK_CONTROLLER BIT(0)
1201
1202void tb_check_quirks(struct tb_switch *sw);
1203
Mika Westerbergb2be2b02019-04-02 15:26:00 +03001204#ifdef CONFIG_ACPI
1205void tb_acpi_add_links(struct tb_nhi *nhi);
Mika Westerbergc6da62a2020-02-18 16:14:42 +02001206
1207bool tb_acpi_is_native(void);
1208bool tb_acpi_may_tunnel_usb3(void);
1209bool tb_acpi_may_tunnel_dp(void);
1210bool tb_acpi_may_tunnel_pcie(void);
1211bool tb_acpi_is_xdomain_allowed(void);
Rajmohan Maniccc5cb82021-04-01 18:20:17 +03001212
1213int tb_acpi_init(void);
1214void tb_acpi_exit(void);
1215int tb_acpi_power_on_retimers(struct tb_port *port);
1216int tb_acpi_power_off_retimers(struct tb_port *port);
Mika Westerbergb2be2b02019-04-02 15:26:00 +03001217#else
1218static inline void tb_acpi_add_links(struct tb_nhi *nhi) { }
Mika Westerbergc6da62a2020-02-18 16:14:42 +02001219
1220static inline bool tb_acpi_is_native(void) { return true; }
1221static inline bool tb_acpi_may_tunnel_usb3(void) { return true; }
1222static inline bool tb_acpi_may_tunnel_dp(void) { return true; }
1223static inline bool tb_acpi_may_tunnel_pcie(void) { return true; }
1224static inline bool tb_acpi_is_xdomain_allowed(void) { return true; }
Rajmohan Maniccc5cb82021-04-01 18:20:17 +03001225
1226static inline int tb_acpi_init(void) { return 0; }
1227static inline void tb_acpi_exit(void) { }
1228static inline int tb_acpi_power_on_retimers(struct tb_port *port) { return 0; }
1229static inline int tb_acpi_power_off_retimers(struct tb_port *port) { return 0; }
Mika Westerbergb2be2b02019-04-02 15:26:00 +03001230#endif
1231
Gil Fine54e41812020-06-29 20:30:52 +03001232#ifdef CONFIG_DEBUG_FS
1233void tb_debugfs_init(void);
1234void tb_debugfs_exit(void);
1235void tb_switch_debugfs_init(struct tb_switch *sw);
1236void tb_switch_debugfs_remove(struct tb_switch *sw);
Mika Westerberg407ac932020-10-07 17:53:44 +03001237void tb_service_debugfs_init(struct tb_service *svc);
1238void tb_service_debugfs_remove(struct tb_service *svc);
Gil Fine54e41812020-06-29 20:30:52 +03001239#else
1240static inline void tb_debugfs_init(void) { }
1241static inline void tb_debugfs_exit(void) { }
1242static inline void tb_switch_debugfs_init(struct tb_switch *sw) { }
1243static inline void tb_switch_debugfs_remove(struct tb_switch *sw) { }
Mika Westerberg407ac932020-10-07 17:53:44 +03001244static inline void tb_service_debugfs_init(struct tb_service *svc) { }
1245static inline void tb_service_debugfs_remove(struct tb_service *svc) { }
Gil Fine54e41812020-06-29 20:30:52 +03001246#endif
1247
Mika Westerberg2c6ea4e2020-08-24 12:46:52 +03001248#ifdef CONFIG_USB4_KUNIT_TEST
1249int tb_test_init(void);
1250void tb_test_exit(void);
1251#else
1252static inline int tb_test_init(void) { return 0; }
1253static inline void tb_test_exit(void) { }
1254#endif
1255
Andreas Noeverd6cc51c2014-06-03 22:04:00 +02001256#endif