freedreno: add dmabuf import/export helpers
[platform/upstream/libdrm.git] / freedreno / freedreno_drmif.h
1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
2
3 /*
4  * Copyright (C) 2012 Rob Clark <robclark@freedesktop.org>
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  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  *
25  * Authors:
26  *    Rob Clark <robclark@freedesktop.org>
27  */
28
29 #ifndef FREEDRENO_DRMIF_H_
30 #define FREEDRENO_DRMIF_H_
31
32 #include <xf86drm.h>
33 #include <stdint.h>
34
35 struct fd_bo;
36 struct fd_pipe;
37 struct fd_device;
38
39 enum fd_pipe_id {
40         FD_PIPE_3D = 1,
41         FD_PIPE_2D = 2,
42         /* some devices have two 2d blocks.. not really sure how to
43          * use that yet, so just ignoring the 2nd 2d pipe for now
44          */
45         FD_PIPE_MAX
46 };
47
48 enum fd_param_id {
49         FD_DEVICE_ID,
50         FD_GMEM_SIZE,
51         FD_GPU_ID,
52         FD_CHIP_ID,
53 };
54
55 /* bo flags: */
56 #define DRM_FREEDRENO_GEM_TYPE_SMI        0x00000001
57 #define DRM_FREEDRENO_GEM_TYPE_KMEM       0x00000002
58 #define DRM_FREEDRENO_GEM_TYPE_MEM_MASK   0x0000000f
59 #define DRM_FREEDRENO_GEM_CACHE_NONE      0x00000000
60 #define DRM_FREEDRENO_GEM_CACHE_WCOMBINE  0x00100000
61 #define DRM_FREEDRENO_GEM_CACHE_WTHROUGH  0x00200000
62 #define DRM_FREEDRENO_GEM_CACHE_WBACK     0x00400000
63 #define DRM_FREEDRENO_GEM_CACHE_WBACKWA   0x00800000
64 #define DRM_FREEDRENO_GEM_CACHE_MASK      0x00f00000
65 #define DRM_FREEDRENO_GEM_GPUREADONLY     0x01000000
66
67 /* bo access flags: (keep aligned to MSM_PREP_x) */
68 #define DRM_FREEDRENO_PREP_READ           0x01
69 #define DRM_FREEDRENO_PREP_WRITE          0x02
70 #define DRM_FREEDRENO_PREP_NOSYNC         0x04
71
72 /* device functions:
73  */
74
75 struct fd_device * fd_device_new(int fd);
76 struct fd_device * fd_device_new_dup(int fd);
77 struct fd_device * fd_device_ref(struct fd_device *dev);
78 void fd_device_del(struct fd_device *dev);
79
80
81 /* pipe functions:
82  */
83
84 struct fd_pipe * fd_pipe_new(struct fd_device *dev, enum fd_pipe_id id);
85 void fd_pipe_del(struct fd_pipe *pipe);
86 int fd_pipe_get_param(struct fd_pipe *pipe, enum fd_param_id param,
87                 uint64_t *value);
88 int fd_pipe_wait(struct fd_pipe *pipe, uint32_t timestamp);
89
90
91 /* buffer-object functions:
92  */
93
94 struct fd_bo * fd_bo_new(struct fd_device *dev,
95                 uint32_t size, uint32_t flags);
96 struct fd_bo * fd_bo_from_fbdev(struct fd_pipe *pipe,
97                 int fbfd, uint32_t size);
98 struct fd_bo *fd_bo_from_handle(struct fd_device *dev,
99                 uint32_t handle, uint32_t size);
100 struct fd_bo * fd_bo_from_name(struct fd_device *dev, uint32_t name);
101 struct fd_bo * fd_bo_from_dmabuf(struct fd_device *dev, int fd);
102 struct fd_bo * fd_bo_ref(struct fd_bo *bo);
103 void fd_bo_del(struct fd_bo *bo);
104 int fd_bo_get_name(struct fd_bo *bo, uint32_t *name);
105 uint32_t fd_bo_handle(struct fd_bo *bo);
106 int fd_bo_dmabuf(struct fd_bo *bo);
107 uint32_t fd_bo_size(struct fd_bo *bo);
108 void * fd_bo_map(struct fd_bo *bo);
109 int fd_bo_cpu_prep(struct fd_bo *bo, struct fd_pipe *pipe, uint32_t op);
110 void fd_bo_cpu_fini(struct fd_bo *bo);
111
112 #endif /* FREEDRENO_DRMIF_H_ */