summaryrefslogtreecommitdiff
path: root/src/gallium/drivers/r300/r300_winsys.h
blob: 7e115c2d624592dc69906be266276b84b972da8f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
/*
 * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
 * Copyright 2010 Marek Olšák <maraeo@gmail.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * on the rights to use, copy, modify, merge, publish, distribute, sub
 * license, and/or sell copies of the Software, and to permit persons to whom
 * the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 * USE OR OTHER DEALINGS IN THE SOFTWARE. */

#ifndef R300_WINSYS_H
#define R300_WINSYS_H

/* The public winsys interface header for the r300 pipe driver.
 * Any winsys hosting this pipe needs to implement r300_winsys_screen and then
 * call r300_screen_create to start things. */

#include "pipe/p_defines.h"
#include "pipe/p_state.h"

#include "r300_defines.h"

struct r300_winsys_screen;

struct r300_winsys_buffer;

struct r300_winsys_cs {
    uint32_t *ptr;      /* Pointer to the beginning of the CS. */
    unsigned cdw;       /* Number of used dwords. */
    unsigned ndw;       /* Size of the CS in dwords. */
};

enum r300_value_id {
    R300_VID_PCI_ID,
    R300_VID_GB_PIPES,
    R300_VID_Z_PIPES,
    R300_VID_SQUARE_TILING_SUPPORT,
    R300_VID_DRM_2_3_0,
};

enum r300_reference_domain { /* bitfield */
    R300_REF_CS = 1,
    R300_REF_HW = 2
};

struct r300_winsys_screen {
    /**
     * Destroy this winsys.
     *
     * \param ws        The winsys this function is called from.
     */
    void (*destroy)(struct r300_winsys_screen *ws);

    /**
     * Query a system value from a winsys.
     *
     * \param ws        The winsys this function is called from.
     * \param vid       One of the R300_VID_* enums.
     */
    uint32_t (*get_value)(struct r300_winsys_screen *ws,
                          enum r300_value_id vid);

    /**************************************************************************
     * Buffer management. Buffer attributes are mostly fixed over its lifetime.
     *
     * Remember that gallium gets to choose the interface it needs, and the
     * window systems must then implement that interface (rather than the
     * other way around...).
     *************************************************************************/

    /**
     * Create a buffer object.
     *
     * \param ws        The winsys this function is called from.
     * \param size      The size to allocate.
     * \param alignment An alignment of the buffer in memory.
     * \param bind      A bitmask of the PIPE_BIND_* flags.
     * \param usage     A bitmask of the PIPE_USAGE_* flags.
     * \param domain    A bitmask of the R300_DOMAIN_* flags.
     * \return          The created buffer object.
     */
    struct r300_winsys_buffer *(*buffer_create)(struct r300_winsys_screen *ws,
                                                unsigned size,
                                                unsigned alignment,
                                                unsigned bind,
                                                unsigned usage,
                                                enum r300_buffer_domain domain);

    /**
     * Reference a buffer object (assign with reference counting).
     *
     * \param ws        The winsys this function is called from.
     * \param pdst      A destination pointer to set the source buffer to.
     * \param src       A source buffer object.
     */
    void (*buffer_reference)(struct r300_winsys_screen *ws,
                             struct r300_winsys_buffer **pdst,
                             struct r300_winsys_buffer *src);

    /**
     * Map the entire data store of a buffer object into the client's address
     * space.
     *
     * \param ws        The winsys this function is called from.
     * \param buf       A winsys buffer object to map.
     * \param cs        A command stream to flush if the buffer is referenced by it.
     * \param usage     A bitmask of the PIPE_TRANSFER_* flags.
     * \return          The pointer at the beginning of the buffer.
     */
    void *(*buffer_map)(struct r300_winsys_screen *ws,
                        struct r300_winsys_buffer *buf,
                        struct r300_winsys_cs *cs,
                        enum pipe_transfer_usage usage);

    /**
     * Unmap a buffer object from the client's address space.
     *
     * \param ws        The winsys this function is called from.
     * \param buf       A winsys buffer object to unmap.
     */
    void (*buffer_unmap)(struct r300_winsys_screen *ws,
                         struct r300_winsys_buffer *buf);

    /**
     * Wait for a buffer object until it is not used by a GPU. This is
     * equivalent to a fence placed after the last command using the buffer,
     * and synchronizing to the fence.
     *
     * \param ws        The winsys this function is called from.
     * \param buf       A winsys buffer object to wait for.
     */
    void (*buffer_wait)(struct r300_winsys_screen *ws,
                        struct r300_winsys_buffer *buf);

    /**
     * Return tiling flags describing a memory layout of a buffer object.
     *
     * \param ws        The winsys this function is called from.
     * \param buf       A winsys buffer object to get the flags from.
     * \param macrotile A pointer to the return value of the microtile flag.
     * \param microtile A pointer to the return value of the macrotile flag.
     *
     * \note microtile and macrotile are not bitmasks!
     */
    void (*buffer_get_tiling)(struct r300_winsys_screen *ws,
                              struct r300_winsys_buffer *buf,
                              enum r300_buffer_tiling *microtile,
                              enum r300_buffer_tiling *macrotile);

