[mirror_ubuntu-bionic-kernel.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_VIC = 0x5D,
	HOST1X_CLASS_GR3D = 0x60,
};

struct host1x_client;

/**
 * struct host1x_client_ops - host1x client operations
 * @init: host1x client initialization code
 * @exit: host1x client tear down code
 */
struct host1x_client_ops {
	int (*init)(struct host1x_client *client);
	int (*exit)(struct host1x_client *client);
};

/**
 * struct host1x_client - host1x client structure
 * @list: list node for the host1x client
 * @parent: pointer to struct device representing the host1x controller
 * @dev: pointer to struct device backing this host1x client
 * @ops: host1x client operations
 * @class: host1x class represented by this client
 * @channel: host1x channel associated with this client
 * @syncpts: array of syncpoints requested for this client
 * @num_syncpts: number of syncpoints requested for this 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);
u32 host1x_syncpt_read(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 host1x_client *client,
					    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);
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_waitchk {
	struct host1x_bo *bo;
	u32 offset;
	u32 syncpt_id;
	u32 thresh;
};

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 class, u32 reg);

	/* Check if class belongs to the unit */
	int (*is_valid_class)(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 - host1x logical device driver
 * @driver: core driver
 * @subdevs: table of OF device IDs matching subdevices for this driver
 * @list: list node for the driver
 * @probe: called when the host1x logical device is probed
 * @remove: called when the host1x logical device is removed
 * @shutdown: called when the host1x logical device is shut down
 */
struct host1x_driver {
	struct device_driver driver;

	const struct of_device_id *subdevs;
	struct list_head list;

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

static inline struct host1x_driver *
to_host1x_driver(struct device_driver *driver)
{
	return container_of(driver, struct host1x_driver, driver);
}

int host1x_driver_register_full(struct host1x_driver *driver,
				struct module *owner);
void host1x_driver_unregister(struct host1x_driver *driver);

#define host1x_driver_register(driver) \
	host1x_driver_register_full(driver, THIS_MODULE)

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;

	bool registered;

	struct device_dma_parameters dma_parms;
};

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_enable(struct tegra_mipi_device *device);
int tegra_mipi_disable(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,
0ae797a8	29	HOST1X_CLASS_VIC = 0x5D,
5f60ed0d	30	HOST1X_CLASS_GR3D = 0x60,
6579324a TB	31	};
6579324a TB	32
53fa7f72 TR	33	struct host1x_client;
53fa7f72 TR	34
466749f1 TR	35	/**
	36	* struct host1x_client_ops - host1x client operations
	37	* @init: host1x client initialization code
	38	* @exit: host1x client tear down code
	39	*/
53fa7f72 TR	40	struct host1x_client_ops {
	41	int (init)(struct host1x_client client);
	42	int (exit)(struct host1x_client client);
	43	};
	44
466749f1 TR	45	/**
	46	* struct host1x_client - host1x client structure
	47	* @list: list node for the host1x client
	48	* @parent: pointer to struct device representing the host1x controller
	49	* @dev: pointer to struct device backing this host1x client
	50	* @ops: host1x client operations
	51	* @class: host1x class represented by this client
	52	* @channel: host1x channel associated with this client
	53	* @syncpts: array of syncpoints requested for this client
	54	* @num_syncpts: number of syncpoints requested for this client
	55	*/
53fa7f72 TR	56	struct host1x_client {
53fa7f72 TR	57	struct list_head list;
776dc384	58	struct device *parent;
53fa7f72 TR	59	struct device *dev;
	60
	61	const struct host1x_client_ops *ops;
	62
	63	enum host1x_class class;
	64	struct host1x_channel *channel;
	65
	66	struct host1x_syncpt **syncpts;
	67	unsigned int num_syncpts;
	68	};
	69
35d747a8 TR	70	/*
	71	* host1x buffer objects
	72	*/
	73
	74	struct host1x_bo;
	75	struct sg_table;
	76
	77	struct host1x_bo_ops {
	78	struct host1x_bo (get)(struct host1x_bo *bo);
	79	void (put)(struct host1x_bo bo);
	80	dma_addr_t (pin)(struct host1x_bo bo, struct sg_table **sgt);
	81	void (unpin)(struct host1x_bo bo, struct sg_table *sgt);
	82	void (mmap)(struct host1x_bo *bo);
	83	void (munmap)(struct host1x_bo bo, void *addr);
	84	void (kmap)(struct host1x_bo *bo, unsigned int pagenum);
	85	void (kunmap)(struct host1x_bo bo, unsigned int pagenum, void *addr);
	86	};
	87
	88	struct host1x_bo {
	89	const struct host1x_bo_ops *ops;
	90	};
	91
	92	static inline void host1x_bo_init(struct host1x_bo *bo,
	93	const struct host1x_bo_ops *ops)
	94	{
	95	bo->ops = ops;
	96	}
	97
	98	static inline struct host1x_bo host1x_bo_get(struct host1x_bo bo)
	99	{
	100	return bo->ops->get(bo);
	101	}
	102
	103	static inline void host1x_bo_put(struct host1x_bo *bo)
	104	{
	105	bo->ops->put(bo);
	106	}
	107
	108	static inline dma_addr_t host1x_bo_pin(struct host1x_bo *bo,
	109	struct sg_table **sgt)
	110	{
	111	return bo->ops->pin(bo, sgt);
	112	}
	113
	114	static inline void host1x_bo_unpin(struct host1x_bo bo, struct sg_table sgt)
	115	{
	116	bo->ops->unpin(bo, sgt);
	117	}
	118
	119	static inline void host1x_bo_mmap(struct host1x_bo bo)
	120	{
	121	return bo->ops->mmap(bo);
	122	}
	123
	124	static inline void host1x_bo_munmap(struct host1x_bo bo, void addr)
	125	{
	126	bo->ops->munmap(bo, addr);
	127	}
	128
	129	static inline void host1x_bo_kmap(struct host1x_bo bo, unsigned int pagenum)
	130	{
	131	return bo->ops->kmap(bo, pagenum);
	132	}
	133
134	static inline void host1x_bo_kunmap(struct host1x_bo *bo,
135	unsigned int pagenum, void *addr)
136	{
137	bo->ops->kunmap(bo, pagenum, addr);
138	}
139
140	/*
141	* host1x syncpoints
142	*/
143
8736fe81	144	#define HOST1X_SYNCPT_CLIENT_MANAGED (1 << 0)
f5a954fe	145	#define HOST1X_SYNCPT_HAS_BASE (1 << 1)
8736fe81	146
f5a954fe	147	struct host1x_syncpt_base;
35d747a8 TR	148	struct host1x_syncpt;
	149	struct host1x;
	150
	151	struct host1x_syncpt host1x_syncpt_get(struct host1x host, u32 id);
	152	u32 host1x_syncpt_id(struct host1x_syncpt *sp);
	153	u32 host1x_syncpt_read_min(struct host1x_syncpt *sp);
	154	u32 host1x_syncpt_read_max(struct host1x_syncpt *sp);
b4a20144	155	u32 host1x_syncpt_read(struct host1x_syncpt *sp);
35d747a8	156	int host1x_syncpt_incr(struct host1x_syncpt *sp);
64400c37	157	u32 host1x_syncpt_incr_max(struct host1x_syncpt *sp, u32 incrs);
35d747a8 TR	158	int host1x_syncpt_wait(struct host1x_syncpt *sp, u32 thresh, long timeout,
35d747a8 TR	159	u32 *value);
617dd7cc	160	struct host1x_syncpt host1x_syncpt_request(struct host1x_client client,
8736fe81	161	unsigned long flags);
35d747a8 TR	162	void host1x_syncpt_free(struct host1x_syncpt *sp);
35d747a8 TR	163
f5a954fe AM	164	struct host1x_syncpt_base host1x_syncpt_get_base(struct host1x_syncpt sp);
	165	u32 host1x_syncpt_base_id(struct host1x_syncpt_base *base);
	166
35d747a8 TR	167	/*
	168	* host1x channel
	169	*/
	170
	171	struct host1x_channel;
	172	struct host1x_job;
	173
	174	struct host1x_channel host1x_channel_request(struct device dev);
35d747a8 TR	175	struct host1x_channel host1x_channel_get(struct host1x_channel channel);
	176	void host1x_channel_put(struct host1x_channel *channel);
	177	int host1x_job_submit(struct host1x_job *job);
	178
	179	/*
	180	* host1x job
	181	*/
	182
	183	struct host1x_reloc {
961e3bea TR	184	struct {
	185	struct host1x_bo *bo;
	186	unsigned long offset;
	187	} cmdbuf;
	188	struct {
	189	struct host1x_bo *bo;
	190	unsigned long offset;
	191	} target;
	192	unsigned long shift;
35d747a8 TR	193	};
35d747a8 TR	194
d0fbbdff DO	195	struct host1x_waitchk {
	196	struct host1x_bo *bo;
	197	u32 offset;
	198	u32 syncpt_id;
	199	u32 thresh;
	200	};
	201
35d747a8 TR	202	struct host1x_job {
	203	/* When refcount goes to zero, job can be freed */
	204	struct kref ref;
	205
	206	/* List entry */
	207	struct list_head list;
	208
	209	/* Channel where job is submitted to */
	210	struct host1x_channel *channel;
	211
	212	u32 client;
	213
	214	/* Gathers and their memory */
	215	struct host1x_job_gather *gathers;
	216	unsigned int num_gathers;
	217
	218	/* Wait checks to be processed at submit time */
	219	struct host1x_waitchk *waitchk;
	220	unsigned int num_waitchk;
	221	u32 waitchk_mask;
	222
	223	/* Array of handles to be pinned & unpinned */
	224	struct host1x_reloc *relocarray;
	225	unsigned int num_relocs;
	226	struct host1x_job_unpin_data *unpins;
	227	unsigned int num_unpins;
	228
	229	dma_addr_t *addr_phys;
	230	dma_addr_t *gather_addr_phys;
	231	dma_addr_t *reloc_addr_phys;
	232
	233	/* Sync point id, number of increments and end related to the submit */
	234	u32 syncpt_id;
	235	u32 syncpt_incrs;
	236	u32 syncpt_end;
	237
	238	/* Maximum time to wait for this job */
	239	unsigned int timeout;
	240
	241	/* Index and number of slots used in the push buffer */
	242	unsigned int first_get;
	243	unsigned int num_slots;
	244
	245	/* Copy of gathers */
	246	size_t gather_copy_size;
	247	dma_addr_t gather_copy;
	248	u8 *gather_copy_mapped;
	249
	250	/* Check if register is marked as an address reg */
a2b78b0d	251	int (is_addr_reg)(struct device dev, u32 class, u32 reg);
35d747a8	252
0f563a4b DO	253	/* Check if class belongs to the unit */
	254	int (*is_valid_class)(u32 class);
	255
35d747a8 TR	256	/* Request a SETCLASS to this class */
	257	u32 class;
	258
	259	/* Add a channel wait for previous ops to complete */
	260	bool serialize;
	261	};
	262
	263	struct host1x_job host1x_job_alloc(struct host1x_channel ch,
	264	u32 num_cmdbufs, u32 num_relocs,
	265	u32 num_waitchks);
	266	void host1x_job_add_gather(struct host1x_job job, struct host1x_bo mem_id,
	267	u32 words, u32 offset);
	268	struct host1x_job host1x_job_get(struct host1x_job job);
	269	void host1x_job_put(struct host1x_job *job);
	270	int host1x_job_pin(struct host1x_job job, struct device dev);
	271	void host1x_job_unpin(struct host1x_job *job);
	272
776dc384 TR	273	/*
	274	* subdevice probe infrastructure
	275	*/
	276
	277	struct host1x_device;
	278
466749f1 TR	279	/**
	280	* struct host1x_driver - host1x logical device driver
	281	* @driver: core driver
	282	* @subdevs: table of OF device IDs matching subdevices for this driver
	283	* @list: list node for the driver
	284	* @probe: called when the host1x logical device is probed
	285	* @remove: called when the host1x logical device is removed
	286	* @shutdown: called when the host1x logical device is shut down
	287	*/
776dc384	288	struct host1x_driver {
f4c5cf88 TR	289	struct device_driver driver;
f4c5cf88 TR	290
776dc384 TR	291	const struct of_device_id *subdevs;
776dc384 TR	292	struct list_head list;
776dc384 TR	293
	294	int (probe)(struct host1x_device device);
	295	int (remove)(struct host1x_device device);
f4c5cf88	296	void (shutdown)(struct host1x_device device);
776dc384 TR	297	};
776dc384 TR	298
f4c5cf88 TR	299	static inline struct host1x_driver *
	300	to_host1x_driver(struct device_driver *driver)
	301	{
	302	return container_of(driver, struct host1x_driver, driver);
	303	}
	304
	305	int host1x_driver_register_full(struct host1x_driver *driver,
	306	struct module *owner);
776dc384 TR	307	void host1x_driver_unregister(struct host1x_driver *driver);
776dc384 TR	308
f4c5cf88 TR	309	#define host1x_driver_register(driver) \
	310	host1x_driver_register_full(driver, THIS_MODULE)
	311
776dc384 TR	312	struct host1x_device {
	313	struct host1x_driver *driver;
	314	struct list_head list;
	315	struct device dev;
	316
	317	struct mutex subdevs_lock;
	318	struct list_head subdevs;
	319	struct list_head active;
	320
	321	struct mutex clients_lock;
	322	struct list_head clients;
536e1715	323
f4c5cf88	324	bool registered;
ea3cbf62 TR	325
ea3cbf62 TR	326	struct device_dma_parameters dma_parms;
776dc384 TR	327	};
	328
	329	static inline struct host1x_device to_host1x_device(struct device dev)
	330	{
	331	return container_of(dev, struct host1x_device, dev);
	332	}
	333
	334	int host1x_device_init(struct host1x_device *device);
	335	int host1x_device_exit(struct host1x_device *device);
	336
	337	int host1x_client_register(struct host1x_client *client);
	338	int host1x_client_unregister(struct host1x_client *client);
	339
4de6a2d6 TR	340	struct tegra_mipi_device;
	341
	342	struct tegra_mipi_device tegra_mipi_request(struct device device);
	343	void tegra_mipi_free(struct tegra_mipi_device *device);
87904c3e TR	344	int tegra_mipi_enable(struct tegra_mipi_device *device);
87904c3e TR	345	int tegra_mipi_disable(struct tegra_mipi_device *device);
4de6a2d6 TR	346	int tegra_mipi_calibrate(struct tegra_mipi_device *device);
4de6a2d6 TR	347
6579324a	348	#endif