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