xref: /openbmc/linux/include/drm/drm_fb_helper.h (revision 588b48ca)
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_helper_crtc {
38 	struct drm_mode_set mode_set;
39 	struct drm_display_mode *desired_mode;
40 };
41 
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 
51 /**
52  * struct drm_fb_helper_funcs - driver callbacks for the fbdev emulation library
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
58  *            structure. Furthermore it also needs to allocate the drm
59  *            framebuffer used to back the fbdev.
60  * @initial_config: Setup an initial fbdev display configuration
61  *
62  * Driver callbacks used by the fbdev emulation helper library.
63  */
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);
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);
76 };
77 
78 struct drm_fb_helper_connector {
79 	struct drm_connector *connector;
80 	struct drm_cmdline_mode cmdline_mode;
81 };
82 
83 struct drm_fb_helper {
84 	struct drm_framebuffer *fb;
85 	struct drm_device *dev;
86 	int crtc_count;
87 	struct drm_fb_helper_crtc *crtc_info;
88 	int connector_count;
89 	int connector_info_alloc_count;
90 	struct drm_fb_helper_connector **connector_info;
91 	const struct drm_fb_helper_funcs *funcs;
92 	struct fb_info *fbdev;
93 	u32 pseudo_palette[17];
94 	struct list_head kernel_fb_list;
95 
96 	/* we got a hotplug but fbdev wasn't running the console
97 	   delay until next set_par */
98 	bool delayed_hotplug;
99 };
100 
101 void drm_fb_helper_prepare(struct drm_device *dev, struct drm_fb_helper *helper,
102 			   const struct drm_fb_helper_funcs *funcs);
103 int drm_fb_helper_init(struct drm_device *dev,
104 		       struct drm_fb_helper *helper, int crtc_count,
105 		       int max_conn);
106 void drm_fb_helper_fini(struct drm_fb_helper *helper);
107 int drm_fb_helper_blank(int blank, struct fb_info *info);
108 int drm_fb_helper_pan_display(struct fb_var_screeninfo *var,
109 			      struct fb_info *info);
110 int drm_fb_helper_set_par(struct fb_info *info);
111 int drm_fb_helper_check_var(struct fb_var_screeninfo *var,
112 			    struct fb_info *info);
113 
114 bool drm_fb_helper_restore_fbdev_mode_unlocked(struct drm_fb_helper *fb_helper);
115 void drm_fb_helper_fill_var(struct fb_info *info, struct drm_fb_helper *fb_helper,
116 			    uint32_t fb_width, uint32_t fb_height);
117 void drm_fb_helper_fill_fix(struct fb_info *info, uint32_t pitch,
118 			    uint32_t depth);
119 
120 int drm_fb_helper_setcmap(struct fb_cmap *cmap, struct fb_info *info);
121 
122 int drm_fb_helper_hotplug_event(struct drm_fb_helper *fb_helper);
123 bool drm_fb_helper_initial_config(struct drm_fb_helper *fb_helper, int bpp_sel);
124 int drm_fb_helper_single_add_all_connectors(struct drm_fb_helper *fb_helper);
125 int drm_fb_helper_debug_enter(struct fb_info *info);
126 int drm_fb_helper_debug_leave(struct fb_info *info);
127 struct drm_display_mode *
128 drm_has_preferred_mode(struct drm_fb_helper_connector *fb_connector,
129 			int width, int height);
130 struct drm_display_mode *
131 drm_pick_cmdline_mode(struct drm_fb_helper_connector *fb_helper_conn,
132 		      int width, int height);
133 
134 int drm_fb_helper_add_one_connector(struct drm_fb_helper *fb_helper, struct drm_connector *connector);
135 int drm_fb_helper_remove_one_connector(struct drm_fb_helper *fb_helper,
136 				       struct drm_connector *connector);
137 #endif
138