1 /*
2  * Copyright (C) 2015 Etnaviv Project
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms of the GNU General Public License version 2 as published by
6  * the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
11  * more details.
12  *
13  * You should have received a copy of the GNU General Public License along with
14  * this program.  If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #ifndef __ETNAVIV_DRV_H__
18 #define __ETNAVIV_DRV_H__
19 
20 #include <linux/kernel.h>
21 #include <linux/clk.h>
22 #include <linux/cpufreq.h>
23 #include <linux/module.h>
24 #include <linux/platform_device.h>
25 #include <linux/pm.h>
26 #include <linux/pm_runtime.h>
27 #include <linux/slab.h>
28 #include <linux/list.h>
29 #include <linux/iommu.h>
30 #include <linux/types.h>
31 #include <linux/sizes.h>
32 
33 #include <drm/drmP.h>
34 #include <drm/drm_crtc_helper.h>
35 #include <drm/drm_fb_helper.h>
36 #include <drm/drm_gem.h>
37 #include <drm/etnaviv_drm.h>
38 
39 struct etnaviv_cmdbuf;
40 struct etnaviv_gpu;
41 struct etnaviv_mmu;
42 struct etnaviv_gem_object;
43 struct etnaviv_gem_submit;
44 
45 struct etnaviv_file_private {
46 	/* currently we don't do anything useful with this.. but when
47 	 * per-context address spaces are supported we'd keep track of
48 	 * the context's page-tables here.
49 	 */
50 	int dummy;
51 };
52 
53 struct etnaviv_drm_private {
54 	int num_gpus;
55 	struct etnaviv_gpu *gpu[ETNA_MAX_PIPES];
56 
57 	/* list of GEM objects: */
58 	struct mutex gem_lock;
59 	struct list_head gem_list;
60 
61 	struct workqueue_struct *wq;
62 };
63 
64 static inline void etnaviv_queue_work(struct drm_device *dev,
65 	struct work_struct *w)
66 {
67 	struct etnaviv_drm_private *priv = dev->dev_private;
68 
69 	queue_work(priv->wq, w);
70 }
71 
72 int etnaviv_ioctl_gem_submit(struct drm_device *dev, void *data,
73 		struct drm_file *file);
74 
75 int etnaviv_gem_mmap(struct file *filp, struct vm_area_struct *vma);
76 int etnaviv_gem_fault(struct vm_fault *vmf);
77 int etnaviv_gem_mmap_offset(struct drm_gem_object *obj, u64 *offset);
78 struct sg_table *etnaviv_gem_prime_get_sg_table(struct drm_gem_object *obj);
79 void *etnaviv_gem_prime_vmap(struct drm_gem_object *obj);
80 void etnaviv_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr);
81 int etnaviv_gem_prime_mmap(struct drm_gem_object *obj,
82 			   struct vm_area_struct *vma);
83 struct reservation_object *etnaviv_gem_prime_res_obj(struct drm_gem_object *obj);
84 struct drm_gem_object *etnaviv_gem_prime_import_sg_table(struct drm_device *dev,
85 	struct dma_buf_attachment *attach, struct sg_table *sg);
86 int etnaviv_gem_prime_pin(struct drm_gem_object *obj);
87 void etnaviv_gem_prime_unpin(struct drm_gem_object *obj);
88 void *etnaviv_gem_vmap(struct drm_gem_object *obj);
89 int etnaviv_gem_cpu_prep(struct drm_gem_object *obj, u32 op,
90 		struct timespec *timeout);
91 int etnaviv_gem_cpu_fini(struct drm_gem_object *obj);
92 void etnaviv_gem_free_object(struct drm_gem_object *obj);
93 int etnaviv_gem_new_handle(struct drm_device *dev, struct drm_file *file,
94 		u32 size, u32 flags, u32 *handle);
95 struct drm_gem_object *etnaviv_gem_new_locked(struct drm_device *dev,
96 		u32 size, u32 flags);
97 struct drm_gem_object *etnaviv_gem_new(struct drm_device *dev,
98 		u32 size, u32 flags);
99 int etnaviv_gem_new_userptr(struct drm_device *dev, struct drm_file *file,
100 	uintptr_t ptr, u32 size, u32 flags, u32 *handle);
101 u16 etnaviv_buffer_init(struct etnaviv_gpu *gpu);
102 u16 etnaviv_buffer_config_mmuv2(struct etnaviv_gpu *gpu, u32 mtlb_addr, u32 safe_addr);
103 void etnaviv_buffer_end(struct etnaviv_gpu *gpu);
104 void etnaviv_buffer_queue(struct etnaviv_gpu *gpu, unsigned int event,
105 	struct etnaviv_cmdbuf *cmdbuf);
106 void etnaviv_validate_init(void);
107 bool etnaviv_cmd_validate_one(struct etnaviv_gpu *gpu,
108 	u32 *stream, unsigned int size,
109 	struct drm_etnaviv_gem_submit_reloc *relocs, unsigned int reloc_size);
110 
111 #ifdef CONFIG_DEBUG_FS
112 void etnaviv_gem_describe_objects(struct etnaviv_drm_private *priv,
113 	struct seq_file *m);
114 #endif
115 
116 void __iomem *etnaviv_ioremap(struct platform_device *pdev, const char *name,
117 		const char *dbgname);
118 void etnaviv_writel(u32 data, void __iomem *addr);
119 u32 etnaviv_readl(const void __iomem *addr);
120 
121 #define DBG(fmt, ...) DRM_DEBUG(fmt"\n", ##__VA_ARGS__)
122 #define VERB(fmt, ...) if (0) DRM_DEBUG(fmt"\n", ##__VA_ARGS__)
123 
124 /*
125  * Return the storage size of a structure with a variable length array.
126  * The array is nelem elements of elem_size, where the base structure
127  * is defined by base.  If the size overflows size_t, return zero.
128  */
129 static inline size_t size_vstruct(size_t nelem, size_t elem_size, size_t base)
130 {
131 	if (elem_size && nelem > (SIZE_MAX - base) / elem_size)
132 		return 0;
133 	return base + nelem * elem_size;
134 }
135 
136 /* returns true if fence a comes after fence b */
137 static inline bool fence_after(u32 a, u32 b)
138 {
139 	return (s32)(a - b) > 0;
140 }
141 
142 static inline bool fence_after_eq(u32 a, u32 b)
143 {
144 	return (s32)(a - b) >= 0;
145 }
146 
147 static inline unsigned long etnaviv_timeout_to_jiffies(
148 	const struct timespec *timeout)
149 {
150 	unsigned long timeout_jiffies = timespec_to_jiffies(timeout);
151 	unsigned long start_jiffies = jiffies;
152 	unsigned long remaining_jiffies;
153 
154 	if (time_after(start_jiffies, timeout_jiffies))
155 		remaining_jiffies = 0;
156 	else
157 		remaining_jiffies = timeout_jiffies - start_jiffies;
158 
159 	return remaining_jiffies;
160 }
161 
162 #endif /* __ETNAVIV_DRV_H__ */
163