src/panfrost/encoder/pan_bo.h

   1 /*
   2  * © Copyright 2019 Alyssa Rosenzweig
   3  * © Copyright 2019 Collabora, Ltd.
   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  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * 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 NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  22  * SOFTWARE.
  23  *
  24  */
  25
  26 #ifndef __PAN_BO_H__
  27 #define __PAN_BO_H__
  28
  29 #include <panfrost-misc.h>
  30 #include "util/list.h"
  31 #include "pan_device.h"
  32 #include <time.h>
  33
  34 /* Flags for allocated memory */
  35
  36 /* This memory region is executable */
  37 #define PAN_BO_EXECUTE            (1 << 0)
  38
  39 /* This memory region should be lazily allocated and grow-on-page-fault. Must
  40  * be used in conjunction with INVISIBLE */
  41 #define PAN_BO_GROWABLE           (1 << 1)
  42
  43 /* This memory region should not be mapped to the CPU */
  44 #define PAN_BO_INVISIBLE          (1 << 2)
  45
  46 /* This memory region will be used for varyings and needs to have the cache
  47  * bits twiddled accordingly */
  48 #define PAN_BO_COHERENT_LOCAL     (1 << 3)
  49
  50 /* This region may not be used immediately and will not mmap on allocate
  51  * (semantically distinct from INVISIBLE, which cannot never be mmaped) */
  52 #define PAN_BO_DELAY_MMAP         (1 << 4)
  53
  54 /* Some BOs shouldn't be returned back to the reuse BO cache, use this flag to
  55  * let the BO logic know about this contraint. */
  56 #define PAN_BO_DONT_REUSE         (1 << 5)
  57
  58 /* BO has been imported */
  59 #define PAN_BO_IMPORTED           (1 << 6)
  60
  61 /* BO has been exported */
  62 #define PAN_BO_EXPORTED           (1 << 7)
  63
  64 /* GPU access flags */
  65
  66 /* BO is either shared (can be accessed by more than one GPU batch) or private
  67  * (reserved by a specific GPU job). */
  68 #define PAN_BO_ACCESS_PRIVATE         (0 << 0)
  69 #define PAN_BO_ACCESS_SHARED          (1 << 0)
  70
  71 /* BO is being read/written by the GPU */
  72 #define PAN_BO_ACCESS_READ            (1 << 1)
  73 #define PAN_BO_ACCESS_WRITE           (1 << 2)
  74 #define PAN_BO_ACCESS_RW              (PAN_BO_ACCESS_READ | PAN_BO_ACCESS_WRITE)
  75
  76 /* BO is accessed by the vertex/tiler job. */
  77 #define PAN_BO_ACCESS_VERTEX_TILER    (1 << 3)
  78
  79 /* BO is accessed by the fragment job. */
  80 #define PAN_BO_ACCESS_FRAGMENT        (1 << 4)
  81
  82 struct panfrost_bo {
  83         /* Must be first for casting */
  84         struct list_head bucket_link;
  85
  86         /* Used to link the BO to the BO cache LRU list. */
  87         struct list_head lru_link;
  88
  89         /* Store the time this BO was use last, so the BO cache logic can evict
  90          * stale BOs.
  91          */
  92         time_t last_used;
  93
  94         /* Atomic reference count */
  95         int32_t refcnt;
  96
  97         struct panfrost_device *dev;
  98
  99         /* Mapping for the entire object (all levels) */
 100         uint8_t *cpu;
 101
 102         /* GPU address for the object */
 103         mali_ptr gpu;
 104
 105         /* Size of all entire trees */
 106         size_t size;
 107
 108         int gem_handle;
 109
 110         uint32_t flags;
 111
 112         /* Combination of PAN_BO_ACCESS_{READ,WRITE} flags encoding pending
 113          * GPU accesses to this BO. Useful to avoid calling the WAIT_BO ioctl
 114          * when the BO is idle.
 115          */
 116         uint32_t gpu_access;
 117 };
 118
 119 bool
 120 panfrost_bo_wait(struct panfrost_bo *bo, int64_t timeout_ns,
 121                  uint32_t access_type);
 122 void
 123 panfrost_bo_reference(struct panfrost_bo *bo);
 124 void
 125 panfrost_bo_unreference(struct panfrost_bo *bo);
 126 struct panfrost_bo *
 127 panfrost_bo_create(struct panfrost_device *dev, size_t size,
 128                    uint32_t flags);
 129 void
 130 panfrost_bo_mmap(struct panfrost_bo *bo);
 131 struct panfrost_bo *
 132 panfrost_bo_import(struct panfrost_device *dev, int fd);
 133 int
 134 panfrost_bo_export(struct panfrost_bo *bo);
 135 void
 136 panfrost_bo_cache_evict_all(struct panfrost_device *dev);
 137
 138 #endif /* __PAN_BO_H__ */