[mirror_ubuntu-kernels.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;
struct host1x_client;
struct iommu_group;

u64 host1x_get_dma_mask(struct host1x *host1x);

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

/**
 * struct host1x_client - host1x client structure
 * @list: list node for the host1x client
 * @host: pointer to struct device representing the host1x controller
 * @dev: pointer to struct device backing this host1x client
 * @group: IOMMU group that this client is a member of
 * @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
 * @parent: pointer to parent structure
 * @usecount: reference count for this structure
 * @lock: mutex for mutually exclusive concurrency
 */
struct host1x_client {
	struct list_head list;
	struct device *host;
	struct device *dev;
	struct iommu_group *group;

	const struct host1x_client_ops *ops;

	enum host1x_class class;
	struct host1x_channel *channel;

	struct host1x_syncpt **syncpts;
	unsigned int num_syncpts;

	struct host1x_client *parent;
	unsigned int usecount;
	struct mutex lock;
};

/*
 * 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);
	struct sg_table *(*pin)(struct device *dev, struct host1x_bo *bo,
				dma_addr_t *phys);
	void (*unpin)(struct device *dev, struct sg_table *sgt);
	void *(*mmap)(struct host1x_bo *bo);
	void (*munmap)(struct host1x_bo *bo, 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 struct sg_table *host1x_bo_pin(struct device *dev,
					     struct host1x_bo *bo,
					     dma_addr_t *phys)
{
	return bo->ops->pin(dev, bo, phys);
}

static inline void host1x_bo_unpin(struct device *dev, struct host1x_bo *bo,
				   struct sg_table *sgt)
{
	bo->ops->unpin(dev, 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);
}

/*
 * 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 host1x_client *client);
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
 */

#define HOST1X_RELOC_READ	(1 << 0)
#define HOST1X_RELOC_WRITE	(1 << 1)

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

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;

	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,
			     struct lock_class_key *key);
#define host1x_client_register(class) \
	({ \
		static struct lock_class_key __key; \
		__host1x_client_register(class, &__key); \
	})

int host1x_client_unregister(struct host1x_client *client);

int host1x_client_suspend(struct host1x_client *client);
int host1x_client_resume(struct host1x_client *client);

struct tegra_mipi_device;

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