1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2015-2018, The Linux Foundation. All rights reserved. 4 * Copyright (C) 2013 Red Hat 5 * Author: Rob Clark <robdclark@gmail.com> 6 */ 7 8 #ifndef __DPU_KMS_H__ 9 #define __DPU_KMS_H__ 10 11 #include <linux/interconnect.h> 12 13 #include <drm/drm_drv.h> 14 15 #include "msm_drv.h" 16 #include "msm_kms.h" 17 #include "msm_mmu.h" 18 #include "msm_gem.h" 19 #include "dpu_hw_catalog.h" 20 #include "dpu_hw_ctl.h" 21 #include "dpu_hw_lm.h" 22 #include "dpu_hw_interrupts.h" 23 #include "dpu_hw_top.h" 24 #include "dpu_rm.h" 25 #include "dpu_core_perf.h" 26 27 #define DRMID(x) ((x) ? (x)->base.id : -1) 28 29 /** 30 * DPU_DEBUG - macro for kms/plane/crtc/encoder/connector logs 31 * @fmt: Pointer to format string 32 */ 33 #define DPU_DEBUG(fmt, ...) \ 34 do { \ 35 if (drm_debug_enabled(DRM_UT_KMS)) \ 36 DRM_DEBUG(fmt, ##__VA_ARGS__); \ 37 else \ 38 pr_debug(fmt, ##__VA_ARGS__); \ 39 } while (0) 40 41 /** 42 * DPU_DEBUG_DRIVER - macro for hardware driver logging 43 * @fmt: Pointer to format string 44 */ 45 #define DPU_DEBUG_DRIVER(fmt, ...) \ 46 do { \ 47 if (drm_debug_enabled(DRM_UT_DRIVER)) \ 48 DRM_ERROR(fmt, ##__VA_ARGS__); \ 49 else \ 50 pr_debug(fmt, ##__VA_ARGS__); \ 51 } while (0) 52 53 #define DPU_ERROR(fmt, ...) pr_err("[dpu error]" fmt, ##__VA_ARGS__) 54 55 /** 56 * ktime_compare_safe - compare two ktime structures 57 * This macro is similar to the standard ktime_compare() function, but 58 * attempts to also handle ktime overflows. 59 * @A: First ktime value 60 * @B: Second ktime value 61 * Returns: -1 if A < B, 0 if A == B, 1 if A > B 62 */ 63 #define ktime_compare_safe(A, B) \ 64 ktime_compare(ktime_sub((A), (B)), ktime_set(0, 0)) 65 66 #define DPU_NAME_SIZE 12 67 68 /* 69 * struct dpu_irq_callback - IRQ callback handlers 70 * @list: list to callback 71 * @func: intr handler 72 * @arg: argument for the handler 73 */ 74 struct dpu_irq_callback { 75 struct list_head list; 76 void (*func)(void *arg, int irq_idx); 77 void *arg; 78 }; 79 80 struct dpu_kms { 81 struct msm_kms base; 82 struct drm_device *dev; 83 int core_rev; 84 struct dpu_mdss_cfg *catalog; 85 86 /* io/register spaces: */ 87 void __iomem *mmio, *vbif[VBIF_MAX], *reg_dma; 88 89 struct regulator *vdd; 90 struct regulator *mmagic; 91 struct regulator *venus; 92 93 struct dpu_hw_intr *hw_intr; 94 95 struct dpu_core_perf perf; 96 97 /* 98 * Global private object state, Do not access directly, use 99 * dpu_kms_global_get_state() 100 */ 101 struct drm_modeset_lock global_state_lock; 102 struct drm_private_obj global_state; 103 104 struct dpu_rm rm; 105 bool rm_init; 106 107 struct dpu_hw_vbif *hw_vbif[VBIF_MAX]; 108 struct dpu_hw_mdp *hw_mdp; 109 110 bool has_danger_ctrl; 111 112 struct platform_device *pdev; 113 bool rpm_enabled; 114 115 struct clk_bulk_data *clocks; 116 size_t num_clocks; 117 118 /* reference count bandwidth requests, so we know when we can 119 * release bandwidth. Each atomic update increments, and frame- 120 * done event decrements. Additionally, for video mode, the 121 * reference is incremented when crtc is enabled, and decremented 122 * when disabled. 123 */ 124 atomic_t bandwidth_ref; 125 struct icc_path *path[2]; 126 u32 num_paths; 127 }; 128 129 struct vsync_info { 130 u32 frame_count; 131 u32 line_count; 132 }; 133 134 #define to_dpu_kms(x) container_of(x, struct dpu_kms, base) 135 136 #define to_dpu_global_state(x) container_of(x, struct dpu_global_state, base) 137 138 /* Global private object state for tracking resources that are shared across 139 * multiple kms objects (planes/crtcs/etc). 140 */ 141 struct dpu_global_state { 142 struct drm_private_state base; 143 144 uint32_t pingpong_to_enc_id[PINGPONG_MAX - PINGPONG_0]; 145 uint32_t mixer_to_enc_id[LM_MAX - LM_0]; 146 uint32_t ctl_to_enc_id[CTL_MAX - CTL_0]; 147 uint32_t dspp_to_enc_id[DSPP_MAX - DSPP_0]; 148 }; 149 150 struct dpu_global_state 151 *dpu_kms_get_existing_global_state(struct dpu_kms *dpu_kms); 152 struct dpu_global_state 153 *__must_check dpu_kms_get_global_state(struct drm_atomic_state *s); 154 155 /** 156 * Debugfs functions - extra helper functions for debugfs support 157 * 158 * Main debugfs documentation is located at, 159 * 160 * Documentation/filesystems/debugfs.rst 161 * 162 * @dpu_debugfs_create_regset32: Create 32-bit register dump file 163 */ 164 165 /** 166 * dpu_debugfs_create_regset32 - Create register read back file for debugfs 167 * 168 * This function is almost identical to the standard debugfs_create_regset32() 169 * function, with the main difference being that a list of register 170 * names/offsets do not need to be provided. The 'read' function simply outputs 171 * sequential register values over a specified range. 172 * 173 * @name: File name within debugfs 174 * @mode: File mode within debugfs 175 * @parent: Parent directory entry within debugfs, can be NULL 176 * @offset: sub-block offset 177 * @length: sub-block length, in bytes 178 * @dpu_kms: pointer to dpu kms structure 179 */ 180 void dpu_debugfs_create_regset32(const char *name, umode_t mode, 181 void *parent, 182 uint32_t offset, uint32_t length, struct dpu_kms *dpu_kms); 183 184 /** 185 * dpu_debugfs_get_root - Return root directory entry for KMS's debugfs 186 * 187 * The return value should be passed as the 'parent' argument to subsequent 188 * debugfs create calls. 189 * 190 * @dpu_kms: Pointer to DPU's KMS structure 191 * 192 * Return: dentry pointer for DPU's debugfs location 193 */ 194 void *dpu_debugfs_get_root(struct dpu_kms *dpu_kms); 195 196 /** 197 * DPU info management functions 198 * These functions/definitions allow for building up a 'dpu_info' structure 199 * containing one or more "key=value\n" entries. 200 */ 201 #define DPU_KMS_INFO_MAX_SIZE 4096 202 203 /** 204 * Vblank enable/disable functions 205 */ 206 int dpu_enable_vblank(struct msm_kms *kms, struct drm_crtc *crtc); 207 void dpu_disable_vblank(struct msm_kms *kms, struct drm_crtc *crtc); 208 209 /** 210 * dpu_kms_get_clk_rate() - get the clock rate 211 * @dpu_kms: pointer to dpu_kms structure 212 * @clock_name: clock name to get the rate 213 * 214 * Return: current clock rate 215 */ 216 u64 dpu_kms_get_clk_rate(struct dpu_kms *dpu_kms, char *clock_name); 217 218 #endif /* __dpu_kms_H__ */ 219