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