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_chunk {
 229     unsigned cdw;  /* Number of used dwords. */
 230     unsigned max_dw; /* Maximum number of dwords. */
 231     uint32_t *buf; /* The base pointer of the chunk. */
 232 };
 233
 234 struct radeon_winsys_cs {
 235     struct radeon_winsys_cs_chunk current;
 236     struct radeon_winsys_cs_chunk *prev;
 237     unsigned                      num_prev; /* Number of previous chunks. */
 238     unsigned                      max_prev; /* Space in array pointed to by prev. */
 239     unsigned                      prev_dw; /* Total number of dwords in previous chunks. */
 240 };
 241
 242 struct radeon_info {
 243     /* PCI info: domain:bus:dev:func */
 244     uint32_t                    pci_domain;
 245     uint32_t                    pci_bus;
 246     uint32_t                    pci_dev;
 247     uint32_t                    pci_func;
 248
 249     /* Device info. */
 250     uint32_t                    pci_id;
 251     enum radeon_family          family;
 252     enum chip_class             chip_class;
 253     uint32_t                    gart_page_size;
 254     uint64_t                    gart_size;
 255     uint64_t                    vram_size;
 256     bool                        has_dedicated_vram;
 257     boolean                     has_virtual_memory;
 258     bool                        gfx_ib_pad_with_type2;
 259     boolean                     has_sdma;
 260     boolean                     has_uvd;
 261     uint32_t                    vce_fw_version;
 262     uint32_t                    vce_harvest_config;
 263     uint32_t                    clock_crystal_freq;
 264
 265     /* Kernel info. */
 266     uint32_t                    drm_major; /* version */
 267     uint32_t                    drm_minor;
 268     uint32_t                    drm_patchlevel;
 269     boolean                     has_userptr;
 270
 271     /* Shader cores. */
 272     uint32_t                    r600_max_quad_pipes; /* wave size / 16 */
 273     uint32_t                    max_shader_clock;
 274     uint32_t                    num_good_compute_units;
 275     uint32_t                    max_se; /* shader engines */
 276     uint32_t                    max_sh_per_se; /* shader arrays per shader engine */
 277
 278     /* Render backends (color + depth blocks). */
 279     uint32_t                    r300_num_gb_pipes;
 280     uint32_t                    r300_num_z_pipes;
 281     uint32_t                    r600_gb_backend_map; /* R600 harvest config */
 282     boolean                     r600_gb_backend_map_valid;
 283     uint32_t                    r600_num_banks;
 284     uint32_t                    num_render_backends;
 285     uint32_t                    num_tile_pipes; /* pipe count from PIPE_CONFIG */
 286     uint32_t                    pipe_interleave_bytes;
 287     uint32_t                    enabled_rb_mask; /* GCN harvest config */
 288
 289     /* Tile modes. */
 290     uint32_t                    si_tile_mode_array[32];
 291     uint32_t                    cik_macrotile_mode_array[16];
 292 };
 293
 294 /* Tiling info for display code, DRI sharing, and other data. */
 295 struct radeon_bo_metadata {
 296     /* Tiling flags describing the texture layout for display code
 297      * and DRI sharing.
 298      */
 299     enum radeon_bo_layout   microtile;
 300     enum radeon_bo_layout   macrotile;
 301     unsigned                pipe_config;
 302     unsigned                bankw;
 303     unsigned                bankh;
 304     unsigned                tile_split;
 305     unsigned                mtilea;
 306     unsigned                num_banks;
 307     unsigned                stride;
 308     bool                    scanout;
 309
 310     /* Additional metadata associated with the buffer, in bytes.
 311      * The maximum size is 64 * 4. This is opaque for the winsys & kernel.
 312      * Supported by amdgpu only.
 313      */
 314     uint32_t                size_metadata;
 315     uint32_t                metadata[64];
 316 };
 317
 318 enum radeon_feature_id {
 319     RADEON_FID_R300_HYPERZ_ACCESS,     /* ZMask + HiZ */
 320     RADEON_FID_R300_CMASK_ACCESS,
 321 };
 322
 323 #define RADEON_SURF_MAX_LEVEL                   32
 324
 325 #define RADEON_SURF_TYPE_MASK                   0xFF
 326 #define RADEON_SURF_TYPE_SHIFT                  0
 327 #define     RADEON_SURF_TYPE_1D                     0
 328 #define     RADEON_SURF_TYPE_2D                     1
 329 #define     RADEON_SURF_TYPE_3D                     2
 330 #define     RADEON_SURF_TYPE_CUBEMAP                3
 331 #define     RADEON_SURF_TYPE_1D_ARRAY               4
 332 #define     RADEON_SURF_TYPE_2D_ARRAY               5
 333 #define RADEON_SURF_MODE_MASK                   0xFF
 334 #define RADEON_SURF_MODE_SHIFT                  8
 335 #define     RADEON_SURF_MODE_LINEAR_ALIGNED         1
 336 #define     RADEON_SURF_MODE_1D                     2
 337 #define     RADEON_SURF_MODE_2D                     3
 338 #define RADEON_SURF_SCANOUT                     (1 << 16)
 339 #define RADEON_SURF_ZBUFFER                     (1 << 17)
 340 #define RADEON_SURF_SBUFFER                     (1 << 18)
 341 #define RADEON_SURF_Z_OR_SBUFFER                (RADEON_SURF_ZBUFFER | RADEON_SURF_SBUFFER)
 342 #define RADEON_SURF_HAS_SBUFFER_MIPTREE         (1 << 19)
 343 #define RADEON_SURF_HAS_TILE_MODE_INDEX         (1 << 20)
 344 #define RADEON_SURF_FMASK                       (1 << 21)
 345
 346 #define RADEON_SURF_GET(v, field)   (((v) >> RADEON_SURF_ ## field ## _SHIFT) & RADEON_SURF_ ## field ## _MASK)
 347 #define RADEON_SURF_SET(v, field)   (((v) & RADEON_SURF_ ## field ## _MASK) << RADEON_SURF_ ## field ## _SHIFT)
 348 #define RADEON_SURF_CLR(v, field)   ((v) & ~(RADEON_SURF_ ## field ## _MASK << RADEON_SURF_ ## field ## _SHIFT))
 349
 350 struct radeon_surf_level {
 351     uint64_t                    offset;
 352     uint64_t                    slice_size;
 353     uint32_t                    npix_x;
 354     uint32_t                    npix_y;
 355     uint32_t                    npix_z;
 356     uint32_t                    nblk_x;
 357     uint32_t                    nblk_y;
 358     uint32_t                    nblk_z;
 359     uint32_t                    pitch_bytes;
 360     uint32_t                    mode;
 361     uint64_t                    dcc_offset;
 362 };
 363
 364 struct radeon_surf {
 365     /* These are inputs to the calculator. */
 366     uint32_t                    npix_x;
 367     uint32_t                    npix_y;
 368     uint32_t                    npix_z;
 369     uint32_t                    blk_w;
 370     uint32_t                    blk_h;
 371     uint32_t                    blk_d;
 372     uint32_t                    array_size;
 373     uint32_t                    last_level;
 374     uint32_t                    bpe;
 375     uint32_t                    nsamples;
 376     uint32_t                    flags;
 377
 378     /* These are return values. Some of them can be set by the caller, but
 379      * they will be treated as hints (e.g. bankw, bankh) and might be
 380      * changed by the calculator.
 381      */
 382     uint64_t                    bo_size;
 383     uint64_t                    bo_alignment;
 384     /* This applies to EG and later. */
 385     uint32_t                    bankw;
 386     uint32_t                    bankh;
 387     uint32_t                    mtilea;
 388     uint32_t                    tile_split;
 389     uint32_t                    stencil_tile_split;
 390     uint64_t                    stencil_offset;
 391     struct radeon_surf_level    level[RADEON_SURF_MAX_LEVEL];
 392     struct radeon_surf_level    stencil_level[RADEON_SURF_MAX_LEVEL];
 393     uint32_t                    tiling_index[RADEON_SURF_MAX_LEVEL];
 394     uint32_t                    stencil_tiling_index[RADEON_SURF_MAX_LEVEL];
 395     uint32_t                    pipe_config;
 396     uint32_t                    num_banks;
 397     uint32_t                    macro_tile_index;
 398
 399     uint64_t                    dcc_size;
 400     uint64_t                    dcc_alignment;
 401 };
 402
 403 struct radeon_bo_list_item {
 404     struct pb_buffer *buf;
 405     uint64_t vm_address;
 406     uint64_t priority_usage; /* mask of (1 << RADEON_PRIO_*) */
 407 };
 408
 409 struct radeon_winsys {
 410     /**
 411      * The screen object this winsys was created for
 412      */
 413     struct pipe_screen *screen;
 414
 415     /**
 416      * Decrement the winsys reference count.
 417      *
 418      * \param ws  The winsys this function is called for.
 419      * \return    True if the winsys and screen should be destroyed.
 420      */
 421     bool (*unref)(struct radeon_winsys *ws);
 422
 423     /**
 424      * Destroy this winsys.
 425      *
 426      * \param ws        The winsys this function is called from.
 427      */
 428     void (*destroy)(struct radeon_winsys *ws);
 429
 430     /**
 431      * Query an info structure from winsys.
 432      *
 433      * \param ws        The winsys this function is called from.
 434      * \param info      Return structure
 435      */
 436     void (*query_info)(struct radeon_winsys *ws,
 437                        struct radeon_info *info);
 438
 439     /**************************************************************************
 440      * Buffer management. Buffer attributes are mostly fixed over its lifetime.
 441      *
 442      * Remember that gallium gets to choose the interface it needs, and the
 443      * window systems must then implement that interface (rather than the
 444      * other way around...).
 445      *************************************************************************/
 446
 447     /**
 448      * Create a buffer object.
 449      *
 450      * \param ws        The winsys this function is called from.
 451      * \param size      The size to allocate.
 452      * \param alignment An alignment of the buffer in memory.
 453      * \param use_reusable_pool Whether the cache buffer manager should be used.
 454      * \param domain    A bitmask of the RADEON_DOMAIN_* flags.
 455      * \return          The created buffer object.
 456      */
 457     struct pb_buffer *(*buffer_create)(struct radeon_winsys *ws,
 458                                        uint64_t size,
 459                                        unsigned alignment,
 460                                        enum radeon_bo_domain domain,
 461                                        enum radeon_bo_flag flags);
 462
 463     /**
 464      * Map the entire data store of a buffer object into the client's address
 465      * space.
 466      *
 467      * \param buf       A winsys buffer object to map.
 468      * \param cs        A command stream to flush if the buffer is referenced by it.
 469      * \param usage     A bitmask of the PIPE_TRANSFER_* flags.
 470      * \return          The pointer at the beginning of the buffer.
 471      */
 472     void *(*buffer_map)(struct pb_buffer *buf,
 473                         struct radeon_winsys_cs *cs,
 474                         enum pipe_transfer_usage usage);
 475
 476     /**
 477      * Unmap a buffer object from the client's address space.
 478      *
 479      * \param buf       A winsys buffer object to unmap.
 480      */
 481     void (*buffer_unmap)(struct pb_buffer *buf);
 482
 483     /**
 484      * Wait for the buffer and return true if the buffer is not used
 485      * by the device.
 486      *
 487      * The timeout of 0 will only return the status.
 488      * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the buffer
 489      * is idle.
 490      */
 491     bool (*buffer_wait)(struct pb_buffer *buf, uint64_t timeout,
 492                         enum radeon_bo_usage usage);
 493
 494     /**
 495      * Return buffer metadata.
 496      * (tiling info for display code, DRI sharing, and other data)
 497      *
 498      * \param buf       A winsys buffer object to get the flags from.
 499      * \param md        Metadata
 500      */
 501     void (*buffer_get_metadata)(struct pb_buffer *buf,
 502                                 struct radeon_bo_metadata *md);
 503
 504     /**
 505      * Set buffer metadata.
 506      * (tiling info for display code, DRI sharing, and other data)
 507      *
 508      * \param buf       A winsys buffer object to set the flags for.
 509      * \param md        Metadata
 510      */
 511     void (*buffer_set_metadata)(struct pb_buffer *buf,
 512                                 struct radeon_bo_metadata *md);
 513
 514     /**
 515      * Get a winsys buffer from a winsys handle. The internal structure
 516      * of the handle is platform-specific and only a winsys should access it.
 517      *
 518      * \param ws        The winsys this function is called from.
 519      * \param whandle   A winsys handle pointer as was received from a state
 520      *                  tracker.
 521      * \param stride    The returned buffer stride in bytes.
 522      */
 523     struct pb_buffer *(*buffer_from_handle)(struct radeon_winsys *ws,
 524                                             struct winsys_handle *whandle,
 525                                             unsigned *stride, unsigned *offset);
 526
 527     /**
 528      * Get a winsys buffer from a user pointer. The resulting buffer can't
 529      * be exported. Both pointer and size must be page aligned.
 530      *
 531      * \param ws        The winsys this function is called from.
 532      * \param pointer   User pointer to turn into a buffer object.
 533      * \param Size      Size in bytes for the new buffer.
 534      */
 535     struct pb_buffer *(*buffer_from_ptr)(struct radeon_winsys *ws,
 536                                          void *pointer, uint64_t size);
 537
 538     /**
 539      * Whether the buffer was created from a user pointer.
 540      *
 541      * \param buf       A winsys buffer object
 542      * \return          whether \p buf was created via buffer_from_ptr
 543      */
 544     bool (*buffer_is_user_ptr)(struct pb_buffer *buf);
 545
 546     /**
 547      * Get a winsys handle from a winsys buffer. The internal structure
 548      * of the handle is platform-specific and only a winsys should access it.
 549      *
 550      * \param buf       A winsys buffer object to get the handle from.
 551      * \param whandle   A winsys handle pointer.
 552      * \param stride    A stride of the buffer in bytes, for texturing.
 553      * \return          TRUE on success.
 554      */
 555     boolean (*buffer_get_handle)(struct pb_buffer *buf,
 556                                  unsigned stride, unsigned offset,
 557                                  unsigned slice_size,
 558                                  struct winsys_handle *whandle);
 559
 560     /**
 561      * Return the virtual address of a buffer.
 562      *
 563      * \param buf       A winsys buffer object
 564      * \return          virtual address
 565      */
 566     uint64_t (*buffer_get_virtual_address)(struct pb_buffer *buf);
 567
 568     /**
 569      * Query the initial placement of the buffer from the kernel driver.
 570      */
 571     enum radeon_bo_domain (*buffer_get_initial_domain)(struct pb_buffer *buf);
 572
 573     /**************************************************************************
 574      * Command submission.
 575      *
 576      * Each pipe context should create its own command stream and submit
 577      * commands independently of other contexts.
 578      *************************************************************************/
 579
 580     /**
 581      * Create a command submission context.
 582      * Various command streams can be submitted to the same context.
 583      */
 584     struct radeon_winsys_ctx *(*ctx_create)(struct radeon_winsys *ws);
 585
 586     /**
 587      * Destroy a context.
 588      */
 589     void (*ctx_destroy)(struct radeon_winsys_ctx *ctx);
 590
 591     /**
 592      * Query a GPU reset status.
 593      */
 594     enum pipe_reset_status (*ctx_query_reset_status)(struct radeon_winsys_ctx *ctx);
 595
 596     /**
 597      * Create a command stream.
 598      *
 599      * \param ctx       The submission context
 600      * \param ring_type The ring type (GFX, DMA, UVD)
 601      * \param flush     Flush callback function associated with the command stream.
 602      * \param user      User pointer that will be passed to the flush callback.
 603      */
 604     struct radeon_winsys_cs *(*cs_create)(struct radeon_winsys_ctx *ctx,
 605                                           enum ring_type ring_type,
 606                                           void (*flush)(void *ctx, unsigned flags,
 607                                                         struct pipe_fence_handle **fence),
 608                                           void *flush_ctx);
 609
 610     /**
 611      * Add a constant engine IB to a graphics CS. This makes the graphics CS
 612      * from "cs_create" a group of two IBs that share a buffer list and are
 613      * flushed together.
 614      *
 615      * The returned constant CS is only a stream for writing packets to the new
 616      * IB. Calling other winsys functions with it is not allowed, not even
 617      * "cs_destroy".
 618      *
 619      * In order to add buffers and check memory usage, use the graphics CS.
 620      * In order to flush it, use the graphics CS, which will flush both IBs.
 621      * Destroying the graphics CS will destroy both of them.
 622      *
 623      * \param cs  The graphics CS from "cs_create" that will hold the buffer
 624      *            list and will be used for flushing.
 625      */
 626     struct radeon_winsys_cs *(*cs_add_const_ib)(struct radeon_winsys_cs *cs);
 627
 628      /**
 629      * Add a constant engine preamble IB to a graphics CS. This add an extra IB
 630      * in similar manner to cs_add_const_ib. This should always be called after
 631      * cs_add_const_ib.
 632      *
 633      * The returned IB is a constant engine IB that only gets flushed if the
 634      * context changed.
 635      *
 636      * \param cs  The graphics CS from "cs_create" that will hold the buffer
 637      *            list and will be used for flushing.
 638      */
 639     struct radeon_winsys_cs *(*cs_add_const_preamble_ib)(struct radeon_winsys_cs *cs);
 640     /**
 641      * Destroy a command stream.
 642      *
 643      * \param cs        A command stream to destroy.
 644      */
 645     void (*cs_destroy)(struct radeon_winsys_cs *cs);
 646
 647     /**
 648      * Add a buffer. Each buffer used by a CS must be added using this function.
 649      *
 650      * \param cs      Command stream
 651      * \param buf     Buffer
 652      * \param usage   Whether the buffer is used for read and/or write.
 653      * \param domain  Bitmask of the RADEON_DOMAIN_* flags.
 654      * \param priority  A higher number means a greater chance of being
 655      *                  placed in the requested domain. 15 is the maximum.
 656      * \return Buffer index.
 657      */
 658     unsigned (*cs_add_buffer)(struct radeon_winsys_cs *cs,
 659                              struct pb_buffer *buf,
 660                              enum radeon_bo_usage usage,
 661                              enum radeon_bo_domain domain,
 662                              enum radeon_bo_priority priority);
 663
 664     /**
 665      * Return the index of an already-added buffer.
 666      *
 667      * \param cs        Command stream
 668      * \param buf       Buffer
 669      * \return          The buffer index, or -1 if the buffer has not been added.
 670      */
 671     int (*cs_lookup_buffer)(struct radeon_winsys_cs *cs,
 672                             struct pb_buffer *buf);
 673
 674     /**
 675      * Return TRUE if there is enough memory in VRAM and GTT for the buffers
 676      * added so far. If the validation fails, all buffers which have
 677      * been added since the last call of cs_validate will be removed and
 678      * the CS will be flushed (provided there are still any buffers).
 679      *
 680      * \param cs        A command stream to validate.
 681      */
 682     boolean (*cs_validate)(struct radeon_winsys_cs *cs);
 683
 684     /**
 685      * Check whether the given number of dwords is available in the IB.
 686      * Optionally chain a new chunk of the IB if necessary and supported.
 687      *
 688      * \param cs        A command stream.
 689      * \param dw        Number of CS dwords requested by the caller.
 690      */
 691     bool (*cs_check_space)(struct radeon_winsys_cs *cs, unsigned dw);
 692
 693     /**
 694      * Return TRUE if there is enough memory in VRAM and GTT for the buffers
 695      * added so far.
 696      *
 697      * \param cs        A command stream to validate.
 698      * \param vram      VRAM memory size pending to be use
 699      * \param gtt       GTT memory size pending to be use
 700      */
 701     boolean (*cs_memory_below_limit)(struct radeon_winsys_cs *cs, uint64_t vram, uint64_t gtt);
 702
 703     uint64_t (*cs_query_memory_usage)(struct radeon_winsys_cs *cs);
 704
 705     /**
 706      * Return the buffer list.
 707      *
 708      * \param cs    Command stream
 709      * \param list  Returned buffer list. Set to NULL to query the count only.
 710      * \return      The buffer count.
 711      */
 712     unsigned (*cs_get_buffer_list)(struct radeon_winsys_cs *cs,
 713                                    struct radeon_bo_list_item *list);
 714
 715     /**
 716      * Flush a command stream.
 717      *
 718      * \param cs          A command stream to flush.
 719      * \param flags,      RADEON_FLUSH_ASYNC or 0.
 720      * \param fence       Pointer to a fence. If non-NULL, a fence is inserted
 721      *                    after the CS and is returned through this parameter.
 722      */
 723     void (*cs_flush)(struct radeon_winsys_cs *cs,
 724                      unsigned flags,
 725                      struct pipe_fence_handle **fence);
 726
 727     /**
 728      * Return TRUE if a buffer is referenced by a command stream.
 729      *
 730      * \param cs        A command stream.
 731      * \param buf       A winsys buffer.
 732      */
 733     boolean (*cs_is_buffer_referenced)(struct radeon_winsys_cs *cs,
 734                                        struct pb_buffer *buf,
 735                                        enum radeon_bo_usage usage);
 736
 737     /**
 738      * Request access to a feature for a command stream.
 739      *
 740      * \param cs        A command stream.
 741      * \param fid       Feature ID, one of RADEON_FID_*
 742      * \param enable    Whether to enable or disable the feature.
 743      */
 744     boolean (*cs_request_feature)(struct radeon_winsys_cs *cs,
 745                                   enum radeon_feature_id fid,
 746                                   boolean enable);
 747      /**
 748       * Make sure all asynchronous flush of the cs have completed
 749       *
 750       * \param cs        A command stream.
 751       */
 752     void (*cs_sync_flush)(struct radeon_winsys_cs *cs);
 753
 754     /**
 755      * Wait for the fence and return true if the fence has been signalled.
 756      * The timeout of 0 will only return the status.
 757      * The timeout of PIPE_TIMEOUT_INFINITE will always wait until the fence
 758      * is signalled.
 759      */
 760     bool (*fence_wait)(struct radeon_winsys *ws,
 761                        struct pipe_fence_handle *fence,
 762                        uint64_t timeout);
 763
 764     /**
 765      * Reference counting for fences.
 766      */
 767     void (*fence_reference)(struct pipe_fence_handle **dst,
 768                             struct pipe_fence_handle *src);
 769
 770     /**
 771      * Initialize surface
 772      *
 773      * \param ws        The winsys this function is called from.
 774      * \param surf      Surface structure ptr
 775      */
 776     int (*surface_init)(struct radeon_winsys *ws,
 777                         struct radeon_surf *surf);
 778
 779     /**
 780      * Find best values for a surface
 781      *
 782      * \param ws        The winsys this function is called from.
 783      * \param surf      Surface structure ptr
 784      */
 785     int (*surface_best)(struct radeon_winsys *ws,
 786                         struct radeon_surf *surf);
 787
 788     uint64_t (*query_value)(struct radeon_winsys *ws,
 789                             enum radeon_value_id value);
 790
 791     bool (*read_registers)(struct radeon_winsys *ws, unsigned reg_offset,
 792                            unsigned num_registers, uint32_t *out);
 793 };
 794
 795 static inline bool radeon_emitted(struct radeon_winsys_cs *cs, unsigned num_dw)
 796 {
 797     return cs && (cs->prev_dw + cs->current.cdw > num_dw);
 798 }
 799
 800 static inline void radeon_emit(struct radeon_winsys_cs *cs, uint32_t value)
 801 {
 802     cs->current.buf[cs->current.cdw++] = value;
 803 }
 804
 805 static inline void radeon_emit_array(struct radeon_winsys_cs *cs,
 806                                      const uint32_t *values, unsigned count)
 807 {
 808     memcpy(cs->current.buf + cs->current.cdw, values, count * 4);
 809     cs->current.cdw += count;
 810 }
 811
 812 #endif