freedreno/freedreno_ringbuffer.h

   1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
   2
   3 /*
   4  * Copyright (C) 2012 Rob Clark <robclark@freedesktop.org>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice (including the next
  14  * paragraph) shall be included in all copies or substantial portions of the
  15  * Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  *
  25  * Authors:
  26  *    Rob Clark <robclark@freedesktop.org>
  27  */
  28
  29 #ifndef FREEDRENO_RINGBUFFER_H_
  30 #define FREEDRENO_RINGBUFFER_H_
  31
  32 #include <freedreno_drmif.h>
  33
  34 /* the ringbuffer object is not opaque so that OUT_RING() type stuff
  35  * can be inlined.  Note that users should not make assumptions about
  36  * the size of this struct.
  37  */
  38
  39 struct fd_ringbuffer_funcs;
  40 struct fd_ringmarker;
  41
  42 struct fd_ringbuffer {
  43         int size;
  44         uint32_t *cur, *end, *start, *last_start;
  45         struct fd_pipe *pipe;
  46         const struct fd_ringbuffer_funcs *funcs;
  47         uint32_t last_timestamp;
  48         struct fd_ringbuffer *parent;
  49
  50         /* for users of fd_ringbuffer to store their own private per-
  51          * ringbuffer data
  52          */
  53         void *user;
  54
  55         uint32_t flags;
  56
  57         /* This is a bit gross, but we can't use atomic_t in exported
  58          * headers.  OTOH, we don't need the refcnt to be publicly
  59          * visible.  The only reason that this struct is exported is
  60          * because fd_ringbuffer_emit needs to be something that can
  61          * be inlined for performance reasons.
  62          */
  63         union {
  64 #ifdef HAS_ATOMIC_OPS
  65                 atomic_t refcnt;
  66 #endif
  67                 uint64_t __pad;
  68         };
  69 };
  70
  71 struct fd_ringbuffer * fd_ringbuffer_new(struct fd_pipe *pipe,
  72                 uint32_t size);
  73 struct fd_ringbuffer * fd_ringbuffer_new_object(struct fd_pipe *pipe,
  74                 uint32_t size);
  75
  76 struct fd_ringbuffer *fd_ringbuffer_ref(struct fd_ringbuffer *ring);
  77 void fd_ringbuffer_del(struct fd_ringbuffer *ring);
  78 void fd_ringbuffer_set_parent(struct fd_ringbuffer *ring,
  79                 struct fd_ringbuffer *parent);
  80 void fd_ringbuffer_reset(struct fd_ringbuffer *ring);
  81 int fd_ringbuffer_flush(struct fd_ringbuffer *ring);
  82 /* in_fence_fd: -1 for no in-fence, else fence fd
  83  * out_fence_fd: NULL for no output-fence requested, else ptr to return out-fence
  84  */
  85 int fd_ringbuffer_flush2(struct fd_ringbuffer *ring, int in_fence_fd,
  86                 int *out_fence_fd);
  87 void fd_ringbuffer_grow(struct fd_ringbuffer *ring, uint32_t ndwords);
  88 uint32_t fd_ringbuffer_timestamp(struct fd_ringbuffer *ring);
  89
  90 static inline void fd_ringbuffer_emit(struct fd_ringbuffer *ring,
  91                 uint32_t data)
  92 {
  93         (*ring->cur++) = data;
  94 }
  95
  96 struct fd_reloc {
  97         struct fd_bo *bo;
  98 #define FD_RELOC_READ             0x0001
  99 #define FD_RELOC_WRITE            0x0002
 100         uint32_t flags;
 101         uint32_t offset;
 102         uint32_t or;
 103         int32_t  shift;
 104         uint32_t orhi;      /* used for a5xx+ */
 105 };
 106
 107 /* NOTE: relocs are 2 dwords on a5xx+ */
 108
 109 void fd_ringbuffer_reloc2(struct fd_ringbuffer *ring, const struct fd_reloc *reloc);
 110 will_be_deprecated void fd_ringbuffer_reloc(struct fd_ringbuffer *ring, const struct fd_reloc *reloc);
 111 will_be_deprecated void fd_ringbuffer_emit_reloc_ring(struct fd_ringbuffer *ring,
 112                 struct fd_ringmarker *target, struct fd_ringmarker *end);
 113 uint32_t fd_ringbuffer_cmd_count(struct fd_ringbuffer *ring);
 114 uint32_t fd_ringbuffer_emit_reloc_ring_full(struct fd_ringbuffer *ring,
 115                 struct fd_ringbuffer *target, uint32_t cmd_idx);
 116 uint32_t fd_ringbuffer_size(struct fd_ringbuffer *ring);
 117
 118 will_be_deprecated struct fd_ringmarker * fd_ringmarker_new(struct fd_ringbuffer *ring);
 119 will_be_deprecated void fd_ringmarker_del(struct fd_ringmarker *marker);
 120 will_be_deprecated void fd_ringmarker_mark(struct fd_ringmarker *marker);
 121 will_be_deprecated uint32_t fd_ringmarker_dwords(struct fd_ringmarker *start,
 122                 struct fd_ringmarker *end);
 123 will_be_deprecated int fd_ringmarker_flush(struct fd_ringmarker *marker);
 124
 125 #endif /* FREEDRENO_RINGBUFFER_H_ */