[linux-block.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_clip_rect;
struct drm_fb_helper;

#include <linux/fb.h>

#include <drm/drm_client.h>

/**
 * 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. fb_width/fb_height is used by
 * drm_fb_helper_fill_info() to fill out the &fb_info.var structure.
 */
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
 *
 * Driver callbacks used by the fbdev emulation helper library.
 */
struct drm_fb_helper_funcs {
	/**
	 * @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.
	 *
	 * This callback is mandatory.
	 *
	 * RETURNS:
	 *
	 * The driver should return 0 on success and a negative error code on
	 * failure.
	 */
	int (*fb_probe)(struct drm_fb_helper *helper,
			struct drm_fb_helper_surface_size *sizes);

	/**
	 * @fb_dirty:
	 *
	 * Driver callback to update the framebuffer memory. If set, fbdev
	 * emulation will invoke this callback in regular intervals after
	 * the framebuffer has been written.
	 *
	 * This callback is optional.
	 *
	 * Returns:
	 * 0 on success, or an error code otherwise.
	 */
	int (*fb_dirty)(struct drm_fb_helper *helper, struct drm_clip_rect *clip);
};

/**
 * struct drm_fb_helper - main structure to emulate fbdev on top of KMS
 * @fb: Scanout framebuffer object
 * @dev: DRM device
 * @funcs: driver callbacks for fb helper
 * @info: emulated fbdev device info struct
 * @pseudo_palette: fake palette of 16 colors
 * @damage_clip: clip rectangle used with deferred_io to accumulate damage to
 *                the screen buffer
 * @damage_lock: spinlock protecting @damage_clip
 * @damage_work: worker used to flush the framebuffer
 * @resume_work: worker used during resume if the console lock is already taken
 *
 * This is the main structure used by the fbdev helpers. Drivers supporting
 * fbdev emulation should embedded this into their overall driver structure.
 * Drivers must also fill out a &struct drm_fb_helper_funcs with a few
 * operations.
 */
struct drm_fb_helper {
	/**
	 * @client:
	 *
	 * DRM client used by the generic fbdev emulation.
	 */
	struct drm_client_dev client;

	/**
	 * @buffer:
	 *
	 * Framebuffer used by the generic fbdev emulation.
	 */
	struct drm_client_buffer *buffer;

	struct drm_framebuffer *fb;
	struct drm_device *dev;
	const struct drm_fb_helper_funcs *funcs;
	struct fb_info *info;
	u32 pseudo_palette[17];
	struct drm_clip_rect damage_clip;
	spinlock_t damage_lock;
	struct work_struct damage_work;
	struct work_struct resume_work;

	/**
	 * @lock:
	 *
	 * Top-level FBDEV helper lock. This protects all internal data
	 * structures and lists, such as @connector_info and @crtc_info.
	 *
	 * FIXME: fbdev emulation locking is a mess and long term we want to
	 * protect all helper internal state with this lock as well as reduce
	 * core KMS locking as much as possible.
	 */
	struct mutex lock;

	/**
	 * @kernel_fb_list:
	 *
	 * Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
	 */
	struct list_head kernel_fb_list;

	/**
	 * @delayed_hotplug:
	 *
	 * A hotplug was received while fbdev wasn't in control of the DRM
	 * device, i.e. another KMS master was active. The output configuration
	 * needs to be reprobe when fbdev is in control again.
	 */
	bool delayed_hotplug;

	/**
	 * @deferred_setup:
	 *
	 * If no outputs are connected (disconnected or unknown) the FB helper
	 * code will defer setup until at least one of the outputs shows up.
	 * This field keeps track of the status so that setup can be retried
	 * at every hotplug event until it succeeds eventually.
	 *
	 * Protected by @lock.
	 */
	bool deferred_setup;

	/**
	 * @preferred_bpp:
	 *
	 * Temporary storage for the driver's preferred BPP setting passed to
	 * FB helper initialization. This needs to be tracked so that deferred
	 * FB helper setup can pass this on.
	 *
	 * See also: @deferred_setup
	 */
	int preferred_bpp;

#ifdef CONFIG_FB_DEFERRED_IO
	/**
	 * @fbdefio:
	 *
	 * Temporary storage for the driver's FB deferred I/O handler. If the
	 * driver uses the DRM fbdev emulation layer, this is set by the core
	 * to a generic deferred I/O handler if a driver is preferring to use
	 * a shadow buffer.
	 */
	struct fb_deferred_io fbdefio;
#endif
};

static inline struct drm_fb_helper *
drm_fb_helper_from_client(struct drm_client_dev *client)
{
	return container_of(client, struct drm_fb_helper, client);
}

/**
 * define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
 *
 * Helper define to register default implementations of drm_fb_helper
 * functions. To be used in struct fb_ops of drm drivers.
 */
#define DRM_FB_HELPER_DEFAULT_OPS \
	.fb_check_var	= drm_fb_helper_check_var, \
	.fb_set_par	= drm_fb_helper_set_par, \
	.fb_setcmap	= drm_fb_helper_setcmap, \
	.fb_blank	= drm_fb_helper_blank, \
	.fb_pan_display	= drm_fb_helper_pan_display, \
	.fb_debug_enter = drm_fb_helper_debug_enter, \
	.fb_debug_leave = drm_fb_helper_debug_leave, \
	.fb_ioctl	= drm_fb_helper_ioctl

#ifdef CONFIG_DRM_FBDEV_EMULATION
void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
			   unsigned int preferred_bpp,
			   const struct drm_fb_helper_funcs *funcs);
