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