[mirror_ubuntu-zesty-kernel.git] / include / drm / drm_dp_mst_helper.h

/*
 * Copyright © 2014 Red Hat.
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 */
#ifndef _DRM_DP_MST_HELPER_H_
#define _DRM_DP_MST_HELPER_H_

#include <linux/types.h>
#include <drm/drm_dp_helper.h>

struct drm_dp_mst_branch;

/**
 * struct drm_dp_vcpi - Virtual Channel Payload Identifier
 * @vcpi: Virtual channel ID.
 * @pbn: Payload Bandwidth Number for this channel
 * @aligned_pbn: PBN aligned with slot size
 * @num_slots: number of slots for this PBN
 */
struct drm_dp_vcpi {
	int vcpi;
	int pbn;
	int aligned_pbn;
	int num_slots;
};

/**
 * struct drm_dp_mst_port - MST port
 * @kref: reference count for this port.
 * @guid_valid: for DP 1.2 devices if we have validated the GUID.
 * @guid: guid for DP 1.2 device on this port.
 * @port_num: port number
 * @input: if this port is an input port.
 * @mcs: message capability status - DP 1.2 spec.
 * @ddps: DisplayPort Device Plug Status - DP 1.2
 * @pdt: Peer Device Type
 * @ldps: Legacy Device Plug Status
 * @dpcd_rev: DPCD revision of device on this port
 * @num_sdp_streams: Number of simultaneous streams
 * @num_sdp_stream_sinks: Number of stream sinks
 * @available_pbn: Available bandwidth for this port.
 * @next: link to next port on this branch device
 * @mstb: branch device attach below this port
 * @aux: i2c aux transport to talk to device connected to this port.
 * @parent: branch device parent of this port
 * @vcpi: Virtual Channel Payload info for this port.
 * @connector: DRM connector this port is connected to.
 * @mgr: topology manager this port lives under.
 *
 * This structure represents an MST port endpoint on a device somewhere
 * in the MST topology.
 */
struct drm_dp_mst_port {
	struct kref kref;

	/* if dpcd 1.2 device is on this port - its GUID info */
	bool guid_valid;
	u8 guid[16];

	u8 port_num;
	bool input;
	bool mcs;
	bool ddps;
	u8 pdt;
	bool ldps;
	u8 dpcd_rev;
	u8 num_sdp_streams;
	u8 num_sdp_stream_sinks;
	uint16_t available_pbn;
	struct list_head next;
	struct drm_dp_mst_branch *mstb; /* pointer to an mstb if this port has one */
	struct drm_dp_aux aux; /* i2c bus for this port? */
	struct drm_dp_mst_branch *parent;

	struct drm_dp_vcpi vcpi;
	struct drm_connector *connector;
	struct drm_dp_mst_topology_mgr *mgr;

	struct edid *cached_edid; /* for DP logical ports - make tiling work */
};

/**
 * struct drm_dp_mst_branch - MST branch device.
 * @kref: reference count for this port.
 * @rad: Relative Address to talk to this branch device.
 * @lct: Link count total to talk to this branch device.
 * @num_ports: number of ports on the branch.
 * @msg_slots: one bit per transmitted msg slot.
 * @ports: linked list of ports on this branch.
 * @port_parent: pointer to the port parent, NULL if toplevel.
 * @mgr: topology manager for this branch device.
 * @tx_slots: transmission slots for this device.
 * @last_seqno: last sequence number used to talk to this.
 * @link_address_sent: if a link address message has been sent to this device yet.
 *
 * This structure represents an MST branch device, there is one
 * primary branch device at the root, along with any others connected
 * to downstream ports
 */
struct drm_dp_mst_branch {
	struct kref kref;
	u8 rad[8];
	u8 lct;
	int num_ports;

	int msg_slots;
	struct list_head ports;

	/* list of tx ops queue for this port */
	struct drm_dp_mst_port *port_parent;
	struct drm_dp_mst_topology_mgr *mgr;

	/* slots are protected by mstb->mgr->qlock */
	struct drm_dp_sideband_msg_tx *tx_slots[2];
	int last_seqno;
	bool link_address_sent;
};


