src/gallium/drivers/radeon/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_buffer.h"
  44
  45 #define RADEON_FLUSH_ASYNC              (1 << 0)
  46 #define RADEON_FLUSH_KEEP_TILING_FLAGS  (1 << 1) /* needs DRM 2.12.0 */
  47 #define RADEON_FLUSH_END_OF_FRAME       (1 << 2)
  48
  49 /* Tiling flags. */
  50 enum radeon_bo_layout {
  51     RADEON_LAYOUT_LINEAR = 0,
  52     RADEON_LAYOUT_TILED,
  53     RADEON_LAYOUT_SQUARETILED,
  54
  55     RADEON_LAYOUT_UNKNOWN
  56 };
  57
  58 enum radeon_bo_domain { /* bitfield */
  59     RADEON_DOMAIN_GTT  = 2,
  60     RADEON_DOMAIN_VRAM = 4,
  61     RADEON_DOMAIN_VRAM_GTT = RADEON_DOMAIN_VRAM | RADEON_DOMAIN_GTT
  62 };
  63
  64 enum radeon_bo_flag { /* bitfield */
  65     RADEON_FLAG_GTT_WC =        (1 << 0),
  66     RADEON_FLAG_CPU_ACCESS =    (1 << 1),
  67     RADEON_FLAG_NO_CPU_ACCESS = (1 << 2),
  68 };
  69
  70 enum radeon_bo_usage { /* bitfield */
  71     RADEON_USAGE_READ = 2,
  72     RADEON_USAGE_WRITE = 4,
  73     RADEON_USAGE_READWRITE = RADEON_USAGE_READ | RADEON_USAGE_WRITE
  74 };
  75
  76 enum radeon_family {
  77     CHIP_UNKNOWN = 0,
  78     CHIP_R300, /* R3xx-based cores. */
  79     CHIP_R350,
  80     CHIP_RV350,
  81     CHIP_RV370,
  82     CHIP_RV380,
  83     CHIP_RS400,
  84     CHIP_RC410,
  85     CHIP_RS480,
  86     CHIP_R420,     /* R4xx-based cores. */
  87     CHIP_R423,
  88     CHIP_R430,
  89     CHIP_R480,
  90     CHIP_R481,
  91     CHIP_RV410,
  92     CHIP_RS600,
  93     CHIP_RS690,
  94     CHIP_RS740,
  95     CHIP_RV515,    /* R5xx-based cores. */
  96     CHIP_R520,
  97     CHIP_RV530,
  98     CHIP_R580,
  99     CHIP_RV560,
 100     CHIP_RV570,
 101     CHIP_R600,
 102     CHIP_RV610,
 103     CHIP_RV630,
 104     CHIP_RV670,
 105     CHIP_RV620,
 106     CHIP_RV635,
 107     CHIP_RS780,
 108     CHIP_RS880,
 109     CHIP_RV770,
 110     CHIP_RV730,
 111     CHIP_RV710,
 112     CHIP_RV740,
 113     CHIP_CEDAR,
 114     CHIP_REDWOOD,
 115     CHIP_JUNIPER,
 116     CHIP_CYPRESS,
 117     CHIP_HEMLOCK,
 118     CHIP_PALM,
 119     CHIP_SUMO,
 120     CHIP_SUMO2,
 121     CHIP_BARTS,
 122     CHIP_TURKS,
 123     CHIP_CAICOS,
 124     CHIP_CAYMAN,
 125     CHIP_ARUBA,
 126     CHIP_TAHITI,
 127     CHIP_PITCAIRN,
 128     CHIP_VERDE,
 129     CHIP_OLAND,
 130     CHIP_HAINAN,
 131     CHIP_BONAIRE,
 132     CHIP_KAVERI,
 133     CHIP_KABINI,
 134     CHIP_HAWAII,
 135     CHIP_MULLINS,
 136     CHIP_TONGA,
 137     CHIP_ICELAND,
 138     CHIP_CARRIZO,
 139     CHIP_FIJI,
 140     CHIP_STONEY,
 141     CHIP_LAST,
 142 };
 143
 144 enum chip_class {
 145     CLASS_UNKNOWN = 0,
 146     R300,
 147     R400,
 148     R500,
 149     R600,
 150     R700,
 151     EVERGREEN,
 152     CAYMAN,
 153     SI,
 154     CIK,
 155     VI,
 156 };
 157
 158 enum ring_type {
 159     RING_GFX = 0,
 160     RING_COMPUTE,
 161     RING_DMA,
 162     RING_UVD,
 163     RING_VCE,
 164     RING_LAST,
 165 };
 166
 167 enum radeon_value_id {
 168     RADEON_REQUESTED_VRAM_MEMORY,
 169     RADEON_REQUESTED_GTT_MEMORY,
 170     RADEON_BUFFER_WAIT_TIME_NS,
 171     RADEON_TIMESTAMP,
 172     RADEON_NUM_CS_FLUSHES,
 173     RADEON_NUM_BYTES_MOVED,
 174     RADEON_VRAM_USAGE,
 175     RADEON_GTT_USAGE,
 176     RADEON_GPU_TEMPERATURE, /* DRM 2.42.0 */
 177     RADEON_CURRENT_SCLK,
 178     RADEON_CURRENT_MCLK,
 179     RADEON_GPU_RESET_COUNTER, /* DRM 2.43.0 */
 180 };
 181
 182 /* Each group of four has the same priority. */
 183 enum radeon_bo_priority {
 184     RADEON_PRIO_FENCE = 0,
 185     RADEON_PRIO_TRACE,
 186     RADEON_PRIO_SO_FILLED_SIZE,
 187     RADEON_PRIO_QUERY,
 188
 189     RADEON_PRIO_IB1 = 4, /* main IB submitted to the kernel */
 190     RADEON_PRIO_IB2, /* IB executed with INDIRECT_BUFFER */
 191     RADEON_PRIO_DRAW_INDIRECT,
 192     RADEON_PRIO_INDEX_BUFFER,
 193
 194     RADEON_PRIO_CP_DMA = 8,
 195
 196     RADEON_PRIO_VCE = 12,
 197     RADEON_PRIO_UVD,
 198     RADEON_PRIO_SDMA_BUFFER,
 199     RADEON_PRIO_SDMA_TEXTURE,
 200
 201     RADEON_PRIO_USER_SHADER = 16,
 202     RADEON_PRIO_INTERNAL_SHADER, /* fetch shader, etc. */
 203
 204     /* gap: 20 */
 205
 206     RADEON_PRIO_CONST_BUFFER = 24,
 207     RADEON_PRIO_DESCRIPTORS,
 208     RADEON_PRIO_BORDER_COLORS,
 209
 210     RADEON_PRIO_SAMPLER_BUFFER = 28,
 211     RADEON_PRIO_VERTEX_BUFFER,
 212
 213     RADEON_PRIO_SHADER_RW_BUFFER = 32,
 214     RADEON_PRIO_RINGS_STREAMOUT,
 215     RADEON_PRIO_SCRATCH_BUFFER,
 216     RADEON_PRIO_COMPUTE_GLOBAL,
 217
 218     RADEON_PRIO_SAMPLER_TEXTURE = 36,
 219     RADEON_PRIO_SHADER_RW_IMAGE,
 220
 221     RADEON_PRIO_SAMPLER_TEXTURE_MSAA = 40,
 222
 223     RADEON_PRIO_COLOR_BUFFER = 44,
 224
 225     RADEON_PRIO_DEPTH_BUFFER = 48,
 226
 227     RADEON_PRIO_COLOR_BUFFER_MSAA = 52,
 228
 229     RADEON_PRIO_DEPTH_BUFFER_MSAA = 56,
 230
 231     RADEON_PRIO_CMASK = 60,
 232     RADEON_PRIO_DCC,
 233     RADEON_PRIO_HTILE,
 234     /* 63 is the maximum value */
 235 };
 236
 237 struct winsys_handle;
 238 struct radeon_winsys_cs_handle;
 239 struct radeon_winsys_ctx;
 240
 241 struct radeon_winsys_cs {
 242     unsigned                    cdw;  /* Number of used dwords. */
 243     unsigned                    max_dw; /* Maximum number of dwords. */
 244     uint32_t                    *buf; /* The command buffer. */
 245     enum ring_type              ring_type;
 246 };
 247
 248 struct radeon_info {
 249     uint32_t                    pci_id;
 250     enum radeon_family          family;
 251     enum chip_class             chip_class;
 252     uint64_t                    gart_size;
 253     uint64_t                    vram_size;
 254     uint32_t                    max_sclk;
 255     uint32_t                    max_compute_units;
 256     uint32_t                    max_se;
 257     uint32_t                    max_sh_per_se;
 258
 259     uint32_t                    drm_major; /* version */
 260     uint32_t                    drm_minor;
 261     uint32_t                    drm_patchlevel;
 262
 263     boolean                     has_uvd;
 264     uint32_t                    vce_fw_version;
 265     boolean                     has_userptr;
 266     bool                        gfx_ib_pad_with_type2;
 267
 268     uint32_t                    r300_num_gb_pipes;
 269     uint32_t                    r300_num_z_pipes;
 270
 271     uint32_t                    r600_num_backends;
 272     uint32_t                    r600_clock_crystal_freq;
 273     uint32_t                    r600_tiling_config;
 274     uint32_t                    r600_num_tile_pipes;
 275     uint32_t                    r600_max_pipes;
 276     boolean                     r600_virtual_address;
 277     boolean                     r600_has_dma;
 278
 279     uint32_t                    r600_backend_map;
 280     boolean                     r600_backend_map_valid;
 281
 282     boolean                     si_tile_mode_array_valid;
 283     uint32_t                    si_tile_mode_array[32];
 284     uint32_t                    si_backend_enabled_mask;
 285
 286     boolean                     cik_macrotile_mode_array_valid;
 287     uint32_t                    cik_macrotile_mode_array[16];
 288     uint32_t                    vce_harvest_config;
 289 };
 290
 291 enum radeon_feature_id {
 292     RADEON_FID_R300_HYPERZ_ACCESS,     /* ZMask + HiZ */
 293     RADEON_FID_R300_CMASK_ACCESS,
 294 };
 295
 296 #define RADEON_SURF_MAX_LEVEL                   32
 297
 298 #define RADEON_SURF_TYPE_MASK                   0xFF
 299 #define RADEON_SURF_TYPE_SHIFT                  0
 300 #define     RADEON_SURF_TYPE_1D                     0
 301 #define     RADEON_SURF_TYPE_2D                     1
 302 #define     RADEON_SURF_TYPE_3D                     2
 303 #define     RADEON_SURF_TYPE_CUBEMAP                3
 304 #define     RADEON_SURF_TYPE_1D_ARRAY               4
 305 #define     RADEON_SURF_TYPE_2D_ARRAY               5
 306 #define RADEON_SURF_MODE_MASK                   0xFF
 307 #define RADEON_SURF_MODE_SHIFT                  8
 308 #define     RADEON_SURF_MODE_LINEAR                 0
 309 #define     RADEON_SURF_MODE_LINEAR_ALIGNED         1
 310 #define     RADEON_SURF_MODE_1D                     2
 311 #define     RADEON_SURF_MODE_2D                     3
 312 #define RADEON_SURF_SCANOUT                     (1 << 16)
 313 #define RADEON_SURF_ZBUFFER                     (1 << 17)
 314 #define RADEON_SURF_SBUFFER                     (1 << 18)
 315 #define RADEON_SURF_Z_OR_SBUFFER                (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
 316 #define RADEON_SURF_HAS_SBUFFER_MIPTREE         (1 << 19)
 317 #define RADEON_SURF_HAS_TILE_MODE_INDEX         (1 << 20)
 318 #define RADEON_SURF_FMASK                       (1 << 21)
 319
 320 #define RADEON_SURF_GET(v, field)   (((v) >> RADEON_SURF_ ## field ## _SHIFT) & RADEON_SURF_ ## field ## _MASK)
 321 #define RADEON_SURF_SET(v, field)   (((v) & RADEON_SURF_ ## field ## _MASK) << RADEON_SURF_ ## field ## _SHIFT)
 322 #define RADEON_SURF_CLR(v, field)   ((v) & ~(RADEON_SURF_ ## field ## _MASK << RADEON_SURF_ ## field ## _SHIFT))
 323
 324 struct radeon_surf_level {
 325     uint64_t                    offset;
 326     uint64_t                    slice_size;
 327     uint32_t                    npix_x;
 328     uint32_t                    npix_y;
 329     uint32_t                    npix_z;
 330     uint32_t                    nblk_x;
 331     uint32_t                    nblk_y;
 332     uint32_t                    nblk_z;
 333     uint32_t                    pitch_bytes;
 334     uint32_t                    mode;
 335     uint64_t                    dcc_offset;
 336 };
 337
 338 struct radeon_surf {
 339     /* These are inputs to the calculator. */
 340     uint32_t                    npix_x;
 341     uint32_t                    npix_y;
 342     uint32_t                    npix_z;
 343     uint32_t                    blk_w;
 344     uint32_t                    blk_h;
 345     uint32_t                    blk_d;
 346     uint32_t                    array_size;
 347     uint32_t                    last_level;
 348     uint32_t                    bpe;
 349     uint32_t                    nsamples;
 350     uint32_t                    flags;
 351
 352     /* These are return values. Some of them can be set by the caller, but
 353      * they will be treated as hints (e.g. bankw, bankh) and might be
 354      * changed by the calculator.
 355      */
 356     uint64_t                    bo_size;
 357     uint64_t                    bo_alignment;
 358     /* This applies to EG and later. */
 359     uint32_t                    bankw;
 360     uint32_t                    bankh;
 361     uint32_t                    mtilea;
 362     uint32_t                    tile_split;
 363     uint32_t                    stencil_tile_split;
 364     uint64_t                    stencil_offset;
 365     struct radeon_surf_level    level[RADEON_SURF_MAX_LEVEL];
 366     struct radeon_surf_level    stencil_level[RADEON_SURF_MAX_LEVEL];
 367     uint32_t                    tiling_index[RADEON_SURF_MAX_LEVEL];
 368     uint32_t                    stencil_tiling_index[RADEON_SURF_MAX_LEVEL];
 369     uint32_t                    pipe_config;
 370     uint32_t                    num_banks;
 371
 372     uint64_t                    dcc_size;
 373     uint64_t                    dcc_alignment;
 374     bool                        dcc_enabled;
 375 };
 376
 377 struct radeon_bo_list_item {
 378     struct pb_buffer *buf;
 379     uint64_t vm_address;
 380     uint64_t priority_usage; /* mask of (1 << RADEON_PRIO_*) */
 381 };
 382
 383 struct radeon_winsys {
 384     /**
 385      * The screen object this winsys was created for
 386      */
 387     struct pipe_screen *screen;
 388
 389     /**
 390      * Decrement the winsys reference count.
 391      *
 392      * \param ws  The winsys this function is called for.
 393      * \return    True if the winsys and screen should be destroyed.
 394      */
 395     bool (*unref)(struct radeon_winsys *ws);
 396
 397     /**
 398      * Destroy this winsys.
 399      *
 400      * \param ws        The winsys this function is called from.
 401      */
 402     void (*destroy)(struct radeon_winsys *ws);
 403
 404     /**
 405      * Query an info structure from winsys.
 406      *
 407      * \param ws        The winsys this function is called from.
 408      * \param info      Return structure
 409      */
 410     void (*query_info)(struct radeon_winsys *ws,
 411                        struct radeon_info *info);
 412
 413     /**************************************************************************
 414      * Buffer management. Buffer attributes are mostly fixed over its lifetime.
 415      *
 416      * Remember that gallium gets to choose the interface it needs, and the
 417      * window systems must then implement that interface (rather than the
 418      * other way around...).
 419      *************************************************************************/
 420
 421     /**
 422      * Create a buffer object.
 423      *
 424      * \param ws        The winsys this function is called from.
 425      * \param size      The size to allocate.
 426      * \param alignment An alignment of the buffer in memory.
 427      * \param use_reusable_pool Whether the cache buffer manager should be used.
 428      * \param domain    A bitmask of the RADEON_DOMAIN_* flags.
 429      * \return          The created buffer object.
 430      */
 431     struct pb_buffer *(*buffer_create)(struct radeon_winsys *ws,
 432                                        unsigned size,
 433                                        unsigned alignment,
 434                                        boolean use_reusable_pool,
 435                                        enum radeon_bo_domain domain,
 436                                        enum radeon_bo_flag flags);
 437
 438     struct radeon_winsys_cs_handle *(*buffer_get_cs_handle)(
 439             struct pb_buffer *buf);
 440
 441     /**
 442      * Map the entire data store of a buffer object into the client's address
 443      * space.
 444      *
 445      * \param buf       A winsys buffer object to map.
 446      * \param cs        A command stream to flush if the buffer is referenced by it.
 447      * \param usage     A bitmask of the PIPE_TRANSFER_* flags.
 448      * \return          The pointer at the beginning of the buffer.
 449      */
 450     void *(*buffer_map)(struct radeon_winsys_cs_handle *buf,
 451                         struct radeon_winsys_cs *cs,
 452                         enum pipe_transfer_usage usage);
 453
 454     /**
 455      * Unmap a buffer object from the client's address space.
 456      *
 457      * \param buf       A winsys buffer object to unmap.
 458      */
 459     void (*buffer_unmap)(struct radeon_winsys_cs_handle *buf);
 460
 461     /**
 462      * Wait for the buffer and return true if the buffer is not used
 463      * by the device.
 464      *
 465      * The timeout of 0 will only return the status.
 466      * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the buffer
 467      * is idle.
 468      */
 469     bool (*buffer_wait)(struct pb_buffer *buf, uint64_t timeout,
 470                         enum radeon_bo_usage usage);
 471
 472     /**
 473      * Return tiling flags describing a memory layout of a buffer object.
 474      *
 475      * \param buf       A winsys buffer object to get the flags from.
 476      * \param macrotile A pointer to the return value of the microtile flag.
 477      * \param microtile A pointer to the return value of the macrotile flag.
 478      *
 479      * \note microtile and macrotile are not bitmasks!
 480      */
 481     void (*buffer_get_tiling)(struct pb_buffer *buf,
 482                               enum radeon_bo_layout *microtile,
 483                               enum radeon_bo_layout *macrotile,
 484                               unsigned *bankw, unsigned *bankh,
 485                               unsigned *tile_split,
 486                               unsigned *stencil_tile_split,
 487                               unsigned *mtilea,
 488                               bool *scanout);
 489
 490     /**
 491      * Set tiling flags describing a memory layout of a buffer object.
 492      *
 493      * \param buf       A winsys buffer object to set the flags for.
 494      * \param cs        A command stream to flush if the buffer is referenced by it.
 495      * \param macrotile A macrotile flag.
 496      * \param microtile A microtile flag.
 497      * \param stride    A stride of the buffer in bytes, for texturing.
 498      *
 499      * \note microtile and macrotile are not bitmasks!
 500      */
 501     void (*buffer_set_tiling)(struct pb_buffer *buf,
 502                               struct radeon_winsys_cs *rcs,
 503                               enum radeon_bo_layout microtile,
 504                               enum radeon_bo_layout macrotile,
 505                               unsigned pipe_config,
 506                               unsigned bankw, unsigned bankh,
 507                               unsigned tile_split,
 508                               unsigned stencil_tile_split,
 509                               unsigned mtilea, unsigned num_banks,
 510                               unsigned stride,
 511                               bool scanout);
 512
 513     /**
 514      * Get a winsys buffer from a winsys handle. The internal structure
 515      * of the handle is platform-specific and only a winsys should access it.
 516      *
 517      * \param ws        The winsys this function is called from.
 518      * \param whandle   A winsys handle pointer as was received from a state
 519      *                  tracker.
 520      * \param stride    The returned buffer stride in bytes.
 521      */
 522     struct pb_buffer *(*buffer_from_handle)(struct radeon_winsys *ws,
 523                                             struct winsys_handle *whandle,
 524                                             unsigned *stride);
 525
 526     /**
 527      * Get a winsys buffer from a user pointer. The resulting buffer can't
 528      * be exported. Both pointer and size must be page aligned.
 529      *
 530      * \param ws        The winsys this function is called from.
 531      * \param pointer   User pointer to turn into a buffer object.
 532      * \param Size      Size in bytes for the new buffer.
 533      */
 534     struct pb_buffer *(*buffer_from_ptr)(struct radeon_winsys *ws,
 535                                          void *pointer, unsigned size);
 536
 537     /**
 538      * Get a winsys handle from a winsys buffer. The internal structure
 539      * of the handle is platform-specific and only a winsys should access it.
 540      *
 541      * \param buf       A winsys buffer object to get the handle from.
 542      * \param whandle   A winsys handle pointer.
 543      * \param stride    A stride of the buffer in bytes, for texturing.
 544      * \return          TRUE on success.
 545      */
 546     boolean (*buffer_get_handle)(struct pb_buffer *buf,
 547                                  unsigned stride,
 548                                  struct winsys_handle *whandle);
 549
 550     /**
 551      * Return the virtual address of a buffer.
 552      *
 553      * \param buf       A winsys buffer object
 554      * \return          virtual address
 555      */
 556     uint64_t (*buffer_get_virtual_address)(struct radeon_winsys_cs_handle *buf);
 557
 558     /**
 559      * Query the initial placement of the buffer from the kernel driver.
 560      */
 561     enum radeon_bo_domain (*buffer_get_initial_domain)(struct radeon_winsys_cs_handle *buf);
 562
 563     /**************************************************************************
 564      * Command submission.
 565      *
 566      * Each pipe context should create its own command stream and submit
 567      * commands independently of other contexts.
 568      *************************************************************************/
 569
 570     /**
 571      * Create a command submission context.
 572      * Various command streams can be submitted to the same context.
 573      */
 574     struct radeon_winsys_ctx *(*ctx_create)(struct radeon_winsys *ws);
 575
 576     /**
 577      * Destroy a context.
 578      */
 579     void (*ctx_destroy)(struct radeon_winsys_ctx *ctx);
 580
 581     /**
 582      * Query a GPU reset status.
 583      */
 584     enum pipe_reset_status (*ctx_query_reset_status)(struct radeon_winsys_ctx *ctx);
 585
 586     /**
 587      * Create a command stream.
 588      *
 589      * \param ctx       The submission context
 590      * \param ring_type The ring type (GFX, DMA, UVD)
 591      * \param flush     Flush callback function associated with the command stream.
 592      * \param user      User pointer that will be passed to the flush callback.
 593      * \param trace_buf Trace buffer when tracing is enabled
 594      */
 595     struct radeon_winsys_cs *(*cs_create)(struct radeon_winsys_ctx *ctx,
 596                                           enum ring_type ring_type,
 597                                           void (*flush)(void *ctx, unsigned flags,
 598                                                         struct pipe_fence_handle **fence),
 599                                           void *flush_ctx,
 600                                           struct radeon_winsys_cs_handle *trace_buf);
 601
 602     /**
 603      * Destroy a command stream.
 604      *
 605      * \param cs        A command stream to destroy.
 606      */
 607     void (*cs_destroy)(struct radeon_winsys_cs *cs);
 608
 609     /**
 610      * Add a buffer. Each buffer used by a CS must be added using this function.
 611      *
 612      * \param cs      Command stream
 613      * \param buf     Buffer
 614      * \param usage   Whether the buffer is used for read and/or write.
 615      * \param domain  Bitmask of the RADEON_DOMAIN_* flags.
 616      * \param priority  A higher number means a greater chance of being
 617      *                  placed in the requested domain. 15 is the maximum.
 618      * \return Buffer index.
 619      */
 620     unsigned (*cs_add_buffer)(struct radeon_winsys_cs *cs,
 621                              struct radeon_winsys_cs_handle *buf,
 622                              enum radeon_bo_usage usage,
 623                              enum radeon_bo_domain domain,
 624                              enum radeon_bo_priority priority);
 625
 626     /**
 627      * Return the index of an already-added buffer.
 628      *
 629      * \param cs        Command stream
 630      * \param buf       Buffer
 631      * \return          The buffer index, or -1 if the buffer has not been added.
 632      */
 633     int (*cs_lookup_buffer)(struct radeon_winsys_cs *cs,
 634                             struct radeon_winsys_cs_handle *buf);
 635
 636     /**
 637      * Return TRUE if there is enough memory in VRAM and GTT for the buffers
 638      * added so far. If the validation fails, all buffers which have
 639      * been added since the last call of cs_validate will be removed and
 640      * the CS will be flushed (provided there are still any buffers).
 641      *
 642      * \param cs        A command stream to validate.
 643      */
 644     boolean (*cs_validate)(struct radeon_winsys_cs *cs);
 645
 646     /**
 647      * Return TRUE if there is enough memory in VRAM and GTT for the buffers
 648      * added so far.
 649      *
 650      * \param cs        A command stream to validate.
 651      * \param vram      VRAM memory size pending to be use
 652      * \param gtt       GTT memory size pending to be use
 653      */
 654     boolean (*cs_memory_below_limit)(struct radeon_winsys_cs *cs, uint64_t vram, uint64_t gtt);
 655
 656     /**
 657      * Return the buffer list.
 658      *
 659      * \param cs    Command stream
 660      * \param list  Returned buffer list. Set to NULL to query the count only.
 661      * \return      The buffer count.
 662      */
 663     unsigned (*cs_get_buffer_list)(struct radeon_winsys_cs *cs,
 664                                    struct radeon_bo_list_item *list);
 665
 666     /**
 667      * Flush a command stream.
 668      *
 669      * \param cs          A command stream to flush.
 670      * \param flags,      RADEON_FLUSH_ASYNC or 0.
 671      * \param fence       Pointer to a fence. If non-NULL, a fence is inserted
 672      *                    after the CS and is returned through this parameter.
 673      * \param cs_trace_id A unique identifier of the cs, used for tracing.
 674      */
 675     void (*cs_flush)(struct radeon_winsys_cs *cs,
 676                      unsigned flags,
 677                      struct pipe_fence_handle **fence,
 678                      uint32_t cs_trace_id);
 679
 680     /**
 681      * Return TRUE if a buffer is referenced by a command stream.
 682      *
 683      * \param cs        A command stream.
 684      * \param buf       A winsys buffer.
 685      */
 686     boolean (*cs_is_buffer_referenced)(struct radeon_winsys_cs *cs,
 687                                        struct radeon_winsys_cs_handle *buf,
 688                                        enum radeon_bo_usage usage);
 689
 690     /**
 691      * Request access to a feature for a command stream.
 692      *
 693      * \param cs        A command stream.
 694      * \param fid       Feature ID, one of RADEON_FID_*
 695      * \param enable    Whether to enable or disable the feature.
 696      */
 697     boolean (*cs_request_feature)(struct radeon_winsys_cs *cs,
 698                                   enum radeon_feature_id fid,
 699                                   boolean enable);
 700      /**
 701       * Make sure all asynchronous flush of the cs have completed
 702       *
 703       * \param cs        A command stream.
 704       */
 705     void (*cs_sync_flush)(struct radeon_winsys_cs *cs);
 706
 707     /**
 708      * Wait for the fence and return true if the fence has been signalled.
 709      * The timeout of 0 will only return the status.
 710      * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the fence
 711      * is signalled.
 712      */
 713     bool (*fence_wait)(struct radeon_winsys *ws,
 714                        struct pipe_fence_handle *fence,
 715                        uint64_t timeout);
 716
 717     /**
 718      * Reference counting for fences.
 719      */
 720     void (*fence_reference)(struct pipe_fence_handle **dst,
 721                             struct pipe_fence_handle *src);
 722
 723     /**
 724      * Initialize surface
 725      *
 726      * \param ws        The winsys this function is called from.
 727      * \param surf      Surface structure ptr
 728      */
 729     int (*surface_init)(struct radeon_winsys *ws,
 730                         struct radeon_surf *surf);
 731
 732     /**
 733      * Find best values for a surface
 734      *
 735      * \param ws        The winsys this function is called from.
 736      * \param surf      Surface structure ptr
 737      */
 738     int (*surface_best)(struct radeon_winsys *ws,
 739                         struct radeon_surf *surf);
 740
 741     uint64_t (*query_value)(struct radeon_winsys *ws,
 742                             enum radeon_value_id value);
 743
 744     bool (*read_registers)(struct radeon_winsys *ws, unsigned reg_offset,
 745                            unsigned num_registers, uint32_t *out);
 746 };
 747
 748
 749 static inline void radeon_emit(struct radeon_winsys_cs *cs, uint32_t value)
 750 {
 751     cs->buf[cs->cdw++] = value;
 752 }
 753
 754 static inline void radeon_emit_array(struct radeon_winsys_cs *cs,
 755                                      const uint32_t *values, unsigned count)
 756 {
 757     memcpy(cs->buf+cs->cdw, values, count * 4);
 758     cs->cdw += count;
 759 }
 760
 761 #endif