[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / gpu / drm / exynos / exynos_drm_gem.h

/* exynos_drm_gem.h
 *
 * Copyright (c) 2011 Samsung Electronics Co., Ltd.
 * Authoer: Inki Dae <inki.dae@samsung.com>
 *
 * This program is free software; you can redistribute  it and/or modify it
 * under  the terms of  the GNU General  Public License as published by the
 * Free Software Foundation;  either version 2 of the  License, or (at your
 * option) any later version.
 */

#ifndef _EXYNOS_DRM_GEM_H_
#define _EXYNOS_DRM_GEM_H_

#define to_exynos_gem_obj(x)	container_of(x,\
			struct exynos_drm_gem_obj, base)

#define IS_NONCONTIG_BUFFER(f)		(f & EXYNOS_BO_NONCONTIG)

/*
 * exynos drm gem buffer structure.
 *
 * @kvaddr: kernel virtual address to allocated memory region.
 * *userptr: user space address.
 * @dma_addr: bus address(accessed by dma) to allocated memory region.
 *	- this address could be physical address without IOMMU and
 *	device address with IOMMU.
 * @write: whether pages will be written to by the caller.
 * @pages: Array of backing pages.
 * @sgt: sg table to transfer page data.
 * @size: size of allocated memory region.
 * @pfnmap: indicate whether memory region from userptr is mmaped with
 *	VM_PFNMAP or not.
 */
struct exynos_drm_gem_buf {
	void __iomem		*kvaddr;
	unsigned long		userptr;
	dma_addr_t		dma_addr;
	struct dma_attrs	dma_attrs;
	unsigned int		write;
	struct page		**pages;
	struct sg_table		*sgt;
	unsigned long		size;
	bool			pfnmap;
};

/*
 * exynos drm buffer structure.
 *
 * @base: a gem object.
 *	- a new handle to this gem object would be created
 *	by drm_gem_handle_create().
 * @buffer: a pointer to exynos_drm_gem_buffer object.
 *	- contain the information to memory region allocated
 *	by user request or at framebuffer creation.
 *	continuous memory region allocated by user request
 *	or at framebuffer creation.
 * @size: size requested from user, in bytes and this size is aligned
 *	in page unit.
 * @vma: a pointer to vm_area.
 * @flags: indicate memory type to allocated buffer and cache attruibute.
 *
 * P.S. this object would be transfered to user as kms_bo.handle so
 *	user can access the buffer through kms_bo.handle.
 */
struct exynos_drm_gem_obj {
	struct drm_gem_object		base;
	struct exynos_drm_gem_buf	*buffer;
	unsigned long			size;
	struct vm_area_struct		*vma;
	unsigned int			flags;
};

struct page **exynos_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask);

/* destroy a buffer with gem object */
void exynos_drm_gem_destroy(struct exynos_drm_gem_obj *exynos_gem_obj);

/* create a private gem object and initialize it. */
struct exynos_drm_gem_obj *exynos_drm_gem_init(struct drm_device *dev,
						      unsigned long size);

/* create a new buffer with gem object */
struct exynos_drm_gem_obj *exynos_drm_gem_create(struct drm_device *dev,
						unsigned int flags,
						unsigned long size);

/*
 * request gem object creation and buffer allocation as the size
 * that it is calculated with framebuffer information such as width,
 * height and bpp.
 */
int exynos_drm_gem_create_ioctl(struct drm_device *dev, void *data,
				struct drm_file *file_priv);

/*
 * get dma address from gem handle and this function could be used for
 * other drivers such as 2d/3d acceleration drivers.
 * with this function call, gem object reference count would be increased.
 */
dma_addr_t *exynos_drm_gem_get_dma_addr(struct drm_device *dev,
					unsigned int gem_handle,
					struct drm_file *filp);

/*
 * put dma address from gem handle and this function could be used for
 * other drivers such as 2d/3d acceleration drivers.
 * with this function call, gem object reference count would be decreased.
 */
void exynos_drm_gem_put_dma_addr(struct drm_device *dev,
					unsigned int gem_handle,
					struct drm_file *filp);

