[mirror_ubuntu-eoan-kernel.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>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */

#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.
 * @dma_addr: bus address(accessed by dma) to allocated memory region.
 *	- this address could be physical address without IOMMU and
 *	device address with IOMMU.
 * @sgt: sg table to transfer page data.
 * @pages: contain all pages to allocated memory region.
 * @page_size: could be 4K, 64K or 1MB.
 * @size: size of allocated memory region.
 */
struct exynos_drm_gem_buf {
	void __iomem		*kvaddr;
	dma_addr_t		dma_addr;
	struct sg_table		*sgt;
	struct page		**pages;
	unsigned long		page_size;
	unsigned long		size;
};

/*
 * 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: total memory size to physically non-continuous memory region.
 * @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;
	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.
 */
void *exynos_drm_gem_get_dma_addr(struct drm_device *dev,
					unsigned int gem_handle,
					struct drm_file *file_priv);

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

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

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

#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	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a
	7	* copy of this software and associated documentation files (the "Software"),
	8	* to deal in the Software without restriction, including without limitation
	9	* the rights to use, copy, modify, merge, publish, distribute, sublicense,
	10	* and/or sell copies of the Software, and to permit persons to whom the
	11	* Software is furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice (including the next
	14	* paragraph) shall be included in all copies or substantial portions of the
	15	* Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	20	* VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
	21	* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
	22	* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	23	* OTHER DEALINGS IN THE SOFTWARE.
	24	*/
	25
	26	#ifndef _EXYNOS_DRM_GEM_H_
	27	#define _EXYNOS_DRM_GEM_H_
	28
	29	#define to_exynos_gem_obj(x) container_of(x,\
	30	struct exynos_drm_gem_obj, base)
	31
dcf9af82 ID	32	#define IS_NONCONTIG_BUFFER(f) (f & EXYNOS_BO_NONCONTIG)
dcf9af82 ID	33
2c871127 ID	34	/*
	35	* exynos drm gem buffer structure.
	36	*
	37	* @kvaddr: kernel virtual address to allocated memory region.
	38	* @dma_addr: bus address(accessed by dma) to allocated memory region.
	39	* - this address could be physical address without IOMMU and
	40	* device address with IOMMU.
2b35892e ID	41	* @sgt: sg table to transfer page data.
2b35892e ID	42	* @pages: contain all pages to allocated memory region.
b2df26c1	43	* @page_size: could be 4K, 64K or 1MB.
2c871127 ID	44	* @size: size of allocated memory region.
	45	*/
	46	struct exynos_drm_gem_buf {
	47	void __iomem *kvaddr;
	48	dma_addr_t dma_addr;
2b35892e ID	49	struct sg_table *sgt;
2b35892e ID	50	struct page **pages;
b2df26c1	51	unsigned long page_size;
2c871127 ID	52	unsigned long size;
	53	};
	54
1c248b7d ID	55	/*
	56	* exynos drm buffer structure.
	57	*
	58	* @base: a gem object.
	59	* - a new handle to this gem object would be created
	60	* by drm_gem_handle_create().
2c871127 ID	61	* @buffer: a pointer to exynos_drm_gem_buffer object.
	62	* - contain the information to memory region allocated
	63	* by user request or at framebuffer creation.
1c248b7d ID	64	* continuous memory region allocated by user request
1c248b7d ID	65	* or at framebuffer creation.
2b35892e ID	66	* @size: total memory size to physically non-continuous memory region.
2b35892e ID	67	* @flags: indicate memory type to allocated buffer and cache attruibute.
1c248b7d ID	68	*
	69	* P.S. this object would be transfered to user as kms_bo.handle so
	70	* user can access the buffer through kms_bo.handle.
	71	*/
	72	struct exynos_drm_gem_obj {
ee5e770e JS	73	struct drm_gem_object base;
ee5e770e JS	74	struct exynos_drm_gem_buf *buffer;
2b35892e ID	75	unsigned long size;
2b35892e ID	76	unsigned int flags;
1c248b7d ID	77	};
1c248b7d ID	78
b2df26c1 ID	79	struct page *exynos_gem_get_pages(struct drm_gem_object obj, gfp_t gfpmask);
b2df26c1 ID	80
2364839a JS	81	/* destroy a buffer with gem object */
	82	void exynos_drm_gem_destroy(struct exynos_drm_gem_obj *exynos_gem_obj);
	83
