[deliverable/linux.git] / include / drm / drm_fb_helper.h

/*
 * Copyright (c) 2006-2009 Red Hat Inc.
 * Copyright (c) 2006-2008 Intel Corporation
 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
 *
 * DRM framebuffer helper functions
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that copyright
 * notice and this permission notice appear in supporting documentation, and
 * that the name of the copyright holders not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  The copyright holders make no representations
 * about the suitability of this software for any purpose.  It is provided "as
 * is" without express or implied warranty.
 *
 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
 * OF THIS SOFTWARE.
 *
 * Authors:
 *      Dave Airlie <airlied@linux.ie>
 *      Jesse Barnes <jesse.barnes@intel.com>
 */
#ifndef DRM_FB_HELPER_H
#define DRM_FB_HELPER_H

struct drm_fb_helper;

#include <linux/kgdb.h>

struct drm_fb_offset {
	int x, y;
};

struct drm_fb_helper_crtc {
	struct drm_mode_set mode_set;
	struct drm_display_mode *desired_mode;
	int x, y;
};

/**
 * struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
 * @fb_width: fbdev width
 * @fb_height: fbdev height
 * @surface_width: scanout buffer width
 * @surface_height: scanout buffer height
 * @surface_bpp: scanout buffer bpp
 * @surface_depth: scanout buffer depth
 *
 * Note that the scanout surface width/height may be larger than the fbdev
 * width/height.  In case of multiple displays, the scanout surface is sized
 * according to the largest width/height (so it is large enough for all CRTCs
 * to scanout).  But the fbdev width/height is sized to the minimum width/
 * height of all the displays.  This ensures that fbcon fits on the smallest
 * of the attached displays.
 *
 * So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height,
 * rather than the surface size.
 */
struct drm_fb_helper_surface_size {
	u32 fb_width;
	u32 fb_height;
	u32 surface_width;
	u32 surface_height;
	u32 surface_bpp;
	u32 surface_depth;
};

/**
 * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
 * @gamma_set: Set the given gamma lut register on the given crtc.
 * @gamma_get: Read the given gamma lut register on the given crtc, used to
 *             save the current lut when force-restoring the fbdev for e.g.
 *             kdbg.
 * @fb_probe: Driver callback to allocate and initialize the fbdev info
 *            structure. Furthermore it also needs to allocate the drm
 *            framebuffer used to back the fbdev.
 * @initial_config: Setup an initial fbdev display configuration
 *
 * Driver callbacks used by the fbdev emulation helper library.
 */
struct drm_fb_helper_funcs {
	void (*gamma_set)(struct drm_crtc *crtc, u16 red, u16 green,
			  u16 blue, int regno);
	void (*gamma_get)(struct drm_crtc *crtc, u16 *red, u16 *green,
			  u16 *blue, int regno);

	int (*fb_probe)(struct drm_fb_helper *helper,
			struct drm_fb_helper_surface_size *sizes);
	bool (*initial_config)(struct drm_fb_helper *fb_helper,
			       struct drm_fb_helper_crtc **crtcs,
			       struct drm_display_mode **modes,
			       struct drm_fb_offset *offsets,
			       bool *enabled, int width, int height);
};

struct drm_fb_helper_connector {
	struct drm_connector *connector;
};

struct drm_fb_helper {
	struct drm_framebuffer *fb;
	struct drm_device *dev;
	int crtc_count;
	struct drm_fb_helper_crtc *crtc_info;
	int connector_count;
	int connector_info_alloc_count;
	struct drm_fb_helper_connector **connector_info;
	const struct drm_fb_helper_funcs *funcs;
	struct fb_info *fbdev;
	u32 pseudo_palette[17];
	struct list_head kernel_fb_list;

	/* we got a hotplug but fbdev wasn't running the console
	   delay until next set_par */
	bool delayed_hotplug;
};

void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
			   const struct drm_fb_helper_funcs *funcs);
int drm_fb_helper_init(struct drm_device *dev,
		       struct drm_fb_helper *helper, int crtc_count,
		       int max_conn);
