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 <drm/drm_dp_helper.h>
  31 #include <drm/drm_dp_aux_dev.h>
  32 #include <drm/drmP.h>
  33
  34 /**
  35  * DOC: dp helpers
  36  *
  37  * These functions contain some common logic and helpers at various abstraction
  38  * levels to deal with Display Port sink devices and related things like DP aux
  39  * channel transfers, EDID reading over DP aux channels, decoding certain DPCD
  40  * blocks, ...
  41  */
  42
  43 /* Helpers for DP link training */
  44 static u8 dp_link_status(const u8 link_status[DP_LINK_STATUS_SIZE], int r)
  45 {
  46         return link_status[r - DP_LANE0_1_STATUS];
  47 }
  48
  49 static u8 dp_get_lane_status(const u8 link_status[DP_LINK_STATUS_SIZE],
  50                              int lane)
  51 {
  52         int i = DP_LANE0_1_STATUS + (lane >> 1);
  53         int s = (lane & 1) * 4;
  54         u8 l = dp_link_status(link_status, i);
  55         return (l >> s) & 0xf;
  56 }
  57
  58 bool drm_dp_channel_eq_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
  59                           int lane_count)
  60 {
  61         u8 lane_align;
  62         u8 lane_status;
  63         int lane;
  64
  65         lane_align = dp_link_status(link_status,
  66                                     DP_LANE_ALIGN_STATUS_UPDATED);
  67         if ((lane_align & DP_INTERLANE_ALIGN_DONE) == 0)
  68                 return false;
  69         for (lane = 0; lane < lane_count; lane++) {
  70                 lane_status = dp_get_lane_status(link_status, lane);
  71                 if ((lane_status & DP_CHANNEL_EQ_BITS) != DP_CHANNEL_EQ_BITS)
  72                         return false;
  73         }
  74         return true;
  75 }
  76 EXPORT_SYMBOL(drm_dp_channel_eq_ok);
  77
  78 bool drm_dp_clock_recovery_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
  79                               int lane_count)
  80 {
  81         int lane;
  82         u8 lane_status;
  83
  84         for (lane = 0; lane < lane_count; lane++) {
  85                 lane_status = dp_get_lane_status(link_status, lane);
  86                 if ((lane_status & DP_LANE_CR_DONE) == 0)
  87                         return false;
  88         }
  89         return true;
  90 }
  91 EXPORT_SYMBOL(drm_dp_clock_recovery_ok);
  92
  93 u8 drm_dp_get_adjust_request_voltage(const u8 link_status[DP_LINK_STATUS_SIZE],
  94                                      int lane)
  95 {
  96         int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
  97         int s = ((lane & 1) ?
  98                  DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT :
  99                  DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT);
 100         u8 l = dp_link_status(link_status, i);
 101
 102         return ((l >> s) & 0x3) << DP_TRAIN_VOLTAGE_SWING_SHIFT;
 103 }
 104 EXPORT_SYMBOL(drm_dp_get_adjust_request_voltage);
 105
 106 u8 drm_dp_get_adjust_request_pre_emphasis(const u8 link_status[DP_LINK_STATUS_SIZE],
 107                                           int lane)
 108 {
 109         int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
 110         int s = ((lane & 1) ?
 111                  DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT :
 112                  DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT);
 113         u8 l = dp_link_status(link_status, i);
 114
 115         return ((l >> s) & 0x3) << DP_TRAIN_PRE_EMPHASIS_SHIFT;
 116 }
 117 EXPORT_SYMBOL(drm_dp_get_adjust_request_pre_emphasis);
 118
 119 void drm_dp_link_train_clock_recovery_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) {
 120         if (dpcd[DP_TRAINING_AUX_RD_INTERVAL] == 0)
 121                 udelay(100);
 122         else
 123                 mdelay(dpcd[DP_TRAINING_AUX_RD_INTERVAL] * 4);
 124 }
 125 EXPORT_SYMBOL(drm_dp_link_train_clock_recovery_delay);
 126
 127 void drm_dp_link_train_channel_eq_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]) {
 128         if (dpcd[DP_TRAINING_AUX_RD_INTERVAL] == 0)
 129                 udelay(400);
 130         else
 131                 mdelay(dpcd[DP_TRAINING_AUX_RD_INTERVAL] * 4);
 132 }
 133 EXPORT_SYMBOL(drm_dp_link_train_channel_eq_delay);
 134
 135 u8 drm_dp_link_rate_to_bw_code(int link_rate)
 136 {
 137         switch (link_rate) {
 138         case 162000:
 139         default:
 140                 return DP_LINK_BW_1_62;
 141         case 270000:
 142                 return DP_LINK_BW_2_7;
 143         case 540000:
 144                 return DP_LINK_BW_5_4;
 145         }
 146 }
 147 EXPORT_SYMBOL(drm_dp_link_rate_to_bw_code);
 148
 149 int drm_dp_bw_code_to_link_rate(u8 link_bw)
 150 {
 151         switch (link_bw) {
 152         case DP_LINK_BW_1_62:
 153         default:
 154                 return 162000;
 155         case DP_LINK_BW_2_7:
 156                 return 270000;
 157         case DP_LINK_BW_5_4:
 158                 return 540000;
 159         }
 160 }
 161 EXPORT_SYMBOL(drm_dp_bw_code_to_link_rate);
 162
 163 #define AUX_RETRY_INTERVAL 500 /* us */
 164
 165 /**
 166  * DOC: dp helpers
 167  *
 168  * The DisplayPort AUX channel is an abstraction to allow generic, driver-
 169  * independent access to AUX functionality. Drivers can take advantage of
 170  * this by filling in the fields of the drm_dp_aux structure.
 171  *
 172  * Transactions are described using a hardware-independent drm_dp_aux_msg
 173  * structure, which is passed into a driver's .transfer() implementation.
 174  * Both native and I2C-over-AUX transactions are supported.
 175  */
 176
 177 static int drm_dp_dpcd_access(struct drm_dp_aux *aux, u8 request,
 178                               unsigned int offset, void *buffer, size_t size)
 179 {
 180         struct drm_dp_aux_msg msg;
 181         unsigned int retry, native_reply;
 182         int err = 0, ret = 0;
 183
 184         memset(&msg, 0, sizeof(msg));
 185         msg.address = offset;
 186         msg.request = request;
 187         msg.buffer = buffer;
 188         msg.size = size;
 189
 190         mutex_lock(&aux->hw_mutex);
 191
 192         /*
 193          * The specification doesn't give any recommendation on how often to
 194          * retry native transactions. We used to retry 7 times like for
 195          * aux i2c transactions but real world devices this wasn't
 196          * sufficient, bump to 32 which makes Dell 4k monitors happier.
 197          */
 198         for (retry = 0; retry < 32; retry++) {
 199                 if (ret != 0 && ret != -ETIMEDOUT) {
 200                         usleep_range(AUX_RETRY_INTERVAL,
 201                                      AUX_RETRY_INTERVAL + 100);
 202                 }
 203
 204                 ret = aux->transfer(aux, &msg);
 205
 206                 if (ret > 0) {
 207                         native_reply = msg.reply & DP_AUX_NATIVE_REPLY_MASK;
 208                         if (native_reply == DP_AUX_NATIVE_REPLY_ACK) {
 209                                 if (ret == size)
 210                                         goto unlock;
 211
 212                                 ret = -EPROTO;
 213                         } else
 214                                 ret = -EIO;
 215                 }
 216
 217                 /*
 218                  * We want the error we return to be the error we received on
 219                  * the first transaction, since we may get a different error the
 220                  * next time we retry
 221                  */
 222                 if (!err)
 223                         err = ret;
 224         }
 225
 226         DRM_DEBUG_KMS("too many retries, giving up\n");
 227         ret = err;
 228
 229 unlock:
 230         mutex_unlock(&aux->hw_mutex);
 231         return ret;
 232 }
 233
 234 /**
 235  * drm_dp_dpcd_read() - read a series of bytes from the DPCD
 236  * @aux: DisplayPort AUX channel
 237  * @offset: address of the (first) register to read
 238  * @buffer: buffer to store the register values
 239  * @size: number of bytes in @buffer
 240  *
 241  * Returns the number of bytes transferred on success, or a negative error
 242  * code on failure. -EIO is returned if the request was NAKed by the sink or
 243  * if the retry count was exceeded. If not all bytes were transferred, this
 244  * function returns -EPROTO. Errors from the underlying AUX channel transfer
 245  * function, with the exception of -EBUSY (which causes the transaction to
 246  * be retried), are propagated to the caller.
 247  */
 248 ssize_t drm_dp_dpcd_read(struct drm_dp_aux *aux, unsigned int offset,
 249                          void *buffer, size_t size)
 250 {
 251         return drm_dp_dpcd_access(aux, DP_AUX_NATIVE_READ, offset, buffer,
 252                                   size);
 253 }
 254 EXPORT_SYMBOL(drm_dp_dpcd_read);
 255
 256 /**
 257  * drm_dp_dpcd_write() - write a series of bytes to the DPCD
 258  * @aux: DisplayPort AUX channel
 259  * @offset: address of the (first) register to write
 260  * @buffer: buffer containing the values to write
 261  * @size: number of bytes in @buffer
 262  *
 263  * Returns the number of bytes transferred on success, or a negative error
 264  * code on failure. -EIO is returned if the request was NAKed by the sink or
 265  * if the retry count was exceeded. If not all bytes were transferred, this
 266  * function returns -EPROTO. Errors from the underlying AUX channel transfer
 267  * function, with the exception of -EBUSY (which causes the transaction to
 268  * be retried), are propagated to the caller.
 269  */
 270 ssize_t drm_dp_dpcd_write(struct drm_dp_aux *aux, unsigned int offset,
 271                           void *buffer, size_t size)
 272 {
 273         return drm_dp_dpcd_access(aux, DP_AUX_NATIVE_WRITE, offset, buffer,
 274                                   size);
 275 }
 276 EXPORT_SYMBOL(drm_dp_dpcd_write);
 277
 278 /**
 279  * drm_dp_dpcd_read_link_status() - read DPCD link status (bytes 0x202-0x207)
 280  * @aux: DisplayPort AUX channel
 281  * @status: buffer to store the link status in (must be at least 6 bytes)
 282  *
 283  * Returns the number of bytes transferred on success or a negative error
 284  * code on failure.
 285  */
 286 int drm_dp_dpcd_read_link_status(struct drm_dp_aux *aux,
 287                                  u8 status[DP_LINK_STATUS_SIZE])
 288 {
 289         return drm_dp_dpcd_read(aux, DP_LANE0_1_STATUS, status,
 290                                 DP_LINK_STATUS_SIZE);
 291 }
 292 EXPORT_SYMBOL(drm_dp_dpcd_read_link_status);
 293
 294 /**
 295  * drm_dp_link_probe() - probe a DisplayPort link for capabilities
 296  * @aux: DisplayPort AUX channel
 297  * @link: pointer to structure in which to return link capabilities
 298  *
 299  * The structure filled in by this function can usually be passed directly
 300  * into drm_dp_link_power_up() and drm_dp_link_configure() to power up and
 301  * configure the link based on the link's capabilities.
 302  *
 303  * Returns 0 on success or a negative error code on failure.
 304  */
 305 int drm_dp_link_probe(struct drm_dp_aux *aux, struct drm_dp_link *link)
 306 {
 307         u8 values[3];
 308         int err;
 309
 310         memset(link, 0, sizeof(*link));
 311
 312         err = drm_dp_dpcd_read(aux, DP_DPCD_REV, values, sizeof(values));
 313         if (err < 0)
 314                 return err;
 315
 316         link->revision = values[0];
 317         link->rate = drm_dp_bw_code_to_link_rate(values[1]);
 318         link->num_lanes = values[2] & DP_MAX_LANE_COUNT_MASK;
 319
 320         if (values[2] & DP_ENHANCED_FRAME_CAP)
 321                 link->capabilities |= DP_LINK_CAP_ENHANCED_FRAMING;
 322
 323         return 0;
 324 }
 325 EXPORT_SYMBOL(drm_dp_link_probe);
 326
 327 /**
 328  * drm_dp_link_power_up() - power up a DisplayPort link
 329  * @aux: DisplayPort AUX channel
 330  * @link: pointer to a structure containing the link configuration
 331  *
 332  * Returns 0 on success or a negative error code on failure.
 333  */
 334 int drm_dp_link_power_up(struct drm_dp_aux *aux, struct drm_dp_link *link)
 335 {
 336         u8 value;
 337         int err;
 338
 339         /* DP_SET_POWER register is only available on DPCD v1.1 and later */
 340         if (link->revision < 0x11)
 341                 return 0;
 342
 343         err = drm_dp_dpcd_readb(aux, DP_SET_POWER, &value);
 344         if (err < 0)
 345                 return err;
 346
 347         value &= ~DP_SET_POWER_MASK;
 348         value |= DP_SET_POWER_D0;
 349
 350         err = drm_dp_dpcd_writeb(aux, DP_SET_POWER, value);
 351         if (err < 0)
 352                 return err;
 353
 354         /*
 355          * According to the DP 1.1 specification, a "Sink Device must exit the
 356          * power saving state within 1 ms" (Section 2.5.3.1, Table 5-52, "Sink
 357          * Control Field" (register 0x600).
 358          */
 359         usleep_range(1000, 2000);
 360
 361         return 0;
 362 }
 363 EXPORT_SYMBOL(drm_dp_link_power_up);
 364
 365 /**
 366  * drm_dp_link_power_down() - power down a DisplayPort link
 367  * @aux: DisplayPort AUX channel
 368  * @link: pointer to a structure containing the link configuration
 369  *
 370  * Returns 0 on success or a negative error code on failure.
 371  */
 372 int drm_dp_link_power_down(struct drm_dp_aux *aux, struct drm_dp_link *link)
 373 {
 374         u8 value;
 375         int err;
 376
 377         /* DP_SET_POWER register is only available on DPCD v1.1 and later */
 378         if (link->revision < 0x11)
 379                 return 0;
 380
 381         err = drm_dp_dpcd_readb(aux, DP_SET_POWER, &value);
 382         if (err < 0)
 383                 return err;
 384
 385         value &= ~DP_SET_POWER_MASK;
 386         value |= DP_SET_POWER_D3;
 387
 388         err = drm_dp_dpcd_writeb(aux, DP_SET_POWER, value);
 389         if (err < 0)
 390                 return err;
 391
 392         return 0;
 393 }
 394 EXPORT_SYMBOL(drm_dp_link_power_down);
 395
 396 /**
 397  * drm_dp_link_configure() - configure a DisplayPort link
 398  * @aux: DisplayPort AUX channel
 399  * @link: pointer to a structure containing the link configuration
 400  *
 401  * Returns 0 on success or a negative error code on failure.
 402  */
 403 int drm_dp_link_configure(struct drm_dp_aux *aux, struct drm_dp_link *link)
 404 {
 405         u8 values[2];
 406         int err;
 407
 408         values[0] = drm_dp_link_rate_to_bw_code(link->rate);
 409         values[1] = link->num_lanes;
 410
 411         if (link->capabilities & DP_LINK_CAP_ENHANCED_FRAMING)
 412                 values[1] |= DP_LANE_COUNT_ENHANCED_FRAME_EN;
 413
 414         err = drm_dp_dpcd_write(aux, DP_LINK_BW_SET, values, sizeof(values));
 415         if (err < 0)
 416                 return err;
 417
 418         return 0;
 419 }
 420 EXPORT_SYMBOL(drm_dp_link_configure);
 421
 422 /*
 423  * I2C-over-AUX implementation
 424  */
 425
 426 static u32 drm_dp_i2c_functionality(struct i2c_adapter *adapter)
 427 {
 428         return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
 429                I2C_FUNC_SMBUS_READ_BLOCK_DATA |
 430                I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
 431                I2C_FUNC_10BIT_ADDR;
 432 }
 433
 434 static void drm_dp_i2c_msg_write_status_update(struct drm_dp_aux_msg *msg)
 435 {
 436         /*
 437          * In case of i2c defer or short i2c ack reply to a write,
 438          * we need to switch to WRITE_STATUS_UPDATE to drain the
 439          * rest of the message
 440          */
 441         if ((msg->request & ~DP_AUX_I2C_MOT) == DP_AUX_I2C_WRITE) {
 442                 msg->request &= DP_AUX_I2C_MOT;
 443                 msg->request |= DP_AUX_I2C_WRITE_STATUS_UPDATE;
 444         }
 445 }
 446
 447 #define AUX_PRECHARGE_LEN 10 /* 10 to 16 */
 448 #define AUX_SYNC_LEN (16 + 4) /* preamble + AUX_SYNC_END */
 449 #define AUX_STOP_LEN 4
 450 #define AUX_CMD_LEN 4
 451 #define AUX_ADDRESS_LEN 20
 452 #define AUX_REPLY_PAD_LEN 4
 453 #define AUX_LENGTH_LEN 8
 454
 455 /*
 456  * Calculate the duration of the AUX request/reply in usec. Gives the
 457  * "best" case estimate, ie. successful while as short as possible.
 458  */
 459 static int drm_dp_aux_req_duration(const struct drm_dp_aux_msg *msg)
 460 {
 461         int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
 462                 AUX_CMD_LEN + AUX_ADDRESS_LEN + AUX_LENGTH_LEN;
 463
 464         if ((msg->request & DP_AUX_I2C_READ) == 0)
 465                 len += msg->size * 8;
 466
 467         return len;
 468 }
 469
 470 static int drm_dp_aux_reply_duration(const struct drm_dp_aux_msg *msg)
 471 {
 472         int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
 473                 AUX_CMD_LEN + AUX_REPLY_PAD_LEN;
 474
 475         /*
 476          * For read we expect what was asked. For writes there will
 477          * be 0 or 1 data bytes. Assume 0 for the "best" case.
 478          */
 479         if (msg->request & DP_AUX_I2C_READ)
 480                 len += msg->size * 8;
 481
 482         return len;
 483 }
 484
 485 #define I2C_START_LEN 1
 486 #define I2C_STOP_LEN 1
 487 #define I2C_ADDR_LEN 9 /* ADDRESS + R/W + ACK/NACK */
 488 #define I2C_DATA_LEN 9 /* DATA + ACK/NACK */
 489
 490 /*
 491  * Calculate the length of the i2c transfer in usec, assuming
 492  * the i2c bus speed is as specified. Gives the the "worst"
 493  * case estimate, ie. successful while as long as possible.
 494  * Doesn't account the the "MOT" bit, and instead assumes each
 495  * message includes a START, ADDRESS and STOP. Neither does it
 496  * account for additional random variables such as clock stretching.
 497  */
 498 static int drm_dp_i2c_msg_duration(const struct drm_dp_aux_msg *msg,
 499                                    int i2c_speed_khz)
 500 {
 501         /* AUX bitrate is 1MHz, i2c bitrate as specified */
 502         return DIV_ROUND_UP((I2C_START_LEN + I2C_ADDR_LEN +
 503                              msg->size * I2C_DATA_LEN +
 504                              I2C_STOP_LEN) * 1000, i2c_speed_khz);
 505 }
 506
 507 /*
 508  * Deterine how many retries should be attempted to successfully transfer
 509  * the specified message, based on the estimated durations of the
 510  * i2c and AUX transfers.
 511  */
 512 static int drm_dp_i2c_retry_count(const struct drm_dp_aux_msg *msg,
 513                               int i2c_speed_khz)
 514 {
 515         int aux_time_us = drm_dp_aux_req_duration(msg) +
 516                 drm_dp_aux_reply_duration(msg);
 517         int i2c_time_us = drm_dp_i2c_msg_duration(msg, i2c_speed_khz);
 518
 519         return DIV_ROUND_UP(i2c_time_us, aux_time_us + AUX_RETRY_INTERVAL);
 520 }
 521
 522 /*
 523  * FIXME currently assumes 10 kHz as some real world devices seem
 524  * to require it. We should query/set the speed via DPCD if supported.
 525  */
 526 static int dp_aux_i2c_speed_khz __read_mostly = 10;
 527 module_param_unsafe(dp_aux_i2c_speed_khz, int, 0644);
 528 MODULE_PARM_DESC(dp_aux_i2c_speed_khz,
 529                  "Assumed speed of the i2c bus in kHz, (1-400, default 10)");
 530
 531 /*
 532  * Transfer a single I2C-over-AUX message and handle various error conditions,
 533  * retrying the transaction as appropriate.  It is assumed that the
 534  * aux->transfer function does not modify anything in the msg other than the
 535  * reply field.
 536  *
 537  * Returns bytes transferred on success, or a negative error code on failure.
 538  */
 539 static int drm_dp_i2c_do_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *msg)
 540 {
 541         unsigned int retry, defer_i2c;
 542         int ret;
 543         /*
 544          * DP1.2 sections 2.7.7.1.5.6.1 and 2.7.7.1.6.6.1: A DP Source device
 545          * is required to retry at least seven times upon receiving AUX_DEFER
 546          * before giving up the AUX transaction.
 547          *
 548          * We also try to account for the i2c bus speed.
 549          */
 550         int max_retries = max(7, drm_dp_i2c_retry_count(msg, dp_aux_i2c_speed_khz));
 551
 552         for (retry = 0, defer_i2c = 0; retry < (max_retries + defer_i2c); retry++) {
 553                 ret = aux->transfer(aux, msg);
 554                 if (ret < 0) {
 555                         if (ret == -EBUSY)
 556                                 continue;
 557
 558                         DRM_DEBUG_KMS("transaction failed: %d\n", ret);
 559                         return ret;
 560                 }
 561
 562
 563                 switch (msg->reply & DP_AUX_NATIVE_REPLY_MASK) {
 564                 case DP_AUX_NATIVE_REPLY_ACK:
 565                         /*
 566                          * For I2C-over-AUX transactions this isn't enough, we
 567                          * need to check for the I2C ACK reply.
 568                          */
 569                         break;
 570
 571                 case DP_AUX_NATIVE_REPLY_NACK:
 572                         DRM_DEBUG_KMS("native nack (result=%d, size=%zu)\n", ret, msg->size);
 573                         return -EREMOTEIO;
 574
 575                 case DP_AUX_NATIVE_REPLY_DEFER:
 576                         DRM_DEBUG_KMS("native defer\n");
 577                         /*
 578                          * We could check for I2C bit rate capabilities and if
 579                          * available adjust this interval. We could also be
 580                          * more careful with DP-to-legacy adapters where a
 581                          * long legacy cable may force very low I2C bit rates.
 582                          *
 583                          * For now just defer for long enough to hopefully be
 584                          * safe for all use-cases.
 585                          */
 586                         usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
 587                         continue;
 588
 589                 default:
 590                         DRM_ERROR("invalid native reply %#04x\n", msg->reply);
 591                         return -EREMOTEIO;
 592                 }
 593
 594                 switch (msg->reply & DP_AUX_I2C_REPLY_MASK) {
 595                 case DP_AUX_I2C_REPLY_ACK:
 596                         /*
 597                          * Both native ACK and I2C ACK replies received. We
 598                          * can assume the transfer was successful.
 599                          */
 600                         if (ret != msg->size)
 601                                 drm_dp_i2c_msg_write_status_update(msg);
 602                         return ret;
 603
 604                 case DP_AUX_I2C_REPLY_NACK:
 605                         DRM_DEBUG_KMS("I2C nack (result=%d, size=%zu\n", ret, msg->size);
 606                         aux->i2c_nack_count++;
 607                         return -EREMOTEIO;
 608
 609                 case DP_AUX_I2C_REPLY_DEFER:
 610                         DRM_DEBUG_KMS("I2C defer\n");
 611                         /* DP Compliance Test 4.2.2.5 Requirement:
 612                          * Must have at least 7 retries for I2C defers on the
 613                          * transaction to pass this test
 614                          */
 615                         aux->i2c_defer_count++;
 616                         if (defer_i2c < 7)
 617                                 defer_i2c++;
 618                         usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
 619                         drm_dp_i2c_msg_write_status_update(msg);
 620
 621                         continue;
 622
 623                 default:
 624                         DRM_ERROR("invalid I2C reply %#04x\n", msg->reply);
 625                         return -EREMOTEIO;
 626                 }
 627         }
 628
 629         DRM_DEBUG_KMS("too many retries, giving up\n");
 630         return -EREMOTEIO;
 631 }
 632
 633 static void drm_dp_i2c_msg_set_request(struct drm_dp_aux_msg *msg,
 634                                        const struct i2c_msg *i2c_msg)
 635 {
 636         msg->request = (i2c_msg->flags & I2C_M_RD) ?
 637                 DP_AUX_I2C_READ : DP_AUX_I2C_WRITE;
 638         msg->request |= DP_AUX_I2C_MOT;
 639 }
 640
 641 /*
 642  * Keep retrying drm_dp_i2c_do_msg until all data has been transferred.
 643  *
 644  * Returns an error code on failure, or a recommended transfer size on success.
 645  */
 646 static int drm_dp_i2c_drain_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *orig_msg)
 647 {
 648         int err, ret = orig_msg->size;
 649         struct drm_dp_aux_msg msg = *orig_msg;
 650
 651         while (msg.size > 0) {
 652                 err = drm_dp_i2c_do_msg(aux, &msg);
 653                 if (err <= 0)
 654                         return err == 0 ? -EPROTO : err;
 655
 656                 if (err < msg.size && err < ret) {
 657                         DRM_DEBUG_KMS("Partial I2C reply: requested %zu bytes got %d bytes\n",
 658                                       msg.size, err);
 659                         ret = err;
 660                 }
 661
 662                 msg.size -= err;
 663                 msg.buffer += err;
 664         }
 665
 666         return ret;
 667 }
 668
 669 /*
 670  * Bizlink designed DP->DVI-D Dual Link adapters require the I2C over AUX
 671  * packets to be as large as possible. If not, the I2C transactions never
 672  * succeed. Hence the default is maximum.
 673  */
 674 static int dp_aux_i2c_transfer_size __read_mostly = DP_AUX_MAX_PAYLOAD_BYTES;
 675 module_param_unsafe(dp_aux_i2c_transfer_size, int, 0644);
 676 MODULE_PARM_DESC(dp_aux_i2c_transfer_size,
 677                  "Number of bytes to transfer in a single I2C over DP AUX CH message, (1-16, default 16)");
 678
 679 static int drm_dp_i2c_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs,
 680                            int num)
 681 {
 682         struct drm_dp_aux *aux = adapter->algo_data;
 683         unsigned int i, j;
 684         unsigned transfer_size;
 685         struct drm_dp_aux_msg msg;
 686         int err = 0;
 687
 688         dp_aux_i2c_transfer_size = clamp(dp_aux_i2c_transfer_size, 1, DP_AUX_MAX_PAYLOAD_BYTES);
 689
 690         memset(&msg, 0, sizeof(msg));
 691
 692         mutex_lock(&aux->hw_mutex);
 693
 694         for (i = 0; i < num; i++) {
 695                 msg.address = msgs[i].addr;
 696                 drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
 697                 /* Send a bare address packet to start the transaction.
 698                  * Zero sized messages specify an address only (bare
 699                  * address) transaction.
 700                  */
 701                 msg.buffer = NULL;
 702                 msg.size = 0;
 703                 err = drm_dp_i2c_do_msg(aux, &msg);
 704
 705                 /*
 706                  * Reset msg.request in case in case it got
 707                  * changed into a WRITE_STATUS_UPDATE.
 708                  */
 709                 drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
 710
 711                 if (err < 0)
 712                         break;
 713                 /* We want each transaction to be as large as possible, but
 714                  * we'll go to smaller sizes if the hardware gives us a
 715                  * short reply.
 716                  */
 717                 transfer_size = dp_aux_i2c_transfer_size;
 718                 for (j = 0; j < msgs[i].len; j += msg.size) {
 719                         msg.buffer = msgs[i].buf + j;
 720                         msg.size = min(transfer_size, msgs[i].len - j);
 721
 722                         err = drm_dp_i2c_drain_msg(aux, &msg);
 723
 724                         /*
 725                          * Reset msg.request in case in case it got
 726                          * changed into a WRITE_STATUS_UPDATE.
 727                          */
 728                         drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
 729
 730                         if (err < 0)
 731                                 break;
 732                         transfer_size = err;
 733                 }
 734                 if (err < 0)
 735                         break;
 736         }
 737         if (err >= 0)
 738                 err = num;
 739         /* Send a bare address packet to close out the transaction.
 740          * Zero sized messages specify an address only (bare
 741          * address) transaction.
 742          */
 743         msg.request &= ~DP_AUX_I2C_MOT;
 744         msg.buffer = NULL;
 745         msg.size = 0;
 746         (void)drm_dp_i2c_do_msg(aux, &msg);
 747
 748         mutex_unlock(&aux->hw_mutex);
 749
 750         return err;
 751 }
 752
 753 static const struct i2c_algorithm drm_dp_i2c_algo = {
 754         .functionality = drm_dp_i2c_functionality,
 755         .master_xfer = drm_dp_i2c_xfer,
 756 };
 757
 758 /**
 759  * drm_dp_aux_register() - initialise and register aux channel
 760  * @aux: DisplayPort AUX channel
 761  *
 762  * Returns 0 on success or a negative error code on failure.
 763  */
 764 int drm_dp_aux_register(struct drm_dp_aux *aux)
 765 {
 766         int ret;
 767
 768         mutex_init(&aux->hw_mutex);
 769
 770         aux->ddc.algo = &drm_dp_i2c_algo;
 771         aux->ddc.algo_data = aux;
 772         aux->ddc.retries = 3;
 773
 774         aux->ddc.class = I2C_CLASS_DDC;
 775         aux->ddc.owner = THIS_MODULE;
 776         aux->ddc.dev.parent = aux->dev;
 777         aux->ddc.dev.of_node = aux->dev->of_node;
 778
 779         strlcpy(aux->ddc.name, aux->name ? aux->name : dev_name(aux->dev),
 780                 sizeof(aux->ddc.name));
 781
 782         ret = drm_dp_aux_register_devnode(aux);
 783         if (ret)
 784                 return ret;
 785
 786         ret = i2c_add_adapter(&aux->ddc);
 787         if (ret) {
 788                 drm_dp_aux_unregister_devnode(aux);
 789                 return ret;
 790         }
 791
 792         return 0;
 793 }
 794 EXPORT_SYMBOL(drm_dp_aux_register);
 795
 796 /**
 797  * drm_dp_aux_unregister() - unregister an AUX adapter
 798  * @aux: DisplayPort AUX channel
 799  */
 800 void drm_dp_aux_unregister(struct drm_dp_aux *aux)
 801 {
 802         drm_dp_aux_unregister_devnode(aux);
 803         i2c_del_adapter(&aux->ddc);
 804 }
 805 EXPORT_SYMBOL(drm_dp_aux_unregister);