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 #include <drm/drm_atomic.h>
  28
  29 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
  30 #include <linux/stackdepot.h>
  31 #include <linux/timekeeping.h>
  32
  33 enum drm_dp_mst_topology_ref_type {
  34         DRM_DP_MST_TOPOLOGY_REF_GET,
  35         DRM_DP_MST_TOPOLOGY_REF_PUT,
  36 };
  37
  38 struct drm_dp_mst_topology_ref_history {
  39         struct drm_dp_mst_topology_ref_entry {
  40                 enum drm_dp_mst_topology_ref_type type;
  41                 int count;
  42                 ktime_t ts_nsec;
  43                 depot_stack_handle_t backtrace;
  44         } *entries;
  45         int len;
  46 };
  47 #endif /* IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS) */
  48
  49 struct drm_dp_mst_branch;
  50
  51 /**
  52  * struct drm_dp_vcpi - Virtual Channel Payload Identifier
  53  * @vcpi: Virtual channel ID.
  54  * @pbn: Payload Bandwidth Number for this channel
  55  * @aligned_pbn: PBN aligned with slot size
  56  * @num_slots: number of slots for this PBN
  57  */
  58 struct drm_dp_vcpi {
  59         int vcpi;
  60         int pbn;
  61         int aligned_pbn;
  62         int num_slots;
  63 };
  64
  65 /**
  66  * struct drm_dp_mst_port - MST port
  67  * @port_num: port number
  68  * @input: if this port is an input port. Protected by
  69  * &drm_dp_mst_topology_mgr.base.lock.
  70  * @mcs: message capability status - DP 1.2 spec. Protected by
  71  * &drm_dp_mst_topology_mgr.base.lock.
  72  * @ddps: DisplayPort Device Plug Status - DP 1.2. Protected by
  73  * &drm_dp_mst_topology_mgr.base.lock.
  74  * @pdt: Peer Device Type. Protected by
  75  * &drm_dp_mst_topology_mgr.base.lock.
  76  * @ldps: Legacy Device Plug Status. Protected by
  77  * &drm_dp_mst_topology_mgr.base.lock.
  78  * @dpcd_rev: DPCD revision of device on this port. Protected by
  79  * &drm_dp_mst_topology_mgr.base.lock.
  80  * @num_sdp_streams: Number of simultaneous streams. Protected by
  81  * &drm_dp_mst_topology_mgr.base.lock.
  82  * @num_sdp_stream_sinks: Number of stream sinks. Protected by
  83  * &drm_dp_mst_topology_mgr.base.lock.
  84  * @available_pbn: Available bandwidth for this port. Protected by
  85  * &drm_dp_mst_topology_mgr.base.lock.
  86  * @next: link to next port on this branch device
  87  * @aux: i2c aux transport to talk to device connected to this port, protected
  88  * by &drm_dp_mst_topology_mgr.base.lock.
  89  * @parent: branch device parent of this port
  90  * @vcpi: Virtual Channel Payload info for this port.
  91  * @connector: DRM connector this port is connected to. Protected by
  92  * &drm_dp_mst_topology_mgr.base.lock.
  93  * @mgr: topology manager this port lives under.
  94  *
  95  * This structure represents an MST port endpoint on a device somewhere
  96  * in the MST topology.
  97  */
  98 struct drm_dp_mst_port {
  99         /**
 100          * @topology_kref: refcount for this port's lifetime in the topology,
 101          * only the DP MST helpers should need to touch this
 102          */
 103         struct kref topology_kref;
 104
 105         /**
 106          * @malloc_kref: refcount for the memory allocation containing this
 107          * structure. See drm_dp_mst_get_port_malloc() and
 108          * drm_dp_mst_put_port_malloc().
 109          */
 110         struct kref malloc_kref;
 111
 112 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
 113         /**
 114          * @topology_ref_history: A history of each topology
 115          * reference/dereference. See CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS.
 116          */
 117         struct drm_dp_mst_topology_ref_history topology_ref_history;
 118 #endif
 119
 120         u8 port_num;
 121         bool input;
 122         bool mcs;
 123         bool ddps;
 124         u8 pdt;
 125         bool ldps;
 126         u8 dpcd_rev;
 127         u8 num_sdp_streams;
 128         u8 num_sdp_stream_sinks;
 129         uint16_t available_pbn;
 130         struct list_head next;
 131         /**
 132          * @mstb: the branch device connected to this port, if there is one.
 133          * This should be considered protected for reading by
 134          * &drm_dp_mst_topology_mgr.lock. There are two exceptions to this:
 135          * &drm_dp_mst_topology_mgr.up_req_work and
 136          * &drm_dp_mst_topology_mgr.work, which do not grab
 137          * &drm_dp_mst_topology_mgr.lock during reads but are the only
 138          * updaters of this list and are protected from writing concurrently
 139          * by &drm_dp_mst_topology_mgr.probe_lock.
 140          */
 141         struct drm_dp_mst_branch *mstb;
 142         struct drm_dp_aux aux; /* i2c bus for this port? */
 143         struct drm_dp_mst_branch *parent;
 144
 145         struct drm_dp_vcpi vcpi;
 146         struct drm_connector *connector;
 147         struct drm_dp_mst_topology_mgr *mgr;
 148
 149         /**
 150          * @cached_edid: for DP logical ports - make tiling work by ensuring
 151          * that the EDID for all connectors is read immediately.
 152          */
 153         struct edid *cached_edid;
 154         /**
 155          * @has_audio: Tracks whether the sink connector to this port is
 156          * audio-capable.
 157          */
 158         bool has_audio;
 159 };
 160
 161 /**
 162  * struct drm_dp_mst_branch - MST branch device.
 163  * @rad: Relative Address to talk to this branch device.
 164  * @lct: Link count total to talk to this branch device.
 165  * @num_ports: number of ports on the branch.
 166  * @msg_slots: one bit per transmitted msg slot.
 167  * @port_parent: pointer to the port parent, NULL if toplevel.
 168  * @mgr: topology manager for this branch device.
 169  * @tx_slots: transmission slots for this device.
 170  * @last_seqno: last sequence number used to talk to this.
 171  * @link_address_sent: if a link address message has been sent to this device yet.
 172  * @guid: guid for DP 1.2 branch device. port under this branch can be
 173  * identified by port #.
 174  *
 175  * This structure represents an MST branch device, there is one
 176  * primary branch device at the root, along with any other branches connected
 177  * to downstream port of parent branches.
 178  */
 179 struct drm_dp_mst_branch {
 180         /**
 181          * @topology_kref: refcount for this branch device's lifetime in the
 182          * topology, only the DP MST helpers should need to touch this
 183          */
 184         struct kref topology_kref;
 185
 186         /**
 187          * @malloc_kref: refcount for the memory allocation containing this
 188          * structure. See drm_dp_mst_get_mstb_malloc() and
 189          * drm_dp_mst_put_mstb_malloc().
 190          */
 191         struct kref malloc_kref;
 192
 193 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
 194         /**
 195          * @topology_ref_history: A history of each topology
 196          * reference/dereference. See CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS.
 197          */
 198         struct drm_dp_mst_topology_ref_history topology_ref_history;
 199 #endif
 200
 201         /**
 202          * @destroy_next: linked-list entry used by
 203          * drm_dp_delayed_destroy_work()
 204          */
 205         struct list_head destroy_next;
 206
 207         u8 rad[8];
 208         u8 lct;
 209         int num_ports;
 210
 211         int msg_slots;
 212         /**
 213          * @ports: the list of ports on this branch device. This should be
 214          * considered protected for reading by &drm_dp_mst_topology_mgr.lock.
 215          * There are two exceptions to this:
 216          * &drm_dp_mst_topology_mgr.up_req_work and
 217          * &drm_dp_mst_topology_mgr.work, which do not grab
 218          * &drm_dp_mst_topology_mgr.lock during reads but are the only
 219          * updaters of this list and are protected from updating the list
 220          * concurrently by @drm_dp_mst_topology_mgr.probe_lock
 221          */
 222         struct list_head ports;
 223
 224         /* list of tx ops queue for this port */
 225         struct drm_dp_mst_port *port_parent;
 226         struct drm_dp_mst_topology_mgr *mgr;
 227
 228         /* slots are protected by mstb->mgr->qlock */
 229         struct drm_dp_sideband_msg_tx *tx_slots[2];
 230         int last_seqno;
 231         bool link_address_sent;
 232
 233         /* global unique identifier to identify branch devices */
 234         u8 guid[16];
 235 };
 236
 237
 238 /* sideband msg header - not bit struct */
 239 struct drm_dp_sideband_msg_hdr {
 240         u8 lct;
 241         u8 lcr;
 242         u8 rad[8];
 243         bool broadcast;
 244         bool path_msg;
 245         u8 msg_len;
 246         bool somt;
 247         bool eomt;
 248         bool seqno;
 249 };
 250
 251 struct drm_dp_nak_reply {
 252         u8 guid[16];
 253         u8 reason;
 254         u8 nak_data;
 255 };
 256
 257 struct drm_dp_link_address_ack_reply {
 258         u8 guid[16];
 259         u8 nports;
 260         struct drm_dp_link_addr_reply_port {
 261                 bool input_port;
 262                 u8 peer_device_type;
 263                 u8 port_number;
 264                 bool mcs;
 265                 bool ddps;
 266                 bool legacy_device_plug_status;
 267                 u8 dpcd_revision;
 268                 u8 peer_guid[16];
 269                 u8 num_sdp_streams;
 270                 u8 num_sdp_stream_sinks;
 271         } ports[16];
 272 };
 273
 274 struct drm_dp_remote_dpcd_read_ack_reply {
 275         u8 port_number;
 276         u8 num_bytes;
 277         u8 bytes[255];
 278 };
 279
 280 struct drm_dp_remote_dpcd_write_ack_reply {
 281         u8 port_number;
 282 };
 283
 284 struct drm_dp_remote_dpcd_write_nak_reply {
 285         u8 port_number;
 286         u8 reason;
 287         u8 bytes_written_before_failure;
 288 };
 289
 290 struct drm_dp_remote_i2c_read_ack_reply {
 291         u8 port_number;
 292         u8 num_bytes;
 293         u8 bytes[255];
 294 };
 295
 296 struct drm_dp_remote_i2c_read_nak_reply {
 297         u8 port_number;
 298         u8 nak_reason;
 299         u8 i2c_nak_transaction;
 300 };
 301
 302 struct drm_dp_remote_i2c_write_ack_reply {
 303         u8 port_number;
 304 };
 305
 306
 307 struct drm_dp_sideband_msg_rx {
 308         u8 chunk[48];
 309         u8 msg[256];
 310         u8 curchunk_len;
 311         u8 curchunk_idx; /* chunk we are parsing now */
 312         u8 curchunk_hdrlen;
 313         u8 curlen; /* total length of the msg */
 314         bool have_somt;
 315         bool have_eomt;
 316         struct drm_dp_sideband_msg_hdr initial_hdr;
 317 };
 318
 319 #define DRM_DP_MAX_SDP_STREAMS 16
 320 struct drm_dp_allocate_payload {
 321         u8 port_number;
 322         u8 number_sdp_streams;
 323         u8 vcpi;
 324         u16 pbn;
 325         u8 sdp_stream_sink[DRM_DP_MAX_SDP_STREAMS];
 326 };
 327
 328 struct drm_dp_allocate_payload_ack_reply {
 329         u8 port_number;
 330         u8 vcpi;
 331         u16 allocated_pbn;
 332 };
 333
 334 struct drm_dp_connection_status_notify {
 335         u8 guid[16];
 336         u8 port_number;
 337         bool legacy_device_plug_status;
 338         bool displayport_device_plug_status;
 339         bool message_capability_status;
 340         bool input_port;
 341         u8 peer_device_type;
 342 };
 343
 344 struct drm_dp_remote_dpcd_read {
 345         u8 port_number;
 346         u32 dpcd_address;
 347         u8 num_bytes;
 348 };
 349
 350 struct drm_dp_remote_dpcd_write {
 351         u8 port_number;
 352         u32 dpcd_address;
 353         u8 num_bytes;
 354         u8 *bytes;
 355 };
 356
 357 #define DP_REMOTE_I2C_READ_MAX_TRANSACTIONS 4
 358 struct drm_dp_remote_i2c_read {
 359         u8 num_transactions;
 360         u8 port_number;
 361         struct drm_dp_remote_i2c_read_tx {
 362                 u8 i2c_dev_id;
 363                 u8 num_bytes;
 364                 u8 *bytes;
 365                 u8 no_stop_bit;
 366                 u8 i2c_transaction_delay;
 367         } transactions[DP_REMOTE_I2C_READ_MAX_TRANSACTIONS];
 368         u8 read_i2c_device_id;
 369         u8 num_bytes_read;
 370 };
 371
 372 struct drm_dp_remote_i2c_write {
 373         u8 port_number;
 374         u8 write_i2c_device_id;
 375         u8 num_bytes;
 376         u8 *bytes;
 377 };
 378
 379 /* this covers ENUM_RESOURCES, POWER_DOWN_PHY, POWER_UP_PHY */
 380 struct drm_dp_port_number_req {
 381         u8 port_number;
 382 };
 383
 384 struct drm_dp_enum_path_resources_ack_reply {
 385         u8 port_number;
 386         u16 full_payload_bw_number;
 387         u16 avail_payload_bw_number;
 388 };
 389
 390 /* covers POWER_DOWN_PHY, POWER_UP_PHY */
 391 struct drm_dp_port_number_rep {
 392         u8 port_number;
 393 };
 394
 395 struct drm_dp_query_payload {
 396         u8 port_number;
 397         u8 vcpi;
 398 };
 399
 400 struct drm_dp_resource_status_notify {
 401         u8 port_number;
 402         u8 guid[16];
 403         u16 available_pbn;
 404 };
 405
 406 struct drm_dp_query_payload_ack_reply {
 407         u8 port_number;
 408         u16 allocated_pbn;
 409 };
 410
 411 struct drm_dp_sideband_msg_req_body {
 412         u8 req_type;
 413         union ack_req {
 414                 struct drm_dp_connection_status_notify conn_stat;
 415                 struct drm_dp_port_number_req port_num;
 416                 struct drm_dp_resource_status_notify resource_stat;
 417
 418                 struct drm_dp_query_payload query_payload;
 419                 struct drm_dp_allocate_payload allocate_payload;
 420
 421                 struct drm_dp_remote_dpcd_read dpcd_read;
 422                 struct drm_dp_remote_dpcd_write dpcd_write;
 423
 424                 struct drm_dp_remote_i2c_read i2c_read;
 425                 struct drm_dp_remote_i2c_write i2c_write;
 426         } u;
 427 };
 428
 429 struct drm_dp_sideband_msg_reply_body {
 430         u8 reply_type;
 431         u8 req_type;
 432         union ack_replies {
 433                 struct drm_dp_nak_reply nak;
 434                 struct drm_dp_link_address_ack_reply link_addr;
 435                 struct drm_dp_port_number_rep port_number;
 436
 437                 struct drm_dp_enum_path_resources_ack_reply path_resources;
 438                 struct drm_dp_allocate_payload_ack_reply allocate_payload;
 439                 struct drm_dp_query_payload_ack_reply query_payload;
 440
 441                 struct drm_dp_remote_dpcd_read_ack_reply remote_dpcd_read_ack;
 442                 struct drm_dp_remote_dpcd_write_ack_reply remote_dpcd_write_ack;
 443                 struct drm_dp_remote_dpcd_write_nak_reply remote_dpcd_write_nack;
 444
 445                 struct drm_dp_remote_i2c_read_ack_reply remote_i2c_read_ack;
 446                 struct drm_dp_remote_i2c_read_nak_reply remote_i2c_read_nack;
 447                 struct drm_dp_remote_i2c_write_ack_reply remote_i2c_write_ack;
 448         } u;
 449 };
 450
 451 /* msg is queued to be put into a slot */
 452 #define DRM_DP_SIDEBAND_TX_QUEUED 0
 453 /* msg has started transmitting on a slot - still on msgq */
 454 #define DRM_DP_SIDEBAND_TX_START_SEND 1
 455 /* msg has finished transmitting on a slot - removed from msgq only in slot */
 456 #define DRM_DP_SIDEBAND_TX_SENT 2
 457 /* msg has received a response - removed from slot */
 458 #define DRM_DP_SIDEBAND_TX_RX 3
 459 #define DRM_DP_SIDEBAND_TX_TIMEOUT 4
 460
 461 struct drm_dp_sideband_msg_tx {
 462         u8 msg[256];
 463         u8 chunk[48];
 464         u8 cur_offset;
 465         u8 cur_len;
 466         struct drm_dp_mst_branch *dst;
 467         struct list_head next;
 468         int seqno;
 469         int state;
 470         bool path_msg;
 471         struct drm_dp_sideband_msg_reply_body reply;
 472 };
 473
 474 /* sideband msg handler */
 475 struct drm_dp_mst_topology_mgr;
 476 struct drm_dp_mst_topology_cbs {
 477         /* create a connector for a port */
 478         struct drm_connector *(*add_connector)(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port, const char *path);
 479         void (*register_connector)(struct drm_connector *connector);
 480         void (*destroy_connector)(struct drm_dp_mst_topology_mgr *mgr,
 481                                   struct drm_connector *connector);
 482 };
 483
 484 #define DP_MAX_PAYLOAD (sizeof(unsigned long) * 8)
 485
 486 #define DP_PAYLOAD_LOCAL 1
 487 #define DP_PAYLOAD_REMOTE 2
 488 #define DP_PAYLOAD_DELETE_LOCAL 3
 489
 490 struct drm_dp_payload {
 491         int payload_state;
 492         int start_slot;
 493         int num_slots;
 494         int vcpi;
 495 };
 496
 497 #define to_dp_mst_topology_state(x) container_of(x, struct drm_dp_mst_topology_state, base)
 498
 499 struct drm_dp_vcpi_allocation {
 500         struct drm_dp_mst_port *port;
 501         int vcpi;
 502         struct list_head next;
 503 };
 504
 505 struct drm_dp_mst_topology_state {
 506         struct drm_private_state base;
 507         struct list_head vcpis;
 508         struct drm_dp_mst_topology_mgr *mgr;
 509 };
 510
 511 #define to_dp_mst_topology_mgr(x) container_of(x, struct drm_dp_mst_topology_mgr, base)
 512
 513 /**
 514  * struct drm_dp_mst_topology_mgr - DisplayPort MST manager
 515  *
 516  * This struct represents the toplevel displayport MST topology manager.
 517  * There should be one instance of this for every MST capable DP connector
 518  * on the GPU.
 519  */
 520 struct drm_dp_mst_topology_mgr {
 521         /**
 522          * @base: Base private object for atomic
 523          */
 524         struct drm_private_obj base;
 525
 526         /**
 527          * @dev: device pointer for adding i2c devices etc.
 528          */
 529         struct drm_device *dev;
 530         /**
 531          * @cbs: callbacks for connector addition and destruction.
 532          */
 533         const struct drm_dp_mst_topology_cbs *cbs;
 534         /**
 535          * @max_dpcd_transaction_bytes: maximum number of bytes to read/write
 536          * in one go.
 537          */
 538         int max_dpcd_transaction_bytes;
 539         /**
 540          * @aux: AUX channel for the DP MST connector this topolgy mgr is
 541          * controlling.
 542          */
 543         struct drm_dp_aux *aux;
 544         /**
 545          * @max_payloads: maximum number of payloads the GPU can generate.
 546          */
 547         int max_payloads;
 548         /**
 549          * @conn_base_id: DRM connector ID this mgr is connected to. Only used
 550          * to build the MST connector path value.
 551          */
 552         int conn_base_id;
 553
 554         /**
 555          * @down_rep_recv: Message receiver state for down replies.
 556          */
 557         struct drm_dp_sideband_msg_rx down_rep_recv;
 558         /**
 559          * @up_req_recv: Message receiver state for up requests.
 560          */
 561         struct drm_dp_sideband_msg_rx up_req_recv;
 562
 563         /**
 564          * @lock: protects @mst_state, @mst_primary, @dpcd, and
 565          * @payload_id_table_cleared.
 566          */
 567         struct mutex lock;
 568
 569         /**
 570          * @probe_lock: Prevents @work and @up_req_work, the only writers of
 571          * &drm_dp_mst_port.mstb and &drm_dp_mst_branch.ports, from racing
 572          * while they update the topology.
 573          */
 574         struct mutex probe_lock;
 575
 576         /**
 577          * @mst_state: If this manager is enabled for an MST capable port. False
 578          * if no MST sink/branch devices is connected.
 579          */
 580         bool mst_state : 1;
 581
 582         /**
 583          * @payload_id_table_cleared: Whether or not we've cleared the payload
 584          * ID table for @mst_primary. Protected by @lock.
 585          */
 586         bool payload_id_table_cleared : 1;
 587
 588         /**
 589          * @mst_primary: Pointer to the primary/first branch device.
 590          */
 591         struct drm_dp_mst_branch *mst_primary;
 592
 593         /**
 594          * @dpcd: Cache of DPCD for primary port.
 595          */
 596         u8 dpcd[DP_RECEIVER_CAP_SIZE];
 597         /**
 598          * @sink_count: Sink count from DEVICE_SERVICE_IRQ_VECTOR_ESI0.
 599          */
 600         u8 sink_count;
 601         /**
 602          * @pbn_div: PBN to slots divisor.
 603          */
 604         int pbn_div;
 605
 606         /**
 607          * @funcs: Atomic helper callbacks
 608          */
 609         const struct drm_private_state_funcs *funcs;
 610
 611         /**
 612          * @qlock: protects @tx_msg_downq, the &drm_dp_mst_branch.txslost and
 613          * &drm_dp_sideband_msg_tx.state once they are queued
 614          */
 615         struct mutex qlock;
 616         /**
 617          * @tx_msg_downq: List of pending down replies.
 618          */
 619         struct list_head tx_msg_downq;
 620
 621         /**
 622          * @payload_lock: Protect payload information.
 623          */
 624         struct mutex payload_lock;
 625         /**
 626          * @proposed_vcpis: Array of pointers for the new VCPI allocation. The
 627          * VCPI structure itself is &drm_dp_mst_port.vcpi.
 628          */
 629         struct drm_dp_vcpi **proposed_vcpis;
 630         /**
 631          * @payloads: Array of payloads.
 632          */
 633         struct drm_dp_payload *payloads;
 634         /**
 635          * @payload_mask: Elements of @payloads actually in use. Since
 636          * reallocation of active outputs isn't possible gaps can be created by
 637          * disabling outputs out of order compared to how they've been enabled.
 638          */
 639         unsigned long payload_mask;
 640         /**
 641          * @vcpi_mask: Similar to @payload_mask, but for @proposed_vcpis.
 642          */
 643         unsigned long vcpi_mask;
 644
 645         /**
 646          * @tx_waitq: Wait to queue stall for the tx worker.
 647          */
 648         wait_queue_head_t tx_waitq;
 649         /**
 650          * @work: Probe work.
 651          */
 652         struct work_struct work;
 653         /**
 654          * @tx_work: Sideband transmit worker. This can nest within the main
 655          * @work worker for each transaction @work launches.
 656          */
 657         struct work_struct tx_work;
 658
 659         /**
 660          * @destroy_port_list: List of to be destroyed connectors.
 661          */
 662         struct list_head destroy_port_list;
 663         /**
 664          * @destroy_branch_device_list: List of to be destroyed branch
 665          * devices.
 666          */
 667         struct list_head destroy_branch_device_list;
 668         /**
 669          * @delayed_destroy_lock: Protects @destroy_port_list and
 670          * @destroy_branch_device_list.
 671          */
 672         struct mutex delayed_destroy_lock;
 673         /**
 674          * @delayed_destroy_work: Work item to destroy MST port and branch
 675          * devices, needed to avoid locking inversion.
 676          */
 677         struct work_struct delayed_destroy_work;
 678
 679         /**
 680          * @up_req_list: List of pending up requests from the topology that
 681          * need to be processed, in chronological order.
 682          */
 683         struct list_head up_req_list;
 684         /**
 685          * @up_req_lock: Protects @up_req_list
 686          */
 687         struct mutex up_req_lock;
 688         /**
 689          * @up_req_work: Work item to process up requests received from the
 690          * topology. Needed to avoid blocking hotplug handling and sideband
 691          * transmissions.
 692          */
 693         struct work_struct up_req_work;
 694
 695 #if IS_ENABLED(CONFIG_DRM_DEBUG_DP_MST_TOPOLOGY_REFS)
 696         /**
 697          * @topology_ref_history_lock: protects
 698          * &drm_dp_mst_port.topology_ref_history and
 699          * &drm_dp_mst_branch.topology_ref_history.
 700          */
 701         struct mutex topology_ref_history_lock;
 702 #endif
 703 };
 704
 705 int drm_dp_mst_topology_mgr_init(struct drm_dp_mst_topology_mgr *mgr,
 706                                  struct drm_device *dev, struct drm_dp_aux *aux,
 707                                  int max_dpcd_transaction_bytes,
 708                                  int max_payloads, int conn_base_id);
 709
 710 void drm_dp_mst_topology_mgr_destroy(struct drm_dp_mst_topology_mgr *mgr);
 711
 712
 713 int drm_dp_mst_topology_mgr_set_mst(struct drm_dp_mst_topology_mgr *mgr, bool mst_state);
 714
 715
 716 int drm_dp_mst_hpd_irq(struct drm_dp_mst_topology_mgr *mgr, u8 *esi, bool *handled);
 717
 718
 719 int
 720 drm_dp_mst_detect_port(struct drm_connector *connector,
 721                        struct drm_modeset_acquire_ctx *ctx,
 722                        struct drm_dp_mst_topology_mgr *mgr,
 723                        struct drm_dp_mst_port *port);
 724
 725 bool drm_dp_mst_port_has_audio(struct drm_dp_mst_topology_mgr *mgr,
 726                                         struct drm_dp_mst_port *port);
 727 struct edid *drm_dp_mst_get_edid(struct drm_connector *connector, struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
 728
 729
 730 int drm_dp_calc_pbn_mode(int clock, int bpp, bool dsc);
 731
 732 bool drm_dp_mst_allocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
 733                               struct drm_dp_mst_port *port, int pbn, int slots);
 734
 735 int drm_dp_mst_get_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
 736
 737
 738 void drm_dp_mst_reset_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr, struct drm_dp_mst_port *port);
 739
 740
 741 void drm_dp_mst_deallocate_vcpi(struct drm_dp_mst_topology_mgr *mgr,
 742                                 struct drm_dp_mst_port *port);
 743
 744
 745 int drm_dp_find_vcpi_slots(struct drm_dp_mst_topology_mgr *mgr,
 746                            int pbn);
 747
 748
 749 int drm_dp_update_payload_part1(struct drm_dp_mst_topology_mgr *mgr);
 750
 751
 752 int drm_dp_update_payload_part2(struct drm_dp_mst_topology_mgr *mgr);
 753
 754 int drm_dp_check_act_status(struct drm_dp_mst_topology_mgr *mgr);
 755
 756 void drm_dp_mst_dump_topology(struct seq_file *m,
 757                               struct drm_dp_mst_topology_mgr *mgr);
 758
 759 void drm_dp_mst_topology_mgr_suspend(struct drm_dp_mst_topology_mgr *mgr);
 760 int __must_check
 761 drm_dp_mst_topology_mgr_resume(struct drm_dp_mst_topology_mgr *mgr,
 762                                bool sync);
 763
 764 ssize_t drm_dp_mst_dpcd_read(struct drm_dp_aux *aux,
 765                              unsigned int offset, void *buffer, size_t size);
 766 ssize_t drm_dp_mst_dpcd_write(struct drm_dp_aux *aux,
 767                               unsigned int offset, void *buffer, size_t size);
 768
 769 int drm_dp_mst_connector_late_register(struct drm_connector *connector,
 770                                        struct drm_dp_mst_port *port);
 771 void drm_dp_mst_connector_early_unregister(struct drm_connector *connector,
 772                                            struct drm_dp_mst_port *port);
 773
 774 struct drm_dp_mst_topology_state *drm_atomic_get_mst_topology_state(struct drm_atomic_state *state,
 775                                                                     struct drm_dp_mst_topology_mgr *mgr);
 776 int __must_check
 777 drm_dp_atomic_find_vcpi_slots(struct drm_atomic_state *state,
 778                               struct drm_dp_mst_topology_mgr *mgr,
 779                               struct drm_dp_mst_port *port, int pbn);
 780 int __must_check
 781 drm_dp_atomic_release_vcpi_slots(struct drm_atomic_state *state,
 782                                  struct drm_dp_mst_topology_mgr *mgr,
 783                                  struct drm_dp_mst_port *port);
 784 int drm_dp_send_power_updown_phy(struct drm_dp_mst_topology_mgr *mgr,
 785                                  struct drm_dp_mst_port *port, bool power_up);
 786 int __must_check drm_dp_mst_atomic_check(struct drm_atomic_state *state);
 787
 788 void drm_dp_mst_get_port_malloc(struct drm_dp_mst_port *port);
 789 void drm_dp_mst_put_port_malloc(struct drm_dp_mst_port *port);
 790
 791 extern const struct drm_private_state_funcs drm_dp_mst_topology_state_funcs;
 792
 793 /**
 794  * __drm_dp_mst_state_iter_get - private atomic state iterator function for
 795  * macro-internal use
 796  * @state: &struct drm_atomic_state pointer
 797  * @mgr: pointer to the &struct drm_dp_mst_topology_mgr iteration cursor
 798  * @old_state: optional pointer to the old &struct drm_dp_mst_topology_state
 799  * iteration cursor
 800  * @new_state: optional pointer to the new &struct drm_dp_mst_topology_state
 801  * iteration cursor
 802  * @i: int iteration cursor, for macro-internal use
 803  *
 804  * Used by for_each_oldnew_mst_mgr_in_state(),
 805  * for_each_old_mst_mgr_in_state(), and for_each_new_mst_mgr_in_state(). Don't
 806  * call this directly.
 807  *
 808  * Returns:
 809  * True if the current &struct drm_private_obj is a &struct
 810  * drm_dp_mst_topology_mgr, false otherwise.
 811  */
 812 static inline bool
 813 __drm_dp_mst_state_iter_get(struct drm_atomic_state *state,
 814                             struct drm_dp_mst_topology_mgr **mgr,
 815                             struct drm_dp_mst_topology_state **old_state,
 816                             struct drm_dp_mst_topology_state **new_state,
 817                             int i)
 818 {
 819         struct __drm_private_objs_state *objs_state = &state->private_objs[i];
 820
 821         if (objs_state->ptr->funcs != &drm_dp_mst_topology_state_funcs)
 822                 return false;
 823
 824         *mgr = to_dp_mst_topology_mgr(objs_state->ptr);
 825         if (old_state)
 826                 *old_state = to_dp_mst_topology_state(objs_state->old_state);
 827         if (new_state)
 828                 *new_state = to_dp_mst_topology_state(objs_state->new_state);
 829
 830         return true;
 831 }
 832
 833 /**
 834  * for_each_oldnew_mst_mgr_in_state - iterate over all DP MST topology
 835  * managers in an atomic update
 836  * @__state: &struct drm_atomic_state pointer
 837  * @mgr: &struct drm_dp_mst_topology_mgr iteration cursor
 838  * @old_state: &struct drm_dp_mst_topology_state iteration cursor for the old
 839  * state
 840  * @new_state: &struct drm_dp_mst_topology_state iteration cursor for the new
 841  * state
 842  * @__i: int iteration cursor, for macro-internal use
 843  *
 844  * This iterates over all DRM DP MST topology managers in an atomic update,
 845  * tracking both old and new state. This is useful in places where the state
 846  * delta needs to be considered, for example in atomic check functions.
 847  */
 848 #define for_each_oldnew_mst_mgr_in_state(__state, mgr, old_state, new_state, __i) \
 849         for ((__i) = 0; (__i) < (__state)->num_private_objs; (__i)++) \
 850                 for_each_if(__drm_dp_mst_state_iter_get((__state), &(mgr), &(old_state), &(new_state), (__i)))
 851
 852 /**
 853  * for_each_old_mst_mgr_in_state - iterate over all DP MST topology managers
 854  * in an atomic update
 855  * @__state: &struct drm_atomic_state pointer
 856  * @mgr: &struct drm_dp_mst_topology_mgr iteration cursor
 857  * @old_state: &struct drm_dp_mst_topology_state iteration cursor for the old
 858  * state
 859  * @__i: int iteration cursor, for macro-internal use
 860  *
 861  * This iterates over all DRM DP MST topology managers in an atomic update,
 862  * tracking only the old state. This is useful in disable functions, where we
 863  * need the old state the hardware is still in.
 864  */
 865 #define for_each_old_mst_mgr_in_state(__state, mgr, old_state, __i) \
 866         for ((__i) = 0; (__i) < (__state)->num_private_objs; (__i)++) \
 867                 for_each_if(__drm_dp_mst_state_iter_get((__state), &(mgr), &(old_state), NULL, (__i)))
 868
 869 /**
 870  * for_each_new_mst_mgr_in_state - iterate over all DP MST topology managers
 871  * in an atomic update
 872  * @__state: &struct drm_atomic_state pointer
 873  * @mgr: &struct drm_dp_mst_topology_mgr iteration cursor
 874  * @new_state: &struct drm_dp_mst_topology_state iteration cursor for the new
 875  * state
 876  * @__i: int iteration cursor, for macro-internal use
 877  *
 878  * This iterates over all DRM DP MST topology managers in an atomic update,
 879  * tracking only the new state. This is useful in enable functions, where we
 880  * need the new state the hardware should be in when the atomic commit
 881  * operation has completed.
 882  */
 883 #define for_each_new_mst_mgr_in_state(__state, mgr, new_state, __i) \
 884         for ((__i) = 0; (__i) < (__state)->num_private_objs; (__i)++) \
 885                 for_each_if(__drm_dp_mst_state_iter_get((__state), &(mgr), NULL, &(new_state), (__i)))
 886
 887 #endif