drivers/gpu/drm/msm/msm_drv.h

   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 <[email protected]>
   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 struct msm_disp_state;
  47
  48 #define MAX_CRTCS      8
  49 #define MAX_PLANES     20
  50 #define MAX_ENCODERS   8
  51 #define MAX_BRIDGES    8
  52 #define MAX_CONNECTORS 8
  53
  54 #define FRAC_16_16(mult, div)    (((mult) << 16) / (div))
  55
  56 enum msm_mdp_plane_property {
  57         PLANE_PROP_ZPOS,
  58         PLANE_PROP_ALPHA,
  59         PLANE_PROP_PREMULTIPLIED,
  60         PLANE_PROP_MAX_NUM
  61 };
  62
  63 enum msm_dp_controller {
  64         MSM_DP_CONTROLLER_0,
  65         MSM_DP_CONTROLLER_1,
  66         MSM_DP_CONTROLLER_2,
  67         MSM_DP_CONTROLLER_COUNT,
  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         /* DSI is shared by mdp4 and mdp5 */
 155         struct msm_dsi *dsi[2];
 156
 157         struct msm_dp *dp[MSM_DP_CONTROLLER_COUNT];
 158
 159         /* when we have more than one 'msm_gpu' these need to be an array: */
 160         struct msm_gpu *gpu;
 161
 162         /* gpu is only set on open(), but we need this info earlier */
 163         bool is_a2xx;
 164         bool has_cached_coherent;
 165
 166         struct drm_fb_helper *fbdev;
 167
 168         struct msm_rd_state *rd;       /* debugfs to dump all submits */
 169         struct msm_rd_state *hangrd;   /* debugfs to dump hanging submits */
 170         struct msm_perf_state *perf;
 171
 172         /**
 173          * List of all GEM objects (mainly for debugfs, protected by obj_lock
 174          * (acquire before per GEM object lock)
 175          */
 176         struct list_head objects;
 177         struct mutex obj_lock;
 178
 179         /**
 180          * LRUs of inactive GEM objects.  Every bo is either in one of the
 181          * inactive lists (depending on whether or not it is shrinkable) or
 182          * gpu->active_list (for the gpu it is active on[1]), or transiently
 183          * on a temporary list as the shrinker is running.
 184          *
 185          * Note that inactive_willneed also contains pinned and vmap'd bos,
 186          * but the number of pinned-but-not-active objects is small (scanout
 187          * buffers, ringbuffer, etc).
 188          *
 189          * These lists are protected by mm_lock (which should be acquired
 190          * before per GEM object lock).  One should *not* hold mm_lock in
 191          * get_pages()/vmap()/etc paths, as they can trigger the shrinker.
 192          *
 193          * [1] if someone ever added support for the old 2d cores, there could be
 194          *     more than one gpu object
 195          */
 196         struct list_head inactive_willneed;  /* inactive + potentially unpin/evictable */
 197         struct list_head inactive_dontneed;  /* inactive + shrinkable */
 198         struct list_head inactive_unpinned;  /* inactive + purged or unpinned */
 199         long shrinkable_count;               /* write access under mm_lock */
 200         long evictable_count;                /* write access under mm_lock */
 201         struct mutex mm_lock;
 202
 203         struct workqueue_struct *wq;
 204
 205         unsigned int num_planes;
 206         struct drm_plane *planes[MAX_PLANES];
 207
 208         unsigned int num_crtcs;
 209         struct drm_crtc *crtcs[MAX_CRTCS];
 210
 211         struct msm_drm_thread event_thread[MAX_CRTCS];
 212
 213         unsigned int num_encoders;
 214         struct drm_encoder *encoders[MAX_ENCODERS];
 215
 216         unsigned int num_bridges;
 217         struct drm_bridge *bridges[MAX_BRIDGES];
 218
 219         unsigned int num_connectors;
 220         struct drm_connector *connectors[MAX_CONNECTORS];
 221
 222         /* Properties */
 223         struct drm_property *plane_property[PLANE_PROP_MAX_NUM];
 224
 225         /* VRAM carveout, used when no IOMMU: */
 226         struct {
 227                 unsigned long size;
 228                 dma_addr_t paddr;
 229                 /* NOTE: mm managed at the page level, size is in # of pages
 230                  * and position mm_node->start is in # of pages:
 231                  */
 232                 struct drm_mm mm;
 233                 spinlock_t lock; /* Protects drm_mm node allocation/removal */
 234         } vram;
 235
 236         struct notifier_block vmap_notifier;
 237         struct shrinker shrinker;
 238
 239         struct drm_atomic_state *pm_state;
 240
 241         /* For hang detection, in ms */
 242         unsigned int hangcheck_period;
 243
 244         /**
 245          * disable_err_irq:
 246          *
 247          * Disable handling of GPU hw error interrupts, to force fallback to
 248          * sw hangcheck timer.  Written (via debugfs) by igt tests to test
 249          * the sw hangcheck mechanism.
 250          */
 251         bool disable_err_irq;
 252 };
 253
 254 struct msm_format {
 255         uint32_t pixel_format;
 256 };
 257
 258 struct msm_pending_timer;
 259
 260 int msm_atomic_prepare_fb(struct drm_plane *plane,
 261                           struct drm_plane_state *new_state);
 262 int msm_atomic_init_pending_timer(struct msm_pending_timer *timer,
 263                 struct msm_kms *kms, int crtc_idx);
 264 void msm_atomic_destroy_pending_timer(struct msm_pending_timer *timer);
 265 void msm_atomic_commit_tail(struct drm_atomic_state *state);
 266 struct drm_atomic_state *msm_atomic_state_alloc(struct drm_device *dev);
 267 void msm_atomic_state_clear(struct drm_atomic_state *state);
 268 void msm_atomic_state_free(struct drm_atomic_state *state);
 269
 270 int msm_crtc_enable_vblank(struct drm_crtc *crtc);
 271 void msm_crtc_disable_vblank(struct drm_crtc *crtc);
 272
 273 int msm_gem_init_vma(struct msm_gem_address_space *aspace,
 274                 struct msm_gem_vma *vma, int npages,
 275                 u64 range_start, u64 range_end);
 276 void msm_gem_purge_vma(struct msm_gem_address_space *aspace,
 277                 struct msm_gem_vma *vma);
 278 void msm_gem_unmap_vma(struct msm_gem_address_space *aspace,
 279                 struct msm_gem_vma *vma);
 280 int msm_gem_map_vma(struct msm_gem_address_space *aspace,
 281                 struct msm_gem_vma *vma, int prot,
 282                 struct sg_table *sgt, int npages);
 283 void msm_gem_close_vma(struct msm_gem_address_space *aspace,
 284                 struct msm_gem_vma *vma);
 285
 286
 287 struct msm_gem_address_space *
 288 msm_gem_address_space_get(struct msm_gem_address_space *aspace);
 289
 290 void msm_gem_address_space_put(struct msm_gem_address_space *aspace);
 291
 292 struct msm_gem_address_space *
 293 msm_gem_address_space_create(struct msm_mmu *mmu, const char *name,
 294                 u64 va_start, u64 size);
 295
 296 int msm_register_mmu(struct drm_device *dev, struct msm_mmu *mmu);
 297 void msm_unregister_mmu(struct drm_device *dev, struct msm_mmu *mmu);
 298
 299 bool msm_use_mmu(struct drm_device *dev);
 300
 301 int msm_ioctl_gem_submit(struct drm_device *dev, void *data,
 302                 struct drm_file *file);
 303
 304 #ifdef CONFIG_DEBUG_FS
 305 unsigned long msm_gem_shrinker_shrink(struct drm_device *dev, unsigned long nr_to_scan);
 306 #endif
 307
 308 void msm_gem_shrinker_init(struct drm_device *dev);
 309 void msm_gem_shrinker_cleanup(struct drm_device *dev);
 310
 311 struct sg_table *msm_gem_prime_get_sg_table(struct drm_gem_object *obj);
 312 int msm_gem_prime_vmap(struct drm_gem_object *obj, struct dma_buf_map *map);
 313 void msm_gem_prime_vunmap(struct drm_gem_object *obj, struct dma_buf_map *map);
 314 struct drm_gem_object *msm_gem_prime_import_sg_table(struct drm_device *dev,
 315                 struct dma_buf_attachment *attach, struct sg_table *sg);
 316 int msm_gem_prime_pin(struct drm_gem_object *obj);
 317 void msm_gem_prime_unpin(struct drm_gem_object *obj);
 318
 319 int msm_framebuffer_prepare(struct drm_framebuffer *fb,
 320                 struct msm_gem_address_space *aspace);
 321 void msm_framebuffer_cleanup(struct drm_framebuffer *fb,
 322                 struct msm_gem_address_space *aspace);
 323 uint32_t msm_framebuffer_iova(struct drm_framebuffer *fb,
 324                 struct msm_gem_address_space *aspace, int plane);
 325 struct drm_gem_object *msm_framebuffer_bo(struct drm_framebuffer *fb, int plane);
 326 const struct msm_format *msm_framebuffer_format(struct drm_framebuffer *fb);
 327 struct drm_framebuffer *msm_framebuffer_create(struct drm_device *dev,
 328                 struct drm_file *file, const struct drm_mode_fb_cmd2 *mode_cmd);
 329 struct drm_framebuffer * msm_alloc_stolen_fb(struct drm_device *dev,
 330                 int w, int h, int p, uint32_t format);
 331
 332 struct drm_fb_helper *msm_fbdev_init(struct drm_device *dev);
 333 void msm_fbdev_free(struct drm_device *dev);
 334
 335 struct hdmi;
 336 int msm_hdmi_modeset_init(struct hdmi *hdmi, struct drm_device *dev,
 337                 struct drm_encoder *encoder);
 338 void __init msm_hdmi_register(void);
 339 void __exit msm_hdmi_unregister(void);
 340
 341 struct msm_dsi;
 342 #ifdef CONFIG_DRM_MSM_DSI
 343 int dsi_dev_attach(struct platform_device *pdev);
 344 void dsi_dev_detach(struct platform_device *pdev);
 345 void __init msm_dsi_register(void);
 346 void __exit msm_dsi_unregister(void);
 347 int msm_dsi_modeset_init(struct msm_dsi *msm_dsi, struct drm_device *dev,
 348                          struct drm_encoder *encoder);
 349 void msm_dsi_snapshot(struct msm_disp_state *disp_state, struct msm_dsi *msm_dsi);
 350 bool msm_dsi_is_cmd_mode(struct msm_dsi *msm_dsi);
 351 bool msm_dsi_is_bonded_dsi(struct msm_dsi *msm_dsi);
 352 bool msm_dsi_is_master_dsi(struct msm_dsi *msm_dsi);
 353 #else
 354 static inline void __init msm_dsi_register(void)
 355 {
 356 }
 357 static inline void __exit msm_dsi_unregister(void)
 358 {
 359 }
 360 static inline int msm_dsi_modeset_init(struct msm_dsi *msm_dsi,
 361                                        struct drm_device *dev,
 362                                        struct drm_encoder *encoder)
 363 {
 364         return -EINVAL;
 365 }
 366 static inline void msm_dsi_snapshot(struct msm_disp_state *disp_state, struct msm_dsi *msm_dsi)
 367 {
 368 }
 369 static inline bool msm_dsi_is_cmd_mode(struct msm_dsi *msm_dsi)
 370 {
 371         return false;
 372 }
 373 static inline bool msm_dsi_is_bonded_dsi(struct msm_dsi *msm_dsi)
 374 {
 375         return false;
 376 }
 377 static inline bool msm_dsi_is_master_dsi(struct msm_dsi *msm_dsi)
 378 {
 379         return false;
 380 }
 381 #endif
 382
 383 #ifdef CONFIG_DRM_MSM_DP
 384 int __init msm_dp_register(void);
 385 void __exit msm_dp_unregister(void);
 386 int msm_dp_modeset_init(struct msm_dp *dp_display, struct drm_device *dev,
 387                          struct drm_encoder *encoder);
 388 int msm_dp_display_enable(struct msm_dp *dp, struct drm_encoder *encoder);
 389 int msm_dp_display_disable(struct msm_dp *dp, struct drm_encoder *encoder);
 390 int msm_dp_display_pre_disable(struct msm_dp *dp, struct drm_encoder *encoder);
 391 void msm_dp_display_mode_set(struct msm_dp *dp, struct drm_encoder *encoder,
 392                                 const struct drm_display_mode *mode,
 393                                 const struct drm_display_mode *adjusted_mode);
 394
 395 struct drm_bridge *msm_dp_bridge_init(struct msm_dp *dp_display,
 396                                         struct drm_device *dev,
 397                                         struct drm_encoder *encoder);
 398 void msm_dp_irq_postinstall(struct msm_dp *dp_display);
 399 void msm_dp_snapshot(struct msm_disp_state *disp_state, struct msm_dp *dp_display);
 400
 401 void msm_dp_debugfs_init(struct msm_dp *dp_display, struct drm_minor *minor);
 402
 403 #else
 404 static inline int __init msm_dp_register(void)
 405 {
 406         return -EINVAL;
 407 }
 408 static inline void __exit msm_dp_unregister(void)
 409 {
 410 }
 411 static inline int msm_dp_modeset_init(struct msm_dp *dp_display,
 412                                        struct drm_device *dev,
 413                                        struct drm_encoder *encoder)
 414 {
 415         return -EINVAL;
 416 }
 417 static inline int msm_dp_display_enable(struct msm_dp *dp,
 418                                         struct drm_encoder *encoder)
 419 {
 420         return -EINVAL;
 421 }
 422 static inline int msm_dp_display_disable(struct msm_dp *dp,
 423                                         struct drm_encoder *encoder)
 424 {
 425         return -EINVAL;
 426 }
 427 static inline int msm_dp_display_pre_disable(struct msm_dp *dp,
 428                                         struct drm_encoder *encoder)
 429 {
 430         return -EINVAL;
 431 }
 432 static inline void msm_dp_display_mode_set(struct msm_dp *dp,
 433                                 struct drm_encoder *encoder,
 434                                 const struct drm_display_mode *mode,
 435                                 const struct drm_display_mode *adjusted_mode)
 436 {
 437 }
 438
 439 static inline void msm_dp_irq_postinstall(struct msm_dp *dp_display)
 440 {
 441 }
 442
 443 static inline void msm_dp_snapshot(struct msm_disp_state *disp_state, struct msm_dp *dp_display)
 444 {
 445 }
 446
 447 static inline void msm_dp_debugfs_init(struct msm_dp *dp_display,
 448                 struct drm_minor *minor)
 449 {
 450 }
 451
 452 #endif
 453
 454 void __init msm_mdp_register(void);
 455 void __exit msm_mdp_unregister(void);
 456 void __init msm_dpu_register(void);
 457 void __exit msm_dpu_unregister(void);
 458
 459 #ifdef CONFIG_DEBUG_FS
 460 void msm_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m);
 461 int msm_debugfs_late_init(struct drm_device *dev);
 462 int msm_rd_debugfs_init(struct drm_minor *minor);
 463 void msm_rd_debugfs_cleanup(struct msm_drm_private *priv);
 464 __printf(3, 4)
 465 void msm_rd_dump_submit(struct msm_rd_state *rd, struct msm_gem_submit *submit,
 466                 const char *fmt, ...);
 467 int msm_perf_debugfs_init(struct drm_minor *minor);
 468 void msm_perf_debugfs_cleanup(struct msm_drm_private *priv);
 469 #else
 470 static inline int msm_debugfs_late_init(struct drm_device *dev) { return 0; }
 471 __printf(3, 4)
 472 static inline void msm_rd_dump_submit(struct msm_rd_state *rd,
 473                         struct msm_gem_submit *submit,
 474                         const char *fmt, ...) {}
 475 static inline void msm_rd_debugfs_cleanup(struct msm_drm_private *priv) {}
 476 static inline void msm_perf_debugfs_cleanup(struct msm_drm_private *priv) {}
 477 #endif
 478
 479 struct clk *msm_clk_get(struct platform_device *pdev, const char *name);
 480
 481 struct clk *msm_clk_bulk_get_clock(struct clk_bulk_data *bulk, int count,
 482         const char *name);
 483 void __iomem *msm_ioremap(struct platform_device *pdev, const char *name,
 484                 const char *dbgname);
 485 void __iomem *msm_ioremap_size(struct platform_device *pdev, const char *name,
 486                 const char *dbgname, phys_addr_t *size);
 487 void __iomem *msm_ioremap_quiet(struct platform_device *pdev, const char *name,
 488                 const char *dbgname);
 489 void msm_writel(u32 data, void __iomem *addr);
 490 u32 msm_readl(const void __iomem *addr);
 491 void msm_rmw(void __iomem *addr, u32 mask, u32 or);
 492
 493 /**
 494  * struct msm_hrtimer_work - a helper to combine an hrtimer with kthread_work
 495  *
 496  * @timer: hrtimer to control when the kthread work is triggered
 497  * @work:  the kthread work
 498  * @worker: the kthread worker the work will be scheduled on
 499  */
 500 struct msm_hrtimer_work {
 501         struct hrtimer timer;
 502         struct kthread_work work;
 503         struct kthread_worker *worker;
 504 };
 505
 506 void msm_hrtimer_queue_work(struct msm_hrtimer_work *work,
 507                             ktime_t wakeup_time,
 508                             enum hrtimer_mode mode);
 509 void msm_hrtimer_work_init(struct msm_hrtimer_work *work,
 510                            struct kthread_worker *worker,
 511                            kthread_work_func_t fn,
 512                            clockid_t clock_id,
 513                            enum hrtimer_mode mode);
 514
 515 #define DBG(fmt, ...) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
 516 #define VERB(fmt, ...) if (0) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
 517
 518 static inline int align_pitch(int width, int bpp)
 519 {
 520         int bytespp = (bpp + 7) / 8;
 521         /* adreno needs pitch aligned to 32 pixels: */
 522         return bytespp * ALIGN(width, 32);
 523 }
 524
 525 /* for the generated headers: */
 526 #define INVALID_IDX(idx) ({BUG(); 0;})
 527 #define fui(x)                ({BUG(); 0;})
 528 #define _mesa_float_to_half(x) ({BUG(); 0;})
 529
 530
 531 #define FIELD(val, name) (((val) & name ## __MASK) >> name ## __SHIFT)
 532
 533 /* for conditionally setting boolean flag(s): */
 534 #define COND(bool, val) ((bool) ? (val) : 0)
 535
 536 static inline unsigned long timeout_to_jiffies(const ktime_t *timeout)
 537 {
 538         ktime_t now = ktime_get();
 539         s64 remaining_jiffies;
 540
 541         if (ktime_compare(*timeout, now) < 0) {
 542                 remaining_jiffies = 0;
 543         } else {
 544                 ktime_t rem = ktime_sub(*timeout, now);
 545                 remaining_jiffies = ktime_divns(rem, NSEC_PER_SEC / HZ);
 546         }
 547
 548         return clamp(remaining_jiffies, 0LL, (s64)INT_MAX);
 549 }
 550
 551 #endif /* __MSM_DRV_H__ */