xref: /linux/drivers/gpu/drm/msm/msm_gem.h (revision fcc8487d477a3452a1d0ccbdd4c5e0e1e3cb8bed)
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_GEM_H__
19 #define __MSM_GEM_H__
20 
21 #include <linux/kref.h>
22 #include <linux/reservation.h>
23 #include "msm_drv.h"
24 
25 /* Additional internal-use only BO flags: */
26 #define MSM_BO_STOLEN        0x10000000    /* try to use stolen/splash memory */
27 
28 struct msm_gem_address_space {
29 	const char *name;
30 	/* NOTE: mm managed at the page level, size is in # of pages
31 	 * and position mm_node->start is in # of pages:
32 	 */
33 	struct drm_mm mm;
34 	struct msm_mmu *mmu;
35 	struct kref kref;
36 };
37 
38 struct msm_gem_vma {
39 	struct drm_mm_node node;
40 	uint64_t iova;
41 };
42 
43 struct msm_gem_object {
44 	struct drm_gem_object base;
45 
46 	uint32_t flags;
47 
48 	/**
49 	 * Advice: are the backing pages purgeable?
50 	 */
51 	uint8_t madv;
52 
53 	/**
54 	 * count of active vmap'ing
55 	 */
56 	uint8_t vmap_count;
57 
58 	/* And object is either:
59 	 *  inactive - on priv->inactive_list
60 	 *  active   - on one one of the gpu's active_list..  well, at
61 	 *     least for now we don't have (I don't think) hw sync between
62 	 *     2d and 3d one devices which have both, meaning we need to
63 	 *     block on submit if a bo is already on other ring
64 	 *
65 	 */
66 	struct list_head mm_list;
67 	struct msm_gpu *gpu;     /* non-null if active */
68 
69 	/* Transiently in the process of submit ioctl, objects associated
70 	 * with the submit are on submit->bo_list.. this only lasts for
71 	 * the duration of the ioctl, so one bo can never be on multiple
72 	 * submit lists.
73 	 */
74 	struct list_head submit_entry;
75 
76 	struct page **pages;
77 	struct sg_table *sgt;
78 	void *vaddr;
79 
80 	struct msm_gem_vma domain[NUM_DOMAINS];
81 
82 	/* normally (resv == &_resv) except for imported bo's */
83 	struct reservation_object *resv;
84 	struct reservation_object _resv;
85 
86 	/* For physically contiguous buffers.  Used when we don't have
87 	 * an IOMMU.  Also used for stolen/splashscreen buffer.
88 	 */
89 	struct drm_mm_node *vram_node;
90 };
91 #define to_msm_bo(x) container_of(x, struct msm_gem_object, base)
92 
93 static inline bool is_active(struct msm_gem_object *msm_obj)
94 {
95 	return msm_obj->gpu != NULL;
96 }
97 
98 static inline bool is_purgeable(struct msm_gem_object *msm_obj)
99 {
100 	return (msm_obj->madv == MSM_MADV_DONTNEED) && msm_obj->sgt &&
101 			!msm_obj->base.dma_buf && !msm_obj->base.import_attach;
102 }
103 
104 static inline bool is_vunmapable(struct msm_gem_object *msm_obj)
105 {
106 	return (msm_obj->vmap_count == 0) && msm_obj->vaddr;
107 }
108 
109 /* Created per submit-ioctl, to track bo's and cmdstream bufs, etc,
110  * associated with the cmdstream submission for synchronization (and
111  * make it easier to unwind when things go wrong, etc).  This only
112  * lasts for the duration of the submit-ioctl.
113  */
114 struct msm_gem_submit {
115 	struct drm_device *dev;
116 	struct msm_gpu *gpu;
117 	struct list_head node;   /* node in gpu submit_list */
118 	struct list_head bo_list;
119 	struct ww_acquire_ctx ticket;
120 	struct dma_fence *fence;
121 	struct pid *pid;    /* submitting process */
122 	bool valid;         /* true if no cmdstream patching needed */
123 	unsigned int nr_cmds;
124 	unsigned int nr_bos;
125 	struct {
126 		uint32_t type;
127 		uint32_t size;  /* in dwords */
128 		uint64_t iova;
129 		uint32_t idx;   /* cmdstream buffer idx in bos[] */
130 	} *cmd;  /* array of size nr_cmds */
131 	struct {
132 		uint32_t flags;
133 		struct msm_gem_object *obj;
134 		uint64_t iova;
135 	} bos[0];
136 };
137 
138 #endif /* __MSM_GEM_H__ */
139