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 * @guid_valid: for DP 1.2 devices if we have validated the GUID.
48 * @guid: guid for DP 1.2 device on this port.
49 * @port_num: port number
50 * @input: if this port is an input port.
51 * @mcs: message capability status - DP 1.2 spec.
52 * @ddps: DisplayPort Device Plug Status - DP 1.2
53 * @pdt: Peer Device Type
54 * @ldps: Legacy Device Plug Status
55 * @dpcd_rev: DPCD revision of device on this port
56 * @num_sdp_streams: Number of simultaneous streams
57 * @num_sdp_stream_sinks: Number of stream sinks
58 * @available_pbn: Available bandwidth for this port.
59 * @next: link to next port on this branch device
60 * @mstb: branch device attach below this port
61 * @aux: i2c aux transport to talk to device connected to this port.
62 * @parent: branch device parent of this port
63 * @vcpi: Virtual Channel Payload info for this port.
64 * @connector: DRM connector this port is connected to.
65 * @mgr: topology manager this port lives under.
67 * This structure represents an MST port endpoint on a device somewhere
68 * in the MST topology.
70 struct drm_dp_mst_port
{
73 /* if dpcd 1.2 device is on this port - its GUID info */
85 u8 num_sdp_stream_sinks
;
86 uint16_t available_pbn
;
87 struct list_head next
;
88 struct drm_dp_mst_branch
*mstb
; /* pointer to an mstb if this port has one */
89 struct drm_dp_aux aux
; /* i2c bus for this port? */
90 struct drm_dp_mst_branch
*parent
;
92 struct drm_dp_vcpi vcpi
;
93 struct drm_connector
*connector
;
94 struct drm_dp_mst_topology_mgr
*mgr
;
96 struct edid
*cached_edid
; /* for DP logical ports - make tiling work */
101 * struct drm_dp_mst_branch - MST branch device.
102 * @kref: reference count for this port.
103 * @rad: Relative Address to talk to this branch device.
104 * @lct: Link count total to talk to this branch device.
105 * @num_ports: number of ports on the branch.
106 * @msg_slots: one bit per transmitted msg slot.
107 * @ports: linked list of ports on this branch.
108 * @port_parent: pointer to the port parent, NULL if toplevel.
109 * @mgr: topology manager for this branch device.
110 * @tx_slots: transmission slots for this device.
111 * @last_seqno: last sequence number used to talk to this.
112 * @link_address_sent: if a link address message has been sent to this device yet.
114 * This structure represents an MST branch device, there is one
115 * primary branch device at the root, along with any others connected
116 * to downstream ports
118 struct drm_dp_mst_branch
{
125 struct list_head ports
;
127 /* list of tx ops queue for this port */
128 struct drm_dp_mst_port
*port_parent
;
129 struct drm_dp_mst_topology_mgr
*mgr
;
131 /* slots are protected by mstb->mgr->qlock */
132 struct drm_dp_sideband_msg_tx
*tx_slots
[2];
134 bool link_address_sent
;
138 /* sideband msg header - not bit struct */
139 struct drm_dp_sideband_msg_hdr
{
151 struct drm_dp_nak_reply
{
157 struct drm_dp_link_address_ack_reply
{
160 struct drm_dp_link_addr_reply_port
{
166 bool legacy_device_plug_status
;
170 u8 num_sdp_stream_sinks
;
174 struct drm_dp_remote_dpcd_read_ack_reply
{
180 struct drm_dp_remote_dpcd_write_ack_reply
{
184 struct drm_dp_remote_dpcd_write_nak_reply
{
187 u8 bytes_written_before_failure
;
190 struct drm_dp_remote_i2c_read_ack_reply
{
196 struct drm_dp_remote_i2c_read_nak_reply
{
199 u8 i2c_nak_transaction
;
202 struct drm_dp_remote_i2c_write_ack_reply
{
207 struct drm_dp_sideband_msg_rx
{
211 u8 curchunk_idx
; /* chunk we are parsing now */
213 u8 curlen
; /* total length of the msg */
216 struct drm_dp_sideband_msg_hdr initial_hdr
;
219 #define DRM_DP_MAX_SDP_STREAMS 16
220 struct drm_dp_allocate_payload
{
222 u8 number_sdp_streams
;
225 u8 sdp_stream_sink
[DRM_DP_MAX_SDP_STREAMS
];
228 struct drm_dp_allocate_payload_ack_reply
{
234 struct drm_dp_connection_status_notify
{
237 bool legacy_device_plug_status
;
238 bool displayport_device_plug_status
;
239 bool message_capability_status
;
244 struct drm_dp_remote_dpcd_read
{
250 struct drm_dp_remote_dpcd_write
{
257 #define DP_REMOTE_I2C_READ_MAX_TRANSACTIONS 4
258 struct drm_dp_remote_i2c_read
{
266 u8 i2c_transaction_delay
;
267 } transactions
[DP_REMOTE_I2C_READ_MAX_TRANSACTIONS
];
268 u8 read_i2c_device_id
;
272 struct drm_dp_remote_i2c_write
{
274 u8 write_i2c_device_id
;
279 /* this covers ENUM_RESOURCES, POWER_DOWN_PHY, POWER_UP_PHY */
280 struct drm_dp_port_number_req
{
284 struct drm_dp_enum_path_resources_ack_reply
{
286 u16 full_payload_bw_number
;
287 u16 avail_payload_bw_number
;
290 /* covers POWER_DOWN_PHY, POWER_UP_PHY */
291 struct drm_dp_port_number_rep
{
295 struct drm_dp_query_payload
{
300 struct drm_dp_resource_status_notify
{
306 struct drm_dp_query_payload_ack_reply
{
311 struct drm_dp_sideband_msg_req_body
{
314 struct drm_dp_connection_status_notify conn_stat
;
315 struct drm_dp_port_number_req port_num
;
316 struct drm_dp_resource_status_notify resource_stat
;
318 struct drm_dp_query_payload query_payload
;
319 struct drm_dp_allocate_payload allocate_payload
;
321 struct drm_dp_remote_dpcd_read dpcd_read
;
322 struct drm_dp_remote_dpcd_write dpcd_write
;
324 struct drm_dp_remote_i2c_read i2c_read
;
325 struct drm_dp_remote_i2c_write i2c_write
;
329 struct drm_dp_sideband_msg_reply_body
{
333 struct drm_dp_nak_reply nak
;
334 struct drm_dp_link_address_ack_reply link_addr
;
335 struct drm_dp_port_number_rep port_number
;
337 struct drm_dp_enum_path_resources_ack_reply path_resources
;
338 struct drm_dp_allocate_payload_ack_reply allocate_payload
;
339 struct drm_dp_query_payload_ack_reply query_payload
;
341 struct drm_dp_remote_dpcd_read_ack_reply remote_dpcd_read_ack
;
342 struct drm_dp_remote_dpcd_write_ack_reply remote_dpcd_write_ack
;
343 struct drm_dp_remote_dpcd_write_nak_reply remote_dpcd_write_nack
;
345 struct drm_dp_remote_i2c_read_ack_reply remote_i2c_read_ack
;
346 struct drm_dp_remote_i2c_read_nak_reply remote_i2c_read_nack
;
347 struct drm_dp_remote_i2c_write_ack_reply remote_i2c_write_ack
;
351 /* msg is queued to be put into a slot */
352 #define DRM_DP_SIDEBAND_TX_QUEUED 0
353 /* msg has started transmitting on a slot - still on msgq */
354 #define DRM_DP_SIDEBAND_TX_START_SEND 1
355 /* msg has finished transmitting on a slot - removed from msgq only in slot */
356 #define DRM_DP_SIDEBAND_TX_SENT 2
357 /* msg has received a response - removed from slot */
358 #define DRM_DP_SIDEBAND_TX_RX 3
359 #define DRM_DP_SIDEBAND_TX_TIMEOUT 4
361 struct drm_dp_sideband_msg_tx
{
366 struct drm_dp_mst_branch
*dst
;
367 struct list_head next
;
371 struct drm_dp_sideband_msg_reply_body reply
;
374 /* sideband msg handler */
375 struct drm_dp_mst_topology_mgr
;
376 struct drm_dp_mst_topology_cbs
{
377 /* create a connector for a port */
378 struct drm_connector
*(*add_connector
)(struct drm_dp_mst_topology_mgr
*mgr
, struct drm_dp_mst_port
*port
, const char *path
);
379 void (*register_connector
)(struct drm_connector
*connector
);
380 void (*destroy_connector
)(struct drm_dp_mst_topology_mgr
*mgr
,
381 struct drm_connector
*connector
);
382 void (*hotplug
)(struct drm_dp_mst_topology_mgr
*mgr
);
386 #define DP_MAX_PAYLOAD (sizeof(unsigned long) * 8)
388 #define DP_PAYLOAD_LOCAL 1
389 #define DP_PAYLOAD_REMOTE 2
390 #define DP_PAYLOAD_DELETE_LOCAL 3
392 struct drm_dp_payload
{
400 * struct drm_dp_mst_topology_mgr - DisplayPort MST manager
401 * @dev: device pointer for adding i2c devices etc.
402 * @cbs: callbacks for connector addition and destruction.
403 * @max_dpcd_transaction_bytes - maximum number of bytes to read/write in one go.
404 * @aux: aux channel for the DP connector.
405 * @max_payloads: maximum number of payloads the GPU can generate.
406 * @conn_base_id: DRM connector ID this mgr is connected to.
407 * @down_rep_recv: msg receiver state for down replies.
408 * @up_req_recv: msg receiver state for up requests.
409 * @lock: protects mst state, primary, guid, dpcd.
410 * @mst_state: if this manager is enabled for an MST capable port.
411 * @mst_primary: pointer to the primary branch device.
412 * @guid_valid: GUID valid for the primary branch device.
413 * @guid: GUID for primary port.
414 * @dpcd: cache of DPCD for primary port.
415 * @pbn_div: PBN to slots divisor.
417 * This struct represents the toplevel displayport MST topology manager.
418 * There should be one instance of this for every MST capable DP connector
421 struct drm_dp_mst_topology_mgr
{
424 struct drm_dp_mst_topology_cbs
*cbs
;
425 int max_dpcd_transaction_bytes
;
426 struct drm_dp_aux
*aux
; /* auxch for this topology mgr to use */
430 /* only ever accessed from the workqueue - which should be serialised */
431 struct drm_dp_sideband_msg_rx down_rep_recv
;
432 struct drm_dp_sideband_msg_rx up_req_recv
;
434 /* pointer to info about the initial MST device */
435 struct mutex lock
; /* protects mst_state + primary + guid + dpcd */
438 struct drm_dp_mst_branch
*mst_primary
;
439 /* primary MST device GUID */
442 u8 dpcd
[DP_RECEIVER_CAP_SIZE
];
449 /* messages to be transmitted */
450 /* qlock protects the upq/downq and in_progress,
451 the mstb tx_slots and txmsg->state once they are queued */
453 struct list_head tx_msg_downq
;
454 bool tx_down_in_progress
;
456 /* payload info + lock for it */
457 struct mutex payload_lock
;
458 struct drm_dp_vcpi
**proposed_vcpis
;
459 struct drm_dp_payload
*payloads
;
460 unsigned long payload_mask
;
461 unsigned long vcpi_mask
;
463 wait_queue_head_t tx_waitq
;
464 struct work_struct work
;
466 struct work_struct tx_work
;
468 struct list_head destroy_connector_list
;
469 struct mutex destroy_connector_lock
;
470 struct work_struct destroy_connector_work
;
473 int drm_dp_mst_topology_mgr_init(struct drm_dp_mst_topology_mgr
*mgr
, struct device
*dev
, struct drm_dp_aux
*aux
, int max_dpcd_transaction_bytes
, int max_payloads
, int conn_base_id
);
475 void drm_dp_mst_topology_mgr_destroy(struct drm_dp_mst_topology_mgr
*mgr
);
478 int drm_dp_mst_topology_mgr_set_mst(struct drm_dp_mst_topology_mgr
*mgr
, bool mst_state
);
481 int drm_dp_mst_hpd_irq(struct drm_dp_mst_topology_mgr
*mgr
, u8
*esi
, bool *handled
);
484 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
);
486 bool drm_dp_mst_port_has_audio(struct drm_dp_mst_topology_mgr
*mgr
,
487 struct drm_dp_mst_port
*port
);
488 struct edid
*drm_dp_mst_get_edid(struct drm_connector
*connector
, struct drm_dp_mst_topology_mgr
*mgr
, struct drm_dp_mst_port
*port
);
491 int drm_dp_calc_pbn_mode(int clock
, int bpp
);
494 bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr
*mgr
, struct drm_dp_mst_port
*port
, int pbn
, int *slots
);
496 int drm_dp_mst_get_vcpi_slots(struct drm_dp_mst_topology_mgr
*mgr
, struct drm_dp_mst_port
*port
);
499 void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr
*mgr
, struct drm_dp_mst_port
*port
);
502 void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr
*mgr
,
503 struct drm_dp_mst_port
*port
);
506 int drm_dp_find_vcpi_slots(struct drm_dp_mst_topology_mgr
*mgr
,
510 int drm_dp_update_payload_part1(struct drm_dp_mst_topology_mgr
*mgr
);
513 int drm_dp_update_payload_part2(struct drm_dp_mst_topology_mgr
*mgr
);
515 int drm_dp_check_act_status(struct drm_dp_mst_topology_mgr
*mgr
);
517 void drm_dp_mst_dump_topology(struct seq_file
*m
,
518 struct drm_dp_mst_topology_mgr
*mgr
);
520 void drm_dp_mst_topology_mgr_suspend(struct drm_dp_mst_topology_mgr
*mgr
);
521 int drm_dp_mst_topology_mgr_resume(struct drm_dp_mst_topology_mgr
*mgr
);