summaryrefslogtreecommitdiff
path: root/exa/exa.h
blob: 43573aece61155bc0e7c74748a8e063f99ff9a96 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
/*
 *
 * Copyright (C) 2000 Keith Packard
 *               2004 Eric Anholt
 *               2005 Zack Rusin
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of copyright holders not be used in
 * advertising or publicity pertaining to distribution of the software without
 * specific, written prior permission. Copyright holders make no
 * representations about the suitability of this software for any purpose.  It
 * is provided "as is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
 * SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
 * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
 * OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
 * SOFTWARE.
 */
#ifndef EXA_H
#define EXA_H

#include "scrnintstr.h"
#include "pixmapstr.h"
#include "windowstr.h"
#include "gcstruct.h"
#include "picturestr.h"

#define EXA_VERSION_MAJOR   0
#define EXA_VERSION_MINOR   2
#define EXA_VERSION_RELEASE 0

typedef struct _ExaOffscreenArea ExaOffscreenArea;

typedef void (*ExaOffscreenSaveProc) (ScreenPtr pScreen, ExaOffscreenArea *area);

typedef enum _ExaOffscreenState {
    ExaOffscreenAvail,
    ExaOffscreenRemovable,
    ExaOffscreenLocked
} ExaOffscreenState;

struct _ExaOffscreenArea {
    int                 base_offset;	/* allocation base */
    int                 offset;         /* aligned offset */
    int                 size;           /* total allocation size */
    int                 score;
    pointer             privData;

    ExaOffscreenSaveProc save;

    ExaOffscreenState   state;

    ExaOffscreenArea    *next;
};

typedef struct _ExaCardInfo {
    /* These are here because I don't want to be adding more to
     * ScrnInfoRec */
    CARD8         *memoryBase;
    unsigned long  offScreenBase;

    /* It's fix.smem_len.
       This one could be potentially substituted by ScrnInfoRec
       videoRam member, but I do not want to be doing the silly
       << 10, >>10 all over the place */
    unsigned long memorySize;

    int pixmapOffsetAlign;
    int pixmapPitchAlign;
    int flags;

    /* The coordinate limitations for rendering for this hardware.
     * Exa breaks larger pixmaps into smaller pieces and calls Prepare multiple times
     * to handle larger pixmaps
     */
    int maxX;
    int maxY;

    /* private */
    ExaOffscreenArea *offScreenAreas;
    Bool              needsSync;
    int               lastMarker;
} ExaCardInfoRec, *ExaCardInfoPtr;

