[linux-2.6-block.git] / include / linux / host1x.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (c) 2009-2013, NVIDIA Corporation. All rights reserved.
 */

#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_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;

	/* client where the job originated */
	struct host1x_client *client;

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

	/* Array of handles to be pinned & unpinned */
	struct host1x_reloc *relocs;
	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);
void host1x_job_add_gather(struct host1x_job *job, struct host1x_bo *bo,
			   unsigned int words, unsigned int 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;
};

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
16216333	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
6579324a	2	/*
6579324a	3	* Copyright (c) 2009-2013, NVIDIA Corporation. All rights reserved.
6579324a TB	4	*/
	5
	6	#ifndef __LINUX_HOST1X_H
	7	#define __LINUX_HOST1X_H
	8
776dc384	9	#include <linux/device.h>
35d747a8 TR	10	#include <linux/types.h>
35d747a8 TR	11
6579324a	12	enum host1x_class {
e1e90644 TR	13	HOST1X_CLASS_HOST1X = 0x1,
	14	HOST1X_CLASS_GR2D = 0x51,
	15	HOST1X_CLASS_GR2D_SB = 0x52,
0ae797a8	16	HOST1X_CLASS_VIC = 0x5D,
5f60ed0d	17	HOST1X_CLASS_GR3D = 0x60,
6579324a TB	18	};
6579324a TB	19
53fa7f72 TR	20	struct host1x_client;
53fa7f72 TR	21
466749f1 TR	22	/**
	23	* struct host1x_client_ops - host1x client operations
	24	* @init: host1x client initialization code
	25	* @exit: host1x client tear down code
	26	*/
53fa7f72 TR	27	struct host1x_client_ops {
	28	int (init)(struct host1x_client client);
	29	int (exit)(struct host1x_client client);
	30	};
	31
466749f1 TR	32	/**
	33	* struct host1x_client - host1x client structure
	34	* @list: list node for the host1x client
	35	* @parent: pointer to struct device representing the host1x controller
	36	* @dev: pointer to struct device backing this host1x client
	37	* @ops: host1x client operations
	38	* @class: host1x class represented by this client
	39	* @channel: host1x channel associated with this client
	40	* @syncpts: array of syncpoints requested for this client
	41	* @num_syncpts: number of syncpoints requested for this client
	42	*/
53fa7f72 TR	43	struct host1x_client {
53fa7f72 TR	44	struct list_head list;
776dc384	45	struct device *parent;
53fa7f72 TR	46	struct device *dev;
	47
	48	const struct host1x_client_ops *ops;
	49
	50	enum host1x_class class;
	51	struct host1x_channel *channel;
	52
	53	struct host1x_syncpt **syncpts;
	54	unsigned int num_syncpts;
	55	};
	56
35d747a8 TR	57	/*
	58	* host1x buffer objects
	59	*/
	60
	61	struct host1x_bo;
	62	struct sg_table;
	63
	64	struct host1x_bo_ops {
	65	struct host1x_bo (get)(struct host1x_bo *bo);
	66	void (put)(struct host1x_bo bo);
	67	dma_addr_t (pin)(struct host1x_bo bo, struct sg_table **sgt);
	68	void (unpin)(struct host1x_bo bo, struct sg_table *sgt);
	69	void (mmap)(struct host1x_bo *bo);
	70	void (munmap)(struct host1x_bo bo, void *addr);
	71	void (kmap)(struct host1x_bo *bo, unsigned int pagenum);
	72	void (kunmap)(struct host1x_bo bo, unsigned int pagenum, void *addr);
	73	};
	74
	75	struct host1x_bo {
	76	const struct host1x_bo_ops *ops;
	77	};
	78
	79	static inline void host1x_bo_init(struct host1x_bo *bo,
	80	const struct host1x_bo_ops *ops)
	81	{
	82	bo->ops = ops;
	83	}
	84
	85	static inline struct host1x_bo host1x_bo_get(struct host1x_bo bo)
	86	{
	87	return bo->ops->get(bo);
	88	}
	89
	90	static inline void host1x_bo_put(struct host1x_bo *bo)
	91	{
	92	bo->ops->put(bo);
	93	}
	94
	95	static inline dma_addr_t host1x_bo_pin(struct host1x_bo *bo,
	96	struct sg_table **sgt)
	97	{
	98	return bo->ops->pin(bo, sgt);
	99	}
	100
	101	static inline void host1x_bo_unpin(struct host1x_bo bo, struct sg_table sgt)
	102	{
	103	bo->ops->unpin(bo, sgt);
	104	}
	105
	106	static inline void host1x_bo_mmap(struct host1x_bo bo)
	107	{
	108	return bo->ops->mmap(bo);
	109	}
	110
	111	static inline void host1x_bo_munmap(struct host1x_bo bo, void addr)
	112	{
	113	bo->ops->munmap(bo, addr);
	114	}
	115
	116	static inline void host1x_bo_kmap(struct host1x_bo bo, unsigned int pagenum)
	117	{
	118	return bo->ops->kmap(bo, pagenum);
	119	}
	120
