[mirror_ubuntu-jammy-kernel.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 iommu_group;

/**
 * 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
 * @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
 */
struct host1x_client {
	struct list_head list;
	struct device *parent;
	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;
};

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

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