void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper);
int drm_fb_helper_init(struct drm_device *dev, struct drm_fb_helper *helper);
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);

int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);

struct fb_info *drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper);
void drm_fb_helper_release_info(struct drm_fb_helper *fb_helper);
void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper);
void drm_fb_helper_fill_info(struct fb_info *info,
			     struct drm_fb_helper *fb_helper,
			     struct drm_fb_helper_surface_size *sizes);

void drm_fb_helper_deferred_io(struct fb_info *info, struct list_head *pagereflist);

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

void drm_fb_helper_sys_fillrect(struct fb_info *info,
				const struct fb_fillrect *rect);
void drm_fb_helper_sys_copyarea(struct fb_info *info,
				const struct fb_copyarea *area);
void drm_fb_helper_sys_imageblit(struct fb_info *info,
				 const struct fb_image *image);

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

void drm_fb_helper_cfb_fillrect(struct fb_info *info,
				const struct fb_fillrect *rect);
void drm_fb_helper_cfb_copyarea(struct fb_info *info,
				const struct fb_copyarea *area);
void drm_fb_helper_cfb_imageblit(struct fb_info *info,
				 const struct fb_image *image);

void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
					bool suspend);

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

int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
			unsigned long arg);

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 drm_fb_helper_debug_enter(struct fb_info *info);
int drm_fb_helper_debug_leave(struct fb_info *info);

void drm_fb_helper_lastclose(struct drm_device *dev);
void drm_fb_helper_output_poll_changed(struct drm_device *dev);
#else
static inline void drm_fb_helper_prepare(struct drm_device *dev,
					 struct drm_fb_helper *helper,
					 unsigned int preferred_bpp,
					 const struct drm_fb_helper_funcs *funcs)
{
}

static inline void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper)
{
}

static inline int drm_fb_helper_init(struct drm_device *dev,
		       struct drm_fb_helper *helper)
{
	/* So drivers can use it to free the struct */
	helper->dev = dev;
	dev->fb_helper = helper;

	return 0;
}

static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
{
	if (helper && helper->dev)
		helper->dev->fb_helper = NULL;
}

static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
{
	return 0;
}

static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
					    struct fb_info *info)
{
	return 0;
}

static inline int drm_fb_helper_set_par(struct fb_info *info)
{
	return 0;
}

static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
					  struct fb_info *info)
{
	return 0;
}

static inline int
drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
{
	return 0;
}

static inline struct fb_info *
drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper)
{
	return NULL;
}

static inline void drm_fb_helper_release_info(struct drm_fb_helper *fb_helper)
{
}

static inline void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper)
{
}

static inline void
drm_fb_helper_fill_info(struct fb_info *info,
			struct drm_fb_helper *fb_helper,
			struct drm_fb_helper_surface_size *sizes)
{
}

