drivers/gpu/drm/msm/msm_drv.h

   1 /*
   2  * Copyright (c) 2016-2018, The Linux Foundation. All rights reserved.
   3  * Copyright (C) 2013 Red Hat
   4  * Author: Rob Clark <robdclark@gmail.com>
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms of the GNU General Public License version 2 as published by
   8  * the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along with
  16  * this program.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef __MSM_DRV_H__
  20 #define __MSM_DRV_H__
  21
  22 #include <linux/kernel.h>
  23 #include <linux/clk.h>
  24 #include <linux/cpufreq.h>
  25 #include <linux/module.h>
  26 #include <linux/component.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/pm.h>
  29 #include <linux/pm_runtime.h>
  30 #include <linux/slab.h>
  31 #include <linux/list.h>
  32 #include <linux/iommu.h>
  33 #include <linux/types.h>
  34 #include <linux/of_graph.h>
  35 #include <linux/of_device.h>
  36 #include <asm/sizes.h>
  37 #include <linux/kthread.h>
  38
  39 #include <drm/drmP.h>
  40 #include <drm/drm_atomic.h>
  41 #include <drm/drm_atomic_helper.h>
  42 #include <drm/drm_crtc_helper.h>
  43 #include <drm/drm_plane_helper.h>
  44 #include <drm/drm_fb_helper.h>
  45 #include <drm/msm_drm.h>
  46 #include <drm/drm_gem.h>
  47
  48 struct msm_kms;
  49 struct msm_gpu;
  50 struct msm_mmu;
  51 struct msm_mdss;
  52 struct msm_rd_state;
  53 struct msm_perf_state;
  54 struct msm_gem_submit;
  55 struct msm_fence_context;
  56 struct msm_gem_address_space;
  57 struct msm_gem_vma;
  58
  59 #define MAX_CRTCS      8
  60 #define MAX_PLANES     20
  61 #define MAX_ENCODERS   8
  62 #define MAX_BRIDGES    8
  63 #define MAX_CONNECTORS 8
  64
  65 #define FRAC_16_16(mult, div)    (((mult) << 16) / (div))
  66
  67 struct msm_file_private {
  68         rwlock_t queuelock;
  69         struct list_head submitqueues;
  70         int queueid;
  71 };
  72
  73 enum msm_mdp_plane_property {
  74         PLANE_PROP_ZPOS,
  75         PLANE_PROP_ALPHA,
  76         PLANE_PROP_PREMULTIPLIED,
  77         PLANE_PROP_MAX_NUM
  78 };
  79
  80 struct msm_vblank_ctrl {
  81         struct kthread_work work;
  82         struct list_head event_list;
  83         spinlock_t lock;
  84 };
  85
  86 #define MSM_GPU_MAX_RINGS 4
  87 #define MAX_H_TILES_PER_DISPLAY 2
  88
  89 /**
  90  * enum msm_display_caps - features/capabilities supported by displays
  91  * @MSM_DISPLAY_CAP_VID_MODE:           Video or "active" mode supported
  92  * @MSM_DISPLAY_CAP_CMD_MODE:           Command mode supported
  93  * @MSM_DISPLAY_CAP_HOT_PLUG:           Hot plug detection supported
  94  * @MSM_DISPLAY_CAP_EDID:               EDID supported
  95  */
  96 enum msm_display_caps {
  97         MSM_DISPLAY_CAP_VID_MODE        = BIT(0),
  98         MSM_DISPLAY_CAP_CMD_MODE        = BIT(1),
  99         MSM_DISPLAY_CAP_HOT_PLUG        = BIT(2),
 100         MSM_DISPLAY_CAP_EDID            = BIT(3),
 101 };
 102
 103 /**
 104  * enum msm_event_wait - type of HW events to wait for
 105  * @MSM_ENC_COMMIT_DONE - wait for the driver to flush the registers to HW
 106  * @MSM_ENC_TX_COMPLETE - wait for the HW to transfer the frame to panel
 107  * @MSM_ENC_VBLANK - wait for the HW VBLANK event (for driver-internal waiters)
 108  */
 109 enum msm_event_wait {
 110         MSM_ENC_COMMIT_DONE = 0,
 111         MSM_ENC_TX_COMPLETE,
 112         MSM_ENC_VBLANK,
 113 };
 114
 115 /**
 116  * struct msm_display_topology - defines a display topology pipeline
 117  * @num_lm:       number of layer mixers used
 118  * @num_enc:      number of compression encoder blocks used
 119  * @num_intf:     number of interfaces the panel is mounted on
 120  */
 121 struct msm_display_topology {
 122         u32 num_lm;
 123         u32 num_enc;
 124         u32 num_intf;
 125 };
 126
 127 /**
 128  * struct msm_display_info - defines display properties
 129  * @intf_type:          DRM_MODE_CONNECTOR_ display type
 130  * @capabilities:       Bitmask of display flags
 131  * @num_of_h_tiles:     Number of horizontal tiles in case of split interface
 132  * @h_tile_instance:    Controller instance used per tile. Number of elements is
 133  *                      based on num_of_h_tiles
 134  * @is_te_using_watchdog_timer:  Boolean to indicate watchdog TE is
 135  *                               used instead of panel TE in cmd mode panels
 136  */
 137 struct msm_display_info {
 138         int intf_type;
 139         uint32_t capabilities;
 140         uint32_t num_of_h_tiles;
 141         uint32_t h_tile_instance[MAX_H_TILES_PER_DISPLAY];
 142         bool is_te_using_watchdog_timer;
 143 };
 144
 145 /* Commit/Event thread specific structure */
 146 struct msm_drm_thread {
 147         struct drm_device *dev;
 148         struct task_struct *thread;
 149         unsigned int crtc_id;
 150         struct kthread_worker worker;
 151 };
 152
 153 struct msm_drm_private {
 154
 155         struct drm_device *dev;
 156
 157         struct msm_kms *kms;
 158
 159         /* subordinate devices, if present: */
 160         struct platform_device *gpu_pdev;
 161
 162         /* top level MDSS wrapper device (for MDP5/DPU only) */
 163         struct msm_mdss *mdss;
 164
 165         /* possibly this should be in the kms component, but it is
 166          * shared by both mdp4 and mdp5..
 167          */
 168         struct hdmi *hdmi;
 169
 170         /* eDP is for mdp5 only, but kms has not been created
 171          * when edp_bind() and edp_init() are called. Here is the only
 172          * place to keep the edp instance.
 173          */
 174         struct msm_edp *edp;
 175
 176         /* DSI is shared by mdp4 and mdp5 */
 177         struct msm_dsi *dsi[2];
 178
 179         /* when we have more than one 'msm_gpu' these need to be an array: */
 180         struct msm_gpu *gpu;
 181         struct msm_file_private *lastctx;
 182         /* gpu is only set on open(), but we need this info earlier */
 183         bool is_a2xx;
 184
 185         struct drm_fb_helper *fbdev;
 186
 187         struct msm_rd_state *rd;       /* debugfs to dump all submits */
 188         struct msm_rd_state *hangrd;   /* debugfs to dump hanging submits */
 189         struct msm_perf_state *perf;
 190
 191         /* list of GEM objects: */
 192         struct list_head inactive_list;
 193
 194         struct workqueue_struct *wq;
 195
 196         unsigned int num_planes;
 197         struct drm_plane *planes[MAX_PLANES];
 198
 199         unsigned int num_crtcs;
 200         struct drm_crtc *crtcs[MAX_CRTCS];
 201
 202         struct msm_drm_thread disp_thread[MAX_CRTCS];
 203         struct msm_drm_thread event_thread[MAX_CRTCS];
 204
 205         unsigned int num_encoders;
 206         struct drm_encoder *encoders[MAX_ENCODERS];
 207
 208         unsigned int num_bridges;
 209         struct drm_bridge *bridges[MAX_BRIDGES];
 210
 211         unsigned int num_connectors;
 212         struct drm_connector *connectors[MAX_CONNECTORS];
 213
 214         /* Properties */
 215         struct drm_property *plane_property[PLANE_PROP_MAX_NUM];
 216
 217         /* VRAM carveout, used when no IOMMU: */
 218         struct {
 219                 unsigned long size;
 220                 dma_addr_t paddr;
 221                 /* NOTE: mm managed at the page level, size is in # of pages
 222                  * and position mm_node->start is in # of pages:
 223                  */
 224                 struct drm_mm mm;
 225                 spinlock_t lock; /* Protects drm_mm node allocation/removal */
 226         } vram;
 227
 228         struct notifier_block vmap_notifier;
 229         struct shrinker shrinker;
 230
 231         struct msm_vblank_ctrl vblank_ctrl;
 232         struct drm_atomic_state *pm_state;
 233 };
 234
 235 struct msm_format {
 236         uint32_t pixel_format;
 237 };
 238
 239 int msm_atomic_prepare_fb(struct drm_plane *plane,
 240                           struct drm_plane_state *new_state);
 241 void msm_atomic_commit_tail(struct drm_atomic_state *state);
 242 struct drm_atomic_state *msm_atomic_state_alloc(struct drm_device *dev);
 243 void msm_atomic_state_clear(struct drm_atomic_state *state);
 244 void msm_atomic_state_free(struct drm_atomic_state *state);
 245
 246 int msm_gem_init_vma(struct msm_gem_address_space *aspace,
 247                 struct msm_gem_vma *vma, int npages);
 248 void msm_gem_purge_vma(struct msm_gem_address_space *aspace,
 249                 struct msm_gem_vma *vma);
 250 void msm_gem_unmap_vma(struct msm_gem_address_space *aspace,
 251                 struct msm_gem_vma *vma);
 252 int msm_gem_map_vma(struct msm_gem_address_space *aspace,
 253                 struct msm_gem_vma *vma, struct sg_table *sgt, int npages);
 254 void msm_gem_close_vma(struct msm_gem_address_space *aspace,
 255                 struct msm_gem_vma *vma);
 256
 257 void msm_gem_address_space_put(struct msm_gem_address_space *aspace);
 258
 259 struct msm_gem_address_space *
 260 msm_gem_address_space_create(struct device *dev, struct iommu_domain *domain,
 261                 const char *name);
 262
 263 struct msm_gem_address_space *
 264 msm_gem_address_space_create_a2xx(struct device *dev, struct msm_gpu *gpu,
 265                 const char *name, uint64_t va_start, uint64_t va_end);
 266
 267 int msm_register_mmu(struct drm_device *dev, struct msm_mmu *mmu);
 268 void msm_unregister_mmu(struct drm_device *dev, struct msm_mmu *mmu);
 269
 270 bool msm_use_mmu(struct drm_device *dev);
 271
 272 void msm_gem_submit_free(struct msm_gem_submit *submit);
 273 int msm_ioctl_gem_submit(struct drm_device *dev, void *data,
 274                 struct drm_file *file);
 275
 276 void msm_gem_shrinker_init(struct drm_device *dev);
 277 void msm_gem_shrinker_cleanup(struct drm_device *dev);
 278
 279 int msm_gem_mmap_obj(struct drm_gem_object *obj,
 280                         struct vm_area_struct *vma);
 281 int msm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
 282 vm_fault_t msm_gem_fault(struct vm_fault *vmf);
 283 uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj);
 284 int msm_gem_get_iova(struct drm_gem_object *obj,
 285                 struct msm_gem_address_space *aspace, uint64_t *iova);
 286 int msm_gem_get_and_pin_iova(struct drm_gem_object *obj,
 287                 struct msm_gem_address_space *aspace, uint64_t *iova);
 288 uint64_t msm_gem_iova(struct drm_gem_object *obj,
 289                 struct msm_gem_address_space *aspace);
 290 void msm_gem_unpin_iova(struct drm_gem_object *obj,
 291                 struct msm_gem_address_space *aspace);
 292 struct page **msm_gem_get_pages(struct drm_gem_object *obj);
 293 void msm_gem_put_pages(struct drm_gem_object *obj);
 294 int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
 295                 struct drm_mode_create_dumb *args);
 296 int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
 297                 uint32_t handle, uint64_t *offset);
 298 struct sg_table *msm_gem_prime_get_sg_table(struct drm_gem_object *obj);
 299 void *msm_gem_prime_vmap(struct drm_gem_object *obj);
 300 void msm_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
 301 int msm_gem_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
 302 struct reservation_object *msm_gem_prime_res_obj(struct drm_gem_object *obj);
 303 struct drm_gem_object *msm_gem_prime_import_sg_table(struct drm_device *dev,
 304                 struct dma_buf_attachment *attach, struct sg_table *sg);
 305 int msm_gem_prime_pin(struct drm_gem_object *obj);
 306 void msm_gem_prime_unpin(struct drm_gem_object *obj);
 307 void *msm_gem_get_vaddr(struct drm_gem_object *obj);
 308 void *msm_gem_get_vaddr_active(struct drm_gem_object *obj);
 309 void msm_gem_put_vaddr(struct drm_gem_object *obj);
 310 int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv);
 311 int msm_gem_sync_object(struct drm_gem_object *obj,
 312                 struct msm_fence_context *fctx, bool exclusive);
 313 void msm_gem_move_to_active(struct drm_gem_object *obj,
 314                 struct msm_gpu *gpu, bool exclusive, struct dma_fence *fence);
 315 void msm_gem_move_to_inactive(struct drm_gem_object *obj);
 316 int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout);
 317 int msm_gem_cpu_fini(struct drm_gem_object *obj);
 318 void msm_gem_free_object(struct drm_gem_object *obj);
 319 int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file,
 320                 uint32_t size, uint32_t flags, uint32_t *handle, char *name);
 321 struct drm_gem_object *msm_gem_new(struct drm_device *dev,
 322                 uint32_t size, uint32_t flags);
 323 struct drm_gem_object *msm_gem_new_locked(struct drm_device *dev,
 324                 uint32_t size, uint32_t flags);
 325 void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size,
 326                 uint32_t flags, struct msm_gem_address_space *aspace,
 327                 struct drm_gem_object **bo, uint64_t *iova);
 328 void *msm_gem_kernel_new_locked(struct drm_device *dev, uint32_t size,
 329                 uint32_t flags, struct msm_gem_address_space *aspace,
 330                 struct drm_gem_object **bo, uint64_t *iova);
 331 void msm_gem_kernel_put(struct drm_gem_object *bo,
 332                 struct msm_gem_address_space *aspace, bool locked);
 333 struct drm_gem_object *msm_gem_import(struct drm_device *dev,
 334                 struct dma_buf *dmabuf, struct sg_table *sgt);
 335
 336 void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...);
 337
 338 int msm_framebuffer_prepare(struct drm_framebuffer *fb,
 339                 struct msm_gem_address_space *aspace);
 340 void msm_framebuffer_cleanup(struct drm_framebuffer *fb,
 341                 struct msm_gem_address_space *aspace);
 342 uint32_t msm_framebuffer_iova(struct drm_framebuffer *fb,
 343                 struct msm_gem_address_space *aspace, int plane);
 344 struct drm_gem_object *msm_framebuffer_bo(struct drm_framebuffer *fb, int plane);
 345 const struct msm_format *msm_framebuffer_format(struct drm_framebuffer *fb);
 346 struct drm_framebuffer *msm_framebuffer_create(struct drm_device *dev,
 347                 struct drm_file *file, const struct drm_mode_fb_cmd2 *mode_cmd);
 348 struct drm_framebuffer * msm_alloc_stolen_fb(struct drm_device *dev,
 349                 int w, int h, int p, uint32_t format);
 350
 351 struct drm_fb_helper *msm_fbdev_init(struct drm_device *dev);
 352 void msm_fbdev_free(struct drm_device *dev);
 353
 354 struct hdmi;
 355 int msm_hdmi_modeset_init(struct hdmi *hdmi, struct drm_device *dev,
 356                 struct drm_encoder *encoder);
 357 void __init msm_hdmi_register(void);
 358 void __exit msm_hdmi_unregister(void);
 359
 360 struct msm_edp;
 361 void __init msm_edp_register(void);
 362 void __exit msm_edp_unregister(void);
 363 int msm_edp_modeset_init(struct msm_edp *edp, struct drm_device *dev,
 364                 struct drm_encoder *encoder);
 365
 366 struct msm_dsi;
 367 #ifdef CONFIG_DRM_MSM_DSI
 368 void __init msm_dsi_register(void);
 369 void __exit msm_dsi_unregister(void);
 370 int msm_dsi_modeset_init(struct msm_dsi *msm_dsi, struct drm_device *dev,
 371                          struct drm_encoder *encoder);
 372 #else
 373 static inline void __init msm_dsi_register(void)
 374 {
 375 }
 376 static inline void __exit msm_dsi_unregister(void)
 377 {
 378 }
 379 static inline int msm_dsi_modeset_init(struct msm_dsi *msm_dsi,
 380                                        struct drm_device *dev,
 381                                        struct drm_encoder *encoder)
 382 {
 383         return -EINVAL;
 384 }
 385 #endif
 386
 387 void __init msm_mdp_register(void);
 388 void __exit msm_mdp_unregister(void);
 389 void __init msm_dpu_register(void);
 390 void __exit msm_dpu_unregister(void);
 391
 392 #ifdef CONFIG_DEBUG_FS
 393 void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m);
 394 void msm_gem_describe_objects(struct list_head *list, struct seq_file *m);
 395 void msm_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m);
 396 int msm_debugfs_late_init(struct drm_device *dev);
 397 int msm_rd_debugfs_init(struct drm_minor *minor);
 398 void msm_rd_debugfs_cleanup(struct msm_drm_private *priv);
 399 void msm_rd_dump_submit(struct msm_rd_state *rd, struct msm_gem_submit *submit,
 400                 const char *fmt, ...);
 401 int msm_perf_debugfs_init(struct drm_minor *minor);
 402 void msm_perf_debugfs_cleanup(struct msm_drm_private *priv);
 403 #else
 404 static inline int msm_debugfs_late_init(struct drm_device *dev) { return 0; }
 405 static inline void msm_rd_dump_submit(struct msm_rd_state *rd, struct msm_gem_submit *submit,
 406                 const char *fmt, ...) {}
 407 static inline void msm_rd_debugfs_cleanup(struct msm_drm_private *priv) {}
 408 static inline void msm_perf_debugfs_cleanup(struct msm_drm_private *priv) {}
 409 #endif
 410
 411 struct clk *msm_clk_get(struct platform_device *pdev, const char *name);
 412 int msm_clk_bulk_get(struct device *dev, struct clk_bulk_data **bulk);
 413
 414 struct clk *msm_clk_bulk_get_clock(struct clk_bulk_data *bulk, int count,
 415         const char *name);
 416 void __iomem *msm_ioremap(struct platform_device *pdev, const char *name,
 417                 const char *dbgname);
 418 void msm_writel(u32 data, void __iomem *addr);
 419 u32 msm_readl(const void __iomem *addr);
 420
 421 struct msm_gpu_submitqueue;
 422 int msm_submitqueue_init(struct drm_device *drm, struct msm_file_private *ctx);
 423 struct msm_gpu_submitqueue *msm_submitqueue_get(struct msm_file_private *ctx,
 424                 u32 id);
 425 int msm_submitqueue_create(struct drm_device *drm, struct msm_file_private *ctx,
 426                 u32 prio, u32 flags, u32 *id);
 427 int msm_submitqueue_remove(struct msm_file_private *ctx, u32 id);
 428 void msm_submitqueue_close(struct msm_file_private *ctx);
 429
 430 void msm_submitqueue_destroy(struct kref *kref);
 431
 432
 433 #define DBG(fmt, ...) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
 434 #define VERB(fmt, ...) if (0) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
 435
 436 static inline int align_pitch(int width, int bpp)
 437 {
 438         int bytespp = (bpp + 7) / 8;
 439         /* adreno needs pitch aligned to 32 pixels: */
 440         return bytespp * ALIGN(width, 32);
 441 }
 442
 443 /* for the generated headers: */
 444 #define INVALID_IDX(idx) ({BUG(); 0;})
 445 #define fui(x)                ({BUG(); 0;})
 446 #define util_float_to_half(x) ({BUG(); 0;})
 447
 448
 449 #define FIELD(val, name) (((val) & name ## __MASK) >> name ## __SHIFT)
 450
 451 /* for conditionally setting boolean flag(s): */
 452 #define COND(bool, val) ((bool) ? (val) : 0)
 453
 454 static inline unsigned long timeout_to_jiffies(const ktime_t *timeout)
 455 {
 456         ktime_t now = ktime_get();
 457         unsigned long remaining_jiffies;
 458
 459         if (ktime_compare(*timeout, now) < 0) {
 460                 remaining_jiffies = 0;
 461         } else {
 462                 ktime_t rem = ktime_sub(*timeout, now);
 463                 struct timespec ts = ktime_to_timespec(rem);
 464                 remaining_jiffies = timespec_to_jiffies(&ts);
 465         }
 466
 467         return remaining_jiffies;
 468 }
 469
 470 #endif /* __MSM_DRV_H__ */