/* sideband msg header - not bit struct */
struct drm_dp_sideband_msg_hdr {
	u8 lct;
	u8 lcr;
	u8 rad[8];
	bool broadcast;
	bool path_msg;
	u8 msg_len;
	bool somt;
	bool eomt;
	bool seqno;
};

struct drm_dp_nak_reply {
	u8 guid[16];
	u8 reason;
	u8 nak_data;
};

struct drm_dp_link_address_ack_reply {
	u8 guid[16];
	u8 nports;
	struct drm_dp_link_addr_reply_port {
		bool input_port;
		u8 peer_device_type;
		u8 port_number;
		bool mcs;
		bool ddps;
		bool legacy_device_plug_status;
		u8 dpcd_revision;
		u8 peer_guid[16];
		u8 num_sdp_streams;
		u8 num_sdp_stream_sinks;
	} ports[16];
};

struct drm_dp_remote_dpcd_read_ack_reply {
	u8 port_number;
	u8 num_bytes;
	u8 bytes[255];
};

struct drm_dp_remote_dpcd_write_ack_reply {
	u8 port_number;
};

struct drm_dp_remote_dpcd_write_nak_reply {
	u8 port_number;
	u8 reason;
	u8 bytes_written_before_failure;
};

struct drm_dp_remote_i2c_read_ack_reply {
	u8 port_number;
	u8 num_bytes;
	u8 bytes[255];
};

struct drm_dp_remote_i2c_read_nak_reply {
	u8 port_number;
	u8 nak_reason;
	u8 i2c_nak_transaction;
};

struct drm_dp_remote_i2c_write_ack_reply {
	u8 port_number;
};


struct drm_dp_sideband_msg_rx {
	u8 chunk[48];
	u8 msg[256];
	u8 curchunk_len;
	u8 curchunk_idx; /* chunk we are parsing now */
	u8 curchunk_hdrlen;
	u8 curlen; /* total length of the msg */
	bool have_somt;
	bool have_eomt;
	struct drm_dp_sideband_msg_hdr initial_hdr;
};


struct drm_dp_allocate_payload {
	u8 port_number;
	u8 number_sdp_streams;
	u8 vcpi;
	u16 pbn;
	u8 sdp_stream_sink[8];
};

struct drm_dp_allocate_payload_ack_reply {
	u8 port_number;
	u8 vcpi;
	u16 allocated_pbn;
};

struct drm_dp_connection_status_notify {
	u8 guid[16];
	u8 port_number;
	bool legacy_device_plug_status;
	bool displayport_device_plug_status;
	bool message_capability_status;
	bool input_port;
	u8 peer_device_type;
};

struct drm_dp_remote_dpcd_read {
	u8 port_number;
	u32 dpcd_address;
	u8 num_bytes;
};

struct drm_dp_remote_dpcd_write {
	u8 port_number;
	u32 dpcd_address;
	u8 num_bytes;
	u8 *bytes;
};

struct drm_dp_remote_i2c_read {
	u8 num_transactions;
	u8 port_number;
	struct {
		u8 i2c_dev_id;
		u8 num_bytes;
		u8 *bytes;
		u8 no_stop_bit;
		u8 i2c_transaction_delay;
	} transactions[4];
	u8 read_i2c_device_id;
	u8 num_bytes_read;
};

struct drm_dp_remote_i2c_write {
	u8 port_number;
	u8 write_i2c_device_id;
	u8 num_bytes;
	u8 *bytes;
};

/* this covers ENUM_RESOURCES, POWER_DOWN_PHY, POWER_UP_PHY */
struct drm_dp_port_number_req {
	u8 port_number;
};

struct drm_dp_enum_path_resources_ack_reply {
	u8 port_number;
	u16 full_payload_bw_number;
	u16 avail_payload_bw_number;
};

/* covers POWER_DOWN_PHY, POWER_UP_PHY */
struct drm_dp_port_number_rep {
	u8 port_number;
};

struct drm_dp_query_payload {
	u8 port_number;
	u8 vcpi;
};

struct drm_dp_resource_status_notify {
	u8 port_number;
	u8 guid[16];
	u16 available_pbn;
};

struct drm_dp_query_payload_ack_reply {
	u8 port_number;
	u8 allocated_pbn;
};

struct drm_dp_sideband_msg_req_body {
	u8 req_type;
	union ack_req {
		struct drm_dp_connection_status_notify conn_stat;
		struct drm_dp_port_number_req port_num;
		struct drm_dp_resource_status_notify resource_stat;

