drm/amd/powerplay: fix bug that get wrong polaris evv voltage.
[linux-2.6-block.git] / include / drm / drm_fb_helper.h
CommitLineData
785b93ef
DA
1/*
2 * Copyright (c) 2006-2009 Red Hat Inc.
3 * Copyright (c) 2006-2008 Intel Corporation
4 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
5 *
6 * DRM framebuffer helper functions
7 *
8 * Permission to use, copy, modify, distribute, and sell this software and its
9 * documentation for any purpose is hereby granted without fee, provided that
10 * the above copyright notice appear in all copies and that both that copyright
11 * notice and this permission notice appear in supporting documentation, and
12 * that the name of the copyright holders not be used in advertising or
13 * publicity pertaining to distribution of the software without specific,
14 * written prior permission. The copyright holders make no representations
15 * about the suitability of this software for any purpose. It is provided "as
16 * is" without express or implied warranty.
17 *
18 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
20 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
21 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
22 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
23 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24 * OF THIS SOFTWARE.
25 *
26 * Authors:
27 * Dave Airlie <airlied@linux.ie>
28 * Jesse Barnes <jesse.barnes@intel.com>
29 */
30#ifndef DRM_FB_HELPER_H
31#define DRM_FB_HELPER_H
32
4abe3520
DA
33struct drm_fb_helper;
34
1a7aba7f
JB
35#include <linux/kgdb.h>
36
b516a9ef
DV
37enum mode_set_atomic {
38 LEAVE_ATOMIC_MODE_SET,
39 ENTER_ATOMIC_MODE_SET,
40};
41
b0ee9e7f
DA
42struct drm_fb_offset {
43 int x, y;
44};
45
785b93ef 46struct drm_fb_helper_crtc {
785b93ef 47 struct drm_mode_set mode_set;
8be48d92 48 struct drm_display_mode *desired_mode;
b0ee9e7f 49 int x, y;
785b93ef
DA
50};
51
b7b5ee59
RC
52/**
53 * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
54 * @fb_width: fbdev width
55 * @fb_height: fbdev height
56 * @surface_width: scanout buffer width
57 * @surface_height: scanout buffer height
58 * @surface_bpp: scanout buffer bpp
59 * @surface_depth: scanout buffer depth
60 *
61 * Note that the scanout surface width/height may be larger than the fbdev
62 * width/height. In case of multiple displays, the scanout surface is sized
63 * according to the largest width/height (so it is large enough for all CRTCs
64 * to scanout). But the fbdev width/height is sized to the minimum width/
65 * height of all the displays. This ensures that fbcon fits on the smallest
66 * of the attached displays.
67 *
68 * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height,
69 * rather than the surface size.
70 */
38651674
DA
71struct drm_fb_helper_surface_size {
72 u32 fb_width;
73 u32 fb_height;
74 u32 surface_width;
75 u32 surface_height;
76 u32 surface_bpp;
77 u32 surface_depth;
78};
79
207fd329
DV
80/**
81 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
207fd329
DV
82 *
83 * Driver callbacks used by the fbdev emulation helper library.
84 */
4abe3520 85struct drm_fb_helper_funcs {
264d6970
DV
86 /**
87 * @gamma_set:
88 *
89 * Set the given gamma LUT register on the given CRTC.
90 *
91 * This callback is optional.
92 *
93 * FIXME:
94 *
95 * This callback is functionally redundant with the core gamma table
96 * support and simply exists because the fbdev hasn't yet been
97 * refactored to use the core gamma table interfaces.
98 */
4abe3520
DA
99 void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
100 u16 blue, int regno);
264d6970
DV
101 /**
102 * @gamma_get:
103 *
104 * Read the given gamma LUT register on the given CRTC, used to save the
105 * current LUT when force-restoring the fbdev for e.g. kdbg.
106 *
107 * This callback is optional.
108 *
109 * FIXME:
110 *
111 * This callback is functionally redundant with the core gamma table
112 * support and simply exists because the fbdev hasn't yet been
113 * refactored to use the core gamma table interfaces.
114 */
4abe3520
DA
115 void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
116 u16 *blue, int regno);
117
264d6970
DV
118 /**
119 * @fb_probe:
120 *
121 * Driver callback to allocate and initialize the fbdev info structure.
122 * Furthermore it also needs to allocate the DRM framebuffer used to
123 * back the fbdev.
124 *
125 * This callback is mandatory.
126 *
127 * RETURNS:
128 *
129 * The driver should return 0 on success and a negative error code on
130 * failure.
131 */
4abe3520
DA
132 int (*fb_probe)(struct drm_fb_helper *helper,
133 struct drm_fb_helper_surface_size *sizes);
264d6970
DV
134
135 /**
136 * @initial_config:
137 *
138 * Driver callback to setup an initial fbdev display configuration.
139 * Drivers can use this callback to tell the fbdev emulation what the
140 * preferred initial configuration is. This is useful to implement
141 * smooth booting where the fbdev (and subsequently all userspace) never
142 * changes the mode, but always inherits the existing configuration.
143 *
144 * This callback is optional.
145 *
146 * RETURNS:
147 *
148 * The driver should return true if a suitable initial configuration has
149 * been filled out and false when the fbdev helper should fall back to
150 * the default probing logic.
151 */
11e17a08
JB
152 bool (*initial_config)(struct drm_fb_helper *fb_helper,
153 struct drm_fb_helper_crtc **crtcs,
154 struct drm_display_mode **modes,
b0ee9e7f 155 struct drm_fb_offset *offsets,
11e17a08 156 bool *enabled, int width, int height);
4abe3520
DA
157};
158
d50ba256 159struct drm_fb_helper_connector {
0b4c0f3f 160 struct drm_connector *connector;
d50ba256
DA
161};
162
9685cd9d 163/**
264d6970
DV
164 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
165 * @fb: Scanout framebuffer object
166 * @dev: DRM device
9685cd9d
RC
167 * @crtc_count: number of possible CRTCs
168 * @crtc_info: per-CRTC helper state (mode, x/y offset, etc)
169 * @connector_count: number of connected connectors
170 * @connector_info_alloc_count: size of connector_info
264d6970 171 * @connector_info: array of per-connector information
9685cd9d
RC
172 * @funcs: driver callbacks for fb helper
173 * @fbdev: emulated fbdev device info struct
174 * @pseudo_palette: fake palette of 16 colors
eaa434de
NT
175 * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to
176 * the screen buffer
177 * @dirty_lock: spinlock protecting @dirty_clip
178 * @dirty_work: worker used to flush the framebuffer
264d6970
DV
179 *
180 * This is the main structure used by the fbdev helpers. Drivers supporting
181 * fbdev emulation should embedded this into their overall driver structure.
182 * Drivers must also fill out a struct &drm_fb_helper_funcs with a few
183 * operations.
9685cd9d 184 */
785b93ef
DA
185struct drm_fb_helper {
186 struct drm_framebuffer *fb;
187 struct drm_device *dev;
785b93ef
DA
188 int crtc_count;
189 struct drm_fb_helper_crtc *crtc_info;
0b4c0f3f 190 int connector_count;
65c2a89c 191 int connector_info_alloc_count;
0b4c0f3f 192 struct drm_fb_helper_connector **connector_info;
3a493879 193 const struct drm_fb_helper_funcs *funcs;
38651674
DA
194 struct fb_info *fbdev;
195 u32 pseudo_palette[17];
eaa434de
NT
196 struct drm_clip_rect dirty_clip;
197 spinlock_t dirty_lock;
198 struct work_struct dirty_work;
264d6970
DV
199
200 /**
201 * @kernel_fb_list:
202 *
203 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
204 */
785b93ef 205 struct list_head kernel_fb_list;
8be48d92 206
264d6970
DV
207 /**
208 * @delayed_hotplug:
209 *
210 * A hotplug was received while fbdev wasn't in control of the DRM
211 * device, i.e. another KMS master was active. The output configuration
212 * needs to be reprobe when fbdev is in control again.
213 */
4abe3520 214 bool delayed_hotplug;
bbb1e524
RC
215
216 /**
217 * @atomic:
218 *
219 * Use atomic updates for restore_fbdev_mode(), etc. This defaults to
220 * true if driver has DRIVER_ATOMIC feature flag, but drivers can
221 * override it to true after drm_fb_helper_init() if they support atomic
222 * modeset but do not yet advertise DRIVER_ATOMIC (note that fb-helper
223 * does not require ASYNC commits).
224 */
225 bool atomic;
785b93ef
DA
226};
227
a03fdcb1 228#ifdef CONFIG_DRM_FBDEV_EMULATION
70412cfa 229int drm_fb_helper_modinit(void);
10a23102
TR
230void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
231 const struct drm_fb_helper_funcs *funcs);
4abe3520
DA
232int drm_fb_helper_init(struct drm_device *dev,
233 struct drm_fb_helper *helper, int crtc_count,
eb1f8e4f 234 int max_conn);
4abe3520 235void drm_fb_helper_fini(struct drm_fb_helper *helper);
785b93ef
DA
236int drm_fb_helper_blank(int blank, struct fb_info *info);
237int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
238 struct fb_info *info);
239int drm_fb_helper_set_par(struct fb_info *info);
240int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
241 struct fb_info *info);
785b93ef 242
b7bdf0a8 243int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
b8017d6c
AT
244
245struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
246void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
247void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper);
38651674 248void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
785b93ef 249 uint32_t fb_width, uint32_t fb_height);
3632ef89
DA
250void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
251 uint32_t depth);
252
47074ab7
AT
253void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
254
eaa434de
NT
255void drm_fb_helper_deferred_io(struct fb_info *info,
256 struct list_head *pagelist);
257
cbb1a82e
AT
258ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
259 size_t count, loff_t *ppos);
260ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
261 size_t count, loff_t *ppos);
262
742547b7
AT
263void drm_fb_helper_sys_fillrect(struct fb_info *info,
264 const struct fb_fillrect *rect);
265void drm_fb_helper_sys_copyarea(struct fb_info *info,
266 const struct fb_copyarea *area);
267void drm_fb_helper_sys_imageblit(struct fb_info *info,
268 const struct fb_image *image);
269
270void drm_fb_helper_cfb_fillrect(struct fb_info *info,
271 const struct fb_fillrect *rect);
272void drm_fb_helper_cfb_copyarea(struct fb_info *info,
273 const struct fb_copyarea *area);
274void drm_fb_helper_cfb_imageblit(struct fb_info *info,
275 const struct fb_image *image);
276
fdefa58a
AT
277void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, int state);
278
068143d3 279int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
d50ba256 280
7394371d 281int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
01934c2a 282int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
0b4c0f3f 283int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
1a7aba7f
JB
284int drm_fb_helper_debug_enter(struct fb_info *info);
285int drm_fb_helper_debug_leave(struct fb_info *info);
2f1046f3
JB
286struct drm_display_mode *
287drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
288 int width, int height);
289struct drm_display_mode *
290drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
291 int width, int height);
8be48d92 292
65c2a89c
DA
293int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
294int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
295 struct drm_connector *connector);
a03fdcb1 296#else
70412cfa
RA
297static inline int drm_fb_helper_modinit(void)
298{
299 return 0;
300}
301
a03fdcb1
AT
302static inline void drm_fb_helper_prepare(struct drm_device *dev,
303 struct drm_fb_helper *helper,
304 const struct drm_fb_helper_funcs *funcs)
305{
306}
307
308static inline int drm_fb_helper_init(struct drm_device *dev,
309 struct drm_fb_helper *helper, int crtc_count,
310 int max_conn)
311{
312 return 0;
313}
314
315static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
316{
317}
318
319static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
320{
321 return 0;
322}
323
324static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
325 struct fb_info *info)
326{
327 return 0;
328}
329
330static inline int drm_fb_helper_set_par(struct fb_info *info)
331{
332 return 0;
333}
334
335static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
336 struct fb_info *info)
337{
338 return 0;
339}
340
b7bdf0a8 341static inline int
a03fdcb1
AT
342drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
343{
b7bdf0a8 344 return 0;
a03fdcb1
AT
345}
346
347static inline struct fb_info *
348drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper)
349{
350 return NULL;
351}
352
353static inline void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper)
354{
355}
356static inline void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper)
357{
358}
359
360static inline void drm_fb_helper_fill_var(struct fb_info *info,
361 struct drm_fb_helper *fb_helper,
362 uint32_t fb_width, uint32_t fb_height)
363{
364}
365
366static inline void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
367 uint32_t depth)
368{
369}
370
371static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
372 struct fb_info *info)
373{
374 return 0;
375}
376
377static inline void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper)
378{
379}
380
eaa434de
NT
381static inline void drm_fb_helper_deferred_io(struct fb_info *info,
382 struct list_head *pagelist)
383{
384}
385
a03fdcb1
AT
386static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
387 char __user *buf, size_t count,
388 loff_t *ppos)
389{
390 return -ENODEV;
391}
392
393static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
394 const char __user *buf,
395 size_t count, loff_t *ppos)
396{
397 return -ENODEV;
398}
399
400static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
401 const struct fb_fillrect *rect)
402{
403}
404
405static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
406 const struct fb_copyarea *area)
407{
408}
409
410static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
411 const struct fb_image *image)
412{
413}
414
415static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
416 const struct fb_fillrect *rect)
417{
418}
419
420static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
421 const struct fb_copyarea *area)
422{
423}
424
425static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
426 const struct fb_image *image)
427{
428}
429
430static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
431 int state)
432{
433}
434
435static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
436{
437 return 0;
438}
439
440static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper,
441 int bpp_sel)
442{
443 return 0;
444}
445
446static inline int
447drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper)
448{
449 return 0;
450}
451
452static inline int drm_fb_helper_debug_enter(struct fb_info *info)
453{
454 return 0;
455}
456
457static inline int drm_fb_helper_debug_leave(struct fb_info *info)
458{
459 return 0;
460}
461
462static inline struct drm_display_mode *
463drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
464 int width, int height)
465{
466 return NULL;
467}
468
469static inline struct drm_display_mode *
470drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
471 int width, int height)
472{
473 return NULL;
474}
475
476static inline int
477drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper,
478 struct drm_connector *connector)
479{
480 return 0;
481}
482
483static inline int
484drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
485 struct drm_connector *connector)
486{
487 return 0;
488}
489#endif
785b93ef 490#endif