rs_hal.h revision 358747a3118301c5faeee73c98dd5f839bbfb54a 
1/*
2 * Copyright (C) 2011-2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef RS_HAL_H
18#define RS_HAL_H
19
20#include <rsDefines.h>
21
22struct ANativeWindow;
23
24namespace android {
25namespace renderscript {
26
27class Context;
28class ObjectBase;
29class Element;
30class Type;
31class Allocation;
32class Script;
33class ScriptKernelID;
34class ScriptFieldID;
35class ScriptMethodID;
36class ScriptC;
37class ScriptGroup;
38class Path;
39class Program;
40class ProgramStore;
41class ProgramRaster;
42class ProgramVertex;
43class ProgramFragment;
44class Mesh;
45class Sampler;
46class FBOCache;
47
48typedef void *(*RsHalSymbolLookupFunc)(void *usrptr, char const *symbolName);
49
50typedef struct {
51    const void *in;
52    void *out;
53    const void *usr;
54    size_t usrLen;
55    uint32_t x;
56    uint32_t y;
57    uint32_t z;
58    uint32_t lod;
59    RsAllocationCubemapFace face;
60    uint32_t ar[16];
61    uint32_t lid;
62
63    uint32_t dimX;
64    uint32_t dimY;
65    uint32_t dimZ;
66    uint32_t dimArray;
67
68    const uint8_t *ptrIn;
69    uint8_t *ptrOut;
70    uint32_t eStrideIn;
71    uint32_t eStrideOut;
72    uint32_t yStrideIn;
73    uint32_t yStrideOut;
74    uint32_t slot;
75} RsForEachStubParamStruct;
76
77/**
78 * Script management functions
79 */
80typedef struct {
81    bool (*initGraphics)(const Context *);
82    void (*shutdownGraphics)(const Context *);
83    bool (*setSurface)(const Context *, uint32_t w, uint32_t h, RsNativeWindow);
84    void (*swap)(const Context *);
85
86    void (*shutdownDriver)(Context *);
87    void (*getVersion)(unsigned int *major, unsigned int *minor);
88    void (*setPriority)(const Context *, int32_t priority);
89
90
91
92    struct {
93        bool (*init)(const Context *rsc, ScriptC *s,
94                     char const *resName,
95                     char const *cacheDir,
96                     uint8_t const *bitcode,
97                     size_t bitcodeSize,
98                     uint32_t flags);
99        bool (*initIntrinsic)(const Context *rsc, Script *s,
100                              RsScriptIntrinsicID iid,
101                              Element *e);
102
103        void (*invokeFunction)(const Context *rsc, Script *s,
104                               uint32_t slot,
105                               const void *params,
106                               size_t paramLength);
107        int (*invokeRoot)(const Context *rsc, Script *s);
108        void (*invokeForEach)(const Context *rsc,
109                              Script *s,
110                              uint32_t slot,
111                              const Allocation * ain,
112                              Allocation * aout,
113                              const void * usr,
114                              uint32_t usrLen,
115                              const RsScriptCall *sc);
116        void (*invokeInit)(const Context *rsc, Script *s);
117        void (*invokeFreeChildren)(const Context *rsc, Script *s);
118
119        void (*setGlobalVar)(const Context *rsc, const Script *s,
120                             uint32_t slot,
121                             void *data,
122                             size_t dataLength);
123        void (*setGlobalVarWithElemDims)(const Context *rsc, const Script *s,
124                                         uint32_t slot,
125                                         void *data,
126                                         size_t dataLength,
127                                         const Element *e,
128                                         const size_t *dims,
129                                         size_t dimLength);
130        void (*setGlobalBind)(const Context *rsc, const Script *s,
131                              uint32_t slot,
132                              Allocation *data);
133        void (*setGlobalObj)(const Context *rsc, const Script *s,
134                             uint32_t slot,
135                             ObjectBase *data);
136
137        void (*destroy)(const Context *rsc, Script *s);
138    } script;
139
140    struct {
141        bool (*init)(const Context *rsc, Allocation *alloc, bool forceZero);
142        void (*destroy)(const Context *rsc, Allocation *alloc);
143
144        void (*resize)(const Context *rsc, const Allocation *alloc, const Type *newType,
145                       bool zeroNew);
146        void (*syncAll)(const Context *rsc, const Allocation *alloc, RsAllocationUsageType src);
147        void (*markDirty)(const Context *rsc, const Allocation *alloc);
148
149        int32_t (*initSurfaceTexture)(const Context *rsc, const Allocation *alloc);
150        void (*setSurfaceTexture)(const Context *rsc, Allocation *alloc, ANativeWindow *sur);
151        void (*ioSend)(const Context *rsc, Allocation *alloc);
152        void (*ioReceive)(const Context *rsc, Allocation *alloc);
153
154        void (*data1D)(const Context *rsc, const Allocation *alloc,
155                       uint32_t xoff, uint32_t lod, uint32_t count,
156                       const void *data, size_t sizeBytes);
157        void (*data2D)(const Context *rsc, const Allocation *alloc,
158                       uint32_t xoff, uint32_t yoff, uint32_t lod,
159                       RsAllocationCubemapFace face, uint32_t w, uint32_t h,
160                       const void *data, size_t sizeBytes, size_t stride);
161        void (*data3D)(const Context *rsc, const Allocation *alloc,
162                       uint32_t xoff, uint32_t yoff, uint32_t zoff,
163                       uint32_t lod, RsAllocationCubemapFace face,
164                       uint32_t w, uint32_t h, uint32_t d, const void *data, size_t sizeBytes);
165
166        void (*read1D)(const Context *rsc, const Allocation *alloc,
167                       uint32_t xoff, uint32_t lod, uint32_t count,
168                       void *data, size_t sizeBytes);
169        void (*read2D)(const Context *rsc, const Allocation *alloc,
170                       uint32_t xoff, uint32_t yoff, uint32_t lod,
171                       RsAllocationCubemapFace face, uint32_t w, uint32_t h,
172                       void *data, size_t sizeBytes, size_t stride);
173        void (*read3D)(const Context *rsc, const Allocation *alloc,
174                       uint32_t xoff, uint32_t yoff, uint32_t zoff,
175                       uint32_t lod, RsAllocationCubemapFace face,
176                       uint32_t w, uint32_t h, uint32_t d, void *data, size_t sizeBytes);
177
178        // Lock and unlock make a 1D region of memory available to the CPU
179        // for direct access by pointer.  Once unlock is called control is
180        // returned to the SOC driver.
181        void * (*lock1D)(const Context *rsc, const Allocation *alloc);
182        void (*unlock1D)(const Context *rsc, const Allocation *alloc);
183
184        // Allocation to allocation copies
185        void (*allocData1D)(const Context *rsc,
186                            const Allocation *dstAlloc,
187                            uint32_t dstXoff, uint32_t dstLod, uint32_t count,
188                            const Allocation *srcAlloc, uint32_t srcXoff, uint32_t srcLod);
189        void (*allocData2D)(const Context *rsc,
190                            const Allocation *dstAlloc,
191                            uint32_t dstXoff, uint32_t dstYoff, uint32_t dstLod,
192                            RsAllocationCubemapFace dstFace, uint32_t w, uint32_t h,
193                            const Allocation *srcAlloc,
194                            uint32_t srcXoff, uint32_t srcYoff, uint32_t srcLod,
195                            RsAllocationCubemapFace srcFace);
196        void (*allocData3D)(const Context *rsc,
197                            const Allocation *dstAlloc,
198                            uint32_t dstXoff, uint32_t dstYoff, uint32_t dstZoff,
199                            uint32_t dstLod, RsAllocationCubemapFace dstFace,
200                            uint32_t w, uint32_t h, uint32_t d,
201                            const Allocation *srcAlloc,
202                            uint32_t srcXoff, uint32_t srcYoff, uint32_t srcZoff,
203                            uint32_t srcLod, RsAllocationCubemapFace srcFace);
204
205        void (*elementData1D)(const Context *rsc, const Allocation *alloc, uint32_t x,
206                              const void *data, uint32_t elementOff, size_t sizeBytes);
207        void (*elementData2D)(const Context *rsc, const Allocation *alloc, uint32_t x, uint32_t y,
208                              const void *data, uint32_t elementOff, size_t sizeBytes);
209
210        void (*generateMipmaps)(const Context *rsc, const Allocation *alloc);
211    } allocation;
212
213    struct {
214        bool (*init)(const Context *rsc, const ProgramStore *ps);
215        void (*setActive)(const Context *rsc, const ProgramStore *ps);
216        void (*destroy)(const Context *rsc, const ProgramStore *ps);
217    } store;
218
219    struct {
220        bool (*init)(const Context *rsc, const ProgramRaster *ps);
221        void (*setActive)(const Context *rsc, const ProgramRaster *ps);
222        void (*destroy)(const Context *rsc, const ProgramRaster *ps);
223    } raster;
224
225    struct {
226        bool (*init)(const Context *rsc, const ProgramVertex *pv,
227                     const char* shader, size_t shaderLen,
228                     const char** textureNames, size_t textureNamesCount,
229                     const size_t *textureNamesLength);
230        void (*setActive)(const Context *rsc, const ProgramVertex *pv);
231        void (*destroy)(const Context *rsc, const ProgramVertex *pv);
232    } vertex;
233
234    struct {
235        bool (*init)(const Context *rsc, const ProgramFragment *pf,
236                     const char* shader, size_t shaderLen,
237                     const char** textureNames, size_t textureNamesCount,
238                     const size_t *textureNamesLength);
239        void (*setActive)(const Context *rsc, const ProgramFragment *pf);
240        void (*destroy)(const Context *rsc, const ProgramFragment *pf);
241    } fragment;
242
243    struct {
244        bool (*init)(const Context *rsc, const Mesh *m);
245        void (*draw)(const Context *rsc, const Mesh *m, uint32_t primIndex, uint32_t start, uint32_t len);
246        void (*destroy)(const Context *rsc, const Mesh *m);
247    } mesh;
248
249    struct {
250        bool (*initStatic)(const Context *rsc, const Path *m, const Allocation *vtx, const Allocation *loops);
251        bool (*initDynamic)(const Context *rsc, const Path *m);
252        void (*draw)(const Context *rsc, const Path *m);
253        void (*destroy)(const Context *rsc, const Path *m);
254    } path;
255
256    struct {
257        bool (*init)(const Context *rsc, const Sampler *m);
258        void (*destroy)(const Context *rsc, const Sampler *m);
259    } sampler;
260
261    struct {
262        bool (*init)(const Context *rsc, const FBOCache *fb);
263        void (*setActive)(const Context *rsc, const FBOCache *fb);
264        void (*destroy)(const Context *rsc, const FBOCache *fb);
265    } framebuffer;
266
267    struct {
268        bool (*init)(const Context *rsc, ScriptGroup *sg);
269        void (*setInput)(const Context *rsc, const ScriptGroup *sg,
270                         const ScriptKernelID *kid, Allocation *);
271        void (*setOutput)(const Context *rsc, const ScriptGroup *sg,
272                          const ScriptKernelID *kid, Allocation *);
273        void (*execute)(const Context *rsc, const ScriptGroup *sg);
274        void (*destroy)(const Context *rsc, const ScriptGroup *sg);
275    } scriptgroup;
276
277} RsdHalFunctions;
278
279
280}
281}
282
283#ifdef __cplusplus
284extern "C" {
285#endif
286
287bool rsdHalInit(RsContext, uint32_t version_major, uint32_t version_minor);
288
289#ifdef __cplusplus
290}
291#endif
292
293#endif
294
295