[deliverable/linux.git] / include / linux / host1x.h

/*
 * Copyright (c) 2009-2013, NVIDIA Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

#ifndef __LINUX_HOST1X_H
#define __LINUX_HOST1X_H

#include <linux/device.h>
#include <linux/types.h>

enum host1x_class {
	HOST1X_CLASS_HOST1X = 0x1,
	HOST1X_CLASS_GR2D = 0x51,
	HOST1X_CLASS_GR2D_SB = 0x52,
	HOST1X_CLASS_GR3D = 0x60,
};

struct host1x_client;

struct host1x_client_ops {
	int (*init)(struct host1x_client *client);
	int (*exit)(struct host1x_client *client);
};

struct host1x_client {
	struct list_head list;
	struct device *parent;
	struct device *dev;

	const struct host1x_client_ops *ops;

	enum host1x_class class;
	struct host1x_channel *channel;

	struct host1x_syncpt **syncpts;
	unsigned int num_syncpts;
};

/*
 * host1x buffer objects
 */

struct host1x_bo;
struct sg_table;

struct host1x_bo_ops {
	struct host1x_bo *(*get)(struct host1x_bo *bo);
	void (*put)(struct host1x_bo *bo);
	dma_addr_t (*pin)(struct host1x_bo *bo, struct sg_table **sgt);
	void (*unpin)(struct host1x_bo *bo, struct sg_table *sgt);
	void *(*mmap)(struct host1x_bo *bo);
	void (*munmap)(struct host1x_bo *bo, void *addr);
	void *(*kmap)(struct host1x_bo *bo, unsigned int pagenum);
	void (*kunmap)(struct host1x_bo *bo, unsigned int pagenum, void *addr);
};

struct host1x_bo {
	const struct host1x_bo_ops *ops;
};

static inline void host1x_bo_init(struct host1x_bo *bo,
				  const struct host1x_bo_ops *ops)
{
	bo->ops = ops;
}

static inline struct host1x_bo *host1x_bo_get(struct host1x_bo *bo)
{
	return bo->ops->get(bo);
}

static inline void host1x_bo_put(struct host1x_bo *bo)
{
	bo->ops->put(bo);
}

static inline dma_addr_t host1x_bo_pin(struct host1x_bo *bo,
				       struct sg_table **sgt)
{
	return bo->ops->pin(bo, sgt);
}

static inline void host1x_bo_unpin(struct host1x_bo *bo, struct sg_table *sgt)
{
	bo->ops->unpin(bo, sgt);
}

static inline void *host1x_bo_mmap(struct host1x_bo *bo)
{
	return bo->ops->mmap(bo);
}

static inline void host1x_bo_munmap(struct host1x_bo *bo, void *addr)
{
	bo->ops->munmap(bo, addr);
}

static inline void *host1x_bo_kmap(struct host1x_bo *bo, unsigned int pagenum)
{
	return bo->ops->kmap(bo, pagenum);
}

static inline void host1x_bo_kunmap(struct host1x_bo *bo,
				    unsigned int pagenum, void *addr)
{
	bo->ops->kunmap(bo, pagenum, addr);
}

/*
 * host1x syncpoints
 */

#define HOST1X_SYNCPT_CLIENT_MANAGED	(1 << 0)
#define HOST1X_SYNCPT_HAS_BASE		(1 << 1)

struct host1x_syncpt_base;
struct host1x_syncpt;
struct host1x;

struct host1x_syncpt *host1x_syncpt_get(struct host1x *host, u32 id);
u32 host1x_syncpt_id(struct host1x_syncpt *sp);
u32 host1x_syncpt_read_min(struct host1x_syncpt *sp);
u32 host1x_syncpt_read_max(struct host1x_syncpt *sp);
int host1x_syncpt_incr(struct host1x_syncpt *sp);
u32 host1x_syncpt_incr_max(struct host1x_syncpt *sp, u32 incrs);
int host1x_syncpt_wait(struct host1x_syncpt *sp, u32 thresh, long timeout,
		       u32 *value);
struct host1x_syncpt *host1x_syncpt_request(struct device *dev,
					    unsigned long flags);
void host1x_syncpt_free(struct host1x_syncpt *sp);

struct host1x_syncpt_base *host1x_syncpt_get_base(struct host1x_syncpt *sp);
u32 host1x_syncpt_base_id(struct host1x_syncpt_base *base);

/*
 * host1x channel
 */

struct host1x_channel;
struct host1x_job;

struct host1x_channel *host1x_channel_request(struct device *dev);
void host1x_channel_free(struct host1x_channel *channel);
struct host1x_channel *host1x_channel_get(struct host1x_channel *channel);
void host1x_channel_put(struct host1x_channel *channel);
int host1x_job_submit(struct host1x_job *job);

