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/devfreq.h>
15#include <linux/module.h>
16#include <linux/component.h>
17#include <linux/platform_device.h>
18#include <linux/pm.h>
19#include <linux/pm_runtime.h>
20#include <linux/slab.h>
21#include <linux/list.h>
22#include <linux/iommu.h>
23#include <linux/types.h>
24#include <linux/of_graph.h>
25#include <linux/of_device.h>
26#include <linux/sizes.h>
27#include <linux/kthread.h>
28
29#include <drm/drm_atomic.h>
30#include <drm/drm_atomic_helper.h>
31#include <drm/drm_probe_helper.h>
32#include <drm/display/drm_dsc.h>
33#include <drm/msm_drm.h>
34#include <drm/drm_gem.h>
35
36#ifdef CONFIG_FAULT_INJECTION
37extern struct fault_attr fail_gem_alloc;
38extern struct fault_attr fail_gem_iova;
39#else
40# define should_fail(attr, size) 0
41#endif
42
43struct msm_kms;
44struct msm_gpu;
45struct msm_mmu;
46struct msm_mdss;
47struct msm_rd_state;
48struct msm_perf_state;
49struct msm_gem_submit;
50struct msm_fence_context;
51struct msm_gem_address_space;
52struct msm_gem_vma;
53struct msm_disp_state;
54
55#define MAX_CRTCS 8
56#define MAX_BRIDGES 8
57
58#define FRAC_16_16(mult, div) (((mult) << 16) / (div))
59
60enum msm_dp_controller {
61 MSM_DP_CONTROLLER_0,
62 MSM_DP_CONTROLLER_1,
63 MSM_DP_CONTROLLER_2,
64 MSM_DP_CONTROLLER_3,
65 MSM_DP_CONTROLLER_COUNT,
66};
67
68enum msm_dsi_controller {
69 MSM_DSI_CONTROLLER_0,
70 MSM_DSI_CONTROLLER_1,
71 MSM_DSI_CONTROLLER_COUNT,
72};
73
74#define MSM_GPU_MAX_RINGS 4
75#define MAX_H_TILES_PER_DISPLAY 2
76
77/**
78 * struct msm_display_topology - defines a display topology pipeline
79 * @num_lm: number of layer mixers used
80 * @num_intf: number of interfaces the panel is mounted on
81 * @num_dspp: number of dspp blocks used
82 * @num_dsc: number of Display Stream Compression (DSC) blocks used
83 * @needs_cdm: indicates whether cdm block is needed for this display topology
84 */
85struct msm_display_topology {
86 u32 num_lm;
87 u32 num_intf;
88 u32 num_dspp;
89 u32 num_dsc;
90 bool needs_cdm;
91};
92
93/* Commit/Event thread specific structure */
94struct msm_drm_thread {
95 struct drm_device *dev;
96 struct kthread_worker *worker;
97};
98
99struct msm_drm_private {
100
101 struct drm_device *dev;
102
103 struct msm_kms *kms;
104 int (*kms_init)(struct drm_device *dev);
105
106 /* subordinate devices, if present: */
107 struct platform_device *gpu_pdev;
108
109 /* possibly this should be in the kms component, but it is
110 * shared by both mdp4 and mdp5..
111 */
112 struct hdmi *hdmi;
113
114 /* DSI is shared by mdp4 and mdp5 */
115 struct msm_dsi *dsi[MSM_DSI_CONTROLLER_COUNT];
116
117 struct msm_dp *dp[MSM_DP_CONTROLLER_COUNT];
118
119 /* when we have more than one 'msm_gpu' these need to be an array: */
120 struct msm_gpu *gpu;
121
122 /* gpu is only set on open(), but we need this info earlier */
123 bool is_a2xx;
124 bool has_cached_coherent;
125
126 struct msm_rd_state *rd; /* debugfs to dump all submits */
127 struct msm_rd_state *hangrd; /* debugfs to dump hanging submits */
128 struct msm_perf_state *perf;
129
130 /**
131 * List of all GEM objects (mainly for debugfs, protected by obj_lock
132 * (acquire before per GEM object lock)
133 */
134 struct list_head objects;
135 struct mutex obj_lock;
136
137 /**
138 * lru:
139 *
140 * The various LRU's that a GEM object is in at various stages of
141 * it's lifetime. Objects start out in the unbacked LRU. When
142 * pinned (for scannout or permanently mapped GPU buffers, like
143 * ringbuffer, memptr, fw, etc) it moves to the pinned LRU. When
144 * unpinned, it moves into willneed or dontneed LRU depending on
145 * madvise state. When backing pages are evicted (willneed) or
146 * purged (dontneed) it moves back into the unbacked LRU.
147 *
148 * The dontneed LRU is considered by the shrinker for objects
149 * that are candidate for purging, and the willneed LRU is
150 * considered for objects that could be evicted.
151 */
152 struct {
153 /**
154 * unbacked:
155 *
156 * The LRU for GEM objects without backing pages allocated.
157 * This mostly exists so that objects are always is one
158 * LRU.
159 */
160 struct drm_gem_lru unbacked;
161
162 /**
163 * pinned:
164 *
165 * The LRU for pinned GEM objects
166 */
167 struct drm_gem_lru pinned;
168
169 /**
170 * willneed:
171 *
172 * The LRU for unpinned GEM objects which are in madvise
173 * WILLNEED state (ie. can be evicted)
174 */
175 struct drm_gem_lru willneed;
176
177 /**
178 * dontneed:
179 *
180 * The LRU for unpinned GEM objects which are in madvise
181 * DONTNEED state (ie. can be purged)
182 */
183 struct drm_gem_lru dontneed;
184
185 /**
186 * lock:
187 *
188 * Protects manipulation of all of the LRUs.
189 */
190 struct mutex lock;
191 } lru;
192
193 struct workqueue_struct *wq;
194
195 unsigned int num_crtcs;
196
197 struct msm_drm_thread event_thread[MAX_CRTCS];
198
199 /* VRAM carveout, used when no IOMMU: */
200 struct {
201 unsigned long size;
202 dma_addr_t paddr;
203 /* NOTE: mm managed at the page level, size is in # of pages
204 * and position mm_node->start is in # of pages:
205 */
206 struct drm_mm mm;
207 spinlock_t lock; /* Protects drm_mm node allocation/removal */
208 } vram;
209
210 struct notifier_block vmap_notifier;
211 struct shrinker *shrinker;
212
213 struct drm_atomic_state *pm_state;
214
215 /**
216 * hangcheck_period: For hang detection, in ms
217 *
218 * Note that in practice, a submit/job will get at least two hangcheck
219 * periods, due to checking for progress being implemented as simply
220 * "have the CP position registers changed since last time?"
221 */
222 unsigned int hangcheck_period;
223
224 /** gpu_devfreq_config: Devfreq tuning config for the GPU. */
225 struct devfreq_simple_ondemand_data gpu_devfreq_config;
226
227 /**
228 * gpu_clamp_to_idle: Enable clamping to idle freq when inactive
229 */
230 bool gpu_clamp_to_idle;
231
232 /**
233 * disable_err_irq:
234 *
235 * Disable handling of GPU hw error interrupts, to force fallback to
236 * sw hangcheck timer. Written (via debugfs) by igt tests to test
237 * the sw hangcheck mechanism.
238 */
239 bool disable_err_irq;
240};
241
242struct msm_format {
243 uint32_t pixel_format;
244};
245
246struct msm_pending_timer;
247
248int msm_atomic_init_pending_timer(struct msm_pending_timer *timer,
249 struct msm_kms *kms, int crtc_idx);
250void msm_atomic_destroy_pending_timer(struct msm_pending_timer *timer);
251void msm_atomic_commit_tail(struct drm_atomic_state *state);
252int msm_atomic_check(struct drm_device *dev, struct drm_atomic_state *state);
253struct drm_atomic_state *msm_atomic_state_alloc(struct drm_device *dev);
254void msm_atomic_state_clear(struct drm_atomic_state *state);
255void msm_atomic_state_free(struct drm_atomic_state *state);
256
257int msm_crtc_enable_vblank(struct drm_crtc *crtc);
258void msm_crtc_disable_vblank(struct drm_crtc *crtc);
259
260int msm_register_mmu(struct drm_device *dev, struct msm_mmu *mmu);
261void msm_unregister_mmu(struct drm_device *dev, struct msm_mmu *mmu);
262
263struct msm_gem_address_space *msm_kms_init_aspace(struct drm_device *dev);
264bool msm_use_mmu(struct drm_device *dev);
265
266int msm_ioctl_gem_submit(struct drm_device *dev, void *data,
267 struct drm_file *file);
268
269#ifdef CONFIG_DEBUG_FS
270unsigned long msm_gem_shrinker_shrink(struct drm_device *dev, unsigned long nr_to_scan);
271#endif
272
273int msm_gem_shrinker_init(struct drm_device *dev);
274void msm_gem_shrinker_cleanup(struct drm_device *dev);
275
276struct sg_table *msm_gem_prime_get_sg_table(struct drm_gem_object *obj);
277int msm_gem_prime_vmap(struct drm_gem_object *obj, struct iosys_map *map);
278void msm_gem_prime_vunmap(struct drm_gem_object *obj, struct iosys_map *map);
279struct drm_gem_object *msm_gem_prime_import_sg_table(struct drm_device *dev,
280 struct dma_buf_attachment *attach, struct sg_table *sg);
281int msm_gem_prime_pin(struct drm_gem_object *obj);
282void msm_gem_prime_unpin(struct drm_gem_object *obj);
283
284int msm_framebuffer_prepare(struct drm_framebuffer *fb,
285 struct msm_gem_address_space *aspace, bool needs_dirtyfb);
286void msm_framebuffer_cleanup(struct drm_framebuffer *fb,
287 struct msm_gem_address_space *aspace, bool needed_dirtyfb);
288uint32_t msm_framebuffer_iova(struct drm_framebuffer *fb,
289 struct msm_gem_address_space *aspace, int plane);
290struct drm_gem_object *msm_framebuffer_bo(struct drm_framebuffer *fb, int plane);
291const struct msm_format *msm_framebuffer_format(struct drm_framebuffer *fb);
292struct drm_framebuffer *msm_framebuffer_create(struct drm_device *dev,
293 struct drm_file *file, const struct drm_mode_fb_cmd2 *mode_cmd);
294struct drm_framebuffer * msm_alloc_stolen_fb(struct drm_device *dev,
295 int w, int h, int p, uint32_t format);
296
297#ifdef CONFIG_DRM_FBDEV_EMULATION
298void msm_fbdev_setup(struct drm_device *dev);
299#else
300static inline void msm_fbdev_setup(struct drm_device *dev)
301{
302}
303#endif
304
305struct hdmi;
306#ifdef CONFIG_DRM_MSM_HDMI
307int msm_hdmi_modeset_init(struct hdmi *hdmi, struct drm_device *dev,
308 struct drm_encoder *encoder);
309void __init msm_hdmi_register(void);
310void __exit msm_hdmi_unregister(void);
311#else
312static inline int msm_hdmi_modeset_init(struct hdmi *hdmi, struct drm_device *dev,
313 struct drm_encoder *encoder)
314{
315 return -EINVAL;
316}
317static inline void __init msm_hdmi_register(void) {}
318static inline void __exit msm_hdmi_unregister(void) {}
319#endif
320
321struct msm_dsi;
322#ifdef CONFIG_DRM_MSM_DSI
323int dsi_dev_attach(struct platform_device *pdev);
324void dsi_dev_detach(struct platform_device *pdev);
325void __init msm_dsi_register(void);
326void __exit msm_dsi_unregister(void);
327int msm_dsi_modeset_init(struct msm_dsi *msm_dsi, struct drm_device *dev,
328 struct drm_encoder *encoder);
329void msm_dsi_snapshot(struct msm_disp_state *disp_state, struct msm_dsi *msm_dsi);
330bool msm_dsi_is_cmd_mode(struct msm_dsi *msm_dsi);
331bool msm_dsi_is_bonded_dsi(struct msm_dsi *msm_dsi);
332bool msm_dsi_is_master_dsi(struct msm_dsi *msm_dsi);
333bool msm_dsi_wide_bus_enabled(struct msm_dsi *msm_dsi);
334struct drm_dsc_config *msm_dsi_get_dsc_config(struct msm_dsi *msm_dsi);
335#else
336static inline void __init msm_dsi_register(void)
337{
338}
339static inline void __exit msm_dsi_unregister(void)
340{
341}
342static inline int msm_dsi_modeset_init(struct msm_dsi *msm_dsi,
343 struct drm_device *dev,
344 struct drm_encoder *encoder)
345{
346 return -EINVAL;
347}
348static inline void msm_dsi_snapshot(struct msm_disp_state *disp_state, struct msm_dsi *msm_dsi)
349{
350}
351static inline bool msm_dsi_is_cmd_mode(struct msm_dsi *msm_dsi)
352{
353 return false;
354}
355static inline bool msm_dsi_is_bonded_dsi(struct msm_dsi *msm_dsi)
356{
357 return false;
358}
359static inline bool msm_dsi_is_master_dsi(struct msm_dsi *msm_dsi)
360{
361 return false;
362}
363static inline bool msm_dsi_wide_bus_enabled(struct msm_dsi *msm_dsi)
364{
365 return false;
366}
367
368static inline struct drm_dsc_config *msm_dsi_get_dsc_config(struct msm_dsi *msm_dsi)
369{
370 return NULL;
371}
372#endif
373
374#ifdef CONFIG_DRM_MSM_DP
375int __init msm_dp_register(void);
376void __exit msm_dp_unregister(void);
377int msm_dp_modeset_init(struct msm_dp *dp_display, struct drm_device *dev,
378 struct drm_encoder *encoder, bool yuv_supported);
379void msm_dp_snapshot(struct msm_disp_state *disp_state, struct msm_dp *dp_display);
380bool msm_dp_is_yuv_420_enabled(const struct msm_dp *dp_display,
381 const struct drm_display_mode *mode);
382bool msm_dp_needs_periph_flush(const struct msm_dp *dp_display,
383 const struct drm_display_mode *mode);
384bool msm_dp_wide_bus_available(const struct msm_dp *dp_display);
385
386#else
387static inline int __init msm_dp_register(void)
388{
389 return -EINVAL;
390}
391static inline void __exit msm_dp_unregister(void)
392{
393}
394static inline int msm_dp_modeset_init(struct msm_dp *dp_display,
395 struct drm_device *dev,
396 struct drm_encoder *encoder,
397 bool yuv_supported)
398{
399 return -EINVAL;
400}
401
402static inline void msm_dp_snapshot(struct msm_disp_state *disp_state, struct msm_dp *dp_display)
403{
404}
405
406static inline bool msm_dp_is_yuv_420_enabled(const struct msm_dp *dp_display,
407 const struct drm_display_mode *mode)
408{
409 return false;
410}
411
412static inline bool msm_dp_needs_periph_flush(const struct msm_dp *dp_display,
413 const struct drm_display_mode *mode)
414{
415 return false;
416}
417
418static inline bool msm_dp_wide_bus_available(const struct msm_dp *dp_display)
419{
420 return false;
421}
422
423#endif
424
425#ifdef CONFIG_DRM_MSM_MDP4
426void msm_mdp4_register(void);
427void msm_mdp4_unregister(void);
428#else
429static inline void msm_mdp4_register(void) {}
430static inline void msm_mdp4_unregister(void) {}
431#endif
432
433#ifdef CONFIG_DRM_MSM_MDP5
434void msm_mdp_register(void);
435void msm_mdp_unregister(void);
436#else
437static inline void msm_mdp_register(void) {}
438static inline void msm_mdp_unregister(void) {}
439#endif
440
441#ifdef CONFIG_DRM_MSM_DPU
442void msm_dpu_register(void);
443void msm_dpu_unregister(void);
444#else
445static inline void msm_dpu_register(void) {}
446static inline void msm_dpu_unregister(void) {}
447#endif
448
449#ifdef CONFIG_DRM_MSM_MDSS
450void msm_mdss_register(void);
451void msm_mdss_unregister(void);
452#else
453static inline void msm_mdss_register(void) {}
454static inline void msm_mdss_unregister(void) {}
455#endif
456
457#ifdef CONFIG_DEBUG_FS
458void msm_framebuffer_describe(struct drm_framebuffer *fb, struct seq_file *m);
459int msm_debugfs_late_init(struct drm_device *dev);
460int msm_rd_debugfs_init(struct drm_minor *minor);
461void msm_rd_debugfs_cleanup(struct msm_drm_private *priv);
462__printf(3, 4)
463void msm_rd_dump_submit(struct msm_rd_state *rd, struct msm_gem_submit *submit,
464 const char *fmt, ...);
465int msm_perf_debugfs_init(struct drm_minor *minor);
466void msm_perf_debugfs_cleanup(struct msm_drm_private *priv);
467#else
468static inline int msm_debugfs_late_init(struct drm_device *dev) { return 0; }
469__printf(3, 4)
470static inline void msm_rd_dump_submit(struct msm_rd_state *rd,
471 struct msm_gem_submit *submit,
472 const char *fmt, ...) {}
473static inline void msm_rd_debugfs_cleanup(struct msm_drm_private *priv) {}
474static inline void msm_perf_debugfs_cleanup(struct msm_drm_private *priv) {}
475#endif
476
477struct clk *msm_clk_get(struct platform_device *pdev, const char *name);
478
479struct clk *msm_clk_bulk_get_clock(struct clk_bulk_data *bulk, int count,
480 const char *name);
481void __iomem *msm_ioremap(struct platform_device *pdev, const char *name);
482void __iomem *msm_ioremap_size(struct platform_device *pdev, const char *name,
483 phys_addr_t *size);
484void __iomem *msm_ioremap_quiet(struct platform_device *pdev, const char *name);
485void __iomem *msm_ioremap_mdss(struct platform_device *mdss_pdev,
486 struct platform_device *dev,
487 const char *name);
488
489struct icc_path *msm_icc_get(struct device *dev, const char *name);
490
491#define msm_writel(data, addr) writel((data), (addr))
492#define msm_readl(addr) readl((addr))
493
494static inline void msm_rmw(void __iomem *addr, u32 mask, u32 or)
495{
496 u32 val = msm_readl(addr);
497
498 val &= ~mask;
499 msm_writel(val | or, addr);
500}
501
502/**
503 * struct msm_hrtimer_work - a helper to combine an hrtimer with kthread_work
504 *
505 * @timer: hrtimer to control when the kthread work is triggered
506 * @work: the kthread work
507 * @worker: the kthread worker the work will be scheduled on
508 */
509struct msm_hrtimer_work {
510 struct hrtimer timer;
511 struct kthread_work work;
512 struct kthread_worker *worker;
513};
514
515void msm_hrtimer_queue_work(struct msm_hrtimer_work *work,
516 ktime_t wakeup_time,
517 enum hrtimer_mode mode);
518void msm_hrtimer_work_init(struct msm_hrtimer_work *work,
519 struct kthread_worker *worker,
520 kthread_work_func_t fn,
521 clockid_t clock_id,
522 enum hrtimer_mode mode);
523
524#define DBG(fmt, ...) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
525#define VERB(fmt, ...) if (0) DRM_DEBUG_DRIVER(fmt"\n", ##__VA_ARGS__)
526
527static inline int align_pitch(int width, int bpp)
528{
529 int bytespp = (bpp + 7) / 8;
530 /* adreno needs pitch aligned to 32 pixels: */
531 return bytespp * ALIGN(width, 32);
532}
533
534/* for the generated headers: */
535#define INVALID_IDX(idx) ({BUG(); 0;})
536#define fui(x) ({BUG(); 0;})
537#define _mesa_float_to_half(x) ({BUG(); 0;})
538
539
540#define FIELD(val, name) (((val) & name ## __MASK) >> name ## __SHIFT)
541
542/* for conditionally setting boolean flag(s): */
543#define COND(bool, val) ((bool) ? (val) : 0)
544
545static inline unsigned long timeout_to_jiffies(const ktime_t *timeout)
546{
547 ktime_t now = ktime_get();
548 s64 remaining_jiffies;
549
550 if (ktime_compare(cmp1: *timeout, cmp2: now) < 0) {
551 remaining_jiffies = 0;
552 } else {
553 ktime_t rem = ktime_sub(*timeout, now);
554 remaining_jiffies = ktime_divns(kt: rem, NSEC_PER_SEC / HZ);
555 }
556
557 return clamp(remaining_jiffies, 1LL, (s64)INT_MAX);
558}
559
560/* Driver helpers */
561
562extern const struct component_master_ops msm_drm_ops;
563
564int msm_kms_pm_prepare(struct device *dev);
565void msm_kms_pm_complete(struct device *dev);
566
567int msm_drv_probe(struct device *dev,
568 int (*kms_init)(struct drm_device *dev),
569 struct msm_kms *kms);
570void msm_kms_shutdown(struct platform_device *pdev);
571
572bool msm_disp_drv_should_bind(struct device *dev, bool dpu_driver);
573
574#endif /* __MSM_DRV_H__ */
575

source code of linux/drivers/gpu/drm/msm/msm_drv.h