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 <[email protected]>
   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 <linux/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_plane_helper.h>
  43 #include <drm/drm_probe_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 #define MSM_GPU_MAX_RINGS 4
  81 #define MAX_H_TILES_PER_DISPLAY 2
  82
  83 /**
  84  * enum msm_display_caps - features/capabilities supported by displays
  85  * @MSM_DISPLAY_CAP_VID_MODE:           Video or "active" mode supported
  86  * @MSM_DISPLAY_CAP_CMD_MODE:           Command mode supported
  87  * @MSM_DISPLAY_CAP_HOT_PLUG:           Hot plug detection supported
  88  * @MSM_DISPLAY_CAP_EDID:               EDID supported
  89  */
  90 enum msm_display_caps {
  91         MSM_DISPLAY_CAP_VID_MODE        = BIT(0),
  92         MSM_DISPLAY_CAP_CMD_MODE        = BIT(1),
  93         MSM_DISPLAY_CAP_HOT_PLUG        = BIT(2),
  94         MSM_DISPLAY_CAP_EDID            = BIT(3),
  95 };
  96
  97 /**
  98  * enum msm_event_wait - type of HW events to wait for
  99  * @MSM_ENC_COMMIT_DONE - wait for the driver to flush the registers to HW
 100  * @MSM_ENC_TX_COMPLETE - wait for the HW to transfer the frame to panel
 101  * @MSM_ENC_VBLANK - wait for the HW VBLANK event (for driver-internal waiters)
 102  */
 103 enum msm_event_wait {
 104         MSM_ENC_COMMIT_DONE = 0,
 105         MSM_ENC_TX_COMPLETE,
 106         MSM_ENC_VBLANK,
 107 };
 108
 109 /**
 110  * struct msm_display_topology - defines a display topology pipeline
 111  * @num_lm:       number of layer mixers used
 112  * @num_enc:      number of compression encoder blocks used
 113  * @num_intf:     number of interfaces the panel is mounted on
 114  */
 115 struct msm_display_topology {
 116         u32 num_lm;
 117         u32 num_enc;
 118         u32 num_intf;
 119 };
 120
 121 /**
 122  * struct msm_display_info - defines display properties
 123  * @intf_type:          DRM_MODE_ENCODER_ type
 124  * @capabilities:       Bitmask of display flags
 125  * @num_of_h_tiles:     Number of horizontal tiles in case of split interface
 126  * @h_tile_instance:    Controller instance used per tile. Number of elements is
 127  *                      based on num_of_h_tiles
 128  * @is_te_using_watchdog_timer:  Boolean to indicate watchdog TE is
 129  *                               used instead of panel TE in cmd mode panels
 130  */
 131 struct msm_display_info {
 132         int intf_type;
 133         uint32_t capabilities;
 134         uint32_t num_of_h_tiles;
 135         uint32_t h_tile_instance[MAX_H_TILES_PER_DISPLAY];
 136         bool is_te_using_watchdog_timer;
 137 };
 138
 139 /* Commit/Event thread specific structure */
 140 struct msm_drm_thread {
 141         struct drm_device *dev;
 142         struct task_struct *thread;
 143         unsigned int crtc_id;
 144         struct kthread_worker worker;
 145 };
 146
 147 struct msm_drm_private {
 148
 149         struct drm_device *dev;
 150
 151         struct msm_kms *kms;
 152
 153         /* subordinate devices, if present: */
 154         struct platform_device *gpu_pdev;
 155
 156         /* top level MDSS wrapper device (for MDP5/DPU only) */
 157         struct msm_mdss *mdss;
 158
 159         /* possibly this should be in the kms component, but it is
 160          * shared by both mdp4 and mdp5..
 161          */
 162         struct hdmi *hdmi;
 163
 164         /* eDP is for mdp5 only, but kms has not been created
 165          * when edp_bind() and edp_init() are called. Here is the only
 166          * place to keep the edp instance.
 167          */
 168         struct msm_edp *edp;
 169
 170         /* DSI is shared by mdp4 and mdp5 */
 171         struct msm_dsi *dsi[2];
 172
 173         /* when we have more than one 'msm_gpu' these need to be an array: */
 174         struct msm_gpu *gpu;
 175         struct msm_file_private *lastctx;
 176         /* gpu is only set on open(), but we need this info earlier */
 177         bool is_a2xx;
 178
 179         struct drm_fb_helper *fbdev;
 180
 181         struct msm_rd_state *rd;       /* debugfs to dump all submits */
 182         struct msm_rd_state *hangrd;   /* debugfs to dump hanging submits */
 183         struct msm_perf_state *perf;
 184
 185         /* list of GEM objects: */
 186         struct list_head inactive_list;
 187
 188         /* worker for delayed free of objects: */
 189         struct work_struct free_work;
 190         struct llist_head free_list;
 191
 192         struct workqueue_struct *wq;
 193
 194         unsigned int num_planes;
 195         struct drm_plane *planes[MAX_PLANES];
 196
 197         unsigned int num_crtcs;
 198         struct drm_crtc *crtcs[MAX_CRTCS];
 199
 200         struct msm_drm_thread event_thread[MAX_CRTCS];
 201
 202         unsigned int num_encoders;
 203         struct drm_encoder *encoders[MAX_ENCODERS];
 204
 205         unsigned int num_bridges;
 206         struct drm_bridge *bridges[MAX_BRIDGES];
 207
 208         unsigned int num_connectors;
 209         struct drm_connector *connectors[MAX_CONNECTORS];
 210
 211         /* Properties */
 212         struct drm_property *plane_property[PLANE_PROP_MAX_NUM];
 213
 214         /* VRAM carveout, used when no IOMMU: */
 215         struct {
 216                 unsigned long size;
 217                 dma_addr_t paddr;
 218                 /* NOTE: mm managed at the page level, size is in # of pages
 219                  * and position mm_node->start is in # of pages:
 220                  */
 221                 struct drm_mm mm;
 222                 spinlock_t lock; /* Protects drm_mm node allocation/removal */
 223         } vram;
 224
 225         struct notifier_block vmap_notifier;
 226         struct shrinker shrinker;
 227
 228         struct drm_atomic_state *pm_state;
 229 };
 230
 231 struct msm_format {
 232         uint32_t pixel_format;
 233 };
 234
 235 int msm_atomic_prepare_fb(struct drm_plane *plane,
 236                           struct drm_plane_state *new_state);
 237 void msm_atomic_commit_tail(struct drm_atomic_state *state);
 238 struct drm_atomic_state *msm_atomic_state_alloc(struct drm_device *dev);
 239 void msm_atomic_state_clear(struct drm_atomic_state *state);
 240 void msm_atomic_state_free(struct drm_atomic_state *state);
 241
 242 int msm_gem_init_vma(struct msm_gem_address_space *aspace,
 243                 struct msm_gem_vma *vma, int npages);
 244 void msm_gem_purge_vma(struct msm_gem_address_space *aspace,
 245                 struct msm_gem_vma *vma);
 246 void msm_gem_unmap_vma(struct msm_gem_address_space *aspace,
 247                 struct msm_gem_vma *vma);
 248 int msm_gem_map_vma(struct msm_gem_address_space *aspace,
 249                 struct msm_gem_vma *vma, int prot,
 250                 struct sg_table *sgt, int npages);
 251 void msm_gem_close_vma(struct msm_gem_address_space *aspace,
 252                 struct msm_gem_vma *vma);
 253
 254 void msm_gem_address_space_put(struct msm_gem_address_space *aspace);
 255
 256 struct msm_gem_address_space *
 257 msm_gem_address_space_create(struct device *dev, struct iommu_domain *domain,
 258                 const char *name);
 259
 260 struct msm_gem_address_space *
 261 msm_gem_address_space_create_a2xx(struct device *dev, struct msm_gpu *gpu,
 262                 const char *name, uint64_t va_start, uint64_t va_end);
 263
 264 int msm_register_mmu(struct drm_device *dev, struct msm_mmu *mmu);
 265 void msm_unregister_mmu(struct drm_device *dev, struct msm_mmu *mmu);
 266
 267 bool msm_use_mmu(struct drm_device *dev);
 268
 269 void msm_gem_submit_free(struct msm_gem_submit *submit);
 270 int msm_ioctl_gem_submit(struct drm_device *dev, void *data,
 271                 struct drm_file *file);
 272
 273 void msm_gem_shrinker_init(struct drm_device *dev);
 274 void msm_gem_shrinker_cleanup(struct drm_device *dev);
 275
 276 int msm_gem_mmap_obj(struct drm_gem_object *obj,
 277                         struct vm_area_struct *vma);
 278 int msm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
 279 vm_fault_t msm_gem_fault(struct vm_fault *vmf);
 280 uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj);
 281 int msm_gem_get_iova(struct drm_gem_object *obj,
 282                 struct msm_gem_address_space *aspace, uint64_t *iova);
 283 int msm_gem_get_and_pin_iova(struct drm_gem_object *obj,
 284                 struct msm_gem_address_space *aspace, uint64_t *iova);
 285 uint64_t msm_gem_iova(struct drm_gem_object *obj,
 286                 struct msm_gem_address_space *aspace);
 287 void msm_gem_unpin_iova(struct drm_gem_object *obj,
 288                 struct msm_gem_address_space *aspace);
 289 struct page **msm_gem_get_pages(struct drm_gem_object *obj);
 290 void msm_gem_put_pages(struct drm_gem_object *obj);
 291 int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
 292                 struct drm_mode_create_dumb *args);
 293 int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
 294                 uint32_t handle, uint64_t *offset);
 295 struct sg_table *msm_gem_prime_get_sg_table(struct drm_gem_object *obj);
 296 void *msm_gem_prime_vmap(struct drm_gem_object *obj);
 297 void msm_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
 298 int msm_gem_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
 299 struct drm_gem_object *msm_gem_prime_import_sg_table(struct drm_device *dev,
 300                 struct dma_buf_attachment *attach, struct sg_table *sg);
 301 int msm_gem_prime_pin(struct drm_gem_object *obj);
 302 void msm_gem_prime_unpin(struct drm_gem_object *obj);
 303 void *msm_gem_get_vaddr(struct drm_gem_object *obj);
 304 void *msm_gem_get_vaddr_active(struct drm_gem_object *obj);
 305 void msm_gem_put_vaddr(struct drm_gem_object *obj);
 306 int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv);
 307 int msm_gem_sync_object(struct drm_gem_object *obj,
 308                 struct msm_fence_context *fctx, bool exclusive);
 309 void msm_gem_move_to_active(struct drm_gem_object *obj,
 310                 struct msm_gpu *gpu, bool exclusive, struct dma_fence *fence);
 311 void msm_gem_move_to_inactive(struct drm_gem_object *obj);
 312 int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout);
 313 int msm_gem_cpu_fini(struct drm_gem_object *obj);
 314 void msm_gem_free_object(struct drm_gem_object *obj);
 315 int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file,
 316                 uint32_t size, uint32_t flags, uint32_t *handle, char *name);
 317 struct drm_gem_object *msm_gem_new(struct drm_device *dev,
 318                 uint32_t size, uint32_t flags);
 319 struct drm_gem_object *msm_gem_new_locked(struct drm_device *dev,
 320                 uint32_t size, uint32_t flags);
 321 void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size,
 322                 uint32_t flags, struct msm_gem_address_space *aspace,
 323                 struct drm_gem_object **bo, uint64_t *iova);
 324 void *msm_gem_kernel_new_locked(struct drm_device *dev, uint32_t size,
 325                 uint32_t flags, struct msm_gem_address_space *aspace,
 326                 struct drm_gem_object **bo, uint64_t *iova);
 327 void msm_gem_kernel_put(struct drm_gem_object *bo,
 328                 struct msm_gem_address_space *aspace, bool locked);
 329 struct drm_gem_object *msm_gem_import(struct drm_device *dev,
 330                 struct dma_buf *dmabuf, struct sg_table *sgt);
 331 void msm_gem_free_work(struct work_struct *work);
 332
 333 __printf(2, 3)
 334 void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...);
 335
 336 int msm_framebuffer_prepare(struct drm_framebuffer *fb,
 337                 struct msm_gem_address_space *aspace);
 338 void msm_framebuffer_cleanup(struct drm_framebuffer *fb,
 339                 struct msm_gem_address_space *aspace);
 340 uint32_t msm_framebuffer_iova(struct drm_framebuffer *fb,
 341                 struct msm_gem_address_space *aspace, int plane);
 342 struct drm_gem_object *msm_framebuffer_bo(struct drm_framebuffer *fb, int plane);
 343 const struct msm_format *msm_framebuffer_format(struct drm_framebuffer *fb);
 344 struct drm_framebuffer *msm_framebuffer_create(struct drm_device *dev,
 345                 struct drm_file *file, const struct drm_mode_fb_cmd2 *mode_cmd);
 346 struct drm_framebuffer * msm_alloc_stolen_fb(struct drm_device *dev,
 347                 int w, int h, int p, uint32_t format);
 348
 349 struct drm_fb_helper *msm_fbdev_init(struct drm_device *dev);
 350 void msm_fbdev_free(struct drm_device *dev);
 351
 352 struct hdmi;
 353 int msm_hdmi_modeset_init(struct hdmi *hdmi, struct drm_device *dev,
 354                 struct drm_encoder *encoder);
 355 void __init msm_hdmi_register(void);
 356 void __exit msm_hdmi_unregister(void);
 357
 358 struct msm_edp;
 359 void __init msm_edp_register(void);
 360 void __exit msm_edp_unregister(void);
 361 int msm_edp_modeset_init(struct msm_edp *edp, struct drm_device *dev,
 362                 struct drm_encoder *encoder);
 363
 364 struct msm_dsi;
 365 #ifdef CONFIG_DRM_MSM_DSI
 366 void __init msm_dsi_register(void);
 367 void __exit msm_dsi_unregister(void);
 368 int msm_dsi_modeset_init(struct msm_dsi *msm_dsi, struct drm_device *dev,
 369                          struct drm_encoder *encoder);
 370 #else
 371 static inline void __init msm_dsi_register(void)
 372 {
 373 }
 374 static inline void __exit msm_dsi_unregister(void)
 375 {
 376 }
 377 static inline int msm_dsi_modeset_init(struct msm_dsi *msm_dsi,
 378                                        struct drm_device *dev,
 379                                        struct drm_encoder *encoder)
 380 {
 381         return -EINVAL;
 382 }
 383 #endif
 384
 385 void __init msm_mdp_register(void);
 386 void __exit msm_mdp_unregister(void);
 387 void __init msm_dpu_register(void);
 388 void __exit msm_dpu_unregister(void);
 389
 390 #ifdef CONFIG_DEBUG_FS
 391 void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m);
 392 void msm_gem_describe_objects(struct list_head *list, struct seq_file *m);
 393 void msm_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m);
 394 int msm_debugfs_late_init(struct drm_device *dev);
 395 int msm_rd_debugfs_init(struct drm_minor *minor);
 396 void msm_rd_debugfs_cleanup(struct msm_drm_private *priv);
 397 __printf(3, 4)
 398 void msm_rd_dump_submit(struct msm_rd_state *rd, struct msm_gem_submit *submit,
 399                 const char *fmt, ...);
 400 int msm_perf_debugfs_init(struct drm_minor *minor);
 401 void msm_perf_debugfs_cleanup(struct msm_drm_private *priv);
 402 #else
 403 static inline int msm_debugfs_late_init(struct drm_device *dev) { return 0; }
 404 __printf(3, 4)
 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_query(struct drm_device *drm, struct msm_file_private *ctx,
 428                 struct drm_msm_submitqueue_query *args);
 429 int msm_submitqueue_remove(struct msm_file_private *ctx, u32 id);
 430 void msm_submitqueue_close(struct msm_file_private *ctx);
 431
 432 void msm_submitqueue_destroy(struct kref *kref);
 433
 434
 435 #define DBG(fmt, ...) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
 436 #define VERB(fmt, ...) if (0) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
 437
 438 static inline int align_pitch(int width, int bpp)
 439 {
 440         int bytespp = (bpp + 7) / 8;
 441         /* adreno needs pitch aligned to 32 pixels: */
 442         return bytespp * ALIGN(width, 32);
 443 }
 444
 445 /* for the generated headers: */
 446 #define INVALID_IDX(idx) ({BUG(); 0;})
 447 #define fui(x)                ({BUG(); 0;})
 448 #define util_float_to_half(x) ({BUG(); 0;})
 449
 450
 451 #define FIELD(val, name) (((val) & name ## __MASK) >> name ## __SHIFT)
 452
 453 /* for conditionally setting boolean flag(s): */
 454 #define COND(bool, val) ((bool) ? (val) : 0)
 455
 456 static inline unsigned long timeout_to_jiffies(const ktime_t *timeout)
 457 {
 458         ktime_t now = ktime_get();
 459         unsigned long remaining_jiffies;
 460
 461         if (ktime_compare(*timeout, now) < 0) {
 462                 remaining_jiffies = 0;
 463         } else {
 464                 ktime_t rem = ktime_sub(*timeout, now);
 465                 struct timespec ts = ktime_to_timespec(rem);
 466                 remaining_jiffies = timespec_to_jiffies(&ts);
 467         }
 468
 469         return remaining_jiffies;
 470 }
 471
 472 #endif /* __MSM_DRV_H__ */