omap: port to compat server API.
[gstreamer-omap:xf86-video-omap.git] / src / omap_exa.h
1 /* -*- mode: C; c-file-style: "k&r"; tab-width 4; indent-tabs-mode: t; -*- */
2
3 /*
4  * Copyright © 2011 Texas Instruments, Inc
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 <rob@ti.com>
27  */
28
29 #ifndef OMAP_EXA_COMMON_H_
30 #define OMAP_EXA_COMMON_H_
31
32 /* note: don't include "omap_driver.h" here.. we want to keep some
33  * isolation between structs shared with submodules and stuff internal
34  * to core driver..
35  */
36 #include <omap_drmif.h>
37 #include "omap_util.h"
38 #include "exa.h"
39
40 #include "compat-api.h"
41
42 /**
43  * A per-Screen structure used to communicate and coordinate between the OMAP X
44  * driver and an external EXA sub-module (if loaded).
45  */
46 typedef struct _OMAPEXARec
47 {
48         union { struct {
49
50         /**
51          * Called by X driver's CloseScreen() function at the end of each server
52          * generation to free per-Screen data structures (except those held by
53          * pScrn).
54          */
55         Bool (*CloseScreen)(CLOSE_SCREEN_ARGS_DECL);
56
57         /**
58          * Called by X driver's FreeScreen() function at the end of each server
59          * lifetime to free per-ScrnInfoRec data structures, to close any external
60          * connections (e.g. with PVR2D, DRM), etc.
61          */
62         void (*FreeScreen)(FREE_SCREEN_ARGS_DECL);
63
64         /** get formats supported by PutTextureImage() (for dri2 video..) */
65 #define MAX_FORMATS 16
66         unsigned int (*GetFormats)(unsigned int *formats);
67
68         Bool (*PutTextureImage)(PixmapPtr pSrcPix, BoxPtr pSrcBox,
69                         PixmapPtr pOsdPix, BoxPtr pOsdBox,
70                         PixmapPtr pDstPix, BoxPtr pDstBox,
71                         unsigned int extraCount, PixmapPtr *extraPix,
72                         unsigned int format);
73
74         /* add new fields here at end, to preserve ABI */
75
76
77         /* padding to keep ABI stable, so an existing EXA submodule
78          * doesn't need to be recompiled when new fields are added
79          */
80         }; void *pad[64]; };
81
82 } OMAPEXARec, *OMAPEXAPtr;
83
84
85 /**
86  * Canonical name of an external sub-module providing support for EXA
87  * acceleration, that utiltizes the OMAP's PowerVR accelerator and uses closed
88  * source from Imaginations Technology Limited.
89  */
90 #define SUB_MODULE_PVR  "omap_pvr"
91 OMAPEXAPtr InitPowerVREXA(ScreenPtr pScreen, ScrnInfoPtr pScrn, int fd);
92
93 /**
94  * Fallback EXA implementation
95  */
96 OMAPEXAPtr InitNullEXA(ScreenPtr pScreen, ScrnInfoPtr pScrn, int fd);
97
98
99 OMAPEXAPtr OMAPEXAPTR(ScrnInfoPtr pScrn);
100
101 static inline ScrnInfoPtr
102 pix2scrn(PixmapPtr pPixmap)
103 {
104         return xf86Screens[(pPixmap)->drawable.pScreen->myNum];
105 }
106
107 static inline PixmapPtr
108 draw2pix(DrawablePtr pDraw)
109 {
110         if (!pDraw) {
111                 return NULL;
112         } else if (pDraw->type == DRAWABLE_WINDOW) {
113                 return pDraw->pScreen->GetWindowPixmap((WindowPtr)pDraw);
114         } else {
115                 return (PixmapPtr)pDraw;
116         }
117 }
118
119 /* Common OMAP EXA functions, mostly related to pixmap/buffer allocation.
120  * Individual driver submodules can use these directly, or wrap them with
121  * there own functions if anything additional is required.  Submodules
122  * can use OMAPPrixmapPrivPtr#priv for their own private data.
123  */
124
125 typedef struct {
126         void *priv;                     /* EXA submodule private data */
127         struct omap_bo *bo;
128 } OMAPPixmapPrivRec, *OMAPPixmapPrivPtr;
129
130 #define OMAP_CREATE_PIXMAP_SCANOUT 0x80000000
131 #define OMAP_CREATE_PIXMAP_TILED   0x40000000
132
133
134 void * OMAPCreatePixmap (ScreenPtr pScreen, int width, int height,
135                 int depth, int usage_hint, int bitsPerPixel,
136                 int *new_fb_pitch);
137 void OMAPDestroyPixmap(ScreenPtr pScreen, void *driverPriv);
138 Bool OMAPModifyPixmapHeader(PixmapPtr pPixmap, int width, int height,
139                 int depth, int bitsPerPixel, int devKind,
140                 pointer pPixData);
141 void OMAPWaitMarker(ScreenPtr pScreen, int marker);
142 Bool OMAPPrepareAccess(PixmapPtr pPixmap, int index);
143 void OMAPFinishAccess(PixmapPtr pPixmap, int index);
144 Bool OMAPPixmapIsOffscreen(PixmapPtr pPixmap);
145
146 static inline struct omap_bo *
147 OMAPPixmapBo(PixmapPtr pPixmap)
148 {
149         OMAPPixmapPrivPtr priv = exaGetPixmapDriverPrivate(pPixmap);
150         return priv->bo;
151 }
152
153 void OMAPPixmapExchange(PixmapPtr a, PixmapPtr b);
154
155 #endif /* OMAP_EXA_COMMON_H_ */