74384858a6f56ef783de117f7fe9dd52c676de45
[platform/upstream/libdrm.git] / freedreno / freedreno_priv.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_PRIV_H_
30 #define FREEDRENO_PRIV_H_
31
32 #include <stdlib.h>
33 #include <errno.h>
34 #include <string.h>
35 #include <unistd.h>
36 #include <errno.h>
37 #include <fcntl.h>
38 #include <sys/ioctl.h>
39 #include <sys/mman.h>
40 #include <pthread.h>
41 #include <stdio.h>
42 #include <assert.h>
43
44 #include "xf86drm.h"
45 #include "xf86atomic.h"
46
47 #include "list.h"
48
49 #include "freedreno_drmif.h"
50 #include "freedreno_ringbuffer.h"
51 #include "drm.h"
52
53 struct fd_device_funcs {
54         int (*bo_new_handle)(struct fd_device *dev, uint32_t size,
55                         uint32_t flags, uint32_t *handle);
56         struct fd_bo * (*bo_from_handle)(struct fd_device *dev,
57                         uint32_t size, uint32_t handle);
58         struct fd_pipe * (*pipe_new)(struct fd_device *dev, enum fd_pipe_id id);
59         void (*destroy)(struct fd_device *dev);
60 };
61
62 struct fd_bo_bucket {
63         uint32_t size;
64         struct list_head list;
65 };
66
67 struct fd_device {
68         int fd;
69         atomic_t refcnt;
70
71         /* tables to keep track of bo's, to avoid "evil-twin" fd_bo objects:
72          *
73          *   handle_table: maps handle to fd_bo
74          *   name_table: maps flink name to fd_bo
75          *
76          * We end up needing two tables, because DRM_IOCTL_GEM_OPEN always
77          * returns a new handle.  So we need to figure out if the bo is already
78          * open in the process first, before calling gem-open.
79          */
80         void *handle_table, *name_table;
81
82         struct fd_device_funcs *funcs;
83
84         struct fd_bo_bucket cache_bucket[14 * 4];
85         int num_buckets;
86         time_t time;
87
88         int closefd;        /* call close(fd) upon destruction */
89 };
90
91 void fd_cleanup_bo_cache(struct fd_device *dev, time_t time);
92
93 /* for where @table_lock is already held: */
94 void fd_device_del_locked(struct fd_device *dev);
95
96 struct fd_pipe_funcs {
97         struct fd_ringbuffer * (*ringbuffer_new)(struct fd_pipe *pipe, uint32_t size);
98         int (*get_param)(struct fd_pipe *pipe, enum fd_param_id param, uint64_t *value);
99         int (*wait)(struct fd_pipe *pipe, uint32_t timestamp);
100         void (*destroy)(struct fd_pipe *pipe);
101 };
102
103 struct fd_pipe {
104         struct fd_device *dev;
105         enum fd_pipe_id id;
106         struct fd_pipe_funcs *funcs;
107 };
108
109 struct fd_ringmarker {
110         struct fd_ringbuffer *ring;
111         uint32_t *cur;
112 };
113
114 struct fd_ringbuffer_funcs {
115         void * (*hostptr)(struct fd_ringbuffer *ring);
116         int (*flush)(struct fd_ringbuffer *ring, uint32_t *last_start);
117         void (*reset)(struct fd_ringbuffer *ring);
118         void (*emit_reloc)(struct fd_ringbuffer *ring,
119                         const struct fd_reloc *reloc);
120         void (*emit_reloc_ring)(struct fd_ringbuffer *ring,
121                         struct fd_ringmarker *target, struct fd_ringmarker *end);
122         void (*destroy)(struct fd_ringbuffer *ring);
123 };
124
125 struct fd_bo_funcs {
126         int (*offset)(struct fd_bo *bo, uint64_t *offset);
127         int (*cpu_prep)(struct fd_bo *bo, struct fd_pipe *pipe, uint32_t op);
128         void (*cpu_fini)(struct fd_bo *bo);
129         void (*destroy)(struct fd_bo *bo);
130 };
131
132 struct fd_bo {
133         struct fd_device *dev;
134         uint32_t size;
135         uint32_t handle;
136         uint32_t name;
137         void *map;
138         atomic_t refcnt;
139         struct fd_bo_funcs *funcs;
140
141         int bo_reuse;
142         struct list_head list;   /* bucket-list entry */
143         time_t free_time;        /* time when added to bucket-list */
144 };
145
146 struct fd_bo *fd_bo_from_handle(struct fd_device *dev,
147                 uint32_t handle, uint32_t size);
148
149 #define ALIGN(v,a) (((v) + (a) - 1) & ~((a) - 1))
150 #define ARRAY_SIZE(arr) (sizeof(arr) / sizeof((arr)[0]))
151
152 #define enable_debug 0  /* TODO make dynamic */
153
154 #define INFO_MSG(fmt, ...) \
155                 do { drmMsg("[I] "fmt " (%s:%d)\n", \
156                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
157 #define DEBUG_MSG(fmt, ...) \
158                 do if (enable_debug) { drmMsg("[D] "fmt " (%s:%d)\n", \
159                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
160 #define WARN_MSG(fmt, ...) \
161                 do { drmMsg("[W] "fmt " (%s:%d)\n", \
162                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
163 #define ERROR_MSG(fmt, ...) \
164                 do { drmMsg("[E] " fmt " (%s:%d)\n", \
165                                 ##__VA_ARGS__, __FUNCTION__, __LINE__); } while (0)
166
167 #define U642VOID(x) ((void *)(unsigned long)(x))
168 #define VOID2U64(x) ((uint64_t)(unsigned long)(x))
169
170 #endif /* FREEDRENO_PRIV_H_ */