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 32 #define IS_NONCONTIG_BUFFER(f) (f & EXYNOS_BO_NONCONTIG) 33 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. 41 * @sgt: sg table to transfer page data. 42 * @pages: contain all pages to allocated memory region. 43 * @size: size of allocated memory region. 44 */ 45 struct exynos_drm_gem_buf { 46 void __iomem *kvaddr; 47 dma_addr_t dma_addr; 48 struct sg_table *sgt; 49 struct page **pages; 50 unsigned long size; 51 }; 52 53 /* 54 * exynos drm buffer structure. 55 * 56 * @base: a gem object. 57 * - a new handle to this gem object would be created 58 * by drm_gem_handle_create(). 59 * @buffer: a pointer to exynos_drm_gem_buffer object. 60 * - contain the information to memory region allocated 61 * by user request or at framebuffer creation. 62 * continuous memory region allocated by user request 63 * or at framebuffer creation. 64 * @size: total memory size to physically non-continuous memory region. 65 * @flags: indicate memory type to allocated buffer and cache attruibute. 66 * 67 * P.S. this object would be transfered to user as kms_bo.handle so 68 * user can access the buffer through kms_bo.handle. 69 */ 70 struct exynos_drm_gem_obj { 71 struct drm_gem_object base; 72 struct exynos_drm_gem_buf *buffer; 73 unsigned long size; 74 unsigned int flags; 75 }; 76 77 /* destroy a buffer with gem object */ 78 void exynos_drm_gem_destroy(struct exynos_drm_gem_obj *exynos_gem_obj); 79 80 /* create a new buffer with gem object */ 81 struct exynos_drm_gem_obj *exynos_drm_gem_create(struct drm_device *dev, 82 unsigned int flags, 83 unsigned long size); 84 85 /* 86 * request gem object creation and buffer allocation as the size 87 * that it is calculated with framebuffer information such as width, 88 * height and bpp. 89 */ 90 int exynos_drm_gem_create_ioctl(struct drm_device *dev, void *data, 91 struct drm_file *file_priv); 92 93 /* 94 * get dma address from gem handle and this function could be used for 95 * other drivers such as 2d/3d acceleration drivers. 96 * with this function call, gem object reference count would be increased. 97 */ 98 void *exynos_drm_gem_get_dma_addr(struct drm_device *dev, 99 unsigned int gem_handle, 100 struct drm_file *file_priv); 101 102 /* 103 * put dma address from gem handle and this function could be used for 104 * other drivers such as 2d/3d acceleration drivers. 105 * with this function call, gem object reference count would be decreased. 106 */ 107 void exynos_drm_gem_put_dma_addr(struct drm_device *dev, 108 unsigned int gem_handle, 109 struct drm_file *file_priv); 110 111 /* get buffer offset to map to user space. */ 112 int exynos_drm_gem_map_offset_ioctl(struct drm_device *dev, void *data, 113 struct drm_file *file_priv); 114 115 /* 116 * mmap the physically continuous memory that a gem object contains 117 * to user space. 118 */ 119 int exynos_drm_gem_mmap_ioctl(struct drm_device *dev, void *data, 120 struct drm_file *file_priv); 121 122 /* initialize gem object. */ 123 int exynos_drm_gem_init_object(struct drm_gem_object *obj); 124 125 /* free gem object. */ 126 void exynos_drm_gem_free_object(struct drm_gem_object *gem_obj); 127 128 /* create memory region for drm framebuffer. */ 129 int exynos_drm_gem_dumb_create(struct drm_file *file_priv, 130 struct drm_device *dev, 131 struct drm_mode_create_dumb *args); 132 133 /* map memory region for drm framebuffer to user space. */ 134 int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv, 135 struct drm_device *dev, uint32_t handle, 136 uint64_t *offset); 137 138 /* 139 * destroy memory region allocated. 140 * - a gem handle and physical memory region pointed by a gem object 141 * would be released by drm_gem_handle_delete(). 142 */ 143 int exynos_drm_gem_dumb_destroy(struct drm_file *file_priv, 144 struct drm_device *dev, 145 unsigned int handle); 146 147 /* page fault handler and mmap fault address(virtual) to physical memory. */ 148 int exynos_drm_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf); 149 150 /* set vm_flags and we can change the vm attribute to other one at here. */ 151 int exynos_drm_gem_mmap(struct file *filp, struct vm_area_struct *vma); 152 153 #endif 154