2 * Copyright (C) 2015-2020 Advanced Micro Devices, Inc. All rights reserved.
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:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
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.
26 #ifndef __AMDGPU_DM_H__
27 #define __AMDGPU_DM_H__
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>
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
47 #define AMDGPU_DM_MAX_DISPLAY_INDEX 31
49 #define AMDGPU_DM_MAX_CRTC 6
51 #define AMDGPU_DM_MAX_NUM_EDP 2
53 #define AMDGPU_DMUB_NOTIFICATION_MAX 5
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
59 #include "include/amdgpu_dal_power_if.h"
60 #include "amdgpu_dm_irq.h"
63 #include "irq_types.h"
64 #include "signal_types.h"
65 #include "amdgpu_dm_crc.h"
66 #include "mod_info_packet.h"
68 struct set_config_cmd_payload;
69 enum aux_return_code_type;
70 enum set_config_status;
72 /* Forward declarations */
79 struct dc_plane_state;
80 struct dmub_notification;
82 struct amd_vsdb_block {
83 unsigned char ieee_id[3];
84 unsigned char version;
85 unsigned char feature_caps;
88 struct common_irq_params {
89 struct amdgpu_device *adev;
90 enum dc_irq_source irq_src;
91 atomic64_t previous_timestamp;
95 * struct dm_compressor_info - Buffer info used by frame buffer compression
96 * @cpu_addr: MMIO cpu addr
97 * @bo_ptr: Pointer to the buffer object
98 * @gpu_addr: MMIO gpu addr
100 struct dm_compressor_info {
102 struct amdgpu_bo *bo_ptr;
106 typedef void (*dmub_notify_interrupt_callback_t)(struct amdgpu_device *adev, struct dmub_notification *notify);
109 * struct dmub_hpd_work - Handle time consuming work in low priority outbox IRQ
111 * @handle_hpd_work: Work to be executed in a separate thread to handle hpd_low_irq
112 * @dmub_notify: notification for callback function
113 * @adev: amdgpu_device pointer
115 struct dmub_hpd_work {
116 struct work_struct handle_hpd_work;
117 struct dmub_notification *dmub_notify;
118 struct amdgpu_device *adev;
122 * struct vblank_control_work - Work data for vblank control
123 * @work: Kernel work data for the work event
124 * @dm: amdgpu display manager device
125 * @acrtc: amdgpu CRTC instance for which the event has occurred
126 * @stream: DC stream for which the event has occurred
127 * @enable: true if enabling vblank
129 struct vblank_control_work {
130 struct work_struct work;
131 struct amdgpu_display_manager *dm;
132 struct amdgpu_crtc *acrtc;
133 struct dc_stream_state *stream;
138 * struct amdgpu_dm_backlight_caps - Information about backlight
140 * Describe the backlight support for ACPI or eDP AUX.
142 struct amdgpu_dm_backlight_caps {
144 * @ext_caps: Keep the data struct with all the information about the
145 * display support for HDR.
147 union dpcd_sink_ext_caps *ext_caps;
149 * @aux_min_input_signal: Min brightness value supported by the display
151 u32 aux_min_input_signal;
153 * @aux_max_input_signal: Max brightness value supported by the display
156 u32 aux_max_input_signal;
158 * @min_input_signal: minimum possible input in range 0-255.
160 int min_input_signal;
162 * @max_input_signal: maximum possible input in range 0-255.
164 int max_input_signal;
166 * @caps_valid: true if these values are from the ACPI interface.
170 * @aux_support: Describes if the display supports AUX backlight.
176 * struct dal_allocation - Tracks mapped FB memory for SMU communication
177 * @list: list of dal allocations
178 * @bo: GPU buffer object
179 * @cpu_ptr: CPU virtual address of the GPU buffer object
180 * @gpu_addr: GPU virtual address of the GPU buffer object
182 struct dal_allocation {
183 struct list_head list;
184 struct amdgpu_bo *bo;
190 * struct hpd_rx_irq_offload_work_queue - Work queue to handle hpd_rx_irq
193 struct hpd_rx_irq_offload_work_queue {
195 * @wq: workqueue structure to queue offload work.
197 struct workqueue_struct *wq;
199 * @offload_lock: To protect fields of offload work queue.
201 spinlock_t offload_lock;
203 * @is_handling_link_loss: Used to prevent inserting link loss event when
204 * we're handling link loss
206 bool is_handling_link_loss;
208 * @is_handling_mst_msg_rdy_event: Used to prevent inserting mst message
209 * ready event when we're already handling mst message ready event
211 bool is_handling_mst_msg_rdy_event;
213 * @aconnector: The aconnector that this work queue is attached to
215 struct amdgpu_dm_connector *aconnector;
219 * struct hpd_rx_irq_offload_work - hpd_rx_irq offload work structure
221 struct hpd_rx_irq_offload_work {
223 * @work: offload work
225 struct work_struct work;
227 * @data: reference irq data which is used while handling offload work
229 union hpd_irq_data data;
231 * @offload_wq: offload work queue that this work is queued to
233 struct hpd_rx_irq_offload_work_queue *offload_wq;
237 * struct amdgpu_display_manager - Central amdgpu display manager device
239 * @dc: Display Core control structure
240 * @adev: AMDGPU base driver structure
241 * @ddev: DRM base driver structure
242 * @display_indexes_num: Max number of display streams supported
243 * @irq_handler_list_table_lock: Synchronizes access to IRQ tables
244 * @backlight_dev: Backlight control device
245 * @backlight_link: Link on which to control backlight
246 * @backlight_caps: Capabilities of the backlight device
247 * @freesync_module: Module handling freesync calculations
248 * @hdcp_workqueue: AMDGPU content protection queue
249 * @fw_dmcu: Reference to DMCU firmware
250 * @dmcu_fw_version: Version of the DMCU firmware
251 * @soc_bounding_box: SOC bounding box values provided by gpu_info FW
252 * @cached_state: Caches device atomic state for suspend/resume
253 * @cached_dc_state: Cached state of content streams
254 * @compressor: Frame buffer compression buffer. See &struct dm_compressor_info
255 * @force_timing_sync: set via debugfs. When set, indicates that all connected
256 * displays will be forced to synchronize.
257 * @dmcub_trace_event_en: enable dmcub trace events
258 * @dmub_outbox_params: DMUB Outbox parameters
259 * @num_of_edps: number of backlight eDPs
260 * @disable_hpd_irq: disables all HPD and HPD RX interrupt handling in the
262 * @dmub_aux_transfer_done: struct completion used to indicate when DMUB
264 * @delayed_hpd_wq: work queue used to delay DMUB HPD work
266 struct amdgpu_display_manager {
273 * DMUB service, used for controlling the DMUB on hardware
274 * that supports it. The pointer to the dmub_srv will be
275 * NULL on hardware that does not support it.
277 struct dmub_srv *dmub_srv;
282 * Notification from DMUB.
285 struct dmub_notification *dmub_notify;
290 * Callback functions to handle notification from DMUB.
293 dmub_notify_interrupt_callback_t dmub_callback[AMDGPU_DMUB_NOTIFICATION_MAX];
296 * @dmub_thread_offload:
298 * Flag to indicate if callback is offload.
301 bool dmub_thread_offload[AMDGPU_DMUB_NOTIFICATION_MAX];
306 * Framebuffer regions for the DMUB.
308 struct dmub_srv_fb_info *dmub_fb_info;
313 * DMUB firmware, required on hardware that has DMUB support.
315 const struct firmware *dmub_fw;
320 * Buffer object for the DMUB.
322 struct amdgpu_bo *dmub_bo;
327 * GPU virtual address for the DMUB buffer object.
329 u64 dmub_bo_gpu_addr;
334 * CPU address for the DMUB buffer object.
336 void *dmub_bo_cpu_addr;
341 * DMCUB firmware version.
343 uint32_t dmcub_fw_version;
348 * The Common Graphics Services device. It provides an interface for
349 * accessing registers.
351 struct cgs_device *cgs_device;
353 struct amdgpu_device *adev;
354 struct drm_device *ddev;
355 u16 display_indexes_num;
360 * In combination with &dm_atomic_state it helps manage
361 * global atomic state that doesn't map cleanly into existing
362 * drm resources, like &dc_context.
364 struct drm_private_obj atomic_obj;
369 * Guards access to DC functions that can issue register write
372 struct mutex dc_lock;
377 * Guards access to audio instance changes.
379 struct mutex audio_lock;
384 * Used to notify ELD changes to sound driver.
386 struct drm_audio_component *audio_component;
391 * True if the audio component has been registered
392 * successfully, false otherwise.
394 bool audio_registered;
397 * @irq_handler_list_low_tab:
399 * Low priority IRQ handler table.
401 * It is a n*m table consisting of n IRQ sources, and m handlers per IRQ
402 * source. Low priority IRQ handlers are deferred to a workqueue to be
403 * processed. Hence, they can sleep.
405 * Note that handlers are called in the same order as they were
408 struct list_head irq_handler_list_low_tab[DAL_IRQ_SOURCES_NUMBER];
411 * @irq_handler_list_high_tab:
413 * High priority IRQ handler table.
415 * It is a n*m table, same as &irq_handler_list_low_tab. However,
416 * handlers in this table are not deferred and are called immediately.
418 struct list_head irq_handler_list_high_tab[DAL_IRQ_SOURCES_NUMBER];
423 * Page flip IRQ parameters, passed to registered handlers when
426 struct common_irq_params
427 pflip_params[DC_IRQ_SOURCE_PFLIP_LAST - DC_IRQ_SOURCE_PFLIP_FIRST + 1];
432 * Vertical blanking IRQ parameters, passed to registered handlers when
435 struct common_irq_params
436 vblank_params[DC_IRQ_SOURCE_VBLANK6 - DC_IRQ_SOURCE_VBLANK1 + 1];
441 * OTG vertical interrupt0 IRQ parameters, passed to registered
442 * handlers when triggered.
444 struct common_irq_params
445 vline0_params[DC_IRQ_SOURCE_DC6_VLINE0 - DC_IRQ_SOURCE_DC1_VLINE0 + 1];
450 * Vertical update IRQ parameters, passed to registered handlers when
453 struct common_irq_params
454 vupdate_params[DC_IRQ_SOURCE_VUPDATE6 - DC_IRQ_SOURCE_VUPDATE1 + 1];
457 * @dmub_trace_params:
459 * DMUB trace event IRQ parameters, passed to registered handlers when
462 struct common_irq_params
463 dmub_trace_params[1];
465 struct common_irq_params
466 dmub_outbox_params[1];
468 spinlock_t irq_handler_list_table_lock;
470 struct backlight_device *backlight_dev[AMDGPU_DM_MAX_NUM_EDP];
472 const struct dc_link *backlight_link[AMDGPU_DM_MAX_NUM_EDP];
476 struct amdgpu_dm_backlight_caps backlight_caps[AMDGPU_DM_MAX_NUM_EDP];
478 struct mod_freesync *freesync_module;
479 struct hdcp_workqueue *hdcp_workqueue;
482 * @vblank_control_workqueue:
484 * Deferred work for vblank control events.
486 struct workqueue_struct *vblank_control_workqueue;
488 struct drm_atomic_state *cached_state;
489 struct dc_state *cached_dc_state;
491 struct dm_compressor_info compressor;
493 const struct firmware *fw_dmcu;
494 uint32_t dmcu_fw_version;
498 * gpu_info FW provided soc bounding box struct or 0 if not
501 const struct gpu_info_soc_bounding_box_v1_0 *soc_bounding_box;
504 * @active_vblank_irq_count:
506 * number of currently active vblank irqs
508 uint32_t active_vblank_irq_count;
510 #if defined(CONFIG_DRM_AMD_SECURE_DISPLAY)
512 * @secure_display_ctxs:
514 * Store the ROI information and the work_struct to command dmub and psp for
517 struct secure_display_context *secure_display_ctxs;
520 * @hpd_rx_offload_wq:
522 * Work queue to offload works of hpd_rx_irq
524 struct hpd_rx_irq_offload_work_queue *hpd_rx_offload_wq;
528 * fake encoders used for DP MST.
530 struct amdgpu_encoder mst_encoders[AMDGPU_DM_MAX_CRTC];
531 bool force_timing_sync;
532 bool disable_hpd_irq;
533 bool dmcub_trace_event_en;
537 * DAL fb memory allocation list, for communication with SMU.
539 struct list_head da_list;
540 struct completion dmub_aux_transfer_done;
541 struct workqueue_struct *delayed_hpd_wq;
546 * cached backlight values.
548 u32 brightness[AMDGPU_DM_MAX_NUM_EDP];
550 * @actual_brightness:
552 * last successfully applied backlight values.
554 u32 actual_brightness[AMDGPU_DM_MAX_NUM_EDP];
557 * @aux_hpd_discon_quirk:
559 * quirk for hpd discon while aux is on-going.
560 * occurred on certain intel platform
562 bool aux_hpd_discon_quirk;
567 * Guards access to DPIA AUX
569 struct mutex dpia_aux_lock;
572 enum dsc_clock_force_state {
573 DSC_CLK_FORCE_DEFAULT = 0,
574 DSC_CLK_FORCE_ENABLE,
575 DSC_CLK_FORCE_DISABLE,
578 struct dsc_preferred_settings {
579 enum dsc_clock_force_state dsc_force_enable;
580 uint32_t dsc_num_slices_v;
581 uint32_t dsc_num_slices_h;
582 uint32_t dsc_bits_per_pixel;
583 bool dsc_force_disable_passthrough;
586 enum mst_progress_status {
587 MST_STATUS_DEFAULT = 0,
589 MST_REMOTE_EDID = BIT(1),
590 MST_ALLOCATE_NEW_PAYLOAD = BIT(2),
591 MST_CLEAR_ALLOCATED_PAYLOAD = BIT(3),
595 * struct amdgpu_hdmi_vsdb_info - Keep track of the VSDB info
597 * AMDGPU supports FreeSync over HDMI by using the VSDB section, and this
598 * struct is useful to keep track of the display-specific information about
601 struct amdgpu_hdmi_vsdb_info {
603 * @amd_vsdb_version: Vendor Specific Data Block Version, should be
604 * used to determine which Vendor Specific InfoFrame (VSIF) to send.
606 unsigned int amd_vsdb_version;
609 * @freesync_supported: FreeSync Supported.
611 bool freesync_supported;
614 * @min_refresh_rate_hz: FreeSync Minimum Refresh Rate in Hz.
616 unsigned int min_refresh_rate_hz;
619 * @max_refresh_rate_hz: FreeSync Maximum Refresh Rate in Hz
621 unsigned int max_refresh_rate_hz;
624 * @replay_mode: Replay supported
629 struct amdgpu_dm_connector {
631 struct drm_connector base;
632 uint32_t connector_id;
635 /* we need to mind the EDID between detect
636 and get modes due to analog/digital/tvencoder */
639 /* shared with amdgpu */
640 struct amdgpu_hpd hpd;
642 /* number of modes generated from EDID at 'dc_sink' */
645 /* The 'old' sink - before an HPD.
646 * The 'current' sink is in dc_link->sink. */
647 struct dc_sink *dc_sink;
648 struct dc_link *dc_link;
651 * @dc_em_sink: Reference to the emulated (virtual) sink.
653 struct dc_sink *dc_em_sink;
656 struct drm_dp_mst_topology_mgr mst_mgr;
657 struct amdgpu_dm_dp_aux dm_dp_aux;
658 struct drm_dp_mst_port *mst_output_port;
659 struct amdgpu_dm_connector *mst_root;
660 struct drm_dp_aux *dsc_aux;
661 struct mutex handle_mst_msg_ready;
663 /* TODO see if we can merge with ddc_bus or make a dm_connector */
664 struct amdgpu_i2c_adapter *i2c;
666 /* Monitor range limits */
668 * @min_vfreq: Minimal frequency supported by the display in Hz. This
669 * value is set to zero when there is no FreeSync support.
674 * @max_vfreq: Maximum frequency supported by the display in Hz. This
675 * value is set to zero when there is no FreeSync support.
680 /* Audio instance - protected by audio_lock. */
683 struct mutex hpd_lock;
686 bool force_yuv420_output;
687 struct dsc_preferred_settings dsc_settings;
688 union dp_downstream_port_present mst_downstream_port_present;
689 /* Cached display modes */
690 struct drm_display_mode freesync_vid_base;
694 /* Record progress status of mst*/
697 /* Automated testing */
699 struct dc_crtc_timing *timing_requested;
703 enum adaptive_sync_type as_type;
704 struct amdgpu_hdmi_vsdb_info vsdb_info;
707 static inline void amdgpu_dm_set_mst_status(uint8_t *status,
708 uint8_t flags, bool set)
716 #define to_amdgpu_dm_connector(x) container_of(x, struct amdgpu_dm_connector, base)
718 struct amdgpu_dm_wb_connector {
719 struct drm_writeback_connector base;
720 struct dc_link *link;
723 #define to_amdgpu_dm_wb_connector(x) container_of(x, struct amdgpu_dm_wb_connector, base)
725 extern const struct amdgpu_ip_block_version dm_ip_block;
727 struct dm_plane_state {
728 struct drm_plane_state base;
729 struct dc_plane_state *dc_state;
732 struct dm_crtc_state {
733 struct drm_crtc_state base;
734 struct dc_stream_state *stream;
737 bool cm_is_degamma_srgb;
746 bool freesync_vrr_info_changed;
748 bool dsc_force_changed;
750 struct mod_freesync_config freesync_config;
751 struct dc_info_packet vrr_infopacket;
756 #define to_dm_crtc_state(x) container_of(x, struct dm_crtc_state, base)
758 struct dm_atomic_state {
759 struct drm_private_state base;
761 struct dc_state *context;
764 #define to_dm_atomic_state(x) container_of(x, struct dm_atomic_state, base)
766 struct dm_connector_state {
767 struct drm_connector_state base;
769 enum amdgpu_rmx_type scaling;
770 uint8_t underscan_vborder;
771 uint8_t underscan_hborder;
772 bool underscan_enable;
773 bool freesync_capable;
780 #define to_dm_connector_state(x)\
781 container_of((x), struct dm_connector_state, base)
783 void amdgpu_dm_connector_funcs_reset(struct drm_connector *connector);
784 struct drm_connector_state *
785 amdgpu_dm_connector_atomic_duplicate_state(struct drm_connector *connector);
786 int amdgpu_dm_connector_atomic_set_property(struct drm_connector *connector,
787 struct drm_connector_state *state,
788 struct drm_property *property,
791 int amdgpu_dm_connector_atomic_get_property(struct drm_connector *connector,
792 const struct drm_connector_state *state,
793 struct drm_property *property,
796 int amdgpu_dm_get_encoder_crtc_mask(struct amdgpu_device *adev);
798 void amdgpu_dm_connector_init_helper(struct amdgpu_display_manager *dm,
799 struct amdgpu_dm_connector *aconnector,
801 struct dc_link *link,
804 enum drm_mode_status amdgpu_dm_connector_mode_valid(struct drm_connector *connector,
805 struct drm_display_mode *mode);
807 void dm_restore_drm_connector_state(struct drm_device *dev,
808 struct drm_connector *connector);
810 void amdgpu_dm_update_freesync_caps(struct drm_connector *connector,
813 void amdgpu_dm_trigger_timing_sync(struct drm_device *dev);
815 #define MAX_COLOR_LUT_ENTRIES 4096
816 /* Legacy gamm LUT users such as X doesn't like large LUT sizes */
817 #define MAX_COLOR_LEGACY_LUT_ENTRIES 256
819 void amdgpu_dm_init_color_mod(void);
820 int amdgpu_dm_verify_lut_sizes(const struct drm_crtc_state *crtc_state);
821 int amdgpu_dm_update_crtc_color_mgmt(struct dm_crtc_state *crtc);
822 int amdgpu_dm_update_plane_color_mgmt(struct dm_crtc_state *crtc,
823 struct dc_plane_state *dc_plane_state);
825 void amdgpu_dm_update_connector_after_detect(
826 struct amdgpu_dm_connector *aconnector);
828 extern const struct drm_encoder_helper_funcs amdgpu_dm_encoder_helper_funcs;
830 int amdgpu_dm_process_dmub_aux_transfer_sync(struct dc_context *ctx, unsigned int link_index,
831 struct aux_payload *payload, enum aux_return_code_type *operation_result);
833 int amdgpu_dm_process_dmub_set_config_sync(struct dc_context *ctx, unsigned int link_index,
834 struct set_config_cmd_payload *payload, enum set_config_status *operation_result);
836 struct dc_stream_state *
837 create_validate_stream_for_sink(struct amdgpu_dm_connector *aconnector,
838 const struct drm_display_mode *drm_mode,
839 const struct dm_connector_state *dm_state,
840 const struct dc_stream_state *old_stream);
842 int dm_atomic_get_state(struct drm_atomic_state *state,
843 struct dm_atomic_state **dm_state);
845 struct drm_connector *
846 amdgpu_dm_find_first_crtc_matching_connector(struct drm_atomic_state *state,
847 struct drm_crtc *crtc);
849 int convert_dc_color_depth_into_bpc(enum dc_color_depth display_color_depth);
850 #endif /* __AMDGPU_DM_H__ */