static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
					struct fb_info *info)
{
	return 0;
}

static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
				      unsigned long arg)
{
	return 0;
}

static inline void drm_fb_helper_deferred_io(struct fb_info *info,
					     struct list_head *pagelist)
{
}

static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
{
	return -ENODEV;
}

static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
					     char __user *buf, size_t count,
					     loff_t *ppos)
{
	return -ENODEV;
}

static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
					      const char __user *buf,
					      size_t count, loff_t *ppos)
{
	return -ENODEV;
}

static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
					      const struct fb_fillrect *rect)
{
}

static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
					      const struct fb_copyarea *area)
{
}

static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
					       const struct fb_image *image)
{
}

static inline ssize_t drm_fb_helper_cfb_read(struct fb_info *info, char __user *buf,
					     size_t count, loff_t *ppos)
{
	return -ENODEV;
}

static inline ssize_t drm_fb_helper_cfb_write(struct fb_info *info, const char __user *buf,
					      size_t count, loff_t *ppos)
{
	return -ENODEV;
}

static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
					      const struct fb_fillrect *rect)
{
}

static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
					      const struct fb_copyarea *area)
{
}

static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
					       const struct fb_image *image)
{
}

static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
					     bool suspend)
{
}

static inline void
drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
{
}

static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
{
	return 0;
}

static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper)
{
	return 0;
}

static inline int drm_fb_helper_debug_enter(struct fb_info *info)
{
	return 0;
}

static inline int drm_fb_helper_debug_leave(struct fb_info *info)
{
	return 0;
}

static inline void drm_fb_helper_lastclose(struct drm_device *dev)
{
}

static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
{
}
#endif

#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
f231af49	33	struct drm_clip_rect;
4abe3520 DA	34	struct drm_fb_helper;
4abe3520 DA	35
73289afe	36	#include <linux/fb.h>
7e8c9ef5 TZ	37
7e8c9ef5 TZ	38	#include <drm/drm_client.h>
1a7aba7f	39
b7b5ee59 RC	40	/**
	41	* struct drm_fb_helper_surface_size - describes fbdev size and scanout surface size
	42	* @fb_width: fbdev width
	43	* @fb_height: fbdev height
	44	* @surface_width: scanout buffer width
	45	* @surface_height: scanout buffer height
	46	* @surface_bpp: scanout buffer bpp
	47	* @surface_depth: scanout buffer depth
	48	*
	49	* Note that the scanout surface width/height may be larger than the fbdev
	50	* width/height. In case of multiple displays, the scanout surface is sized
	51	* according to the largest width/height (so it is large enough for all CRTCs
	52	* to scanout). But the fbdev width/height is sized to the minimum width/
	53	* height of all the displays. This ensures that fbcon fits on the smallest
ec8bf194 DV	54	* of the attached displays. fb_width/fb_height is used by
ec8bf194 DV	55	* drm_fb_helper_fill_info() to fill out the &fb_info.var structure.
b7b5ee59	56	*/
38651674 DA	57	struct drm_fb_helper_surface_size {
	58	u32 fb_width;
	59	u32 fb_height;
	60	u32 surface_width;
	61	u32 surface_height;
	62	u32 surface_bpp;
	63	u32 surface_depth;
	64	};
	65
207fd329 DV	66	/**
207fd329 DV	67	* struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
207fd329 DV	68	*
	69	* Driver callbacks used by the fbdev emulation helper library.
	70	*/
