2 * Copyright © 2014 Red Hat
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/bitfield.h>
24 #include <linux/delay.h>
25 #include <linux/errno.h>
26 #include <linux/i2c.h>
27 #include <linux/init.h>
28 #include <linux/kernel.h>
29 #include <linux/random.h>
30 #include <linux/sched.h>
31 #include <linux/seq_file.h>
32 #include <linux/iopoll.h>
34 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
35 #include <linux/stacktrace.h>
36 #include <linux/sort.h>
37 #include <linux/timekeeping.h>
38 #include <linux/math64.h>
41 #include <drm/drm_atomic.h>
42 #include <drm/drm_atomic_helper.h>
43 #include <drm/drm_dp_mst_helper.h>
44 #include <drm/drm_drv.h>
45 #include <drm/drm_print.h>
46 #include <drm/drm_probe_helper.h>
48 #include "drm_crtc_helper_internal.h"
49 #include "drm_dp_mst_topology_internal.h"
54 * These functions contain parts of the DisplayPort 1.2a MultiStream Transport
55 * protocol. The helpers contain a topology manager and bandwidth manager.
56 * The helpers encapsulate the sending and received of sideband msgs.
58 struct drm_dp_pending_up_req {
59 struct drm_dp_sideband_msg_hdr hdr;
60 struct drm_dp_sideband_msg_req_body msg;
61 struct list_head next;
64 static bool dump_dp_payload_table(struct drm_dp_mst_topology_mgr *mgr,
67 static void drm_dp_mst_topology_put_port(struct drm_dp_mst_port *port);
69 static int drm_dp_dpcd_write_payload(struct drm_dp_mst_topology_mgr *mgr,
71 struct drm_dp_payload *payload);
73 static int drm_dp_send_dpcd_read(struct drm_dp_mst_topology_mgr *mgr,
74 struct drm_dp_mst_port *port,
75 int offset, int size, u8 *bytes);
76 static int drm_dp_send_dpcd_write(struct drm_dp_mst_topology_mgr *mgr,
77 struct drm_dp_mst_port *port,
78 int offset, int size, u8 *bytes);
80 static int drm_dp_send_link_address(struct drm_dp_mst_topology_mgr *mgr,
81 struct drm_dp_mst_branch *mstb);
84 drm_dp_send_clear_payload_id_table(struct drm_dp_mst_topology_mgr *mgr,
85 struct drm_dp_mst_branch *mstb);
87 static int drm_dp_send_enum_path_resources(struct drm_dp_mst_topology_mgr *mgr,
88 struct drm_dp_mst_branch *mstb,
89 struct drm_dp_mst_port *port);
90 static bool drm_dp_validate_guid(struct drm_dp_mst_topology_mgr *mgr,
93 static int drm_dp_mst_register_i2c_bus(struct drm_dp_mst_port *port);
94 static void drm_dp_mst_unregister_i2c_bus(struct drm_dp_mst_port *port);
95 static void drm_dp_mst_kick_tx(struct drm_dp_mst_topology_mgr *mgr);
97 #define DBG_PREFIX "[dp_mst]"
99 #define DP_STR(x) [DP_ ## x] = #x
101 static const char *drm_dp_mst_req_type_str(u8 req_type)
103 static const char * const req_type_str[] = {
104 DP_STR(GET_MSG_TRANSACTION_VERSION),
105 DP_STR(LINK_ADDRESS),
106 DP_STR(CONNECTION_STATUS_NOTIFY),
107 DP_STR(ENUM_PATH_RESOURCES),
108 DP_STR(ALLOCATE_PAYLOAD),
109 DP_STR(QUERY_PAYLOAD),
110 DP_STR(RESOURCE_STATUS_NOTIFY),
111 DP_STR(CLEAR_PAYLOAD_ID_TABLE),
112 DP_STR(REMOTE_DPCD_READ),
113 DP_STR(REMOTE_DPCD_WRITE),
114 DP_STR(REMOTE_I2C_READ),
115 DP_STR(REMOTE_I2C_WRITE),
116 DP_STR(POWER_UP_PHY),
117 DP_STR(POWER_DOWN_PHY),
118 DP_STR(SINK_EVENT_NOTIFY),
119 DP_STR(QUERY_STREAM_ENC_STATUS),
122 if (req_type >= ARRAY_SIZE(req_type_str) ||
123 !req_type_str[req_type])
126 return req_type_str[req_type];
130 #define DP_STR(x) [DP_NAK_ ## x] = #x
132 static const char *drm_dp_mst_nak_reason_str(u8 nak_reason)
134 static const char * const nak_reason_str[] = {
135 DP_STR(WRITE_FAILURE),
136 DP_STR(INVALID_READ),
140 DP_STR(LINK_FAILURE),
141 DP_STR(NO_RESOURCES),
144 DP_STR(ALLOCATE_FAIL),
147 if (nak_reason >= ARRAY_SIZE(nak_reason_str) ||
148 !nak_reason_str[nak_reason])
151 return nak_reason_str[nak_reason];
155 #define DP_STR(x) [DRM_DP_SIDEBAND_TX_ ## x] = #x
157 static const char *drm_dp_mst_sideband_tx_state_str(int state)
159 static const char * const sideband_reason_str[] = {
167 if (state >= ARRAY_SIZE(sideband_reason_str) ||
168 !sideband_reason_str[state])
171 return sideband_reason_str[state];
175 drm_dp_mst_rad_to_str(const u8 rad[8], u8 lct, char *out, size_t len)
180 for (i = 0; i < lct; i++) {
182 unpacked_rad[i] = rad[i / 2] >> 4;
184 unpacked_rad[i] = rad[i / 2] & BIT_MASK(4);
187 /* TODO: Eventually add something to printk so we can format the rad
190 return snprintf(out, len, "%*phC", lct, unpacked_rad);
193 /* sideband msg handling */
194 static u8 drm_dp_msg_header_crc4(const uint8_t *data, size_t num_nibbles)
199 int number_of_bits = num_nibbles * 4;
202 while (number_of_bits != 0) {
205 remainder |= (data[array_index] & bitmask) >> bitshift;
213 if ((remainder & 0x10) == 0x10)
218 while (number_of_bits != 0) {
221 if ((remainder & 0x10) != 0)
228 static u8 drm_dp_msg_data_crc4(const uint8_t *data, u8 number_of_bytes)
233 int number_of_bits = number_of_bytes * 8;
236 while (number_of_bits != 0) {
239 remainder |= (data[array_index] & bitmask) >> bitshift;
247 if ((remainder & 0x100) == 0x100)
252 while (number_of_bits != 0) {
255 if ((remainder & 0x100) != 0)
259 return remainder & 0xff;
261 static inline u8 drm_dp_calc_sb_hdr_size(struct drm_dp_sideband_msg_hdr *hdr)
265 size += (hdr->lct / 2);
269 static void drm_dp_encode_sideband_msg_hdr(struct drm_dp_sideband_msg_hdr *hdr,
276 buf[idx++] = ((hdr->lct & 0xf) << 4) | (hdr->lcr & 0xf);
277 for (i = 0; i < (hdr->lct / 2); i++)
278 buf[idx++] = hdr->rad[i];
279 buf[idx++] = (hdr->broadcast << 7) | (hdr->path_msg << 6) |
280 (hdr->msg_len & 0x3f);
281 buf[idx++] = (hdr->somt << 7) | (hdr->eomt << 6) | (hdr->seqno << 4);
283 crc4 = drm_dp_msg_header_crc4(buf, (idx * 2) - 1);
284 buf[idx - 1] |= (crc4 & 0xf);
289 static bool drm_dp_decode_sideband_msg_hdr(struct drm_dp_sideband_msg_hdr *hdr,
290 u8 *buf, int buflen, u8 *hdrlen)
300 len += ((buf[0] & 0xf0) >> 4) / 2;
303 crc4 = drm_dp_msg_header_crc4(buf, (len * 2) - 1);
305 if ((crc4 & 0xf) != (buf[len - 1] & 0xf)) {
306 DRM_DEBUG_KMS("crc4 mismatch 0x%x 0x%x\n", crc4, buf[len - 1]);
310 hdr->lct = (buf[0] & 0xf0) >> 4;
311 hdr->lcr = (buf[0] & 0xf);
313 for (i = 0; i < (hdr->lct / 2); i++)
314 hdr->rad[i] = buf[idx++];
315 hdr->broadcast = (buf[idx] >> 7) & 0x1;
316 hdr->path_msg = (buf[idx] >> 6) & 0x1;
317 hdr->msg_len = buf[idx] & 0x3f;
319 hdr->somt = (buf[idx] >> 7) & 0x1;
320 hdr->eomt = (buf[idx] >> 6) & 0x1;
321 hdr->seqno = (buf[idx] >> 4) & 0x1;
328 drm_dp_encode_sideband_req(const struct drm_dp_sideband_msg_req_body *req,
329 struct drm_dp_sideband_msg_tx *raw)
335 buf[idx++] = req->req_type & 0x7f;
337 switch (req->req_type) {
338 case DP_ENUM_PATH_RESOURCES:
339 case DP_POWER_DOWN_PHY:
340 case DP_POWER_UP_PHY:
341 buf[idx] = (req->u.port_num.port_number & 0xf) << 4;
344 case DP_ALLOCATE_PAYLOAD:
345 buf[idx] = (req->u.allocate_payload.port_number & 0xf) << 4 |
346 (req->u.allocate_payload.number_sdp_streams & 0xf);
348 buf[idx] = (req->u.allocate_payload.vcpi & 0x7f);
350 buf[idx] = (req->u.allocate_payload.pbn >> 8);
352 buf[idx] = (req->u.allocate_payload.pbn & 0xff);
354 for (i = 0; i < req->u.allocate_payload.number_sdp_streams / 2; i++) {
355 buf[idx] = ((req->u.allocate_payload.sdp_stream_sink[i * 2] & 0xf) << 4) |
356 (req->u.allocate_payload.sdp_stream_sink[i * 2 + 1] & 0xf);
359 if (req->u.allocate_payload.number_sdp_streams & 1) {
360 i = req->u.allocate_payload.number_sdp_streams - 1;
361 buf[idx] = (req->u.allocate_payload.sdp_stream_sink[i] & 0xf) << 4;
365 case DP_QUERY_PAYLOAD:
366 buf[idx] = (req->u.query_payload.port_number & 0xf) << 4;
368 buf[idx] = (req->u.query_payload.vcpi & 0x7f);
371 case DP_REMOTE_DPCD_READ:
372 buf[idx] = (req->u.dpcd_read.port_number & 0xf) << 4;
373 buf[idx] |= ((req->u.dpcd_read.dpcd_address & 0xf0000) >> 16) & 0xf;
375 buf[idx] = (req->u.dpcd_read.dpcd_address & 0xff00) >> 8;
377 buf[idx] = (req->u.dpcd_read.dpcd_address & 0xff);
379 buf[idx] = (req->u.dpcd_read.num_bytes);
383 case DP_REMOTE_DPCD_WRITE:
384 buf[idx] = (req->u.dpcd_write.port_number & 0xf) << 4;
385 buf[idx] |= ((req->u.dpcd_write.dpcd_address & 0xf0000) >> 16) & 0xf;
387 buf[idx] = (req->u.dpcd_write.dpcd_address & 0xff00) >> 8;
389 buf[idx] = (req->u.dpcd_write.dpcd_address & 0xff);
391 buf[idx] = (req->u.dpcd_write.num_bytes);
393 memcpy(&buf[idx], req->u.dpcd_write.bytes, req->u.dpcd_write.num_bytes);
394 idx += req->u.dpcd_write.num_bytes;
396 case DP_REMOTE_I2C_READ:
397 buf[idx] = (req->u.i2c_read.port_number & 0xf) << 4;
398 buf[idx] |= (req->u.i2c_read.num_transactions & 0x3);
400 for (i = 0; i < (req->u.i2c_read.num_transactions & 0x3); i++) {
401 buf[idx] = req->u.i2c_read.transactions[i].i2c_dev_id & 0x7f;
403 buf[idx] = req->u.i2c_read.transactions[i].num_bytes;
405 memcpy(&buf[idx], req->u.i2c_read.transactions[i].bytes, req->u.i2c_read.transactions[i].num_bytes);
406 idx += req->u.i2c_read.transactions[i].num_bytes;
408 buf[idx] = (req->u.i2c_read.transactions[i].no_stop_bit & 0x1) << 4;
409 buf[idx] |= (req->u.i2c_read.transactions[i].i2c_transaction_delay & 0xf);
412 buf[idx] = (req->u.i2c_read.read_i2c_device_id) & 0x7f;
414 buf[idx] = (req->u.i2c_read.num_bytes_read);
418 case DP_REMOTE_I2C_WRITE:
419 buf[idx] = (req->u.i2c_write.port_number & 0xf) << 4;
421 buf[idx] = (req->u.i2c_write.write_i2c_device_id) & 0x7f;
423 buf[idx] = (req->u.i2c_write.num_bytes);
425 memcpy(&buf[idx], req->u.i2c_write.bytes, req->u.i2c_write.num_bytes);
426 idx += req->u.i2c_write.num_bytes;
428 case DP_QUERY_STREAM_ENC_STATUS: {
429 const struct drm_dp_query_stream_enc_status *msg;
431 msg = &req->u.enc_status;
432 buf[idx] = msg->stream_id;
434 memcpy(&buf[idx], msg->client_id, sizeof(msg->client_id));
435 idx += sizeof(msg->client_id);
437 buf[idx] |= FIELD_PREP(GENMASK(1, 0), msg->stream_event);
438 buf[idx] |= msg->valid_stream_event ? BIT(2) : 0;
439 buf[idx] |= FIELD_PREP(GENMASK(4, 3), msg->stream_behavior);
440 buf[idx] |= msg->valid_stream_behavior ? BIT(5) : 0;
447 EXPORT_SYMBOL_FOR_TESTS_ONLY(drm_dp_encode_sideband_req);
449 /* Decode a sideband request we've encoded, mainly used for debugging */
451 drm_dp_decode_sideband_req(const struct drm_dp_sideband_msg_tx *raw,
452 struct drm_dp_sideband_msg_req_body *req)
454 const u8 *buf = raw->msg;
457 req->req_type = buf[idx++] & 0x7f;
458 switch (req->req_type) {
459 case DP_ENUM_PATH_RESOURCES:
460 case DP_POWER_DOWN_PHY:
461 case DP_POWER_UP_PHY:
462 req->u.port_num.port_number = (buf[idx] >> 4) & 0xf;
464 case DP_ALLOCATE_PAYLOAD:
466 struct drm_dp_allocate_payload *a =
467 &req->u.allocate_payload;
469 a->number_sdp_streams = buf[idx] & 0xf;
470 a->port_number = (buf[idx] >> 4) & 0xf;
472 WARN_ON(buf[++idx] & 0x80);
473 a->vcpi = buf[idx] & 0x7f;
475 a->pbn = buf[++idx] << 8;
476 a->pbn |= buf[++idx];
479 for (i = 0; i < a->number_sdp_streams; i++) {
480 a->sdp_stream_sink[i] =
481 (buf[idx + (i / 2)] >> ((i % 2) ? 0 : 4)) & 0xf;
485 case DP_QUERY_PAYLOAD:
486 req->u.query_payload.port_number = (buf[idx] >> 4) & 0xf;
487 WARN_ON(buf[++idx] & 0x80);
488 req->u.query_payload.vcpi = buf[idx] & 0x7f;
490 case DP_REMOTE_DPCD_READ:
492 struct drm_dp_remote_dpcd_read *r = &req->u.dpcd_read;
494 r->port_number = (buf[idx] >> 4) & 0xf;
496 r->dpcd_address = (buf[idx] << 16) & 0xf0000;
497 r->dpcd_address |= (buf[++idx] << 8) & 0xff00;
498 r->dpcd_address |= buf[++idx] & 0xff;
500 r->num_bytes = buf[++idx];
503 case DP_REMOTE_DPCD_WRITE:
505 struct drm_dp_remote_dpcd_write *w =
508 w->port_number = (buf[idx] >> 4) & 0xf;
510 w->dpcd_address = (buf[idx] << 16) & 0xf0000;
511 w->dpcd_address |= (buf[++idx] << 8) & 0xff00;
512 w->dpcd_address |= buf[++idx] & 0xff;
514 w->num_bytes = buf[++idx];
516 w->bytes = kmemdup(&buf[++idx], w->num_bytes,
522 case DP_REMOTE_I2C_READ:
524 struct drm_dp_remote_i2c_read *r = &req->u.i2c_read;
525 struct drm_dp_remote_i2c_read_tx *tx;
528 r->num_transactions = buf[idx] & 0x3;
529 r->port_number = (buf[idx] >> 4) & 0xf;
530 for (i = 0; i < r->num_transactions; i++) {
531 tx = &r->transactions[i];
533 tx->i2c_dev_id = buf[++idx] & 0x7f;
534 tx->num_bytes = buf[++idx];
535 tx->bytes = kmemdup(&buf[++idx],
542 idx += tx->num_bytes;
543 tx->no_stop_bit = (buf[idx] >> 5) & 0x1;
544 tx->i2c_transaction_delay = buf[idx] & 0xf;
548 for (i = 0; i < r->num_transactions; i++) {
549 tx = &r->transactions[i];
555 r->read_i2c_device_id = buf[++idx] & 0x7f;
556 r->num_bytes_read = buf[++idx];
559 case DP_REMOTE_I2C_WRITE:
561 struct drm_dp_remote_i2c_write *w = &req->u.i2c_write;
563 w->port_number = (buf[idx] >> 4) & 0xf;
564 w->write_i2c_device_id = buf[++idx] & 0x7f;
565 w->num_bytes = buf[++idx];
566 w->bytes = kmemdup(&buf[++idx], w->num_bytes,
572 case DP_QUERY_STREAM_ENC_STATUS:
573 req->u.enc_status.stream_id = buf[idx++];
574 for (i = 0; i < sizeof(req->u.enc_status.client_id); i++)
575 req->u.enc_status.client_id[i] = buf[idx++];
577 req->u.enc_status.stream_event = FIELD_GET(GENMASK(1, 0),
579 req->u.enc_status.valid_stream_event = FIELD_GET(BIT(2),
581 req->u.enc_status.stream_behavior = FIELD_GET(GENMASK(4, 3),
583 req->u.enc_status.valid_stream_behavior = FIELD_GET(BIT(5),
590 EXPORT_SYMBOL_FOR_TESTS_ONLY(drm_dp_decode_sideband_req);
593 drm_dp_dump_sideband_msg_req_body(const struct drm_dp_sideband_msg_req_body *req,
594 int indent, struct drm_printer *printer)
598 #define P(f, ...) drm_printf_indent(printer, indent, f, ##__VA_ARGS__)
599 if (req->req_type == DP_LINK_ADDRESS) {
600 /* No contents to print */
601 P("type=%s\n", drm_dp_mst_req_type_str(req->req_type));
605 P("type=%s contents:\n", drm_dp_mst_req_type_str(req->req_type));
608 switch (req->req_type) {
609 case DP_ENUM_PATH_RESOURCES:
610 case DP_POWER_DOWN_PHY:
611 case DP_POWER_UP_PHY:
612 P("port=%d\n", req->u.port_num.port_number);
614 case DP_ALLOCATE_PAYLOAD:
615 P("port=%d vcpi=%d pbn=%d sdp_streams=%d %*ph\n",
616 req->u.allocate_payload.port_number,
617 req->u.allocate_payload.vcpi, req->u.allocate_payload.pbn,
618 req->u.allocate_payload.number_sdp_streams,
619 req->u.allocate_payload.number_sdp_streams,
620 req->u.allocate_payload.sdp_stream_sink);
622 case DP_QUERY_PAYLOAD:
623 P("port=%d vcpi=%d\n",
624 req->u.query_payload.port_number,
625 req->u.query_payload.vcpi);
627 case DP_REMOTE_DPCD_READ:
628 P("port=%d dpcd_addr=%05x len=%d\n",
629 req->u.dpcd_read.port_number, req->u.dpcd_read.dpcd_address,
630 req->u.dpcd_read.num_bytes);
632 case DP_REMOTE_DPCD_WRITE:
633 P("port=%d addr=%05x len=%d: %*ph\n",
634 req->u.dpcd_write.port_number,
635 req->u.dpcd_write.dpcd_address,
636 req->u.dpcd_write.num_bytes, req->u.dpcd_write.num_bytes,
637 req->u.dpcd_write.bytes);
639 case DP_REMOTE_I2C_READ:
640 P("port=%d num_tx=%d id=%d size=%d:\n",
641 req->u.i2c_read.port_number,
642 req->u.i2c_read.num_transactions,
643 req->u.i2c_read.read_i2c_device_id,
644 req->u.i2c_read.num_bytes_read);
647 for (i = 0; i < req->u.i2c_read.num_transactions; i++) {
648 const struct drm_dp_remote_i2c_read_tx *rtx =
649 &req->u.i2c_read.transactions[i];
651 P("%d: id=%03d size=%03d no_stop_bit=%d tx_delay=%03d: %*ph\n",
652 i, rtx->i2c_dev_id, rtx->num_bytes,
653 rtx->no_stop_bit, rtx->i2c_transaction_delay,
654 rtx->num_bytes, rtx->bytes);
657 case DP_REMOTE_I2C_WRITE:
658 P("port=%d id=%d size=%d: %*ph\n",
659 req->u.i2c_write.port_number,
660 req->u.i2c_write.write_i2c_device_id,
661 req->u.i2c_write.num_bytes, req->u.i2c_write.num_bytes,
662 req->u.i2c_write.bytes);
664 case DP_QUERY_STREAM_ENC_STATUS:
665 P("stream_id=%u client_id=%*ph stream_event=%x "
666 "valid_event=%d stream_behavior=%x valid_behavior=%d",
667 req->u.enc_status.stream_id,
668 (int)ARRAY_SIZE(req->u.enc_status.client_id),
669 req->u.enc_status.client_id, req->u.enc_status.stream_event,
670 req->u.enc_status.valid_stream_event,
671 req->u.enc_status.stream_behavior,
672 req->u.enc_status.valid_stream_behavior);
680 EXPORT_SYMBOL_FOR_TESTS_ONLY(drm_dp_dump_sideband_msg_req_body);
683 drm_dp_mst_dump_sideband_msg_tx(struct drm_printer *p,
684 const struct drm_dp_sideband_msg_tx *txmsg)
686 struct drm_dp_sideband_msg_req_body req;
691 drm_dp_mst_rad_to_str(txmsg->dst->rad, txmsg->dst->lct, buf,
693 drm_printf(p, "txmsg cur_offset=%x cur_len=%x seqno=%x state=%s path_msg=%d dst=%s\n",
694 txmsg->cur_offset, txmsg->cur_len, txmsg->seqno,
695 drm_dp_mst_sideband_tx_state_str(txmsg->state),
696 txmsg->path_msg, buf);
698 ret = drm_dp_decode_sideband_req(txmsg, &req);
700 drm_printf(p, "<failed to decode sideband req: %d>\n", ret);
703 drm_dp_dump_sideband_msg_req_body(&req, 1, p);
705 switch (req.req_type) {
706 case DP_REMOTE_DPCD_WRITE:
707 kfree(req.u.dpcd_write.bytes);
709 case DP_REMOTE_I2C_READ:
710 for (i = 0; i < req.u.i2c_read.num_transactions; i++)
711 kfree(req.u.i2c_read.transactions[i].bytes);
713 case DP_REMOTE_I2C_WRITE:
714 kfree(req.u.i2c_write.bytes);
719 static void drm_dp_crc_sideband_chunk_req(u8 *msg, u8 len)
723 crc4 = drm_dp_msg_data_crc4(msg, len);
727 static void drm_dp_encode_sideband_reply(struct drm_dp_sideband_msg_reply_body *rep,
728 struct drm_dp_sideband_msg_tx *raw)
733 buf[idx++] = (rep->reply_type & 0x1) << 7 | (rep->req_type & 0x7f);
738 static int drm_dp_sideband_msg_set_header(struct drm_dp_sideband_msg_rx *msg,
739 struct drm_dp_sideband_msg_hdr *hdr,
743 * ignore out-of-order messages or messages that are part of a
746 if (!hdr->somt && !msg->have_somt)
749 /* get length contained in this portion */
750 msg->curchunk_idx = 0;
751 msg->curchunk_len = hdr->msg_len;
752 msg->curchunk_hdrlen = hdrlen;
754 /* we have already gotten an somt - don't bother parsing */
755 if (hdr->somt && msg->have_somt)
759 memcpy(&msg->initial_hdr, hdr,
760 sizeof(struct drm_dp_sideband_msg_hdr));
761 msg->have_somt = true;
764 msg->have_eomt = true;
769 /* this adds a chunk of msg to the builder to get the final msg */
770 static bool drm_dp_sideband_append_payload(struct drm_dp_sideband_msg_rx *msg,
771 u8 *replybuf, u8 replybuflen)
775 memcpy(&msg->chunk[msg->curchunk_idx], replybuf, replybuflen);
776 msg->curchunk_idx += replybuflen;
778 if (msg->curchunk_idx >= msg->curchunk_len) {
780 crc4 = drm_dp_msg_data_crc4(msg->chunk, msg->curchunk_len - 1);
781 if (crc4 != msg->chunk[msg->curchunk_len - 1])
782 print_hex_dump(KERN_DEBUG, "wrong crc",
783 DUMP_PREFIX_NONE, 16, 1,
784 msg->chunk, msg->curchunk_len, false);
785 /* copy chunk into bigger msg */
786 memcpy(&msg->msg[msg->curlen], msg->chunk, msg->curchunk_len - 1);
787 msg->curlen += msg->curchunk_len - 1;
792 static bool drm_dp_sideband_parse_link_address(struct drm_dp_sideband_msg_rx *raw,
793 struct drm_dp_sideband_msg_reply_body *repmsg)
798 memcpy(repmsg->u.link_addr.guid, &raw->msg[idx], 16);
800 repmsg->u.link_addr.nports = raw->msg[idx] & 0xf;
802 if (idx > raw->curlen)
804 for (i = 0; i < repmsg->u.link_addr.nports; i++) {
805 if (raw->msg[idx] & 0x80)
806 repmsg->u.link_addr.ports[i].input_port = 1;
808 repmsg->u.link_addr.ports[i].peer_device_type = (raw->msg[idx] >> 4) & 0x7;
809 repmsg->u.link_addr.ports[i].port_number = (raw->msg[idx] & 0xf);
812 if (idx > raw->curlen)
814 repmsg->u.link_addr.ports[i].mcs = (raw->msg[idx] >> 7) & 0x1;
815 repmsg->u.link_addr.ports[i].ddps = (raw->msg[idx] >> 6) & 0x1;
816 if (repmsg->u.link_addr.ports[i].input_port == 0)
817 repmsg->u.link_addr.ports[i].legacy_device_plug_status = (raw->msg[idx] >> 5) & 0x1;
819 if (idx > raw->curlen)
821 if (repmsg->u.link_addr.ports[i].input_port == 0) {
822 repmsg->u.link_addr.ports[i].dpcd_revision = (raw->msg[idx]);
824 if (idx > raw->curlen)
826 memcpy(repmsg->u.link_addr.ports[i].peer_guid, &raw->msg[idx], 16);
828 if (idx > raw->curlen)
830 repmsg->u.link_addr.ports[i].num_sdp_streams = (raw->msg[idx] >> 4) & 0xf;
831 repmsg->u.link_addr.ports[i].num_sdp_stream_sinks = (raw->msg[idx] & 0xf);
835 if (idx > raw->curlen)
841 DRM_DEBUG_KMS("link address reply parse length fail %d %d\n", idx, raw->curlen);
845 static bool drm_dp_sideband_parse_remote_dpcd_read(struct drm_dp_sideband_msg_rx *raw,
846 struct drm_dp_sideband_msg_reply_body *repmsg)
850 repmsg->u.remote_dpcd_read_ack.port_number = raw->msg[idx] & 0xf;
852 if (idx > raw->curlen)
854 repmsg->u.remote_dpcd_read_ack.num_bytes = raw->msg[idx];
856 if (idx > raw->curlen)
859 memcpy(repmsg->u.remote_dpcd_read_ack.bytes, &raw->msg[idx], repmsg->u.remote_dpcd_read_ack.num_bytes);
862 DRM_DEBUG_KMS("link address reply parse length fail %d %d\n", idx, raw->curlen);
866 static bool drm_dp_sideband_parse_remote_dpcd_write(struct drm_dp_sideband_msg_rx *raw,
867 struct drm_dp_sideband_msg_reply_body *repmsg)
871 repmsg->u.remote_dpcd_write_ack.port_number = raw->msg[idx] & 0xf;
873 if (idx > raw->curlen)
877 DRM_DEBUG_KMS("parse length fail %d %d\n", idx, raw->curlen);
881 static bool drm_dp_sideband_parse_remote_i2c_read_ack(struct drm_dp_sideband_msg_rx *raw,
882 struct drm_dp_sideband_msg_reply_body *repmsg)
886 repmsg->u.remote_i2c_read_ack.port_number = (raw->msg[idx] & 0xf);
888 if (idx > raw->curlen)
890 repmsg->u.remote_i2c_read_ack.num_bytes = raw->msg[idx];
893 memcpy(repmsg->u.remote_i2c_read_ack.bytes, &raw->msg[idx], repmsg->u.remote_i2c_read_ack.num_bytes);
896 DRM_DEBUG_KMS("remote i2c reply parse length fail %d %d\n", idx, raw->curlen);
900 static bool drm_dp_sideband_parse_enum_path_resources_ack(struct drm_dp_sideband_msg_rx *raw,
901 struct drm_dp_sideband_msg_reply_body *repmsg)
905 repmsg->u.path_resources.port_number = (raw->msg[idx] >> 4) & 0xf;
906 repmsg->u.path_resources.fec_capable = raw->msg[idx] & 0x1;
908 if (idx > raw->curlen)
910 repmsg->u.path_resources.full_payload_bw_number = (raw->msg[idx] << 8) | (raw->msg[idx+1]);
912 if (idx > raw->curlen)
914 repmsg->u.path_resources.avail_payload_bw_number = (raw->msg[idx] << 8) | (raw->msg[idx+1]);
916 if (idx > raw->curlen)
920 DRM_DEBUG_KMS("enum resource parse length fail %d %d\n", idx, raw->curlen);
924 static bool drm_dp_sideband_parse_allocate_payload_ack(struct drm_dp_sideband_msg_rx *raw,
925 struct drm_dp_sideband_msg_reply_body *repmsg)
929 repmsg->u.allocate_payload.port_number = (raw->msg[idx] >> 4) & 0xf;
931 if (idx > raw->curlen)
933 repmsg->u.allocate_payload.vcpi = raw->msg[idx];
935 if (idx > raw->curlen)
937 repmsg->u.allocate_payload.allocated_pbn = (raw->msg[idx] << 8) | (raw->msg[idx+1]);
939 if (idx > raw->curlen)
943 DRM_DEBUG_KMS("allocate payload parse length fail %d %d\n", idx, raw->curlen);
947 static bool drm_dp_sideband_parse_query_payload_ack(struct drm_dp_sideband_msg_rx *raw,
948 struct drm_dp_sideband_msg_reply_body *repmsg)
952 repmsg->u.query_payload.port_number = (raw->msg[idx] >> 4) & 0xf;
954 if (idx > raw->curlen)
956 repmsg->u.query_payload.allocated_pbn = (raw->msg[idx] << 8) | (raw->msg[idx + 1]);
958 if (idx > raw->curlen)
962 DRM_DEBUG_KMS("query payload parse length fail %d %d\n", idx, raw->curlen);
966 static bool drm_dp_sideband_parse_power_updown_phy_ack(struct drm_dp_sideband_msg_rx *raw,
967 struct drm_dp_sideband_msg_reply_body *repmsg)
971 repmsg->u.port_number.port_number = (raw->msg[idx] >> 4) & 0xf;
973 if (idx > raw->curlen) {
974 DRM_DEBUG_KMS("power up/down phy parse length fail %d %d\n",
982 drm_dp_sideband_parse_query_stream_enc_status(
983 struct drm_dp_sideband_msg_rx *raw,
984 struct drm_dp_sideband_msg_reply_body *repmsg)
986 struct drm_dp_query_stream_enc_status_ack_reply *reply;
988 reply = &repmsg->u.enc_status;
990 reply->stream_id = raw->msg[3];
992 reply->reply_signed = raw->msg[2] & BIT(0);
995 * NOTE: It's my impression from reading the spec that the below parsing
996 * is correct. However I noticed while testing with an HDCP 1.4 display
997 * through an HDCP 2.2 hub that only bit 3 was set. In that case, I
998 * would expect both bits to be set. So keep the parsing following the
999 * spec, but beware reality might not match the spec (at least for some
1002 reply->hdcp_1x_device_present = raw->msg[2] & BIT(4);
1003 reply->hdcp_2x_device_present = raw->msg[2] & BIT(3);
1005 reply->query_capable_device_present = raw->msg[2] & BIT(5);
1006 reply->legacy_device_present = raw->msg[2] & BIT(6);
1007 reply->unauthorizable_device_present = raw->msg[2] & BIT(7);
1009 reply->auth_completed = !!(raw->msg[1] & BIT(3));
1010 reply->encryption_enabled = !!(raw->msg[1] & BIT(4));
1011 reply->repeater_present = !!(raw->msg[1] & BIT(5));
1012 reply->state = (raw->msg[1] & GENMASK(7, 6)) >> 6;
1017 static bool drm_dp_sideband_parse_reply(struct drm_dp_sideband_msg_rx *raw,
1018 struct drm_dp_sideband_msg_reply_body *msg)
1020 memset(msg, 0, sizeof(*msg));
1021 msg->reply_type = (raw->msg[0] & 0x80) >> 7;
1022 msg->req_type = (raw->msg[0] & 0x7f);
1024 if (msg->reply_type == DP_SIDEBAND_REPLY_NAK) {
1025 memcpy(msg->u.nak.guid, &raw->msg[1], 16);
1026 msg->u.nak.reason = raw->msg[17];
1027 msg->u.nak.nak_data = raw->msg[18];
1031 switch (msg->req_type) {
1032 case DP_LINK_ADDRESS:
1033 return drm_dp_sideband_parse_link_address(raw, msg);
1034 case DP_QUERY_PAYLOAD:
1035 return drm_dp_sideband_parse_query_payload_ack(raw, msg);
1036 case DP_REMOTE_DPCD_READ:
1037 return drm_dp_sideband_parse_remote_dpcd_read(raw, msg);
1038 case DP_REMOTE_DPCD_WRITE:
1039 return drm_dp_sideband_parse_remote_dpcd_write(raw, msg);
1040 case DP_REMOTE_I2C_READ:
1041 return drm_dp_sideband_parse_remote_i2c_read_ack(raw, msg);
1042 case DP_REMOTE_I2C_WRITE:
1043 return true; /* since there's nothing to parse */
1044 case DP_ENUM_PATH_RESOURCES:
1045 return drm_dp_sideband_parse_enum_path_resources_ack(raw, msg);
1046 case DP_ALLOCATE_PAYLOAD:
1047 return drm_dp_sideband_parse_allocate_payload_ack(raw, msg);
1048 case DP_POWER_DOWN_PHY:
1049 case DP_POWER_UP_PHY:
1050 return drm_dp_sideband_parse_power_updown_phy_ack(raw, msg);
1051 case DP_CLEAR_PAYLOAD_ID_TABLE:
1052 return true; /* since there's nothing to parse */
1053 case DP_QUERY_STREAM_ENC_STATUS:
1054 return drm_dp_sideband_parse_query_stream_enc_status(raw, msg);
1056 DRM_ERROR("Got unknown reply 0x%02x (%s)\n", msg->req_type,
1057 drm_dp_mst_req_type_str(msg->req_type));
1062 static bool drm_dp_sideband_parse_connection_status_notify(struct drm_dp_sideband_msg_rx *raw,
1063 struct drm_dp_sideband_msg_req_body *msg)
1067 msg->u.conn_stat.port_number = (raw->msg[idx] & 0xf0) >> 4;
1069 if (idx > raw->curlen)
1072 memcpy(msg->u.conn_stat.guid, &raw->msg[idx], 16);
1074 if (idx > raw->curlen)
1077 msg->u.conn_stat.legacy_device_plug_status = (raw->msg[idx] >> 6) & 0x1;
1078 msg->u.conn_stat.displayport_device_plug_status = (raw->msg[idx] >> 5) & 0x1;
1079 msg->u.conn_stat.message_capability_status = (raw->msg[idx] >> 4) & 0x1;
1080 msg->u.conn_stat.input_port = (raw->msg[idx] >> 3) & 0x1;
1081 msg->u.conn_stat.peer_device_type = (raw->msg[idx] & 0x7);
1085 DRM_DEBUG_KMS("connection status reply parse length fail %d %d\n", idx, raw->curlen);
1089 static bool drm_dp_sideband_parse_resource_status_notify(struct drm_dp_sideband_msg_rx *raw,
1090 struct drm_dp_sideband_msg_req_body *msg)
1094 msg->u.resource_stat.port_number = (raw->msg[idx] & 0xf0) >> 4;
1096 if (idx > raw->curlen)
1099 memcpy(msg->u.resource_stat.guid, &raw->msg[idx], 16);
1101 if (idx > raw->curlen)
1104 msg->u.resource_stat.available_pbn = (raw->msg[idx] << 8) | (raw->msg[idx + 1]);
1108 DRM_DEBUG_KMS("resource status reply parse length fail %d %d\n", idx, raw->curlen);
1112 static bool drm_dp_sideband_parse_req(struct drm_dp_sideband_msg_rx *raw,
1113 struct drm_dp_sideband_msg_req_body *msg)
1115 memset(msg, 0, sizeof(*msg));
1116 msg->req_type = (raw->msg[0] & 0x7f);
1118 switch (msg->req_type) {
1119 case DP_CONNECTION_STATUS_NOTIFY:
1120 return drm_dp_sideband_parse_connection_status_notify(raw, msg);
1121 case DP_RESOURCE_STATUS_NOTIFY:
1122 return drm_dp_sideband_parse_resource_status_notify(raw, msg);
1124 DRM_ERROR("Got unknown request 0x%02x (%s)\n", msg->req_type,
1125 drm_dp_mst_req_type_str(msg->req_type));
1130 static void build_dpcd_write(struct drm_dp_sideband_msg_tx *msg,
1131 u8 port_num, u32 offset, u8 num_bytes, u8 *bytes)
1133 struct drm_dp_sideband_msg_req_body req;
1135 req.req_type = DP_REMOTE_DPCD_WRITE;
1136 req.u.dpcd_write.port_number = port_num;
1137 req.u.dpcd_write.dpcd_address = offset;
1138 req.u.dpcd_write.num_bytes = num_bytes;
1139 req.u.dpcd_write.bytes = bytes;
1140 drm_dp_encode_sideband_req(&req, msg);
1143 static void build_link_address(struct drm_dp_sideband_msg_tx *msg)
1145 struct drm_dp_sideband_msg_req_body req;
1147 req.req_type = DP_LINK_ADDRESS;
1148 drm_dp_encode_sideband_req(&req, msg);
1151 static void build_clear_payload_id_table(struct drm_dp_sideband_msg_tx *msg)
1153 struct drm_dp_sideband_msg_req_body req;
1155 req.req_type = DP_CLEAR_PAYLOAD_ID_TABLE;
1156 drm_dp_encode_sideband_req(&req, msg);
1159 static int build_enum_path_resources(struct drm_dp_sideband_msg_tx *msg,
1162 struct drm_dp_sideband_msg_req_body req;
1164 req.req_type = DP_ENUM_PATH_RESOURCES;
1165 req.u.port_num.port_number = port_num;
1166 drm_dp_encode_sideband_req(&req, msg);
1167 msg->path_msg = true;
1171 static void build_allocate_payload(struct drm_dp_sideband_msg_tx *msg,
1173 u8 vcpi, uint16_t pbn,
1174 u8 number_sdp_streams,
1175 u8 *sdp_stream_sink)
1177 struct drm_dp_sideband_msg_req_body req;
1179 memset(&req, 0, sizeof(req));
1180 req.req_type = DP_ALLOCATE_PAYLOAD;
1181 req.u.allocate_payload.port_number = port_num;
1182 req.u.allocate_payload.vcpi = vcpi;
1183 req.u.allocate_payload.pbn = pbn;
1184 req.u.allocate_payload.number_sdp_streams = number_sdp_streams;
1185 memcpy(req.u.allocate_payload.sdp_stream_sink, sdp_stream_sink,
1186 number_sdp_streams);
1187 drm_dp_encode_sideband_req(&req, msg);
1188 msg->path_msg = true;
1191 static void build_power_updown_phy(struct drm_dp_sideband_msg_tx *msg,
1192 int port_num, bool power_up)
1194 struct drm_dp_sideband_msg_req_body req;
1197 req.req_type = DP_POWER_UP_PHY;
1199 req.req_type = DP_POWER_DOWN_PHY;
1201 req.u.port_num.port_number = port_num;
1202 drm_dp_encode_sideband_req(&req, msg);
1203 msg->path_msg = true;
1207 build_query_stream_enc_status(struct drm_dp_sideband_msg_tx *msg, u8 stream_id,
1210 struct drm_dp_sideband_msg_req_body req;
1212 req.req_type = DP_QUERY_STREAM_ENC_STATUS;
1213 req.u.enc_status.stream_id = stream_id;
1214 memcpy(req.u.enc_status.client_id, q_id,
1215 sizeof(req.u.enc_status.client_id));
1216 req.u.enc_status.stream_event = 0;
1217 req.u.enc_status.valid_stream_event = false;
1218 req.u.enc_status.stream_behavior = 0;
1219 req.u.enc_status.valid_stream_behavior = false;
1221 drm_dp_encode_sideband_req(&req, msg);
1225 static int drm_dp_mst_assign_payload_id(struct drm_dp_mst_topology_mgr *mgr,
1226 struct drm_dp_vcpi *vcpi)
1230 mutex_lock(&mgr->payload_lock);
1231 ret = find_first_zero_bit(&mgr->payload_mask, mgr->max_payloads + 1);
1232 if (ret > mgr->max_payloads) {
1234 DRM_DEBUG_KMS("out of payload ids %d\n", ret);
1238 vcpi_ret = find_first_zero_bit(&mgr->vcpi_mask, mgr->max_payloads + 1);
1239 if (vcpi_ret > mgr->max_payloads) {
1241 DRM_DEBUG_KMS("out of vcpi ids %d\n", ret);
1245 set_bit(ret, &mgr->payload_mask);
1246 set_bit(vcpi_ret, &mgr->vcpi_mask);
1247 vcpi->vcpi = vcpi_ret + 1;
1248 mgr->proposed_vcpis[ret - 1] = vcpi;
1250 mutex_unlock(&mgr->payload_lock);
1254 static void drm_dp_mst_put_payload_id(struct drm_dp_mst_topology_mgr *mgr,
1262 mutex_lock(&mgr->payload_lock);
1263 DRM_DEBUG_KMS("putting payload %d\n", vcpi);
1264 clear_bit(vcpi - 1, &mgr->vcpi_mask);
1266 for (i = 0; i < mgr->max_payloads; i++) {
1267 if (mgr->proposed_vcpis[i] &&
1268 mgr->proposed_vcpis[i]->vcpi == vcpi) {
1269 mgr->proposed_vcpis[i] = NULL;
1270 clear_bit(i + 1, &mgr->payload_mask);
1273 mutex_unlock(&mgr->payload_lock);
1276 static bool check_txmsg_state(struct drm_dp_mst_topology_mgr *mgr,
1277 struct drm_dp_sideband_msg_tx *txmsg)
1282 * All updates to txmsg->state are protected by mgr->qlock, and the two
1283 * cases we check here are terminal states. For those the barriers
1284 * provided by the wake_up/wait_event pair are enough.
1286 state = READ_ONCE(txmsg->state);
1287 return (state == DRM_DP_SIDEBAND_TX_RX ||
1288 state == DRM_DP_SIDEBAND_TX_TIMEOUT);
1291 static int drm_dp_mst_wait_tx_reply(struct drm_dp_mst_branch *mstb,
1292 struct drm_dp_sideband_msg_tx *txmsg)
1294 struct drm_dp_mst_topology_mgr *mgr = mstb->mgr;
1295 unsigned long wait_timeout = msecs_to_jiffies(4000);
1296 unsigned long wait_expires = jiffies + wait_timeout;
1301 * If the driver provides a way for this, change to
1302 * poll-waiting for the MST reply interrupt if we didn't receive
1303 * it for 50 msec. This would cater for cases where the HPD
1304 * pulse signal got lost somewhere, even though the sink raised
1305 * the corresponding MST interrupt correctly. One example is the
1306 * Club 3D CAC-1557 TypeC -> DP adapter which for some reason
1307 * filters out short pulses with a duration less than ~540 usec.
1309 * The poll period is 50 msec to avoid missing an interrupt
1310 * after the sink has cleared it (after a 110msec timeout
1311 * since it raised the interrupt).
1313 ret = wait_event_timeout(mgr->tx_waitq,
1314 check_txmsg_state(mgr, txmsg),
1315 mgr->cbs->poll_hpd_irq ?
1316 msecs_to_jiffies(50) :
1319 if (ret || !mgr->cbs->poll_hpd_irq ||
1320 time_after(jiffies, wait_expires))
1323 mgr->cbs->poll_hpd_irq(mgr);
1326 mutex_lock(&mgr->qlock);
1328 if (txmsg->state == DRM_DP_SIDEBAND_TX_TIMEOUT) {
1333 DRM_DEBUG_KMS("timedout msg send %p %d %d\n", txmsg, txmsg->state, txmsg->seqno);
1335 /* dump some state */
1339 if (txmsg->state == DRM_DP_SIDEBAND_TX_QUEUED ||
1340 txmsg->state == DRM_DP_SIDEBAND_TX_START_SEND ||
1341 txmsg->state == DRM_DP_SIDEBAND_TX_SENT)
1342 list_del(&txmsg->next);
1345 if (unlikely(ret == -EIO) && drm_debug_enabled(DRM_UT_DP)) {
1346 struct drm_printer p = drm_debug_printer(DBG_PREFIX);
1348 drm_dp_mst_dump_sideband_msg_tx(&p, txmsg);
1350 mutex_unlock(&mgr->qlock);
1352 drm_dp_mst_kick_tx(mgr);
1356 static struct drm_dp_mst_branch *drm_dp_add_mst_branch_device(u8 lct, u8 *rad)
1358 struct drm_dp_mst_branch *mstb;
1360 mstb = kzalloc(sizeof(*mstb), GFP_KERNEL);
1366 memcpy(mstb->rad, rad, lct / 2);
1367 INIT_LIST_HEAD(&mstb->ports);
1368 kref_init(&mstb->topology_kref);
1369 kref_init(&mstb->malloc_kref);
1373 static void drm_dp_free_mst_branch_device(struct kref *kref)
1375 struct drm_dp_mst_branch *mstb =
1376 container_of(kref, struct drm_dp_mst_branch, malloc_kref);
1378 if (mstb->port_parent)
1379 drm_dp_mst_put_port_malloc(mstb->port_parent);
1385 * DOC: Branch device and port refcounting
1387 * Topology refcount overview
1388 * ~~~~~~~~~~~~~~~~~~~~~~~~~~
1390 * The refcounting schemes for &struct drm_dp_mst_branch and &struct
1391 * drm_dp_mst_port are somewhat unusual. Both ports and branch devices have
1392 * two different kinds of refcounts: topology refcounts, and malloc refcounts.
1394 * Topology refcounts are not exposed to drivers, and are handled internally
1395 * by the DP MST helpers. The helpers use them in order to prevent the
1396 * in-memory topology state from being changed in the middle of critical
1397 * operations like changing the internal state of payload allocations. This
1398 * means each branch and port will be considered to be connected to the rest
1399 * of the topology until its topology refcount reaches zero. Additionally,
1400 * for ports this means that their associated &struct drm_connector will stay
1401 * registered with userspace until the port's refcount reaches 0.
1403 * Malloc refcount overview
1404 * ~~~~~~~~~~~~~~~~~~~~~~~~
1406 * Malloc references are used to keep a &struct drm_dp_mst_port or &struct
1407 * drm_dp_mst_branch allocated even after all of its topology references have
1408 * been dropped, so that the driver or MST helpers can safely access each
1409 * branch's last known state before it was disconnected from the topology.
1410 * When the malloc refcount of a port or branch reaches 0, the memory
1411 * allocation containing the &struct drm_dp_mst_branch or &struct
1412 * drm_dp_mst_port respectively will be freed.
1414 * For &struct drm_dp_mst_branch, malloc refcounts are not currently exposed
1415 * to drivers. As of writing this documentation, there are no drivers that
1416 * have a usecase for accessing &struct drm_dp_mst_branch outside of the MST
1417 * helpers. Exposing this API to drivers in a race-free manner would take more
1418 * tweaking of the refcounting scheme, however patches are welcome provided
1419 * there is a legitimate driver usecase for this.
1421 * Refcount relationships in a topology
1422 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1424 * Let's take a look at why the relationship between topology and malloc
1425 * refcounts is designed the way it is.
1427 * .. kernel-figure:: dp-mst/topology-figure-1.dot
1429 * An example of topology and malloc refs in a DP MST topology with two
1430 * active payloads. Topology refcount increments are indicated by solid
1431 * lines, and malloc refcount increments are indicated by dashed lines.
1432 * Each starts from the branch which incremented the refcount, and ends at
1433 * the branch to which the refcount belongs to, i.e. the arrow points the
1434 * same way as the C pointers used to reference a structure.
1436 * As you can see in the above figure, every branch increments the topology
1437 * refcount of its children, and increments the malloc refcount of its
1438 * parent. Additionally, every payload increments the malloc refcount of its
1439 * assigned port by 1.
1441 * So, what would happen if MSTB #3 from the above figure was unplugged from
1442 * the system, but the driver hadn't yet removed payload #2 from port #3? The
1443 * topology would start to look like the figure below.
1445 * .. kernel-figure:: dp-mst/topology-figure-2.dot
1447 * Ports and branch devices which have been released from memory are
1448 * colored grey, and references which have been removed are colored red.
1450 * Whenever a port or branch device's topology refcount reaches zero, it will
1451 * decrement the topology refcounts of all its children, the malloc refcount
1452 * of its parent, and finally its own malloc refcount. For MSTB #4 and port
1453 * #4, this means they both have been disconnected from the topology and freed
1454 * from memory. But, because payload #2 is still holding a reference to port
1455 * #3, port #3 is removed from the topology but its &struct drm_dp_mst_port
1456 * is still accessible from memory. This also means port #3 has not yet
1457 * decremented the malloc refcount of MSTB #3, so its &struct
1458 * drm_dp_mst_branch will also stay allocated in memory until port #3's
1459 * malloc refcount reaches 0.
1461 * This relationship is necessary because in order to release payload #2, we
1462 * need to be able to figure out the last relative of port #3 that's still
1463 * connected to the topology. In this case, we would travel up the topology as
1466 * .. kernel-figure:: dp-mst/topology-figure-3.dot
1468 * And finally, remove payload #2 by communicating with port #2 through
1469 * sideband transactions.
1473 * drm_dp_mst_get_mstb_malloc() - Increment the malloc refcount of a branch
1475 * @mstb: The &struct drm_dp_mst_branch to increment the malloc refcount of
1477 * Increments &drm_dp_mst_branch.malloc_kref. When
1478 * &drm_dp_mst_branch.malloc_kref reaches 0, the memory allocation for @mstb
1479 * will be released and @mstb may no longer be used.
1481 * See also: drm_dp_mst_put_mstb_malloc()
1484 drm_dp_mst_get_mstb_malloc(struct drm_dp_mst_branch *mstb)
1486 kref_get(&mstb->malloc_kref);
1487 DRM_DEBUG("mstb %p (%d)\n", mstb, kref_read(&mstb->malloc_kref));
1491 * drm_dp_mst_put_mstb_malloc() - Decrement the malloc refcount of a branch
1493 * @mstb: The &struct drm_dp_mst_branch to decrement the malloc refcount of
1495 * Decrements &drm_dp_mst_branch.malloc_kref. When
1496 * &drm_dp_mst_branch.malloc_kref reaches 0, the memory allocation for @mstb
1497 * will be released and @mstb may no longer be used.
1499 * See also: drm_dp_mst_get_mstb_malloc()
1502 drm_dp_mst_put_mstb_malloc(struct drm_dp_mst_branch *mstb)
1504 DRM_DEBUG("mstb %p (%d)\n", mstb, kref_read(&mstb->malloc_kref) - 1);
1505 kref_put(&mstb->malloc_kref, drm_dp_free_mst_branch_device);
1508 static void drm_dp_free_mst_port(struct kref *kref)
1510 struct drm_dp_mst_port *port =
1511 container_of(kref, struct drm_dp_mst_port, malloc_kref);
1513 drm_dp_mst_put_mstb_malloc(port->parent);
1518 * drm_dp_mst_get_port_malloc() - Increment the malloc refcount of an MST port
1519 * @port: The &struct drm_dp_mst_port to increment the malloc refcount of
1521 * Increments &drm_dp_mst_port.malloc_kref. When &drm_dp_mst_port.malloc_kref
1522 * reaches 0, the memory allocation for @port will be released and @port may
1523 * no longer be used.
1525 * Because @port could potentially be freed at any time by the DP MST helpers
1526 * if &drm_dp_mst_port.malloc_kref reaches 0, including during a call to this
1527 * function, drivers that which to make use of &struct drm_dp_mst_port should
1528 * ensure that they grab at least one main malloc reference to their MST ports
1529 * in &drm_dp_mst_topology_cbs.add_connector. This callback is called before
1530 * there is any chance for &drm_dp_mst_port.malloc_kref to reach 0.
1532 * See also: drm_dp_mst_put_port_malloc()
1535 drm_dp_mst_get_port_malloc(struct drm_dp_mst_port *port)
1537 kref_get(&port->malloc_kref);
1538 DRM_DEBUG("port %p (%d)\n", port, kref_read(&port->malloc_kref));
1540 EXPORT_SYMBOL(drm_dp_mst_get_port_malloc);
1543 * drm_dp_mst_put_port_malloc() - Decrement the malloc refcount of an MST port
1544 * @port: The &struct drm_dp_mst_port to decrement the malloc refcount of
1546 * Decrements &drm_dp_mst_port.malloc_kref. When &drm_dp_mst_port.malloc_kref
1547 * reaches 0, the memory allocation for @port will be released and @port may
1548 * no longer be used.
1550 * See also: drm_dp_mst_get_port_malloc()
1553 drm_dp_mst_put_port_malloc(struct drm_dp_mst_port *port)
1555 DRM_DEBUG("port %p (%d)\n", port, kref_read(&port->malloc_kref) - 1);
1556 kref_put(&port->malloc_kref, drm_dp_free_mst_port);
1558 EXPORT_SYMBOL(drm_dp_mst_put_port_malloc);
1560 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
1562 #define STACK_DEPTH 8
1564 static noinline void
1565 __topology_ref_save(struct drm_dp_mst_topology_mgr *mgr,
1566 struct drm_dp_mst_topology_ref_history *history,
1567 enum drm_dp_mst_topology_ref_type type)
1569 struct drm_dp_mst_topology_ref_entry *entry = NULL;
1570 depot_stack_handle_t backtrace;
1571 ulong stack_entries[STACK_DEPTH];
1575 n = stack_trace_save(stack_entries, ARRAY_SIZE(stack_entries), 1);
1576 backtrace = stack_depot_save(stack_entries, n, GFP_KERNEL);
1580 /* Try to find an existing entry for this backtrace */
1581 for (i = 0; i < history->len; i++) {
1582 if (history->entries[i].backtrace == backtrace) {
1583 entry = &history->entries[i];
1588 /* Otherwise add one */
1590 struct drm_dp_mst_topology_ref_entry *new;
1591 int new_len = history->len + 1;
1593 new = krealloc(history->entries, sizeof(*new) * new_len,
1598 entry = &new[history->len];
1599 history->len = new_len;
1600 history->entries = new;
1602 entry->backtrace = backtrace;
1607 entry->ts_nsec = ktime_get_ns();
1611 topology_ref_history_cmp(const void *a, const void *b)
1613 const struct drm_dp_mst_topology_ref_entry *entry_a = a, *entry_b = b;
1615 if (entry_a->ts_nsec > entry_b->ts_nsec)
1617 else if (entry_a->ts_nsec < entry_b->ts_nsec)
1623 static inline const char *
1624 topology_ref_type_to_str(enum drm_dp_mst_topology_ref_type type)
1626 if (type == DRM_DP_MST_TOPOLOGY_REF_GET)
1633 __dump_topology_ref_history(struct drm_dp_mst_topology_ref_history *history,
1634 void *ptr, const char *type_str)
1636 struct drm_printer p = drm_debug_printer(DBG_PREFIX);
1637 char *buf = kzalloc(PAGE_SIZE, GFP_KERNEL);
1646 /* First, sort the list so that it goes from oldest to newest
1649 sort(history->entries, history->len, sizeof(*history->entries),
1650 topology_ref_history_cmp, NULL);
1652 drm_printf(&p, "%s (%p) topology count reached 0, dumping history:\n",
1655 for (i = 0; i < history->len; i++) {
1656 const struct drm_dp_mst_topology_ref_entry *entry =
1657 &history->entries[i];
1660 u64 ts_nsec = entry->ts_nsec;
1661 u32 rem_nsec = do_div(ts_nsec, 1000000000);
1663 nr_entries = stack_depot_fetch(entry->backtrace, &entries);
1664 stack_trace_snprint(buf, PAGE_SIZE, entries, nr_entries, 4);
1666 drm_printf(&p, " %d %ss (last at %5llu.%06u):\n%s",
1668 topology_ref_type_to_str(entry->type),
1669 ts_nsec, rem_nsec / 1000, buf);
1672 /* Now free the history, since this is the only time we expose it */
1673 kfree(history->entries);
1678 static __always_inline void
1679 drm_dp_mst_dump_mstb_topology_history(struct drm_dp_mst_branch *mstb)
1681 __dump_topology_ref_history(&mstb->topology_ref_history, mstb,
1685 static __always_inline void
1686 drm_dp_mst_dump_port_topology_history(struct drm_dp_mst_port *port)
1688 __dump_topology_ref_history(&port->topology_ref_history, port,
1692 static __always_inline void
1693 save_mstb_topology_ref(struct drm_dp_mst_branch *mstb,
1694 enum drm_dp_mst_topology_ref_type type)
1696 __topology_ref_save(mstb->mgr, &mstb->topology_ref_history, type);
1699 static __always_inline void
1700 save_port_topology_ref(struct drm_dp_mst_port *port,
1701 enum drm_dp_mst_topology_ref_type type)
1703 __topology_ref_save(port->mgr, &port->topology_ref_history, type);
1707 topology_ref_history_lock(struct drm_dp_mst_topology_mgr *mgr)
1709 mutex_lock(&mgr->topology_ref_history_lock);
1713 topology_ref_history_unlock(struct drm_dp_mst_topology_mgr *mgr)
1715 mutex_unlock(&mgr->topology_ref_history_lock);
1719 topology_ref_history_lock(struct drm_dp_mst_topology_mgr *mgr) {}
1721 topology_ref_history_unlock(struct drm_dp_mst_topology_mgr *mgr) {}
1723 drm_dp_mst_dump_mstb_topology_history(struct drm_dp_mst_branch *mstb) {}
1725 drm_dp_mst_dump_port_topology_history(struct drm_dp_mst_port *port) {}
1726 #define save_mstb_topology_ref(mstb, type)
1727 #define save_port_topology_ref(port, type)
1730 static void drm_dp_destroy_mst_branch_device(struct kref *kref)
1732 struct drm_dp_mst_branch *mstb =
1733 container_of(kref, struct drm_dp_mst_branch, topology_kref);
1734 struct drm_dp_mst_topology_mgr *mgr = mstb->mgr;
1736 drm_dp_mst_dump_mstb_topology_history(mstb);
1738 INIT_LIST_HEAD(&mstb->destroy_next);
1741 * This can get called under mgr->mutex, so we need to perform the
1742 * actual destruction of the mstb in another worker
1744 mutex_lock(&mgr->delayed_destroy_lock);
1745 list_add(&mstb->destroy_next, &mgr->destroy_branch_device_list);
1746 mutex_unlock(&mgr->delayed_destroy_lock);
1747 queue_work(mgr->delayed_destroy_wq, &mgr->delayed_destroy_work);
1751 * drm_dp_mst_topology_try_get_mstb() - Increment the topology refcount of a
1752 * branch device unless it's zero
1753 * @mstb: &struct drm_dp_mst_branch to increment the topology refcount of
1755 * Attempts to grab a topology reference to @mstb, if it hasn't yet been
1756 * removed from the topology (e.g. &drm_dp_mst_branch.topology_kref has
1757 * reached 0). Holding a topology reference implies that a malloc reference
1758 * will be held to @mstb as long as the user holds the topology reference.
1760 * Care should be taken to ensure that the user has at least one malloc
1761 * reference to @mstb. If you already have a topology reference to @mstb, you
1762 * should use drm_dp_mst_topology_get_mstb() instead.
1765 * drm_dp_mst_topology_get_mstb()
1766 * drm_dp_mst_topology_put_mstb()
1769 * * 1: A topology reference was grabbed successfully
1770 * * 0: @port is no longer in the topology, no reference was grabbed
1772 static int __must_check
1773 drm_dp_mst_topology_try_get_mstb(struct drm_dp_mst_branch *mstb)
1777 topology_ref_history_lock(mstb->mgr);
1778 ret = kref_get_unless_zero(&mstb->topology_kref);
1780 DRM_DEBUG("mstb %p (%d)\n",
1781 mstb, kref_read(&mstb->topology_kref));
1782 save_mstb_topology_ref(mstb, DRM_DP_MST_TOPOLOGY_REF_GET);
1785 topology_ref_history_unlock(mstb->mgr);
1791 * drm_dp_mst_topology_get_mstb() - Increment the topology refcount of a
1793 * @mstb: The &struct drm_dp_mst_branch to increment the topology refcount of
1795 * Increments &drm_dp_mst_branch.topology_refcount without checking whether or
1796 * not it's already reached 0. This is only valid to use in scenarios where
1797 * you are already guaranteed to have at least one active topology reference
1798 * to @mstb. Otherwise, drm_dp_mst_topology_try_get_mstb() must be used.
1801 * drm_dp_mst_topology_try_get_mstb()
1802 * drm_dp_mst_topology_put_mstb()
1804 static void drm_dp_mst_topology_get_mstb(struct drm_dp_mst_branch *mstb)
1806 topology_ref_history_lock(mstb->mgr);
1808 save_mstb_topology_ref(mstb, DRM_DP_MST_TOPOLOGY_REF_GET);
1809 WARN_ON(kref_read(&mstb->topology_kref) == 0);
1810 kref_get(&mstb->topology_kref);
1811 DRM_DEBUG("mstb %p (%d)\n", mstb, kref_read(&mstb->topology_kref));
1813 topology_ref_history_unlock(mstb->mgr);
1817 * drm_dp_mst_topology_put_mstb() - release a topology reference to a branch
1819 * @mstb: The &struct drm_dp_mst_branch to release the topology reference from
1821 * Releases a topology reference from @mstb by decrementing
1822 * &drm_dp_mst_branch.topology_kref.
1825 * drm_dp_mst_topology_try_get_mstb()
1826 * drm_dp_mst_topology_get_mstb()
1829 drm_dp_mst_topology_put_mstb(struct drm_dp_mst_branch *mstb)
1831 topology_ref_history_lock(mstb->mgr);
1833 DRM_DEBUG("mstb %p (%d)\n",
1834 mstb, kref_read(&mstb->topology_kref) - 1);
1835 save_mstb_topology_ref(mstb, DRM_DP_MST_TOPOLOGY_REF_PUT);
1837 topology_ref_history_unlock(mstb->mgr);
1838 kref_put(&mstb->topology_kref, drm_dp_destroy_mst_branch_device);
1841 static void drm_dp_destroy_port(struct kref *kref)
1843 struct drm_dp_mst_port *port =
1844 container_of(kref, struct drm_dp_mst_port, topology_kref);
1845 struct drm_dp_mst_topology_mgr *mgr = port->mgr;
1847 drm_dp_mst_dump_port_topology_history(port);
1849 /* There's nothing that needs locking to destroy an input port yet */
1851 drm_dp_mst_put_port_malloc(port);
1855 kfree(port->cached_edid);
1858 * we can't destroy the connector here, as we might be holding the
1859 * mode_config.mutex from an EDID retrieval
1861 mutex_lock(&mgr->delayed_destroy_lock);
1862 list_add(&port->next, &mgr->destroy_port_list);
1863 mutex_unlock(&mgr->delayed_destroy_lock);
1864 queue_work(mgr->delayed_destroy_wq, &mgr->delayed_destroy_work);
1868 * drm_dp_mst_topology_try_get_port() - Increment the topology refcount of a
1869 * port unless it's zero
1870 * @port: &struct drm_dp_mst_port to increment the topology refcount of
1872 * Attempts to grab a topology reference to @port, if it hasn't yet been
1873 * removed from the topology (e.g. &drm_dp_mst_port.topology_kref has reached
1874 * 0). Holding a topology reference implies that a malloc reference will be
1875 * held to @port as long as the user holds the topology reference.
1877 * Care should be taken to ensure that the user has at least one malloc
1878 * reference to @port. If you already have a topology reference to @port, you
1879 * should use drm_dp_mst_topology_get_port() instead.
1882 * drm_dp_mst_topology_get_port()
1883 * drm_dp_mst_topology_put_port()
1886 * * 1: A topology reference was grabbed successfully
1887 * * 0: @port is no longer in the topology, no reference was grabbed
1889 static int __must_check
1890 drm_dp_mst_topology_try_get_port(struct drm_dp_mst_port *port)
1894 topology_ref_history_lock(port->mgr);
1895 ret = kref_get_unless_zero(&port->topology_kref);
1897 DRM_DEBUG("port %p (%d)\n",
1898 port, kref_read(&port->topology_kref));
1899 save_port_topology_ref(port, DRM_DP_MST_TOPOLOGY_REF_GET);
1902 topology_ref_history_unlock(port->mgr);
1907 * drm_dp_mst_topology_get_port() - Increment the topology refcount of a port
1908 * @port: The &struct drm_dp_mst_port to increment the topology refcount of
1910 * Increments &drm_dp_mst_port.topology_refcount without checking whether or
1911 * not it's already reached 0. This is only valid to use in scenarios where
1912 * you are already guaranteed to have at least one active topology reference
1913 * to @port. Otherwise, drm_dp_mst_topology_try_get_port() must be used.
1916 * drm_dp_mst_topology_try_get_port()
1917 * drm_dp_mst_topology_put_port()
1919 static void drm_dp_mst_topology_get_port(struct drm_dp_mst_port *port)
1921 topology_ref_history_lock(port->mgr);
1923 WARN_ON(kref_read(&port->topology_kref) == 0);
1924 kref_get(&port->topology_kref);
1925 DRM_DEBUG("port %p (%d)\n", port, kref_read(&port->topology_kref));
1926 save_port_topology_ref(port, DRM_DP_MST_TOPOLOGY_REF_GET);
1928 topology_ref_history_unlock(port->mgr);
1932 * drm_dp_mst_topology_put_port() - release a topology reference to a port
1933 * @port: The &struct drm_dp_mst_port to release the topology reference from
1935 * Releases a topology reference from @port by decrementing
1936 * &drm_dp_mst_port.topology_kref.
1939 * drm_dp_mst_topology_try_get_port()
1940 * drm_dp_mst_topology_get_port()
1942 static void drm_dp_mst_topology_put_port(struct drm_dp_mst_port *port)
1944 topology_ref_history_lock(port->mgr);
1946 DRM_DEBUG("port %p (%d)\n",
1947 port, kref_read(&port->topology_kref) - 1);
1948 save_port_topology_ref(port, DRM_DP_MST_TOPOLOGY_REF_PUT);
1950 topology_ref_history_unlock(port->mgr);
1951 kref_put(&port->topology_kref, drm_dp_destroy_port);
1954 static struct drm_dp_mst_branch *
1955 drm_dp_mst_topology_get_mstb_validated_locked(struct drm_dp_mst_branch *mstb,
1956 struct drm_dp_mst_branch *to_find)
1958 struct drm_dp_mst_port *port;
1959 struct drm_dp_mst_branch *rmstb;
1961 if (to_find == mstb)
1964 list_for_each_entry(port, &mstb->ports, next) {
1966 rmstb = drm_dp_mst_topology_get_mstb_validated_locked(
1967 port->mstb, to_find);
1975 static struct drm_dp_mst_branch *
1976 drm_dp_mst_topology_get_mstb_validated(struct drm_dp_mst_topology_mgr *mgr,
1977 struct drm_dp_mst_branch *mstb)
1979 struct drm_dp_mst_branch *rmstb = NULL;
1981 mutex_lock(&mgr->lock);
1982 if (mgr->mst_primary) {
1983 rmstb = drm_dp_mst_topology_get_mstb_validated_locked(
1984 mgr->mst_primary, mstb);
1986 if (rmstb && !drm_dp_mst_topology_try_get_mstb(rmstb))
1989 mutex_unlock(&mgr->lock);
1993 static struct drm_dp_mst_port *
1994 drm_dp_mst_topology_get_port_validated_locked(struct drm_dp_mst_branch *mstb,
1995 struct drm_dp_mst_port *to_find)
1997 struct drm_dp_mst_port *port, *mport;
1999 list_for_each_entry(port, &mstb->ports, next) {
2000 if (port == to_find)
2004 mport = drm_dp_mst_topology_get_port_validated_locked(
2005 port->mstb, to_find);
2013 static struct drm_dp_mst_port *
2014 drm_dp_mst_topology_get_port_validated(struct drm_dp_mst_topology_mgr *mgr,
2015 struct drm_dp_mst_port *port)
2017 struct drm_dp_mst_port *rport = NULL;
2019 mutex_lock(&mgr->lock);
2020 if (mgr->mst_primary) {
2021 rport = drm_dp_mst_topology_get_port_validated_locked(
2022 mgr->mst_primary, port);
2024 if (rport && !drm_dp_mst_topology_try_get_port(rport))
2027 mutex_unlock(&mgr->lock);
2031 static struct drm_dp_mst_port *drm_dp_get_port(struct drm_dp_mst_branch *mstb, u8 port_num)
2033 struct drm_dp_mst_port *port;
2036 list_for_each_entry(port, &mstb->ports, next) {
2037 if (port->port_num == port_num) {
2038 ret = drm_dp_mst_topology_try_get_port(port);
2039 return ret ? port : NULL;
2047 * calculate a new RAD for this MST branch device
2048 * if parent has an LCT of 2 then it has 1 nibble of RAD,
2049 * if parent has an LCT of 3 then it has 2 nibbles of RAD,
2051 static u8 drm_dp_calculate_rad(struct drm_dp_mst_port *port,
2054 int parent_lct = port->parent->lct;
2056 int idx = (parent_lct - 1) / 2;
2058 if (parent_lct > 1) {
2059 memcpy(rad, port->parent->rad, idx + 1);
2060 shift = (parent_lct % 2) ? 4 : 0;
2064 rad[idx] |= port->port_num << shift;
2065 return parent_lct + 1;
2068 static bool drm_dp_mst_is_end_device(u8 pdt, bool mcs)
2071 case DP_PEER_DEVICE_DP_LEGACY_CONV:
2072 case DP_PEER_DEVICE_SST_SINK:
2074 case DP_PEER_DEVICE_MST_BRANCHING:
2075 /* For sst branch device */
2085 drm_dp_port_set_pdt(struct drm_dp_mst_port *port, u8 new_pdt,
2088 struct drm_dp_mst_topology_mgr *mgr = port->mgr;
2089 struct drm_dp_mst_branch *mstb;
2093 if (port->pdt == new_pdt && port->mcs == new_mcs)
2096 /* Teardown the old pdt, if there is one */
2097 if (port->pdt != DP_PEER_DEVICE_NONE) {
2098 if (drm_dp_mst_is_end_device(port->pdt, port->mcs)) {
2100 * If the new PDT would also have an i2c bus,
2101 * don't bother with reregistering it
2103 if (new_pdt != DP_PEER_DEVICE_NONE &&
2104 drm_dp_mst_is_end_device(new_pdt, new_mcs)) {
2105 port->pdt = new_pdt;
2106 port->mcs = new_mcs;
2110 /* remove i2c over sideband */
2111 drm_dp_mst_unregister_i2c_bus(port);
2113 mutex_lock(&mgr->lock);
2114 drm_dp_mst_topology_put_mstb(port->mstb);
2116 mutex_unlock(&mgr->lock);
2120 port->pdt = new_pdt;
2121 port->mcs = new_mcs;
2123 if (port->pdt != DP_PEER_DEVICE_NONE) {
2124 if (drm_dp_mst_is_end_device(port->pdt, port->mcs)) {
2125 /* add i2c over sideband */
2126 ret = drm_dp_mst_register_i2c_bus(port);
2128 lct = drm_dp_calculate_rad(port, rad);
2129 mstb = drm_dp_add_mst_branch_device(lct, rad);
2132 DRM_ERROR("Failed to create MSTB for port %p",
2137 mutex_lock(&mgr->lock);
2139 mstb->mgr = port->mgr;
2140 mstb->port_parent = port;
2143 * Make sure this port's memory allocation stays
2144 * around until its child MSTB releases it
2146 drm_dp_mst_get_port_malloc(port);
2147 mutex_unlock(&mgr->lock);
2149 /* And make sure we send a link address for this */
2156 port->pdt = DP_PEER_DEVICE_NONE;
2161 * drm_dp_mst_dpcd_read() - read a series of bytes from the DPCD via sideband
2162 * @aux: Fake sideband AUX CH
2163 * @offset: address of the (first) register to read
2164 * @buffer: buffer to store the register values
2165 * @size: number of bytes in @buffer
2167 * Performs the same functionality for remote devices via
2168 * sideband messaging as drm_dp_dpcd_read() does for local
2169 * devices via actual AUX CH.
2171 * Return: Number of bytes read, or negative error code on failure.
2173 ssize_t drm_dp_mst_dpcd_read(struct drm_dp_aux *aux,
2174 unsigned int offset, void *buffer, size_t size)
2176 struct drm_dp_mst_port *port = container_of(aux, struct drm_dp_mst_port,
2179 return drm_dp_send_dpcd_read(port->mgr, port,
2180 offset, size, buffer);
2184 * drm_dp_mst_dpcd_write() - write a series of bytes to the DPCD via sideband
2185 * @aux: Fake sideband AUX CH
2186 * @offset: address of the (first) register to write
2187 * @buffer: buffer containing the values to write
2188 * @size: number of bytes in @buffer
2190 * Performs the same functionality for remote devices via
2191 * sideband messaging as drm_dp_dpcd_write() does for local
2192 * devices via actual AUX CH.
2194 * Return: number of bytes written on success, negative error code on failure.
2196 ssize_t drm_dp_mst_dpcd_write(struct drm_dp_aux *aux,
2197 unsigned int offset, void *buffer, size_t size)
2199 struct drm_dp_mst_port *port = container_of(aux, struct drm_dp_mst_port,
2202 return drm_dp_send_dpcd_write(port->mgr, port,
2203 offset, size, buffer);
2206 static int drm_dp_check_mstb_guid(struct drm_dp_mst_branch *mstb, u8 *guid)
2210 memcpy(mstb->guid, guid, 16);
2212 if (!drm_dp_validate_guid(mstb->mgr, mstb->guid)) {
2213 if (mstb->port_parent) {
2214 ret = drm_dp_send_dpcd_write(mstb->mgr,
2216 DP_GUID, 16, mstb->guid);
2218 ret = drm_dp_dpcd_write(mstb->mgr->aux,
2219 DP_GUID, mstb->guid, 16);
2223 if (ret < 16 && ret > 0)
2226 return ret == 16 ? 0 : ret;
2229 static void build_mst_prop_path(const struct drm_dp_mst_branch *mstb,
2232 size_t proppath_size)
2237 snprintf(proppath, proppath_size, "mst:%d", mstb->mgr->conn_base_id);
2238 for (i = 0; i < (mstb->lct - 1); i++) {
2239 int shift = (i % 2) ? 0 : 4;
2240 int port_num = (mstb->rad[i / 2] >> shift) & 0xf;
2242 snprintf(temp, sizeof(temp), "-%d", port_num);
2243 strlcat(proppath, temp, proppath_size);
2245 snprintf(temp, sizeof(temp), "-%d", pnum);
2246 strlcat(proppath, temp, proppath_size);
2250 * drm_dp_mst_connector_late_register() - Late MST connector registration
2251 * @connector: The MST connector
2252 * @port: The MST port for this connector
2254 * Helper to register the remote aux device for this MST port. Drivers should
2255 * call this from their mst connector's late_register hook to enable MST aux
2258 * Return: 0 on success, negative error code on failure.
2260 int drm_dp_mst_connector_late_register(struct drm_connector *connector,
2261 struct drm_dp_mst_port *port)
2263 DRM_DEBUG_KMS("registering %s remote bus for %s\n",
2264 port->aux.name, connector->kdev->kobj.name);
2266 port->aux.dev = connector->kdev;
2267 return drm_dp_aux_register_devnode(&port->aux);
2269 EXPORT_SYMBOL(drm_dp_mst_connector_late_register);
2272 * drm_dp_mst_connector_early_unregister() - Early MST connector unregistration
2273 * @connector: The MST connector
2274 * @port: The MST port for this connector
2276 * Helper to unregister the remote aux device for this MST port, registered by
2277 * drm_dp_mst_connector_late_register(). Drivers should call this from their mst
2278 * connector's early_unregister hook.
2280 void drm_dp_mst_connector_early_unregister(struct drm_connector *connector,
2281 struct drm_dp_mst_port *port)
2283 DRM_DEBUG_KMS("unregistering %s remote bus for %s\n",
2284 port->aux.name, connector->kdev->kobj.name);
2285 drm_dp_aux_unregister_devnode(&port->aux);
2287 EXPORT_SYMBOL(drm_dp_mst_connector_early_unregister);
2290 drm_dp_mst_port_add_connector(struct drm_dp_mst_branch *mstb,
2291 struct drm_dp_mst_port *port)
2293 struct drm_dp_mst_topology_mgr *mgr = port->mgr;
2297 build_mst_prop_path(mstb, port->port_num, proppath, sizeof(proppath));
2298 port->connector = mgr->cbs->add_connector(mgr, port, proppath);
2299 if (!port->connector) {
2304 if (port->pdt != DP_PEER_DEVICE_NONE &&
2305 drm_dp_mst_is_end_device(port->pdt, port->mcs) &&
2306 port->port_num >= DP_MST_LOGICAL_PORT_0) {
2307 port->cached_edid = drm_get_edid(port->connector,
2309 drm_connector_set_tile_property(port->connector);
2312 drm_connector_register(port->connector);
2316 DRM_ERROR("Failed to create connector for port %p: %d\n", port, ret);
2320 * Drop a topology reference, and unlink the port from the in-memory topology
2324 drm_dp_mst_topology_unlink_port(struct drm_dp_mst_topology_mgr *mgr,
2325 struct drm_dp_mst_port *port)
2327 mutex_lock(&mgr->lock);
2328 port->parent->num_ports--;
2329 list_del(&port->next);
2330 mutex_unlock(&mgr->lock);
2331 drm_dp_mst_topology_put_port(port);
2334 static struct drm_dp_mst_port *
2335 drm_dp_mst_add_port(struct drm_device *dev,
2336 struct drm_dp_mst_topology_mgr *mgr,
2337 struct drm_dp_mst_branch *mstb, u8 port_number)
2339 struct drm_dp_mst_port *port = kzalloc(sizeof(*port), GFP_KERNEL);
2344 kref_init(&port->topology_kref);
2345 kref_init(&port->malloc_kref);
2346 port->parent = mstb;
2347 port->port_num = port_number;
2349 port->aux.name = "DPMST";
2350 port->aux.dev = dev->dev;
2351 port->aux.is_remote = true;
2353 /* initialize the MST downstream port's AUX crc work queue */
2354 drm_dp_remote_aux_init(&port->aux);
2357 * Make sure the memory allocation for our parent branch stays
2358 * around until our own memory allocation is released
2360 drm_dp_mst_get_mstb_malloc(mstb);
2366 drm_dp_mst_handle_link_address_port(struct drm_dp_mst_branch *mstb,
2367 struct drm_device *dev,
2368 struct drm_dp_link_addr_reply_port *port_msg)
2370 struct drm_dp_mst_topology_mgr *mgr = mstb->mgr;
2371 struct drm_dp_mst_port *port;
2372 int old_ddps = 0, ret;
2373 u8 new_pdt = DP_PEER_DEVICE_NONE;
2375 bool created = false, send_link_addr = false, changed = false;
2377 port = drm_dp_get_port(mstb, port_msg->port_number);
2379 port = drm_dp_mst_add_port(dev, mgr, mstb,
2380 port_msg->port_number);
2385 } else if (!port->input && port_msg->input_port && port->connector) {
2386 /* Since port->connector can't be changed here, we create a
2387 * new port if input_port changes from 0 to 1
2389 drm_dp_mst_topology_unlink_port(mgr, port);
2390 drm_dp_mst_topology_put_port(port);
2391 port = drm_dp_mst_add_port(dev, mgr, mstb,
2392 port_msg->port_number);
2397 } else if (port->input && !port_msg->input_port) {
2399 } else if (port->connector) {
2400 /* We're updating a port that's exposed to userspace, so do it
2403 drm_modeset_lock(&mgr->base.lock, NULL);
2405 old_ddps = port->ddps;
2406 changed = port->ddps != port_msg->ddps ||
2408 (port->ldps != port_msg->legacy_device_plug_status ||
2409 port->dpcd_rev != port_msg->dpcd_revision ||
2410 port->mcs != port_msg->mcs ||
2411 port->pdt != port_msg->peer_device_type ||
2412 port->num_sdp_stream_sinks !=
2413 port_msg->num_sdp_stream_sinks));
2416 port->input = port_msg->input_port;
2418 new_pdt = port_msg->peer_device_type;
2419 new_mcs = port_msg->mcs;
2420 port->ddps = port_msg->ddps;
2421 port->ldps = port_msg->legacy_device_plug_status;
2422 port->dpcd_rev = port_msg->dpcd_revision;
2423 port->num_sdp_streams = port_msg->num_sdp_streams;
2424 port->num_sdp_stream_sinks = port_msg->num_sdp_stream_sinks;
2426 /* manage mstb port lists with mgr lock - take a reference
2429 mutex_lock(&mgr->lock);
2430 drm_dp_mst_topology_get_port(port);
2431 list_add(&port->next, &mstb->ports);
2433 mutex_unlock(&mgr->lock);
2437 * Reprobe PBN caps on both hotplug, and when re-probing the link
2438 * for our parent mstb
2440 if (old_ddps != port->ddps || !created) {
2441 if (port->ddps && !port->input) {
2442 ret = drm_dp_send_enum_path_resources(mgr, mstb,
2451 ret = drm_dp_port_set_pdt(port, new_pdt, new_mcs);
2453 send_link_addr = true;
2454 } else if (ret < 0) {
2455 DRM_ERROR("Failed to change PDT on port %p: %d\n",
2461 * If this port wasn't just created, then we're reprobing because
2462 * we're coming out of suspend. In this case, always resend the link
2463 * address if there's an MSTB on this port
2465 if (!created && port->pdt == DP_PEER_DEVICE_MST_BRANCHING &&
2467 send_link_addr = true;
2469 if (port->connector)
2470 drm_modeset_unlock(&mgr->base.lock);
2471 else if (!port->input)
2472 drm_dp_mst_port_add_connector(mstb, port);
2474 if (send_link_addr && port->mstb) {
2475 ret = drm_dp_send_link_address(mgr, port->mstb);
2476 if (ret == 1) /* MSTB below us changed */
2482 /* put reference to this port */
2483 drm_dp_mst_topology_put_port(port);
2487 drm_dp_mst_topology_unlink_port(mgr, port);
2488 if (port->connector)
2489 drm_modeset_unlock(&mgr->base.lock);
2491 drm_dp_mst_topology_put_port(port);
2496 drm_dp_mst_handle_conn_stat(struct drm_dp_mst_branch *mstb,
2497 struct drm_dp_connection_status_notify *conn_stat)
2499 struct drm_dp_mst_topology_mgr *mgr = mstb->mgr;
2500 struct drm_dp_mst_port *port;
2501 int old_ddps, old_input, ret, i;
2504 bool dowork = false, create_connector = false;
2506 port = drm_dp_get_port(mstb, conn_stat->port_number);
2510 if (port->connector) {
2511 if (!port->input && conn_stat->input_port) {
2513 * We can't remove a connector from an already exposed
2514 * port, so just throw the port out and make sure we
2515 * reprobe the link address of it's parent MSTB
2517 drm_dp_mst_topology_unlink_port(mgr, port);
2518 mstb->link_address_sent = false;
2523 /* Locking is only needed if the port's exposed to userspace */
2524 drm_modeset_lock(&mgr->base.lock, NULL);
2525 } else if (port->input && !conn_stat->input_port) {
2526 create_connector = true;
2527 /* Reprobe link address so we get num_sdp_streams */
2528 mstb->link_address_sent = false;
2532 old_ddps = port->ddps;
2533 old_input = port->input;
2534 port->input = conn_stat->input_port;
2535 port->ldps = conn_stat->legacy_device_plug_status;
2536 port->ddps = conn_stat->displayport_device_plug_status;
2538 if (old_ddps != port->ddps) {
2539 if (port->ddps && !port->input)
2540 drm_dp_send_enum_path_resources(mgr, mstb, port);
2545 new_pdt = port->input ? DP_PEER_DEVICE_NONE : conn_stat->peer_device_type;
2546 new_mcs = conn_stat->message_capability_status;
2547 ret = drm_dp_port_set_pdt(port, new_pdt, new_mcs);
2550 } else if (ret < 0) {
2551 DRM_ERROR("Failed to change PDT for port %p: %d\n",
2556 if (!old_input && old_ddps != port->ddps && !port->ddps) {
2557 for (i = 0; i < mgr->max_payloads; i++) {
2558 struct drm_dp_vcpi *vcpi = mgr->proposed_vcpis[i];
2559 struct drm_dp_mst_port *port_validated;
2565 container_of(vcpi, struct drm_dp_mst_port, vcpi);
2567 drm_dp_mst_topology_get_port_validated(mgr, port_validated);
2568 if (!port_validated) {
2569 mutex_lock(&mgr->payload_lock);
2570 vcpi->num_slots = 0;
2571 mutex_unlock(&mgr->payload_lock);
2573 drm_dp_mst_topology_put_port(port_validated);
2578 if (port->connector)
2579 drm_modeset_unlock(&mgr->base.lock);
2580 else if (create_connector)
2581 drm_dp_mst_port_add_connector(mstb, port);
2584 drm_dp_mst_topology_put_port(port);
2586 queue_work(system_long_wq, &mstb->mgr->work);
2589 static struct drm_dp_mst_branch *drm_dp_get_mst_branch_device(struct drm_dp_mst_topology_mgr *mgr,
2592 struct drm_dp_mst_branch *mstb;
2593 struct drm_dp_mst_port *port;
2595 /* find the port by iterating down */
2597 mutex_lock(&mgr->lock);
2598 mstb = mgr->mst_primary;
2603 for (i = 0; i < lct - 1; i++) {
2604 int shift = (i % 2) ? 0 : 4;
2605 int port_num = (rad[i / 2] >> shift) & 0xf;
2607 list_for_each_entry(port, &mstb->ports, next) {
2608 if (port->port_num == port_num) {
2611 DRM_ERROR("failed to lookup MSTB with lct %d, rad %02x\n", lct, rad[0]);
2619 ret = drm_dp_mst_topology_try_get_mstb(mstb);
2623 mutex_unlock(&mgr->lock);
2627 static struct drm_dp_mst_branch *get_mst_branch_device_by_guid_helper(
2628 struct drm_dp_mst_branch *mstb,
2629 const uint8_t *guid)
2631 struct drm_dp_mst_branch *found_mstb;
2632 struct drm_dp_mst_port *port;
2634 if (memcmp(mstb->guid, guid, 16) == 0)
2638 list_for_each_entry(port, &mstb->ports, next) {
2642 found_mstb = get_mst_branch_device_by_guid_helper(port->mstb, guid);
2651 static struct drm_dp_mst_branch *
2652 drm_dp_get_mst_branch_device_by_guid(struct drm_dp_mst_topology_mgr *mgr,
2653 const uint8_t *guid)
2655 struct drm_dp_mst_branch *mstb;
2658 /* find the port by iterating down */
2659 mutex_lock(&mgr->lock);
2661 mstb = get_mst_branch_device_by_guid_helper(mgr->mst_primary, guid);
2663 ret = drm_dp_mst_topology_try_get_mstb(mstb);
2668 mutex_unlock(&mgr->lock);
2672 static int drm_dp_check_and_send_link_address(struct drm_dp_mst_topology_mgr *mgr,
2673 struct drm_dp_mst_branch *mstb)
2675 struct drm_dp_mst_port *port;
2677 bool changed = false;
2679 if (!mstb->link_address_sent) {
2680 ret = drm_dp_send_link_address(mgr, mstb);
2687 list_for_each_entry(port, &mstb->ports, next) {
2688 struct drm_dp_mst_branch *mstb_child = NULL;
2690 if (port->input || !port->ddps)
2694 mstb_child = drm_dp_mst_topology_get_mstb_validated(
2698 ret = drm_dp_check_and_send_link_address(mgr,
2700 drm_dp_mst_topology_put_mstb(mstb_child);
2711 static void drm_dp_mst_link_probe_work(struct work_struct *work)
2713 struct drm_dp_mst_topology_mgr *mgr =
2714 container_of(work, struct drm_dp_mst_topology_mgr, work);
2715 struct drm_device *dev = mgr->dev;
2716 struct drm_dp_mst_branch *mstb;
2718 bool clear_payload_id_table;
2720 mutex_lock(&mgr->probe_lock);
2722 mutex_lock(&mgr->lock);
2723 clear_payload_id_table = !mgr->payload_id_table_cleared;
2724 mgr->payload_id_table_cleared = true;
2726 mstb = mgr->mst_primary;
2728 ret = drm_dp_mst_topology_try_get_mstb(mstb);
2732 mutex_unlock(&mgr->lock);
2734 mutex_unlock(&mgr->probe_lock);
2739 * Certain branch devices seem to incorrectly report an available_pbn
2740 * of 0 on downstream sinks, even after clearing the
2741 * DP_PAYLOAD_ALLOCATE_* registers in
2742 * drm_dp_mst_topology_mgr_set_mst(). Namely, the CableMatters USB-C
2743 * 2x DP hub. Sending a CLEAR_PAYLOAD_ID_TABLE message seems to make
2744 * things work again.
2746 if (clear_payload_id_table) {
2747 DRM_DEBUG_KMS("Clearing payload ID table\n");
2748 drm_dp_send_clear_payload_id_table(mgr, mstb);
2751 ret = drm_dp_check_and_send_link_address(mgr, mstb);
2752 drm_dp_mst_topology_put_mstb(mstb);
2754 mutex_unlock(&mgr->probe_lock);
2756 drm_kms_helper_hotplug_event(dev);
2759 static bool drm_dp_validate_guid(struct drm_dp_mst_topology_mgr *mgr,
2764 if (memchr_inv(guid, 0, 16))
2767 salt = get_jiffies_64();
2769 memcpy(&guid[0], &salt, sizeof(u64));
2770 memcpy(&guid[8], &salt, sizeof(u64));
2775 static void build_dpcd_read(struct drm_dp_sideband_msg_tx *msg,
2776 u8 port_num, u32 offset, u8 num_bytes)
2778 struct drm_dp_sideband_msg_req_body req;
2780 req.req_type = DP_REMOTE_DPCD_READ;
2781 req.u.dpcd_read.port_number = port_num;
2782 req.u.dpcd_read.dpcd_address = offset;
2783 req.u.dpcd_read.num_bytes = num_bytes;
2784 drm_dp_encode_sideband_req(&req, msg);
2787 static int drm_dp_send_sideband_msg(struct drm_dp_mst_topology_mgr *mgr,
2788 bool up, u8 *msg, int len)
2791 int regbase = up ? DP_SIDEBAND_MSG_UP_REP_BASE : DP_SIDEBAND_MSG_DOWN_REQ_BASE;
2792 int tosend, total, offset;
2799 tosend = min3(mgr->max_dpcd_transaction_bytes, 16, total);
2801 ret = drm_dp_dpcd_write(mgr->aux, regbase + offset,
2804 if (ret != tosend) {
2805 if (ret == -EIO && retries < 5) {
2809 DRM_DEBUG_KMS("failed to dpcd write %d %d\n", tosend, ret);
2815 } while (total > 0);
2819 static int set_hdr_from_dst_qlock(struct drm_dp_sideband_msg_hdr *hdr,
2820 struct drm_dp_sideband_msg_tx *txmsg)
2822 struct drm_dp_mst_branch *mstb = txmsg->dst;
2825 req_type = txmsg->msg[0] & 0x7f;
2826 if (req_type == DP_CONNECTION_STATUS_NOTIFY ||
2827 req_type == DP_RESOURCE_STATUS_NOTIFY)
2831 hdr->path_msg = txmsg->path_msg;
2832 hdr->lct = mstb->lct;
2833 hdr->lcr = mstb->lct - 1;
2835 memcpy(hdr->rad, mstb->rad, mstb->lct / 2);
2840 * process a single block of the next message in the sideband queue
2842 static int process_single_tx_qlock(struct drm_dp_mst_topology_mgr *mgr,
2843 struct drm_dp_sideband_msg_tx *txmsg,
2847 struct drm_dp_sideband_msg_hdr hdr;
2848 int len, space, idx, tosend;
2851 if (txmsg->state == DRM_DP_SIDEBAND_TX_SENT)
2854 memset(&hdr, 0, sizeof(struct drm_dp_sideband_msg_hdr));
2856 if (txmsg->state == DRM_DP_SIDEBAND_TX_QUEUED)
2857 txmsg->state = DRM_DP_SIDEBAND_TX_START_SEND;
2859 /* make hdr from dst mst */
2860 ret = set_hdr_from_dst_qlock(&hdr, txmsg);
2864 /* amount left to send in this message */
2865 len = txmsg->cur_len - txmsg->cur_offset;
2867 /* 48 - sideband msg size - 1 byte for data CRC, x header bytes */
2868 space = 48 - 1 - drm_dp_calc_sb_hdr_size(&hdr);
2870 tosend = min(len, space);
2871 if (len == txmsg->cur_len)
2877 hdr.msg_len = tosend + 1;
2878 drm_dp_encode_sideband_msg_hdr(&hdr, chunk, &idx);
2879 memcpy(&chunk[idx], &txmsg->msg[txmsg->cur_offset], tosend);
2880 /* add crc at end */
2881 drm_dp_crc_sideband_chunk_req(&chunk[idx], tosend);
2884 ret = drm_dp_send_sideband_msg(mgr, up, chunk, idx);
2885 if (unlikely(ret) && drm_debug_enabled(DRM_UT_DP)) {
2886 struct drm_printer p = drm_debug_printer(DBG_PREFIX);
2888 drm_printf(&p, "sideband msg failed to send\n");
2889 drm_dp_mst_dump_sideband_msg_tx(&p, txmsg);
2893 txmsg->cur_offset += tosend;
2894 if (txmsg->cur_offset == txmsg->cur_len) {
2895 txmsg->state = DRM_DP_SIDEBAND_TX_SENT;
2901 static void process_single_down_tx_qlock(struct drm_dp_mst_topology_mgr *mgr)
2903 struct drm_dp_sideband_msg_tx *txmsg;
2906 WARN_ON(!mutex_is_locked(&mgr->qlock));
2908 /* construct a chunk from the first msg in the tx_msg queue */
2909 if (list_empty(&mgr->tx_msg_downq))
2912 txmsg = list_first_entry(&mgr->tx_msg_downq,
2913 struct drm_dp_sideband_msg_tx, next);
2914 ret = process_single_tx_qlock(mgr, txmsg, false);
2916 DRM_DEBUG_KMS("failed to send msg in q %d\n", ret);
2917 list_del(&txmsg->next);
2918 txmsg->state = DRM_DP_SIDEBAND_TX_TIMEOUT;
2919 wake_up_all(&mgr->tx_waitq);
2923 static void drm_dp_queue_down_tx(struct drm_dp_mst_topology_mgr *mgr,
2924 struct drm_dp_sideband_msg_tx *txmsg)
2926 mutex_lock(&mgr->qlock);
2927 list_add_tail(&txmsg->next, &mgr->tx_msg_downq);
2929 if (drm_debug_enabled(DRM_UT_DP)) {
2930 struct drm_printer p = drm_debug_printer(DBG_PREFIX);
2932 drm_dp_mst_dump_sideband_msg_tx(&p, txmsg);
2935 if (list_is_singular(&mgr->tx_msg_downq))
2936 process_single_down_tx_qlock(mgr);
2937 mutex_unlock(&mgr->qlock);
2941 drm_dp_dump_link_address(struct drm_dp_link_address_ack_reply *reply)
2943 struct drm_dp_link_addr_reply_port *port_reply;
2946 for (i = 0; i < reply->nports; i++) {
2947 port_reply = &reply->ports[i];
2948 DRM_DEBUG_KMS("port %d: input %d, pdt: %d, pn: %d, dpcd_rev: %02x, mcs: %d, ddps: %d, ldps %d, sdp %d/%d\n",
2950 port_reply->input_port,
2951 port_reply->peer_device_type,
2952 port_reply->port_number,
2953 port_reply->dpcd_revision,
2956 port_reply->legacy_device_plug_status,
2957 port_reply->num_sdp_streams,
2958 port_reply->num_sdp_stream_sinks);
2962 static int drm_dp_send_link_address(struct drm_dp_mst_topology_mgr *mgr,
2963 struct drm_dp_mst_branch *mstb)
2965 struct drm_dp_sideband_msg_tx *txmsg;
2966 struct drm_dp_link_address_ack_reply *reply;
2967 struct drm_dp_mst_port *port, *tmp;
2968 int i, ret, port_mask = 0;
2969 bool changed = false;
2971 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
2976 build_link_address(txmsg);
2978 mstb->link_address_sent = true;
2979 drm_dp_queue_down_tx(mgr, txmsg);
2981 /* FIXME: Actually do some real error handling here */
2982 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
2984 DRM_ERROR("Sending link address failed with %d\n", ret);
2987 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK) {
2988 DRM_ERROR("link address NAK received\n");
2993 reply = &txmsg->reply.u.link_addr;
2994 DRM_DEBUG_KMS("link address reply: %d\n", reply->nports);
2995 drm_dp_dump_link_address(reply);
2997 ret = drm_dp_check_mstb_guid(mstb, reply->guid);
3001 drm_dp_mst_rad_to_str(mstb->rad, mstb->lct, buf, sizeof(buf));
3002 DRM_ERROR("GUID check on %s failed: %d\n",
3007 for (i = 0; i < reply->nports; i++) {
3008 port_mask |= BIT(reply->ports[i].port_number);
3009 ret = drm_dp_mst_handle_link_address_port(mstb, mgr->dev,
3017 /* Prune any ports that are currently a part of mstb in our in-memory
3018 * topology, but were not seen in this link address. Usually this
3019 * means that they were removed while the topology was out of sync,
3020 * e.g. during suspend/resume
3022 mutex_lock(&mgr->lock);
3023 list_for_each_entry_safe(port, tmp, &mstb->ports, next) {
3024 if (port_mask & BIT(port->port_num))
3027 DRM_DEBUG_KMS("port %d was not in link address, removing\n",
3029 list_del(&port->next);
3030 drm_dp_mst_topology_put_port(port);
3033 mutex_unlock(&mgr->lock);
3037 mstb->link_address_sent = false;
3039 return ret < 0 ? ret : changed;
3043 drm_dp_send_clear_payload_id_table(struct drm_dp_mst_topology_mgr *mgr,
3044 struct drm_dp_mst_branch *mstb)
3046 struct drm_dp_sideband_msg_tx *txmsg;
3049 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3054 build_clear_payload_id_table(txmsg);
3056 drm_dp_queue_down_tx(mgr, txmsg);
3058 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
3059 if (ret > 0 && txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK)
3060 DRM_DEBUG_KMS("clear payload table id nak received\n");
3066 drm_dp_send_enum_path_resources(struct drm_dp_mst_topology_mgr *mgr,
3067 struct drm_dp_mst_branch *mstb,
3068 struct drm_dp_mst_port *port)
3070 struct drm_dp_enum_path_resources_ack_reply *path_res;
3071 struct drm_dp_sideband_msg_tx *txmsg;
3074 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3079 build_enum_path_resources(txmsg, port->port_num);
3081 drm_dp_queue_down_tx(mgr, txmsg);
3083 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
3086 path_res = &txmsg->reply.u.path_resources;
3088 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK) {
3089 DRM_DEBUG_KMS("enum path resources nak received\n");
3091 if (port->port_num != path_res->port_number)
3092 DRM_ERROR("got incorrect port in response\n");
3094 DRM_DEBUG_KMS("enum path resources %d: %d %d\n",
3095 path_res->port_number,
3096 path_res->full_payload_bw_number,
3097 path_res->avail_payload_bw_number);
3100 * If something changed, make sure we send a
3103 if (port->full_pbn != path_res->full_payload_bw_number ||
3104 port->fec_capable != path_res->fec_capable)
3107 port->full_pbn = path_res->full_payload_bw_number;
3108 port->fec_capable = path_res->fec_capable;
3116 static struct drm_dp_mst_port *drm_dp_get_last_connected_port_to_mstb(struct drm_dp_mst_branch *mstb)
3118 if (!mstb->port_parent)
3121 if (mstb->port_parent->mstb != mstb)
3122 return mstb->port_parent;
3124 return drm_dp_get_last_connected_port_to_mstb(mstb->port_parent->parent);
3128 * Searches upwards in the topology starting from mstb to try to find the
3129 * closest available parent of mstb that's still connected to the rest of the
3130 * topology. This can be used in order to perform operations like releasing
3131 * payloads, where the branch device which owned the payload may no longer be
3132 * around and thus would require that the payload on the last living relative
3135 static struct drm_dp_mst_branch *
3136 drm_dp_get_last_connected_port_and_mstb(struct drm_dp_mst_topology_mgr *mgr,
3137 struct drm_dp_mst_branch *mstb,
3140 struct drm_dp_mst_branch *rmstb = NULL;
3141 struct drm_dp_mst_port *found_port;
3143 mutex_lock(&mgr->lock);
3144 if (!mgr->mst_primary)
3148 found_port = drm_dp_get_last_connected_port_to_mstb(mstb);
3152 if (drm_dp_mst_topology_try_get_mstb(found_port->parent)) {
3153 rmstb = found_port->parent;
3154 *port_num = found_port->port_num;
3156 /* Search again, starting from this parent */
3157 mstb = found_port->parent;
3161 mutex_unlock(&mgr->lock);
3165 static int drm_dp_payload_send_msg(struct drm_dp_mst_topology_mgr *mgr,
3166 struct drm_dp_mst_port *port,
3170 struct drm_dp_sideband_msg_tx *txmsg;
3171 struct drm_dp_mst_branch *mstb;
3173 u8 sinks[DRM_DP_MAX_SDP_STREAMS];
3176 port_num = port->port_num;
3177 mstb = drm_dp_mst_topology_get_mstb_validated(mgr, port->parent);
3179 mstb = drm_dp_get_last_connected_port_and_mstb(mgr,
3187 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3193 for (i = 0; i < port->num_sdp_streams; i++)
3197 build_allocate_payload(txmsg, port_num,
3199 pbn, port->num_sdp_streams, sinks);
3201 drm_dp_queue_down_tx(mgr, txmsg);
3204 * FIXME: there is a small chance that between getting the last
3205 * connected mstb and sending the payload message, the last connected
3206 * mstb could also be removed from the topology. In the future, this
3207 * needs to be fixed by restarting the
3208 * drm_dp_get_last_connected_port_and_mstb() search in the event of a
3209 * timeout if the topology is still connected to the system.
3211 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
3213 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK)
3220 drm_dp_mst_topology_put_mstb(mstb);
3224 int drm_dp_send_power_updown_phy(struct drm_dp_mst_topology_mgr *mgr,
3225 struct drm_dp_mst_port *port, bool power_up)
3227 struct drm_dp_sideband_msg_tx *txmsg;
3230 port = drm_dp_mst_topology_get_port_validated(mgr, port);
3234 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3236 drm_dp_mst_topology_put_port(port);
3240 txmsg->dst = port->parent;
3241 build_power_updown_phy(txmsg, port->port_num, power_up);
3242 drm_dp_queue_down_tx(mgr, txmsg);
3244 ret = drm_dp_mst_wait_tx_reply(port->parent, txmsg);
3246 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK)
3252 drm_dp_mst_topology_put_port(port);
3256 EXPORT_SYMBOL(drm_dp_send_power_updown_phy);
3258 int drm_dp_send_query_stream_enc_status(struct drm_dp_mst_topology_mgr *mgr,
3259 struct drm_dp_mst_port *port,
3260 struct drm_dp_query_stream_enc_status_ack_reply *status)
3262 struct drm_dp_sideband_msg_tx *txmsg;
3266 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3270 port = drm_dp_mst_topology_get_port_validated(mgr, port);
3276 get_random_bytes(nonce, sizeof(nonce));
3279 * "Source device targets the QUERY_STREAM_ENCRYPTION_STATUS message
3280 * transaction at the MST Branch device directly connected to the
3283 txmsg->dst = mgr->mst_primary;
3285 build_query_stream_enc_status(txmsg, port->vcpi.vcpi, nonce);
3287 drm_dp_queue_down_tx(mgr, txmsg);
3289 ret = drm_dp_mst_wait_tx_reply(mgr->mst_primary, txmsg);
3292 } else if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK) {
3293 drm_dbg_kms(mgr->dev, "query encryption status nak received\n");
3299 memcpy(status, &txmsg->reply.u.enc_status, sizeof(*status));
3302 drm_dp_mst_topology_put_port(port);
3307 EXPORT_SYMBOL(drm_dp_send_query_stream_enc_status);
3309 static int drm_dp_create_payload_step1(struct drm_dp_mst_topology_mgr *mgr,
3311 struct drm_dp_payload *payload)
3315 ret = drm_dp_dpcd_write_payload(mgr, id, payload);
3317 payload->payload_state = 0;
3320 payload->payload_state = DP_PAYLOAD_LOCAL;
3324 static int drm_dp_create_payload_step2(struct drm_dp_mst_topology_mgr *mgr,
3325 struct drm_dp_mst_port *port,
3327 struct drm_dp_payload *payload)
3331 ret = drm_dp_payload_send_msg(mgr, port, id, port->vcpi.pbn);
3334 payload->payload_state = DP_PAYLOAD_REMOTE;
3338 static int drm_dp_destroy_payload_step1(struct drm_dp_mst_topology_mgr *mgr,
3339 struct drm_dp_mst_port *port,
3341 struct drm_dp_payload *payload)
3343 DRM_DEBUG_KMS("\n");
3344 /* it's okay for these to fail */
3346 drm_dp_payload_send_msg(mgr, port, id, 0);
3349 drm_dp_dpcd_write_payload(mgr, id, payload);
3350 payload->payload_state = DP_PAYLOAD_DELETE_LOCAL;
3354 static int drm_dp_destroy_payload_step2(struct drm_dp_mst_topology_mgr *mgr,
3356 struct drm_dp_payload *payload)
3358 payload->payload_state = 0;
3363 * drm_dp_update_payload_part1() - Execute payload update part 1
3364 * @mgr: manager to use.
3366 * This iterates over all proposed virtual channels, and tries to
3367 * allocate space in the link for them. For 0->slots transitions,
3368 * this step just writes the VCPI to the MST device. For slots->0
3369 * transitions, this writes the updated VCPIs and removes the
3370 * remote VC payloads.
3372 * after calling this the driver should generate ACT and payload
3375 int drm_dp_update_payload_part1(struct drm_dp_mst_topology_mgr *mgr)
3377 struct drm_dp_payload req_payload;
3378 struct drm_dp_mst_port *port;
3382 mutex_lock(&mgr->payload_lock);
3383 for (i = 0; i < mgr->max_payloads; i++) {
3384 struct drm_dp_vcpi *vcpi = mgr->proposed_vcpis[i];
3385 struct drm_dp_payload *payload = &mgr->payloads[i];
3386 bool put_port = false;
3388 /* solve the current payloads - compare to the hw ones
3389 - update the hw view */
3390 req_payload.start_slot = cur_slots;
3392 port = container_of(vcpi, struct drm_dp_mst_port,
3395 /* Validated ports don't matter if we're releasing
3398 if (vcpi->num_slots) {
3399 port = drm_dp_mst_topology_get_port_validated(
3402 mutex_unlock(&mgr->payload_lock);
3408 req_payload.num_slots = vcpi->num_slots;
3409 req_payload.vcpi = vcpi->vcpi;
3412 req_payload.num_slots = 0;
3415 payload->start_slot = req_payload.start_slot;
3416 /* work out what is required to happen with this payload */
3417 if (payload->num_slots != req_payload.num_slots) {
3419 /* need to push an update for this payload */
3420 if (req_payload.num_slots) {
3421 drm_dp_create_payload_step1(mgr, vcpi->vcpi,
3423 payload->num_slots = req_payload.num_slots;
3424 payload->vcpi = req_payload.vcpi;
3426 } else if (payload->num_slots) {
3427 payload->num_slots = 0;
3428 drm_dp_destroy_payload_step1(mgr, port,
3431 req_payload.payload_state =
3432 payload->payload_state;
3433 payload->start_slot = 0;
3435 payload->payload_state = req_payload.payload_state;
3437 cur_slots += req_payload.num_slots;
3440 drm_dp_mst_topology_put_port(port);
3443 for (i = 0; i < mgr->max_payloads; /* do nothing */) {
3444 if (mgr->payloads[i].payload_state != DP_PAYLOAD_DELETE_LOCAL) {
3449 DRM_DEBUG_KMS("removing payload %d\n", i);
3450 for (j = i; j < mgr->max_payloads - 1; j++) {
3451 mgr->payloads[j] = mgr->payloads[j + 1];
3452 mgr->proposed_vcpis[j] = mgr->proposed_vcpis[j + 1];
3454 if (mgr->proposed_vcpis[j] &&
3455 mgr->proposed_vcpis[j]->num_slots) {
3456 set_bit(j + 1, &mgr->payload_mask);
3458 clear_bit(j + 1, &mgr->payload_mask);
3462 memset(&mgr->payloads[mgr->max_payloads - 1], 0,
3463 sizeof(struct drm_dp_payload));
3464 mgr->proposed_vcpis[mgr->max_payloads - 1] = NULL;
3465 clear_bit(mgr->max_payloads, &mgr->payload_mask);
3467 mutex_unlock(&mgr->payload_lock);
3471 EXPORT_SYMBOL(drm_dp_update_payload_part1);
3474 * drm_dp_update_payload_part2() - Execute payload update part 2
3475 * @mgr: manager to use.
3477 * This iterates over all proposed virtual channels, and tries to
3478 * allocate space in the link for them. For 0->slots transitions,
3479 * this step writes the remote VC payload commands. For slots->0
3480 * this just resets some internal state.
3482 int drm_dp_update_payload_part2(struct drm_dp_mst_topology_mgr *mgr)
3484 struct drm_dp_mst_port *port;
3488 mutex_lock(&mgr->payload_lock);
3489 for (i = 0; i < mgr->max_payloads; i++) {
3491 if (!mgr->proposed_vcpis[i])
3494 port = container_of(mgr->proposed_vcpis[i], struct drm_dp_mst_port, vcpi);
3496 DRM_DEBUG_KMS("payload %d %d\n", i, mgr->payloads[i].payload_state);
3497 if (mgr->payloads[i].payload_state == DP_PAYLOAD_LOCAL) {
3498 ret = drm_dp_create_payload_step2(mgr, port, mgr->proposed_vcpis[i]->vcpi, &mgr->payloads[i]);
3499 } else if (mgr->payloads[i].payload_state == DP_PAYLOAD_DELETE_LOCAL) {
3500 ret = drm_dp_destroy_payload_step2(mgr, mgr->proposed_vcpis[i]->vcpi, &mgr->payloads[i]);
3503 mutex_unlock(&mgr->payload_lock);
3507 mutex_unlock(&mgr->payload_lock);
3510 EXPORT_SYMBOL(drm_dp_update_payload_part2);
3512 static int drm_dp_send_dpcd_read(struct drm_dp_mst_topology_mgr *mgr,
3513 struct drm_dp_mst_port *port,
3514 int offset, int size, u8 *bytes)
3517 struct drm_dp_sideband_msg_tx *txmsg;
3518 struct drm_dp_mst_branch *mstb;
3520 mstb = drm_dp_mst_topology_get_mstb_validated(mgr, port->parent);
3524 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3530 build_dpcd_read(txmsg, port->port_num, offset, size);
3531 txmsg->dst = port->parent;
3533 drm_dp_queue_down_tx(mgr, txmsg);
3535 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
3539 /* DPCD read should never be NACKed */
3540 if (txmsg->reply.reply_type == 1) {
3541 DRM_ERROR("mstb %p port %d: DPCD read on addr 0x%x for %d bytes NAKed\n",
3542 mstb, port->port_num, offset, size);
3547 if (txmsg->reply.u.remote_dpcd_read_ack.num_bytes != size) {
3552 ret = min_t(size_t, txmsg->reply.u.remote_dpcd_read_ack.num_bytes,
3554 memcpy(bytes, txmsg->reply.u.remote_dpcd_read_ack.bytes, ret);
3559 drm_dp_mst_topology_put_mstb(mstb);
3564 static int drm_dp_send_dpcd_write(struct drm_dp_mst_topology_mgr *mgr,
3565 struct drm_dp_mst_port *port,
3566 int offset, int size, u8 *bytes)
3569 struct drm_dp_sideband_msg_tx *txmsg;
3570 struct drm_dp_mst_branch *mstb;
3572 mstb = drm_dp_mst_topology_get_mstb_validated(mgr, port->parent);
3576 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3582 build_dpcd_write(txmsg, port->port_num, offset, size, bytes);
3585 drm_dp_queue_down_tx(mgr, txmsg);
3587 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
3589 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK)
3597 drm_dp_mst_topology_put_mstb(mstb);
3601 static int drm_dp_encode_up_ack_reply(struct drm_dp_sideband_msg_tx *msg, u8 req_type)
3603 struct drm_dp_sideband_msg_reply_body reply;
3605 reply.reply_type = DP_SIDEBAND_REPLY_ACK;
3606 reply.req_type = req_type;
3607 drm_dp_encode_sideband_reply(&reply, msg);
3611 static int drm_dp_send_up_ack_reply(struct drm_dp_mst_topology_mgr *mgr,
3612 struct drm_dp_mst_branch *mstb,
3613 int req_type, bool broadcast)
3615 struct drm_dp_sideband_msg_tx *txmsg;
3617 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
3622 drm_dp_encode_up_ack_reply(txmsg, req_type);
3624 mutex_lock(&mgr->qlock);
3625 /* construct a chunk from the first msg in the tx_msg queue */
3626 process_single_tx_qlock(mgr, txmsg, true);
3627 mutex_unlock(&mgr->qlock);
3634 * drm_dp_get_vc_payload_bw - get the VC payload BW for an MST link
3635 * @link_rate: link rate in 10kbits/s units
3636 * @link_lane_count: lane count
3638 * Calculate the total bandwidth of a MultiStream Transport link. The returned
3639 * value is in units of PBNs/(timeslots/1 MTP). This value can be used to
3640 * convert the number of PBNs required for a given stream to the number of
3641 * timeslots this stream requires in each MTP.
3643 int drm_dp_get_vc_payload_bw(int link_rate, int link_lane_count)
3645 if (link_rate == 0 || link_lane_count == 0)
3646 DRM_DEBUG_KMS("invalid link rate/lane count: (%d / %d)\n",
3647 link_rate, link_lane_count);
3649 /* See DP v2.0 2.6.4.2, VCPayload_Bandwidth_for_OneTimeSlotPer_MTP_Allocation */
3650 return link_rate * link_lane_count / 54000;
3652 EXPORT_SYMBOL(drm_dp_get_vc_payload_bw);
3655 * drm_dp_read_mst_cap() - check whether or not a sink supports MST
3656 * @aux: The DP AUX channel to use
3657 * @dpcd: A cached copy of the DPCD capabilities for this sink
3659 * Returns: %True if the sink supports MST, %false otherwise
3661 bool drm_dp_read_mst_cap(struct drm_dp_aux *aux,
3662 const u8 dpcd[DP_RECEIVER_CAP_SIZE])
3666 if (dpcd[DP_DPCD_REV] < DP_DPCD_REV_12)
3669 if (drm_dp_dpcd_readb(aux, DP_MSTM_CAP, &mstm_cap) != 1)
3672 return mstm_cap & DP_MST_CAP;
3674 EXPORT_SYMBOL(drm_dp_read_mst_cap);
3677 * drm_dp_mst_topology_mgr_set_mst() - Set the MST state for a topology manager
3678 * @mgr: manager to set state for
3679 * @mst_state: true to enable MST on this connector - false to disable.
3681 * This is called by the driver when it detects an MST capable device plugged
3682 * into a DP MST capable port, or when a DP MST capable device is unplugged.
3684 int drm_dp_mst_topology_mgr_set_mst(struct drm_dp_mst_topology_mgr *mgr, bool mst_state)
3687 struct drm_dp_mst_branch *mstb = NULL;
3689 mutex_lock(&mgr->payload_lock);
3690 mutex_lock(&mgr->lock);
3691 if (mst_state == mgr->mst_state)
3694 mgr->mst_state = mst_state;
3695 /* set the device into MST mode */
3697 struct drm_dp_payload reset_pay;
3699 WARN_ON(mgr->mst_primary);
3702 ret = drm_dp_dpcd_read(mgr->aux, DP_DPCD_REV, mgr->dpcd, DP_RECEIVER_CAP_SIZE);
3703 if (ret != DP_RECEIVER_CAP_SIZE) {
3704 DRM_DEBUG_KMS("failed to read DPCD\n");
3708 mgr->pbn_div = drm_dp_get_vc_payload_bw(drm_dp_bw_code_to_link_rate(mgr->dpcd[1]),
3709 mgr->dpcd[2] & DP_MAX_LANE_COUNT_MASK);
3710 if (mgr->pbn_div == 0) {
3715 /* add initial branch device at LCT 1 */
3716 mstb = drm_dp_add_mst_branch_device(1, NULL);
3723 /* give this the main reference */
3724 mgr->mst_primary = mstb;
3725 drm_dp_mst_topology_get_mstb(mgr->mst_primary);
3727 ret = drm_dp_dpcd_writeb(mgr->aux, DP_MSTM_CTRL,
3730 DP_UPSTREAM_IS_SRC);
3734 reset_pay.start_slot = 0;
3735 reset_pay.num_slots = 0x3f;
3736 drm_dp_dpcd_write_payload(mgr, 0, &reset_pay);
3738 queue_work(system_long_wq, &mgr->work);
3742 /* disable MST on the device */
3743 mstb = mgr->mst_primary;
3744 mgr->mst_primary = NULL;
3745 /* this can fail if the device is gone */
3746 drm_dp_dpcd_writeb(mgr->aux, DP_MSTM_CTRL, 0);
3748 memset(mgr->payloads, 0,
3749 mgr->max_payloads * sizeof(mgr->payloads[0]));
3750 memset(mgr->proposed_vcpis, 0,
3751 mgr->max_payloads * sizeof(mgr->proposed_vcpis[0]));
3752 mgr->payload_mask = 0;
3753 set_bit(0, &mgr->payload_mask);
3755 mgr->payload_id_table_cleared = false;
3759 mutex_unlock(&mgr->lock);
3760 mutex_unlock(&mgr->payload_lock);
3762 drm_dp_mst_topology_put_mstb(mstb);
3766 EXPORT_SYMBOL(drm_dp_mst_topology_mgr_set_mst);
3769 drm_dp_mst_topology_mgr_invalidate_mstb(struct drm_dp_mst_branch *mstb)
3771 struct drm_dp_mst_port *port;
3773 /* The link address will need to be re-sent on resume */
3774 mstb->link_address_sent = false;
3776 list_for_each_entry(port, &mstb->ports, next)
3778 drm_dp_mst_topology_mgr_invalidate_mstb(port->mstb);
3782 * drm_dp_mst_topology_mgr_suspend() - suspend the MST manager
3783 * @mgr: manager to suspend
3785 * This function tells the MST device that we can't handle UP messages
3786 * anymore. This should stop it from sending any since we are suspended.
3788 void drm_dp_mst_topology_mgr_suspend(struct drm_dp_mst_topology_mgr *mgr)
3790 mutex_lock(&mgr->lock);
3791 drm_dp_dpcd_writeb(mgr->aux, DP_MSTM_CTRL,
3792 DP_MST_EN | DP_UPSTREAM_IS_SRC);
3793 mutex_unlock(&mgr->lock);
3794 flush_work(&mgr->up_req_work);
3795 flush_work(&mgr->work);
3796 flush_work(&mgr->delayed_destroy_work);
3798 mutex_lock(&mgr->lock);
3799 if (mgr->mst_state && mgr->mst_primary)
3800 drm_dp_mst_topology_mgr_invalidate_mstb(mgr->mst_primary);
3801 mutex_unlock(&mgr->lock);
3803 EXPORT_SYMBOL(drm_dp_mst_topology_mgr_suspend);
3806 * drm_dp_mst_topology_mgr_resume() - resume the MST manager
3807 * @mgr: manager to resume
3808 * @sync: whether or not to perform topology reprobing synchronously
3810 * This will fetch DPCD and see if the device is still there,
3811 * if it is, it will rewrite the MSTM control bits, and return.
3813 * If the device fails this returns -1, and the driver should do
3814 * a full MST reprobe, in case we were undocked.
3816 * During system resume (where it is assumed that the driver will be calling
3817 * drm_atomic_helper_resume()) this function should be called beforehand with
3818 * @sync set to true. In contexts like runtime resume where the driver is not
3819 * expected to be calling drm_atomic_helper_resume(), this function should be
3820 * called with @sync set to false in order to avoid deadlocking.
3822 * Returns: -1 if the MST topology was removed while we were suspended, 0
3825 int drm_dp_mst_topology_mgr_resume(struct drm_dp_mst_topology_mgr *mgr,
3831 mutex_lock(&mgr->lock);
3832 if (!mgr->mst_primary)
3835 ret = drm_dp_dpcd_read(mgr->aux, DP_DPCD_REV, mgr->dpcd,
3836 DP_RECEIVER_CAP_SIZE);
3837 if (ret != DP_RECEIVER_CAP_SIZE) {
3838 DRM_DEBUG_KMS("dpcd read failed - undocked during suspend?\n");
3842 ret = drm_dp_dpcd_writeb(mgr->aux, DP_MSTM_CTRL,
3845 DP_UPSTREAM_IS_SRC);
3847 DRM_DEBUG_KMS("mst write failed - undocked during suspend?\n");
3851 /* Some hubs forget their guids after they resume */
3852 ret = drm_dp_dpcd_read(mgr->aux, DP_GUID, guid, 16);
3854 DRM_DEBUG_KMS("dpcd read failed - undocked during suspend?\n");
3858 ret = drm_dp_check_mstb_guid(mgr->mst_primary, guid);
3860 DRM_DEBUG_KMS("check mstb failed - undocked during suspend?\n");
3865 * For the final step of resuming the topology, we need to bring the
3866 * state of our in-memory topology back into sync with reality. So,
3867 * restart the probing process as if we're probing a new hub
3869 queue_work(system_long_wq, &mgr->work);
3870 mutex_unlock(&mgr->lock);
3873 DRM_DEBUG_KMS("Waiting for link probe work to finish re-syncing topology...\n");
3874 flush_work(&mgr->work);
3880 mutex_unlock(&mgr->lock);
3883 EXPORT_SYMBOL(drm_dp_mst_topology_mgr_resume);
3886 drm_dp_get_one_sb_msg(struct drm_dp_mst_topology_mgr *mgr, bool up,
3887 struct drm_dp_mst_branch **mstb)
3891 int replylen, curreply;
3894 struct drm_dp_sideband_msg_hdr hdr;
3895 struct drm_dp_sideband_msg_rx *msg =
3896 up ? &mgr->up_req_recv : &mgr->down_rep_recv;
3897 int basereg = up ? DP_SIDEBAND_MSG_UP_REQ_BASE :
3898 DP_SIDEBAND_MSG_DOWN_REP_BASE;
3903 len = min(mgr->max_dpcd_transaction_bytes, 16);
3904 ret = drm_dp_dpcd_read(mgr->aux, basereg, replyblock, len);
3906 DRM_DEBUG_KMS("failed to read DPCD down rep %d %d\n", len, ret);
3910 ret = drm_dp_decode_sideband_msg_hdr(&hdr, replyblock, len, &hdrlen);
3912 print_hex_dump(KERN_DEBUG, "failed hdr", DUMP_PREFIX_NONE, 16,
3913 1, replyblock, len, false);
3914 DRM_DEBUG_KMS("ERROR: failed header\n");
3919 /* Caller is responsible for giving back this reference */
3920 *mstb = drm_dp_get_mst_branch_device(mgr, hdr.lct, hdr.rad);
3922 DRM_DEBUG_KMS("Got MST reply from unknown device %d\n",
3928 if (!drm_dp_sideband_msg_set_header(msg, &hdr, hdrlen)) {
3929 DRM_DEBUG_KMS("sideband msg set header failed %d\n",
3934 replylen = min(msg->curchunk_len, (u8)(len - hdrlen));
3935 ret = drm_dp_sideband_append_payload(msg, replyblock + hdrlen, replylen);
3937 DRM_DEBUG_KMS("sideband msg build failed %d\n", replyblock[0]);
3941 replylen = msg->curchunk_len + msg->curchunk_hdrlen - len;
3943 while (replylen > 0) {
3944 len = min3(replylen, mgr->max_dpcd_transaction_bytes, 16);
3945 ret = drm_dp_dpcd_read(mgr->aux, basereg + curreply,
3948 DRM_DEBUG_KMS("failed to read a chunk (len %d, ret %d)\n",
3953 ret = drm_dp_sideband_append_payload(msg, replyblock, len);
3955 DRM_DEBUG_KMS("failed to build sideband msg\n");
3965 static int drm_dp_mst_handle_down_rep(struct drm_dp_mst_topology_mgr *mgr)
3967 struct drm_dp_sideband_msg_tx *txmsg;
3968 struct drm_dp_mst_branch *mstb = NULL;
3969 struct drm_dp_sideband_msg_rx *msg = &mgr->down_rep_recv;
3971 if (!drm_dp_get_one_sb_msg(mgr, false, &mstb))
3974 /* Multi-packet message transmission, don't clear the reply */
3975 if (!msg->have_eomt)
3978 /* find the message */
3979 mutex_lock(&mgr->qlock);
3980 txmsg = list_first_entry_or_null(&mgr->tx_msg_downq,
3981 struct drm_dp_sideband_msg_tx, next);
3982 mutex_unlock(&mgr->qlock);
3984 /* Were we actually expecting a response, and from this mstb? */
3985 if (!txmsg || txmsg->dst != mstb) {
3986 struct drm_dp_sideband_msg_hdr *hdr;
3988 hdr = &msg->initial_hdr;
3989 DRM_DEBUG_KMS("Got MST reply with no msg %p %d %d %02x %02x\n",
3990 mstb, hdr->seqno, hdr->lct, hdr->rad[0],
3992 goto out_clear_reply;
3995 drm_dp_sideband_parse_reply(msg, &txmsg->reply);
3997 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK) {
3998 DRM_DEBUG_KMS("Got NAK reply: req 0x%02x (%s), reason 0x%02x (%s), nak data 0x%02x\n",
3999 txmsg->reply.req_type,
4000 drm_dp_mst_req_type_str(txmsg->reply.req_type),
4001 txmsg->reply.u.nak.reason,
4002 drm_dp_mst_nak_reason_str(txmsg->reply.u.nak.reason),
4003 txmsg->reply.u.nak.nak_data);
4006 memset(msg, 0, sizeof(struct drm_dp_sideband_msg_rx));
4007 drm_dp_mst_topology_put_mstb(mstb);
4009 mutex_lock(&mgr->qlock);
4010 txmsg->state = DRM_DP_SIDEBAND_TX_RX;
4011 list_del(&txmsg->next);
4012 mutex_unlock(&mgr->qlock);
4014 wake_up_all(&mgr->tx_waitq);
4019 memset(msg, 0, sizeof(struct drm_dp_sideband_msg_rx));
4022 drm_dp_mst_topology_put_mstb(mstb);
4028 drm_dp_mst_process_up_req(struct drm_dp_mst_topology_mgr *mgr,
4029 struct drm_dp_pending_up_req *up_req)
4031 struct drm_dp_mst_branch *mstb = NULL;
4032 struct drm_dp_sideband_msg_req_body *msg = &up_req->msg;
4033 struct drm_dp_sideband_msg_hdr *hdr = &up_req->hdr;
4034 bool hotplug = false;
4036 if (hdr->broadcast) {
4037 const u8 *guid = NULL;
4039 if (msg->req_type == DP_CONNECTION_STATUS_NOTIFY)
4040 guid = msg->u.conn_stat.guid;
4041 else if (msg->req_type == DP_RESOURCE_STATUS_NOTIFY)
4042 guid = msg->u.resource_stat.guid;
4045 mstb = drm_dp_get_mst_branch_device_by_guid(mgr, guid);
4047 mstb = drm_dp_get_mst_branch_device(mgr, hdr->lct, hdr->rad);
4051 DRM_DEBUG_KMS("Got MST reply from unknown device %d\n",
4056 /* TODO: Add missing handler for DP_RESOURCE_STATUS_NOTIFY events */
4057 if (msg->req_type == DP_CONNECTION_STATUS_NOTIFY) {
4058 drm_dp_mst_handle_conn_stat(mstb, &msg->u.conn_stat);
4062 drm_dp_mst_topology_put_mstb(mstb);
4066 static void drm_dp_mst_up_req_work(struct work_struct *work)
4068 struct drm_dp_mst_topology_mgr *mgr =
4069 container_of(work, struct drm_dp_mst_topology_mgr,
4071 struct drm_dp_pending_up_req *up_req;
4072 bool send_hotplug = false;
4074 mutex_lock(&mgr->probe_lock);
4076 mutex_lock(&mgr->up_req_lock);
4077 up_req = list_first_entry_or_null(&mgr->up_req_list,
4078 struct drm_dp_pending_up_req,
4081 list_del(&up_req->next);
4082 mutex_unlock(&mgr->up_req_lock);
4087 send_hotplug |= drm_dp_mst_process_up_req(mgr, up_req);
4090 mutex_unlock(&mgr->probe_lock);
4093 drm_kms_helper_hotplug_event(mgr->dev);
4096 static int drm_dp_mst_handle_up_req(struct drm_dp_mst_topology_mgr *mgr)
4098 struct drm_dp_pending_up_req *up_req;
4100 if (!drm_dp_get_one_sb_msg(mgr, true, NULL))
4103 if (!mgr->up_req_recv.have_eomt)
4106 up_req = kzalloc(sizeof(*up_req), GFP_KERNEL);
4108 DRM_ERROR("Not enough memory to process MST up req\n");
4111 INIT_LIST_HEAD(&up_req->next);
4113 drm_dp_sideband_parse_req(&mgr->up_req_recv, &up_req->msg);
4115 if (up_req->msg.req_type != DP_CONNECTION_STATUS_NOTIFY &&
4116 up_req->msg.req_type != DP_RESOURCE_STATUS_NOTIFY) {
4117 DRM_DEBUG_KMS("Received unknown up req type, ignoring: %x\n",
4118 up_req->msg.req_type);
4123 drm_dp_send_up_ack_reply(mgr, mgr->mst_primary, up_req->msg.req_type,
4126 if (up_req->msg.req_type == DP_CONNECTION_STATUS_NOTIFY) {
4127 const struct drm_dp_connection_status_notify *conn_stat =
4128 &up_req->msg.u.conn_stat;
4130 DRM_DEBUG_KMS("Got CSN: pn: %d ldps:%d ddps: %d mcs: %d ip: %d pdt: %d\n",
4131 conn_stat->port_number,
4132 conn_stat->legacy_device_plug_status,
4133 conn_stat->displayport_device_plug_status,
4134 conn_stat->message_capability_status,
4135 conn_stat->input_port,
4136 conn_stat->peer_device_type);
4137 } else if (up_req->msg.req_type == DP_RESOURCE_STATUS_NOTIFY) {
4138 const struct drm_dp_resource_status_notify *res_stat =
4139 &up_req->msg.u.resource_stat;
4141 DRM_DEBUG_KMS("Got RSN: pn: %d avail_pbn %d\n",
4142 res_stat->port_number,
4143 res_stat->available_pbn);
4146 up_req->hdr = mgr->up_req_recv.initial_hdr;
4147 mutex_lock(&mgr->up_req_lock);
4148 list_add_tail(&up_req->next, &mgr->up_req_list);
4149 mutex_unlock(&mgr->up_req_lock);
4150 queue_work(system_long_wq, &mgr->up_req_work);
4153 memset(&mgr->up_req_recv, 0, sizeof(struct drm_dp_sideband_msg_rx));
4158 * drm_dp_mst_hpd_irq() - MST hotplug IRQ notify
4159 * @mgr: manager to notify irq for.
4160 * @esi: 4 bytes from SINK_COUNT_ESI
4161 * @handled: whether the hpd interrupt was consumed or not
4163 * This should be called from the driver when it detects a short IRQ,
4164 * along with the value of the DEVICE_SERVICE_IRQ_VECTOR_ESI0. The
4165 * topology manager will process the sideband messages received as a result
4168 int drm_dp_mst_hpd_irq(struct drm_dp_mst_topology_mgr *mgr, u8 *esi, bool *handled)
4175 if (sc != mgr->sink_count) {
4176 mgr->sink_count = sc;
4180 if (esi[1] & DP_DOWN_REP_MSG_RDY) {
4181 ret = drm_dp_mst_handle_down_rep(mgr);
4185 if (esi[1] & DP_UP_REQ_MSG_RDY) {
4186 ret |= drm_dp_mst_handle_up_req(mgr);
4190 drm_dp_mst_kick_tx(mgr);
4193 EXPORT_SYMBOL(drm_dp_mst_hpd_irq);
4196 * drm_dp_mst_detect_port() - get connection status for an MST port
4197 * @connector: DRM connector for this port
4198 * @ctx: The acquisition context to use for grabbing locks
4199 * @mgr: manager for this port
4200 * @port: pointer to a port
4202 * This returns the current connection state for a port.
4205 drm_dp_mst_detect_port(struct drm_connector *connector,
4206 struct drm_modeset_acquire_ctx *ctx,
4207 struct drm_dp_mst_topology_mgr *mgr,
4208 struct drm_dp_mst_port *port)
4212 /* we need to search for the port in the mgr in case it's gone */
4213 port = drm_dp_mst_topology_get_port_validated(mgr, port);
4215 return connector_status_disconnected;
4217 ret = drm_modeset_lock(&mgr->base.lock, ctx);
4221 ret = connector_status_disconnected;
4226 switch (port->pdt) {
4227 case DP_PEER_DEVICE_NONE:
4228 case DP_PEER_DEVICE_MST_BRANCHING:
4230 ret = connector_status_connected;
4233 case DP_PEER_DEVICE_SST_SINK:
4234 ret = connector_status_connected;
4235 /* for logical ports - cache the EDID */
4236 if (port->port_num >= 8 && !port->cached_edid) {
4237 port->cached_edid = drm_get_edid(connector, &port->aux.ddc);
4240 case DP_PEER_DEVICE_DP_LEGACY_CONV:
4242 ret = connector_status_connected;
4246 drm_dp_mst_topology_put_port(port);
4249 EXPORT_SYMBOL(drm_dp_mst_detect_port);
4252 * drm_dp_mst_get_edid() - get EDID for an MST port
4253 * @connector: toplevel connector to get EDID for
4254 * @mgr: manager for this port
4255 * @port: unverified pointer to a port.
4257 * This returns an EDID for the port connected to a connector,
4258 * It validates the pointer still exists so the caller doesn't require a
4261 struct edid *drm_dp_mst_get_edid(struct drm_connector *connector, struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port)
4263 struct edid *edid = NULL;
4265 /* we need to search for the port in the mgr in case it's gone */
4266 port = drm_dp_mst_topology_get_port_validated(mgr, port);
4270 if (port->cached_edid)
4271 edid = drm_edid_duplicate(port->cached_edid);
4273 edid = drm_get_edid(connector, &port->aux.ddc);
4275 port->has_audio = drm_detect_monitor_audio(edid);
4276 drm_dp_mst_topology_put_port(port);
4279 EXPORT_SYMBOL(drm_dp_mst_get_edid);
4282 * drm_dp_find_vcpi_slots() - Find VCPI slots for this PBN value
4283 * @mgr: manager to use
4284 * @pbn: payload bandwidth to convert into slots.
4286 * Calculate the number of VCPI slots that will be required for the given PBN
4287 * value. This function is deprecated, and should not be used in atomic
4291 * The total slots required for this port, or error.
4293 int drm_dp_find_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr,
4298 num_slots = DIV_ROUND_UP(pbn, mgr->pbn_div);
4300 /* max. time slots - one slot for MTP header */
4305 EXPORT_SYMBOL(drm_dp_find_vcpi_slots);
4307 static int drm_dp_init_vcpi(struct drm_dp_mst_topology_mgr *mgr,
4308 struct drm_dp_vcpi *vcpi, int pbn, int slots)
4312 /* max. time slots - one slot for MTP header */
4317 vcpi->aligned_pbn = slots * mgr->pbn_div;
4318 vcpi->num_slots = slots;
4320 ret = drm_dp_mst_assign_payload_id(mgr, vcpi);
4327 * drm_dp_atomic_find_vcpi_slots() - Find and add VCPI slots to the state
4328 * @state: global atomic state
4329 * @mgr: MST topology manager for the port
4330 * @port: port to find vcpi slots for
4331 * @pbn: bandwidth required for the mode in PBN
4332 * @pbn_div: divider for DSC mode that takes FEC into account
4334 * Allocates VCPI slots to @port, replacing any previous VCPI allocations it
4335 * may have had. Any atomic drivers which support MST must call this function
4336 * in their &drm_encoder_helper_funcs.atomic_check() callback to change the
4337 * current VCPI allocation for the new state, but only when
4338 * &drm_crtc_state.mode_changed or &drm_crtc_state.connectors_changed is set
4339 * to ensure compatibility with userspace applications that still use the
4340 * legacy modesetting UAPI.
4342 * Allocations set by this function are not checked against the bandwidth
4343 * restraints of @mgr until the driver calls drm_dp_mst_atomic_check().
4345 * Additionally, it is OK to call this function multiple times on the same
4346 * @port as needed. It is not OK however, to call this function and
4347 * drm_dp_atomic_release_vcpi_slots() in the same atomic check phase.
4350 * drm_dp_atomic_release_vcpi_slots()
4351 * drm_dp_mst_atomic_check()
4354 * Total slots in the atomic state assigned for this port, or a negative error
4355 * code if the port no longer exists
4357 int drm_dp_atomic_find_vcpi_slots(struct drm_atomic_state *state,
4358 struct drm_dp_mst_topology_mgr *mgr,
4359 struct drm_dp_mst_port *port, int pbn,
4362 struct drm_dp_mst_topology_state *topology_state;
4363 struct drm_dp_vcpi_allocation *pos, *vcpi = NULL;
4364 int prev_slots, prev_bw, req_slots;
4366 topology_state = drm_atomic_get_mst_topology_state(state, mgr);
4367 if (IS_ERR(topology_state))
4368 return PTR_ERR(topology_state);
4370 /* Find the current allocation for this port, if any */
4371 list_for_each_entry(pos, &topology_state->vcpis, next) {
4372 if (pos->port == port) {
4374 prev_slots = vcpi->vcpi;
4375 prev_bw = vcpi->pbn;
4378 * This should never happen, unless the driver tries
4379 * releasing and allocating the same VCPI allocation,
4382 if (WARN_ON(!prev_slots)) {
4383 DRM_ERROR("cannot allocate and release VCPI on [MST PORT:%p] in the same state\n",
4397 pbn_div = mgr->pbn_div;
4399 req_slots = DIV_ROUND_UP(pbn, pbn_div);
4401 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] [MST PORT:%p] VCPI %d -> %d\n",
4402 port->connector->base.id, port->connector->name,
4403 port, prev_slots, req_slots);
4404 DRM_DEBUG_ATOMIC("[CONNECTOR:%d:%s] [MST PORT:%p] PBN %d -> %d\n",
4405 port->connector->base.id, port->connector->name,
4406 port, prev_bw, pbn);
4408 /* Add the new allocation to the state */
4410 vcpi = kzalloc(sizeof(*vcpi), GFP_KERNEL);
4414 drm_dp_mst_get_port_malloc(port);
4416 list_add(&vcpi->next, &topology_state->vcpis);
4418 vcpi->vcpi = req_slots;
4423 EXPORT_SYMBOL(drm_dp_atomic_find_vcpi_slots);
4426 * drm_dp_atomic_release_vcpi_slots() - Release allocated vcpi slots
4427 * @state: global atomic state
4428 * @mgr: MST topology manager for the port
4429 * @port: The port to release the VCPI slots from
4431 * Releases any VCPI slots that have been allocated to a port in the atomic
4432 * state. Any atomic drivers which support MST must call this function in
4433 * their &drm_connector_helper_funcs.atomic_check() callback when the
4434 * connector will no longer have VCPI allocated (e.g. because its CRTC was
4435 * removed) when it had VCPI allocated in the previous atomic state.
4437 * It is OK to call this even if @port has been removed from the system.
4438 * Additionally, it is OK to call this function multiple times on the same
4439 * @port as needed. It is not OK however, to call this function and
4440 * drm_dp_atomic_find_vcpi_slots() on the same @port in a single atomic check
4444 * drm_dp_atomic_find_vcpi_slots()
4445 * drm_dp_mst_atomic_check()
4448 * 0 if all slots for this port were added back to
4449 * &drm_dp_mst_topology_state.avail_slots or negative error code
4451 int drm_dp_atomic_release_vcpi_slots(struct drm_atomic_state *state,
4452 struct drm_dp_mst_topology_mgr *mgr,
4453 struct drm_dp_mst_port *port)
4455 struct drm_dp_mst_topology_state *topology_state;
4456 struct drm_dp_vcpi_allocation *pos;
4459 topology_state = drm_atomic_get_mst_topology_state(state, mgr);
4460 if (IS_ERR(topology_state))
4461 return PTR_ERR(topology_state);
4463 list_for_each_entry(pos, &topology_state->vcpis, next) {
4464 if (pos->port == port) {
4469 if (WARN_ON(!found)) {
4470 DRM_ERROR("no VCPI for [MST PORT:%p] found in mst state %p\n",
4471 port, &topology_state->base);
4475 DRM_DEBUG_ATOMIC("[MST PORT:%p] VCPI %d -> 0\n", port, pos->vcpi);
4477 drm_dp_mst_put_port_malloc(port);
4484 EXPORT_SYMBOL(drm_dp_atomic_release_vcpi_slots);
4487 * drm_dp_mst_allocate_vcpi() - Allocate a virtual channel
4488 * @mgr: manager for this port
4489 * @port: port to allocate a virtual channel for.
4490 * @pbn: payload bandwidth number to request
4491 * @slots: returned number of slots for this PBN.
4493 bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
4494 struct drm_dp_mst_port *port, int pbn, int slots)
4501 port = drm_dp_mst_topology_get_port_validated(mgr, port);
4505 if (port->vcpi.vcpi > 0) {
4506 DRM_DEBUG_KMS("payload: vcpi %d already allocated for pbn %d - requested pbn %d\n",
4507 port->vcpi.vcpi, port->vcpi.pbn, pbn);
4508 if (pbn == port->vcpi.pbn) {
4509 drm_dp_mst_topology_put_port(port);
4514 ret = drm_dp_init_vcpi(mgr, &port->vcpi, pbn, slots);
4516 DRM_DEBUG_KMS("failed to init vcpi slots=%d max=63 ret=%d\n",
4517 DIV_ROUND_UP(pbn, mgr->pbn_div), ret);
4518 drm_dp_mst_topology_put_port(port);
4521 DRM_DEBUG_KMS("initing vcpi for pbn=%d slots=%d\n",
4522 pbn, port->vcpi.num_slots);
4524 /* Keep port allocated until its payload has been removed */
4525 drm_dp_mst_get_port_malloc(port);
4526 drm_dp_mst_topology_put_port(port);
4531 EXPORT_SYMBOL(drm_dp_mst_allocate_vcpi);
4533 int drm_dp_mst_get_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port)
4537 port = drm_dp_mst_topology_get_port_validated(mgr, port);
4541 slots = port->vcpi.num_slots;
4542 drm_dp_mst_topology_put_port(port);
4545 EXPORT_SYMBOL(drm_dp_mst_get_vcpi_slots);
4548 * drm_dp_mst_reset_vcpi_slots() - Reset number of slots to 0 for VCPI
4549 * @mgr: manager for this port
4550 * @port: unverified pointer to a port.
4552 * This just resets the number of slots for the ports VCPI for later programming.
4554 void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port)
4557 * A port with VCPI will remain allocated until its VCPI is
4558 * released, no verified ref needed
4561 port->vcpi.num_slots = 0;
4563 EXPORT_SYMBOL(drm_dp_mst_reset_vcpi_slots);
4566 * drm_dp_mst_deallocate_vcpi() - deallocate a VCPI
4567 * @mgr: manager for this port
4568 * @port: port to deallocate vcpi for
4570 * This can be called unconditionally, regardless of whether
4571 * drm_dp_mst_allocate_vcpi() succeeded or not.
4573 void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
4574 struct drm_dp_mst_port *port)
4576 if (!port->vcpi.vcpi)
4579 drm_dp_mst_put_payload_id(mgr, port->vcpi.vcpi);
4580 port->vcpi.num_slots = 0;
4582 port->vcpi.aligned_pbn = 0;
4583 port->vcpi.vcpi = 0;
4584 drm_dp_mst_put_port_malloc(port);
4586 EXPORT_SYMBOL(drm_dp_mst_deallocate_vcpi);
4588 static int drm_dp_dpcd_write_payload(struct drm_dp_mst_topology_mgr *mgr,
4589 int id, struct drm_dp_payload *payload)
4591 u8 payload_alloc[3], status;
4595 drm_dp_dpcd_writeb(mgr->aux, DP_PAYLOAD_TABLE_UPDATE_STATUS,
4596 DP_PAYLOAD_TABLE_UPDATED);
4598 payload_alloc[0] = id;
4599 payload_alloc[1] = payload->start_slot;
4600 payload_alloc[2] = payload->num_slots;
4602 ret = drm_dp_dpcd_write(mgr->aux, DP_PAYLOAD_ALLOCATE_SET, payload_alloc, 3);
4604 DRM_DEBUG_KMS("failed to write payload allocation %d\n", ret);
4609 ret = drm_dp_dpcd_readb(mgr->aux, DP_PAYLOAD_TABLE_UPDATE_STATUS, &status);
4611 DRM_DEBUG_KMS("failed to read payload table status %d\n", ret);
4615 if (!(status & DP_PAYLOAD_TABLE_UPDATED)) {
4618 usleep_range(10000, 20000);
4621 DRM_DEBUG_KMS("status not set after read payload table status %d\n", status);
4630 static int do_get_act_status(struct drm_dp_aux *aux)
4635 ret = drm_dp_dpcd_readb(aux, DP_PAYLOAD_TABLE_UPDATE_STATUS, &status);
4643 * drm_dp_check_act_status() - Polls for ACT handled status.
4644 * @mgr: manager to use
4646 * Tries waiting for the MST hub to finish updating it's payload table by
4647 * polling for the ACT handled bit for up to 3 seconds (yes-some hubs really
4651 * 0 if the ACT was handled in time, negative error code on failure.
4653 int drm_dp_check_act_status(struct drm_dp_mst_topology_mgr *mgr)
4656 * There doesn't seem to be any recommended retry count or timeout in
4657 * the MST specification. Since some hubs have been observed to take
4658 * over 1 second to update their payload allocations under certain
4659 * conditions, we use a rather large timeout value.
4661 const int timeout_ms = 3000;
4664 ret = readx_poll_timeout(do_get_act_status, mgr->aux, status,
4665 status & DP_PAYLOAD_ACT_HANDLED || status < 0,
4666 200, timeout_ms * USEC_PER_MSEC);
4667 if (ret < 0 && status >= 0) {
4668 DRM_ERROR("Failed to get ACT after %dms, last status: %02x\n",
4669 timeout_ms, status);
4671 } else if (status < 0) {
4673 * Failure here isn't unexpected - the hub may have
4674 * just been unplugged
4676 DRM_DEBUG_KMS("Failed to read payload table status: %d\n",
4683 EXPORT_SYMBOL(drm_dp_check_act_status);
4686 * drm_dp_calc_pbn_mode() - Calculate the PBN for a mode.
4687 * @clock: dot clock for the mode
4688 * @bpp: bpp for the mode.
4689 * @dsc: DSC mode. If true, bpp has units of 1/16 of a bit per pixel
4691 * This uses the formula in the spec to calculate the PBN value for a mode.
4693 int drm_dp_calc_pbn_mode(int clock, int bpp, bool dsc)
4696 * margin 5300ppm + 300ppm ~ 0.6% as per spec, factor is 1.006
4697 * The unit of 54/64Mbytes/sec is an arbitrary unit chosen based on
4698 * common multiplier to render an integer PBN for all link rate/lane
4699 * counts combinations
4701 * peak_kbps *= (1006/1000)
4702 * peak_kbps *= (64/54)
4703 * peak_kbps *= 8 convert to bytes
4705 * If the bpp is in units of 1/16, further divide by 16. Put this
4706 * factor in the numerator rather than the denominator to avoid
4711 return DIV_ROUND_UP_ULL(mul_u32_u32(clock * (bpp / 16), 64 * 1006),
4712 8 * 54 * 1000 * 1000);
4714 return DIV_ROUND_UP_ULL(mul_u32_u32(clock * bpp, 64 * 1006),
4715 8 * 54 * 1000 * 1000);
4717 EXPORT_SYMBOL(drm_dp_calc_pbn_mode);
4719 /* we want to kick the TX after we've ack the up/down IRQs. */
4720 static void drm_dp_mst_kick_tx(struct drm_dp_mst_topology_mgr *mgr)
4722 queue_work(system_long_wq, &mgr->tx_work);
4725 static void drm_dp_mst_dump_mstb(struct seq_file *m,
4726 struct drm_dp_mst_branch *mstb)
4728 struct drm_dp_mst_port *port;
4729 int tabs = mstb->lct;
4733 for (i = 0; i < tabs; i++)
4737 seq_printf(m, "%smst: %p, %d\n", prefix, mstb, mstb->num_ports);
4738 list_for_each_entry(port, &mstb->ports, next) {
4739 seq_printf(m, "%sport: %d: input: %d: pdt: %d, ddps: %d ldps: %d, sdp: %d/%d, %p, conn: %p\n", prefix, port->port_num, port->input, port->pdt, port->ddps, port->ldps, port->num_sdp_streams, port->num_sdp_stream_sinks, port, port->connector);
4741 drm_dp_mst_dump_mstb(m, port->mstb);
4745 #define DP_PAYLOAD_TABLE_SIZE 64
4747 static bool dump_dp_payload_table(struct drm_dp_mst_topology_mgr *mgr,
4752 for (i = 0; i < DP_PAYLOAD_TABLE_SIZE; i += 16) {
4753 if (drm_dp_dpcd_read(mgr->aux,
4754 DP_PAYLOAD_TABLE_UPDATE_STATUS + i,
4761 static void fetch_monitor_name(struct drm_dp_mst_topology_mgr *mgr,
4762 struct drm_dp_mst_port *port, char *name,
4765 struct edid *mst_edid;
4767 mst_edid = drm_dp_mst_get_edid(port->connector, mgr, port);
4768 drm_edid_get_monitor_name(mst_edid, name, namelen);
4772 * drm_dp_mst_dump_topology(): dump topology to seq file.
4773 * @m: seq_file to dump output to
4774 * @mgr: manager to dump current topology for.
4776 * helper to dump MST topology to a seq file for debugfs.
4778 void drm_dp_mst_dump_topology(struct seq_file *m,
4779 struct drm_dp_mst_topology_mgr *mgr)
4782 struct drm_dp_mst_port *port;
4784 mutex_lock(&mgr->lock);
4785 if (mgr->mst_primary)
4786 drm_dp_mst_dump_mstb(m, mgr->mst_primary);
4789 mutex_unlock(&mgr->lock);
4791 mutex_lock(&mgr->payload_lock);
4792 seq_printf(m, "vcpi: %lx %lx %d\n", mgr->payload_mask, mgr->vcpi_mask,
4795 for (i = 0; i < mgr->max_payloads; i++) {
4796 if (mgr->proposed_vcpis[i]) {
4799 port = container_of(mgr->proposed_vcpis[i], struct drm_dp_mst_port, vcpi);
4800 fetch_monitor_name(mgr, port, name, sizeof(name));
4801 seq_printf(m, "vcpi %d: %d %d %d sink name: %s\n", i,
4802 port->port_num, port->vcpi.vcpi,
4803 port->vcpi.num_slots,
4804 (*name != 0) ? name : "Unknown");
4806 seq_printf(m, "vcpi %d:unused\n", i);
4808 for (i = 0; i < mgr->max_payloads; i++) {
4809 seq_printf(m, "payload %d: %d, %d, %d\n",
4811 mgr->payloads[i].payload_state,
4812 mgr->payloads[i].start_slot,
4813 mgr->payloads[i].num_slots);
4817 mutex_unlock(&mgr->payload_lock);
4819 mutex_lock(&mgr->lock);
4820 if (mgr->mst_primary) {
4821 u8 buf[DP_PAYLOAD_TABLE_SIZE];
4824 ret = drm_dp_dpcd_read(mgr->aux, DP_DPCD_REV, buf, DP_RECEIVER_CAP_SIZE);
4826 seq_printf(m, "dpcd read failed\n");
4829 seq_printf(m, "dpcd: %*ph\n", DP_RECEIVER_CAP_SIZE, buf);
4831 ret = drm_dp_dpcd_read(mgr->aux, DP_FAUX_CAP, buf, 2);
4833 seq_printf(m, "faux/mst read failed\n");
4836 seq_printf(m, "faux/mst: %*ph\n", 2, buf);
4838 ret = drm_dp_dpcd_read(mgr->aux, DP_MSTM_CTRL, buf, 1);
4840 seq_printf(m, "mst ctrl read failed\n");
4843 seq_printf(m, "mst ctrl: %*ph\n", 1, buf);
4845 /* dump the standard OUI branch header */
4846 ret = drm_dp_dpcd_read(mgr->aux, DP_BRANCH_OUI, buf, DP_BRANCH_OUI_HEADER_SIZE);
4848 seq_printf(m, "branch oui read failed\n");
4851 seq_printf(m, "branch oui: %*phN devid: ", 3, buf);
4853 for (i = 0x3; i < 0x8 && buf[i]; i++)
4854 seq_printf(m, "%c", buf[i]);
4855 seq_printf(m, " revision: hw: %x.%x sw: %x.%x\n",
4856 buf[0x9] >> 4, buf[0x9] & 0xf, buf[0xa], buf[0xb]);
4857 if (dump_dp_payload_table(mgr, buf))
4858 seq_printf(m, "payload table: %*ph\n", DP_PAYLOAD_TABLE_SIZE, buf);
4862 mutex_unlock(&mgr->lock);
4865 EXPORT_SYMBOL(drm_dp_mst_dump_topology);
4867 static void drm_dp_tx_work(struct work_struct *work)
4869 struct drm_dp_mst_topology_mgr *mgr = container_of(work, struct drm_dp_mst_topology_mgr, tx_work);
4871 mutex_lock(&mgr->qlock);
4872 if (!list_empty(&mgr->tx_msg_downq))
4873 process_single_down_tx_qlock(mgr);
4874 mutex_unlock(&mgr->qlock);
4878 drm_dp_delayed_destroy_port(struct drm_dp_mst_port *port)
4880 drm_dp_port_set_pdt(port, DP_PEER_DEVICE_NONE, port->mcs);
4882 if (port->connector) {
4883 drm_connector_unregister(port->connector);
4884 drm_connector_put(port->connector);
4887 drm_dp_mst_put_port_malloc(port);
4891 drm_dp_delayed_destroy_mstb(struct drm_dp_mst_branch *mstb)
4893 struct drm_dp_mst_topology_mgr *mgr = mstb->mgr;
4894 struct drm_dp_mst_port *port, *port_tmp;
4895 struct drm_dp_sideband_msg_tx *txmsg, *txmsg_tmp;
4896 bool wake_tx = false;
4898 mutex_lock(&mgr->lock);
4899 list_for_each_entry_safe(port, port_tmp, &mstb->ports, next) {
4900 list_del(&port->next);
4901 drm_dp_mst_topology_put_port(port);
4903 mutex_unlock(&mgr->lock);
4905 /* drop any tx slot msg */
4906 mutex_lock(&mstb->mgr->qlock);
4907 list_for_each_entry_safe(txmsg, txmsg_tmp, &mgr->tx_msg_downq, next) {
4908 if (txmsg->dst != mstb)
4911 txmsg->state = DRM_DP_SIDEBAND_TX_TIMEOUT;
4912 list_del(&txmsg->next);
4915 mutex_unlock(&mstb->mgr->qlock);
4918 wake_up_all(&mstb->mgr->tx_waitq);
4920 drm_dp_mst_put_mstb_malloc(mstb);
4923 static void drm_dp_delayed_destroy_work(struct work_struct *work)
4925 struct drm_dp_mst_topology_mgr *mgr =
4926 container_of(work, struct drm_dp_mst_topology_mgr,
4927 delayed_destroy_work);
4928 bool send_hotplug = false, go_again;
4931 * Not a regular list traverse as we have to drop the destroy
4932 * connector lock before destroying the mstb/port, to avoid AB->BA
4933 * ordering between this lock and the config mutex.
4939 struct drm_dp_mst_branch *mstb;
4941 mutex_lock(&mgr->delayed_destroy_lock);
4942 mstb = list_first_entry_or_null(&mgr->destroy_branch_device_list,
4943 struct drm_dp_mst_branch,
4946 list_del(&mstb->destroy_next);
4947 mutex_unlock(&mgr->delayed_destroy_lock);
4952 drm_dp_delayed_destroy_mstb(mstb);
4957 struct drm_dp_mst_port *port;
4959 mutex_lock(&mgr->delayed_destroy_lock);
4960 port = list_first_entry_or_null(&mgr->destroy_port_list,
4961 struct drm_dp_mst_port,
4964 list_del(&port->next);
4965 mutex_unlock(&mgr->delayed_destroy_lock);
4970 drm_dp_delayed_destroy_port(port);
4971 send_hotplug = true;
4977 drm_kms_helper_hotplug_event(mgr->dev);
4980 static struct drm_private_state *
4981 drm_dp_mst_duplicate_state(struct drm_private_obj *obj)
4983 struct drm_dp_mst_topology_state *state, *old_state =
4984 to_dp_mst_topology_state(obj->state);
4985 struct drm_dp_vcpi_allocation *pos, *vcpi;
4987 state = kmemdup(old_state, sizeof(*state), GFP_KERNEL);
4991 __drm_atomic_helper_private_obj_duplicate_state(obj, &state->base);
4993 INIT_LIST_HEAD(&state->vcpis);
4995 list_for_each_entry(pos, &old_state->vcpis, next) {
4996 /* Prune leftover freed VCPI allocations */
5000 vcpi = kmemdup(pos, sizeof(*vcpi), GFP_KERNEL);
5004 drm_dp_mst_get_port_malloc(vcpi->port);
5005 list_add(&vcpi->next, &state->vcpis);
5008 return &state->base;
5011 list_for_each_entry_safe(pos, vcpi, &state->vcpis, next) {
5012 drm_dp_mst_put_port_malloc(pos->port);
5020 static void drm_dp_mst_destroy_state(struct drm_private_obj *obj,
5021 struct drm_private_state *state)
5023 struct drm_dp_mst_topology_state *mst_state =
5024 to_dp_mst_topology_state(state);
5025 struct drm_dp_vcpi_allocation *pos, *tmp;
5027 list_for_each_entry_safe(pos, tmp, &mst_state->vcpis, next) {
5028 /* We only keep references to ports with non-zero VCPIs */
5030 drm_dp_mst_put_port_malloc(pos->port);
5037 static bool drm_dp_mst_port_downstream_of_branch(struct drm_dp_mst_port *port,
5038 struct drm_dp_mst_branch *branch)
5040 while (port->parent) {
5041 if (port->parent == branch)
5044 if (port->parent->port_parent)
5045 port = port->parent->port_parent;
5053 drm_dp_mst_atomic_check_port_bw_limit(struct drm_dp_mst_port *port,
5054 struct drm_dp_mst_topology_state *state);
5057 drm_dp_mst_atomic_check_mstb_bw_limit(struct drm_dp_mst_branch *mstb,
5058 struct drm_dp_mst_topology_state *state)
5060 struct drm_dp_vcpi_allocation *vcpi;
5061 struct drm_dp_mst_port *port;
5062 int pbn_used = 0, ret;
5065 /* Check that we have at least one port in our state that's downstream
5066 * of this branch, otherwise we can skip this branch
5068 list_for_each_entry(vcpi, &state->vcpis, next) {
5070 !drm_dp_mst_port_downstream_of_branch(vcpi->port, mstb))
5079 if (mstb->port_parent)
5080 DRM_DEBUG_ATOMIC("[MSTB:%p] [MST PORT:%p] Checking bandwidth limits on [MSTB:%p]\n",
5081 mstb->port_parent->parent, mstb->port_parent,
5084 DRM_DEBUG_ATOMIC("[MSTB:%p] Checking bandwidth limits\n",
5087 list_for_each_entry(port, &mstb->ports, next) {
5088 ret = drm_dp_mst_atomic_check_port_bw_limit(port, state);
5099 drm_dp_mst_atomic_check_port_bw_limit(struct drm_dp_mst_port *port,
5100 struct drm_dp_mst_topology_state *state)
5102 struct drm_dp_vcpi_allocation *vcpi;
5105 if (port->pdt == DP_PEER_DEVICE_NONE)
5108 if (drm_dp_mst_is_end_device(port->pdt, port->mcs)) {
5111 list_for_each_entry(vcpi, &state->vcpis, next) {
5112 if (vcpi->port != port)
5123 /* This should never happen, as it means we tried to
5124 * set a mode before querying the full_pbn
5126 if (WARN_ON(!port->full_pbn))
5129 pbn_used = vcpi->pbn;
5131 pbn_used = drm_dp_mst_atomic_check_mstb_bw_limit(port->mstb,
5137 if (pbn_used > port->full_pbn) {
5138 DRM_DEBUG_ATOMIC("[MSTB:%p] [MST PORT:%p] required PBN of %d exceeds port limit of %d\n",
5139 port->parent, port, pbn_used,
5144 DRM_DEBUG_ATOMIC("[MSTB:%p] [MST PORT:%p] uses %d out of %d PBN\n",
5145 port->parent, port, pbn_used, port->full_pbn);
5151 drm_dp_mst_atomic_check_vcpi_alloc_limit(struct drm_dp_mst_topology_mgr *mgr,
5152 struct drm_dp_mst_topology_state *mst_state)
5154 struct drm_dp_vcpi_allocation *vcpi;
5155 int avail_slots = 63, payload_count = 0;
5157 list_for_each_entry(vcpi, &mst_state->vcpis, next) {
5158 /* Releasing VCPI is always OK-even if the port is gone */
5160 DRM_DEBUG_ATOMIC("[MST PORT:%p] releases all VCPI slots\n",
5165 DRM_DEBUG_ATOMIC("[MST PORT:%p] requires %d vcpi slots\n",
5166 vcpi->port, vcpi->vcpi);
5168 avail_slots -= vcpi->vcpi;
5169 if (avail_slots < 0) {
5170 DRM_DEBUG_ATOMIC("[MST PORT:%p] not enough VCPI slots in mst state %p (avail=%d)\n",
5171 vcpi->port, mst_state,
5172 avail_slots + vcpi->vcpi);
5176 if (++payload_count > mgr->max_payloads) {
5177 DRM_DEBUG_ATOMIC("[MST MGR:%p] state %p has too many payloads (max=%d)\n",
5178 mgr, mst_state, mgr->max_payloads);
5182 DRM_DEBUG_ATOMIC("[MST MGR:%p] mst state %p VCPI avail=%d used=%d\n",
5183 mgr, mst_state, avail_slots,
5190 * drm_dp_mst_add_affected_dsc_crtcs
5191 * @state: Pointer to the new struct drm_dp_mst_topology_state
5192 * @mgr: MST topology manager
5194 * Whenever there is a change in mst topology
5195 * DSC configuration would have to be recalculated
5196 * therefore we need to trigger modeset on all affected
5197 * CRTCs in that topology
5200 * drm_dp_mst_atomic_enable_dsc()
5202 int drm_dp_mst_add_affected_dsc_crtcs(struct drm_atomic_state *state, struct drm_dp_mst_topology_mgr *mgr)
5204 struct drm_dp_mst_topology_state *mst_state;
5205 struct drm_dp_vcpi_allocation *pos;
5206 struct drm_connector *connector;
5207 struct drm_connector_state *conn_state;
5208 struct drm_crtc *crtc;
5209 struct drm_crtc_state *crtc_state;
5211 mst_state = drm_atomic_get_mst_topology_state(state, mgr);
5213 if (IS_ERR(mst_state))
5216 list_for_each_entry(pos, &mst_state->vcpis, next) {
5218 connector = pos->port->connector;
5223 conn_state = drm_atomic_get_connector_state(state, connector);
5225 if (IS_ERR(conn_state))
5226 return PTR_ERR(conn_state);
5228 crtc = conn_state->crtc;
5233 if (!drm_dp_mst_dsc_aux_for_port(pos->port))
5236 crtc_state = drm_atomic_get_crtc_state(mst_state->base.state, crtc);
5238 if (IS_ERR(crtc_state))
5239 return PTR_ERR(crtc_state);
5241 DRM_DEBUG_ATOMIC("[MST MGR:%p] Setting mode_changed flag on CRTC %p\n",
5244 crtc_state->mode_changed = true;
5248 EXPORT_SYMBOL(drm_dp_mst_add_affected_dsc_crtcs);
5251 * drm_dp_mst_atomic_enable_dsc - Set DSC Enable Flag to On/Off
5252 * @state: Pointer to the new drm_atomic_state
5253 * @port: Pointer to the affected MST Port
5254 * @pbn: Newly recalculated bw required for link with DSC enabled
5255 * @pbn_div: Divider to calculate correct number of pbn per slot
5256 * @enable: Boolean flag to enable or disable DSC on the port
5258 * This function enables DSC on the given Port
5259 * by recalculating its vcpi from pbn provided
5260 * and sets dsc_enable flag to keep track of which
5261 * ports have DSC enabled
5264 int drm_dp_mst_atomic_enable_dsc(struct drm_atomic_state *state,
5265 struct drm_dp_mst_port *port,
5266 int pbn, int pbn_div,
5269 struct drm_dp_mst_topology_state *mst_state;
5270 struct drm_dp_vcpi_allocation *pos;
5274 mst_state = drm_atomic_get_mst_topology_state(state, port->mgr);
5276 if (IS_ERR(mst_state))
5277 return PTR_ERR(mst_state);
5279 list_for_each_entry(pos, &mst_state->vcpis, next) {
5280 if (pos->port == port) {
5287 DRM_DEBUG_ATOMIC("[MST PORT:%p] Couldn't find VCPI allocation in mst state %p\n",
5292 if (pos->dsc_enabled == enable) {
5293 DRM_DEBUG_ATOMIC("[MST PORT:%p] DSC flag is already set to %d, returning %d VCPI slots\n",
5294 port, enable, pos->vcpi);
5299 vcpi = drm_dp_atomic_find_vcpi_slots(state, port->mgr, port, pbn, pbn_div);
5300 DRM_DEBUG_ATOMIC("[MST PORT:%p] Enabling DSC flag, reallocating %d VCPI slots on the port\n",
5306 pos->dsc_enabled = enable;
5310 EXPORT_SYMBOL(drm_dp_mst_atomic_enable_dsc);
5312 * drm_dp_mst_atomic_check - Check that the new state of an MST topology in an
5313 * atomic update is valid
5314 * @state: Pointer to the new &struct drm_dp_mst_topology_state
5316 * Checks the given topology state for an atomic update to ensure that it's
5317 * valid. This includes checking whether there's enough bandwidth to support
5318 * the new VCPI allocations in the atomic update.
5320 * Any atomic drivers supporting DP MST must make sure to call this after
5321 * checking the rest of their state in their
5322 * &drm_mode_config_funcs.atomic_check() callback.
5325 * drm_dp_atomic_find_vcpi_slots()
5326 * drm_dp_atomic_release_vcpi_slots()
5330 * 0 if the new state is valid, negative error code otherwise.
5332 int drm_dp_mst_atomic_check(struct drm_atomic_state *state)
5334 struct drm_dp_mst_topology_mgr *mgr;
5335 struct drm_dp_mst_topology_state *mst_state;
5338 for_each_new_mst_mgr_in_state(state, mgr, mst_state, i) {
5339 if (!mgr->mst_state)
5342 ret = drm_dp_mst_atomic_check_vcpi_alloc_limit(mgr, mst_state);
5346 mutex_lock(&mgr->lock);
5347 ret = drm_dp_mst_atomic_check_mstb_bw_limit(mgr->mst_primary,
5349 mutex_unlock(&mgr->lock);
5358 EXPORT_SYMBOL(drm_dp_mst_atomic_check);
5360 const struct drm_private_state_funcs drm_dp_mst_topology_state_funcs = {
5361 .atomic_duplicate_state = drm_dp_mst_duplicate_state,
5362 .atomic_destroy_state = drm_dp_mst_destroy_state,
5364 EXPORT_SYMBOL(drm_dp_mst_topology_state_funcs);
5367 * drm_atomic_get_mst_topology_state: get MST topology state
5369 * @state: global atomic state
5370 * @mgr: MST topology manager, also the private object in this case
5372 * This function wraps drm_atomic_get_priv_obj_state() passing in the MST atomic
5373 * state vtable so that the private object state returned is that of a MST
5374 * topology object. Also, drm_atomic_get_private_obj_state() expects the caller
5375 * to care of the locking, so warn if don't hold the connection_mutex.
5379 * The MST topology state or error pointer.
5381 struct drm_dp_mst_topology_state *drm_atomic_get_mst_topology_state(struct drm_atomic_state *state,
5382 struct drm_dp_mst_topology_mgr *mgr)
5384 return to_dp_mst_topology_state(drm_atomic_get_private_obj_state(state, &mgr->base));
5386 EXPORT_SYMBOL(drm_atomic_get_mst_topology_state);
5389 * drm_dp_mst_topology_mgr_init - initialise a topology manager
5390 * @mgr: manager struct to initialise
5391 * @dev: device providing this structure - for i2c addition.
5392 * @aux: DP helper aux channel to talk to this device
5393 * @max_dpcd_transaction_bytes: hw specific DPCD transaction limit
5394 * @max_payloads: maximum number of payloads this GPU can source
5395 * @conn_base_id: the connector object ID the MST device is connected to.
5397 * Return 0 for success, or negative error code on failure
5399 int drm_dp_mst_topology_mgr_init(struct drm_dp_mst_topology_mgr *mgr,
5400 struct drm_device *dev, struct drm_dp_aux *aux,
5401 int max_dpcd_transaction_bytes,
5402 int max_payloads, int conn_base_id)
5404 struct drm_dp_mst_topology_state *mst_state;
5406 mutex_init(&mgr->lock);
5407 mutex_init(&mgr->qlock);
5408 mutex_init(&mgr->payload_lock);
5409 mutex_init(&mgr->delayed_destroy_lock);
5410 mutex_init(&mgr->up_req_lock);
5411 mutex_init(&mgr->probe_lock);
5412 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
5413 mutex_init(&mgr->topology_ref_history_lock);
5415 INIT_LIST_HEAD(&mgr->tx_msg_downq);
5416 INIT_LIST_HEAD(&mgr->destroy_port_list);
5417 INIT_LIST_HEAD(&mgr->destroy_branch_device_list);
5418 INIT_LIST_HEAD(&mgr->up_req_list);
5421 * delayed_destroy_work will be queued on a dedicated WQ, so that any
5422 * requeuing will be also flushed when deiniting the topology manager.
5424 mgr->delayed_destroy_wq = alloc_ordered_workqueue("drm_dp_mst_wq", 0);
5425 if (mgr->delayed_destroy_wq == NULL)
5428 INIT_WORK(&mgr->work, drm_dp_mst_link_probe_work);
5429 INIT_WORK(&mgr->tx_work, drm_dp_tx_work);
5430 INIT_WORK(&mgr->delayed_destroy_work, drm_dp_delayed_destroy_work);
5431 INIT_WORK(&mgr->up_req_work, drm_dp_mst_up_req_work);
5432 init_waitqueue_head(&mgr->tx_waitq);
5435 mgr->max_dpcd_transaction_bytes = max_dpcd_transaction_bytes;
5436 mgr->max_payloads = max_payloads;
5437 mgr->conn_base_id = conn_base_id;
5438 if (max_payloads + 1 > sizeof(mgr->payload_mask) * 8 ||
5439 max_payloads + 1 > sizeof(mgr->vcpi_mask) * 8)
5441 mgr->payloads = kcalloc(max_payloads, sizeof(struct drm_dp_payload), GFP_KERNEL);
5444 mgr->proposed_vcpis = kcalloc(max_payloads, sizeof(struct drm_dp_vcpi *), GFP_KERNEL);
5445 if (!mgr->proposed_vcpis)
5447 set_bit(0, &mgr->payload_mask);
5449 mst_state = kzalloc(sizeof(*mst_state), GFP_KERNEL);
5450 if (mst_state == NULL)
5453 mst_state->mgr = mgr;
5454 INIT_LIST_HEAD(&mst_state->vcpis);
5456 drm_atomic_private_obj_init(dev, &mgr->base,
5458 &drm_dp_mst_topology_state_funcs);
5462 EXPORT_SYMBOL(drm_dp_mst_topology_mgr_init);
5465 * drm_dp_mst_topology_mgr_destroy() - destroy topology manager.
5466 * @mgr: manager to destroy
5468 void drm_dp_mst_topology_mgr_destroy(struct drm_dp_mst_topology_mgr *mgr)
5470 drm_dp_mst_topology_mgr_set_mst(mgr, false);
5471 flush_work(&mgr->work);
5472 /* The following will also drain any requeued work on the WQ. */
5473 if (mgr->delayed_destroy_wq) {
5474 destroy_workqueue(mgr->delayed_destroy_wq);
5475 mgr->delayed_destroy_wq = NULL;
5477 mutex_lock(&mgr->payload_lock);
5478 kfree(mgr->payloads);
5479 mgr->payloads = NULL;
5480 kfree(mgr->proposed_vcpis);
5481 mgr->proposed_vcpis = NULL;
5482 mutex_unlock(&mgr->payload_lock);
5485 drm_atomic_private_obj_fini(&mgr->base);
5488 mutex_destroy(&mgr->delayed_destroy_lock);
5489 mutex_destroy(&mgr->payload_lock);
5490 mutex_destroy(&mgr->qlock);
5491 mutex_destroy(&mgr->lock);
5492 mutex_destroy(&mgr->up_req_lock);
5493 mutex_destroy(&mgr->probe_lock);
5494 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
5495 mutex_destroy(&mgr->topology_ref_history_lock);
5498 EXPORT_SYMBOL(drm_dp_mst_topology_mgr_destroy);
5500 static bool remote_i2c_read_ok(const struct i2c_msg msgs[], int num)
5504 if (num - 1 > DP_REMOTE_I2C_READ_MAX_TRANSACTIONS)
5507 for (i = 0; i < num - 1; i++) {
5508 if (msgs[i].flags & I2C_M_RD ||
5513 return msgs[num - 1].flags & I2C_M_RD &&
5514 msgs[num - 1].len <= 0xff;
5517 static bool remote_i2c_write_ok(const struct i2c_msg msgs[], int num)
5521 for (i = 0; i < num - 1; i++) {
5522 if (msgs[i].flags & I2C_M_RD || !(msgs[i].flags & I2C_M_STOP) ||
5527 return !(msgs[num - 1].flags & I2C_M_RD) && msgs[num - 1].len <= 0xff;
5530 static int drm_dp_mst_i2c_read(struct drm_dp_mst_branch *mstb,
5531 struct drm_dp_mst_port *port,
5532 struct i2c_msg *msgs, int num)
5534 struct drm_dp_mst_topology_mgr *mgr = port->mgr;
5536 struct drm_dp_sideband_msg_req_body msg;
5537 struct drm_dp_sideband_msg_tx *txmsg = NULL;
5540 memset(&msg, 0, sizeof(msg));
5541 msg.req_type = DP_REMOTE_I2C_READ;
5542 msg.u.i2c_read.num_transactions = num - 1;
5543 msg.u.i2c_read.port_number = port->port_num;
5544 for (i = 0; i < num - 1; i++) {
5545 msg.u.i2c_read.transactions[i].i2c_dev_id = msgs[i].addr;
5546 msg.u.i2c_read.transactions[i].num_bytes = msgs[i].len;
5547 msg.u.i2c_read.transactions[i].bytes = msgs[i].buf;
5548 msg.u.i2c_read.transactions[i].no_stop_bit = !(msgs[i].flags & I2C_M_STOP);
5550 msg.u.i2c_read.read_i2c_device_id = msgs[num - 1].addr;
5551 msg.u.i2c_read.num_bytes_read = msgs[num - 1].len;
5553 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
5560 drm_dp_encode_sideband_req(&msg, txmsg);
5562 drm_dp_queue_down_tx(mgr, txmsg);
5564 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
5567 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK) {
5571 if (txmsg->reply.u.remote_i2c_read_ack.num_bytes != msgs[num - 1].len) {
5575 memcpy(msgs[num - 1].buf, txmsg->reply.u.remote_i2c_read_ack.bytes, msgs[num - 1].len);
5583 static int drm_dp_mst_i2c_write(struct drm_dp_mst_branch *mstb,
5584 struct drm_dp_mst_port *port,
5585 struct i2c_msg *msgs, int num)
5587 struct drm_dp_mst_topology_mgr *mgr = port->mgr;
5589 struct drm_dp_sideband_msg_req_body msg;
5590 struct drm_dp_sideband_msg_tx *txmsg = NULL;
5593 txmsg = kzalloc(sizeof(*txmsg), GFP_KERNEL);
5598 for (i = 0; i < num; i++) {
5599 memset(&msg, 0, sizeof(msg));
5600 msg.req_type = DP_REMOTE_I2C_WRITE;
5601 msg.u.i2c_write.port_number = port->port_num;
5602 msg.u.i2c_write.write_i2c_device_id = msgs[i].addr;
5603 msg.u.i2c_write.num_bytes = msgs[i].len;
5604 msg.u.i2c_write.bytes = msgs[i].buf;
5606 memset(txmsg, 0, sizeof(*txmsg));
5609 drm_dp_encode_sideband_req(&msg, txmsg);
5610 drm_dp_queue_down_tx(mgr, txmsg);
5612 ret = drm_dp_mst_wait_tx_reply(mstb, txmsg);
5614 if (txmsg->reply.reply_type == DP_SIDEBAND_REPLY_NAK) {
5629 static int drm_dp_mst_i2c_xfer(struct i2c_adapter *adapter,
5630 struct i2c_msg *msgs, int num)
5632 struct drm_dp_aux *aux = adapter->algo_data;
5633 struct drm_dp_mst_port *port =
5634 container_of(aux, struct drm_dp_mst_port, aux);
5635 struct drm_dp_mst_branch *mstb;
5636 struct drm_dp_mst_topology_mgr *mgr = port->mgr;
5639 mstb = drm_dp_mst_topology_get_mstb_validated(mgr, port->parent);
5643 if (remote_i2c_read_ok(msgs, num)) {
5644 ret = drm_dp_mst_i2c_read(mstb, port, msgs, num);
5645 } else if (remote_i2c_write_ok(msgs, num)) {
5646 ret = drm_dp_mst_i2c_write(mstb, port, msgs, num);
5648 DRM_DEBUG_KMS("Unsupported I2C transaction for MST device\n");
5652 drm_dp_mst_topology_put_mstb(mstb);
5656 static u32 drm_dp_mst_i2c_functionality(struct i2c_adapter *adapter)
5658 return I2C_FUNC_I2C | I2C_FUNC_SMBUS_EMUL |
5659 I2C_FUNC_SMBUS_READ_BLOCK_DATA |
5660 I2C_FUNC_SMBUS_BLOCK_PROC_CALL |
5661 I2C_FUNC_10BIT_ADDR;
5664 static const struct i2c_algorithm drm_dp_mst_i2c_algo = {
5665 .functionality = drm_dp_mst_i2c_functionality,
5666 .master_xfer = drm_dp_mst_i2c_xfer,
5670 * drm_dp_mst_register_i2c_bus() - register an I2C adapter for I2C-over-AUX
5671 * @port: The port to add the I2C bus on
5673 * Returns 0 on success or a negative error code on failure.
5675 static int drm_dp_mst_register_i2c_bus(struct drm_dp_mst_port *port)
5677 struct drm_dp_aux *aux = &port->aux;
5678 struct device *parent_dev = port->mgr->dev->dev;
5680 aux->ddc.algo = &drm_dp_mst_i2c_algo;
5681 aux->ddc.algo_data = aux;
5682 aux->ddc.retries = 3;
5684 aux->ddc.class = I2C_CLASS_DDC;
5685 aux->ddc.owner = THIS_MODULE;
5686 /* FIXME: set the kdev of the port's connector as parent */
5687 aux->ddc.dev.parent = parent_dev;
5688 aux->ddc.dev.of_node = parent_dev->of_node;
5690 strlcpy(aux->ddc.name, aux->name ? aux->name : dev_name(parent_dev),
5691 sizeof(aux->ddc.name));
5693 return i2c_add_adapter(&aux->ddc);
5697 * drm_dp_mst_unregister_i2c_bus() - unregister an I2C-over-AUX adapter
5698 * @port: The port to remove the I2C bus from
5700 static void drm_dp_mst_unregister_i2c_bus(struct drm_dp_mst_port *port)
5702 i2c_del_adapter(&port->aux.ddc);
5706 * drm_dp_mst_is_virtual_dpcd() - Is the given port a virtual DP Peer Device
5707 * @port: The port to check
5709 * A single physical MST hub object can be represented in the topology
5710 * by multiple branches, with virtual ports between those branches.
5712 * As of DP1.4, An MST hub with internal (virtual) ports must expose
5713 * certain DPCD registers over those ports. See sections 2.6.1.1.1
5714 * and 2.6.1.1.2 of Display Port specification v1.4 for details.
5716 * May acquire mgr->lock
5719 * true if the port is a virtual DP peer device, false otherwise
5721 static bool drm_dp_mst_is_virtual_dpcd(struct drm_dp_mst_port *port)
5723 struct drm_dp_mst_port *downstream_port;
5725 if (!port || port->dpcd_rev < DP_DPCD_REV_14)
5728 /* Virtual DP Sink (Internal Display Panel) */
5729 if (port->port_num >= 8)
5732 /* DP-to-HDMI Protocol Converter */
5733 if (port->pdt == DP_PEER_DEVICE_DP_LEGACY_CONV &&
5739 mutex_lock(&port->mgr->lock);
5740 if (port->pdt == DP_PEER_DEVICE_MST_BRANCHING &&
5742 port->mstb->num_ports == 2) {
5743 list_for_each_entry(downstream_port, &port->mstb->ports, next) {
5744 if (downstream_port->pdt == DP_PEER_DEVICE_SST_SINK &&
5745 !downstream_port->input) {
5746 mutex_unlock(&port->mgr->lock);
5751 mutex_unlock(&port->mgr->lock);
5757 * drm_dp_mst_dsc_aux_for_port() - Find the correct aux for DSC
5758 * @port: The port to check. A leaf of the MST tree with an attached display.
5760 * Depending on the situation, DSC may be enabled via the endpoint aux,
5761 * the immediately upstream aux, or the connector's physical aux.
5763 * This is both the correct aux to read DSC_CAPABILITY and the
5764 * correct aux to write DSC_ENABLED.
5766 * This operation can be expensive (up to four aux reads), so
5767 * the caller should cache the return.
5770 * NULL if DSC cannot be enabled on this port, otherwise the aux device
5772 struct drm_dp_aux *drm_dp_mst_dsc_aux_for_port(struct drm_dp_mst_port *port)
5774 struct drm_dp_mst_port *immediate_upstream_port;
5775 struct drm_dp_mst_port *fec_port;
5776 struct drm_dp_desc desc = {};
5783 if (port->parent->port_parent)
5784 immediate_upstream_port = port->parent->port_parent;
5786 immediate_upstream_port = NULL;
5788 fec_port = immediate_upstream_port;
5791 * Each physical link (i.e. not a virtual port) between the
5792 * output and the primary device must support FEC
5794 if (!drm_dp_mst_is_virtual_dpcd(fec_port) &&
5795 !fec_port->fec_capable)
5798 fec_port = fec_port->parent->port_parent;
5801 /* DP-to-DP peer device */
5802 if (drm_dp_mst_is_virtual_dpcd(immediate_upstream_port)) {
5805 if (drm_dp_dpcd_read(&port->aux,
5806 DP_DSC_SUPPORT, &endpoint_dsc, 1) != 1)
5808 if (drm_dp_dpcd_read(&port->aux,
5809 DP_FEC_CAPABILITY, &endpoint_fec, 1) != 1)
5811 if (drm_dp_dpcd_read(&immediate_upstream_port->aux,
5812 DP_DSC_SUPPORT, &upstream_dsc, 1) != 1)
5815 /* Enpoint decompression with DP-to-DP peer device */
5816 if ((endpoint_dsc & DP_DSC_DECOMPRESSION_IS_SUPPORTED) &&
5817 (endpoint_fec & DP_FEC_CAPABLE) &&
5818 (upstream_dsc & 0x2) /* DSC passthrough */)
5821 /* Virtual DPCD decompression with DP-to-DP peer device */
5822 return &immediate_upstream_port->aux;
5825 /* Virtual DPCD decompression with DP-to-HDMI or Virtual DP Sink */
5826 if (drm_dp_mst_is_virtual_dpcd(port))
5831 * Applies to ports for which:
5832 * - Physical aux has Synaptics OUI
5833 * - DPv1.4 or higher
5834 * - Port is on primary branch device
5835 * - Not a VGA adapter (DP_DWN_STRM_PORT_TYPE_ANALOG)
5837 if (drm_dp_read_desc(port->mgr->aux, &desc, true))
5840 if (drm_dp_has_quirk(&desc, DP_DPCD_QUIRK_DSC_WITHOUT_VIRTUAL_DPCD) &&
5841 port->mgr->dpcd[DP_DPCD_REV] >= DP_DPCD_REV_14 &&
5842 port->parent == port->mgr->mst_primary) {
5845 if (drm_dp_dpcd_read(&port->aux, DP_DOWNSTREAMPORT_PRESENT,
5846 &downstreamport, 1) < 0)
5849 if ((downstreamport & DP_DWN_STRM_PORT_PRESENT) &&
5850 ((downstreamport & DP_DWN_STRM_PORT_TYPE_MASK)
5851 != DP_DWN_STRM_PORT_TYPE_ANALOG))
5852 return port->mgr->aux;
5856 * The check below verifies if the MST sink
5857 * connected to the GPU is capable of DSC -
5858 * therefore the endpoint needs to be
5859 * both DSC and FEC capable.
5861 if (drm_dp_dpcd_read(&port->aux,
5862 DP_DSC_SUPPORT, &endpoint_dsc, 1) != 1)
5864 if (drm_dp_dpcd_read(&port->aux,
5865 DP_FEC_CAPABILITY, &endpoint_fec, 1) != 1)
5867 if ((endpoint_dsc & DP_DSC_DECOMPRESSION_IS_SUPPORTED) &&
5868 (endpoint_fec & DP_FEC_CAPABLE))
5873 EXPORT_SYMBOL(drm_dp_mst_dsc_aux_for_port);