[linux-2.6-block.git] / include / drm / drm_gem_cma_helper.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __DRM_GEM_CMA_HELPER_H__
#define __DRM_GEM_CMA_HELPER_H__

#include <drm/drmP.h>
#include <drm/drm_gem.h>

/**
 * struct drm_gem_cma_object - GEM object backed by CMA memory allocations
 * @base: base GEM object
 * @paddr: physical address of the backing memory
 * @sgt: scatter/gather table for imported PRIME buffers. The table can have
 *       more than one entry but they are guaranteed to have contiguous
 *       DMA addresses.
 * @vaddr: kernel virtual address of the backing memory
 */
struct drm_gem_cma_object {
	struct drm_gem_object base;
	dma_addr_t paddr;
	struct sg_table *sgt;

	/* For objects with DMA memory allocated by GEM CMA */
	void *vaddr;
};

#define to_drm_gem_cma_obj(gem_obj) \
	container_of(gem_obj, struct drm_gem_cma_object, base)

#ifndef CONFIG_MMU
#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
	.get_unmapped_area	= drm_gem_cma_get_unmapped_area,
#else
#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS
#endif

/**
 * DEFINE_DRM_GEM_CMA_FOPS() - macro to generate file operations for CMA drivers
 * @name: name for the generated structure
 *
 * This macro autogenerates a suitable &struct file_operations for CMA based
 * drivers, which can be assigned to &drm_driver.fops. Note that this structure
 * cannot be shared between drivers, because it contains a reference to the
 * current module using THIS_MODULE.
 *
 * Note that the declaration is already marked as static - if you need a
 * non-static version of this you're probably doing it wrong and will break the
 * THIS_MODULE reference by accident.
 */
#define DEFINE_DRM_GEM_CMA_FOPS(name) \
	static const struct file_operations name = {\
		.owner		= THIS_MODULE,\
		.open		= drm_open,\
		.release	= drm_release,\
		.unlocked_ioctl	= drm_ioctl,\
		.compat_ioctl	= drm_compat_ioctl,\
		.poll		= drm_poll,\
		.read		= drm_read,\
		.llseek		= noop_llseek,\
		.mmap		= drm_gem_cma_mmap,\
		DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
	}

/* free GEM object */
void drm_gem_cma_free_object(struct drm_gem_object *gem_obj);

/* create memory region for DRM framebuffer */
int drm_gem_cma_dumb_create_internal(struct drm_file *file_priv,
				     struct drm_device *drm,
				     struct drm_mode_create_dumb *args);

/* create memory region for DRM framebuffer */
int drm_gem_cma_dumb_create(struct drm_file *file_priv,
			    struct drm_device *drm,
			    struct drm_mode_create_dumb *args);

/* set vm_flags and we can change the VM attribute to other one at here */
int drm_gem_cma_mmap(struct file *filp, struct vm_area_struct *vma);

/* allocate physical memory */
struct drm_gem_cma_object *drm_gem_cma_create(struct drm_device *drm,
					      size_t size);

extern const struct vm_operations_struct drm_gem_cma_vm_ops;

#ifndef CONFIG_MMU
unsigned long drm_gem_cma_get_unmapped_area(struct file *filp,
					    unsigned long addr,
					    unsigned long len,
					    unsigned long pgoff,
					    unsigned long flags);
#endif

void drm_gem_cma_print_info(struct drm_printer *p, unsigned int indent,
			    const struct drm_gem_object *obj);

struct sg_table *drm_gem_cma_prime_get_sg_table(struct drm_gem_object *obj);
struct drm_gem_object *
drm_gem_cma_prime_import_sg_table(struct drm_device *dev,
				  struct dma_buf_attachment *attach,
				  struct sg_table *sgt);
int drm_gem_cma_prime_mmap(struct drm_gem_object *obj,
			   struct vm_area_struct *vma);
