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
25enum 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
32struct host1x_client;
33
34struct host1x_client_ops {
35	int (*init)(struct host1x_client *client);
36	int (*exit)(struct host1x_client *client);
37};
38
39struct 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
57struct host1x_bo;
58struct sg_table;
59
60struct 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
71struct host1x_bo {
72	const struct host1x_bo_ops *ops;
73};
74
75static inline void host1x_bo_init(struct host1x_bo *bo,
76				  const struct host1x_bo_ops *ops)
77{
78	bo->ops = ops;
79}
80
81static inline struct host1x_bo *host1x_bo_get(struct host1x_bo *bo)
82{
83	return bo->ops->get(bo);
84}
85
86static inline void host1x_bo_put(struct host1x_bo *bo)
87{
88	bo->ops->put(bo);
89}
90
91static 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
97static inline void host1x_bo_unpin(struct host1x_bo *bo, struct sg_table *sgt)
98{
99	bo->ops->unpin(bo, sgt);
100}
101
102static inline void *host1x_bo_mmap(struct host1x_bo *bo)
103{
104	return bo->ops->mmap(bo);
105}
106
107static inline void host1x_bo_munmap(struct host1x_bo *bo, void *addr)
108{
109	bo->ops->munmap(bo, addr);
110}
111
112static inline void *host1x_bo_kmap(struct host1x_bo *bo, unsigned int pagenum)
113{
114	return bo->ops->kmap(bo, pagenum);
115}
116
117static 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
130struct host1x_syncpt_base;
131struct host1x_syncpt;
132struct host1x;
133
134struct host1x_syncpt *host1x_syncpt_get(struct host1x *host, u32 id);
135u32 host1x_syncpt_id(struct host1x_syncpt *sp);
136u32 host1x_syncpt_read_min(struct host1x_syncpt *sp);
137u32 host1x_syncpt_read_max(struct host1x_syncpt *sp);
138u32 host1x_syncpt_read(struct host1x_syncpt *sp);
139int host1x_syncpt_incr(struct host1x_syncpt *sp);
140u32 host1x_syncpt_incr_max(struct host1x_syncpt *sp, u32 incrs);
141int host1x_syncpt_wait(struct host1x_syncpt *sp, u32 thresh, long timeout,
142		       u32 *value);
143struct host1x_syncpt *host1x_syncpt_request(struct device *dev,
144					    unsigned long flags);
145void host1x_syncpt_free(struct host1x_syncpt *sp);
146
147struct host1x_syncpt_base *host1x_syncpt_get_base(struct host1x_syncpt *sp);
148u32 host1x_syncpt_base_id(struct host1x_syncpt_base *base);
149
150/*
151 * host1x channel
152 */
153
154struct host1x_channel;
155struct host1x_job;
156
157struct host1x_channel *host1x_channel_request(struct device *dev);
158void host1x_channel_free(struct host1x_channel *channel);
159struct host1x_channel *host1x_channel_get(struct host1x_channel *channel);
160void host1x_channel_put(struct host1x_channel *channel);
161int host1x_job_submit(struct host1x_job *job);
162
163/*
164 * host1x job
165 */
166
167struct host1x_reloc {
168	struct {
169		struct host1x_bo *bo;
170		unsigned long offset;
171	} cmdbuf;
172	struct {
173		struct host1x_bo *bo;
174		unsigned long offset;
175	} target;
176	unsigned long shift;
177};
178
179struct host1x_job {
180	/* When refcount goes to zero, job can be freed */
181	struct kref ref;
182
183	/* List entry */
184	struct list_head list;
185
186	/* Channel where job is submitted to */
187	struct host1x_channel *channel;
188
189	u32 client;
190
191	/* Gathers and their memory */
192	struct host1x_job_gather *gathers;
193	unsigned int num_gathers;
194
195	/* Wait checks to be processed at submit time */
196	struct host1x_waitchk *waitchk;
197	unsigned int num_waitchk;
198	u32 waitchk_mask;
199
200	/* Array of handles to be pinned & unpinned */
201	struct host1x_reloc *relocarray;
202	unsigned int num_relocs;
203	struct host1x_job_unpin_data *unpins;
204	unsigned int num_unpins;
205
206	dma_addr_t *addr_phys;
207	dma_addr_t *gather_addr_phys;
208	dma_addr_t *reloc_addr_phys;
209
210	/* Sync point id, number of increments and end related to the submit */
211	u32 syncpt_id;
212	u32 syncpt_incrs;
213	u32 syncpt_end;
214
215	/* Maximum time to wait for this job */
216	unsigned int timeout;
217
218	/* Index and number of slots used in the push buffer */
219	unsigned int first_get;
220	unsigned int num_slots;
221
222	/* Copy of gathers */
223	size_t gather_copy_size;
224	dma_addr_t gather_copy;
225	u8 *gather_copy_mapped;
226
227	/* Check if register is marked as an address reg */
228	int (*is_addr_reg)(struct device *dev, u32 reg, u32 class);
229
230	/* Request a SETCLASS to this class */
231	u32 class;
232
233	/* Add a channel wait for previous ops to complete */
234	bool serialize;
235};
236
237struct host1x_job *host1x_job_alloc(struct host1x_channel *ch,
238				    u32 num_cmdbufs, u32 num_relocs,
239				    u32 num_waitchks);
240void host1x_job_add_gather(struct host1x_job *job, struct host1x_bo *mem_id,
241			   u32 words, u32 offset);
242struct host1x_job *host1x_job_get(struct host1x_job *job);
243void host1x_job_put(struct host1x_job *job);
244int host1x_job_pin(struct host1x_job *job, struct device *dev);
245void host1x_job_unpin(struct host1x_job *job);
246
247/*
248 * subdevice probe infrastructure
249 */
250
251struct host1x_device;
252
253struct host1x_driver {
254	struct device_driver driver;
255
256	const struct of_device_id *subdevs;
257	struct list_head list;
258
259	int (*probe)(struct host1x_device *device);
260	int (*remove)(struct host1x_device *device);
261	void (*shutdown)(struct host1x_device *device);
262};
263
264static inline struct host1x_driver *
265to_host1x_driver(struct device_driver *driver)
266{
267	return container_of(driver, struct host1x_driver, driver);
268}
269
270int host1x_driver_register_full(struct host1x_driver *driver,
271				struct module *owner);
272void host1x_driver_unregister(struct host1x_driver *driver);
273
274#define host1x_driver_register(driver) \
275	host1x_driver_register_full(driver, THIS_MODULE)
276
277struct host1x_device {
278	struct host1x_driver *driver;
279	struct list_head list;
280	struct device dev;
281
282	struct mutex subdevs_lock;
283	struct list_head subdevs;
284	struct list_head active;
285
286	struct mutex clients_lock;
287	struct list_head clients;
288
289	bool registered;
290};
291
292static inline struct host1x_device *to_host1x_device(struct device *dev)
293{
294	return container_of(dev, struct host1x_device, dev);
295}
296
297int host1x_device_init(struct host1x_device *device);
298int host1x_device_exit(struct host1x_device *device);
299
300int host1x_client_register(struct host1x_client *client);
301int host1x_client_unregister(struct host1x_client *client);
302
303struct tegra_mipi_device;
304
305struct tegra_mipi_device *tegra_mipi_request(struct device *device);
306void tegra_mipi_free(struct tegra_mipi_device *device);
307int tegra_mipi_calibrate(struct tegra_mipi_device *device);
308
309#endif
310