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