void *drm_gem_cma_prime_vmap(struct drm_gem_object *obj);
void drm_gem_cma_prime_vunmap(struct drm_gem_object *obj, void *vaddr);

struct drm_gem_object *
drm_cma_gem_create_object_default_funcs(struct drm_device *dev, size_t size);

/**
 * DRM_GEM_CMA_VMAP_DRIVER_OPS - CMA GEM driver operations ensuring a virtual
 *                               address on the buffer
 *
 * This macro provides a shortcut for setting the default GEM operations in the
 * &drm_driver structure for drivers that need the virtual address also on
 * imported buffers.
 */
#define DRM_GEM_CMA_VMAP_DRIVER_OPS \
	.gem_create_object	= drm_cma_gem_create_object_default_funcs, \
	.dumb_create		= drm_gem_cma_dumb_create, \
	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd, \
	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle, \
	.gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table_vmap, \
	.gem_prime_mmap		= drm_gem_prime_mmap

struct drm_gem_object *
drm_gem_cma_prime_import_sg_table_vmap(struct drm_device *drm,
				       struct dma_buf_attachment *attach,
				       struct sg_table *sgt);

#endif /* __DRM_GEM_CMA_HELPER_H__ */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
b9d47450 SH	2	#ifndef __DRM_GEM_CMA_HELPER_H__
	3	#define __DRM_GEM_CMA_HELPER_H__
	4
740c22ae	5	#include <drm/drmP.h>
d9fc9413	6	#include <drm/drm_gem.h>
740c22ae	7
d7883f87 TR	8	/**
	9	* struct drm_gem_cma_object - GEM object backed by CMA memory allocations
	10	* @base: base GEM object
	11	* @paddr: physical address of the backing memory
998fb1a0 LD	12	* @sgt: scatter/gather table for imported PRIME buffers. The table can have
	13	* more than one entry but they are guaranteed to have contiguous
	14	* DMA addresses.
d7883f87 TR	15	* @vaddr: kernel virtual address of the backing memory
d7883f87 TR	16	*/
b9d47450 SH	17	struct drm_gem_cma_object {
	18	struct drm_gem_object base;
	19	dma_addr_t paddr;
71d7282a LP	20	struct sg_table *sgt;
	21
	22	/* For objects with DMA memory allocated by GEM CMA */
b9d47450 SH	23	void *vaddr;
	24	};
	25
8d25cceb NT	26	#define to_drm_gem_cma_obj(gem_obj) \
8d25cceb NT	27	container_of(gem_obj, struct drm_gem_cma_object, base)
b9d47450	28
75cccac4 EA	29	#ifndef CONFIG_MMU
	30	#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
	31	.get_unmapped_area = drm_gem_cma_get_unmapped_area,
	32	#else
	33	#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS
	34	#endif
	35
d55f7e5d DV	36	/**
	37	* DEFINE_DRM_GEM_CMA_FOPS() - macro to generate file operations for CMA drivers
	38	* @name: name for the generated structure
	39	*
	40	* This macro autogenerates a suitable &struct file_operations for CMA based
	41	* drivers, which can be assigned to &drm_driver.fops. Note that this structure
	42	* cannot be shared between drivers, because it contains a reference to the
	43	* current module using THIS_MODULE.
	44	*
	45	* Note that the declaration is already marked as static - if you need a
	46	* non-static version of this you're probably doing it wrong and will break the
	47	* THIS_MODULE reference by accident.
	48	*/
	49	#define DEFINE_DRM_GEM_CMA_FOPS(name) \
	50	static const struct file_operations name = {\
	51	.owner = THIS_MODULE,\
	52	.open = drm_open,\
	53	.release = drm_release,\
	54	.unlocked_ioctl = drm_ioctl,\
	55	.compat_ioctl = drm_compat_ioctl,\
	56	.poll = drm_poll,\
	57	.read = drm_read,\
	58	.llseek = noop_llseek,\
	59	.mmap = drm_gem_cma_mmap,\
75cccac4	60	DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
d55f7e5d DV	61	}
d55f7e5d DV	62
d7883f87	63	/* free GEM object */
b9d47450 SH	64	void drm_gem_cma_free_object(struct drm_gem_object *gem_obj);
b9d47450 SH	65
6d178291 TR	66	/* create memory region for DRM framebuffer */
	67	int drm_gem_cma_dumb_create_internal(struct drm_file *file_priv,
	68	struct drm_device *drm,
	69	struct drm_mode_create_dumb *args);
	70
