[mirror_ubuntu-bionic-kernel.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
 * @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;
};

static inline struct drm_gem_cma_object *
to_drm_gem_cma_obj(struct drm_gem_object *gem_obj)
{
	return 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

#ifdef CONFIG_DEBUG_FS
void drm_gem_cma_describe(struct drm_gem_cma_object *obj, struct seq_file *m);
#endif

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);

#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
	12	* @sgt: scatter/gather table for imported PRIME buffers
	13	* @vaddr: kernel virtual address of the backing memory
	14	*/
b9d47450 SH	15	struct drm_gem_cma_object {
	16	struct drm_gem_object base;
	17	dma_addr_t paddr;
71d7282a LP	18	struct sg_table *sgt;
	19
	20	/* For objects with DMA memory allocated by GEM CMA */
b9d47450 SH	21	void *vaddr;
	22	};
	23
	24	static inline struct drm_gem_cma_object *
	25	to_drm_gem_cma_obj(struct drm_gem_object *gem_obj)
	26	{
	27	return container_of(gem_obj, struct drm_gem_cma_object, base);
	28	}
	29
75cccac4 EA	30	#ifndef CONFIG_MMU
	31	#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
	32	.get_unmapped_area = drm_gem_cma_get_unmapped_area,
	33	#else
	34	#define DRM_GEM_CMA_UNMAPPED_AREA_FOPS
	35	#endif
	36
d55f7e5d DV	37	/**
	38	* DEFINE_DRM_GEM_CMA_FOPS() - macro to generate file operations for CMA drivers
	39	* @name: name for the generated structure
	40	*
	41	* This macro autogenerates a suitable &struct file_operations for CMA based
	42	* drivers, which can be assigned to &drm_driver.fops. Note that this structure
	43	* cannot be shared between drivers, because it contains a reference to the
	44	* current module using THIS_MODULE.
	45	*
	46	* Note that the declaration is already marked as static - if you need a
	47	* non-static version of this you're probably doing it wrong and will break the
	48	* THIS_MODULE reference by accident.
	49	*/
	50	#define DEFINE_DRM_GEM_CMA_FOPS(name) \
	51	static const struct file_operations name = {\
	52	.owner = THIS_MODULE,\
	53	.open = drm_open,\
	54	.release = drm_release,\
	55	.unlocked_ioctl = drm_ioctl,\
	56	.compat_ioctl = drm_compat_ioctl,\
	57	.poll = drm_poll,\
	58	.read = drm_read,\
	59	.llseek = noop_llseek,\
	60	.mmap = drm_gem_cma_mmap,\
75cccac4	61	DRM_GEM_CMA_UNMAPPED_AREA_FOPS \
d55f7e5d DV	62	}
d55f7e5d DV	63
d7883f87	64	/* free GEM object */
b9d47450 SH	65	void drm_gem_cma_free_object(struct drm_gem_object *gem_obj);
b9d47450 SH	66
6d178291 TR	67	/* create memory region for DRM framebuffer */
	68	int drm_gem_cma_dumb_create_internal(struct drm_file *file_priv,
	69	struct drm_device *drm,
	70	struct drm_mode_create_dumb *args);
	71
d7883f87	72	/* create memory region for DRM framebuffer */
b9d47450	73	int drm_gem_cma_dumb_create(struct drm_file *file_priv,
d7883f87 TR	74	struct drm_device *drm,
d7883f87 TR	75	struct drm_mode_create_dumb *args);
b9d47450	76
d7883f87	77	/* set vm_flags and we can change the VM attribute to other one at here */
b9d47450 SH	78	int drm_gem_cma_mmap(struct file filp, struct vm_area_struct vma);
b9d47450 SH	79
d7883f87	80	/* allocate physical memory */
b9d47450	81	struct drm_gem_cma_object drm_gem_cma_create(struct drm_device drm,
d7883f87	82	size_t size);
b9d47450 SH	83
	84	extern const struct vm_operations_struct drm_gem_cma_vm_ops;
	85
62a0d98a BG	86	#ifndef CONFIG_MMU
	87	unsigned long drm_gem_cma_get_unmapped_area(struct file *filp,
	88	unsigned long addr,
	89	unsigned long len,
	90	unsigned long pgoff,
	91	unsigned long flags);
62a0d98a BG	92	#endif
62a0d98a BG	93
6f646095 RC	94	#ifdef CONFIG_DEBUG_FS
	95	void drm_gem_cma_describe(struct drm_gem_cma_object obj, struct seq_file m);
	96	#endif
	97
78467dc5 JS	98	struct sg_table drm_gem_cma_prime_get_sg_table(struct drm_gem_object obj);
78467dc5 JS	99	struct drm_gem_object *
b5e9c1a2 ML	100	drm_gem_cma_prime_import_sg_table(struct drm_device *dev,
b5e9c1a2 ML	101	struct dma_buf_attachment *attach,
78467dc5 JS	102	struct sg_table *sgt);
	103	int drm_gem_cma_prime_mmap(struct drm_gem_object *obj,
	104	struct vm_area_struct *vma);
	105	void drm_gem_cma_prime_vmap(struct drm_gem_object obj);
	106	void drm_gem_cma_prime_vunmap(struct drm_gem_object obj, void vaddr);
	107
b9d47450	108	#endif /* __DRM_GEM_CMA_HELPER_H__ */