[mirror_ubuntu-zesty-kernel.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_helper_crtc {
	struct drm_mode_set mode_set;
	struct drm_display_mode *desired_mode;
};

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,
			       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);
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);

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);
bool 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
785b93ef	37	struct drm_fb_helper_crtc {
785b93ef	38	struct drm_mode_set mode_set;
8be48d92	39	struct drm_display_mode *desired_mode;
785b93ef DA	40	};
785b93ef DA	41
38651674 DA	42	struct drm_fb_helper_surface_size {
	43	u32 fb_width;
	44	u32 fb_height;
	45	u32 surface_width;
	46	u32 surface_height;
	47	u32 surface_bpp;
	48	u32 surface_depth;
	49	};
	50
207fd329 DV	51	/**
207fd329 DV	52	* struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
7b97936f VS	53	* @gamma_set: Set the given gamma lut register on the given crtc.
	54	* @gamma_get: Read the given gamma lut register on the given crtc, used to
	55	* save the current lut when force-restoring the fbdev for e.g.
	56	* kdbg.
	57	* @fb_probe: Driver callback to allocate and initialize the fbdev info
e227867f	58	* structure. Furthermore it also needs to allocate the drm
7b97936f VS	59	* framebuffer used to back the fbdev.
7b97936f VS	60	* @initial_config: Setup an initial fbdev display configuration
207fd329 DV	61	*
	62	* Driver callbacks used by the fbdev emulation helper library.
	63	*/
4abe3520 DA	64	struct drm_fb_helper_funcs {
	65	void (gamma_set)(struct drm_crtc crtc, u16 red, u16 green,
	66	u16 blue, int regno);
	67	void (gamma_get)(struct drm_crtc crtc, u16 red, u16 green,
	68	u16 *blue, int regno);
	69
	70	int (fb_probe)(struct drm_fb_helper helper,
	71	struct drm_fb_helper_surface_size *sizes);
11e17a08 JB	72	bool (initial_config)(struct drm_fb_helper fb_helper,
	73	struct drm_fb_helper_crtc **crtcs,
	74	struct drm_display_mode **modes,
	75	bool *enabled, int width, int height);
4abe3520 DA	76	};
4abe3520 DA	77
d50ba256	78	struct drm_fb_helper_connector {
0b4c0f3f	79	struct drm_connector *connector;
d50ba256 DA	80	};
d50ba256 DA	81
785b93ef DA	82	struct drm_fb_helper {
	83	struct drm_framebuffer *fb;
	84	struct drm_device *dev;
785b93ef DA	85	int crtc_count;
785b93ef DA	86	struct drm_fb_helper_crtc *crtc_info;
0b4c0f3f	87	int connector_count;
65c2a89c	88	int connector_info_alloc_count;
0b4c0f3f	89	struct drm_fb_helper_connector **connector_info;
3a493879	90	const struct drm_fb_helper_funcs *funcs;
38651674 DA	91	struct fb_info *fbdev;
38651674 DA	92	u32 pseudo_palette[17];
785b93ef	93	struct list_head kernel_fb_list;
8be48d92	94
4abe3520 DA	95	/* we got a hotplug but fbdev wasn't running the console
	96	delay until next set_par */
	97	bool delayed_hotplug;
785b93ef DA	98	};
785b93ef DA	99
10a23102 TR	100	void drm_fb_helper_prepare(struct drm_device dev, struct drm_fb_helper helper,
10a23102 TR	101	const struct drm_fb_helper_funcs *funcs);
4abe3520 DA	102	int drm_fb_helper_init(struct drm_device *dev,
4abe3520 DA	103	struct drm_fb_helper *helper, int crtc_count,
eb1f8e4f	104	int max_conn);
4abe3520	105	void drm_fb_helper_fini(struct drm_fb_helper *helper);
785b93ef DA	106	int drm_fb_helper_blank(int blank, struct fb_info *info);
	107	int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
	108	struct fb_info *info);
	109	int drm_fb_helper_set_par(struct fb_info *info);
	110	int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
	111	struct fb_info *info);
785b93ef	112
5ea1f752	113	bool drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
38651674	114	void drm_fb_helper_fill_var(struct fb_info info, struct drm_fb_helper fb_helper,
785b93ef	115	uint32_t fb_width, uint32_t fb_height);
3632ef89 DA	116	void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
	117	uint32_t depth);
	118
068143d3	119	int drm_fb_helper_setcmap(struct fb_cmap cmap, struct fb_info info);
d50ba256	120
7394371d	121	int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
4abe3520	122	bool drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
0b4c0f3f	123	int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
1a7aba7f JB	124	int drm_fb_helper_debug_enter(struct fb_info *info);
1a7aba7f JB	125	int drm_fb_helper_debug_leave(struct fb_info *info);
2f1046f3 JB	126	struct drm_display_mode *
	127	drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
	128	int width, int height);
	129	struct drm_display_mode *
	130	drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
	131	int width, int height);
8be48d92	132
65c2a89c DA	133	int drm_fb_helper_add_one_connector(struct drm_fb_helper fb_helper, struct drm_connector connector);
	134	int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
	135	struct drm_connector *connector);
785b93ef	136	#endif