4abe3520	71	struct drm_fb_helper_funcs {
264d6970 DV	72	/**
	73	* @fb_probe:
	74	*
	75	* Driver callback to allocate and initialize the fbdev info structure.
	76	* Furthermore it also needs to allocate the DRM framebuffer used to
	77	* back the fbdev.
	78	*
	79	* This callback is mandatory.
	80	*
	81	* RETURNS:
	82	*
	83	* The driver should return 0 on success and a negative error code on
	84	* failure.
	85	*/
4abe3520 DA	86	int (fb_probe)(struct drm_fb_helper helper,
4abe3520 DA	87	struct drm_fb_helper_surface_size *sizes);
f231af49 TZ	88
	89	/**
	90	* @fb_dirty:
	91	*
	92	* Driver callback to update the framebuffer memory. If set, fbdev
	93	* emulation will invoke this callback in regular intervals after
	94	* the framebuffer has been written.
	95	*
	96	* This callback is optional.
	97	*
	98	* Returns:
	99	* 0 on success, or an error code otherwise.
	100	*/
	101	int (fb_dirty)(struct drm_fb_helper helper, struct drm_clip_rect *clip);
4abe3520 DA	102	};
4abe3520 DA	103
9685cd9d	104	/**
264d6970 DV	105	* struct drm_fb_helper - main structure to emulate fbdev on top of KMS
	106	* @fb: Scanout framebuffer object
	107	* @dev: DRM device
9685cd9d	108	* @funcs: driver callbacks for fb helper
9877d8f6	109	* @info: emulated fbdev device info struct
9685cd9d	110	* @pseudo_palette: fake palette of 16 colors
9622349e TZ	111	* @damage_clip: clip rectangle used with deferred_io to accumulate damage to
	112	* the screen buffer
	113	* @damage_lock: spinlock protecting @damage_clip
7aa3d63e	114	* @damage_work: worker used to flush the framebuffer
cfe63423	115	* @resume_work: worker used during resume if the console lock is already taken
264d6970 DV	116	*
	117	* This is the main structure used by the fbdev helpers. Drivers supporting
	118	* fbdev emulation should embedded this into their overall driver structure.
ea0dd85a	119	* Drivers must also fill out a &struct drm_fb_helper_funcs with a few
264d6970	120	* operations.
9685cd9d	121	*/
785b93ef	122	struct drm_fb_helper {
d536540f NT	123	/**
	124	* @client:
	125	*
	126	* DRM client used by the generic fbdev emulation.
	127	*/
	128	struct drm_client_dev client;
	129
	130	/**
	131	* @buffer:
	132	*
	133	* Framebuffer used by the generic fbdev emulation.
	134	*/
	135	struct drm_client_buffer *buffer;
	136
785b93ef DA	137	struct drm_framebuffer *fb;
785b93ef DA	138	struct drm_device *dev;
3a493879	139	const struct drm_fb_helper_funcs *funcs;
9877d8f6	140	struct fb_info *info;
38651674	141	u32 pseudo_palette[17];
9622349e TZ	142	struct drm_clip_rect damage_clip;
9622349e TZ	143	spinlock_t damage_lock;
7aa3d63e	144	struct work_struct damage_work;
cfe63423	145	struct work_struct resume_work;
264d6970	146
e9827d8e TR	147	/**
	148	* @lock:
	149	*
	150	* Top-level FBDEV helper lock. This protects all internal data
	151	* structures and lists, such as @connector_info and @crtc_info.
	152	*
	153	* FIXME: fbdev emulation locking is a mess and long term we want to
	154	* protect all helper internal state with this lock as well as reduce
	155	* core KMS locking as much as possible.
	156	*/
	157	struct mutex lock;
	158
264d6970 DV	159	/**
	160	* @kernel_fb_list:
	161	*
	162	* Entry on the global kernel_fb_helper_list, used for kgdb entry/exit.
	163	*/
785b93ef	164	struct list_head kernel_fb_list;
8be48d92	165
264d6970 DV	166	/**
	167	* @delayed_hotplug:
	168	*
	169	* A hotplug was received while fbdev wasn't in control of the DRM
	170	* device, i.e. another KMS master was active. The output configuration
	171	* needs to be reprobe when fbdev is in control again.
	172	*/
4abe3520	173	bool delayed_hotplug;
ca91a275 DV	174
	175	/**
	176	* @deferred_setup:
	177	*
	178	* If no outputs are connected (disconnected or unknown) the FB helper
	179	* code will defer setup until at least one of the outputs shows up.
	180	* This field keeps track of the status so that setup can be retried
	181	* at every hotplug event until it succeeds eventually.
	182	*
	183	* Protected by @lock.
	184	*/
	185	bool deferred_setup;
	186
	187	/**
	188	* @preferred_bpp:
	189	*
	190	* Temporary storage for the driver's preferred BPP setting passed to
	191	* FB helper initialization. This needs to be tracked so that deferred
	192	* FB helper setup can pass this on.
	193	*
	194	* See also: @deferred_setup
	195	*/
	196	int preferred_bpp;
e7c5c29a	197
d6591da5 JMC	198	#ifdef CONFIG_FB_DEFERRED_IO
	199	/**
	200	* @fbdefio:
	201	*
	202	* Temporary storage for the driver's FB deferred I/O handler. If the
	203	* driver uses the DRM fbdev emulation layer, this is set by the core
	204	* to a generic deferred I/O handler if a driver is preferring to use
	205	* a shadow buffer.
	206	*/
	207	struct fb_deferred_io fbdefio;
	208	#endif
785b93ef DA	209	};
785b93ef DA	210
d536540f NT	211	static inline struct drm_fb_helper *
	212	drm_fb_helper_from_client(struct drm_client_dev *client)
	213	{
	214	return container_of(client, struct drm_fb_helper, client);
	215	}
	216