		struct drm_dp_query_payload query_payload;
		struct drm_dp_allocate_payload allocate_payload;

		struct drm_dp_remote_dpcd_read dpcd_read;
		struct drm_dp_remote_dpcd_write dpcd_write;

		struct drm_dp_remote_i2c_read i2c_read;
		struct drm_dp_remote_i2c_write i2c_write;
	} u;
};

struct drm_dp_sideband_msg_reply_body {
	u8 reply_type;
	u8 req_type;
	union ack_replies {
		struct drm_dp_nak_reply nak;
		struct drm_dp_link_address_ack_reply link_addr;
		struct drm_dp_port_number_rep port_number;

		struct drm_dp_enum_path_resources_ack_reply path_resources;
		struct drm_dp_allocate_payload_ack_reply allocate_payload;
		struct drm_dp_query_payload_ack_reply query_payload;

		struct drm_dp_remote_dpcd_read_ack_reply remote_dpcd_read_ack;
		struct drm_dp_remote_dpcd_write_ack_reply remote_dpcd_write_ack;
		struct drm_dp_remote_dpcd_write_nak_reply remote_dpcd_write_nack;

		struct drm_dp_remote_i2c_read_ack_reply remote_i2c_read_ack;
		struct drm_dp_remote_i2c_read_nak_reply remote_i2c_read_nack;
		struct drm_dp_remote_i2c_write_ack_reply remote_i2c_write_ack;
	} u;
};

/* msg is queued to be put into a slot */
#define DRM_DP_SIDEBAND_TX_QUEUED 0
/* msg has started transmitting on a slot - still on msgq */
#define DRM_DP_SIDEBAND_TX_START_SEND 1
/* msg has finished transmitting on a slot - removed from msgq only in slot */
#define DRM_DP_SIDEBAND_TX_SENT 2
/* msg has received a response - removed from slot */
#define DRM_DP_SIDEBAND_TX_RX 3
#define DRM_DP_SIDEBAND_TX_TIMEOUT 4

struct drm_dp_sideband_msg_tx {
	u8 msg[256];
	u8 chunk[48];
	u8 cur_offset;
	u8 cur_len;
	struct drm_dp_mst_branch *dst;
	struct list_head next;
	int seqno;
	int state;
	bool path_msg;
	struct drm_dp_sideband_msg_reply_body reply;
};

/* sideband msg handler */
struct drm_dp_mst_topology_mgr;
struct drm_dp_mst_topology_cbs {
	/* create a connector for a port */
	struct drm_connector *(*add_connector)(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port, const char *path);
	void (*register_connector)(struct drm_connector *connector);
	void (*destroy_connector)(struct drm_dp_mst_topology_mgr *mgr,
				  struct drm_connector *connector);
	void (*hotplug)(struct drm_dp_mst_topology_mgr *mgr);

};

#define DP_MAX_PAYLOAD (sizeof(unsigned long) * 8)

#define DP_PAYLOAD_LOCAL 1
#define DP_PAYLOAD_REMOTE 2
#define DP_PAYLOAD_DELETE_LOCAL 3

struct drm_dp_payload {
	int payload_state;
	int start_slot;
	int num_slots;
	int vcpi;
};

/**
 * struct drm_dp_mst_topology_mgr - DisplayPort MST manager
 * @dev: device pointer for adding i2c devices etc.
 * @cbs: callbacks for connector addition and destruction.
 * @max_dpcd_transaction_bytes - maximum number of bytes to read/write in one go.
 * @aux: aux channel for the DP connector.
 * @max_payloads: maximum number of payloads the GPU can generate.
 * @conn_base_id: DRM connector ID this mgr is connected to.
 * @down_rep_recv: msg receiver state for down replies.
 * @up_req_recv: msg receiver state for up requests.
 * @lock: protects mst state, primary, guid, dpcd.
 * @mst_state: if this manager is enabled for an MST capable port.
 * @mst_primary: pointer to the primary branch device.
 * @guid_valid: GUID valid for the primary branch device.
 * @guid: GUID for primary port.
 * @dpcd: cache of DPCD for primary port.
 * @pbn_div: PBN to slots divisor.
 *
 * This struct represents the toplevel displayport MST topology manager.
 * There should be one instance of this for every MST capable DP connector
 * on the GPU.
 */