    /**
     * Set tiling flags describing a memory layout of a buffer object.
     *
     * \param ws        The winsys this function is called from.
     * \param buf       A winsys buffer object to set the flags for.
     * \param macrotile A macrotile flag.
     * \param microtile A microtile flag.
     * \param stride    A stride of the buffer in bytes, for texturing.
     *
     * \note microtile and macrotile are not bitmasks!
     */
    void (*buffer_set_tiling)(struct r300_winsys_screen *ws,
                              struct r300_winsys_buffer *buf,
                              enum r300_buffer_tiling microtile,
                              enum r300_buffer_tiling macrotile,
                              unsigned stride);

    /**
     * Get a winsys buffer from a winsys handle. The internal structure
     * of the handle is platform-specific and only a winsys should access it.
     *
     * \param ws        The winsys this function is called from.
     * \param whandle   A winsys handle pointer as was received from a state
     *                  tracker.
     * \param stride    A pointer to the stride return variable.
     *                  The stride is in bytes.
     */
    struct r300_winsys_buffer *(*buffer_from_handle)(struct r300_winsys_screen *ws,
                                                     struct winsys_handle *whandle,
                                                     unsigned *stride);

    /**
     * Get a winsys handle from a winsys buffer. The internal structure
     * of the handle is platform-specific and only a winsys should access it.
     *
     * \param ws        The winsys this function is called from.
     * \param buf       A winsys buffer object to get the handle from.
     * \param whandle   A winsys handle pointer.
     * \param stride    A stride of the buffer in bytes, for texturing.
     * \return          TRUE on success.
     */
    boolean (*buffer_get_handle)(struct r300_winsys_screen *ws,
                                 struct r300_winsys_buffer *buf,
                                 unsigned stride,
                                 struct winsys_handle *whandle);

    /**************************************************************************
     * Command submission.
     *
     * Each pipe context should create its own command stream and submit
     * commands independently of other contexts.
     *************************************************************************/

    /**
     * Create a command stream.
     *
     * \param ws        The winsys this function is called from.
     */
    struct r300_winsys_cs *(*cs_create)(struct r300_winsys_screen *ws);

    /**
     * Destroy a command stream.
     *
     * \param cs        A command stream to destroy.
     */
    void (*cs_destroy)(struct r300_winsys_cs *cs);

    /**
     * Add a buffer object to the list of buffers to validate.
     *
     * \param cs        A command stream to add buffer for validation against.
     * \param buf       A winsys buffer to validate.
     * \param rd        A read domain containing a bitmask
     *                  of the R300_DOMAIN_* flags.
     * \param wd        A write domain containing a bitmask
     *                  of the R300_DOMAIN_* flags.
     */
    void (*cs_add_buffer)(struct r300_winsys_cs *cs,
                          struct r300_winsys_buffer *buf,
                          enum r300_buffer_domain rd,
                          enum r300_buffer_domain wd);

    /**
     * Revalidate all currently set up winsys buffers.
     * Returns TRUE if a flush is required.
     *
     * \param cs        A command stream to validate.
     */
    boolean (*cs_validate)(struct r300_winsys_cs *cs);

    /**
     * Write a relocated dword to a command buffer.
     *
     * \param cs        A command stream the relocation is written to.
     * \param buf       A winsys buffer to write the relocation for.
     * \param rd        A read domain containing a bitmask of the R300_DOMAIN_* flags.
     * \param wd        A write domain containing a bitmask of the R300_DOMAIN_* flags.
     */
    void (*cs_write_reloc)(struct r300_winsys_cs *cs,
                           struct r300_winsys_buffer *buf,
                           enum r300_buffer_domain rd,
                           enum r300_buffer_domain wd);

    /**
     * Flush a command stream.
     *
     * \param cs        A command stream to flush.
     */
    void (*cs_flush)(struct r300_winsys_cs *cs);

    /**
     * Set a flush callback which is called from winsys when flush is
     * required.
     *
     * \param cs        A command stream to set the callback for.
     * \param flush     A flush callback function associated with the command stream.
     * \param user      A user pointer that will be passed to the flush callback.
     */
    void (*cs_set_flush)(struct r300_winsys_cs *cs,
                         void (*flush)(void *),
                         void *user);

    /**
     * Reset the list of buffer objects to validate, usually called
     * prior to adding buffer objects for validation.
     *
     * \param cs        A command stream to reset buffers for.
     */
    void (*cs_reset_buffers)(struct r300_winsys_cs *cs);

    /**
     * Return TRUE if a buffer is referenced by a command stream or by hardware
     * (i.e. is busy), based on the domain parameter.
     *
     * \param cs        A command stream.
     * \param buf       A winsys buffer.
     * \param domain    A bitmask of the R300_REF_* enums.
     */
    boolean (*cs_is_buffer_referenced)(struct r300_winsys_cs *cs,
                                       struct r300_winsys_buffer *buf,
                                       enum r300_reference_domain domain);
};

#endif /* R300_WINSYS_H */