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_RINGBUFFER_H_
30 #define FREEDRENO_RINGBUFFER_H_
31
32 #include <freedreno_drmif.h>
33
34 /* the ringbuffer object is not opaque so that OUT_RING() type stuff
35 * can be inlined. Note that users should not make assumptions about
36 * the size of this struct.
37 */
38
39 struct fd_ringbuffer_funcs;
40
41 enum fd_ringbuffer_flags {
42
43 /* Ringbuffer is a "state object", which is potentially reused
44 * many times, rather than being used in one-shot mode linked
45 * to a parent ringbuffer.
46 */
47 FD_RINGBUFFER_OBJECT = 0x1,
48
49 /* Hint that the stateobj will be used for streaming state
50 * that is used once or a few times and then discarded.
51 *
52 * For sub-allocation, non streaming stateobj's should be
53 * sub-allocated from a page size buffer, so one long lived
54 * state obj doesn't prevent other pages from being freed.
55 * (Ie. it would be no worse than allocating a page sized
56 * bo for each small non-streaming stateobj).
57 *
58 * But streaming stateobj's could be sub-allocated from a
59 * larger buffer to reduce the alloc/del overhead.
60 */
61 FD_RINGBUFFER_STREAMING = 0x2,
62 };
63
64 struct fd_ringbuffer {
65 int size;
66 uint32_t *cur, *end, *start, *last_start;
67 struct fd_pipe *pipe;
68 const struct fd_ringbuffer_funcs *funcs;
69 uint32_t last_timestamp;
70 struct fd_ringbuffer *parent;
71
72 /* for users of fd_ringbuffer to store their own private per-
73 * ringbuffer data
74 */
75 void *user;
76
77 enum fd_ringbuffer_flags flags;
78
79 /* This is a bit gross, but we can't use atomic_t in exported
80 * headers. OTOH, we don't need the refcnt to be publicly
81 * visible. The only reason that this struct is exported is
82 * because fd_ringbuffer_emit needs to be something that can
83 * be inlined for performance reasons.
84 */
85 union {
86 #ifdef HAS_ATOMIC_OPS
87 atomic_t refcnt;
88 #endif
89 uint64_t __pad;
90 };
91 };
92
93 struct fd_ringbuffer * fd_ringbuffer_new(struct fd_pipe *pipe,
94 uint32_t size);
95 will_be_deprecated
96 struct fd_ringbuffer * fd_ringbuffer_new_object(struct fd_pipe *pipe,
97 uint32_t size);
98 struct fd_ringbuffer * fd_ringbuffer_new_flags(struct fd_pipe *pipe,
99 uint32_t size, enum fd_ringbuffer_flags flags);
100
101 struct fd_ringbuffer *fd_ringbuffer_ref(struct fd_ringbuffer *ring);
102 void fd_ringbuffer_del(struct fd_ringbuffer *ring);
103 void fd_ringbuffer_set_parent(struct fd_ringbuffer *ring,
104 struct fd_ringbuffer *parent);
105 will_be_deprecated
106 void fd_ringbuffer_reset(struct fd_ringbuffer *ring);
107 int fd_ringbuffer_flush(struct fd_ringbuffer *ring);
108 /* in_fence_fd: -1 for no in-fence, else fence fd
109 * out_fence_fd: NULL for no output-fence requested, else ptr to return out-fence
110 */
111 int fd_ringbuffer_flush2(struct fd_ringbuffer *ring, int in_fence_fd,
112 int *out_fence_fd);
113 void fd_ringbuffer_grow(struct fd_ringbuffer *ring, uint32_t ndwords);
114 uint32_t fd_ringbuffer_timestamp(struct fd_ringbuffer *ring);
115
fd_ringbuffer_emit(struct fd_ringbuffer * ring,uint32_t data)116 static inline void fd_ringbuffer_emit(struct fd_ringbuffer *ring,
117 uint32_t data)
118 {
119 (*ring->cur++) = data;
120 }
121
122 struct fd_reloc {
123 struct fd_bo *bo;
124 #define FD_RELOC_READ 0x0001
125 #define FD_RELOC_WRITE 0x0002
126 uint32_t flags;
127 uint32_t offset;
128 uint32_t or;
129 int32_t shift;
130 uint32_t orhi; /* used for a5xx+ */
131 };
132
133 /* NOTE: relocs are 2 dwords on a5xx+ */
134
135 void fd_ringbuffer_reloc2(struct fd_ringbuffer *ring, const struct fd_reloc *reloc);
136 will_be_deprecated void fd_ringbuffer_reloc(struct fd_ringbuffer *ring, const struct fd_reloc *reloc);
137 uint32_t fd_ringbuffer_cmd_count(struct fd_ringbuffer *ring);
138 uint32_t fd_ringbuffer_emit_reloc_ring_full(struct fd_ringbuffer *ring,
139 struct fd_ringbuffer *target, uint32_t cmd_idx);
140 uint32_t fd_ringbuffer_size(struct fd_ringbuffer *ring);
141
142 #endif /* FREEDRENO_RINGBUFFER_H_ */
143