/* get buffer offset to map to user space. */
int exynos_drm_gem_map_offset_ioctl(struct drm_device *dev, void *data,
				    struct drm_file *file_priv);

/*
 * mmap the physically continuous memory that a gem object contains
 * to user space.
 */
int exynos_drm_gem_mmap_ioctl(struct drm_device *dev, void *data,
			      struct drm_file *file_priv);

/* map user space allocated by malloc to pages. */
int exynos_drm_gem_userptr_ioctl(struct drm_device *dev, void *data,
				      struct drm_file *file_priv);

/* get buffer information to memory region allocated by gem. */
int exynos_drm_gem_get_ioctl(struct drm_device *dev, void *data,
				      struct drm_file *file_priv);

/* get buffer size to gem handle. */
unsigned long exynos_drm_gem_get_size(struct drm_device *dev,
						unsigned int gem_handle,
						struct drm_file *file_priv);

/* initialize gem object. */
int exynos_drm_gem_init_object(struct drm_gem_object *obj);

/* free gem object. */
void exynos_drm_gem_free_object(struct drm_gem_object *gem_obj);

/* create memory region for drm framebuffer. */
int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
			       struct drm_device *dev,
			       struct drm_mode_create_dumb *args);

/* map memory region for drm framebuffer to user space. */
int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv,
				   struct drm_device *dev, uint32_t handle,
				   uint64_t *offset);

/*
 * destroy memory region allocated.
 *	- a gem handle and physical memory region pointed by a gem object
 *	would be released by drm_gem_handle_delete().
 */
int exynos_drm_gem_dumb_destroy(struct drm_file *file_priv,
				struct drm_device *dev,
				unsigned int handle);

/* page fault handler and mmap fault address(virtual) to physical memory. */
int exynos_drm_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);

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

static inline int vma_is_io(struct vm_area_struct *vma)
{
	return !!(vma->vm_flags & (VM_IO | VM_PFNMAP));
}

/* get a copy of a virtual memory region. */
struct vm_area_struct *exynos_gem_get_vma(struct vm_area_struct *vma);

/* release a userspace virtual memory area. */
void exynos_gem_put_vma(struct vm_area_struct *vma);

/* get pages from user space. */
int exynos_gem_get_pages_from_userptr(unsigned long start,
						unsigned int npages,
						struct page **pages,
						struct vm_area_struct *vma);

/* drop the reference to pages. */
void exynos_gem_put_pages_to_userptr(struct page **pages,
					unsigned int npages,
					struct vm_area_struct *vma);

/* map sgt with dma region. */
int exynos_gem_map_sgt_with_dma(struct drm_device *drm_dev,
				struct sg_table *sgt,
				enum dma_data_direction dir);

/* unmap sgt from dma region. */
void exynos_gem_unmap_sgt_from_dma(struct drm_device *drm_dev,
				struct sg_table *sgt,
				enum dma_data_direction dir);

#endif
Commit	Line	Data
1c248b7d ID	1	/* exynos_drm_gem.h
	2	*
	3	* Copyright (c) 2011 Samsung Electronics Co., Ltd.
	4	* Authoer: Inki Dae <inki.dae@samsung.com>
	5	*
d81aecb5 ID	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms of the GNU General Public License as published by the
	8	* Free Software Foundation; either version 2 of the License, or (at your
	9	* option) any later version.
1c248b7d ID	10	*/
	11
	12	#ifndef _EXYNOS_DRM_GEM_H_
	13	#define _EXYNOS_DRM_GEM_H_
	14
	15	#define to_exynos_gem_obj(x) container_of(x,\
	16	struct exynos_drm_gem_obj, base)
	17