void drm_fb_helper_fini(struct drm_fb_helper *helper);
int drm_fb_helper_blank(int blank, struct fb_info *info);
int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
			      struct fb_info *info);
int drm_fb_helper_set_par(struct fb_info *info);
int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
			    struct fb_info *info);

bool drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);

struct fb_info *drm_fb_helper_alloc_fbi(struct drm_fb_helper *fb_helper);
void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper);
void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
			    uint32_t fb_width, uint32_t fb_height);
void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
			    uint32_t depth);

void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);

ssize_t drm_fb_helper_sys_read(struct fb_info *info, char __user *buf,
			       size_t count, loff_t *ppos);
ssize_t drm_fb_helper_sys_write(struct fb_info *info, const char __user *buf,
				size_t count, loff_t *ppos);

int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);

int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
int drm_fb_helper_debug_enter(struct fb_info *info);
int drm_fb_helper_debug_leave(struct fb_info *info);
struct drm_display_mode *
drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
			int width, int height);
struct drm_display_mode *
drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
		      int width, int height);

int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
				       struct drm_connector *connector);
#endif
Commit	Line	Data
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	33	struct drm_fb_helper;
4abe3520 DA	34
1a7aba7f JB	35	#include <linux/kgdb.h>
1a7aba7f JB	36
b0ee9e7f DA	37	struct drm_fb_offset {
	38	int x, y;
	39	};
	40
785b93ef	41	struct drm_fb_helper_crtc {
785b93ef	42	struct drm_mode_set mode_set;
8be48d92	43	struct drm_display_mode *desired_mode;
b0ee9e7f	44	int x, y;
785b93ef DA	45	};
785b93ef DA	46
b7b5ee59 RC	47	/**
	48	* struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
	49	* @fb_width: fbdev width
	50	* @fb_height: fbdev height
	51	* @surface_width: scanout buffer width
	52	* @surface_height: scanout buffer height
	53	* @surface_bpp: scanout buffer bpp
	54	* @surface_depth: scanout buffer depth
	55	*
	56	* Note that the scanout surface width/height may be larger than the fbdev
	57	* width/height. In case of multiple displays, the scanout surface is sized
	58	* according to the largest width/height (so it is large enough for all CRTCs
	59	* to scanout). But the fbdev width/height is sized to the minimum width/
	60	* height of all the displays. This ensures that fbcon fits on the smallest
	61	* of the attached displays.
	62	*
	63	* So what is passed to drm_fb_helper_fill_var() should be fb_width/fb_height,
	64	* rather than the surface size.
	65	*/
38651674 DA	66	struct drm_fb_helper_surface_size {
	67	u32 fb_width;
	68	u32 fb_height;
	69	u32 surface_width;
	70	u32 surface_height;
	71	u32 surface_bpp;
	72	u32 surface_depth;
	73	};
	74
207fd329 DV	75	/**
207fd329 DV	76	* struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
7b97936f VS	77	* @gamma_set: Set the given gamma lut register on the given crtc.
	78	* @gamma_get: Read the given gamma lut register on the given crtc, used to
	79	* save the current lut when force-restoring the fbdev for e.g.
	80	* kdbg.
	81	* @fb_probe: Driver callback to allocate and initialize the fbdev info
e227867f	82	* structure. Furthermore it also needs to allocate the drm
7b97936f VS	83	* framebuffer used to back the fbdev.
7b97936f VS	84	* @initial_config: Setup an initial fbdev display configuration
207fd329 DV	85	*
	86	* Driver callbacks used by the fbdev emulation helper library.
	87	*/
