i915_winsys.h revision 1e966636d06e92f562a7dbcd69aa88c4c9283c41 
1/**************************************************************************
2 *
3 * Copyright © 2009 Jakob Bornecrantz
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
21 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
22 * DEALINGS IN THE SOFTWARE.
23 *
24 **************************************************************************/
25
26#ifndef I915_WINSYS_H
27#define I915_WINSYS_H
28
29#include "pipe/p_compiler.h"
30
31struct i915_winsys;
32struct i915_winsys_buffer;
33struct i915_winsys_batchbuffer;
34struct pipe_resource;
35struct pipe_fence_handle;
36struct winsys_handle;
37
38enum i915_winsys_buffer_usage
39{
40   /* use on textures */
41   I915_USAGE_RENDER    = 0x01,
42   I915_USAGE_SAMPLER   = 0x02,
43   I915_USAGE_2D_TARGET = 0x04,
44   I915_USAGE_2D_SOURCE = 0x08,
45   /* use on vertex */
46   I915_USAGE_VERTEX    = 0x10
47};
48
49enum i915_winsys_buffer_type
50{
51   I915_NEW_TEXTURE,
52   I915_NEW_SCANOUT, /**< a texture used for scanning out from */
53   I915_NEW_VERTEX
54};
55
56/* These need to be in sync with the definitions of libdrm-intel! */
57enum i915_winsys_buffer_tile
58{
59   I915_TILE_NONE,
60   I915_TILE_X,
61   I915_TILE_Y
62};
63
64struct i915_winsys_batchbuffer {
65
66   struct i915_winsys *iws;
67
68   /**
69    * Values exported to speed up the writing the batchbuffer,
70    * instead of having to go trough a accesor function for
71    * each dword written.
72    */
73   /*{@*/
74   uint8_t *map;
75   uint8_t *ptr;
76   size_t size;
77
78   size_t relocs;
79   size_t max_relocs;
80   /*@}*/
81};
82
83struct i915_winsys {
84
85   unsigned pci_id; /**< PCI ID for the device */
86
87   /**
88    * Batchbuffer functions.
89    */
90   /*@{*/
91   /**
92    * Create a new batchbuffer.
93    */
94   struct i915_winsys_batchbuffer *
95      (*batchbuffer_create)(struct i915_winsys *iws);
96
97   /**
98    * Emit a relocation to a buffer.
99    * Target position in batchbuffer is the same as ptr.
100    *
101    * @batch
102    * @reloc buffer address to be inserted into target.
103    * @usage how is the hardware going to use the buffer.
104    * @offset add this to the reloc buffers address
105    * @target buffer where to write the address, null for batchbuffer.
106    * @fenced relocation needs a fence.
107    */
108   int (*batchbuffer_reloc)(struct i915_winsys_batchbuffer *batch,
109                            struct i915_winsys_buffer *reloc,
110                            enum i915_winsys_buffer_usage usage,
111                            unsigned offset, boolean fenced);
112
113   /**
114    * Flush a bufferbatch.
115    */
116   void (*batchbuffer_flush)(struct i915_winsys_batchbuffer *batch,
117                             struct pipe_fence_handle **fence);
118
119   /**
120    * Destroy a batchbuffer.
121    */
122   void (*batchbuffer_destroy)(struct i915_winsys_batchbuffer *batch);
123   /*@}*/
124
125
126   /**
127    * Buffer functions.
128    */
129   /*@{*/
130   /**
131    * Create a buffer.
132    */
133   struct i915_winsys_buffer *
134      (*buffer_create)(struct i915_winsys *iws,
135                       unsigned size,
136                       enum i915_winsys_buffer_type type);
137
138   /**
139    * Create a tiled buffer.
140    *
141    * *stride, height are in bytes. The winsys tries to allocate the buffer with
142    * the tiling mode provide in *tiling. If tiling is no possible, *tiling will
143    * be set to I915_TILE_NONE. The calculated stride (incorporateing hw/kernel
144    * requirements) is always returned in *stride.
145    */
146   struct i915_winsys_buffer *
147      (*buffer_create_tiled)(struct i915_winsys *iws,
148                             unsigned *stride, unsigned height,
149                             enum i915_winsys_buffer_tile *tiling,
150                             enum i915_winsys_buffer_type type);
151
152   /**
153    * Creates a buffer from a handle.
154    * Used to implement pipe_screen::resource_from_handle.
155    * Also provides the stride information needed for the
156    * texture via the stride argument.
157    */
158   struct i915_winsys_buffer *
159      (*buffer_from_handle)(struct i915_winsys *iws,
160                            struct winsys_handle *whandle,
161                            enum i915_winsys_buffer_tile *tiling,
162                            unsigned *stride);
163
164   /**
165    * Used to implement pipe_screen::resource_get_handle.
166    * The winsys might need the stride information.
167    */
168   boolean (*buffer_get_handle)(struct i915_winsys *iws,
169                                struct i915_winsys_buffer *buffer,
170                                struct winsys_handle *whandle,
171                                unsigned stride);
172
173   /**
174    * Map a buffer.
175    */
176   void *(*buffer_map)(struct i915_winsys *iws,
177                       struct i915_winsys_buffer *buffer,
178                       boolean write);
179
180   /**
181    * Unmap a buffer.
182    */
183   void (*buffer_unmap)(struct i915_winsys *iws,
184                        struct i915_winsys_buffer *buffer);
185
186   /**
187    * Write to a buffer.
188    *
189    * Arguments follows pipe_buffer_write.
190    */
191   int (*buffer_write)(struct i915_winsys *iws,
192                       struct i915_winsys_buffer *dst,
193                       size_t offset,
194                       size_t size,
195                       const void *data);
196
197   void (*buffer_destroy)(struct i915_winsys *iws,
198                          struct i915_winsys_buffer *buffer);
199   /*@}*/
200
201
202   /**
203    * Fence functions.
204    */
205   /*@{*/
206   /**
207    * Reference fence and set ptr to fence.
208    */
209   void (*fence_reference)(struct i915_winsys *iws,
210                           struct pipe_fence_handle **ptr,
211                           struct pipe_fence_handle *fence);
212
213   /**
214    * Check if a fence has finished.
215    */
216   int (*fence_signalled)(struct i915_winsys *iws,
217                          struct pipe_fence_handle *fence);
218
219   /**
220    * Wait on a fence to finish.
221    */
222   int (*fence_finish)(struct i915_winsys *iws,
223                       struct pipe_fence_handle *fence);
224   /*@}*/
225
226
227   /**
228    * Destroy the winsys.
229    */
230   void (*destroy)(struct i915_winsys *iws);
231};
232
233#endif
234