/*
 * host1x job
 */

struct host1x_reloc {
	struct {
		struct host1x_bo *bo;
		unsigned long offset;
	} cmdbuf;
	struct {
		struct host1x_bo *bo;
		unsigned long offset;
	} target;
	unsigned long shift;
};

struct host1x_job {
	/* When refcount goes to zero, job can be freed */
	struct kref ref;

	/* List entry */
	struct list_head list;

	/* Channel where job is submitted to */
	struct host1x_channel *channel;

	u32 client;

	/* Gathers and their memory */
	struct host1x_job_gather *gathers;
	unsigned int num_gathers;

	/* Wait checks to be processed at submit time */
	struct host1x_waitchk *waitchk;
	unsigned int num_waitchk;
	u32 waitchk_mask;

	/* Array of handles to be pinned & unpinned */
	struct host1x_reloc *relocarray;
	unsigned int num_relocs;
	struct host1x_job_unpin_data *unpins;
	unsigned int num_unpins;

	dma_addr_t *addr_phys;
	dma_addr_t *gather_addr_phys;
	dma_addr_t *reloc_addr_phys;

	/* Sync point id, number of increments and end related to the submit */
	u32 syncpt_id;
	u32 syncpt_incrs;
	u32 syncpt_end;

	/* Maximum time to wait for this job */
	unsigned int timeout;

	/* Index and number of slots used in the push buffer */
	unsigned int first_get;
	unsigned int num_slots;

	/* Copy of gathers */
	size_t gather_copy_size;
	dma_addr_t gather_copy;
	u8 *gather_copy_mapped;

	/* Check if register is marked as an address reg */
	int (*is_addr_reg)(struct device *dev, u32 reg, u32 class);

	/* Request a SETCLASS to this class */
	u32 class;

	/* Add a channel wait for previous ops to complete */
	bool serialize;
};

struct host1x_job *host1x_job_alloc(struct host1x_channel *ch,
				    u32 num_cmdbufs, u32 num_relocs,
				    u32 num_waitchks);
void host1x_job_add_gather(struct host1x_job *job, struct host1x_bo *mem_id,
			   u32 words, u32 offset);
struct host1x_job *host1x_job_get(struct host1x_job *job);
void host1x_job_put(struct host1x_job *job);
int host1x_job_pin(struct host1x_job *job, struct device *dev);
void host1x_job_unpin(struct host1x_job *job);

/*
 * subdevice probe infrastructure
 */

struct host1x_device;

struct host1x_driver {
	const struct of_device_id *subdevs;
	struct list_head list;
	const char *name;

	int (*probe)(struct host1x_device *device);
	int (*remove)(struct host1x_device *device);
};

int host1x_driver_register(struct host1x_driver *driver);
void host1x_driver_unregister(struct host1x_driver *driver);

struct host1x_device {
	struct host1x_driver *driver;
	struct list_head list;
	struct device dev;

	struct mutex subdevs_lock;
	struct list_head subdevs;
	struct list_head active;

	struct mutex clients_lock;
	struct list_head clients;
};

static inline struct host1x_device *to_host1x_device(struct device *dev)
{
	return container_of(dev, struct host1x_device, dev);
}

int host1x_device_init(struct host1x_device *device);
int host1x_device_exit(struct host1x_device *device);

int host1x_client_register(struct host1x_client *client);
int host1x_client_unregister(struct host1x_client *client);

struct tegra_mipi_device;

struct tegra_mipi_device *tegra_mipi_request(struct device *device);
void tegra_mipi_free(struct tegra_mipi_device *device);
int tegra_mipi_calibrate(struct tegra_mipi_device *device);

