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 /* R300 features in DRM.
  30  *
  31  * 2.6.0:
  32  * - Hyper-Z
  33  * - GB_Z_PEQ_CONFIG on rv350->r4xx
  34  * - R500 FG_ALPHA_VALUE
  35  *
  36  * 2.8.0:
  37  * - R500 US_FORMAT regs
  38  * - R500 ARGB2101010 colorbuffer
  39  * - CMask and AA regs
  40  * - R16F/RG16F
  41  */
  42
  43 #include "pipebuffer/pb_bufmgr.h"
  44 #include "pipe/p_defines.h"
  45 #include "pipe/p_state.h"
  46 #include "libdrm/radeon_surface.h"
  47
  48 #define RADEON_MAX_CMDBUF_DWORDS (16 * 1024)
  49
  50 #define RADEON_FLUSH_ASYNC             (1 << 0)
  51 #define RADEON_FLUSH_KEEP_TILING_FLAGS (1 << 1) /* needs DRM 2.12.0 */
  52
  53 /* Tiling flags. */
  54 enum radeon_bo_layout {
  55     RADEON_LAYOUT_LINEAR = 0,
  56     RADEON_LAYOUT_TILED,
  57     RADEON_LAYOUT_SQUARETILED,
  58
  59     RADEON_LAYOUT_UNKNOWN
  60 };
  61
  62 enum radeon_bo_domain { /* bitfield */
  63     RADEON_DOMAIN_GTT  = 2,
  64     RADEON_DOMAIN_VRAM = 4
  65 };
  66
  67 enum radeon_bo_usage { /* bitfield */
  68     RADEON_USAGE_READ = 2,
  69     RADEON_USAGE_WRITE = 4,
  70     RADEON_USAGE_READWRITE = RADEON_USAGE_READ | RADEON_USAGE_WRITE
  71 };
  72
  73 struct winsys_handle;
  74 struct radeon_winsys_cs_handle;
  75
  76 struct radeon_winsys_cs {
  77     unsigned cdw;  /* Number of used dwords. */
  78     uint32_t *buf; /* The command buffer. */
  79 };
  80
  81 struct radeon_info {
  82     uint32_t pci_id;
  83     uint32_t gart_size;
  84     uint32_t vram_size;
  85
  86     uint32_t drm_major; /* version */
  87     uint32_t drm_minor;
  88     uint32_t drm_patchlevel;
  89
  90     uint32_t r300_num_gb_pipes;
  91     uint32_t r300_num_z_pipes;
  92
  93     uint32_t r600_num_backends;
  94     uint32_t r600_clock_crystal_freq;
  95     uint32_t r600_tiling_config;
  96     uint32_t r600_num_tile_pipes;
  97     uint32_t r600_backend_map;
  98     boolean r600_backend_map_valid;
  99     boolean r600_virtual_address;
 100     uint32_t r600_va_start;
 101     uint32_t r600_ib_vm_max_size;
 102 };
 103
 104 enum radeon_feature_id {
 105     RADEON_FID_R300_HYPERZ_ACCESS,     /* ZMask + HiZ */
 106     RADEON_FID_R300_CMASK_ACCESS,
 107 };
 108
 109 struct radeon_winsys {
 110     /**
 111      * Destroy this winsys.
 112      *
 113      * \param ws        The winsys this function is called from.
 114      */
 115     void (*destroy)(struct radeon_winsys *ws);
 116
 117     /**
 118      * Query an info structure from winsys.
 119      *
 120      * \param ws        The winsys this function is called from.
 121      * \param info      Return structure
 122      */
 123     void (*query_info)(struct radeon_winsys *ws,
 124                        struct radeon_info *info);
 125
 126     /**************************************************************************
 127      * Buffer management. Buffer attributes are mostly fixed over its lifetime.
 128      *
 129      * Remember that gallium gets to choose the interface it needs, and the
 130      * window systems must then implement that interface (rather than the
 131      * other way around...).
 132      *************************************************************************/
 133
 134     /**
 135      * Create a buffer object.
 136      *
 137      * \param ws        The winsys this function is called from.
 138      * \param size      The size to allocate.
 139      * \param alignment An alignment of the buffer in memory.
 140      * \param bind      A bitmask of the PIPE_BIND_* flags.
 141      * \param domain    A bitmask of the RADEON_DOMAIN_* flags.
 142      * \return          The created buffer object.
 143      */
 144     struct pb_buffer *(*buffer_create)(struct radeon_winsys *ws,
 145                                        unsigned size,
 146                                        unsigned alignment,
 147                                        unsigned bind,
 148                                        enum radeon_bo_domain domain);
 149
 150     struct radeon_winsys_cs_handle *(*buffer_get_cs_handle)(
 151             struct pb_buffer *buf);
 152
 153     /**
 154      * Map the entire data store of a buffer object into the client's address
 155      * space.
 156      *
 157      * \param buf       A winsys buffer object to map.
 158      * \param cs        A command stream to flush if the buffer is referenced by it.
 159      * \param usage     A bitmask of the PIPE_TRANSFER_* flags.
 160      * \return          The pointer at the beginning of the buffer.
 161      */
 162     void *(*buffer_map)(struct pb_buffer *buf,
 163                         struct radeon_winsys_cs *cs,
 164                         enum pipe_transfer_usage usage);
 165
 166     /**
 167      * Unmap a buffer object from the client's address space.
 168      *
 169      * \param buf       A winsys buffer object to unmap.
 170      */
 171     void (*buffer_unmap)(struct pb_buffer *buf);
 172
 173     /**
 174      * Return TRUE if a buffer object is being used by the GPU.
 175      *
 176      * \param buf       A winsys buffer object.
 177      * \param usage     Only check whether the buffer is busy for the given usage.
 178      */
 179     boolean (*buffer_is_busy)(struct pb_buffer *buf,
 180                               enum radeon_bo_usage usage);
 181
 182     /**
 183      * Wait for a buffer object until it is not used by a GPU. This is
 184      * equivalent to a fence placed after the last command using the buffer,
 185      * and synchronizing to the fence.
 186      *
 187      * \param buf       A winsys buffer object to wait for.
 188      * \param usage     Only wait until the buffer is idle for the given usage,
 189      *                  but may still be busy for some other usage.
 190      */
 191     void (*buffer_wait)(struct pb_buffer *buf, enum radeon_bo_usage usage);
 192
 193     /**
 194      * Return tiling flags describing a memory layout of a buffer object.
 195      *
 196      * \param buf       A winsys buffer object to get the flags from.
 197      * \param macrotile A pointer to the return value of the microtile flag.
 198      * \param microtile A pointer to the return value of the macrotile flag.
 199      *
 200      * \note microtile and macrotile are not bitmasks!
 201      */
 202     void (*buffer_get_tiling)(struct pb_buffer *buf,
 203                               enum radeon_bo_layout *microtile,
 204                               enum radeon_bo_layout *macrotile,
 205                               unsigned *bankw, unsigned *bankh,
 206                               unsigned *tile_split,
 207                               unsigned *stencil_tile_split,
 208                               unsigned *mtilea);
 209
 210     /**
 211      * Set tiling flags describing a memory layout of a buffer object.
 212      *
 213      * \param buf       A winsys buffer object to set the flags for.
 214      * \param cs        A command stream to flush if the buffer is referenced by it.
 215      * \param macrotile A macrotile flag.
 216      * \param microtile A microtile flag.
 217      * \param stride    A stride of the buffer in bytes, for texturing.
 218      *
 219      * \note microtile and macrotile are not bitmasks!
 220      */
 221     void (*buffer_set_tiling)(struct pb_buffer *buf,
 222                               struct radeon_winsys_cs *cs,
 223                               enum radeon_bo_layout microtile,
 224                               enum radeon_bo_layout macrotile,
 225                               unsigned stride);
 226
 227     /**
 228      * Get a winsys buffer from a winsys handle. The internal structure
 229      * of the handle is platform-specific and only a winsys should access it.
 230      *
 231      * \param ws        The winsys this function is called from.
 232      * \param whandle   A winsys handle pointer as was received from a state
 233      *                  tracker.
 234      * \param stride    The returned buffer stride in bytes.
 235      */
 236     struct pb_buffer *(*buffer_from_handle)(struct radeon_winsys *ws,
 237                                             struct winsys_handle *whandle,
 238                                             unsigned *stride);
 239
 240     /**
 241      * Get a winsys handle from a winsys buffer. The internal structure
 242      * of the handle is platform-specific and only a winsys should access it.
 243      *
 244      * \param buf       A winsys buffer object to get the handle from.
 245      * \param whandle   A winsys handle pointer.
 246      * \param stride    A stride of the buffer in bytes, for texturing.
 247      * \return          TRUE on success.
 248      */
 249     boolean (*buffer_get_handle)(struct pb_buffer *buf,
 250                                  unsigned stride,
 251                                  struct winsys_handle *whandle);
 252
 253     /**
 254      * Return the virtual address of a buffer.
 255      *
 256      * \param buf       A winsys buffer object
 257      * \return          virtual address
 258      */
 259     uint64_t (*buffer_get_virtual_address)(struct pb_buffer *buf);
 260
 261     /**************************************************************************
 262      * Command submission.
 263      *
 264      * Each pipe context should create its own command stream and submit
 265      * commands independently of other contexts.
 266      *************************************************************************/
 267
 268     /**
 269      * Create a command stream.
 270      *
 271      * \param ws        The winsys this function is called from.
 272      */
 273     struct radeon_winsys_cs *(*cs_create)(struct radeon_winsys *ws);
 274
 275     /**
 276      * Destroy a command stream.
 277      *
 278      * \param cs        A command stream to destroy.
 279      */
 280     void (*cs_destroy)(struct radeon_winsys_cs *cs);
 281
 282     /**
 283      * Add a new buffer relocation. Every relocation must first be added
 284      * before it can be written.
 285      *
 286      * \param cs  A command stream to add buffer for validation against.
 287      * \param buf A winsys buffer to validate.
 288      * \param usage   Whether the buffer is used for read and/or write.
 289      * \param domain  Bitmask of the RADEON_DOMAIN_* flags.
 290      * \return Relocation index.
 291      */
 292     unsigned (*cs_add_reloc)(struct radeon_winsys_cs *cs,
 293                              struct radeon_winsys_cs_handle *buf,
 294                              enum radeon_bo_usage usage,
 295                              enum radeon_bo_domain domain);
 296
 297     /**
 298      * Return TRUE if there is enough memory in VRAM and GTT for the relocs
 299      * added so far. If the validation fails, all the relocations which have
 300      * been added since the last call of cs_validate will be removed and
 301      * the CS will be flushed (provided there are still any relocations).
 302      *
 303      * \param cs        A command stream to validate.
 304      */
 305     boolean (*cs_validate)(struct radeon_winsys_cs *cs);
 306
 307     /**
 308      * Write a relocated dword to a command buffer.
 309      *
 310      * \param cs        A command stream the relocation is written to.
 311      * \param buf       A winsys buffer to write the relocation for.
 312      */
 313     void (*cs_write_reloc)(struct radeon_winsys_cs *cs,
 314                            struct radeon_winsys_cs_handle *buf);
 315
 316     /**
 317      * Flush a command stream.
 318      *
 319      * \param cs        A command stream to flush.
 320      * \param flags,    RADEON_FLUSH_ASYNC or 0.
 321      */
 322     void (*cs_flush)(struct radeon_winsys_cs *cs, unsigned flags);
 323
 324     /**
 325      * Set a flush callback which is called from winsys when flush is
 326      * required.
 327      *
 328      * \param cs        A command stream to set the callback for.
 329      * \param flush     A flush callback function associated with the command stream.
 330      * \param user      A user pointer that will be passed to the flush callback.
 331      */
 332     void (*cs_set_flush_callback)(struct radeon_winsys_cs *cs,
 333                                   void (*flush)(void *ctx, unsigned flags),
 334                                   void *ctx);
 335
 336     /**
 337      * Return TRUE if a buffer is referenced by a command stream.
 338      *
 339      * \param cs        A command stream.
 340      * \param buf       A winsys buffer.
 341      */
 342     boolean (*cs_is_buffer_referenced)(struct radeon_winsys_cs *cs,
 343                                        struct radeon_winsys_cs_handle *buf);
 344
 345     /**
 346      * Request access to a feature for a command stream.
 347      *
 348      * \param cs        A command stream.
 349      * \param fid       Feature ID, one of RADEON_FID_*
 350      * \param enable    Whether to enable or disable the feature.
 351      */
 352     boolean (*cs_request_feature)(struct radeon_winsys_cs *cs,
 353                                   enum radeon_feature_id fid,
 354                                   boolean enable);
 355
 356     /**
 357      * Initialize surface
 358      *
 359      * \param ws        The winsys this function is called from.
 360      * \param surf      Surface structure ptr
 361      */
 362     int (*surface_init)(struct radeon_winsys *ws,
 363                         struct radeon_surface *surf);
 364
 365     /**
 366      * Find best values for a surface
 367      *
 368      * \param ws        The winsys this function is called from.
 369      * \param surf      Surface structure ptr
 370      */
 371     int (*surface_best)(struct radeon_winsys *ws,
 372                         struct radeon_surface *surf);
 373 };
 374
 375 #endif