drivers/gpu/drm/exynos/exynos_drm_gem.h

   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 /*
  33  * exynos drm gem buffer structure.
  34  *
  35  * @kvaddr: kernel virtual address to allocated memory region.
  36  * @dma_addr: bus address(accessed by dma) to allocated memory region.
  37  *      - this address could be physical address without IOMMU and
  38  *      device address with IOMMU.
  39  * @size: size of allocated memory region.
  40  */
  41 struct exynos_drm_gem_buf {
  42         void __iomem            *kvaddr;
  43         dma_addr_t              dma_addr;
  44         unsigned long           size;
  45 };
  46
  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().
  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.
  56  *      continuous memory region allocated by user request
  57  *      or at framebuffer creation.
  58  *
  59  * P.S. this object would be transfered to user as kms_bo.handle so
  60  *      user can access the buffer through kms_bo.handle.
  61  */
  62 struct exynos_drm_gem_obj {
  63         struct drm_gem_object           base;
  64         struct exynos_drm_gem_buf       *buffer;
  65 };
  66
  67 /* destroy a buffer with gem object */
  68 void exynos_drm_gem_destroy(struct exynos_drm_gem_obj *exynos_gem_obj);
  69
  70 /* create a new buffer with gem object */
  71 struct exynos_drm_gem_obj *exynos_drm_gem_create(struct drm_device *dev,
  72                                                  unsigned long size);
  73
  74 /*
  75  * request gem object creation and buffer allocation as the size
  76  * that it is calculated with framebuffer information such as width,
  77  * height and bpp.
  78  */
  79 int exynos_drm_gem_create_ioctl(struct drm_device *dev, void *data,
  80                                 struct drm_file *file_priv);
  81
  82 /* get buffer offset to map to user space. */
  83 int exynos_drm_gem_map_offset_ioctl(struct drm_device *dev, void *data,
  84                                     struct drm_file *file_priv);
  85
  86 /*
  87  * mmap the physically continuous memory that a gem object contains
  88  * to user space.
  89  */
  90 int exynos_drm_gem_mmap_ioctl(struct drm_device *dev, void *data,
  91                               struct drm_file *file_priv);
  92
  93 /* initialize gem object. */
  94 int exynos_drm_gem_init_object(struct drm_gem_object *obj);
  95
  96 /* free gem object. */
  97 void exynos_drm_gem_free_object(struct drm_gem_object *gem_obj);
  98
  99 /* create memory region for drm framebuffer. */
 100 int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
 101                                struct drm_device *dev,
 102                                struct drm_mode_create_dumb *args);
 103
 104 /* map memory region for drm framebuffer to user space. */
 105 int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv,
 106                                    struct drm_device *dev, uint32_t handle,
 107                                    uint64_t *offset);
 108
 109 /*
 110  * destroy memory region allocated.
 111  *      - a gem handle and physical memory region pointed by a gem object
 112  *      would be released by drm_gem_handle_delete().
 113  */
 114 int exynos_drm_gem_dumb_destroy(struct drm_file *file_priv,
 115                                 struct drm_device *dev,
 116                                 unsigned int handle);
 117
 118 /* page fault handler and mmap fault address(virtual) to physical memory. */
 119 int exynos_drm_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
 120
 121 /* set vm_flags and we can change the vm attribute to other one at here. */
 122 int exynos_drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
 123
 124 #endif