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 <drm/drm_drv.h> 12 13 #include "msm_drv.h" 14 #include "msm_kms.h" 15 #include "msm_mmu.h" 16 #include "msm_gem.h" 17 #include "dpu_hw_catalog.h" 18 #include "dpu_hw_ctl.h" 19 #include "dpu_hw_lm.h" 20 #include "dpu_hw_interrupts.h" 21 #include "dpu_hw_top.h" 22 #include "dpu_io_util.h" 23 #include "dpu_rm.h" 24 #include "dpu_core_perf.h" 25 26 #define DRMID(x) ((x) ? (x)->base.id : -1) 27 28 /** 29 * DPU_DEBUG - macro for kms/plane/crtc/encoder/connector logs 30 * @fmt: Pointer to format string 31 */ 32 #define DPU_DEBUG(fmt, ...) \ 33 do { \ 34 if (drm_debug_enabled(DRM_UT_KMS)) \ 35 DRM_DEBUG(fmt, ##__VA_ARGS__); \ 36 else \ 37 pr_debug(fmt, ##__VA_ARGS__); \ 38 } while (0) 39 40 /** 41 * DPU_DEBUG_DRIVER - macro for hardware driver logging 42 * @fmt: Pointer to format string 43 */ 44 #define DPU_DEBUG_DRIVER(fmt, ...) \ 45 do { \ 46 if (drm_debug_enabled(DRM_UT_DRIVER)) \ 47 DRM_ERROR(fmt, ##__VA_ARGS__); \ 48 else \ 49 pr_debug(fmt, ##__VA_ARGS__); \ 50 } while (0) 51 52 #define DPU_ERROR(fmt, ...) pr_err("[dpu error]" fmt, ##__VA_ARGS__) 53 54 /** 55 * ktime_compare_safe - compare two ktime structures 56 * This macro is similar to the standard ktime_compare() function, but 57 * attempts to also handle ktime overflows. 58 * @A: First ktime value 59 * @B: Second ktime value 60 * Returns: -1 if A < B, 0 if A == B, 1 if A > B 61 */ 62 #define ktime_compare_safe(A, B) \ 63 ktime_compare(ktime_sub((A), (B)), ktime_set(0, 0)) 64 65 #define DPU_NAME_SIZE 12 66 67 /* 68 * struct dpu_irq_callback - IRQ callback handlers 69 * @list: list to callback 70 * @func: intr handler 71 * @arg: argument for the handler 72 */ 73 struct dpu_irq_callback { 74 struct list_head list; 75 void (*func)(void *arg, int irq_idx); 76 void *arg; 77 }; 78 79 /** 80 * struct dpu_irq: IRQ structure contains callback registration info 81 * @total_irq: total number of irq_idx obtained from HW interrupts mapping 82 * @irq_cb_tbl: array of IRQ callbacks setting 83 * @enable_counts array of IRQ enable counts 84 * @cb_lock: callback lock 85 * @debugfs_file: debugfs file for irq statistics 86 */ 87 struct dpu_irq { 88 u32 total_irqs; 89 struct list_head *irq_cb_tbl; 90 atomic_t *enable_counts; 91 atomic_t *irq_counts; 92 spinlock_t cb_lock; 93 }; 94 95 struct dpu_kms { 96 struct msm_kms base; 97 struct drm_device *dev; 98 int core_rev; 99 struct dpu_mdss_cfg *catalog; 100 101 /* io/register spaces: */ 102 void __iomem *mmio, *vbif[VBIF_MAX], *reg_dma; 103 unsigned long mmio_len, vbif_len[VBIF_MAX], reg_dma_len; 104 105 struct regulator *vdd; 106 struct regulator *mmagic; 107 struct regulator *venus; 108 109 struct dpu_hw_intr *hw_intr; 110 struct dpu_irq irq_obj; 111 112 struct dpu_core_perf perf; 113 114 /* 115 * Global private object state, Do not access directly, use 116 * dpu_kms_global_get_state() 117 */ 118 struct drm_modeset_lock global_state_lock; 119 struct drm_private_obj global_state; 120 121 struct dpu_rm rm; 122 bool rm_init; 123 124 struct dpu_hw_vbif *hw_vbif[VBIF_MAX]; 125 struct dpu_hw_mdp *hw_mdp; 126 127 bool has_danger_ctrl; 128 129 struct platform_device *pdev; 130 bool rpm_enabled; 131 struct dss_module_power mp; 132 133 /* reference count bandwidth requests, so we know when we can 134 * release bandwidth. Each atomic update increments, and frame- 135 * done event decrements. Additionally, for video mode, the 136 * reference is incremented when crtc is enabled, and decremented 137 * when disabled. 138 */ 139 atomic_t bandwidth_ref; 140 }; 141 142 struct vsync_info { 143 u32 frame_count; 144 u32 line_count; 145 }; 146 147 #define to_dpu_kms(x) container_of(x, struct dpu_kms, base) 148 149 #define to_dpu_global_state(x) container_of(x, struct dpu_global_state, base) 150 151 /* Global private object state for tracking resources that are shared across 152 * multiple kms objects (planes/crtcs/etc). 153 */ 154 struct dpu_global_state { 155 struct drm_private_state base; 156 157 uint32_t pingpong_to_enc_id[PINGPONG_MAX - PINGPONG_0]; 158 uint32_t mixer_to_enc_id[LM_MAX - LM_0]; 159 uint32_t ctl_to_enc_id[CTL_MAX - CTL_0]; 160 uint32_t intf_to_enc_id[INTF_MAX - INTF_0]; 161 uint32_t dspp_to_enc_id[DSPP_MAX - DSPP_0]; 162 }; 163 164 struct dpu_global_state 165 *dpu_kms_get_existing_global_state(struct dpu_kms *dpu_kms); 166 struct dpu_global_state 167 *__must_check dpu_kms_get_global_state(struct drm_atomic_state *s); 168 169 /** 170 * Debugfs functions - extra helper functions for debugfs support 171 * 172 * Main debugfs documentation is located at, 173 * 174 * Documentation/filesystems/debugfs.rst 175 * 176 * @dpu_debugfs_setup_regset32: Initialize data for dpu_debugfs_create_regset32 177 * @dpu_debugfs_create_regset32: Create 32-bit register dump file 178 * @dpu_debugfs_get_root: Get root dentry for DPU_KMS's debugfs node 179 */ 180 181 /** 182 * Companion structure for dpu_debugfs_create_regset32. Do not initialize the 183 * members of this structure explicitly; use dpu_debugfs_setup_regset32 instead. 184 */ 185 struct dpu_debugfs_regset32 { 186 uint32_t offset; 187 uint32_t blk_len; 188 struct dpu_kms *dpu_kms; 189 }; 190 191 /** 192 * dpu_debugfs_setup_regset32 - Initialize register block definition for debugfs 193 * This function is meant to initialize dpu_debugfs_regset32 structures for use 194 * with dpu_debugfs_create_regset32. 195 * @regset: opaque register definition structure 196 * @offset: sub-block offset 197 * @length: sub-block length, in bytes 198 * @dpu_kms: pointer to dpu kms structure 199 */ 200 void dpu_debugfs_setup_regset32(struct dpu_debugfs_regset32 *regset, 201 uint32_t offset, uint32_t length, struct dpu_kms *dpu_kms); 202 203 /** 204 * dpu_debugfs_create_regset32 - Create register read back file for debugfs 205 * 206 * This function is almost identical to the standard debugfs_create_regset32() 207 * function, with the main difference being that a list of register 208 * names/offsets do not need to be provided. The 'read' function simply outputs 209 * sequential register values over a specified range. 210 * 211 * Similar to the related debugfs_create_regset32 API, the structure pointed to 212 * by regset needs to persist for the lifetime of the created file. The calling 213 * code is responsible for initialization/management of this structure. 214 * 215 * The structure pointed to by regset is meant to be opaque. Please use 216 * dpu_debugfs_setup_regset32 to initialize it. 217 * 218 * @name: File name within debugfs 219 * @mode: File mode within debugfs 220 * @parent: Parent directory entry within debugfs, can be NULL 221 * @regset: Pointer to persistent register block definition 222 */ 223 void dpu_debugfs_create_regset32(const char *name, umode_t mode, 224 void *parent, struct dpu_debugfs_regset32 *regset); 225 226 /** 227 * dpu_debugfs_get_root - Return root directory entry for KMS's debugfs 228 * 229 * The return value should be passed as the 'parent' argument to subsequent 230 * debugfs create calls. 231 * 232 * @dpu_kms: Pointer to DPU's KMS structure 233 * 234 * Return: dentry pointer for DPU's debugfs location 235 */ 236 void *dpu_debugfs_get_root(struct dpu_kms *dpu_kms); 237 238 /** 239 * DPU info management functions 240 * These functions/definitions allow for building up a 'dpu_info' structure 241 * containing one or more "key=value\n" entries. 242 */ 243 #define DPU_KMS_INFO_MAX_SIZE 4096 244 245 /** 246 * Vblank enable/disable functions 247 */ 248 int dpu_enable_vblank(struct msm_kms *kms, struct drm_crtc *crtc); 249 void dpu_disable_vblank(struct msm_kms *kms, struct drm_crtc *crtc); 250 251 void dpu_kms_encoder_enable(struct drm_encoder *encoder); 252 253 /** 254 * dpu_kms_get_clk_rate() - get the clock rate 255 * @dpu_kms: poiner to dpu_kms structure 256 * @clock_name: clock name to get the rate 257 * 258 * Return: current clock rate 259 */ 260 u64 dpu_kms_get_clk_rate(struct dpu_kms *dpu_kms, char *clock_name); 261 262 #endif /* __dpu_kms_H__ */ 263