74064893	217	/**
21bf75ec	218	* define DRM_FB_HELPER_DEFAULT_OPS - helper define for drm drivers
74064893 SC	219	*
	220	* Helper define to register default implementations of drm_fb_helper
	221	* functions. To be used in struct fb_ops of drm drivers.
	222	*/
	223	#define DRM_FB_HELPER_DEFAULT_OPS \
	224	.fb_check_var = drm_fb_helper_check_var, \
	225	.fb_set_par = drm_fb_helper_set_par, \
	226	.fb_setcmap = drm_fb_helper_setcmap, \
	227	.fb_blank = drm_fb_helper_blank, \
1e008928 SC	228	.fb_pan_display = drm_fb_helper_pan_display, \
1e008928 SC	229	.fb_debug_enter = drm_fb_helper_debug_enter, \
0f3bbe07 MR	230	.fb_debug_leave = drm_fb_helper_debug_leave, \
0f3bbe07 MR	231	.fb_ioctl = drm_fb_helper_ioctl
74064893	232
a03fdcb1	233	#ifdef CONFIG_DRM_FBDEV_EMULATION
10a23102	234	void drm_fb_helper_prepare(struct drm_device dev, struct drm_fb_helper helper,
6c80a93b	235	unsigned int preferred_bpp,
10a23102	236	const struct drm_fb_helper_funcs *funcs);
4825797c	237	void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper);
2dea2d11	238	int drm_fb_helper_init(struct drm_device dev, struct drm_fb_helper helper);
4abe3520	239	void drm_fb_helper_fini(struct drm_fb_helper *helper);
785b93ef DA	240	int drm_fb_helper_blank(int blank, struct fb_info *info);
	241	int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
	242	struct fb_info *info);
	243	int drm_fb_helper_set_par(struct fb_info *info);
	244	int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
	245	struct fb_info *info);
785b93ef	246
b7bdf0a8	247	int drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
b8017d6c	248
7fd50bc3	249	struct fb_info drm_fb_helper_alloc_info(struct drm_fb_helper fb_helper);
6a4fef21	250	void drm_fb_helper_release_info(struct drm_fb_helper *fb_helper);
afb0ff78	251	void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper);
3df3116a DV	252	void drm_fb_helper_fill_info(struct fb_info *info,
	253	struct drm_fb_helper *fb_helper,
	254	struct drm_fb_helper_surface_size *sizes);
3632ef89	255
e80eec1b	256	void drm_fb_helper_deferred_io(struct fb_info info, struct list_head pagereflist);
eaa434de	257
cbb1a82e AT	258	ssize_t drm_fb_helper_sys_read(struct fb_info info, char __user buf,
	259	size_t count, loff_t *ppos);
	260	ssize_t drm_fb_helper_sys_write(struct fb_info info, const char __user buf,
	261	size_t count, loff_t *ppos);
	262
742547b7 AT	263	void drm_fb_helper_sys_fillrect(struct fb_info *info,
	264	const struct fb_fillrect *rect);
	265	void drm_fb_helper_sys_copyarea(struct fb_info *info,
	266	const struct fb_copyarea *area);
	267	void drm_fb_helper_sys_imageblit(struct fb_info *info,
	268	const struct fb_image *image);
	269