b2df26c1 ID	84	/* create a private gem object and initialize it. */
	85	struct exynos_drm_gem_obj exynos_drm_gem_init(struct drm_device dev,
	86	unsigned long size);
	87
2364839a	88	/* create a new buffer with gem object */
f088d5a9	89	struct exynos_drm_gem_obj exynos_drm_gem_create(struct drm_device dev,
2b35892e ID	90	unsigned int flags,
2b35892e ID	91	unsigned long size);
1c248b7d ID	92
	93	/*
	94	* request gem object creation and buffer allocation as the size
	95	* that it is calculated with framebuffer information such as width,
	96	* height and bpp.
	97	*/
	98	int exynos_drm_gem_create_ioctl(struct drm_device dev, void data,
ee5e770e	99	struct drm_file *file_priv);
1c248b7d	100
f0b1bda7 ID	101	/*
	102	* get dma address from gem handle and this function could be used for
	103	* other drivers such as 2d/3d acceleration drivers.
	104	* with this function call, gem object reference count would be increased.
	105	*/
	106	void exynos_drm_gem_get_dma_addr(struct drm_device dev,
	107	unsigned int gem_handle,
	108	struct drm_file *file_priv);
	109
	110	/*
	111	* put dma address from gem handle and this function could be used for
	112	* other drivers such as 2d/3d acceleration drivers.
	113	* with this function call, gem object reference count would be decreased.
	114	*/
	115	void exynos_drm_gem_put_dma_addr(struct drm_device *dev,
	116	unsigned int gem_handle,
	117	struct drm_file *file_priv);
	118
1c248b7d ID	119	/* get buffer offset to map to user space. */
1c248b7d ID	120	int exynos_drm_gem_map_offset_ioctl(struct drm_device dev, void data,
ee5e770e	121	struct drm_file *file_priv);
1c248b7d	122
ee5e770e JS	123	/*
	124	* mmap the physically continuous memory that a gem object contains
	125	* to user space.
	126	*/
	127	int exynos_drm_gem_mmap_ioctl(struct drm_device dev, void data,
	128	struct drm_file *file_priv);
1c248b7d ID	129
	130	/* initialize gem object. */
	131	int exynos_drm_gem_init_object(struct drm_gem_object *obj);
	132
	133	/* free gem object. */
	134	void exynos_drm_gem_free_object(struct drm_gem_object *gem_obj);
	135
	136	/* create memory region for drm framebuffer. */
	137	int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
ee5e770e JS	138	struct drm_device *dev,
ee5e770e JS	139	struct drm_mode_create_dumb *args);
1c248b7d ID	140
	141	/* map memory region for drm framebuffer to user space. */
	142	int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv,
ee5e770e JS	143	struct drm_device *dev, uint32_t handle,
ee5e770e JS	144	uint64_t *offset);
1c248b7d ID	145
	146	/*
	147	* destroy memory region allocated.
	148	* - a gem handle and physical memory region pointed by a gem object
	149	* would be released by drm_gem_handle_delete().
	150	*/
	151	int exynos_drm_gem_dumb_destroy(struct drm_file *file_priv,
ee5e770e JS	152	struct drm_device *dev,
	153	unsigned int handle);
	154
	155	/* page fault handler and mmap fault address(virtual) to physical memory. */
	156	int exynos_drm_gem_fault(struct vm_area_struct vma, struct vm_fault vmf);
	157
	158	/* set vm_flags and we can change the vm attribute to other one at here. */
	159	int exynos_drm_gem_mmap(struct file filp, struct vm_area_struct vma);
1c248b7d ID	160
1c248b7d ID	161	#endif