tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 */
41struct 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 */
62struct exynos_drm_gem_obj {
63 struct drm_gem_object base;
64 struct exynos_drm_gem_buf *buffer;
65};
66
67/* create a new buffer and get a new gem handle. */
68struct exynos_drm_gem_obj *exynos_drm_gem_create(struct drm_device *dev,
69 struct drm_file *file_priv,
70 unsigned int *handle, unsigned long size);
71
72/*
73 * request gem object creation and buffer allocation as the size
74 * that it is calculated with framebuffer information such as width,
75 * height and bpp.
76 */
77int exynos_drm_gem_create_ioctl(struct drm_device *dev, void *data,
78 struct drm_file *file_priv);
79
80/* get buffer offset to map to user space. */
81int exynos_drm_gem_map_offset_ioctl(struct drm_device *dev, void *data,
82 struct drm_file *file_priv);
83
84/* unmap a buffer from user space. */
85int exynos_drm_gem_munmap_ioctl(struct drm_device *dev, void *data,
86 struct drm_file *file_priv);
87
88/* initialize gem object. */
89int exynos_drm_gem_init_object(struct drm_gem_object *obj);
90
91/* free gem object. */
92void exynos_drm_gem_free_object(struct drm_gem_object *gem_obj);
93
94/* create memory region for drm framebuffer. */
95int exynos_drm_gem_dumb_create(struct drm_file *file_priv,
96 struct drm_device *dev, struct drm_mode_create_dumb *args);
97
98/* map memory region for drm framebuffer to user space. */
99int exynos_drm_gem_dumb_map_offset(struct drm_file *file_priv,
100 struct drm_device *dev, uint32_t handle, uint64_t *offset);
101
102/* page fault handler and mmap fault address(virtual) to physical memory. */
103int exynos_drm_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf);
104
105/*
106 * mmap the physically continuous memory that a gem object contains
107 * to user space.
108 */
109int exynos_drm_gem_mmap_ioctl(struct drm_device *dev, void *data,
110 struct drm_file *file_priv);
111
112/* set vm_flags and we can change the vm attribute to other one at here. */
113int exynos_drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
114
115/*
116 * destroy memory region allocated.
117 * - a gem handle and physical memory region pointed by a gem object
118 * would be released by drm_gem_handle_delete().
119 */
120int exynos_drm_gem_dumb_destroy(struct drm_file *file_priv,
121 struct drm_device *dev, unsigned int handle);
122
123#endif