2 * Copyright © 2009 Keith Packard
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.
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
23 #include <linux/delay.h>
24 #include <linux/errno.h>
25 #include <linux/i2c.h>
26 #include <linux/init.h>
27 #include <linux/kernel.h>
28 #include <linux/module.h>
29 #include <linux/sched.h>
30 #include <linux/seq_file.h>
32 #include <drm/drm_dp_helper.h>
33 #include <drm/drm_print.h>
34 #include <drm/drm_vblank.h>
35 #include <drm/drm_dp_mst_helper.h>
37 #include "drm_crtc_helper_internal.h"
42 * These functions contain some common logic and helpers at various abstraction
43 * levels to deal with Display Port sink devices and related things like DP aux
44 * channel transfers, EDID reading over DP aux channels, decoding certain DPCD
48 /* Helpers for DP link training */
49 static u8 dp_link_status(const u8 link_status[DP_LINK_STATUS_SIZE], int r)
51 return link_status[r - DP_LANE0_1_STATUS];
54 static u8 dp_get_lane_status(const u8 link_status[DP_LINK_STATUS_SIZE],
57 int i = DP_LANE0_1_STATUS + (lane >> 1);
58 int s = (lane & 1) * 4;
59 u8 l = dp_link_status(link_status, i);
61 return (l >> s) & 0xf;
64 bool drm_dp_channel_eq_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
71 lane_align = dp_link_status(link_status,
72 DP_LANE_ALIGN_STATUS_UPDATED);
73 if ((lane_align & DP_INTERLANE_ALIGN_DONE) == 0)
75 for (lane = 0; lane < lane_count; lane++) {
76 lane_status = dp_get_lane_status(link_status, lane);
77 if ((lane_status & DP_CHANNEL_EQ_BITS) != DP_CHANNEL_EQ_BITS)
82 EXPORT_SYMBOL(drm_dp_channel_eq_ok);
84 bool drm_dp_clock_recovery_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
90 for (lane = 0; lane < lane_count; lane++) {
91 lane_status = dp_get_lane_status(link_status, lane);
92 if ((lane_status & DP_LANE_CR_DONE) == 0)
97 EXPORT_SYMBOL(drm_dp_clock_recovery_ok);
99 u8 drm_dp_get_adjust_request_voltage(const u8 link_status[DP_LINK_STATUS_SIZE],
102 int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
103 int s = ((lane & 1) ?
104 DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT :
105 DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT);
106 u8 l = dp_link_status(link_status, i);
108 return ((l >> s) & 0x3) << DP_TRAIN_VOLTAGE_SWING_SHIFT;
110 EXPORT_SYMBOL(drm_dp_get_adjust_request_voltage);
112 u8 drm_dp_get_adjust_request_pre_emphasis(const u8 link_status[DP_LINK_STATUS_SIZE],
115 int i = DP_ADJUST_REQUEST_LANE0_1 + (lane >> 1);
116 int s = ((lane & 1) ?
117 DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT :
118 DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT);
119 u8 l = dp_link_status(link_status, i);
121 return ((l >> s) & 0x3) << DP_TRAIN_PRE_EMPHASIS_SHIFT;
123 EXPORT_SYMBOL(drm_dp_get_adjust_request_pre_emphasis);
125 u8 drm_dp_get_adjust_request_post_cursor(const u8 link_status[DP_LINK_STATUS_SIZE],
128 unsigned int offset = DP_ADJUST_REQUEST_POST_CURSOR2;
129 u8 value = dp_link_status(link_status, offset);
131 return (value >> (lane << 1)) & 0x3;
133 EXPORT_SYMBOL(drm_dp_get_adjust_request_post_cursor);
135 void drm_dp_link_train_clock_recovery_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
137 unsigned long rd_interval = dpcd[DP_TRAINING_AUX_RD_INTERVAL] &
138 DP_TRAINING_AUX_RD_MASK;
141 DRM_DEBUG_KMS("AUX interval %lu, out of range (max 4)\n",
144 if (rd_interval == 0 || dpcd[DP_DPCD_REV] >= DP_DPCD_REV_14)
147 rd_interval *= 4 * USEC_PER_MSEC;
149 usleep_range(rd_interval, rd_interval * 2);
151 EXPORT_SYMBOL(drm_dp_link_train_clock_recovery_delay);
153 void drm_dp_link_train_channel_eq_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
155 unsigned long rd_interval = dpcd[DP_TRAINING_AUX_RD_INTERVAL] &
156 DP_TRAINING_AUX_RD_MASK;
159 DRM_DEBUG_KMS("AUX interval %lu, out of range (max 4)\n",
162 if (rd_interval == 0)
165 rd_interval *= 4 * USEC_PER_MSEC;
167 usleep_range(rd_interval, rd_interval * 2);
169 EXPORT_SYMBOL(drm_dp_link_train_channel_eq_delay);
171 u8 drm_dp_link_rate_to_bw_code(int link_rate)
173 /* Spec says link_bw = link_rate / 0.27Gbps */
174 return link_rate / 27000;
176 EXPORT_SYMBOL(drm_dp_link_rate_to_bw_code);
178 int drm_dp_bw_code_to_link_rate(u8 link_bw)
180 /* Spec says link_rate = link_bw * 0.27Gbps */
181 return link_bw * 27000;
183 EXPORT_SYMBOL(drm_dp_bw_code_to_link_rate);
185 #define AUX_RETRY_INTERVAL 500 /* us */
188 drm_dp_dump_access(const struct drm_dp_aux *aux,
189 u8 request, uint offset, void *buffer, int ret)
191 const char *arrow = request == DP_AUX_NATIVE_READ ? "->" : "<-";
194 DRM_DEBUG_DP("%s: 0x%05x AUX %s (ret=%3d) %*ph\n",
195 aux->name, offset, arrow, ret, min(ret, 20), buffer);
197 DRM_DEBUG_DP("%s: 0x%05x AUX %s (ret=%3d)\n",
198 aux->name, offset, arrow, ret);
204 * The DisplayPort AUX channel is an abstraction to allow generic, driver-
205 * independent access to AUX functionality. Drivers can take advantage of
206 * this by filling in the fields of the drm_dp_aux structure.
208 * Transactions are described using a hardware-independent drm_dp_aux_msg
209 * structure, which is passed into a driver's .transfer() implementation.
210 * Both native and I2C-over-AUX transactions are supported.
213 static int drm_dp_dpcd_access(struct drm_dp_aux *aux, u8 request,
214 unsigned int offset, void *buffer, size_t size)
216 struct drm_dp_aux_msg msg;
217 unsigned int retry, native_reply;
218 int err = 0, ret = 0;
220 memset(&msg, 0, sizeof(msg));
221 msg.address = offset;
222 msg.request = request;
226 mutex_lock(&aux->hw_mutex);
229 * The specification doesn't give any recommendation on how often to
230 * retry native transactions. We used to retry 7 times like for
231 * aux i2c transactions but real world devices this wasn't
232 * sufficient, bump to 32 which makes Dell 4k monitors happier.
234 for (retry = 0; retry < 32; retry++) {
235 if (ret != 0 && ret != -ETIMEDOUT) {
236 usleep_range(AUX_RETRY_INTERVAL,
237 AUX_RETRY_INTERVAL + 100);
240 ret = aux->transfer(aux, &msg);
242 native_reply = msg.reply & DP_AUX_NATIVE_REPLY_MASK;
243 if (native_reply == DP_AUX_NATIVE_REPLY_ACK) {
253 * We want the error we return to be the error we received on
254 * the first transaction, since we may get a different error the
261 DRM_DEBUG_KMS("%s: Too many retries, giving up. First error: %d\n",
266 mutex_unlock(&aux->hw_mutex);
271 * drm_dp_dpcd_read() - read a series of bytes from the DPCD
272 * @aux: DisplayPort AUX channel (SST or MST)
273 * @offset: address of the (first) register to read
274 * @buffer: buffer to store the register values
275 * @size: number of bytes in @buffer
277 * Returns the number of bytes transferred on success, or a negative error
278 * code on failure. -EIO is returned if the request was NAKed by the sink or
279 * if the retry count was exceeded. If not all bytes were transferred, this
280 * function returns -EPROTO. Errors from the underlying AUX channel transfer
281 * function, with the exception of -EBUSY (which causes the transaction to
282 * be retried), are propagated to the caller.
284 ssize_t drm_dp_dpcd_read(struct drm_dp_aux *aux, unsigned int offset,
285 void *buffer, size_t size)
290 * HP ZR24w corrupts the first DPCD access after entering power save
291 * mode. Eg. on a read, the entire buffer will be filled with the same
292 * byte. Do a throw away read to avoid corrupting anything we care
293 * about. Afterwards things will work correctly until the monitor
294 * gets woken up and subsequently re-enters power save mode.
296 * The user pressing any button on the monitor is enough to wake it
297 * up, so there is no particularly good place to do the workaround.
298 * We just have to do it before any DPCD access and hope that the
299 * monitor doesn't power down exactly after the throw away read.
301 if (!aux->is_remote) {
302 ret = drm_dp_dpcd_access(aux, DP_AUX_NATIVE_READ, DP_DPCD_REV,
309 ret = drm_dp_mst_dpcd_read(aux, offset, buffer, size);
311 ret = drm_dp_dpcd_access(aux, DP_AUX_NATIVE_READ, offset,
315 drm_dp_dump_access(aux, DP_AUX_NATIVE_READ, offset, buffer, ret);
318 EXPORT_SYMBOL(drm_dp_dpcd_read);
321 * drm_dp_dpcd_write() - write a series of bytes to the DPCD
322 * @aux: DisplayPort AUX channel (SST or MST)
323 * @offset: address of the (first) register to write
324 * @buffer: buffer containing the values to write
325 * @size: number of bytes in @buffer
327 * Returns the number of bytes transferred on success, or a negative error
328 * code on failure. -EIO is returned if the request was NAKed by the sink or
329 * if the retry count was exceeded. If not all bytes were transferred, this
330 * function returns -EPROTO. Errors from the underlying AUX channel transfer
331 * function, with the exception of -EBUSY (which causes the transaction to
332 * be retried), are propagated to the caller.
334 ssize_t drm_dp_dpcd_write(struct drm_dp_aux *aux, unsigned int offset,
335 void *buffer, size_t size)
340 ret = drm_dp_mst_dpcd_write(aux, offset, buffer, size);
342 ret = drm_dp_dpcd_access(aux, DP_AUX_NATIVE_WRITE, offset,
345 drm_dp_dump_access(aux, DP_AUX_NATIVE_WRITE, offset, buffer, ret);
348 EXPORT_SYMBOL(drm_dp_dpcd_write);
351 * drm_dp_dpcd_read_link_status() - read DPCD link status (bytes 0x202-0x207)
352 * @aux: DisplayPort AUX channel
353 * @status: buffer to store the link status in (must be at least 6 bytes)
355 * Returns the number of bytes transferred on success or a negative error
358 int drm_dp_dpcd_read_link_status(struct drm_dp_aux *aux,
359 u8 status[DP_LINK_STATUS_SIZE])
361 return drm_dp_dpcd_read(aux, DP_LANE0_1_STATUS, status,
362 DP_LINK_STATUS_SIZE);
364 EXPORT_SYMBOL(drm_dp_dpcd_read_link_status);
367 * drm_dp_send_real_edid_checksum() - send back real edid checksum value
368 * @aux: DisplayPort AUX channel
369 * @real_edid_checksum: real edid checksum for the last block
374 bool drm_dp_send_real_edid_checksum(struct drm_dp_aux *aux,
375 u8 real_edid_checksum)
377 u8 link_edid_read = 0, auto_test_req = 0, test_resp = 0;
379 if (drm_dp_dpcd_read(aux, DP_DEVICE_SERVICE_IRQ_VECTOR,
380 &auto_test_req, 1) < 1) {
381 DRM_ERROR("%s: DPCD failed read at register 0x%x\n",
382 aux->name, DP_DEVICE_SERVICE_IRQ_VECTOR);
385 auto_test_req &= DP_AUTOMATED_TEST_REQUEST;
387 if (drm_dp_dpcd_read(aux, DP_TEST_REQUEST, &link_edid_read, 1) < 1) {
388 DRM_ERROR("%s: DPCD failed read at register 0x%x\n",
389 aux->name, DP_TEST_REQUEST);
392 link_edid_read &= DP_TEST_LINK_EDID_READ;
394 if (!auto_test_req || !link_edid_read) {
395 DRM_DEBUG_KMS("%s: Source DUT does not support TEST_EDID_READ\n",
400 if (drm_dp_dpcd_write(aux, DP_DEVICE_SERVICE_IRQ_VECTOR,
401 &auto_test_req, 1) < 1) {
402 DRM_ERROR("%s: DPCD failed write at register 0x%x\n",
403 aux->name, DP_DEVICE_SERVICE_IRQ_VECTOR);
407 /* send back checksum for the last edid extension block data */
408 if (drm_dp_dpcd_write(aux, DP_TEST_EDID_CHECKSUM,
409 &real_edid_checksum, 1) < 1) {
410 DRM_ERROR("%s: DPCD failed write at register 0x%x\n",
411 aux->name, DP_TEST_EDID_CHECKSUM);
415 test_resp |= DP_TEST_EDID_CHECKSUM_WRITE;
416 if (drm_dp_dpcd_write(aux, DP_TEST_RESPONSE, &test_resp, 1) < 1) {
417 DRM_ERROR("%s: DPCD failed write at register 0x%x\n",
418 aux->name, DP_TEST_RESPONSE);
424 EXPORT_SYMBOL(drm_dp_send_real_edid_checksum);
427 * drm_dp_downstream_max_clock() - extract branch device max
428 * pixel rate for legacy VGA
429 * converter or max TMDS clock
431 * @dpcd: DisplayPort configuration data
432 * @port_cap: port capabilities
434 * Returns max clock in kHz on success or 0 if max clock not defined
436 int drm_dp_downstream_max_clock(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
437 const u8 port_cap[4])
439 int type = port_cap[0] & DP_DS_PORT_TYPE_MASK;
440 bool detailed_cap_info = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
441 DP_DETAILED_CAP_INFO_AVAILABLE;
443 if (!detailed_cap_info)
447 case DP_DS_PORT_TYPE_VGA:
448 return port_cap[1] * 8 * 1000;
449 case DP_DS_PORT_TYPE_DVI:
450 case DP_DS_PORT_TYPE_HDMI:
451 case DP_DS_PORT_TYPE_DP_DUALMODE:
452 return port_cap[1] * 2500;
457 EXPORT_SYMBOL(drm_dp_downstream_max_clock);
460 * drm_dp_downstream_max_bpc() - extract branch device max
462 * @dpcd: DisplayPort configuration data
463 * @port_cap: port capabilities
465 * Returns max bpc on success or 0 if max bpc not defined
467 int drm_dp_downstream_max_bpc(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
468 const u8 port_cap[4])
470 int type = port_cap[0] & DP_DS_PORT_TYPE_MASK;
471 bool detailed_cap_info = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
472 DP_DETAILED_CAP_INFO_AVAILABLE;
475 if (!detailed_cap_info)
479 case DP_DS_PORT_TYPE_VGA:
480 case DP_DS_PORT_TYPE_DVI:
481 case DP_DS_PORT_TYPE_HDMI:
482 case DP_DS_PORT_TYPE_DP_DUALMODE:
483 bpc = port_cap[2] & DP_DS_MAX_BPC_MASK;
500 EXPORT_SYMBOL(drm_dp_downstream_max_bpc);
503 * drm_dp_downstream_id() - identify branch device
504 * @aux: DisplayPort AUX channel
505 * @id: DisplayPort branch device id
507 * Returns branch device id on success or NULL on failure
509 int drm_dp_downstream_id(struct drm_dp_aux *aux, char id[6])
511 return drm_dp_dpcd_read(aux, DP_BRANCH_ID, id, 6);
513 EXPORT_SYMBOL(drm_dp_downstream_id);
516 * drm_dp_downstream_debug() - debug DP branch devices
517 * @m: pointer for debugfs file
518 * @dpcd: DisplayPort configuration data
519 * @port_cap: port capabilities
520 * @aux: DisplayPort AUX channel
523 void drm_dp_downstream_debug(struct seq_file *m,
524 const u8 dpcd[DP_RECEIVER_CAP_SIZE],
525 const u8 port_cap[4], struct drm_dp_aux *aux)
527 bool detailed_cap_info = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
528 DP_DETAILED_CAP_INFO_AVAILABLE;
534 int type = port_cap[0] & DP_DS_PORT_TYPE_MASK;
535 bool branch_device = drm_dp_is_branch(dpcd);
537 seq_printf(m, "\tDP branch device present: %s\n",
538 branch_device ? "yes" : "no");
544 case DP_DS_PORT_TYPE_DP:
545 seq_puts(m, "\t\tType: DisplayPort\n");
547 case DP_DS_PORT_TYPE_VGA:
548 seq_puts(m, "\t\tType: VGA\n");
550 case DP_DS_PORT_TYPE_DVI:
551 seq_puts(m, "\t\tType: DVI\n");
553 case DP_DS_PORT_TYPE_HDMI:
554 seq_puts(m, "\t\tType: HDMI\n");
556 case DP_DS_PORT_TYPE_NON_EDID:
557 seq_puts(m, "\t\tType: others without EDID support\n");
559 case DP_DS_PORT_TYPE_DP_DUALMODE:
560 seq_puts(m, "\t\tType: DP++\n");
562 case DP_DS_PORT_TYPE_WIRELESS:
563 seq_puts(m, "\t\tType: Wireless\n");
566 seq_puts(m, "\t\tType: N/A\n");
569 memset(id, 0, sizeof(id));
570 drm_dp_downstream_id(aux, id);
571 seq_printf(m, "\t\tID: %s\n", id);
573 len = drm_dp_dpcd_read(aux, DP_BRANCH_HW_REV, &rev[0], 1);
575 seq_printf(m, "\t\tHW: %d.%d\n",
576 (rev[0] & 0xf0) >> 4, rev[0] & 0xf);
578 len = drm_dp_dpcd_read(aux, DP_BRANCH_SW_REV, rev, 2);
580 seq_printf(m, "\t\tSW: %d.%d\n", rev[0], rev[1]);
582 if (detailed_cap_info) {
583 clk = drm_dp_downstream_max_clock(dpcd, port_cap);
586 if (type == DP_DS_PORT_TYPE_VGA)
587 seq_printf(m, "\t\tMax dot clock: %d kHz\n", clk);
589 seq_printf(m, "\t\tMax TMDS clock: %d kHz\n", clk);
592 bpc = drm_dp_downstream_max_bpc(dpcd, port_cap);
595 seq_printf(m, "\t\tMax bpc: %d\n", bpc);
598 EXPORT_SYMBOL(drm_dp_downstream_debug);
601 * drm_dp_subconnector_type() - get DP branch device type
604 enum drm_mode_subconnector
605 drm_dp_subconnector_type(const u8 dpcd[DP_RECEIVER_CAP_SIZE],
606 const u8 port_cap[4])
609 if (!drm_dp_is_branch(dpcd))
610 return DRM_MODE_SUBCONNECTOR_Native;
611 /* DP 1.0 approach */
612 if (dpcd[DP_DPCD_REV] == DP_DPCD_REV_10) {
613 type = dpcd[DP_DOWNSTREAMPORT_PRESENT] &
614 DP_DWN_STRM_PORT_TYPE_MASK;
617 case DP_DWN_STRM_PORT_TYPE_TMDS:
618 /* Can be HDMI or DVI-D, DVI-D is a safer option */
619 return DRM_MODE_SUBCONNECTOR_DVID;
620 case DP_DWN_STRM_PORT_TYPE_ANALOG:
621 /* Can be VGA or DVI-A, VGA is more popular */
622 return DRM_MODE_SUBCONNECTOR_VGA;
623 case DP_DWN_STRM_PORT_TYPE_DP:
624 return DRM_MODE_SUBCONNECTOR_DisplayPort;
625 case DP_DWN_STRM_PORT_TYPE_OTHER:
627 return DRM_MODE_SUBCONNECTOR_Unknown;
630 type = port_cap[0] & DP_DS_PORT_TYPE_MASK;
633 case DP_DS_PORT_TYPE_DP:
634 case DP_DS_PORT_TYPE_DP_DUALMODE:
635 return DRM_MODE_SUBCONNECTOR_DisplayPort;
636 case DP_DS_PORT_TYPE_VGA:
637 return DRM_MODE_SUBCONNECTOR_VGA;
638 case DP_DS_PORT_TYPE_DVI:
639 return DRM_MODE_SUBCONNECTOR_DVID;
640 case DP_DS_PORT_TYPE_HDMI:
641 return DRM_MODE_SUBCONNECTOR_HDMIA;
642 case DP_DS_PORT_TYPE_WIRELESS:
643 return DRM_MODE_SUBCONNECTOR_Wireless;
644 case DP_DS_PORT_TYPE_NON_EDID:
646 return DRM_MODE_SUBCONNECTOR_Unknown;
649 EXPORT_SYMBOL(drm_dp_subconnector_type);
652 * drm_mode_set_dp_subconnector_property - set subconnector for DP connector
654 * Called by a driver on every detect event.
656 void drm_dp_set_subconnector_property(struct drm_connector *connector,
657 enum drm_connector_status status,
659 const u8 port_cap[4])
661 enum drm_mode_subconnector subconnector = DRM_MODE_SUBCONNECTOR_Unknown;
663 if (status == connector_status_connected)
664 subconnector = drm_dp_subconnector_type(dpcd, port_cap);
665 drm_object_property_set_value(&connector->base,
666 connector->dev->mode_config.dp_subconnector_property,
669 EXPORT_SYMBOL(drm_dp_set_subconnector_property);
672 * I2C-over-AUX implementation
675 static u32 drm_dp_i2c_functionality(struct i2c_adapter *adapter)
677 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
678 I2C_FUNC_SMBUS_READ_BLOCK_DATA |
679 I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
683 static void drm_dp_i2c_msg_write_status_update(struct drm_dp_aux_msg *msg)
686 * In case of i2c defer or short i2c ack reply to a write,
687 * we need to switch to WRITE_STATUS_UPDATE to drain the
688 * rest of the message
690 if ((msg->request & ~DP_AUX_I2C_MOT) == DP_AUX_I2C_WRITE) {
691 msg->request &= DP_AUX_I2C_MOT;
692 msg->request |= DP_AUX_I2C_WRITE_STATUS_UPDATE;
696 #define AUX_PRECHARGE_LEN 10 /* 10 to 16 */
697 #define AUX_SYNC_LEN (16 + 4) /* preamble + AUX_SYNC_END */
698 #define AUX_STOP_LEN 4
699 #define AUX_CMD_LEN 4
700 #define AUX_ADDRESS_LEN 20
701 #define AUX_REPLY_PAD_LEN 4
702 #define AUX_LENGTH_LEN 8
705 * Calculate the duration of the AUX request/reply in usec. Gives the
706 * "best" case estimate, ie. successful while as short as possible.
708 static int drm_dp_aux_req_duration(const struct drm_dp_aux_msg *msg)
710 int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
711 AUX_CMD_LEN + AUX_ADDRESS_LEN + AUX_LENGTH_LEN;
713 if ((msg->request & DP_AUX_I2C_READ) == 0)
714 len += msg->size * 8;
719 static int drm_dp_aux_reply_duration(const struct drm_dp_aux_msg *msg)
721 int len = AUX_PRECHARGE_LEN + AUX_SYNC_LEN + AUX_STOP_LEN +
722 AUX_CMD_LEN + AUX_REPLY_PAD_LEN;
725 * For read we expect what was asked. For writes there will
726 * be 0 or 1 data bytes. Assume 0 for the "best" case.
728 if (msg->request & DP_AUX_I2C_READ)
729 len += msg->size * 8;
734 #define I2C_START_LEN 1
735 #define I2C_STOP_LEN 1
736 #define I2C_ADDR_LEN 9 /* ADDRESS + R/W + ACK/NACK */
737 #define I2C_DATA_LEN 9 /* DATA + ACK/NACK */
740 * Calculate the length of the i2c transfer in usec, assuming
741 * the i2c bus speed is as specified. Gives the the "worst"
742 * case estimate, ie. successful while as long as possible.
743 * Doesn't account the the "MOT" bit, and instead assumes each
744 * message includes a START, ADDRESS and STOP. Neither does it
745 * account for additional random variables such as clock stretching.
747 static int drm_dp_i2c_msg_duration(const struct drm_dp_aux_msg *msg,
750 /* AUX bitrate is 1MHz, i2c bitrate as specified */
751 return DIV_ROUND_UP((I2C_START_LEN + I2C_ADDR_LEN +
752 msg->size * I2C_DATA_LEN +
753 I2C_STOP_LEN) * 1000, i2c_speed_khz);
757 * Deterine how many retries should be attempted to successfully transfer
758 * the specified message, based on the estimated durations of the
759 * i2c and AUX transfers.
761 static int drm_dp_i2c_retry_count(const struct drm_dp_aux_msg *msg,
764 int aux_time_us = drm_dp_aux_req_duration(msg) +
765 drm_dp_aux_reply_duration(msg);
766 int i2c_time_us = drm_dp_i2c_msg_duration(msg, i2c_speed_khz);
768 return DIV_ROUND_UP(i2c_time_us, aux_time_us + AUX_RETRY_INTERVAL);
772 * FIXME currently assumes 10 kHz as some real world devices seem
773 * to require it. We should query/set the speed via DPCD if supported.
775 static int dp_aux_i2c_speed_khz __read_mostly = 10;
776 module_param_unsafe(dp_aux_i2c_speed_khz, int, 0644);
777 MODULE_PARM_DESC(dp_aux_i2c_speed_khz,
778 "Assumed speed of the i2c bus in kHz, (1-400, default 10)");
781 * Transfer a single I2C-over-AUX message and handle various error conditions,
782 * retrying the transaction as appropriate. It is assumed that the
783 * &drm_dp_aux.transfer function does not modify anything in the msg other than the
786 * Returns bytes transferred on success, or a negative error code on failure.
788 static int drm_dp_i2c_do_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *msg)
790 unsigned int retry, defer_i2c;
793 * DP1.2 sections 2.7.7.1.5.6.1 and 2.7.7.1.6.6.1: A DP Source device
794 * is required to retry at least seven times upon receiving AUX_DEFER
795 * before giving up the AUX transaction.
797 * We also try to account for the i2c bus speed.
799 int max_retries = max(7, drm_dp_i2c_retry_count(msg, dp_aux_i2c_speed_khz));
801 for (retry = 0, defer_i2c = 0; retry < (max_retries + defer_i2c); retry++) {
802 ret = aux->transfer(aux, msg);
808 * While timeouts can be errors, they're usually normal
809 * behavior (for instance, when a driver tries to
810 * communicate with a non-existant DisplayPort device).
811 * Avoid spamming the kernel log with timeout errors.
813 if (ret == -ETIMEDOUT)
814 DRM_DEBUG_KMS_RATELIMITED("%s: transaction timed out\n",
817 DRM_DEBUG_KMS("%s: transaction failed: %d\n",
823 switch (msg->reply & DP_AUX_NATIVE_REPLY_MASK) {
824 case DP_AUX_NATIVE_REPLY_ACK:
826 * For I2C-over-AUX transactions this isn't enough, we
827 * need to check for the I2C ACK reply.
831 case DP_AUX_NATIVE_REPLY_NACK:
832 DRM_DEBUG_KMS("%s: native nack (result=%d, size=%zu)\n",
833 aux->name, ret, msg->size);
836 case DP_AUX_NATIVE_REPLY_DEFER:
837 DRM_DEBUG_KMS("%s: native defer\n", aux->name);
839 * We could check for I2C bit rate capabilities and if
840 * available adjust this interval. We could also be
841 * more careful with DP-to-legacy adapters where a
842 * long legacy cable may force very low I2C bit rates.
844 * For now just defer for long enough to hopefully be
845 * safe for all use-cases.
847 usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
851 DRM_ERROR("%s: invalid native reply %#04x\n",
852 aux->name, msg->reply);
856 switch (msg->reply & DP_AUX_I2C_REPLY_MASK) {
857 case DP_AUX_I2C_REPLY_ACK:
859 * Both native ACK and I2C ACK replies received. We
860 * can assume the transfer was successful.
862 if (ret != msg->size)
863 drm_dp_i2c_msg_write_status_update(msg);
866 case DP_AUX_I2C_REPLY_NACK:
867 DRM_DEBUG_KMS("%s: I2C nack (result=%d, size=%zu)\n",
868 aux->name, ret, msg->size);
869 aux->i2c_nack_count++;
872 case DP_AUX_I2C_REPLY_DEFER:
873 DRM_DEBUG_KMS("%s: I2C defer\n", aux->name);
874 /* DP Compliance Test 4.2.2.5 Requirement:
875 * Must have at least 7 retries for I2C defers on the
876 * transaction to pass this test
878 aux->i2c_defer_count++;
881 usleep_range(AUX_RETRY_INTERVAL, AUX_RETRY_INTERVAL + 100);
882 drm_dp_i2c_msg_write_status_update(msg);
887 DRM_ERROR("%s: invalid I2C reply %#04x\n",
888 aux->name, msg->reply);
893 DRM_DEBUG_KMS("%s: Too many retries, giving up\n", aux->name);
897 static void drm_dp_i2c_msg_set_request(struct drm_dp_aux_msg *msg,
898 const struct i2c_msg *i2c_msg)
900 msg->request = (i2c_msg->flags & I2C_M_RD) ?
901 DP_AUX_I2C_READ : DP_AUX_I2C_WRITE;
902 if (!(i2c_msg->flags & I2C_M_STOP))
903 msg->request |= DP_AUX_I2C_MOT;
907 * Keep retrying drm_dp_i2c_do_msg until all data has been transferred.
909 * Returns an error code on failure, or a recommended transfer size on success.
911 static int drm_dp_i2c_drain_msg(struct drm_dp_aux *aux, struct drm_dp_aux_msg *orig_msg)
913 int err, ret = orig_msg->size;
914 struct drm_dp_aux_msg msg = *orig_msg;
916 while (msg.size > 0) {
917 err = drm_dp_i2c_do_msg(aux, &msg);
919 return err == 0 ? -EPROTO : err;
921 if (err < msg.size && err < ret) {
922 DRM_DEBUG_KMS("%s: Partial I2C reply: requested %zu bytes got %d bytes\n",
923 aux->name, msg.size, err);
935 * Bizlink designed DP->DVI-D Dual Link adapters require the I2C over AUX
936 * packets to be as large as possible. If not, the I2C transactions never
937 * succeed. Hence the default is maximum.
939 static int dp_aux_i2c_transfer_size __read_mostly = DP_AUX_MAX_PAYLOAD_BYTES;
940 module_param_unsafe(dp_aux_i2c_transfer_size, int, 0644);
941 MODULE_PARM_DESC(dp_aux_i2c_transfer_size,
942 "Number of bytes to transfer in a single I2C over DP AUX CH message, (1-16, default 16)");
944 static int drm_dp_i2c_xfer(struct i2c_adapter *adapter, struct i2c_msg *msgs,
947 struct drm_dp_aux *aux = adapter->algo_data;
949 unsigned transfer_size;
950 struct drm_dp_aux_msg msg;
953 dp_aux_i2c_transfer_size = clamp(dp_aux_i2c_transfer_size, 1, DP_AUX_MAX_PAYLOAD_BYTES);
955 memset(&msg, 0, sizeof(msg));
957 for (i = 0; i < num; i++) {
958 msg.address = msgs[i].addr;
959 drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
960 /* Send a bare address packet to start the transaction.
961 * Zero sized messages specify an address only (bare
962 * address) transaction.
966 err = drm_dp_i2c_do_msg(aux, &msg);
969 * Reset msg.request in case in case it got
970 * changed into a WRITE_STATUS_UPDATE.
972 drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
976 /* We want each transaction to be as large as possible, but
977 * we'll go to smaller sizes if the hardware gives us a
980 transfer_size = dp_aux_i2c_transfer_size;
981 for (j = 0; j < msgs[i].len; j += msg.size) {
982 msg.buffer = msgs[i].buf + j;
983 msg.size = min(transfer_size, msgs[i].len - j);
985 err = drm_dp_i2c_drain_msg(aux, &msg);
988 * Reset msg.request in case in case it got
989 * changed into a WRITE_STATUS_UPDATE.
991 drm_dp_i2c_msg_set_request(&msg, &msgs[i]);
1002 /* Send a bare address packet to close out the transaction.
1003 * Zero sized messages specify an address only (bare
1004 * address) transaction.
1006 msg.request &= ~DP_AUX_I2C_MOT;
1009 (void)drm_dp_i2c_do_msg(aux, &msg);
1014 static const struct i2c_algorithm drm_dp_i2c_algo = {
1015 .functionality = drm_dp_i2c_functionality,
1016 .master_xfer = drm_dp_i2c_xfer,
1019 static struct drm_dp_aux *i2c_to_aux(struct i2c_adapter *i2c)
1021 return container_of(i2c, struct drm_dp_aux, ddc);
1024 static void lock_bus(struct i2c_adapter *i2c, unsigned int flags)
1026 mutex_lock(&i2c_to_aux(i2c)->hw_mutex);
1029 static int trylock_bus(struct i2c_adapter *i2c, unsigned int flags)
1031 return mutex_trylock(&i2c_to_aux(i2c)->hw_mutex);
1034 static void unlock_bus(struct i2c_adapter *i2c, unsigned int flags)
1036 mutex_unlock(&i2c_to_aux(i2c)->hw_mutex);
1039 static const struct i2c_lock_operations drm_dp_i2c_lock_ops = {
1040 .lock_bus = lock_bus,
1041 .trylock_bus = trylock_bus,
1042 .unlock_bus = unlock_bus,
1045 static int drm_dp_aux_get_crc(struct drm_dp_aux *aux, u8 *crc)
1050 ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK, &buf);
1054 WARN_ON(!(buf & DP_TEST_SINK_START));
1056 ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK_MISC, &buf);
1060 count = buf & DP_TEST_COUNT_MASK;
1061 if (count == aux->crc_count)
1062 return -EAGAIN; /* No CRC yet */
1064 aux->crc_count = count;
1067 * At DP_TEST_CRC_R_CR, there's 6 bytes containing CRC data, 2 bytes
1068 * per component (RGB or CrYCb).
1070 ret = drm_dp_dpcd_read(aux, DP_TEST_CRC_R_CR, crc, 6);
1077 static void drm_dp_aux_crc_work(struct work_struct *work)
1079 struct drm_dp_aux *aux = container_of(work, struct drm_dp_aux,
1081 struct drm_crtc *crtc;
1086 if (WARN_ON(!aux->crtc))
1090 while (crtc->crc.opened) {
1091 drm_crtc_wait_one_vblank(crtc);
1092 if (!crtc->crc.opened)
1095 ret = drm_dp_aux_get_crc(aux, crc_bytes);
1096 if (ret == -EAGAIN) {
1097 usleep_range(1000, 2000);
1098 ret = drm_dp_aux_get_crc(aux, crc_bytes);
1101 if (ret == -EAGAIN) {
1102 DRM_DEBUG_KMS("%s: Get CRC failed after retrying: %d\n",
1106 DRM_DEBUG_KMS("%s: Failed to get a CRC: %d\n",
1111 crcs[0] = crc_bytes[0] | crc_bytes[1] << 8;
1112 crcs[1] = crc_bytes[2] | crc_bytes[3] << 8;
1113 crcs[2] = crc_bytes[4] | crc_bytes[5] << 8;
1114 drm_crtc_add_crc_entry(crtc, false, 0, crcs);
1119 * drm_dp_remote_aux_init() - minimally initialise a remote aux channel
1120 * @aux: DisplayPort AUX channel
1122 * Used for remote aux channel in general. Merely initialize the crc work
1125 void drm_dp_remote_aux_init(struct drm_dp_aux *aux)
1127 INIT_WORK(&aux->crc_work, drm_dp_aux_crc_work);
1129 EXPORT_SYMBOL(drm_dp_remote_aux_init);
1132 * drm_dp_aux_init() - minimally initialise an aux channel
1133 * @aux: DisplayPort AUX channel
1135 * If you need to use the drm_dp_aux's i2c adapter prior to registering it
1136 * with the outside world, call drm_dp_aux_init() first. You must still
1137 * call drm_dp_aux_register() once the connector has been registered to
1138 * allow userspace access to the auxiliary DP channel.
1140 void drm_dp_aux_init(struct drm_dp_aux *aux)
1142 mutex_init(&aux->hw_mutex);
1143 mutex_init(&aux->cec.lock);
1144 INIT_WORK(&aux->crc_work, drm_dp_aux_crc_work);
1146 aux->ddc.algo = &drm_dp_i2c_algo;
1147 aux->ddc.algo_data = aux;
1148 aux->ddc.retries = 3;
1150 aux->ddc.lock_ops = &drm_dp_i2c_lock_ops;
1152 EXPORT_SYMBOL(drm_dp_aux_init);
1155 * drm_dp_aux_register() - initialise and register aux channel
1156 * @aux: DisplayPort AUX channel
1158 * Automatically calls drm_dp_aux_init() if this hasn't been done yet.
1159 * This should only be called when the underlying &struct drm_connector is
1160 * initialiazed already. Therefore the best place to call this is from
1161 * &drm_connector_funcs.late_register. Not that drivers which don't follow this
1162 * will Oops when CONFIG_DRM_DP_AUX_CHARDEV is enabled.
1164 * Drivers which need to use the aux channel before that point (e.g. at driver
1165 * load time, before drm_dev_register() has been called) need to call
1166 * drm_dp_aux_init().
1168 * Returns 0 on success or a negative error code on failure.
1170 int drm_dp_aux_register(struct drm_dp_aux *aux)
1175 drm_dp_aux_init(aux);
1177 aux->ddc.class = I2C_CLASS_DDC;
1178 aux->ddc.owner = THIS_MODULE;
1179 aux->ddc.dev.parent = aux->dev;
1181 strlcpy(aux->ddc.name, aux->name ? aux->name : dev_name(aux->dev),
1182 sizeof(aux->ddc.name));
1184 ret = drm_dp_aux_register_devnode(aux);
1188 ret = i2c_add_adapter(&aux->ddc);
1190 drm_dp_aux_unregister_devnode(aux);
1196 EXPORT_SYMBOL(drm_dp_aux_register);
1199 * drm_dp_aux_unregister() - unregister an AUX adapter
1200 * @aux: DisplayPort AUX channel
1202 void drm_dp_aux_unregister(struct drm_dp_aux *aux)
1204 drm_dp_aux_unregister_devnode(aux);
1205 i2c_del_adapter(&aux->ddc);
1207 EXPORT_SYMBOL(drm_dp_aux_unregister);
1209 #define PSR_SETUP_TIME(x) [DP_PSR_SETUP_TIME_ ## x >> DP_PSR_SETUP_TIME_SHIFT] = (x)
1212 * drm_dp_psr_setup_time() - PSR setup in time usec
1213 * @psr_cap: PSR capabilities from DPCD
1216 * PSR setup time for the panel in microseconds, negative
1217 * error code on failure.
1219 int drm_dp_psr_setup_time(const u8 psr_cap[EDP_PSR_RECEIVER_CAP_SIZE])
1221 static const u16 psr_setup_time_us[] = {
1222 PSR_SETUP_TIME(330),
1223 PSR_SETUP_TIME(275),
1224 PSR_SETUP_TIME(220),
1225 PSR_SETUP_TIME(165),
1226 PSR_SETUP_TIME(110),
1232 i = (psr_cap[1] & DP_PSR_SETUP_TIME_MASK) >> DP_PSR_SETUP_TIME_SHIFT;
1233 if (i >= ARRAY_SIZE(psr_setup_time_us))
1236 return psr_setup_time_us[i];
1238 EXPORT_SYMBOL(drm_dp_psr_setup_time);
1240 #undef PSR_SETUP_TIME
1243 * drm_dp_start_crc() - start capture of frame CRCs
1244 * @aux: DisplayPort AUX channel
1245 * @crtc: CRTC displaying the frames whose CRCs are to be captured
1247 * Returns 0 on success or a negative error code on failure.
1249 int drm_dp_start_crc(struct drm_dp_aux *aux, struct drm_crtc *crtc)
1254 ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK, &buf);
1258 ret = drm_dp_dpcd_writeb(aux, DP_TEST_SINK, buf | DP_TEST_SINK_START);
1264 schedule_work(&aux->crc_work);
1268 EXPORT_SYMBOL(drm_dp_start_crc);
1271 * drm_dp_stop_crc() - stop capture of frame CRCs
1272 * @aux: DisplayPort AUX channel
1274 * Returns 0 on success or a negative error code on failure.
1276 int drm_dp_stop_crc(struct drm_dp_aux *aux)
1281 ret = drm_dp_dpcd_readb(aux, DP_TEST_SINK, &buf);
1285 ret = drm_dp_dpcd_writeb(aux, DP_TEST_SINK, buf & ~DP_TEST_SINK_START);
1289 flush_work(&aux->crc_work);
1294 EXPORT_SYMBOL(drm_dp_stop_crc);
1303 #define OUI(first, second, third) { (first), (second), (third) }
1304 #define DEVICE_ID(first, second, third, fourth, fifth, sixth) \
1305 { (first), (second), (third), (fourth), (fifth), (sixth) }
1307 #define DEVICE_ID_ANY DEVICE_ID(0, 0, 0, 0, 0, 0)
1309 static const struct dpcd_quirk dpcd_quirk_list[] = {
1310 /* Analogix 7737 needs reduced M and N at HBR2 link rates */
1311 { OUI(0x00, 0x22, 0xb9), DEVICE_ID_ANY, true, BIT(DP_DPCD_QUIRK_CONSTANT_N) },
1312 /* LG LP140WF6-SPM1 eDP panel */
1313 { OUI(0x00, 0x22, 0xb9), DEVICE_ID('s', 'i', 'v', 'a', 'r', 'T'), false, BIT(DP_DPCD_QUIRK_CONSTANT_N) },
1314 /* Apple panels need some additional handling to support PSR */
1315 { OUI(0x00, 0x10, 0xfa), DEVICE_ID_ANY, false, BIT(DP_DPCD_QUIRK_NO_PSR) },
1316 /* CH7511 seems to leave SINK_COUNT zeroed */
1317 { OUI(0x00, 0x00, 0x00), DEVICE_ID('C', 'H', '7', '5', '1', '1'), false, BIT(DP_DPCD_QUIRK_NO_SINK_COUNT) },
1318 /* Synaptics DP1.4 MST hubs can support DSC without virtual DPCD */
1319 { OUI(0x90, 0xCC, 0x24), DEVICE_ID_ANY, true, BIT(DP_DPCD_QUIRK_DSC_WITHOUT_VIRTUAL_DPCD) },
1320 /* Apple MacBookPro 2017 15 inch eDP Retina panel reports too low DP_MAX_LINK_RATE */
1321 { OUI(0x00, 0x10, 0xfa), DEVICE_ID(101, 68, 21, 101, 98, 97), false, BIT(DP_DPCD_QUIRK_CAN_DO_MAX_LINK_RATE_3_24_GBPS) },
1327 * Get a bit mask of DPCD quirks for the sink/branch device identified by
1328 * ident. The quirk data is shared but it's up to the drivers to act on the
1331 * For now, only the OUI (first three bytes) is used, but this may be extended
1332 * to device identification string and hardware/firmware revisions later.
1335 drm_dp_get_quirks(const struct drm_dp_dpcd_ident *ident, bool is_branch)
1337 const struct dpcd_quirk *quirk;
1340 u8 any_device[] = DEVICE_ID_ANY;
1342 for (i = 0; i < ARRAY_SIZE(dpcd_quirk_list); i++) {
1343 quirk = &dpcd_quirk_list[i];
1345 if (quirk->is_branch != is_branch)
1348 if (memcmp(quirk->oui, ident->oui, sizeof(ident->oui)) != 0)
1351 if (memcmp(quirk->device_id, any_device, sizeof(any_device)) != 0 &&
1352 memcmp(quirk->device_id, ident->device_id, sizeof(ident->device_id)) != 0)
1355 quirks |= quirk->quirks;
1361 #undef DEVICE_ID_ANY
1370 #define MFG(first, second) { (first), (second) }
1371 #define PROD_ID(first, second) { (first), (second) }
1374 * Some devices have unreliable OUIDs where they don't set the device ID
1375 * correctly, and as a result we need to use the EDID for finding additional
1376 * DP quirks in such cases.
1378 static const struct edid_quirk edid_quirk_list[] = {
1379 /* Optional 4K AMOLED panel in the ThinkPad X1 Extreme 2nd Generation
1380 * only supports DPCD backlight controls
1382 { MFG(0x4c, 0x83), PROD_ID(0x41, 0x41), BIT(DP_QUIRK_FORCE_DPCD_BACKLIGHT) },
1384 * Some Dell CML 2020 systems have panels support both AUX and PWM
1385 * backlight control, and some only support AUX backlight control. All
1386 * said panels start up in AUX mode by default, and we don't have any
1387 * support for disabling HDR mode on these panels which would be
1388 * required to switch to PWM backlight control mode (plus, I'm not
1389 * even sure we want PWM backlight controls over DPCD backlight
1390 * controls anyway...). Until we have a better way of detecting these,
1391 * force DPCD backlight mode on all of them.
1393 { MFG(0x06, 0xaf), PROD_ID(0x9b, 0x32), BIT(DP_QUIRK_FORCE_DPCD_BACKLIGHT) },
1394 { MFG(0x06, 0xaf), PROD_ID(0xeb, 0x41), BIT(DP_QUIRK_FORCE_DPCD_BACKLIGHT) },
1395 { MFG(0x4d, 0x10), PROD_ID(0xc7, 0x14), BIT(DP_QUIRK_FORCE_DPCD_BACKLIGHT) },
1396 { MFG(0x4d, 0x10), PROD_ID(0xe6, 0x14), BIT(DP_QUIRK_FORCE_DPCD_BACKLIGHT) },
1397 { MFG(0x4c, 0x83), PROD_ID(0x47, 0x41), BIT(DP_QUIRK_FORCE_DPCD_BACKLIGHT) },
1404 * drm_dp_get_edid_quirks() - Check the EDID of a DP device to find additional
1405 * DP-specific quirks
1406 * @edid: The EDID to check
1408 * While OUIDs are meant to be used to recognize a DisplayPort device, a lot
1409 * of manufacturers don't seem to like following standards and neglect to fill
1410 * the dev-ID in, making it impossible to only use OUIDs for determining
1411 * quirks in some cases. This function can be used to check the EDID and look
1412 * up any additional DP quirks. The bits returned by this function correspond
1413 * to the quirk bits in &drm_dp_quirk.
1415 * Returns: a bitmask of quirks, if any. The driver can check this using
1416 * drm_dp_has_quirk().
1418 u32 drm_dp_get_edid_quirks(const struct edid *edid)
1420 const struct edid_quirk *quirk;
1427 for (i = 0; i < ARRAY_SIZE(edid_quirk_list); i++) {
1428 quirk = &edid_quirk_list[i];
1429 if (memcmp(quirk->mfg_id, edid->mfg_id,
1430 sizeof(edid->mfg_id)) == 0 &&
1431 memcmp(quirk->prod_id, edid->prod_code,
1432 sizeof(edid->prod_code)) == 0)
1433 quirks |= quirk->quirks;
1436 DRM_DEBUG_KMS("DP sink: EDID mfg %*phD prod-ID %*phD quirks: 0x%04x\n",
1437 (int)sizeof(edid->mfg_id), edid->mfg_id,
1438 (int)sizeof(edid->prod_code), edid->prod_code, quirks);
1442 EXPORT_SYMBOL(drm_dp_get_edid_quirks);
1445 * drm_dp_read_desc - read sink/branch descriptor from DPCD
1446 * @aux: DisplayPort AUX channel
1447 * @desc: Device descriptor to fill from DPCD
1448 * @is_branch: true for branch devices, false for sink devices
1450 * Read DPCD 0x400 (sink) or 0x500 (branch) into @desc. Also debug log the
1453 * Returns 0 on success or a negative error code on failure.
1455 int drm_dp_read_desc(struct drm_dp_aux *aux, struct drm_dp_desc *desc,
1458 struct drm_dp_dpcd_ident *ident = &desc->ident;
1459 unsigned int offset = is_branch ? DP_BRANCH_OUI : DP_SINK_OUI;
1460 int ret, dev_id_len;
1462 ret = drm_dp_dpcd_read(aux, offset, ident, sizeof(*ident));
1466 desc->quirks = drm_dp_get_quirks(ident, is_branch);
1468 dev_id_len = strnlen(ident->device_id, sizeof(ident->device_id));
1470 DRM_DEBUG_KMS("%s: DP %s: OUI %*phD dev-ID %*pE HW-rev %d.%d SW-rev %d.%d quirks 0x%04x\n",
1471 aux->name, is_branch ? "branch" : "sink",
1472 (int)sizeof(ident->oui), ident->oui,
1473 dev_id_len, ident->device_id,
1474 ident->hw_rev >> 4, ident->hw_rev & 0xf,
1475 ident->sw_major_rev, ident->sw_minor_rev,
1480 EXPORT_SYMBOL(drm_dp_read_desc);
1483 * drm_dp_dsc_sink_max_slice_count() - Get the max slice count
1484 * supported by the DSC sink.
1485 * @dsc_dpcd: DSC capabilities from DPCD
1486 * @is_edp: true if its eDP, false for DP
1488 * Read the slice capabilities DPCD register from DSC sink to get
1489 * the maximum slice count supported. This is used to populate
1490 * the DSC parameters in the &struct drm_dsc_config by the driver.
1491 * Driver creates an infoframe using these parameters to populate
1492 * &struct drm_dsc_pps_infoframe. These are sent to the sink using DSC
1493 * infoframe using the helper function drm_dsc_pps_infoframe_pack()
1496 * Maximum slice count supported by DSC sink or 0 its invalid
1498 u8 drm_dp_dsc_sink_max_slice_count(const u8 dsc_dpcd[DP_DSC_RECEIVER_CAP_SIZE],
1501 u8 slice_cap1 = dsc_dpcd[DP_DSC_SLICE_CAP_1 - DP_DSC_SUPPORT];
1504 /* For eDP, register DSC_SLICE_CAPABILITIES_1 gives slice count */
1505 if (slice_cap1 & DP_DSC_4_PER_DP_DSC_SINK)
1507 if (slice_cap1 & DP_DSC_2_PER_DP_DSC_SINK)
1509 if (slice_cap1 & DP_DSC_1_PER_DP_DSC_SINK)
1512 /* For DP, use values from DSC_SLICE_CAP_1 and DSC_SLICE_CAP2 */
1513 u8 slice_cap2 = dsc_dpcd[DP_DSC_SLICE_CAP_2 - DP_DSC_SUPPORT];
1515 if (slice_cap2 & DP_DSC_24_PER_DP_DSC_SINK)
1517 if (slice_cap2 & DP_DSC_20_PER_DP_DSC_SINK)
1519 if (slice_cap2 & DP_DSC_16_PER_DP_DSC_SINK)
1521 if (slice_cap1 & DP_DSC_12_PER_DP_DSC_SINK)
1523 if (slice_cap1 & DP_DSC_10_PER_DP_DSC_SINK)
1525 if (slice_cap1 & DP_DSC_8_PER_DP_DSC_SINK)
1527 if (slice_cap1 & DP_DSC_6_PER_DP_DSC_SINK)
1529 if (slice_cap1 & DP_DSC_4_PER_DP_DSC_SINK)
1531 if (slice_cap1 & DP_DSC_2_PER_DP_DSC_SINK)
1533 if (slice_cap1 & DP_DSC_1_PER_DP_DSC_SINK)
1539 EXPORT_SYMBOL(drm_dp_dsc_sink_max_slice_count);
1542 * drm_dp_dsc_sink_line_buf_depth() - Get the line buffer depth in bits
1543 * @dsc_dpcd: DSC capabilities from DPCD
1545 * Read the DSC DPCD register to parse the line buffer depth in bits which is
1546 * number of bits of precision within the decoder line buffer supported by
1547 * the DSC sink. This is used to populate the DSC parameters in the
1548 * &struct drm_dsc_config by the driver.
1549 * Driver creates an infoframe using these parameters to populate
1550 * &struct drm_dsc_pps_infoframe. These are sent to the sink using DSC
1551 * infoframe using the helper function drm_dsc_pps_infoframe_pack()
1554 * Line buffer depth supported by DSC panel or 0 its invalid
1556 u8 drm_dp_dsc_sink_line_buf_depth(const u8 dsc_dpcd[DP_DSC_RECEIVER_CAP_SIZE])
1558 u8 line_buf_depth = dsc_dpcd[DP_DSC_LINE_BUF_BIT_DEPTH - DP_DSC_SUPPORT];
1560 switch (line_buf_depth & DP_DSC_LINE_BUF_BIT_DEPTH_MASK) {
1561 case DP_DSC_LINE_BUF_BIT_DEPTH_9:
1563 case DP_DSC_LINE_BUF_BIT_DEPTH_10:
1565 case DP_DSC_LINE_BUF_BIT_DEPTH_11:
1567 case DP_DSC_LINE_BUF_BIT_DEPTH_12:
1569 case DP_DSC_LINE_BUF_BIT_DEPTH_13:
1571 case DP_DSC_LINE_BUF_BIT_DEPTH_14:
1573 case DP_DSC_LINE_BUF_BIT_DEPTH_15:
1575 case DP_DSC_LINE_BUF_BIT_DEPTH_16:
1577 case DP_DSC_LINE_BUF_BIT_DEPTH_8:
1583 EXPORT_SYMBOL(drm_dp_dsc_sink_line_buf_depth);
1586 * drm_dp_dsc_sink_supported_input_bpcs() - Get all the input bits per component
1587 * values supported by the DSC sink.
1588 * @dsc_dpcd: DSC capabilities from DPCD
1589 * @dsc_bpc: An array to be filled by this helper with supported
1592 * Read the DSC DPCD from the sink device to parse the supported bits per
1593 * component values. This is used to populate the DSC parameters
1594 * in the &struct drm_dsc_config by the driver.
1595 * Driver creates an infoframe using these parameters to populate
1596 * &struct drm_dsc_pps_infoframe. These are sent to the sink using DSC
1597 * infoframe using the helper function drm_dsc_pps_infoframe_pack()
1600 * Number of input BPC values parsed from the DPCD
1602 int drm_dp_dsc_sink_supported_input_bpcs(const u8 dsc_dpcd[DP_DSC_RECEIVER_CAP_SIZE],
1606 u8 color_depth = dsc_dpcd[DP_DSC_DEC_COLOR_DEPTH_CAP - DP_DSC_SUPPORT];
1608 if (color_depth & DP_DSC_12_BPC)
1609 dsc_bpc[num_bpc++] = 12;
1610 if (color_depth & DP_DSC_10_BPC)
1611 dsc_bpc[num_bpc++] = 10;
1612 if (color_depth & DP_DSC_8_BPC)
1613 dsc_bpc[num_bpc++] = 8;
1617 EXPORT_SYMBOL(drm_dp_dsc_sink_supported_input_bpcs);
1620 * drm_dp_get_phy_test_pattern() - get the requested pattern from the sink.
1621 * @aux: DisplayPort AUX channel
1622 * @data: DP phy compliance test parameters.
1624 * Returns 0 on success or a negative error code on failure.
1626 int drm_dp_get_phy_test_pattern(struct drm_dp_aux *aux,
1627 struct drm_dp_phy_test_params *data)
1632 err = drm_dp_dpcd_readb(aux, DP_TEST_LINK_RATE, &rate);
1635 data->link_rate = drm_dp_bw_code_to_link_rate(rate);
1637 err = drm_dp_dpcd_readb(aux, DP_TEST_LANE_COUNT, &lanes);
1640 data->num_lanes = lanes & DP_MAX_LANE_COUNT_MASK;
1642 if (lanes & DP_ENHANCED_FRAME_CAP)
1643 data->enhanced_frame_cap = true;
1645 err = drm_dp_dpcd_readb(aux, DP_PHY_TEST_PATTERN, &data->phy_pattern);
1649 switch (data->phy_pattern) {
1650 case DP_PHY_TEST_PATTERN_80BIT_CUSTOM:
1651 err = drm_dp_dpcd_read(aux, DP_TEST_80BIT_CUSTOM_PATTERN_7_0,
1652 &data->custom80, sizeof(data->custom80));
1657 case DP_PHY_TEST_PATTERN_CP2520:
1658 err = drm_dp_dpcd_read(aux, DP_TEST_HBR2_SCRAMBLER_RESET,
1660 sizeof(data->hbr2_reset));
1667 EXPORT_SYMBOL(drm_dp_get_phy_test_pattern);
1670 * drm_dp_set_phy_test_pattern() - set the pattern to the sink.
1671 * @aux: DisplayPort AUX channel
1672 * @data: DP phy compliance test parameters.
1673 * @dp_rev: DP revision to use for compliance testing
1675 * Returns 0 on success or a negative error code on failure.
1677 int drm_dp_set_phy_test_pattern(struct drm_dp_aux *aux,
1678 struct drm_dp_phy_test_params *data, u8 dp_rev)
1684 link_config[0] = drm_dp_link_rate_to_bw_code(data->link_rate);
1685 link_config[1] = data->num_lanes;
1686 if (data->enhanced_frame_cap)
1687 link_config[1] |= DP_LANE_COUNT_ENHANCED_FRAME_EN;
1688 err = drm_dp_dpcd_write(aux, DP_LINK_BW_SET, link_config, 2);
1692 test_pattern = data->phy_pattern;
1693 if (dp_rev < 0x12) {
1694 test_pattern = (test_pattern << 2) &
1695 DP_LINK_QUAL_PATTERN_11_MASK;
1696 err = drm_dp_dpcd_writeb(aux, DP_TRAINING_PATTERN_SET,
1701 for (i = 0; i < data->num_lanes; i++) {
1702 err = drm_dp_dpcd_writeb(aux,
1703 DP_LINK_QUAL_LANE0_SET + i,
1712 EXPORT_SYMBOL(drm_dp_set_phy_test_pattern);
1714 static const char *dp_pixelformat_get_name(enum dp_pixelformat pixelformat)
1716 if (pixelformat < 0 || pixelformat > DP_PIXELFORMAT_RESERVED)
1719 switch (pixelformat) {
1720 case DP_PIXELFORMAT_RGB:
1722 case DP_PIXELFORMAT_YUV444:
1724 case DP_PIXELFORMAT_YUV422:
1726 case DP_PIXELFORMAT_YUV420:
1728 case DP_PIXELFORMAT_Y_ONLY:
1730 case DP_PIXELFORMAT_RAW:
1737 static const char *dp_colorimetry_get_name(enum dp_pixelformat pixelformat,
1738 enum dp_colorimetry colorimetry)
1740 if (pixelformat < 0 || pixelformat > DP_PIXELFORMAT_RESERVED)
1743 switch (colorimetry) {
1744 case DP_COLORIMETRY_DEFAULT:
1745 switch (pixelformat) {
1746 case DP_PIXELFORMAT_RGB:
1748 case DP_PIXELFORMAT_YUV444:
1749 case DP_PIXELFORMAT_YUV422:
1750 case DP_PIXELFORMAT_YUV420:
1752 case DP_PIXELFORMAT_Y_ONLY:
1753 return "DICOM PS3.14";
1754 case DP_PIXELFORMAT_RAW:
1755 return "Custom Color Profile";
1759 case DP_COLORIMETRY_RGB_WIDE_FIXED: /* and DP_COLORIMETRY_BT709_YCC */
1760 switch (pixelformat) {
1761 case DP_PIXELFORMAT_RGB:
1762 return "Wide Fixed";
1763 case DP_PIXELFORMAT_YUV444:
1764 case DP_PIXELFORMAT_YUV422:
1765 case DP_PIXELFORMAT_YUV420:
1770 case DP_COLORIMETRY_RGB_WIDE_FLOAT: /* and DP_COLORIMETRY_XVYCC_601 */
1771 switch (pixelformat) {
1772 case DP_PIXELFORMAT_RGB:
1773 return "Wide Float";
1774 case DP_PIXELFORMAT_YUV444:
1775 case DP_PIXELFORMAT_YUV422:
1776 case DP_PIXELFORMAT_YUV420:
1781 case DP_COLORIMETRY_OPRGB: /* and DP_COLORIMETRY_XVYCC_709 */
1782 switch (pixelformat) {
1783 case DP_PIXELFORMAT_RGB:
1785 case DP_PIXELFORMAT_YUV444:
1786 case DP_PIXELFORMAT_YUV422:
1787 case DP_PIXELFORMAT_YUV420:
1792 case DP_COLORIMETRY_DCI_P3_RGB: /* and DP_COLORIMETRY_SYCC_601 */
1793 switch (pixelformat) {
1794 case DP_PIXELFORMAT_RGB:
1796 case DP_PIXELFORMAT_YUV444:
1797 case DP_PIXELFORMAT_YUV422:
1798 case DP_PIXELFORMAT_YUV420:
1803 case DP_COLORIMETRY_RGB_CUSTOM: /* and DP_COLORIMETRY_OPYCC_601 */
1804 switch (pixelformat) {
1805 case DP_PIXELFORMAT_RGB:
1806 return "Custom Profile";
1807 case DP_PIXELFORMAT_YUV444:
1808 case DP_PIXELFORMAT_YUV422:
1809 case DP_PIXELFORMAT_YUV420:
1814 case DP_COLORIMETRY_BT2020_RGB: /* and DP_COLORIMETRY_BT2020_CYCC */
1815 switch (pixelformat) {
1816 case DP_PIXELFORMAT_RGB:
1817 return "BT.2020 RGB";
1818 case DP_PIXELFORMAT_YUV444:
1819 case DP_PIXELFORMAT_YUV422:
1820 case DP_PIXELFORMAT_YUV420:
1821 return "BT.2020 CYCC";
1825 case DP_COLORIMETRY_BT2020_YCC:
1826 switch (pixelformat) {
1827 case DP_PIXELFORMAT_YUV444:
1828 case DP_PIXELFORMAT_YUV422:
1829 case DP_PIXELFORMAT_YUV420:
1830 return "BT.2020 YCC";
1839 static const char *dp_dynamic_range_get_name(enum dp_dynamic_range dynamic_range)
1841 switch (dynamic_range) {
1842 case DP_DYNAMIC_RANGE_VESA:
1843 return "VESA range";
1844 case DP_DYNAMIC_RANGE_CTA:
1851 static const char *dp_content_type_get_name(enum dp_content_type content_type)
1853 switch (content_type) {
1854 case DP_CONTENT_TYPE_NOT_DEFINED:
1855 return "Not defined";
1856 case DP_CONTENT_TYPE_GRAPHICS:
1858 case DP_CONTENT_TYPE_PHOTO:
1860 case DP_CONTENT_TYPE_VIDEO:
1862 case DP_CONTENT_TYPE_GAME:
1869 void drm_dp_vsc_sdp_log(const char *level, struct device *dev,
1870 const struct drm_dp_vsc_sdp *vsc)
1872 #define DP_SDP_LOG(fmt, ...) dev_printk(level, dev, fmt, ##__VA_ARGS__)
1873 DP_SDP_LOG("DP SDP: %s, revision %u, length %u\n", "VSC",
1874 vsc->revision, vsc->length);
1875 DP_SDP_LOG(" pixelformat: %s\n",
1876 dp_pixelformat_get_name(vsc->pixelformat));
1877 DP_SDP_LOG(" colorimetry: %s\n",
1878 dp_colorimetry_get_name(vsc->pixelformat, vsc->colorimetry));
1879 DP_SDP_LOG(" bpc: %u\n", vsc->bpc);
1880 DP_SDP_LOG(" dynamic range: %s\n",
1881 dp_dynamic_range_get_name(vsc->dynamic_range));
1882 DP_SDP_LOG(" content type: %s\n",
1883 dp_content_type_get_name(vsc->content_type));
1886 EXPORT_SYMBOL(drm_dp_vsc_sdp_log);