src/gallium/winsys/radeon/drm/radeon_winsys.h

   1 /*
   2  * Copyright 2008 Corbin Simpson <MostAwesomeDude@gmail.com>
   3  * Copyright 2010 Marek Olšák <maraeo@gmail.com>
   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  * on the rights to use, copy, modify, merge, publish, distribute, sub
   9  * license, and/or sell copies of the Software, and to permit persons to whom
  10  * the 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 NON-INFRINGEMENT. IN NO EVENT SHALL
  19  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  22  * USE OR OTHER DEALINGS IN THE SOFTWARE. */
  23
  24 #ifndef RADEON_WINSYS_H
  25 #define RADEON_WINSYS_H
  26
  27 /* The public winsys interface header for the radeon driver. */
  28
  29 #include "pipebuffer/pb_bufmgr.h"
  30 #include "pipe/p_defines.h"
  31 #include "pipe/p_state.h"
  32
  33 #define RADEON_MAX_CMDBUF_DWORDS (16 * 1024)
  34 #define RADEON_FLUSH_ASYNC       (1 << 0)
  35
  36 /* Tiling flags. */
  37 enum radeon_bo_layout {
  38     RADEON_LAYOUT_LINEAR = 0,
  39     RADEON_LAYOUT_TILED,
  40     RADEON_LAYOUT_SQUARETILED,
  41
  42     RADEON_LAYOUT_UNKNOWN
  43 };
  44
  45 enum radeon_bo_domain { /* bitfield */
  46     RADEON_DOMAIN_GTT  = 2,
  47     RADEON_DOMAIN_VRAM = 4
  48 };
  49
  50 struct winsys_handle;
  51 struct radeon_winsys_cs_handle;   /* for write_reloc etc. */
  52
  53 struct radeon_winsys_cs {
  54     unsigned cdw;  /* Number of used dwords. */
  55     uint32_t *buf; /* The command buffer. */
  56 };
  57
  58 enum radeon_value_id {
  59     RADEON_VID_PCI_ID,
  60     RADEON_VID_R300_GB_PIPES,
  61     RADEON_VID_R300_Z_PIPES,
  62     RADEON_VID_GART_SIZE,
  63     RADEON_VID_VRAM_SIZE,
  64     RADEON_VID_DRM_MAJOR,
  65     RADEON_VID_DRM_MINOR,
  66     RADEON_VID_DRM_PATCHLEVEL,
  67
  68     /* These should probably go away: */
  69
  70     /* R300 features:
  71      * - Hyper-Z
  72      * - GB_Z_PEQ_CONFIG on rv350->r4xx
  73      * - R500 FG_ALPHA_VALUE
  74      *
  75      * R600 features:
  76      * - TBD
  77      */
  78     RADEON_VID_DRM_2_6_0,
  79
  80     /* R300 features:
  81      * - R500 US_FORMAT regs
  82      * - R500 ARGB2101010 colorbuffer
  83      * - CMask and AA regs
  84      * - R16F/RG16F
  85      *
  86      * R600 features:
  87      * - TBD
  88      */
  89     RADEON_VID_DRM_2_8_0,
  90
  91     RADEON_VID_CAN_HYPERZ,     /* ZMask + HiZ */
  92     RADEON_VID_CAN_AACOMPRESS, /* CMask */
  93 };
  94
  95 struct radeon_winsys {
  96     /**
  97      * Destroy this winsys.
  98      *
  99      * \param ws        The winsys this function is called from.
 100      */
 101     void (*destroy)(struct radeon_winsys *ws);
 102
 103     /**
 104      * Query a system value from a winsys.
 105      *
 106      * \param ws        The winsys this function is called from.
 107      * \param vid       One of the RADEON_VID_* enums.
 108      */
 109     uint32_t (*get_value)(struct radeon_winsys *ws,
 110                           enum radeon_value_id vid);
 111
 112     /**************************************************************************
 113      * Buffer management. Buffer attributes are mostly fixed over its lifetime.
 114      *
 115      * Remember that gallium gets to choose the interface it needs, and the
 116      * window systems must then implement that interface (rather than the
 117      * other way around...).
 118      *************************************************************************/
 119
 120     /**
 121      * Create a buffer object.
 122      *
 123      * \param ws        The winsys this function is called from.
 124      * \param size      The size to allocate.
 125      * \param alignment An alignment of the buffer in memory.
 126      * \param bind      A bitmask of the PIPE_BIND_* flags.
 127      * \param usage     A bitmask of the PIPE_USAGE_* flags.
 128      * \param domain    A bitmask of the RADEON_DOMAIN_* flags.
 129      * \return          The created buffer object.
 130      */
 131     struct pb_buffer *(*buffer_create)(struct radeon_winsys *ws,
 132                                        unsigned size,
 133                                        unsigned alignment,
 134                                        unsigned bind,
 135                                        unsigned usage,
 136                                        enum radeon_bo_domain domain);
 137
 138     struct radeon_winsys_cs_handle *(*buffer_get_cs_handle)(
 139             struct pb_buffer *buf);
 140
 141     /**
 142      * Map the entire data store of a buffer object into the client's address
 143      * space.
 144      *
 145      * \param buf       A winsys buffer object to map.
 146      * \param cs        A command stream to flush if the buffer is referenced by it.
 147      * \param usage     A bitmask of the PIPE_TRANSFER_* flags.
 148      * \return          The pointer at the beginning of the buffer.
 149      */
 150     void *(*buffer_map)(struct pb_buffer *buf,
 151                         struct radeon_winsys_cs *cs,
 152                         enum pipe_transfer_usage usage);
 153
 154     /**
 155      * Unmap a buffer object from the client's address space.
 156      *
 157      * \param buf       A winsys buffer object to unmap.
 158      */
 159     void (*buffer_unmap)(struct pb_buffer *buf);
 160
 161     /**
 162      * Return TRUE if a buffer object is being used by the GPU.
 163      *
 164      * \param buf       A winsys buffer object.
 165      */
 166     boolean (*buffer_is_busy)(struct pb_buffer *buf);
 167
 168     /**
 169      * Wait for a buffer object until it is not used by a GPU. This is
 170      * equivalent to a fence placed after the last command using the buffer,
 171      * and synchronizing to the fence.
 172      *
 173      * \param buf       A winsys buffer object to wait for.
 174      */
 175     void (*buffer_wait)(struct pb_buffer *buf);
 176
 177     /**
 178      * Return tiling flags describing a memory layout of a buffer object.
 179      *
 180      * \param buf       A winsys buffer object to get the flags from.
 181      * \param macrotile A pointer to the return value of the microtile flag.
 182      * \param microtile A pointer to the return value of the macrotile flag.
 183      *
 184      * \note microtile and macrotile are not bitmasks!
 185      */
 186     void (*buffer_get_tiling)(struct pb_buffer *buf,
 187                               enum radeon_bo_layout *microtile,
 188                               enum radeon_bo_layout *macrotile);
 189
 190     /**
 191      * Set tiling flags describing a memory layout of a buffer object.
 192      *
 193      * \param buf       A winsys buffer object to set the flags for.
 194      * \param cs        A command stream to flush if the buffer is referenced by it.
 195      * \param macrotile A macrotile flag.
 196      * \param microtile A microtile flag.
 197      * \param stride    A stride of the buffer in bytes, for texturing.
 198      *
 199      * \note microtile and macrotile are not bitmasks!
 200      */
 201     void (*buffer_set_tiling)(struct pb_buffer *buf,
 202                               struct radeon_winsys_cs *cs,
 203                               enum radeon_bo_layout microtile,
 204                               enum radeon_bo_layout macrotile,
 205                               unsigned stride);
 206
 207     /**
 208      * Get a winsys buffer from a winsys handle. The internal structure
 209      * of the handle is platform-specific and only a winsys should access it.
 210      *
 211      * \param ws        The winsys this function is called from.
 212      * \param whandle   A winsys handle pointer as was received from a state
 213      *                  tracker.
 214      * \param stride    The returned buffer stride in bytes.
 215      * \param size      The returned buffer size.
 216      */
 217     struct pb_buffer *(*buffer_from_handle)(struct radeon_winsys *ws,
 218                                             struct winsys_handle *whandle,
 219                                             unsigned *stride,
 220                                             unsigned *size);
 221
 222     /**
 223      * Get a winsys handle from a winsys buffer. The internal structure
 224      * of the handle is platform-specific and only a winsys should access it.
 225      *
 226      * \param buf       A winsys buffer object to get the handle from.
 227      * \param whandle   A winsys handle pointer.
 228      * \param stride    A stride of the buffer in bytes, for texturing.
 229      * \return          TRUE on success.
 230      */
 231     boolean (*buffer_get_handle)(struct pb_buffer *buf,
 232                                  unsigned stride,
 233                                  struct winsys_handle *whandle);
 234
 235     /**************************************************************************
 236      * Command submission.
 237      *
 238      * Each pipe context should create its own command stream and submit
 239      * commands independently of other contexts.
 240      *************************************************************************/
 241
 242     /**
 243      * Create a command stream.
 244      *
 245      * \param ws        The winsys this function is called from.
 246      */
 247     struct radeon_winsys_cs *(*cs_create)(struct radeon_winsys *ws);
 248
 249     /**
 250      * Destroy a command stream.
 251      *
 252      * \param cs        A command stream to destroy.
 253      */
 254     void (*cs_destroy)(struct radeon_winsys_cs *cs);
 255
 256     /**
 257      * Add a new buffer relocation. Every relocation must first be added
 258      * before it can be written.
 259      *
 260      * \param cs  A command stream to add buffer for validation against.
 261      * \param buf A winsys buffer to validate.
 262      * \param rd  A read domain containing a bitmask of the RADEON_DOMAIN_* flags.
 263      * \param wd  A write domain containing a bitmask of the RADEON_DOMAIN_* flags.
 264      */
 265     void (*cs_add_reloc)(struct radeon_winsys_cs *cs,
 266                          struct radeon_winsys_cs_handle *buf,
 267                          enum radeon_bo_domain rd,
 268                          enum radeon_bo_domain wd);
 269
 270     /**
 271      * Return TRUE if there is enough memory in VRAM and GTT for the relocs
 272      * added so far.
 273      *
 274      * \param cs        A command stream to validate.
 275      */
 276     boolean (*cs_validate)(struct radeon_winsys_cs *cs);
 277
 278     /**
 279      * Write a relocated dword to a command buffer.
 280      *
 281      * \param cs        A command stream the relocation is written to.
 282      * \param buf       A winsys buffer to write the relocation for.
 283      * \param rd        A read domain containing a bitmask of the RADEON_DOMAIN_* flags.
 284      * \param wd        A write domain containing a bitmask of the RADEON_DOMAIN_* flags.
 285      */
 286     void (*cs_write_reloc)(struct radeon_winsys_cs *cs,
 287                            struct radeon_winsys_cs_handle *buf);
 288
 289     /**
 290      * Flush a command stream.
 291      *
 292      * \param cs        A command stream to flush.
 293      * \param flags,    RADEON_FLUSH_ASYNC or 0.
 294      */
 295     void (*cs_flush)(struct radeon_winsys_cs *cs, unsigned flags);
 296
 297     /**
 298      * Set a flush callback which is called from winsys when flush is
 299      * required.
 300      *
 301      * \param cs        A command stream to set the callback for.
 302      * \param flush     A flush callback function associated with the command stream.
 303      * \param user      A user pointer that will be passed to the flush callback.
 304      */
 305     void (*cs_set_flush)(struct radeon_winsys_cs *cs,
 306                          void (*flush)(void *ctx, unsigned flags),
 307                          void *user);
 308
 309     /**
 310      * Return TRUE if a buffer is referenced by a command stream.
 311      *
 312      * \param cs        A command stream.
 313      * \param buf       A winsys buffer.
 314      */
 315     boolean (*cs_is_buffer_referenced)(struct radeon_winsys_cs *cs,
 316                                        struct radeon_winsys_cs_handle *buf);
 317 };
 318
 319 #endif