struct drm_dp_mst_topology_mgr {

	struct device *dev;
	struct drm_dp_mst_topology_cbs *cbs;
	int max_dpcd_transaction_bytes;
	struct drm_dp_aux *aux; /* auxch for this topology mgr to use */
	int max_payloads;
	int conn_base_id;

	/* only ever accessed from the workqueue - which should be serialised */
	struct drm_dp_sideband_msg_rx down_rep_recv;
	struct drm_dp_sideband_msg_rx up_req_recv;

	/* pointer to info about the initial MST device */
	struct mutex lock; /* protects mst_state + primary + guid + dpcd */

	bool mst_state;
	struct drm_dp_mst_branch *mst_primary;
	/* primary MST device GUID */
	bool guid_valid;
	u8 guid[16];
	u8 dpcd[DP_RECEIVER_CAP_SIZE];
	u8 sink_count;
	int pbn_div;
	int total_slots;
	int avail_slots;
	int total_pbn;

	/* messages to be transmitted */
	/* qlock protects the upq/downq and in_progress,
	   the mstb tx_slots and txmsg->state once they are queued */
	struct mutex qlock;
	struct list_head tx_msg_downq;
	struct list_head tx_msg_upq;
	bool tx_down_in_progress;
	bool tx_up_in_progress;

	/* payload info + lock for it */
	struct mutex payload_lock;
	struct drm_dp_vcpi **proposed_vcpis;
	struct drm_dp_payload *payloads;
	unsigned long payload_mask;
	unsigned long vcpi_mask;

	wait_queue_head_t tx_waitq;
	struct work_struct work;

	struct work_struct tx_work;

	struct list_head destroy_connector_list;
	struct mutex destroy_connector_lock;
	struct work_struct destroy_connector_work;
};

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);

void drm_dp_mst_topology_mgr_destroy(struct drm_dp_mst_topology_mgr *mgr);


int drm_dp_mst_topology_mgr_set_mst(struct drm_dp_mst_topology_mgr *mgr, bool mst_state);


int drm_dp_mst_hpd_irq(struct drm_dp_mst_topology_mgr *mgr, u8 *esi, bool *handled);


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);

struct edid *drm_dp_mst_get_edid(struct drm_connector *connector, struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);


int drm_dp_calc_pbn_mode(int clock, int bpp);


bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port, int pbn, int *slots);

int drm_dp_mst_get_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);


void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);


void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
				struct drm_dp_mst_port *port);


int drm_dp_find_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr,
			   int pbn);


int drm_dp_update_payload_part1(struct drm_dp_mst_topology_mgr *mgr);


int drm_dp_update_payload_part2(struct drm_dp_mst_topology_mgr *mgr);

int drm_dp_check_act_status(struct drm_dp_mst_topology_mgr *mgr);

void drm_dp_mst_dump_topology(struct seq_file *m,
			      struct drm_dp_mst_topology_mgr *mgr);

