freedreno_drmif.h revision 7cdc0497
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#if defined(__GNUC__)
36#  define drm_deprecated __attribute__((__deprecated__))
37#else
38#  define drm_deprecated
39#endif
40
41/* an empty marker for things that will be deprecated in the future: */
42#define will_be_deprecated
43
44struct fd_bo;
45struct fd_pipe;
46struct fd_device;
47
48enum fd_pipe_id {
49	FD_PIPE_3D = 1,
50	FD_PIPE_2D = 2,
51	/* some devices have two 2d blocks.. not really sure how to
52	 * use that yet, so just ignoring the 2nd 2d pipe for now
53	 */
54	FD_PIPE_MAX
55};
56
57enum fd_param_id {
58	FD_DEVICE_ID,
59	FD_GMEM_SIZE,
60	FD_GPU_ID,
61	FD_CHIP_ID,
62	FD_MAX_FREQ,
63	FD_TIMESTAMP,
64	FD_NR_RINGS,      /* # of rings == # of distinct priority levels */
65};
66
67/* bo flags: */
68#define DRM_FREEDRENO_GEM_TYPE_SMI        0x00000001
69#define DRM_FREEDRENO_GEM_TYPE_KMEM       0x00000002
70#define DRM_FREEDRENO_GEM_TYPE_MEM_MASK   0x0000000f
71#define DRM_FREEDRENO_GEM_CACHE_NONE      0x00000000
72#define DRM_FREEDRENO_GEM_CACHE_WCOMBINE  0x00100000
73#define DRM_FREEDRENO_GEM_CACHE_WTHROUGH  0x00200000
74#define DRM_FREEDRENO_GEM_CACHE_WBACK     0x00400000
75#define DRM_FREEDRENO_GEM_CACHE_WBACKWA   0x00800000
76#define DRM_FREEDRENO_GEM_CACHE_MASK      0x00f00000
77#define DRM_FREEDRENO_GEM_GPUREADONLY     0x01000000
78
79/* bo access flags: (keep aligned to MSM_PREP_x) */
80#define DRM_FREEDRENO_PREP_READ           0x01
81#define DRM_FREEDRENO_PREP_WRITE          0x02
82#define DRM_FREEDRENO_PREP_NOSYNC         0x04
83
84/* device functions:
85 */
86
87struct fd_device * fd_device_new(int fd);
88struct fd_device * fd_device_new_dup(int fd);
89struct fd_device * fd_device_ref(struct fd_device *dev);
90void fd_device_del(struct fd_device *dev);
91int fd_device_fd(struct fd_device *dev);
92
93enum fd_version {
94	FD_VERSION_MADVISE = 1,            /* kernel supports madvise */
95	FD_VERSION_UNLIMITED_CMDS = 1,     /* submits w/ >4 cmd buffers (growable ringbuffer) */
96	FD_VERSION_FENCE_FD = 2,           /* submit command supports in/out fences */
97	FD_VERSION_SUBMIT_QUEUES = 3,      /* submit queues and multiple priority levels */
98	FD_VERSION_BO_IOVA = 3,            /* supports fd_bo_get/put_iova() */
99};
100enum fd_version fd_device_version(struct fd_device *dev);
101
102/* pipe functions:
103 */
104
105struct fd_pipe * fd_pipe_new(struct fd_device *dev, enum fd_pipe_id id);
106struct fd_pipe * fd_pipe_new2(struct fd_device *dev, enum fd_pipe_id id, uint32_t prio);
107struct fd_pipe * fd_pipe_ref(struct fd_pipe *pipe);
108void fd_pipe_del(struct fd_pipe *pipe);
109int fd_pipe_get_param(struct fd_pipe *pipe, enum fd_param_id param,
110		uint64_t *value);
111int fd_pipe_wait(struct fd_pipe *pipe, uint32_t timestamp);
112/* timeout in nanosec */
113int fd_pipe_wait_timeout(struct fd_pipe *pipe, uint32_t timestamp,
114		uint64_t timeout);
115
116
117/* buffer-object functions:
118 */
119
120struct fd_bo * fd_bo_new(struct fd_device *dev,
121		uint32_t size, uint32_t flags);
122struct fd_bo * fd_bo_from_fbdev(struct fd_pipe *pipe,
123		int fbfd, uint32_t size);
124struct fd_bo *fd_bo_from_handle(struct fd_device *dev,
125		uint32_t handle, uint32_t size);
126struct fd_bo * fd_bo_from_name(struct fd_device *dev, uint32_t name);
127struct fd_bo * fd_bo_from_dmabuf(struct fd_device *dev, int fd);
128uint64_t fd_bo_get_iova(struct fd_bo *bo);
129void fd_bo_put_iova(struct fd_bo *bo);
130struct fd_bo * fd_bo_ref(struct fd_bo *bo);
131void fd_bo_del(struct fd_bo *bo);
132int fd_bo_get_name(struct fd_bo *bo, uint32_t *name);
133uint32_t fd_bo_handle(struct fd_bo *bo);
134int fd_bo_dmabuf(struct fd_bo *bo);
135uint32_t fd_bo_size(struct fd_bo *bo);
136void * fd_bo_map(struct fd_bo *bo);
137int fd_bo_cpu_prep(struct fd_bo *bo, struct fd_pipe *pipe, uint32_t op);
138void fd_bo_cpu_fini(struct fd_bo *bo);
139
140#endif /* FREEDRENO_DRMIF_H_ */
141