d7883f87	71	/* create memory region for DRM framebuffer */
b9d47450	72	int drm_gem_cma_dumb_create(struct drm_file *file_priv,
d7883f87 TR	73	struct drm_device *drm,
d7883f87 TR	74	struct drm_mode_create_dumb *args);
b9d47450	75
d7883f87	76	/* set vm_flags and we can change the VM attribute to other one at here */
b9d47450 SH	77	int drm_gem_cma_mmap(struct file filp, struct vm_area_struct vma);
b9d47450 SH	78
d7883f87	79	/* allocate physical memory */
b9d47450	80	struct drm_gem_cma_object drm_gem_cma_create(struct drm_device drm,
d7883f87	81	size_t size);
b9d47450 SH	82
	83	extern const struct vm_operations_struct drm_gem_cma_vm_ops;
	84
62a0d98a BG	85	#ifndef CONFIG_MMU
	86	unsigned long drm_gem_cma_get_unmapped_area(struct file *filp,
	87	unsigned long addr,
	88	unsigned long len,
	89	unsigned long pgoff,
	90	unsigned long flags);
62a0d98a BG	91	#endif
62a0d98a BG	92
d6892012 NT	93	void drm_gem_cma_print_info(struct drm_printer *p, unsigned int indent,
d6892012 NT	94	const struct drm_gem_object *obj);
6f646095	95
78467dc5 JS	96	struct sg_table drm_gem_cma_prime_get_sg_table(struct drm_gem_object obj);
78467dc5 JS	97	struct drm_gem_object *
b5e9c1a2 ML	98	drm_gem_cma_prime_import_sg_table(struct drm_device *dev,
b5e9c1a2 ML	99	struct dma_buf_attachment *attach,
78467dc5 JS	100	struct sg_table *sgt);
	101	int drm_gem_cma_prime_mmap(struct drm_gem_object *obj,
	102	struct vm_area_struct *vma);
	103	void drm_gem_cma_prime_vmap(struct drm_gem_object obj);
	104	void drm_gem_cma_prime_vunmap(struct drm_gem_object obj, void vaddr);
	105
b9068cde NT	106	struct drm_gem_object *
	107	drm_cma_gem_create_object_default_funcs(struct drm_device *dev, size_t size);
	108
	109	/**
	110	* DRM_GEM_CMA_VMAP_DRIVER_OPS - CMA GEM driver operations ensuring a virtual
	111	* address on the buffer
	112	*
	113	* This macro provides a shortcut for setting the default GEM operations in the
	114	* &drm_driver structure for drivers that need the virtual address also on
	115	* imported buffers.
	116	*/
	117	#define DRM_GEM_CMA_VMAP_DRIVER_OPS \
	118	.gem_create_object = drm_cma_gem_create_object_default_funcs, \
	119	.dumb_create = drm_gem_cma_dumb_create, \
	120	.prime_handle_to_fd = drm_gem_prime_handle_to_fd, \
	121	.prime_fd_to_handle = drm_gem_prime_fd_to_handle, \
	122	.gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table_vmap, \
	123	.gem_prime_mmap = drm_gem_prime_mmap
	124
	125	struct drm_gem_object *
	126	drm_gem_cma_prime_import_sg_table_vmap(struct drm_device *drm,
	127	struct dma_buf_attachment *attach,
	128	struct sg_table *sgt);
	129
b9d47450	130	#endif /* __DRM_GEM_CMA_HELPER_H__ */