drivers/usb/typec/ucsi/ucsi.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * USB Type-C Connector System Software Interface driver
   4  *
   5  * Copyright (C) 2017, Intel Corporation
   6  * Author: Heikki Krogerus <[email protected]>
   7  */
   8
   9 #include <linux/completion.h>
  10 #include <linux/property.h>
  11 #include <linux/device.h>
  12 #include <linux/module.h>
  13 #include <linux/delay.h>
  14 #include <linux/slab.h>
  15 #include <linux/usb/typec_dp.h>
  16
  17 #include "ucsi.h"
  18 #include "trace.h"
  19
  20 /*
  21  * UCSI_TIMEOUT_MS - PPM communication timeout
  22  *
  23  * Ideally we could use MIN_TIME_TO_RESPOND_WITH_BUSY (which is defined in UCSI
  24  * specification) here as reference, but unfortunately we can't. It is very
  25  * difficult to estimate the time it takes for the system to process the command
  26  * before it is actually passed to the PPM.
  27  */
  28 #define UCSI_TIMEOUT_MS         5000
  29
  30 /*
  31  * UCSI_SWAP_TIMEOUT_MS - Timeout for role swap requests
  32  *
  33  * 5 seconds is close to the time it takes for CapsCounter to reach 0, so even
  34  * if the PPM does not generate Connector Change events before that with
  35  * partners that do not support USB Power Delivery, this should still work.
  36  */
  37 #define UCSI_SWAP_TIMEOUT_MS    5000
  38
  39 static int ucsi_acknowledge_command(struct ucsi *ucsi)
  40 {
  41         u64 ctrl;
  42
  43         ctrl = UCSI_ACK_CC_CI;
  44         ctrl |= UCSI_ACK_COMMAND_COMPLETE;
  45
  46         return ucsi->ops->sync_write(ucsi, UCSI_CONTROL, &ctrl, sizeof(ctrl));
  47 }
  48
  49 static int ucsi_acknowledge_connector_change(struct ucsi *ucsi)
  50 {
  51         u64 ctrl;
  52
  53         ctrl = UCSI_ACK_CC_CI;
  54         ctrl |= UCSI_ACK_CONNECTOR_CHANGE;
  55
  56         return ucsi->ops->async_write(ucsi, UCSI_CONTROL, &ctrl, sizeof(ctrl));
  57 }
  58
  59 static int ucsi_exec_command(struct ucsi *ucsi, u64 command);
  60
  61 static int ucsi_read_error(struct ucsi *ucsi)
  62 {
  63         u16 error;
  64         int ret;
  65
  66         /* Acknowlege the command that failed */
  67         ret = ucsi_acknowledge_command(ucsi);
  68         if (ret)
  69                 return ret;
  70
  71         ret = ucsi_exec_command(ucsi, UCSI_GET_ERROR_STATUS);
  72         if (ret < 0)
  73                 return ret;
  74
  75         ret = ucsi->ops->read(ucsi, UCSI_MESSAGE_IN, &error, sizeof(error));
  76         if (ret)
  77                 return ret;
  78
  79         switch (error) {
  80         case UCSI_ERROR_INCOMPATIBLE_PARTNER:
  81                 return -EOPNOTSUPP;
  82         case UCSI_ERROR_CC_COMMUNICATION_ERR:
  83                 return -ECOMM;
  84         case UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL:
  85                 return -EPROTO;
  86         case UCSI_ERROR_DEAD_BATTERY:
  87                 dev_warn(ucsi->dev, "Dead battery condition!\n");
  88                 return -EPERM;
  89         case UCSI_ERROR_INVALID_CON_NUM:
  90         case UCSI_ERROR_UNREGONIZED_CMD:
  91         case UCSI_ERROR_INVALID_CMD_ARGUMENT:
  92                 dev_err(ucsi->dev, "possible UCSI driver bug %u\n", error);
  93                 return -EINVAL;
  94         case UCSI_ERROR_OVERCURRENT:
  95                 dev_warn(ucsi->dev, "Overcurrent condition\n");
  96                 break;
  97         case UCSI_ERROR_PARTNER_REJECTED_SWAP:
  98                 dev_warn(ucsi->dev, "Partner rejected swap\n");
  99                 break;
 100         case UCSI_ERROR_HARD_RESET:
 101                 dev_warn(ucsi->dev, "Hard reset occurred\n");
 102                 break;
 103         case UCSI_ERROR_PPM_POLICY_CONFLICT:
 104                 dev_warn(ucsi->dev, "PPM Policy conflict\n");
 105                 break;
 106         case UCSI_ERROR_SWAP_REJECTED:
 107                 dev_warn(ucsi->dev, "Swap rejected\n");
 108                 break;
 109         case UCSI_ERROR_UNDEFINED:
 110         default:
 111                 dev_err(ucsi->dev, "unknown error %u\n", error);
 112                 break;
 113         }
 114
 115         return -EIO;
 116 }
 117
 118 static int ucsi_exec_command(struct ucsi *ucsi, u64 cmd)
 119 {
 120         u32 cci;
 121         int ret;
 122
 123         ret = ucsi->ops->sync_write(ucsi, UCSI_CONTROL, &cmd, sizeof(cmd));
 124         if (ret)
 125                 return ret;
 126
 127         ret = ucsi->ops->read(ucsi, UCSI_CCI, &cci, sizeof(cci));
 128         if (ret)
 129                 return ret;
 130
 131         if (cci & UCSI_CCI_BUSY)
 132                 return -EBUSY;
 133
 134         if (!(cci & UCSI_CCI_COMMAND_COMPLETE))
 135                 return -EIO;
 136
 137         if (cci & UCSI_CCI_NOT_SUPPORTED)
 138                 return -EOPNOTSUPP;
 139
 140         if (cci & UCSI_CCI_ERROR) {
 141                 if (cmd == UCSI_GET_ERROR_STATUS)
 142                         return -EIO;
 143                 return ucsi_read_error(ucsi);
 144         }
 145
 146         return UCSI_CCI_LENGTH(cci);
 147 }
 148
 149 int ucsi_send_command(struct ucsi *ucsi, u64 command,
 150                       void *data, size_t size)
 151 {
 152         u8 length;
 153         int ret;
 154
 155         mutex_lock(&ucsi->ppm_lock);
 156
 157         ret = ucsi_exec_command(ucsi, command);
 158         if (ret < 0)
 159                 goto out;
 160
 161         length = ret;
 162
 163         if (data) {
 164                 ret = ucsi->ops->read(ucsi, UCSI_MESSAGE_IN, data, size);
 165                 if (ret)
 166                         goto out;
 167         }
 168
 169         ret = ucsi_acknowledge_command(ucsi);
 170         if (ret)
 171                 goto out;
 172
 173         ret = length;
 174 out:
 175         mutex_unlock(&ucsi->ppm_lock);
 176         return ret;
 177 }
 178 EXPORT_SYMBOL_GPL(ucsi_send_command);
 179
 180 int ucsi_resume(struct ucsi *ucsi)
 181 {
 182         u64 command;
 183
 184         /* Restore UCSI notification enable mask after system resume */
 185         command = UCSI_SET_NOTIFICATION_ENABLE | ucsi->ntfy;
 186
 187         return ucsi_send_command(ucsi, command, NULL, 0);
 188 }
 189 EXPORT_SYMBOL_GPL(ucsi_resume);
 190 /* -------------------------------------------------------------------------- */
 191
 192 void ucsi_altmode_update_active(struct ucsi_connector *con)
 193 {
 194         const struct typec_altmode *altmode = NULL;
 195         u64 command;
 196         int ret;
 197         u8 cur;
 198         int i;
 199
 200         command = UCSI_GET_CURRENT_CAM | UCSI_CONNECTOR_NUMBER(con->num);
 201         ret = ucsi_send_command(con->ucsi, command, &cur, sizeof(cur));
 202         if (ret < 0) {
 203                 if (con->ucsi->version > 0x0100) {
 204                         dev_err(con->ucsi->dev,
 205                                 "GET_CURRENT_CAM command failed\n");
 206                         return;
 207                 }
 208                 cur = 0xff;
 209         }
 210
 211         if (cur < UCSI_MAX_ALTMODES)
 212                 altmode = typec_altmode_get_partner(con->port_altmode[cur]);
 213
 214         for (i = 0; con->partner_altmode[i]; i++)
 215                 typec_altmode_update_active(con->partner_altmode[i],
 216                                             con->partner_altmode[i] == altmode);
 217 }
 218
 219 static int ucsi_altmode_next_mode(struct typec_altmode **alt, u16 svid)
 220 {
 221         u8 mode = 1;
 222         int i;
 223
 224         for (i = 0; alt[i]; i++) {
 225                 if (i > MODE_DISCOVERY_MAX)
 226                         return -ERANGE;
 227
 228                 if (alt[i]->svid == svid)
 229                         mode++;
 230         }
 231
 232         return mode;
 233 }
 234
 235 static int ucsi_next_altmode(struct typec_altmode **alt)
 236 {
 237         int i = 0;
 238
 239         for (i = 0; i < UCSI_MAX_ALTMODES; i++)
 240                 if (!alt[i])
 241                         return i;
 242
 243         return -ENOENT;
 244 }
 245
 246 static int ucsi_register_altmode(struct ucsi_connector *con,
 247                                  struct typec_altmode_desc *desc,
 248                                  u8 recipient)
 249 {
 250         struct typec_altmode *alt;
 251         bool override;
 252         int ret;
 253         int i;
 254
 255         override = !!(con->ucsi->cap.features & UCSI_CAP_ALT_MODE_OVERRIDE);
 256
 257         switch (recipient) {
 258         case UCSI_RECIPIENT_CON:
 259                 i = ucsi_next_altmode(con->port_altmode);
 260                 if (i < 0) {
 261                         ret = i;
 262                         goto err;
 263                 }
 264
 265                 ret = ucsi_altmode_next_mode(con->port_altmode, desc->svid);
 266                 if (ret < 0)
 267                         return ret;
 268
 269                 desc->mode = ret;
 270
 271                 switch (desc->svid) {
 272                 case USB_TYPEC_DP_SID:
 273                         alt = ucsi_register_displayport(con, override, i, desc);
 274                         break;
 275                 case USB_TYPEC_NVIDIA_VLINK_SID:
 276                         if (desc->vdo == USB_TYPEC_NVIDIA_VLINK_DBG_VDO)
 277                                 alt = typec_port_register_altmode(con->port,
 278                                                                   desc);
 279                         else
 280                                 alt = ucsi_register_displayport(con, override,
 281                                                                 i, desc);
 282                         break;
 283                 default:
 284                         alt = typec_port_register_altmode(con->port, desc);
 285                         break;
 286                 }
 287
 288                 if (IS_ERR(alt)) {
 289                         ret = PTR_ERR(alt);
 290                         goto err;
 291                 }
 292
 293                 con->port_altmode[i] = alt;
 294                 break;
 295         case UCSI_RECIPIENT_SOP:
 296                 i = ucsi_next_altmode(con->partner_altmode);
 297                 if (i < 0) {
 298                         ret = i;
 299                         goto err;
 300                 }
 301
 302                 ret = ucsi_altmode_next_mode(con->partner_altmode, desc->svid);
 303                 if (ret < 0)
 304                         return ret;
 305
 306                 desc->mode = ret;
 307
 308                 alt = typec_partner_register_altmode(con->partner, desc);
 309                 if (IS_ERR(alt)) {
 310                         ret = PTR_ERR(alt);
 311                         goto err;
 312                 }
 313
 314                 con->partner_altmode[i] = alt;
 315                 break;
 316         default:
 317                 return -EINVAL;
 318         }
 319
 320         trace_ucsi_register_altmode(recipient, alt);
 321
 322         return 0;
 323
 324 err:
 325         dev_err(con->ucsi->dev, "failed to registers svid 0x%04x mode %d\n",
 326                 desc->svid, desc->mode);
 327
 328         return ret;
 329 }
 330
 331 static int
 332 ucsi_register_altmodes_nvidia(struct ucsi_connector *con, u8 recipient)
 333 {
 334         int max_altmodes = UCSI_MAX_ALTMODES;
 335         struct typec_altmode_desc desc;
 336         struct ucsi_altmode alt;
 337         struct ucsi_altmode orig[UCSI_MAX_ALTMODES];
 338         struct ucsi_altmode updated[UCSI_MAX_ALTMODES];
 339         struct ucsi *ucsi = con->ucsi;
 340         bool multi_dp = false;
 341         u64 command;
 342         int ret;
 343         int len;
 344         int i;
 345         int k = 0;
 346
 347         if (recipient == UCSI_RECIPIENT_CON)
 348                 max_altmodes = con->ucsi->cap.num_alt_modes;
 349
 350         memset(orig, 0, sizeof(orig));
 351         memset(updated, 0, sizeof(updated));
 352
 353         /* First get all the alternate modes */
 354         for (i = 0; i < max_altmodes; i++) {
 355                 memset(&alt, 0, sizeof(alt));
 356                 command = UCSI_GET_ALTERNATE_MODES;
 357                 command |= UCSI_GET_ALTMODE_RECIPIENT(recipient);
 358                 command |= UCSI_GET_ALTMODE_CONNECTOR_NUMBER(con->num);
 359                 command |= UCSI_GET_ALTMODE_OFFSET(i);
 360                 len = ucsi_send_command(con->ucsi, command, &alt, sizeof(alt));
 361                 /*
 362                  * We are collecting all altmodes first and then registering.
 363                  * Some type-C device will return zero length data beyond last
 364                  * alternate modes. We should not return if length is zero.
 365                  */
 366                 if (len < 0)
 367                         return len;
 368
 369                 /* We got all altmodes, now break out and register them */
 370                 if (!len || !alt.svid)
 371                         break;
 372
 373                 orig[k].mid = alt.mid;
 374                 orig[k].svid = alt.svid;
 375                 k++;
 376         }
 377         /*
 378          * Update the original altmode table as some ppms may report
 379          * multiple DP altmodes.
 380          */
 381         if (recipient == UCSI_RECIPIENT_CON)
 382                 multi_dp = ucsi->ops->update_altmodes(ucsi, orig, updated);
 383
 384         /* now register altmodes */
 385         for (i = 0; i < max_altmodes; i++) {
 386                 memset(&desc, 0, sizeof(desc));
 387                 if (multi_dp && recipient == UCSI_RECIPIENT_CON) {
 388                         desc.svid = updated[i].svid;
 389                         desc.vdo = updated[i].mid;
 390                 } else {
 391                         desc.svid = orig[i].svid;
 392                         desc.vdo = orig[i].mid;
 393                 }
 394                 desc.roles = TYPEC_PORT_DRD;
 395
 396                 if (!desc.svid)
 397                         return 0;
 398
 399                 ret = ucsi_register_altmode(con, &desc, recipient);
 400                 if (ret)
 401                         return ret;
 402         }
 403
 404         return 0;
 405 }
 406
 407 static int ucsi_register_altmodes(struct ucsi_connector *con, u8 recipient)
 408 {
 409         int max_altmodes = UCSI_MAX_ALTMODES;
 410         struct typec_altmode_desc desc;
 411         struct ucsi_altmode alt[2];
 412         u64 command;
 413         int num;
 414         int ret;
 415         int len;
 416         int j;
 417         int i;
 418
 419         if (!(con->ucsi->cap.features & UCSI_CAP_ALT_MODE_DETAILS))
 420                 return 0;
 421
 422         if (recipient == UCSI_RECIPIENT_SOP && con->partner_altmode[0])
 423                 return 0;
 424
 425         if (con->ucsi->ops->update_altmodes)
 426                 return ucsi_register_altmodes_nvidia(con, recipient);
 427
 428         if (recipient == UCSI_RECIPIENT_CON)
 429                 max_altmodes = con->ucsi->cap.num_alt_modes;
 430
 431         for (i = 0; i < max_altmodes;) {
 432                 memset(alt, 0, sizeof(alt));
 433                 command = UCSI_GET_ALTERNATE_MODES;
 434                 command |= UCSI_GET_ALTMODE_RECIPIENT(recipient);
 435                 command |= UCSI_GET_ALTMODE_CONNECTOR_NUMBER(con->num);
 436                 command |= UCSI_GET_ALTMODE_OFFSET(i);
 437                 len = ucsi_send_command(con->ucsi, command, alt, sizeof(alt));
 438                 if (len <= 0)
 439                         return len;
 440
 441                 /*
 442                  * This code is requesting one alt mode at a time, but some PPMs
 443                  * may still return two. If that happens both alt modes need be
 444                  * registered and the offset for the next alt mode has to be
 445                  * incremented.
 446                  */
 447                 num = len / sizeof(alt[0]);
 448                 i += num;
 449
 450                 for (j = 0; j < num; j++) {
 451                         if (!alt[j].svid)
 452                                 return 0;
 453
 454                         memset(&desc, 0, sizeof(desc));
 455                         desc.vdo = alt[j].mid;
 456                         desc.svid = alt[j].svid;
 457                         desc.roles = TYPEC_PORT_DRD;
 458
 459                         ret = ucsi_register_altmode(con, &desc, recipient);
 460                         if (ret)
 461                                 return ret;
 462                 }
 463         }
 464
 465         return 0;
 466 }
 467
 468 static void ucsi_unregister_altmodes(struct ucsi_connector *con, u8 recipient)
 469 {
 470         const struct typec_altmode *pdev;
 471         struct typec_altmode **adev;
 472         int i = 0;
 473
 474         switch (recipient) {
 475         case UCSI_RECIPIENT_CON:
 476                 adev = con->port_altmode;
 477                 break;
 478         case UCSI_RECIPIENT_SOP:
 479                 adev = con->partner_altmode;
 480                 break;
 481         default:
 482                 return;
 483         }
 484
 485         while (adev[i]) {
 486                 if (recipient == UCSI_RECIPIENT_SOP &&
 487                     (adev[i]->svid == USB_TYPEC_DP_SID ||
 488                         (adev[i]->svid == USB_TYPEC_NVIDIA_VLINK_SID &&
 489                         adev[i]->vdo != USB_TYPEC_NVIDIA_VLINK_DBG_VDO))) {
 490                         pdev = typec_altmode_get_partner(adev[i]);
 491                         ucsi_displayport_remove_partner((void *)pdev);
 492                 }
 493                 typec_unregister_altmode(adev[i]);
 494                 adev[i++] = NULL;
 495         }
 496 }
 497
 498 static void ucsi_get_pdos(struct ucsi_connector *con, int is_partner)
 499 {
 500         struct ucsi *ucsi = con->ucsi;
 501         u64 command;
 502         int ret;
 503
 504         command = UCSI_COMMAND(UCSI_GET_PDOS) | UCSI_CONNECTOR_NUMBER(con->num);
 505         command |= UCSI_GET_PDOS_PARTNER_PDO(is_partner);
 506         command |= UCSI_GET_PDOS_NUM_PDOS(UCSI_MAX_PDOS - 1);
 507         command |= UCSI_GET_PDOS_SRC_PDOS;
 508         ret = ucsi_send_command(ucsi, command, con->src_pdos,
 509                                sizeof(con->src_pdos));
 510         if (ret < 0) {
 511                 dev_err(ucsi->dev, "UCSI_GET_PDOS failed (%d)\n", ret);
 512                 return;
 513         }
 514         con->num_pdos = ret / sizeof(u32); /* number of bytes to 32-bit PDOs */
 515         if (ret == 0)
 516                 dev_warn(ucsi->dev, "UCSI_GET_PDOS returned 0 bytes\n");
 517 }
 518
 519 static void ucsi_pwr_opmode_change(struct ucsi_connector *con)
 520 {
 521         switch (UCSI_CONSTAT_PWR_OPMODE(con->status.flags)) {
 522         case UCSI_CONSTAT_PWR_OPMODE_PD:
 523                 con->rdo = con->status.request_data_obj;
 524                 typec_set_pwr_opmode(con->port, TYPEC_PWR_MODE_PD);
 525                 ucsi_get_pdos(con, 1);
 526                 break;
 527         case UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5:
 528                 con->rdo = 0;
 529                 typec_set_pwr_opmode(con->port, TYPEC_PWR_MODE_1_5A);
 530                 break;
 531         case UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0:
 532                 con->rdo = 0;
 533                 typec_set_pwr_opmode(con->port, TYPEC_PWR_MODE_3_0A);
 534                 break;
 535         default:
 536                 con->rdo = 0;
 537                 typec_set_pwr_opmode(con->port, TYPEC_PWR_MODE_USB);
 538                 break;
 539         }
 540 }
 541
 542 static int ucsi_register_partner(struct ucsi_connector *con)
 543 {
 544         u8 pwr_opmode = UCSI_CONSTAT_PWR_OPMODE(con->status.flags);
 545         struct typec_partner_desc desc;
 546         struct typec_partner *partner;
 547
 548         if (con->partner)
 549                 return 0;
 550
 551         memset(&desc, 0, sizeof(desc));
 552
 553         switch (UCSI_CONSTAT_PARTNER_TYPE(con->status.flags)) {
 554         case UCSI_CONSTAT_PARTNER_TYPE_DEBUG:
 555                 desc.accessory = TYPEC_ACCESSORY_DEBUG;
 556                 break;
 557         case UCSI_CONSTAT_PARTNER_TYPE_AUDIO:
 558                 desc.accessory = TYPEC_ACCESSORY_AUDIO;
 559                 break;
 560         default:
 561                 break;
 562         }
 563
 564         desc.usb_pd = pwr_opmode == UCSI_CONSTAT_PWR_OPMODE_PD;
 565
 566         partner = typec_register_partner(con->port, &desc);
 567         if (IS_ERR(partner)) {
 568                 dev_err(con->ucsi->dev,
 569                         "con%d: failed to register partner (%ld)\n", con->num,
 570                         PTR_ERR(partner));
 571                 return PTR_ERR(partner);
 572         }
 573
 574         con->partner = partner;
 575
 576         return 0;
 577 }
 578
 579 static void ucsi_unregister_partner(struct ucsi_connector *con)
 580 {
 581         if (!con->partner)
 582                 return;
 583
 584         ucsi_unregister_altmodes(con, UCSI_RECIPIENT_SOP);
 585         typec_unregister_partner(con->partner);
 586         con->partner = NULL;
 587 }
 588
 589 static void ucsi_partner_change(struct ucsi_connector *con)
 590 {
 591         int ret;
 592
 593         if (!con->partner)
 594                 return;
 595
 596         switch (UCSI_CONSTAT_PARTNER_TYPE(con->status.flags)) {
 597         case UCSI_CONSTAT_PARTNER_TYPE_UFP:
 598         case UCSI_CONSTAT_PARTNER_TYPE_CABLE:
 599         case UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP:
 600                 typec_set_data_role(con->port, TYPEC_HOST);
 601                 break;
 602         case UCSI_CONSTAT_PARTNER_TYPE_DFP:
 603                 typec_set_data_role(con->port, TYPEC_DEVICE);
 604                 break;
 605         default:
 606                 break;
 607         }
 608
 609         /* Complete pending data role swap */
 610         if (!completion_done(&con->complete))
 611                 complete(&con->complete);
 612
 613         /* Can't rely on Partner Flags field. Always checking the alt modes. */
 614         ret = ucsi_register_altmodes(con, UCSI_RECIPIENT_SOP);
 615         if (ret)
 616                 dev_err(con->ucsi->dev,
 617                         "con%d: failed to register partner alternate modes\n",
 618                         con->num);
 619         else
 620                 ucsi_altmode_update_active(con);
 621 }
 622
 623 static void ucsi_handle_connector_change(struct work_struct *work)
 624 {
 625         struct ucsi_connector *con = container_of(work, struct ucsi_connector,
 626                                                   work);
 627         struct ucsi *ucsi = con->ucsi;
 628         enum typec_role role;
 629         u64 command;
 630         int ret;
 631
 632         mutex_lock(&con->lock);
 633
 634         command = UCSI_GET_CONNECTOR_STATUS | UCSI_CONNECTOR_NUMBER(con->num);
 635         ret = ucsi_send_command(ucsi, command, &con->status,
 636                                 sizeof(con->status));
 637         if (ret < 0) {
 638                 dev_err(ucsi->dev, "%s: GET_CONNECTOR_STATUS failed (%d)\n",
 639                         __func__, ret);
 640                 goto out_unlock;
 641         }
 642
 643         role = !!(con->status.flags & UCSI_CONSTAT_PWR_DIR);
 644
 645         if (con->status.change & UCSI_CONSTAT_POWER_OPMODE_CHANGE ||
 646             con->status.change & UCSI_CONSTAT_POWER_LEVEL_CHANGE) {
 647                 ucsi_pwr_opmode_change(con);
 648                 ucsi_port_psy_changed(con);
 649         }
 650
 651         if (con->status.change & UCSI_CONSTAT_POWER_DIR_CHANGE) {
 652                 typec_set_pwr_role(con->port, role);
 653
 654                 /* Complete pending power role swap */
 655                 if (!completion_done(&con->complete))
 656                         complete(&con->complete);
 657         }
 658
 659         if (con->status.change & UCSI_CONSTAT_CONNECT_CHANGE) {
 660                 typec_set_pwr_role(con->port, role);
 661
 662                 switch (UCSI_CONSTAT_PARTNER_TYPE(con->status.flags)) {
 663                 case UCSI_CONSTAT_PARTNER_TYPE_UFP:
 664                 case UCSI_CONSTAT_PARTNER_TYPE_CABLE:
 665                 case UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP:
 666                         typec_set_data_role(con->port, TYPEC_HOST);
 667                         break;
 668                 case UCSI_CONSTAT_PARTNER_TYPE_DFP:
 669                         typec_set_data_role(con->port, TYPEC_DEVICE);
 670                         break;
 671                 default:
 672                         break;
 673                 }
 674
 675                 if (con->status.flags & UCSI_CONSTAT_CONNECTED)
 676                         ucsi_register_partner(con);
 677                 else
 678                         ucsi_unregister_partner(con);
 679
 680                 ucsi_port_psy_changed(con);
 681         }
 682
 683         if (con->status.change & UCSI_CONSTAT_CAM_CHANGE) {
 684                 /*
 685                  * We don't need to know the currently supported alt modes here.
 686                  * Running GET_CAM_SUPPORTED command just to make sure the PPM
 687                  * does not get stuck in case it assumes we do so.
 688                  */
 689                 command = UCSI_GET_CAM_SUPPORTED;
 690                 command |= UCSI_CONNECTOR_NUMBER(con->num);
 691                 ucsi_send_command(con->ucsi, command, NULL, 0);
 692         }
 693
 694         if (con->status.change & UCSI_CONSTAT_PARTNER_CHANGE)
 695                 ucsi_partner_change(con);
 696
 697         ret = ucsi_acknowledge_connector_change(ucsi);
 698         if (ret)
 699                 dev_err(ucsi->dev, "%s: ACK failed (%d)", __func__, ret);
 700
 701         trace_ucsi_connector_change(con->num, &con->status);
 702
 703 out_unlock:
 704         clear_bit(EVENT_PENDING, &ucsi->flags);
 705         mutex_unlock(&con->lock);
 706 }
 707
 708 /**
 709  * ucsi_connector_change - Process Connector Change Event
 710  * @ucsi: UCSI Interface
 711  * @num: Connector number
 712  */
 713 void ucsi_connector_change(struct ucsi *ucsi, u8 num)
 714 {
 715         struct ucsi_connector *con = &ucsi->connector[num - 1];
 716
 717         if (!(ucsi->ntfy & UCSI_ENABLE_NTFY_CONNECTOR_CHANGE)) {
 718                 dev_dbg(ucsi->dev, "Bogus connector change event\n");
 719                 return;
 720         }
 721
 722         if (!test_and_set_bit(EVENT_PENDING, &ucsi->flags))
 723                 schedule_work(&con->work);
 724 }
 725 EXPORT_SYMBOL_GPL(ucsi_connector_change);
 726
 727 /* -------------------------------------------------------------------------- */
 728
 729 static int ucsi_reset_connector(struct ucsi_connector *con, bool hard)
 730 {
 731         u64 command;
 732
 733         command = UCSI_CONNECTOR_RESET | UCSI_CONNECTOR_NUMBER(con->num);
 734         command |= hard ? UCSI_CONNECTOR_RESET_HARD : 0;
 735
 736         return ucsi_send_command(con->ucsi, command, NULL, 0);
 737 }
 738
 739 static int ucsi_reset_ppm(struct ucsi *ucsi)
 740 {
 741         u64 command = UCSI_PPM_RESET;
 742         unsigned long tmo;
 743         u32 cci;
 744         int ret;
 745
 746         mutex_lock(&ucsi->ppm_lock);
 747
 748         ret = ucsi->ops->async_write(ucsi, UCSI_CONTROL, &command,
 749                                      sizeof(command));
 750         if (ret < 0)
 751                 goto out;
 752
 753         tmo = jiffies + msecs_to_jiffies(UCSI_TIMEOUT_MS);
 754
 755         do {
 756                 if (time_is_before_jiffies(tmo)) {
 757                         ret = -ETIMEDOUT;
 758                         goto out;
 759                 }
 760
 761                 ret = ucsi->ops->read(ucsi, UCSI_CCI, &cci, sizeof(cci));
 762                 if (ret)
 763                         goto out;
 764
 765                 /* If the PPM is still doing something else, reset it again. */
 766                 if (cci & ~UCSI_CCI_RESET_COMPLETE) {
 767                         ret = ucsi->ops->async_write(ucsi, UCSI_CONTROL,
 768                                                      &command,
 769                                                      sizeof(command));
 770                         if (ret < 0)
 771                                 goto out;
 772                 }
 773
 774                 msleep(20);
 775         } while (!(cci & UCSI_CCI_RESET_COMPLETE));
 776
 777 out:
 778         mutex_unlock(&ucsi->ppm_lock);
 779         return ret;
 780 }
 781
 782 static int ucsi_role_cmd(struct ucsi_connector *con, u64 command)
 783 {
 784         int ret;
 785
 786         ret = ucsi_send_command(con->ucsi, command, NULL, 0);
 787         if (ret == -ETIMEDOUT) {
 788                 u64 c;
 789
 790                 /* PPM most likely stopped responding. Resetting everything. */
 791                 ucsi_reset_ppm(con->ucsi);
 792
 793                 c = UCSI_SET_NOTIFICATION_ENABLE | con->ucsi->ntfy;
 794                 ucsi_send_command(con->ucsi, c, NULL, 0);
 795
 796                 ucsi_reset_connector(con, true);
 797         }
 798
 799         return ret;
 800 }
 801
 802 static int ucsi_dr_swap(struct typec_port *port, enum typec_data_role role)
 803 {
 804         struct ucsi_connector *con = typec_get_drvdata(port);
 805         u8 partner_type;
 806         u64 command;
 807         int ret = 0;
 808
 809         mutex_lock(&con->lock);
 810
 811         if (!con->partner) {
 812                 ret = -ENOTCONN;
 813                 goto out_unlock;
 814         }
 815
 816         partner_type = UCSI_CONSTAT_PARTNER_TYPE(con->status.flags);
 817         if ((partner_type == UCSI_CONSTAT_PARTNER_TYPE_DFP &&
 818              role == TYPEC_DEVICE) ||
 819             (partner_type == UCSI_CONSTAT_PARTNER_TYPE_UFP &&
 820              role == TYPEC_HOST))
 821                 goto out_unlock;
 822
 823         command = UCSI_SET_UOR | UCSI_CONNECTOR_NUMBER(con->num);
 824         command |= UCSI_SET_UOR_ROLE(role);
 825         command |= UCSI_SET_UOR_ACCEPT_ROLE_SWAPS;
 826         ret = ucsi_role_cmd(con, command);
 827         if (ret < 0)
 828                 goto out_unlock;
 829
 830         if (!wait_for_completion_timeout(&con->complete,
 831                                         msecs_to_jiffies(UCSI_SWAP_TIMEOUT_MS)))
 832                 ret = -ETIMEDOUT;
 833
 834 out_unlock:
 835         mutex_unlock(&con->lock);
 836
 837         return ret < 0 ? ret : 0;
 838 }
 839
 840 static int ucsi_pr_swap(struct typec_port *port, enum typec_role role)
 841 {
 842         struct ucsi_connector *con = typec_get_drvdata(port);
 843         enum typec_role cur_role;
 844         u64 command;
 845         int ret = 0;
 846
 847         mutex_lock(&con->lock);
 848
 849         if (!con->partner) {
 850                 ret = -ENOTCONN;
 851                 goto out_unlock;
 852         }
 853
 854         cur_role = !!(con->status.flags & UCSI_CONSTAT_PWR_DIR);
 855
 856         if (cur_role == role)
 857                 goto out_unlock;
 858
 859         command = UCSI_SET_PDR | UCSI_CONNECTOR_NUMBER(con->num);
 860         command |= UCSI_SET_PDR_ROLE(role);
 861         command |= UCSI_SET_PDR_ACCEPT_ROLE_SWAPS;
 862         ret = ucsi_role_cmd(con, command);
 863         if (ret < 0)
 864                 goto out_unlock;
 865
 866         if (!wait_for_completion_timeout(&con->complete,
 867                                 msecs_to_jiffies(UCSI_SWAP_TIMEOUT_MS))) {
 868                 ret = -ETIMEDOUT;
 869                 goto out_unlock;
 870         }
 871
 872         /* Something has gone wrong while swapping the role */
 873         if (UCSI_CONSTAT_PWR_OPMODE(con->status.flags) !=
 874             UCSI_CONSTAT_PWR_OPMODE_PD) {
 875                 ucsi_reset_connector(con, true);
 876                 ret = -EPROTO;
 877         }
 878
 879 out_unlock:
 880         mutex_unlock(&con->lock);
 881
 882         return ret;
 883 }
 884
 885 static const struct typec_operations ucsi_ops = {
 886         .dr_set = ucsi_dr_swap,
 887         .pr_set = ucsi_pr_swap
 888 };
 889
 890 static struct fwnode_handle *ucsi_find_fwnode(struct ucsi_connector *con)
 891 {
 892         struct fwnode_handle *fwnode;
 893         int i = 1;
 894
 895         device_for_each_child_node(con->ucsi->dev, fwnode)
 896                 if (i++ == con->num)
 897                         return fwnode;
 898         return NULL;
 899 }
 900
 901 static int ucsi_register_port(struct ucsi *ucsi, int index)
 902 {
 903         struct ucsi_connector *con = &ucsi->connector[index];
 904         struct typec_capability *cap = &con->typec_cap;
 905         enum typec_accessory *accessory = cap->accessory;
 906         u64 command;
 907         int ret;
 908
 909         INIT_WORK(&con->work, ucsi_handle_connector_change);
 910         init_completion(&con->complete);
 911         mutex_init(&con->lock);
 912         con->num = index + 1;
 913         con->ucsi = ucsi;
 914
 915         /* Delay other interactions with the con until registration is complete */
 916         mutex_lock(&con->lock);
 917
 918         /* Get connector capability */
 919         command = UCSI_GET_CONNECTOR_CAPABILITY;
 920         command |= UCSI_CONNECTOR_NUMBER(con->num);
 921         ret = ucsi_send_command(ucsi, command, &con->cap, sizeof(con->cap));
 922         if (ret < 0)
 923                 goto out;
 924
 925         if (con->cap.op_mode & UCSI_CONCAP_OPMODE_DRP)
 926                 cap->data = TYPEC_PORT_DRD;
 927         else if (con->cap.op_mode & UCSI_CONCAP_OPMODE_DFP)
 928                 cap->data = TYPEC_PORT_DFP;
 929         else if (con->cap.op_mode & UCSI_CONCAP_OPMODE_UFP)
 930                 cap->data = TYPEC_PORT_UFP;
 931
 932         if ((con->cap.flags & UCSI_CONCAP_FLAG_PROVIDER) &&
 933             (con->cap.flags & UCSI_CONCAP_FLAG_CONSUMER))
 934                 cap->type = TYPEC_PORT_DRP;
 935         else if (con->cap.flags & UCSI_CONCAP_FLAG_PROVIDER)
 936                 cap->type = TYPEC_PORT_SRC;
 937         else if (con->cap.flags & UCSI_CONCAP_FLAG_CONSUMER)
 938                 cap->type = TYPEC_PORT_SNK;
 939
 940         cap->revision = ucsi->cap.typec_version;
 941         cap->pd_revision = ucsi->cap.pd_version;
 942         cap->prefer_role = TYPEC_NO_PREFERRED_ROLE;
 943
 944         if (con->cap.op_mode & UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY)
 945                 *accessory++ = TYPEC_ACCESSORY_AUDIO;
 946         if (con->cap.op_mode & UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY)
 947                 *accessory = TYPEC_ACCESSORY_DEBUG;
 948
 949         cap->fwnode = ucsi_find_fwnode(con);
 950         cap->driver_data = con;
 951         cap->ops = &ucsi_ops;
 952
 953         ret = ucsi_register_port_psy(con);
 954         if (ret)
 955                 goto out;
 956
 957         /* Register the connector */
 958         con->port = typec_register_port(ucsi->dev, cap);
 959         if (IS_ERR(con->port)) {
 960                 ret = PTR_ERR(con->port);
 961                 goto out;
 962         }
 963
 964         /* Alternate modes */
 965         ret = ucsi_register_altmodes(con, UCSI_RECIPIENT_CON);
 966         if (ret) {
 967                 dev_err(ucsi->dev, "con%d: failed to register alt modes\n",
 968                         con->num);
 969                 goto out;
 970         }
 971
 972         /* Get the status */
 973         command = UCSI_GET_CONNECTOR_STATUS | UCSI_CONNECTOR_NUMBER(con->num);
 974         ret = ucsi_send_command(ucsi, command, &con->status, sizeof(con->status));
 975         if (ret < 0) {
 976                 dev_err(ucsi->dev, "con%d: failed to get status\n", con->num);
 977                 ret = 0;
 978                 goto out;
 979         }
 980         ret = 0; /* ucsi_send_command() returns length on success */
 981
 982         switch (UCSI_CONSTAT_PARTNER_TYPE(con->status.flags)) {
 983         case UCSI_CONSTAT_PARTNER_TYPE_UFP:
 984         case UCSI_CONSTAT_PARTNER_TYPE_CABLE:
 985         case UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP:
 986                 typec_set_data_role(con->port, TYPEC_HOST);
 987                 break;
 988         case UCSI_CONSTAT_PARTNER_TYPE_DFP:
 989                 typec_set_data_role(con->port, TYPEC_DEVICE);
 990                 break;
 991         default:
 992                 break;
 993         }
 994
 995         /* Check if there is already something connected */
 996         if (con->status.flags & UCSI_CONSTAT_CONNECTED) {
 997                 typec_set_pwr_role(con->port,
 998                                   !!(con->status.flags & UCSI_CONSTAT_PWR_DIR));
 999                 ucsi_pwr_opmode_change(con);
1000                 ucsi_register_partner(con);
1001                 ucsi_port_psy_changed(con);
1002         }
1003
1004         if (con->partner) {
1005                 ret = ucsi_register_altmodes(con, UCSI_RECIPIENT_SOP);
1006                 if (ret) {
1007                         dev_err(ucsi->dev,
1008                                 "con%d: failed to register alternate modes\n",
1009                                 con->num);
1010                         ret = 0;
1011                 } else {
1012                         ucsi_altmode_update_active(con);
1013                 }
1014         }
1015
1016         trace_ucsi_register_port(con->num, &con->status);
1017
1018 out:
1019         mutex_unlock(&con->lock);
1020         return ret;
1021 }
1022
1023 /**
1024  * ucsi_init - Initialize UCSI interface
1025  * @ucsi: UCSI to be initialized
1026  *
1027  * Registers all ports @ucsi has and enables all notification events.
1028  */
1029 static int ucsi_init(struct ucsi *ucsi)
1030 {
1031         struct ucsi_connector *con;
1032         u64 command;
1033         int ret;
1034         int i;
1035
1036         /* Reset the PPM */
1037         ret = ucsi_reset_ppm(ucsi);
1038         if (ret) {
1039                 dev_err(ucsi->dev, "failed to reset PPM!\n");
1040                 goto err;
1041         }
1042
1043         /* Enable basic notifications */
1044         ucsi->ntfy = UCSI_ENABLE_NTFY_CMD_COMPLETE | UCSI_ENABLE_NTFY_ERROR;
1045         command = UCSI_SET_NOTIFICATION_ENABLE | ucsi->ntfy;
1046         ret = ucsi_send_command(ucsi, command, NULL, 0);
1047         if (ret < 0)
1048                 goto err_reset;
1049
1050         /* Get PPM capabilities */
1051         command = UCSI_GET_CAPABILITY;
1052         ret = ucsi_send_command(ucsi, command, &ucsi->cap, sizeof(ucsi->cap));
1053         if (ret < 0)
1054                 goto err_reset;
1055
1056         if (!ucsi->cap.num_connectors) {
1057                 ret = -ENODEV;
1058                 goto err_reset;
1059         }
1060
1061         /* Allocate the connectors. Released in ucsi_unregister_ppm() */
1062         ucsi->connector = kcalloc(ucsi->cap.num_connectors + 1,
1063                                   sizeof(*ucsi->connector), GFP_KERNEL);
1064         if (!ucsi->connector) {
1065                 ret = -ENOMEM;
1066                 goto err_reset;
1067         }
1068
1069         /* Register all connectors */
1070         for (i = 0; i < ucsi->cap.num_connectors; i++) {
1071                 ret = ucsi_register_port(ucsi, i);
1072                 if (ret)
1073                         goto err_unregister;
1074         }
1075
1076         /* Enable all notifications */
1077         ucsi->ntfy = UCSI_ENABLE_NTFY_ALL;
1078         command = UCSI_SET_NOTIFICATION_ENABLE | ucsi->ntfy;
1079         ret = ucsi_send_command(ucsi, command, NULL, 0);
1080         if (ret < 0)
1081                 goto err_unregister;
1082
1083         return 0;
1084
1085 err_unregister:
1086         for (con = ucsi->connector; con->port; con++) {
1087                 ucsi_unregister_partner(con);
1088                 ucsi_unregister_altmodes(con, UCSI_RECIPIENT_CON);
1089                 ucsi_unregister_port_psy(con);
1090                 typec_unregister_port(con->port);
1091                 con->port = NULL;
1092         }
1093
1094 err_reset:
1095         ucsi_reset_ppm(ucsi);
1096 err:
1097         return ret;
1098 }
1099
1100 static void ucsi_init_work(struct work_struct *work)
1101 {
1102         struct ucsi *ucsi = container_of(work, struct ucsi, work);
1103         int ret;
1104
1105         ret = ucsi_init(ucsi);
1106         if (ret)
1107                 dev_err(ucsi->dev, "PPM init failed (%d)\n", ret);
1108 }
1109
1110 /**
1111  * ucsi_get_drvdata - Return private driver data pointer
1112  * @ucsi: UCSI interface
1113  */
1114 void *ucsi_get_drvdata(struct ucsi *ucsi)
1115 {
1116         return ucsi->driver_data;
1117 }
1118 EXPORT_SYMBOL_GPL(ucsi_get_drvdata);
1119
1120 /**
1121  * ucsi_get_drvdata - Assign private driver data pointer
1122  * @ucsi: UCSI interface
1123  * @data: Private data pointer
1124  */
1125 void ucsi_set_drvdata(struct ucsi *ucsi, void *data)
1126 {
1127         ucsi->driver_data = data;
1128 }
1129 EXPORT_SYMBOL_GPL(ucsi_set_drvdata);
1130
1131 /**
1132  * ucsi_create - Allocate UCSI instance
1133  * @dev: Device interface to the PPM (Platform Policy Manager)
1134  * @ops: I/O routines
1135  */
1136 struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops)
1137 {
1138         struct ucsi *ucsi;
1139
1140         if (!ops || !ops->read || !ops->sync_write || !ops->async_write)
1141                 return ERR_PTR(-EINVAL);
1142
1143         ucsi = kzalloc(sizeof(*ucsi), GFP_KERNEL);
1144         if (!ucsi)
1145                 return ERR_PTR(-ENOMEM);
1146
1147         INIT_WORK(&ucsi->work, ucsi_init_work);
1148         mutex_init(&ucsi->ppm_lock);
1149         ucsi->dev = dev;
1150         ucsi->ops = ops;
1151
1152         return ucsi;
1153 }
1154 EXPORT_SYMBOL_GPL(ucsi_create);
1155
1156 /**
1157  * ucsi_destroy - Free UCSI instance
1158  * @ucsi: UCSI instance to be freed
1159  */
1160 void ucsi_destroy(struct ucsi *ucsi)
1161 {
1162         kfree(ucsi);
1163 }
1164 EXPORT_SYMBOL_GPL(ucsi_destroy);
1165
1166 /**
1167  * ucsi_register - Register UCSI interface
1168  * @ucsi: UCSI instance
1169  */
1170 int ucsi_register(struct ucsi *ucsi)
1171 {
1172         int ret;
1173
1174         ret = ucsi->ops->read(ucsi, UCSI_VERSION, &ucsi->version,
1175                               sizeof(ucsi->version));
1176         if (ret)
1177                 return ret;
1178
1179         if (!ucsi->version)
1180                 return -ENODEV;
1181
1182         queue_work(system_long_wq, &ucsi->work);
1183
1184         return 0;
1185 }
1186 EXPORT_SYMBOL_GPL(ucsi_register);
1187
1188 /**
1189  * ucsi_unregister - Unregister UCSI interface
1190  * @ucsi: UCSI interface to be unregistered
1191  *
1192  * Unregister UCSI interface that was created with ucsi_register().
1193  */
1194 void ucsi_unregister(struct ucsi *ucsi)
1195 {
1196         u64 cmd = UCSI_SET_NOTIFICATION_ENABLE;
1197         int i;
1198
1199         /* Make sure that we are not in the middle of driver initialization */
1200         cancel_work_sync(&ucsi->work);
1201
1202         /* Disable notifications */
1203         ucsi->ops->async_write(ucsi, UCSI_CONTROL, &cmd, sizeof(cmd));
1204
1205         for (i = 0; i < ucsi->cap.num_connectors; i++) {
1206                 cancel_work_sync(&ucsi->connector[i].work);
1207                 ucsi_unregister_partner(&ucsi->connector[i]);
1208                 ucsi_unregister_altmodes(&ucsi->connector[i],
1209                                          UCSI_RECIPIENT_CON);
1210                 ucsi_unregister_port_psy(&ucsi->connector[i]);
1211                 typec_unregister_port(ucsi->connector[i].port);
1212         }
1213
1214         kfree(ucsi->connector);
1215 }
1216 EXPORT_SYMBOL_GPL(ucsi_unregister);
1217
1218 MODULE_AUTHOR("Heikki Krogerus <[email protected]>");
1219 MODULE_LICENSE("GPL v2");
1220 MODULE_DESCRIPTION("USB Type-C Connector System Software Interface driver");