include/drm/drm_dp_mst_helper.h

   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 /**
  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
  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;
  95
  96         struct edid *cached_edid; /* for DP logical ports - make tiling work */
  97         bool has_audio;
  98 };
  99
 100 /**
 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.
 113  *
 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
 117  */
 118 struct drm_dp_mst_branch {
 119         struct kref kref;
 120         u8 rad[8];
 121         u8 lct;
 122         int num_ports;
 123
 124         int msg_slots;
 125         struct list_head ports;
 126
 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;
 130
 131         /* slots are protected by mstb->mgr->qlock */
 132         struct drm_dp_sideband_msg_tx *tx_slots[2];
 133         int last_seqno;
 134         bool link_address_sent;
 135 };
 136
 137
 138 /* sideband msg header - not bit struct */
 139 struct drm_dp_sideband_msg_hdr {
 140         u8 lct;
 141         u8 lcr;
 142         u8 rad[8];
 143         bool broadcast;
 144         bool path_msg;
 145         u8 msg_len;
 146         bool somt;
 147         bool eomt;
 148         bool seqno;
 149 };
 150
 151 struct drm_dp_nak_reply {
 152         u8 guid[16];
 153         u8 reason;
 154         u8 nak_data;
 155 };
 156
 157 struct drm_dp_link_address_ack_reply {
 158         u8 guid[16];
 159         u8 nports;
 160         struct drm_dp_link_addr_reply_port {
 161                 bool input_port;
 162                 u8 peer_device_type;
 163                 u8 port_number;
 164                 bool mcs;
 165                 bool ddps;
 166                 bool legacy_device_plug_status;
 167                 u8 dpcd_revision;
 168                 u8 peer_guid[16];
 169                 u8 num_sdp_streams;
 170                 u8 num_sdp_stream_sinks;
 171         } ports[16];
 172 };
 173
 174 struct drm_dp_remote_dpcd_read_ack_reply {
 175         u8 port_number;
 176         u8 num_bytes;
 177         u8 bytes[255];
 178 };
 179
 180 struct drm_dp_remote_dpcd_write_ack_reply {
 181         u8 port_number;
 182 };
 183
 184 struct drm_dp_remote_dpcd_write_nak_reply {
 185         u8 port_number;
 186         u8 reason;
 187         u8 bytes_written_before_failure;
 188 };
 189
 190 struct drm_dp_remote_i2c_read_ack_reply {
 191         u8 port_number;
 192         u8 num_bytes;
 193         u8 bytes[255];
 194 };
 195
 196 struct drm_dp_remote_i2c_read_nak_reply {
 197         u8 port_number;
 198         u8 nak_reason;
 199         u8 i2c_nak_transaction;
 200 };
 201
 202 struct drm_dp_remote_i2c_write_ack_reply {
 203         u8 port_number;
 204 };
 205
 206
 207 struct drm_dp_sideband_msg_rx {
 208         u8 chunk[48];
 209         u8 msg[256];
 210         u8 curchunk_len;
 211         u8 curchunk_idx; /* chunk we are parsing now */
 212         u8 curchunk_hdrlen;
 213         u8 curlen; /* total length of the msg */
 214         bool have_somt;
 215         bool have_eomt;
 216         struct drm_dp_sideband_msg_hdr initial_hdr;
 217 };
 218
 219 #define DRM_DP_MAX_SDP_STREAMS 16
 220 struct drm_dp_allocate_payload {
 221         u8 port_number;
 222         u8 number_sdp_streams;
 223         u8 vcpi;
 224         u16 pbn;
 225         u8 sdp_stream_sink[DRM_DP_MAX_SDP_STREAMS];
 226 };
 227
 228 struct drm_dp_allocate_payload_ack_reply {
 229         u8 port_number;
 230         u8 vcpi;
 231         u16 allocated_pbn;
 232 };
 233
 234 struct drm_dp_connection_status_notify {
 235         u8 guid[16];
 236         u8 port_number;
 237         bool legacy_device_plug_status;
 238         bool displayport_device_plug_status;
 239         bool message_capability_status;
 240         bool input_port;
 241         u8 peer_device_type;
 242 };
 243
 244 struct drm_dp_remote_dpcd_read {
 245         u8 port_number;
 246         u32 dpcd_address;
 247         u8 num_bytes;
 248 };
 249
 250 struct drm_dp_remote_dpcd_write {
 251         u8 port_number;
 252         u32 dpcd_address;
 253         u8 num_bytes;
 254         u8 *bytes;
 255 };
 256
 257 #define DP_REMOTE_I2C_READ_MAX_TRANSACTIONS 4
 258 struct drm_dp_remote_i2c_read {
 259         u8 num_transactions;
 260         u8 port_number;
 261         struct {
 262                 u8 i2c_dev_id;
 263                 u8 num_bytes;
 264                 u8 *bytes;
 265                 u8 no_stop_bit;
 266                 u8 i2c_transaction_delay;
 267         } transactions[DP_REMOTE_I2C_READ_MAX_TRANSACTIONS];
 268         u8 read_i2c_device_id;
 269         u8 num_bytes_read;
 270 };
 271
 272 struct drm_dp_remote_i2c_write {
 273         u8 port_number;
 274         u8 write_i2c_device_id;
 275         u8 num_bytes;
 276         u8 *bytes;
 277 };
 278
 279 /* this covers ENUM_RESOURCES, POWER_DOWN_PHY, POWER_UP_PHY */
 280 struct drm_dp_port_number_req {
 281         u8 port_number;
 282 };
 283
 284 struct drm_dp_enum_path_resources_ack_reply {
 285         u8 port_number;
 286         u16 full_payload_bw_number;
 287         u16 avail_payload_bw_number;
 288 };
 289
 290 /* covers POWER_DOWN_PHY, POWER_UP_PHY */
 291 struct drm_dp_port_number_rep {
 292         u8 port_number;
 293 };
 294
 295 struct drm_dp_query_payload {
 296         u8 port_number;
 297         u8 vcpi;
 298 };
 299
 300 struct drm_dp_resource_status_notify {
 301         u8 port_number;
 302         u8 guid[16];
 303         u16 available_pbn;
 304 };
 305
 306 struct drm_dp_query_payload_ack_reply {
 307         u8 port_number;
 308         u8 allocated_pbn;
 309 };
 310
 311 struct drm_dp_sideband_msg_req_body {
 312         u8 req_type;
 313         union ack_req {
 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;
 317
 318                 struct drm_dp_query_payload query_payload;
 319                 struct drm_dp_allocate_payload allocate_payload;
 320
 321                 struct drm_dp_remote_dpcd_read dpcd_read;
 322                 struct drm_dp_remote_dpcd_write dpcd_write;
 323
 324                 struct drm_dp_remote_i2c_read i2c_read;
 325                 struct drm_dp_remote_i2c_write i2c_write;
 326         } u;
 327 };
 328
 329 struct drm_dp_sideband_msg_reply_body {
 330         u8 reply_type;
 331         u8 req_type;
 332         union ack_replies {
 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;
 336
 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;
 340
 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;
 344
 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;
 348         } u;
 349 };
 350
 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
 360
 361 struct drm_dp_sideband_msg_tx {
 362         u8 msg[256];
 363         u8 chunk[48];
 364         u8 cur_offset;
 365         u8 cur_len;
 366         struct drm_dp_mst_branch *dst;
 367         struct list_head next;
 368         int seqno;
 369         int state;
 370         bool path_msg;
 371         struct drm_dp_sideband_msg_reply_body reply;
 372 };
 373
 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);
 383
 384 };
 385
 386 #define DP_MAX_PAYLOAD (sizeof(unsigned long) * 8)
 387
 388 #define DP_PAYLOAD_LOCAL 1
 389 #define DP_PAYLOAD_REMOTE 2
 390 #define DP_PAYLOAD_DELETE_LOCAL 3
 391
 392 struct drm_dp_payload {
 393         int payload_state;
 394         int start_slot;
 395         int num_slots;
 396         int vcpi;
 397 };
 398
 399 /**
 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.
 416  *
 417  * This struct represents the toplevel displayport MST topology manager.
 418  * There should be one instance of this for every MST capable DP connector
 419  * on the GPU.
 420  */
 421 struct drm_dp_mst_topology_mgr {
 422
 423         struct device *dev;
 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 */
 427         int max_payloads;
 428         int conn_base_id;
 429
 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;
 433
 434         /* pointer to info about the initial MST device */
 435         struct mutex lock; /* protects mst_state + primary + guid + dpcd */
 436
 437         bool mst_state;
 438         struct drm_dp_mst_branch *mst_primary;
 439         /* primary MST device GUID */
 440         bool guid_valid;
 441         u8 guid[16];
 442         u8 dpcd[DP_RECEIVER_CAP_SIZE];
 443         u8 sink_count;
 444         int pbn_div;
 445         int total_slots;
 446         int avail_slots;
 447         int total_pbn;
 448
 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 */
 452         struct mutex qlock;
 453         struct list_head tx_msg_downq;
 454         struct list_head tx_msg_upq;
 455         bool tx_down_in_progress;
 456         bool tx_up_in_progress;
 457
 458         /* payload info + lock for it */
 459         struct mutex payload_lock;
 460         struct drm_dp_vcpi **proposed_vcpis;
 461         struct drm_dp_payload *payloads;
 462         unsigned long payload_mask;
 463         unsigned long vcpi_mask;
 464
 465         wait_queue_head_t tx_waitq;
 466         struct work_struct work;
 467
 468         struct work_struct tx_work;
 469
 470         struct list_head destroy_connector_list;
 471         struct mutex destroy_connector_lock;
 472         struct work_struct destroy_connector_work;
 473 };
 474
 475 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);
 476
 477 void drm_dp_mst_topology_mgr_destroy(struct drm_dp_mst_topology_mgr *mgr);
 478
 479
 480 int drm_dp_mst_topology_mgr_set_mst(struct drm_dp_mst_topology_mgr *mgr, bool mst_state);
 481
 482
 483 int drm_dp_mst_hpd_irq(struct drm_dp_mst_topology_mgr *mgr, u8 *esi, bool *handled);
 484
 485
 486 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);
 487
 488 bool drm_dp_mst_port_has_audio(struct drm_dp_mst_topology_mgr *mgr,
 489                                         struct drm_dp_mst_port *port);
 490 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
 492
 493 int drm_dp_calc_pbn_mode(int clock, int bpp);
 494
 495
 496 bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port, int pbn, int *slots);
 497
 498 int drm_dp_mst_get_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
 499
 500
 501 void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
 502
 503
 504 void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
 505                                 struct drm_dp_mst_port *port);
 506
 507
 508 int drm_dp_find_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr,
 509                            int pbn);
 510
 511
 512 int drm_dp_update_payload_part1(struct drm_dp_mst_topology_mgr *mgr);
 513
 514
 515 int drm_dp_update_payload_part2(struct drm_dp_mst_topology_mgr *mgr);
 516
 517 int drm_dp_check_act_status(struct drm_dp_mst_topology_mgr *mgr);
 518
 519 void drm_dp_mst_dump_topology(struct seq_file *m,
 520                               struct drm_dp_mst_topology_mgr *mgr);
 521
 522 void drm_dp_mst_topology_mgr_suspend(struct drm_dp_mst_topology_mgr *mgr);
 523 int drm_dp_mst_topology_mgr_resume(struct drm_dp_mst_topology_mgr *mgr);
 524 #endif