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