98378091 TZ	270	ssize_t drm_fb_helper_cfb_read(struct fb_info info, char __user buf,
	271	size_t count, loff_t *ppos);
	272	ssize_t drm_fb_helper_cfb_write(struct fb_info info, const char __user buf,
	273	size_t count, loff_t *ppos);
	274
742547b7 AT	275	void drm_fb_helper_cfb_fillrect(struct fb_info *info,
	276	const struct fb_fillrect *rect);
	277	void drm_fb_helper_cfb_copyarea(struct fb_info *info,
	278	const struct fb_copyarea *area);
	279	void drm_fb_helper_cfb_imageblit(struct fb_info *info,
	280	const struct fb_image *image);
	281
28579f37	282	void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper, bool suspend);
cfe63423	283	void drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper,
28579f37	284	bool suspend);
fdefa58a	285
068143d3	286	int drm_fb_helper_setcmap(struct fb_cmap cmap, struct fb_info info);
d50ba256	287
0f3bbe07 MR	288	int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
	289	unsigned long arg);
	290
7394371d	291	int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
6c80a93b	292	int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper);
1a7aba7f JB	293	int drm_fb_helper_debug_enter(struct fb_info *info);
1a7aba7f JB	294	int drm_fb_helper_debug_leave(struct fb_info *info);
304a4f6a NT	295
	296	void drm_fb_helper_lastclose(struct drm_device *dev);
	297	void drm_fb_helper_output_poll_changed(struct drm_device *dev);
a03fdcb1 AT	298	#else
a03fdcb1 AT	299	static inline void drm_fb_helper_prepare(struct drm_device *dev,
6c80a93b TZ	300	struct drm_fb_helper *helper,
	301	unsigned int preferred_bpp,
	302	const struct drm_fb_helper_funcs *funcs)
a03fdcb1 AT	303	{
	304	}
	305
4825797c TZ	306	static inline void drm_fb_helper_unprepare(struct drm_fb_helper *fb_helper)
	307	{
	308	}
	309
a03fdcb1	310	static inline int drm_fb_helper_init(struct drm_device *dev,
2dea2d11	311	struct drm_fb_helper *helper)
a03fdcb1	312	{
a65eb01f NT	313	/* So drivers can use it to free the struct */
	314	helper->dev = dev;
	315	dev->fb_helper = helper;
	316
a03fdcb1 AT	317	return 0;
	318	}
	319
	320	static inline void drm_fb_helper_fini(struct drm_fb_helper *helper)
	321	{
a65eb01f NT	322	if (helper && helper->dev)
a65eb01f NT	323	helper->dev->fb_helper = NULL;
a03fdcb1 AT	324	}
	325
	326	static inline int drm_fb_helper_blank(int blank, struct fb_info *info)
	327	{
	328	return 0;
	329	}
	330
	331	static inline int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
	332	struct fb_info *info)
	333	{
	334	return 0;
	335	}
	336
	337	static inline int drm_fb_helper_set_par(struct fb_info *info)
	338	{
	339	return 0;
	340	}
	341
	342	static inline int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
	343	struct fb_info *info)
	344	{
	345	return 0;
	346	}
	347
b7bdf0a8	348	static inline int
a03fdcb1 AT	349	drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper)
a03fdcb1 AT	350	{
b7bdf0a8	351	return 0;
a03fdcb1 AT	352	}
	353
	354	static inline struct fb_info *
7fd50bc3	355	drm_fb_helper_alloc_info(struct drm_fb_helper *fb_helper)
a03fdcb1 AT	356	{
	357	return NULL;
	358	}
	359
6a4fef21 TZ	360	static inline void drm_fb_helper_release_info(struct drm_fb_helper *fb_helper)
	361	{
	362	}
	363
afb0ff78	364	static inline void drm_fb_helper_unregister_info(struct drm_fb_helper *fb_helper)
a03fdcb1 AT	365	{
a03fdcb1 AT	366	}
a03fdcb1	367
ec8bf194 DV	368	static inline void
	369	drm_fb_helper_fill_info(struct fb_info *info,
	370	struct drm_fb_helper *fb_helper,
	371	struct drm_fb_helper_surface_size *sizes)
