xref: /linux-6.15/include/linux/host1x.h (revision bb66fc67)
1 /*
2  * Copyright (c) 2009-2013, NVIDIA Corporation. All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
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
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17  */
18 
19 #ifndef __LINUX_HOST1X_H
20 #define __LINUX_HOST1X_H
21 
22 #include <linux/device.h>
23 #include <linux/types.h>
24 
25 enum host1x_class {
26 	HOST1X_CLASS_HOST1X = 0x1,
27 	HOST1X_CLASS_GR2D = 0x51,
28 	HOST1X_CLASS_GR2D_SB = 0x52,
29 	HOST1X_CLASS_GR3D = 0x60,
30 };
31 
32 struct host1x_client;
33 
34 struct host1x_client_ops {
35 	int (*init)(struct host1x_client *client);
36 	int (*exit)(struct host1x_client *client);
37 };
38 
39 struct host1x_client {
40 	struct list_head list;
41 	struct device *parent;
42 	struct device *dev;
43 
44 	const struct host1x_client_ops *ops;
45 
46 	enum host1x_class class;
47 	struct host1x_channel *channel;
48 
49 	struct host1x_syncpt **syncpts;
50 	unsigned int num_syncpts;
51 };
52 
53 /*
54  * host1x buffer objects
55  */
56 
57 struct host1x_bo;
58 struct sg_table;
59 
60 struct host1x_bo_ops {
61 	struct host1x_bo *(*get)(struct host1x_bo *bo);
62 	void (*put)(struct host1x_bo *bo);
63 	dma_addr_t (*pin)(struct host1x_bo *bo, struct sg_table **sgt);
64 	void (*unpin)(struct host1x_bo *bo, struct sg_table *sgt);
65 	void *(*mmap)(struct host1x_bo *bo);
66 	void (*munmap)(struct host1x_bo *bo, void *addr);
67 	void *(*kmap)(struct host1x_bo *bo, unsigned int pagenum);
68 	void (*kunmap)(struct host1x_bo *bo, unsigned int pagenum, void *addr);
69 };
70 
71 struct host1x_bo {
72 	const struct host1x_bo_ops *ops;
73 };
74 
75 static inline void host1x_bo_init(struct host1x_bo *bo,
76 				  const struct host1x_bo_ops *ops)
77 {
78 	bo->ops = ops;
79 }
80 
81 static inline struct host1x_bo *host1x_bo_get(struct host1x_bo *bo)
82 {
83 	return bo->ops->get(bo);
84 }
85 
86 static inline void host1x_bo_put(struct host1x_bo *bo)
87 {
88 	bo->ops->put(bo);
89 }
90 
91 static inline dma_addr_t host1x_bo_pin(struct host1x_bo *bo,
92 				       struct sg_table **sgt)
93 {
94 	return bo->ops->pin(bo, sgt);
95 }
96 
97 static inline void host1x_bo_unpin(struct host1x_bo *bo, struct sg_table *sgt)
98 {
99 	bo->ops->unpin(bo, sgt);
100 }
101 
102 static inline void *host1x_bo_mmap(struct host1x_bo *bo)
103 {
104 	return bo->ops->mmap(bo);
105 }
106 
107 static inline void host1x_bo_munmap(struct host1x_bo *bo, void *addr)
108 {
109 	bo->ops->munmap(bo, addr);
110 }
111 
112 static inline void *host1x_bo_kmap(struct host1x_bo *bo, unsigned int pagenum)
113 {
114 	return bo->ops->kmap(bo, pagenum);
115 }
116 
117 static inline void host1x_bo_kunmap(struct host1x_bo *bo,
118 				    unsigned int pagenum, void *addr)
119 {
120 	bo->ops->kunmap(bo, pagenum, addr);
121 }
122 
123 /*
124  * host1x syncpoints
125  */
126 
127 #define HOST1X_SYNCPT_CLIENT_MANAGED	(1 << 0)
128 #define HOST1X_SYNCPT_HAS_BASE		(1 << 1)
129 
130 struct host1x_syncpt_base;
131 struct host1x_syncpt;
132 struct host1x;
133 
134 struct host1x_syncpt *host1x_syncpt_get(struct host1x *host, u32 id);
135 u32 host1x_syncpt_id(struct host1x_syncpt *sp);
136 u32 host1x_syncpt_read_min(struct host1x_syncpt *sp);
137 u32 host1x_syncpt_read_max(struct host1x_syncpt *sp);
138 int host1x_syncpt_incr(struct host1x_syncpt *sp);
139 u32 host1x_syncpt_incr_max(struct host1x_syncpt *sp, u32 incrs);
140 int host1x_syncpt_wait(struct host1x_syncpt *sp, u32 thresh, long timeout,
141 		       u32 *value);
142 struct host1x_syncpt *host1x_syncpt_request(struct device *dev,
143 					    unsigned long flags);
144 void host1x_syncpt_free(struct host1x_syncpt *sp);
145 
146 struct host1x_syncpt_base *host1x_syncpt_get_base(struct host1x_syncpt *sp);
147 u32 host1x_syncpt_base_id(struct host1x_syncpt_base *base);
148 
149 /*
150  * host1x channel
151  */
152 
153 struct host1x_channel;
154 struct host1x_job;
155 
156 struct host1x_channel *host1x_channel_request(struct device *dev);
157 void host1x_channel_free(struct host1x_channel *channel);
158 struct host1x_channel *host1x_channel_get(struct host1x_channel *channel);
159 void host1x_channel_put(struct host1x_channel *channel);
160 int host1x_job_submit(struct host1x_job *job);
161 
162 /*
163  * host1x job
164  */
165 
166 struct host1x_reloc {
167 	struct host1x_bo *cmdbuf;
168 	u32 cmdbuf_offset;
169 	struct host1x_bo *target;
170 	u32 target_offset;
171 	u32 shift;
172 	u32 pad;
173 };
174 
175 struct host1x_job {
176 	/* When refcount goes to zero, job can be freed */
177 	struct kref ref;
178 
179 	/* List entry */
180 	struct list_head list;
181 
182 	/* Channel where job is submitted to */
183 	struct host1x_channel *channel;
184 
185 	u32 client;
186 
187 	/* Gathers and their memory */
188 	struct host1x_job_gather *gathers;
189 	unsigned int num_gathers;
190 
191 	/* Wait checks to be processed at submit time */
192 	struct host1x_waitchk *waitchk;
193 	unsigned int num_waitchk;
194 	u32 waitchk_mask;
195 
196 	/* Array of handles to be pinned & unpinned */
197 	struct host1x_reloc *relocarray;
198 	unsigned int num_relocs;
199 	struct host1x_job_unpin_data *unpins;
200 	unsigned int num_unpins;
201 
202 	dma_addr_t *addr_phys;
203 	dma_addr_t *gather_addr_phys;
204 	dma_addr_t *reloc_addr_phys;
205 
206 	/* Sync point id, number of increments and end related to the submit */
207 	u32 syncpt_id;
208 	u32 syncpt_incrs;
209 	u32 syncpt_end;
210 
211 	/* Maximum time to wait for this job */
212 	unsigned int timeout;
213 
214 	/* Index and number of slots used in the push buffer */
215 	unsigned int first_get;
216 	unsigned int num_slots;
217 
218 	/* Copy of gathers */
219 	size_t gather_copy_size;
220 	dma_addr_t gather_copy;
221 	u8 *gather_copy_mapped;
222 
223 	/* Check if register is marked as an address reg */
224 	int (*is_addr_reg)(struct device *dev, u32 reg, u32 class);
225 
226 	/* Request a SETCLASS to this class */
227 	u32 class;
228 
229 	/* Add a channel wait for previous ops to complete */
230 	bool serialize;
231 };
232 
233 struct host1x_job *host1x_job_alloc(struct host1x_channel *ch,
234 				    u32 num_cmdbufs, u32 num_relocs,
235 				    u32 num_waitchks);
236 void host1x_job_add_gather(struct host1x_job *job, struct host1x_bo *mem_id,
237 			   u32 words, u32 offset);
238 struct host1x_job *host1x_job_get(struct host1x_job *job);
239 void host1x_job_put(struct host1x_job *job);
240 int host1x_job_pin(struct host1x_job *job, struct device *dev);
241 void host1x_job_unpin(struct host1x_job *job);
242 
243 /*
244  * subdevice probe infrastructure
245  */
246 
247 struct host1x_device;
248 
249 struct host1x_driver {
250 	const struct of_device_id *subdevs;
251 	struct list_head list;
252 	const char *name;
253 
254 	int (*probe)(struct host1x_device *device);
255 	int (*remove)(struct host1x_device *device);
256 };
257 
258 int host1x_driver_register(struct host1x_driver *driver);
259 void host1x_driver_unregister(struct host1x_driver *driver);
260 
261 struct host1x_device {
262 	struct host1x_driver *driver;
263 	struct list_head list;
264 	struct device dev;
265 
266 	struct mutex subdevs_lock;
267 	struct list_head subdevs;
268 	struct list_head active;
269 
270 	struct mutex clients_lock;
271 	struct list_head clients;
272 };
273 
274 static inline struct host1x_device *to_host1x_device(struct device *dev)
275 {
276 	return container_of(dev, struct host1x_device, dev);
277 }
278 
279 int host1x_device_init(struct host1x_device *device);
280 int host1x_device_exit(struct host1x_device *device);
281 
282 int host1x_client_register(struct host1x_client *client);
283 int host1x_client_unregister(struct host1x_client *client);
284 
285 struct tegra_mipi_device;
286 
287 struct tegra_mipi_device *tegra_mipi_request(struct device *device);
288 void tegra_mipi_free(struct tegra_mipi_device *device);
289 int tegra_mipi_calibrate(struct tegra_mipi_device *device);
290 
291 #endif
292