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