[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_fb_helper;

#include <drm/drm_client.h>
#include <drm/drm_crtc.h>
#include <drm/drm_device.h>
#include <linux/kgdb.h>
#include <linux/vgaarb.h>

enum mode_set_atomic {
	LEAVE_ATOMIC_MODE_SET,
	ENTER_ATOMIC_MODE_SET,
};

/**
 * 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);
};

/**
 * 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
 * @fbdev: emulated fbdev device info struct
 * @pseudo_palette: fake palette of 16 colors
 * @dirty_clip: clip rectangle used with deferred_io to accumulate damage to
 *              the screen buffer
 * @dirty_lock: spinlock protecting @dirty_clip
 * @dirty_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 *fbdev;
	u32 pseudo_palette[17];
	struct drm_clip_rect dirty_clip;
	spinlock_t dirty_lock;
	struct work_struct dirty_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;
};

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,
			   const struct drm_fb_helper_funcs *funcs);
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_fbi(struct drm_fb_helper *fb_helper);
void drm_fb_helper_unregister_fbi(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 *pagelist);

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

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

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

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_fbi(struct drm_fb_helper *fb_helper)
{
	return NULL;
}

static inline void drm_fb_helper_unregister_fbi(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 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,
					       int bpp_sel)
{
	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)
{
}

static inline void
drm_fbdev_generic_setup(struct drm_device *dev, unsigned int preferred_bpp)
{
}

#endif

/**
 * drm_fb_helper_remove_conflicting_framebuffers - remove firmware-configured framebuffers
 * @a: memory range, users of which are to be removed
 * @name: requesting driver name
 * @primary: also kick vga16fb if present
 *
 * This function removes framebuffer devices (initialized by firmware/bootloader)
 * which use memory range described by @a. If @a is NULL all such devices are
 * removed.
 */
static inline int
drm_fb_helper_remove_conflicting_framebuffers(struct apertures_struct *a,
					      const char *name, bool primary)
{
#if IS_REACHABLE(CONFIG_FB)
	return remove_conflicting_framebuffers(a, name, primary);
#else
	return 0;
#endif
}

/**
 * drm_fb_helper_remove_conflicting_pci_framebuffers - remove firmware-configured framebuffers for PCI devices
 * @pdev: PCI device
 * @name: requesting driver name
 *
 * This function removes framebuffer devices (eg. initialized by firmware)
 * using memory range configured for any of @pdev's memory bars.
 *
 * The function assumes that PCI device with shadowed ROM drives a primary
 * display and so kicks out vga16fb.
 */
static inline int
drm_fb_helper_remove_conflicting_pci_framebuffers(struct pci_dev *pdev,
						  const char *name)
{
	int ret = 0;

	/*
	 * WARNING: Apparently we must kick fbdev drivers before vgacon,
	 * otherwise the vga fbdev driver falls over.
	 */
#if IS_REACHABLE(CONFIG_FB)
	ret = remove_conflicting_pci_framebuffers(pdev, name);
#endif
	if (ret == 0)
		ret = vga_remove_vgacon(pdev);
	return ret;
}

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