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
22 #ifndef _DRM_DP_MST_HELPER_H_
23 #define _DRM_DP_MST_HELPER_H_
25 #include <linux/types.h>
26 #include <drm/drm_dp_helper.h>
28 struct drm_dp_mst_branch;
31 * struct drm_dp_vcpi - Virtual Channel Payload Identifier
32 * @vcpi: Virtual channel ID.
33 * @pbn: Payload Bandwidth Number for this channel
34 * @aligned_pbn: PBN aligned with slot size
35 * @num_slots: number of slots for this PBN
45 * struct drm_dp_mst_port - MST port
46 * @kref: reference count for this port.
47 * @port_num: port number
48 * @input: if this port is an input port.
49 * @mcs: message capability status - DP 1.2 spec.
50 * @ddps: DisplayPort Device Plug Status - DP 1.2
51 * @pdt: Peer Device Type
52 * @ldps: Legacy Device Plug Status
53 * @dpcd_rev: DPCD revision of device on this port
54 * @num_sdp_streams: Number of simultaneous streams
55 * @num_sdp_stream_sinks: Number of stream sinks
56 * @available_pbn: Available bandwidth for this port.
57 * @next: link to next port on this branch device
58 * @mstb: branch device attach below this port
59 * @aux: i2c aux transport to talk to device connected to this port.
60 * @parent: branch device parent of this port
61 * @vcpi: Virtual Channel Payload info for this port.
62 * @connector: DRM connector this port is connected to.
63 * @mgr: topology manager this port lives under.
65 * This structure represents an MST port endpoint on a device somewhere
66 * in the MST topology.
68 struct drm_dp_mst_port {
79 u8 num_sdp_stream_sinks;
80 uint16_t available_pbn;
81 struct list_head next;
82 struct drm_dp_mst_branch *mstb; /* pointer to an mstb if this port has one */
83 struct drm_dp_aux aux; /* i2c bus for this port? */
84 struct drm_dp_mst_branch *parent;
86 struct drm_dp_vcpi vcpi;
87 struct drm_connector *connector;
88 struct drm_dp_mst_topology_mgr *mgr;
91 * @cached_edid: for DP logical ports - make tiling work by ensuring
92 * that the EDID for all connectors is read immediately.
94 struct edid *cached_edid;
96 * @has_audio: Tracks whether the sink connector to this port is
103 * struct drm_dp_mst_branch - MST branch device.
104 * @kref: reference count for this port.
105 * @rad: Relative Address to talk to this branch device.
106 * @lct: Link count total to talk to this branch device.
107 * @num_ports: number of ports on the branch.
108 * @msg_slots: one bit per transmitted msg slot.
109 * @ports: linked list of ports on this branch.
110 * @port_parent: pointer to the port parent, NULL if toplevel.
111 * @mgr: topology manager for this branch device.
112 * @tx_slots: transmission slots for this device.
113 * @last_seqno: last sequence number used to talk to this.
114 * @link_address_sent: if a link address message has been sent to this device yet.
115 * @guid: guid for DP 1.2 branch device. port under this branch can be
116 * identified by port #.
118 * This structure represents an MST branch device, there is one
119 * primary branch device at the root, along with any other branches connected
120 * to downstream port of parent branches.
122 struct drm_dp_mst_branch {
129 struct list_head ports;
131 /* list of tx ops queue for this port */
132 struct drm_dp_mst_port *port_parent;
133 struct drm_dp_mst_topology_mgr *mgr;
135 /* slots are protected by mstb->mgr->qlock */
136 struct drm_dp_sideband_msg_tx *tx_slots[2];
138 bool link_address_sent;
140 /* global unique identifier to identify branch devices */
145 /* sideband msg header - not bit struct */
146 struct drm_dp_sideband_msg_hdr {
158 struct drm_dp_nak_reply {
164 struct drm_dp_link_address_ack_reply {
167 struct drm_dp_link_addr_reply_port {
173 bool legacy_device_plug_status;
177 u8 num_sdp_stream_sinks;
181 struct drm_dp_remote_dpcd_read_ack_reply {
187 struct drm_dp_remote_dpcd_write_ack_reply {
191 struct drm_dp_remote_dpcd_write_nak_reply {
194 u8 bytes_written_before_failure;
197 struct drm_dp_remote_i2c_read_ack_reply {
203 struct drm_dp_remote_i2c_read_nak_reply {
206 u8 i2c_nak_transaction;
209 struct drm_dp_remote_i2c_write_ack_reply {
214 struct drm_dp_sideband_msg_rx {
218 u8 curchunk_idx; /* chunk we are parsing now */
220 u8 curlen; /* total length of the msg */
223 struct drm_dp_sideband_msg_hdr initial_hdr;
226 #define DRM_DP_MAX_SDP_STREAMS 16
227 struct drm_dp_allocate_payload {
229 u8 number_sdp_streams;
232 u8 sdp_stream_sink[DRM_DP_MAX_SDP_STREAMS];
235 struct drm_dp_allocate_payload_ack_reply {
241 struct drm_dp_connection_status_notify {
244 bool legacy_device_plug_status;
245 bool displayport_device_plug_status;
246 bool message_capability_status;
251 struct drm_dp_remote_dpcd_read {
257 struct drm_dp_remote_dpcd_write {
264 #define DP_REMOTE_I2C_READ_MAX_TRANSACTIONS 4
265 struct drm_dp_remote_i2c_read {
273 u8 i2c_transaction_delay;
274 } transactions[DP_REMOTE_I2C_READ_MAX_TRANSACTIONS];
275 u8 read_i2c_device_id;
279 struct drm_dp_remote_i2c_write {
281 u8 write_i2c_device_id;
286 /* this covers ENUM_RESOURCES, POWER_DOWN_PHY, POWER_UP_PHY */
287 struct drm_dp_port_number_req {
291 struct drm_dp_enum_path_resources_ack_reply {
293 u16 full_payload_bw_number;
294 u16 avail_payload_bw_number;
297 /* covers POWER_DOWN_PHY, POWER_UP_PHY */
298 struct drm_dp_port_number_rep {
302 struct drm_dp_query_payload {
307 struct drm_dp_resource_status_notify {
313 struct drm_dp_query_payload_ack_reply {
318 struct drm_dp_sideband_msg_req_body {
321 struct drm_dp_connection_status_notify conn_stat;
322 struct drm_dp_port_number_req port_num;
323 struct drm_dp_resource_status_notify resource_stat;
325 struct drm_dp_query_payload query_payload;
326 struct drm_dp_allocate_payload allocate_payload;
328 struct drm_dp_remote_dpcd_read dpcd_read;
329 struct drm_dp_remote_dpcd_write dpcd_write;
331 struct drm_dp_remote_i2c_read i2c_read;
332 struct drm_dp_remote_i2c_write i2c_write;
336 struct drm_dp_sideband_msg_reply_body {
340 struct drm_dp_nak_reply nak;
341 struct drm_dp_link_address_ack_reply link_addr;
342 struct drm_dp_port_number_rep port_number;
344 struct drm_dp_enum_path_resources_ack_reply path_resources;
345 struct drm_dp_allocate_payload_ack_reply allocate_payload;
346 struct drm_dp_query_payload_ack_reply query_payload;
348 struct drm_dp_remote_dpcd_read_ack_reply remote_dpcd_read_ack;
349 struct drm_dp_remote_dpcd_write_ack_reply remote_dpcd_write_ack;
350 struct drm_dp_remote_dpcd_write_nak_reply remote_dpcd_write_nack;
352 struct drm_dp_remote_i2c_read_ack_reply remote_i2c_read_ack;
353 struct drm_dp_remote_i2c_read_nak_reply remote_i2c_read_nack;
354 struct drm_dp_remote_i2c_write_ack_reply remote_i2c_write_ack;
358 /* msg is queued to be put into a slot */
359 #define DRM_DP_SIDEBAND_TX_QUEUED 0
360 /* msg has started transmitting on a slot - still on msgq */
361 #define DRM_DP_SIDEBAND_TX_START_SEND 1
362 /* msg has finished transmitting on a slot - removed from msgq only in slot */
363 #define DRM_DP_SIDEBAND_TX_SENT 2
364 /* msg has received a response - removed from slot */
365 #define DRM_DP_SIDEBAND_TX_RX 3
366 #define DRM_DP_SIDEBAND_TX_TIMEOUT 4
368 struct drm_dp_sideband_msg_tx {
373 struct drm_dp_mst_branch *dst;
374 struct list_head next;
378 struct drm_dp_sideband_msg_reply_body reply;
381 /* sideband msg handler */
382 struct drm_dp_mst_topology_mgr;
383 struct drm_dp_mst_topology_cbs {
384 /* create a connector for a port */
385 struct drm_connector *(*add_connector)(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port, const char *path);
386 void (*register_connector)(struct drm_connector *connector);
387 void (*destroy_connector)(struct drm_dp_mst_topology_mgr *mgr,
388 struct drm_connector *connector);
389 void (*hotplug)(struct drm_dp_mst_topology_mgr *mgr);
393 #define DP_MAX_PAYLOAD (sizeof(unsigned long) * 8)
395 #define DP_PAYLOAD_LOCAL 1
396 #define DP_PAYLOAD_REMOTE 2
397 #define DP_PAYLOAD_DELETE_LOCAL 3
399 struct drm_dp_payload {
407 * struct drm_dp_mst_topology_mgr - DisplayPort MST manager
409 * This struct represents the toplevel displayport MST topology manager.
410 * There should be one instance of this for every MST capable DP connector
413 struct drm_dp_mst_topology_mgr {
415 * @dev: device pointer for adding i2c devices etc.
417 struct drm_device *dev;
419 * @cbs: callbacks for connector addition and destruction.
421 const struct drm_dp_mst_topology_cbs *cbs;
423 * @max_dpcd_transaction_bytes: maximum number of bytes to read/write
426 int max_dpcd_transaction_bytes;
428 * @aux: AUX channel for the DP MST connector this topolgy mgr is
431 struct drm_dp_aux *aux;
433 * @max_payloads: maximum number of payloads the GPU can generate.
437 * @conn_base_id: DRM connector ID this mgr is connected to. Only used
438 * to build the MST connector path value.
443 * @down_rep_recv: Message receiver state for down replies. This and
444 * @up_req_recv are only ever access from the work item, which is
447 struct drm_dp_sideband_msg_rx down_rep_recv;
449 * @up_req_recv: Message receiver state for up requests. This and
450 * @down_rep_recv are only ever access from the work item, which is
453 struct drm_dp_sideband_msg_rx up_req_recv;
456 * @lock: protects mst state, primary, dpcd.
461 * @mst_state: If this manager is enabled for an MST capable port. False
462 * if no MST sink/branch devices is connected.
466 * @mst_primary: Pointer to the primary/first branch device.
468 struct drm_dp_mst_branch *mst_primary;
471 * @dpcd: Cache of DPCD for primary port.
473 u8 dpcd[DP_RECEIVER_CAP_SIZE];
475 * @sink_count: Sink count from DEVICE_SERVICE_IRQ_VECTOR_ESI0.
479 * @pbn_div: PBN to slots divisor.
484 * @qlock: protects @tx_msg_downq, the &drm_dp_mst_branch.txslost and
485 * &drm_dp_sideband_msg_tx.state once they are queued
489 * @tx_msg_downq: List of pending down replies.
491 struct list_head tx_msg_downq;
494 * @payload_lock: Protect payload information.
496 struct mutex payload_lock;
498 * @proposed_vcpis: Array of pointers for the new VCPI allocation. The
499 * VCPI structure itself is &drm_dp_mst_port.vcpi.
501 struct drm_dp_vcpi **proposed_vcpis;
503 * @payloads: Array of payloads.
505 struct drm_dp_payload *payloads;
507 * @payload_mask: Elements of @payloads actually in use. Since
508 * reallocation of active outputs isn't possible gaps can be created by
509 * disabling outputs out of order compared to how they've been enabled.
511 unsigned long payload_mask;
513 * @vcpi_mask: Similar to @payload_mask, but for @proposed_vcpis.
515 unsigned long vcpi_mask;
518 * @tx_waitq: Wait to queue stall for the tx worker.
520 wait_queue_head_t tx_waitq;
524 struct work_struct work;
526 * @tx_work: Sideband transmit worker. This can nest within the main
527 * @work worker for each transaction @work launches.
529 struct work_struct tx_work;
532 * @destroy_connector_list: List of to be destroyed connectors.
534 struct list_head destroy_connector_list;
536 * @destroy_connector_lock: Protects @connector_list.
538 struct mutex destroy_connector_lock;
540 * @destroy_connector_work: Work item to destroy connectors. Needed to
541 * avoid locking inversion.
543 struct work_struct destroy_connector_work;
546 int drm_dp_mst_topology_mgr_init(struct drm_dp_mst_topology_mgr *mgr,
547 struct drm_device *dev, struct drm_dp_aux *aux,
548 int max_dpcd_transaction_bytes,
549 int max_payloads, int conn_base_id);
551 void drm_dp_mst_topology_mgr_destroy(struct drm_dp_mst_topology_mgr *mgr);
554 int drm_dp_mst_topology_mgr_set_mst(struct drm_dp_mst_topology_mgr *mgr, bool mst_state);
557 int drm_dp_mst_hpd_irq(struct drm_dp_mst_topology_mgr *mgr, u8 *esi, bool *handled);
560 enum drm_connector_status drm_dp_mst_detect_port(struct drm_connector *connector, struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
562 bool drm_dp_mst_port_has_audio(struct drm_dp_mst_topology_mgr *mgr,
563 struct drm_dp_mst_port *port);
564 struct edid *drm_dp_mst_get_edid(struct drm_connector *connector, struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
567 int drm_dp_calc_pbn_mode(int clock, int bpp);
570 bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
571 struct drm_dp_mst_port *port, int pbn, int slots);
573 int drm_dp_mst_get_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
576 void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
579 void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
580 struct drm_dp_mst_port *port);
583 int drm_dp_find_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr,
587 int drm_dp_update_payload_part1(struct drm_dp_mst_topology_mgr *mgr);
590 int drm_dp_update_payload_part2(struct drm_dp_mst_topology_mgr *mgr);
592 int drm_dp_check_act_status(struct drm_dp_mst_topology_mgr *mgr);
594 void drm_dp_mst_dump_topology(struct seq_file *m,
595 struct drm_dp_mst_topology_mgr *mgr);
597 void drm_dp_mst_topology_mgr_suspend(struct drm_dp_mst_topology_mgr *mgr);
598 int drm_dp_mst_topology_mgr_resume(struct drm_dp_mst_topology_mgr *mgr);