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_GEM_H__
18 #define __ETNAVIV_GEM_H__
19 
20 #include <linux/reservation.h>
21 #include "etnaviv_drv.h"
22 
23 struct dma_fence;
24 struct etnaviv_gem_ops;
25 struct etnaviv_gem_object;
26 
27 struct etnaviv_gem_userptr {
28 	uintptr_t ptr;
29 	struct task_struct *task;
30 	struct work_struct *work;
31 	bool ro;
32 };
33 
34 struct etnaviv_vram_mapping {
35 	struct list_head obj_node;
36 	struct list_head scan_node;
37 	struct list_head mmu_node;
38 	struct etnaviv_gem_object *object;
39 	struct etnaviv_iommu *mmu;
40 	struct drm_mm_node vram_node;
41 	unsigned int use;
42 	u32 iova;
43 };
44 
45 struct etnaviv_gem_object {
46 	struct drm_gem_object base;
47 	const struct etnaviv_gem_ops *ops;
48 	struct mutex lock;
49 
50 	u32 flags;
51 
52 	struct list_head gem_node;
53 	struct etnaviv_gpu *gpu;     /* non-null if active */
54 	atomic_t gpu_active;
55 	u32 access;
56 
57 	struct page **pages;
58 	struct sg_table *sgt;
59 	void *vaddr;
60 
61 	/* normally (resv == &_resv) except for imported bo's */
62 	struct reservation_object *resv;
63 	struct reservation_object _resv;
64 
65 	struct list_head vram_list;
66 
67 	/* cache maintenance */
68 	u32 last_cpu_prep_op;
69 
70 	struct etnaviv_gem_userptr userptr;
71 };
72 
73 static inline
74 struct etnaviv_gem_object *to_etnaviv_bo(struct drm_gem_object *obj)
75 {
76 	return container_of(obj, struct etnaviv_gem_object, base);
77 }
78 
79 struct etnaviv_gem_ops {
80 	int (*get_pages)(struct etnaviv_gem_object *);
81 	void (*release)(struct etnaviv_gem_object *);
82 	void *(*vmap)(struct etnaviv_gem_object *);
83 	int (*mmap)(struct etnaviv_gem_object *, struct vm_area_struct *);
84 };
85 
86 static inline bool is_active(struct etnaviv_gem_object *etnaviv_obj)
87 {
88 	return atomic_read(&etnaviv_obj->gpu_active) != 0;
89 }
90 
91 #define MAX_CMDS 4
92 
93 struct etnaviv_gem_submit_bo {
94 	u32 flags;
95 	struct etnaviv_gem_object *obj;
96 	struct etnaviv_vram_mapping *mapping;
97 };
98 
99 /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc,
100  * associated with the cmdstream submission for synchronization (and
101  * make it easier to unwind when things go wrong, etc).  This only
102  * lasts for the duration of the submit-ioctl.
103  */
104 struct etnaviv_gem_submit {
105 	struct drm_device *dev;
106 	struct etnaviv_gpu *gpu;
107 	struct ww_acquire_ctx ticket;
108 	struct dma_fence *fence;
109 	u32 flags;
110 	unsigned int nr_bos;
111 	struct etnaviv_gem_submit_bo bos[0];
112 	/* No new members here, the previous one is variable-length! */
113 };
114 
115 int etnaviv_gem_wait_bo(struct etnaviv_gpu *gpu, struct drm_gem_object *obj,
116 	struct timespec *timeout);
117 int etnaviv_gem_new_private(struct drm_device *dev, size_t size, u32 flags,
118 	struct reservation_object *robj, const struct etnaviv_gem_ops *ops,
119 	struct etnaviv_gem_object **res);
120 int etnaviv_gem_obj_add(struct drm_device *dev, struct drm_gem_object *obj);
121 struct page **etnaviv_gem_get_pages(struct etnaviv_gem_object *obj);
122 void etnaviv_gem_put_pages(struct etnaviv_gem_object *obj);
123 
124 struct etnaviv_vram_mapping *etnaviv_gem_mapping_get(
125 	struct drm_gem_object *obj, struct etnaviv_gpu *gpu);
126 void etnaviv_gem_mapping_reference(struct etnaviv_vram_mapping *mapping);
127 void etnaviv_gem_mapping_unreference(struct etnaviv_vram_mapping *mapping);
128 
129 #endif /* __ETNAVIV_GEM_H__ */
130