121	static inline void host1x_bo_kunmap(struct host1x_bo *bo,
122	unsigned int pagenum, void *addr)
123	{
124	bo->ops->kunmap(bo, pagenum, addr);
125	}
126
127	/*
128	* host1x syncpoints
129	*/
130
8736fe81	131	#define HOST1X_SYNCPT_CLIENT_MANAGED (1 << 0)
f5a954fe	132	#define HOST1X_SYNCPT_HAS_BASE (1 << 1)
8736fe81	133
f5a954fe	134	struct host1x_syncpt_base;
35d747a8 TR	135	struct host1x_syncpt;
	136	struct host1x;
	137
	138	struct host1x_syncpt host1x_syncpt_get(struct host1x host, u32 id);
	139	u32 host1x_syncpt_id(struct host1x_syncpt *sp);
	140	u32 host1x_syncpt_read_min(struct host1x_syncpt *sp);
	141	u32 host1x_syncpt_read_max(struct host1x_syncpt *sp);
b4a20144	142	u32 host1x_syncpt_read(struct host1x_syncpt *sp);
35d747a8	143	int host1x_syncpt_incr(struct host1x_syncpt *sp);
64400c37	144	u32 host1x_syncpt_incr_max(struct host1x_syncpt *sp, u32 incrs);
35d747a8 TR	145	int host1x_syncpt_wait(struct host1x_syncpt *sp, u32 thresh, long timeout,
35d747a8 TR	146	u32 *value);
617dd7cc	147	struct host1x_syncpt host1x_syncpt_request(struct host1x_client client,
8736fe81	148	unsigned long flags);
35d747a8 TR	149	void host1x_syncpt_free(struct host1x_syncpt *sp);
35d747a8 TR	150
f5a954fe AM	151	struct host1x_syncpt_base host1x_syncpt_get_base(struct host1x_syncpt sp);
	152	u32 host1x_syncpt_base_id(struct host1x_syncpt_base *base);
	153
35d747a8 TR	154	/*
	155	* host1x channel
	156	*/
	157
	158	struct host1x_channel;
	159	struct host1x_job;
	160
	161	struct host1x_channel host1x_channel_request(struct device dev);
