drivers/gpu/drm/drm_dp_helper.c

   1 /*
   2  * Copyright © 2009 Keith Packard
   3  *
   4  * Permission to use, copy, modify, distribute, and sell this software and its
   5  * documentation for any purpose is hereby granted without fee, provided that
   6  * the above copyright notice appear in all copies and that both that copyright
   7  * notice and this permission notice appear in supporting documentation, and
   8  * that the name of the copyright holders not be used in advertising or
   9  * publicity pertaining to distribution of the software without specific,
  10  * written prior permission.  The copyright holders make no representations
  11  * about the suitability of this software for any purpose.  It is provided "as
  12  * is" without express or implied warranty.
  13  *
  14  * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  15  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  16  * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  17  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  18  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  19  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
  20  * OF THIS SOFTWARE.
  21  */
  22
  23 #include <linux/kernel.h>
  24 #include <linux/module.h>
  25 #include <linux/delay.h>
  26 #include <linux/init.h>
  27 #include <linux/errno.h>
  28 #include <linux/sched.h>
  29 #include <linux/i2c.h>
  30 #include <linux/seq_file.h>
  31 #include <drm/drm_dp_helper.h>
  32 #include <drm/drmP.h>
  33
  34 #include "drm_crtc_helper_internal.h"
  35
  36 /**
  37  * DOC: dp helpers
  38  *
  39  * These functions contain some common logic and helpers at various abstraction
  40  * levels to deal with Display Port sink devices and related things like DP aux
  41  * channel transfers, EDID reading over DP aux channels, decoding certain DPCD
  42  * blocks, ...
  43  */
  44
  45 /* Helpers for DP link training */
  46 static u8 dp_link_status(const u8 link_status[DP_LINK_STATUS_SIZE], int r)
  47 {
  48         return link_status[r - DP_LANE0_1_STATUS];
  49 }
  50
  51 static u8 dp_get_lane_status(const u8 link_status[DP_LINK_STATUS_SIZE],
  52                              int lane)
  53 {
  54         int i = DP_LANE0_1_STATUS + (lane >> 1);
  55         int s = (lane & 1) * 4;
  56         u8 l = dp_link_status(link_status, i);
  57         return (l >> s) & 0xf;
  58 }
  59
  60 bool drm_dp_channel_eq_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
  61                           int lane_count)
  62 {
  63         u8 lane_align;
  64         u8 lane_status;
  65         int lane;
  66
  67         lane_align = dp_link_status(link_status,
  68                                     DP_LANE_ALIGN_STATUS_UPDATED);
  69         if ((lane_align & DP_INTERLANE_ALIGN_DONE) == 0)
  70                 return false;
  71         for (lane = 0; lane < lane_count; lane++) {
  72                 lane_status = dp_get_lane_status(link_status, lane);
  73                 if ((lane_status & DP_CHANNEL_EQ_BITS) != DP_CHANNEL_EQ_BITS)
  74                         return false;
  75         }
  76         return true;
  77 }
  78 EXPORT_SYMBOL(drm_dp_channel_eq_ok);
  79
  80 bool drm_dp_clock_recovery_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
  81                               int lane_count)
  82 {
  83         int lane;
  84         u8 lane_status;
  85
  86         for (lane = 0; lane < lane_count; lane++) {
  87                 lane_status = dp_get_lane_status(link_status, lane);
  88                 if ((lane_status & DP_LANE_CR_DONE) == 0)
  89                         return false;
  90         }
  91         return true;
  92 }
  93 EXPORT_SYMBOL(drm_dp_clock_recovery_ok);
  94
  95 u8 drm_dp_get_adjust_request_voltage(const u8 link_status[DP_LINK_STATUS_SIZE],
  96                                      int lane)
  97 {
  98         int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
  99         int s = ((lane & 1) ?
 100                  DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT :
 101                  DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT);
 102         u8 l = dp_link_status(link_status, i);
 103
 104         return ((l >> s) & 0x3) << DP_TRAIN_VOLTAGE_SWING_SHIFT;
 105 }
 106 EXPORT_SYMBOL(drm_dp_get_adjust_request_voltage);
 107
 108 u8 drm_dp_get_adjust_request_pre_emphasis(const u8 link_status[DP_LINK_STATUS_SIZE],
 109                                           int lane)
 110 {
 111         int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
 112         int s = ((lane & 1) ?
 113                  DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT :
 114                  DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT);
 115         u8 l = dp_link_status(link_status, i);
 116
 117         return ((l >> s) & 0x3) << DP_TRAIN_PRE_EMPHASIS_SHIFT;
 118 }
 119 EXPORT_SYMBOL(drm_dp_get_adjust_request_pre_emphasis);
 120
 121 void drm_dp_link_train_clock_recovery_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) {
 122         int rd_interval = dpcd[DP_TRAINING_AUX_RD_INTERVAL] &
 123                           DP_TRAINING_AUX_RD_MASK;
 124
 125         if (rd_interval > 4)
 126                 DRM_DEBUG_KMS("AUX interval %d, out of range (max 4)\n",
 127                               rd_interval);
 128
 129         if (rd_interval == 0 || dpcd[DP_DPCD_REV] >= DP_DPCD_REV_14)
 130                 udelay(100);
 131         else
 132                 mdelay(rd_interval * 4);
 133 }
 134 EXPORT_SYMBOL(drm_dp_link_train_clock_recovery_delay);
 135
 136 void drm_dp_link_train_channel_eq_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) {
 137         int rd_interval = dpcd[DP_TRAINING_AUX_RD_INTERVAL] &
 138                           DP_TRAINING_AUX_RD_MASK;
 139
 140         if (rd_interval > 4)
 141                 DRM_DEBUG_KMS("AUX interval %d, out of range (max 4)\n",
 142                               rd_interval);
 143
 144         if (rd_interval == 0)
 145                 udelay(400);
 146         else
 147                 mdelay(rd_interval * 4);
 148 }
 149 EXPORT_SYMBOL(drm_dp_link_train_channel_eq_delay);
 150
 151 u8 drm_dp_link_rate_to_bw_code(int link_rate)
 152 {
 153         switch (link_rate) {
 154         default:
 155                 WARN(1, "unknown DP link rate %d, using %x\n", link_rate,
 156                      DP_LINK_BW_1_62);
 157         case 162000:
 158                 return DP_LINK_BW_1_62;
 159         case 270000:
 160                 return DP_LINK_BW_2_7;
 161         case 540000:
 162                 return DP_LINK_BW_5_4;
 163         case 810000:
 164                 return DP_LINK_BW_8_1;
 165         }
 166 }
 167 EXPORT_SYMBOL(drm_dp_link_rate_to_bw_code);
 168
 169 int drm_dp_bw_code_to_link_rate(u8 link_bw)
 170 {
 171         switch (link_bw) {
 172         default:
 173                 WARN(1, "unknown DP link BW code %x, using 162000\n", link_bw);
 174         case DP_LINK_BW_1_62:
 175                 return 162000;
 176         case DP_LINK_BW_2_7:
 177                 return 270000;
 178         case DP_LINK_BW_5_4:
 179                 return 540000;
 180         case DP_LINK_BW_8_1:
 181                 return 810000;
 182         }
 183 }
 184 EXPORT_SYMBOL(drm_dp_bw_code_to_link_rate);
 185
 186 #define AUX_RETRY_INTERVAL 500 /* us */
 187
 188 static inline void
 189 drm_dp_dump_access(const struct drm_dp_aux *aux,
 190                    u8 request, uint offset, void *buffer, int ret)
 191 {
 192         const char *arrow = request == DP_AUX_NATIVE_READ ? "->" : "<-";
 193
 194         if (ret > 0)
 195                 drm_dbg(DRM_UT_DP, "%s: 0x%05x AUX %s (ret=%3d) %*ph\n",
 196                         aux->name, offset, arrow, ret, min(ret, 20), buffer);
 197         else
 198                 drm_dbg(DRM_UT_DP, "%s: 0x%05x AUX %s (ret=%3d)\n",
 199                         aux->name, offset, arrow, ret);
 200 }
 201
 202 /**
 203  * DOC: dp helpers
 204  *
 205  * The DisplayPort AUX channel is an abstraction to allow generic, driver-
 206  * independent access to AUX functionality. Drivers can take advantage of
 207  * this by filling in the fields of the drm_dp_aux structure.
 208  *
 209  * Transactions are described using a hardware-independent drm_dp_aux_msg
 210  * structure, which is passed into a driver's .transfer() implementation.
 211  * Both native and I2C-over-AUX transactions are supported.
 212  */
 213
 214 static int drm_dp_dpcd_access(struct drm_dp_aux *aux, u8 request,
 215                               unsigned int offset, void *buffer, size_t size)
 216 {
 217         struct drm_dp_aux_msg msg;
 218         unsigned int retry, native_reply;
 219         int err = 0, ret = 0;
 220
 221         memset(&msg, 0, sizeof(msg));
 222         msg.address = offset;
 223         msg.request = request;
 224         msg.buffer = buffer;
 225         msg.size = size;
 226
 227         mutex_lock(&aux->hw_mutex);
 228
 229         /*
 230          * The specification doesn't give any recommendation on how often to
 231          * retry native transactions. We used to retry 7 times like for
 232          * aux i2c transactions but real world devices this wasn't
 233          * sufficient, bump to 32 which makes Dell 4k monitors happier.
 234          */
 235         for (retry = 0; retry < 32; retry++) {
 236                 if (ret != 0 && ret != -ETIMEDOUT) {
 237                         usleep_range(AUX_RETRY_INTERVAL,
 238                                      AUX_RETRY_INTERVAL + 100);
 239                 }
 240
 241                 ret = aux->transfer(aux, &msg);
 242
 243                 if (ret >= 0) {
 244                         native_reply = msg.reply & DP_AUX_NATIVE_REPLY_MASK;
 245                         if (native_reply == DP_AUX_NATIVE_REPLY_ACK) {
 246                                 if (ret == size)
 247                                         goto unlock;
 248
 249                                 ret = -EPROTO;
 250                         } else
 251                                 ret = -EIO;
 252                 }
 253
 254                 /*
 255                  * We want the error we return to be the error we received on
 256                  * the first transaction, since we may get a different error the
 257                  * next time we retry
 258                  */
 259                 if (!err)
 260                         err = ret;
 261         }
 262
 263         DRM_DEBUG_KMS("Too many retries, giving up. First error: %d\n", err);
 264         ret = err;
 265
 266 unlock:
 267         mutex_unlock(&aux->hw_mutex);
 268         return ret;
 269 }
 270
 271 /**
 272  * drm_dp_dpcd_read() - read a series of bytes from the DPCD
 273  * @aux: DisplayPort AUX channel
 274  * @offset: address of the (first) register to read
 275  * @buffer: buffer to store the register values
 276  * @size: number of bytes in @buffer
 277  *
 278  * Returns the number of bytes transferred on success, or a negative error
 279  * code on failure. -EIO is returned if the request was NAKed by the sink or
 280  * if the retry count was exceeded. If not all bytes were transferred, this
 281  * function returns -EPROTO. Errors from the underlying AUX channel transfer
 282  * function, with the exception of -EBUSY (which causes the transaction to
 283  * be retried), are propagated to the caller.
 284  */
 285 ssize_t drm_dp_dpcd_read(struct drm_dp_aux *aux, unsigned int offset,
 286                          void *buffer, size_t size)
 287 {
 288         int ret;
 289
 290         /*
 291          * HP ZR24w corrupts the first DPCD access after entering power save
 292          * mode. Eg. on a read, the entire buffer will be filled with the same
 293          * byte. Do a throw away read to avoid corrupting anything we care
 294          * about. Afterwards things will work correctly until the monitor
 295          * gets woken up and subsequently re-enters power save mode.
 296          *
 297          * The user pressing any button on the monitor is enough to wake it
 298          * up, so there is no particularly good place to do the workaround.
 299          * We just have to do it before any DPCD access and hope that the
 300          * monitor doesn't power down exactly after the throw away read.
 301          */
 302         ret = drm_dp_dpcd_access(aux, DP_AUX_NATIVE_READ, DP_DPCD_REV, buffer,
 303                                  1);
 304         if (ret != 1)
 305                 goto out;
 306
 307         ret = drm_dp_dpcd_access(aux, DP_AUX_NATIVE_READ, offset, buffer,
 308                                  size);
 309
 310 out:
 311         drm_dp_dump_access(aux, DP_AUX_NATIVE_READ, offset, buffer, ret);
 312         return ret;
 313 }
 314 EXPORT_SYMBOL(drm_dp_dpcd_read);
 315
 316 /**
 317  * drm_dp_dpcd_write() - write a series of bytes to the DPCD
 318  * @aux: DisplayPort AUX channel
 319  * @offset: address of the (first) register to write
 320  * @buffer: buffer containing the values to write
 321  * @size: number of bytes in @buffer
 322  *
 323  * Returns the number of bytes transferred on success, or a negative error
 324  * code on failure. -EIO is returned if the request was NAKed by the sink or
 325  * if the retry count was exceeded. If not all bytes were transferred, this
 326  * function returns -EPROTO. Errors from the underlying AUX channel transfer
 327  * function, with the exception of -EBUSY (which causes the transaction to
 328  * be retried), are propagated to the caller.
 329  */
 330 ssize_t drm_dp_dpcd_write(struct drm_dp_aux *aux, unsigned int offset,
 331                           void *buffer, size_t size)
 332 {
 333         int ret;
 334
 335         ret = drm_dp_dpcd_access(aux, DP_AUX_NATIVE_WRITE, offset, buffer,
 336                                  size);
 337         drm_dp_dump_access(aux, DP_AUX_NATIVE_WRITE, offset, buffer, ret);
 338         return ret;
 339 }
 340 EXPORT_SYMBOL(drm_dp_dpcd_write);
 341
 342 /**
 343  * drm_dp_dpcd_read_link_status() - read DPCD link status (bytes 0x202-0x207)
 344  * @aux: DisplayPort AUX channel
 345  * @status: buffer to store the link status in (must be at least 6 bytes)
 346  *
 347  * Returns the number of bytes transferred on success or a negative error
 348  * code on failure.
 349  */
 350 int drm_dp_dpcd_read_link_status(struct drm_dp_aux *aux,
 351                                  u8 status[DP_LINK_STATUS_SIZE])
 352 {
 353         return drm_dp_dpcd_read(aux, DP_LANE0_1_STATUS, status,
 354                                 DP_LINK_STATUS_SIZE);
 355 }
 356 EXPORT_SYMBOL(drm_dp_dpcd_read_link_status);
 357
 358 /**
 359  * drm_dp_link_probe() - probe a DisplayPort link for capabilities
 360  * @aux: DisplayPort AUX channel
 361  * @link: pointer to structure in which to return link capabilities
 362  *
 363  * The structure filled in by this function can usually be passed directly
 364  * into drm_dp_link_power_up() and drm_dp_link_configure() to power up and
 365  * configure the link based on the link's capabilities.
 366  *
 367  * Returns 0 on success or a negative error code on failure.
 368  */
 369 int drm_dp_link_probe(struct drm_dp_aux *aux, struct drm_dp_link *link)
 370 {
 371         u8 values[3];
 372         int err;
 373
 374         memset(link, 0, sizeof(*link));
 375
 376         err = drm_dp_dpcd_read(aux, DP_DPCD_REV, values, sizeof(values));
 377         if (err < 0)
 378                 return err;
 379
 380         link->revision = values[0];
 381         link->rate = drm_dp_bw_code_to_link_rate(values[1]);
 382         link->num_lanes = values[2] & DP_MAX_LANE_COUNT_MASK;
 383
 384         if (values[2] & DP_ENHANCED_FRAME_CAP)
 385                 link->capabilities |= DP_LINK_CAP_ENHANCED_FRAMING;
 386
 387         return 0;
 388 }
 389 EXPORT_SYMBOL(drm_dp_link_probe);
 390
 391 /**
 392  * drm_dp_link_power_up() - power up a DisplayPort link
 393  * @aux: DisplayPort AUX channel
 394  * @link: pointer to a structure containing the link configuration
 395  *
 396  * Returns 0 on success or a negative error code on failure.
 397  */
 398 int drm_dp_link_power_up(struct drm_dp_aux *aux, struct drm_dp_link *link)
 399 {
 400         u8 value;
 401         int err;
 402
 403         /* DP_SET_POWER register is only available on DPCD v1.1 and later */
 404         if (link->revision < 0x11)
 405                 return 0;
 406
 407         err = drm_dp_dpcd_readb(aux, DP_SET_POWER, &value);
 408         if (err < 0)
 409                 return err;
 410
 411         value &= ~DP_SET_POWER_MASK;
 412         value |= DP_SET_POWER_D0;
 413
 414         err = drm_dp_dpcd_writeb(aux, DP_SET_POWER, value);
 415         if (err < 0)
 416                 return err;
 417
 418         /*
 419          * According to the DP 1.1 specification, a "Sink Device must exit the
 420          * power saving state within 1 ms" (Section 2.5.3.1, Table 5-52, "Sink
 421          * Control Field" (register 0x600).
 422          */
 423         usleep_range(1000, 2000);
 424
 425         return 0;
 426 }
 427 EXPORT_SYMBOL(drm_dp_link_power_up);
 428
 429 /**
 430  * drm_dp_link_power_down() - power down a DisplayPort link
 431  * @aux: DisplayPort AUX channel
 432  * @link: pointer to a structure containing the link configuration
 433  *
 434  * Returns 0 on success or a negative error code on failure.
 435  */
 436 int drm_dp_link_power_down(struct drm_dp_aux *aux, struct drm_dp_link *link)
 437 {
 438         u8 value;
 439         int err;
 440
 441         /* DP_SET_POWER register is only available on DPCD v1.1 and later */
 442         if (link->revision < 0x11)
 443                 return 0;
 444
 445         err = drm_dp_dpcd_readb(aux, DP_SET_POWER, &value);
 446         if (err < 0)
 447                 return err;
 448
 449         value &= ~DP_SET_POWER_MASK;
 450         value |= DP_SET_POWER_D3;
 451
 452         err = drm_dp_dpcd_writeb(aux, DP_SET_POWER, value);
 453         if (err < 0)
 454                 return err;
 455
 456         return 0;
 457 }
 458 EXPORT_SYMBOL(drm_dp_link_power_down);
 459
 460 /**
 461  * drm_dp_link_configure() - configure a DisplayPort link
 462  * @aux: DisplayPort AUX channel
 463  * @link: pointer to a structure containing the link configuration
 464  *
 465  * Returns 0 on success or a negative error code on failure.
 466  */
 467 int drm_dp_link_configure(struct drm_dp_aux *aux, struct drm_dp_link *link)
 468 {
 469         u8 values[2];
 470         int err;
 471
 472         values[0] = drm_dp_link_rate_to_bw_code(link->rate);
 473         values[1] = link->num_lanes;
 474
 475         if (link->capabilities & DP_LINK_CAP_ENHANCED_FRAMING)
 476                 values[1] |= DP_LANE_COUNT_ENHANCED_FRAME_EN;
 477
 478         err = drm_dp_dpcd_write(aux, DP_LINK_BW_SET, values, sizeof(values));
 479         if (err < 0)
 480                 return err;
 481
 482         return 0;
 483 }
 484 EXPORT_SYMBOL(drm_dp_link_configure);
 485
 486 /**
 487  * drm_dp_downstream_max_clock() - extract branch device max
 488  *                                 pixel rate for legacy VGA
 489  *                                 converter or max TMDS clock
 490  *                                 rate for others
 491  * @dpcd: DisplayPort configuration data
 492  * @port_cap: port capabilities
 493  *
 494  * Returns max clock in kHz on success or 0 if max clock not defined
 495  */
 496 int drm_dp_downstream_max_clock(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
 497                                 const u8 port_cap[4])
 498 {
 499         int type = port_cap[0] & DP_DS_PORT_TYPE_MASK;
 500         bool detailed_cap_info = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
 501                 DP_DETAILED_CAP_INFO_AVAILABLE;
 502
 503         if (!detailed_cap_info)
 504                 return 0;
 505
 506         switch (type) {
 507         case DP_DS_PORT_TYPE_VGA:
 508                 return port_cap[1] * 8 * 1000;
 509         case DP_DS_PORT_TYPE_DVI:
 510         case DP_DS_PORT_TYPE_HDMI:
 511         case DP_DS_PORT_TYPE_DP_DUALMODE:
 512                 return port_cap[1] * 2500;
 513         default:
 514                 return 0;
 515         }
 516 }
 517 EXPORT_SYMBOL(drm_dp_downstream_max_clock);
 518
 519 /**
 520  * drm_dp_downstream_max_bpc() - extract branch device max
 521  *                               bits per component
 522  * @dpcd: DisplayPort configuration data
 523  * @port_cap: port capabilities
 524  *
 525  * Returns max bpc on success or 0 if max bpc not defined
 526  */
 527 int drm_dp_downstream_max_bpc(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
 528                               const u8 port_cap[4])
 529 {
 530         int type = port_cap[0] & DP_DS_PORT_TYPE_MASK;
 531         bool detailed_cap_info = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
 532                 DP_DETAILED_CAP_INFO_AVAILABLE;
 533         int bpc;
 534
 535         if (!detailed_cap_info)
 536                 return 0;
 537
 538         switch (type) {
 539         case DP_DS_PORT_TYPE_VGA:
 540         case DP_DS_PORT_TYPE_DVI:
 541         case DP_DS_PORT_TYPE_HDMI:
 542         case DP_DS_PORT_TYPE_DP_DUALMODE:
 543                 bpc = port_cap[2] & DP_DS_MAX_BPC_MASK;
 544
 545                 switch (bpc) {
 546                 case DP_DS_8BPC:
 547                         return 8;
 548                 case DP_DS_10BPC:
 549                         return 10;
 550                 case DP_DS_12BPC:
 551                         return 12;
 552                 case DP_DS_16BPC:
 553                         return 16;
 554                 }
 555         default:
 556                 return 0;
 557         }
 558 }
 559 EXPORT_SYMBOL(drm_dp_downstream_max_bpc);
 560
 561 /**
 562  * drm_dp_downstream_id() - identify branch device
 563  * @aux: DisplayPort AUX channel
 564  * @id: DisplayPort branch device id
 565  *
 566  * Returns branch device id on success or NULL on failure
 567  */
 568 int drm_dp_downstream_id(struct drm_dp_aux *aux, char id[6])
 569 {
 570         return drm_dp_dpcd_read(aux, DP_BRANCH_ID, id, 6);
 571 }
 572 EXPORT_SYMBOL(drm_dp_downstream_id);
 573
 574 /**
 575  * drm_dp_downstream_debug() - debug DP branch devices
 576  * @m: pointer for debugfs file
 577  * @dpcd: DisplayPort configuration data
 578  * @port_cap: port capabilities
 579  * @aux: DisplayPort AUX channel
 580  *
 581  */
 582 void drm_dp_downstream_debug(struct seq_file *m,
 583                              const u8 dpcd[DP_RECEIVER_CAP_SIZE],
 584                              const u8 port_cap[4], struct drm_dp_aux *aux)
 585 {
 586         bool detailed_cap_info = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
 587                                  DP_DETAILED_CAP_INFO_AVAILABLE;
 588         int clk;
 589         int bpc;
 590         char id[7];
 591         int len;
 592         uint8_t rev[2];
 593         int type = port_cap[0] & DP_DS_PORT_TYPE_MASK;
 594         bool branch_device = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
 595                              DP_DWN_STRM_PORT_PRESENT;
 596
 597         seq_printf(m, "\tDP branch device present: %s\n",
 598                    branch_device ? "yes" : "no");
 599
 600         if (!branch_device)
 601                 return;
 602
 603         switch (type) {
 604         case DP_DS_PORT_TYPE_DP:
 605                 seq_puts(m, "\t\tType: DisplayPort\n");
 606                 break;
 607         case DP_DS_PORT_TYPE_VGA:
 608                 seq_puts(m, "\t\tType: VGA\n");
 609                 break;
 610         case DP_DS_PORT_TYPE_DVI:
 611                 seq_puts(m, "\t\tType: DVI\n");
 612                 break;
 613         case DP_DS_PORT_TYPE_HDMI:
 614                 seq_puts(m, "\t\tType: HDMI\n");
 615                 break;
 616         case DP_DS_PORT_TYPE_NON_EDID:
 617                 seq_puts(m, "\t\tType: others without EDID support\n");
 618                 break;
 619         case DP_DS_PORT_TYPE_DP_DUALMODE:
 620                 seq_puts(m, "\t\tType: DP++\n");
 621                 break;
 622         case DP_DS_PORT_TYPE_WIRELESS:
 623                 seq_puts(m, "\t\tType: Wireless\n");
 624                 break;
 625         default:
 626                 seq_puts(m, "\t\tType: N/A\n");
 627         }
 628
 629         memset(id, 0, sizeof(id));
 630         drm_dp_downstream_id(aux, id);
 631         seq_printf(m, "\t\tID: %s\n", id);
 632
 633         len = drm_dp_dpcd_read(aux, DP_BRANCH_HW_REV, &rev[0], 1);
 634         if (len > 0)
 635                 seq_printf(m, "\t\tHW: %d.%d\n",
 636                            (rev[0] & 0xf0) >> 4, rev[0] & 0xf);
 637
 638         len = drm_dp_dpcd_read(aux, DP_BRANCH_SW_REV, rev, 2);
 639         if (len > 0)
 640                 seq_printf(m, "\t\tSW: %d.%d\n", rev[0], rev[1]);
 641
 642         if (detailed_cap_info) {
 643                 clk = drm_dp_downstream_max_clock(dpcd, port_cap);
 644
 645                 if (clk > 0) {
 646                         if (type == DP_DS_PORT_TYPE_VGA)
 647                                 seq_printf(m, "\t\tMax dot clock: %d kHz\n", clk);
 648                         else
 649                                 seq_printf(m, "\t\tMax TMDS clock: %d kHz\n", clk);
 650                 }
 651
 652                 bpc = drm_dp_downstream_max_bpc(dpcd, port_cap);
 653
 654                 if (bpc > 0)
 655                         seq_printf(m, "\t\tMax bpc: %d\n", bpc);
 656         }
 657 }
 658 EXPORT_SYMBOL(drm_dp_downstream_debug);
 659
 660 /*
 661  * I2C-over-AUX implementation
 662  */
 663
 664 static u32 drm_dp_i2c_functionality(struct i2c_adapter *adapter)
 665 {
 666         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
 667                I2C_FUNC_SMBUS_READ_BLOCK_DATA |
 668                I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
 669                I2C_FUNC_10BIT_ADDR;
 670 }
 671
 672 static void drm_dp_i2c_msg_write_status_update(struct drm_dp_aux_msg *msg)
 673 {
 674         /*
 675          * In case of i2c defer or short i2c ack reply to a write,
 676          * we need to switch to WRITE_STATUS_UPDATE to drain the
 677          * rest of the message
 678          */
 679         if ((msg->request & ~DP_AUX_I2C_MOT) == DP_AUX_I2C_WRITE) {
 680                 msg->request &= DP_AUX_I2C_MOT;
 681                 msg->request |= DP_AUX_I2C_WRITE_STATUS_UPDATE;
 682         }
 683 }
 684
 685 #define AUX_PRECHARGE_LEN 10 /* 10 to 16 */
 686 #define AUX_SYNC_LEN (16 + 4) /* preamble + AUX_SYNC_END */
 687 #define AUX_STOP_LEN 4
 688 #define AUX_CMD_LEN 4
 689 #define AUX_ADDRESS_LEN 20
 690 #define AUX_REPLY_PAD_LEN 4
 691 #define AUX_LENGTH_LEN 8
 692
 693 /*
 694  * Calculate the duration of the AUX request/reply in usec. Gives the
 695  * "best" case estimate, ie. successful while as short as possible.
 696  */
 697 static int drm_dp_aux_req_duration(const struct drm_dp_aux_msg *msg)
 698 {
 699         int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
 700                 AUX_CMD_LEN + AUX_ADDRESS_LEN + AUX_LENGTH_LEN;
 701
 702         if ((msg->request & DP_AUX_I2C_READ) == 0)
 703                 len += msg->size * 8;
 704
 705         return len;
 706 }
 707
 708 static int drm_dp_aux_reply_duration(const struct drm_dp_aux_msg *msg)
 709 {
 710         int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
 711                 AUX_CMD_LEN + AUX_REPLY_PAD_LEN;
 712
 713         /*
 714          * For read we expect what was asked. For writes there will
 715          * be 0 or 1 data bytes. Assume 0 for the "best" case.
 716          */
 717         if (msg->request & DP_AUX_I2C_READ)
 718                 len += msg->size * 8;
 719
 720         return len;
 721 }
 722
 723 #define I2C_START_LEN 1
 724 #define I2C_STOP_LEN 1
 725 #define I2C_ADDR_LEN 9 /* ADDRESS + R/W + ACK/NACK */
 726 #define I2C_DATA_LEN 9 /* DATA + ACK/NACK */
 727
 728 /*
 729  * Calculate the length of the i2c transfer in usec, assuming
 730  * the i2c bus speed is as specified. Gives the the "worst"
 731  * case estimate, ie. successful while as long as possible.
 732  * Doesn't account the the "MOT" bit, and instead assumes each
 733  * message includes a START, ADDRESS and STOP. Neither does it
 734  * account for additional random variables such as clock stretching.
 735  */
 736 static int drm_dp_i2c_msg_duration(const struct drm_dp_aux_msg *msg,
 737                                    int i2c_speed_khz)
 738 {
 739         /* AUX bitrate is 1MHz, i2c bitrate as specified */
 740         return DIV_ROUND_UP((I2C_START_LEN + I2C_ADDR_LEN +
 741                              msg->size * I2C_DATA_LEN +
 742                              I2C_STOP_LEN) * 1000, i2c_speed_khz);
 743 }
 744
 745 /*
 746  * Deterine how many retries should be attempted to successfully transfer
 747  * the specified message, based on the estimated durations of the
 748  * i2c and AUX transfers.
 749  */
 750 static int drm_dp_i2c_retry_count(const struct drm_dp_aux_msg *msg,
 751                               int i2c_speed_khz)
 752 {
 753         int aux_time_us = drm_dp_aux_req_duration(msg) +
 754                 drm_dp_aux_reply_duration(msg);
 755         int i2c_time_us = drm_dp_i2c_msg_duration(msg, i2c_speed_khz);
 756
 757         return DIV_ROUND_UP(i2c_time_us, aux_time_us + AUX_RETRY_INTERVAL);
 758 }
 759
 760 /*
 761  * FIXME currently assumes 10 kHz as some real world devices seem
 762  * to require it. We should query/set the speed via DPCD if supported.
 763  */
 764 static int dp_aux_i2c_speed_khz __read_mostly = 10;
 765 module_param_unsafe(dp_aux_i2c_speed_khz, int, 0644);
 766 MODULE_PARM_DESC(dp_aux_i2c_speed_khz,
 767                  "Assumed speed of the i2c bus in kHz, (1-400, default 10)");
 768
 769 /*
 770  * Transfer a single I2C-over-AUX message and handle various error conditions,
 771  * retrying the transaction as appropriate.  It is assumed that the
 772  * &drm_dp_aux.transfer function does not modify anything in the msg other than the
 773  * reply field.
 774  *
 775  * Returns bytes transferred on success, or a negative error code on failure.
 776  */
 777 static int drm_dp_i2c_do_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *msg)
 778 {
 779         unsigned int retry, defer_i2c;
 780         int ret;
 781         /*
 782          * DP1.2 sections 2.7.7.1.5.6.1 and 2.7.7.1.6.6.1: A DP Source device
 783          * is required to retry at least seven times upon receiving AUX_DEFER
 784          * before giving up the AUX transaction.
 785          *
 786          * We also try to account for the i2c bus speed.
 787          */
 788         int max_retries = max(7, drm_dp_i2c_retry_count(msg, dp_aux_i2c_speed_khz));
 789
 790         for (retry = 0, defer_i2c = 0; retry < (max_retries + defer_i2c); retry++) {
 791                 ret = aux->transfer(aux, msg);
 792                 if (ret < 0) {
 793                         if (ret == -EBUSY)
 794                                 continue;
 795
 796                         /*
 797                          * While timeouts can be errors, they're usually normal
 798                          * behavior (for instance, when a driver tries to
 799                          * communicate with a non-existant DisplayPort device).
 800                          * Avoid spamming the kernel log with timeout errors.
 801                          */
 802                         if (ret == -ETIMEDOUT)
 803                                 DRM_DEBUG_KMS_RATELIMITED("transaction timed out\n");
 804                         else
 805                                 DRM_DEBUG_KMS("transaction failed: %d\n", ret);
 806
 807                         return ret;
 808                 }
 809
 810
 811                 switch (msg->reply & DP_AUX_NATIVE_REPLY_MASK) {
 812                 case DP_AUX_NATIVE_REPLY_ACK:
 813                         /*
 814                          * For I2C-over-AUX transactions this isn't enough, we
 815                          * need to check for the I2C ACK reply.
 816                          */
 817                         break;
 818
 819                 case DP_AUX_NATIVE_REPLY_NACK:
 820                         DRM_DEBUG_KMS("native nack (result=%d, size=%zu)\n", ret, msg->size);
 821                         return -EREMOTEIO;
 822
 823                 case DP_AUX_NATIVE_REPLY_DEFER:
 824                         DRM_DEBUG_KMS("native defer\n");
 825                         /*
 826                          * We could check for I2C bit rate capabilities and if
 827                          * available adjust this interval. We could also be
 828                          * more careful with DP-to-legacy adapters where a
 829                          * long legacy cable may force very low I2C bit rates.
 830                          *
 831                          * For now just defer for long enough to hopefully be
 832                          * safe for all use-cases.
 833                          */
 834                         usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
 835                         continue;
 836
 837                 default:
 838                         DRM_ERROR("invalid native reply %#04x\n", msg->reply);
 839                         return -EREMOTEIO;
 840                 }
 841
 842                 switch (msg->reply & DP_AUX_I2C_REPLY_MASK) {
 843                 case DP_AUX_I2C_REPLY_ACK:
 844                         /*
 845                          * Both native ACK and I2C ACK replies received. We
 846                          * can assume the transfer was successful.
 847                          */
 848                         if (ret != msg->size)
 849                                 drm_dp_i2c_msg_write_status_update(msg);
 850                         return ret;
 851
 852                 case DP_AUX_I2C_REPLY_NACK:
 853                         DRM_DEBUG_KMS("I2C nack (result=%d, size=%zu)\n",
 854                                       ret, msg->size);
 855                         aux->i2c_nack_count++;
 856                         return -EREMOTEIO;
 857
 858                 case DP_AUX_I2C_REPLY_DEFER:
 859                         DRM_DEBUG_KMS("I2C defer\n");
 860                         /* DP Compliance Test 4.2.2.5 Requirement:
 861                          * Must have at least 7 retries for I2C defers on the
 862                          * transaction to pass this test
 863                          */
 864                         aux->i2c_defer_count++;
 865                         if (defer_i2c < 7)
 866                                 defer_i2c++;
 867                         usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
 868                         drm_dp_i2c_msg_write_status_update(msg);
 869
 870                         continue;
 871
 872                 default:
 873                         DRM_ERROR("invalid I2C reply %#04x\n", msg->reply);
 874                         return -EREMOTEIO;
 875                 }
 876         }
 877
 878         DRM_DEBUG_KMS("too many retries, giving up\n");
 879         return -EREMOTEIO;
 880 }
 881
 882 static void drm_dp_i2c_msg_set_request(struct drm_dp_aux_msg *msg,
 883                                        const struct i2c_msg *i2c_msg)
 884 {
 885         msg->request = (i2c_msg->flags & I2C_M_RD) ?
 886                 DP_AUX_I2C_READ : DP_AUX_I2C_WRITE;
 887         msg->request |= DP_AUX_I2C_MOT;
 888 }
 889
 890 /*
 891  * Keep retrying drm_dp_i2c_do_msg until all data has been transferred.
 892  *
 893  * Returns an error code on failure, or a recommended transfer size on success.
 894  */
 895 static int drm_dp_i2c_drain_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *orig_msg)
 896 {
 897         int err, ret = orig_msg->size;
 898         struct drm_dp_aux_msg msg = *orig_msg;
 899
 900         while (msg.size > 0) {
 901                 err = drm_dp_i2c_do_msg(aux, &msg);
 902                 if (err <= 0)
 903                         return err == 0 ? -EPROTO : err;
 904
 905                 if (err < msg.size && err < ret) {
 906                         DRM_DEBUG_KMS("Partial I2C reply: requested %zu bytes got %d bytes\n",
 907                                       msg.size, err);
 908                         ret = err;
 909                 }
 910
 911                 msg.size -= err;
 912                 msg.buffer += err;
 913         }
 914
 915         return ret;
 916 }
 917
 918 /*
 919  * Bizlink designed DP->DVI-D Dual Link adapters require the I2C over AUX
 920  * packets to be as large as possible. If not, the I2C transactions never
 921  * succeed. Hence the default is maximum.
 922  */
 923 static int dp_aux_i2c_transfer_size __read_mostly = DP_AUX_MAX_PAYLOAD_BYTES;
 924 module_param_unsafe(dp_aux_i2c_transfer_size, int, 0644);
 925 MODULE_PARM_DESC(dp_aux_i2c_transfer_size,
 926                  "Number of bytes to transfer in a single I2C over DP AUX CH message, (1-16, default 16)");
 927
 928 static int drm_dp_i2c_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs,
 929                            int num)
 930 {
 931         struct drm_dp_aux *aux = adapter->algo_data;
 932         unsigned int i, j;
 933         unsigned transfer_size;
 934         struct drm_dp_aux_msg msg;
 935         int err = 0;
 936
 937         dp_aux_i2c_transfer_size = clamp(dp_aux_i2c_transfer_size, 1, DP_AUX_MAX_PAYLOAD_BYTES);
 938
 939         memset(&msg, 0, sizeof(msg));
 940
 941         for (i = 0; i < num; i++) {
 942                 msg.address = msgs[i].addr;
 943                 drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
 944                 /* Send a bare address packet to start the transaction.
 945                  * Zero sized messages specify an address only (bare
 946                  * address) transaction.
 947                  */
 948                 msg.buffer = NULL;
 949                 msg.size = 0;
 950                 err = drm_dp_i2c_do_msg(aux, &msg);
 951
 952                 /*
 953                  * Reset msg.request in case in case it got
 954                  * changed into a WRITE_STATUS_UPDATE.
 955                  */
 956                 drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
 957
 958                 if (err < 0)
 959                         break;
 960                 /* We want each transaction to be as large as possible, but
 961                  * we'll go to smaller sizes if the hardware gives us a
 962                  * short reply.
 963                  */
 964                 transfer_size = dp_aux_i2c_transfer_size;
 965                 for (j = 0; j < msgs[i].len; j += msg.size) {
 966                         msg.buffer = msgs[i].buf + j;
 967                         msg.size = min(transfer_size, msgs[i].len - j);
 968
 969                         err = drm_dp_i2c_drain_msg(aux, &msg);
 970
 971                         /*
 972                          * Reset msg.request in case in case it got
 973                          * changed into a WRITE_STATUS_UPDATE.
 974                          */
 975                         drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
 976
 977                         if (err < 0)
 978                                 break;
 979                         transfer_size = err;
 980                 }
 981                 if (err < 0)
 982                         break;
 983         }
 984         if (err >= 0)
 985                 err = num;
 986         /* Send a bare address packet to close out the transaction.
 987          * Zero sized messages specify an address only (bare
 988          * address) transaction.
 989          */
 990         msg.request &= ~DP_AUX_I2C_MOT;
 991         msg.buffer = NULL;
 992         msg.size = 0;
 993         (void)drm_dp_i2c_do_msg(aux, &msg);
 994
 995         return err;
 996 }
 997
 998 static const struct i2c_algorithm drm_dp_i2c_algo = {
 999         .functionality = drm_dp_i2c_functionality,
1000         .master_xfer = drm_dp_i2c_xfer,
1001 };
1002
1003 static struct drm_dp_aux *i2c_to_aux(struct i2c_adapter *i2c)
1004 {
1005         return container_of(i2c, struct drm_dp_aux, ddc);
1006 }
1007
1008 static void lock_bus(struct i2c_adapter *i2c, unsigned int flags)
1009 {
1010         mutex_lock(&i2c_to_aux(i2c)->hw_mutex);
1011 }
1012
1013 static int trylock_bus(struct i2c_adapter *i2c, unsigned int flags)
1014 {
1015         return mutex_trylock(&i2c_to_aux(i2c)->hw_mutex);
1016 }
1017
1018 static void unlock_bus(struct i2c_adapter *i2c, unsigned int flags)
1019 {
1020         mutex_unlock(&i2c_to_aux(i2c)->hw_mutex);
1021 }
1022
1023 static const struct i2c_lock_operations drm_dp_i2c_lock_ops = {
1024         .lock_bus = lock_bus,
1025         .trylock_bus = trylock_bus,
1026         .unlock_bus = unlock_bus,
1027 };
1028
1029 static int drm_dp_aux_get_crc(struct drm_dp_aux *aux, u8 *crc)
1030 {
1031         u8 buf, count;
1032         int ret;
1033
1034         ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK, &buf);
1035         if (ret < 0)
1036                 return ret;
1037
1038         WARN_ON(!(buf & DP_TEST_SINK_START));
1039
1040         ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK_MISC, &buf);
1041         if (ret < 0)
1042                 return ret;
1043
1044         count = buf & DP_TEST_COUNT_MASK;
1045         if (count == aux->crc_count)
1046                 return -EAGAIN; /* No CRC yet */
1047
1048         aux->crc_count = count;
1049
1050         /*
1051          * At DP_TEST_CRC_R_CR, there's 6 bytes containing CRC data, 2 bytes
1052          * per component (RGB or CrYCb).
1053          */
1054         ret = drm_dp_dpcd_read(aux, DP_TEST_CRC_R_CR, crc, 6);
1055         if (ret < 0)
1056                 return ret;
1057
1058         return 0;
1059 }
1060
1061 static void drm_dp_aux_crc_work(struct work_struct *work)
1062 {
1063         struct drm_dp_aux *aux = container_of(work, struct drm_dp_aux,
1064                                               crc_work);
1065         struct drm_crtc *crtc;
1066         u8 crc_bytes[6];
1067         uint32_t crcs[3];
1068         int ret;
1069
1070         if (WARN_ON(!aux->crtc))
1071                 return;
1072
1073         crtc = aux->crtc;
1074         while (crtc->crc.opened) {
1075                 drm_crtc_wait_one_vblank(crtc);
1076                 if (!crtc->crc.opened)
1077                         break;
1078
1079                 ret = drm_dp_aux_get_crc(aux, crc_bytes);
1080                 if (ret == -EAGAIN) {
1081                         usleep_range(1000, 2000);
1082                         ret = drm_dp_aux_get_crc(aux, crc_bytes);
1083                 }
1084
1085                 if (ret == -EAGAIN) {
1086                         DRM_DEBUG_KMS("Get CRC failed after retrying: %d\n",
1087                                       ret);
1088                         continue;
1089                 } else if (ret) {
1090                         DRM_DEBUG_KMS("Failed to get a CRC: %d\n", ret);
1091                         continue;
1092                 }
1093
1094                 crcs[0] = crc_bytes[0] | crc_bytes[1] << 8;
1095                 crcs[1] = crc_bytes[2] | crc_bytes[3] << 8;
1096                 crcs[2] = crc_bytes[4] | crc_bytes[5] << 8;
1097                 drm_crtc_add_crc_entry(crtc, false, 0, crcs);
1098         }
1099 }
1100
1101 /**
1102  * drm_dp_aux_init() - minimally initialise an aux channel
1103  * @aux: DisplayPort AUX channel
1104  *
1105  * If you need to use the drm_dp_aux's i2c adapter prior to registering it
1106  * with the outside world, call drm_dp_aux_init() first. You must still
1107  * call drm_dp_aux_register() once the connector has been registered to
1108  * allow userspace access to the auxiliary DP channel.
1109  */
1110 void drm_dp_aux_init(struct drm_dp_aux *aux)
1111 {
1112         mutex_init(&aux->hw_mutex);
1113         mutex_init(&aux->cec.lock);
1114         INIT_WORK(&aux->crc_work, drm_dp_aux_crc_work);
1115
1116         aux->ddc.algo = &drm_dp_i2c_algo;
1117         aux->ddc.algo_data = aux;
1118         aux->ddc.retries = 3;
1119
1120         aux->ddc.lock_ops = &drm_dp_i2c_lock_ops;
1121 }
1122 EXPORT_SYMBOL(drm_dp_aux_init);
1123
1124 /**
1125  * drm_dp_aux_register() - initialise and register aux channel
1126  * @aux: DisplayPort AUX channel
1127  *
1128  * Automatically calls drm_dp_aux_init() if this hasn't been done yet.
1129  *
1130  * Returns 0 on success or a negative error code on failure.
1131  */
1132 int drm_dp_aux_register(struct drm_dp_aux *aux)
1133 {
1134         int ret;
1135
1136         if (!aux->ddc.algo)
1137                 drm_dp_aux_init(aux);
1138
1139         aux->ddc.class = I2C_CLASS_DDC;
1140         aux->ddc.owner = THIS_MODULE;
1141         aux->ddc.dev.parent = aux->dev;
1142
1143         strlcpy(aux->ddc.name, aux->name ? aux->name : dev_name(aux->dev),
1144                 sizeof(aux->ddc.name));
1145
1146         ret = drm_dp_aux_register_devnode(aux);
1147         if (ret)
1148                 return ret;
1149
1150         ret = i2c_add_adapter(&aux->ddc);
1151         if (ret) {
1152                 drm_dp_aux_unregister_devnode(aux);
1153                 return ret;
1154         }
1155
1156         return 0;
1157 }
1158 EXPORT_SYMBOL(drm_dp_aux_register);
1159
1160 /**
1161  * drm_dp_aux_unregister() - unregister an AUX adapter
1162  * @aux: DisplayPort AUX channel
1163  */
1164 void drm_dp_aux_unregister(struct drm_dp_aux *aux)
1165 {
1166         drm_dp_aux_unregister_devnode(aux);
1167         i2c_del_adapter(&aux->ddc);
1168 }
1169 EXPORT_SYMBOL(drm_dp_aux_unregister);
1170
1171 #define PSR_SETUP_TIME(x) [DP_PSR_SETUP_TIME_ ## x >> DP_PSR_SETUP_TIME_SHIFT] = (x)
1172
1173 /**
1174  * drm_dp_psr_setup_time() - PSR setup in time usec
1175  * @psr_cap: PSR capabilities from DPCD
1176  *
1177  * Returns:
1178  * PSR setup time for the panel in microseconds,  negative
1179  * error code on failure.
1180  */
1181 int drm_dp_psr_setup_time(const u8 psr_cap[EDP_PSR_RECEIVER_CAP_SIZE])
1182 {
1183         static const u16 psr_setup_time_us[] = {
1184                 PSR_SETUP_TIME(330),
1185                 PSR_SETUP_TIME(275),
1186                 PSR_SETUP_TIME(220),
1187                 PSR_SETUP_TIME(165),
1188                 PSR_SETUP_TIME(110),
1189                 PSR_SETUP_TIME(55),
1190                 PSR_SETUP_TIME(0),
1191         };
1192         int i;
1193
1194         i = (psr_cap[1] & DP_PSR_SETUP_TIME_MASK) >> DP_PSR_SETUP_TIME_SHIFT;
1195         if (i >= ARRAY_SIZE(psr_setup_time_us))
1196                 return -EINVAL;
1197
1198         return psr_setup_time_us[i];
1199 }
1200 EXPORT_SYMBOL(drm_dp_psr_setup_time);
1201
1202 #undef PSR_SETUP_TIME
1203
1204 /**
1205  * drm_dp_start_crc() - start capture of frame CRCs
1206  * @aux: DisplayPort AUX channel
1207  * @crtc: CRTC displaying the frames whose CRCs are to be captured
1208  *
1209  * Returns 0 on success or a negative error code on failure.
1210  */
1211 int drm_dp_start_crc(struct drm_dp_aux *aux, struct drm_crtc *crtc)
1212 {
1213         u8 buf;
1214         int ret;
1215
1216         ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK, &buf);
1217         if (ret < 0)
1218                 return ret;
1219
1220         ret = drm_dp_dpcd_writeb(aux, DP_TEST_SINK, buf | DP_TEST_SINK_START);
1221         if (ret < 0)
1222                 return ret;
1223
1224         aux->crc_count = 0;
1225         aux->crtc = crtc;
1226         schedule_work(&aux->crc_work);
1227
1228         return 0;
1229 }
1230 EXPORT_SYMBOL(drm_dp_start_crc);
1231
1232 /**
1233  * drm_dp_stop_crc() - stop capture of frame CRCs
1234  * @aux: DisplayPort AUX channel
1235  *
1236  * Returns 0 on success or a negative error code on failure.
1237  */
1238 int drm_dp_stop_crc(struct drm_dp_aux *aux)
1239 {
1240         u8 buf;
1241         int ret;
1242
1243         ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK, &buf);
1244         if (ret < 0)
1245                 return ret;
1246
1247         ret = drm_dp_dpcd_writeb(aux, DP_TEST_SINK, buf & ~DP_TEST_SINK_START);
1248         if (ret < 0)
1249                 return ret;
1250
1251         flush_work(&aux->crc_work);
1252         aux->crtc = NULL;
1253
1254         return 0;
1255 }
1256 EXPORT_SYMBOL(drm_dp_stop_crc);
1257
1258 struct dpcd_quirk {
1259         u8 oui[3];
1260         u8 device_id[6];
1261         bool is_branch;
1262         u32 quirks;
1263 };
1264
1265 #define OUI(first, second, third) { (first), (second), (third) }
1266 #define DEVICE_ID(first, second, third, fourth, fifth, sixth) \
1267         { (first), (second), (third), (fourth), (fifth), (sixth) }
1268
1269 #define DEVICE_ID_ANY   DEVICE_ID(0, 0, 0, 0, 0, 0)
1270
1271 static const struct dpcd_quirk dpcd_quirk_list[] = {
1272         /* Analogix 7737 needs reduced M and N at HBR2 link rates */
1273         { OUI(0x00, 0x22, 0xb9), DEVICE_ID_ANY, true, BIT(DP_DPCD_QUIRK_CONSTANT_N) },
1274         /* LG LP140WF6-SPM1 eDP panel */
1275         { OUI(0x00, 0x22, 0xb9), DEVICE_ID('s', 'i', 'v', 'a', 'r', 'T'), false, BIT(DP_DPCD_QUIRK_CONSTANT_N) },
1276 };
1277
1278 #undef OUI
1279
1280 /*
1281  * Get a bit mask of DPCD quirks for the sink/branch device identified by
1282  * ident. The quirk data is shared but it's up to the drivers to act on the
1283  * data.
1284  *
1285  * For now, only the OUI (first three bytes) is used, but this may be extended
1286  * to device identification string and hardware/firmware revisions later.
1287  */
1288 static u32
1289 drm_dp_get_quirks(const struct drm_dp_dpcd_ident *ident, bool is_branch)
1290 {
1291         const struct dpcd_quirk *quirk;
1292         u32 quirks = 0;
1293         int i;
1294         u8 any_device[] = DEVICE_ID_ANY;
1295
1296         for (i = 0; i < ARRAY_SIZE(dpcd_quirk_list); i++) {
1297                 quirk = &dpcd_quirk_list[i];
1298
1299                 if (quirk->is_branch != is_branch)
1300                         continue;
1301
1302                 if (memcmp(quirk->oui, ident->oui, sizeof(ident->oui)) != 0)
1303                         continue;
1304
1305                 if (memcmp(quirk->device_id, any_device, sizeof(any_device)) != 0 &&
1306                     memcmp(quirk->device_id, ident->device_id, sizeof(ident->device_id)) != 0)
1307                         continue;
1308
1309                 quirks |= quirk->quirks;
1310         }
1311
1312         return quirks;
1313 }
1314
1315 #undef DEVICE_ID_ANY
1316 #undef DEVICE_ID
1317
1318 /**
1319  * drm_dp_read_desc - read sink/branch descriptor from DPCD
1320  * @aux: DisplayPort AUX channel
1321  * @desc: Device decriptor to fill from DPCD
1322  * @is_branch: true for branch devices, false for sink devices
1323  *
1324  * Read DPCD 0x400 (sink) or 0x500 (branch) into @desc. Also debug log the
1325  * identification.
1326  *
1327  * Returns 0 on success or a negative error code on failure.
1328  */
1329 int drm_dp_read_desc(struct drm_dp_aux *aux, struct drm_dp_desc *desc,
1330                      bool is_branch)
1331 {
1332         struct drm_dp_dpcd_ident *ident = &desc->ident;
1333         unsigned int offset = is_branch ? DP_BRANCH_OUI : DP_SINK_OUI;
1334         int ret, dev_id_len;
1335
1336         ret = drm_dp_dpcd_read(aux, offset, ident, sizeof(*ident));
1337         if (ret < 0)
1338                 return ret;
1339
1340         desc->quirks = drm_dp_get_quirks(ident, is_branch);
1341
1342         dev_id_len = strnlen(ident->device_id, sizeof(ident->device_id));
1343
1344         DRM_DEBUG_KMS("DP %s: OUI %*phD dev-ID %*pE HW-rev %d.%d SW-rev %d.%d quirks 0x%04x\n",
1345                       is_branch ? "branch" : "sink",
1346                       (int)sizeof(ident->oui), ident->oui,
1347                       dev_id_len, ident->device_id,
1348                       ident->hw_rev >> 4, ident->hw_rev & 0xf,
1349                       ident->sw_major_rev, ident->sw_minor_rev,
1350                       desc->quirks);
1351
1352         return 0;
1353 }
1354 EXPORT_SYMBOL(drm_dp_read_desc);