freedreno/drm: sync uapi and enable softpin
[mesa.git] / src / freedreno / drm / freedreno_drmif.h
1 /*
2 * Copyright (C) 2012-2018 Rob Clark <robclark@freedesktop.org>
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
13 * Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 *
23 * Authors:
24 * Rob Clark <robclark@freedesktop.org>
25 */
26
27 #ifndef FREEDRENO_DRMIF_H_
28 #define FREEDRENO_DRMIF_H_
29
30 #include <stdint.h>
31
32 struct fd_bo;
33 struct fd_pipe;
34 struct fd_device;
35
36 enum fd_pipe_id {
37 FD_PIPE_3D = 1,
38 FD_PIPE_2D = 2,
39 /* some devices have two 2d blocks.. not really sure how to
40 * use that yet, so just ignoring the 2nd 2d pipe for now
41 */
42 FD_PIPE_MAX
43 };
44
45 enum fd_param_id {
46 FD_DEVICE_ID,
47 FD_GMEM_SIZE,
48 FD_GPU_ID,
49 FD_CHIP_ID,
50 FD_MAX_FREQ,
51 FD_TIMESTAMP,
52 FD_NR_RINGS, /* # of rings == # of distinct priority levels */
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 #define DRM_FREEDRENO_GEM_SCANOUT 0x02000000
67
68 /* bo access flags: (keep aligned to MSM_PREP_x) */
69 #define DRM_FREEDRENO_PREP_READ 0x01
70 #define DRM_FREEDRENO_PREP_WRITE 0x02
71 #define DRM_FREEDRENO_PREP_NOSYNC 0x04
72
73 /* device functions:
74 */
75
76 struct fd_device * fd_device_new(int fd);
77 struct fd_device * fd_device_new_dup(int fd);
78 struct fd_device * fd_device_ref(struct fd_device *dev);
79 void fd_device_del(struct fd_device *dev);
80 int fd_device_fd(struct fd_device *dev);
81
82 enum fd_version {
83 FD_VERSION_MADVISE = 1, /* kernel supports madvise */
84 FD_VERSION_UNLIMITED_CMDS = 1, /* submits w/ >4 cmd buffers (growable ringbuffer) */
85 FD_VERSION_FENCE_FD = 2, /* submit command supports in/out fences */
86 FD_VERSION_SUBMIT_QUEUES = 3, /* submit queues and multiple priority levels */
87 FD_VERSION_BO_IOVA = 3, /* supports fd_bo_get/put_iova() */
88 FD_VERSION_SOFTPIN = 4, /* adds softpin, bo name, and dump flag */
89 };
90 enum fd_version fd_device_version(struct fd_device *dev);
91
92 /* pipe functions:
93 */
94
95 struct fd_pipe * fd_pipe_new(struct fd_device *dev, enum fd_pipe_id id);
96 struct fd_pipe * fd_pipe_new2(struct fd_device *dev, enum fd_pipe_id id, uint32_t prio);
97 struct fd_pipe * fd_pipe_ref(struct fd_pipe *pipe);
98 void fd_pipe_del(struct fd_pipe *pipe);
99 int fd_pipe_get_param(struct fd_pipe *pipe, enum fd_param_id param,
100 uint64_t *value);
101 int fd_pipe_wait(struct fd_pipe *pipe, uint32_t timestamp);
102 /* timeout in nanosec */
103 int fd_pipe_wait_timeout(struct fd_pipe *pipe, uint32_t timestamp,
104 uint64_t timeout);
105
106
107 /* buffer-object functions:
108 */
109
110 struct fd_bo * fd_bo_new(struct fd_device *dev,
111 uint32_t size, uint32_t flags);
112 struct fd_bo *fd_bo_from_handle(struct fd_device *dev,
113 uint32_t handle, uint32_t size);
114 struct fd_bo * fd_bo_from_name(struct fd_device *dev, uint32_t name);
115 struct fd_bo * fd_bo_from_dmabuf(struct fd_device *dev, int fd);
116 uint64_t fd_bo_get_iova(struct fd_bo *bo);
117 void fd_bo_put_iova(struct fd_bo *bo);
118 struct fd_bo * fd_bo_ref(struct fd_bo *bo);
119 void fd_bo_del(struct fd_bo *bo);
120 int fd_bo_get_name(struct fd_bo *bo, uint32_t *name);
121 uint32_t fd_bo_handle(struct fd_bo *bo);
122 int fd_bo_dmabuf(struct fd_bo *bo);
123 uint32_t fd_bo_size(struct fd_bo *bo);
124 void * fd_bo_map(struct fd_bo *bo);
125 int fd_bo_cpu_prep(struct fd_bo *bo, struct fd_pipe *pipe, uint32_t op);
126 void fd_bo_cpu_fini(struct fd_bo *bo);
127
128 #endif /* FREEDRENO_DRMIF_H_ */