typedef struct _ExaAccelInfo {
    /* PrepareSolid may fail if the pixmaps can't be accelerated to/from.
     * This is an important feature for handling strange corner cases
     * in hardware that are poorly expressed through flags.
     */
    Bool        (*PrepareSolid) (PixmapPtr      pPixmap,
                                 int            alu,
                                 Pixel          planemask,
                                 Pixel          fg);
    void        (*Solid) (PixmapPtr      pPixmap, int x1, int y1, int x2, int y2);
    void        (*DoneSolid) (PixmapPtr      pPixmap);

    /* PrepareSolid may fail if the pixmaps can't be accelerated to/from.
     * This is an important feature for handling strange corner cases
     * in hardware that are poorly expressed through flags.
     */
    Bool        (*PrepareCopy) (PixmapPtr       pSrcPixmap,
                                PixmapPtr       pDstPixmap,
                                int             dx,
                                int             dy,
                                int             alu,
                                Pixel           planemask);
    void        (*Copy) (PixmapPtr       pDstPixmap,
                         int    srcX,
                         int    srcY,
                         int    dstX,
                         int    dstY,
                         int    width,
                         int    height);
    void        (*DoneCopy) (PixmapPtr       pDstPixmap);

    /* The Composite hooks are a wrapper around the Composite operation.
     * The CheckComposite occurs before pixmap migration occurs,
     * and may fail for many hardware-dependent reasons.
     * PrepareComposite should not fail, and the Bool return may
     * not be necessary if we can
     * adequately represent pixmap location/pitch limitations..
     */
    Bool        (*CheckComposite) (int          op,
                                   PicturePtr   pSrcPicture,
                                   PicturePtr   pMaskPicture,
                                   PicturePtr   pDstPicture);
    Bool        (*PrepareComposite) (int                op,
                                     PicturePtr         pSrcPicture,
                                     PicturePtr         pMaskPicture,
                                     PicturePtr         pDstPicture,
                                     PixmapPtr          pSrc,
                                     PixmapPtr          pMask,
                                     PixmapPtr          pDst);
    void        (*Composite) (PixmapPtr         pDst,
                              int       srcX,
                              int        srcY,
                              int        maskX,
                              int        maskY,
                              int        dstX,
                              int        dstY,
                              int        width,
                              int        height);
    void        (*DoneComposite) (PixmapPtr         pDst);

    /* Attempt to upload the data from src into the rectangle of the
     * in-framebuffer pDst beginning at x,y and of width w,h.  May fail.
     */
    Bool        (*UploadToScreen) (PixmapPtr            pDst,
				   int                  x,
				   int                  y,
				   int                  w,
				   int                  h,
                                   char                 *src,
                                   int                  src_pitch);
    Bool        (*UploadToScratch) (PixmapPtr           pSrc,
                                    PixmapPtr           pDst);

    /* Attempt to download the rectangle from the in-framebuffer pSrc into
     * dst, given the pitch.  May fail.  Since it is likely
     * accelerated, a markSync will follow it as with other acceleration
     * hooks.
     */
    Bool (*DownloadFromScreen)(PixmapPtr pSrc,
                               int x,  int y,
                               int w,  int h,
                               char *dst,  int dst_pitch);

    /* Should return a hrdware-dependent marker number which can
     * be waited for with WaitMarker. It can be not implemented in which
     * case WaitMarker must wait for idle on any given marker
     * number.
     */
    int		(*MarkSync)   (ScreenPtr pScreen);
    void	(*WaitMarker) (ScreenPtr pScreen, int marker);

    /* These are wrapping all fb or composite operations that will cause
     * a direct access to the framebuffer. You can use them to update
     * endian swappers, force migration to RAM, or whatever else you find
     * useful at this point. EXA can stack up to 3 calls to Prepare/Finish
     * access, though they will have a different index. If your hardware
     * doesn't have enough separate configurable swapper, you can return
     * FALSE from PrepareAccess() to force EXA to migrate the pixmap to RAM.
     * Note that DownloadFromScreen and UploadToScreen can both be called
     * between PrepareAccess() and FinishAccess(). If they need to use a
     * swapper, they should save & restore its setting.
     */
    Bool	(*PrepareAccess)(PixmapPtr pPix, int index);
    void	(*FinishAccess)(PixmapPtr pPix, int index);
	#define EXA_PREPARE_DEST	0
	#define EXA_PREPARE_SRC		1
	#define EXA_PREPARE_MASK	2

} ExaAccelInfoRec, *ExaAccelInfoPtr;

typedef struct _ExaDriver {
    ExaCardInfoRec  card;
    ExaAccelInfoRec accel;
} ExaDriverRec, *ExaDriverPtr;

#define EXA_OFFSCREEN_PIXMAPS           (1 << 0)
#define EXA_OFFSCREEN_ALIGN_POT         (1 << 1)


#define EXA_MAKE_VERSION(a, b, c) (((a) << 16) | ((b) << 8) | (c))
#define EXA_VERSION \
    EXA_MAKE_VERSION(EXA_VERSION_MAJOR, EXA_VERSION_MINOR, EXA_VERSION_RELEASE)
#define EXA_IS_VERSION(a,b,c) (EXA_VERSION >= EXA_MAKE_VERSION(a,b,c))

unsigned int
exaGetVersion(void);

Bool
exaDriverInit(ScreenPtr                pScreen,
              ExaDriverPtr   pScreenInfo);

void
exaDriverFini(ScreenPtr                pScreen);

void
exaMarkSync(ScreenPtr pScreen);
void
exaWaitSync(ScreenPtr pScreen);

Bool
exaOffscreenInit(ScreenPtr pScreen);

ExaOffscreenArea *
exaOffscreenAlloc(ScreenPtr pScreen, int size, int align,
                  Bool locked,
                  ExaOffscreenSaveProc save,
                  pointer privData);

ExaOffscreenArea *
exaOffscreenFree(ScreenPtr pScreen, ExaOffscreenArea *area);

unsigned long
exaGetPixmapOffset(PixmapPtr pPix);

unsigned long
exaGetPixmapPitch(PixmapPtr pPix);

unsigned long
exaGetPixmapSize(PixmapPtr pPix);

#define exaInitCard(exa, sync, memory_base, off_screen_base, memory_size, \
                    offscreen_byte_align, offscreen_pitch, flags, \
                    max_x, max_y) \
    (exa)->card.Sync               = sync; \
    (exa)->card.memoryBase         = memory_base; \
    (exa)->card.offScreenBase      = off_screen_base; \
    (exa)->card.memorySize         = memory_size; \
    (exa)->card.offscreenByteAlign = offscreen_byte_align; \
    (exa)->card.offscreenPitch     = offscreen_pitch; \
    (exa)->card.flags              = flags; \
    (exa)->card.maxX               = max_x; \
    (exa)->card.maxY               = max_y

#endif /* EXA_H */