1/*
2 * Copyright (c) 2012-2015 Etnaviv Project
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sub license,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the
12 * next paragraph) shall be included in all copies or substantial portions
13 * of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 *    Wladimir J. van der Laan <laanwj@gmail.com>
25 */
26
27#ifndef H_ETNAVIV_RESOURCE
28#define H_ETNAVIV_RESOURCE
29
30#include "etnaviv_internal.h"
31#include "etnaviv_tiling.h"
32#include "pipe/p_state.h"
33#include "util/list.h"
34#include "util/set.h"
35#include "util/u_helpers.h"
36
37struct etna_context;
38struct pipe_screen;
39struct util_dynarray;
40
41struct etna_resource_level {
42   unsigned width, padded_width; /* in pixels */
43   unsigned height, padded_height; /* in samples */
44   unsigned offset; /* offset into memory area */
45   uint32_t stride; /* row stride */
46   uint32_t layer_stride; /* layer stride */
47   unsigned size; /* total size of memory area */
48
49   uint32_t ts_offset;
50   uint32_t ts_layer_stride;
51   uint32_t ts_size;
52   uint32_t clear_value; /* clear value of resource level (mainly for TS) */
53   bool ts_valid;
54
55   /* keep track if we have done some per block patching */
56   bool patched;
57   struct util_dynarray *patch_offsets;
58};
59
60enum etna_resource_addressing_mode {
61   ETNA_ADDRESSING_MODE_TILED = 0,
62   ETNA_ADDRESSING_MODE_LINEAR,
63};
64
65/* status of queued up but not flushed reads and write operations.
66 * In _transfer_map() we need to know if queued up rendering needs
67 * to be flushed to preserve the order of cpu and gpu access. */
68enum etna_resource_status {
69   ETNA_PENDING_WRITE = 0x01,
70   ETNA_PENDING_READ = 0x02,
71};
72
73struct etna_resource {
74   struct pipe_resource base;
75   struct renderonly_scanout *scanout;
76   uint32_t seqno;
77   uint32_t flush_seqno;
78
79   /* only lod 0 used for non-texture buffers */
80   /* Layout for surface (tiled, multitiled, split tiled, ...) */
81   enum etna_surface_layout layout;
82   enum etna_resource_addressing_mode addressing_mode;
83   /* Horizontal alignment for texture unit (TEXTURE_HALIGN_*) */
84   unsigned halign;
85   struct etna_bo *bo; /* Surface video memory */
86   struct etna_bo *ts_bo; /* Tile status video memory */
87
88   struct etna_resource_level levels[ETNA_NUM_LOD];
89
90   /* When we are rendering to a texture, we need a differently tiled resource */
91   struct pipe_resource *texture;
92   /*
93    * If imported resources have an render/sampler incompatible tiling, we keep
94    * them as an external resource, which is blitted as needed.
95    */
96   struct pipe_resource *external;
97
98   enum etna_resource_status status;
99
100   struct set *pending_ctx;
101};
102
103/* returns TRUE if a is newer than b */
104static inline bool
105etna_resource_newer(struct etna_resource *a, struct etna_resource *b)
106{
107   return (int)(a->seqno - b->seqno) > 0;
108}
109
110/* returns TRUE if a is older than b */
111static inline bool
112etna_resource_older(struct etna_resource *a, struct etna_resource *b)
113{
114   return (int)(a->seqno - b->seqno) < 0;
115}
116
117/* returns TRUE if a resource has a TS, and it is valid for at least one level */
118bool
119etna_resource_has_valid_ts(struct etna_resource *res);
120
121/* returns TRUE if the resource needs a resolve to itself */
122static inline bool
123etna_resource_needs_flush(struct etna_resource *res)
124{
125   return etna_resource_has_valid_ts(res) && ((int)(res->seqno - res->flush_seqno) > 0);
126}
127
128/* is the resource only used on the sampler? */
129static inline bool
130etna_resource_sampler_only(const struct pipe_resource *pres)
131{
132   return (pres->bind & (PIPE_BIND_SAMPLER_VIEW | PIPE_BIND_RENDER_TARGET |
133                         PIPE_BIND_DEPTH_STENCIL | PIPE_BIND_BLENDABLE)) ==
134          PIPE_BIND_SAMPLER_VIEW;
135}
136
137static inline struct etna_resource *
138etna_resource(struct pipe_resource *p)
139{
140   return (struct etna_resource *)p;
141}
142
143void
144etna_resource_used(struct etna_context *ctx, struct pipe_resource *prsc,
145                   enum etna_resource_status status);
146
147static inline void
148resource_read(struct etna_context *ctx, struct pipe_resource *prsc)
149{
150   etna_resource_used(ctx, prsc, ETNA_PENDING_READ);
151}
152
153static inline void
154resource_written(struct etna_context *ctx, struct pipe_resource *prsc)
155{
156   etna_resource_used(ctx, prsc, ETNA_PENDING_WRITE);
157}
158
159/* Allocate Tile Status for an etna resource.
160 * Tile status is a cache of the clear status per tile. This means a smaller
161 * surface has to be cleared which is faster.
162 * This is also called "fast clear". */
163bool
164etna_screen_resource_alloc_ts(struct pipe_screen *pscreen,
165                              struct etna_resource *prsc);
166
167struct pipe_resource *
168etna_resource_alloc(struct pipe_screen *pscreen, unsigned layout,
169                    enum etna_resource_addressing_mode mode, uint64_t modifier,
170                    const struct pipe_resource *templat);
171
172void
173etna_resource_screen_init(struct pipe_screen *pscreen);
174
175#endif
176