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