dcf9af82 ID	18	#define IS_NONCONTIG_BUFFER(f) (f & EXYNOS_BO_NONCONTIG)
dcf9af82 ID	19
2c871127 ID	20	/*
	21	* exynos drm gem buffer structure.
	22	*
	23	* @kvaddr: kernel virtual address to allocated memory region.
2a3098ff	24	* *userptr: user space address.
2c871127 ID	25	* @dma_addr: bus address(accessed by dma) to allocated memory region.
	26	* - this address could be physical address without IOMMU and
	27	* device address with IOMMU.
2a3098ff	28	* @write: whether pages will be written to by the caller.
4744ad24	29	* @pages: Array of backing pages.
2b35892e	30	* @sgt: sg table to transfer page data.
2c871127	31	* @size: size of allocated memory region.
2a3098ff ID	32	* @pfnmap: indicate whether memory region from userptr is mmaped with
2a3098ff ID	33	* VM_PFNMAP or not.
2c871127 ID	34	*/
	35	struct exynos_drm_gem_buf {
	36	void __iomem *kvaddr;
2a3098ff	37	unsigned long userptr;
2c871127	38	dma_addr_t dma_addr;
0519f9a1	39	struct dma_attrs dma_attrs;
2a3098ff	40	unsigned int write;
4744ad24	41	struct page **pages;
2b35892e	42	struct sg_table *sgt;
2c871127	43	unsigned long size;
2a3098ff	44	bool pfnmap;
2c871127 ID	45	};
2c871127 ID	46
1c248b7d ID	47	/*
	48	* exynos drm buffer structure.
	49	*
	50	* @base: a gem object.
	51	* - a new handle to this gem object would be created
	52	* by drm_gem_handle_create().
2c871127 ID	53	* @buffer: a pointer to exynos_drm_gem_buffer object.
	54	* - contain the information to memory region allocated
	55	* by user request or at framebuffer creation.
1c248b7d ID	56	* continuous memory region allocated by user request
1c248b7d ID	57	* or at framebuffer creation.
3c52b880 ID	58	* @size: size requested from user, in bytes and this size is aligned
3c52b880 ID	59	* in page unit.
2a3098ff	60	* @vma: a pointer to vm_area.
2b35892e	61	* @flags: indicate memory type to allocated buffer and cache attruibute.
1c248b7d ID	62	*
	63	* P.S. this object would be transfered to user as kms_bo.handle so
	64	* user can access the buffer through kms_bo.handle.
	65	*/
	66	struct exynos_drm_gem_obj {
ee5e770e JS	67	struct drm_gem_object base;
ee5e770e JS	68	struct exynos_drm_gem_buf *buffer;
2b35892e	69	unsigned long size;
2a3098ff	70	struct vm_area_struct *vma;
2b35892e	71	unsigned int flags;
1c248b7d ID	72	};
1c248b7d ID	73
b2df26c1 ID	74	struct page *exynos_gem_get_pages(struct drm_gem_object obj, gfp_t gfpmask);
b2df26c1 ID	75
2364839a JS	76	/* destroy a buffer with gem object */
	77	void exynos_drm_gem_destroy(struct exynos_drm_gem_obj *exynos_gem_obj);
	78
b2df26c1 ID	79	/* create a private gem object and initialize it. */
	80	struct exynos_drm_gem_obj exynos_drm_gem_init(struct drm_device dev,
	81	unsigned long size);
	82
2364839a	83	/* create a new buffer with gem object */
f088d5a9	84	struct exynos_drm_gem_obj exynos_drm_gem_create(struct drm_device dev,
2b35892e ID	85	unsigned int flags,
2b35892e ID	86	unsigned long size);
1c248b7d ID	87
	88	/*
	89	* request gem object creation and buffer allocation as the size
	90	* that it is calculated with framebuffer information such as width,
	91	* height and bpp.
	92	*/
	93	int exynos_drm_gem_create_ioctl(struct drm_device dev, void data,
ee5e770e	94	struct drm_file *file_priv);
1c248b7d	95
f0b1bda7 ID	96	/*
	97	* get dma address from gem handle and this function could be used for
	98	* other drivers such as 2d/3d acceleration drivers.
	99	* with this function call, gem object reference count would be increased.
	100	*/
