xref: /openbmc/linux/drivers/gpu/drm/msm/msm_gpu.h (revision 4f3db074)
1 /*
2  * Copyright (C) 2013 Red Hat
3  * Author: Rob Clark <robdclark@gmail.com>
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 as published by
7  * the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * You should have received a copy of the GNU General Public License along with
15  * this program.  If not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef __MSM_GPU_H__
19 #define __MSM_GPU_H__
20 
21 #include <linux/clk.h>
22 #include <linux/regulator/consumer.h>
23 
24 #include "msm_drv.h"
25 #include "msm_ringbuffer.h"
26 
27 struct msm_gem_submit;
28 struct msm_gpu_perfcntr;
29 
30 /* So far, with hardware that I've seen to date, we can have:
31  *  + zero, one, or two z180 2d cores
32  *  + a3xx or a2xx 3d core, which share a common CP (the firmware
33  *    for the CP seems to implement some different PM4 packet types
34  *    but the basics of cmdstream submission are the same)
35  *
36  * Which means that the eventual complete "class" hierarchy, once
37  * support for all past and present hw is in place, becomes:
38  *  + msm_gpu
39  *    + adreno_gpu
40  *      + a3xx_gpu
41  *      + a2xx_gpu
42  *    + z180_gpu
43  */
44 struct msm_gpu_funcs {
45 	int (*get_param)(struct msm_gpu *gpu, uint32_t param, uint64_t *value);
46 	int (*hw_init)(struct msm_gpu *gpu);
47 	int (*pm_suspend)(struct msm_gpu *gpu);
48 	int (*pm_resume)(struct msm_gpu *gpu);
49 	int (*submit)(struct msm_gpu *gpu, struct msm_gem_submit *submit,
50 			struct msm_file_private *ctx);
51 	void (*flush)(struct msm_gpu *gpu);
52 	void (*idle)(struct msm_gpu *gpu);
53 	irqreturn_t (*irq)(struct msm_gpu *irq);
54 	uint32_t (*last_fence)(struct msm_gpu *gpu);
55 	void (*recover)(struct msm_gpu *gpu);
56 	void (*destroy)(struct msm_gpu *gpu);
57 #ifdef CONFIG_DEBUG_FS
58 	/* show GPU status in debugfs: */
59 	void (*show)(struct msm_gpu *gpu, struct seq_file *m);
60 #endif
61 };
62 
63 struct msm_gpu {
64 	const char *name;
65 	struct drm_device *dev;
66 	const struct msm_gpu_funcs *funcs;
67 
68 	/* performance counters (hw & sw): */
69 	spinlock_t perf_lock;
70 	bool perfcntr_active;
71 	struct {
72 		bool active;
73 		ktime_t time;
74 	} last_sample;
75 	uint32_t totaltime, activetime;    /* sw counters */
76 	uint32_t last_cntrs[5];            /* hw counters */
77 	const struct msm_gpu_perfcntr *perfcntrs;
78 	uint32_t num_perfcntrs;
79 
80 	struct msm_ringbuffer *rb;
81 	uint32_t rb_iova;
82 
83 	/* list of GEM active objects: */
84 	struct list_head active_list;
85 
86 	uint32_t submitted_fence;
87 
88 	/* is gpu powered/active? */
89 	int active_cnt;
90 	bool inactive;
91 
92 	/* worker for handling active-list retiring: */
93 	struct work_struct retire_work;
94 
95 	void __iomem *mmio;
96 	int irq;
97 
98 	struct msm_mmu *mmu;
99 	int id;
100 
101 	/* Power Control: */
102 	struct regulator *gpu_reg, *gpu_cx;
103 	struct clk *ebi1_clk, *grp_clks[5];
104 	uint32_t fast_rate, slow_rate, bus_freq;
105 
106 #ifdef CONFIG_MSM_BUS_SCALING
107 	struct msm_bus_scale_pdata *bus_scale_table;
108 	uint32_t bsc;
109 #endif
110 
111 	/* Hang and Inactivity Detection:
112 	 */
113 #define DRM_MSM_INACTIVE_PERIOD   66 /* in ms (roughly four frames) */
114 #define DRM_MSM_INACTIVE_JIFFIES  msecs_to_jiffies(DRM_MSM_INACTIVE_PERIOD)
115 	struct timer_list inactive_timer;
116 	struct work_struct inactive_work;
117 #define DRM_MSM_HANGCHECK_PERIOD 500 /* in ms */
118 #define DRM_MSM_HANGCHECK_JIFFIES msecs_to_jiffies(DRM_MSM_HANGCHECK_PERIOD)
119 	struct timer_list hangcheck_timer;
120 	uint32_t hangcheck_fence;
121 	struct work_struct recover_work;
122 };
123 
124 static inline bool msm_gpu_active(struct msm_gpu *gpu)
125 {
126 	return gpu->submitted_fence > gpu->funcs->last_fence(gpu);
127 }
128 
129 /* Perf-Counters:
130  * The select_reg and select_val are just there for the benefit of the child
131  * class that actually enables the perf counter..  but msm_gpu base class
132  * will handle sampling/displaying the counters.
133  */
134 
135 struct msm_gpu_perfcntr {
136 	uint32_t select_reg;
137 	uint32_t sample_reg;
138 	uint32_t select_val;
139 	const char *name;
140 };
141 
142 static inline void gpu_write(struct msm_gpu *gpu, u32 reg, u32 data)
143 {
144 	msm_writel(data, gpu->mmio + (reg << 2));
145 }
146 
147 static inline u32 gpu_read(struct msm_gpu *gpu, u32 reg)
148 {
149 	return msm_readl(gpu->mmio + (reg << 2));
150 }
151 
152 int msm_gpu_pm_suspend(struct msm_gpu *gpu);
153 int msm_gpu_pm_resume(struct msm_gpu *gpu);
154 
155 void msm_gpu_perfcntr_start(struct msm_gpu *gpu);
156 void msm_gpu_perfcntr_stop(struct msm_gpu *gpu);
157 int msm_gpu_perfcntr_sample(struct msm_gpu *gpu, uint32_t *activetime,
158 		uint32_t *totaltime, uint32_t ncntrs, uint32_t *cntrs);
159 
160 void msm_gpu_retire(struct msm_gpu *gpu);
161 int msm_gpu_submit(struct msm_gpu *gpu, struct msm_gem_submit *submit,
162 		struct msm_file_private *ctx);
163 
164 int msm_gpu_init(struct drm_device *drm, struct platform_device *pdev,
165 		struct msm_gpu *gpu, const struct msm_gpu_funcs *funcs,
166 		const char *name, const char *ioname, const char *irqname, int ringsz);
167 void msm_gpu_cleanup(struct msm_gpu *gpu);
168 
169 struct msm_gpu *adreno_load_gpu(struct drm_device *dev);
170 void __init adreno_register(void);
171 void __exit adreno_unregister(void);
172 
173 #endif /* __MSM_GPU_H__ */
174