Linux 6.9-rc1
[linux-2.6-microblaze.git] / drivers / gpu / drm / amd / display / amdgpu_dm / amdgpu_dm.h
1 /*
2  * Copyright (C) 2015-2020 Advanced Micro Devices, Inc. All rights reserved.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: AMD
23  *
24  */
25
26 #ifndef __AMDGPU_DM_H__
27 #define __AMDGPU_DM_H__
28
29 #include <drm/display/drm_dp_mst_helper.h>
30 #include <drm/drm_atomic.h>
31 #include <drm/drm_connector.h>
32 #include <drm/drm_crtc.h>
33 #include <drm/drm_plane.h>
34 #include "link_service_types.h"
35 #include <drm/drm_writeback.h>
36
37 /*
38  * This file contains the definition for amdgpu_display_manager
39  * and its API for amdgpu driver's use.
40  * This component provides all the display related functionality
41  * and this is the only component that calls DAL API.
42  * The API contained here intended for amdgpu driver use.
43  * The API that is called directly from KMS framework is located
44  * in amdgpu_dm_kms.h file
45  */
46
47 #define AMDGPU_DM_MAX_DISPLAY_INDEX 31
48
49 #define AMDGPU_DM_MAX_CRTC 6
50
51 #define AMDGPU_DM_MAX_NUM_EDP 2
52
53 #define AMDGPU_DMUB_NOTIFICATION_MAX 5
54
55 #define HDMI_AMD_VENDOR_SPECIFIC_DATA_BLOCK_IEEE_REGISTRATION_ID 0x00001A
56 #define AMD_VSDB_VERSION_3_FEATURECAP_REPLAYMODE 0x40
57 #define HDMI_AMD_VENDOR_SPECIFIC_DATA_BLOCK_VERSION_3 0x3
58
59 #define AMDGPU_HDR_MULT_DEFAULT (0x100000000LL)
60
61 /*
62 #include "include/amdgpu_dal_power_if.h"
63 #include "amdgpu_dm_irq.h"
64 */
65
66 #include "irq_types.h"
67 #include "signal_types.h"
68 #include "amdgpu_dm_crc.h"
69 #include "mod_info_packet.h"
70 struct aux_payload;
71 struct set_config_cmd_payload;
72 enum aux_return_code_type;
73 enum set_config_status;
74
75 /* Forward declarations */
76 struct amdgpu_device;
77 struct amdgpu_crtc;
78 struct drm_device;
79 struct dc;
80 struct amdgpu_bo;
81 struct dmub_srv;
82 struct dc_plane_state;
83 struct dmub_notification;
84
85 struct amd_vsdb_block {
86         unsigned char ieee_id[3];
87         unsigned char version;
88         unsigned char feature_caps;
89 };
90
91 struct common_irq_params {
92         struct amdgpu_device *adev;
93         enum dc_irq_source irq_src;
94         atomic64_t previous_timestamp;
95 };
96
97 /**
98  * struct dm_compressor_info - Buffer info used by frame buffer compression
99  * @cpu_addr: MMIO cpu addr
100  * @bo_ptr: Pointer to the buffer object
101  * @gpu_addr: MMIO gpu addr
102  */
103 struct dm_compressor_info {
104         void *cpu_addr;
105         struct amdgpu_bo *bo_ptr;
106         uint64_t gpu_addr;
107 };
108
109 typedef void (*dmub_notify_interrupt_callback_t)(struct amdgpu_device *adev, struct dmub_notification *notify);
110
111 /**
112  * struct dmub_hpd_work - Handle time consuming work in low priority outbox IRQ
113  *
114  * @handle_hpd_work: Work to be executed in a separate thread to handle hpd_low_irq
115  * @dmub_notify:  notification for callback function
116  * @adev: amdgpu_device pointer
117  */
118 struct dmub_hpd_work {
119         struct work_struct handle_hpd_work;
120         struct dmub_notification *dmub_notify;
121         struct amdgpu_device *adev;
122 };
123
124 /**
125  * struct vblank_control_work - Work data for vblank control
126  * @work: Kernel work data for the work event
127  * @dm: amdgpu display manager device
128  * @acrtc: amdgpu CRTC instance for which the event has occurred
129  * @stream: DC stream for which the event has occurred
130  * @enable: true if enabling vblank
131  */
132 struct vblank_control_work {
133         struct work_struct work;
134         struct amdgpu_display_manager *dm;
135         struct amdgpu_crtc *acrtc;
136         struct dc_stream_state *stream;
137         bool enable;
138 };
139
140 /**
141  * struct amdgpu_dm_backlight_caps - Information about backlight
142  *
143  * Describe the backlight support for ACPI or eDP AUX.
144  */
145 struct amdgpu_dm_backlight_caps {
146         /**
147          * @ext_caps: Keep the data struct with all the information about the
148          * display support for HDR.
149          */
150         union dpcd_sink_ext_caps *ext_caps;
151         /**
152          * @aux_min_input_signal: Min brightness value supported by the display
153          */
154         u32 aux_min_input_signal;
155         /**
156          * @aux_max_input_signal: Max brightness value supported by the display
157          * in nits.
158          */
159         u32 aux_max_input_signal;
160         /**
161          * @min_input_signal: minimum possible input in range 0-255.
162          */
163         int min_input_signal;
164         /**
165          * @max_input_signal: maximum possible input in range 0-255.
166          */
167         int max_input_signal;
168         /**
169          * @caps_valid: true if these values are from the ACPI interface.
170          */
171         bool caps_valid;
172         /**
173          * @aux_support: Describes if the display supports AUX backlight.
174          */
175         bool aux_support;
176 };
177
178 /**
179  * struct dal_allocation - Tracks mapped FB memory for SMU communication
180  * @list: list of dal allocations
181  * @bo: GPU buffer object
182  * @cpu_ptr: CPU virtual address of the GPU buffer object
183  * @gpu_addr: GPU virtual address of the GPU buffer object
184  */
185 struct dal_allocation {
186         struct list_head list;
187         struct amdgpu_bo *bo;
188         void *cpu_ptr;
189         u64 gpu_addr;
190 };
191
192 /**
193  * struct hpd_rx_irq_offload_work_queue - Work queue to handle hpd_rx_irq
194  * offload work
195  */
196 struct hpd_rx_irq_offload_work_queue {
197         /**
198          * @wq: workqueue structure to queue offload work.
199          */
200         struct workqueue_struct *wq;
201         /**
202          * @offload_lock: To protect fields of offload work queue.
203          */
204         spinlock_t offload_lock;
205         /**
206          * @is_handling_link_loss: Used to prevent inserting link loss event when
207          * we're handling link loss
208          */
209         bool is_handling_link_loss;
210         /**
211          * @is_handling_mst_msg_rdy_event: Used to prevent inserting mst message
212          * ready event when we're already handling mst message ready event
213          */
214         bool is_handling_mst_msg_rdy_event;
215         /**
216          * @aconnector: The aconnector that this work queue is attached to
217          */
218         struct amdgpu_dm_connector *aconnector;
219 };
220
221 /**
222  * struct hpd_rx_irq_offload_work - hpd_rx_irq offload work structure
223  */
224 struct hpd_rx_irq_offload_work {
225         /**
226          * @work: offload work
227          */
228         struct work_struct work;
229         /**
230          * @data: reference irq data which is used while handling offload work
231          */
232         union hpd_irq_data data;
233         /**
234          * @offload_wq: offload work queue that this work is queued to
235          */
236         struct hpd_rx_irq_offload_work_queue *offload_wq;
237 };
238
239 /**
240  * struct amdgpu_display_manager - Central amdgpu display manager device
241  *
242  * @dc: Display Core control structure
243  * @adev: AMDGPU base driver structure
244  * @ddev: DRM base driver structure
245  * @display_indexes_num: Max number of display streams supported
246  * @irq_handler_list_table_lock: Synchronizes access to IRQ tables
247  * @backlight_dev: Backlight control device
248  * @backlight_link: Link on which to control backlight
249  * @backlight_caps: Capabilities of the backlight device
250  * @freesync_module: Module handling freesync calculations
251  * @hdcp_workqueue: AMDGPU content protection queue
252  * @fw_dmcu: Reference to DMCU firmware
253  * @dmcu_fw_version: Version of the DMCU firmware
254  * @soc_bounding_box: SOC bounding box values provided by gpu_info FW
255  * @cached_state: Caches device atomic state for suspend/resume
256  * @cached_dc_state: Cached state of content streams
257  * @compressor: Frame buffer compression buffer. See &struct dm_compressor_info
258  * @force_timing_sync: set via debugfs. When set, indicates that all connected
259  *                     displays will be forced to synchronize.
260  * @dmcub_trace_event_en: enable dmcub trace events
261  * @dmub_outbox_params: DMUB Outbox parameters
262  * @num_of_edps: number of backlight eDPs
263  * @disable_hpd_irq: disables all HPD and HPD RX interrupt handling in the
264  *                   driver when true
265  * @dmub_aux_transfer_done: struct completion used to indicate when DMUB
266  *                          transfers are done
267  * @delayed_hpd_wq: work queue used to delay DMUB HPD work
268  */
269 struct amdgpu_display_manager {
270
271         struct dc *dc;
272
273         /**
274          * @dmub_srv:
275          *
276          * DMUB service, used for controlling the DMUB on hardware
277          * that supports it. The pointer to the dmub_srv will be
278          * NULL on hardware that does not support it.
279          */
280         struct dmub_srv *dmub_srv;
281
282         /**
283          * @dmub_notify:
284          *
285          * Notification from DMUB.
286          */
287
288         struct dmub_notification *dmub_notify;
289
290         /**
291          * @dmub_callback:
292          *
293          * Callback functions to handle notification from DMUB.
294          */
295
296         dmub_notify_interrupt_callback_t dmub_callback[AMDGPU_DMUB_NOTIFICATION_MAX];
297
298         /**
299          * @dmub_thread_offload:
300          *
301          * Flag to indicate if callback is offload.
302          */
303
304         bool dmub_thread_offload[AMDGPU_DMUB_NOTIFICATION_MAX];
305
306         /**
307          * @dmub_fb_info:
308          *
309          * Framebuffer regions for the DMUB.
310          */
311         struct dmub_srv_fb_info *dmub_fb_info;
312
313         /**
314          * @dmub_fw:
315          *
316          * DMUB firmware, required on hardware that has DMUB support.
317          */
318         const struct firmware *dmub_fw;
319
320         /**
321          * @dmub_bo:
322          *
323          * Buffer object for the DMUB.
324          */
325         struct amdgpu_bo *dmub_bo;
326
327         /**
328          * @dmub_bo_gpu_addr:
329          *
330          * GPU virtual address for the DMUB buffer object.
331          */
332         u64 dmub_bo_gpu_addr;
333
334         /**
335          * @dmub_bo_cpu_addr:
336          *
337          * CPU address for the DMUB buffer object.
338          */
339         void *dmub_bo_cpu_addr;
340
341         /**
342          * @dmcub_fw_version:
343          *
344          * DMCUB firmware version.
345          */
346         uint32_t dmcub_fw_version;
347
348         /**
349          * @cgs_device:
350          *
351          * The Common Graphics Services device. It provides an interface for
352          * accessing registers.
353          */
354         struct cgs_device *cgs_device;
355
356         struct amdgpu_device *adev;
357         struct drm_device *ddev;
358         u16 display_indexes_num;
359
360         /**
361          * @atomic_obj:
362          *
363          * In combination with &dm_atomic_state it helps manage
364          * global atomic state that doesn't map cleanly into existing
365          * drm resources, like &dc_context.
366          */
367         struct drm_private_obj atomic_obj;
368
369         /**
370          * @dc_lock:
371          *
372          * Guards access to DC functions that can issue register write
373          * sequences.
374          */
375         struct mutex dc_lock;
376
377         /**
378          * @audio_lock:
379          *
380          * Guards access to audio instance changes.
381          */
382         struct mutex audio_lock;
383
384         /**
385          * @audio_component:
386          *
387          * Used to notify ELD changes to sound driver.
388          */
389         struct drm_audio_component *audio_component;
390
391         /**
392          * @audio_registered:
393          *
394          * True if the audio component has been registered
395          * successfully, false otherwise.
396          */
397         bool audio_registered;
398
399         /**
400          * @irq_handler_list_low_tab:
401          *
402          * Low priority IRQ handler table.
403          *
404          * It is a n*m table consisting of n IRQ sources, and m handlers per IRQ
405          * source. Low priority IRQ handlers are deferred to a workqueue to be
406          * processed. Hence, they can sleep.
407          *
408          * Note that handlers are called in the same order as they were
409          * registered (FIFO).
410          */
411         struct list_head irq_handler_list_low_tab[DAL_IRQ_SOURCES_NUMBER];
412
413         /**
414          * @irq_handler_list_high_tab:
415          *
416          * High priority IRQ handler table.
417          *
418          * It is a n*m table, same as &irq_handler_list_low_tab. However,
419          * handlers in this table are not deferred and are called immediately.
420          */
421         struct list_head irq_handler_list_high_tab[DAL_IRQ_SOURCES_NUMBER];
422
423         /**
424          * @pflip_params:
425          *
426          * Page flip IRQ parameters, passed to registered handlers when
427          * triggered.
428          */
429         struct common_irq_params
430         pflip_params[DC_IRQ_SOURCE_PFLIP_LAST - DC_IRQ_SOURCE_PFLIP_FIRST + 1];
431
432         /**
433          * @vblank_params:
434          *
435          * Vertical blanking IRQ parameters, passed to registered handlers when
436          * triggered.
437          */
438         struct common_irq_params
439         vblank_params[DC_IRQ_SOURCE_VBLANK6 - DC_IRQ_SOURCE_VBLANK1 + 1];
440
441         /**
442          * @vline0_params:
443          *
444          * OTG vertical interrupt0 IRQ parameters, passed to registered
445          * handlers when triggered.
446          */
447         struct common_irq_params
448         vline0_params[DC_IRQ_SOURCE_DC6_VLINE0 - DC_IRQ_SOURCE_DC1_VLINE0 + 1];
449
450         /**
451          * @vupdate_params:
452          *
453          * Vertical update IRQ parameters, passed to registered handlers when
454          * triggered.
455          */
456         struct common_irq_params
457         vupdate_params[DC_IRQ_SOURCE_VUPDATE6 - DC_IRQ_SOURCE_VUPDATE1 + 1];
458
459         /**
460          * @dmub_trace_params:
461          *
462          * DMUB trace event IRQ parameters, passed to registered handlers when
463          * triggered.
464          */
465         struct common_irq_params
466         dmub_trace_params[1];
467
468         struct common_irq_params
469         dmub_outbox_params[1];
470
471         spinlock_t irq_handler_list_table_lock;
472
473         struct backlight_device *backlight_dev[AMDGPU_DM_MAX_NUM_EDP];
474
475         const struct dc_link *backlight_link[AMDGPU_DM_MAX_NUM_EDP];
476
477         uint8_t num_of_edps;
478
479         struct amdgpu_dm_backlight_caps backlight_caps[AMDGPU_DM_MAX_NUM_EDP];
480
481         struct mod_freesync *freesync_module;
482         struct hdcp_workqueue *hdcp_workqueue;
483
484         /**
485          * @vblank_control_workqueue:
486          *
487          * Deferred work for vblank control events.
488          */
489         struct workqueue_struct *vblank_control_workqueue;
490
491         struct drm_atomic_state *cached_state;
492         struct dc_state *cached_dc_state;
493
494         struct dm_compressor_info compressor;
495
496         const struct firmware *fw_dmcu;
497         uint32_t dmcu_fw_version;
498         /**
499          * @soc_bounding_box:
500          *
501          * gpu_info FW provided soc bounding box struct or 0 if not
502          * available in FW
503          */
504         const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
505
506         /**
507          * @active_vblank_irq_count:
508          *
509          * number of currently active vblank irqs
510          */
511         uint32_t active_vblank_irq_count;
512
513 #if defined(CONFIG_DRM_AMD_SECURE_DISPLAY)
514         /**
515          * @secure_display_ctxs:
516          *
517          * Store the ROI information and the work_struct to command dmub and psp for
518          * all crtcs.
519          */
520         struct secure_display_context *secure_display_ctxs;
521 #endif
522         /**
523          * @hpd_rx_offload_wq:
524          *
525          * Work queue to offload works of hpd_rx_irq
526          */
527         struct hpd_rx_irq_offload_work_queue *hpd_rx_offload_wq;
528         /**
529          * @mst_encoders:
530          *
531          * fake encoders used for DP MST.
532          */
533         struct amdgpu_encoder mst_encoders[AMDGPU_DM_MAX_CRTC];
534         bool force_timing_sync;
535         bool disable_hpd_irq;
536         bool dmcub_trace_event_en;
537         /**
538          * @da_list:
539          *
540          * DAL fb memory allocation list, for communication with SMU.
541          */
542         struct list_head da_list;
543         struct completion dmub_aux_transfer_done;
544         struct workqueue_struct *delayed_hpd_wq;
545
546         /**
547          * @brightness:
548          *
549          * cached backlight values.
550          */
551         u32 brightness[AMDGPU_DM_MAX_NUM_EDP];
552         /**
553          * @actual_brightness:
554          *
555          * last successfully applied backlight values.
556          */
557         u32 actual_brightness[AMDGPU_DM_MAX_NUM_EDP];
558
559         /**
560          * @aux_hpd_discon_quirk:
561          *
562          * quirk for hpd discon while aux is on-going.
563          * occurred on certain intel platform
564          */
565         bool aux_hpd_discon_quirk;
566
567         /**
568          * @dpia_aux_lock:
569          *
570          * Guards access to DPIA AUX
571          */
572         struct mutex dpia_aux_lock;
573 };
574
575 enum dsc_clock_force_state {
576         DSC_CLK_FORCE_DEFAULT = 0,
577         DSC_CLK_FORCE_ENABLE,
578         DSC_CLK_FORCE_DISABLE,
579 };
580
581 struct dsc_preferred_settings {
582         enum dsc_clock_force_state dsc_force_enable;
583         uint32_t dsc_num_slices_v;
584         uint32_t dsc_num_slices_h;
585         uint32_t dsc_bits_per_pixel;
586         bool dsc_force_disable_passthrough;
587 };
588
589 enum mst_progress_status {
590         MST_STATUS_DEFAULT = 0,
591         MST_PROBE = BIT(0),
592         MST_REMOTE_EDID = BIT(1),
593         MST_ALLOCATE_NEW_PAYLOAD = BIT(2),
594         MST_CLEAR_ALLOCATED_PAYLOAD = BIT(3),
595 };
596
597 /**
598  * struct amdgpu_hdmi_vsdb_info - Keep track of the VSDB info
599  *
600  * AMDGPU supports FreeSync over HDMI by using the VSDB section, and this
601  * struct is useful to keep track of the display-specific information about
602  * FreeSync.
603  */
604 struct amdgpu_hdmi_vsdb_info {
605         /**
606          * @amd_vsdb_version: Vendor Specific Data Block Version, should be
607          * used to determine which Vendor Specific InfoFrame (VSIF) to send.
608          */
609         unsigned int amd_vsdb_version;
610
611         /**
612          * @freesync_supported: FreeSync Supported.
613          */
614         bool freesync_supported;
615
616         /**
617          * @min_refresh_rate_hz: FreeSync Minimum Refresh Rate in Hz.
618          */
619         unsigned int min_refresh_rate_hz;
620
621         /**
622          * @max_refresh_rate_hz: FreeSync Maximum Refresh Rate in Hz
623          */
624         unsigned int max_refresh_rate_hz;
625
626         /**
627          * @replay_mode: Replay supported
628          */
629         bool replay_mode;
630 };
631
632 struct amdgpu_dm_connector {
633
634         struct drm_connector base;
635         uint32_t connector_id;
636         int bl_idx;
637
638         /* we need to mind the EDID between detect
639            and get modes due to analog/digital/tvencoder */
640         struct edid *edid;
641
642         /* shared with amdgpu */
643         struct amdgpu_hpd hpd;
644
645         /* number of modes generated from EDID at 'dc_sink' */
646         int num_modes;
647
648         /* The 'old' sink - before an HPD.
649          * The 'current' sink is in dc_link->sink. */
650         struct dc_sink *dc_sink;
651         struct dc_link *dc_link;
652
653         /**
654          * @dc_em_sink: Reference to the emulated (virtual) sink.
655          */
656         struct dc_sink *dc_em_sink;
657
658         /* DM only */
659         struct drm_dp_mst_topology_mgr mst_mgr;
660         struct amdgpu_dm_dp_aux dm_dp_aux;
661         struct drm_dp_mst_port *mst_output_port;
662         struct amdgpu_dm_connector *mst_root;
663         struct drm_dp_aux *dsc_aux;
664         struct mutex handle_mst_msg_ready;
665
666         /* TODO see if we can merge with ddc_bus or make a dm_connector */
667         struct amdgpu_i2c_adapter *i2c;
668
669         /* Monitor range limits */
670         /**
671          * @min_vfreq: Minimal frequency supported by the display in Hz. This
672          * value is set to zero when there is no FreeSync support.
673          */
674         int min_vfreq;
675
676         /**
677          * @max_vfreq: Maximum frequency supported by the display in Hz. This
678          * value is set to zero when there is no FreeSync support.
679          */
680         int max_vfreq ;
681         int pixel_clock_mhz;
682
683         /* Audio instance - protected by audio_lock. */
684         int audio_inst;
685
686         struct mutex hpd_lock;
687
688         bool fake_enable;
689         bool force_yuv420_output;
690         struct dsc_preferred_settings dsc_settings;
691         union dp_downstream_port_present mst_downstream_port_present;
692         /* Cached display modes */
693         struct drm_display_mode freesync_vid_base;
694
695         int psr_skip_count;
696         bool disallow_edp_enter_psr;
697
698         /* Record progress status of mst*/
699         uint8_t mst_status;
700
701         /* Automated testing */
702         bool timing_changed;
703         struct dc_crtc_timing *timing_requested;
704
705         /* Adaptive Sync */
706         bool pack_sdp_v1_3;
707         enum adaptive_sync_type as_type;
708         struct amdgpu_hdmi_vsdb_info vsdb_info;
709 };
710
711 static inline void amdgpu_dm_set_mst_status(uint8_t *status,
712                 uint8_t flags, bool set)
713 {
714         if (set)
715                 *status |= flags;
716         else
717                 *status &= ~flags;
718 }
719
720 #define to_amdgpu_dm_connector(x) container_of(x, struct amdgpu_dm_connector, base)
721
722 struct amdgpu_dm_wb_connector {
723         struct drm_writeback_connector base;
724         struct dc_link *link;
725 };
726
727 #define to_amdgpu_dm_wb_connector(x) container_of(x, struct amdgpu_dm_wb_connector, base)
728
729 extern const struct amdgpu_ip_block_version dm_ip_block;
730
731 /* enum amdgpu_transfer_function: pre-defined transfer function supported by AMD.
732  *
733  * It includes standardized transfer functions and pure power functions. The
734  * transfer function coefficients are available at modules/color/color_gamma.c
735  */
736 enum amdgpu_transfer_function {
737         AMDGPU_TRANSFER_FUNCTION_DEFAULT,
738         AMDGPU_TRANSFER_FUNCTION_SRGB_EOTF,
739         AMDGPU_TRANSFER_FUNCTION_BT709_INV_OETF,
740         AMDGPU_TRANSFER_FUNCTION_PQ_EOTF,
741         AMDGPU_TRANSFER_FUNCTION_IDENTITY,
742         AMDGPU_TRANSFER_FUNCTION_GAMMA22_EOTF,
743         AMDGPU_TRANSFER_FUNCTION_GAMMA24_EOTF,
744         AMDGPU_TRANSFER_FUNCTION_GAMMA26_EOTF,
745         AMDGPU_TRANSFER_FUNCTION_SRGB_INV_EOTF,
746         AMDGPU_TRANSFER_FUNCTION_BT709_OETF,
747         AMDGPU_TRANSFER_FUNCTION_PQ_INV_EOTF,
748         AMDGPU_TRANSFER_FUNCTION_GAMMA22_INV_EOTF,
749         AMDGPU_TRANSFER_FUNCTION_GAMMA24_INV_EOTF,
750         AMDGPU_TRANSFER_FUNCTION_GAMMA26_INV_EOTF,
751         AMDGPU_TRANSFER_FUNCTION_COUNT
752 };
753
754 struct dm_plane_state {
755         struct drm_plane_state base;
756         struct dc_plane_state *dc_state;
757
758         /* Plane color mgmt */
759         /**
760          * @degamma_lut:
761          *
762          * 1D LUT for mapping framebuffer/plane pixel data before sampling or
763          * blending operations. It's usually applied to linearize input space.
764          * The blob (if not NULL) is an array of &struct drm_color_lut.
765          */
766         struct drm_property_blob *degamma_lut;
767         /**
768          * @degamma_tf:
769          *
770          * Predefined transfer function to tell DC driver the input space to
771          * linearize.
772          */
773         enum amdgpu_transfer_function degamma_tf;
774         /**
775          * @hdr_mult:
776          *
777          * Multiplier to 'gain' the plane.  When PQ is decoded using the fixed
778          * func transfer function to the internal FP16 fb, 1.0 -> 80 nits (on
779          * AMD at least). When sRGB is decoded, 1.0 -> 1.0, obviously.
780          * Therefore, 1.0 multiplier = 80 nits for SDR content.  So if you
781          * want, 203 nits for SDR content, pass in (203.0 / 80.0).  Format is
782          * S31.32 sign-magnitude.
783          *
784          * HDR multiplier can wide range beyond [0.0, 1.0]. This means that PQ
785          * TF is needed for any subsequent linear-to-non-linear transforms.
786          */
787         __u64 hdr_mult;
788         /**
789          * @ctm:
790          *
791          * Color transformation matrix. The blob (if not NULL) is a &struct
792          * drm_color_ctm_3x4.
793          */
794         struct drm_property_blob *ctm;
795         /**
796          * @shaper_lut: shaper lookup table blob. The blob (if not NULL) is an
797          * array of &struct drm_color_lut.
798          */
799         struct drm_property_blob *shaper_lut;
800         /**
801          * @shaper_tf:
802          *
803          * Predefined transfer function to delinearize color space.
804          */
805         enum amdgpu_transfer_function shaper_tf;
806         /**
807          * @lut3d: 3D lookup table blob. The blob (if not NULL) is an array of
808          * &struct drm_color_lut.
809          */
810         struct drm_property_blob *lut3d;
811         /**
812          * @blend_lut: blend lut lookup table blob. The blob (if not NULL) is an
813          * array of &struct drm_color_lut.
814          */
815         struct drm_property_blob *blend_lut;
816         /**
817          * @blend_tf:
818          *
819          * Pre-defined transfer function for converting plane pixel data before
820          * applying blend LUT.
821          */
822         enum amdgpu_transfer_function blend_tf;
823 };
824
825 struct dm_crtc_state {
826         struct drm_crtc_state base;
827         struct dc_stream_state *stream;
828
829         bool cm_has_degamma;
830         bool cm_is_degamma_srgb;
831
832         bool mpo_requested;
833
834         int update_type;
835         int active_planes;
836
837         int crc_skip_count;
838
839         bool freesync_vrr_info_changed;
840
841         bool dsc_force_changed;
842         bool vrr_supported;
843         struct mod_freesync_config freesync_config;
844         struct dc_info_packet vrr_infopacket;
845
846         int abm_level;
847
848         /**
849          * @regamma_tf:
850          *
851          * Pre-defined transfer function for converting internal FB -> wire
852          * encoding.
853          */
854         enum amdgpu_transfer_function regamma_tf;
855 };
856
857 #define to_dm_crtc_state(x) container_of(x, struct dm_crtc_state, base)
858
859 struct dm_atomic_state {
860         struct drm_private_state base;
861
862         struct dc_state *context;
863 };
864
865 #define to_dm_atomic_state(x) container_of(x, struct dm_atomic_state, base)
866
867 struct dm_connector_state {
868         struct drm_connector_state base;
869
870         enum amdgpu_rmx_type scaling;
871         uint8_t underscan_vborder;
872         uint8_t underscan_hborder;
873         bool underscan_enable;
874         bool freesync_capable;
875         bool update_hdcp;
876         uint8_t abm_level;
877         int vcpi_slots;
878         uint64_t pbn;
879 };
880
881 #define to_dm_connector_state(x)\
882         container_of((x), struct dm_connector_state, base)
883
884 void amdgpu_dm_connector_funcs_reset(struct drm_connector *connector);
885 struct drm_connector_state *
886 amdgpu_dm_connector_atomic_duplicate_state(struct drm_connector *connector);
887 int amdgpu_dm_connector_atomic_set_property(struct drm_connector *connector,
888                                             struct drm_connector_state *state,
889                                             struct drm_property *property,
890                                             uint64_t val);
891
892 int amdgpu_dm_connector_atomic_get_property(struct drm_connector *connector,
893                                             const struct drm_connector_state *state,
894                                             struct drm_property *property,
895                                             uint64_t *val);
896
897 int amdgpu_dm_get_encoder_crtc_mask(struct amdgpu_device *adev);
898
899 void amdgpu_dm_connector_init_helper(struct amdgpu_display_manager *dm,
900                                      struct amdgpu_dm_connector *aconnector,
901                                      int connector_type,
902                                      struct dc_link *link,
903                                      int link_index);
904
905 enum drm_mode_status amdgpu_dm_connector_mode_valid(struct drm_connector *connector,
906                                    struct drm_display_mode *mode);
907
908 void dm_restore_drm_connector_state(struct drm_device *dev,
909                                     struct drm_connector *connector);
910
911 void amdgpu_dm_update_freesync_caps(struct drm_connector *connector,
912                                         struct edid *edid);
913
914 void amdgpu_dm_trigger_timing_sync(struct drm_device *dev);
915
916 /* 3D LUT max size is 17x17x17 (4913 entries) */
917 #define MAX_COLOR_3DLUT_SIZE 17
918 #define MAX_COLOR_3DLUT_BITDEPTH 12
919 int amdgpu_dm_verify_lut3d_size(struct amdgpu_device *adev,
920                                 struct drm_plane_state *plane_state);
921 /* 1D LUT size */
922 #define MAX_COLOR_LUT_ENTRIES 4096
923 /* Legacy gamm LUT users such as X doesn't like large LUT sizes */
924 #define MAX_COLOR_LEGACY_LUT_ENTRIES 256
925
926 void amdgpu_dm_init_color_mod(void);
927 int amdgpu_dm_create_color_properties(struct amdgpu_device *adev);
928 int amdgpu_dm_verify_lut_sizes(const struct drm_crtc_state *crtc_state);
929 int amdgpu_dm_update_crtc_color_mgmt(struct dm_crtc_state *crtc);
930 int amdgpu_dm_update_plane_color_mgmt(struct dm_crtc_state *crtc,
931                                       struct drm_plane_state *plane_state,
932                                       struct dc_plane_state *dc_plane_state);
933
934 void amdgpu_dm_update_connector_after_detect(
935                 struct amdgpu_dm_connector *aconnector);
936
937 extern const struct drm_encoder_helper_funcs amdgpu_dm_encoder_helper_funcs;
938
939 int amdgpu_dm_process_dmub_aux_transfer_sync(struct dc_context *ctx, unsigned int link_index,
940                                         struct aux_payload *payload, enum aux_return_code_type *operation_result);
941
942 int amdgpu_dm_process_dmub_set_config_sync(struct dc_context *ctx, unsigned int link_index,
943                                         struct set_config_cmd_payload *payload, enum set_config_status *operation_result);
944
945 struct dc_stream_state *
946         create_validate_stream_for_sink(struct amdgpu_dm_connector *aconnector,
947                                         const struct drm_display_mode *drm_mode,
948                                         const struct dm_connector_state *dm_state,
949                                         const struct dc_stream_state *old_stream);
950
951 int dm_atomic_get_state(struct drm_atomic_state *state,
952                         struct dm_atomic_state **dm_state);
953
954 struct drm_connector *
955 amdgpu_dm_find_first_crtc_matching_connector(struct drm_atomic_state *state,
956                                              struct drm_crtc *crtc);
957
958 int convert_dc_color_depth_into_bpc(enum dc_color_depth display_color_depth);
959 #endif /* __AMDGPU_DM_H__ */