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