drivers/thunderbolt/switch.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Thunderbolt driver - switch/port utility functions
   4  *
   5  * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com>
   6  * Copyright (C) 2018, Intel Corporation
   7  */
   8
   9 #include <linux/delay.h>
  10 #include <linux/idr.h>
  11 #include <linux/nvmem-provider.h>
  12 #include <linux/pm_runtime.h>
  13 #include <linux/sched/signal.h>
  14 #include <linux/sizes.h>
  15 #include <linux/slab.h>
  16 #include <linux/module.h>
  17
  18 #include "tb.h"
  19
  20 /* Switch NVM support */
  21
  22 #define NVM_CSS                 0x10
  23
  24 struct nvm_auth_status {
  25         struct list_head list;
  26         uuid_t uuid;
  27         u32 status;
  28 };
  29
  30 static bool clx_enabled = true;
  31 module_param_named(clx, clx_enabled, bool, 0444);
  32 MODULE_PARM_DESC(clx, "allow low power states on the high-speed lanes (default: true)");
  33
  34 /*
  35  * Hold NVM authentication failure status per switch This information
  36  * needs to stay around even when the switch gets power cycled so we
  37  * keep it separately.
  38  */
  39 static LIST_HEAD(nvm_auth_status_cache);
  40 static DEFINE_MUTEX(nvm_auth_status_lock);
  41
  42 static struct nvm_auth_status *__nvm_get_auth_status(const struct tb_switch *sw)
  43 {
  44         struct nvm_auth_status *st;
  45
  46         list_for_each_entry(st, &nvm_auth_status_cache, list) {
  47                 if (uuid_equal(&st->uuid, sw->uuid))
  48                         return st;
  49         }
  50
  51         return NULL;
  52 }
  53
  54 static void nvm_get_auth_status(const struct tb_switch *sw, u32 *status)
  55 {
  56         struct nvm_auth_status *st;
  57
  58         mutex_lock(&nvm_auth_status_lock);
  59         st = __nvm_get_auth_status(sw);
  60         mutex_unlock(&nvm_auth_status_lock);
  61
  62         *status = st ? st->status : 0;
  63 }
  64
  65 static void nvm_set_auth_status(const struct tb_switch *sw, u32 status)
  66 {
  67         struct nvm_auth_status *st;
  68
  69         if (WARN_ON(!sw->uuid))
  70                 return;
  71
  72         mutex_lock(&nvm_auth_status_lock);
  73         st = __nvm_get_auth_status(sw);
  74
  75         if (!st) {
  76                 st = kzalloc(sizeof(*st), GFP_KERNEL);
  77                 if (!st)
  78                         goto unlock;
  79
  80                 memcpy(&st->uuid, sw->uuid, sizeof(st->uuid));
  81                 INIT_LIST_HEAD(&st->list);
  82                 list_add_tail(&st->list, &nvm_auth_status_cache);
  83         }
  84
  85         st->status = status;
  86 unlock:
  87         mutex_unlock(&nvm_auth_status_lock);
  88 }
  89
  90 static void nvm_clear_auth_status(const struct tb_switch *sw)
  91 {
  92         struct nvm_auth_status *st;
  93
  94         mutex_lock(&nvm_auth_status_lock);
  95         st = __nvm_get_auth_status(sw);
  96         if (st) {
  97                 list_del(&st->list);
  98                 kfree(st);
  99         }
 100         mutex_unlock(&nvm_auth_status_lock);
 101 }
 102
 103 static int nvm_validate_and_write(struct tb_switch *sw)
 104 {
 105         unsigned int image_size, hdr_size;
 106         const u8 *buf = sw->nvm->buf;
 107         u16 ds_size;
 108         int ret;
 109
 110         if (!buf)
 111                 return -EINVAL;
 112
 113         image_size = sw->nvm->buf_data_size;
 114         if (image_size < NVM_MIN_SIZE || image_size > NVM_MAX_SIZE)
 115                 return -EINVAL;
 116
 117         /*
 118          * FARB pointer must point inside the image and must at least
 119          * contain parts of the digital section we will be reading here.
 120          */
 121         hdr_size = (*(u32 *)buf) & 0xffffff;
 122         if (hdr_size + NVM_DEVID + 2 >= image_size)
 123                 return -EINVAL;
 124
 125         /* Digital section start should be aligned to 4k page */
 126         if (!IS_ALIGNED(hdr_size, SZ_4K))
 127                 return -EINVAL;
 128
 129         /*
 130          * Read digital section size and check that it also fits inside
 131          * the image.
 132          */
 133         ds_size = *(u16 *)(buf + hdr_size);
 134         if (ds_size >= image_size)
 135                 return -EINVAL;
 136
 137         if (!sw->safe_mode) {
 138                 u16 device_id;
 139
 140                 /*
 141                  * Make sure the device ID in the image matches the one
 142                  * we read from the switch config space.
 143                  */
 144                 device_id = *(u16 *)(buf + hdr_size + NVM_DEVID);
 145                 if (device_id != sw->config.device_id)
 146                         return -EINVAL;
 147
 148                 if (sw->generation < 3) {
 149                         /* Write CSS headers first */
 150                         ret = dma_port_flash_write(sw->dma_port,
 151                                 DMA_PORT_CSS_ADDRESS, buf + NVM_CSS,
 152                                 DMA_PORT_CSS_MAX_SIZE);
 153                         if (ret)
 154                                 return ret;
 155                 }
 156
 157                 /* Skip headers in the image */
 158                 buf += hdr_size;
 159                 image_size -= hdr_size;
 160         }
 161
 162         if (tb_switch_is_usb4(sw))
 163                 ret = usb4_switch_nvm_write(sw, 0, buf, image_size);
 164         else
 165                 ret = dma_port_flash_write(sw->dma_port, 0, buf, image_size);
 166         if (!ret)
 167                 sw->nvm->flushed = true;
 168         return ret;
 169 }
 170
 171 static int nvm_authenticate_host_dma_port(struct tb_switch *sw)
 172 {
 173         int ret = 0;
 174
 175         /*
 176          * Root switch NVM upgrade requires that we disconnect the
 177          * existing paths first (in case it is not in safe mode
 178          * already).
 179          */
 180         if (!sw->safe_mode) {
 181                 u32 status;
 182
 183                 ret = tb_domain_disconnect_all_paths(sw->tb);
 184                 if (ret)
 185                         return ret;
 186                 /*
 187                  * The host controller goes away pretty soon after this if
 188                  * everything goes well so getting timeout is expected.
 189                  */
 190                 ret = dma_port_flash_update_auth(sw->dma_port);
 191                 if (!ret || ret == -ETIMEDOUT)
 192                         return 0;
 193
 194                 /*
 195                  * Any error from update auth operation requires power
 196                  * cycling of the host router.
 197                  */
 198                 tb_sw_warn(sw, "failed to authenticate NVM, power cycling\n");
 199                 if (dma_port_flash_update_auth_status(sw->dma_port, &status) > 0)
 200                         nvm_set_auth_status(sw, status);
 201         }
 202
 203         /*
 204          * From safe mode we can get out by just power cycling the
 205          * switch.
 206          */
 207         dma_port_power_cycle(sw->dma_port);
 208         return ret;
 209 }
 210
 211 static int nvm_authenticate_device_dma_port(struct tb_switch *sw)
 212 {
 213         int ret, retries = 10;
 214
 215         ret = dma_port_flash_update_auth(sw->dma_port);
 216         switch (ret) {
 217         case 0:
 218         case -ETIMEDOUT:
 219         case -EACCES:
 220         case -EINVAL:
 221                 /* Power cycle is required */
 222                 break;
 223         default:
 224                 return ret;
 225         }
 226
 227         /*
 228          * Poll here for the authentication status. It takes some time
 229          * for the device to respond (we get timeout for a while). Once
 230          * we get response the device needs to be power cycled in order
 231          * to the new NVM to be taken into use.
 232          */
 233         do {
 234                 u32 status;
 235
 236                 ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
 237                 if (ret < 0 && ret != -ETIMEDOUT)
 238                         return ret;
 239                 if (ret > 0) {
 240                         if (status) {
 241                                 tb_sw_warn(sw, "failed to authenticate NVM\n");
 242                                 nvm_set_auth_status(sw, status);
 243                         }
 244
 245                         tb_sw_info(sw, "power cycling the switch now\n");
 246                         dma_port_power_cycle(sw->dma_port);
 247                         return 0;
 248                 }
 249
 250                 msleep(500);
 251         } while (--retries);
 252
 253         return -ETIMEDOUT;
 254 }
 255
 256 static void nvm_authenticate_start_dma_port(struct tb_switch *sw)
 257 {
 258         struct pci_dev *root_port;
 259
 260         /*
 261          * During host router NVM upgrade we should not allow root port to
 262          * go into D3cold because some root ports cannot trigger PME
 263          * itself. To be on the safe side keep the root port in D0 during
 264          * the whole upgrade process.
 265          */
 266         root_port = pcie_find_root_port(sw->tb->nhi->pdev);
 267         if (root_port)
 268                 pm_runtime_get_noresume(&root_port->dev);
 269 }
 270
 271 static void nvm_authenticate_complete_dma_port(struct tb_switch *sw)
 272 {
 273         struct pci_dev *root_port;
 274
 275         root_port = pcie_find_root_port(sw->tb->nhi->pdev);
 276         if (root_port)
 277                 pm_runtime_put(&root_port->dev);
 278 }
 279
 280 static inline bool nvm_readable(struct tb_switch *sw)
 281 {
 282         if (tb_switch_is_usb4(sw)) {
 283                 /*
 284                  * USB4 devices must support NVM operations but it is
 285                  * optional for hosts. Therefore we query the NVM sector
 286                  * size here and if it is supported assume NVM
 287                  * operations are implemented.
 288                  */
 289                 return usb4_switch_nvm_sector_size(sw) > 0;
 290         }
 291
 292         /* Thunderbolt 2 and 3 devices support NVM through DMA port */
 293         return !!sw->dma_port;
 294 }
 295
 296 static inline bool nvm_upgradeable(struct tb_switch *sw)
 297 {
 298         if (sw->no_nvm_upgrade)
 299                 return false;
 300         return nvm_readable(sw);
 301 }
 302
 303 static inline int nvm_read(struct tb_switch *sw, unsigned int address,
 304                            void *buf, size_t size)
 305 {
 306         if (tb_switch_is_usb4(sw))
 307                 return usb4_switch_nvm_read(sw, address, buf, size);
 308         return dma_port_flash_read(sw->dma_port, address, buf, size);
 309 }
 310
 311 static int nvm_authenticate(struct tb_switch *sw, bool auth_only)
 312 {
 313         int ret;
 314
 315         if (tb_switch_is_usb4(sw)) {
 316                 if (auth_only) {
 317                         ret = usb4_switch_nvm_set_offset(sw, 0);
 318                         if (ret)
 319                                 return ret;
 320                 }
 321                 sw->nvm->authenticating = true;
 322                 return usb4_switch_nvm_authenticate(sw);
 323         } else if (auth_only) {
 324                 return -EOPNOTSUPP;
 325         }
 326
 327         sw->nvm->authenticating = true;
 328         if (!tb_route(sw)) {
 329                 nvm_authenticate_start_dma_port(sw);
 330                 ret = nvm_authenticate_host_dma_port(sw);
 331         } else {
 332                 ret = nvm_authenticate_device_dma_port(sw);
 333         }
 334
 335         return ret;
 336 }
 337
 338 static int tb_switch_nvm_read(void *priv, unsigned int offset, void *val,
 339                               size_t bytes)
 340 {
 341         struct tb_nvm *nvm = priv;
 342         struct tb_switch *sw = tb_to_switch(nvm->dev);
 343         int ret;
 344
 345         pm_runtime_get_sync(&sw->dev);
 346
 347         if (!mutex_trylock(&sw->tb->lock)) {
 348                 ret = restart_syscall();
 349                 goto out;
 350         }
 351
 352         ret = nvm_read(sw, offset, val, bytes);
 353         mutex_unlock(&sw->tb->lock);
 354
 355 out:
 356         pm_runtime_mark_last_busy(&sw->dev);
 357         pm_runtime_put_autosuspend(&sw->dev);
 358
 359         return ret;
 360 }
 361
 362 static int tb_switch_nvm_write(void *priv, unsigned int offset, void *val,
 363                                size_t bytes)
 364 {
 365         struct tb_nvm *nvm = priv;
 366         struct tb_switch *sw = tb_to_switch(nvm->dev);
 367         int ret;
 368
 369         if (!mutex_trylock(&sw->tb->lock))
 370                 return restart_syscall();
 371
 372         /*
 373          * Since writing the NVM image might require some special steps,
 374          * for example when CSS headers are written, we cache the image
 375          * locally here and handle the special cases when the user asks
 376          * us to authenticate the image.
 377          */
 378         ret = tb_nvm_write_buf(nvm, offset, val, bytes);
 379         mutex_unlock(&sw->tb->lock);
 380
 381         return ret;
 382 }
 383
 384 static int tb_switch_nvm_add(struct tb_switch *sw)
 385 {
 386         struct tb_nvm *nvm;
 387         u32 val;
 388         int ret;
 389
 390         if (!nvm_readable(sw))
 391                 return 0;
 392
 393         /*
 394          * The NVM format of non-Intel hardware is not known so
 395          * currently restrict NVM upgrade for Intel hardware. We may
 396          * relax this in the future when we learn other NVM formats.
 397          */
 398         if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL &&
 399             sw->config.vendor_id != 0x8087) {
 400                 dev_info(&sw->dev,
 401                          "NVM format of vendor %#x is not known, disabling NVM upgrade\n",
 402                          sw->config.vendor_id);
 403                 return 0;
 404         }
 405
 406         nvm = tb_nvm_alloc(&sw->dev);
 407         if (IS_ERR(nvm))
 408                 return PTR_ERR(nvm);
 409
 410         /*
 411          * If the switch is in safe-mode the only accessible portion of
 412          * the NVM is the non-active one where userspace is expected to
 413          * write new functional NVM.
 414          */
 415         if (!sw->safe_mode) {
 416                 u32 nvm_size, hdr_size;
 417
 418                 ret = nvm_read(sw, NVM_FLASH_SIZE, &val, sizeof(val));
 419                 if (ret)
 420                         goto err_nvm;
 421
 422                 hdr_size = sw->generation < 3 ? SZ_8K : SZ_16K;
 423                 nvm_size = (SZ_1M << (val & 7)) / 8;
 424                 nvm_size = (nvm_size - hdr_size) / 2;
 425
 426                 ret = nvm_read(sw, NVM_VERSION, &val, sizeof(val));
 427                 if (ret)
 428                         goto err_nvm;
 429
 430                 nvm->major = val >> 16;
 431                 nvm->minor = val >> 8;
 432
 433                 ret = tb_nvm_add_active(nvm, nvm_size, tb_switch_nvm_read);
 434                 if (ret)
 435                         goto err_nvm;
 436         }
 437
 438         if (!sw->no_nvm_upgrade) {
 439                 ret = tb_nvm_add_non_active(nvm, NVM_MAX_SIZE,
 440                                             tb_switch_nvm_write);
 441                 if (ret)
 442                         goto err_nvm;
 443         }
 444
 445         sw->nvm = nvm;
 446         return 0;
 447
 448 err_nvm:
 449         tb_nvm_free(nvm);
 450         return ret;
 451 }
 452
 453 static void tb_switch_nvm_remove(struct tb_switch *sw)
 454 {
 455         struct tb_nvm *nvm;
 456
 457         nvm = sw->nvm;
 458         sw->nvm = NULL;
 459
 460         if (!nvm)
 461                 return;
 462
 463         /* Remove authentication status in case the switch is unplugged */
 464         if (!nvm->authenticating)
 465                 nvm_clear_auth_status(sw);
 466
 467         tb_nvm_free(nvm);
 468 }
 469
 470 /* port utility functions */
 471
 472 static const char *tb_port_type(const struct tb_regs_port_header *port)
 473 {
 474         switch (port->type >> 16) {
 475         case 0:
 476                 switch ((u8) port->type) {
 477                 case 0:
 478                         return "Inactive";
 479                 case 1:
 480                         return "Port";
 481                 case 2:
 482                         return "NHI";
 483                 default:
 484                         return "unknown";
 485                 }
 486         case 0x2:
 487                 return "Ethernet";
 488         case 0x8:
 489                 return "SATA";
 490         case 0xe:
 491                 return "DP/HDMI";
 492         case 0x10:
 493                 return "PCIe";
 494         case 0x20:
 495                 return "USB";
 496         default:
 497                 return "unknown";
 498         }
 499 }
 500
 501 static void tb_dump_port(struct tb *tb, const struct tb_port *port)
 502 {
 503         const struct tb_regs_port_header *regs = &port->config;
 504
 505         tb_dbg(tb,
 506                " Port %d: %x:%x (Revision: %d, TB Version: %d, Type: %s (%#x))\n",
 507                regs->port_number, regs->vendor_id, regs->device_id,
 508                regs->revision, regs->thunderbolt_version, tb_port_type(regs),
 509                regs->type);
 510         tb_dbg(tb, "  Max hop id (in/out): %d/%d\n",
 511                regs->max_in_hop_id, regs->max_out_hop_id);
 512         tb_dbg(tb, "  Max counters: %d\n", regs->max_counters);
 513         tb_dbg(tb, "  NFC Credits: %#x\n", regs->nfc_credits);
 514         tb_dbg(tb, "  Credits (total/control): %u/%u\n", port->total_credits,
 515                port->ctl_credits);
 516 }
 517
 518 /**
 519  * tb_port_state() - get connectedness state of a port
 520  * @port: the port to check
 521  *
 522  * The port must have a TB_CAP_PHY (i.e. it should be a real port).
 523  *
 524  * Return: Returns an enum tb_port_state on success or an error code on failure.
 525  */
 526 int tb_port_state(struct tb_port *port)
 527 {
 528         struct tb_cap_phy phy;
 529         int res;
 530         if (port->cap_phy == 0) {
 531                 tb_port_WARN(port, "does not have a PHY\n");
 532                 return -EINVAL;
 533         }
 534         res = tb_port_read(port, &phy, TB_CFG_PORT, port->cap_phy, 2);
 535         if (res)
 536                 return res;
 537         return phy.state;
 538 }
 539
 540 /**
 541  * tb_wait_for_port() - wait for a port to become ready
 542  * @port: Port to wait
 543  * @wait_if_unplugged: Wait also when port is unplugged
 544  *
 545  * Wait up to 1 second for a port to reach state TB_PORT_UP. If
 546  * wait_if_unplugged is set then we also wait if the port is in state
 547  * TB_PORT_UNPLUGGED (it takes a while for the device to be registered after
 548  * switch resume). Otherwise we only wait if a device is registered but the link
 549  * has not yet been established.
 550  *
 551  * Return: Returns an error code on failure. Returns 0 if the port is not
 552  * connected or failed to reach state TB_PORT_UP within one second. Returns 1
 553  * if the port is connected and in state TB_PORT_UP.
 554  */
 555 int tb_wait_for_port(struct tb_port *port, bool wait_if_unplugged)
 556 {
 557         int retries = 10;
 558         int state;
 559         if (!port->cap_phy) {
 560                 tb_port_WARN(port, "does not have PHY\n");
 561                 return -EINVAL;
 562         }
 563         if (tb_is_upstream_port(port)) {
 564                 tb_port_WARN(port, "is the upstream port\n");
 565                 return -EINVAL;
 566         }
 567
 568         while (retries--) {
 569                 state = tb_port_state(port);
 570                 if (state < 0)
 571                         return state;
 572                 if (state == TB_PORT_DISABLED) {
 573                         tb_port_dbg(port, "is disabled (state: 0)\n");
 574                         return 0;
 575                 }
 576                 if (state == TB_PORT_UNPLUGGED) {
 577                         if (wait_if_unplugged) {
 578                                 /* used during resume */
 579                                 tb_port_dbg(port,
 580                                             "is unplugged (state: 7), retrying...\n");
 581                                 msleep(100);
 582                                 continue;
 583                         }
 584                         tb_port_dbg(port, "is unplugged (state: 7)\n");
 585                         return 0;
 586                 }
 587                 if (state == TB_PORT_UP) {
 588                         tb_port_dbg(port, "is connected, link is up (state: 2)\n");
 589                         return 1;
 590                 }
 591
 592                 /*
 593                  * After plug-in the state is TB_PORT_CONNECTING. Give it some
 594                  * time.
 595                  */
 596                 tb_port_dbg(port,
 597                             "is connected, link is not up (state: %d), retrying...\n",
 598                             state);
 599                 msleep(100);
 600         }
 601         tb_port_warn(port,
 602                      "failed to reach state TB_PORT_UP. Ignoring port...\n");
 603         return 0;
 604 }
 605
 606 /**
 607  * tb_port_add_nfc_credits() - add/remove non flow controlled credits to port
 608  * @port: Port to add/remove NFC credits
 609  * @credits: Credits to add/remove
 610  *
 611  * Change the number of NFC credits allocated to @port by @credits. To remove
 612  * NFC credits pass a negative amount of credits.
 613  *
 614  * Return: Returns 0 on success or an error code on failure.
 615  */
 616 int tb_port_add_nfc_credits(struct tb_port *port, int credits)
 617 {
 618         u32 nfc_credits;
 619
 620         if (credits == 0 || port->sw->is_unplugged)
 621                 return 0;
 622
 623         /*
 624          * USB4 restricts programming NFC buffers to lane adapters only
 625          * so skip other ports.
 626          */
 627         if (tb_switch_is_usb4(port->sw) && !tb_port_is_null(port))
 628                 return 0;
 629
 630         nfc_credits = port->config.nfc_credits & ADP_CS_4_NFC_BUFFERS_MASK;
 631         if (credits < 0)
 632                 credits = max_t(int, -nfc_credits, credits);
 633
 634         nfc_credits += credits;
 635
 636         tb_port_dbg(port, "adding %d NFC credits to %lu", credits,
 637                     port->config.nfc_credits & ADP_CS_4_NFC_BUFFERS_MASK);
 638
 639         port->config.nfc_credits &= ~ADP_CS_4_NFC_BUFFERS_MASK;
 640         port->config.nfc_credits |= nfc_credits;
 641
 642         return tb_port_write(port, &port->config.nfc_credits,
 643                              TB_CFG_PORT, ADP_CS_4, 1);
 644 }
 645
 646 /**
 647  * tb_port_clear_counter() - clear a counter in TB_CFG_COUNTER
 648  * @port: Port whose counters to clear
 649  * @counter: Counter index to clear
 650  *
 651  * Return: Returns 0 on success or an error code on failure.
 652  */
 653 int tb_port_clear_counter(struct tb_port *port, int counter)
 654 {
 655         u32 zero[3] = { 0, 0, 0 };
 656         tb_port_dbg(port, "clearing counter %d\n", counter);
 657         return tb_port_write(port, zero, TB_CFG_COUNTERS, 3 * counter, 3);
 658 }
 659
 660 /**
 661  * tb_port_unlock() - Unlock downstream port
 662  * @port: Port to unlock
 663  *
 664  * Needed for USB4 but can be called for any CIO/USB4 ports. Makes the
 665  * downstream router accessible for CM.
 666  */
 667 int tb_port_unlock(struct tb_port *port)
 668 {
 669         if (tb_switch_is_icm(port->sw))
 670                 return 0;
 671         if (!tb_port_is_null(port))
 672                 return -EINVAL;
 673         if (tb_switch_is_usb4(port->sw))
 674                 return usb4_port_unlock(port);
 675         return 0;
 676 }
 677
 678 static int __tb_port_enable(struct tb_port *port, bool enable)
 679 {
 680         int ret;
 681         u32 phy;
 682
 683         if (!tb_port_is_null(port))
 684                 return -EINVAL;
 685
 686         ret = tb_port_read(port, &phy, TB_CFG_PORT,
 687                            port->cap_phy + LANE_ADP_CS_1, 1);
 688         if (ret)
 689                 return ret;
 690
 691         if (enable)
 692                 phy &= ~LANE_ADP_CS_1_LD;
 693         else
 694                 phy |= LANE_ADP_CS_1_LD;
 695
 696
 697         ret = tb_port_write(port, &phy, TB_CFG_PORT,
 698                             port->cap_phy + LANE_ADP_CS_1, 1);
 699         if (ret)
 700                 return ret;
 701
 702         tb_port_dbg(port, "lane %sabled\n", enable ? "en" : "dis");
 703         return 0;
 704 }
 705
 706 /**
 707  * tb_port_enable() - Enable lane adapter
 708  * @port: Port to enable (can be %NULL)
 709  *
 710  * This is used for lane 0 and 1 adapters to enable it.
 711  */
 712 int tb_port_enable(struct tb_port *port)
 713 {
 714         return __tb_port_enable(port, true);
 715 }
 716
 717 /**
 718  * tb_port_disable() - Disable lane adapter
 719  * @port: Port to disable (can be %NULL)
 720  *
 721  * This is used for lane 0 and 1 adapters to disable it.
 722  */
 723 int tb_port_disable(struct tb_port *port)
 724 {
 725         return __tb_port_enable(port, false);
 726 }
 727
 728 /*
 729  * tb_init_port() - initialize a port
 730  *
 731  * This is a helper method for tb_switch_alloc. Does not check or initialize
 732  * any downstream switches.
 733  *
 734  * Return: Returns 0 on success or an error code on failure.
 735  */
 736 static int tb_init_port(struct tb_port *port)
 737 {
 738         int res;
 739         int cap;
 740
 741         INIT_LIST_HEAD(&port->list);
 742
 743         /* Control adapter does not have configuration space */
 744         if (!port->port)
 745                 return 0;
 746
 747         res = tb_port_read(port, &port->config, TB_CFG_PORT, 0, 8);
 748         if (res) {
 749                 if (res == -ENODEV) {
 750                         tb_dbg(port->sw->tb, " Port %d: not implemented\n",
 751                                port->port);
 752                         port->disabled = true;
 753                         return 0;
 754                 }
 755                 return res;
 756         }
 757
 758         /* Port 0 is the switch itself and has no PHY. */
 759         if (port->config.type == TB_TYPE_PORT) {
 760                 cap = tb_port_find_cap(port, TB_PORT_CAP_PHY);
 761
 762                 if (cap > 0)
 763                         port->cap_phy = cap;
 764                 else
 765                         tb_port_WARN(port, "non switch port without a PHY\n");
 766
 767                 cap = tb_port_find_cap(port, TB_PORT_CAP_USB4);
 768                 if (cap > 0)
 769                         port->cap_usb4 = cap;
 770
 771                 /*
 772                  * USB4 ports the buffers allocated for the control path
 773                  * can be read from the path config space. Legacy
 774                  * devices we use hard-coded value.
 775                  */
 776                 if (tb_switch_is_usb4(port->sw)) {
 777                         struct tb_regs_hop hop;
 778
 779                         if (!tb_port_read(port, &hop, TB_CFG_HOPS, 0, 2))
 780                                 port->ctl_credits = hop.initial_credits;
 781                 }
 782                 if (!port->ctl_credits)
 783                         port->ctl_credits = 2;
 784
 785         } else {
 786                 cap = tb_port_find_cap(port, TB_PORT_CAP_ADAP);
 787                 if (cap > 0)
 788                         port->cap_adap = cap;
 789         }
 790
 791         port->total_credits =
 792                 (port->config.nfc_credits & ADP_CS_4_TOTAL_BUFFERS_MASK) >>
 793                 ADP_CS_4_TOTAL_BUFFERS_SHIFT;
 794
 795         tb_dump_port(port->sw->tb, port);
 796         return 0;
 797 }
 798
 799 static int tb_port_alloc_hopid(struct tb_port *port, bool in, int min_hopid,
 800                                int max_hopid)
 801 {
 802         int port_max_hopid;
 803         struct ida *ida;
 804
 805         if (in) {
 806                 port_max_hopid = port->config.max_in_hop_id;
 807                 ida = &port->in_hopids;
 808         } else {
 809                 port_max_hopid = port->config.max_out_hop_id;
 810                 ida = &port->out_hopids;
 811         }
 812
 813         /*
 814          * NHI can use HopIDs 1-max for other adapters HopIDs 0-7 are
 815          * reserved.
 816          */
 817         if (!tb_port_is_nhi(port) && min_hopid < TB_PATH_MIN_HOPID)
 818                 min_hopid = TB_PATH_MIN_HOPID;
 819
 820         if (max_hopid < 0 || max_hopid > port_max_hopid)
 821                 max_hopid = port_max_hopid;
 822
 823         return ida_simple_get(ida, min_hopid, max_hopid + 1, GFP_KERNEL);
 824 }
 825
 826 /**
 827  * tb_port_alloc_in_hopid() - Allocate input HopID from port
 828  * @port: Port to allocate HopID for
 829  * @min_hopid: Minimum acceptable input HopID
 830  * @max_hopid: Maximum acceptable input HopID
 831  *
 832  * Return: HopID between @min_hopid and @max_hopid or negative errno in
 833  * case of error.
 834  */
 835 int tb_port_alloc_in_hopid(struct tb_port *port, int min_hopid, int max_hopid)
 836 {
 837         return tb_port_alloc_hopid(port, true, min_hopid, max_hopid);
 838 }
 839
 840 /**
 841  * tb_port_alloc_out_hopid() - Allocate output HopID from port
 842  * @port: Port to allocate HopID for
 843  * @min_hopid: Minimum acceptable output HopID
 844  * @max_hopid: Maximum acceptable output HopID
 845  *
 846  * Return: HopID between @min_hopid and @max_hopid or negative errno in
 847  * case of error.
 848  */
 849 int tb_port_alloc_out_hopid(struct tb_port *port, int min_hopid, int max_hopid)
 850 {
 851         return tb_port_alloc_hopid(port, false, min_hopid, max_hopid);
 852 }
 853
 854 /**
 855  * tb_port_release_in_hopid() - Release allocated input HopID from port
 856  * @port: Port whose HopID to release
 857  * @hopid: HopID to release
 858  */
 859 void tb_port_release_in_hopid(struct tb_port *port, int hopid)
 860 {
 861         ida_simple_remove(&port->in_hopids, hopid);
 862 }
 863
 864 /**
 865  * tb_port_release_out_hopid() - Release allocated output HopID from port
 866  * @port: Port whose HopID to release
 867  * @hopid: HopID to release
 868  */
 869 void tb_port_release_out_hopid(struct tb_port *port, int hopid)
 870 {
 871         ida_simple_remove(&port->out_hopids, hopid);
 872 }
 873
 874 static inline bool tb_switch_is_reachable(const struct tb_switch *parent,
 875                                           const struct tb_switch *sw)
 876 {
 877         u64 mask = (1ULL << parent->config.depth * 8) - 1;
 878         return (tb_route(parent) & mask) == (tb_route(sw) & mask);
 879 }
 880
 881 /**
 882  * tb_next_port_on_path() - Return next port for given port on a path
 883  * @start: Start port of the walk
 884  * @end: End port of the walk
 885  * @prev: Previous port (%NULL if this is the first)
 886  *
 887  * This function can be used to walk from one port to another if they
 888  * are connected through zero or more switches. If the @prev is dual
 889  * link port, the function follows that link and returns another end on
 890  * that same link.
 891  *
 892  * If the @end port has been reached, return %NULL.
 893  *
 894  * Domain tb->lock must be held when this function is called.
 895  */
 896 struct tb_port *tb_next_port_on_path(struct tb_port *start, struct tb_port *end,
 897                                      struct tb_port *prev)
 898 {
 899         struct tb_port *next;
 900
 901         if (!prev)
 902                 return start;
 903
 904         if (prev->sw == end->sw) {
 905                 if (prev == end)
 906                         return NULL;
 907                 return end;
 908         }
 909
 910         if (tb_switch_is_reachable(prev->sw, end->sw)) {
 911                 next = tb_port_at(tb_route(end->sw), prev->sw);
 912                 /* Walk down the topology if next == prev */
 913                 if (prev->remote &&
 914                     (next == prev || next->dual_link_port == prev))
 915                         next = prev->remote;
 916         } else {
 917                 if (tb_is_upstream_port(prev)) {
 918                         next = prev->remote;
 919                 } else {
 920                         next = tb_upstream_port(prev->sw);
 921                         /*
 922                          * Keep the same link if prev and next are both
 923                          * dual link ports.
 924                          */
 925                         if (next->dual_link_port &&
 926                             next->link_nr != prev->link_nr) {
 927                                 next = next->dual_link_port;
 928                         }
 929                 }
 930         }
 931
 932         return next != prev ? next : NULL;
 933 }
 934
 935 /**
 936  * tb_port_get_link_speed() - Get current link speed
 937  * @port: Port to check (USB4 or CIO)
 938  *
 939  * Returns link speed in Gb/s or negative errno in case of failure.
 940  */
 941 int tb_port_get_link_speed(struct tb_port *port)
 942 {
 943         u32 val, speed;
 944         int ret;
 945
 946         if (!port->cap_phy)
 947                 return -EINVAL;
 948
 949         ret = tb_port_read(port, &val, TB_CFG_PORT,
 950                            port->cap_phy + LANE_ADP_CS_1, 1);
 951         if (ret)
 952                 return ret;
 953
 954         speed = (val & LANE_ADP_CS_1_CURRENT_SPEED_MASK) >>
 955                 LANE_ADP_CS_1_CURRENT_SPEED_SHIFT;
 956         return speed == LANE_ADP_CS_1_CURRENT_SPEED_GEN3 ? 20 : 10;
 957 }
 958
 959 /**
 960  * tb_port_get_link_width() - Get current link width
 961  * @port: Port to check (USB4 or CIO)
 962  *
 963  * Returns link width. Return values can be 1 (Single-Lane), 2 (Dual-Lane)
 964  * or negative errno in case of failure.
 965  */
 966 int tb_port_get_link_width(struct tb_port *port)
 967 {
 968         u32 val;
 969         int ret;
 970
 971         if (!port->cap_phy)
 972                 return -EINVAL;
 973
 974         ret = tb_port_read(port, &val, TB_CFG_PORT,
 975                            port->cap_phy + LANE_ADP_CS_1, 1);
 976         if (ret)
 977                 return ret;
 978
 979         return (val & LANE_ADP_CS_1_CURRENT_WIDTH_MASK) >>
 980                 LANE_ADP_CS_1_CURRENT_WIDTH_SHIFT;
 981 }
 982
 983 static bool tb_port_is_width_supported(struct tb_port *port, int width)
 984 {
 985         u32 phy, widths;
 986         int ret;
 987
 988         if (!port->cap_phy)
 989                 return false;
 990
 991         ret = tb_port_read(port, &phy, TB_CFG_PORT,
 992                            port->cap_phy + LANE_ADP_CS_0, 1);
 993         if (ret)
 994                 return false;
 995
 996         widths = (phy & LANE_ADP_CS_0_SUPPORTED_WIDTH_MASK) >>
 997                 LANE_ADP_CS_0_SUPPORTED_WIDTH_SHIFT;
 998
 999         return !!(widths & width);
1000 }
1001
1002 /**
1003  * tb_port_set_link_width() - Set target link width of the lane adapter
1004  * @port: Lane adapter
1005  * @width: Target link width (%1 or %2)
1006  *
1007  * Sets the target link width of the lane adapter to @width. Does not
1008  * enable/disable lane bonding. For that call tb_port_set_lane_bonding().
1009  *
1010  * Return: %0 in case of success and negative errno in case of error
1011  */
1012 int tb_port_set_link_width(struct tb_port *port, unsigned int width)
1013 {
1014         u32 val;
1015         int ret;
1016
1017         if (!port->cap_phy)
1018                 return -EINVAL;
1019
1020         ret = tb_port_read(port, &val, TB_CFG_PORT,
1021                            port->cap_phy + LANE_ADP_CS_1, 1);
1022         if (ret)
1023                 return ret;
1024
1025         val &= ~LANE_ADP_CS_1_TARGET_WIDTH_MASK;
1026         switch (width) {
1027         case 1:
1028                 val |= LANE_ADP_CS_1_TARGET_WIDTH_SINGLE <<
1029                         LANE_ADP_CS_1_TARGET_WIDTH_SHIFT;
1030                 break;
1031         case 2:
1032                 val |= LANE_ADP_CS_1_TARGET_WIDTH_DUAL <<
1033                         LANE_ADP_CS_1_TARGET_WIDTH_SHIFT;
1034                 break;
1035         default:
1036                 return -EINVAL;
1037         }
1038
1039         return tb_port_write(port, &val, TB_CFG_PORT,
1040                              port->cap_phy + LANE_ADP_CS_1, 1);
1041 }
1042
1043 /**
1044  * tb_port_set_lane_bonding() - Enable/disable lane bonding
1045  * @port: Lane adapter
1046  * @bonding: enable/disable bonding
1047  *
1048  * Enables or disables lane bonding. This should be called after target
1049  * link width has been set (tb_port_set_link_width()). Note in most
1050  * cases one should use tb_port_lane_bonding_enable() instead to enable
1051  * lane bonding.
1052  *
1053  * As a side effect sets @port->bonding accordingly (and does the same
1054  * for lane 1 too).
1055  *
1056  * Return: %0 in case of success and negative errno in case of error
1057  */
1058 int tb_port_set_lane_bonding(struct tb_port *port, bool bonding)
1059 {
1060         u32 val;
1061         int ret;
1062
1063         if (!port->cap_phy)
1064                 return -EINVAL;
1065
1066         ret = tb_port_read(port, &val, TB_CFG_PORT,
1067                            port->cap_phy + LANE_ADP_CS_1, 1);
1068         if (ret)
1069                 return ret;
1070
1071         if (bonding)
1072                 val |= LANE_ADP_CS_1_LB;
1073         else
1074                 val &= ~LANE_ADP_CS_1_LB;
1075
1076         ret = tb_port_write(port, &val, TB_CFG_PORT,
1077                             port->cap_phy + LANE_ADP_CS_1, 1);
1078         if (ret)
1079                 return ret;
1080
1081         /*
1082          * When lane 0 bonding is set it will affect lane 1 too so
1083          * update both.
1084          */
1085         port->bonded = bonding;
1086         port->dual_link_port->bonded = bonding;
1087
1088         return 0;
1089 }
1090
1091 /**
1092  * tb_port_lane_bonding_enable() - Enable bonding on port
1093  * @port: port to enable
1094  *
1095  * Enable bonding by setting the link width of the port and the other
1096  * port in case of dual link port. Does not wait for the link to
1097  * actually reach the bonded state so caller needs to call
1098  * tb_port_wait_for_link_width() before enabling any paths through the
1099  * link to make sure the link is in expected state.
1100  *
1101  * Return: %0 in case of success and negative errno in case of error
1102  */
1103 int tb_port_lane_bonding_enable(struct tb_port *port)
1104 {
1105         int ret;
1106
1107         /*
1108          * Enable lane bonding for both links if not already enabled by
1109          * for example the boot firmware.
1110          */
1111         ret = tb_port_get_link_width(port);
1112         if (ret == 1) {
1113                 ret = tb_port_set_link_width(port, 2);
1114                 if (ret)
1115                         goto err_lane0;
1116         }
1117
1118         ret = tb_port_get_link_width(port->dual_link_port);
1119         if (ret == 1) {
1120                 ret = tb_port_set_link_width(port->dual_link_port, 2);
1121                 if (ret)
1122                         goto err_lane0;
1123         }
1124
1125         ret = tb_port_set_lane_bonding(port, true);
1126         if (ret)
1127                 goto err_lane1;
1128
1129         return 0;
1130
1131 err_lane1:
1132         tb_port_set_link_width(port->dual_link_port, 1);
1133 err_lane0:
1134         tb_port_set_link_width(port, 1);
1135         return ret;
1136 }
1137
1138 /**
1139  * tb_port_lane_bonding_disable() - Disable bonding on port
1140  * @port: port to disable
1141  *
1142  * Disable bonding by setting the link width of the port and the
1143  * other port in case of dual link port.
1144  */
1145 void tb_port_lane_bonding_disable(struct tb_port *port)
1146 {
1147         tb_port_set_lane_bonding(port, false);
1148         tb_port_set_link_width(port->dual_link_port, 1);
1149         tb_port_set_link_width(port, 1);
1150 }
1151
1152 /**
1153  * tb_port_wait_for_link_width() - Wait until link reaches specific width
1154  * @port: Port to wait for
1155  * @width: Expected link width (%1 or %2)
1156  * @timeout_msec: Timeout in ms how long to wait
1157  *
1158  * Should be used after both ends of the link have been bonded (or
1159  * bonding has been disabled) to wait until the link actually reaches
1160  * the expected state. Returns %-ETIMEDOUT if the @width was not reached
1161  * within the given timeout, %0 if it did.
1162  */
1163 int tb_port_wait_for_link_width(struct tb_port *port, int width,
1164                                 int timeout_msec)
1165 {
1166         ktime_t timeout = ktime_add_ms(ktime_get(), timeout_msec);
1167         int ret;
1168
1169         do {
1170                 ret = tb_port_get_link_width(port);
1171                 if (ret < 0) {
1172                         /*
1173                          * Sometimes we get port locked error when
1174                          * polling the lanes so we can ignore it and
1175                          * retry.
1176                          */
1177                         if (ret != -EACCES)
1178                                 return ret;
1179                 } else if (ret == width) {
1180                         return 0;
1181                 }
1182
1183                 usleep_range(1000, 2000);
1184         } while (ktime_before(ktime_get(), timeout));
1185
1186         return -ETIMEDOUT;
1187 }
1188
1189 static int tb_port_do_update_credits(struct tb_port *port)
1190 {
1191         u32 nfc_credits;
1192         int ret;
1193
1194         ret = tb_port_read(port, &nfc_credits, TB_CFG_PORT, ADP_CS_4, 1);
1195         if (ret)
1196                 return ret;
1197
1198         if (nfc_credits != port->config.nfc_credits) {
1199                 u32 total;
1200
1201                 total = (nfc_credits & ADP_CS_4_TOTAL_BUFFERS_MASK) >>
1202                         ADP_CS_4_TOTAL_BUFFERS_SHIFT;
1203
1204                 tb_port_dbg(port, "total credits changed %u -> %u\n",
1205                             port->total_credits, total);
1206
1207                 port->config.nfc_credits = nfc_credits;
1208                 port->total_credits = total;
1209         }
1210
1211         return 0;
1212 }
1213
1214 /**
1215  * tb_port_update_credits() - Re-read port total credits
1216  * @port: Port to update
1217  *
1218  * After the link is bonded (or bonding was disabled) the port total
1219  * credits may change, so this function needs to be called to re-read
1220  * the credits. Updates also the second lane adapter.
1221  */
1222 int tb_port_update_credits(struct tb_port *port)
1223 {
1224         int ret;
1225
1226         ret = tb_port_do_update_credits(port);
1227         if (ret)
1228                 return ret;
1229         return tb_port_do_update_credits(port->dual_link_port);
1230 }
1231
1232 static int __tb_port_pm_secondary_set(struct tb_port *port, bool secondary)
1233 {
1234         u32 phy;
1235         int ret;
1236
1237         ret = tb_port_read(port, &phy, TB_CFG_PORT,
1238                            port->cap_phy + LANE_ADP_CS_1, 1);
1239         if (ret)
1240                 return ret;
1241
1242         if (secondary)
1243                 phy |= LANE_ADP_CS_1_PMS;
1244         else
1245                 phy &= ~LANE_ADP_CS_1_PMS;
1246
1247         return tb_port_write(port, &phy, TB_CFG_PORT,
1248                              port->cap_phy + LANE_ADP_CS_1, 1);
1249 }
1250
1251 static int tb_port_pm_secondary_enable(struct tb_port *port)
1252 {
1253         return __tb_port_pm_secondary_set(port, true);
1254 }
1255
1256 static int tb_port_pm_secondary_disable(struct tb_port *port)
1257 {
1258         return __tb_port_pm_secondary_set(port, false);
1259 }
1260
1261 /* Called for USB4 or Titan Ridge routers only */
1262 static bool tb_port_clx_supported(struct tb_port *port, unsigned int clx_mask)
1263 {
1264         u32 val, mask = 0;
1265         bool ret;
1266
1267         /* Don't enable CLx in case of two single-lane links */
1268         if (!port->bonded && port->dual_link_port)
1269                 return false;
1270
1271         /* Don't enable CLx in case of inter-domain link */
1272         if (port->xdomain)
1273                 return false;
1274
1275         if (tb_switch_is_usb4(port->sw)) {
1276                 if (!usb4_port_clx_supported(port))
1277                         return false;
1278         } else if (!tb_lc_is_clx_supported(port)) {
1279                 return false;
1280         }
1281
1282         if (clx_mask & TB_CL1) {
1283                 /* CL0s and CL1 are enabled and supported together */
1284                 mask |= LANE_ADP_CS_0_CL0S_SUPPORT | LANE_ADP_CS_0_CL1_SUPPORT;
1285         }
1286         if (clx_mask & TB_CL2)
1287                 mask |= LANE_ADP_CS_0_CL2_SUPPORT;
1288
1289         ret = tb_port_read(port, &val, TB_CFG_PORT,
1290                            port->cap_phy + LANE_ADP_CS_0, 1);
1291         if (ret)
1292                 return false;
1293
1294         return !!(val & mask);
1295 }
1296
1297 static int __tb_port_clx_set(struct tb_port *port, enum tb_clx clx, bool enable)
1298 {
1299         u32 phy, mask;
1300         int ret;
1301
1302         /* CL0s and CL1 are enabled and supported together */
1303         if (clx == TB_CL1)
1304                 mask = LANE_ADP_CS_1_CL0S_ENABLE | LANE_ADP_CS_1_CL1_ENABLE;
1305         else
1306                 /* For now we support only CL0s and CL1. Not CL2 */
1307                 return -EOPNOTSUPP;
1308
1309         ret = tb_port_read(port, &phy, TB_CFG_PORT,
1310                            port->cap_phy + LANE_ADP_CS_1, 1);
1311         if (ret)
1312                 return ret;
1313
1314         if (enable)
1315                 phy |= mask;
1316         else
1317                 phy &= ~mask;
1318
1319         return tb_port_write(port, &phy, TB_CFG_PORT,
1320                              port->cap_phy + LANE_ADP_CS_1, 1);
1321 }
1322
1323 static int tb_port_clx_disable(struct tb_port *port, enum tb_clx clx)
1324 {
1325         return __tb_port_clx_set(port, clx, false);
1326 }
1327
1328 static int tb_port_clx_enable(struct tb_port *port, enum tb_clx clx)
1329 {
1330         return __tb_port_clx_set(port, clx, true);
1331 }
1332
1333 static int tb_port_start_lane_initialization(struct tb_port *port)
1334 {
1335         int ret;
1336
1337         if (tb_switch_is_usb4(port->sw))
1338                 return 0;
1339
1340         ret = tb_lc_start_lane_initialization(port);
1341         return ret == -EINVAL ? 0 : ret;
1342 }
1343
1344 /*
1345  * Returns true if the port had something (router, XDomain) connected
1346  * before suspend.
1347  */
1348 static bool tb_port_resume(struct tb_port *port)
1349 {
1350         bool has_remote = tb_port_has_remote(port);
1351
1352         if (port->usb4) {
1353                 usb4_port_device_resume(port->usb4);
1354         } else if (!has_remote) {
1355                 /*
1356                  * For disconnected downstream lane adapters start lane
1357                  * initialization now so we detect future connects.
1358                  *
1359                  * For XDomain start the lane initialzation now so the
1360                  * link gets re-established.
1361                  *
1362                  * This is only needed for non-USB4 ports.
1363                  */
1364                 if (!tb_is_upstream_port(port) || port->xdomain)
1365                         tb_port_start_lane_initialization(port);
1366         }
1367
1368         return has_remote || port->xdomain;
1369 }
1370
1371 /**
1372  * tb_port_is_enabled() - Is the adapter port enabled
1373  * @port: Port to check
1374  */
1375 bool tb_port_is_enabled(struct tb_port *port)
1376 {
1377         switch (port->config.type) {
1378         case TB_TYPE_PCIE_UP:
1379         case TB_TYPE_PCIE_DOWN:
1380                 return tb_pci_port_is_enabled(port);
1381
1382         case TB_TYPE_DP_HDMI_IN:
1383         case TB_TYPE_DP_HDMI_OUT:
1384                 return tb_dp_port_is_enabled(port);
1385
1386         case TB_TYPE_USB3_UP:
1387         case TB_TYPE_USB3_DOWN:
1388                 return tb_usb3_port_is_enabled(port);
1389
1390         default:
1391                 return false;
1392         }
1393 }
1394
1395 /**
1396  * tb_usb3_port_is_enabled() - Is the USB3 adapter port enabled
1397  * @port: USB3 adapter port to check
1398  */
1399 bool tb_usb3_port_is_enabled(struct tb_port *port)
1400 {
1401         u32 data;
1402
1403         if (tb_port_read(port, &data, TB_CFG_PORT,
1404                          port->cap_adap + ADP_USB3_CS_0, 1))
1405                 return false;
1406
1407         return !!(data & ADP_USB3_CS_0_PE);
1408 }
1409
1410 /**
1411  * tb_usb3_port_enable() - Enable USB3 adapter port
1412  * @port: USB3 adapter port to enable
1413  * @enable: Enable/disable the USB3 adapter
1414  */
1415 int tb_usb3_port_enable(struct tb_port *port, bool enable)
1416 {
1417         u32 word = enable ? (ADP_USB3_CS_0_PE | ADP_USB3_CS_0_V)
1418                           : ADP_USB3_CS_0_V;
1419
1420         if (!port->cap_adap)
1421                 return -ENXIO;
1422         return tb_port_write(port, &word, TB_CFG_PORT,
1423                              port->cap_adap + ADP_USB3_CS_0, 1);
1424 }
1425
1426 /**
1427  * tb_pci_port_is_enabled() - Is the PCIe adapter port enabled
1428  * @port: PCIe port to check
1429  */
1430 bool tb_pci_port_is_enabled(struct tb_port *port)
1431 {
1432         u32 data;
1433
1434         if (tb_port_read(port, &data, TB_CFG_PORT,
1435                          port->cap_adap + ADP_PCIE_CS_0, 1))
1436                 return false;
1437
1438         return !!(data & ADP_PCIE_CS_0_PE);
1439 }
1440
1441 /**
1442  * tb_pci_port_enable() - Enable PCIe adapter port
1443  * @port: PCIe port to enable
1444  * @enable: Enable/disable the PCIe adapter
1445  */
1446 int tb_pci_port_enable(struct tb_port *port, bool enable)
1447 {
1448         u32 word = enable ? ADP_PCIE_CS_0_PE : 0x0;
1449         if (!port->cap_adap)
1450                 return -ENXIO;
1451         return tb_port_write(port, &word, TB_CFG_PORT,
1452                              port->cap_adap + ADP_PCIE_CS_0, 1);
1453 }
1454
1455 /**
1456  * tb_dp_port_hpd_is_active() - Is HPD already active
1457  * @port: DP out port to check
1458  *
1459  * Checks if the DP OUT adapter port has HDP bit already set.
1460  */
1461 int tb_dp_port_hpd_is_active(struct tb_port *port)
1462 {
1463         u32 data;
1464         int ret;
1465
1466         ret = tb_port_read(port, &data, TB_CFG_PORT,
1467                            port->cap_adap + ADP_DP_CS_2, 1);
1468         if (ret)
1469                 return ret;
1470
1471         return !!(data & ADP_DP_CS_2_HDP);
1472 }
1473
1474 /**
1475  * tb_dp_port_hpd_clear() - Clear HPD from DP IN port
1476  * @port: Port to clear HPD
1477  *
1478  * If the DP IN port has HDP set, this function can be used to clear it.
1479  */
1480 int tb_dp_port_hpd_clear(struct tb_port *port)
1481 {
1482         u32 data;
1483         int ret;
1484
1485         ret = tb_port_read(port, &data, TB_CFG_PORT,
1486                            port->cap_adap + ADP_DP_CS_3, 1);
1487         if (ret)
1488                 return ret;
1489
1490         data |= ADP_DP_CS_3_HDPC;
1491         return tb_port_write(port, &data, TB_CFG_PORT,
1492                              port->cap_adap + ADP_DP_CS_3, 1);
1493 }
1494
1495 /**
1496  * tb_dp_port_set_hops() - Set video/aux Hop IDs for DP port
1497  * @port: DP IN/OUT port to set hops
1498  * @video: Video Hop ID
1499  * @aux_tx: AUX TX Hop ID
1500  * @aux_rx: AUX RX Hop ID
1501  *
1502  * Programs specified Hop IDs for DP IN/OUT port. Can be called for USB4
1503  * router DP adapters too but does not program the values as the fields
1504  * are read-only.
1505  */
1506 int tb_dp_port_set_hops(struct tb_port *port, unsigned int video,
1507                         unsigned int aux_tx, unsigned int aux_rx)
1508 {
1509         u32 data[2];
1510         int ret;
1511
1512         if (tb_switch_is_usb4(port->sw))
1513                 return 0;
1514
1515         ret = tb_port_read(port, data, TB_CFG_PORT,
1516                            port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1517         if (ret)
1518                 return ret;
1519
1520         data[0] &= ~ADP_DP_CS_0_VIDEO_HOPID_MASK;
1521         data[1] &= ~ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1522         data[1] &= ~ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1523
1524         data[0] |= (video << ADP_DP_CS_0_VIDEO_HOPID_SHIFT) &
1525                 ADP_DP_CS_0_VIDEO_HOPID_MASK;
1526         data[1] |= aux_tx & ADP_DP_CS_1_AUX_TX_HOPID_MASK;
1527         data[1] |= (aux_rx << ADP_DP_CS_1_AUX_RX_HOPID_SHIFT) &
1528                 ADP_DP_CS_1_AUX_RX_HOPID_MASK;
1529
1530         return tb_port_write(port, data, TB_CFG_PORT,
1531                              port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1532 }
1533
1534 /**
1535  * tb_dp_port_is_enabled() - Is DP adapter port enabled
1536  * @port: DP adapter port to check
1537  */
1538 bool tb_dp_port_is_enabled(struct tb_port *port)
1539 {
1540         u32 data[2];
1541
1542         if (tb_port_read(port, data, TB_CFG_PORT, port->cap_adap + ADP_DP_CS_0,
1543                          ARRAY_SIZE(data)))
1544                 return false;
1545
1546         return !!(data[0] & (ADP_DP_CS_0_VE | ADP_DP_CS_0_AE));
1547 }
1548
1549 /**
1550  * tb_dp_port_enable() - Enables/disables DP paths of a port
1551  * @port: DP IN/OUT port
1552  * @enable: Enable/disable DP path
1553  *
1554  * Once Hop IDs are programmed DP paths can be enabled or disabled by
1555  * calling this function.
1556  */
1557 int tb_dp_port_enable(struct tb_port *port, bool enable)
1558 {
1559         u32 data[2];
1560         int ret;
1561
1562         ret = tb_port_read(port, data, TB_CFG_PORT,
1563                           port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1564         if (ret)
1565                 return ret;
1566
1567         if (enable)
1568                 data[0] |= ADP_DP_CS_0_VE | ADP_DP_CS_0_AE;
1569         else
1570                 data[0] &= ~(ADP_DP_CS_0_VE | ADP_DP_CS_0_AE);
1571
1572         return tb_port_write(port, data, TB_CFG_PORT,
1573                              port->cap_adap + ADP_DP_CS_0, ARRAY_SIZE(data));
1574 }
1575
1576 /* switch utility functions */
1577
1578 static const char *tb_switch_generation_name(const struct tb_switch *sw)
1579 {
1580         switch (sw->generation) {
1581         case 1:
1582                 return "Thunderbolt 1";
1583         case 2:
1584                 return "Thunderbolt 2";
1585         case 3:
1586                 return "Thunderbolt 3";
1587         case 4:
1588                 return "USB4";
1589         default:
1590                 return "Unknown";
1591         }
1592 }
1593
1594 static void tb_dump_switch(const struct tb *tb, const struct tb_switch *sw)
1595 {
1596         const struct tb_regs_switch_header *regs = &sw->config;
1597
1598         tb_dbg(tb, " %s Switch: %x:%x (Revision: %d, TB Version: %d)\n",
1599                tb_switch_generation_name(sw), regs->vendor_id, regs->device_id,
1600                regs->revision, regs->thunderbolt_version);
1601         tb_dbg(tb, "  Max Port Number: %d\n", regs->max_port_number);
1602         tb_dbg(tb, "  Config:\n");
1603         tb_dbg(tb,
1604                 "   Upstream Port Number: %d Depth: %d Route String: %#llx Enabled: %d, PlugEventsDelay: %dms\n",
1605                regs->upstream_port_number, regs->depth,
1606                (((u64) regs->route_hi) << 32) | regs->route_lo,
1607                regs->enabled, regs->plug_events_delay);
1608         tb_dbg(tb, "   unknown1: %#x unknown4: %#x\n",
1609                regs->__unknown1, regs->__unknown4);
1610 }
1611
1612 /**
1613  * tb_switch_reset() - reconfigure route, enable and send TB_CFG_PKG_RESET
1614  * @sw: Switch to reset
1615  *
1616  * Return: Returns 0 on success or an error code on failure.
1617  */
1618 int tb_switch_reset(struct tb_switch *sw)
1619 {
1620         struct tb_cfg_result res;
1621
1622         if (sw->generation > 1)
1623                 return 0;
1624
1625         tb_sw_dbg(sw, "resetting switch\n");
1626
1627         res.err = tb_sw_write(sw, ((u32 *) &sw->config) + 2,
1628                               TB_CFG_SWITCH, 2, 2);
1629         if (res.err)
1630                 return res.err;
1631         res = tb_cfg_reset(sw->tb->ctl, tb_route(sw));
1632         if (res.err > 0)
1633                 return -EIO;
1634         return res.err;
1635 }
1636
1637 /**
1638  * tb_switch_wait_for_bit() - Wait for specified value of bits in offset
1639  * @sw: Router to read the offset value from
1640  * @offset: Offset in the router config space to read from
1641  * @bit: Bit mask in the offset to wait for
1642  * @value: Value of the bits to wait for
1643  * @timeout_msec: Timeout in ms how long to wait
1644  *
1645  * Wait till the specified bits in specified offset reach specified value.
1646  * Returns %0 in case of success, %-ETIMEDOUT if the @value was not reached
1647  * within the given timeout or a negative errno in case of failure.
1648  */
1649 int tb_switch_wait_for_bit(struct tb_switch *sw, u32 offset, u32 bit,
1650                            u32 value, int timeout_msec)
1651 {
1652         ktime_t timeout = ktime_add_ms(ktime_get(), timeout_msec);
1653
1654         do {
1655                 u32 val;
1656                 int ret;
1657
1658                 ret = tb_sw_read(sw, &val, TB_CFG_SWITCH, offset, 1);
1659                 if (ret)
1660                         return ret;
1661
1662                 if ((val & bit) == value)
1663                         return 0;
1664
1665                 usleep_range(50, 100);
1666         } while (ktime_before(ktime_get(), timeout));
1667
1668         return -ETIMEDOUT;
1669 }
1670
1671 /*
1672  * tb_plug_events_active() - enable/disable plug events on a switch
1673  *
1674  * Also configures a sane plug_events_delay of 255ms.
1675  *
1676  * Return: Returns 0 on success or an error code on failure.
1677  */
1678 static int tb_plug_events_active(struct tb_switch *sw, bool active)
1679 {
1680         u32 data;
1681         int res;
1682
1683         if (tb_switch_is_icm(sw) || tb_switch_is_usb4(sw))
1684                 return 0;
1685
1686         sw->config.plug_events_delay = 0xff;
1687         res = tb_sw_write(sw, ((u32 *) &sw->config) + 4, TB_CFG_SWITCH, 4, 1);
1688         if (res)
1689                 return res;
1690
1691         res = tb_sw_read(sw, &data, TB_CFG_SWITCH, sw->cap_plug_events + 1, 1);
1692         if (res)
1693                 return res;
1694
1695         if (active) {
1696                 data = data & 0xFFFFFF83;
1697                 switch (sw->config.device_id) {
1698                 case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
1699                 case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
1700                 case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
1701                         break;
1702                 default:
1703                         /*
1704                          * Skip Alpine Ridge, it needs to have vendor
1705                          * specific USB hotplug event enabled for the
1706                          * internal xHCI to work.
1707                          */
1708                         if (!tb_switch_is_alpine_ridge(sw))
1709                                 data |= TB_PLUG_EVENTS_USB_DISABLE;
1710                 }
1711         } else {
1712                 data = data | 0x7c;
1713         }
1714         return tb_sw_write(sw, &data, TB_CFG_SWITCH,
1715                            sw->cap_plug_events + 1, 1);
1716 }
1717
1718 static ssize_t authorized_show(struct device *dev,
1719                                struct device_attribute *attr,
1720                                char *buf)
1721 {
1722         struct tb_switch *sw = tb_to_switch(dev);
1723
1724         return sprintf(buf, "%u\n", sw->authorized);
1725 }
1726
1727 static int disapprove_switch(struct device *dev, void *not_used)
1728 {
1729         char *envp[] = { "AUTHORIZED=0", NULL };
1730         struct tb_switch *sw;
1731
1732         sw = tb_to_switch(dev);
1733         if (sw && sw->authorized) {
1734                 int ret;
1735
1736                 /* First children */
1737                 ret = device_for_each_child_reverse(&sw->dev, NULL, disapprove_switch);
1738                 if (ret)
1739                         return ret;
1740
1741                 ret = tb_domain_disapprove_switch(sw->tb, sw);
1742                 if (ret)
1743                         return ret;
1744
1745                 sw->authorized = 0;
1746                 kobject_uevent_env(&sw->dev.kobj, KOBJ_CHANGE, envp);
1747         }
1748
1749         return 0;
1750 }
1751
1752 static int tb_switch_set_authorized(struct tb_switch *sw, unsigned int val)
1753 {
1754         char envp_string[13];
1755         int ret = -EINVAL;
1756         char *envp[] = { envp_string, NULL };
1757
1758         if (!mutex_trylock(&sw->tb->lock))
1759                 return restart_syscall();
1760
1761         if (!!sw->authorized == !!val)
1762                 goto unlock;
1763
1764         switch (val) {
1765         /* Disapprove switch */
1766         case 0:
1767                 if (tb_route(sw)) {
1768                         ret = disapprove_switch(&sw->dev, NULL);
1769                         goto unlock;
1770                 }
1771                 break;
1772
1773         /* Approve switch */
1774         case 1:
1775                 if (sw->key)
1776                         ret = tb_domain_approve_switch_key(sw->tb, sw);
1777                 else
1778                         ret = tb_domain_approve_switch(sw->tb, sw);
1779                 break;
1780
1781         /* Challenge switch */
1782         case 2:
1783                 if (sw->key)
1784                         ret = tb_domain_challenge_switch_key(sw->tb, sw);
1785                 break;
1786
1787         default:
1788                 break;
1789         }
1790
1791         if (!ret) {
1792                 sw->authorized = val;
1793                 /*
1794                  * Notify status change to the userspace, informing the new
1795                  * value of /sys/bus/thunderbolt/devices/.../authorized.
1796                  */
1797                 sprintf(envp_string, "AUTHORIZED=%u", sw->authorized);
1798                 kobject_uevent_env(&sw->dev.kobj, KOBJ_CHANGE, envp);
1799         }
1800
1801 unlock:
1802         mutex_unlock(&sw->tb->lock);
1803         return ret;
1804 }
1805
1806 static ssize_t authorized_store(struct device *dev,
1807                                 struct device_attribute *attr,
1808                                 const char *buf, size_t count)
1809 {
1810         struct tb_switch *sw = tb_to_switch(dev);
1811         unsigned int val;
1812         ssize_t ret;
1813
1814         ret = kstrtouint(buf, 0, &val);
1815         if (ret)
1816                 return ret;
1817         if (val > 2)
1818                 return -EINVAL;
1819
1820         pm_runtime_get_sync(&sw->dev);
1821         ret = tb_switch_set_authorized(sw, val);
1822         pm_runtime_mark_last_busy(&sw->dev);
1823         pm_runtime_put_autosuspend(&sw->dev);
1824
1825         return ret ? ret : count;
1826 }
1827 static DEVICE_ATTR_RW(authorized);
1828
1829 static ssize_t boot_show(struct device *dev, struct device_attribute *attr,
1830                          char *buf)
1831 {
1832         struct tb_switch *sw = tb_to_switch(dev);
1833
1834         return sprintf(buf, "%u\n", sw->boot);
1835 }
1836 static DEVICE_ATTR_RO(boot);
1837
1838 static ssize_t device_show(struct device *dev, struct device_attribute *attr,
1839                            char *buf)
1840 {
1841         struct tb_switch *sw = tb_to_switch(dev);
1842
1843         return sprintf(buf, "%#x\n", sw->device);
1844 }
1845 static DEVICE_ATTR_RO(device);
1846
1847 static ssize_t
1848 device_name_show(struct device *dev, struct device_attribute *attr, char *buf)
1849 {
1850         struct tb_switch *sw = tb_to_switch(dev);
1851
1852         return sprintf(buf, "%s\n", sw->device_name ? sw->device_name : "");
1853 }
1854 static DEVICE_ATTR_RO(device_name);
1855
1856 static ssize_t
1857 generation_show(struct device *dev, struct device_attribute *attr, char *buf)
1858 {
1859         struct tb_switch *sw = tb_to_switch(dev);
1860
1861         return sprintf(buf, "%u\n", sw->generation);
1862 }
1863 static DEVICE_ATTR_RO(generation);
1864
1865 static ssize_t key_show(struct device *dev, struct device_attribute *attr,
1866                         char *buf)
1867 {
1868         struct tb_switch *sw = tb_to_switch(dev);
1869         ssize_t ret;
1870
1871         if (!mutex_trylock(&sw->tb->lock))
1872                 return restart_syscall();
1873
1874         if (sw->key)
1875                 ret = sprintf(buf, "%*phN\n", TB_SWITCH_KEY_SIZE, sw->key);
1876         else
1877                 ret = sprintf(buf, "\n");
1878
1879         mutex_unlock(&sw->tb->lock);
1880         return ret;
1881 }
1882
1883 static ssize_t key_store(struct device *dev, struct device_attribute *attr,
1884                          const char *buf, size_t count)
1885 {
1886         struct tb_switch *sw = tb_to_switch(dev);
1887         u8 key[TB_SWITCH_KEY_SIZE];
1888         ssize_t ret = count;
1889         bool clear = false;
1890
1891         if (!strcmp(buf, "\n"))
1892                 clear = true;
1893         else if (hex2bin(key, buf, sizeof(key)))
1894                 return -EINVAL;
1895
1896         if (!mutex_trylock(&sw->tb->lock))
1897                 return restart_syscall();
1898
1899         if (sw->authorized) {
1900                 ret = -EBUSY;
1901         } else {
1902                 kfree(sw->key);
1903                 if (clear) {
1904                         sw->key = NULL;
1905                 } else {
1906                         sw->key = kmemdup(key, sizeof(key), GFP_KERNEL);
1907                         if (!sw->key)
1908                                 ret = -ENOMEM;
1909                 }
1910         }
1911
1912         mutex_unlock(&sw->tb->lock);
1913         return ret;
1914 }
1915 static DEVICE_ATTR(key, 0600, key_show, key_store);
1916
1917 static ssize_t speed_show(struct device *dev, struct device_attribute *attr,
1918                           char *buf)
1919 {
1920         struct tb_switch *sw = tb_to_switch(dev);
1921
1922         return sprintf(buf, "%u.0 Gb/s\n", sw->link_speed);
1923 }
1924
1925 /*
1926  * Currently all lanes must run at the same speed but we expose here
1927  * both directions to allow possible asymmetric links in the future.
1928  */
1929 static DEVICE_ATTR(rx_speed, 0444, speed_show, NULL);
1930 static DEVICE_ATTR(tx_speed, 0444, speed_show, NULL);
1931
1932 static ssize_t lanes_show(struct device *dev, struct device_attribute *attr,
1933                           char *buf)
1934 {
1935         struct tb_switch *sw = tb_to_switch(dev);
1936
1937         return sprintf(buf, "%u\n", sw->link_width);
1938 }
1939
1940 /*
1941  * Currently link has same amount of lanes both directions (1 or 2) but
1942  * expose them separately to allow possible asymmetric links in the future.
1943  */
1944 static DEVICE_ATTR(rx_lanes, 0444, lanes_show, NULL);
1945 static DEVICE_ATTR(tx_lanes, 0444, lanes_show, NULL);
1946
1947 static ssize_t nvm_authenticate_show(struct device *dev,
1948         struct device_attribute *attr, char *buf)
1949 {
1950         struct tb_switch *sw = tb_to_switch(dev);
1951         u32 status;
1952
1953         nvm_get_auth_status(sw, &status);
1954         return sprintf(buf, "%#x\n", status);
1955 }
1956
1957 static ssize_t nvm_authenticate_sysfs(struct device *dev, const char *buf,
1958                                       bool disconnect)
1959 {
1960         struct tb_switch *sw = tb_to_switch(dev);
1961         int val, ret;
1962
1963         pm_runtime_get_sync(&sw->dev);
1964
1965         if (!mutex_trylock(&sw->tb->lock)) {
1966                 ret = restart_syscall();
1967                 goto exit_rpm;
1968         }
1969
1970         /* If NVMem devices are not yet added */
1971         if (!sw->nvm) {
1972                 ret = -EAGAIN;
1973                 goto exit_unlock;
1974         }
1975
1976         ret = kstrtoint(buf, 10, &val);
1977         if (ret)
1978                 goto exit_unlock;
1979
1980         /* Always clear the authentication status */
1981         nvm_clear_auth_status(sw);
1982
1983         if (val > 0) {
1984                 if (val == AUTHENTICATE_ONLY) {
1985                         if (disconnect)
1986                                 ret = -EINVAL;
1987                         else
1988                                 ret = nvm_authenticate(sw, true);
1989                 } else {
1990                         if (!sw->nvm->flushed) {
1991                                 if (!sw->nvm->buf) {
1992                                         ret = -EINVAL;
1993                                         goto exit_unlock;
1994                                 }
1995
1996                                 ret = nvm_validate_and_write(sw);
1997                                 if (ret || val == WRITE_ONLY)
1998                                         goto exit_unlock;
1999                         }
2000                         if (val == WRITE_AND_AUTHENTICATE) {
2001                                 if (disconnect)
2002                                         ret = tb_lc_force_power(sw);
2003                                 else
2004                                         ret = nvm_authenticate(sw, false);
2005                         }
2006                 }
2007         }
2008
2009 exit_unlock:
2010         mutex_unlock(&sw->tb->lock);
2011 exit_rpm:
2012         pm_runtime_mark_last_busy(&sw->dev);
2013         pm_runtime_put_autosuspend(&sw->dev);
2014
2015         return ret;
2016 }
2017
2018 static ssize_t nvm_authenticate_store(struct device *dev,
2019         struct device_attribute *attr, const char *buf, size_t count)
2020 {
2021         int ret = nvm_authenticate_sysfs(dev, buf, false);
2022         if (ret)
2023                 return ret;
2024         return count;
2025 }
2026 static DEVICE_ATTR_RW(nvm_authenticate);
2027
2028 static ssize_t nvm_authenticate_on_disconnect_show(struct device *dev,
2029         struct device_attribute *attr, char *buf)
2030 {
2031         return nvm_authenticate_show(dev, attr, buf);
2032 }
2033
2034 static ssize_t nvm_authenticate_on_disconnect_store(struct device *dev,
2035         struct device_attribute *attr, const char *buf, size_t count)
2036 {
2037         int ret;
2038
2039         ret = nvm_authenticate_sysfs(dev, buf, true);
2040         return ret ? ret : count;
2041 }
2042 static DEVICE_ATTR_RW(nvm_authenticate_on_disconnect);
2043
2044 static ssize_t nvm_version_show(struct device *dev,
2045                                 struct device_attribute *attr, char *buf)
2046 {
2047         struct tb_switch *sw = tb_to_switch(dev);
2048         int ret;
2049
2050         if (!mutex_trylock(&sw->tb->lock))
2051                 return restart_syscall();
2052
2053         if (sw->safe_mode)
2054                 ret = -ENODATA;
2055         else if (!sw->nvm)
2056                 ret = -EAGAIN;
2057         else
2058                 ret = sprintf(buf, "%x.%x\n", sw->nvm->major, sw->nvm->minor);
2059
2060         mutex_unlock(&sw->tb->lock);
2061
2062         return ret;
2063 }
2064 static DEVICE_ATTR_RO(nvm_version);
2065
2066 static ssize_t vendor_show(struct device *dev, struct device_attribute *attr,
2067                            char *buf)
2068 {
2069         struct tb_switch *sw = tb_to_switch(dev);
2070
2071         return sprintf(buf, "%#x\n", sw->vendor);
2072 }
2073 static DEVICE_ATTR_RO(vendor);
2074
2075 static ssize_t
2076 vendor_name_show(struct device *dev, struct device_attribute *attr, char *buf)
2077 {
2078         struct tb_switch *sw = tb_to_switch(dev);
2079
2080         return sprintf(buf, "%s\n", sw->vendor_name ? sw->vendor_name : "");
2081 }
2082 static DEVICE_ATTR_RO(vendor_name);
2083
2084 static ssize_t unique_id_show(struct device *dev, struct device_attribute *attr,
2085                               char *buf)
2086 {
2087         struct tb_switch *sw = tb_to_switch(dev);
2088
2089         return sprintf(buf, "%pUb\n", sw->uuid);
2090 }
2091 static DEVICE_ATTR_RO(unique_id);
2092
2093 static struct attribute *switch_attrs[] = {
2094         &dev_attr_authorized.attr,
2095         &dev_attr_boot.attr,
2096         &dev_attr_device.attr,
2097         &dev_attr_device_name.attr,
2098         &dev_attr_generation.attr,
2099         &dev_attr_key.attr,
2100         &dev_attr_nvm_authenticate.attr,
2101         &dev_attr_nvm_authenticate_on_disconnect.attr,
2102         &dev_attr_nvm_version.attr,
2103         &dev_attr_rx_speed.attr,
2104         &dev_attr_rx_lanes.attr,
2105         &dev_attr_tx_speed.attr,
2106         &dev_attr_tx_lanes.attr,
2107         &dev_attr_vendor.attr,
2108         &dev_attr_vendor_name.attr,
2109         &dev_attr_unique_id.attr,
2110         NULL,
2111 };
2112
2113 static umode_t switch_attr_is_visible(struct kobject *kobj,
2114                                       struct attribute *attr, int n)
2115 {
2116         struct device *dev = kobj_to_dev(kobj);
2117         struct tb_switch *sw = tb_to_switch(dev);
2118
2119         if (attr == &dev_attr_authorized.attr) {
2120                 if (sw->tb->security_level == TB_SECURITY_NOPCIE ||
2121                     sw->tb->security_level == TB_SECURITY_DPONLY)
2122                         return 0;
2123         } else if (attr == &dev_attr_device.attr) {
2124                 if (!sw->device)
2125                         return 0;
2126         } else if (attr == &dev_attr_device_name.attr) {
2127                 if (!sw->device_name)
2128                         return 0;
2129         } else if (attr == &dev_attr_vendor.attr)  {
2130                 if (!sw->vendor)
2131                         return 0;
2132         } else if (attr == &dev_attr_vendor_name.attr)  {
2133                 if (!sw->vendor_name)
2134                         return 0;
2135         } else if (attr == &dev_attr_key.attr) {
2136                 if (tb_route(sw) &&
2137                     sw->tb->security_level == TB_SECURITY_SECURE &&
2138                     sw->security_level == TB_SECURITY_SECURE)
2139                         return attr->mode;
2140                 return 0;
2141         } else if (attr == &dev_attr_rx_speed.attr ||
2142                    attr == &dev_attr_rx_lanes.attr ||
2143                    attr == &dev_attr_tx_speed.attr ||
2144                    attr == &dev_attr_tx_lanes.attr) {
2145                 if (tb_route(sw))
2146                         return attr->mode;
2147                 return 0;
2148         } else if (attr == &dev_attr_nvm_authenticate.attr) {
2149                 if (nvm_upgradeable(sw))
2150                         return attr->mode;
2151                 return 0;
2152         } else if (attr == &dev_attr_nvm_version.attr) {
2153                 if (nvm_readable(sw))
2154                         return attr->mode;
2155                 return 0;
2156         } else if (attr == &dev_attr_boot.attr) {
2157                 if (tb_route(sw))
2158                         return attr->mode;
2159                 return 0;
2160         } else if (attr == &dev_attr_nvm_authenticate_on_disconnect.attr) {
2161                 if (sw->quirks & QUIRK_FORCE_POWER_LINK_CONTROLLER)
2162                         return attr->mode;
2163                 return 0;
2164         }
2165
2166         return sw->safe_mode ? 0 : attr->mode;
2167 }
2168
2169 static const struct attribute_group switch_group = {
2170         .is_visible = switch_attr_is_visible,
2171         .attrs = switch_attrs,
2172 };
2173
2174 static const struct attribute_group *switch_groups[] = {
2175         &switch_group,
2176         NULL,
2177 };
2178
2179 static void tb_switch_release(struct device *dev)
2180 {
2181         struct tb_switch *sw = tb_to_switch(dev);
2182         struct tb_port *port;
2183
2184         dma_port_free(sw->dma_port);
2185
2186         tb_switch_for_each_port(sw, port) {
2187                 ida_destroy(&port->in_hopids);
2188                 ida_destroy(&port->out_hopids);
2189         }
2190
2191         kfree(sw->uuid);
2192         kfree(sw->device_name);
2193         kfree(sw->vendor_name);
2194         kfree(sw->ports);
2195         kfree(sw->drom);
2196         kfree(sw->key);
2197         kfree(sw);
2198 }
2199
2200 static int tb_switch_uevent(struct device *dev, struct kobj_uevent_env *env)
2201 {
2202         struct tb_switch *sw = tb_to_switch(dev);
2203         const char *type;
2204
2205         if (sw->config.thunderbolt_version == USB4_VERSION_1_0) {
2206                 if (add_uevent_var(env, "USB4_VERSION=1.0"))
2207                         return -ENOMEM;
2208         }
2209
2210         if (!tb_route(sw)) {
2211                 type = "host";
2212         } else {
2213                 const struct tb_port *port;
2214                 bool hub = false;
2215
2216                 /* Device is hub if it has any downstream ports */
2217                 tb_switch_for_each_port(sw, port) {
2218                         if (!port->disabled && !tb_is_upstream_port(port) &&
2219                              tb_port_is_null(port)) {
2220                                 hub = true;
2221                                 break;
2222                         }
2223                 }
2224
2225                 type = hub ? "hub" : "device";
2226         }
2227
2228         if (add_uevent_var(env, "USB4_TYPE=%s", type))
2229                 return -ENOMEM;
2230         return 0;
2231 }
2232
2233 /*
2234  * Currently only need to provide the callbacks. Everything else is handled
2235  * in the connection manager.
2236  */
2237 static int __maybe_unused tb_switch_runtime_suspend(struct device *dev)
2238 {
2239         struct tb_switch *sw = tb_to_switch(dev);
2240         const struct tb_cm_ops *cm_ops = sw->tb->cm_ops;
2241
2242         if (cm_ops->runtime_suspend_switch)
2243                 return cm_ops->runtime_suspend_switch(sw);
2244
2245         return 0;
2246 }
2247
2248 static int __maybe_unused tb_switch_runtime_resume(struct device *dev)
2249 {
2250         struct tb_switch *sw = tb_to_switch(dev);
2251         const struct tb_cm_ops *cm_ops = sw->tb->cm_ops;
2252
2253         if (cm_ops->runtime_resume_switch)
2254                 return cm_ops->runtime_resume_switch(sw);
2255         return 0;
2256 }
2257
2258 static const struct dev_pm_ops tb_switch_pm_ops = {
2259         SET_RUNTIME_PM_OPS(tb_switch_runtime_suspend, tb_switch_runtime_resume,
2260                            NULL)
2261 };
2262
2263 struct device_type tb_switch_type = {
2264         .name = "thunderbolt_device",
2265         .release = tb_switch_release,
2266         .uevent = tb_switch_uevent,
2267         .pm = &tb_switch_pm_ops,
2268 };
2269
2270 static int tb_switch_get_generation(struct tb_switch *sw)
2271 {
2272         switch (sw->config.device_id) {
2273         case PCI_DEVICE_ID_INTEL_LIGHT_RIDGE:
2274         case PCI_DEVICE_ID_INTEL_EAGLE_RIDGE:
2275         case PCI_DEVICE_ID_INTEL_LIGHT_PEAK:
2276         case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_2C:
2277         case PCI_DEVICE_ID_INTEL_CACTUS_RIDGE_4C:
2278         case PCI_DEVICE_ID_INTEL_PORT_RIDGE:
2279         case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_2C_BRIDGE:
2280         case PCI_DEVICE_ID_INTEL_REDWOOD_RIDGE_4C_BRIDGE:
2281                 return 1;
2282
2283         case PCI_DEVICE_ID_INTEL_WIN_RIDGE_2C_BRIDGE:
2284         case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_2C_BRIDGE:
2285         case PCI_DEVICE_ID_INTEL_FALCON_RIDGE_4C_BRIDGE:
2286                 return 2;
2287
2288         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_LP_BRIDGE:
2289         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_2C_BRIDGE:
2290         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_4C_BRIDGE:
2291         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_2C_BRIDGE:
2292         case PCI_DEVICE_ID_INTEL_ALPINE_RIDGE_C_4C_BRIDGE:
2293         case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_2C_BRIDGE:
2294         case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_4C_BRIDGE:
2295         case PCI_DEVICE_ID_INTEL_TITAN_RIDGE_DD_BRIDGE:
2296         case PCI_DEVICE_ID_INTEL_ICL_NHI0:
2297         case PCI_DEVICE_ID_INTEL_ICL_NHI1:
2298                 return 3;
2299
2300         default:
2301                 if (tb_switch_is_usb4(sw))
2302                         return 4;
2303
2304                 /*
2305                  * For unknown switches assume generation to be 1 to be
2306                  * on the safe side.
2307                  */
2308                 tb_sw_warn(sw, "unsupported switch device id %#x\n",
2309                            sw->config.device_id);
2310                 return 1;
2311         }
2312 }
2313
2314 static bool tb_switch_exceeds_max_depth(const struct tb_switch *sw, int depth)
2315 {
2316         int max_depth;
2317
2318         if (tb_switch_is_usb4(sw) ||
2319             (sw->tb->root_switch && tb_switch_is_usb4(sw->tb->root_switch)))
2320                 max_depth = USB4_SWITCH_MAX_DEPTH;
2321         else
2322                 max_depth = TB_SWITCH_MAX_DEPTH;
2323
2324         return depth > max_depth;
2325 }
2326
2327 /**
2328  * tb_switch_alloc() - allocate a switch
2329  * @tb: Pointer to the owning domain
2330  * @parent: Parent device for this switch
2331  * @route: Route string for this switch
2332  *
2333  * Allocates and initializes a switch. Will not upload configuration to
2334  * the switch. For that you need to call tb_switch_configure()
2335  * separately. The returned switch should be released by calling
2336  * tb_switch_put().
2337  *
2338  * Return: Pointer to the allocated switch or ERR_PTR() in case of
2339  * failure.
2340  */
2341 struct tb_switch *tb_switch_alloc(struct tb *tb, struct device *parent,
2342                                   u64 route)
2343 {
2344         struct tb_switch *sw;
2345         int upstream_port;
2346         int i, ret, depth;
2347
2348         /* Unlock the downstream port so we can access the switch below */
2349         if (route) {
2350                 struct tb_switch *parent_sw = tb_to_switch(parent);
2351                 struct tb_port *down;
2352
2353                 down = tb_port_at(route, parent_sw);
2354                 tb_port_unlock(down);
2355         }
2356
2357         depth = tb_route_length(route);
2358
2359         upstream_port = tb_cfg_get_upstream_port(tb->ctl, route);
2360         if (upstream_port < 0)
2361                 return ERR_PTR(upstream_port);
2362
2363         sw = kzalloc(sizeof(*sw), GFP_KERNEL);
2364         if (!sw)
2365                 return ERR_PTR(-ENOMEM);
2366
2367         sw->tb = tb;
2368         ret = tb_cfg_read(tb->ctl, &sw->config, route, 0, TB_CFG_SWITCH, 0, 5);
2369         if (ret)
2370                 goto err_free_sw_ports;
2371
2372         sw->generation = tb_switch_get_generation(sw);
2373
2374         tb_dbg(tb, "current switch config:\n");
2375         tb_dump_switch(tb, sw);
2376
2377         /* configure switch */
2378         sw->config.upstream_port_number = upstream_port;
2379         sw->config.depth = depth;
2380         sw->config.route_hi = upper_32_bits(route);
2381         sw->config.route_lo = lower_32_bits(route);
2382         sw->config.enabled = 0;
2383
2384         /* Make sure we do not exceed maximum topology limit */
2385         if (tb_switch_exceeds_max_depth(sw, depth)) {
2386                 ret = -EADDRNOTAVAIL;
2387                 goto err_free_sw_ports;
2388         }
2389
2390         /* initialize ports */
2391         sw->ports = kcalloc(sw->config.max_port_number + 1, sizeof(*sw->ports),
2392                                 GFP_KERNEL);
2393         if (!sw->ports) {
2394                 ret = -ENOMEM;
2395                 goto err_free_sw_ports;
2396         }
2397
2398         for (i = 0; i <= sw->config.max_port_number; i++) {
2399                 /* minimum setup for tb_find_cap and tb_drom_read to work */
2400                 sw->ports[i].sw = sw;
2401                 sw->ports[i].port = i;
2402
2403                 /* Control port does not need HopID allocation */
2404                 if (i) {
2405                         ida_init(&sw->ports[i].in_hopids);
2406                         ida_init(&sw->ports[i].out_hopids);
2407                 }
2408         }
2409
2410         ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_PLUG_EVENTS);
2411         if (ret > 0)
2412                 sw->cap_plug_events = ret;
2413
2414         ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_TIME2);
2415         if (ret > 0)
2416                 sw->cap_vsec_tmu = ret;
2417
2418         ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_LINK_CONTROLLER);
2419         if (ret > 0)
2420                 sw->cap_lc = ret;
2421
2422         ret = tb_switch_find_vse_cap(sw, TB_VSE_CAP_CP_LP);
2423         if (ret > 0)
2424                 sw->cap_lp = ret;
2425
2426         /* Root switch is always authorized */
2427         if (!route)
2428                 sw->authorized = true;
2429
2430         device_initialize(&sw->dev);
2431         sw->dev.parent = parent;
2432         sw->dev.bus = &tb_bus_type;
2433         sw->dev.type = &tb_switch_type;
2434         sw->dev.groups = switch_groups;
2435         dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
2436
2437         return sw;
2438
2439 err_free_sw_ports:
2440         kfree(sw->ports);
2441         kfree(sw);
2442
2443         return ERR_PTR(ret);
2444 }
2445
2446 /**
2447  * tb_switch_alloc_safe_mode() - allocate a switch that is in safe mode
2448  * @tb: Pointer to the owning domain
2449  * @parent: Parent device for this switch
2450  * @route: Route string for this switch
2451  *
2452  * This creates a switch in safe mode. This means the switch pretty much
2453  * lacks all capabilities except DMA configuration port before it is
2454  * flashed with a valid NVM firmware.
2455  *
2456  * The returned switch must be released by calling tb_switch_put().
2457  *
2458  * Return: Pointer to the allocated switch or ERR_PTR() in case of failure
2459  */
2460 struct tb_switch *
2461 tb_switch_alloc_safe_mode(struct tb *tb, struct device *parent, u64 route)
2462 {
2463         struct tb_switch *sw;
2464
2465         sw = kzalloc(sizeof(*sw), GFP_KERNEL);
2466         if (!sw)
2467                 return ERR_PTR(-ENOMEM);
2468
2469         sw->tb = tb;
2470         sw->config.depth = tb_route_length(route);
2471         sw->config.route_hi = upper_32_bits(route);
2472         sw->config.route_lo = lower_32_bits(route);
2473         sw->safe_mode = true;
2474
2475         device_initialize(&sw->dev);
2476         sw->dev.parent = parent;
2477         sw->dev.bus = &tb_bus_type;
2478         sw->dev.type = &tb_switch_type;
2479         sw->dev.groups = switch_groups;
2480         dev_set_name(&sw->dev, "%u-%llx", tb->index, tb_route(sw));
2481
2482         return sw;
2483 }
2484
2485 /**
2486  * tb_switch_configure() - Uploads configuration to the switch
2487  * @sw: Switch to configure
2488  *
2489  * Call this function before the switch is added to the system. It will
2490  * upload configuration to the switch and makes it available for the
2491  * connection manager to use. Can be called to the switch again after
2492  * resume from low power states to re-initialize it.
2493  *
2494  * Return: %0 in case of success and negative errno in case of failure
2495  */
2496 int tb_switch_configure(struct tb_switch *sw)
2497 {
2498         struct tb *tb = sw->tb;
2499         u64 route;
2500         int ret;
2501
2502         route = tb_route(sw);
2503
2504         tb_dbg(tb, "%s Switch at %#llx (depth: %d, up port: %d)\n",
2505                sw->config.enabled ? "restoring" : "initializing", route,
2506                tb_route_length(route), sw->config.upstream_port_number);
2507
2508         sw->config.enabled = 1;
2509
2510         if (tb_switch_is_usb4(sw)) {
2511                 /*
2512                  * For USB4 devices, we need to program the CM version
2513                  * accordingly so that it knows to expose all the
2514                  * additional capabilities.
2515                  */
2516                 sw->config.cmuv = USB4_VERSION_1_0;
2517
2518                 /* Enumerate the switch */
2519                 ret = tb_sw_write(sw, (u32 *)&sw->config + 1, TB_CFG_SWITCH,
2520                                   ROUTER_CS_1, 4);
2521                 if (ret)
2522                         return ret;
2523
2524                 ret = usb4_switch_setup(sw);
2525         } else {
2526                 if (sw->config.vendor_id != PCI_VENDOR_ID_INTEL)
2527                         tb_sw_warn(sw, "unknown switch vendor id %#x\n",
2528                                    sw->config.vendor_id);
2529
2530                 if (!sw->cap_plug_events) {
2531                         tb_sw_warn(sw, "cannot find TB_VSE_CAP_PLUG_EVENTS aborting\n");
2532                         return -ENODEV;
2533                 }
2534
2535                 /* Enumerate the switch */
2536                 ret = tb_sw_write(sw, (u32 *)&sw->config + 1, TB_CFG_SWITCH,
2537                                   ROUTER_CS_1, 3);
2538         }
2539         if (ret)
2540                 return ret;
2541
2542         return tb_plug_events_active(sw, true);
2543 }
2544
2545 static int tb_switch_set_uuid(struct tb_switch *sw)
2546 {
2547         bool uid = false;
2548         u32 uuid[4];
2549         int ret;
2550
2551         if (sw->uuid)
2552                 return 0;
2553
2554         if (tb_switch_is_usb4(sw)) {
2555                 ret = usb4_switch_read_uid(sw, &sw->uid);
2556                 if (ret)
2557                         return ret;
2558                 uid = true;
2559         } else {
2560                 /*
2561                  * The newer controllers include fused UUID as part of
2562                  * link controller specific registers
2563                  */
2564                 ret = tb_lc_read_uuid(sw, uuid);
2565                 if (ret) {
2566                         if (ret != -EINVAL)
2567                                 return ret;
2568                         uid = true;
2569                 }
2570         }
2571
2572         if (uid) {
2573                 /*
2574                  * ICM generates UUID based on UID and fills the upper
2575                  * two words with ones. This is not strictly following
2576                  * UUID format but we want to be compatible with it so
2577                  * we do the same here.
2578                  */
2579                 uuid[0] = sw->uid & 0xffffffff;
2580                 uuid[1] = (sw->uid >> 32) & 0xffffffff;
2581                 uuid[2] = 0xffffffff;
2582                 uuid[3] = 0xffffffff;
2583         }
2584
2585         sw->uuid = kmemdup(uuid, sizeof(uuid), GFP_KERNEL);
2586         if (!sw->uuid)
2587                 return -ENOMEM;
2588         return 0;
2589 }
2590
2591 static int tb_switch_add_dma_port(struct tb_switch *sw)
2592 {
2593         u32 status;
2594         int ret;
2595
2596         switch (sw->generation) {
2597         case 2:
2598                 /* Only root switch can be upgraded */
2599                 if (tb_route(sw))
2600                         return 0;
2601
2602                 fallthrough;
2603         case 3:
2604         case 4:
2605                 ret = tb_switch_set_uuid(sw);
2606                 if (ret)
2607                         return ret;
2608                 break;
2609
2610         default:
2611                 /*
2612                  * DMA port is the only thing available when the switch
2613                  * is in safe mode.
2614                  */
2615                 if (!sw->safe_mode)
2616                         return 0;
2617                 break;
2618         }
2619
2620         if (sw->no_nvm_upgrade)
2621                 return 0;
2622
2623         if (tb_switch_is_usb4(sw)) {
2624                 ret = usb4_switch_nvm_authenticate_status(sw, &status);
2625                 if (ret)
2626                         return ret;
2627
2628                 if (status) {
2629                         tb_sw_info(sw, "switch flash authentication failed\n");
2630                         nvm_set_auth_status(sw, status);
2631                 }
2632
2633                 return 0;
2634         }
2635
2636         /* Root switch DMA port requires running firmware */
2637         if (!tb_route(sw) && !tb_switch_is_icm(sw))
2638                 return 0;
2639
2640         sw->dma_port = dma_port_alloc(sw);
2641         if (!sw->dma_port)
2642                 return 0;
2643
2644         /*
2645          * If there is status already set then authentication failed
2646          * when the dma_port_flash_update_auth() returned. Power cycling
2647          * is not needed (it was done already) so only thing we do here
2648          * is to unblock runtime PM of the root port.
2649          */
2650         nvm_get_auth_status(sw, &status);
2651         if (status) {
2652                 if (!tb_route(sw))
2653                         nvm_authenticate_complete_dma_port(sw);
2654                 return 0;
2655         }
2656
2657         /*
2658          * Check status of the previous flash authentication. If there
2659          * is one we need to power cycle the switch in any case to make
2660          * it functional again.
2661          */
2662         ret = dma_port_flash_update_auth_status(sw->dma_port, &status);
2663         if (ret <= 0)
2664                 return ret;
2665
2666         /* Now we can allow root port to suspend again */
2667         if (!tb_route(sw))
2668                 nvm_authenticate_complete_dma_port(sw);
2669
2670         if (status) {
2671                 tb_sw_info(sw, "switch flash authentication failed\n");
2672                 nvm_set_auth_status(sw, status);
2673         }
2674
2675         tb_sw_info(sw, "power cycling the switch now\n");
2676         dma_port_power_cycle(sw->dma_port);
2677
2678         /*
2679          * We return error here which causes the switch adding failure.
2680          * It should appear back after power cycle is complete.
2681          */
2682         return -ESHUTDOWN;
2683 }
2684
2685 static void tb_switch_default_link_ports(struct tb_switch *sw)
2686 {
2687         int i;
2688
2689         for (i = 1; i <= sw->config.max_port_number; i++) {
2690                 struct tb_port *port = &sw->ports[i];
2691                 struct tb_port *subordinate;
2692
2693                 if (!tb_port_is_null(port))
2694                         continue;
2695
2696                 /* Check for the subordinate port */
2697                 if (i == sw->config.max_port_number ||
2698                     !tb_port_is_null(&sw->ports[i + 1]))
2699                         continue;
2700
2701                 /* Link them if not already done so (by DROM) */
2702                 subordinate = &sw->ports[i + 1];
2703                 if (!port->dual_link_port && !subordinate->dual_link_port) {
2704                         port->link_nr = 0;
2705                         port->dual_link_port = subordinate;
2706                         subordinate->link_nr = 1;
2707                         subordinate->dual_link_port = port;
2708
2709                         tb_sw_dbg(sw, "linked ports %d <-> %d\n",
2710                                   port->port, subordinate->port);
2711                 }
2712         }
2713 }
2714
2715 static bool tb_switch_lane_bonding_possible(struct tb_switch *sw)
2716 {
2717         const struct tb_port *up = tb_upstream_port(sw);
2718
2719         if (!up->dual_link_port || !up->dual_link_port->remote)
2720                 return false;
2721
2722         if (tb_switch_is_usb4(sw))
2723                 return usb4_switch_lane_bonding_possible(sw);
2724         return tb_lc_lane_bonding_possible(sw);
2725 }
2726
2727 static int tb_switch_update_link_attributes(struct tb_switch *sw)
2728 {
2729         struct tb_port *up;
2730         bool change = false;
2731         int ret;
2732
2733         if (!tb_route(sw) || tb_switch_is_icm(sw))
2734                 return 0;
2735
2736         up = tb_upstream_port(sw);
2737
2738         ret = tb_port_get_link_speed(up);
2739         if (ret < 0)
2740                 return ret;
2741         if (sw->link_speed != ret)
2742                 change = true;
2743         sw->link_speed = ret;
2744
2745         ret = tb_port_get_link_width(up);
2746         if (ret < 0)
2747                 return ret;
2748         if (sw->link_width != ret)
2749                 change = true;
2750         sw->link_width = ret;
2751
2752         /* Notify userspace that there is possible link attribute change */
2753         if (device_is_registered(&sw->dev) && change)
2754                 kobject_uevent(&sw->dev.kobj, KOBJ_CHANGE);
2755
2756         return 0;
2757 }
2758
2759 /**
2760  * tb_switch_lane_bonding_enable() - Enable lane bonding
2761  * @sw: Switch to enable lane bonding
2762  *
2763  * Connection manager can call this function to enable lane bonding of a
2764  * switch. If conditions are correct and both switches support the feature,
2765  * lanes are bonded. It is safe to call this to any switch.
2766  */
2767 int tb_switch_lane_bonding_enable(struct tb_switch *sw)
2768 {
2769         struct tb_switch *parent = tb_to_switch(sw->dev.parent);
2770         struct tb_port *up, *down;
2771         u64 route = tb_route(sw);
2772         int ret;
2773
2774         if (!route)
2775                 return 0;
2776
2777         if (!tb_switch_lane_bonding_possible(sw))
2778                 return 0;
2779
2780         up = tb_upstream_port(sw);
2781         down = tb_port_at(route, parent);
2782
2783         if (!tb_port_is_width_supported(up, 2) ||
2784             !tb_port_is_width_supported(down, 2))
2785                 return 0;
2786
2787         ret = tb_port_lane_bonding_enable(up);
2788         if (ret) {
2789                 tb_port_warn(up, "failed to enable lane bonding\n");
2790                 return ret;
2791         }
2792
2793         ret = tb_port_lane_bonding_enable(down);
2794         if (ret) {
2795                 tb_port_warn(down, "failed to enable lane bonding\n");
2796                 tb_port_lane_bonding_disable(up);
2797                 return ret;
2798         }
2799
2800         ret = tb_port_wait_for_link_width(down, 2, 100);
2801         if (ret) {
2802                 tb_port_warn(down, "timeout enabling lane bonding\n");
2803                 return ret;
2804         }
2805
2806         tb_port_update_credits(down);
2807         tb_port_update_credits(up);
2808         tb_switch_update_link_attributes(sw);
2809
2810         tb_sw_dbg(sw, "lane bonding enabled\n");
2811         return ret;
2812 }
2813
2814 /**
2815  * tb_switch_lane_bonding_disable() - Disable lane bonding
2816  * @sw: Switch whose lane bonding to disable
2817  *
2818  * Disables lane bonding between @sw and parent. This can be called even
2819  * if lanes were not bonded originally.
2820  */
2821 void tb_switch_lane_bonding_disable(struct tb_switch *sw)
2822 {
2823         struct tb_switch *parent = tb_to_switch(sw->dev.parent);
2824         struct tb_port *up, *down;
2825
2826         if (!tb_route(sw))
2827                 return;
2828
2829         up = tb_upstream_port(sw);
2830         if (!up->bonded)
2831                 return;
2832
2833         down = tb_port_at(tb_route(sw), parent);
2834
2835         tb_port_lane_bonding_disable(up);
2836         tb_port_lane_bonding_disable(down);
2837
2838         /*
2839          * It is fine if we get other errors as the router might have
2840          * been unplugged.
2841          */
2842         if (tb_port_wait_for_link_width(down, 1, 100) == -ETIMEDOUT)
2843                 tb_sw_warn(sw, "timeout disabling lane bonding\n");
2844
2845         tb_port_update_credits(down);
2846         tb_port_update_credits(up);
2847         tb_switch_update_link_attributes(sw);
2848
2849         tb_sw_dbg(sw, "lane bonding disabled\n");
2850 }
2851
2852 /**
2853  * tb_switch_configure_link() - Set link configured
2854  * @sw: Switch whose link is configured
2855  *
2856  * Sets the link upstream from @sw configured (from both ends) so that
2857  * it will not be disconnected when the domain exits sleep. Can be
2858  * called for any switch.
2859  *
2860  * It is recommended that this is called after lane bonding is enabled.
2861  *
2862  * Returns %0 on success and negative errno in case of error.
2863  */
2864 int tb_switch_configure_link(struct tb_switch *sw)
2865 {
2866         struct tb_port *up, *down;
2867         int ret;
2868
2869         if (!tb_route(sw) || tb_switch_is_icm(sw))
2870                 return 0;
2871
2872         up = tb_upstream_port(sw);
2873         if (tb_switch_is_usb4(up->sw))
2874                 ret = usb4_port_configure(up);
2875         else
2876                 ret = tb_lc_configure_port(up);
2877         if (ret)
2878                 return ret;
2879
2880         down = up->remote;
2881         if (tb_switch_is_usb4(down->sw))
2882                 return usb4_port_configure(down);
2883         return tb_lc_configure_port(down);
2884 }
2885
2886 /**
2887  * tb_switch_unconfigure_link() - Unconfigure link
2888  * @sw: Switch whose link is unconfigured
2889  *
2890  * Sets the link unconfigured so the @sw will be disconnected if the
2891  * domain exists sleep.
2892  */
2893 void tb_switch_unconfigure_link(struct tb_switch *sw)
2894 {
2895         struct tb_port *up, *down;
2896
2897         if (sw->is_unplugged)
2898                 return;
2899         if (!tb_route(sw) || tb_switch_is_icm(sw))
2900                 return;
2901
2902         up = tb_upstream_port(sw);
2903         if (tb_switch_is_usb4(up->sw))
2904                 usb4_port_unconfigure(up);
2905         else
2906                 tb_lc_unconfigure_port(up);
2907
2908         down = up->remote;
2909         if (tb_switch_is_usb4(down->sw))
2910                 usb4_port_unconfigure(down);
2911         else
2912                 tb_lc_unconfigure_port(down);
2913 }
2914
2915 static void tb_switch_credits_init(struct tb_switch *sw)
2916 {
2917         if (tb_switch_is_icm(sw))
2918                 return;
2919         if (!tb_switch_is_usb4(sw))
2920                 return;
2921         if (usb4_switch_credits_init(sw))
2922                 tb_sw_info(sw, "failed to determine preferred buffer allocation, using defaults\n");
2923 }
2924
2925 /**
2926  * tb_switch_add() - Add a switch to the domain
2927  * @sw: Switch to add
2928  *
2929  * This is the last step in adding switch to the domain. It will read
2930  * identification information from DROM and initializes ports so that
2931  * they can be used to connect other switches. The switch will be
2932  * exposed to the userspace when this function successfully returns. To
2933  * remove and release the switch, call tb_switch_remove().
2934  *
2935  * Return: %0 in case of success and negative errno in case of failure
2936  */
2937 int tb_switch_add(struct tb_switch *sw)
2938 {
2939         int i, ret;
2940
2941         /*
2942          * Initialize DMA control port now before we read DROM. Recent
2943          * host controllers have more complete DROM on NVM that includes
2944          * vendor and model identification strings which we then expose
2945          * to the userspace. NVM can be accessed through DMA
2946          * configuration based mailbox.
2947          */
2948         ret = tb_switch_add_dma_port(sw);
2949         if (ret) {
2950                 dev_err(&sw->dev, "failed to add DMA port\n");
2951                 return ret;
2952         }
2953
2954         if (!sw->safe_mode) {
2955                 tb_switch_credits_init(sw);
2956
2957                 /* read drom */
2958                 ret = tb_drom_read(sw);
2959                 if (ret)
2960                         dev_warn(&sw->dev, "reading DROM failed: %d\n", ret);
2961                 tb_sw_dbg(sw, "uid: %#llx\n", sw->uid);
2962
2963                 tb_check_quirks(sw);
2964
2965                 ret = tb_switch_set_uuid(sw);
2966                 if (ret) {
2967                         dev_err(&sw->dev, "failed to set UUID\n");
2968                         return ret;
2969                 }
2970
2971                 for (i = 0; i <= sw->config.max_port_number; i++) {
2972                         if (sw->ports[i].disabled) {
2973                                 tb_port_dbg(&sw->ports[i], "disabled by eeprom\n");
2974                                 continue;
2975                         }
2976                         ret = tb_init_port(&sw->ports[i]);
2977                         if (ret) {
2978                                 dev_err(&sw->dev, "failed to initialize port %d\n", i);
2979                                 return ret;
2980                         }
2981                 }
2982
2983                 tb_switch_default_link_ports(sw);
2984
2985                 ret = tb_switch_update_link_attributes(sw);
2986                 if (ret)
2987                         return ret;
2988
2989                 ret = tb_switch_tmu_init(sw);
2990                 if (ret)
2991                         return ret;
2992         }
2993
2994         ret = device_add(&sw->dev);
2995         if (ret) {
2996                 dev_err(&sw->dev, "failed to add device: %d\n", ret);
2997                 return ret;
2998         }
2999
3000         if (tb_route(sw)) {
3001                 dev_info(&sw->dev, "new device found, vendor=%#x device=%#x\n",
3002                          sw->vendor, sw->device);
3003                 if (sw->vendor_name && sw->device_name)
3004                         dev_info(&sw->dev, "%s %s\n", sw->vendor_name,
3005                                  sw->device_name);
3006         }
3007
3008         ret = usb4_switch_add_ports(sw);
3009         if (ret) {
3010                 dev_err(&sw->dev, "failed to add USB4 ports\n");
3011                 goto err_del;
3012         }
3013
3014         ret = tb_switch_nvm_add(sw);
3015         if (ret) {
3016                 dev_err(&sw->dev, "failed to add NVM devices\n");
3017                 goto err_ports;
3018         }
3019
3020         /*
3021          * Thunderbolt routers do not generate wakeups themselves but
3022          * they forward wakeups from tunneled protocols, so enable it
3023          * here.
3024          */
3025         device_init_wakeup(&sw->dev, true);
3026
3027         pm_runtime_set_active(&sw->dev);
3028         if (sw->rpm) {
3029                 pm_runtime_set_autosuspend_delay(&sw->dev, TB_AUTOSUSPEND_DELAY);
3030                 pm_runtime_use_autosuspend(&sw->dev);
3031                 pm_runtime_mark_last_busy(&sw->dev);
3032                 pm_runtime_enable(&sw->dev);
3033                 pm_request_autosuspend(&sw->dev);
3034         }
3035
3036         tb_switch_debugfs_init(sw);
3037         return 0;
3038
3039 err_ports:
3040         usb4_switch_remove_ports(sw);
3041 err_del:
3042         device_del(&sw->dev);
3043
3044         return ret;
3045 }
3046
3047 /**
3048  * tb_switch_remove() - Remove and release a switch
3049  * @sw: Switch to remove
3050  *
3051  * This will remove the switch from the domain and release it after last
3052  * reference count drops to zero. If there are switches connected below
3053  * this switch, they will be removed as well.
3054  */
3055 void tb_switch_remove(struct tb_switch *sw)
3056 {
3057         struct tb_port *port;
3058
3059         tb_switch_debugfs_remove(sw);
3060
3061         if (sw->rpm) {
3062                 pm_runtime_get_sync(&sw->dev);
3063                 pm_runtime_disable(&sw->dev);
3064         }
3065
3066         /* port 0 is the switch itself and never has a remote */
3067         tb_switch_for_each_port(sw, port) {
3068                 if (tb_port_has_remote(port)) {
3069                         tb_switch_remove(port->remote->sw);
3070                         port->remote = NULL;
3071                 } else if (port->xdomain) {
3072                         tb_xdomain_remove(port->xdomain);
3073                         port->xdomain = NULL;
3074                 }
3075
3076                 /* Remove any downstream retimers */
3077                 tb_retimer_remove_all(port);
3078         }
3079
3080         if (!sw->is_unplugged)
3081                 tb_plug_events_active(sw, false);
3082
3083         tb_switch_nvm_remove(sw);
3084         usb4_switch_remove_ports(sw);
3085
3086         if (tb_route(sw))
3087                 dev_info(&sw->dev, "device disconnected\n");
3088         device_unregister(&sw->dev);
3089 }
3090
3091 /**
3092  * tb_sw_set_unplugged() - set is_unplugged on switch and downstream switches
3093  * @sw: Router to mark unplugged
3094  */
3095 void tb_sw_set_unplugged(struct tb_switch *sw)
3096 {
3097         struct tb_port *port;
3098
3099         if (sw == sw->tb->root_switch) {
3100                 tb_sw_WARN(sw, "cannot unplug root switch\n");
3101                 return;
3102         }
3103         if (sw->is_unplugged) {
3104                 tb_sw_WARN(sw, "is_unplugged already set\n");
3105                 return;
3106         }
3107         sw->is_unplugged = true;
3108         tb_switch_for_each_port(sw, port) {
3109                 if (tb_port_has_remote(port))
3110                         tb_sw_set_unplugged(port->remote->sw);
3111                 else if (port->xdomain)
3112                         port->xdomain->is_unplugged = true;
3113         }
3114 }
3115
3116 static int tb_switch_set_wake(struct tb_switch *sw, unsigned int flags)
3117 {
3118         if (flags)
3119                 tb_sw_dbg(sw, "enabling wakeup: %#x\n", flags);
3120         else
3121                 tb_sw_dbg(sw, "disabling wakeup\n");
3122
3123         if (tb_switch_is_usb4(sw))
3124                 return usb4_switch_set_wake(sw, flags);
3125         return tb_lc_set_wake(sw, flags);
3126 }
3127
3128 int tb_switch_resume(struct tb_switch *sw)
3129 {
3130         struct tb_port *port;
3131         int err;
3132
3133         tb_sw_dbg(sw, "resuming switch\n");
3134
3135         /*
3136          * Check for UID of the connected switches except for root
3137          * switch which we assume cannot be removed.
3138          */
3139         if (tb_route(sw)) {
3140                 u64 uid;
3141
3142                 /*
3143                  * Check first that we can still read the switch config
3144                  * space. It may be that there is now another domain
3145                  * connected.
3146                  */
3147                 err = tb_cfg_get_upstream_port(sw->tb->ctl, tb_route(sw));
3148                 if (err < 0) {
3149                         tb_sw_info(sw, "switch not present anymore\n");
3150                         return err;
3151                 }
3152
3153                 /* We don't have any way to confirm this was the same device */
3154                 if (!sw->uid)
3155                         return -ENODEV;
3156
3157                 if (tb_switch_is_usb4(sw))
3158                         err = usb4_switch_read_uid(sw, &uid);
3159                 else
3160                         err = tb_drom_read_uid_only(sw, &uid);
3161                 if (err) {
3162                         tb_sw_warn(sw, "uid read failed\n");
3163                         return err;
3164                 }
3165                 if (sw->uid != uid) {
3166                         tb_sw_info(sw,
3167                                 "changed while suspended (uid %#llx -> %#llx)\n",
3168                                 sw->uid, uid);
3169                         return -ENODEV;
3170                 }
3171         }
3172
3173         err = tb_switch_configure(sw);
3174         if (err)
3175                 return err;
3176
3177         /* Disable wakes */
3178         tb_switch_set_wake(sw, 0);
3179
3180         err = tb_switch_tmu_init(sw);
3181         if (err)
3182                 return err;
3183
3184         /* check for surviving downstream switches */
3185         tb_switch_for_each_port(sw, port) {
3186                 if (!tb_port_is_null(port))
3187                         continue;
3188
3189                 if (!tb_port_resume(port))
3190                         continue;
3191
3192                 if (tb_wait_for_port(port, true) <= 0) {
3193                         tb_port_warn(port,
3194                                      "lost during suspend, disconnecting\n");
3195                         if (tb_port_has_remote(port))
3196                                 tb_sw_set_unplugged(port->remote->sw);
3197                         else if (port->xdomain)
3198                                 port->xdomain->is_unplugged = true;
3199                 } else {
3200                         /*
3201                          * Always unlock the port so the downstream
3202                          * switch/domain is accessible.
3203                          */
3204                         if (tb_port_unlock(port))
3205                                 tb_port_warn(port, "failed to unlock port\n");
3206                         if (port->remote && tb_switch_resume(port->remote->sw)) {
3207                                 tb_port_warn(port,
3208                                              "lost during suspend, disconnecting\n");
3209                                 tb_sw_set_unplugged(port->remote->sw);
3210                         }
3211                 }
3212         }
3213         return 0;
3214 }
3215
3216 /**
3217  * tb_switch_suspend() - Put a switch to sleep
3218  * @sw: Switch to suspend
3219  * @runtime: Is this runtime suspend or system sleep
3220  *
3221  * Suspends router and all its children. Enables wakes according to
3222  * value of @runtime and then sets sleep bit for the router. If @sw is
3223  * host router the domain is ready to go to sleep once this function
3224  * returns.
3225  */
3226 void tb_switch_suspend(struct tb_switch *sw, bool runtime)
3227 {
3228         unsigned int flags = 0;
3229         struct tb_port *port;
3230         int err;
3231
3232         tb_sw_dbg(sw, "suspending switch\n");
3233
3234         /*
3235          * Actually only needed for Titan Ridge but for simplicity can be
3236          * done for USB4 device too as CLx is re-enabled at resume.
3237          * CL0s and CL1 are enabled and supported together.
3238          */
3239         if (tb_switch_is_clx_enabled(sw, TB_CL1)) {
3240                 if (tb_switch_disable_clx(sw, TB_CL1))
3241                         tb_sw_warn(sw, "failed to disable %s on upstream port\n",
3242                                    tb_switch_clx_name(TB_CL1));
3243         }
3244
3245         err = tb_plug_events_active(sw, false);
3246         if (err)
3247                 return;
3248
3249         tb_switch_for_each_port(sw, port) {
3250                 if (tb_port_has_remote(port))
3251                         tb_switch_suspend(port->remote->sw, runtime);
3252         }
3253
3254         if (runtime) {
3255                 /* Trigger wake when something is plugged in/out */
3256                 flags |= TB_WAKE_ON_CONNECT | TB_WAKE_ON_DISCONNECT;
3257                 flags |= TB_WAKE_ON_USB4;
3258                 flags |= TB_WAKE_ON_USB3 | TB_WAKE_ON_PCIE | TB_WAKE_ON_DP;
3259         } else if (device_may_wakeup(&sw->dev)) {
3260                 flags |= TB_WAKE_ON_USB4 | TB_WAKE_ON_USB3 | TB_WAKE_ON_PCIE;
3261         }
3262
3263         tb_switch_set_wake(sw, flags);
3264
3265         if (tb_switch_is_usb4(sw))
3266                 usb4_switch_set_sleep(sw);
3267         else
3268                 tb_lc_set_sleep(sw);
3269 }
3270
3271 /**
3272  * tb_switch_query_dp_resource() - Query availability of DP resource
3273  * @sw: Switch whose DP resource is queried
3274  * @in: DP IN port
3275  *
3276  * Queries availability of DP resource for DP tunneling using switch
3277  * specific means. Returns %true if resource is available.
3278  */
3279 bool tb_switch_query_dp_resource(struct tb_switch *sw, struct tb_port *in)
3280 {
3281         if (tb_switch_is_usb4(sw))
3282                 return usb4_switch_query_dp_resource(sw, in);
3283         return tb_lc_dp_sink_query(sw, in);
3284 }
3285
3286 /**
3287  * tb_switch_alloc_dp_resource() - Allocate available DP resource
3288  * @sw: Switch whose DP resource is allocated
3289  * @in: DP IN port
3290  *
3291  * Allocates DP resource for DP tunneling. The resource must be
3292  * available for this to succeed (see tb_switch_query_dp_resource()).
3293  * Returns %0 in success and negative errno otherwise.
3294  */
3295 int tb_switch_alloc_dp_resource(struct tb_switch *sw, struct tb_port *in)
3296 {
3297         int ret;
3298
3299         if (tb_switch_is_usb4(sw))
3300                 ret = usb4_switch_alloc_dp_resource(sw, in);
3301         else
3302                 ret = tb_lc_dp_sink_alloc(sw, in);
3303
3304         if (ret)
3305                 tb_sw_warn(sw, "failed to allocate DP resource for port %d\n",
3306                            in->port);
3307         else
3308                 tb_sw_dbg(sw, "allocated DP resource for port %d\n", in->port);
3309
3310         return ret;
3311 }
3312
3313 /**
3314  * tb_switch_dealloc_dp_resource() - De-allocate DP resource
3315  * @sw: Switch whose DP resource is de-allocated
3316  * @in: DP IN port
3317  *
3318  * De-allocates DP resource that was previously allocated for DP
3319  * tunneling.
3320  */
3321 void tb_switch_dealloc_dp_resource(struct tb_switch *sw, struct tb_port *in)
3322 {
3323         int ret;
3324
3325         if (tb_switch_is_usb4(sw))
3326                 ret = usb4_switch_dealloc_dp_resource(sw, in);
3327         else
3328                 ret = tb_lc_dp_sink_dealloc(sw, in);
3329
3330         if (ret)
3331                 tb_sw_warn(sw, "failed to de-allocate DP resource for port %d\n",
3332                            in->port);
3333         else
3334                 tb_sw_dbg(sw, "released DP resource for port %d\n", in->port);
3335 }
3336
3337 struct tb_sw_lookup {
3338         struct tb *tb;
3339         u8 link;
3340         u8 depth;
3341         const uuid_t *uuid;
3342         u64 route;
3343 };
3344
3345 static int tb_switch_match(struct device *dev, const void *data)
3346 {
3347         struct tb_switch *sw = tb_to_switch(dev);
3348         const struct tb_sw_lookup *lookup = data;
3349
3350         if (!sw)
3351                 return 0;
3352         if (sw->tb != lookup->tb)
3353                 return 0;
3354
3355         if (lookup->uuid)
3356                 return !memcmp(sw->uuid, lookup->uuid, sizeof(*lookup->uuid));
3357
3358         if (lookup->route) {
3359                 return sw->config.route_lo == lower_32_bits(lookup->route) &&
3360                        sw->config.route_hi == upper_32_bits(lookup->route);
3361         }
3362
3363         /* Root switch is matched only by depth */
3364         if (!lookup->depth)
3365                 return !sw->depth;
3366
3367         return sw->link == lookup->link && sw->depth == lookup->depth;
3368 }
3369
3370 /**
3371  * tb_switch_find_by_link_depth() - Find switch by link and depth
3372  * @tb: Domain the switch belongs
3373  * @link: Link number the switch is connected
3374  * @depth: Depth of the switch in link
3375  *
3376  * Returned switch has reference count increased so the caller needs to
3377  * call tb_switch_put() when done with the switch.
3378  */
3379 struct tb_switch *tb_switch_find_by_link_depth(struct tb *tb, u8 link, u8 depth)
3380 {
3381         struct tb_sw_lookup lookup;
3382         struct device *dev;
3383
3384         memset(&lookup, 0, sizeof(lookup));
3385         lookup.tb = tb;
3386         lookup.link = link;
3387         lookup.depth = depth;
3388
3389         dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
3390         if (dev)
3391                 return tb_to_switch(dev);
3392
3393         return NULL;
3394 }
3395
3396 /**
3397  * tb_switch_find_by_uuid() - Find switch by UUID
3398  * @tb: Domain the switch belongs
3399  * @uuid: UUID to look for
3400  *
3401  * Returned switch has reference count increased so the caller needs to
3402  * call tb_switch_put() when done with the switch.
3403  */
3404 struct tb_switch *tb_switch_find_by_uuid(struct tb *tb, const uuid_t *uuid)
3405 {
3406         struct tb_sw_lookup lookup;
3407         struct device *dev;
3408
3409         memset(&lookup, 0, sizeof(lookup));
3410         lookup.tb = tb;
3411         lookup.uuid = uuid;
3412
3413         dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
3414         if (dev)
3415                 return tb_to_switch(dev);
3416
3417         return NULL;
3418 }
3419
3420 /**
3421  * tb_switch_find_by_route() - Find switch by route string
3422  * @tb: Domain the switch belongs
3423  * @route: Route string to look for
3424  *
3425  * Returned switch has reference count increased so the caller needs to
3426  * call tb_switch_put() when done with the switch.
3427  */
3428 struct tb_switch *tb_switch_find_by_route(struct tb *tb, u64 route)
3429 {
3430         struct tb_sw_lookup lookup;
3431         struct device *dev;
3432
3433         if (!route)
3434                 return tb_switch_get(tb->root_switch);
3435
3436         memset(&lookup, 0, sizeof(lookup));
3437         lookup.tb = tb;
3438         lookup.route = route;
3439
3440         dev = bus_find_device(&tb_bus_type, NULL, &lookup, tb_switch_match);
3441         if (dev)
3442                 return tb_to_switch(dev);
3443
3444         return NULL;
3445 }
3446
3447 /**
3448  * tb_switch_find_port() - return the first port of @type on @sw or NULL
3449  * @sw: Switch to find the port from
3450  * @type: Port type to look for
3451  */
3452 struct tb_port *tb_switch_find_port(struct tb_switch *sw,
3453                                     enum tb_port_type type)
3454 {
3455         struct tb_port *port;
3456
3457         tb_switch_for_each_port(sw, port) {
3458                 if (port->config.type == type)
3459                         return port;
3460         }
3461
3462         return NULL;
3463 }
3464
3465 static int tb_switch_pm_secondary_resolve(struct tb_switch *sw)
3466 {
3467         struct tb_switch *parent = tb_switch_parent(sw);
3468         struct tb_port *up, *down;
3469         int ret;
3470
3471         if (!tb_route(sw))
3472                 return 0;
3473
3474         up = tb_upstream_port(sw);
3475         down = tb_port_at(tb_route(sw), parent);
3476         ret = tb_port_pm_secondary_enable(up);
3477         if (ret)
3478                 return ret;
3479
3480         return tb_port_pm_secondary_disable(down);
3481 }
3482
3483 static int __tb_switch_enable_clx(struct tb_switch *sw, enum tb_clx clx)
3484 {
3485         struct tb_switch *parent = tb_switch_parent(sw);
3486         bool up_clx_support, down_clx_support;
3487         struct tb_port *up, *down;
3488         int ret;
3489
3490         if (!tb_switch_is_clx_supported(sw))
3491                 return 0;
3492
3493         /*
3494          * Enable CLx for host router's downstream port as part of the
3495          * downstream router enabling procedure.
3496          */
3497         if (!tb_route(sw))
3498                 return 0;
3499
3500         /* Enable CLx only for first hop router (depth = 1) */
3501         if (tb_route(parent))
3502                 return 0;
3503
3504         ret = tb_switch_pm_secondary_resolve(sw);
3505         if (ret)
3506                 return ret;
3507
3508         up = tb_upstream_port(sw);
3509         down = tb_port_at(tb_route(sw), parent);
3510
3511         up_clx_support = tb_port_clx_supported(up, clx);
3512         down_clx_support = tb_port_clx_supported(down, clx);
3513
3514         tb_port_dbg(up, "%s %ssupported\n", tb_switch_clx_name(clx),
3515                     up_clx_support ? "" : "not ");
3516         tb_port_dbg(down, "%s %ssupported\n", tb_switch_clx_name(clx),
3517                     down_clx_support ? "" : "not ");
3518
3519         if (!up_clx_support || !down_clx_support)
3520                 return -EOPNOTSUPP;
3521
3522         ret = tb_port_clx_enable(up, clx);
3523         if (ret)
3524                 return ret;
3525
3526         ret = tb_port_clx_enable(down, clx);
3527         if (ret) {
3528                 tb_port_clx_disable(up, clx);
3529                 return ret;
3530         }
3531
3532         ret = tb_switch_mask_clx_objections(sw);
3533         if (ret) {
3534                 tb_port_clx_disable(up, clx);
3535                 tb_port_clx_disable(down, clx);
3536                 return ret;
3537         }
3538
3539         sw->clx = clx;
3540
3541         tb_port_dbg(up, "%s enabled\n", tb_switch_clx_name(clx));
3542         return 0;
3543 }
3544
3545 /**
3546  * tb_switch_enable_clx() - Enable CLx on upstream port of specified router
3547  * @sw: Router to enable CLx for
3548  * @clx: The CLx state to enable
3549  *
3550  * Enable CLx state only for first hop router. That is the most common
3551  * use-case, that is intended for better thermal management, and so helps
3552  * to improve performance. CLx is enabled only if both sides of the link
3553  * support CLx, and if both sides of the link are not configured as two
3554  * single lane links and only if the link is not inter-domain link. The
3555  * complete set of conditions is described in CM Guide 1.0 section 8.1.
3556  *
3557  * Return: Returns 0 on success or an error code on failure.
3558  */
3559 int tb_switch_enable_clx(struct tb_switch *sw, enum tb_clx clx)
3560 {
3561         struct tb_switch *root_sw = sw->tb->root_switch;
3562
3563         if (!clx_enabled)
3564                 return 0;
3565
3566         /*
3567          * CLx is not enabled and validated on Intel USB4 platforms before
3568          * Alder Lake.
3569          */
3570         if (root_sw->generation < 4 || tb_switch_is_tiger_lake(root_sw))
3571                 return 0;
3572
3573         switch (clx) {
3574         case TB_CL1:
3575                 /* CL0s and CL1 are enabled and supported together */
3576                 return __tb_switch_enable_clx(sw, clx);
3577
3578         default:
3579                 return -EOPNOTSUPP;
3580         }
3581 }
3582
3583 static int __tb_switch_disable_clx(struct tb_switch *sw, enum tb_clx clx)
3584 {
3585         struct tb_switch *parent = tb_switch_parent(sw);
3586         struct tb_port *up, *down;
3587         int ret;
3588
3589         if (!tb_switch_is_clx_supported(sw))
3590                 return 0;
3591
3592         /*
3593          * Disable CLx for host router's downstream port as part of the
3594          * downstream router enabling procedure.
3595          */
3596         if (!tb_route(sw))
3597                 return 0;
3598
3599         /* Disable CLx only for first hop router (depth = 1) */
3600         if (tb_route(parent))
3601                 return 0;
3602
3603         up = tb_upstream_port(sw);
3604         down = tb_port_at(tb_route(sw), parent);
3605         ret = tb_port_clx_disable(up, clx);
3606         if (ret)
3607                 return ret;
3608
3609         ret = tb_port_clx_disable(down, clx);
3610         if (ret)
3611                 return ret;
3612
3613         sw->clx = TB_CLX_DISABLE;
3614
3615         tb_port_dbg(up, "%s disabled\n", tb_switch_clx_name(clx));
3616         return 0;
3617 }
3618
3619 /**
3620  * tb_switch_disable_clx() - Disable CLx on upstream port of specified router
3621  * @sw: Router to disable CLx for
3622  * @clx: The CLx state to disable
3623  *
3624  * Return: Returns 0 on success or an error code on failure.
3625  */
3626 int tb_switch_disable_clx(struct tb_switch *sw, enum tb_clx clx)
3627 {
3628         if (!clx_enabled)
3629                 return 0;
3630
3631         switch (clx) {
3632         case TB_CL1:
3633                 /* CL0s and CL1 are enabled and supported together */
3634                 return __tb_switch_disable_clx(sw, clx);
3635
3636         default:
3637                 return -EOPNOTSUPP;
3638         }
3639 }
3640
3641 /**
3642  * tb_switch_mask_clx_objections() - Mask CLx objections for a router
3643  * @sw: Router to mask objections for
3644  *
3645  * Mask the objections coming from the second depth routers in order to
3646  * stop these objections from interfering with the CLx states of the first
3647  * depth link.
3648  */
3649 int tb_switch_mask_clx_objections(struct tb_switch *sw)
3650 {
3651         int up_port = sw->config.upstream_port_number;
3652         u32 offset, val[2], mask_obj, unmask_obj;
3653         int ret, i;
3654
3655         /* Only Titan Ridge of pre-USB4 devices support CLx states */
3656         if (!tb_switch_is_titan_ridge(sw))
3657                 return 0;
3658
3659         if (!tb_route(sw))
3660                 return 0;
3661
3662         /*
3663          * In Titan Ridge there are only 2 dual-lane Thunderbolt ports:
3664          * Port A consists of lane adapters 1,2 and
3665          * Port B consists of lane adapters 3,4
3666          * If upstream port is A, (lanes are 1,2), we mask objections from
3667          * port B (lanes 3,4) and unmask objections from Port A and vice-versa.
3668          */
3669         if (up_port == 1) {
3670                 mask_obj = TB_LOW_PWR_C0_PORT_B_MASK;
3671                 unmask_obj = TB_LOW_PWR_C1_PORT_A_MASK;
3672                 offset = TB_LOW_PWR_C1_CL1;
3673         } else {
3674                 mask_obj = TB_LOW_PWR_C1_PORT_A_MASK;
3675                 unmask_obj = TB_LOW_PWR_C0_PORT_B_MASK;
3676                 offset = TB_LOW_PWR_C3_CL1;
3677         }
3678
3679         ret = tb_sw_read(sw, &val, TB_CFG_SWITCH,
3680                          sw->cap_lp + offset, ARRAY_SIZE(val));
3681         if (ret)
3682                 return ret;
3683
3684         for (i = 0; i < ARRAY_SIZE(val); i++) {
3685                 val[i] |= mask_obj;
3686                 val[i] &= ~unmask_obj;
3687         }
3688
3689         return tb_sw_write(sw, &val, TB_CFG_SWITCH,
3690                            sw->cap_lp + offset, ARRAY_SIZE(val));
3691 }
3692
3693 /*
3694  * Can be used for read/write a specified PCIe bridge for any Thunderbolt 3
3695  * device. For now used only for Titan Ridge.
3696  */
3697 static int tb_switch_pcie_bridge_write(struct tb_switch *sw, unsigned int bridge,
3698                                        unsigned int pcie_offset, u32 value)
3699 {
3700         u32 offset, command, val;
3701         int ret;
3702
3703         if (sw->generation != 3)
3704                 return -EOPNOTSUPP;
3705
3706         offset = sw->cap_plug_events + TB_PLUG_EVENTS_PCIE_WR_DATA;
3707         ret = tb_sw_write(sw, &value, TB_CFG_SWITCH, offset, 1);
3708         if (ret)
3709                 return ret;
3710
3711         command = pcie_offset & TB_PLUG_EVENTS_PCIE_CMD_DW_OFFSET_MASK;
3712         command |= BIT(bridge + TB_PLUG_EVENTS_PCIE_CMD_BR_SHIFT);
3713         command |= TB_PLUG_EVENTS_PCIE_CMD_RD_WR_MASK;
3714         command |= TB_PLUG_EVENTS_PCIE_CMD_COMMAND_VAL
3715                         << TB_PLUG_EVENTS_PCIE_CMD_COMMAND_SHIFT;
3716         command |= TB_PLUG_EVENTS_PCIE_CMD_REQ_ACK_MASK;
3717
3718         offset = sw->cap_plug_events + TB_PLUG_EVENTS_PCIE_CMD;
3719
3720         ret = tb_sw_write(sw, &command, TB_CFG_SWITCH, offset, 1);
3721         if (ret)
3722                 return ret;
3723
3724         ret = tb_switch_wait_for_bit(sw, offset,
3725                                      TB_PLUG_EVENTS_PCIE_CMD_REQ_ACK_MASK, 0, 100);
3726         if (ret)
3727                 return ret;
3728
3729         ret = tb_sw_read(sw, &val, TB_CFG_SWITCH, offset, 1);
3730         if (ret)
3731                 return ret;
3732
3733         if (val & TB_PLUG_EVENTS_PCIE_CMD_TIMEOUT_MASK)
3734                 return -ETIMEDOUT;
3735
3736         return 0;
3737 }
3738
3739 /**
3740  * tb_switch_pcie_l1_enable() - Enable PCIe link to enter L1 state
3741  * @sw: Router to enable PCIe L1
3742  *
3743  * For Titan Ridge switch to enter CLx state, its PCIe bridges shall enable
3744  * entry to PCIe L1 state. Shall be called after the upstream PCIe tunnel
3745  * was configured. Due to Intel platforms limitation, shall be called only
3746  * for first hop switch.
3747  */
3748 int tb_switch_pcie_l1_enable(struct tb_switch *sw)
3749 {
3750         struct tb_switch *parent = tb_switch_parent(sw);
3751         int ret;
3752
3753         if (!tb_route(sw))
3754                 return 0;
3755
3756         if (!tb_switch_is_titan_ridge(sw))
3757                 return 0;
3758
3759         /* Enable PCIe L1 enable only for first hop router (depth = 1) */
3760         if (tb_route(parent))
3761                 return 0;
3762
3763         /* Write to downstream PCIe bridge #5 aka Dn4 */
3764         ret = tb_switch_pcie_bridge_write(sw, 5, 0x143, 0x0c7806b1);
3765         if (ret)
3766                 return ret;
3767
3768         /* Write to Upstream PCIe bridge #0 aka Up0 */
3769         return tb_switch_pcie_bridge_write(sw, 0, 0x143, 0x0c5806b1);
3770 }
3771
3772 /**
3773  * tb_switch_xhci_connect() - Connect internal xHCI
3774  * @sw: Router whose xHCI to connect
3775  *
3776  * Can be called to any router. For Alpine Ridge and Titan Ridge
3777  * performs special flows that bring the xHCI functional for any device
3778  * connected to the type-C port. Call only after PCIe tunnel has been
3779  * established. The function only does the connect if not done already
3780  * so can be called several times for the same router.
3781  */
3782 int tb_switch_xhci_connect(struct tb_switch *sw)
3783 {
3784         bool usb_port1, usb_port3, xhci_port1, xhci_port3;
3785         struct tb_port *port1, *port3;
3786         int ret;
3787
3788         port1 = &sw->ports[1];
3789         port3 = &sw->ports[3];
3790
3791         if (tb_switch_is_alpine_ridge(sw)) {
3792                 usb_port1 = tb_lc_is_usb_plugged(port1);
3793                 usb_port3 = tb_lc_is_usb_plugged(port3);
3794                 xhci_port1 = tb_lc_is_xhci_connected(port1);
3795                 xhci_port3 = tb_lc_is_xhci_connected(port3);
3796
3797                 /* Figure out correct USB port to connect */
3798                 if (usb_port1 && !xhci_port1) {
3799                         ret = tb_lc_xhci_connect(port1);
3800                         if (ret)
3801                                 return ret;
3802                 }
3803                 if (usb_port3 && !xhci_port3)
3804                         return tb_lc_xhci_connect(port3);
3805         } else if (tb_switch_is_titan_ridge(sw)) {
3806                 ret = tb_lc_xhci_connect(port1);
3807                 if (ret)
3808                         return ret;
3809                 return tb_lc_xhci_connect(port3);
3810         }
3811
3812         return 0;
3813 }
3814
3815 /**
3816  * tb_switch_xhci_disconnect() - Disconnect internal xHCI
3817  * @sw: Router whose xHCI to disconnect
3818  *
3819  * The opposite of tb_switch_xhci_connect(). Disconnects xHCI on both
3820  * ports.
3821  */
3822 void tb_switch_xhci_disconnect(struct tb_switch *sw)
3823 {
3824         if (sw->generation == 3) {
3825                 struct tb_port *port1 = &sw->ports[1];
3826                 struct tb_port *port3 = &sw->ports[3];
3827
3828                 tb_lc_xhci_disconnect(port1);
3829                 tb_port_dbg(port1, "disconnected xHCI\n");
3830                 tb_lc_xhci_disconnect(port3);
3831                 tb_port_dbg(port3, "disconnected xHCI\n");
3832         }
3833 }