1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright (c) 2016-2018, The Linux Foundation. All rights reserved. 4 * Copyright (C) 2013 Red Hat 5 * Author: Rob Clark <robdclark@gmail.com> 6 */ 7 8 #ifndef __MSM_DRV_H__ 9 #define __MSM_DRV_H__ 10 11 #include <linux/kernel.h> 12 #include <linux/clk.h> 13 #include <linux/cpufreq.h> 14 #include <linux/module.h> 15 #include <linux/component.h> 16 #include <linux/platform_device.h> 17 #include <linux/pm.h> 18 #include <linux/pm_runtime.h> 19 #include <linux/slab.h> 20 #include <linux/list.h> 21 #include <linux/iommu.h> 22 #include <linux/types.h> 23 #include <linux/of_graph.h> 24 #include <linux/of_device.h> 25 #include <linux/sizes.h> 26 #include <linux/kthread.h> 27 28 #include <drm/drm_atomic.h> 29 #include <drm/drm_atomic_helper.h> 30 #include <drm/drm_plane_helper.h> 31 #include <drm/drm_probe_helper.h> 32 #include <drm/drm_fb_helper.h> 33 #include <drm/msm_drm.h> 34 #include <drm/drm_gem.h> 35 36 struct msm_kms; 37 struct msm_gpu; 38 struct msm_mmu; 39 struct msm_mdss; 40 struct msm_rd_state; 41 struct msm_perf_state; 42 struct msm_gem_submit; 43 struct msm_fence_context; 44 struct msm_gem_address_space; 45 struct msm_gem_vma; 46 47 #define MAX_CRTCS 8 48 #define MAX_PLANES 20 49 #define MAX_ENCODERS 8 50 #define MAX_BRIDGES 8 51 #define MAX_CONNECTORS 8 52 53 #define FRAC_16_16(mult, div) (((mult) << 16) / (div)) 54 55 struct msm_file_private { 56 rwlock_t queuelock; 57 struct list_head submitqueues; 58 int queueid; 59 struct msm_gem_address_space *aspace; 60 struct kref ref; 61 }; 62 63 enum msm_mdp_plane_property { 64 PLANE_PROP_ZPOS, 65 PLANE_PROP_ALPHA, 66 PLANE_PROP_PREMULTIPLIED, 67 PLANE_PROP_MAX_NUM 68 }; 69 70 #define MSM_GPU_MAX_RINGS 4 71 #define MAX_H_TILES_PER_DISPLAY 2 72 73 /** 74 * enum msm_display_caps - features/capabilities supported by displays 75 * @MSM_DISPLAY_CAP_VID_MODE: Video or "active" mode supported 76 * @MSM_DISPLAY_CAP_CMD_MODE: Command mode supported 77 * @MSM_DISPLAY_CAP_HOT_PLUG: Hot plug detection supported 78 * @MSM_DISPLAY_CAP_EDID: EDID supported 79 */ 80 enum msm_display_caps { 81 MSM_DISPLAY_CAP_VID_MODE = BIT(0), 82 MSM_DISPLAY_CAP_CMD_MODE = BIT(1), 83 MSM_DISPLAY_CAP_HOT_PLUG = BIT(2), 84 MSM_DISPLAY_CAP_EDID = BIT(3), 85 }; 86 87 /** 88 * enum msm_event_wait - type of HW events to wait for 89 * @MSM_ENC_COMMIT_DONE - wait for the driver to flush the registers to HW 90 * @MSM_ENC_TX_COMPLETE - wait for the HW to transfer the frame to panel 91 * @MSM_ENC_VBLANK - wait for the HW VBLANK event (for driver-internal waiters) 92 */ 93 enum msm_event_wait { 94 MSM_ENC_COMMIT_DONE = 0, 95 MSM_ENC_TX_COMPLETE, 96 MSM_ENC_VBLANK, 97 }; 98 99 /** 100 * struct msm_display_topology - defines a display topology pipeline 101 * @num_lm: number of layer mixers used 102 * @num_enc: number of compression encoder blocks used 103 * @num_intf: number of interfaces the panel is mounted on 104 */ 105 struct msm_display_topology { 106 u32 num_lm; 107 u32 num_enc; 108 u32 num_intf; 109 u32 num_dspp; 110 }; 111 112 /** 113 * struct msm_display_info - defines display properties 114 * @intf_type: DRM_MODE_ENCODER_ type 115 * @capabilities: Bitmask of display flags 116 * @num_of_h_tiles: Number of horizontal tiles in case of split interface 117 * @h_tile_instance: Controller instance used per tile. Number of elements is 118 * based on num_of_h_tiles 119 * @is_te_using_watchdog_timer: Boolean to indicate watchdog TE is 120 * used instead of panel TE in cmd mode panels 121 */ 122 struct msm_display_info { 123 int intf_type; 124 uint32_t capabilities; 125 uint32_t num_of_h_tiles; 126 uint32_t h_tile_instance[MAX_H_TILES_PER_DISPLAY]; 127 bool is_te_using_watchdog_timer; 128 }; 129 130 /* Commit/Event thread specific structure */ 131 struct msm_drm_thread { 132 struct drm_device *dev; 133 unsigned int crtc_id; 134 struct kthread_worker *worker; 135 }; 136 137 struct msm_drm_private { 138 139 struct drm_device *dev; 140 141 struct msm_kms *kms; 142 143 /* subordinate devices, if present: */ 144 struct platform_device *gpu_pdev; 145 146 /* top level MDSS wrapper device (for MDP5/DPU only) */ 147 struct msm_mdss *mdss; 148 149 /* possibly this should be in the kms component, but it is 150 * shared by both mdp4 and mdp5.. 151 */ 152 struct hdmi *hdmi; 153 154 /* eDP is for mdp5 only, but kms has not been created 155 * when edp_bind() and edp_init() are called. Here is the only 156 * place to keep the edp instance. 157 */ 158 struct msm_edp *edp; 159 160 /* DSI is shared by mdp4 and mdp5 */ 161 struct msm_dsi *dsi[2]; 162 163 struct msm_dp *dp; 164 165 /* when we have more than one 'msm_gpu' these need to be an array: */ 166 struct msm_gpu *gpu; 167 struct msm_file_private *lastctx; 168 /* gpu is only set on open(), but we need this info earlier */ 169 bool is_a2xx; 170 171 struct drm_fb_helper *fbdev; 172 173 struct msm_rd_state *rd; /* debugfs to dump all submits */ 174 struct msm_rd_state *hangrd; /* debugfs to dump hanging submits */ 175 struct msm_perf_state *perf; 176 177 /** 178 * List of all GEM objects (mainly for debugfs, protected by obj_lock 179 * (acquire before per GEM object lock) 180 */ 181 struct list_head objects; 182 struct mutex obj_lock; 183 184 /** 185 * LRUs of inactive GEM objects. Every bo is either in one of the 186 * inactive lists (depending on whether or not it is shrinkable) or 187 * gpu->active_list (for the gpu it is active on[1]), or transiently 188 * on a temporary list as the shrinker is running. 189 * 190 * Note that inactive_willneed also contains pinned and vmap'd bos, 191 * but the number of pinned-but-not-active objects is small (scanout 192 * buffers, ringbuffer, etc). 193 * 194 * These lists are protected by mm_lock (which should be acquired 195 * before per GEM object lock). One should *not* hold mm_lock in 196 * get_pages()/vmap()/etc paths, as they can trigger the shrinker. 197 * 198 * [1] if someone ever added support for the old 2d cores, there could be 199 * more than one gpu object 200 */ 201 struct list_head inactive_willneed; /* inactive + potentially unpin/evictable */ 202 struct list_head inactive_dontneed; /* inactive + shrinkable */ 203 struct list_head inactive_unpinned; /* inactive + purged or unpinned */ 204 long shrinkable_count; /* write access under mm_lock */ 205 long evictable_count; /* write access under mm_lock */ 206 struct mutex mm_lock; 207 208 struct workqueue_struct *wq; 209 210 unsigned int num_planes; 211 struct drm_plane *planes[MAX_PLANES]; 212 213 unsigned int num_crtcs; 214 struct drm_crtc *crtcs[MAX_CRTCS]; 215 216 struct msm_drm_thread event_thread[MAX_CRTCS]; 217 218 unsigned int num_encoders; 219 struct drm_encoder *encoders[MAX_ENCODERS]; 220 221 unsigned int num_bridges; 222 struct drm_bridge *bridges[MAX_BRIDGES]; 223 224 unsigned int num_connectors; 225 struct drm_connector *connectors[MAX_CONNECTORS]; 226 227 /* Properties */ 228 struct drm_property *plane_property[PLANE_PROP_MAX_NUM]; 229 230 /* VRAM carveout, used when no IOMMU: */ 231 struct { 232 unsigned long size; 233 dma_addr_t paddr; 234 /* NOTE: mm managed at the page level, size is in # of pages 235 * and position mm_node->start is in # of pages: 236 */ 237 struct drm_mm mm; 238 spinlock_t lock; /* Protects drm_mm node allocation/removal */ 239 } vram; 240 241 struct notifier_block vmap_notifier; 242 struct shrinker shrinker; 243 244 struct drm_atomic_state *pm_state; 245 }; 246 247 struct msm_format { 248 uint32_t pixel_format; 249 }; 250 251 struct msm_pending_timer; 252 253 int msm_atomic_prepare_fb(struct drm_plane *plane, 254 struct drm_plane_state *new_state); 255 int msm_atomic_init_pending_timer(struct msm_pending_timer *timer, 256 struct msm_kms *kms, int crtc_idx); 257 void msm_atomic_destroy_pending_timer(struct msm_pending_timer *timer); 258 void msm_atomic_commit_tail(struct drm_atomic_state *state); 259 struct drm_atomic_state *msm_atomic_state_alloc(struct drm_device *dev); 260 void msm_atomic_state_clear(struct drm_atomic_state *state); 261 void msm_atomic_state_free(struct drm_atomic_state *state); 262 263 int msm_crtc_enable_vblank(struct drm_crtc *crtc); 264 void msm_crtc_disable_vblank(struct drm_crtc *crtc); 265 266 int msm_gem_init_vma(struct msm_gem_address_space *aspace, 267 struct msm_gem_vma *vma, int npages, 268 u64 range_start, u64 range_end); 269 void msm_gem_purge_vma(struct msm_gem_address_space *aspace, 270 struct msm_gem_vma *vma); 271 void msm_gem_unmap_vma(struct msm_gem_address_space *aspace, 272 struct msm_gem_vma *vma); 273 int msm_gem_map_vma(struct msm_gem_address_space *aspace, 274 struct msm_gem_vma *vma, int prot, 275 struct sg_table *sgt, int npages); 276 void msm_gem_close_vma(struct msm_gem_address_space *aspace, 277 struct msm_gem_vma *vma); 278 279 280 struct msm_gem_address_space * 281 msm_gem_address_space_get(struct msm_gem_address_space *aspace); 282 283 void msm_gem_address_space_put(struct msm_gem_address_space *aspace); 284 285 struct msm_gem_address_space * 286 msm_gem_address_space_create(struct msm_mmu *mmu, const char *name, 287 u64 va_start, u64 size); 288 289 int msm_register_mmu(struct drm_device *dev, struct msm_mmu *mmu); 290 void msm_unregister_mmu(struct drm_device *dev, struct msm_mmu *mmu); 291 292 bool msm_use_mmu(struct drm_device *dev); 293 294 int msm_ioctl_gem_submit(struct drm_device *dev, void *data, 295 struct drm_file *file); 296 297 void msm_gem_shrinker_init(struct drm_device *dev); 298 void msm_gem_shrinker_cleanup(struct drm_device *dev); 299 300 struct sg_table *msm_gem_prime_get_sg_table(struct drm_gem_object *obj); 301 int msm_gem_prime_vmap(struct drm_gem_object *obj, struct dma_buf_map *map); 302 void msm_gem_prime_vunmap(struct drm_gem_object *obj, struct dma_buf_map *map); 303 int msm_gem_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma); 304 struct drm_gem_object *msm_gem_prime_import_sg_table(struct drm_device *dev, 305 struct dma_buf_attachment *attach, struct sg_table *sg); 306 int msm_gem_prime_pin(struct drm_gem_object *obj); 307 void msm_gem_prime_unpin(struct drm_gem_object *obj); 308 309 int msm_framebuffer_prepare(struct drm_framebuffer *fb, 310 struct msm_gem_address_space *aspace); 311 void msm_framebuffer_cleanup(struct drm_framebuffer *fb, 312 struct msm_gem_address_space *aspace); 313 uint32_t msm_framebuffer_iova(struct drm_framebuffer *fb, 314 struct msm_gem_address_space *aspace, int plane); 315 struct drm_gem_object *msm_framebuffer_bo(struct drm_framebuffer *fb, int plane); 316 const struct msm_format *msm_framebuffer_format(struct drm_framebuffer *fb); 317 struct drm_framebuffer *msm_framebuffer_create(struct drm_device *dev, 318 struct drm_file *file, const struct drm_mode_fb_cmd2 *mode_cmd); 319 struct drm_framebuffer * msm_alloc_stolen_fb(struct drm_device *dev, 320 int w, int h, int p, uint32_t format); 321 322 struct drm_fb_helper *msm_fbdev_init(struct drm_device *dev); 323 void msm_fbdev_free(struct drm_device *dev); 324 325 struct hdmi; 326 int msm_hdmi_modeset_init(struct hdmi *hdmi, struct drm_device *dev, 327 struct drm_encoder *encoder); 328 void __init msm_hdmi_register(void); 329 void __exit msm_hdmi_unregister(void); 330 331 struct msm_edp; 332 void __init msm_edp_register(void); 333 void __exit msm_edp_unregister(void); 334 int msm_edp_modeset_init(struct msm_edp *edp, struct drm_device *dev, 335 struct drm_encoder *encoder); 336 337 struct msm_dsi; 338 #ifdef CONFIG_DRM_MSM_DSI 339 void __init msm_dsi_register(void); 340 void __exit msm_dsi_unregister(void); 341 int msm_dsi_modeset_init(struct msm_dsi *msm_dsi, struct drm_device *dev, 342 struct drm_encoder *encoder); 343 #else 344 static inline void __init msm_dsi_register(void) 345 { 346 } 347 static inline void __exit msm_dsi_unregister(void) 348 { 349 } 350 static inline int msm_dsi_modeset_init(struct msm_dsi *msm_dsi, 351 struct drm_device *dev, 352 struct drm_encoder *encoder) 353 { 354 return -EINVAL; 355 } 356 #endif 357 358 #ifdef CONFIG_DRM_MSM_DP 359 int __init msm_dp_register(void); 360 void __exit msm_dp_unregister(void); 361 int msm_dp_modeset_init(struct msm_dp *dp_display, struct drm_device *dev, 362 struct drm_encoder *encoder); 363 int msm_dp_display_enable(struct msm_dp *dp, struct drm_encoder *encoder); 364 int msm_dp_display_disable(struct msm_dp *dp, struct drm_encoder *encoder); 365 int msm_dp_display_pre_disable(struct msm_dp *dp, struct drm_encoder *encoder); 366 void msm_dp_display_mode_set(struct msm_dp *dp, struct drm_encoder *encoder, 367 struct drm_display_mode *mode, 368 struct drm_display_mode *adjusted_mode); 369 void msm_dp_irq_postinstall(struct msm_dp *dp_display); 370 371 void msm_dp_debugfs_init(struct msm_dp *dp_display, struct drm_minor *minor); 372 373 #else 374 static inline int __init msm_dp_register(void) 375 { 376 return -EINVAL; 377 } 378 static inline void __exit msm_dp_unregister(void) 379 { 380 } 381 static inline int msm_dp_modeset_init(struct msm_dp *dp_display, 382 struct drm_device *dev, 383 struct drm_encoder *encoder) 384 { 385 return -EINVAL; 386 } 387 static inline int msm_dp_display_enable(struct msm_dp *dp, 388 struct drm_encoder *encoder) 389 { 390 return -EINVAL; 391 } 392 static inline int msm_dp_display_disable(struct msm_dp *dp, 393 struct drm_encoder *encoder) 394 { 395 return -EINVAL; 396 } 397 static inline int msm_dp_display_pre_disable(struct msm_dp *dp, 398 struct drm_encoder *encoder) 399 { 400 return -EINVAL; 401 } 402 static inline void msm_dp_display_mode_set(struct msm_dp *dp, 403 struct drm_encoder *encoder, 404 struct drm_display_mode *mode, 405 struct drm_display_mode *adjusted_mode) 406 { 407 } 408 409 static inline void msm_dp_irq_postinstall(struct msm_dp *dp_display) 410 { 411 } 412 413 static inline void msm_dp_debugfs_init(struct msm_dp *dp_display, 414 struct drm_minor *minor) 415 { 416 } 417 418 #endif 419 420 void __init msm_mdp_register(void); 421 void __exit msm_mdp_unregister(void); 422 void __init msm_dpu_register(void); 423 void __exit msm_dpu_unregister(void); 424 425 #ifdef CONFIG_DEBUG_FS 426 void msm_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m); 427 int msm_debugfs_late_init(struct drm_device *dev); 428 int msm_rd_debugfs_init(struct drm_minor *minor); 429 void msm_rd_debugfs_cleanup(struct msm_drm_private *priv); 430 __printf(3, 4) 431 void msm_rd_dump_submit(struct msm_rd_state *rd, struct msm_gem_submit *submit, 432 const char *fmt, ...); 433 int msm_perf_debugfs_init(struct drm_minor *minor); 434 void msm_perf_debugfs_cleanup(struct msm_drm_private *priv); 435 #else 436 static inline int msm_debugfs_late_init(struct drm_device *dev) { return 0; } 437 __printf(3, 4) 438 static inline void msm_rd_dump_submit(struct msm_rd_state *rd, 439 struct msm_gem_submit *submit, 440 const char *fmt, ...) {} 441 static inline void msm_rd_debugfs_cleanup(struct msm_drm_private *priv) {} 442 static inline void msm_perf_debugfs_cleanup(struct msm_drm_private *priv) {} 443 #endif 444 445 struct clk *msm_clk_get(struct platform_device *pdev, const char *name); 446 447 struct clk *msm_clk_bulk_get_clock(struct clk_bulk_data *bulk, int count, 448 const char *name); 449 void __iomem *msm_ioremap(struct platform_device *pdev, const char *name, 450 const char *dbgname); 451 void __iomem *msm_ioremap_quiet(struct platform_device *pdev, const char *name, 452 const char *dbgname); 453 void msm_writel(u32 data, void __iomem *addr); 454 u32 msm_readl(const void __iomem *addr); 455 void msm_rmw(void __iomem *addr, u32 mask, u32 or); 456 457 struct msm_gpu_submitqueue; 458 int msm_submitqueue_init(struct drm_device *drm, struct msm_file_private *ctx); 459 struct msm_gpu_submitqueue *msm_submitqueue_get(struct msm_file_private *ctx, 460 u32 id); 461 int msm_submitqueue_create(struct drm_device *drm, 462 struct msm_file_private *ctx, 463 u32 prio, u32 flags, u32 *id); 464 int msm_submitqueue_query(struct drm_device *drm, struct msm_file_private *ctx, 465 struct drm_msm_submitqueue_query *args); 466 int msm_submitqueue_remove(struct msm_file_private *ctx, u32 id); 467 void msm_submitqueue_close(struct msm_file_private *ctx); 468 469 void msm_submitqueue_destroy(struct kref *kref); 470 471 static inline void __msm_file_private_destroy(struct kref *kref) 472 { 473 struct msm_file_private *ctx = container_of(kref, 474 struct msm_file_private, ref); 475 476 msm_gem_address_space_put(ctx->aspace); 477 kfree(ctx); 478 } 479 480 static inline void msm_file_private_put(struct msm_file_private *ctx) 481 { 482 kref_put(&ctx->ref, __msm_file_private_destroy); 483 } 484 485 static inline struct msm_file_private *msm_file_private_get( 486 struct msm_file_private *ctx) 487 { 488 kref_get(&ctx->ref); 489 return ctx; 490 } 491 492 #define DBG(fmt, ...) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__) 493 #define VERB(fmt, ...) if (0) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__) 494 495 static inline int align_pitch(int width, int bpp) 496 { 497 int bytespp = (bpp + 7) / 8; 498 /* adreno needs pitch aligned to 32 pixels: */ 499 return bytespp * ALIGN(width, 32); 500 } 501 502 /* for the generated headers: */ 503 #define INVALID_IDX(idx) ({BUG(); 0;}) 504 #define fui(x) ({BUG(); 0;}) 505 #define util_float_to_half(x) ({BUG(); 0;}) 506 507 508 #define FIELD(val, name) (((val) & name ## __MASK) >> name ## __SHIFT) 509 510 /* for conditionally setting boolean flag(s): */ 511 #define COND(bool, val) ((bool) ? (val) : 0) 512 513 static inline unsigned long timeout_to_jiffies(const ktime_t *timeout) 514 { 515 ktime_t now = ktime_get(); 516 unsigned long remaining_jiffies; 517 518 if (ktime_compare(*timeout, now) < 0) { 519 remaining_jiffies = 0; 520 } else { 521 ktime_t rem = ktime_sub(*timeout, now); 522 remaining_jiffies = ktime_divns(rem, NSEC_PER_SEC / HZ); 523 } 524 525 return remaining_jiffies; 526 } 527 528 #endif /* __MSM_DRV_H__ */ 529