nouveau: prototype PFIFO/PGRAPH engtab API
[platform/upstream/libdrm.git] / shared-core / nouveau_drv.h
1 /*
2  * Copyright 2005 Stephane Marchesin.
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice (including the next
13  * paragraph) shall be included in all copies or substantial portions of the
14  * Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
19  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22  * OTHER DEALINGS IN THE SOFTWARE.
23  */
24
25 #ifndef __NOUVEAU_DRV_H__
26 #define __NOUVEAU_DRV_H__
27
28 #define DRIVER_AUTHOR           "Stephane Marchesin"
29 #define DRIVER_EMAIL            "dri-devel@lists.sourceforge.net"
30
31 #define DRIVER_NAME             "nouveau"
32 #define DRIVER_DESC             "nVidia Riva/TNT/GeForce"
33 #define DRIVER_DATE             "20060213"
34
35 #define DRIVER_MAJOR            0
36 #define DRIVER_MINOR            0
37 #define DRIVER_PATCHLEVEL       6
38
39 #define NOUVEAU_FAMILY   0x0000FFFF
40 #define NOUVEAU_FLAGS    0xFFFF0000
41
42 #include "nouveau_drm.h"
43 #include "nouveau_reg.h"
44
45 struct mem_block {
46         struct mem_block *next;
47         struct mem_block *prev;
48         uint64_t start;
49         uint64_t size;
50         DRMFILE filp;           /* 0: free, -1: heap, other: real files */
51         int flags;
52         drm_local_map_t *map;
53 };
54
55 enum nouveau_flags {
56         NV_NFORCE   =0x10000000,
57         NV_NFORCE2  =0x20000000
58 };
59
60 struct nouveau_object
61 {
62         struct nouveau_object *next;
63         struct nouveau_object *prev;
64         int channel;
65
66         struct mem_block *instance;
67         uint32_t          ht_loc;
68
69         uint32_t handle;
70         int      class;
71         int      engine;
72 };
73
74 struct nouveau_fifo
75 {
76         int used;
77         /* owner of this fifo */
78         DRMFILE filp;
79         /* mapping of the fifo itself */
80         drm_local_map_t *map;
81         /* mapping of the regs controling the fifo */
82         drm_local_map_t *regs;
83         /* dma object for the command buffer itself */
84         struct mem_block      *cmdbuf_mem;
85         struct nouveau_object *cmdbuf_obj;
86         /* PGRAPH context, for cards that keep it in RAMIN */
87         struct mem_block *ramin_grctx;
88         /* objects belonging to this fifo */
89         struct nouveau_object *objs;
90
91         /* XXX dynamic alloc ? */
92         uint32_t pgraph_ctx [340];
93 };
94
95 struct nouveau_config {
96         struct {
97                 int location;
98                 int size;
99         } cmdbuf;
100 };
101
102 struct nouveau_engine_func {
103         struct {
104                 int     (*init)(drm_device_t *dev);
105                 void    (*takedown)(drm_device_t *dev);
106         } mc;
107
108         struct {
109                 int     (*init)(drm_device_t *dev);
110                 void    (*takedown)(drm_device_t *dev);
111         } timer;
112
113         struct {
114                 int     (*init)(drm_device_t *dev);
115                 void    (*takedown)(drm_device_t *dev);
116         } fb;
117
118         struct {
119                 int     (*init)(drm_device_t *);
120                 void    (*takedown)(drm_device_t *);
121
122                 int     (*create_context)(drm_device_t *, int channel);
123                 void    (*destroy_context)(drm_device_t *, int channel);
124                 int     (*load_context)(drm_device_t *, int channel);
125                 int     (*save_context)(drm_device_t *, int channel);
126         } graph;
127
128         struct {
129                 int     (*init)(drm_device_t *);
130                 void    (*takedown)(drm_device_t *);
131
132                 int     (*create_context)(drm_device_t *, int channel);
133                 void    (*destroy_context)(drm_device_t *, int channel);
134                 int     (*load_context)(drm_device_t *, int channel);
135                 int     (*save_context)(drm_device_t *, int channel);
136         } fifo;
137 };
138
139 typedef struct drm_nouveau_private {
140         /* the card type, takes NV_* as values */
141         int card_type;
142         /* exact chipset, derived from NV_PMC_BOOT_0 */
143         int chipset;
144         int flags;
145
146         drm_local_map_t *mmio;
147         drm_local_map_t *fb;
148         drm_local_map_t *ramin; /* NV40 onwards */
149
150         int fifo_alloc_count;
151         struct nouveau_fifo fifos[NV_MAX_FIFO_NUMBER];
152
153         struct nouveau_engine_func Engine;
154
155         /* RAMIN configuration, RAMFC, RAMHT and RAMRO offsets */
156         uint32_t ramin_size;
157         uint32_t ramht_offset;
158         uint32_t ramht_size;
159         uint32_t ramht_bits;
160         uint32_t ramfc_offset;
161         uint32_t ramfc_size;
162         uint32_t ramro_offset;
163         uint32_t ramro_size;
164
165         /* base physical adresses */
166         uint64_t fb_phys;
167         uint64_t fb_available_size;
168         uint64_t agp_phys;
169         uint64_t agp_available_size;
170
171         /* the mtrr covering the FB */
172         int fb_mtrr;
173
174         struct mem_block *agp_heap;
175         struct mem_block *fb_heap;
176         struct mem_block *fb_nomap_heap;
177         struct mem_block *ramin_heap;
178
179         /* context table pointed to be NV_PGRAPH_CHANNEL_CTX_TABLE (0x400780) */
180         uint32_t ctx_table_size;
181         struct mem_block *ctx_table;
182
183         struct nouveau_config config;
184 }
185 drm_nouveau_private_t;
186
187 /* nouveau_state.c */
188 extern void nouveau_preclose(drm_device_t * dev, DRMFILE filp);
189 extern int nouveau_load(struct drm_device *dev, unsigned long flags);
190 extern int nouveau_firstopen(struct drm_device *dev);
191 extern void nouveau_lastclose(struct drm_device *dev);
192 extern int nouveau_unload(struct drm_device *dev);
193 extern int nouveau_ioctl_getparam(DRM_IOCTL_ARGS);
194 extern int nouveau_ioctl_setparam(DRM_IOCTL_ARGS);
195 extern void nouveau_wait_for_idle(struct drm_device *dev);
196 extern int nouveau_ioctl_card_init(DRM_IOCTL_ARGS);
197
198 /* nouveau_mem.c */
199 extern uint64_t          nouveau_mem_fb_amount(struct drm_device *dev);
200 extern void              nouveau_mem_release(DRMFILE filp, struct mem_block *heap);
201 extern int               nouveau_ioctl_mem_alloc(DRM_IOCTL_ARGS);
202 extern int               nouveau_ioctl_mem_free(DRM_IOCTL_ARGS);
203 extern struct mem_block* nouveau_mem_alloc(struct drm_device *dev, int alignment, uint64_t size, int flags, DRMFILE filp);
204 extern void              nouveau_mem_free(struct drm_device* dev, struct mem_block*);
205 extern int               nouveau_mem_init(struct drm_device *dev);
206 extern void              nouveau_mem_close(struct drm_device *dev);
207 extern int               nouveau_instmem_init(struct drm_device *dev);
208 extern struct mem_block* nouveau_instmem_alloc(struct drm_device *dev,
209                                                uint32_t size, uint32_t align);
210 extern void              nouveau_instmem_free(struct drm_device *dev,
211                                               struct mem_block *block);
212 extern uint32_t          nouveau_instmem_r32(drm_nouveau_private_t *dev_priv,
213                                              struct mem_block *mem, int index);
214 extern void              nouveau_instmem_w32(drm_nouveau_private_t *dev_priv,
215                                              struct mem_block *mem, int index,
216                                              uint32_t val);
217
218 /* nouveau_fifo.c */
219 extern int  nouveau_fifo_init(drm_device_t *dev);
220 extern int  nouveau_fifo_number(drm_device_t *dev);
221 extern int  nouveau_fifo_ctx_size(drm_device_t *dev);
222 extern void nouveau_fifo_cleanup(drm_device_t *dev, DRMFILE filp);
223 extern int  nouveau_fifo_owner(drm_device_t *dev, DRMFILE filp, int channel);
224 extern void nouveau_fifo_free(drm_device_t *dev, int channel);
225
226 /* nouveau_object.c */
227 extern void nouveau_object_cleanup(drm_device_t *dev, int channel);
228 extern struct nouveau_object *
229 nouveau_object_gr_create(drm_device_t *dev, int channel, int class);
230 extern struct nouveau_object *
231 nouveau_object_dma_create(drm_device_t *dev, int channel, int class,
232                           uint32_t offset, uint32_t size,
233                           int access, int target);
234 extern void nouveau_object_free(drm_device_t *dev, struct nouveau_object *obj);
235 extern int  nouveau_ioctl_object_init(DRM_IOCTL_ARGS);
236 extern int  nouveau_ioctl_dma_object_init(DRM_IOCTL_ARGS);
237 extern uint32_t nouveau_chip_instance_get(drm_device_t *dev, struct mem_block *mem);
238
239 /* nouveau_irq.c */
240 extern irqreturn_t nouveau_irq_handler(DRM_IRQ_ARGS);
241 extern void        nouveau_irq_preinstall(drm_device_t*);
242 extern void        nouveau_irq_postinstall(drm_device_t*);
243 extern void        nouveau_irq_uninstall(drm_device_t*);
244
245 /* nv04_fb.c */
246 extern int  nv04_fb_init(drm_device_t *dev);
247 extern void nv04_fb_takedown(drm_device_t *dev);
248
249 /* nv10_fb.c */
250 extern int  nv10_fb_init(drm_device_t *dev);
251 extern void nv10_fb_takedown(drm_device_t *dev);
252
253 /* nv40_fb.c */
254 extern int  nv40_fb_init(drm_device_t *dev);
255 extern void nv40_fb_takedown(drm_device_t *dev);
256
257 /* nv04_graph.c */
258 extern void nouveau_nv04_context_switch(drm_device_t *dev);
259 extern int nv04_graph_init(drm_device_t *dev);
260 extern void nv04_graph_takedown(drm_device_t *dev);
261 extern int nv04_graph_context_create(drm_device_t *dev, int channel);
262
263 /* nv10_graph.c */
264 extern void nouveau_nv10_context_switch(drm_device_t *dev);
265 extern int nv10_graph_init(drm_device_t *dev);
266 extern void nv10_graph_takedown(drm_device_t *dev);
267 extern int nv10_graph_context_create(drm_device_t *dev, int channel);
268
269 /* nv20_graph.c */
270 extern void nouveau_nv20_context_switch(drm_device_t *dev);
271 extern int nv20_graph_init(drm_device_t *dev);
272 extern void nv20_graph_takedown(drm_device_t *dev);
273 extern int nv20_graph_context_create(drm_device_t *dev, int channel);
274
275 /* nv30_graph.c */
276 extern int nv30_graph_init(drm_device_t *dev);
277 extern void nv30_graph_takedown(drm_device_t *dev);
278 extern int nv30_graph_context_create(drm_device_t *dev, int channel);
279
280 /* nv40_graph.c */
281 extern int  nv40_graph_init(drm_device_t *dev);
282 extern void nv40_graph_takedown(drm_device_t *dev);
283 extern int  nv40_graph_context_create(drm_device_t *dev, int channel);
284 extern void nv40_graph_context_save_current(drm_device_t *dev);
285 extern void nv40_graph_context_restore(drm_device_t *dev, int channel);
286
287 /* nv04_mc.c */
288 extern int  nv04_mc_init(drm_device_t *dev);
289 extern void nv04_mc_takedown(drm_device_t *dev);
290
291 /* nv40_mc.c */
292 extern int  nv40_mc_init(drm_device_t *dev);
293 extern void nv40_mc_takedown(drm_device_t *dev);
294
295 /* nv04_timer.c */
296 extern int  nv04_timer_init(drm_device_t *dev);
297 extern void nv04_timer_takedown(drm_device_t *dev);
298
299 extern long nouveau_compat_ioctl(struct file *filp, unsigned int cmd,
300                                 unsigned long arg);
301
302 #if defined(__powerpc__)
303 #define NV_READ(reg)        in_be32((void __iomem *)(dev_priv->mmio)->handle + (reg) )
304 #define NV_WRITE(reg,val)   out_be32((void __iomem *)(dev_priv->mmio)->handle + (reg) , (val) )
305 #else
306 #define NV_READ(reg)        DRM_READ32(  dev_priv->mmio, (reg) )
307 #define NV_WRITE(reg,val)   DRM_WRITE32( dev_priv->mmio, (reg), (val) )
308 #endif
309
310 #define INSTANCE_WR(mem,ofs,val) nouveau_instmem_w32(dev_priv,(mem),(ofs),(val))
311 #define INSTANCE_RD(mem,ofs)     nouveau_instmem_r32(dev_priv,(mem),(ofs))
312
313 #endif /* __NOUVEAU_DRV_H__ */
314