drm: Change the return type of the unload hook to void
[linux-2.6-microblaze.git] / drivers / gpu / drm / mgag200 / mgag200_drv.h
1 /*
2  * Copyright 2010 Matt Turner.
3  * Copyright 2012 Red Hat 
4  *
5  * This file is subject to the terms and conditions of the GNU General
6  * Public License version 2. See the file COPYING in the main
7  * directory of this archive for more details.
8  *
9  * Authors: Matthew Garrett
10  *          Matt Turner
11  *          Dave Airlie
12  */
13 #ifndef __MGAG200_DRV_H__
14 #define __MGAG200_DRV_H__
15
16 #include <video/vga.h>
17
18 #include <drm/drm_encoder.h>
19 #include <drm/drm_fb_helper.h>
20 #include <drm/ttm/ttm_bo_api.h>
21 #include <drm/ttm/ttm_bo_driver.h>
22 #include <drm/ttm/ttm_placement.h>
23 #include <drm/ttm/ttm_memory.h>
24 #include <drm/ttm/ttm_module.h>
25
26 #include <drm/drm_gem.h>
27
28 #include <linux/i2c.h>
29 #include <linux/i2c-algo-bit.h>
30
31 #include "mgag200_reg.h"
32
33 #define DRIVER_AUTHOR           "Matthew Garrett"
34
35 #define DRIVER_NAME             "mgag200"
36 #define DRIVER_DESC             "MGA G200 SE"
37 #define DRIVER_DATE             "20110418"
38
39 #define DRIVER_MAJOR            1
40 #define DRIVER_MINOR            0
41 #define DRIVER_PATCHLEVEL       0
42
43 #define MGAG200FB_CONN_LIMIT 1
44
45 #define RREG8(reg) ioread8(((void __iomem *)mdev->rmmio) + (reg))
46 #define WREG8(reg, v) iowrite8(v, ((void __iomem *)mdev->rmmio) + (reg))
47 #define RREG32(reg) ioread32(((void __iomem *)mdev->rmmio) + (reg))
48 #define WREG32(reg, v) iowrite32(v, ((void __iomem *)mdev->rmmio) + (reg))
49
50 #define ATTR_INDEX 0x1fc0
51 #define ATTR_DATA 0x1fc1
52
53 #define WREG_ATTR(reg, v)                                       \
54         do {                                                    \
55                 RREG8(0x1fda);                                  \
56                 WREG8(ATTR_INDEX, reg);                         \
57                 WREG8(ATTR_DATA, v);                            \
58         } while (0)                                             \
59
60 #define WREG_SEQ(reg, v)                                        \
61         do {                                                    \
62                 WREG8(MGAREG_SEQ_INDEX, reg);                   \
63                 WREG8(MGAREG_SEQ_DATA, v);                      \
64         } while (0)                                             \
65
66 #define WREG_CRT(reg, v)                                        \
67         do {                                                    \
68                 WREG8(MGAREG_CRTC_INDEX, reg);                  \
69                 WREG8(MGAREG_CRTC_DATA, v);                     \
70         } while (0)                                             \
71
72
73 #define WREG_ECRT(reg, v)                                       \
74         do {                                                    \
75                 WREG8(MGAREG_CRTCEXT_INDEX, reg);                               \
76                 WREG8(MGAREG_CRTCEXT_DATA, v);                          \
77         } while (0)                                             \
78
79 #define GFX_INDEX 0x1fce
80 #define GFX_DATA 0x1fcf
81
82 #define WREG_GFX(reg, v)                                        \
83         do {                                                    \
84                 WREG8(GFX_INDEX, reg);                          \
85                 WREG8(GFX_DATA, v);                             \
86         } while (0)                                             \
87
88 #define DAC_INDEX 0x3c00
89 #define DAC_DATA 0x3c0a
90
91 #define WREG_DAC(reg, v)                                        \
92         do {                                                    \
93                 WREG8(DAC_INDEX, reg);                          \
94                 WREG8(DAC_DATA, v);                             \
95         } while (0)                                             \
96
97 #define MGA_MISC_OUT 0x1fc2
98 #define MGA_MISC_IN 0x1fcc
99
100 #define MGAG200_MAX_FB_HEIGHT 4096
101 #define MGAG200_MAX_FB_WIDTH 4096
102
103 #define MATROX_DPMS_CLEARED (-1)
104
105 #define to_mga_crtc(x) container_of(x, struct mga_crtc, base)
106 #define to_mga_encoder(x) container_of(x, struct mga_encoder, base)
107 #define to_mga_connector(x) container_of(x, struct mga_connector, base)
108 #define to_mga_framebuffer(x) container_of(x, struct mga_framebuffer, base)
109
110 struct mga_framebuffer {
111         struct drm_framebuffer base;
112         struct drm_gem_object *obj;
113 };
114
115 struct mga_fbdev {
116         struct drm_fb_helper helper;
117         struct mga_framebuffer mfb;
118         void *sysram;
119         int size;
120         struct ttm_bo_kmap_obj mapping;
121         int x1, y1, x2, y2; /* dirty rect */
122         spinlock_t dirty_lock;
123 };
124
125 struct mga_crtc {
126         struct drm_crtc base;
127         u8 lut_r[256], lut_g[256], lut_b[256];
128         int last_dpms;
129         bool enabled;
130 };
131
132 struct mga_mode_info {
133         bool mode_config_initialized;
134         struct mga_crtc *crtc;
135 };
136
137 struct mga_encoder {
138         struct drm_encoder base;
139         int last_dpms;
140 };
141
142
143 struct mga_i2c_chan {
144         struct i2c_adapter adapter;
145         struct drm_device *dev;
146         struct i2c_algo_bit_data bit;
147         int data, clock;
148 };
149
150 struct mga_connector {
151         struct drm_connector base;
152         struct mga_i2c_chan *i2c;
153 };
154
155 struct mga_cursor {
156         /*
157            We have to have 2 buffers for the cursor to avoid occasional
158            corruption while switching cursor icons.
159            If either of these is NULL, then don't do hardware cursors, and
160            fall back to software.
161         */
162         struct mgag200_bo *pixels_1;
163         struct mgag200_bo *pixels_2;
164         u64 pixels_1_gpu_addr, pixels_2_gpu_addr;
165         /* The currently displayed icon, this points to one of pixels_1, or pixels_2 */
166         struct mgag200_bo *pixels_current;
167         /* The previously displayed icon */
168         struct mgag200_bo *pixels_prev;
169 };
170
171 struct mga_mc {
172         resource_size_t                 vram_size;
173         resource_size_t                 vram_base;
174         resource_size_t                 vram_window;
175 };
176
177 enum mga_type {
178         G200_SE_A,
179         G200_SE_B,
180         G200_WB,
181         G200_EV,
182         G200_EH,
183         G200_ER,
184         G200_EW3,
185 };
186
187 #define IS_G200_SE(mdev) (mdev->type == G200_SE_A || mdev->type == G200_SE_B)
188
189 struct mga_device {
190         struct drm_device               *dev;
191         unsigned long                   flags;
192
193         resource_size_t                 rmmio_base;
194         resource_size_t                 rmmio_size;
195         void __iomem                    *rmmio;
196
197         struct mga_mc                   mc;
198         struct mga_mode_info            mode_info;
199
200         struct mga_fbdev *mfbdev;
201         struct mga_cursor cursor;
202
203         bool                            suspended;
204         int                             num_crtc;
205         enum mga_type                   type;
206         int                             has_sdram;
207         struct drm_display_mode         mode;
208
209         int bpp_shifts[4];
210
211         int fb_mtrr;
212
213         struct {
214                 struct drm_global_reference mem_global_ref;
215                 struct ttm_bo_global_ref bo_global_ref;
216                 struct ttm_bo_device bdev;
217         } ttm;
218
219         /* SE model number stored in reg 0x1e24 */
220         u32 unique_rev_id;
221 };
222
223
224 struct mgag200_bo {
225         struct ttm_buffer_object bo;
226         struct ttm_placement placement;
227         struct ttm_bo_kmap_obj kmap;
228         struct drm_gem_object gem;
229         struct ttm_place placements[3];
230         int pin_count;
231 };
232 #define gem_to_mga_bo(gobj) container_of((gobj), struct mgag200_bo, gem)
233
234 static inline struct mgag200_bo *
235 mgag200_bo(struct ttm_buffer_object *bo)
236 {
237         return container_of(bo, struct mgag200_bo, bo);
238 }
239                                 /* mgag200_crtc.c */
240 void mga_crtc_fb_gamma_set(struct drm_crtc *crtc, u16 red, u16 green,
241                              u16 blue, int regno);
242 void mga_crtc_fb_gamma_get(struct drm_crtc *crtc, u16 *red, u16 *green,
243                              u16 *blue, int regno);
244
245                                 /* mgag200_mode.c */
246 int mgag200_modeset_init(struct mga_device *mdev);
247 void mgag200_modeset_fini(struct mga_device *mdev);
248
249                                 /* mgag200_fb.c */
250 int mgag200_fbdev_init(struct mga_device *mdev);
251 void mgag200_fbdev_fini(struct mga_device *mdev);
252
253                                 /* mgag200_main.c */
254 int mgag200_framebuffer_init(struct drm_device *dev,
255                              struct mga_framebuffer *mfb,
256                              const struct drm_mode_fb_cmd2 *mode_cmd,
257                              struct drm_gem_object *obj);
258
259
260 int mgag200_driver_load(struct drm_device *dev, unsigned long flags);
261 void mgag200_driver_unload(struct drm_device *dev);
262 int mgag200_gem_create(struct drm_device *dev,
263                    u32 size, bool iskernel,
264                        struct drm_gem_object **obj);
265 int mgag200_dumb_create(struct drm_file *file,
266                         struct drm_device *dev,
267                         struct drm_mode_create_dumb *args);
268 void mgag200_gem_free_object(struct drm_gem_object *obj);
269 int
270 mgag200_dumb_mmap_offset(struct drm_file *file,
271                          struct drm_device *dev,
272                          uint32_t handle,
273                          uint64_t *offset);
274                                 /* mgag200_i2c.c */
275 struct mga_i2c_chan *mgag200_i2c_create(struct drm_device *dev);
276 void mgag200_i2c_destroy(struct mga_i2c_chan *i2c);
277
278 #define DRM_FILE_PAGE_OFFSET (0x100000000ULL >> PAGE_SHIFT)
279 void mgag200_ttm_placement(struct mgag200_bo *bo, int domain);
280
281 static inline int mgag200_bo_reserve(struct mgag200_bo *bo, bool no_wait)
282 {
283         int ret;
284
285         ret = ttm_bo_reserve(&bo->bo, true, no_wait, NULL);
286         if (ret) {
287                 if (ret != -ERESTARTSYS && ret != -EBUSY)
288                         DRM_ERROR("reserve failed %p\n", bo);
289                 return ret;
290         }
291         return 0;
292 }
293
294 static inline void mgag200_bo_unreserve(struct mgag200_bo *bo)
295 {
296         ttm_bo_unreserve(&bo->bo);
297 }
298
299 int mgag200_bo_create(struct drm_device *dev, int size, int align,
300                       uint32_t flags, struct mgag200_bo **pastbo);
301 int mgag200_mm_init(struct mga_device *mdev);
302 void mgag200_mm_fini(struct mga_device *mdev);
303 int mgag200_mmap(struct file *filp, struct vm_area_struct *vma);
304 int mgag200_bo_pin(struct mgag200_bo *bo, u32 pl_flag, u64 *gpu_addr);
305 int mgag200_bo_unpin(struct mgag200_bo *bo);
306 int mgag200_bo_push_sysram(struct mgag200_bo *bo);
307                            /* mgag200_cursor.c */
308 int mga_crtc_cursor_set(struct drm_crtc *crtc, struct drm_file *file_priv,
309                                                 uint32_t handle, uint32_t width, uint32_t height);
310 int mga_crtc_cursor_move(struct drm_crtc *crtc, int x, int y);
311
312 #endif                          /* __MGAG200_DRV_H__ */