35d747a8 TR	162	struct host1x_channel host1x_channel_get(struct host1x_channel channel);
	163	void host1x_channel_put(struct host1x_channel *channel);
	164	int host1x_job_submit(struct host1x_job *job);
	165
	166	/*
	167	* host1x job
	168	*/
	169
	170	struct host1x_reloc {
961e3bea TR	171	struct {
	172	struct host1x_bo *bo;
	173	unsigned long offset;
	174	} cmdbuf;
	175	struct {
	176	struct host1x_bo *bo;
	177	unsigned long offset;
	178	} target;
	179	unsigned long shift;
35d747a8 TR	180	};
	181
	182	struct host1x_job {
	183	/* When refcount goes to zero, job can be freed */
	184	struct kref ref;
	185
	186	/* List entry */
	187	struct list_head list;
	188
	189	/* Channel where job is submitted to */
	190	struct host1x_channel *channel;
	191
bf3d41cc TR	192	/* client where the job originated */
bf3d41cc TR	193	struct host1x_client *client;
35d747a8 TR	194
	195	/* Gathers and their memory */
	196	struct host1x_job_gather *gathers;
	197	unsigned int num_gathers;
	198
35d747a8	199	/* Array of handles to be pinned & unpinned */
06490bb9	200	struct host1x_reloc *relocs;
35d747a8 TR	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 */
a2b78b0d	227	int (is_addr_reg)(struct device dev, u32 class, u32 reg);
35d747a8	228
0f563a4b DO	229	/* Check if class belongs to the unit */
	230	int (*is_valid_class)(u32 class);
	231
35d747a8 TR	232	/* Request a SETCLASS to this class */
	233	u32 class;
	234
	235	/* Add a channel wait for previous ops to complete */
	236	bool serialize;
	237	};
	238
	239	struct host1x_job host1x_job_alloc(struct host1x_channel ch,
24c94e16	240	u32 num_cmdbufs, u32 num_relocs);
326bbd79 TR	241	void host1x_job_add_gather(struct host1x_job job, struct host1x_bo bo,
326bbd79 TR	242	unsigned int words, unsigned int offset);
35d747a8 TR	243	struct host1x_job host1x_job_get(struct host1x_job job);
	244	void host1x_job_put(struct host1x_job *job);
	245	int host1x_job_pin(struct host1x_job job, struct device dev);
	246	void host1x_job_unpin(struct host1x_job *job);
	247
776dc384 TR	248	/*
	249	* subdevice probe infrastructure
	250	*/
	251
	252	struct host1x_device;
	253
466749f1 TR	254	/**
	255	* struct host1x_driver - host1x logical device driver
	256	* @driver: core driver
	257	* @subdevs: table of OF device IDs matching subdevices for this driver
	258	* @list: list node for the driver
	259	* @probe: called when the host1x logical device is probed
	260	* @remove: called when the host1x logical device is removed
	261	* @shutdown: called when the host1x logical device is shut down
	262	*/
776dc384	263	struct host1x_driver {
f4c5cf88 TR	264	struct device_driver driver;
f4c5cf88 TR	265
776dc384 TR	266	const struct of_device_id *subdevs;
776dc384 TR	267	struct list_head list;
776dc384 TR	268
	269	int (probe)(struct host1x_device device);
	270	int (remove)(struct host1x_device device);
f4c5cf88	271	void (shutdown)(struct host1x_device device);
776dc384 TR	272	};
776dc384 TR	273
f4c5cf88 TR	274	static inline struct host1x_driver *
	275	to_host1x_driver(struct device_driver *driver)
	276	{
	277	return container_of(driver, struct host1x_driver, driver);
	278	}
	279
	280	int host1x_driver_register_full(struct host1x_driver *driver,
	281	struct module *owner);
776dc384 TR	282	void host1x_driver_unregister(struct host1x_driver *driver);
776dc384 TR	283
f4c5cf88 TR	284	#define host1x_driver_register(driver) \
	285	host1x_driver_register_full(driver, THIS_MODULE)
	286
776dc384 TR	287	struct host1x_device {
	288	struct host1x_driver *driver;
	289	struct list_head list;
	290	struct device dev;
	291
	292	struct mutex subdevs_lock;
	293	struct list_head subdevs;
	294	struct list_head active;
	295
	296	struct mutex clients_lock;
	297	struct list_head clients;
536e1715	298
f4c5cf88	299	bool registered;
776dc384 TR	300	};
	301
	302	static inline struct host1x_device to_host1x_device(struct device dev)
	303	{
	304	return container_of(dev, struct host1x_device, dev);
	305	}
	306
	307	int host1x_device_init(struct host1x_device *device);
	308	int host1x_device_exit(struct host1x_device *device);
	309
	310	int host1x_client_register(struct host1x_client *client);
	311	int host1x_client_unregister(struct host1x_client *client);
	312
4de6a2d6 TR	313	struct tegra_mipi_device;
	314
	315	struct tegra_mipi_device tegra_mipi_request(struct device device);
	316	void tegra_mipi_free(struct tegra_mipi_device *device);
87904c3e TR	317	int tegra_mipi_enable(struct tegra_mipi_device *device);
87904c3e TR	318	int tegra_mipi_disable(struct tegra_mipi_device *device);
4de6a2d6 TR	319	int tegra_mipi_calibrate(struct tegra_mipi_device *device);
4de6a2d6 TR	320
6579324a	321	#endif