[linux.git] / include / drm / drm_gem_cma_helper.h

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

/**
 * 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,\
	}

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

/* map memory region for DRM framebuffer to user space */
int drm_gem_cma_dumb_map_offset(struct drm_file *file_priv,
				struct drm_device *drm, u32 handle,
				u64 *offset);

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