void drm_dp_mst_topology_mgr_suspend(struct drm_dp_mst_topology_mgr *mgr);
int drm_dp_mst_topology_mgr_resume(struct drm_dp_mst_topology_mgr *mgr);
#endif
Commit	Line	Data
ad7f8a1f DA	1	/*
	2	* Copyright © 2014 Red Hat.
	3	*
	4	* Permission to use, copy, modify, distribute, and sell this software and its
	5	* documentation for any purpose is hereby granted without fee, provided that
	6	* the above copyright notice appear in all copies and that both that copyright
	7	* notice and this permission notice appear in supporting documentation, and
	8	* that the name of the copyright holders not be used in advertising or
	9	* publicity pertaining to distribution of the software without specific,
	10	* written prior permission. The copyright holders make no representations
	11	* about the suitability of this software for any purpose. It is provided "as
	12	* is" without express or implied warranty.
	13	*
	14	* THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
	15	* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
	16	* EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
	17	* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
	18	* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
	19	* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
	20	* OF THIS SOFTWARE.
	21	*/
	22	#ifndef _DRM_DP_MST_HELPER_H_
	23	#define _DRM_DP_MST_HELPER_H_
	24
	25	#include <linux/types.h>
	26	#include <drm/drm_dp_helper.h>
	27
	28	struct drm_dp_mst_branch;
	29
	30	/**
32197aab	31	* struct drm_dp_vcpi - Virtual Channel Payload Identifier
ad7f8a1f DA	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
	36	*/
	37	struct drm_dp_vcpi {
	38	int vcpi;
	39	int pbn;
	40	int aligned_pbn;
	41	int num_slots;
	42	};
	43
	44	/**
	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.
	66	*
	67	* This structure represents an MST port endpoint on a device somewhere
	68	* in the MST topology.
	69	*/
	70	struct drm_dp_mst_port {
	71	struct kref kref;
	72
	73	/* if dpcd 1.2 device is on this port - its GUID info */
	74	bool guid_valid;
	75	u8 guid[16];
	76
	77	u8 port_num;
	78	bool input;
	79	bool mcs;
	80	bool ddps;
	81	u8 pdt;
	82	bool ldps;
	83	u8 dpcd_rev;
	84	u8 num_sdp_streams;
	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;
	91
	92	struct drm_dp_vcpi vcpi;
	93	struct drm_connector *connector;
	94	struct drm_dp_mst_topology_mgr *mgr;
c6a0aed4 DA	95
c6a0aed4 DA	96	struct edid cached_edid; / for DP logical ports - make tiling work */
ad7f8a1f DA	97	};
	98
	99	/**
	100	* struct drm_dp_mst_branch - MST branch device.
	101	* @kref: reference count for this port.
	102	* @rad: Relative Address to talk to this branch device.
	103	* @lct: Link count total to talk to this branch device.
	104	* @num_ports: number of ports on the branch.
	105	* @msg_slots: one bit per transmitted msg slot.
	106	* @ports: linked list of ports on this branch.
	107	* @port_parent: pointer to the port parent, NULL if toplevel.
	108	* @mgr: topology manager for this branch device.
	109	* @tx_slots: transmission slots for this device.
	110	* @last_seqno: last sequence number used to talk to this.
	111	* @link_address_sent: if a link address message has been sent to this device yet.
	112	*
	113	* This structure represents an MST branch device, there is one
	114	* primary branch device at the root, along with any others connected
	115	* to downstream ports
	116	*/
	117	struct drm_dp_mst_branch {
	118	struct kref kref;
	119	u8 rad[8];
	120	u8 lct;
	121	int num_ports;
	122
	123	int msg_slots;
	124	struct list_head ports;
	125
	126	/* list of tx ops queue for this port */
	127	struct drm_dp_mst_port *port_parent;
	128	struct drm_dp_mst_topology_mgr *mgr;
	129
	130	/* slots are protected by mstb->mgr->qlock */
	131	struct drm_dp_sideband_msg_tx *tx_slots[2];
	132	int last_seqno;
	133	bool link_address_sent;
	134	};
	135
	136
	137	/* sideband msg header - not bit struct */
	138	struct drm_dp_sideband_msg_hdr {
	139	u8 lct;
	140	u8 lcr;
	141	u8 rad[8];
	142	bool broadcast;
	143	bool path_msg;
	144	u8 msg_len;
	145	bool somt;
	146	bool eomt;
	147	bool seqno;
	148	};
	149
	150	struct drm_dp_nak_reply {
	151	u8 guid[16];
	152	u8 reason;
	153	u8 nak_data;
	154	};
	155
	156	struct drm_dp_link_address_ack_reply {
	157	u8 guid[16];
	158	u8 nports;
	159	struct drm_dp_link_addr_reply_port {
	160	bool input_port;
161	u8 peer_device_type;
162	u8 port_number;
163	bool mcs;
164	bool ddps;
165	bool legacy_device_plug_status;
166	u8 dpcd_revision;
167	u8 peer_guid[16];
168	u8 num_sdp_streams;
169	u8 num_sdp_stream_sinks;
170	} ports[16];
171	};
172
173	struct drm_dp_remote_dpcd_read_ack_reply {
174	u8 port_number;
175	u8 num_bytes;
176	u8 bytes[255];
177	};
178
179	struct drm_dp_remote_dpcd_write_ack_reply {
180	u8 port_number;
181	};
182
183	struct drm_dp_remote_dpcd_write_nak_reply {
184	u8 port_number;
185	u8 reason;
186	u8 bytes_written_before_failure;
187	};
188
189	struct drm_dp_remote_i2c_read_ack_reply {
190	u8 port_number;
191	u8 num_bytes;
192	u8 bytes[255];
193	};
194
195	struct drm_dp_remote_i2c_read_nak_reply {
196	u8 port_number;
197	u8 nak_reason;
198	u8 i2c_nak_transaction;
199	};
200
201	struct drm_dp_remote_i2c_write_ack_reply {
202	u8 port_number;
203	};
204
205
206	struct drm_dp_sideband_msg_rx {
207	u8 chunk[48];
208	u8 msg[256];
209	u8 curchunk_len;
210	u8 curchunk_idx; /* chunk we are parsing now */
211	u8 curchunk_hdrlen;
212	u8 curlen; /* total length of the msg */
213	bool have_somt;
214	bool have_eomt;
215	struct drm_dp_sideband_msg_hdr initial_hdr;
216	};
217
218
219	struct drm_dp_allocate_payload {
220	u8 port_number;
221	u8 number_sdp_streams;
222	u8 vcpi;
223	u16 pbn;
224	u8 sdp_stream_sink[8];
225	};
226
227	struct drm_dp_allocate_payload_ack_reply {
228	u8 port_number;
229	u8 vcpi;
230	u16 allocated_pbn;
231	};
232
233	struct drm_dp_connection_status_notify {
234	u8 guid[16];
235	u8 port_number;
236	bool legacy_device_plug_status;
237	bool displayport_device_plug_status;
238	bool message_capability_status;
239	bool input_port;
240	u8 peer_device_type;
241	};
242
243	struct drm_dp_remote_dpcd_read {
244	u8 port_number;
245	u32 dpcd_address;
246	u8 num_bytes;
247	};
248
249	struct drm_dp_remote_dpcd_write {
250	u8 port_number;
251	u32 dpcd_address;
252	u8 num_bytes;
253	u8 *bytes;
254	};
255
256	struct drm_dp_remote_i2c_read {
257	u8 num_transactions;
258	u8 port_number;
259	struct {
260	u8 i2c_dev_id;
261	u8 num_bytes;
262	u8 *bytes;
263	u8 no_stop_bit;
264	u8 i2c_transaction_delay;
265	} transactions[4];
266	u8 read_i2c_device_id;
267	u8 num_bytes_read;
268	};
269
270	struct drm_dp_remote_i2c_write {
271	u8 port_number;
272	u8 write_i2c_device_id;
273	u8 num_bytes;
274	u8 *bytes;
275	};
276
277	/* this covers ENUM_RESOURCES, POWER_DOWN_PHY, POWER_UP_PHY */
278	struct drm_dp_port_number_req {
279	u8 port_number;
280	};
281
282	struct drm_dp_enum_path_resources_ack_reply {
283	u8 port_number;
284	u16 full_payload_bw_number;
285	u16 avail_payload_bw_number;
286	};
287
288	/* covers POWER_DOWN_PHY, POWER_UP_PHY */
289	struct drm_dp_port_number_rep {
290	u8 port_number;
291	};
292
293	struct drm_dp_query_payload {
294	u8 port_number;
295	u8 vcpi;
296	};
297
298	struct drm_dp_resource_status_notify {
299	u8 port_number;
300	u8 guid[16];
301	u16 available_pbn;
302	};
303
304	struct drm_dp_query_payload_ack_reply {
305	u8 port_number;
306	u8 allocated_pbn;
307	};
308
309	struct drm_dp_sideband_msg_req_body {
310	u8 req_type;
311	union ack_req {
312	struct drm_dp_connection_status_notify conn_stat;
313	struct drm_dp_port_number_req port_num;
314	struct drm_dp_resource_status_notify resource_stat;
315
316	struct drm_dp_query_payload query_payload;
317	struct drm_dp_allocate_payload allocate_payload;
318
319	struct drm_dp_remote_dpcd_read dpcd_read;
320	struct drm_dp_remote_dpcd_write dpcd_write;
321
322	struct drm_dp_remote_i2c_read i2c_read;
323	struct drm_dp_remote_i2c_write i2c_write;
324	} u;
325	};
326
327	struct drm_dp_sideband_msg_reply_body {
328	u8 reply_type;
329	u8 req_type;
330	union ack_replies {
331	struct drm_dp_nak_reply nak;
332	struct drm_dp_link_address_ack_reply link_addr;
333	struct drm_dp_port_number_rep port_number;
334
335	struct drm_dp_enum_path_resources_ack_reply path_resources;
336	struct drm_dp_allocate_payload_ack_reply allocate_payload;
337	struct drm_dp_query_payload_ack_reply query_payload;
338
339	struct drm_dp_remote_dpcd_read_ack_reply remote_dpcd_read_ack;
340	struct drm_dp_remote_dpcd_write_ack_reply remote_dpcd_write_ack;
341	struct drm_dp_remote_dpcd_write_nak_reply remote_dpcd_write_nack;
342
343	struct drm_dp_remote_i2c_read_ack_reply remote_i2c_read_ack;
344	struct drm_dp_remote_i2c_read_nak_reply remote_i2c_read_nack;
345	struct drm_dp_remote_i2c_write_ack_reply remote_i2c_write_ack;
346	} u;
347	};
348
349	/* msg is queued to be put into a slot */
350	#define DRM_DP_SIDEBAND_TX_QUEUED 0
351	/* msg has started transmitting on a slot - still on msgq */
352	#define DRM_DP_SIDEBAND_TX_START_SEND 1
353	/* msg has finished transmitting on a slot - removed from msgq only in slot */
354	#define DRM_DP_SIDEBAND_TX_SENT 2
355	/* msg has received a response - removed from slot */
356	#define DRM_DP_SIDEBAND_TX_RX 3
357	#define DRM_DP_SIDEBAND_TX_TIMEOUT 4
358
359	struct drm_dp_sideband_msg_tx {
360	u8 msg[256];
361	u8 chunk[48];
362	u8 cur_offset;
363	u8 cur_len;
364	struct drm_dp_mst_branch *dst;
365	struct list_head next;
366	int seqno;
367	int state;
368	bool path_msg;
369	struct drm_dp_sideband_msg_reply_body reply;
370	};
371
372	/* sideband msg handler */
373	struct drm_dp_mst_topology_mgr;
374	struct drm_dp_mst_topology_cbs {
375	/* create a connector for a port */
12e6cecd	376	struct drm_connector (add_connector)(struct drm_dp_mst_topology_mgr mgr, struct drm_dp_mst_port port, const char *path);
d9515c5e	377	void (register_connector)(struct drm_connector connector);
ad7f8a1f DA	378	void (destroy_connector)(struct drm_dp_mst_topology_mgr mgr,
	379	struct drm_connector *connector);
	380	void (hotplug)(struct drm_dp_mst_topology_mgr mgr);
	381
	382	};
	383
	384	#define DP_MAX_PAYLOAD (sizeof(unsigned long) * 8)
	385
	386	#define DP_PAYLOAD_LOCAL 1
	387	#define DP_PAYLOAD_REMOTE 2
	388	#define DP_PAYLOAD_DELETE_LOCAL 3
	389
	390	struct drm_dp_payload {
	391	int payload_state;
	392	int start_slot;
	393	int num_slots;
dfda0df3	394	int vcpi;
ad7f8a1f DA	395	};
	396
	397	/**
	398	* struct drm_dp_mst_topology_mgr - DisplayPort MST manager
	399	* @dev: device pointer for adding i2c devices etc.
	400	* @cbs: callbacks for connector addition and destruction.
	401	* @max_dpcd_transaction_bytes - maximum number of bytes to read/write in one go.
	402	* @aux: aux channel for the DP connector.
	403	* @max_payloads: maximum number of payloads the GPU can generate.
	404	* @conn_base_id: DRM connector ID this mgr is connected to.
	405	* @down_rep_recv: msg receiver state for down replies.
	406	* @up_req_recv: msg receiver state for up requests.
	407	* @lock: protects mst state, primary, guid, dpcd.
	408	* @mst_state: if this manager is enabled for an MST capable port.
	409	* @mst_primary: pointer to the primary branch device.
	410	* @guid_valid: GUID valid for the primary branch device.
	411	* @guid: GUID for primary port.
	412	* @dpcd: cache of DPCD for primary port.
	413	* @pbn_div: PBN to slots divisor.
	414	*
	415	* This struct represents the toplevel displayport MST topology manager.
	416	* There should be one instance of this for every MST capable DP connector
	417	* on the GPU.
	418	*/
	419	struct drm_dp_mst_topology_mgr {
	420
	421	struct device *dev;
	422	struct drm_dp_mst_topology_cbs *cbs;
	423	int max_dpcd_transaction_bytes;
	424	struct drm_dp_aux aux; / auxch for this topology mgr to use */
	425	int max_payloads;
	426	int conn_base_id;
	427
	428	/* only ever accessed from the workqueue - which should be serialised */
	429	struct drm_dp_sideband_msg_rx down_rep_recv;
	430	struct drm_dp_sideband_msg_rx up_req_recv;
	431
	432	/* pointer to info about the initial MST device */
	433	struct mutex lock; /* protects mst_state + primary + guid + dpcd */
	434
	435	bool mst_state;
	436	struct drm_dp_mst_branch *mst_primary;
	437	/* primary MST device GUID */
	438	bool guid_valid;
	439	u8 guid[16];
	440	u8 dpcd[DP_RECEIVER_CAP_SIZE];
	441	u8 sink_count;
	442	int pbn_div;
	443	int total_slots;
	444	int avail_slots;
	445	int total_pbn;
	446
	447	/* messages to be transmitted */
	448	/* qlock protects the upq/downq and in_progress,
	449	the mstb tx_slots and txmsg->state once they are queued */
	450	struct mutex qlock;
	451	struct list_head tx_msg_downq;
	452	struct list_head tx_msg_upq;
	453	bool tx_down_in_progress;
	454	bool tx_up_in_progress;
	455
	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;
dfda0df3	461	unsigned long vcpi_mask;
ad7f8a1f DA	462
	463	wait_queue_head_t tx_waitq;
	464	struct work_struct work;
	465
	466	struct work_struct tx_work;
6b8eeca6 DA	467
	468	struct list_head destroy_connector_list;
	469	struct mutex destroy_connector_lock;
	470	struct work_struct destroy_connector_work;
ad7f8a1f DA	471	};
	472
	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);
	474
	475	void drm_dp_mst_topology_mgr_destroy(struct drm_dp_mst_topology_mgr *mgr);
	476
	477
	478	int drm_dp_mst_topology_mgr_set_mst(struct drm_dp_mst_topology_mgr *mgr, bool mst_state);
	479
	480
	481	int drm_dp_mst_hpd_irq(struct drm_dp_mst_topology_mgr mgr, u8 esi, bool *handled);
	482
	483
