src/gallium/drivers/r300/r300_winsys.h

   1 /*
   2  * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * on the rights to use, copy, modify, merge, publish, distribute, sub
   8  * license, and/or sell copies of the Software, and to permit persons to whom
   9  * the Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  18  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  21  * USE OR OTHER DEALINGS IN THE SOFTWARE. */
  22
  23 #ifndef R300_WINSYS_H
  24 #define R300_WINSYS_H
  25
  26 /* The public interface header for the r300 pipe driver.
  27  * Any winsys hosting this pipe needs to implement r300_winsys and then
  28  * call r300_create_screen to start things. */
  29
  30 #include "pipe/p_defines.h"
  31 #include "pipe/p_state.h"
  32
  33 #include "r300_defines.h"
  34
  35 struct r300_winsys_buffer;
  36
  37 enum r300_value_id {
  38     R300_VID_PCI_ID,
  39     R300_VID_GB_PIPES,
  40     R300_VID_Z_PIPES,
  41     R300_VID_SQUARE_TILING_SUPPORT,
  42     R300_VID_DRM_2_3_0,
  43 };
  44
  45 enum r300_reference_domain { /* bitfield */
  46     R300_REF_CS = 1,
  47     R300_REF_HW = 2
  48 };
  49
  50 struct r300_winsys_screen {
  51     void (*destroy)(struct r300_winsys_screen *ws);
  52
  53     /**
  54      * Buffer management. Buffer attributes are mostly fixed over its lifetime.
  55      *
  56      * Remember that gallium gets to choose the interface it needs, and the
  57      * window systems must then implement that interface (rather than the
  58      * other way around...).
  59      *
  60      * usage is a bitmask of R300_WINSYS_BUFFER_USAGE_PIXEL/VERTEX/INDEX/CONSTANT. This
  61      * usage argument is only an optimization hint, not a guarantee, therefore
  62      * proper behavior must be observed in all circumstances.
  63      *
  64      * alignment indicates the client's alignment requirements, eg for
  65      * SSE instructions.
  66      */
  67     struct r300_winsys_buffer *(*buffer_create)(struct r300_winsys_screen *ws,
  68                                                 unsigned alignment,
  69                                                 unsigned usage,
  70                                                 enum r300_buffer_domain domain,
  71                                                 unsigned size);
  72
  73     /**
  74      * Map the entire data store of a buffer object into the client's address.
  75      * flags is bitmask of R300_WINSYS_BUFFER_USAGE_CPU_READ/WRITE flags.
  76      */
  77     void *(*buffer_map)( struct r300_winsys_screen *ws,
  78                          struct r300_winsys_buffer *buf,
  79                          unsigned usage);
  80
  81     void (*buffer_unmap)( struct r300_winsys_screen *ws,
  82                           struct r300_winsys_buffer *buf );
  83
  84     void (*buffer_destroy)( struct r300_winsys_buffer *buf );
  85
  86
  87     void (*buffer_reference)(struct r300_winsys_screen *rws,
  88                              struct r300_winsys_buffer **pdst,
  89                              struct r300_winsys_buffer *src);
  90
  91     void (*buffer_wait)(struct r300_winsys_screen *rws,
  92                         struct r300_winsys_buffer *buf);
  93
  94     /* Add a pipe_resource to the list of buffer objects to validate. */
  95     boolean (*add_buffer)(struct r300_winsys_screen *winsys,
  96                           struct r300_winsys_buffer *buf,
  97                           enum r300_buffer_domain rd,
  98                           enum r300_buffer_domain wd);
  99
 100
 101     /* Revalidate all currently setup pipe_buffers.
 102      * Returns TRUE if a flush is required. */
 103     boolean (*validate)(struct r300_winsys_screen* winsys);
 104
 105     /* Return the number of free dwords in CS. */
 106     unsigned (*get_cs_free_dwords)(struct r300_winsys_screen *winsys);
 107
 108     /* Return the pointer to the first free dword in CS and assume a pipe
 109      * driver wants to fill "count" dwords. */
 110     uint32_t *(*get_cs_pointer)(struct r300_winsys_screen *winsys,
 111                                 unsigned count);
 112
 113     /* Write a dword to the command buffer. */
 114     void (*write_cs_dword)(struct r300_winsys_screen* winsys, uint32_t dword);
 115
 116     /* Write a table of dwords to the command buffer. */
 117     void (*write_cs_table)(struct r300_winsys_screen* winsys,
 118                            const void *dwords, unsigned count);
 119
 120     /* Write a relocated dword to the command buffer. */
 121     void (*write_cs_reloc)(struct r300_winsys_screen *winsys,
 122                            struct r300_winsys_buffer *buf,
 123                            enum r300_buffer_domain rd,
 124                            enum r300_buffer_domain wd,
 125                            uint32_t flags);
 126
 127     /* Flush the CS. */
 128     void (*flush_cs)(struct r300_winsys_screen* winsys);
 129
 130     /* winsys flush - callback from winsys when flush required */
 131     void (*set_flush_cb)(struct r300_winsys_screen *winsys,
 132                          void (*flush_cb)(void *), void *data);
 133
 134     void (*reset_bos)(struct r300_winsys_screen *winsys);
 135
 136     void (*buffer_get_tiling)(struct r300_winsys_screen *winsys,
 137                               struct r300_winsys_buffer *buffer,
 138                               enum r300_buffer_tiling *microtiled,
 139                               enum r300_buffer_tiling *macrotiled);
 140
 141     void (*buffer_set_tiling)(struct r300_winsys_screen *winsys,
 142                               struct r300_winsys_buffer *buffer,
 143                               uint32_t pitch,
 144                               enum r300_buffer_tiling microtiled,
 145                               enum r300_buffer_tiling macrotiled);
 146
 147     uint32_t (*get_value)(struct r300_winsys_screen *winsys,
 148                           enum r300_value_id vid);
 149
 150     struct r300_winsys_buffer *(*buffer_from_handle)(struct r300_winsys_screen *winsys,
 151                                                      unsigned handle);
 152
 153     boolean (*buffer_get_handle)(struct r300_winsys_screen *winsys,
 154                                  struct r300_winsys_buffer *buffer,
 155                                  struct winsys_handle *whandle);
 156
 157     boolean (*is_buffer_referenced)(struct r300_winsys_screen *winsys,
 158                                     struct r300_winsys_buffer *buffer,
 159                                     enum r300_reference_domain domain);
 160 };
 161
 162 struct r300_winsys_screen *
 163 r300_winsys_screen(struct pipe_screen *screen);
 164
 165 #endif /* R300_WINSYS_H */