a03fdcb1 AT	372	{
	373	}
	374
	375	static inline int drm_fb_helper_setcmap(struct fb_cmap *cmap,
	376	struct fb_info *info)
	377	{
	378	return 0;
	379	}
	380
0f3bbe07 MR	381	static inline int drm_fb_helper_ioctl(struct fb_info *info, unsigned int cmd,
	382	unsigned long arg)
	383	{
	384	return 0;
	385	}
	386
eaa434de NT	387	static inline void drm_fb_helper_deferred_io(struct fb_info *info,
	388	struct list_head *pagelist)
	389	{
	390	}
	391
48c9571c NT	392	static inline int drm_fb_helper_defio_init(struct drm_fb_helper *fb_helper)
	393	{
	394	return -ENODEV;
	395	}
	396
a03fdcb1 AT	397	static inline ssize_t drm_fb_helper_sys_read(struct fb_info *info,
	398	char __user *buf, size_t count,
	399	loff_t *ppos)
	400	{
	401	return -ENODEV;
	402	}
	403
	404	static inline ssize_t drm_fb_helper_sys_write(struct fb_info *info,
	405	const char __user *buf,
	406	size_t count, loff_t *ppos)
	407	{
	408	return -ENODEV;
	409	}
	410
	411	static inline void drm_fb_helper_sys_fillrect(struct fb_info *info,
	412	const struct fb_fillrect *rect)
	413	{
	414	}
	415
	416	static inline void drm_fb_helper_sys_copyarea(struct fb_info *info,
	417	const struct fb_copyarea *area)
	418	{
	419	}
	420
	421	static inline void drm_fb_helper_sys_imageblit(struct fb_info *info,
	422	const struct fb_image *image)
	423	{
	424	}
	425
98378091 TZ	426	static inline ssize_t drm_fb_helper_cfb_read(struct fb_info info, char __user buf,
	427	size_t count, loff_t *ppos)
	428	{
	429	return -ENODEV;
	430	}
	431
	432	static inline ssize_t drm_fb_helper_cfb_write(struct fb_info info, const char __user buf,
	433	size_t count, loff_t *ppos)
	434	{
	435	return -ENODEV;
	436	}
	437
a03fdcb1 AT	438	static inline void drm_fb_helper_cfb_fillrect(struct fb_info *info,
	439	const struct fb_fillrect *rect)
	440	{
	441	}
	442
	443	static inline void drm_fb_helper_cfb_copyarea(struct fb_info *info,
	444	const struct fb_copyarea *area)
	445	{
	446	}
	447
	448	static inline void drm_fb_helper_cfb_imageblit(struct fb_info *info,
	449	const struct fb_image *image)
	450	{
	451	}
	452
	453	static inline void drm_fb_helper_set_suspend(struct drm_fb_helper *fb_helper,
28579f37	454	bool suspend)
a03fdcb1 AT	455	{
	456	}
	457
cfe63423	458	static inline void
28579f37	459	drm_fb_helper_set_suspend_unlocked(struct drm_fb_helper *fb_helper, bool suspend)
cfe63423 NT	460	{
	461	}
	462
a03fdcb1 AT	463	static inline int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper)
	464	{
	465	return 0;
	466	}
	467
6c80a93b	468	static inline int drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper)
a03fdcb1 AT	469	{
	470	return 0;
	471	}
	472
a03fdcb1 AT	473	static inline int drm_fb_helper_debug_enter(struct fb_info *info)
	474	{
	475	return 0;
	476	}
	477
	478	static inline int drm_fb_helper_debug_leave(struct fb_info *info)
	479	{
	480	return 0;
	481	}
	482
304a4f6a NT	483	static inline void drm_fb_helper_lastclose(struct drm_device *dev)
	484	{
	485	}
	486
	487	static inline void drm_fb_helper_output_poll_changed(struct drm_device *dev)
	488	{
	489	}
0a3bfe29 CW	490	#endif
0a3bfe29 CW	491
785b93ef	492	#endif