#endif
Commit	Line	Data
6579324a	1	/*
6579324a TB	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
776dc384	22	#include <linux/device.h>
35d747a8 TR	23	#include <linux/types.h>
35d747a8 TR	24
6579324a	25	enum host1x_class {
e1e90644 TR	26	HOST1X_CLASS_HOST1X = 0x1,
	27	HOST1X_CLASS_GR2D = 0x51,
	28	HOST1X_CLASS_GR2D_SB = 0x52,
5f60ed0d	29	HOST1X_CLASS_GR3D = 0x60,
6579324a TB	30	};
6579324a TB	31
53fa7f72 TR	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;
776dc384	41	struct device *parent;
53fa7f72 TR	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
35d747a8 TR	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
8736fe81	127	#define HOST1X_SYNCPT_CLIENT_MANAGED (1 << 0)
f5a954fe	128	#define HOST1X_SYNCPT_HAS_BASE (1 << 1)
8736fe81	129
f5a954fe	130	struct host1x_syncpt_base;
35d747a8 TR	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);
64400c37	139	u32 host1x_syncpt_incr_max(struct host1x_syncpt *sp, u32 incrs);
35d747a8 TR	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,
8736fe81	143	unsigned long flags);
35d747a8 TR	144	void host1x_syncpt_free(struct host1x_syncpt *sp);
35d747a8 TR	145
f5a954fe AM	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
35d747a8 TR	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 {
961e3bea TR	167	struct {
	168	struct host1x_bo *bo;
	169	unsigned long offset;
	170	} cmdbuf;
	171	struct {
	172	struct host1x_bo *bo;
	173	unsigned long offset;
	174	} target;
	175	unsigned long shift;
35d747a8 TR	176	};
	177
	178	struct host1x_job {
	179	/* When refcount goes to zero, job can be freed */
	180	struct kref ref;
	181
	182	/* List entry */
	183	struct list_head list;
	184
	185	/* Channel where job is submitted to */
	186	struct host1x_channel *channel;
	187
	188	u32 client;
	189
	190	/* Gathers and their memory */
	191	struct host1x_job_gather *gathers;
	192	unsigned int num_gathers;
	193
	194	/* Wait checks to be processed at submit time */
	195	struct host1x_waitchk *waitchk;
	196	unsigned int num_waitchk;
	197	u32 waitchk_mask;
	198
	199	/* Array of handles to be pinned & unpinned */
	200	struct host1x_reloc *relocarray;
	201	unsigned int num_relocs;
	202	struct host1x_job_unpin_data *unpins;
	203	unsigned int num_unpins;
	204
	205	dma_addr_t *addr_phys;
	206	dma_addr_t *gather_addr_phys;
	207	dma_addr_t *reloc_addr_phys;
	208
	209	/* Sync point id, number of increments and end related to the submit */
	210	u32 syncpt_id;
	211	u32 syncpt_incrs;
	212	u32 syncpt_end;
	213
	214	/* Maximum time to wait for this job */
	215	unsigned int timeout;
	216
	217	/* Index and number of slots used in the push buffer */
	218	unsigned int first_get;
	219	unsigned int num_slots;
	220
	221	/* Copy of gathers */
	222	size_t gather_copy_size;
	223	dma_addr_t gather_copy;
	224	u8 *gather_copy_mapped;
	225
	226	/* Check if register is marked as an address reg */
	227	int (is_addr_reg)(struct device dev, u32 reg, u32 class);
	228
	229	/* Request a SETCLASS to this class */
	230	u32 class;
	231
	232	/* Add a channel wait for previous ops to complete */
	233	bool serialize;
	234	};
	235
	236	struct host1x_job host1x_job_alloc(struct host1x_channel ch,
	237	u32 num_cmdbufs, u32 num_relocs,
	238	u32 num_waitchks);
	239	void host1x_job_add_gather(struct host1x_job job, struct host1x_bo mem_id,
240	u32 words, u32 offset);
241	struct host1x_job host1x_job_get(struct host1x_job job);
242	void host1x_job_put(struct host1x_job *job);
243	int host1x_job_pin(struct host1x_job job, struct device dev);
244	void host1x_job_unpin(struct host1x_job *job);
245
776dc384 TR	246	/*
	247	* subdevice probe infrastructure
	248	*/
	249
	250	struct host1x_device;
	251
	252	struct host1x_driver {
	253	const struct of_device_id *subdevs;
	254	struct list_head list;
	255	const char *name;
	256
	257	int (probe)(struct host1x_device device);
	258	int (remove)(struct host1x_device device);
	259	};
	260
	261	int host1x_driver_register(struct host1x_driver *driver);
	262	void host1x_driver_unregister(struct host1x_driver *driver);
	263
	264	struct host1x_device {
	265	struct host1x_driver *driver;
	266	struct list_head list;
	267	struct device dev;
	268
	269	struct mutex subdevs_lock;
	270	struct list_head subdevs;
	271	struct list_head active;
	272
	273	struct mutex clients_lock;
	274	struct list_head clients;
	275	};
	276
	277	static inline struct host1x_device to_host1x_device(struct device dev)
	278	{
	279	return container_of(dev, struct host1x_device, dev);
	280	}
	281
	282	int host1x_device_init(struct host1x_device *device);
	283	int host1x_device_exit(struct host1x_device *device);
	284
	285	int host1x_client_register(struct host1x_client *client);
	286	int host1x_client_unregister(struct host1x_client *client);
	287
4de6a2d6 TR	288	struct tegra_mipi_device;
	289
	290	struct tegra_mipi_device tegra_mipi_request(struct device device);
	291	void tegra_mipi_free(struct tegra_mipi_device *device);
	292	int tegra_mipi_calibrate(struct tegra_mipi_device *device);
	293
6579324a	294	#endif