c6a0aed4	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);
ad7f8a1f DA	485
	486	struct edid drm_dp_mst_get_edid(struct drm_connector connector, struct drm_dp_mst_topology_mgr mgr, struct drm_dp_mst_port port);
	487
	488
	489	int drm_dp_calc_pbn_mode(int clock, int bpp);
	490
	491
	492	bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr mgr, struct drm_dp_mst_port port, int pbn, int *slots);
	493
87f5942d DA	494	int drm_dp_mst_get_vcpi_slots(struct drm_dp_mst_topology_mgr mgr, struct drm_dp_mst_port port);
87f5942d DA	495
ad7f8a1f DA	496
	497	void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr mgr, struct drm_dp_mst_port port);
	498
	499
	500	void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
	501	struct drm_dp_mst_port *port);
	502
	503
	504	int drm_dp_find_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr,
	505	int pbn);
	506
	507
	508	int drm_dp_update_payload_part1(struct drm_dp_mst_topology_mgr *mgr);
	509
	510
	511	int drm_dp_update_payload_part2(struct drm_dp_mst_topology_mgr *mgr);
	512
	513	int drm_dp_check_act_status(struct drm_dp_mst_topology_mgr *mgr);
	514
	515	void drm_dp_mst_dump_topology(struct seq_file *m,
	516	struct drm_dp_mst_topology_mgr *mgr);
	517
	518	void drm_dp_mst_topology_mgr_suspend(struct drm_dp_mst_topology_mgr *mgr);
	519	int drm_dp_mst_topology_mgr_resume(struct drm_dp_mst_topology_mgr *mgr);
	520	#endif