4abe3520 DA	88	struct drm_fb_helper_funcs {
	89	void (gamma_set)(struct drm_crtc crtc, u16 red, u16 green,
	90	u16 blue, int regno);
	91	void (gamma_get)(struct drm_crtc crtc, u16 red, u16 green,
	92	u16 *blue, int regno);
	93
	94	int (fb_probe)(struct drm_fb_helper helper,
	95	struct drm_fb_helper_surface_size *sizes);
11e17a08 JB	96	bool (initial_config)(struct drm_fb_helper fb_helper,
	97	struct drm_fb_helper_crtc **crtcs,
	98	struct drm_display_mode **modes,
b0ee9e7f	99	struct drm_fb_offset *offsets,
11e17a08	100	bool *enabled, int width, int height);
4abe3520 DA	101	};
4abe3520 DA	102
d50ba256	103	struct drm_fb_helper_connector {
0b4c0f3f	104	struct drm_connector *connector;
d50ba256 DA	105	};
d50ba256 DA	106
785b93ef DA	107	struct drm_fb_helper {
	108	struct drm_framebuffer *fb;
	109	struct drm_device *dev;
785b93ef DA	110	int crtc_count;
785b93ef DA	111	struct drm_fb_helper_crtc *crtc_info;
0b4c0f3f	112	int connector_count;
65c2a89c	113	int connector_info_alloc_count;
0b4c0f3f	114	struct drm_fb_helper_connector **connector_info;
3a493879	115	const struct drm_fb_helper_funcs *funcs;
38651674 DA	116	struct fb_info *fbdev;
38651674 DA	117	u32 pseudo_palette[17];
785b93ef	118	struct list_head kernel_fb_list;
8be48d92	119
4abe3520 DA	120	/* we got a hotplug but fbdev wasn't running the console
	121	delay until next set_par */
	122	bool delayed_hotplug;
785b93ef DA	123	};
785b93ef DA	124
10a23102 TR	125	void drm_fb_helper_prepare(struct drm_device dev, struct drm_fb_helper helper,
10a23102 TR	126	const struct drm_fb_helper_funcs *funcs);
4abe3520 DA	127	int drm_fb_helper_init(struct drm_device *dev,
4abe3520 DA	128	struct drm_fb_helper *helper, int crtc_count,
eb1f8e4f	129	int max_conn);
4abe3520	130	void drm_fb_helper_fini(struct drm_fb_helper *helper);
785b93ef DA	131	int drm_fb_helper_blank(int blank, struct fb_info *info);
	132	int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
	133	struct fb_info *info);
	134	int drm_fb_helper_set_par(struct fb_info *info);
	135	int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
	136	struct fb_info *info);
785b93ef	137
5ea1f752	138	bool drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
b8017d6c AT	139
	140	struct fb_info drm_fb_helper_alloc_fbi(struct drm_fb_helper fb_helper);
	141	void drm_fb_helper_unregister_fbi(struct drm_fb_helper *fb_helper);
	142	void drm_fb_helper_release_fbi(struct drm_fb_helper *fb_helper);
38651674	143	void drm_fb_helper_fill_var(struct fb_info info, struct drm_fb_helper fb_helper,
785b93ef	144	uint32_t fb_width, uint32_t fb_height);
3632ef89 DA	145	void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
	146	uint32_t depth);
	147
47074ab7 AT	148	void drm_fb_helper_unlink_fbi(struct drm_fb_helper *fb_helper);
47074ab7 AT	149
cbb1a82e AT	150	ssize_t drm_fb_helper_sys_read(struct fb_info info, char __user buf,
	151	size_t count, loff_t *ppos);
	152	ssize_t drm_fb_helper_sys_write(struct fb_info info, const char __user buf,
	153	size_t count, loff_t *ppos);
	154
068143d3	155	int drm_fb_helper_setcmap(struct fb_cmap cmap, struct fb_info info);
d50ba256	156
7394371d	157	int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
01934c2a	158	int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
0b4c0f3f	159	int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
1a7aba7f JB	160	int drm_fb_helper_debug_enter(struct fb_info *info);
1a7aba7f JB	161	int drm_fb_helper_debug_leave(struct fb_info *info);
2f1046f3 JB	162	struct drm_display_mode *
	163	drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
	164	int width, int height);
	165	struct drm_display_mode *
	166	drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
	167	int width, int height);
8be48d92	168
65c2a89c DA	169	int drm_fb_helper_add_one_connector(struct drm_fb_helper fb_helper, struct drm_connector connector);
	170	int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
	171	struct drm_connector *connector);
785b93ef	172	#endif