d87342c1	101	dma_addr_t exynos_drm_gem_get_dma_addr(struct drm_device dev,
f0b1bda7	102	unsigned int gem_handle,
d87342c1	103	struct drm_file *filp);
f0b1bda7 ID	104
	105	/*
	106	* put dma address from gem handle and this function could be used for
	107	* other drivers such as 2d/3d acceleration drivers.
	108	* with this function call, gem object reference count would be decreased.
	109	*/
	110	void exynos_drm_gem_put_dma_addr(struct drm_device *dev,
	111	unsigned int gem_handle,
d87342c1	112	struct drm_file *filp);
f0b1bda7	113
1c248b7d ID	114	/* get buffer offset to map to user space. */
1c248b7d ID	115	int exynos_drm_gem_map_offset_ioctl(struct drm_device dev, void data,
ee5e770e	116	struct drm_file *file_priv);
1c248b7d	117
ee5e770e JS	118	/*
	119	* mmap the physically continuous memory that a gem object contains
	120	* to user space.
	121	*/
	122	int exynos_drm_gem_mmap_ioctl(struct drm_device dev, void data,
	123	struct drm_file *file_priv);
1c248b7d	124
2a3098ff ID	125	/* map user space allocated by malloc to pages. */
	126	int exynos_drm_gem_userptr_ioctl(struct drm_device dev, void data,
	127	struct drm_file *file_priv);
	128
40cd7e0c ID	129	/* get buffer information to memory region allocated by gem. */
	130	int exynos_drm_gem_get_ioctl(struct drm_device dev, void data,
	131	struct drm_file *file_priv);
	132
a4f19aaa ID	133	/* get buffer size to gem handle. */
	134	unsigned long exynos_drm_gem_get_size(struct drm_device *dev,
	135	unsigned int gem_handle,
	136	struct drm_file *file_priv);
	137
1c248b7d ID	138	/* initialize gem object. */
	139	int exynos_drm_gem_init_object(struct drm_gem_object *obj);
	140
	141	/* free gem object. */
	142	void exynos_drm_gem_free_object(struct drm_gem_object *gem_obj);
	143
	144	/* create memory region for drm framebuffer. */
	145	int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
ee5e770e JS	146	struct drm_device *dev,
ee5e770e JS	147	struct drm_mode_create_dumb *args);
1c248b7d ID	148
	149	/* map memory region for drm framebuffer to user space. */
	150	int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv,
ee5e770e JS	151	struct drm_device *dev, uint32_t handle,
ee5e770e JS	152	uint64_t *offset);
1c248b7d ID	153
	154	/*
	155	* destroy memory region allocated.
	156	* - a gem handle and physical memory region pointed by a gem object
	157	* would be released by drm_gem_handle_delete().
	158	*/
	159	int exynos_drm_gem_dumb_destroy(struct drm_file *file_priv,
ee5e770e JS	160	struct drm_device *dev,
	161	unsigned int handle);
	162
	163	/* page fault handler and mmap fault address(virtual) to physical memory. */
	164	int exynos_drm_gem_fault(struct vm_area_struct vma, struct vm_fault vmf);
	165
	166	/* set vm_flags and we can change the vm attribute to other one at here. */
	167	int exynos_drm_gem_mmap(struct file filp, struct vm_area_struct vma);
1c248b7d	168
2a3098ff ID	169	static inline int vma_is_io(struct vm_area_struct *vma)
	170	{
	171	return !!(vma->vm_flags & (VM_IO \| VM_PFNMAP));
	172	}
	173
	174	/* get a copy of a virtual memory region. */
	175	struct vm_area_struct exynos_gem_get_vma(struct vm_area_struct vma);
	176
	177	/* release a userspace virtual memory area. */
	178	void exynos_gem_put_vma(struct vm_area_struct *vma);
	179
	180	/* get pages from user space. */
	181	int exynos_gem_get_pages_from_userptr(unsigned long start,
	182	unsigned int npages,
	183	struct page **pages,
	184	struct vm_area_struct *vma);
	185
	186	/* drop the reference to pages. */
	187	void exynos_gem_put_pages_to_userptr(struct page **pages,
	188	unsigned int npages,
	189	struct vm_area_struct *vma);
	190
	191	/* map sgt with dma region. */
	192	int exynos_gem_map_sgt_with_dma(struct drm_device *drm_dev,
	193	struct sg_table *sgt,
	194	enum dma_data_direction dir);
	195
	196	/* unmap sgt from dma region. */
	197	void exynos_gem_unmap_sgt_from_dma(struct drm_device *drm_dev,
	198	struct sg_table *sgt,
	199	enum dma_data_direction dir);
	200
1c248b7d	201	#endif